@ptdgrp/typedgql 1.0.0-beta.8

package/dist/vite.mjs

@@ -0,0 +1,148 @@
+import { n as loadRemoteSchema, r as Generator, t as loadLocalSchema } from "./schema-loader-CYFTxUkG.mjs";
+import { readFile, realpath } from "node:fs/promises";
+import { createHash } from "node:crypto";
+import { resolve } from "node:path";
+import { normalizePath } from "vite";
+
+//#region src/vite-plugin.ts
+/**
+* Vite plugin for @ptdgrp/typedgql — runs codegen automatically.
+*/
+function isRemote(schema) {
+	return /^https?:\/\//.test(schema);
+}
+function makeSchemaLoader(schema, headers) {
+	return isRemote(schema) ? () => loadRemoteSchema(schema, headers) : () => loadLocalSchema(schema);
+}
+function resolveDevDependencyHmr(option) {
+	if (!option) return void 0;
+	if (option === true) return { strategy: "reload" };
+	return { strategy: option.strategy ?? "reload" };
+}
+function buildNegatedWatchPattern(packageName) {
+	return `!**/node_modules/${packageName}/**`;
+}
+const DEV_DEP_HMR_PACKAGE_NAME = "@ptdgrp/typedgql";
+const DEV_DEP_HMR_WATCH_DIRS = ["dist"];
+async function hashFile(path) {
+	try {
+		const content = await readFile(path);
+		return createHash("sha256").update(content).digest("hex");
+	} catch {
+		return;
+	}
+}
+/**
+* Vite plugin that runs typedgql codegen automatically.
+*
+* - **Local schema** — runs once on startup, then watches for file changes.
+* - **Remote schema** — runs on every `vite dev` / `vite build` invocation.
+*
+* @example
+* ```ts
+* // vite.config.ts
+* import { typedgql } from "@ptdgrp/typedgql/vite";
+*
+* export default defineConfig({
+*   plugins: [
+*     // local file
+*     typedgql({ schema: "./schema.graphql" }),
+*     // or remote endpoint
+*     typedgql({ schema: "http://localhost:4000/graphql" }),
+*   ],
+* });
+* ```
+*/
+function typedgql(options) {
+	const { schema, schemaHeaders, devDependencyHmr, ...generatorOptions } = options;
+	const remote = isRemote(schema);
+	const depHmr = resolveDevDependencyHmr(devDependencyHmr);
+	const codegenOptions = {
+		...generatorOptions,
+		schemaLoader: makeSchemaLoader(schema, schemaHeaders)
+	};
+	let isRunning = false;
+	let isDependencyRefreshRunning = false;
+	let lastSchemaHash;
+	let initSchemaHashPromise;
+	let resolvedConfig;
+	let logger;
+	async function runCodegen(trigger) {
+		if (isRunning) return;
+		isRunning = true;
+		const label = `\x1b[36m[typedgql:${trigger}]\x1b[0m`;
+		try {
+			await new Generator(codegenOptions).generate();
+		} catch (err) {
+			logger.error(`${label} failed: ${err}`);
+		} finally {
+			isRunning = false;
+		}
+	}
+	return {
+		name: "vite-plugin-typedgql",
+		config(config) {
+			if (!depHmr) return;
+			const negatedPattern = buildNegatedWatchPattern(DEV_DEP_HMR_PACKAGE_NAME);
+			const exclude = new Set(config.optimizeDeps?.exclude ?? []);
+			exclude.add(DEV_DEP_HMR_PACKAGE_NAME);
+			const watchIgnored = config.server?.watch?.ignored;
+			const mergedIgnored = Array.isArray(watchIgnored) ? [...watchIgnored, negatedPattern] : watchIgnored === void 0 ? [negatedPattern] : watchIgnored;
+			return {
+				optimizeDeps: { exclude: Array.from(exclude) },
+				server: { watch: { ignored: mergedIgnored } }
+			};
+		},
+		configResolved(cfg) {
+			resolvedConfig = cfg;
+			logger = cfg.logger;
+		},
+		async buildStart() {
+			await runCodegen(resolvedConfig?.command === "build" ? "build" : "start");
+		},
+		configureServer(server) {
+			if (depHmr) {
+				const packageRoot = normalizePath(resolve(server.config.root, "node_modules", DEV_DEP_HMR_PACKAGE_NAME));
+				const watchedDirs = DEV_DEP_HMR_WATCH_DIRS.map((dir) => normalizePath(resolve(packageRoot, dir)));
+				for (const dir of watchedDirs) server.watcher.add(dir);
+				server.watcher.on("change", async (file) => {
+					const changedPath = normalizePath(file);
+					if (!watchedDirs.some((dir) => changedPath.startsWith(dir))) return;
+					if (isDependencyRefreshRunning) return;
+					isDependencyRefreshRunning = true;
+					try {
+						if (depHmr.strategy === "restart") await server.restart();
+						else server.ws.send({ type: "full-reload" });
+					} finally {
+						isDependencyRefreshRunning = false;
+					}
+				});
+			}
+			if (remote) return;
+			const root = server.config.root;
+			const schemaPath = normalizePath(resolve(root, schema));
+			let realSchemaPath = schemaPath;
+			realpath(schemaPath).then((actualPath) => {
+				realSchemaPath = normalizePath(actualPath);
+			}).catch(() => {});
+			server.watcher.add(schemaPath);
+			initSchemaHashPromise = hashFile(schemaPath).then((hash) => {
+				lastSchemaHash = hash;
+			});
+			server.watcher.on("change", async (file) => {
+				const changedPath = normalizePath(file);
+				if (changedPath !== schemaPath && changedPath !== realSchemaPath) return;
+				await initSchemaHashPromise;
+				const nextHash = await hashFile(schemaPath);
+				if (nextHash && nextHash === lastSchemaHash) return;
+				await runCodegen("watch");
+				if (nextHash) lastSchemaHash = nextHash;
+				server.ws.send({ type: "full-reload" });
+			});
+		}
+	};
+}
+
+//#endregion
+export { typedgql };
+//# sourceMappingURL=vite.mjs.map

package/dist/vite.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"vite.mjs","names":[],"sources":["../src/vite-plugin.ts"],"sourcesContent":["/**\n * Vite plugin for @ptdgrp/typedgql — runs codegen automatically.\n */\n\nimport { realpath } from \"node:fs/promises\";\nimport { createHash } from \"node:crypto\";\nimport { readFile } from \"node:fs/promises\";\nimport { resolve } from \"node:path\";\nimport type { Plugin, ResolvedConfig, Logger, UserConfig } from \"vite\";\nimport { normalizePath } from \"vite\";\nimport { Generator } from \"./codegen/generator\";\nimport { loadLocalSchema, loadRemoteSchema } from \"./codegen/schema-loader\";\nimport type { CodegenOptions } from \"./codegen/options\";\n\nexport interface DevDependencyHmrOptions {\n  /**\n   * How to refresh dev server when watched dependency files change.\n   *\n   * - \"reload\": send full page reload\n   * - \"restart\": restart Vite dev server\n   *\n   * @default \"reload\"\n   */\n  strategy?: \"reload\" | \"restart\";\n}\n\nexport interface TypedGqlPluginOptions extends Omit<\n  CodegenOptions,\n  \"schemaLoader\"\n> {\n  /**\n   * GraphQL schema source.\n   * - Local file path:  `\"./schema.graphql\"`\n   * - Remote endpoint: `\"http://localhost:4000/graphql\"`\n   *\n   * Local file → codegen runs on startup, then re-runs on every file change.\n   * Remote URL → codegen runs on every `vite dev` / `vite build` invocation.\n   */\n  schema: string;\n  /**\n   * HTTP headers forwarded when fetching a remote schema.\n   * Only used when `schema` is a URL.\n   */\n  schemaHeaders?: Record<string, string>;\n  /**\n   * Optional dev-time watcher for dependency files in node_modules.\n   * Useful when developing typedgql as an installed package rather than workspace source.\n   */\n  devDependencyHmr?: boolean | DevDependencyHmrOptions;\n}\n\nfunction isRemote(schema: string): boolean {\n  return /^https?:\\/\\//.test(schema);\n}\n\nfunction makeSchemaLoader(\n  schema: string,\n  headers?: Record<string, string>,\n): () => Promise<import(\"graphql\").GraphQLSchema> {\n  return isRemote(schema)\n    ? () => loadRemoteSchema(schema, headers)\n    : () => loadLocalSchema(schema);\n}\n\nfunction resolveDevDependencyHmr(\n  option: boolean | DevDependencyHmrOptions | undefined,\n): { strategy: \"reload\" | \"restart\" } | undefined {\n  if (!option) return undefined;\n  if (option === true) {\n    return { strategy: \"reload\" };\n  }\n  return { strategy: option.strategy ?? \"reload\" };\n}\n\nfunction buildNegatedWatchPattern(packageName: string): string {\n  return `!**/node_modules/${packageName}/**`;\n}\n\nconst DEV_DEP_HMR_PACKAGE_NAME = \"@ptdgrp/typedgql\";\nconst DEV_DEP_HMR_WATCH_DIRS = [\"dist\"] as const;\n\nasync function hashFile(path: string): Promise<string | undefined> {\n  try {\n    const content = await readFile(path);\n    return createHash(\"sha256\").update(content).digest(\"hex\");\n  } catch {\n    return undefined;\n  }\n}\n\n/**\n * Vite plugin that runs typedgql codegen automatically.\n *\n * - **Local schema** — runs once on startup, then watches for file changes.\n * - **Remote schema** — runs on every `vite dev` / `vite build` invocation.\n *\n * @example\n * ```ts\n * // vite.config.ts\n * import { typedgql } from \"@ptdgrp/typedgql/vite\";\n *\n * export default defineConfig({\n *   plugins: [\n *     // local file\n *     typedgql({ schema: \"./schema.graphql\" }),\n *     // or remote endpoint\n *     typedgql({ schema: \"http://localhost:4000/graphql\" }),\n *   ],\n * });\n * ```\n */\nexport function typedgql(options: TypedGqlPluginOptions): Plugin {\n  const { schema, schemaHeaders, devDependencyHmr, ...generatorOptions } = options;\n  const remote = isRemote(schema);\n  const depHmr = resolveDevDependencyHmr(devDependencyHmr);\n\n  const codegenOptions: CodegenOptions = {\n    ...generatorOptions,\n    schemaLoader: makeSchemaLoader(schema, schemaHeaders),\n  };\n\n  let isRunning = false;\n  let isDependencyRefreshRunning = false;\n  let lastSchemaHash: string | undefined;\n  let initSchemaHashPromise: Promise<void> | undefined;\n  let resolvedConfig: ResolvedConfig;\n  let logger: Logger;\n\n  async function runCodegen(trigger: string) {\n    if (isRunning) return;\n    isRunning = true;\n    const label = `\\x1b[36m[typedgql:${trigger}]\\x1b[0m`;\n    try {\n      // logger.info(`${label} running codegen (schema: ${schema})`);\n      const generator = new Generator(codegenOptions);\n      await generator.generate();\n      // logger.info(`${label} done`);\n    } catch (err) {\n      logger.error(`${label} failed: ${err}`);\n    } finally {\n      isRunning = false;\n    }\n  }\n\n  return {\n    name: \"vite-plugin-typedgql\",\n\n    config(config): UserConfig | void {\n      if (!depHmr) return;\n      const negatedPattern = buildNegatedWatchPattern(DEV_DEP_HMR_PACKAGE_NAME);\n      const exclude = new Set(config.optimizeDeps?.exclude ?? []);\n      exclude.add(DEV_DEP_HMR_PACKAGE_NAME);\n      const watchIgnored = config.server?.watch?.ignored;\n      const mergedIgnored = Array.isArray(watchIgnored)\n        ? [...watchIgnored, negatedPattern]\n        : watchIgnored === undefined\n          ? [negatedPattern]\n          : watchIgnored;\n      return {\n        optimizeDeps: {\n          exclude: Array.from(exclude),\n        },\n        server: {\n          watch: {\n            ignored: mergedIgnored,\n          },\n        },\n      };\n    },\n\n    configResolved(cfg) {\n      resolvedConfig = cfg;\n      logger = cfg.logger;\n    },\n\n    /**\n     * Runs on every `vite build` and on `vite dev` startup.\n     * For remote schemas this is the only trigger.\n     * For local schemas this handles the initial run; the watcher handles subsequent ones.\n     */\n    async buildStart() {\n      const trigger = resolvedConfig?.command === \"build\" ? \"build\" : \"start\";\n      await runCodegen(trigger);\n    },\n\n    /**\n     * Dev-only: watch the local schema file and re-run on change.\n     * Not registered for remote schemas — those re-run on the next dev/build start.\n     */\n    configureServer(server) {\n      if (depHmr) {\n        const packageRoot = normalizePath(\n          resolve(server.config.root, \"node_modules\", DEV_DEP_HMR_PACKAGE_NAME),\n        );\n        const watchedDirs = DEV_DEP_HMR_WATCH_DIRS.map((dir) =>\n          normalizePath(resolve(packageRoot, dir)),\n        );\n        for (const dir of watchedDirs) {\n          server.watcher.add(dir);\n        }\n        server.watcher.on(\"change\", async (file) => {\n          const changedPath = normalizePath(file);\n          if (!watchedDirs.some((dir) => changedPath.startsWith(dir))) return;\n          if (isDependencyRefreshRunning) return;\n          isDependencyRefreshRunning = true;\n          try {\n            if (depHmr.strategy === \"restart\") {\n              await server.restart();\n            } else {\n              server.ws.send({ type: \"full-reload\" });\n            }\n          } finally {\n            isDependencyRefreshRunning = false;\n          }\n        });\n      }\n\n      if (remote) return;\n\n      const root = server.config.root;\n      const schemaPath = normalizePath(resolve(root, schema));\n      let realSchemaPath = schemaPath;\n      void realpath(schemaPath)\n        .then((actualPath) => {\n          realSchemaPath = normalizePath(actualPath);\n        })\n        .catch(() => {\n          // Ignore when schema path is not resolvable yet.\n        });\n\n      server.watcher.add(schemaPath);\n      initSchemaHashPromise = hashFile(schemaPath).then((hash) => {\n        lastSchemaHash = hash;\n      });\n      server.watcher.on(\"change\", async (file) => {\n        const changedPath = normalizePath(file);\n        if (changedPath !== schemaPath && changedPath !== realSchemaPath) return;\n        await initSchemaHashPromise;\n        const nextHash = await hashFile(schemaPath);\n        if (nextHash && nextHash === lastSchemaHash) return;\n        await runCodegen(\"watch\");\n        if (nextHash) {\n          lastSchemaHash = nextHash;\n        }\n        server.ws.send({ type: \"full-reload\" });\n      });\n    },\n  };\n}\n"],"mappings":";;;;;;;;;;AAmDA,SAAS,SAAS,QAAyB;AACzC,QAAO,eAAe,KAAK,OAAO;;AAGpC,SAAS,iBACP,QACA,SACgD;AAChD,QAAO,SAAS,OAAO,SACb,iBAAiB,QAAQ,QAAQ,SACjC,gBAAgB,OAAO;;AAGnC,SAAS,wBACP,QACgD;AAChD,KAAI,CAAC,OAAQ,QAAO;AACpB,KAAI,WAAW,KACb,QAAO,EAAE,UAAU,UAAU;AAE/B,QAAO,EAAE,UAAU,OAAO,YAAY,UAAU;;AAGlD,SAAS,yBAAyB,aAA6B;AAC7D,QAAO,oBAAoB,YAAY;;AAGzC,MAAM,2BAA2B;AACjC,MAAM,yBAAyB,CAAC,OAAO;AAEvC,eAAe,SAAS,MAA2C;AACjE,KAAI;EACF,MAAM,UAAU,MAAM,SAAS,KAAK;AACpC,SAAO,WAAW,SAAS,CAAC,OAAO,QAAQ,CAAC,OAAO,MAAM;SACnD;AACN;;;;;;;;;;;;;;;;;;;;;;;;AAyBJ,SAAgB,SAAS,SAAwC;CAC/D,MAAM,EAAE,QAAQ,eAAe,kBAAkB,GAAG,qBAAqB;CACzE,MAAM,SAAS,SAAS,OAAO;CAC/B,MAAM,SAAS,wBAAwB,iBAAiB;CAExD,MAAM,iBAAiC;EACrC,GAAG;EACH,cAAc,iBAAiB,QAAQ,cAAc;EACtD;CAED,IAAI,YAAY;CAChB,IAAI,6BAA6B;CACjC,IAAI;CACJ,IAAI;CACJ,IAAI;CACJ,IAAI;CAEJ,eAAe,WAAW,SAAiB;AACzC,MAAI,UAAW;AACf,cAAY;EACZ,MAAM,QAAQ,qBAAqB,QAAQ;AAC3C,MAAI;AAGF,SADkB,IAAI,UAAU,eAAe,CAC/B,UAAU;WAEnB,KAAK;AACZ,UAAO,MAAM,GAAG,MAAM,WAAW,MAAM;YAC/B;AACR,eAAY;;;AAIhB,QAAO;EACL,MAAM;EAEN,OAAO,QAA2B;AAChC,OAAI,CAAC,OAAQ;GACb,MAAM,iBAAiB,yBAAyB,yBAAyB;GACzE,MAAM,UAAU,IAAI,IAAI,OAAO,cAAc,WAAW,EAAE,CAAC;AAC3D,WAAQ,IAAI,yBAAyB;GACrC,MAAM,eAAe,OAAO,QAAQ,OAAO;GAC3C,MAAM,gBAAgB,MAAM,QAAQ,aAAa,GAC7C,CAAC,GAAG,cAAc,eAAe,GACjC,iBAAiB,SACf,CAAC,eAAe,GAChB;AACN,UAAO;IACL,cAAc,EACZ,SAAS,MAAM,KAAK,QAAQ,EAC7B;IACD,QAAQ,EACN,OAAO,EACL,SAAS,eACV,EACF;IACF;;EAGH,eAAe,KAAK;AAClB,oBAAiB;AACjB,YAAS,IAAI;;EAQf,MAAM,aAAa;AAEjB,SAAM,WADU,gBAAgB,YAAY,UAAU,UAAU,QACvC;;EAO3B,gBAAgB,QAAQ;AACtB,OAAI,QAAQ;IACV,MAAM,cAAc,cAClB,QAAQ,OAAO,OAAO,MAAM,gBAAgB,yBAAyB,CACtE;IACD,MAAM,cAAc,uBAAuB,KAAK,QAC9C,cAAc,QAAQ,aAAa,IAAI,CAAC,CACzC;AACD,SAAK,MAAM,OAAO,YAChB,QAAO,QAAQ,IAAI,IAAI;AAEzB,WAAO,QAAQ,GAAG,UAAU,OAAO,SAAS;KAC1C,MAAM,cAAc,cAAc,KAAK;AACvC,SAAI,CAAC,YAAY,MAAM,QAAQ,YAAY,WAAW,IAAI,CAAC,CAAE;AAC7D,SAAI,2BAA4B;AAChC,kCAA6B;AAC7B,SAAI;AACF,UAAI,OAAO,aAAa,UACtB,OAAM,OAAO,SAAS;UAEtB,QAAO,GAAG,KAAK,EAAE,MAAM,eAAe,CAAC;eAEjC;AACR,mCAA6B;;MAE/B;;AAGJ,OAAI,OAAQ;GAEZ,MAAM,OAAO,OAAO,OAAO;GAC3B,MAAM,aAAa,cAAc,QAAQ,MAAM,OAAO,CAAC;GACvD,IAAI,iBAAiB;AACrB,GAAK,SAAS,WAAW,CACtB,MAAM,eAAe;AACpB,qBAAiB,cAAc,WAAW;KAC1C,CACD,YAAY,GAEX;AAEJ,UAAO,QAAQ,IAAI,WAAW;AAC9B,2BAAwB,SAAS,WAAW,CAAC,MAAM,SAAS;AAC1D,qBAAiB;KACjB;AACF,UAAO,QAAQ,GAAG,UAAU,OAAO,SAAS;IAC1C,MAAM,cAAc,cAAc,KAAK;AACvC,QAAI,gBAAgB,cAAc,gBAAgB,eAAgB;AAClE,UAAM;IACN,MAAM,WAAW,MAAM,SAAS,WAAW;AAC3C,QAAI,YAAY,aAAa,eAAgB;AAC7C,UAAM,WAAW,QAAQ;AACzB,QAAI,SACF,kBAAiB;AAEnB,WAAO,GAAG,KAAK,EAAE,MAAM,eAAe,CAAC;KACvC;;EAEL"}

package/package.json

@@ -0,0 +1,87 @@
+{
+  "name": "@ptdgrp/typedgql",
+  "version": "1.0.0-beta.8",
+  "description": "Strongly typed GraphQL client code generator and runtime",
+  "type": "module",
+  "author": "tonitrnel",
+  "contributors": [
+    {
+      "name": "ChenTao",
+      "url": "https://github.com/babyfish-ct"
+    }
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/tonitrnel/typedgql"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./index.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./index.ts",
+        "default": "./index.ts"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./vite": {
+      "import": {
+        "types": "./dist/vite.d.mts",
+        "default": "./dist/vite.mjs"
+      },
+      "require": {
+        "types": "./dist/vite.d.cts",
+        "default": "./dist/vite.cjs"
+      }
+    },
+    "./node": {
+      "import": {
+        "types": "./dist/node.d.mts",
+        "default": "./dist/node.mjs"
+      },
+      "require": {
+        "types": "./dist/node.d.cts",
+        "default": "./dist/node.cjs"
+      }
+    }
+  },
+  "files": [
+    "/dist"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "test": "vitest --run",
+    "test:coverage": "vitest --run --coverage"
+  },
+  "peerDependencies": {
+    "graphql": ">=15.0.0",
+    "typescript": ">=5.0.0",
+    "vite": ">=5.0.0"
+  },
+  "peerDependenciesMeta": {
+    "vite": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/node": "^25.3.0",
+    "@vitest/coverage-v8": "^4.0.18",
+    "fast-check": "^4.5.3",
+    "graphql": "^16.0.0",
+    "tsdown": "0.20.3",
+    "typescript": "^5.8.0",
+    "vitest": "^4.0.18"
+  },
+  "dependencies": {
+    "tsd": "^0.33.0"
+  }
+}