refactor(graphql): Generate initial app types from schema

.github/workflows/vite.yml

@@ -25,3 +25,6 @@ jobs:
         run: yarn build
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+      # Requires yarn build, so convenient to run here
+      - name: Codegen freshness
+        run: yarn codegen:check

.gitignore

@@ -23,3 +23,4 @@ dist
 .venv/
 coverage
 coverage.lcov
+schema.graphql

codegen.ts

@@ -0,0 +1,47 @@
+import type { CodegenConfig } from "@graphql-codegen/cli"
+
+const config: CodegenConfig = {
+  // For the moment, we use a schema dumped by scripts/dump-schema.ts.
+  // If we can make it work in the future, we may be able to point directly
+  // at packages/openneuro-server/src/graphql/schema.ts, or import and pass
+  // the generated text.
+  // pnp seems to be the sticking point here, and I've given up for now.
+  schema: "schema.graphql",
+  documents: [
+    "packages/openneuro-app/src/**/*.{ts,tsx}",
+    "!packages/openneuro-app/src/gql/**",
+    // Exclude files with duplicate operation names.
+    // These must be deduplicated before they can be included.
+    // Cross-file duplicates:
+    "!packages/openneuro-app/src/scripts/datalad/mutations/snapshot.tsx",
+    "!packages/openneuro-app/src/scripts/dataset/mutations/snapshot.tsx",
+    "!packages/openneuro-app/src/scripts/dataset/download/download-script.tsx",
+    "!packages/openneuro-app/src/scripts/dataset/snapshot-container.tsx",
+    "!packages/openneuro-app/src/scripts/search/use-search-results.tsx",
+    // Intra-file duplicates (two operations share a name):
+    "!packages/openneuro-app/src/scripts/queries/dataset.ts",
+    // Type mismatches (nullable list items vs non-nullable schema):
+    "!packages/openneuro-app/src/scripts/dataset/files/files.tsx",
+  ],
+  generates: {
+    "packages/openneuro-app/src/gql/": {
+      preset: "client",
+      presetConfig: { fragmentMasking: false },
+      config: {
+        scalars: {
+          Date: "string",
+          DateTime: "string",
+          BigInt: "number",
+          JSON: "unknown",
+        },
+        useTypeImports: true,
+        avoidOptionals: { field: false, inputValue: false, object: false },
+      },
+    },
+  },
+  hooks: {
+    afterAllFileWrite: ["deno fmt"],
+  },
+}
+
+export default config

package.json

@@ -14,11 +14,15 @@
     "prepublish": "rm -fr packages/*/dist .build-cache/ && yarn build",
     "prepublishOnly": "pinst --disable",
     "postpublish": "pinst --enable",
+    "codegen": "yarn dump-schema && graphql-codegen --config codegen.ts",
+    "codegen:check": "yarn dump-schema && graphql-codegen --config codegen.ts && git diff --exit-code packages/openneuro-app/src/gql",
     "version": "cat cli/deno.json | jq \".version = $(cat lerna.json | jq '.version')\" > cli/deno.json && git add cli/deno.json && yarn install && git stage yarn.lock"
   },
   "devDependencies": {
     "@elastic/apm-rum-react": "2.0.2",
     "@eslint/js": "^9.13.0",
+    "@graphql-codegen/cli": "6.3.1",
+    "@graphql-codegen/client-preset": "5.3.0",
     "@sentry/cli": "1.37.4",
     "@testing-library/jest-dom": "6.1.3",
     "@types/ioredis-mock": "^8.2.2",

packages/openneuro-app/package.json

@@ -20,6 +20,7 @@
     "@bids/validator": "npm:@jsr/bids__validator@^2.3.2",
     "@emotion/react": "11.11.1",
     "@emotion/styled": "11.11.0",
+    "@graphql-typed-document-node/core": "^3.2.0",
     "@niivue/niivue": "0.57.0",
     "@openneuro/components": "^4.33.4",
     "@sentry/react": "^10.37.0",