nuxt-graphql-middleware 4.3.2 → 5.0.0-alpha.1

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

@@ -6,19 +6,35 @@ import type { GraphqlMiddlewareQuery } from '#nuxt-graphql-middleware/generated-
 import type { GraphqlResponse } from '#graphql-middleware-server-options-build';
 import type { RequestCacheOptions } from '#graphql-middleware/types';
 import type { AsyncData, AsyncDataOptions, NuxtError } from '#app';
-type AsyncGraphqlQueryOptions<ResponseType, DefaultT, Keys extends KeysOf<DefaultT>, F> = AsyncDataOptions<ResponseType, DefaultT, Keys> & {
+import type { DefaultAsyncDataValue } from 'nuxt/app/defaults';
+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.
+     */
     graphqlCaching?: RequestCacheOptions;
-    fetchOptions?: F;
+    /**
+     * Options for the fetch call to the GraphQL middleware endpoint.
+     */
+    fetchOptions?: FetchOptions;
+    /**
+     * Additional client context.
+     *
+     * These values override the values defined globally in defineGraphqlClientOptions().
+     */
     clientContext?: Partial<GraphqlClientContext>;
 };
-/**
- * Wrapper for useAsyncData to perform a single GraphQL query.
- */
-export declare function useAsyncGraphqlQuery<Name extends GraphqlMiddlewareQueryName, VarType extends GraphqlMiddlewareQuery[Name][0], VarsOptional extends GraphqlMiddlewareQuery[Name][1], ResponseType extends GraphqlResponse<GraphqlMiddlewareQuery[Name][2]>, F extends FetchOptions<'json'>, DefaultT = ResponseType, Keys extends KeysOf<DefaultT> = KeysOf<DefaultT>>(name: Name, ...args: VarsOptional extends true ? [
+export declare function useAsyncGraphqlQuery<Name extends GraphqlMiddlewareQueryName, VarType extends GraphqlMiddlewareQuery[Name][0], VarsOptional extends GraphqlMiddlewareQuery[Name][1], ResT extends GraphqlResponse<GraphqlMiddlewareQuery[Name][2]>, FetchO extends FetchOptions<'json'>, NuxtErrorDataT = unknown, DataT = ResT, DefaultT = undefined, PickKeys extends KeysOf<DataT> = KeysOf<DataT>>(name: Name, ...args: VarsOptional extends true ? [
     (undefined | null | Record<string, never> | VarType | Ref<VarType>)?,
-    AsyncGraphqlQueryOptions<ResponseType, DefaultT, Keys, F>?
+    AsyncGraphqlQueryOptions<FetchO, ResT, DataT, PickKeys, DefaultT>?
 ] : [
     VarType | Ref<VarType>,
-    (undefined | null | AsyncGraphqlQueryOptions<ResponseType, DefaultT, Keys, F>)?
-]): AsyncData<PickFrom<DefaultT, KeysOf<DefaultT>> | null, NuxtError<unknown> | null>;
+    (undefined | null | AsyncGraphqlQueryOptions<FetchO, ResT, DataT, PickKeys, DefaultT>)?
+]): AsyncData<PickFrom<DataT, PickKeys> | DefaultT, (NuxtErrorDataT extends Error | NuxtError ? NuxtErrorDataT : NuxtError<NuxtErrorDataT>) | undefined>;
+export declare function useAsyncGraphqlQuery<Name extends GraphqlMiddlewareQueryName, VarType extends GraphqlMiddlewareQuery[Name][0], VarsOptional extends GraphqlMiddlewareQuery[Name][1], ResT extends GraphqlResponse<GraphqlMiddlewareQuery[Name][2]>, FetchO extends FetchOptions<'json'>, NuxtErrorDataT = unknown, DataT = ResT, DefaultT = DataT, PickKeys extends KeysOf<DataT> = KeysOf<DataT>>(name: Name, ...args: VarsOptional extends true ? [
+    (undefined | null | Record<string, never> | VarType | Ref<VarType>)?,
+    AsyncGraphqlQueryOptions<FetchO, ResT, DataT, PickKeys, DefaultT>?
+] : [
+    VarType | Ref<VarType>,
+    (undefined | null | AsyncGraphqlQueryOptions<FetchO, ResT, DataT, PickKeys, DefaultT>)?
+]): AsyncData<PickFrom<DataT, PickKeys> | DefaultT, (NuxtErrorDataT extends Error | NuxtError ? NuxtErrorDataT : NuxtError<NuxtErrorDataT>) | undefined>;
 export {};

package/dist/runtime/serverHandler/debug.js

@@ -1,5 +1,5 @@
 import { defineEventHandler } from "h3";
-import { documents } from "#graphql-documents";
+import { operations } from "#graphql-documents";
 import { useRuntimeConfig } from "#imports";
 export default defineEventHandler(() => {
   function getEndpoint(operation, operationName) {
@@ -8,7 +8,7 @@ export default defineEventHandler(() => {
   }
   let body = "<h1>nuxt-graphql-middleware debug</h1>";
   body += "<table><tbody>";
-  Object.entries(documents).forEach(([operationType, items]) => {
+  Object.entries(operations).forEach(([operationType, items]) => {
     Object.entries(items).forEach(([operationName, operation]) => {
       body += "<tr>";
       body += `<td style="font-size: 1.5rem">${operationType}</td>`;

package/dist/runtime/serverHandler/helpers/index.d.ts

@@ -3,7 +3,7 @@ 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 '#graphql-documents';
+import { type Operations } from '#graphql-documents';
 export declare function queryParamToVariables(query: QueryObject): any;
 /**
  * Extract the client context from the query params.
@@ -21,7 +21,7 @@ export declare function throwError(statusMessage: string, statusCode?: number):
 /**
  * Assure that the request is valid.
  */
-export declare function validateRequest(method?: string, operation?: GraphqlMiddlewareOperation | string, name?: string, documents?: Documents): void;
+export declare function validateRequest(method?: string, operation?: GraphqlMiddlewareOperation | string, name?: string, documents?: Operations): void;
 /**
  * Handle GraphQL server response.
  */

package/dist/runtime/serverHandler/index.js

@@ -9,15 +9,15 @@ import {
   extractRequestContext
 } from "./helpers/index.js";
 import { GraphqlMiddlewareOperation } from "./../settings/index.js";
-import { documents } from "#graphql-documents";
+import { operations } from "#graphql-documents";
 import { serverOptions } from "#graphql-middleware-server-options-build";
 import { useRuntimeConfig } from "#imports";
 export default defineEventHandler(async (event) => {
   const method = event.method;
   const operation = event.context?.params?.operation;
   const operationName = event.context?.params?.name;
-  validateRequest(method, operation, operationName, documents);
-  const operationDocument = documents[operation][operationName];
+  validateRequest(method, operation, operationName, operations);
+  const operationDocument = operations[operation][operationName];
   const queryParams = getQuery(event);
   const context = extractRequestContext(queryParams);
   const variables = operation === GraphqlMiddlewareOperation.Query ? queryParamToVariables(queryParams) : await readBody(event);

package/dist/runtime/serverHandler/upload.js

@@ -13,7 +13,7 @@ import {
   extractRequestContext
 } from "./helpers/index.js";
 import { GraphqlMiddlewareOperation } from "./../settings/index.js";
-import { documents } from "#graphql-documents";
+import { operations } from "#graphql-documents";
 import { serverOptions } from "#graphql-middleware-server-options-build";
 import { useRuntimeConfig } from "#imports";
 function parseMultipart(data) {
@@ -30,8 +30,8 @@ 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];
+  validateRequest(method, operation, operationName, operations);
+  const operationDocument = operations[operation][operationName];
   const multiPartData = await readMultipartFormData(event);
   if (!multiPartData) {
     return throwError("Failed to read multi part data.");

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

@@ -2,7 +2,7 @@ export declare enum GraphqlMiddlewareTemplate {
     /**
      * Contains the TS definitions for all GraphQL queries, mutations and fragments.
      */
-    OperationTypes = "graphql-operations.d.ts",
+    OperationTypes = "graphql-operations.ts",
     /**
      * Signature for the GraphQL composable arguments and return types.
      */
@@ -10,7 +10,7 @@ export declare enum GraphqlMiddlewareTemplate {
     /**
      * Exports a single opject containing the compiled queries and mutations.
      */
-    Documents = "graphql-documents.mjs"
+    Documents = "nuxt-graphql-middleware/graphql-documents.mjs"
 }
 export declare enum GraphqlMiddlewareOperation {
     Query = "query",

package/dist/runtime/settings/index.js

@@ -1,7 +1,7 @@
 export var GraphqlMiddlewareTemplate = /* @__PURE__ */ ((GraphqlMiddlewareTemplate2) => {
-  GraphqlMiddlewareTemplate2["OperationTypes"] = "graphql-operations.d.ts";
+  GraphqlMiddlewareTemplate2["OperationTypes"] = "graphql-operations.ts";
   GraphqlMiddlewareTemplate2["ComposableContext"] = "nuxt-graphql-middleware/generated-types.d.ts";
-  GraphqlMiddlewareTemplate2["Documents"] = "graphql-documents.mjs";
+  GraphqlMiddlewareTemplate2["Documents"] = "nuxt-graphql-middleware/graphql-documents.mjs";
   return GraphqlMiddlewareTemplate2;
 })(GraphqlMiddlewareTemplate || {});
 export var GraphqlMiddlewareOperation = /* @__PURE__ */ ((GraphqlMiddlewareOperation2) => {

package/dist/runtime/types.d.ts

@@ -20,6 +20,11 @@ export interface GraphqlMiddlewareState {
     };
 }
 export type RequestCacheOptions = {
+    /**
+     * Allow caching on the client.
+     *
+     * Caching is only enabled when `clientCache.enabled` is set to `true` in the module options.
+     */
     client?: boolean;
 };
 export type ContextType = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-graphql-middleware",
-  "version": "4.3.2",
+  "version": "5.0.0-alpha.1",
   "description": "Module to perform GraphQL requests as a server middleware.",
   "repository": {
     "type": "git",
@@ -35,7 +35,8 @@
     "dist"
   ],
   "scripts": {
-    "prepack": "nuxt-module-build build && npm run client:build",
+    "prepack": "nuxt-module-build build",
+    "prepack_": "nuxt-module-build build && npm run client:build",
     "dev": "nuxi dev playground --trace-warnings",
     "dev:layers": "nuxi dev playground-layers --trace-warnings",
     "debug": "nuxi dev playground --inspect",
@@ -62,14 +63,15 @@
     "prettier:fix": "prettier --write ."
   },
   "dependencies": {
-    "@graphql-codegen/cli": "^5.0.2",
+    "@graphql-codegen/cli": "^5.0.5",
     "@graphql-codegen/schema-ast": "^4.1.0",
-    "@graphql-codegen/typescript": "^4.0.8",
+    "@graphql-codegen/typescript": "^4.1.3",
     "@graphql-codegen/typescript-generic-sdk": "^4.0.1",
-    "@graphql-codegen/typescript-operations": "^4.2.2",
+    "@graphql-codegen/typescript-operations": "^4.4.1",
     "@graphql-tools/utils": "^10.2.2",
     "@nuxt/devtools-kit": "1.3.7",
-    "@nuxt/kit": "^3.12.2",
+    "dependency-graph": "^1.0.0",
+    "graphql-typescript-deluxe": "^0.0.1",
     "inquirer": "^9.3.2",
     "minisearch": "^6.3.0",
     "picocolors": "^1.0.1"
@@ -79,8 +81,9 @@
     "@nuxt/devtools": "^1.3.7",
     "@nuxt/devtools-ui-kit": "1.3.7",
     "@nuxt/eslint": "^0.3.13",
+    "@nuxt/kit": "^3.15.4",
     "@nuxt/module-builder": "^0.8.4",
-    "@nuxt/schema": "^3.13.2",
+    "@nuxt/schema": "^3.15.4",
     "@types/capture-console": "^1.0.5",
     "@types/cli-table": "^0.3.4",
     "@types/inquirer": "^9.0.7",
@@ -89,7 +92,7 @@
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-prettier": "^5.1.3",
     "jsdoc-to-markdown": "^8.0.1",
-    "nuxt": "^3.13.2",
+    "nuxt": "^3.15.4",
     "prettier": "^3.3.2",
     "strip-ansi": "^7.1.0",
     "typedoc": "^0.26.3",

package/dist/client/200.html

@@ -1,11 +0,0 @@
-<!DOCTYPE html><html  data-capo=""><head><meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1">
-<link rel="stylesheet" href="/__nuxt-graphql-middleware/_nuxt/entry.D9ltLgme.css">
-<link rel="modulepreload" as="script" crossorigin href="/__nuxt-graphql-middleware/_nuxt/CH4m2wxh.js">
-<link rel="prefetch" as="style" crossorigin href="/__nuxt-graphql-middleware/_nuxt/error-404.SWzu_puR.css">
-<link rel="prefetch" as="script" crossorigin href="/__nuxt-graphql-middleware/_nuxt/GKcsigNx.js">
-<link rel="prefetch" as="script" crossorigin href="/__nuxt-graphql-middleware/_nuxt/B4FhP7a6.js">
-<link rel="prefetch" as="style" crossorigin href="/__nuxt-graphql-middleware/_nuxt/error-500.Bkv_zTjr.css">
-<link rel="prefetch" as="script" crossorigin href="/__nuxt-graphql-middleware/_nuxt/CPd6XBwJ.js">
-<script type="module" src="/__nuxt-graphql-middleware/_nuxt/CH4m2wxh.js" crossorigin></script></head><body><div id="__nuxt"></div><div id="teleports"></div><script type="application/json" data-nuxt-data="nuxt-app" data-ssr="false" id="__NUXT_DATA__">[{"prerenderedAt":1,"serverRendered":2},1734444332573,false]</script>
-<script>window.__NUXT__={};window.__NUXT__.config={public:{},app:{baseURL:"/__nuxt-graphql-middleware",buildId:"681c6bf3-56ef-4ca6-8973-d750fea9d239",buildAssetsDir:"/_nuxt/",cdnURL:""}}</script></body></html>

package/dist/client/404.html

@@ -1,11 +0,0 @@
-<!DOCTYPE html><html  data-capo=""><head><meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1">
-<link rel="stylesheet" href="/__nuxt-graphql-middleware/_nuxt/entry.D9ltLgme.css">
-<link rel="modulepreload" as="script" crossorigin href="/__nuxt-graphql-middleware/_nuxt/CH4m2wxh.js">
-<link rel="prefetch" as="style" crossorigin href="/__nuxt-graphql-middleware/_nuxt/error-404.SWzu_puR.css">
-<link rel="prefetch" as="script" crossorigin href="/__nuxt-graphql-middleware/_nuxt/GKcsigNx.js">
-<link rel="prefetch" as="script" crossorigin href="/__nuxt-graphql-middleware/_nuxt/B4FhP7a6.js">
-<link rel="prefetch" as="style" crossorigin href="/__nuxt-graphql-middleware/_nuxt/error-500.Bkv_zTjr.css">
-<link rel="prefetch" as="script" crossorigin href="/__nuxt-graphql-middleware/_nuxt/CPd6XBwJ.js">
-<script type="module" src="/__nuxt-graphql-middleware/_nuxt/CH4m2wxh.js" crossorigin></script></head><body><div id="__nuxt"></div><div id="teleports"></div><script type="application/json" data-nuxt-data="nuxt-app" data-ssr="false" id="__NUXT_DATA__">[{"prerenderedAt":1,"serverRendered":2},1734444332573,false]</script>
-<script>window.__NUXT__={};window.__NUXT__.config={public:{},app:{baseURL:"/__nuxt-graphql-middleware",buildId:"681c6bf3-56ef-4ca6-8973-d750fea9d239",buildAssetsDir:"/_nuxt/",cdnURL:""}}</script></body></html>

package/dist/client/_nuxt/B4FhP7a6.js

@@ -1 +0,0 @@
-import{C as o,r as u,D as f,E as d,e as v,F as l,G as i,H as h,I as m}from"./CH4m2wxh.js";function U(t,a={}){const e=a.head||o();if(e)return e.ssr?e.push(t,a):p(e,t,a)}function p(t,a,e={}){const s=u(!1),n=u({});f(()=>{n.value=s.value?{}:h(a)});const r=t.push(n.value,e);return d(n,c=>{r.patch(c)}),m()&&(v(()=>{r.dispose()}),l(()=>{s.value=!0}),i(()=>{s.value=!1})),r}export{U as u};