Setup gql.tada

Author: CarsonF

.eslintrc.cjs

@@ -93,6 +93,16 @@ const restrictedImports = [
     kind: 'value',
     message: 'Be sure to specify the `type` modifier',
   },
+  {
+    importNames: ['ResultOf', 'VariablesOf'],
+    path: '@graphql-typed-document-node/core',
+    replacement: { path: '~/graphql' },
+  },
+  {
+    importNames: ['FragmentOf', 'ResultOf', 'VariablesOf'],
+    path: 'gql.tada',
+    replacement: { path: '~/graphql' },
+  },
 ];
 
 const namingConvention = [

.github/workflows/lint.yml

@@ -21,11 +21,12 @@ jobs:
       - name: Check for no duplicate dependencies
         run: yarn dedupe --check
 
+      - name: Generate GQL Schema
+        run: yarn start -- --gen-schema && yarn gql-tada generate output
+
       - name: Check TypeScript
         run: yarn type-check
 
-      - name: Generate GQL Schema
-        run: yarn start -- --gen-schema
       - name: Upload GQL Schema
         uses: actions/upload-artifact@v4
         with:

.github/workflows/test.yml

@@ -18,6 +18,9 @@ jobs:
       - name: Gel Setup
         uses: ./.github/actions/gel-setup
 
+      - name: Generate GQL Schema
+        run: yarn start -- --gen-schema && yarn gql-tada generate output
+
       - name: Tests
         run: yarn test --reporters=github-actions
 
@@ -59,6 +62,9 @@ jobs:
       - name: Gel Setup
         uses: ./.github/actions/gel-setup
 
+      - name: Generate GQL Schema
+        run: yarn start -- --gen-schema && yarn gql-tada generate output
+
       - name: E2E Tests
         run: yarn test:e2e --shard=${{ matrix.shard }}/6 --reporters=github-actions
         env:

.gitignore

@@ -7,6 +7,7 @@
 src/core/gel/generated-client
 src/core/gel/schema.ts
 src/**/*.edgeql.ts
+*.generated.*
 
 # Yarn / NPM
 .yarn/cache

package.json

@@ -74,6 +74,7 @@
     "gel": "^2.1.0-canary.20250319T143140",
     "glob": "^11.0.2",
     "got": "^14.3.0",
+    "gql.tada": "^1.8.10",
     "graphql": "^16.9.0",
     "graphql-parse-resolve-info": "^4.14.0",
     "graphql-scalars": "^1.22.4",

src/graphql.ts

@@ -0,0 +1,25 @@
+/* eslint-disable @seedcompany/no-restricted-imports */
+import { initGraphQLTada, type VariablesOf } from 'gql.tada';
+import { type ID } from '~/common';
+import type { introspection } from './graphql-env.generated';
+
+export const graphql = initGraphQLTada<{
+  introspection: introspection;
+  scalars: {
+    ID: ID;
+    Date: string;
+    DateTime: string;
+    InlineMarkdown: string;
+    Markdown: string;
+    RichText: object;
+    URL: string;
+  };
+  disableMasking: true;
+}>();
+
+export type { FragmentOf, ResultOf, VariablesOf } from 'gql.tada';
+export { readFragment } from 'gql.tada';
+
+export type InputOf<T> = VariablesOf<T> extends { input: infer Input }
+  ? Input
+  : never;

tsconfig.json

@@ -37,6 +37,12 @@
     "plugins": [
       { "transform": "typescript-transform-paths" },
       { "transform": "./src/core/resources/plugin/index.js" },
+      {
+        "name": "gql.tada/ts-plugin",
+        "schema": "./schema.graphql",
+        "tadaOutputLocation": "./src/graphql-env.generated.d.ts",
+        "tadaTurboLocation": "./src/graphql-op-cache.generated.d.ts",
+      },
     ],
 
     // Path resolution
@@ -46,6 +52,7 @@
       "~/common/*": ["./src/common/*"],
       "~/core": ["./src/core"],
       "~/core/*": ["./src/core/*"],
+      "~/graphql": ["./src/graphql"],
     },
 
     // Compilation

yarn.lock

@@ -5,6 +5,31 @@ __metadata:
   version: 8
   cacheKey: 10c0
 
+"@0no-co/graphql.web@npm:^1.0.5":
+  version: 1.1.2
+  resolution: "@0no-co/graphql.web@npm:1.1.2"
+  peerDependencies:
+    graphql: ^14.0.0 || ^15.0.0 || ^16.0.0
+  peerDependenciesMeta:
+    graphql:
+      optional: true
+  checksum: 10c0/7074de29681f0563cb9a90d702c7cda4443dce858e09f9a09adbafe32c302890cab81959ccba4ed7ac3e332423b2928a1dc95dd4a5004e6a5c156b733caa349a
+  languageName: node
+  linkType: hard
+
+"@0no-co/graphqlsp@npm:^1.12.13":
+  version: 1.12.16
+  resolution: "@0no-co/graphqlsp@npm:1.12.16"
+  dependencies:
+    "@gql.tada/internal": "npm:^1.0.0"
+    graphql: "npm:^15.5.0 || ^16.0.0 || ^17.0.0"
+  peerDependencies:
+    graphql: ^15.5.0 || ^16.0.0 || ^17.0.0
+    typescript: ^5.0.0
+  checksum: 10c0/e802fe7c719d68e1279f98da161d2b619f93a6768e82dee331af3d35b03b711f1e2b10911d0acae0dbd6fc72a3fea441fbc6c58aae6f75f269d9d4a48a2069bf
+  languageName: node
+  linkType: hard
+
 "@ampproject/remapping@npm:^2.2.0":
   version: 2.3.0
   resolution: "@ampproject/remapping@npm:2.3.0"
@@ -1551,6 +1576,40 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@gql.tada/cli-utils@npm:1.6.3":
+  version: 1.6.3
+  resolution: "@gql.tada/cli-utils@npm:1.6.3"
+  dependencies:
+    "@0no-co/graphqlsp": "npm:^1.12.13"
+    "@gql.tada/internal": "npm:1.0.8"
+    graphql: "npm:^15.5.0 || ^16.0.0 || ^17.0.0"
+  peerDependencies:
+    "@0no-co/graphqlsp": ^1.12.13
+    "@gql.tada/svelte-support": 1.0.1
+    "@gql.tada/vue-support": 1.0.1
+    graphql: ^15.5.0 || ^16.0.0 || ^17.0.0
+    typescript: ^5.0.0
+  peerDependenciesMeta:
+    "@gql.tada/svelte-support":
+      optional: true
+    "@gql.tada/vue-support":
+      optional: true
+  checksum: 10c0/5a2a8e8c082fc63ae497d569e6ffec8ff2e4a58456b92c7d0b82ab3f68f5ac2a63c011f5fcd046f161240cb2661f9c3ab152cc0d977f33fa5016ea341d20c22b
+  languageName: node
+  linkType: hard
+
+"@gql.tada/internal@npm:1.0.8, @gql.tada/internal@npm:^1.0.0":
+  version: 1.0.8
+  resolution: "@gql.tada/internal@npm:1.0.8"
+  dependencies:
+    "@0no-co/graphql.web": "npm:^1.0.5"
+  peerDependencies:
+    graphql: ^15.5.0 || ^16.0.0 || ^17.0.0
+    typescript: ^5.0.0
+  checksum: 10c0/dd9b34296160f7eb4374b1791dd9353fd4147f4d7e2a3a8e2974c2319dc6165a4458c19d9b517a3f7764da4e7a4401c099fdf1936841de02c0e565db95d64a5d
+  languageName: node
+  linkType: hard
+
 "@graphql-hive/cli@npm:>=0.44":
   version: 0.49.1
   resolution: "@graphql-hive/cli@npm:0.49.1"
@@ -5883,6 +5942,7 @@ __metadata:
     gel: "npm:^2.1.0-canary.20250319T143140"
     glob: "npm:^11.0.2"
     got: "npm:^14.3.0"
+    gql.tada: "npm:^1.8.10"
     graphql: "npm:^16.9.0"
     graphql-parse-resolve-info: "npm:^4.14.0"
     graphql-scalars: "npm:^1.22.4"
@@ -8035,6 +8095,23 @@ __metadata:
   languageName: node
   linkType: hard
 
+"gql.tada@npm:^1.8.10":
+  version: 1.8.10
+  resolution: "gql.tada@npm:1.8.10"
+  dependencies:
+    "@0no-co/graphql.web": "npm:^1.0.5"
+    "@0no-co/graphqlsp": "npm:^1.12.13"
+    "@gql.tada/cli-utils": "npm:1.6.3"
+    "@gql.tada/internal": "npm:1.0.8"
+  peerDependencies:
+    typescript: ^5.0.0
+  bin:
+    gql-tada: bin/cli.js
+    gql.tada: bin/cli.js
+  checksum: 10c0/b0485a9cfcd5bfd327bc3d7533654184808eadbf6d47bcb8cdc8655f2dc3928ec0b1a8ffb5f57345f0902370dc0c249f85827644fa5f9eace0817a1f812b1dc2
+  languageName: node
+  linkType: hard
+
 "graceful-fs@npm:^4.2.4, graceful-fs@npm:^4.2.6, graceful-fs@npm:^4.2.9":
   version: 4.2.11
   resolution: "graceful-fs@npm:4.2.11"
@@ -8125,7 +8202,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"graphql@npm:^16.8.1, graphql@npm:^16.9.0":
+"graphql@npm:^15.5.0 || ^16.0.0 || ^17.0.0, graphql@npm:^16.8.1, graphql@npm:^16.9.0":
   version: 16.11.0
   resolution: "graphql@npm:16.11.0"
   checksum: 10c0/124da7860a2292e9acf2fed0c71fc0f6a9b9ca865d390d112bdd563c1f474357141501c12891f4164fe984315764736ad67f705219c62f7580681d431a85db88