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

package/dist/module.d.mts

@@ -1,178 +1,38 @@
 import * as _nuxt_schema from '@nuxt/schema';
-import { HookResult } from 'nuxt/schema';
+import { M as ModuleContext, a as ModuleOptions } from './shared/nuxt-graphql-middleware.-BeiPV4H.mjs';
 import { OperationResponseError } from '../dist/runtime/types.js';
-export { GraphqlMiddlewareServerOptions } 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 { GeneratorOutput } from 'graphql-typescript-deluxe';
+import 'graphql';
+import '@nuxt/kit';
+import 'h3';
+import '@graphql-codegen/plugin-helpers';
+import '@graphql-codegen/schema-ast';
+
+type BuildHookContext = {
+    output: GeneratorOutput;
+};
 
-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?: {
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
+
+declare module '#app' {
+    interface RuntimeNuxtHooks {
         /**
-         * Configure how the schema.graphql file should be generated.
+         * Emitted when any GraphQL response contains errors.
          */
-        schemaAstConfig?: SchemaASTConfig;
+        'nuxt-graphql-middleware:errors': (errors: OperationResponseError) => HookResult;
+    }
+}
+declare module 'vite/types/customEvent.d.ts' {
+    interface CustomEventMap {
         /**
-         * 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',
-         *     }
-         *   }
-         * }
-         * ```
+         * Emitted when GraphQL operations have been updated.
          */
-        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;
-    };
+        'nuxt-graphql-middleware:reload': {
+            operations: string[];
+        };
+    }
 }
-
-declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
-
 declare module '@nuxt/schema' {
     interface AppConfig {
         graphqlMiddleware: {
@@ -186,25 +46,47 @@ declare module '@nuxt/schema' {
             clientCacheMaxSize: number;
         };
     }
-}
-declare module '#app' {
-    interface RuntimeNuxtHooks {
+    interface Nuxt {
         /**
-         * Emitted when any GraphQL response contains errors.
+         * The nuxt-graphql-middleware module context.
          */
-        'nuxt-graphql-middleware:errors': (errors: OperationResponseError) => HookResult;
+        _nuxt_graphql_middleware?: ModuleContext;
     }
-}
-declare module 'vite/types/customEvent.d.ts' {
-    interface CustomEventMap {
+    interface NuxtHooks {
         /**
-         * Emitted when GraphQL operations have been updated.
+         * Called once right before the documents are initialised.
+         *
+         * Use this hook to add any additional documents based on for example the parsed schema.
+         *
+         * @example
+         *
+         * ```typescript`
+         * export default defineNuxtConfig({
+         *   hooks: {
+         *     'nuxt-graphql-middleware:init': (ctx) => {
+         *       if (ctx.schemaHasType('Comment')) {
+         *         ctx.addDocument(
+         *           'queryFromHook',
+         *           `query loadComments { author subject date body }`
+         *         )
+         *       }
+         *     },
+         *   },
+         * })
+         * ```
          */
-        'nuxt-graphql-middleware:reload': {
-            operations: string[];
-        };
+        'nuxt-graphql-middleware:init': (ctx: ModuleContext) => void | Promise<void>;
+        /**
+         * Called when building the state and templates.
+         *
+         * Generally this hook is called from within the builder:watch event, when
+         * a GraphQL file change was detected.
+         *
+         * The received argument is the output from the graphql-typescript-deluxe
+         * generator.
+         */
+        'nuxt-graphql-middleware:build': (ctx: BuildHookContext) => void | Promise<void>;
     }
 }
 
-export { _default as default };
-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.9",
+  "version": "5.1.0",
   "compatibility": {
-    "nuxt": ">=3.15.0"
+    "nuxt": ">=3.17.0"
   },
   "builder": {
-    "@nuxt/module-builder": "0.8.4",
-    "unbuild": "2.0.0"
+    "@nuxt/module-builder": "1.0.1",
+    "unbuild": "3.5.0"
   }
 }