@constructive-io/graphql-codegen 2.20.1 → 2.21.0

package/cli/codegen/mutations.js

@@ -12,8 +12,14 @@ const utils_1 = require("./utils");
 // ============================================================================
 /**
  * Generate create mutation hook file content using AST
+ * When reactQueryEnabled is false, returns null since mutations require React Query
  */
-function generateCreateMutationHook(table) {
+function generateCreateMutationHook(table, options = {}) {
+    const { reactQueryEnabled = true } = options;
+    // Mutations require React Query - skip generation when disabled
+    if (!reactQueryEnabled) {
+        return null;
+    }
     const project = (0, ts_ast_1.createProject)();
     const { typeName, singularName } = (0, utils_1.getTableNames)(table);
     const hookName = (0, utils_1.getCreateMutationHookName)(table);
@@ -143,8 +149,14 @@ mutate({
 // ============================================================================
 /**
  * Generate update mutation hook file content using AST
+ * When reactQueryEnabled is false, returns null since mutations require React Query
  */
-function generateUpdateMutationHook(table) {
+function generateUpdateMutationHook(table, options = {}) {
+    const { reactQueryEnabled = true } = options;
+    // Mutations require React Query - skip generation when disabled
+    if (!reactQueryEnabled) {
+        return null;
+    }
     // Check if update mutation exists
     if (table.query?.update === null) {
         return null;
@@ -278,8 +290,14 @@ mutate({
 // ============================================================================
 /**
  * Generate delete mutation hook file content using AST
+ * When reactQueryEnabled is false, returns null since mutations require React Query
  */
-function generateDeleteMutationHook(table) {
+function generateDeleteMutationHook(table, options = {}) {
+    const { reactQueryEnabled = true } = options;
+    // Mutations require React Query - skip generation when disabled
+    if (!reactQueryEnabled) {
+        return null;
+    }
     // Check if delete mutation exists
     if (table.query?.delete === null) {
         return null;
@@ -392,16 +410,20 @@ mutate({
 // ============================================================================
 /**
  * Generate all mutation hook files for all tables
+ * When reactQueryEnabled is false, returns empty array since mutations require React Query
  */
-function generateAllMutationHooks(tables) {
+function generateAllMutationHooks(tables, options = {}) {
     const files = [];
     for (const table of tables) {
-        files.push(generateCreateMutationHook(table));
-        const updateHook = generateUpdateMutationHook(table);
+        const createHook = generateCreateMutationHook(table, options);
+        if (createHook) {
+            files.push(createHook);
+        }
+        const updateHook = generateUpdateMutationHook(table, options);
         if (updateHook) {
             files.push(updateHook);
         }
-        const deleteHook = generateDeleteMutationHook(table);
+        const deleteHook = generateDeleteMutationHook(table, options);
         if (deleteHook) {
             files.push(deleteHook);
         }

package/cli/codegen/queries.d.ts

@@ -11,15 +11,19 @@ export interface GeneratedQueryFile {
     fileName: string;
     content: string;
 }
+export interface QueryGeneratorOptions {
+    /** Whether to generate React Query hooks (default: true for backwards compatibility) */
+    reactQueryEnabled?: boolean;
+}
 /**
  * Generate list query hook file content using AST
  */
-export declare function generateListQueryHook(table: CleanTable): GeneratedQueryFile;
+export declare function generateListQueryHook(table: CleanTable, options?: QueryGeneratorOptions): GeneratedQueryFile;
 /**
  * Generate single item query hook file content using AST
  */
-export declare function generateSingleQueryHook(table: CleanTable): GeneratedQueryFile;
+export declare function generateSingleQueryHook(table: CleanTable, options?: QueryGeneratorOptions): GeneratedQueryFile;
 /**
  * Generate all query hook files for all tables
  */
-export declare function generateAllQueryHooks(tables: CleanTable[]): GeneratedQueryFile[];
+export declare function generateAllQueryHooks(tables: CleanTable[], options?: QueryGeneratorOptions): GeneratedQueryFile[];

package/cli/codegen/queries.js

@@ -12,7 +12,8 @@ const utils_1 = require("./utils");
 /**
  * Generate list query hook file content using AST
  */
-function generateListQueryHook(table) {
+function generateListQueryHook(table, options = {}) {
+    const { reactQueryEnabled = true } = options;
     const project = (0, ts_ast_1.createProject)();
     const { typeName, pluralName } = (0, utils_1.getTableNames)(table);
     const hookName = (0, utils_1.getListQueryHookName)(table);
@@ -25,7 +26,10 @@ function generateListQueryHook(table) {
     const queryDocument = (0, gql_ast_1.printGraphQL)(queryAST);
     const sourceFile = (0, ts_ast_1.createSourceFile)(project, (0, utils_1.getListQueryFileName)(table));
     // Add file header as leading comment
-    sourceFile.insertText(0, (0, ts_ast_1.createFileHeader)(`List query hook for ${typeName}`) + '\n\n');
+    const headerText = reactQueryEnabled
+        ? `List query hook for ${typeName}`
+        : `List query functions for ${typeName}`;
+    sourceFile.insertText(0, (0, ts_ast_1.createFileHeader)(headerText) + '\n\n');
     // Collect all filter types used by this table's fields
     const filterTypesUsed = new Set();
     for (const field of scalarFields) {
@@ -34,23 +38,24 @@ function generateListQueryHook(table) {
             filterTypesUsed.add(filterType);
         }
     }
-    // Add imports
-    sourceFile.addImportDeclarations([
-        (0, ts_ast_1.createImport)({
+    // Add imports - conditionally include React Query imports
+    const imports = [];
+    if (reactQueryEnabled) {
+        imports.push((0, ts_ast_1.createImport)({
             moduleSpecifier: '@tanstack/react-query',
             namedImports: ['useQuery'],
             typeOnlyNamedImports: ['UseQueryOptions', 'QueryClient'],
-        }),
-        (0, ts_ast_1.createImport)({
-            moduleSpecifier: '../client',
-            namedImports: ['execute'],
-            typeOnlyNamedImports: ['ExecuteOptions'],
-        }),
-        (0, ts_ast_1.createImport)({
-            moduleSpecifier: '../types',
-            typeOnlyNamedImports: [typeName, ...Array.from(filterTypesUsed)],
-        }),
-    ]);
+        }));
+    }
+    imports.push((0, ts_ast_1.createImport)({
+        moduleSpecifier: '../client',
+        namedImports: ['execute'],
+        typeOnlyNamedImports: ['ExecuteOptions'],
+    }), (0, ts_ast_1.createImport)({
+        moduleSpecifier: '../types',
+        typeOnlyNamedImports: [typeName, ...Array.from(filterTypesUsed)],
+    }));
+    sourceFile.addImportDeclarations(imports);
     // Re-export entity type
     sourceFile.addStatements(`\n// Re-export entity type for convenience\nexport type { ${typeName} };\n`);
     // Add section comment
@@ -114,27 +119,28 @@ function generateListQueryHook(table) {
     // Query key factory
     sourceFile.addVariableStatement((0, ts_ast_1.createConst)(`${queryName}QueryKey`, `(variables?: ${(0, utils_1.ucFirst)(pluralName)}QueryVariables) =>
   ['${typeName.toLowerCase()}', 'list', variables] as const`));
-    // Add section comment
-    sourceFile.addStatements('\n// ============================================================================');
-    sourceFile.addStatements('// Hook');
-    sourceFile.addStatements('// ============================================================================\n');
-    // Hook function
-    sourceFile.addFunction({
-        name: hookName,
-        isExported: true,
-        parameters: [
-            {
-                name: 'variables',
-                type: `${(0, utils_1.ucFirst)(pluralName)}QueryVariables`,
-                hasQuestionToken: true,
-            },
-            {
-                name: 'options',
-                type: `Omit<UseQueryOptions<${(0, utils_1.ucFirst)(pluralName)}QueryResult, Error>, 'queryKey' | 'queryFn'>`,
-                hasQuestionToken: true,
-            },
-        ],
-        statements: `return useQuery({
+    // Add React Query hook section (only if enabled)
+    if (reactQueryEnabled) {
+        sourceFile.addStatements('\n// ============================================================================');
+        sourceFile.addStatements('// Hook');
+        sourceFile.addStatements('// ============================================================================\n');
+        // Hook function
+        sourceFile.addFunction({
+            name: hookName,
+            isExported: true,
+            parameters: [
+                {
+                    name: 'variables',
+                    type: `${(0, utils_1.ucFirst)(pluralName)}QueryVariables`,
+                    hasQuestionToken: true,
+                },
+                {
+                    name: 'options',
+                    type: `Omit<UseQueryOptions<${(0, utils_1.ucFirst)(pluralName)}QueryResult, Error>, 'queryKey' | 'queryFn'>`,
+                    hasQuestionToken: true,
+                },
+            ],
+            statements: `return useQuery({
     queryKey: ${queryName}QueryKey(variables),
     queryFn: () => execute<${(0, utils_1.ucFirst)(pluralName)}QueryResult, ${(0, utils_1.ucFirst)(pluralName)}QueryVariables>(
       ${queryName}QueryDocument,
@@ -142,9 +148,9 @@ function generateListQueryHook(table) {
     ),
     ...options,
   });`,
-        docs: [
-            {
-                description: `Query hook for fetching ${typeName} list
+            docs: [
+                {
+                    description: `Query hook for fetching ${typeName} list
 
 @example
 \`\`\`tsx
@@ -154,9 +160,10 @@ const { data, isLoading } = ${hookName}({
   orderBy: ['CREATED_AT_DESC'],
 });
 \`\`\``,
-            },
-        ],
-    });
+                },
+            ],
+        });
+    }
     // Add section comment for standalone functions
     sourceFile.addStatements('\n// ============================================================================');
     sourceFile.addStatements('// Standalone Functions (non-React)');
@@ -202,29 +209,30 @@ const data = await queryClient.fetchQuery({
             },
         ],
     });
-    // Prefetch function (for SSR/QueryClient)
-    sourceFile.addFunction({
-        name: `prefetch${(0, utils_1.ucFirst)(pluralName)}Query`,
-        isExported: true,
-        isAsync: true,
-        parameters: [
-            {
-                name: 'queryClient',
-                type: 'QueryClient',
-            },
-            {
-                name: 'variables',
-                type: `${(0, utils_1.ucFirst)(pluralName)}QueryVariables`,
-                hasQuestionToken: true,
-            },
-            {
-                name: 'options',
-                type: 'ExecuteOptions',
-                hasQuestionToken: true,
-            },
-        ],
-        returnType: 'Promise<void>',
-        statements: `await queryClient.prefetchQuery({
+    // Prefetch function (for SSR/QueryClient) - only if React Query is enabled
+    if (reactQueryEnabled) {
+        sourceFile.addFunction({
+            name: `prefetch${(0, utils_1.ucFirst)(pluralName)}Query`,
+            isExported: true,
+            isAsync: true,
+            parameters: [
+                {
+                    name: 'queryClient',
+                    type: 'QueryClient',
+                },
+                {
+                    name: 'variables',
+                    type: `${(0, utils_1.ucFirst)(pluralName)}QueryVariables`,
+                    hasQuestionToken: true,
+                },
+                {
+                    name: 'options',
+                    type: 'ExecuteOptions',
+                    hasQuestionToken: true,
+                },
+            ],
+            returnType: 'Promise<void>',
+            statements: `await queryClient.prefetchQuery({
     queryKey: ${queryName}QueryKey(variables),
     queryFn: () => execute<${(0, utils_1.ucFirst)(pluralName)}QueryResult, ${(0, utils_1.ucFirst)(pluralName)}QueryVariables>(
       ${queryName}QueryDocument,
@@ -232,17 +240,18 @@ const data = await queryClient.fetchQuery({
       options
     ),
   });`,
-        docs: [
-            {
-                description: `Prefetch ${typeName} list for SSR or cache warming
+            docs: [
+                {
+                    description: `Prefetch ${typeName} list for SSR or cache warming
 
 @example
 \`\`\`ts
 await prefetch${(0, utils_1.ucFirst)(pluralName)}Query(queryClient, { first: 10 });
 \`\`\``,
-            },
-        ],
-    });
+                },
+            ],
+        });
+    }
     return {
         fileName: (0, utils_1.getListQueryFileName)(table),
         content: (0, ts_ast_1.getFormattedOutput)(sourceFile),
@@ -254,7 +263,8 @@ await prefetch${(0, utils_1.ucFirst)(pluralName)}Query(queryClient, { first: 10
 /**
  * Generate single item query hook file content using AST
  */
-function generateSingleQueryHook(table) {
+function generateSingleQueryHook(table, options = {}) {
+    const { reactQueryEnabled = true } = options;
     const project = (0, ts_ast_1.createProject)();
     const { typeName, singularName } = (0, utils_1.getTableNames)(table);
     const hookName = (0, utils_1.getSingleQueryHookName)(table);
@@ -264,24 +274,28 @@ function generateSingleQueryHook(table) {
     const queryDocument = (0, gql_ast_1.printGraphQL)(queryAST);
     const sourceFile = (0, ts_ast_1.createSourceFile)(project, (0, utils_1.getSingleQueryFileName)(table));
     // Add file header
-    sourceFile.insertText(0, (0, ts_ast_1.createFileHeader)(`Single item query hook for ${typeName}`) + '\n\n');
-    // Add imports
-    sourceFile.addImportDeclarations([
-        (0, ts_ast_1.createImport)({
+    const headerText = reactQueryEnabled
+        ? `Single item query hook for ${typeName}`
+        : `Single item query functions for ${typeName}`;
+    sourceFile.insertText(0, (0, ts_ast_1.createFileHeader)(headerText) + '\n\n');
+    // Add imports - conditionally include React Query imports
+    const imports = [];
+    if (reactQueryEnabled) {
+        imports.push((0, ts_ast_1.createImport)({
             moduleSpecifier: '@tanstack/react-query',
             namedImports: ['useQuery'],
             typeOnlyNamedImports: ['UseQueryOptions', 'QueryClient'],
-        }),
-        (0, ts_ast_1.createImport)({
-            moduleSpecifier: '../client',
-            namedImports: ['execute'],
-            typeOnlyNamedImports: ['ExecuteOptions'],
-        }),
-        (0, ts_ast_1.createImport)({
-            moduleSpecifier: '../types',
-            typeOnlyNamedImports: [typeName],
-        }),
-    ]);
+        }));
+    }
+    imports.push((0, ts_ast_1.createImport)({
+        moduleSpecifier: '../client',
+        namedImports: ['execute'],
+        typeOnlyNamedImports: ['ExecuteOptions'],
+    }), (0, ts_ast_1.createImport)({
+        moduleSpecifier: '../types',
+        typeOnlyNamedImports: [typeName],
+    }));
+    sourceFile.addImportDeclarations(imports);
     // Re-export entity type
     sourceFile.addStatements(`\n// Re-export entity type for convenience\nexport type { ${typeName} };\n`);
     // Add section comment
@@ -309,23 +323,24 @@ function generateSingleQueryHook(table) {
     // Query key factory
     sourceFile.addVariableStatement((0, ts_ast_1.createConst)(`${queryName}QueryKey`, `(id: string) =>
   ['${typeName.toLowerCase()}', 'detail', id] as const`));
-    // Add section comment
-    sourceFile.addStatements('\n// ============================================================================');
-    sourceFile.addStatements('// Hook');
-    sourceFile.addStatements('// ============================================================================\n');
-    // Hook function
-    sourceFile.addFunction({
-        name: hookName,
-        isExported: true,
-        parameters: [
-            { name: 'id', type: 'string' },
-            {
-                name: 'options',
-                type: `Omit<UseQueryOptions<${(0, utils_1.ucFirst)(singularName)}QueryResult, Error>, 'queryKey' | 'queryFn'>`,
-                hasQuestionToken: true,
-            },
-        ],
-        statements: `return useQuery({
+    // Add React Query hook section (only if enabled)
+    if (reactQueryEnabled) {
+        sourceFile.addStatements('\n// ============================================================================');
+        sourceFile.addStatements('// Hook');
+        sourceFile.addStatements('// ============================================================================\n');
+        // Hook function
+        sourceFile.addFunction({
+            name: hookName,
+            isExported: true,
+            parameters: [
+                { name: 'id', type: 'string' },
+                {
+                    name: 'options',
+                    type: `Omit<UseQueryOptions<${(0, utils_1.ucFirst)(singularName)}QueryResult, Error>, 'queryKey' | 'queryFn'>`,
+                    hasQuestionToken: true,
+                },
+            ],
+            statements: `return useQuery({
     queryKey: ${queryName}QueryKey(id),
     queryFn: () => execute<${(0, utils_1.ucFirst)(singularName)}QueryResult, ${(0, utils_1.ucFirst)(singularName)}QueryVariables>(
       ${queryName}QueryDocument,
@@ -334,9 +349,9 @@ function generateSingleQueryHook(table) {
     enabled: !!id && (options?.enabled !== false),
     ...options,
   });`,
-        docs: [
-            {
-                description: `Query hook for fetching a single ${typeName} by ID
+            docs: [
+                {
+                    description: `Query hook for fetching a single ${typeName} by ID
 
 @example
 \`\`\`tsx
@@ -346,9 +361,10 @@ if (data?.${queryName}) {
   console.log(data.${queryName}.id);
 }
 \`\`\``,
-            },
-        ],
-    });
+                },
+            ],
+        });
+    }
     // Add section comment for standalone functions
     sourceFile.addStatements('\n// ============================================================================');
     sourceFile.addStatements('// Standalone Functions (non-React)');
@@ -383,22 +399,23 @@ const data = await fetch${(0, utils_1.ucFirst)(singularName)}Query('uuid-here');
             },
         ],
     });
-    // Prefetch function (for SSR/QueryClient)
-    sourceFile.addFunction({
-        name: `prefetch${(0, utils_1.ucFirst)(singularName)}Query`,
-        isExported: true,
-        isAsync: true,
-        parameters: [
-            { name: 'queryClient', type: 'QueryClient' },
-            { name: 'id', type: 'string' },
-            {
-                name: 'options',
-                type: 'ExecuteOptions',
-                hasQuestionToken: true,
-            },
-        ],
-        returnType: 'Promise<void>',
-        statements: `await queryClient.prefetchQuery({
+    // Prefetch function (for SSR/QueryClient) - only if React Query is enabled
+    if (reactQueryEnabled) {
+        sourceFile.addFunction({
+            name: `prefetch${(0, utils_1.ucFirst)(singularName)}Query`,
+            isExported: true,
+            isAsync: true,
+            parameters: [
+                { name: 'queryClient', type: 'QueryClient' },
+                { name: 'id', type: 'string' },
+                {
+                    name: 'options',
+                    type: 'ExecuteOptions',
+                    hasQuestionToken: true,
+                },
+            ],
+            returnType: 'Promise<void>',
+            statements: `await queryClient.prefetchQuery({
     queryKey: ${queryName}QueryKey(id),
     queryFn: () => execute<${(0, utils_1.ucFirst)(singularName)}QueryResult, ${(0, utils_1.ucFirst)(singularName)}QueryVariables>(
       ${queryName}QueryDocument,
@@ -406,17 +423,18 @@ const data = await fetch${(0, utils_1.ucFirst)(singularName)}Query('uuid-here');
       options
     ),
   });`,
-        docs: [
-            {
-                description: `Prefetch a single ${typeName} for SSR or cache warming
+            docs: [
+                {
+                    description: `Prefetch a single ${typeName} for SSR or cache warming
 
 @example
 \`\`\`ts
 await prefetch${(0, utils_1.ucFirst)(singularName)}Query(queryClient, 'uuid-here');
 \`\`\``,
-            },
-        ],
-    });
+                },
+            ],
+        });
+    }
     return {
         fileName: (0, utils_1.getSingleQueryFileName)(table),
         content: (0, ts_ast_1.getFormattedOutput)(sourceFile),
@@ -428,11 +446,11 @@ await prefetch${(0, utils_1.ucFirst)(singularName)}Query(queryClient, 'uuid-here
 /**
  * Generate all query hook files for all tables
  */
-function generateAllQueryHooks(tables) {
+function generateAllQueryHooks(tables, options = {}) {
     const files = [];
     for (const table of tables) {
-        files.push(generateListQueryHook(table));
-        files.push(generateSingleQueryHook(table));
+        files.push(generateListQueryHook(table, options));
+        files.push(generateSingleQueryHook(table, options));
     }
     return files;
 }

package/esm/__tests__/codegen/react-query-optional.test.d.ts

@@ -0,0 +1 @@
+export {};