@lewebsimple/nuxt-graphql 0.1.11 → 0.1.13

package/dist/module.d.mts

@@ -1,5 +1,6 @@
 import * as _nuxt_schema from '@nuxt/schema';
 import { GraphQLCacheConfig } from '../dist/runtime/utils/graphql-cache.js';
+import { CodegenConfig } from '@graphql-codegen/cli';
 
 interface ModuleOptions {
     endpoint?: string;
@@ -12,6 +13,7 @@ interface ModuleOptions {
             input: string;
             output: string;
         }>;
+        generates?: CodegenConfig["generates"];
     };
 }
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "@lewebsimple/nuxt-graphql",
   "configKey": "graphql",
-  "version": "0.1.11",
+  "version": "0.1.13",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "3.6.1"

package/dist/module.mjs

@@ -175,7 +175,7 @@ function formatDefinitions(defs) {
   return defs.map((def) => `${colorOf(def)}${def.name}${reset}`).join(`${dim} / ${reset}`);
 }
 async function runCodegen(options) {
-  const { sdl, documents, operationsFile, schemasFile, scalars } = options;
+  const { sdl, documents, operationsFile, schemasFile, scalars, generates: customGenerates } = options;
   if (documents.length === 0) {
     logger.warn("No GraphQL documents found");
     return;
@@ -232,6 +232,9 @@ async function runCodegen(options) {
           scalarSchemas: zodScalars
         }
       };
+      if (customGenerates) {
+        Object.assign(generates, customGenerates);
+      }
     }
     await generate({ schema: sdl, documents, generates, silent: true, errorsOnly: true }, true);
     logger.success(`Generated types for ${documents.length} document(s)`);
@@ -300,10 +303,8 @@ const module$1 = defineNuxtModule({
     nuxt.options.alias["#graphql/registry"] = registryFile;
     nuxt.options.alias["#graphql/schemas"] = schemasFile;
     const schemaOutput = options.codegen?.schemaOutput ?? "server/graphql/schema.graphql";
-    if (schemaOutput) {
-      if (!schemaOutput.endsWith(".graphql")) {
-        logger.warn(`Schema output '${schemaOutput}' should have .graphql extension.`);
-      }
+    if (schemaOutput && !schemaOutput.endsWith(".graphql")) {
+      logger.warn(`Schema output '${schemaOutput}' should have .graphql extension.`);
     }
     const schemaFile = join(rootDir, schemaOutput);
     const generate = async () => {
@@ -323,7 +324,8 @@ const module$1 = defineNuxtModule({
         documents,
         operationsFile,
         schemasFile,
-        scalars: options.codegen?.scalars
+        scalars: options.codegen?.scalars,
+        generates: options.codegen?.generates
       });
       if (writeFileIfChanged(schemaFile, sdl)) {
         logger.info(`GraphQL schema saved to ${cyan}${schemaOutput}${reset}`);

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

@@ -1,4 +1,9 @@
 import type { QueryName, QueryVariables } from "#graphql/registry";
+/**
+ * GraphQL cache management composable
+ *
+ * @returns Object with enabled flag and invalidate function
+ */
 export declare function useGraphQLCache(): {
     enabled: any;
     invalidate: <N extends QueryName>(operationName?: N, variables?: QueryVariables<N>) => Promise<void>;

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

@@ -1,5 +1,11 @@
 import { type MutationName, type MutationResult, type MutationVariables } from "#graphql/registry";
 import type { IsEmptyObject } from "../utils/helpers.js";
+/**
+ * Client-side GraphQL mutation composable
+ *
+ * @param operationName Mutation operation name
+ * @returns Object with mutate function and pending state
+ */
 export declare function useGraphQLMutation<N extends MutationName>(operationName: N): {
     mutate: (...args: IsEmptyObject<MutationVariables<N>> extends true ? [variables?: MutationVariables<N>, headers?: HeadersInit] : [variables: MutationVariables<N>, headers?: HeadersInit]) => Promise<{
         data: MutationResult<N> | null;

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

@@ -6,4 +6,11 @@ export interface UseGraphQLQueryOptions<T> extends AsyncDataOptions<T> {
     cache?: CacheOptions | false;
     headers?: HeadersInit;
 }
+/**
+ * Client-side GraphQL query composable with caching and deduplication
+ *
+ * @param operationName Query operation name
+ * @param args Variables and optional configuration
+ * @returns AsyncData object with query result
+ */
 export declare function useGraphQLQuery<N extends QueryName>(operationName: N, ...args: IsEmptyObject<QueryVariables<N>> extends true ? [variables?: QueryVariables<N>, options?: UseGraphQLQueryOptions<QueryResult<N>>] : [variables: QueryVariables<N>, options?: UseGraphQLQueryOptions<QueryResult<N>>]): AsyncData<QueryResult<N>, Error | null>;

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

@@ -8,4 +8,11 @@ export type UseGraphQLSubscriptionReturn<N extends SubscriptionName> = {
     start: () => void;
     stop: () => void;
 };
+/**
+ * Client-side GraphQL subscription composable using SSE
+ *
+ * @param operationName Subscription operation name
+ * @param args Variables (can be reactive)
+ * @returns Object with data, error, start, and stop
+ */
 export declare function useGraphQLSubscription<N extends SubscriptionName>(operationName: N, ...args: IsEmptyObject<SubscriptionVariables<N>> extends true ? [variables?: MaybeRefOrGetter<SubscriptionVariables<N>>] : [variables: MaybeRefOrGetter<SubscriptionVariables<N>>]): UseGraphQLSubscriptionReturn<N>;

package/dist/runtime/server/utils/graphql-client.d.ts

@@ -1,10 +1,9 @@
 import type { H3Event } from "h3";
 import { GraphQLClient } from "graphql-request";
 /**
- * Create server-side GraphQL client instance for the given H3 event.
+ * Get or create a server-side GraphQL client for an H3 event
  *
  * @param event H3 event
- *
  * @returns GraphQL client instance
  */
 export declare function getGraphQLClient(event: H3Event): GraphQLClient;

package/dist/runtime/server/utils/{useGraphQLMutation.d.ts → useServerGraphQLMutation.d.ts}

@@ -1,7 +1,14 @@
 import type { H3Event } from "h3";
 import { type MutationName, type MutationResult, type MutationVariables } from "#graphql/registry";
 import type { IsEmptyObject } from "../../utils/helpers.js";
-export declare function useGraphQLMutation<N extends MutationName>(event: H3Event, operationName: N): Promise<{
+/**
+ * Server-side GraphQL mutation composable
+ *
+ * @param event H3 event
+ * @param operationName Mutation operation name
+ * @returns Object with mutate function
+ */
+export declare function useServerGraphQLMutation<N extends MutationName>(event: H3Event, operationName: N): Promise<{
     mutate: (...args: IsEmptyObject<MutationVariables<N>> extends true ? [variables?: MutationVariables<N>, headers?: HeadersInit] : [variables: MutationVariables<N>, headers?: HeadersInit]) => Promise<{
         data: MutationResult<N> | null;
         error: Error | null;

package/dist/runtime/server/utils/{useGraphQLMutation.js → useServerGraphQLMutation.js}

@@ -1,6 +1,6 @@
 import { getGraphQLClient } from "./graphql-client.js";
 import { mutations } from "#graphql/registry";
-export async function useGraphQLMutation(event, operationName) {
+export async function useServerGraphQLMutation(event, operationName) {
   const client = getGraphQLClient(event);
   async function mutate(...args) {
     try {

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

@@ -0,0 +1,12 @@
+import type { H3Event } from "h3";
+import { type QueryName, type QueryResult, type QueryVariables } from "#graphql/registry";
+import type { IsEmptyObject } from "../../utils/helpers.js";
+/**
+ * Server-side GraphQL query composable
+ *
+ * @param event H3 event
+ * @param operationName Query operation name
+ * @param args Variables and optional headers
+ * @returns Query result
+ */
+export declare function useServerGraphQLQuery<N extends QueryName>(event: H3Event, operationName: N, ...args: IsEmptyObject<QueryVariables<N>> extends true ? [variables?: QueryVariables<N>, headers?: HeadersInit] : [variables: QueryVariables<N>, headers?: HeadersInit]): Promise<QueryResult<N>>;

package/dist/runtime/server/utils/{useGraphQLQuery.js → useServerGraphQLQuery.js}

@@ -1,6 +1,6 @@
 import { getGraphQLClient } from "./graphql-client.js";
 import { queries } from "#graphql/registry";
-export async function useGraphQLQuery(event, operationName, ...args) {
+export async function useServerGraphQLQuery(event, operationName, ...args) {
   const client = getGraphQLClient(event);
   const [variables, headers] = args;
   return client.request(queries[operationName], variables, headers);

package/dist/runtime/types/graphql-client.d.ts

@@ -2,17 +2,19 @@ import type { GraphQLClient } from "graphql-request";
 import type { Client as SSEClient } from "graphql-sse";
 import type { GraphQLClientError } from "../utils/graphql-error";
 
+// Extend NuxtApp with GraphQL clients
 declare module "#app" {
   interface NuxtApp {
     $graphql: () => GraphQLClient;
     $graphqlSSE: () => SSEClient;
   }
+
   interface RuntimeNuxtHooks {
-    "graphql:headers": (headers: Record<string, string>) => void | Promise<void>;
     "graphql:error": (error: GraphQLClientError) => void;
   }
 }
 
+// Extend Nuxt runtime config with GraphQL options
 declare module "nuxt/schema" {
   interface PublicRuntimeConfig {
     graphql: {

package/dist/runtime/utils/graphql-cache.d.ts

@@ -15,11 +15,21 @@ export declare function dedupeGet(operationName: string, variables: unknown): Pr
 export declare function dedupeSet(operationName: string, variables: unknown, promise: Promise<unknown>): void;
 /**
  * Register a refresh callback for a query
+ *
+ * @param operationName GraphQL operation name
+ * @param variables Query variables
+ * @param refresh Callback to execute on cache invalidation
+ * @returns Unregister function
  */
 export declare function registerRefresh(operationName: string, variables: unknown, refresh: () => void): () => void;
 /**
- * Invalidate cached queries and trigger refreshes
- * - No args: invalidate all
+ * Invalidate cached queries and trigger refresh callbacks
+ *
+ * @param operationName Optional operation name to filter invalidation
+ * @param variables Optional variables to target specific query
+ *
+ * Usage:
+ * - No args: invalidate all queries
  * - operationName only: invalidate all queries with that name
  * - operationName + variables: invalidate specific query
  */

package/dist/runtime/utils/graphql-error.d.ts

@@ -6,8 +6,7 @@ export declare class GraphQLClientError extends Error {
 /**
  * Wrap a generic error into a GraphQLClientError
  *
- * @param error Generic error
- *
+ * @param error Generic error from various sources
  * @returns Wrapped GraphQLClientError
  */
 export declare function wrapError(error: unknown): GraphQLClientError;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lewebsimple/nuxt-graphql",
-  "version": "0.1.11",
+  "version": "0.1.13",
   "description": "Opinionated Nuxt module for using GraphQL",
   "repository": "lewebsimple/nuxt-graphql",
   "license": "MIT",
@@ -31,13 +31,14 @@
     "lint": "eslint .",
     "test": "vitest run",
     "test:watch": "vitest watch",
+    "test:coverage": "vitest run --coverage",
     "test:types": "vue-tsc --noEmit && cd playground && vue-tsc --noEmit"
   },
   "dependencies": {
-    "@graphql-codegen/cli": "^5.0.7",
-    "@graphql-codegen/typed-document-node": "^5.1.2",
-    "@graphql-codegen/typescript": "^4.1.6",
-    "@graphql-codegen/typescript-operations": "^4.6.1",
+    "@graphql-codegen/cli": "^6.1.0",
+    "@graphql-codegen/typed-document-node": "^6.1.5",
+    "@graphql-codegen/typescript": "^5.0.7",
+    "@graphql-codegen/typescript-operations": "^5.0.7",
     "@graphql-typed-document-node/core": "^3.2.0",
     "@nuxt/kit": "^4.2.2",
     "graphql": "^16.12.0",
@@ -58,6 +59,7 @@
     "@nuxt/schema": "^4.2.2",
     "@nuxt/test-utils": "^3.21.0",
     "@types/node": "latest",
+    "@vitest/coverage-v8": "^4.0.16",
     "changelogen": "^0.6.2",
     "eslint": "^9.39.2",
     "nuxt": "^4.2.2",
@@ -73,4 +75,4 @@
       "chore": false
     }
   }
-}
+}

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

@@ -1,4 +0,0 @@
-import type { H3Event } from "h3";
-import { type QueryName, type QueryResult, type QueryVariables } from "#graphql/registry";
-import type { IsEmptyObject } from "../../utils/helpers.js";
-export declare function useGraphQLQuery<N extends QueryName>(event: H3Event, operationName: N, ...args: IsEmptyObject<QueryVariables<N>> extends true ? [variables?: QueryVariables<N>, headers?: HeadersInit] : [variables: QueryVariables<N>, headers?: HeadersInit]): Promise<QueryResult<N>>;