refactor(sdk): bundle graphql types and make graphql a dev dependency

.changeset/graphql-dev-dependency.md

@@ -0,0 +1,5 @@
+---
+"@tailor-platform/sdk": patch
+---
+
+The SDK no longer installs `graphql`, `@urql/core`, or `wonka` as dependencies. The `DocumentNode` type that HTTP adapter `input` handlers and the executor `query` option accept is now included in the SDK's type declarations, so a project without `graphql` still gets `query` type-checked, and documents typed with `graphql` 16 or 17, including `TypedDocumentNode`, keep type-checking. If your project imports `graphql`, `@urql/core`, or `wonka` without declaring it, which only works when your package manager hoists it, add it to your own dependencies. If you use `graphql` 15 with `skipLibCheck: true`, passing a `parse()` result to the executor `query` option is now a type error, as it already was for HTTP adapters.

packages/sdk/package.json

@@ -151,6 +151,9 @@
       "types": "./dist/runtime/logger.d.mts",
       "import": "./dist/runtime/logger.mjs",
       "default": "./dist/runtime/logger.mjs"
+    },
+    "./vendor/graphql/*": {
+      "types": "./dist/vendor/graphql/*.d.mts"
     }
   },
   "scripts": {
@@ -204,7 +207,6 @@
     "@standard-schema/spec": "1.1.0",
     "@tailor-platform/function-kysely-tailordb": "0.1.3",
     "@toiroakr/read-multiline": "0.4.3",
-    "@urql/core": "6.0.3",
     "amaro": "1.3.0",
     "confbox": "0.3.1",
     "date-fns": "4.4.0",
@@ -213,7 +215,6 @@
     "get-east-asian-width": "1.7.0",
     "get-tsconfig": "4.14.3",
     "globals": "17.13.0",
-    "graphql": "17.0.2",
     "inflection": "3.0.2",
     "kysely": "0.29.7",
     "lines-db": "0.18.1",
@@ -244,6 +245,7 @@
     "@types/semver": "7.8.0",
     "@vitest/coverage-v8": "5.0.5",
     "eslint-plugin-zod": "5.2.2",
+    "graphql": "17.0.2",
     "oxfmt": "0.75.0",
     "oxlint": "1.90.0",
     "oxlint-tsgolint": "7.0.2005",

packages/sdk/scripts/check-public-api-jsdoc.ts

@@ -30,6 +30,7 @@ function entryPoints(): string[] {
   const points: string[] = [];
   for (const [key, value] of Object.entries(pkg.exports)) {
     if (
+      key.includes("*") ||
       typeof value !== "object" ||
       value === null ||
       !("types" in value) ||

packages/sdk/scripts/check-zod-isolation.ts

@@ -95,7 +95,7 @@ interface Violation {
 const violations: Violation[] = [];
 
 for (const [entry, target] of Object.entries(pkg.exports)) {
-  if (ZOD_ALLOWED_ENTRIES.has(entry)) {
+  if (ZOD_ALLOWED_ENTRIES.has(entry) || entry.includes("*")) {
     continue;
   }
   if (typeof target !== "object" || target === null) {

packages/sdk/src/configure/services/executor/operation.ts

@@ -7,20 +7,19 @@ import type {
   WebhookOperation as ParserWebhookOperation,
   WorkflowOperation as ParserWorkflowOperation,
 } from "#/types/executor.generated";
-import type { Client } from "@urql/core";
+import type { DocumentNode } from "graphql";
 
 /** Function-based executor operation. The body receives the trigger args and the `invoker`. */
 export type FunctionOperation<Args> = Omit<ParserFunctionOperation, "body" | "invoker"> & {
   body: (args: Args & { invoker: TailorPrincipal | null }) => void | Promise<void>;
   invoker?: MachineUserName;
 };
 
-type UrqlOperationArgs = Parameters<Client["query"] | Client["mutation"]>;
-
 /** GraphQL-based executor operation. Executes a GraphQL query or mutation. */
 export type GqlOperation<Args> = Omit<ParserGqlOperation, "query" | "variables" | "invoker"> & {
-  query: UrqlOperationArgs[0];
-  variables?: (args: Args) => UrqlOperationArgs[1];
+  query: string | DocumentNode;
+  // oxlint-disable-next-line no-explicit-any
+  variables?: (args: Args) => { [prop: string]: any } | void | undefined;
   invoker?: MachineUserName;
 };
 

packages/sdk/tsdown.config.ts

@@ -1,8 +1,9 @@
-import { cpSync } from "node:fs";
+import { cpSync, mkdirSync, readFileSync, readdirSync, writeFileSync } from "node:fs";
 import path from "node:path";
 import Sonda from "sonda/rolldown";
 import { defineConfig } from "tsdown";
 import { entry } from "./scripts/build-entries.mjs";
+import type { OutputOptions, PreRenderedChunk } from "rolldown";
 
 function copyToOutDir(outDir: string, source: string, dest: string): void {
   cpSync(path.resolve(source), path.join(outDir, dest));
@@ -17,6 +18,24 @@ const jsPlugins = [
   }),
 ];
 
+const GRAPHQL_DIR = "node_modules/graphql/";
+const VENDOR_GRAPHQL_DIR = "vendor/graphql";
+const UP_TO_PACKAGES_DIR = /^(?:.*\/)?packages\//;
+
+function stableChunkName(name: string): string {
+  const graphqlAt = name.indexOf(GRAPHQL_DIR);
+  if (graphqlAt !== -1)
+    return `${VENDOR_GRAPHQL_DIR}/${name.slice(graphqlAt + GRAPHQL_DIR.length)}`;
+  return name.replace(UP_TO_PACKAGES_DIR, "");
+}
+
+function renameChunk(template: OutputOptions["entryFileNames"]) {
+  return (chunk: PreRenderedChunk): string => {
+    const resolved = typeof template === "function" ? template(chunk) : (template ?? "[name].js");
+    return resolved.replace("[name]", stableChunkName(chunk.name.replace(/\.d$/, "")));
+  };
+}
+
 const externalDeps = ["vite", "vitest", /^@tailor-platform\/sdk$/];
 
 const sharedOptions = {
@@ -62,6 +81,28 @@ export default defineConfig([
     },
     unbundle: true,
     root: "src",
-    deps: { neverBundle: externalDeps },
+    deps: { neverBundle: externalDeps, dts: { alwaysBundle: [/^graphql(\/|$)/] } },
+    outputOptions: (options) => ({
+      ...options,
+      entryFileNames: renameChunk(options.entryFileNames),
+      chunkFileNames: renameChunk(options.chunkFileNames),
+    }),
+    onSuccess: (config) => {
+      const vendorDir = path.join(config.outDir, VENDOR_GRAPHQL_DIR);
+      mkdirSync(vendorDir, { recursive: true });
+      copyToOutDir(config.outDir, `${GRAPHQL_DIR}LICENSE`, `${VENDOR_GRAPHQL_DIR}/LICENSE`);
+      for (const file of readdirSync(vendorDir, { recursive: true, encoding: "utf8" })) {
+        if (!file.endsWith(".d.mts")) continue;
+        const target = path.join(vendorDir, file);
+        writeFileSync(
+          target,
+          readFileSync(target, "utf8").replace(/^\/\/#region (.*)$/gm, (line, region: string) => {
+            const graphqlAt = region.indexOf(GRAPHQL_DIR);
+            if (graphqlAt === -1) return line;
+            return `//#region graphql/${region.slice(graphqlAt + GRAPHQL_DIR.length)}`;
+          }),
+        );
+      }
+    },
   },
 ]);

packages/sdk/vitest.config.ts

@@ -15,28 +15,30 @@ const packageJson = JSON.parse(
 
 const escapeRegExp = (value: string): string => value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
 
-const sdkSourceAliases = Object.entries(packageJson.exports).map(([exportName, target]) => {
-  const publicImport =
-    exportName === "." ? "@tailor-platform/sdk" : `@tailor-platform/sdk/${exportName.slice(2)}`;
-  const distImport = target.import ?? target.default;
-
-  if (!distImport?.startsWith("./dist/") || !distImport.endsWith(".mjs")) {
-    throw new Error(
-      `Unsupported @tailor-platform/sdk export ${exportName}: expected ./dist/*.mjs import target`,
-    );
-  }
-
-  return {
-    find: new RegExp(`^${escapeRegExp(publicImport)}$`),
-    replacement: path.resolve(
-      import.meta.dirname,
-      distImport
-        .replace(/^\.\//, "")
-        .replace(/^dist\//, "src/")
-        .replace(/\.mjs$/, ".ts"),
-    ),
-  };
-});
+const sdkSourceAliases = Object.entries(packageJson.exports)
+  .filter(([, target]) => target.import ?? target.default)
+  .map(([exportName, target]) => {
+    const publicImport =
+      exportName === "." ? "@tailor-platform/sdk" : `@tailor-platform/sdk/${exportName.slice(2)}`;
+    const distImport = target.import ?? target.default;
+
+    if (!distImport?.startsWith("./dist/") || !distImport.endsWith(".mjs")) {
+      throw new Error(
+        `Unsupported @tailor-platform/sdk export ${exportName}: expected ./dist/*.mjs import target`,
+      );
+    }
+
+    return {
+      find: new RegExp(`^${escapeRegExp(publicImport)}$`),
+      replacement: path.resolve(
+        import.meta.dirname,
+        distImport
+          .replace(/^\.\//, "")
+          .replace(/^dist\//, "src/")
+          .replace(/\.mjs$/, ".ts"),
+      ),
+    };
+  });
 
 // E2e files whose measured V8 coverage contribution justifies running them in
 // the coverage CI job ("e2e-coverage" project below): deploy.test.ts calls