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

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

@@ -2,6 +2,9 @@ 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/operation-types';
+import type { NuxtApp } from '#app';
+import type { AppConfig } from 'nuxt/schema';
+import { GraphqlMiddlewareCache } from './ClientCache.js';
 export type GraphqlComposableOptions = {
     fetchOptions?: FetchOptions;
     graphqlCaching?: RequestCacheOptions;
@@ -38,3 +41,8 @@ export type MutationObjectArgs<K extends keyof Mutation, M extends Mutation[K] =
 export type PickFrom<T, K extends Array<string>> = T extends Array<any> ? T : T extends Record<string, any> ? keyof T extends K[number] ? T : K[number] extends never ? T : Pick<T, K[number]> : T;
 export type KeysOf<T> = Array<T extends T ? (keyof T extends string ? keyof T : never) : never>;
 export declare function encodeContext(context: Record<string, string | null | undefined>): Record<string, string>;
+/**
+ * Sort an object defining query params alphabetically.
+ */
+export declare function sortQueryParams(obj: Record<string, string>): Record<string, string>;
+export declare function getOrCreateClientCache(app: NuxtApp, config: AppConfig): GraphqlMiddlewareCache | undefined;

package/dist/runtime/helpers/composables.js

@@ -1,4 +1,9 @@
 import { CLIENT_CONTEXT_PREFIX } from "../settings/index.js";
+import { GraphqlMiddlewareCache } from "./ClientCache.js";
+import {
+  clientCacheEnabledAtBuild,
+  importMetaServer
+} from "#nuxt-graphql-middleware/config";
 export function encodeContext(context) {
   return Object.entries(context).reduce(
     (acc, [key, value]) => {
@@ -10,3 +15,25 @@ export function encodeContext(context) {
     {}
   );
 }
+export function sortQueryParams(obj) {
+  const sortedKeys = Object.keys(obj).sort();
+  const sortedObj = {};
+  for (const key of sortedKeys) {
+    sortedObj[key] = obj[key];
+  }
+  return sortedObj;
+}
+export function getOrCreateClientCache(app, config) {
+  if (importMetaServer || !clientCacheEnabledAtBuild) {
+    return;
+  }
+  if (!config.graphqlMiddleware.clientCacheEnabled) {
+    return;
+  }
+  if (!app.$graphqlCache) {
+    app.$graphqlCache = new GraphqlMiddlewareCache(
+      config.graphqlMiddleware.clientCacheMaxSize
+    );
+  }
+  return app.$graphqlCache;
+}

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

@@ -5,7 +5,3 @@
  * items.filter(falsy)
  */
 export declare function falsy<T>(value: T): value is NonNullable<T>;
-/**
- * Get the parameters for the GraphQL middleware query.
- */
-export declare function buildRequestParams(variables?: Record<string, any> | undefined | null): Record<string, any>;

package/dist/runtime/helpers/index.js

@@ -1,16 +1,3 @@
 export function falsy(value) {
   return value !== null && value !== void 0;
 }
-export function buildRequestParams(variables) {
-  if (typeof variables !== "object" || !variables) {
-    return {};
-  }
-  for (const key in variables) {
-    if (typeof variables[key] !== "string") {
-      return {
-        __variables: JSON.stringify(variables)
-      };
-    }
-  }
-  return variables;
-}

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

@@ -0,0 +1,11 @@
+export declare function encodeVariables(variables?: Record<string, any> | null): Record<string, any>;
+/**
+ * Get the variables from query parameters.
+ *
+ * For simple cases with type prefixes:
+ * ?name=Jon&n:age=20&b:isUser=false
+ *
+ * In complex cases, the entire variables are sent as a JSON encoded string:
+ * ?__variables=%7B%22foobar%22:%7B%22path%22:%22%22%7D%7D
+ */
+export declare function decodeVariables(query: Record<string, any>, validKeys?: string[]): any;

package/dist/runtime/helpers/queryEncoding.js

@@ -0,0 +1,89 @@
+import { experimentalQueryParamEncoding } from "#nuxt-graphql-middleware/config";
+import { CLIENT_CONTEXT_PREFIX, OPERATION_HASH_PREFIX } from "../settings/index.js";
+export function encodeVariables(variables) {
+  if (typeof variables !== "object" || !variables) {
+    return {};
+  }
+  if (!experimentalQueryParamEncoding) {
+    for (const key in variables) {
+      if (typeof variables[key] !== "string") {
+        return {
+          __variables: JSON.stringify(variables)
+        };
+      }
+    }
+    return variables;
+  }
+  const result = {};
+  let needsFallback = false;
+  for (const key in variables) {
+    const value = variables[key];
+    const type = typeof value;
+    if (type === "string") {
+      result[key] = value;
+    } else if (type === "number") {
+      result[`n:${key}`] = String(value);
+    } else if (type === "boolean") {
+      result[`b:${key}`] = String(value);
+    } else {
+      needsFallback = true;
+      break;
+    }
+  }
+  if (needsFallback) {
+    return {
+      __variables: JSON.stringify(variables)
+    };
+  }
+  return result;
+}
+function filterValidKeys(validKeys, obj) {
+  return validKeys.reduce((acc, key) => {
+    const value = obj[key];
+    if (value !== void 0 && value !== null) {
+      acc[key] = value;
+    }
+    return acc;
+  }, {});
+}
+export function decodeVariables(query, validKeys) {
+  try {
+    if (query.__variables && typeof query.__variables === "string") {
+      return JSON.parse(query.__variables);
+    }
+  } catch {
+  }
+  if (!experimentalQueryParamEncoding) {
+    if (validKeys) {
+      return filterValidKeys(validKeys, query);
+    }
+    return query;
+  }
+  if (validKeys && validKeys.length === 0) {
+    return {};
+  }
+  const result = {};
+  for (const key in query) {
+    if (key.startsWith(CLIENT_CONTEXT_PREFIX) || key.startsWith(OPERATION_HASH_PREFIX)) {
+      continue;
+    } else if (key.startsWith("n:")) {
+      const actualKey = key.substring(2);
+      if (validKeys && !validKeys.includes(actualKey)) {
+        continue;
+      }
+      result[actualKey] = Number(query[key]);
+    } else if (key.startsWith("b:")) {
+      const actualKey = key.substring(2);
+      if (validKeys && !validKeys.includes(actualKey)) {
+        continue;
+      }
+      result[actualKey] = query[key] === "true";
+    } else if (key !== "__variables") {
+      if (validKeys && !validKeys.includes(key)) {
+        continue;
+      }
+      result[key] = query[key];
+    }
+  }
+  return result;
+}

package/dist/runtime/plugins/devMode.js

@@ -1,6 +1,7 @@
 import { defineNuxtPlugin, useState } from "#imports";
 import { createApp } from "vue";
 import DevModeOverlay from "../components/DevModeOverlay.vue";
+import { importMetaClient } from "#nuxt-graphql-middleware/config";
 export default defineNuxtPlugin({
   name: "nuxt-graphql-middleware:dev-mode",
   setup(nuxtApp) {
@@ -11,7 +12,7 @@ export default defineNuxtPlugin({
     nuxtApp.hook("nuxt-graphql-middleware:errors", (value) => {
       errors.value.push(value);
     });
-    if (import.meta.client) {
+    if (importMetaClient) {
       nuxtApp.hook("app:mounted", () => {
         const container = document.createElement("div");
         document.body.appendChild(container);

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

@@ -20,7 +20,8 @@ export default defineEventHandler(async (event) => {
     {
       query: operationDocument,
       variables,
-      operation: GraphqlMiddlewareOperation.Mutation
+      operation: GraphqlMiddlewareOperation.Mutation,
+      operationName
     },
     context,
     event

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

@@ -1,13 +1,10 @@
 import { defineEventHandler, getQuery, getRouterParam } from "h3";
-import {
-  queryParamToVariables,
-  extractRequestContext,
-  isValidQuery,
-  throwError
-} from "./../helpers/index.js";
+import { 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";
+import { decodeVariables } from "../../helpers/queryEncoding.js";
+import { operationVariables } from "#nuxt-graphql-middleware/operation-variables";
 export default defineEventHandler(async (event) => {
   const operationName = getRouterParam(event, "name");
   if (!isValidQuery(operationName)) {
@@ -16,12 +13,14 @@ export default defineEventHandler(async (event) => {
   const operationDocument = documents.query[operationName];
   const queryParams = getQuery(event);
   const context = extractRequestContext(queryParams);
-  const variables = queryParamToVariables(queryParams);
+  const validVariableKeys = operationVariables[operationName];
+  const variables = decodeVariables(queryParams, validVariableKeys);
   return doGraphqlRequest(
     {
       query: operationDocument,
       variables,
-      operation: GraphqlMiddlewareOperation.Query
+      operation: GraphqlMiddlewareOperation.Query,
+      operationName
     },
     context,
     event

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

@@ -8,9 +8,7 @@ import {
   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,
@@ -21,6 +19,9 @@ export async function doGraphqlRequest(body, context = null, providedEvent = nul
       context: context || {}
     });
   }
+  const operation = body.operation || null;
+  const operationName = body.operationName || null;
+  const runtimeConfig = useRuntimeConfig().graphqlMiddleware;
   const endpoint = await getEndpoint(
     runtimeConfig,
     serverOptions,
@@ -50,7 +51,7 @@ export async function doGraphqlRequest(body, context = null, providedEvent = nul
       serverOptions,
       event,
       response,
-      null,
+      operation,
       operationName,
       context
     );
@@ -59,7 +60,7 @@ export async function doGraphqlRequest(body, context = null, providedEvent = nul
       serverOptions,
       event,
       error,
-      null,
+      operation,
       operationName,
       context
     );

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

@@ -1,7 +1,7 @@
 import {
   encodeContext
 } from "./../../helpers/composables.js";
-import { buildRequestParams } from "./../../helpers/index.js";
+import { encodeVariables } from "./../../helpers/queryEncoding.js";
 import { performRequest } from "./index.js";
 export function useGraphqlQuery(...args) {
   const [name, variables, fetchOptions = {}, clientContext = {}] = typeof args[0] === "string" ? [args[0], args[1], args[2]?.fetchOptions, args[2]?.clientContext] : [
@@ -14,7 +14,7 @@ export function useGraphqlQuery(...args) {
     ...fetchOptions,
     params: {
       ...fetchOptions.params || {},
-      ...buildRequestParams(variables),
+      ...encodeVariables(variables),
       ...encodeContext(clientContext)
     }
   });

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

@@ -3,3 +3,4 @@ export declare enum GraphqlMiddlewareOperation {
     Mutation = "mutation"
 }
 export declare const CLIENT_CONTEXT_PREFIX = "__gqlc_";
+export declare const OPERATION_HASH_PREFIX = "__gqlh";

package/dist/runtime/settings/index.js

@@ -4,3 +4,4 @@ export var GraphqlMiddlewareOperation = /* @__PURE__ */ ((GraphqlMiddlewareOpera
   return GraphqlMiddlewareOperation2;
 })(GraphqlMiddlewareOperation || {});
 export const CLIENT_CONTEXT_PREFIX = "__gqlc_";
+export const OPERATION_HASH_PREFIX = "__gqlh";

package/dist/runtime/types.d.ts

@@ -88,8 +88,8 @@ export type GraphqlClientOptions<T extends ContextType = ContextType> = {
 export type GraphqlMiddlewareRequestContext<C extends ContextType = ContextType> = {
     client?: Partial<C>;
 };
-export type GraphqlMiddlewareGraphqlEndpointMethod<C extends ContextType> = (event?: H3Event, operation?: string | null, operationName?: string | null, context?: GraphqlMiddlewareRequestContext<C> | null) => string | Promise<string> | undefined;
-export type GraphqlMiddlewareServerFetchOptionsMethod<C extends ContextType> = (event?: H3Event, operation?: string | null, operationName?: string | null, context?: GraphqlMiddlewareRequestContext<C> | null) => FetchOptions | Promise<FetchOptions>;
+export type GraphqlMiddlewareGraphqlEndpointMethod<C extends ContextType> = (event: H3Event, operation?: string | null, operationName?: string | null, context?: GraphqlMiddlewareRequestContext<C> | null) => string | Promise<string> | undefined;
+export type GraphqlMiddlewareServerFetchOptionsMethod<C extends ContextType> = (event: H3Event, operation?: string | null, operationName?: string | null, context?: GraphqlMiddlewareRequestContext<C> | null) => FetchOptions | Promise<FetchOptions>;
 export type GraphqlMiddlewareOnServerResponseMethod<ServerReponse, T, C extends ContextType> = (event: H3Event, response: FetchResponse<ServerReponse>, operation?: string | null, operationName?: string | null, context?: GraphqlMiddlewareRequestContext<C> | null) => T | Promise<T>;
 export type GraphqlMiddlewareOnServerErrorMethod<C extends ContextType> = (event: H3Event, error: FetchError, operation?: string | null, operationName?: string | null, context?: GraphqlMiddlewareRequestContext<C> | null) => any | Promise<any>;
 export type GraphqlMiddlewareDoRequestMethodContext<C extends ContextType> = {

package/dist/server-options.d.mts

@@ -0,0 +1,8 @@
+import { GraphqlClientContext } from '#nuxt-graphql-middleware/client-options';
+import { GraphqlMiddlewareResponseUnion } from '#nuxt-graphql-middleware/response';
+import { GraphqlMiddlewareServerOptions } from '../dist/runtime/types.js';
+export { GraphqlMiddlewareServerOptions } from '../dist/runtime/types.js';
+
+declare function defineGraphqlServerOptions<T extends object = object>(options: GraphqlMiddlewareServerOptions<T, GraphqlMiddlewareResponseUnion, GraphqlClientContext>): GraphqlMiddlewareServerOptions<T, GraphqlMiddlewareResponseUnion, GraphqlClientContext>;
+
+export { defineGraphqlServerOptions };

package/dist/server-options.mjs

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