nuxt-graphql-middleware 3.1.0-beta.1 → 3.1.0-beta.3

package/dist/module.d.ts

@@ -1,13 +1,112 @@
-import { NuxtModule } from '@nuxt/schema';
+import * as _nuxt_schema from '@nuxt/schema';
+import { Types } from '@graphql-codegen/plugin-helpers';
+import { SchemaASTConfig } from '@graphql-codegen/schema-ast';
+import { TypeScriptDocumentsPluginConfig } from '@graphql-codegen/typescript-operations';
 import { H3Event } from 'h3';
 import { FetchOptions, FetchResponse, FetchError } from 'ofetch';
-import { TypeScriptDocumentsPluginConfig } from '@graphql-codegen/typescript-operations';
 
 type GraphqlMiddlewareGraphqlEndpointMethod = (event?: H3Event, operation?: string, operationName?: string) => string | Promise<string> | void;
 type GraphqlMiddlewareServerFetchOptionsMethod = (event?: H3Event, operation?: string, operationName?: string) => FetchOptions | Promise<FetchOptions>;
 type GraphqlMiddlewareOnServerResponseMethod = (event: H3Event, response: FetchResponse<any>, operation?: string, operationName?: string) => any | Promise<any>;
 type GraphqlMiddlewareOnServerErrorMethod = (event: H3Event, error: FetchError, operation?: string, operationName?: string) => any | Promise<any>;
-interface GraphqlMiddlewareConfig {
+/**
+ * Configuration options during runtime.
+ */
+type GraphqlMiddlewareServerOptions = {
+    /**
+     * Custom callback to return the GraphQL endpoint per request.
+     *
+     * @default undefined
+     *
+     * @example
+     * ```ts
+     * function graphqlEndpoint(event, operation, operationName) {
+     *   const language = getLanguageFromRequest(event)
+     *   return `https://api.example.com/${language}/graphql`
+     * }
+     * ```
+     */
+    graphqlEndpoint?: GraphqlMiddlewareGraphqlEndpointMethod;
+    /**
+     * Provide the options for the ofetch request to the GraphQL server.
+     *
+     * @default undefined
+     *
+     * @example
+     * ```ts
+     * import { getHeader } from 'h3'
+     *
+     * // Pass the cookie from the client request to the GraphQL request.
+     * function serverFetchOptions(event, operation, operationName) {
+     *   return {
+     *     headers: {
+     *       Cookie: getHeader(event, 'cookie')
+     *     }
+     *   }
+     * }
+     * ```
+     */
+    serverFetchOptions?: GraphqlMiddlewareServerFetchOptionsMethod;
+    /**
+     * Handle the response from the GraphQL server.
+     *
+     * You can alter the response, add additional properties to the data, get
+     * and set headers, etc.
+     *
+     * ```ts
+     * import type { H3Event } from 'h3'
+     * import type { FetchResponse } from 'ofetch'
+     *
+     * function onServerResponse(event: H3Event, graphqlResponse: FetchResponse) {
+     *   // Set a static header.
+     *   event.node.res.setHeader('x-nuxt-custom-header', 'A custom header value')
+     *
+     *   // Pass the set-cookie header from the GraphQL response to the client.
+     *   const setCookie = graphqlResponse.headers.get('set-cookie')
+     *   if (setCookie) {
+     *     event.node.res.setHeader('set-cookie', setCookie)
+     *   }
+     *
+     *   // Add additional properties to the response.
+     *   graphqlResponse._data.__customProperty = ['My', 'values']
+     *
+     *   // Return the GraphQL response.
+     *   return graphqlResponse._data
+     * }
+     * ```
+     */
+    onServerResponse?: GraphqlMiddlewareOnServerResponseMethod;
+    /**
+     * Handle a fetch error from the GraphQL request.
+     *
+     * Note that errors are only thrown for responses that are not status
+     * 200-299. See https://github.com/unjs/ofetch#%EF%B8%8F-handling-errors for
+     * more information.
+     *
+     * ```ts
+     * import { createError } from 'h3'
+     * import type { H3Event } from 'h3'
+     * import type { FetchError } from 'ofetch'
+     *
+     * function onServerError(
+     *   event: H3Event,
+     *   error: FetchError,
+     *   operation: string,
+     *   operationName: string,
+     * ) {
+     *   // Throw a h3 error.
+     *   throw createError({
+     *     statusCode: 500,
+     *     statusMessage: `Couldn't execute GraphQL ${operation} "${operationName}".`,
+     *     data: error.message
+     *   })
+     * }
+     * ```
+     */
+    onServerError?: GraphqlMiddlewareOnServerErrorMethod;
+};
+
+interface ModuleOptions {
     /**
      * File glob patterns for the auto import feature.
      *
@@ -96,7 +195,8 @@ interface GraphqlMiddlewareConfig {
      */
     schemaPath?: string;
     /**
-     * These options are passed to the graphql-codegen method when generating the operations types.
+     * These options are passed to the graphql-codegen method when generating the
+     * TypeScript operations types.
      *
      * {@link https://www.the-guild.dev/graphql/codegen/plugins/typescript/typescript-operations}
      * @default
@@ -115,106 +215,33 @@ interface GraphqlMiddlewareConfig {
      * ```
      */
     codegenConfig?: TypeScriptDocumentsPluginConfig;
-}
-/**
- * Configuration options during runtime.
- */
-type GraphqlMiddlewareServerOptions = {
-    /**
-     * Custom callback to return the GraphQL endpoint per request.
-     *
-     * @default undefined
-     *
-     * @example
-     * ```ts
-     * function graphqlEndpoint(event, operation, operationName) {
-     *   const language = getLanguageFromRequest(event)
-     *   return `https://api.example.com/${language}/graphql`
-     * }
-     * ```
-     */
-    graphqlEndpoint?: GraphqlMiddlewareGraphqlEndpointMethod;
-    /**
-     * Provide the options for the ofetch request to the GraphQL server.
-     *
-     * @default undefined
-     *
-     * @example
-     * ```ts
-     * import { getHeader } from 'h3'
-     *
-     * // Pass the cookie from the client request to the GraphQL request.
-     * function serverFetchOptions(event, operation, operationName) {
-     *   return {
-     *     headers: {
-     *       Cookie: getHeader(event, 'cookie')
-     *     }
-     *   }
-     * }
-     * ```
-     */
-    serverFetchOptions?: GraphqlMiddlewareServerFetchOptionsMethod;
-    /**
-     * Handle the response from the GraphQL server.
-     *
-     * You can alter the response, add additional properties to the data, get
-     * and set headers, etc.
-     *
-     * ```ts
-     * import type { H3Event } from 'h3'
-     * import type { FetchResponse } from 'ofetch'
-     *
-     * function onServerResponse(event: H3Event, graphqlResponse: FetchResponse) {
-     *   // Set a static header.
-     *   event.node.res.setHeader('x-nuxt-custom-header', 'A custom header value')
-     *
-     *   // Pass the set-cookie header from the GraphQL response to the client.
-     *   const setCookie = graphqlResponse.headers.get('set-cookie')
-     *   if (setCookie) {
-     *     event.node.res.setHeader('set-cookie', setCookie)
-     *   }
-     *
-     *   // Add additional properties to the response.
-     *   graphqlResponse._data.__customProperty = ['My', 'values']
-     *
-     *   // Return the GraphQL response.
-     *   return graphqlResponse._data
-     * }
-     * ```
-     */
-    onServerResponse?: GraphqlMiddlewareOnServerResponseMethod;
     /**
-     * Handle a fetch error from the GraphQL request.
-     *
-     * Note that errors are only thrown for responses that are not status
-     * 200-299. See https://github.com/unjs/ofetch#%EF%B8%8F-handling-errors for
-     * more information.
-     *
-     * ```ts
-     * import { createError } from 'h3'
-     * import type { H3Event } from 'h3'
-     * import type { FetchError } from 'ofetch'
-     *
-     * function onServerError(
-     *   event: H3Event,
-     *   error: FetchError,
-     *   operation: string,
-     *   operationName: string,
-     * ) {
-     *   // Throw a h3 error.
-     *   throw createError({
-     *     statusCode: 500,
-     *     statusMessage: `Couldn't execute GraphQL ${operation} "${operationName}".`,
-     *     data: error.message
-     *   })
-     * }
-     * ```
+     * Configuration for graphql-codegen when downloading the schema.
      */
-    onServerError?: GraphqlMiddlewareOnServerErrorMethod;
-};
-
-type ModuleOptions = GraphqlMiddlewareConfig;
+    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;
+    };
+}
 type ModuleHooks = {};
-declare const _default: NuxtModule<GraphqlMiddlewareConfig>;
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
 
 export { GraphqlMiddlewareServerOptions, ModuleHooks, ModuleOptions, _default as default };

package/dist/module.json

@@ -1,8 +1,8 @@
 {
   "name": "nuxt-graphql-middleware",
   "configKey": "graphqlMiddleware",
-  "version": "3.1.0-beta.1",
+  "version": "3.1.0-beta.3",
   "compatibility": {
-    "nuxt": "^3.0.0"
+    "nuxt": "^3.1.0"
   }
 }

package/dist/module.mjs

@@ -17,7 +17,7 @@ import { oldVisit } from '@graphql-codegen/plugin-helpers';
 import { pascalCase } from 'change-case-all';
 
 const name = "nuxt-graphql-middleware";
-const version = "3.1.0-beta.1";
+const version = "3.1.0-beta.3";
 
 var GraphqlMiddlewareTemplate = /* @__PURE__ */ ((GraphqlMiddlewareTemplate2) => {
   GraphqlMiddlewareTemplate2["OperationTypes"] = "graphql-operations.d.ts";
@@ -165,24 +165,25 @@ function pluginLoader(name) {
     return Promise.resolve(PluginSchemaAst);
   }
 }
-function generateSchema(url, dest, writeToDisk) {
-  return generate$1(
-    {
-      schema: url,
-      pluginLoader,
-      silent: true,
-      errorsOnly: true,
-      generates: {
-        [dest]: {
-          plugins: ["schema-ast"],
-          config: {
-            sort: true
-          }
-        }
+function generateSchema(moduleOptions, dest, writeToDisk) {
+  const pluginConfig = moduleOptions.codegenSchemaConfig?.urlSchemaOptions;
+  const schemaAstConfig = moduleOptions.codegenSchemaConfig?.schemaAstConfig || {
+    sort: true
+  };
+  const config = {
+    schema: moduleOptions.graphqlEndpoint,
+    pluginLoader,
+    silent: true,
+    errorsOnly: true,
+    config: pluginConfig,
+    generates: {
+      [dest]: {
+        plugins: ["schema-ast"],
+        config: schemaAstConfig
       }
-    },
-    writeToDisk
-  ).then((v) => v[0]);
+    }
+  };
+  return generate$1(config, writeToDisk).then((v) => v[0]);
 }
 function generateTemplates(documents, schemaPath, options) {
   return executeCodegen({
@@ -255,7 +256,7 @@ function validateDeprecated(options) {
       );
       if (key === "graphqlEndpoint") {
         logger.info(`
-import { defineGraphqlServerOptions } from 'nuxt-graphql-middleware/server'
+import { defineGraphqlServerOptions } from '#graphql-server-options'
 import { getHeader } from 'h3'
 import acceptLanguageParser from 'accept-language-parser';
 
@@ -273,7 +274,7 @@ export default defineGraphqlServerOptions({
       }
       if (key === "serverFetchOptions") {
         logger.info(`
-import { defineGraphqlServerOptions } from 'nuxt-graphql-middleware/server'
+import { defineGraphqlServerOptions } from '#graphql-server-options'
 import { getHeader } from 'h3'
 
 // Pass the cookie from the client request to the GraphQL request.
@@ -289,7 +290,7 @@ export default defineGraphqlServerOptions({
       }
       if (key === "onServerResponse") {
         logger.info(`
-import { defineGraphqlServerOptions } from 'nuxt-graphql-middleware/server'
+import { defineGraphqlServerOptions } from '#graphql-server-options'
 import type { H3Event } from 'h3'
 import type { FetchResponse } from 'ofetch'
 
@@ -314,7 +315,7 @@ export default defineGraphqlServerOptions({
       }
       if (key === "onServerError") {
         logger.info(`
-import { defineGraphqlServerOptions } from 'nuxt-graphql-middleware/server'
+import { defineGraphqlServerOptions } from '#graphql-server-options'
 import type { H3Event } from 'h3'
 import type { FetchError } from 'ofetch'
 
@@ -353,7 +354,7 @@ async function getSchemaPath(options, resolver, writeToDisk = false) {
   if (!options.graphqlEndpoint) {
     throw new Error("Missing graphqlEndpoint config.");
   }
-  await generateSchema(options.graphqlEndpoint, dest, writeToDisk);
+  await generateSchema(options, dest, writeToDisk);
   return dest;
 }
 async function autoImportDocuments(patterns = [], srcResolver) {
@@ -494,7 +495,7 @@ const module = defineNuxtModule({
     configKey: "graphqlMiddleware",
     version,
     compatibility: {
-      nuxt: "^3.0.0"
+      nuxt: "^3.1.0"
     }
   },
   defaults: defaultOptions,
@@ -609,6 +610,9 @@ declare module '#graphql-documents' {
 `;
       }
     });
+    nuxt.options.alias["#graphql-server-options"] = moduleResolver(
+      "runtime/serverOptions"
+    );
     const extensions = ["js", "mjs", "ts"];
     const resolvedPath = "~/app/graphqlMiddleware.serverOptions".replace(/^(~~|@@)/, nuxt.options.rootDir).replace(/^(~|@)/, nuxt.options.srcDir);
     const template = (() => {
@@ -630,7 +634,7 @@ declare module '#graphql-documents' {
     nuxt.options.nitro.externals = nuxt.options.nitro.externals || {};
     nuxt.options.nitro.externals.inline = nuxt.options.nitro.externals.inline || [];
     nuxt.options.nitro.externals.inline.push(template.dst);
-    nuxt.options.alias["#graphql-middleware-server-options"] = template.dst;
+    nuxt.options.alias["#graphql-middleware-server-options-build"] = template.dst;
     addServerHandler({
       handler: moduleResolver("./runtime/serverHandler/index"),
       route: options.serverApiPrefix + "/:operation/:name"

package/dist/runtime/composables/index.mjs

@@ -18,6 +18,7 @@ export function useGraphqlQuery(...args) {
   const state2 = useGraphqlState();
   return $fetch(getEndpoint("query", name), {
     params: buildRequestParams(args[1]),
+    // @todo: Remove any once https://github.com/unjs/nitro/pull/883 is released.
     ...state2.fetchOptions
   });
 }
@@ -29,6 +30,7 @@ export function useGraphqlMutation(...args) {
     return Promise.reject(new Error("Invalid mutation name"));
   }
   return $fetch(getEndpoint("mutation", name), {
+    // @todo: Remove any once https://github.com/unjs/nitro/pull/883 is released.
     method: "post",
     body,
     ...state2.fetchOptions

package/dist/runtime/serverHandler/index.mjs

@@ -10,7 +10,7 @@ import {
 import { GraphqlMiddlewareOperation } from "./../settings/index.mjs";
 import { documents } from "#graphql-documents";
 import { useRuntimeConfig } from "#imports";
-import serverOptions from "#graphql-middleware-server-options";
+import serverOptions from "#graphql-middleware-server-options-build";
 export default defineEventHandler(async (event) => {
   const method = getMethod(event);
   const operation = event.context.params.operation;
@@ -33,6 +33,7 @@ export default defineEventHandler(async (event) => {
   );
   const variables = operation === GraphqlMiddlewareOperation.Query ? queryParamToVariables(getQuery(event)) : await readBody(event);
   return $fetch.raw(endpoint, {
+    // @todo: Remove any once https://github.com/unjs/nitro/pull/883 is released.
     method: "POST",
     body: {
       query,

package/dist/runtime/serverOptions/defineGraphqlServerOptions.d.ts

@@ -0,0 +1,2 @@
+import { GraphqlMiddlewareServerOptions } from './../../types';
+export declare function defineGraphqlServerOptions(options: GraphqlMiddlewareServerOptions): GraphqlMiddlewareServerOptions;

package/dist/runtime/serverOptions/defineGraphqlServerOptions.mjs

@@ -0,0 +1,3 @@
+export function defineGraphqlServerOptions(options) {
+  return options;
+}

package/dist/runtime/serverOptions/index.d.ts

@@ -1,2 +1,2 @@
-import type { GraphqlMiddlewareServerOptions } from './../../types';
-export declare function defineGraphqlServerOptions(options: GraphqlMiddlewareServerOptions): GraphqlMiddlewareServerOptions;
+import { defineGraphqlServerOptions } from './defineGraphqlServerOptions';
+export { defineGraphqlServerOptions };

package/dist/runtime/serverOptions/index.mjs

@@ -1,3 +1,2 @@
-export function defineGraphqlServerOptions(options) {
-  return options;
-}
+import { defineGraphqlServerOptions } from "./defineGraphqlServerOptions.mjs";
+export { defineGraphqlServerOptions };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-graphql-middleware",
-  "version": "3.1.0-beta.1",
+  "version": "3.1.0-beta.3",
   "description": "Module to perform GraphQL requests as a server middleware.",
   "repository": {
     "type": "git",
@@ -12,9 +12,7 @@
     ".": {
       "import": "./dist/module.mjs",
       "require": "./dist/module.cjs"
-    },
-    "./server": "./dist/runtime/serverOptions/index.mjs",
-    "./server/*": "./dist/runtime/serverOptions/*.mjs"
+    }
   },
   "main": "./dist/module.cjs",
   "types": "./dist/types.d.ts",
@@ -37,11 +35,11 @@
     "test:coverage": "vitest run --coverage"
   },
   "dependencies": {
-    "@graphql-codegen/cli": "^2.15.0",
-    "@graphql-codegen/schema-ast": "^2.5.1",
-    "@graphql-codegen/typescript": "^2.8.3",
+    "@graphql-codegen/cli": "^2.16.4",
+    "@graphql-codegen/schema-ast": "^2.6.1",
+    "@graphql-codegen/typescript": "^2.8.7",
     "@graphql-codegen/typescript-generic-sdk": "^3.0.4",
-    "@graphql-codegen/typescript-operations": "^2.5.8",
+    "@graphql-codegen/typescript-operations": "^2.5.12",
     "@graphql-fragment-import/lib": "^2.0.0",
     "@graphql-tools/utils": "^9.1.1",
     "@nuxt/kit": "^3.0.0",
@@ -51,21 +49,21 @@
   "devDependencies": {
     "@nuxt/module-builder": "^0.2.1",
     "@nuxt/schema": "^3.0.0",
-    "@nuxt/test-utils": "^3.0.0",
+    "@nuxt/test-utils": "^3.1.1",
     "@nuxtjs/eslint-config-typescript": "^12.0.0",
     "@types/capture-console": "^1.0.1",
     "@types/cli-table": "^0.3.1",
     "@types/inquirer": "^9.0.3",
-    "@vitest/coverage-c8": "^0.25.3",
+    "@vitest/coverage-c8": "^0.25.8",
     "cypress": "^11.2.0",
-    "eslint": "^8.29.0",
-    "eslint-config-prettier": "^8.5.0",
+    "eslint": "^8.33.0",
+    "eslint-config-prettier": "^8.6.0",
     "eslint-plugin-prettier": "^4.2.1",
     "jsdoc-to-markdown": "^8.0.0",
-    "nuxt": "^3.0.0",
-    "prettier": "^2.8.0",
+    "nuxt": "^3.1.1",
+    "prettier": "^2.8.3",
     "strip-ansi": "^7.0.1",
-    "typedoc": "^0.23.21",
+    "typedoc": "^0.23.24",
     "typedoc-plugin-markdown": "^3.14.0",
     "vitepress": "^1.0.0-alpha.30",
     "vitest": "^0.25.3"