Merge pull request #492 from code0-tech/491-type-graphql-ids

Move to TypeScript codegen configuration and make scalars more type safe

Author: Taucher2003

.gitlab-ci.yml

@@ -190,13 +190,15 @@ npm-types:generate-graphql:
     - .rails
   stage: build
   script:
-    - bundle exec rake graphql:schema:idl
+    - bundle exec rake graphql:schema:dump
   artifacts:
     expire_in: 7 days
     paths:
       - tmp/schema.graphql
+      - tmp/schema.json
       - tooling/graphql/types/
 
+
 .npm-types:publish-graphql:
   image: node:22.16.0
   needs:
@@ -218,6 +220,10 @@ npm-types:publish-graphql-dry-run:
   script:
     - !reference [.npm-types:publish-graphql, script]
     - npm publish --dry-run
+  artifacts:
+    expire_in: 7 days
+    paths:
+      - tooling/graphql/types/index.d.ts
   rules:
     - if: $C0_GH_REF_NAME != "main"
 

tooling/graphql/types/codegen.ts

@@ -0,0 +1,57 @@
+import type {CodegenConfig} from '@graphql-codegen/cli';
+import {readFileSync} from "node:fs";
+
+type Schema = {
+  data: {
+    __schema: {
+      types: Array<{ kind: string; name: string; }>;
+    };
+  };
+}
+
+const schemaData = readFileSync('../../../tmp/schema.json', 'utf-8');
+const schema: Schema = JSON.parse(schemaData);
+
+const globalIds = schema.data.__schema.types
+  .filter(type => type.kind === 'SCALAR' && type.name.endsWith('ID'))
+
+const scalars = {
+  JSON: {
+    input: 'any',
+    output: 'any',
+  },
+  Time: {
+    input: 'string',
+    output: 'string',
+  }
+}
+
+
+globalIds.forEach(type => {
+  const typeConfig = `\`gid://sagittarius/${type.name.replace(/ID$/, '')}/\${number}\``
+
+  scalars[type.name] = {
+    input: typeConfig,
+    output: typeConfig,
+  };
+});
+
+
+const config: CodegenConfig = {
+  schema: "../../../tmp/schema.graphql",
+  generates: {
+    './index.d.ts': {
+      plugins: [
+        "typescript"
+      ],
+      config: {
+        scalars,
+        strictScalars: true,
+        declarationKind: 'interface',
+      }
+    },
+  },
+};
+
+
+export default config;

tooling/graphql/types/codegen.yml

@@ -5,7 +5,7 @@
   "main": "index.js",
   "types": "index.d.ts",
   "scripts": {
-    "generate": "graphql-codegen --config codegen.yml"
+    "generate": "graphql-codegen --config codegen.ts"
   },
   "repository": {
     "type": "git",