nuxt-graphql-middleware 5.0.0-alpha.5 → 5.0.0-alpha.7

package/dist/module.d.mts

@@ -1,19 +1,184 @@
 import * as _nuxt_schema from '@nuxt/schema';
+import { HookResult } from 'nuxt/schema';
+import { ContextType, GraphqlServerResponse, OperationResponseError } from '../dist/runtime/types.js';
 import { Types } from '@graphql-codegen/plugin-helpers';
 import { SchemaASTConfig } from '@graphql-codegen/schema-ast';
 import { GeneratorOptions } from 'graphql-typescript-deluxe';
-import { HookResult } from 'nuxt/schema';
-import { ContextType, GraphqlServerResponse, OperationResponseError } from '../dist/runtime/types.js';
 import { H3Event } from 'h3';
 import { FetchOptions, FetchResponse, FetchError } from 'ofetch';
 
+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.
+     */
+    codegenConfig?: GeneratorOptions;
+    /**
+     * Configuration for graphql-codegen when downloading the schema.
+     */
+    codegenSchemaConfig?: {
+        /**
+         * Configure how the schema.graphql file should be generated.
+         */
+        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',
+         *     }
+         *   }
+         * }
+         * ```
+         */
+        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 GraphqlMiddlewareRequestContext<C extends ContextType = ContextType> = {
     client?: Partial<C>;
 };
-type GraphqlMiddlewareGraphqlEndpointMethod<C extends ContextType> = (event?: H3Event, operation?: string, operationName?: string, context?: GraphqlMiddlewareRequestContext<C>) => string | Promise<string> | undefined;
-type GraphqlMiddlewareServerFetchOptionsMethod<C extends ContextType> = (event?: H3Event, operation?: string, operationName?: string, context?: GraphqlMiddlewareRequestContext<C>) => FetchOptions | Promise<FetchOptions>;
-type GraphqlMiddlewareOnServerResponseMethod<ServerReponse, T, C extends ContextType> = (event: H3Event, response: FetchResponse<ServerReponse>, operation?: string, operationName?: string, context?: GraphqlMiddlewareRequestContext<C>) => T | Promise<T>;
-type GraphqlMiddlewareOnServerErrorMethod<C extends ContextType> = (event: H3Event, error: FetchError, operation?: string, operationName?: string, context?: GraphqlMiddlewareRequestContext<C>) => any | Promise<any>;
+type GraphqlMiddlewareGraphqlEndpointMethod<C extends ContextType> = (event?: H3Event, operation?: string | null, operationName?: string | null, context?: GraphqlMiddlewareRequestContext<C> | null) => string | Promise<string> | undefined;
+type GraphqlMiddlewareServerFetchOptionsMethod<C extends ContextType> = (event?: H3Event, operation?: string | null, operationName?: string | null, context?: GraphqlMiddlewareRequestContext<C> | null) => FetchOptions | Promise<FetchOptions>;
+type GraphqlMiddlewareOnServerResponseMethod<ServerReponse, T, C extends ContextType> = (event: H3Event, response: FetchResponse<ServerReponse>, operation?: string | null, operationName?: string | null, context?: GraphqlMiddlewareRequestContext<C> | null) => T | Promise<T>;
+type GraphqlMiddlewareOnServerErrorMethod<C extends ContextType> = (event: H3Event, error: FetchError, operation?: string | null, operationName?: string | null, context?: GraphqlMiddlewareRequestContext<C> | null) => any | Promise<any>;
 type GraphqlMiddlewareDoRequestMethodContext<C extends ContextType> = {
     /**
      * The incoming request event from H3.
@@ -22,11 +187,11 @@ type GraphqlMiddlewareDoRequestMethodContext<C extends ContextType> = {
     /**
      * The type of operation.
      */
-    operation: 'query' | 'mutation';
+    operation?: 'query' | 'mutation';
     /**
      * The name of the operation.
      */
-    operationName: string;
+    operationName?: string;
     /**
      * The operation document (the raw GraphQL query/mutation as a string).
      */
@@ -199,160 +364,6 @@ type GraphqlMiddlewareServerOptions<Additions extends object = object, ResponseU
     doGraphqlRequest?: GraphqlMiddlewareDoRequestMethod<CustomResponse, C>;
 };
 
-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[];
-    /**
-     * 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.
-     *
-     * @default true
-     */
-    downloadSchema?: boolean;
-    /**
-     * The prefix for the server route.
-     *
-     * @default ```ts
-     * "/api/graphql_middleware"
-     * ```
-     */
-    serverApiPrefix?: string;
-    /**
-     * 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;
-    /**
-     * 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.
-     */
-    codegenConfig?: GeneratorOptions;
-    /**
-     * Configuration for graphql-codegen when downloading the schema.
-     */
-    codegenSchemaConfig?: {
-        /**
-         * Configure how the schema.graphql file should be generated.
-         */
-        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',
-         *     }
-         *   }
-         * }
-         * ```
-         */
-        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;
-    };
-}
 interface ModuleHooks {
 }
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
@@ -360,15 +371,34 @@ declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, fa
 declare module '@nuxt/schema' {
     interface AppConfig {
         graphqlMiddleware: {
+            /**
+             * Whether the client cache is enabled.
+             */
             clientCacheEnabled: boolean;
+            /**
+             * The max number of items in the cache.
+             */
             clientCacheMaxSize: number;
         };
     }
 }
 declare module '#app' {
     interface RuntimeNuxtHooks {
+        /**
+         * Emitted when any GraphQL response contains errors.
+         */
         'nuxt-graphql-middleware:errors': (errors: OperationResponseError) => HookResult;
     }
 }
+declare module 'vite/types/customEvent.d.ts' {
+    interface CustomEventMap {
+        /**
+         * Emitted when GraphQL operations have been updated.
+         */
+        'nuxt-graphql-middleware:reload': {
+            operations: string[];
+        };
+    }
+}
 
 export { type GraphqlMiddlewareServerOptions, type ModuleHooks, type ModuleOptions, _default as default };