nitro-graphql 2.0.0-beta.2 → 2.0.0-beta.20

package/dist/utils/{type-generation.js → type-generation.mjs}

@@ -1,5 +1,7 @@
-import { downloadAndSaveSchema, generateClientTypes, generateExternalClientTypes, loadExternalSchema, loadGraphQLDocuments } from "./client-codegen.js";
-import { generateTypes } from "./server-codegen.js";
+import { downloadAndSaveSchema, generateClientTypes, generateExternalClientTypes, loadExternalSchema, loadGraphQLDocuments } from "./client-codegen.mjs";
+import { writeFileIfNotExists } from "./file-generator.mjs";
+import { getClientUtilsConfig, getDefaultPaths, getSdkConfig, getTypesConfig, resolveFilePath, shouldGenerateClientUtils, shouldGenerateTypes } from "./path-resolver.mjs";
+import { generateTypes } from "./server-codegen.mjs";
 import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
 import consola from "consola";
 import { basename, dirname, join, resolve } from "pathe";
@@ -10,12 +12,16 @@ import { mergeTypeDefs } from "@graphql-tools/merge";
 import { printSchemaWithDirectives } from "@graphql-tools/utils";
 
 //#region src/utils/type-generation.ts
-function generateGraphQLIndexFile(clientDir, externalServices = []) {
-	const indexPath = resolve(clientDir, "index.ts");
+function generateGraphQLIndexFile(nitro, clientDir, externalServices = []) {
+	if (!shouldGenerateClientUtils(nitro)) return;
+	const placeholders = getDefaultPaths(nitro);
+	const clientUtilsConfig = getClientUtilsConfig(nitro);
+	const indexPath = resolveFilePath(clientUtilsConfig.index, clientUtilsConfig.enabled, true, "{clientGraphql}/index.ts", placeholders);
+	if (!indexPath) return;
 	if (!existsSync(indexPath)) {
 		let indexContent = `// This file is auto-generated once by nitro-graphql for quick start
 // You can modify this file according to your needs
-// 
+//
 // Export your main GraphQL service (auto-generated)
 export * from './default/ofetch'
 
@@ -24,23 +30,27 @@ export * from './default/ofetch'
 // export * from './yourServiceName/ofetch'
 `;
 		for (const service of externalServices) indexContent += `export * from './${service.name}/ofetch'\n`;
-		writeFileSync(indexPath, indexContent, "utf-8");
+		writeFileIfNotExists(indexPath, indexContent, "client index.ts");
 	}
 }
-function generateOfetchClient(clientDir, serviceName, endpoint, isDefault = false) {
-	const serviceDir = resolve(clientDir, serviceName);
-	const ofetchPath = resolve(serviceDir, "ofetch.ts");
+function generateNuxtOfetchClient(nitro, clientDir, serviceName = "default") {
+	if (!shouldGenerateClientUtils(nitro)) return;
+	const placeholders = {
+		...getDefaultPaths(nitro),
+		serviceName
+	};
+	const clientUtilsConfig = getClientUtilsConfig(nitro);
+	const ofetchPath = resolveFilePath(clientUtilsConfig.ofetch, clientUtilsConfig.enabled, true, "{clientGraphql}/{serviceName}/ofetch.ts", placeholders);
+	if (!ofetchPath) return;
+	const serviceDir = dirname(ofetchPath);
 	if (!existsSync(serviceDir)) mkdirSync(serviceDir, { recursive: true });
 	if (existsSync(ofetchPath)) return;
-	const capitalizedServiceName = serviceName.charAt(0).toUpperCase() + serviceName.slice(1);
-	const functionName = isDefault ? "createGraphQLClient" : `create${capitalizedServiceName}GraphQLClient`;
-	const exportName = isDefault ? "$sdk" : `$${serviceName}Sdk`;
-	writeFileSync(ofetchPath, `// This file is auto-generated once by nitro-graphql for quick start
+	writeFileIfNotExists(ofetchPath, nitro.options.framework?.name === "nuxt" ? `// This file is auto-generated once by nitro-graphql for quick start
 // You can modify this file according to your needs
-import type { ${isDefault ? "Requester" : "Sdk, Requester"} } from './sdk'
+import type { Requester } from './sdk'
 import { getSdk } from './sdk'
 
-export function ${functionName}(endpoint: string${isDefault ? "" : ` = '${endpoint}'`}): Requester {
+export function createGraphQLClient(endpoint: string): Requester {
   return async <R>(doc: string, vars?: any): Promise<R> => {
     const headers = import.meta.server ? useRequestHeaders() : undefined
 
@@ -57,7 +67,86 @@ export function ${functionName}(endpoint: string${isDefault ? "" : ` = '${endpoi
   }
 }
 
-export const ${exportName}${isDefault ? "" : ": Sdk"} = getSdk(${functionName}(${isDefault ? "'/api/graphql'" : ""}))`, "utf-8");
+export const $sdk = getSdk(createGraphQLClient('/api/graphql'))` : `// This file is auto-generated once by nitro-graphql for quick start
+// You can modify this file according to your needs
+import type { Requester } from './sdk'
+import { ofetch } from 'ofetch'
+import { getSdk } from './sdk'
+
+export function createGraphQLClient(endpoint: string): Requester {
+  return async <R>(doc: string, vars?: any): Promise<R> => {
+    const result = await ofetch(endpoint, {
+      method: 'POST',
+      body: { query: doc, variables: vars },
+      headers: {
+        'Content-Type': 'application/json',
+      },
+    })
+
+    return result as R
+  }
+}
+
+export const $sdk = getSdk(createGraphQLClient('/api/graphql'))`, `${serviceName} ofetch.ts`);
+}
+function generateExternalOfetchClient(nitro, service, endpoint) {
+	if (!shouldGenerateClientUtils(nitro)) return;
+	const serviceName = service.name;
+	const placeholders = {
+		...getDefaultPaths(nitro),
+		serviceName
+	};
+	const clientUtilsConfig = getClientUtilsConfig(nitro);
+	const ofetchPath = resolveFilePath(service.paths?.ofetch ?? clientUtilsConfig.ofetch, clientUtilsConfig.enabled, true, "{clientGraphql}/{serviceName}/ofetch.ts", placeholders);
+	if (!ofetchPath) return;
+	const serviceDir = dirname(ofetchPath);
+	if (!existsSync(serviceDir)) mkdirSync(serviceDir, { recursive: true });
+	if (!existsSync(ofetchPath)) {
+		const capitalizedServiceName = serviceName.charAt(0).toUpperCase() + serviceName.slice(1);
+		writeFileIfNotExists(ofetchPath, nitro.options.framework?.name === "nuxt" ? `// This file is auto-generated once by nitro-graphql for quick start
+// You can modify this file according to your needs
+import type { Sdk, Requester } from './sdk'
+import { getSdk } from './sdk'
+
+export function create${capitalizedServiceName}GraphQLClient(endpoint: string = '${endpoint}'): Requester {
+  return async <R>(doc: string, vars?: any): Promise<R> => {
+    const headers = import.meta.server ? useRequestHeaders() : undefined
+
+    const result = await $fetch(endpoint, {
+      method: 'POST',
+      body: { query: doc, variables: vars },
+      headers: {
+        'Content-Type': 'application/json',
+        ...headers,
+      },
+    })
+
+    return result as R
+  }
+}
+
+export const $${serviceName}Sdk: Sdk = getSdk(create${capitalizedServiceName}GraphQLClient())` : `// This file is auto-generated once by nitro-graphql for quick start
+// You can modify this file according to your needs
+import type { Sdk, Requester } from './sdk'
+import { ofetch } from 'ofetch'
+import { getSdk } from './sdk'
+
+export function create${capitalizedServiceName}GraphQLClient(endpoint: string = '${endpoint}'): Requester {
+  return async <R>(doc: string, vars?: any): Promise<R> => {
+    const result = await ofetch(endpoint, {
+      method: 'POST',
+      body: { query: doc, variables: vars },
+      headers: {
+        'Content-Type': 'application/json',
+      },
+    })
+
+    return result as R
+  }
+}
+
+export const $${serviceName}Sdk: Sdk = getSdk(create${capitalizedServiceName}GraphQLClient())`, `${serviceName} external ofetch.ts`);
+	}
 }
 /**
 * Check for duplicate type definitions using a simpler approach
@@ -151,6 +240,10 @@ function validateNoDuplicateTypes(schemas, schemaStrings) {
 }
 async function serverTypeGeneration(app) {
 	try {
+		if (!shouldGenerateTypes(app)) {
+			consola.debug("[nitro-graphql] Server type generation is disabled");
+			return;
+		}
 		const schemas = app.scanSchemas || [];
 		if (!schemas.length) {
 			consola.info("No GraphQL definitions found for server type generation.");
@@ -170,9 +263,14 @@ async function serverTypeGeneration(app) {
 		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");
+		const placeholders = getDefaultPaths(app);
+		const typesConfig = getTypesConfig(app);
+		const serverTypesPath = resolveFilePath(typesConfig.server, typesConfig.enabled, true, "{typesDir}/nitro-graphql-server.d.ts", placeholders);
+		if (serverTypesPath) {
+			mkdirSync(dirname(serverTypesPath), { recursive: true });
+			writeFileSync(serverTypesPath, data, "utf-8");
+			consola.success(`[nitro-graphql] Generated server types at: ${serverTypesPath}`);
+		}
 	} catch (error) {
 		consola.error("Server schema generation error:", error);
 	}
@@ -225,20 +323,24 @@ async function generateMainClientTypes(nitro) {
 	const graphqlString = readFileSync(schemaFilePath, "utf-8");
 	const types = await generateClientTypes(nitro.options.graphql?.federation?.enabled === true ? buildSubgraphSchema([{ typeDefs: parse(graphqlString) }]) : buildSchema(graphqlString), loadDocs, nitro.options.graphql?.codegen?.client ?? {}, nitro.options.graphql?.codegen?.clientSDK ?? {});
 	if (types === false) return;
-	const clientTypesPath = resolve(nitro.options.buildDir, "types", "nitro-graphql-client.d.ts");
-	const defaultServiceDir = resolve(nitro.graphql.clientDir, "default");
-	const sdkTypesPath = resolve(defaultServiceDir, "sdk.ts");
-	mkdirSync(dirname(clientTypesPath), { recursive: true });
-	writeFileSync(clientTypesPath, types.types, "utf-8");
-	mkdirSync(defaultServiceDir, { recursive: true });
-	let shouldWriteSdk = true;
-	if (existsSync(sdkTypesPath)) shouldWriteSdk = readFileSync(sdkTypesPath, "utf-8") !== types.sdk;
-	if (shouldWriteSdk) writeFileSync(sdkTypesPath, types.sdk, "utf-8");
-	if (nitro.options.framework?.name === "nuxt") {
-		generateOfetchClient(nitro.graphql.clientDir, "default", "/api/graphql", true);
-		const externalServices = nitro.options.graphql?.externalServices || [];
-		generateGraphQLIndexFile(nitro.graphql.clientDir, externalServices);
+	const placeholders = getDefaultPaths(nitro);
+	const typesConfig = getTypesConfig(nitro);
+	const sdkConfig = getSdkConfig(nitro);
+	const clientTypesPath = resolveFilePath(typesConfig.client, typesConfig.enabled, true, "{typesDir}/nitro-graphql-client.d.ts", placeholders);
+	if (clientTypesPath) {
+		mkdirSync(dirname(clientTypesPath), { recursive: true });
+		writeFileSync(clientTypesPath, types.types, "utf-8");
+		consola.success(`[nitro-graphql] Generated client types at: ${clientTypesPath}`);
+	}
+	const sdkPath = resolveFilePath(sdkConfig.main, sdkConfig.enabled, true, "{clientGraphql}/default/sdk.ts", placeholders);
+	if (sdkPath) {
+		mkdirSync(dirname(sdkPath), { recursive: true });
+		writeFileSync(sdkPath, types.sdk, "utf-8");
+		consola.success(`[nitro-graphql] Generated SDK at: ${sdkPath}`);
 	}
+	generateNuxtOfetchClient(nitro, nitro.graphql.clientDir, "default");
+	const externalServices = nitro.options.graphql?.externalServices || [];
+	if (externalServices.length > 0) generateGraphQLIndexFile(nitro, nitro.graphql.clientDir, externalServices);
 }
 async function generateExternalServicesTypes(nitro) {
 	const externalServices = nitro.options.graphql?.externalServices || [];
@@ -267,16 +369,25 @@ async function generateExternalServicesTypes(nitro) {
 			consola.warn(`[graphql:${service.name}] Type generation failed`);
 			continue;
 		}
-		const serviceTypesPath = resolve(nitro.options.buildDir, "types", `nitro-graphql-client-${service.name}.d.ts`);
-		const serviceDir = resolve(nitro.graphql.clientDir, service.name);
-		const serviceSdkPath = resolve(serviceDir, "sdk.ts");
-		mkdirSync(dirname(serviceTypesPath), { recursive: true });
-		writeFileSync(serviceTypesPath, types.types, "utf-8");
-		mkdirSync(serviceDir, { recursive: true });
-		let shouldWriteServiceSdk = true;
-		if (existsSync(serviceSdkPath)) shouldWriteServiceSdk = readFileSync(serviceSdkPath, "utf-8") !== types.sdk;
-		if (shouldWriteServiceSdk) writeFileSync(serviceSdkPath, types.sdk, "utf-8");
-		if (nitro.options.framework?.name === "nuxt") generateOfetchClient(nitro.graphql.clientDir, service.name, service.endpoint, false);
+		const placeholders = {
+			...getDefaultPaths(nitro),
+			serviceName: service.name
+		};
+		const typesConfig = getTypesConfig(nitro);
+		const sdkConfig = getSdkConfig(nitro);
+		const serviceTypesPath = resolveFilePath(service.paths?.types ?? typesConfig.external, typesConfig.enabled, true, "{typesDir}/nitro-graphql-client-{serviceName}.d.ts", placeholders);
+		if (serviceTypesPath) {
+			mkdirSync(dirname(serviceTypesPath), { recursive: true });
+			writeFileSync(serviceTypesPath, types.types, "utf-8");
+			consola.success(`[graphql:${service.name}] Generated types at: ${serviceTypesPath}`);
+		}
+		const serviceSdkPath = resolveFilePath(service.paths?.sdk ?? sdkConfig.external, sdkConfig.enabled, true, "{clientGraphql}/{serviceName}/sdk.ts", placeholders);
+		if (serviceSdkPath) {
+			mkdirSync(dirname(serviceSdkPath), { recursive: true });
+			writeFileSync(serviceSdkPath, types.sdk, "utf-8");
+			consola.success(`[graphql:${service.name}] Generated SDK at: ${serviceSdkPath}`);
+		}
+		generateExternalOfetchClient(nitro, service, service.endpoint);
 		consola.success(`[graphql:${service.name}] External service types generated successfully`);
 	} catch (error) {
 		consola.error(`[graphql:${service.name}] External service generation failed:`, error);

package/dist/virtual/debug-info.d.mts

@@ -0,0 +1,9 @@
+//#region src/virtual/debug-info.d.ts
+/**
+ * Virtual module stub for #nitro-graphql/debug-info
+ * This file is only used during build/bundling to prevent import resolution errors.
+ * At runtime, Nitro will override this with the actual virtual module.
+ */
+declare const debugInfo: Record<string, any>;
+//#endregion
+export { debugInfo };

package/dist/virtual/debug-info.mjs

@@ -0,0 +1,26 @@
+//#region src/virtual/debug-info.ts
+/**
+* Virtual module stub for #nitro-graphql/debug-info
+* This file is only used during build/bundling to prevent import resolution errors.
+* At runtime, Nitro will override this with the actual virtual module.
+*/
+const debugInfo = {
+	isDev: false,
+	framework: "",
+	graphqlFramework: "",
+	federation: {},
+	scanned: {
+		schemas: 0,
+		schemaFiles: [],
+		resolvers: 0,
+		resolverFiles: [],
+		directives: 0,
+		directiveFiles: [],
+		documents: 0,
+		documentFiles: []
+	},
+	virtualModules: {}
+};
+
+//#endregion
+export { debugInfo };

package/dist/virtual/graphql-config.d.mts

@@ -0,0 +1,9 @@
+//#region src/virtual/graphql-config.d.ts
+/**
+ * Virtual module stub for #nitro-graphql/graphql-config
+ * This file is only used during build/bundling to prevent import resolution errors.
+ * At runtime, Nitro will override this with the actual virtual module.
+ */
+declare const importedConfig: {};
+//#endregion
+export { importedConfig };

package/dist/virtual/graphql-config.mjs

@@ -0,0 +1,10 @@
+//#region src/virtual/graphql-config.ts
+/**
+* Virtual module stub for #nitro-graphql/graphql-config
+* This file is only used during build/bundling to prevent import resolution errors.
+* At runtime, Nitro will override this with the actual virtual module.
+*/
+const importedConfig = {};
+
+//#endregion
+export { importedConfig };

package/dist/virtual/module-config.d.mts

@@ -0,0 +1,9 @@
+//#region src/virtual/module-config.d.ts
+/**
+ * Virtual module stub for #nitro-graphql/module-config
+ * This file is only used during build/bundling to prevent import resolution errors.
+ * At runtime, Nitro will override this with the actual virtual module.
+ */
+declare const moduleConfig: Record<string, any>;
+//#endregion
+export { moduleConfig };

package/dist/virtual/module-config.mjs

@@ -0,0 +1,10 @@
+//#region src/virtual/module-config.ts
+/**
+* Virtual module stub for #nitro-graphql/module-config
+* This file is only used during build/bundling to prevent import resolution errors.
+* At runtime, Nitro will override this with the actual virtual module.
+*/
+const moduleConfig = {};
+
+//#endregion
+export { moduleConfig };

package/dist/virtual/server-directives.d.mts

@@ -0,0 +1,11 @@
+//#region src/virtual/server-directives.d.ts
+/**
+ * Virtual module stub for #nitro-graphql/server-directives
+ * This file is only used during build/bundling to prevent import resolution errors.
+ * At runtime, Nitro will override this with the actual virtual module.
+ */
+declare const directives: Array<{
+  directive: any;
+}>;
+//#endregion
+export { directives };

package/dist/virtual/server-directives.mjs

@@ -0,0 +1,10 @@
+//#region src/virtual/server-directives.ts
+/**
+* Virtual module stub for #nitro-graphql/server-directives
+* This file is only used during build/bundling to prevent import resolution errors.
+* At runtime, Nitro will override this with the actual virtual module.
+*/
+const directives = [];
+
+//#endregion
+export { directives };

package/dist/virtual/server-resolvers.d.mts

@@ -0,0 +1,11 @@
+//#region src/virtual/server-resolvers.d.ts
+/**
+ * Virtual module stub for #nitro-graphql/server-resolvers
+ * This file is only used during build/bundling to prevent import resolution errors.
+ * At runtime, Nitro will override this with the actual virtual module.
+ */
+declare const resolvers: Array<{
+  resolver: any;
+}>;
+//#endregion
+export { resolvers };

package/dist/virtual/server-resolvers.mjs

@@ -0,0 +1,10 @@
+//#region src/virtual/server-resolvers.ts
+/**
+* Virtual module stub for #nitro-graphql/server-resolvers
+* This file is only used during build/bundling to prevent import resolution errors.
+* At runtime, Nitro will override this with the actual virtual module.
+*/
+const resolvers = [];
+
+//#endregion
+export { resolvers };

package/dist/virtual/server-schemas.d.mts

@@ -0,0 +1,11 @@
+//#region src/virtual/server-schemas.d.ts
+/**
+ * Virtual module stub for #nitro-graphql/server-schemas
+ * This file is only used during build/bundling to prevent import resolution errors.
+ * At runtime, Nitro will override this with the actual virtual module.
+ */
+declare const schemas: Array<{
+  def: string;
+}>;
+//#endregion
+export { schemas };

package/dist/virtual/server-schemas.mjs

@@ -0,0 +1,10 @@
+//#region src/virtual/server-schemas.ts
+/**
+* Virtual module stub for #nitro-graphql/server-schemas
+* This file is only used during build/bundling to prevent import resolution errors.
+* At runtime, Nitro will override this with the actual virtual module.
+*/
+const schemas = [];
+
+//#endregion
+export { schemas };

package/dist/vite.d.mts

@@ -0,0 +1,27 @@
+import { NitroGraphQLOptions } from "./types/index.mjs";
+import { Plugin } from "vite";
+
+//#region src/vite.d.ts
+
+/**
+ * Vite plugin to load GraphQL files as strings AND auto-register Nitro module
+ * This prevents Vite from trying to parse .graphql/.gql files as JavaScript
+ * and automatically sets up the nitro-graphql module via the nitro: hook
+ *
+ * @example
+ * ```ts
+ * import { defineConfig } from 'vite'
+ * import { nitro } from 'nitro/vite'
+ * import { graphql } from 'nitro-graphql/vite'
+ *
+ * export default defineConfig({
+ *   plugins: [
+ *     graphql({ framework: 'graphql-yoga' }), // Auto-registers Nitro module
+ *     nitro()
+ *   ]
+ * })
+ * ```
+ */
+declare function graphql(options?: NitroGraphQLOptions): Plugin;
+//#endregion
+export { graphql };

package/dist/vite.mjs

@@ -0,0 +1,49 @@
+import { setupNitroGraphQL } from "./setup.mjs";
+import defu from "defu";
+import { readFile } from "node:fs/promises";
+
+//#region src/vite.ts
+/**
+* Vite plugin to load GraphQL files as strings AND auto-register Nitro module
+* This prevents Vite from trying to parse .graphql/.gql files as JavaScript
+* and automatically sets up the nitro-graphql module via the nitro: hook
+*
+* @example
+* ```ts
+* import { defineConfig } from 'vite'
+* import { nitro } from 'nitro/vite'
+* import { graphql } from 'nitro-graphql/vite'
+*
+* export default defineConfig({
+*   plugins: [
+*     graphql({ framework: 'graphql-yoga' }), // Auto-registers Nitro module
+*     nitro()
+*   ]
+* })
+* ```
+*/
+function graphql(options) {
+	return {
+		name: "nitro-graphql:vite",
+		enforce: "pre",
+		async load(id) {
+			if (!/\.(?:graphql|gql)$/i.test(id)) return null;
+			try {
+				const content = await readFile(id, "utf-8");
+				return `export default ${JSON.stringify(content)}`;
+			} catch (error) {
+				if (error && typeof error === "object" && "code" in error && error.code === "ENOENT") return null;
+				throw error;
+			}
+		},
+		nitro: { async setup(nitro) {
+			if (options) nitro.options.graphql = defu(nitro.options.graphql || {}, options);
+			nitro.options.graphql = nitro.options.graphql || {};
+			nitro.options.graphql._vitePlugin = true;
+			await setupNitroGraphQL(nitro);
+		} }
+	};
+}
+
+//#endregion
+export { graphql };