nuxt-graphql-middleware 4.0.0-beta.7 → 4.0.0-beta.9

package/dist/module.d.mts

@@ -9,6 +9,32 @@ type GraphqlMiddlewareGraphqlEndpointMethod = (event?: H3Event, operation?: stri
 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>;
+type GraphqlMiddlewareDoRequestMethodContext = {
+    /**
+     * The incoming request event from H3.
+     */
+    event: H3Event;
+    /**
+     * The type of operation.
+     */
+    operation: 'query' | 'mutation';
+    /**
+     * The name of the operation.
+     */
+    operationName: string;
+    /**
+     * The operation document (the raw GraphQL query/mutation as a string).
+     */
+    operationDocument: string;
+    /**
+     * Variables for the operation.
+     */
+    variables: Record<string, any>;
+};
+type GraphqlMiddlewareDoRequestMethod = (context: GraphqlMiddlewareDoRequestMethodContext) => Promise<{
+    data: any;
+    errors?: any[];
+}>;
 /**
  * Configuration options during runtime.
  */
@@ -104,6 +130,42 @@ type GraphqlMiddlewareServerOptions = {
      * ```
      */
     onServerError?: GraphqlMiddlewareOnServerErrorMethod;
+    /**
+     * Provide a custom fetch method for requests to the GraphQL server.
+     *
+     * This can be used if onServerError, onServerResponse, serverFetchOptions
+     * and graphqlEndpoint are not enough to meet your requirements.
+     *
+     * The method will be called in the /api/graphql server route and should
+     * perform the GraphQL request and return the response.
+     *
+     * An example use case might be to handle expired tokens.
+     *
+     * * ```ts
+     * async function doGraphqlRequest({
+     *   event,
+     *   operation,
+     *   operationName,
+     *   operationDocument,
+     *   variables,
+     * }) {
+     *   const result = await $fetch.raw('https://example.com/graphql', {
+     *     method: 'POST'
+     *     body: {
+     *       query: operationDocument,
+     *       variables,
+     *       operationName
+     *     },
+     *     headers: {
+     *       'custom-header': 'foobar'
+     *     }
+     *   })
+     *
+     *   return result._data
+     * }
+     * ```
+     */
+    doGraphqlRequest?: GraphqlMiddlewareDoRequestMethod;
 };
 
 interface ModuleOptions {

package/dist/module.d.ts

@@ -9,6 +9,32 @@ type GraphqlMiddlewareGraphqlEndpointMethod = (event?: H3Event, operation?: stri
 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>;
+type GraphqlMiddlewareDoRequestMethodContext = {
+    /**
+     * The incoming request event from H3.
+     */
+    event: H3Event;
+    /**
+     * The type of operation.
+     */
+    operation: 'query' | 'mutation';
+    /**
+     * The name of the operation.
+     */
+    operationName: string;
+    /**
+     * The operation document (the raw GraphQL query/mutation as a string).
+     */
+    operationDocument: string;
+    /**
+     * Variables for the operation.
+     */
+    variables: Record<string, any>;
+};
+type GraphqlMiddlewareDoRequestMethod = (context: GraphqlMiddlewareDoRequestMethodContext) => Promise<{
+    data: any;
+    errors?: any[];
+}>;
 /**
  * Configuration options during runtime.
  */
@@ -104,6 +130,42 @@ type GraphqlMiddlewareServerOptions = {
      * ```
      */
     onServerError?: GraphqlMiddlewareOnServerErrorMethod;
+    /**
+     * Provide a custom fetch method for requests to the GraphQL server.
+     *
+     * This can be used if onServerError, onServerResponse, serverFetchOptions
+     * and graphqlEndpoint are not enough to meet your requirements.
+     *
+     * The method will be called in the /api/graphql server route and should
+     * perform the GraphQL request and return the response.
+     *
+     * An example use case might be to handle expired tokens.
+     *
+     * * ```ts
+     * async function doGraphqlRequest({
+     *   event,
+     *   operation,
+     *   operationName,
+     *   operationDocument,
+     *   variables,
+     * }) {
+     *   const result = await $fetch.raw('https://example.com/graphql', {
+     *     method: 'POST'
+     *     body: {
+     *       query: operationDocument,
+     *       variables,
+     *       operationName
+     *     },
+     *     headers: {
+     *       'custom-header': 'foobar'
+     *     }
+     *   })
+     *
+     *   return result._data
+     * }
+     * ```
+     */
+    doGraphqlRequest?: GraphqlMiddlewareDoRequestMethod;
 };
 
 interface ModuleOptions {

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "nuxt-graphql-middleware",
   "configKey": "graphqlMiddleware",
-  "version": "4.0.0-beta.7",
+  "version": "4.0.0-beta.9",
   "compatibility": {
     "nuxt": "^3.1.0"
   }

package/dist/module.mjs

@@ -20,7 +20,7 @@ import * as PluginSchemaAst from '@graphql-codegen/schema-ast';
 import { pascalCase } from 'change-case-all';
 
 const name = "nuxt-graphql-middleware";
-const version = "4.0.0-beta.7";
+const version = "4.0.0-beta.9";
 
 const DEVTOOLS_UI_ROUTE = "/__nuxt-graphql-middleware";
 const DEVTOOLS_UI_LOCAL_PORT = 3300;
@@ -303,7 +303,7 @@ function validateDeprecated(options) {
       );
       if (key === "graphqlEndpoint") {
         logger.info(`
-import { defineGraphqlServerOptions } from '#graphql-server-options'
+import { defineGraphqlServerOptions } from 'nuxt-graphql-middleware/dist/runtime/serverOptions'
 import { getHeader } from 'h3'
 import acceptLanguageParser from 'accept-language-parser';
 
@@ -321,7 +321,7 @@ export default defineGraphqlServerOptions({
       }
       if (key === "serverFetchOptions") {
         logger.info(`
-import { defineGraphqlServerOptions } from '#graphql-server-options'
+import { defineGraphqlServerOptions } from 'nuxt-graphql-middleware/dist/runtime/serverOptions'
 import { getHeader } from 'h3'
 
 // Pass the cookie from the client request to the GraphQL request.
@@ -337,7 +337,7 @@ export default defineGraphqlServerOptions({
       }
       if (key === "onServerResponse") {
         logger.info(`
-import { defineGraphqlServerOptions } from '#graphql-server-options'
+import { defineGraphqlServerOptions } from 'nuxt-graphql-middleware/dist/runtime/serverOptions'
 import type { H3Event } from 'h3'
 import type { FetchResponse } from 'ofetch'
 
@@ -362,7 +362,7 @@ export default defineGraphqlServerOptions({
       }
       if (key === "onServerError") {
         logger.info(`
-import { defineGraphqlServerOptions } from '#graphql-server-options'
+import { defineGraphqlServerOptions } from 'nuxt-graphql-middleware/dist/runtime/serverOptions'
 import type { H3Event } from 'h3'
 import type { FetchError } from 'ofetch'
 
@@ -557,7 +557,8 @@ async function generate(options, schemaPath, resolver, srcDir, logEverything = f
   const extracted = validated.filter(
     (v) => !v.operation
   );
-  validated.forEach((v) => {
+  for (let i = 0; i < validated.length; i++) {
+    const v = validated[i];
     if (v.isValid) {
       try {
         const node = parse(v.content);
@@ -589,15 +590,20 @@ async function generate(options, schemaPath, resolver, srcDir, logEverything = f
         });
       } catch (e) {
         logger.error(e);
+        extracted.push(v);
+        break;
       }
+    } else {
+      extracted.push(v);
+      break;
     }
-  });
+  }
   const templates = await generateTemplates(
     extracted.filter((v) => v.isValid).map((v) => v.content),
     schemaPath,
     options
   );
-  const hasErrors = extracted.some((v) => !v.isValid);
+  const hasErrors = extracted.some((v) => !v.isValid) || validated.some((v) => !v.isValid);
   if (hasErrors || logEverything) {
     const table = new Table({
       head: ["Operation", "Name", "File", "Errors"].map((v) => chalk.white(v))
@@ -831,9 +837,6 @@ 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 = (() => {

package/dist/runtime/serverHandler/index.mjs

@@ -1,4 +1,4 @@
-import { defineEventHandler, getQuery, getMethod, readBody } from "h3";
+import { defineEventHandler, getQuery, readBody } from "h3";
 import {
   queryParamToVariables,
   getEndpoint,
@@ -12,38 +12,59 @@ import { documents } from "#graphql-documents";
 import serverOptions from "#graphql-middleware-server-options-build";
 import { useRuntimeConfig } from "#imports";
 export default defineEventHandler(async (event) => {
-  const method = getMethod(event);
+  const method = event.method;
   const operation = event.context?.params?.operation;
-  const name = event.context?.params?.name;
-  validateRequest(method, operation, name, documents);
-  const query = documents[operation][name];
+  const operationName = event.context?.params?.name;
+  validateRequest(method, operation, operationName, documents);
+  const operationDocument = documents[operation][operationName];
+  const variables = operation === GraphqlMiddlewareOperation.Query ? queryParamToVariables(getQuery(event)) : await readBody(event);
+  if (serverOptions.doGraphqlRequest) {
+    return serverOptions.doGraphqlRequest({
+      event,
+      operation,
+      operationName,
+      operationDocument,
+      variables
+    });
+  }
   const runtimeConfig = useRuntimeConfig().graphqlMiddleware;
   const endpoint = await getEndpoint(
     runtimeConfig,
     serverOptions,
     event,
     operation,
-    name
+    operationName
   );
   const fetchOptions = await getFetchOptions(
     serverOptions,
     event,
     operation,
-    name
+    operationName
   );
-  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,
+      query: operationDocument,
       variables,
-      operationName: name
+      operationName
     },
     ...fetchOptions
   }).then((response) => {
-    return onServerResponse(serverOptions, event, response, operation, name);
+    return onServerResponse(
+      serverOptions,
+      event,
+      response,
+      operation,
+      operationName
+    );
   }).catch((error) => {
-    return onServerError(serverOptions, event, error, operation, name);
+    return onServerError(
+      serverOptions,
+      event,
+      error,
+      operation,
+      operationName
+    );
   });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-graphql-middleware",
-  "version": "4.0.0-beta.7",
+  "version": "4.0.0-beta.9",
   "description": "Module to perform GraphQL requests as a server middleware.",
   "repository": {
     "type": "git",
@@ -12,7 +12,8 @@
     ".": {
       "import": "./dist/module.mjs",
       "require": "./dist/module.cjs"
-    }
+    },
+    "./dist/runtime/serverOptions": "./dist/runtime/serverOptions/index.mjs"
   },
   "main": "./dist/module.cjs",
   "types": "./dist/types.d.ts",
@@ -59,12 +60,10 @@
     "@nuxt/devtools-ui-kit": "0.8.5",
     "@nuxt/module-builder": "^0.5.2",
     "@nuxt/schema": "^3.7.4",
-    "@nuxt/test-utils": "^3.7.4",
     "@nuxtjs/eslint-config-typescript": "^12.1.0",
     "@types/capture-console": "^1.0.2",
     "@types/cli-table": "^0.3.2",
     "@types/inquirer": "^9.0.3",
-    "@vitest/coverage-c8": "^0.30.1",
     "cypress": "^13.3.0",
     "eslint": "^8.50.0",
     "eslint-config-prettier": "^9.0.0",