@constructive-io/graphql-codegen 2.23.2 → 2.24.0

package/cli/codegen/barrel.js

@@ -1,109 +1,171 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateQueriesBarrel = generateQueriesBarrel;
 exports.generateMutationsBarrel = generateMutationsBarrel;
 exports.generateMainBarrel = generateMainBarrel;
 exports.generateCustomQueriesBarrel = generateCustomQueriesBarrel;
 exports.generateCustomMutationsBarrel = generateCustomMutationsBarrel;
-const ts_ast_1 = require("./ts-ast");
+const t = __importStar(require("@babel/types"));
+const babel_ast_1 = require("./babel-ast");
 const utils_1 = require("./utils");
 const type_resolver_1 = require("./type-resolver");
+/**
+ * Helper to create export * from './module' statement
+ */
+function exportAllFrom(modulePath) {
+    return t.exportAllDeclaration(t.stringLiteral(modulePath));
+}
 /**
  * Generate the queries/index.ts barrel file
  */
 function generateQueriesBarrel(tables) {
-    const lines = [(0, ts_ast_1.createFileHeader)('Query hooks barrel export'), ''];
+    const statements = [];
     // Export all query hooks
     for (const table of tables) {
         const listHookName = (0, utils_1.getListQueryHookName)(table);
         const singleHookName = (0, utils_1.getSingleQueryHookName)(table);
-        lines.push(`export * from './${listHookName}';`);
-        lines.push(`export * from './${singleHookName}';`);
+        statements.push(exportAllFrom(`./${listHookName}`));
+        statements.push(exportAllFrom(`./${singleHookName}`));
+    }
+    // Add file header as leading comment on first statement
+    if (statements.length > 0) {
+        (0, babel_ast_1.addJSDocComment)(statements[0], [
+            'Query hooks barrel export',
+            '@generated by @constructive-io/graphql-codegen',
+            'DO NOT EDIT - changes will be overwritten',
+        ]);
     }
-    return lines.join('\n') + '\n';
+    return (0, babel_ast_1.generateCode)(statements);
 }
 /**
  * Generate the mutations/index.ts barrel file
  */
 function generateMutationsBarrel(tables) {
-    const lines = [
-        (0, ts_ast_1.createFileHeader)('Mutation hooks barrel export'),
-        '',
-    ];
+    const statements = [];
     // Export all mutation hooks
     for (const table of tables) {
         const createHookName = (0, utils_1.getCreateMutationHookName)(table);
         const updateHookName = (0, utils_1.getUpdateMutationHookName)(table);
         const deleteHookName = (0, utils_1.getDeleteMutationHookName)(table);
-        lines.push(`export * from './${createHookName}';`);
+        statements.push(exportAllFrom(`./${createHookName}`));
         // Only add update/delete if they exist
         if (table.query?.update !== null) {
-            lines.push(`export * from './${updateHookName}';`);
+            statements.push(exportAllFrom(`./${updateHookName}`));
         }
         if (table.query?.delete !== null) {
-            lines.push(`export * from './${deleteHookName}';`);
+            statements.push(exportAllFrom(`./${deleteHookName}`));
         }
     }
-    return lines.join('\n') + '\n';
+    // Add file header as leading comment on first statement
+    if (statements.length > 0) {
+        (0, babel_ast_1.addJSDocComment)(statements[0], [
+            'Mutation hooks barrel export',
+            '@generated by @constructive-io/graphql-codegen',
+            'DO NOT EDIT - changes will be overwritten',
+        ]);
+    }
+    return (0, babel_ast_1.generateCode)(statements);
 }
 function generateMainBarrel(tables, options = {}) {
     // Support legacy signature where second arg was just hasSchemaTypes boolean
     const opts = typeof options === 'boolean'
         ? { hasSchemaTypes: options, hasMutations: true }
         : options;
-    const { hasSchemaTypes = false, hasMutations = true } = opts;
-    const tableNames = tables.map((t) => t.name).join(', ');
-    const schemaTypesExport = hasSchemaTypes
-        ? `
-// Schema types (input, payload, enum types)
-export * from './schema-types';
-`
-        : '';
-    const mutationsExport = hasMutations
-        ? `
-// Mutation hooks
-export * from './mutations';
-`
-        : '';
-    return `/**
- * Auto-generated GraphQL SDK
- * @generated by @constructive-io/graphql-codegen
- *
- * Tables: ${tableNames}
- *
- * Usage:
- *
- * 1. Configure the client:
- * \`\`\`ts
- * import { configure } from './generated';
- *
- * configure({
- *   endpoint: 'https://api.example.com/graphql',
- *   headers: { Authorization: 'Bearer <token>' },
- * });
- * \`\`\`
- *
- * 2. Use the hooks:
- * \`\`\`tsx
- * import { useCarsQuery, useCreateCarMutation } from './generated';
- *
- * function MyComponent() {
- *   const { data, isLoading } = useCarsQuery({ first: 10 });
- *   const { mutate } = useCreateCarMutation();
- *   // ...
- * }
- * \`\`\`
- */
-
-// Client configuration
-export * from './client';
-
-// Entity and filter types
-export * from './types';
-${schemaTypesExport}
-// Query hooks
-export * from './queries';
-${mutationsExport}`;
+    const { hasSchemaTypes = false, hasMutations = true, hasQueryKeys = false, hasMutationKeys = false, hasInvalidation = false, } = opts;
+    const tableNames = tables.map((tbl) => tbl.name).join(', ');
+    const statements = [];
+    // Client configuration
+    statements.push(exportAllFrom('./client'));
+    // Entity and filter types
+    statements.push(exportAllFrom('./types'));
+    // Schema types (input, payload, enum types)
+    if (hasSchemaTypes) {
+        statements.push(exportAllFrom('./schema-types'));
+    }
+    // Centralized query keys (for cache management)
+    if (hasQueryKeys) {
+        statements.push(exportAllFrom('./query-keys'));
+    }
+    // Centralized mutation keys (for tracking in-flight mutations)
+    if (hasMutationKeys) {
+        statements.push(exportAllFrom('./mutation-keys'));
+    }
+    // Cache invalidation helpers
+    if (hasInvalidation) {
+        statements.push(exportAllFrom('./invalidation'));
+    }
+    // Query hooks
+    statements.push(exportAllFrom('./queries'));
+    // Mutation hooks
+    if (hasMutations) {
+        statements.push(exportAllFrom('./mutations'));
+    }
+    // Add file header as leading comment on first statement
+    if (statements.length > 0) {
+        (0, babel_ast_1.addJSDocComment)(statements[0], [
+            'Auto-generated GraphQL SDK',
+            '@generated by @constructive-io/graphql-codegen',
+            '',
+            `Tables: ${tableNames}`,
+            '',
+            'Usage:',
+            '',
+            '1. Configure the client:',
+            '```ts',
+            "import { configure } from './generated';",
+            '',
+            'configure({',
+            "  endpoint: 'https://api.example.com/graphql',",
+            "  headers: { Authorization: 'Bearer <token>' },",
+            '});',
+            '```',
+            '',
+            '2. Use the hooks:',
+            '```tsx',
+            "import { useCarsQuery, useCreateCarMutation } from './generated';",
+            '',
+            'function MyComponent() {',
+            '  const { data, isLoading } = useCarsQuery({ first: 10 });',
+            '  const { mutate } = useCreateCarMutation();',
+            '  // ...',
+            '}',
+            '```',
+        ]);
+    }
+    return (0, babel_ast_1.generateCode)(statements);
 }
 // ============================================================================
 // Custom operation barrels (includes both table and custom hooks)
@@ -112,60 +174,60 @@ ${mutationsExport}`;
  * Generate queries barrel including custom query operations
  */
 function generateCustomQueriesBarrel(tables, customQueryNames) {
-    const lines = [
-        (0, ts_ast_1.createFileHeader)('Query hooks barrel export'),
-        '',
-        '// Table-based query hooks',
-    ];
+    const statements = [];
     // Export all table query hooks
     for (const table of tables) {
         const listHookName = (0, utils_1.getListQueryHookName)(table);
         const singleHookName = (0, utils_1.getSingleQueryHookName)(table);
-        lines.push(`export * from './${listHookName}';`);
-        lines.push(`export * from './${singleHookName}';`);
+        statements.push(exportAllFrom(`./${listHookName}`));
+        statements.push(exportAllFrom(`./${singleHookName}`));
     }
     // Add custom query hooks
-    if (customQueryNames.length > 0) {
-        lines.push('');
-        lines.push('// Custom query hooks');
-        for (const name of customQueryNames) {
-            const hookName = (0, type_resolver_1.getOperationHookName)(name, 'query');
-            lines.push(`export * from './${hookName}';`);
-        }
+    for (const name of customQueryNames) {
+        const hookName = (0, type_resolver_1.getOperationHookName)(name, 'query');
+        statements.push(exportAllFrom(`./${hookName}`));
+    }
+    // Add file header as leading comment on first statement
+    if (statements.length > 0) {
+        (0, babel_ast_1.addJSDocComment)(statements[0], [
+            'Query hooks barrel export',
+            '@generated by @constructive-io/graphql-codegen',
+            'DO NOT EDIT - changes will be overwritten',
+        ]);
     }
-    return lines.join('\n') + '\n';
+    return (0, babel_ast_1.generateCode)(statements);
 }
 /**
  * Generate mutations barrel including custom mutation operations
  */
 function generateCustomMutationsBarrel(tables, customMutationNames) {
-    const lines = [
-        (0, ts_ast_1.createFileHeader)('Mutation hooks barrel export'),
-        '',
-        '// Table-based mutation hooks',
-    ];
+    const statements = [];
     // Export all table mutation hooks
     for (const table of tables) {
         const createHookName = (0, utils_1.getCreateMutationHookName)(table);
         const updateHookName = (0, utils_1.getUpdateMutationHookName)(table);
         const deleteHookName = (0, utils_1.getDeleteMutationHookName)(table);
-        lines.push(`export * from './${createHookName}';`);
+        statements.push(exportAllFrom(`./${createHookName}`));
         // Only add update/delete if they exist
         if (table.query?.update !== null) {
-            lines.push(`export * from './${updateHookName}';`);
+            statements.push(exportAllFrom(`./${updateHookName}`));
         }
         if (table.query?.delete !== null) {
-            lines.push(`export * from './${deleteHookName}';`);
+            statements.push(exportAllFrom(`./${deleteHookName}`));
         }
     }
     // Add custom mutation hooks
-    if (customMutationNames.length > 0) {
-        lines.push('');
-        lines.push('// Custom mutation hooks');
-        for (const name of customMutationNames) {
-            const hookName = (0, type_resolver_1.getOperationHookName)(name, 'mutation');
-            lines.push(`export * from './${hookName}';`);
-        }
+    for (const name of customMutationNames) {
+        const hookName = (0, type_resolver_1.getOperationHookName)(name, 'mutation');
+        statements.push(exportAllFrom(`./${hookName}`));
+    }
+    // Add file header as leading comment on first statement
+    if (statements.length > 0) {
+        (0, babel_ast_1.addJSDocComment)(statements[0], [
+            'Mutation hooks barrel export',
+            '@generated by @constructive-io/graphql-codegen',
+            'DO NOT EDIT - changes will be overwritten',
+        ]);
     }
-    return lines.join('\n') + '\n';
+    return (0, babel_ast_1.generateCode)(statements);
 }

package/cli/codegen/client.js

@@ -199,5 +199,66 @@ export async function executeWithErrors<TData = unknown, TVariables = Record<str
     errors: json.errors ?? null,
   };
 }
+
+// ============================================================================
+// QueryClient Factory
+// ============================================================================
+
+/**
+ * Default QueryClient configuration optimized for GraphQL
+ *
+ * These defaults provide a good balance between freshness and performance:
+ * - staleTime: 1 minute - data considered fresh, won't refetch
+ * - gcTime: 5 minutes - unused data kept in cache
+ * - refetchOnWindowFocus: false - don't refetch when tab becomes active
+ * - retry: 1 - retry failed requests once
+ */
+export const defaultQueryClientOptions = {
+  defaultOptions: {
+    queries: {
+      staleTime: 1000 * 60, // 1 minute
+      gcTime: 1000 * 60 * 5, // 5 minutes
+      refetchOnWindowFocus: false,
+      retry: 1,
+    },
+  },
+};
+
+/**
+ * QueryClient options type for createQueryClient
+ */
+export interface CreateQueryClientOptions {
+  defaultOptions?: {
+    queries?: {
+      staleTime?: number;
+      gcTime?: number;
+      refetchOnWindowFocus?: boolean;
+      retry?: number | boolean;
+      retryDelay?: number | ((attemptIndex: number) => number);
+    };
+    mutations?: {
+      retry?: number | boolean;
+      retryDelay?: number | ((attemptIndex: number) => number);
+    };
+  };
+}
+
+// Note: createQueryClient is available when using with @tanstack/react-query
+// Import QueryClient from '@tanstack/react-query' and use these options:
+//
+// import { QueryClient } from '@tanstack/react-query';
+// const queryClient = new QueryClient(defaultQueryClientOptions);
+//
+// Or merge with your own options:
+// const queryClient = new QueryClient({
+//   ...defaultQueryClientOptions,
+//   defaultOptions: {
+//     ...defaultQueryClientOptions.defaultOptions,
+//     queries: {
+//       ...defaultQueryClientOptions.defaultOptions.queries,
+//       staleTime: 30000, // Override specific options
+//     },
+//   },
+// });
 `;
 }

package/cli/codegen/custom-mutations.d.ts

@@ -21,28 +21,18 @@ export interface GenerateCustomMutationHookOptions {
     typeRegistry: TypeRegistry;
     maxDepth?: number;
     skipQueryField?: boolean;
-    /** Whether to generate React Query hooks (default: true for backwards compatibility) */
     reactQueryEnabled?: boolean;
-    /** Table entity type names (for import path resolution) */
     tableTypeNames?: Set<string>;
+    useCentralizedKeys?: boolean;
 }
-/**
- * Generate a custom mutation hook file
- * When reactQueryEnabled is false, returns null since mutations require React Query
- */
 export declare function generateCustomMutationHook(options: GenerateCustomMutationHookOptions): GeneratedCustomMutationFile | null;
 export interface GenerateAllCustomMutationHooksOptions {
     operations: CleanOperation[];
     typeRegistry: TypeRegistry;
     maxDepth?: number;
     skipQueryField?: boolean;
-    /** Whether to generate React Query hooks (default: true for backwards compatibility) */
     reactQueryEnabled?: boolean;
-    /** Table entity type names (for import path resolution) */
     tableTypeNames?: Set<string>;
+    useCentralizedKeys?: boolean;
 }
-/**
- * Generate all custom mutation hook files
- * When reactQueryEnabled is false, returns empty array since mutations require React Query
- */
 export declare function generateAllCustomMutationHooks(options: GenerateAllCustomMutationHooksOptions): GeneratedCustomMutationFile[];