nuxt-graphql-middleware 5.0.0-alpha.15 → 5.0.0-alpha.17

package/dist/module.d.mts

@@ -1,510 +1,14 @@
 import * as _nuxt_schema from '@nuxt/schema';
-import { Types } from '@graphql-codegen/plugin-helpers';
-import { SchemaASTConfig } from '@graphql-codegen/schema-ast';
-import { GeneratorOptions, GeneratorOutput } from 'graphql-typescript-deluxe';
-import { GraphQLSchema, GraphQLNamedType } from 'graphql';
-import { Nuxt, ResolvedNuxtTemplate, WatchEvent, HookResult } from 'nuxt/schema';
-import { Resolver } from '@nuxt/kit';
-import { RouterMethod } from 'h3';
+import { M as ModuleContext, a as ModuleOptions } from './shared/nuxt-graphql-middleware.DLNGE1zJ.mjs';
 import { OperationResponseError } from '../dist/runtime/types.js';
-export { GraphqlMiddlewareServerOptions } from '../dist/runtime/types.js';
+import { HookResult } from 'nuxt/schema';
+import 'graphql';
+import '@nuxt/kit';
+import 'h3';
+import '@graphql-codegen/plugin-helpers';
+import '@graphql-codegen/schema-ast';
+import 'graphql-typescript-deluxe';
 
-interface ModuleOptions {
-    /**
-     * File glob patterns for the auto import feature.
-     *
-     * If left empty, no documents are auto imported.
-     *
-     * @default
-     * ```json
-     * ["**\/.{gql,graphql}", "!node_modules"]
-     * ```
-     *
-     * @example
-     * ```ts
-     * // Load .graphql files from pages folder and from a node_modules dependency.
-     * const autoImportPatterns = [
-     *   './pages/**\/*.graphql',
-     *   'node_modules/my_library/dist/**\/*.graphql'
-     * ]
-     * ```
-     */
-    autoImportPatterns?: string[];
-    /**
-     * The path where your graphql.config.ts is, relative to the location of nuxt.config.ts.
-     *
-     * Used to generate the correct paths in the graphql.config.ts file generated by the module.
-     *
-     * @default "./graphql.config.ts"
-     */
-    graphqlConfigFilePath?: string;
-    /**
-     * Additional raw documents to include.
-     *
-     * Useful if for example you need to generate queries during build time.
-     *
-     * @default []
-     *
-     * @example
-     * ```ts
-     * const documents = [`
-     *   query myQuery {
-     *     articles {
-     *       title
-     *       id
-     *     }
-     *   }`,
-     *   ...getGeneratedDocuments()
-     * ]
-     * ```
-     */
-    documents?: string[];
-    /**
-     * Wether the useGraphqlQuery, useGraphqlMutation and useGraphqlState
-     * composables should be included.
-     *
-     * @default ```ts
-     * true
-     * ```
-     */
-    includeComposables?: boolean;
-    /**
-     * Enable support for uploading files via GraphQL.
-     *
-     * When enabled, an additional `useGraphqlUploadMutation` composable is
-     * included, in addition to a new server endpoint that handles multi part
-     * file uploads for GraphQL mutations.
-     */
-    enableFileUploads?: boolean;
-    /**
-     * Enable detailled debugging messages.
-     *
-     * @default false
-     */
-    debug?: boolean;
-    /**
-     * Displays GraphQL response errors in an overlay in dev mode.
-     */
-    errorOverlay?: boolean;
-    /**
-     * The URL of the GraphQL server.
-     *
-     * For the runtime execution you can provide a method that determines the endpoint
-     * during runtime. See the server/graphqlMiddleware.serverOptions.ts documentation
-     * for more information.
-     */
-    graphqlEndpoint: string;
-    /**
-     * Download the GraphQL schema and store it on disk.
-     *
-     * Usually you'll want to only enable this during dev mode.
-     *
-     * @default true
-     */
-    downloadSchema?: boolean;
-    /**
-     * Path to the GraphQL schema file.
-     *
-     * If `downloadSchema` is `true`, the downloaded schema is written to this specified path.
-     * If `downloadSchema` is `false`, this file must be present in order to generate types.
-     *
-     * @default './schema.graphql'
-     */
-    schemaPath?: string;
-    /**
-     * The prefix for the server route.
-     *
-     * @default ```ts
-     * "/api/graphql_middleware"
-     * ```
-     */
-    serverApiPrefix?: string;
-    /**
-     * Logs only errors.
-     *
-     * When enabled only errors are logged to the console when generating the GraphQL operations.
-     * If false, all operations are logged, including valid ones.
-     */
-    logOnlyErrors?: boolean;
-    /**
-     * Options for graphql-typescript-deluxe code generator.
-     *
-     * @see [GeneratorOptions](https://github.com/dulnan/graphql-typescript-deluxe/blob/main/src/types/options.ts#L193)
-     */
-    codegenConfig?: GeneratorOptions;
-    /**
-     * Configuration for graphql-codegen when downloading the schema.
-     */
-    codegenSchemaConfig?: {
-        /**
-         * Configure how the schema.graphql file should be generated.
-         *
-         * @see [SchemaASTConfig](https://github.com/dotansimha/graphql-code-generator/blob/master/packages/plugins/other/schema-ast/src/index.ts#L23)
-         */
-        schemaAstConfig?: SchemaASTConfig;
-        /**
-         * Configure how the schema-ast introspection request should be made.
-         *
-         * Usually this is where you can provide a custom authentication header:
-         *
-         * ```typescript
-         * const codegenSchemaConfig = {
-         *   urlSchemaOptions: {
-         *     headers: {
-         *       authentication: 'foobar',
-         *     }
-         *   }
-         * }
-         * ```
-         *
-         * @see [Types.UrlSchemaOptions](https://github.com/dotansimha/graphql-code-generator/blob/master/packages/utils/plugins-helpers/src/types.ts#L82)
-         */
-        urlSchemaOptions?: Types.UrlSchemaOptions;
-    };
-    /**
-     * Set to true if you want to output each compiled query and mutation in the
-     * .nuxt folder.
-     * Set to a path to output to a custom path.
-     */
-    outputDocuments?: boolean | string;
-    /**
-     * Enable Nuxt DevTools integration.
-     */
-    devtools?: boolean;
-    /**
-     * Client caching configuration.
-     */
-    clientCache?: {
-        enabled?: boolean;
-        maxSize?: number;
-    };
-}
-
-type RpcItem = {
-    id: string;
-    timestamp?: number;
-    source: string;
-    name: string;
-    identifier: 'fragment' | 'query' | 'mutation';
-    filePath: string;
-};
-
-declare const defaultOptions: ModuleOptions;
-
-declare class ConsolePrompt {
-    private abortController;
-    confirm(message: string): Promise<'yes' | 'no' | 'cancel'>;
-    abort(): void;
-}
-
-type TemplateOptions = {
-    path: string;
-    virtual?: boolean;
-};
-type GeneratorTemplateCallback = (output: GeneratorOutput, helper: ModuleHelper) => string;
-type StaticTemplateCallback = (helper: ModuleHelper) => string;
-type GeneratorTemplate = {
-    type: 'generator';
-    options: TemplateOptions;
-    build: GeneratorTemplateCallback | null;
-    buildTypes: GeneratorTemplateCallback | null;
-    virtual?: boolean;
-};
-type StaticTemplate = {
-    type: 'static';
-    options: TemplateOptions;
-    build: StaticTemplateCallback | null;
-    buildTypes: StaticTemplateCallback | null;
-    virtual?: boolean;
-};
-
-type WithRequired<T, K extends keyof T> = T & {
-    [P in K]-?: T[P];
-};
-type RequiredModuleOptions = WithRequired<ModuleOptions, keyof typeof defaultOptions>;
-type ModuleHelperResolvers = {
-    /**
-     * Resolver for paths relative to the module root.
-     */
-    module: Resolver;
-    /**
-     * Resolve relative to the app's server directory.
-     */
-    server: Resolver;
-    /**
-     * Resolve relative to the Nuxt src folder.
-     */
-    src: Resolver;
-    /**
-     * Resolve relative to the Nuxt app directory.
-     */
-    app: Resolver;
-    /**
-     * Resolve relative to the Nuxt root.
-     *
-     * Should be where nuxt.config.ts is located.
-     */
-    root: Resolver;
-};
-type ModuleHelperPaths = {
-    runtimeTypes: string;
-    root: string;
-    nuxtConfig: string;
-    serverDir: string;
-    schema: string;
-    serverOptions: string | null;
-    clientOptions: string | null;
-    moduleBuildDir: string;
-    moduleTypesDir: string;
-};
-declare class ModuleHelper {
-    private nuxt;
-    readonly resolvers: ModuleHelperResolvers;
-    readonly paths: ModuleHelperPaths;
-    readonly isDev: boolean;
-    readonly options: RequiredModuleOptions;
-    readonly prompt: ConsolePrompt;
-    private nitroExternals;
-    private tsPaths;
-    constructor(nuxt: Nuxt, moduleUrl: string, options: ModuleOptions);
-    /**
-     * Find the path to the graphqlMiddleware.serverOptions.ts file.
-     */
-    private findServerOptions;
-    private findClientOptions;
-    /**
-     * Transform the path relative to the module's build directory.
-     *
-     * @param path - The absolute path.
-     *
-     * @returns The path relative to the module's build directory.
-     */
-    toModuleBuildRelative(path: string): string;
-    /**
-     * Transform the path relative to the Nuxt build directory.
-     *
-     * @param path - The absolute path.
-     *
-     * @returns The path relative to the module's build directory.
-     */
-    toBuildRelative(path: string): string;
-    /**
-     * Get all file paths that match the import patterns.
-     */
-    getImportPatternFiles(): Promise<string[]>;
-    matchesImportPattern(filePath: string): boolean;
-    addAlias(name: string, path: string): void;
-    inlineNitroExternals(arg: ResolvedNuxtTemplate | string): void;
-    transpile(path: string): void;
-    applyBuildConfig(): void;
-    processTemplate(path: string, content: string): string;
-    addTemplate(template: StaticTemplate): void;
-    addPlugin(name: string): void;
-    addServerHandler(name: string, path: string, method: RouterMethod): void;
-    addComposable(name: string): void;
-    addServerUtil(name: string): void;
-}
-
-type CollectorWatchEventResult = {
-    hasChanged: boolean;
-    affectedOperations: string[];
-    error?: {
-        message: string;
-    };
-};
-declare class Collector {
-    private schema;
-    private helper;
-    /**
-     * All collected files.
-     */
-    private files;
-    /**
-     * All documents provided by hooks.
-     */
-    private hookDocuments;
-    /**
-     * All file paths provided by hooks.
-     */
-    private hookFiles;
-    /**
-     * The code generator.
-     */
-    private generator;
-    /**
-     * A map of operation name and timestamp when the operation was last validated.
-     */
-    private operationTimestamps;
-    /**
-     * The generated operations and fragments.
-     */
-    readonly rpcItems: Map<string, RpcItem>;
-    /**
-     * The registered templates.
-     */
-    private templates;
-    /**
-     * The generated template contents.
-     */
-    private templateResult;
-    constructor(schema: GraphQLSchema, helper: ModuleHelper);
-    reset(): Promise<void>;
-    updateSchema(schema: GraphQLSchema): Promise<void>;
-    private filePathToBuildRelative;
-    private filePathToSourceRelative;
-    private operationToLogEntry;
-    private getTemplate;
-    /**
-     * Executes code gen and performs validation for operations.
-     */
-    private buildState;
-    private buildErrorMessage;
-    private logError;
-    /**
-     * Initialise the collector.
-     *
-     * In dev mode, the method will call itself recursively until all documents
-     * are valid.
-     *
-     * If not in dev mode the method will throw an error when documents are not
-     * valid.
-     */
-    init(): Promise<void>;
-    addHookDocument(identifier: string, source: string): void;
-    addHookFile(filePath: string): void;
-    /**
-     * Initialise the collector.
-     */
-    private initDocuments;
-    /**
-     * Add a file.
-     */
-    private addFile;
-    private matchesPatternOrExists;
-    private handleAdd;
-    private handleChange;
-    private handleUnlink;
-    private handleUnlinkDir;
-    /**
-     * Handle the watcher event for the given file path.
-     */
-    handleWatchEvent(event: WatchEvent, filePath: string): Promise<CollectorWatchEventResult>;
-    /**
-     * Adds a virtual template (not written to disk) for both Nuxt and Nitro.
-     *
-     * For some reason a template written to disk works for both Nuxt and Nitro,
-     * but a virtual template requires adding two templates.
-     */
-    private addVirtualTemplate;
-    /**
-     * Adds a template that dependes on Collector state.
-     */
-    addTemplate(template: GeneratorTemplate): void;
-}
-
-/**
- * Handles downloading, loading and saving the GraphQL schema.
- */
-declare class SchemaProvider {
-    private helper;
-    /**
-     * The raw schema content.
-     */
-    private schemaContent;
-    /**
-     * The parsed schema object.
-     */
-    private schema;
-    constructor(helper: ModuleHelper);
-    init(): Promise<void>;
-    private loadFromDiskFallback;
-    /**
-     * Loads the schema from disk.
-     *
-     * @returns The schema contents from disk.
-     */
-    private loadSchemaFromDisk;
-    /**
-     * Downloads the schema and saves it to disk.
-     *
-     * @returns The schema contents.
-     */
-    private downloadSchema;
-    /**
-     * Determine if the schema exists on disk.
-     *
-     * @returns True if the schema file exists on disk.
-     */
-    hasSchemaOnDisk(): Promise<boolean>;
-    /**
-     * Load the schema either from disk or by downloading it.
-     *
-     * @param forceDownload - Forces downloading the schema.
-     */
-    loadSchema(opts?: {
-        forceDownload?: boolean;
-        forceDisk?: boolean;
-    }): Promise<void>;
-    /**
-     * Get the schema.
-     *
-     * @returns The parsed GraphQL schema object.
-     */
-    getSchema(): GraphQLSchema;
-}
-
-/**
- * The public module context class.
- */
-declare class ModuleContext {
-    private schemaProvider;
-    private collector;
-    constructor(schemaProvider: SchemaProvider, collector: Collector);
-    /**
-     * Return the GraphQL schema.
-     *
-     * Note that the schema may be updated during development, so it can become
-     * stale. Prefer using methods like `schemaHasType()` to query the schema.
-     *
-     * @returns The GraphQL schema.
-     */
-    getSchema(): GraphQLSchema;
-    /**
-     * Check if the given GraphQL type (interface, concrete type, enum, input type)
-     * exists in the schema.
-     *
-     * @param name - The name of the type.
-     *
-     * @returns True if the type exists in the schema.
-     */
-    schemaHasType(name: string): boolean;
-    /**
-     * Get a type from the schema.
-     *
-     * @param name - The name of the type.
-     *
-     * @returns The type.
-     */
-    schemaGetType(name: string): GraphQLNamedType | undefined;
-    /**
-     * Add an additional static document.
-     *
-     * @param identifier - The unique identifier for your document.
-     * @param source - The document source.
-     */
-    addDocument(identifier: string, source: string): ModuleContext;
-    /**
-     * Add an additional GraphQL file to import.
-     *
-     * @param filePath - The absolute path to the file.
-     */
-    addImportFile(filePath: string): ModuleContext;
-}
-
-declare function useGraphqlModuleContext(): ModuleContext;
-declare function useGraphqlModuleContext(options: {
-    nullOnMissing: true;
-}): ModuleContext | null;
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
 
 declare module '#app' {
@@ -571,5 +75,4 @@ declare module '@nuxt/schema' {
     }
 }
 
-export { _default as default, useGraphqlModuleContext };
-export type { ModuleOptions };
+export { ModuleOptions, _default as default };

package/dist/module.json

@@ -1,12 +1,12 @@
 {
   "name": "nuxt-graphql-middleware",
   "configKey": "graphqlMiddleware",
-  "version": "5.0.0-alpha.15",
+  "version": "5.0.0-alpha.17",
   "compatibility": {
     "nuxt": ">=3.15.0"
   },
   "builder": {
-    "@nuxt/module-builder": "0.8.4",
-    "unbuild": "2.0.0"
+    "@nuxt/module-builder": "1.0.1",
+    "unbuild": "3.5.0"
   }
 }

package/dist/module.mjs

@@ -1,5 +1,5 @@
 import { fileURLToPath } from 'url';
-import { useLogger, addTemplate, addServerTemplate, addTypeTemplate, createResolver, resolveAlias, resolveFiles, addPlugin, addServerHandler, addImports, addServerImports, useNitro, defineNuxtModule, useNuxt } from '@nuxt/kit';
+import { useLogger, addTemplate, addServerTemplate, addTypeTemplate, createResolver, resolveAlias, resolveFiles, addPlugin, addServerHandler, addImports, addServerImports, useNitro, defineNuxtModule } from '@nuxt/kit';
 import { existsSync, promises } from 'node:fs';
 import { basename } from 'node:path';
 import { relative } from 'pathe';
@@ -19,7 +19,7 @@ import { existsSync as existsSync$1 } from 'fs';
 import { onDevToolsInitialized, extendServerRpc } from '@nuxt/devtools-kit';
 
 const name = "nuxt-graphql-middleware";
-const version = "5.0.0-alpha.15";
+const version = "5.0.0-alpha.17";
 
 const logger = useLogger("nuxt-graphql-middleware");
 const defaultOptions = {
@@ -119,6 +119,9 @@ class CollectedFile {
   }
   static async fromFilePath(filePath) {
     const content = (await promises.readFile(filePath)).toString();
+    if (!content) {
+      return null;
+    }
     return new CollectedFile(filePath, content, true);
   }
   /**
@@ -411,7 +414,7 @@ class Collector {
    */
   async addFile(filePath) {
     const file = await CollectedFile.fromFilePath(filePath);
-    if (!file.fileContents) {
+    if (!file?.fileContents) {
       return null;
     }
     this.files.set(filePath, file);
@@ -1049,16 +1052,16 @@ export { clientOptions }
         helper.paths.clientOptions
       );
       return `import type { GraphqlClientOptions } from '${helper.paths.runtimeTypes}'
-import clientOptions from '${pathRelative}'
-
-export type GraphqlClientContext = typeof clientOptions extends GraphqlClientOptions<infer R> ? R : {}
+import clientOptionsImport from '${pathRelative}'
 
-export { clientOptions }`;
+declare export const clientOptions: GraphqlClientOptions
+export type GraphqlClientContext = typeof clientOptionsImport extends GraphqlClientOptions<infer R> ? R : {}
+`;
     }
     return `
 import type { GraphqlClientOptions } from '${helper.paths.runtimeTypes}'
-export const clientOptions: GraphqlClientOptions
 
+declare export const clientOptions: GraphqlClientOptions
 export type GraphqlClientContext = {}
 `;
   }
@@ -1225,16 +1228,27 @@ export { serverOptions }
 `;
   },
   (helper) => {
-    const resolvedPathRelative = helper.paths.serverOptions ? helper.toModuleBuildRelative(helper.paths.serverOptions) : null;
-    const serverOptionsLineTypes = resolvedPathRelative ? `import serverOptions from '${resolvedPathRelative}'` : `const serverOptions: GraphqlMiddlewareServerOptions = {}`;
-    return `
+    if (helper.paths.serverOptions) {
+      const resolvedPathRelative = helper.toModuleBuildRelative(
+        helper.paths.serverOptions
+      );
+      return `
 import type { GraphqlMiddlewareServerOptions } from '${helper.paths.runtimeTypes}'
-${serverOptionsLineTypes}
+import serverOptionsImport from '${resolvedPathRelative}'
 
 export type GraphqlResponseAdditions =
-  typeof serverOptions extends GraphqlMiddlewareServerOptions<infer R, any, any> ? R : {}
+  typeof serverOptionsImport extends GraphqlMiddlewareServerOptions<infer R, any, any> ? R : {}
 
-export { serverOptions }`;
+declare export const serverOptions: GraphqlMiddlewareServerOptions
+`;
+    }
+    return `
+import type { GraphqlMiddlewareServerOptions } from '${helper.paths.runtimeTypes}'
+
+declare export const serverOptions: GraphqlMiddlewareServerOptions
+
+export type GraphqlResponseAdditions = object
+`;
   }
 );
 
@@ -1505,20 +1519,6 @@ class ModuleContext {
   }
 }
 
-const CONTEXT_KEY = "_nuxt_graphql_middleware";
-function useGraphqlModuleContext(options) {
-  const nuxt = useNuxt();
-  const context = nuxt[CONTEXT_KEY];
-  if (!context) {
-    if (options?.nullOnMissing) {
-      return null;
-    }
-    throw new Error(
-      "nuxt-graphql-middleware context is not available. Make sure you call this method only after nuxt-graphql-middleware has been setup. If you call this in a module, make sure your module is declared after nuxt-graphql-middleware in your `modules` Nuxt config."
-    );
-  }
-  return context;
-}
 const module = defineNuxtModule({
   meta: {
     name,
@@ -1598,4 +1598,4 @@ const module = defineNuxtModule({
   }
 });
 
-export { module as default, useGraphqlModuleContext };
+export { module as default };