nitro-graphql 1.5.1 → 1.5.2

package/README.md

@@ -1,17 +1,20 @@
-# Nitro GraphQL
-
 <div align="center">
 
+<img src="./.docs/public/logo.svg" alt="Nitro GraphQL Logo" width="120" height="120">
+
+# Nitro GraphQL
+
 [![npm version][npm-version-src]][npm-version-href]
 [![npm downloads][npm-downloads-src]][npm-downloads-href]
 [![bundle][bundle-src]][bundle-href]
 [![License][license-src]][license-href]
+[![Documentation][docs-src]][docs-href]
 
 **The easiest way to add GraphQL to any Nitro application**
 
 🚀 **Auto-discovery** • 📝 **Type Generation** • 🎮 **Apollo Sandbox** • 🔧 **Zero Config**
 
-[Quick Start](#-quick-start) • [Examples](#-examples) • [Documentation](#-documentation) • [Community](#-community)
+[📚 Documentation](https://nitro-graphql.pages.dev) • [Quick Start](#-quick-start) • [Examples](#-examples) • [Community](#-community)
 
 </div>
 
@@ -1215,4 +1218,6 @@ pnpm lint
 [bundle-src]: https://deno.bundlejs.com/badge?q=nitro-graphql@0.0.4
 [bundle-href]: https://deno.bundlejs.com/badge?q=nitro-graphql@0.0.4
 [license-src]: https://img.shields.io/github/license/productdevbook/nitro-graphql.svg?style=flat&colorA=080f12&colorB=1fa669
-[license-href]: https://github.com/productdevbook/nitro-graphql/blob/main/LICENSE
+[license-href]: https://github.com/productdevbook/nitro-graphql/blob/main/LICENSE
+[docs-src]: https://img.shields.io/badge/docs-read-blue?style=flat&colorA=080f12&colorB=1fa669
+[docs-href]: https://nitro-graphql.pages.dev

package/dist/index.js

@@ -1,7 +1,7 @@
 import { generateDirectiveSchemas } from "./utils/directive-parser.js";
 import { generateLayerIgnorePatterns, getLayerAppDirectories, getLayerServerDirectories, relativeWithDot, scanDirectives, scanDocs, scanResolvers, scanSchemas, validateExternalServices } from "./utils/index.js";
 import { writeFileIfNotExists } from "./utils/file-generator.js";
-import { getDefaultPaths, getScaffoldConfig, resolveFilePath, shouldGenerateScaffold } from "./utils/path-resolver.js";
+import { getDefaultPaths, getScaffoldConfig, getTypesConfig, resolveFilePath, shouldGenerateScaffold } from "./utils/path-resolver.js";
 import { clientTypeGeneration, serverTypeGeneration } from "./utils/type-generation.js";
 import { rollupConfig } from "./rollup.js";
 import { existsSync, mkdirSync } from "node:fs";
@@ -99,7 +99,6 @@ var src_default = defineNitroModule({
 			watcher.close();
 		});
 		const tsconfigDir = dirname(resolve(nitro.options.buildDir, nitro.options.typescript.tsconfigPath));
-		const typesDir = resolve(nitro.options.buildDir, "types");
 		nitro.scanSchemas = await scanSchemas(nitro);
 		nitro.scanDocuments = await scanDocs(nitro);
 		nitro.scanResolvers = await scanResolvers(nitro);
@@ -226,13 +225,33 @@ var src_default = defineNitroModule({
 			types.tsConfig ||= {};
 			types.tsConfig.compilerOptions ??= {};
 			types.tsConfig.compilerOptions.paths ??= {};
-			types.tsConfig.compilerOptions.paths["#graphql/server"] = [relativeWithDot(tsconfigDir, join(typesDir, "nitro-graphql-server.d.ts"))];
-			types.tsConfig.compilerOptions.paths["#graphql/client"] = [relativeWithDot(tsconfigDir, join(typesDir, "nitro-graphql-client.d.ts"))];
+			const placeholders = getDefaultPaths(nitro);
+			const typesConfig = getTypesConfig(nitro);
+			const serverTypesPath = resolveFilePath(typesConfig.server, typesConfig.enabled, true, "{typesDir}/nitro-graphql-server.d.ts", placeholders);
+			if (serverTypesPath) types.tsConfig.compilerOptions.paths["#graphql/server"] = [relativeWithDot(tsconfigDir, serverTypesPath)];
+			const clientTypesPath = resolveFilePath(typesConfig.client, typesConfig.enabled, true, "{typesDir}/nitro-graphql-client.d.ts", placeholders);
+			if (clientTypesPath) types.tsConfig.compilerOptions.paths["#graphql/client"] = [relativeWithDot(tsconfigDir, clientTypesPath)];
 			types.tsConfig.compilerOptions.paths["#graphql/schema"] = [relativeWithDot(tsconfigDir, join(nitro.graphql.serverDir, "schema.ts"))];
-			if (nitro.options.graphql?.externalServices?.length) for (const service of nitro.options.graphql.externalServices) types.tsConfig.compilerOptions.paths[`#graphql/client/${service.name}`] = [relativeWithDot(tsconfigDir, join(typesDir, `nitro-graphql-client-${service.name}.d.ts`))];
+			if (nitro.options.graphql?.externalServices?.length) for (const service of nitro.options.graphql.externalServices) {
+				const servicePlaceholders = {
+					...placeholders,
+					serviceName: service.name
+				};
+				const externalTypesPath = resolveFilePath(service.paths?.types ?? typesConfig.external, typesConfig.enabled, true, "{typesDir}/nitro-graphql-client-{serviceName}.d.ts", servicePlaceholders);
+				if (externalTypesPath) types.tsConfig.compilerOptions.paths[`#graphql/client/${service.name}`] = [relativeWithDot(tsconfigDir, externalTypesPath)];
+			}
 			types.tsConfig.include = types.tsConfig.include || [];
-			types.tsConfig.include.push(relativeWithDot(tsconfigDir, join(typesDir, "nitro-graphql-server.d.ts")), relativeWithDot(tsconfigDir, join(typesDir, "nitro-graphql-client.d.ts")), relativeWithDot(tsconfigDir, join(typesDir, "graphql.d.ts")));
-			if (nitro.options.graphql?.externalServices?.length) for (const service of nitro.options.graphql.externalServices) types.tsConfig.include.push(relativeWithDot(tsconfigDir, join(typesDir, `nitro-graphql-client-${service.name}.d.ts`)));
+			if (serverTypesPath) types.tsConfig.include.push(relativeWithDot(tsconfigDir, serverTypesPath));
+			if (clientTypesPath) types.tsConfig.include.push(relativeWithDot(tsconfigDir, clientTypesPath));
+			types.tsConfig.include.push(relativeWithDot(tsconfigDir, join(placeholders.typesDir, "graphql.d.ts")));
+			if (nitro.options.graphql?.externalServices?.length) for (const service of nitro.options.graphql.externalServices) {
+				const servicePlaceholders = {
+					...placeholders,
+					serviceName: service.name
+				};
+				const externalTypesPath = resolveFilePath(service.paths?.types ?? typesConfig.external, typesConfig.enabled, true, "{typesDir}/nitro-graphql-client-{serviceName}.d.ts", servicePlaceholders);
+				if (externalTypesPath) types.tsConfig.include.push(relativeWithDot(tsconfigDir, externalTypesPath));
+			}
 		});
 		if (nitro.options.framework?.name === "nuxt" && nitro.options.graphql?.externalServices?.length) nitro.hooks.hook("build:before", () => {
 			const nuxtOptions = nitro._nuxt?.options;

package/dist/routes/apollo-server.d.ts

@@ -1,6 +1,6 @@
-import * as h35 from "h3";
+import * as h33 from "h3";
 
 //#region src/routes/apollo-server.d.ts
-declare const _default: h35.EventHandler<h35.EventHandlerRequest, Promise<any>>;
+declare const _default: h33.EventHandler<h33.EventHandlerRequest, Promise<any>>;
 //#endregion
 export { _default as default };

package/dist/routes/debug.d.ts

@@ -1,4 +1,4 @@
-import * as h31 from "h3";
+import * as h30 from "h3";
 
 //#region src/routes/debug.d.ts
 
@@ -10,7 +10,7 @@ import * as h31 from "h3";
  * - /_nitro/graphql/debug - HTML dashboard
  * - /_nitro/graphql/debug?format=json - JSON API
  */
-declare const _default: h31.EventHandler<h31.EventHandlerRequest, Promise<string | {
+declare const _default: h30.EventHandler<h30.EventHandlerRequest, Promise<string | {
   timestamp: string;
   environment: {
     dev: any;

package/dist/routes/graphql-yoga.d.ts

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

package/dist/routes/health.d.ts

@@ -1,7 +1,7 @@
-import * as h33 from "h3";
+import * as h31 from "h3";
 
 //#region src/routes/health.d.ts
-declare const _default: h33.EventHandler<h33.EventHandlerRequest, Promise<{
+declare const _default: h31.EventHandler<h31.EventHandlerRequest, Promise<{
   status: string;
   message: string;
   timestamp: string;

package/dist/utils/client-codegen.d.ts

@@ -23,14 +23,14 @@ declare function loadExternalSchema(service: ExternalGraphQLService, buildDir?:
  */
 declare function downloadAndSaveSchema(service: ExternalGraphQLService, buildDir: string): Promise<string | undefined>;
 declare function loadGraphQLDocuments(patterns: string | string[]): Promise<Source[]>;
-declare function generateClientTypes(schema: GraphQLSchema, docs: Source[], config?: CodegenClientConfig, sdkConfig?: GenericSdkConfig, outputPath?: string, serviceName?: string): Promise<false | {
+declare function generateClientTypes(schema: GraphQLSchema, docs: Source[], config?: CodegenClientConfig, sdkConfig?: GenericSdkConfig, outputPath?: string, serviceName?: string, virtualTypesPath?: string): Promise<false | {
   types: string;
   sdk: string;
 }>;
 /**
  * Generate client types for external GraphQL service
  */
-declare function generateExternalClientTypes(service: ExternalGraphQLService, schema: GraphQLSchema, docs: Source[]): Promise<{
+declare function generateExternalClientTypes(service: ExternalGraphQLService, schema: GraphQLSchema, docs: Source[], virtualTypesPath?: string): Promise<{
   types: string;
   sdk: string;
 } | false>;

package/dist/utils/client-codegen.js

@@ -165,7 +165,7 @@ async function loadGraphQLDocuments(patterns) {
 		else throw e;
 	}
 }
-async function generateClientTypes(schema, docs, config = {}, sdkConfig = {}, outputPath, serviceName) {
+async function generateClientTypes(schema, docs, config = {}, sdkConfig = {}, outputPath, serviceName, virtualTypesPath) {
 	if (docs.length === 0 && !serviceName) {
 		consola$1.info("No client GraphQL files found. Skipping client type generation.");
 		return false;
@@ -252,7 +252,7 @@ export function getSdk(requester: Requester): Sdk {
 				typescriptOperations: { plugin: plugin$2 }
 			}
 		});
-		const typesPath = serviceName ? `#graphql/client/${serviceName}` : "#graphql/client";
+		const typesPath = virtualTypesPath || (serviceName ? `#graphql/client/${serviceName}` : "#graphql/client");
 		const sdkOutput = await preset.buildGeneratesSection({
 			baseOutputDir: outputPath || "client-types.generated.ts",
 			schema: parse(printSchemaWithDirectives(schema)),
@@ -282,8 +282,8 @@ export function getSdk(requester: Requester): Sdk {
 /**
 * Generate client types for external GraphQL service
 */
-async function generateExternalClientTypes(service, schema, docs) {
-	return generateClientTypes(schema, docs, service.codegen?.client || {}, service.codegen?.clientSDK || {}, void 0, service.name);
+async function generateExternalClientTypes(service, schema, docs, virtualTypesPath) {
+	return generateClientTypes(schema, docs, service.codegen?.client || {}, service.codegen?.clientSDK || {}, void 0, service.name, virtualTypesPath);
 }
 
 //#endregion

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "nitro-graphql",
   "type": "module",
-  "version": "1.5.1",
+  "version": "1.5.2",
   "description": "GraphQL integration for Nitro",
   "license": "MIT",
   "sideEffects": false,
@@ -117,7 +117,8 @@
     "h3": "1.15.3",
     "nitropack": "^2.12.7",
     "tsdown": "^0.15.9",
-    "typescript": "^5.9.3"
+    "typescript": "^5.9.3",
+    "vitepress-plugin-llms": "^1.8.1"
   },
   "resolutions": {
     "nitro-graphql": "link:."
@@ -130,6 +131,9 @@
     "playground:nitro": "cd playgrounds/nitro && pnpm install && pnpm dev",
     "playground:nuxt": "cd playgrounds/nuxt && pnpm install && pnpm dev",
     "playground:federation": "cd playgrounds/federation && pnpm install && pnpm dev",
+    "docs:dev": "cd .docs && pnpm install && pnpm dev",
+    "docs:build": "cd .docs && pnpm install && pnpm build",
+    "docs:preview": "cd .docs && pnpm preview",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix"
   }