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

package/dist/runtime/components/CodeFrame.vue

@@ -44,7 +44,7 @@ const lines = computed(() => {
   const sliced = fullLines.slice(indexStart, indexEnd)
 
   // Remove trailing empty lines
-  while (sliced.length && !sliced[sliced.length - 1].trim()) {
+  while (sliced.length && !sliced[sliced.length - 1]?.trim()) {
     sliced.pop()
   }
 

package/dist/runtime/composables/useAsyncGraphqlQuery.d.ts

@@ -6,7 +6,7 @@ import type { GraphqlResponse } from '#nuxt-graphql-middleware/response';
 import type { RequestCacheOptions } from './../types.js';
 import type { AsyncData, AsyncDataOptions, NuxtError } from '#app';
 import type { DefaultAsyncDataValue } from 'nuxt/app/defaults';
-import type { Query } from '#nuxt-graphql-middleware/operations';
+import type { Query } from '#nuxt-graphql-middleware/operation-types';
 type AsyncGraphqlQueryOptions<FetchOptions, ResT, DataT = ResT, PickKeys extends KeysOf<DataT> = KeysOf<DataT>, DefaultT = DefaultAsyncDataValue> = AsyncDataOptions<ResT, DataT, PickKeys, DefaultT> & {
     /**
      * Control how the GraphQL response can be cached.

package/dist/runtime/composables/useAsyncGraphqlQuery.js

@@ -32,7 +32,7 @@ export function useAsyncGraphqlQuery(name, ...args) {
       };
     }
   }
-  return useAsyncData(
+  const result = useAsyncData(
     key,
     () => {
       const globalClientContext = clientOptions.buildClientContext ? clientOptions.buildClientContext() : {};
@@ -56,4 +56,12 @@ export function useAsyncGraphqlQuery(name, ...args) {
     },
     asyncDataOptions
   );
+  if (import.meta.hot) {
+    import.meta.hot.on("nuxt-graphql-middleware:reload", (data) => {
+      if (data.operations.includes(name)) {
+        result.refresh();
+      }
+    });
+  }
+  return result;
 }

package/dist/runtime/composables/useGraphqlMutation.d.ts

@@ -1,6 +1,6 @@
 import { type GetMutationArgs, type MutationObjectArgs, type GetMutationResult } from './../helpers/composables.js';
 import type { GraphqlResponse } from '#nuxt-graphql-middleware/response';
-import type { Mutation } from '#nuxt-graphql-middleware/operations';
+import type { Mutation } from '#nuxt-graphql-middleware/operation-types';
 /**
  * Performs a GraphQL mutation.
  */

package/dist/runtime/composables/useGraphqlQuery.d.ts

@@ -1,6 +1,6 @@
 import { type GetQueryArgs, type QueryObjectArgs, type GetQueryResult } from './../helpers/composables.js';
 import type { GraphqlResponse } from '#nuxt-graphql-middleware/response';
-import type { Query } from '#nuxt-graphql-middleware/operations';
+import type { Query } from '#nuxt-graphql-middleware/operation-types';
 /**
  * Performs a GraphQL query.
  */

package/dist/runtime/composables/useGraphqlUploadMutation.d.ts

@@ -1,6 +1,6 @@
 import { type GetMutationArgs, type MutationObjectArgs, type GetMutationResult } from './../helpers/composables.js';
 import type { GraphqlResponse } from '#nuxt-graphql-middleware/response';
-import type { Mutation } from '#nuxt-graphql-middleware/operations';
+import type { Mutation } from '#nuxt-graphql-middleware/operation-types';
 /**
  * Performs a GraphQL upload mutation.
  */

package/dist/runtime/helpers/composables.d.ts

@@ -1,7 +1,7 @@
 import type { FetchOptions } from 'ofetch';
 import type { RequestCacheOptions } from './../types.js';
 import type { GraphqlClientContext } from '#nuxt-graphql-middleware/client-options';
-import type { Query, Mutation } from '#nuxt-graphql-middleware/operations';
+import type { Query, Mutation } from '#nuxt-graphql-middleware/operation-types';
 export type GraphqlComposableOptions = {
     fetchOptions?: FetchOptions;
     graphqlCaching?: RequestCacheOptions;

package/dist/runtime/server/api/mutation.js

@@ -0,0 +1,28 @@
+import { defineEventHandler, getQuery, getRouterParam, readBody } from "h3";
+import {
+  extractRequestContext,
+  isValidMutation,
+  throwError
+} from "./../helpers/index.js";
+import { GraphqlMiddlewareOperation } from "./../../settings/index.js";
+import { documents } from "#nuxt-graphql-middleware/documents";
+import { doGraphqlRequest } from "../utils/doGraphqlRequest.js";
+export default defineEventHandler(async (event) => {
+  const operationName = getRouterParam(event, "name");
+  if (!isValidMutation(operationName)) {
+    return throwError("Invalid mutation name.");
+  }
+  const operationDocument = documents.mutation[operationName];
+  const queryParams = getQuery(event);
+  const context = extractRequestContext(queryParams);
+  const variables = await readBody(event);
+  return doGraphqlRequest(
+    {
+      query: operationDocument,
+      variables,
+      operation: GraphqlMiddlewareOperation.Mutation
+    },
+    context,
+    event
+  );
+});

package/dist/runtime/server/api/query.js

@@ -0,0 +1,29 @@
+import { defineEventHandler, getQuery, getRouterParam } from "h3";
+import {
+  queryParamToVariables,
+  extractRequestContext,
+  isValidQuery,
+  throwError
+} from "./../helpers/index.js";
+import { GraphqlMiddlewareOperation } from "./../../settings/index.js";
+import { documents } from "#nuxt-graphql-middleware/documents";
+import { doGraphqlRequest } from "../utils/doGraphqlRequest.js";
+export default defineEventHandler(async (event) => {
+  const operationName = getRouterParam(event, "name");
+  if (!isValidQuery(operationName)) {
+    return throwError("Invalid query name.");
+  }
+  const operationDocument = documents.query[operationName];
+  const queryParams = getQuery(event);
+  const context = extractRequestContext(queryParams);
+  const variables = queryParamToVariables(queryParams);
+  return doGraphqlRequest(
+    {
+      query: operationDocument,
+      variables,
+      operation: GraphqlMiddlewareOperation.Query
+    },
+    context,
+    event
+  );
+});

package/dist/runtime/server/api/upload.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<any>>;
+export default _default;

package/dist/runtime/{serverHandler → server/api}/upload.js

@@ -1,21 +1,22 @@
 import {
   defineEventHandler,
   readMultipartFormData,
-  getQuery
+  getQuery,
+  getRouterParam
 } from "h3";
 import {
   getEndpoint,
   getFetchOptions,
-  validateRequest,
   onServerResponse,
   onServerError,
   throwError,
-  extractRequestContext
-} from "./helpers/index.js";
-import { GraphqlMiddlewareOperation } from "./../settings/index.js";
+  extractRequestContext,
+  isValidMutation
+} from "./../helpers/index.js";
 import { documents } from "#nuxt-graphql-middleware/documents";
 import { serverOptions } from "#nuxt-graphql-middleware/server-options";
 import { useRuntimeConfig } from "#imports";
+import { GraphqlMiddlewareOperation } from "../../settings/index.js";
 function parseMultipart(data) {
   const files = data.filter((v) => !!v.filename);
   const variablesData = data.find((v) => v.name === "variables")?.data?.toString();
@@ -27,11 +28,12 @@ function parseMultipart(data) {
   return { files, map, variables };
 }
 export default defineEventHandler(async (event) => {
-  const method = event.method;
   const operation = GraphqlMiddlewareOperation.Mutation;
-  const operationName = event.context?.params?.name;
-  validateRequest(method, operation, operationName, documents);
-  const operationDocument = documents[operation][operationName];
+  const operationName = getRouterParam(event, "name");
+  if (!isValidMutation(operationName)) {
+    return throwError("Invalid mutation name.");
+  }
+  const operationDocument = documents.mutation[operationName];
   const multiPartData = await readMultipartFormData(event);
   if (!multiPartData) {
     return throwError("Failed to read multi part data.");

package/dist/runtime/{serverHandler → server}/helpers/index.d.ts

@@ -2,8 +2,10 @@ import { type QueryObject } from 'ufo';
 import type { H3Event } from 'h3';
 import type { FetchOptions, FetchResponse, FetchError } from 'ofetch';
 import type { GraphqlMiddlewareRequestContext, GraphqlMiddlewareRuntimeConfig, GraphqlMiddlewareServerOptions } from './../../../types.js';
-import { GraphqlMiddlewareOperation } from './../../settings/index.js';
-import type { Documents } from '#nuxt-graphql-middleware/documents';
+import { type GraphqlMiddlewareOperation } from './../../settings/index.js';
+import type { Mutation, Query } from '#nuxt-graphql-middleware/operation-types';
+export declare function isValidMutation(v?: string): v is keyof Mutation;
+export declare function isValidQuery(v?: string): v is keyof Query;
 export declare function queryParamToVariables(query: QueryObject): any;
 /**
  * Extract the client context from the query params.
@@ -12,21 +14,17 @@ export declare function extractRequestContext(query: QueryObject): GraphqlMiddle
 /**
  * Get the URL of the GraphQL endpoint.
  */
-export declare function getEndpoint(config: GraphqlMiddlewareRuntimeConfig, serverOptions: GraphqlMiddlewareServerOptions<any, any>, event: H3Event, operation: GraphqlMiddlewareOperation, operationName: string, context: GraphqlMiddlewareRequestContext<any>): string | Promise<string>;
+export declare function getEndpoint(config: GraphqlMiddlewareRuntimeConfig, serverOptions: GraphqlMiddlewareServerOptions<any, any>, event: H3Event, operation: GraphqlMiddlewareOperation | null, operationName: string | null, context: GraphqlMiddlewareRequestContext<any> | null): string | Promise<string>;
 /**
  * Get the options for the $fetch request to the GraphQL server.
  */
-export declare function getFetchOptions(serverOptions: GraphqlMiddlewareServerOptions<any, any>, event: H3Event, operation: GraphqlMiddlewareOperation, operationName: string, context: GraphqlMiddlewareRequestContext<any>): FetchOptions | Promise<FetchOptions>;
+export declare function getFetchOptions(serverOptions: GraphqlMiddlewareServerOptions<any, any>, event: H3Event, operation: GraphqlMiddlewareOperation | null, operationName: string | null, context: GraphqlMiddlewareRequestContext<any> | null): FetchOptions | Promise<FetchOptions>;
 export declare function throwError(statusMessage: string, statusCode?: number): never;
-/**
- * Assure that the request is valid.
- */
-export declare function validateRequest(method?: string, operation?: GraphqlMiddlewareOperation | string, name?: string, documents?: Documents): void;
 /**
  * Handle GraphQL server response.
  */
-export declare function onServerResponse(serverOptions: GraphqlMiddlewareServerOptions<any, any>, event: H3Event, response: FetchResponse<any>, operation: string, operationName: string, context: GraphqlMiddlewareRequestContext<any>): any;
+export declare function onServerResponse(serverOptions: GraphqlMiddlewareServerOptions<any, any>, event: H3Event, response: FetchResponse<any>, operation: string | null, operationName: string | null, context: GraphqlMiddlewareRequestContext<any> | null): any;
 /**
  * Handle GraphQL server errors.
  */
-export declare function onServerError(serverOptions: GraphqlMiddlewareServerOptions<any, any>, event: H3Event, error: FetchError, operation: string, operationName: string, context: GraphqlMiddlewareRequestContext<any>): any;
+export declare function onServerError(serverOptions: GraphqlMiddlewareServerOptions<any, any>, event: H3Event, error: FetchError, operation: string | null, operationName: string | null, context: GraphqlMiddlewareRequestContext<any> | null): any;

package/dist/runtime/{serverHandler → server}/helpers/index.js

@@ -1,8 +1,14 @@
 import { createError } from "h3";
 import {
-  CLIENT_CONTEXT_PREFIX,
-  GraphqlMiddlewareOperation
+  CLIENT_CONTEXT_PREFIX
 } from "./../../settings/index.js";
+import { documents } from "#nuxt-graphql-middleware/documents";
+export function isValidMutation(v) {
+  return !!v && Object.hasOwn(documents.mutation, v);
+}
+export function isValidQuery(v) {
+  return !!v && Object.hasOwn(documents.query, v);
+}
 export function queryParamToVariables(query) {
   try {
     if (query.__variables && typeof query.__variables === "string") {
@@ -61,29 +67,6 @@ export function throwError(statusMessage, statusCode = 400) {
     statusMessage
   });
 }
-export function validateRequest(method, operation, name, documents) {
-  if (method !== "POST" && method !== "GET") {
-    throwError("Method not allowed.", 405);
-  }
-  if (operation !== GraphqlMiddlewareOperation.Query && operation !== GraphqlMiddlewareOperation.Mutation) {
-    throwError("Unknown operation.");
-  }
-  if (method === "POST" && operation !== GraphqlMiddlewareOperation.Mutation) {
-    throwError("Queries must be a GET request.");
-  }
-  if (method === "GET" && operation !== GraphqlMiddlewareOperation.Query) {
-    throwError("Mutations must be a POST request.");
-  }
-  if (!name) {
-    throwError("Missing name for operation.");
-  }
-  if (!documents) {
-    throwError("Failed to load GraphQL documents", 500);
-  }
-  if (!documents[operation][name]) {
-    throwError(`Operation "${operation}" with name "${name}" not found.`);
-  }
-}
 export function onServerResponse(serverOptions, event, response, operation, operationName, context) {
   if (serverOptions.onServerResponse) {
     return serverOptions.onServerResponse(

package/dist/runtime/server/utils/doGraphqlRequest.d.ts

@@ -0,0 +1,18 @@
+import type { H3Event } from 'h3';
+import type { GraphqlMiddlewareRequestContext } from '../../../types.js';
+import type { GraphqlMiddlewareOperation } from '../../settings/index.js';
+type RequestBody = {
+    query: string;
+    variables?: Record<string, any>;
+    operation?: GraphqlMiddlewareOperation;
+    operationName?: string;
+};
+/**
+ * Perform a raw GraphQL request.
+ *
+ * @param body - The request.
+ * @param context - The client context.
+ * @param event - The H3 event. If not provided, the util will try to get the event using useEvent().
+ */
+export declare function doGraphqlRequest(body: RequestBody, context?: GraphqlMiddlewareRequestContext | null | undefined, providedEvent?: H3Event | null | undefined): Promise<any>;
+export {};

package/dist/runtime/server/utils/doGraphqlRequest.js

@@ -0,0 +1,67 @@
+import { serverOptions } from "#nuxt-graphql-middleware/server-options";
+import { useRuntimeConfig } from "#imports";
+import { useEvent } from "nitropack/runtime";
+import {
+  getEndpoint,
+  getFetchOptions,
+  onServerError,
+  onServerResponse
+} from "../helpers/index.js";
+export async function doGraphqlRequest(body, context = null, providedEvent = null) {
+  const operationName = body.operationName || null;
+  const event = providedEvent ?? useEvent();
+  const runtimeConfig = useRuntimeConfig().graphqlMiddleware;
+  if (serverOptions.doGraphqlRequest) {
+    return serverOptions.doGraphqlRequest({
+      event,
+      operation: body.operation,
+      operationName: body.operationName,
+      operationDocument: body.query,
+      variables: body.variables || {},
+      context: context || {}
+    });
+  }
+  const endpoint = await getEndpoint(
+    runtimeConfig,
+    serverOptions,
+    event,
+    null,
+    operationName,
+    context || null
+  );
+  const fetchOptions = await getFetchOptions(
+    serverOptions,
+    event,
+    null,
+    body.operationName || null,
+    context
+  );
+  return $fetch.raw(endpoint, {
+    // @ts-expect-error Not yet been fixed in nitro.
+    method: "POST",
+    body: {
+      query: body.query,
+      variables: body.variables,
+      operationName: body.operationName
+    },
+    ...fetchOptions
+  }).then((response) => {
+    return onServerResponse(
+      serverOptions,
+      event,
+      response,
+      null,
+      operationName,
+      context
+    );
+  }).catch((error) => {
+    return onServerError(
+      serverOptions,
+      event,
+      error,
+      null,
+      operationName,
+      context
+    );
+  });
+}

package/dist/runtime/server/utils/useGraphqlMutation.d.ts

@@ -1,6 +1,6 @@
 import type { GraphqlResponse } from '#nuxt-graphql-middleware/response';
 import { type GetMutationArgs, type MutationObjectArgs, type GetMutationResult } from './../../helpers/composables.js';
-import type { Mutation } from '#nuxt-graphql-middleware/operations';
+import type { Mutation } from '#nuxt-graphql-middleware/operation-types';
 /**
  * Performs a GraphQL mutation.
  */

package/dist/runtime/server/utils/useGraphqlQuery.d.ts

@@ -1,6 +1,6 @@
 import type { GraphqlResponse } from '#nuxt-graphql-middleware/response';
 import { type GetQueryArgs, type QueryObjectArgs, type GetQueryResult } from './../../helpers/composables.js';
-import type { Query } from '#nuxt-graphql-middleware/operations';
+import type { Query } from '#nuxt-graphql-middleware/operation-types';
 /**
  * Performs a GraphQL query.
  */

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

@@ -1,42 +1,3 @@
-export declare enum GraphqlMiddlewareTemplate {
-    /**
-     * Contains the TS definitions for all GraphQL queries, mutations and fragments.
-     */
-    OperationTypes = "graphql-operations/index.d.ts",
-    /**
-     * Contains the TS definitions for all GraphQL queries, mutations and fragments.
-     */
-    OperationTypesAll = "nuxt-graphql-middleware/operations.d.ts",
-    /**
-     * Contains the TS definitions for all GraphQL queries, mutations and fragments.
-     */
-    Enums = "graphql-operations/enums.ts",
-    /**
-     * Template for the middleware response types.
-     */
-    ResponseTypes = "nuxt-graphql-middleware/response.d.ts",
-    /**
-     * Types for the generated endpoints.
-     */
-    NitroTypes = "nuxt-graphql-middleware/nitro.d.ts",
-    /**
-     * Configuration template.
-     */
-    Helpers = "nuxt-graphql-middleware/helpers.mjs",
-    /**
-     * Configuration template types.
-     */
-    HelpersTypes = "nuxt-graphql-middleware/helpers.d.ts",
-    /**
-     * Exports a single opject containing the compiled queries and mutations.
-     */
-    Documents = "nuxt-graphql-middleware/documents.mjs",
-    /**
-     * Contains the source file paths for every operation.
-     */
-    OperationSources = "nuxt-graphql-middleware/sources.mjs",
-    Types = "nuxt-graphql-middleware/types.d.ts"
-}
 export declare enum GraphqlMiddlewareOperation {
     Query = "query",
     Mutation = "mutation"

package/dist/runtime/settings/index.js

@@ -1,16 +1,3 @@
-export var GraphqlMiddlewareTemplate = /* @__PURE__ */ ((GraphqlMiddlewareTemplate2) => {
-  GraphqlMiddlewareTemplate2["OperationTypes"] = "graphql-operations/index.d.ts";
-  GraphqlMiddlewareTemplate2["OperationTypesAll"] = "nuxt-graphql-middleware/operations.d.ts";
-  GraphqlMiddlewareTemplate2["Enums"] = "graphql-operations/enums.ts";
-  GraphqlMiddlewareTemplate2["ResponseTypes"] = "nuxt-graphql-middleware/response.d.ts";
-  GraphqlMiddlewareTemplate2["NitroTypes"] = "nuxt-graphql-middleware/nitro.d.ts";
-  GraphqlMiddlewareTemplate2["Helpers"] = "nuxt-graphql-middleware/helpers.mjs";
-  GraphqlMiddlewareTemplate2["HelpersTypes"] = "nuxt-graphql-middleware/helpers.d.ts";
-  GraphqlMiddlewareTemplate2["Documents"] = "nuxt-graphql-middleware/documents.mjs";
-  GraphqlMiddlewareTemplate2["OperationSources"] = "nuxt-graphql-middleware/sources.mjs";
-  GraphqlMiddlewareTemplate2["Types"] = "nuxt-graphql-middleware/types.d.ts";
-  return GraphqlMiddlewareTemplate2;
-})(GraphqlMiddlewareTemplate || {});
 export var GraphqlMiddlewareOperation = /* @__PURE__ */ ((GraphqlMiddlewareOperation2) => {
   GraphqlMiddlewareOperation2["Query"] = "query";
   GraphqlMiddlewareOperation2["Mutation"] = "mutation";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-graphql-middleware",
-  "version": "5.0.0-alpha.5",
+  "version": "5.0.0-alpha.7",
   "description": "Module to perform GraphQL requests as a server middleware.",
   "repository": {
     "type": "git",
@@ -41,12 +41,12 @@
     "debug": "nuxi dev playground --inspect",
     "dev:build": "nuxi build playground",
     "dev:layers:build": "nuxi build playground-layers",
-    "dev:prepare": "MODULE_BUILD=true nuxt-module-build build --stub && MODULE_BUILD=true nuxt-module-build prepare && nuxi prepare playground && nuxi prepare playground-layers",
+    "dev:prepare": "MODULE_BUILD=true nuxt-module-build build --stub && MODULE_BUILD=true nuxt-module-build prepare && nuxi prepare playground-layers && nuxi prepare playground",
     "dev:start": "node ./playground/.output/server/index.mjs",
     "client:build": "nuxi generate client",
     "client:dev": "nuxi dev client --port 3300",
     "typedoc": "typedoc --plugin typedoc-plugin-markdown --out foobar",
-    "typecheck": "vue-tsc --noEmit && cd playground && vue-tsc --noEmit",
+    "typecheck": "vue-tsc --noEmit && cd playground && vue-tsc --noEmit && cd ../playground-layers && vue-tsc --noEmit",
     "docs:dev": "vitepress dev docs --port 5000",
     "docs:build": "vitepress build docs",
     "docs:serve": "vitepress serve docs --port 5000",
@@ -64,11 +64,12 @@
     "styles:watch": "postcss ./css/index.css -o ./src/runtime/css/output.css --watch"
   },
   "dependencies": {
+    "@clack/prompts": "^0.10.0",
     "@graphql-codegen/cli": "^5.0.5",
     "@graphql-codegen/schema-ast": "^4.1.0",
     "@graphql-tools/utils": "^10.2.2",
     "@nuxt/devtools-kit": "1.3.7",
-    "graphql-typescript-deluxe": "^0.0.6",
+    "graphql-typescript-deluxe": "^0.0.7",
     "inquirer": "^9.3.2",
     "minisearch": "^6.3.0",
     "picocolors": "^1.0.1"
@@ -78,18 +79,19 @@
     "@nuxt/devtools": "^1.3.7",
     "@nuxt/devtools-ui-kit": "1.3.7",
     "@nuxt/eslint": "^0.3.13",
-    "@nuxt/kit": "^3.15.4",
+    "@nuxt/kit": "^3.16.0",
     "@nuxt/module-builder": "^0.8.4",
-    "@nuxt/schema": "^3.15.4",
+    "@nuxt/schema": "^3.16.0",
     "@types/capture-console": "^1.0.5",
     "@types/cli-table": "^0.3.4",
     "@types/inquirer": "^9.0.7",
+    "@types/micromatch": "^4.0.9",
     "cypress": "^13.12.0",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-prettier": "^5.1.3",
     "jsdoc-to-markdown": "^8.0.1",
-    "nuxt": "^3.15.4",
+    "nuxt": "^3.16.0",
     "postcss": "^8.5.3",
     "postcss-cli": "^11.0.0",
     "postcss-import": "^16.1.0",