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

package/dist/core/scanning/common.mjs

@@ -0,0 +1,60 @@
+import { GLOB_SCAN_PATTERN } from "../constants.mjs";
+import { join, relative } from "pathe";
+import { glob } from "tinyglobby";
+
+//#region src/core/scanning/common.ts
+/**
+* Scan a directory for files matching a glob pattern
+*/
+async function scanDirectory(ctx, baseDir, subDir, globPattern = GLOB_SCAN_PATTERN) {
+	return (await glob(join(subDir, globPattern), {
+		cwd: baseDir,
+		dot: true,
+		ignore: ctx.ignorePatterns,
+		absolute: true
+	}).catch((error) => {
+		if (error?.code === "ENOTDIR") {
+			ctx.logger.warn(`Ignoring \`${join(baseDir, subDir)}\`. It must be a directory.`);
+			return [];
+		}
+		throw error;
+	})).map((fullPath) => ({
+		fullPath,
+		path: relative(join(baseDir, subDir), fullPath)
+	})).sort((a, b) => a.path.localeCompare(b.path));
+}
+/**
+* Deduplicate files by fullPath
+*/
+function deduplicateFiles(files) {
+	const seenPaths = /* @__PURE__ */ new Set();
+	return files.filter((file) => {
+		if (seenPaths.has(file.fullPath)) return false;
+		seenPaths.add(file.fullPath);
+		return true;
+	});
+}
+/**
+* Filter files by extension
+*/
+function filterByExtension(files, extensions) {
+	return files.filter((file) => extensions.some((ext) => file.fullPath.endsWith(ext)));
+}
+/**
+* Extract file paths from scanned files
+*/
+function extractPaths(files) {
+	return files.map((f) => f.fullPath);
+}
+/**
+* Scan directory with layer support
+* Encapsulates the common pattern of scanning main directory + layer directories
+*/
+async function scanWithLayers(ctx, options) {
+	const mainFiles = await scanDirectory(ctx, options.mainDir, options.mainSubDir, options.pattern);
+	const layerFiles = await Promise.all((options.layerDirs || []).map((layerDir) => scanDirectory(ctx, layerDir, options.layerSubDir, options.pattern))).then((r) => r.flat());
+	return deduplicateFiles([...mainFiles, ...layerFiles]);
+}
+
+//#endregion
+export { deduplicateFiles, extractPaths, filterByExtension, scanDirectory, scanWithLayers };

package/dist/core/scanning/directives.d.mts

@@ -0,0 +1,10 @@
+import { ScanContext, ScanResult, ScannedResolver } from "../types/scanning.mjs";
+
+//#region src/core/scanning/directives.d.ts
+
+/**
+ * Scan for directive files (.directive.ts/.js)
+ */
+declare function scanDirectivesCore(ctx: ScanContext): Promise<ScanResult<ScannedResolver>>;
+//#endregion
+export { scanDirectivesCore };

package/dist/core/scanning/directives.mjs

@@ -0,0 +1,29 @@
+import { DIRECTIVE_GLOB_PATTERN } from "../constants.mjs";
+import { scanWithAST } from "./ast-scanner.mjs";
+import { hash } from "ohash";
+
+//#region src/core/scanning/directives.ts
+/**
+* Parse a defineDirective call and return the import info
+*/
+function parseDirectiveCall(calleeName, exportName, filePath) {
+	if (calleeName !== "defineDirective") return null;
+	return {
+		name: exportName,
+		type: "directive",
+		as: `_${hash(exportName + filePath).replace(/-/g, "").slice(0, 6)}`
+	};
+}
+/**
+* Scan for directive files (.directive.ts/.js)
+*/
+function scanDirectivesCore(ctx) {
+	return scanWithAST(ctx, {
+		pattern: DIRECTIVE_GLOB_PATTERN,
+		parseCall: parseDirectiveCall,
+		emitWarnings: false
+	});
+}
+
+//#endregion
+export { scanDirectivesCore };

package/dist/core/scanning/documents.d.mts

@@ -0,0 +1,21 @@
+import { CoreExternalService } from "../types/config.mjs";
+import { ScanContext, ScanResult } from "../types/scanning.mjs";
+
+//#region src/core/scanning/documents.d.ts
+
+/**
+ * Options for scanning documents
+ */
+interface ScanDocumentsOptions {
+  /** External services to exclude from main scan */
+  externalServices?: CoreExternalService[];
+  /** Client directory relative path */
+  clientDirRelative?: string;
+}
+/**
+ * Scan for GraphQL client documents (.graphql) in client directory
+ * Excludes files from external service directories
+ */
+declare function scanDocumentsCore(ctx: ScanContext, options?: ScanDocumentsOptions): Promise<ScanResult<string>>;
+//#endregion
+export { ScanDocumentsOptions, scanDocumentsCore };

package/dist/core/scanning/documents.mjs

@@ -0,0 +1,43 @@
+import { GRAPHQL_GLOB_PATTERN } from "../constants.mjs";
+import { scanWithLayers } from "./common.mjs";
+import { relative } from "pathe";
+
+//#region src/core/scanning/documents.ts
+/**
+* Scan for GraphQL client documents (.graphql) in client directory
+* Excludes files from external service directories
+*/
+async function scanDocumentsCore(ctx, options = {}) {
+	const warnings = [];
+	const errors = [];
+	try {
+		const clientDirRelative = options.clientDirRelative || relative(ctx.rootDir, ctx.clientDir);
+		const allFiles = await scanWithLayers(ctx, {
+			mainDir: ctx.rootDir,
+			mainSubDir: clientDirRelative,
+			layerDirs: ctx.layerAppDirs,
+			layerSubDir: "graphql",
+			pattern: GRAPHQL_GLOB_PATTERN
+		});
+		const externalPatterns = (options.externalServices || []).flatMap((service) => service.documents || []);
+		return {
+			items: allFiles.filter((f) => !f.path.startsWith("external/")).filter((f) => {
+				const relativePath = f.path;
+				for (const pattern of externalPatterns) if (pattern.replace(/* @__PURE__ */ new RegExp(`^${clientDirRelative.replace(/[.*+?^${}()|[\]\\]/g, "\\$&")}/`), "").split("/")[0] === relativePath.split("/")[0]) return false;
+				return true;
+			}).map((f) => f.fullPath),
+			warnings,
+			errors
+		};
+	} catch (error) {
+		errors.push(`Document scanning error: ${error}`);
+		return {
+			items: [],
+			warnings,
+			errors
+		};
+	}
+}
+
+//#endregion
+export { scanDocumentsCore };

package/dist/core/scanning/index.d.mts

@@ -0,0 +1,7 @@
+import { ASTScanConfig, scanWithAST } from "./ast-scanner.mjs";
+import { deduplicateFiles, extractPaths, filterByExtension, scanDirectory } from "./common.mjs";
+import { scanDirectivesCore } from "./directives.mjs";
+import { ScanDocumentsOptions, scanDocumentsCore } from "./documents.mjs";
+import { scanResolversCore } from "./resolvers.mjs";
+import { scanGraphqlCore, scanSchemasCore } from "./schemas.mjs";
+export { type ASTScanConfig, type ScanDocumentsOptions, deduplicateFiles, extractPaths, filterByExtension, scanDirectivesCore, scanDirectory, scanDocumentsCore, scanGraphqlCore, scanResolversCore, scanSchemasCore, scanWithAST };

package/dist/core/scanning/index.mjs

@@ -0,0 +1,8 @@
+import { deduplicateFiles, extractPaths, filterByExtension, scanDirectory } from "./common.mjs";
+import { scanWithAST } from "./ast-scanner.mjs";
+import { scanDirectivesCore } from "./directives.mjs";
+import { scanDocumentsCore } from "./documents.mjs";
+import { scanResolversCore } from "./resolvers.mjs";
+import { scanGraphqlCore, scanSchemasCore } from "./schemas.mjs";
+
+export { deduplicateFiles, extractPaths, filterByExtension, scanDirectivesCore, scanDirectory, scanDocumentsCore, scanGraphqlCore, scanResolversCore, scanSchemasCore, scanWithAST };

package/dist/core/scanning/resolvers.d.mts

@@ -0,0 +1,10 @@
+import { ScanContext, ScanResult, ScannedResolver } from "../types/scanning.mjs";
+
+//#region src/core/scanning/resolvers.d.ts
+
+/**
+ * Scan for resolver files and parse their exports
+ */
+declare function scanResolversCore(ctx: ScanContext): Promise<ScanResult<ScannedResolver>>;
+//#endregion
+export { scanResolversCore };

package/dist/core/scanning/resolvers.mjs

@@ -0,0 +1,58 @@
+import { DEFINE_FUNCTIONS, RESOLVER_GLOB_PATTERN } from "../constants.mjs";
+import { scanWithAST } from "./ast-scanner.mjs";
+import { hash } from "ohash";
+
+//#region src/core/scanning/resolvers.ts
+/**
+* Parse a define* function call and return the import info
+*/
+function parseResolverCall(calleeName, exportName, filePath) {
+	const aliasHash = `_${hash(exportName + filePath).replace(/-/g, "").slice(0, 6)}`;
+	switch (calleeName) {
+		case "defineResolver": return {
+			name: exportName,
+			type: "resolver",
+			as: aliasHash
+		};
+		case "defineQuery": return {
+			name: exportName,
+			type: "query",
+			as: aliasHash
+		};
+		case "defineMutation": return {
+			name: exportName,
+			type: "mutation",
+			as: aliasHash
+		};
+		case "defineField": return {
+			name: exportName,
+			type: "type",
+			as: aliasHash
+		};
+		case "defineSubscription": return {
+			name: exportName,
+			type: "subscription",
+			as: aliasHash
+		};
+		case "defineDirective": return {
+			name: exportName,
+			type: "directive",
+			as: aliasHash
+		};
+		default: return null;
+	}
+}
+/**
+* Scan for resolver files and parse their exports
+*/
+function scanResolversCore(ctx) {
+	return scanWithAST(ctx, {
+		pattern: RESOLVER_GLOB_PATTERN,
+		parseCall: parseResolverCall,
+		emitWarnings: true,
+		validFunctions: DEFINE_FUNCTIONS
+	});
+}
+
+//#endregion
+export { scanResolversCore };

package/dist/core/scanning/schemas.d.mts

@@ -0,0 +1,14 @@
+import { ScanContext, ScanResult } from "../types/scanning.mjs";
+
+//#region src/core/scanning/schemas.d.ts
+
+/**
+ * Scan for GraphQL schema files (.graphql) in server directory
+ */
+declare function scanSchemasCore(ctx: ScanContext): Promise<ScanResult<string>>;
+/**
+ * Scan for GraphQL files (.graphql, .gql) in server directory
+ */
+declare function scanGraphqlCore(ctx: ScanContext): Promise<ScanResult<string>>;
+//#endregion
+export { scanGraphqlCore, scanSchemasCore };

package/dist/core/scanning/schemas.mjs

@@ -0,0 +1,64 @@
+import { GRAPHQL_GLOB_PATTERN } from "../constants.mjs";
+import { extractPaths, scanWithLayers } from "./common.mjs";
+import { relative } from "pathe";
+
+//#region src/core/scanning/schemas.ts
+/**
+* Scan for GraphQL schema files (.graphql) in server directory
+*/
+async function scanSchemasCore(ctx) {
+	const warnings = [];
+	const errors = [];
+	try {
+		const serverDirRelative = relative(ctx.rootDir, ctx.serverDir);
+		return {
+			items: extractPaths(await scanWithLayers(ctx, {
+				mainDir: ctx.rootDir,
+				mainSubDir: serverDirRelative,
+				layerDirs: ctx.layerServerDirs,
+				layerSubDir: "graphql",
+				pattern: GRAPHQL_GLOB_PATTERN
+			})),
+			warnings,
+			errors
+		};
+	} catch (error) {
+		errors.push(`Schema scanning error: ${error}`);
+		return {
+			items: [],
+			warnings,
+			errors
+		};
+	}
+}
+/**
+* Scan for GraphQL files (.graphql, .gql) in server directory
+*/
+async function scanGraphqlCore(ctx) {
+	const warnings = [];
+	const errors = [];
+	try {
+		const serverDirRelative = relative(ctx.rootDir, ctx.serverDir);
+		return {
+			items: extractPaths(await scanWithLayers(ctx, {
+				mainDir: ctx.rootDir,
+				mainSubDir: serverDirRelative,
+				layerDirs: ctx.layerServerDirs,
+				layerSubDir: "graphql",
+				pattern: "**/*.{graphql,gql}"
+			})),
+			warnings,
+			errors
+		};
+	} catch (error) {
+		errors.push(`GraphQL scanning error: ${error}`);
+		return {
+			items: [],
+			warnings,
+			errors
+		};
+	}
+}
+
+//#endregion
+export { scanGraphqlCore, scanSchemasCore };

package/dist/core/schema/builder.d.mts

@@ -0,0 +1,53 @@
+import { DirectiveDefinition } from "../types/define.mjs";
+import { GraphQLSchema } from "graphql";
+
+//#region src/core/schema/builder.d.ts
+
+/**
+ * Schema definition from virtual module
+ */
+interface SchemaDefinition {
+  def: string;
+}
+/**
+ * Resolver definition from virtual module
+ */
+interface ResolverDefinition {
+  resolver: Record<string, unknown>;
+}
+/**
+ * Directive wrapper from virtual module
+ */
+interface DirectiveWrapper {
+  directive: DirectiveDefinition;
+}
+/**
+ * Module configuration for federation
+ */
+interface ModuleConfig {
+  federation?: {
+    enabled?: boolean;
+    serviceName?: string;
+  };
+}
+/**
+ * Options for creating a merged schema
+ */
+interface CreateMergedSchemaOptions {
+  schemas: SchemaDefinition[];
+  resolvers: ResolverDefinition[];
+  directives?: DirectiveWrapper[];
+  moduleConfig: ModuleConfig;
+}
+/**
+ * Create a merged GraphQL schema from schemas, resolvers, and directives
+ * Supports Apollo Federation when enabled
+ */
+declare function createMergedSchema(options: CreateMergedSchemaOptions): Promise<GraphQLSchema>;
+/**
+ * Build a GraphQL schema from file paths (CLI usage)
+ * Reads schema files, merges them, and builds an executable schema
+ */
+declare function buildGraphQLSchema(schemaPaths: string[]): Promise<GraphQLSchema | null>;
+//#endregion
+export { CreateMergedSchemaOptions, DirectiveWrapper, ModuleConfig, ResolverDefinition, SchemaDefinition, buildGraphQLSchema, createMergedSchema };

package/dist/core/schema/builder.mjs

@@ -0,0 +1,70 @@
+import { loadFederationSupport, warnFederationUnavailable } from "./federation.mjs";
+import { consola as consola$1 } from "consola";
+import { buildSchema, parse, print } from "graphql";
+import { readFileSync } from "node:fs";
+import { mergeResolvers, mergeTypeDefs } from "@graphql-tools/merge";
+import { makeExecutableSchema } from "@graphql-tools/schema";
+
+//#region src/core/schema/builder.ts
+/**
+* Create a merged GraphQL schema from schemas, resolvers, and directives
+* Supports Apollo Federation when enabled
+*/
+async function createMergedSchema(options) {
+	const { schemas, resolvers, directives, moduleConfig } = options;
+	try {
+		const typeDefs = mergeTypeDefs([schemas.map((schema$1) => schema$1.def).join("\n\n")], {
+			throwOnConflict: true,
+			commentDescriptions: true,
+			sort: true
+		});
+		const mergedResolvers = mergeResolvers(resolvers.map((r) => r.resolver));
+		const federationEnabled = moduleConfig.federation?.enabled;
+		let schema;
+		if (federationEnabled) {
+			const buildSubgraph = await loadFederationSupport();
+			if (buildSubgraph) schema = buildSubgraph({
+				typeDefs: typeof typeDefs === "string" ? parse(typeDefs) : typeDefs,
+				resolvers: mergedResolvers
+			});
+			else {
+				warnFederationUnavailable();
+				schema = makeExecutableSchema({
+					typeDefs,
+					resolvers: mergedResolvers
+				});
+			}
+		} else schema = makeExecutableSchema({
+			typeDefs,
+			resolvers: mergedResolvers
+		});
+		if (directives && directives.length > 0) {
+			for (const { directive } of directives) if (directive.transformer) schema = directive.transformer(schema);
+		}
+		return schema;
+	} catch (error) {
+		consola$1.error("Schema merge error:", error);
+		throw error;
+	}
+}
+/**
+* Build a GraphQL schema from file paths (CLI usage)
+* Reads schema files, merges them, and builds an executable schema
+*/
+async function buildGraphQLSchema(schemaPaths) {
+	if (schemaPaths.length === 0) return null;
+	try {
+		const mergedTypeDefs = mergeTypeDefs(schemaPaths.map((path) => readFileSync(path, "utf-8")), {
+			throwOnConflict: true,
+			commentDescriptions: true,
+			sort: true
+		});
+		return buildSchema(typeof mergedTypeDefs === "string" ? mergedTypeDefs : print(mergedTypeDefs));
+	} catch (error) {
+		consola$1.error("Failed to build GraphQL schema:", error);
+		return null;
+	}
+}
+
+//#endregion
+export { buildGraphQLSchema, createMergedSchema };

package/dist/core/schema/federation.d.mts

@@ -0,0 +1,34 @@
+import { DocumentNode, GraphQLSchema } from "graphql";
+
+//#region src/core/schema/federation.d.ts
+
+/**
+ * Module type for buildSubgraphSchema
+ */
+interface SubgraphModule {
+  typeDefs: DocumentNode;
+  resolvers?: Record<string, unknown>;
+}
+/**
+ * Type for buildSubgraphSchema function from @apollo/subgraph
+ * Accepts either an array of modules or a single options object
+ */
+type BuildSubgraphSchemaFn = (modulesOrOptions: SubgraphModule[] | SubgraphModule) => GraphQLSchema;
+/**
+ * Dynamically load @apollo/subgraph for federation support.
+ * Returns the buildSubgraphSchema function if available, or false if the package is not installed.
+ * Result is cached for subsequent calls.
+ */
+declare function loadFederationSupport(): Promise<BuildSubgraphSchemaFn | false>;
+/**
+ * Log a warning when federation is enabled but @apollo/subgraph is not available.
+ * Uses consola logger instead of console.warn for consistent logging.
+ */
+declare function warnFederationUnavailable(): void;
+/**
+ * Reset the federation support cache.
+ * Useful for testing or when the module needs to be reloaded.
+ */
+declare function resetFederationCache(): void;
+//#endregion
+export { loadFederationSupport, resetFederationCache, warnFederationUnavailable };

package/dist/core/schema/federation.mjs

@@ -0,0 +1,40 @@
+import { LOG_TAG } from "../constants.mjs";
+import { consola as consola$1 } from "consola";
+
+//#region src/core/schema/federation.ts
+const logger = consola$1.withTag(LOG_TAG);
+/**
+* Cached result: function if available, false if not available, null if not checked yet
+*/
+let buildSubgraphSchemaCache = null;
+/**
+* Dynamically load @apollo/subgraph for federation support.
+* Returns the buildSubgraphSchema function if available, or false if the package is not installed.
+* Result is cached for subsequent calls.
+*/
+async function loadFederationSupport() {
+	if (buildSubgraphSchemaCache !== null) return buildSubgraphSchemaCache;
+	try {
+		buildSubgraphSchemaCache = (await import("@apollo/subgraph")).buildSubgraphSchema;
+	} catch {
+		buildSubgraphSchemaCache = false;
+	}
+	return buildSubgraphSchemaCache;
+}
+/**
+* Log a warning when federation is enabled but @apollo/subgraph is not available.
+* Uses consola logger instead of console.warn for consistent logging.
+*/
+function warnFederationUnavailable() {
+	logger.warn("Federation enabled but @apollo/subgraph not available, falling back to regular schema");
+}
+/**
+* Reset the federation support cache.
+* Useful for testing or when the module needs to be reloaded.
+*/
+function resetFederationCache() {
+	buildSubgraphSchemaCache = null;
+}
+
+//#endregion
+export { loadFederationSupport, resetFederationCache, warnFederationUnavailable };

package/dist/core/schema/index.d.mts

@@ -0,0 +1,3 @@
+import { CreateMergedSchemaOptions, DirectiveWrapper, ModuleConfig, ResolverDefinition, SchemaDefinition, buildGraphQLSchema, createMergedSchema } from "./builder.mjs";
+import { loadFederationSupport, resetFederationCache, warnFederationUnavailable } from "./federation.mjs";
+export { CreateMergedSchemaOptions, DirectiveWrapper, ModuleConfig, ResolverDefinition, SchemaDefinition, buildGraphQLSchema, createMergedSchema, loadFederationSupport, resetFederationCache, warnFederationUnavailable };

package/dist/core/schema/index.mjs

@@ -0,0 +1,4 @@
+import { loadFederationSupport, resetFederationCache, warnFederationUnavailable } from "./federation.mjs";
+import { buildGraphQLSchema, createMergedSchema } from "./builder.mjs";
+
+export { buildGraphQLSchema, createMergedSchema, loadFederationSupport, resetFederationCache, warnFederationUnavailable };

package/dist/core/types/adapter.d.mts

@@ -0,0 +1,58 @@
+import { CoreConfig, CoreContext, CoreLogger } from "./config.mjs";
+import { ScanContext, ScanResult, ScannedResolver } from "./scanning.mjs";
+import "./index.mjs";
+
+//#region src/core/types/adapter.d.ts
+
+/**
+ * Framework adapter interface
+ * Adapters convert framework-specific types to core types
+ */
+interface FrameworkAdapter<TFramework = unknown> {
+  /** Adapter name for logging */
+  readonly name: string;
+  /** Create core config from framework instance */
+  createCoreConfig: (framework: TFramework) => CoreConfig;
+  /** Create core context from framework instance */
+  createCoreContext: (framework: TFramework) => CoreContext;
+  /** Create scan context from framework instance */
+  createScanContext: (framework: TFramework) => ScanContext;
+  /** Get framework logger adapted to CoreLogger interface */
+  getLogger: (framework: TFramework) => CoreLogger;
+}
+/**
+ * Scan adapter interface
+ * Provides high-level scanning operations using the framework adapter
+ */
+interface ScanAdapter<TFramework = unknown> {
+  /** Scan for GraphQL schema files */
+  scanSchemas: (framework: TFramework) => Promise<ScanResult<string>>;
+  /** Scan for GraphQL files (schemas + operations) */
+  scanGraphql: (framework: TFramework) => Promise<ScanResult<string>>;
+  /** Scan for resolver files */
+  scanResolvers: (framework: TFramework) => Promise<ScanResult<ScannedResolver>>;
+  /** Scan for directive files */
+  scanDirectives: (framework: TFramework) => Promise<ScanResult<ScannedResolver>>;
+  /** Scan for client documents */
+  scanDocuments: (framework: TFramework) => Promise<ScanResult<string>>;
+}
+/**
+ * Codegen adapter interface
+ * Provides high-level codegen operations using the framework adapter
+ */
+interface CodegenAdapter<TFramework = unknown> {
+  /** Generate server types */
+  generateServerTypes: (framework: TFramework, options?: {
+    silent?: boolean;
+  }) => Promise<void>;
+  /** Generate client types */
+  generateClientTypes: (framework: TFramework, options?: {
+    silent?: boolean;
+  }) => Promise<void>;
+}
+/**
+ * Combined full adapter interface
+ */
+interface FullFrameworkAdapter<TFramework = unknown> extends FrameworkAdapter<TFramework>, ScanAdapter<TFramework>, CodegenAdapter<TFramework> {}
+//#endregion
+export { CodegenAdapter, FrameworkAdapter, FullFrameworkAdapter, ScanAdapter };