nitro-graphql 2.0.0-beta.4 → 2.0.0-beta.41

package/dist/nitro/types.d.mts

@@ -0,0 +1,374 @@
+import { TypeScriptPluginConfig } from "@graphql-codegen/typescript";
+import { plugin as plugin$1 } from "@graphql-codegen/typescript-generic-sdk";
+import { TypeScriptDocumentsPluginConfig } from "@graphql-codegen/typescript-operations";
+import { IResolvers } from "@graphql-tools/utils";
+import { GraphQLSchema } from "graphql";
+import { TypeScriptResolversPluginConfig } from "@graphql-codegen/typescript-resolvers";
+import { ESMCodeGenOptions } from "knitwork";
+import { ApolloServerOptions } from "@apollo/server";
+import { H3Event } from "nitro/h3";
+import { YogaServerOptions } from "graphql-yoga";
+import { NPMConfig } from "#graphql/server";
+
+//#region src/nitro/types.d.ts
+
+/** The Standard Schema interface. */
+interface StandardSchemaV1<Input = unknown, Output = Input> {
+  /** The Standard Schema properties. */
+  readonly '~standard': StandardSchemaV1.Props<Input, Output>;
+}
+declare namespace StandardSchemaV1 {
+  /** The Standard Schema properties interface. */
+  export interface Props<Input = unknown, Output = Input> {
+    /** The version number of the standard. */
+    readonly version: 1;
+    /** The vendor name of the schema library. */
+    readonly vendor: string;
+    /** Validates unknown input values. */
+    readonly validate: (value: unknown) => Result<Output> | Promise<Result<Output>>;
+    /** Inferred types associated with the schema. */
+    readonly types?: Types<Input, Output> | undefined;
+  }
+  /** The result interface of the validate function. */
+  export type Result<Output> = SuccessResult<Output> | FailureResult;
+  /** The result interface if validation succeeds. */
+  export interface SuccessResult<Output> {
+    /** The typed output value. */
+    readonly value: Output;
+    /** The non-existent issues. */
+    readonly issues?: undefined;
+  }
+  /** The result interface if validation fails. */
+  export interface FailureResult {
+    /** The issues of failed validation. */
+    readonly issues: ReadonlyArray<Issue>;
+  }
+  /** The issue interface of the failure output. */
+  export interface Issue {
+    /** The error message of the issue. */
+    readonly message: string;
+    /** The path of the issue, if any. */
+    readonly path?: ReadonlyArray<PropertyKey | PathSegment> | undefined;
+  }
+  /** The path segment interface of the issue. */
+  export interface PathSegment {
+    /** The key representing a path segment. */
+    readonly key: PropertyKey;
+  }
+  /** The Standard Schema types interface. */
+  export interface Types<Input = unknown, Output = Input> {
+    /** The input type of the schema. */
+    readonly input: Input;
+    /** The output type of the schema. */
+    readonly output: Output;
+  }
+  /** Infers the input type of a Standard Schema. */
+  export type InferInput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['input'];
+  /** Infers the output type of a Standard Schema. */
+  export type InferOutput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['output'];
+  export {};
+}
+type Flatten<T> = T extends infer U ? { [K in keyof U]: U[K] } : never;
+type DefineServerConfig<T extends NPMConfig = NPMConfig> = T['framework'] extends 'graphql-yoga' ? Partial<YogaServerOptions<H3Event, Partial<H3Event>>> : T['framework'] extends 'apollo-server' ? Partial<ApolloServerOptions<H3Event>> : Partial<YogaServerOptions<H3Event, Partial<H3Event>>> | Partial<ApolloServerOptions<H3Event>>;
+type DirectiveLocationName = 'QUERY' | 'MUTATION' | 'SUBSCRIPTION' | 'FIELD' | 'FRAGMENT_DEFINITION' | 'FRAGMENT_SPREAD' | 'INLINE_FRAGMENT' | 'VARIABLE_DEFINITION' | 'SCHEMA' | 'SCALAR' | 'OBJECT' | 'FIELD_DEFINITION' | 'ARGUMENT_DEFINITION' | 'INTERFACE' | 'UNION' | 'ENUM' | 'ENUM_VALUE' | 'INPUT_OBJECT' | 'INPUT_FIELD_DEFINITION';
+type GraphQLScalarType = 'String' | 'Int' | 'Float' | 'Boolean' | 'ID' | 'JSON' | 'DateTime';
+type GraphQLBaseType = GraphQLScalarType | (string & {});
+type GraphQLArgumentType = 'String' | 'Int' | 'Float' | 'Boolean' | 'ID' | 'JSON' | 'DateTime' | 'String!' | 'Int!' | 'Float!' | 'Boolean!' | 'ID!' | 'JSON!' | 'DateTime!' | '[String]' | '[String!]' | '[String]!' | '[String!]!' | '[Int]' | '[Int!]' | '[Int]!' | '[Int!]!' | '[Float]' | '[Float!]' | '[Float]!' | '[Float!]!' | '[Boolean]' | '[Boolean!]' | '[Boolean]!' | '[Boolean!]!' | '[ID]' | '[ID!]' | '[ID]!' | '[ID!]!' | '[JSON]' | '[JSON!]' | '[JSON]!' | '[JSON!]!' | '[DateTime]' | '[DateTime!]' | '[DateTime]!' | '[DateTime!]!' | (string & {});
+interface DirectiveArgument<T extends GraphQLArgumentType = GraphQLArgumentType> {
+  /**
+   * GraphQL type for the argument
+   * @example 'String', 'Int!', '[String!]!', 'DateTime', 'JSON'
+   */
+  type: T;
+  defaultValue?: any;
+  description?: string;
+}
+interface DirectiveArg {
+  type: GraphQLArgumentType;
+  defaultValue?: any;
+  description?: string;
+}
+interface DirectiveDefinition {
+  name: string;
+  locations: DirectiveLocationName[];
+  args?: Record<string, DirectiveArg>;
+  description?: string;
+  isRepeatable?: boolean;
+  transformer?: (schema: GraphQLSchema) => GraphQLSchema;
+}
+interface DefineDirectiveConfig {
+  name: string;
+  locations: ReadonlyArray<DirectiveLocationName>;
+  args?: Record<string, {
+    type: GraphQLArgumentType;
+    defaultValue?: any;
+    description?: string;
+  }>;
+  description?: string;
+  isRepeatable?: boolean;
+  transformer?: (schema: GraphQLSchema) => GraphQLSchema;
+}
+type CodegenServerConfig = TypeScriptPluginConfig & TypeScriptResolversPluginConfig;
+type DocumentModeConfig = Pick<Parameters<typeof plugin$1>[2], 'documentMode'>;
+type DocumentModeEnum = NonNullable<DocumentModeConfig['documentMode']>;
+type DocumentModeType = `${DocumentModeEnum}`;
+type GenericSdkConfig = Omit<Parameters<typeof plugin$1>[2], 'documentMode'> & {
+  documentMode?: DocumentModeType;
+};
+type CodegenClientConfig = TypeScriptPluginConfig & TypeScriptDocumentsPluginConfig & {
+  endpoint?: string;
+  /**
+   * Generate TypedDocumentNode exports for urql/Apollo Client compatibility.
+   * When enabled, generates typed document constants that can be used with
+   * any GraphQL client that supports TypedDocumentNode.
+   * @default false
+   */
+  typedDocumentNode?: boolean;
+};
+interface IESMImport {
+  name: string;
+  as?: string;
+  type: 'resolver' | 'query' | 'mutation' | 'type' | 'subscription' | 'directive';
+}
+interface GenImport {
+  specifier: string;
+  imports: IESMImport[];
+  options?: ESMCodeGenOptions;
+}
+declare module 'nitro/types' {
+  interface Nitro {
+    scanSchemas: string[];
+    scanDocuments: string[];
+    scanResolvers: GenImport[];
+    scanDirectives: GenImport[];
+    graphql: {
+      buildDir: string;
+      watchDirs: string[];
+      clientDir: string;
+      serverDir: string;
+      dir: {
+        build: string;
+        client: string;
+        server: string;
+      };
+      /** Resolved extend paths from manifests (populated during setup) */
+      resolvedExtend?: {
+        schemas: string[];
+        resolvers: string[];
+        directives: string[];
+      };
+    };
+  }
+}
+declare module 'nitro/types' {
+  interface NitroOptions {
+    graphql?: NitroGraphQLOptions;
+  }
+  interface NitroRuntimeConfig {
+    graphql?: NitroGraphQLOptions;
+  }
+  interface NitroConfig {
+    graphql?: NitroGraphQLOptions;
+  }
+}
+/**
+ * Service-specific path overrides for external GraphQL services
+ * These paths override global config for this specific service
+ */
+interface ExternalServicePaths {
+  /** SDK file path (overrides global sdk.external config) */
+  sdk?: FileGenerationConfig;
+  /** Type definitions file path (overrides global types.external config) */
+  types?: FileGenerationConfig;
+}
+interface ExternalGraphQLService {
+  /** Unique name for this service (used for file naming and type generation) */
+  name: string;
+  /** GraphQL endpoint for this service (also used as schema source if `schema` is not specified) */
+  endpoint: string;
+  /**
+   * Schema source - can be URL(s) for remote schemas or file path(s) for local schemas
+   * @default Uses `endpoint` for introspection if not specified
+   */
+  schema?: string | string[];
+  /** Optional headers for schema introspection and client requests */
+  headers?: Record<string, string> | (() => Record<string, string>);
+  /** Optional: specific document patterns for this service */
+  documents?: string[];
+  /**
+   * Optional: Download and cache schema locally for offline usage
+   * - true or 'once': Download if file doesn't exist, then use cached version (offline-friendly)
+   * - 'always': Check for updates on every build (current behavior)
+   * - 'manual': Never download automatically, user manages schema files manually
+   * - false: Disable schema downloading
+   */
+  downloadSchema?: boolean | 'once' | 'always' | 'manual';
+  /** Optional: Custom path to save downloaded schema (default: .nitro/graphql/schemas/[serviceName].graphql) */
+  downloadPath?: string;
+  /** Optional: service-specific codegen configuration */
+  codegen?: {
+    client?: CodegenClientConfig;
+    clientSDK?: GenericSdkConfig;
+  };
+  /**
+   * Optional: Service-specific path overrides
+   * These paths take precedence over global config (sdk, types, clientUtils)
+   * Supports placeholders: {serviceName}, {buildDir}, {rootDir}, {framework}, {typesDir}, {clientDir}
+   */
+  paths?: ExternalServicePaths;
+}
+interface FederationConfig {
+  /** Enable Apollo Federation subgraph support */
+  enabled: boolean;
+  /** Service name for federation (used in subgraph config) */
+  serviceName?: string;
+  /** Service version for federation */
+  serviceVersion?: string;
+  /** Service URL for federation gateway */
+  serviceUrl?: string;
+}
+/**
+ * File generation control:
+ * - false: Do not generate this file
+ * - true: Generate at default location
+ * - string: Generate at custom path (supports placeholders: {serviceName}, {buildDir}, {rootDir}, {framework})
+ */
+type FileGenerationConfig = boolean | string;
+/**
+ * SDK files configuration
+ * Control auto-generation of GraphQL SDK files
+ */
+interface SdkConfig {
+  /** Enable/disable all SDK files */
+  enabled?: boolean;
+  /** app/graphql/default/sdk.ts - Main service SDK */
+  main?: FileGenerationConfig;
+  /** app/graphql/{serviceName}/sdk.ts - External service SDKs */
+  external?: FileGenerationConfig;
+}
+/**
+ * Type files configuration
+ * Control auto-generation of TypeScript type definition files
+ */
+interface TypesConfig {
+  /** Enable/disable all type files */
+  enabled?: boolean;
+  /** .nitro/types/nitro-graphql-server.d.ts - Server-side types */
+  server?: FileGenerationConfig;
+  /** .nitro/types/nitro-graphql-client.d.ts - Client-side types */
+  client?: FileGenerationConfig;
+  /** .nitro/types/nitro-graphql-client-{serviceName}.d.ts - External service types */
+  external?: FileGenerationConfig;
+}
+/**
+ * Security configuration for production environments
+ * All options auto-detect based on NODE_ENV when not explicitly set
+ */
+interface SecurityConfig {
+  /**
+   * Enable GraphQL introspection queries
+   * @default true in development, false in production
+   */
+  introspection?: boolean;
+  /**
+   * Enable GraphQL playground/sandbox UI
+   * @default true in development, false in production
+   */
+  playground?: boolean;
+  /**
+   * Mask internal error details in responses
+   * When enabled, internal errors show "Internal server error" instead of actual message
+   * @default false in development, true in production
+   */
+  maskErrors?: boolean;
+  /**
+   * Disable "Did you mean X?" field suggestions in error messages
+   * Prevents attackers from discovering field names via brute force
+   * @default false in development, true in production
+   */
+  disableSuggestions?: boolean;
+}
+interface NitroGraphQLOptions {
+  framework?: 'graphql-yoga' | 'apollo-server';
+  /**
+   * Enable/disable GraphQL server functionality
+   * When set to false, only external services client types will be generated
+   * Server routes, resolvers, schemas, and directives will not be processed
+   * @default true
+   */
+  server?: boolean;
+  endpoint?: {
+    graphql?: string;
+    healthCheck?: string;
+  };
+  playground?: boolean;
+  typedefs?: string[];
+  resolvers?: Array<IResolvers<any, any>>;
+  loader?: {
+    include?: RegExp;
+    exclude?: RegExp;
+    validate?: boolean;
+  };
+  codegen?: {
+    server?: CodegenServerConfig;
+    client?: CodegenClientConfig;
+    clientSDK?: GenericSdkConfig;
+  };
+  /** External GraphQL services to generate types and SDKs for */
+  externalServices?: ExternalGraphQLService[];
+  /** Apollo Federation configuration */
+  federation?: FederationConfig;
+  /** Server GraphQL directory path (default: 'server/graphql') */
+  serverDir?: string;
+  /** Client GraphQL directory path (default: 'app/graphql' for Nuxt, 'graphql' for Nitro) */
+  clientDir?: string;
+  /** Types directory path (default: '{buildDir}/types') */
+  typesDir?: string;
+  /** Layer directories (populated by Nuxt module) */
+  layerDirectories?: string[];
+  layerServerDirs?: string[];
+  layerAppDirs?: string[];
+  /**
+   * SDK files configuration
+   * Set to false to disable all SDK generation
+   */
+  sdk?: false | SdkConfig;
+  /**
+   * Type files configuration
+   * Set to false to disable all type generation
+   */
+  types?: false | TypesConfig;
+  /**
+   * Security configuration for production environments
+   * Auto-detects NODE_ENV and applies secure defaults in production
+   */
+  security?: SecurityConfig;
+  /**
+   * Extend GraphQL server with external packages
+   * Auto-appends /resolvers and /schema to each package path
+   * @example extend: ['@myorg/graphql', './generated']
+   */
+  extend?: ExtendSource[];
+  /**
+   * Skip local file scanning, use only extend sources
+   * When true, only files from `extend` are used (local server/graphql ignored)
+   * @default false
+   */
+  skipLocalScan?: boolean;
+}
+/**
+ * Extend source - package path or detailed config
+ * - string: package name, requires graphql-manifest.json in package root
+ * - object with manifest: explicit manifest path
+ * - object with resolvers/schemas: explicit paths (legacy)
+ */
+type ExtendSource = string | {
+  /** Explicit manifest path */
+  manifest?: string;
+  /** Explicit resolver paths (legacy, prefer manifest) */
+  resolvers?: string | string[];
+  /** Explicit schema paths (legacy, prefer manifest) */
+  schemas?: string | string[];
+};
+//#endregion
+export { CodegenClientConfig, CodegenServerConfig, DefineDirectiveConfig, DefineServerConfig, DirectiveArgument, DirectiveDefinition, ExtendSource, ExternalGraphQLService, ExternalServicePaths, FederationConfig, FileGenerationConfig, Flatten, GenImport, GenericSdkConfig, GraphQLArgumentType, GraphQLBaseType, GraphQLScalarType, NitroGraphQLOptions, SdkConfig, SecurityConfig, StandardSchemaV1, TypesConfig };

package/dist/nitro/types.mjs

@@ -0,0 +1 @@
+export {  };

package/dist/nitro/virtual/generators.d.mts

@@ -0,0 +1,31 @@
+import { Nitro } from "nitro/types";
+
+//#region src/nitro/virtual/generators.d.ts
+
+declare const serverSchemas: {
+  id: string;
+  getCode: (nitro: Nitro) => string;
+};
+declare const serverResolvers: {
+  id: string;
+  getCode: (nitro: Nitro) => string;
+};
+declare const serverDirectives: {
+  id: string;
+  getCode: (nitro: Nitro) => string;
+};
+declare const graphqlConfig: {
+  id: string;
+  getCode: (nitro: Nitro) => string;
+};
+declare const moduleConfig: {
+  id: string;
+  getCode: (nitro: Nitro) => string;
+};
+declare const debugInfo: {
+  id: string;
+  getCode: (nitro: Nitro) => string;
+};
+declare function registerAllVirtualModules(nitro: Nitro): void;
+//#endregion
+export { debugInfo, graphqlConfig, moduleConfig, registerAllVirtualModules, serverDirectives, serverResolvers, serverSchemas };

package/dist/nitro/virtual/generators.mjs

@@ -0,0 +1,113 @@
+import { getImportId } from "../../core/utils/imports.mjs";
+import { resolve } from "pathe";
+import { genImport } from "knitwork";
+
+//#region src/nitro/virtual/generators.ts
+function generateImportModule(items, exportName, wrapperKey) {
+	if (!items.length) return `export const ${exportName} = []`;
+	const imports = items.flatMap(({ specifier, imports: list, options }) => list?.length ? [genImport(specifier, list, options)] : []);
+	const data = items.flatMap(({ imports: list }) => list.map((i) => `{ ${wrapperKey}: ${i.as || i.name} }`));
+	return `${imports.join("\n")}\n\nexport const ${exportName} = [\n${data.join(",\n")}\n]`;
+}
+function safeGenerateModuleCode(nitro, moduleName) {
+	try {
+		const generator = nitro.options.virtual?.[moduleName];
+		if (generator && typeof generator === "function") return generator();
+		return "// Module not found";
+	} catch (error) {
+		return `// Error: ${error instanceof Error ? error.message : String(error)}`;
+	}
+}
+const serverSchemas = {
+	id: "#nitro-graphql/server-schemas",
+	getCode: (nitro) => {
+		const schemas = [...nitro.scanSchemas, ...nitro.options.graphql?.typedefs ?? []];
+		if (!schemas.length) {
+			if (nitro.options.dev) nitro.logger.warn("[nitro-graphql] No schemas found. Virtual module will export empty array.");
+			return "export const schemas = []";
+		}
+		const importStatements = schemas.map((s) => `import ${getImportId(s)} from '${s}';`);
+		const schemaArray = schemas.map((s) => `{ def: ${getImportId(s)} }`);
+		return `${importStatements.join("\n")}\n\nexport const schemas = [\n${schemaArray.join(",\n")}\n];`;
+	}
+};
+const serverResolvers = {
+	id: "#nitro-graphql/server-resolvers",
+	getCode: (nitro) => {
+		const imports = [...nitro.scanResolvers];
+		if (!imports.length) {
+			if (nitro.options.dev) nitro.logger.warn("[nitro-graphql] No resolvers found. Virtual module will export empty array.");
+			return "export const resolvers = []";
+		}
+		return generateImportModule(imports, "resolvers", "resolver");
+	}
+};
+const serverDirectives = {
+	id: "#nitro-graphql/server-directives",
+	getCode: (nitro) => {
+		const imports = nitro.scanDirectives || [];
+		if (!imports.length) return "export const directives = []";
+		return generateImportModule(imports, "directives", "directive");
+	}
+};
+const graphqlConfig = {
+	id: "#nitro-graphql/graphql-config",
+	getCode: (nitro) => {
+		return `import config from '${resolve(nitro.graphql.serverDir, "config.ts")}'
+const importedConfig = config
+export { importedConfig }
+`;
+	}
+};
+const moduleConfig = {
+	id: "#nitro-graphql/module-config",
+	getCode: (nitro) => {
+		const config = nitro.options.graphql || {};
+		return `export const moduleConfig = ${JSON.stringify(config, null, 2)};`;
+	}
+};
+const debugInfo = {
+	id: "#nitro-graphql/debug-info",
+	getCode: (nitro) => {
+		const virtualModuleCodes = {
+			"server-schemas": safeGenerateModuleCode(nitro, "#nitro-graphql/server-schemas"),
+			"server-resolvers": safeGenerateModuleCode(nitro, "#nitro-graphql/server-resolvers"),
+			"server-directives": safeGenerateModuleCode(nitro, "#nitro-graphql/server-directives"),
+			"module-config": safeGenerateModuleCode(nitro, "#nitro-graphql/module-config"),
+			"graphql-config": safeGenerateModuleCode(nitro, "#nitro-graphql/graphql-config")
+		};
+		const info = {
+			isDev: nitro.options.dev,
+			framework: nitro.options.framework.name,
+			graphqlFramework: nitro.options.graphql?.framework,
+			federation: nitro.options.graphql?.federation,
+			scanned: {
+				schemas: nitro.scanSchemas?.length || 0,
+				schemaFiles: nitro.scanSchemas || [],
+				resolvers: nitro.scanResolvers?.length || 0,
+				resolverFiles: nitro.scanResolvers || [],
+				directives: nitro.scanDirectives?.length || 0,
+				directiveFiles: nitro.scanDirectives || [],
+				documents: nitro.scanDocuments?.length || 0,
+				documentFiles: nitro.scanDocuments || []
+			},
+			virtualModules: virtualModuleCodes
+		};
+		return `export const debugInfo = ${JSON.stringify(info, null, 2)};`;
+	}
+};
+const allModules = [
+	serverSchemas,
+	serverResolvers,
+	serverDirectives,
+	graphqlConfig,
+	moduleConfig,
+	debugInfo
+];
+function registerAllVirtualModules(nitro) {
+	nitro.options.virtual ??= {};
+	for (const mod of allModules) nitro.options.virtual[mod.id] = () => mod.getCode(nitro);
+}
+
+//#endregion
+export { debugInfo, graphqlConfig, moduleConfig, registerAllVirtualModules, serverDirectives, serverResolvers, serverSchemas };

package/dist/nitro/virtual/stubs.d.mts

@@ -0,0 +1,20 @@
+//#region src/nitro/virtual/stubs.d.ts
+/**
+ * Virtual module stubs for #nitro-graphql/*
+ * Used during build to prevent import resolution errors.
+ * At runtime, Nitro overrides these with actual virtual modules.
+ */
+declare const schemas: Array<{
+  def: string;
+}>;
+declare const resolvers: Array<{
+  resolver: any;
+}>;
+declare const directives: Array<{
+  directive: any;
+}>;
+declare const moduleConfig: {};
+declare const importedConfig: {};
+declare const debugInfo: Record<string, any>;
+//#endregion
+export { debugInfo, directives, importedConfig, moduleConfig, resolvers, schemas };

package/dist/nitro/virtual/stubs.mjs

@@ -0,0 +1,31 @@
+//#region src/nitro/virtual/stubs.ts
+/**
+* Virtual module stubs for #nitro-graphql/*
+* Used during build to prevent import resolution errors.
+* At runtime, Nitro overrides these with actual virtual modules.
+*/
+const schemas = [];
+const resolvers = [];
+const directives = [];
+const moduleConfig = {};
+const importedConfig = {};
+const debugInfo = {
+	isDev: false,
+	framework: "",
+	graphqlFramework: "",
+	federation: {},
+	scanned: {
+		schemas: 0,
+		schemaFiles: [],
+		resolvers: 0,
+		resolverFiles: [],
+		directives: 0,
+		directiveFiles: [],
+		documents: 0,
+		documentFiles: []
+	},
+	virtualModules: {}
+};
+
+//#endregion
+export { debugInfo, directives, importedConfig, moduleConfig, resolvers, schemas };

package/dist/{ecosystem/nuxt.d.ts → nuxt.d.mts}

@@ -1,6 +1,6 @@
 import * as _nuxt_schema0 from "@nuxt/schema";
 
-//#region src/ecosystem/nuxt.d.ts
+//#region src/nuxt.d.ts
 interface ModuleOptions {}
 declare const _default: _nuxt_schema0.NuxtModule<ModuleOptions, ModuleOptions, false>;
 //#endregion