nuxt-graphql-middleware 5.0.0-alpha.9 → 5.1.0

package/dist/shared/nuxt-graphql-middleware.-BeiPV4H.d.mts

@@ -0,0 +1,566 @@
+import { GraphQLSchema, GraphQLNamedType } from 'graphql';
+import { Nuxt, ResolvedNuxtTemplate, WatchEvent } from 'nuxt/schema';
+import { Resolver } from '@nuxt/kit';
+import { RouterMethod } from 'h3';
+import { Types } from '@graphql-codegen/plugin-helpers';
+import { SchemaASTConfig } from '@graphql-codegen/schema-ast';
+import { GeneratorOptions, GeneratorOutput } from 'graphql-typescript-deluxe';
+
+type RpcItem = {
+    id: string;
+    timestamp?: number;
+    source: string;
+    name: string;
+    identifier: 'fragment' | 'query' | 'mutation';
+    filePath: string;
+};
+
+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;
+    };
+    /**
+     * Enable Nuxt DevTools integration.
+     *
+     * @default true
+     */
+    devtools?: boolean;
+    /**
+     * Client caching configuration.
+     */
+    clientCache?: {
+        /**
+         * Whether client caching should be enabled.
+         *
+         * Note that if you set this to false during build, the cache will not be
+         * available at all. If you intend to enable/disable it using app config at
+         * runtime, it *must* be enabled at build!
+         *
+         * @default false
+         */
+        enabled?: boolean;
+        /**
+         * The maximum number of cache entries.
+         *
+         * @default 100
+         */
+        maxSize?: number;
+    };
+    /**
+     * Experimental features.
+     */
+    experimental?: {
+        /**
+         * Enables improved encoding for GraphQL query param encoding.
+         *
+         * If enabled, query variables that are non-strings such as numbers or
+         * booleans are encoded as strings, with a prefix in their name to indicate
+         * the type.
+         *
+         * For example, given this object definining query variables:
+         *
+         * ```
+         * {
+         *   name: 'John',
+         *   age: 35,
+         *   isUser: false
+         * }
+         * ```
+         *
+         * This would be encoded as:
+         *
+         * ```
+         * name=John&n:age=35&b:isUser=false
+         * ```
+         *
+         * This only works for flat primitive values. Nested objects or arrays are
+         * still encoded using the __variables fallback where all variables are
+         * JSON encoded.
+         */
+        improvedQueryParamEncoding?: boolean;
+    };
+}
+
+declare const defaultOptions: ModuleOptions;
+
+declare class ConsolePrompt {
+    private abortController;
+    confirm(message: string): Promise<'yes' | 'no' | 'cancel'>;
+    abort(): void;
+}
+
+type TemplateOptions = {
+    path: string;
+    virtual?: boolean;
+    isFullPath?: boolean;
+};
+type GeneratorTemplateCallback = (output: GeneratorOutput, helper: ModuleHelper, collector: Collector) => 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 {
+    readonly nuxt: 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;
+    private isInitialised;
+    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;
+    addOrUpdateHookDocument(identifier: string, source: string): Promise<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;
+    /**
+     * Get the hook documents.
+     */
+    getHookDocuments(): {
+        identifier: string;
+        source: string;
+    }[];
+    /**
+     * Get the hook documents.
+     */
+    getHookFiles(): string[];
+}
+
+/**
+ * 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 or update an additional static document.
+     *
+     * @param identifier - The unique identifier for your document.
+     * @param source - The document source.
+     */
+    addOrUpdateDocument(identifier: string, source: string): Promise<ModuleContext>;
+    /**
+     * Add an additional GraphQL file to import.
+     *
+     * @param filePath - The absolute path to the file.
+     */
+    addImportFile(filePath: string): ModuleContext;
+}
+
+export { ModuleContext as M };
+export type { ModuleOptions as a };

package/dist/types.d.mts

@@ -1,7 +1 @@
-import type { NuxtModule } from '@nuxt/schema'
-
-import type { default as Module } from './module.js'
-
-export type ModuleOptions = typeof Module extends NuxtModule<infer O> ? Partial<O> : Record<string, any>
-
-export { type GraphqlMiddlewareServerOptions } from './module.js'
+export { type ModuleOptions, default } from './module.mjs'

package/dist/utils.d.mts

@@ -0,0 +1,15 @@
+import { M as ModuleContext } from './shared/nuxt-graphql-middleware.-BeiPV4H.mjs';
+import 'graphql';
+import 'nuxt/schema';
+import '@nuxt/kit';
+import 'h3';
+import '@graphql-codegen/plugin-helpers';
+import '@graphql-codegen/schema-ast';
+import 'graphql-typescript-deluxe';
+
+declare function useGraphqlModuleContext(): ModuleContext;
+declare function useGraphqlModuleContext(options: {
+    nullOnMissing: true;
+}): ModuleContext | null;
+
+export { ModuleContext, useGraphqlModuleContext };

package/dist/utils.mjs

@@ -0,0 +1,18 @@
+import { useNuxt } from '@nuxt/kit';
+
+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;
+}
+
+export { useGraphqlModuleContext };