npm - nitro-graphql - Versions diffs - 0.0.3 → 0.0.5 - Mend

nitro-graphql 0.0.3 → 0.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (157) hide show

package/dist/routes/graphql.d.ts ADDED Viewed

@@ -0,0 +1,6 @@
+import * as h36 from "h3";
+//#region src/routes/graphql.d.ts
+declare const _default: h36.EventHandler<h36.EventHandlerRequest, Promise<void>>;
+//#endregion
+export { _default as default };

package/dist/routes/graphql.js ADDED Viewed

@@ -0,0 +1,54 @@
+import { createSchema, createYoga } from "graphql-yoga";
+import { mergeResolvers, mergeTypeDefs } from "@graphql-tools/merge";
+import { defs } from "#nitro-internal-virtual/server-defs";
+import { resolvers } from "#nitro-internal-virtual/server-resolvers";
+import { defineEventHandler } from "h3";
+//#region src/routes/graphql.ts
+const apolloSandboxHtml = `<!DOCTYPE html>
+<html lang="en">
+<body style="margin: 0; overflow-x: hidden; overflow-y: hidden">
+<div id="sandbox" style="height:100vh; width:100vw;"></div>
+<script src="https://embeddable-sandbox.cdn.apollographql.com/02e2da0fccbe0240ef03d2396d6c98559bab5b06/embeddable-sandbox.umd.production.min.js"><\/script>
+<script>
+new window.EmbeddedSandbox({
+  target: "#sandbox",
+  initialEndpoint: window.location.href,
+  hideCookieToggle: false,
+  initialState: {
+    includeCookies: true
+  }
+});
+<\/script>
+</body>
+</html>`;
+function createMergedSchema() {
+	try {
+		const mergedDefs = defs.map((schema) => schema.def).join("\n\n");
+		const typeDefs = mergeTypeDefs([mergedDefs]);
+		const mergedResolvers = mergeResolvers(resolvers.map((r) => r.resolver));
+		return createSchema({
+			typeDefs,
+			resolvers: mergedResolvers
+		});
+	} catch (error) {
+		console.error("Schema merge error:", error);
+		throw error;
+	}
+}
+let yoga;
+var graphql_default = defineEventHandler(async (event) => {
+	if (!yoga) {
+		const schema = createMergedSchema();
+		yoga = createYoga({
+			schema,
+			graphqlEndpoint: "/api/graphql",
+			landingPage: false,
+			renderGraphiQL: () => apolloSandboxHtml
+		});
+	}
+	return yoga.handle(event.node.req, event.node.res);
+});
+//#endregion
+export { graphql_default as default };

package/dist/types.d.ts CHANGED Viewed

@@ -1,9 +1,34 @@
 import { TypeScriptPluginConfig } from "@graphql-codegen/typescript";
+import { TypeScriptResolversPluginConfig } from "@graphql-codegen/typescript-resolvers";
+import { IResolvers } from "@graphql-tools/utils";
 import { TypeScriptDocumentsPluginConfig } from "@graphql-codegen/typescript-operations";
 import { YogaServerOptions } from "graphql-yoga";
 import { IncomingMessage, ServerResponse } from "node:http";
 //#region src/types.d.ts
+type CodegenServerConfig = TypeScriptPluginConfig & TypeScriptResolversPluginConfig;
+declare module 'nitropack/types' {
+  interface Nitro {
+    scanDefs: string[];
+    scanResolvers: any;
+    graphql: {
+      buildDir: string;
+      watchDirs: string[];
+      clientDir: string;
+    };
+  }
+}
+declare module 'nitropack' {
+  interface NitroOptions {
+    graphql?: NitroGraphQLOptions;
+  }
+  interface NitroRuntimeConfig {
+    graphql?: NitroGraphQLOptions;
+  }
+  interface NitroConfig {
+    graphql?: NitroGraphQLOptions;
+  }
+}
 interface GraphQLSchemaConfig {
   typeDefs: string | string[];
   resolvers: any;
@@ -20,19 +45,29 @@ interface NitroGraphQLOptions {
     req: IncomingMessage;
     res: ServerResponse;
   }, any>['cors'];
+  typedefs?: string[];
+  resolvers?: Array<IResolvers<any, any>>;
+  loader?: {
+    include?: RegExp;
+    exclude?: RegExp;
+    validate?: boolean;
+  };
   cacheHeaders?: {
     enabled?: boolean;
     maxAge?: number;
   };
+  codegen?: {
+    server?: CodegenServerConfig;
+    client?: CodegenClientConfig;
+  };
   client?: {
     enabled?: boolean;
     outputPath?: string;
     watchPatterns?: string[];
     nuxtPatterns?: string[];
-    config?: CodegenClientConfig;
   };
   yogaConfig?: Partial<YogaServerOptions<any, any>>;
 }
 interface Resolvers {}
 //#endregion
-export { CodegenClientConfig, GraphQLSchemaConfig, NitroGraphQLOptions, Resolvers };
+export { CodegenClientConfig, CodegenServerConfig, GraphQLSchemaConfig, NitroGraphQLOptions, Resolvers };

package/dist/utils/index.d.ts ADDED Viewed

@@ -0,0 +1,21 @@
+import { Nitro } from "nitropack";
+import { YogaServerOptions } from "graphql-yoga";
+import { GraphQLSchemaConfig, Resolvers } from "nitro-graphql/types";
+//#region src/utils/index.d.ts
+declare const GLOB_SCAN_PATTERN = "**/*.{graphql,gql,js,mjs,cjs,ts,mts,cts,tsx,jsx}";
+declare function defineGraphQLSchema(config: GraphQLSchemaConfig): GraphQLSchemaConfig;
+declare function defineResolver(resolvers: Resolvers): Resolvers;
+/**
+ * Helper function to define GraphQL Yoga configuration with type safety
+ */
+declare function defineYogaConfig<TServerContext = any, TUserContext = any>(config: Partial<YogaServerOptions<TServerContext, TUserContext>>): Partial<YogaServerOptions<TServerContext, TUserContext>>;
+declare function relativeWithDot(from: string, to: string): string;
+declare function scanGraphql(nitro: Nitro): Promise<string[]>;
+declare function scanResolvers(nitro: Nitro): Promise<string[]>;
+declare function scanDirectives(nitro: Nitro): Promise<string[]>;
+declare function scanTypeDefs(nitro: Nitro): Promise<string[]>;
+declare function scanDefs(nitro: Nitro): Promise<string[]>;
+declare function unique(arr: any[]): any[];
+//#endregion
+export { GLOB_SCAN_PATTERN, defineGraphQLSchema, defineResolver, defineYogaConfig, relativeWithDot, scanDefs, scanDirectives, scanGraphql, scanResolvers, scanTypeDefs, unique };

package/dist/utils/index.js ADDED Viewed

@@ -0,0 +1,72 @@
+import { join, relative } from "pathe";
+import { glob } from "tinyglobby";
+//#region src/utils/index.ts
+const GLOB_SCAN_PATTERN = "**/*.{graphql,gql,js,mjs,cjs,ts,mts,cts,tsx,jsx}";
+function defineGraphQLSchema(config) {
+	return config;
+}
+function defineResolver(resolvers) {
+	return resolvers;
+}
+/**
+* Helper function to define GraphQL Yoga configuration with type safety
+*/
+function defineYogaConfig(config) {
+	return config;
+}
+const RELATIVE_RE = /^\.{1,2}\//;
+function relativeWithDot(from, to) {
+	const rel = relative(from, to);
+	return RELATIVE_RE.test(rel) ? rel : `./${rel}`;
+}
+async function scanGraphql(nitro) {
+	const files = await scanFiles(nitro, "graphql");
+	return files.map((f) => f.fullPath);
+}
+async function scanResolvers(nitro) {
+	const files = await scanFiles(nitro, "graphql", "**/*.resolver.{ts,js}");
+	return files.map((f) => f.fullPath);
+}
+async function scanDirectives(nitro) {
+	const files = await scanFiles(nitro, "graphql", "**/*.directive.{ts,js}");
+	return files.map((f) => f.fullPath);
+}
+async function scanTypeDefs(nitro) {
+	const files = await scanFiles(nitro, "graphql", "**/*.typedef.{ts,js}");
+	return files.map((f) => f.fullPath);
+}
+async function scanDefs(nitro) {
+	const files = await scanFiles(nitro, "graphql", "**/*.graphql");
+	return files.map((f) => f.fullPath);
+}
+async function scanFiles(nitro, name, globPattern = GLOB_SCAN_PATTERN) {
+	const files = await Promise.all(nitro.options.scanDirs.map((dir) => scanDir(nitro, dir, name, globPattern))).then((r) => r.flat());
+	return files;
+}
+async function scanDir(nitro, dir, name, globPattern = GLOB_SCAN_PATTERN) {
+	const fileNames = await glob(join(name, globPattern), {
+		cwd: dir,
+		dot: true,
+		ignore: nitro.options.ignore,
+		absolute: true
+	}).catch((error) => {
+		if (error?.code === "ENOTDIR") {
+			nitro.logger.warn(`Ignoring \`${join(dir, name)}\`. It must be a directory.`);
+			return [];
+		}
+		throw error;
+	});
+	return fileNames.map((fullPath) => {
+		return {
+			fullPath,
+			path: relative(join(dir, name), fullPath)
+		};
+	}).sort((a, b) => a.path.localeCompare(b.path));
+}
+function unique(arr) {
+	return [...new Set(arr)];
+}
+//#endregion
+export { GLOB_SCAN_PATTERN, defineGraphQLSchema, defineResolver, defineYogaConfig, relativeWithDot, scanDefs, scanDirectives, scanGraphql, scanResolvers, scanTypeDefs, unique };

package/dist/utils/server-type-generation.js ADDED Viewed

@@ -0,0 +1,52 @@
+import { generateTypes } from "../codegen.js";
+import { generateClientTypes, loadGraphQLDocuments } from "../client-codegen.js";
+import { printSchemaWithDirectives } from "@graphql-tools/utils";
+import consola from "consola";
+import { buildASTSchema, buildSchema } from "graphql";
+import { mkdirSync, readFileSync, writeFileSync } from "node:fs";
+import { dirname, join, resolve } from "pathe";
+import { loadFilesSync } from "@graphql-tools/load-files";
+import { mergeTypeDefs } from "@graphql-tools/merge";
+//#region src/utils/server-type-generation.ts
+async function serverTypeGeneration(app) {
+	try {
+		const defs = app.scanDefs || [];
+		const loadDefs = loadFilesSync(defs);
+		const mergedDefs = mergeTypeDefs(loadDefs);
+		const schema = buildASTSchema(mergedDefs, {
+			assumeValidSDL: true,
+			assumeValid: true
+		});
+		const data = await generateTypes(schema, app.options.graphql?.codegen?.server ?? {});
+		const printSchema = printSchemaWithDirectives(schema);
+		const schemaPath = resolve(app.graphql.buildDir, "schema.graphql");
+		mkdirSync(dirname(schemaPath), { recursive: true });
+		writeFileSync(schemaPath, printSchema, "utf-8");
+		const serverTypesPath = resolve(app.options.buildDir, "types", "nitro-graphql-server.d.ts");
+		mkdirSync(dirname(serverTypesPath), { recursive: true });
+		writeFileSync(serverTypesPath, data, "utf-8");
+	} catch (error) {
+		consola.error("Server schema generation error:", error);
+	}
+}
+async function clientTypeGeneration(app, path) {
+	try {
+		const root = app.graphql.watchDirs.find((dir) => path.startsWith(dir)) || path;
+		if (!root) return;
+		const docs = await loadGraphQLDocuments(root);
+		const graphqlString = readFileSync(join(app.graphql.buildDir, "schema.graphql"), "utf-8");
+		const schema = buildSchema(graphqlString);
+		const types = await generateClientTypes(schema, docs);
+		if (types === false) return;
+		const clientTypesPath = resolve(app.options.buildDir, "types", "nitro-graphql-client.d.ts");
+		const sdkTypesPath = resolve(app.graphql.clientDir, "sdk.ts");
+		writeFileSync(clientTypesPath, types.types, "utf-8");
+		writeFileSync(sdkTypesPath, types.sdk, "utf-8");
+	} catch (error) {
+		consola.error("Client schema generation error:", error);
+	}
+}
+//#endregion
+export { clientTypeGeneration, serverTypeGeneration };

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "nitro-graphql",
   "type": "module",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "GraphQL integration for Nitro",
   "license": "MIT",
   "sideEffects": false,
@@ -27,25 +27,34 @@
       "import": "./dist/context.js"
     },
     "./utils": {
-      "types": "./dist/utils.d.ts",
-      "import": "./dist/utils.js"
+      "types": "./dist/utils/index.d.ts",
+      "import": "./dist/utils/index.js"
     },
     "./types": {
       "types": "./dist/types.d.ts",
       "import": "./dist/types.js"
+    },
+    "./internal": {
+      "types": "./dist/internal/index.d.ts",
+      "import": "./dist/internal/index.js"
+    },
+    "./nuxt": {
+      "types": "./dist/ecosystem/nuxt.d.ts",
+      "import": "./dist/ecosystem/nuxt.js"
     }
   },
   "main": "./dist/index.js",
+  "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
     "dist"
   ],
   "peerDependencies": {
+    "graphql": "^16.11.0",
     "nitropack": "^2.11.13"
   },
   "dependencies": {
     "@graphql-codegen/core": "^4.0.2",
-    "@graphql-codegen/plugin-helpers": "^5.1.1",
     "@graphql-codegen/typescript": "^4.1.6",
     "@graphql-codegen/typescript-generic-sdk": "^4.0.2",
     "@graphql-codegen/typescript-operations": "^4.6.1",
@@ -59,19 +68,22 @@
     "chokidar": "^4.0.3",
     "consola": "^3.4.2",
     "defu": "^6.1.4",
-    "graphql": "^16.11.0",
     "graphql-scalars": "^1.24.2",
-    "graphql-yoga": "^5.14.0",
+    "graphql-yoga": "^5.15.1",
+    "ohash": "^2.0.11",
     "pathe": "^2.0.3",
-    "perfect-debounce": "^1.0.0",
     "tinyglobby": "^0.2.14"
   },
   "devDependencies": {
     "@antfu/eslint-config": "^4.16.2",
+    "@graphql-codegen/import-types-preset": "^3.0.1",
+    "@nuxt/kit": "4.0.0-rc.0",
+    "@nuxt/schema": "4.0.0-rc.0",
     "@types/node": "^20.19.7",
     "bumpp": "^10.2.0",
     "changelogen": "^0.6.2",
-    "eslint": "^9.30.1",
+    "eslint": "^9.31.0",
+    "graphql": "^16.11.0",
     "h3": "^1.15.3",
     "nitropack": "^2.11.13",
     "tsdown": "^0.12.9",

package/dist/client-watcher.d.ts DELETED Viewed

@@ -1,7 +0,0 @@
-import { NitroGraphQLOptions } from "./types.js";
-import { Nitro } from "nitropack/types";
-//#region src/client-watcher.d.ts
-declare function setupClientWatcher(nitro: Nitro, options: NitroGraphQLOptions): Promise<void>;
-//#endregion
-export { setupClientWatcher };

package/dist/client-watcher.js DELETED Viewed

@@ -1,100 +0,0 @@
-import { scanGraphQLFiles } from "./scanner.js";
-import { mkdir, writeFile } from "node:fs/promises";
-import { mergeTypeDefs } from "@graphql-tools/merge";
-import { makeExecutableSchema } from "@graphql-tools/schema";
-import { consola } from "consola";
-import { join } from "pathe";
-import { debounce } from "perfect-debounce";
-//#region src/client-watcher.ts
-const logger = consola.withTag("graphql");
-async function regenerateClientTypes(nitro, options) {
-	try {
-		if (!options.client?.enabled) return;
-		const scanResult = await scanGraphQLFiles(nitro);
-		if (scanResult.typeDefs.length === 0) {
-			logger.warn("⚠️  No server schema found for client type generation");
-			return;
-		}
-		const mergedTypeDefs = mergeTypeDefs(scanResult.typeDefs);
-		const schema = makeExecutableSchema({
-			typeDefs: mergedTypeDefs,
-			resolvers: {}
-		});
-		const getClientPatterns = () => {
-			if (options.client?.watchPatterns) return options.client.watchPatterns;
-			const basePatterns = [
-				join(nitro.options.srcDir, "**/*.graphql"),
-				join(nitro.options.srcDir, "**/*.gql"),
-				`!${join(nitro.options.srcDir, "graphql/**/*")}`
-			];
-			if (nitro.options.framework?.name === "nuxt") if (options.client?.nuxtPatterns) basePatterns.unshift(...options.client.nuxtPatterns);
-			else basePatterns.unshift(join(nitro.options.srcDir, "app/graphql/**/*.graphql"), join(nitro.options.srcDir, "app/graphql/**/*.gql"));
-			return basePatterns;
-		};
-		const clientPatterns = getClientPatterns();
-		const { generateClientTypes } = await import("./client-codegen.js");
-		const generatedTypes = await generateClientTypes(schema, clientPatterns, options.client.config, options.client.outputPath);
-		if (generatedTypes) {
-			const outputPath = options.client.outputPath || join(nitro.options.buildDir, "types", "graphql-client.generated.ts");
-			const typesDir = join(nitro.options.buildDir, "types");
-			await mkdir(typesDir, { recursive: true });
-			await writeFile(outputPath, generatedTypes);
-			logger.success("✨ Client types updated");
-		}
-	} catch (error) {
-		const errorMessage = error instanceof Error ? error.message : String(error);
-		logger.error("❌ Client type generation failed:", errorMessage);
-	}
-}
-async function setupClientWatcher(nitro, options) {
-	if (!options.client?.enabled) {
-		logger.info("🚫 Client type generation disabled");
-		return;
-	}
-	const getClientPatterns = () => {
-		if (options.client?.watchPatterns) return options.client.watchPatterns;
-		const basePatterns = [join(nitro.options.srcDir, "**/*.graphql"), join(nitro.options.srcDir, "**/*.gql")];
-		if (nitro.options.framework?.name === "nuxt") if (options.client?.nuxtPatterns) basePatterns.unshift(...options.client.nuxtPatterns);
-		else basePatterns.unshift(join(nitro.options.srcDir, "app/graphql/**/*.graphql"), join(nitro.options.srcDir, "app/graphql/**/*.gql"));
-		return basePatterns;
-	};
-	const clientPatterns = getClientPatterns();
-	const generateClientTypesDebounced = debounce(async () => {
-		await regenerateClientTypes(nitro, options);
-	}, 300);
-	const { watch } = await import("chokidar");
-	const watcher = watch(clientPatterns, {
-		persistent: true,
-		ignoreInitial: true,
-		ignored: [/(^|[/\\])\.\.\./, join(nitro.options.srcDir, "graphql/**/*")],
-		followSymlinks: false,
-		usePolling: true,
-		interval: 500,
-		binaryInterval: 500
-	});
-	watcher.on("add", (path) => {
-		logger.info(`📁 Client file added: ${path}`);
-		generateClientTypesDebounced();
-	});
-	watcher.on("change", (path) => {
-		logger.info(`📝 Client file changed: ${path}`);
-		generateClientTypesDebounced();
-	});
-	watcher.on("unlink", (path) => {
-		logger.info(`🗑️ Client file removed: ${path}`);
-		generateClientTypesDebounced();
-	});
-	watcher.on("error", (error) => {
-		logger.error("❌ Client watcher error:", error);
-	});
-	nitro.hooks.hook("close", () => {
-		logger.info("🔒 Closing client watcher");
-		watcher.close();
-	});
-	await regenerateClientTypes(nitro, options);
-	logger.success("✅ Client watcher ready");
-}
-//#endregion
-export { setupClientWatcher };

package/dist/dev.js DELETED Viewed

@@ -1,95 +0,0 @@
-import { scanGraphQLFiles } from "./scanner.js";
-import { setupClientWatcher } from "./client-watcher.js";
-import { generateTypes } from "./codegen.js";
-import { mkdir, writeFile } from "node:fs/promises";
-import { mergeTypeDefs } from "@graphql-tools/merge";
-import { makeExecutableSchema } from "@graphql-tools/schema";
-import { consola } from "consola";
-import { join } from "pathe";
-import { debounce } from "perfect-debounce";
-import { existsSync } from "node:fs";
-import { watch } from "chokidar";
-//#region src/dev.ts
-const logger = consola.withTag("graphql");
-async function regenerateGraphQLTypes(nitro) {
-	try {
-		const scanResult = await scanGraphQLFiles(nitro);
-		if (scanResult.typeDefs.length === 0) {
-			logger.warn("⚠️  No schema files found");
-			return;
-		}
-		const mergedTypeDefs = mergeTypeDefs(scanResult.typeDefs);
-		const schema = makeExecutableSchema({
-			typeDefs: mergedTypeDefs,
-			resolvers: {}
-		});
-		const generatedTypes = await generateTypes(schema);
-		const outputPath = join(nitro.options.buildDir, "types", "graphql-types.generated.ts");
-		const typesDir = join(nitro.options.buildDir, "types");
-		await mkdir(typesDir, { recursive: true });
-		await writeFile(outputPath, generatedTypes);
-		logger.success("✨ Types regenerated");
-	} catch (error) {
-		const errorMessage = error instanceof Error ? error.message : String(error);
-		logger.error("❌ Type generation failed:", errorMessage);
-	}
-}
-function devmode(nitro, options) {
-	if (nitro.options.dev) {
-		const generateTypesDebounced = debounce(async () => {
-			await regenerateGraphQLTypes(nitro);
-		}, 100);
-		const graphqlDir = join(nitro.options.srcDir, "graphql");
-		logger.info("🔍 Setting up independent GraphQL watcher for directory:", graphqlDir);
-		try {
-			if (!existsSync(graphqlDir)) {
-				logger.warn(`⚠️ GraphQL directory not found: ${graphqlDir}`);
-				return;
-			}
-		} catch (error) {
-			logger.warn("⚠️ Could not check GraphQL directory:", error);
-			return;
-		}
-		const graphqlWatcher = watch(graphqlDir, {
-			ignoreInitial: true,
-			persistent: true,
-			usePolling: true,
-			interval: 500,
-			depth: 10
-		});
-		graphqlWatcher.on("add", (path) => {
-			logger.info("📁 GraphQL file added:", path);
-			generateTypesDebounced();
-		});
-		graphqlWatcher.on("change", (path) => {
-			logger.info("📝 GraphQL file changed:", path);
-			generateTypesDebounced();
-		});
-		graphqlWatcher.on("unlink", (path) => {
-			logger.info("🗑️ GraphQL file deleted:", path);
-			generateTypesDebounced();
-		});
-		graphqlWatcher.on("error", (error) => {
-			logger.error("❌ GraphQL watcher error:", error);
-		});
-		graphqlWatcher.on("raw", (event, path) => {
-			if (event === "change" && path && path.endsWith("graphql")) {
-				logger.info("📝 GraphQL directory change detected, regenerating types");
-				generateTypesDebounced();
-			}
-		});
-		graphqlWatcher.on("ready", () => {
-			logger.success("✅ GraphQL file watcher ready");
-		});
-		nitro.hooks.hook("close", async () => {
-			await graphqlWatcher.close();
-			logger.info("🔒 GraphQL watcher closed");
-		});
-		setupClientWatcher(nitro, options);
-		logger.success("✅ Independent GraphQL watcher set up");
-	}
-}
-//#endregion
-export { devmode };