@constructive-io/graphql-codegen 2.20.1 → 2.22.0

package/esm/cli/codegen/queries.js

@@ -1,13 +1,14 @@
 import { createProject, createSourceFile, getFormattedOutput, createFileHeader, createImport, createInterface, createConst, createTypeAlias, createUnionType, createFilterInterface, } from './ts-ast';
 import { buildListQueryAST, buildSingleQueryAST, printGraphQL, } from './gql-ast';
-import { getTableNames, getListQueryHookName, getSingleQueryHookName, getListQueryFileName, getSingleQueryFileName, getAllRowsQueryName, getSingleRowQueryName, getFilterTypeName, getOrderByTypeName, getScalarFields, getScalarFilterType, toScreamingSnake, ucFirst, } from './utils';
+import { getTableNames, getListQueryHookName, getSingleQueryHookName, getListQueryFileName, getSingleQueryFileName, getAllRowsQueryName, getSingleRowQueryName, getFilterTypeName, getOrderByTypeName, getScalarFields, getScalarFilterType, getPrimaryKeyInfo, toScreamingSnake, ucFirst, } from './utils';
 // ============================================================================
 // List query hook generator
 // ============================================================================
 /**
  * Generate list query hook file content using AST
  */
-export function generateListQueryHook(table) {
+export function generateListQueryHook(table, options = {}) {
+    const { reactQueryEnabled = true } = options;
     const project = createProject();
     const { typeName, pluralName } = getTableNames(table);
     const hookName = getListQueryHookName(table);
@@ -20,32 +21,36 @@ export function generateListQueryHook(table) {
     const queryDocument = printGraphQL(queryAST);
     const sourceFile = createSourceFile(project, getListQueryFileName(table));
     // Add file header as leading comment
-    sourceFile.insertText(0, createFileHeader(`List query hook for ${typeName}`) + '\n\n');
+    const headerText = reactQueryEnabled
+        ? `List query hook for ${typeName}`
+        : `List query functions for ${typeName}`;
+    sourceFile.insertText(0, createFileHeader(headerText) + '\n\n');
     // Collect all filter types used by this table's fields
     const filterTypesUsed = new Set();
     for (const field of scalarFields) {
-        const filterType = getScalarFilterType(field.type.gqlType);
+        const filterType = getScalarFilterType(field.type.gqlType, field.type.isArray);
         if (filterType) {
             filterTypesUsed.add(filterType);
         }
     }
-    // Add imports
-    sourceFile.addImportDeclarations([
-        createImport({
+    // Add imports - conditionally include React Query imports
+    const imports = [];
+    if (reactQueryEnabled) {
+        imports.push(createImport({
             moduleSpecifier: '@tanstack/react-query',
             namedImports: ['useQuery'],
             typeOnlyNamedImports: ['UseQueryOptions', 'QueryClient'],
-        }),
-        createImport({
-            moduleSpecifier: '../client',
-            namedImports: ['execute'],
-            typeOnlyNamedImports: ['ExecuteOptions'],
-        }),
-        createImport({
-            moduleSpecifier: '../types',
-            typeOnlyNamedImports: [typeName, ...Array.from(filterTypesUsed)],
-        }),
-    ]);
+        }));
+    }
+    imports.push(createImport({
+        moduleSpecifier: '../client',
+        namedImports: ['execute'],
+        typeOnlyNamedImports: ['ExecuteOptions'],
+    }), 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
@@ -61,12 +66,14 @@ export function generateListQueryHook(table) {
     // Generate filter interface
     const fieldFilters = scalarFields
         .map((field) => {
-        const filterType = getScalarFilterType(field.type.gqlType);
+        const filterType = getScalarFilterType(field.type.gqlType, field.type.isArray);
         return filterType ? { fieldName: field.name, filterType } : null;
     })
         .filter((f) => f !== null);
-    sourceFile.addInterface(createFilterInterface(filterTypeName, fieldFilters));
+    // Note: Not exported to avoid conflicts with schema-types
+    sourceFile.addInterface(createFilterInterface(filterTypeName, fieldFilters, { isExported: false }));
     // Generate OrderBy type
+    // Note: Not exported to avoid conflicts with schema-types
     const orderByValues = [
         ...scalarFields.flatMap((f) => [
             `${toScreamingSnake(f.name)}_ASC`,
@@ -76,7 +83,7 @@ export function generateListQueryHook(table) {
         'PRIMARY_KEY_ASC',
         'PRIMARY_KEY_DESC',
     ];
-    sourceFile.addTypeAlias(createTypeAlias(orderByTypeName, createUnionType(orderByValues)));
+    sourceFile.addTypeAlias(createTypeAlias(orderByTypeName, createUnionType(orderByValues), { isExported: false }));
     // Variables interface
     const variablesProps = [
         { name: 'first', type: 'number', optional: true },
@@ -109,27 +116,28 @@ export function generateListQueryHook(table) {
     // Query key factory
     sourceFile.addVariableStatement(createConst(`${queryName}QueryKey`, `(variables?: ${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: `${ucFirst(pluralName)}QueryVariables`,
-                hasQuestionToken: true,
-            },
-            {
-                name: 'options',
-                type: `Omit<UseQueryOptions<${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: `${ucFirst(pluralName)}QueryVariables`,
+                    hasQuestionToken: true,
+                },
+                {
+                    name: 'options',
+                    type: `Omit<UseQueryOptions<${ucFirst(pluralName)}QueryResult, Error>, 'queryKey' | 'queryFn'>`,
+                    hasQuestionToken: true,
+                },
+            ],
+            statements: `return useQuery({
     queryKey: ${queryName}QueryKey(variables),
     queryFn: () => execute<${ucFirst(pluralName)}QueryResult, ${ucFirst(pluralName)}QueryVariables>(
       ${queryName}QueryDocument,
@@ -137,9 +145,9 @@ export function generateListQueryHook(table) {
     ),
     ...options,
   });`,
-        docs: [
-            {
-                description: `Query hook for fetching ${typeName} list
+            docs: [
+                {
+                    description: `Query hook for fetching ${typeName} list
 
 @example
 \`\`\`tsx
@@ -149,9 +157,10 @@ const { data, isLoading } = ${hookName}({
   orderBy: ['CREATED_AT_DESC'],
 });
 \`\`\``,
-            },
-        ],
-    });
+                },
+            ],
+        });
+    }
     // Add section comment for standalone functions
     sourceFile.addStatements('\n// ============================================================================');
     sourceFile.addStatements('// Standalone Functions (non-React)');
@@ -197,29 +206,30 @@ const data = await queryClient.fetchQuery({
             },
         ],
     });
-    // Prefetch function (for SSR/QueryClient)
-    sourceFile.addFunction({
-        name: `prefetch${ucFirst(pluralName)}Query`,
-        isExported: true,
-        isAsync: true,
-        parameters: [
-            {
-                name: 'queryClient',
-                type: 'QueryClient',
-            },
-            {
-                name: 'variables',
-                type: `${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${ucFirst(pluralName)}Query`,
+            isExported: true,
+            isAsync: true,
+            parameters: [
+                {
+                    name: 'queryClient',
+                    type: 'QueryClient',
+                },
+                {
+                    name: 'variables',
+                    type: `${ucFirst(pluralName)}QueryVariables`,
+                    hasQuestionToken: true,
+                },
+                {
+                    name: 'options',
+                    type: 'ExecuteOptions',
+                    hasQuestionToken: true,
+                },
+            ],
+            returnType: 'Promise<void>',
+            statements: `await queryClient.prefetchQuery({
     queryKey: ${queryName}QueryKey(variables),
     queryFn: () => execute<${ucFirst(pluralName)}QueryResult, ${ucFirst(pluralName)}QueryVariables>(
       ${queryName}QueryDocument,
@@ -227,17 +237,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${ucFirst(pluralName)}Query(queryClient, { first: 10 });
 \`\`\``,
-            },
-        ],
-    });
+                },
+            ],
+        });
+    }
     return {
         fileName: getListQueryFileName(table),
         content: getFormattedOutput(sourceFile),
@@ -249,34 +260,46 @@ await prefetch${ucFirst(pluralName)}Query(queryClient, { first: 10 });
 /**
  * Generate single item query hook file content using AST
  */
-export function generateSingleQueryHook(table) {
+export function generateSingleQueryHook(table, options = {}) {
+    const { reactQueryEnabled = true } = options;
     const project = createProject();
     const { typeName, singularName } = getTableNames(table);
     const hookName = getSingleQueryHookName(table);
     const queryName = getSingleRowQueryName(table);
+    // Get primary key info dynamically from table constraints
+    const pkFields = getPrimaryKeyInfo(table);
+    // For simplicity, use first PK field (most common case)
+    // Composite PKs would need more complex handling
+    const pkField = pkFields[0];
+    const pkName = pkField.name;
+    const pkTsType = pkField.tsType;
     // Generate GraphQL document via AST
     const queryAST = buildSingleQueryAST({ table });
     const queryDocument = printGraphQL(queryAST);
     const sourceFile = createSourceFile(project, getSingleQueryFileName(table));
     // Add file header
-    sourceFile.insertText(0, createFileHeader(`Single item query hook for ${typeName}`) + '\n\n');
-    // Add imports
-    sourceFile.addImportDeclarations([
-        createImport({
+    const headerText = reactQueryEnabled
+        ? `Single item query hook for ${typeName}`
+        : `Single item query functions for ${typeName}`;
+    sourceFile.insertText(0, createFileHeader(headerText) + '\n\n');
+    // Add imports - conditionally include React Query imports
+    const imports = [];
+    if (reactQueryEnabled) {
+        imports.push(createImport({
             moduleSpecifier: '@tanstack/react-query',
             namedImports: ['useQuery'],
             typeOnlyNamedImports: ['UseQueryOptions', 'QueryClient'],
-        }),
-        createImport({
-            moduleSpecifier: '../client',
-            namedImports: ['execute'],
-            typeOnlyNamedImports: ['ExecuteOptions'],
-        }),
-        createImport({
-            moduleSpecifier: '../types',
-            typeOnlyNamedImports: [typeName],
-        }),
-    ]);
+        }));
+    }
+    imports.push(createImport({
+        moduleSpecifier: '../client',
+        namedImports: ['execute'],
+        typeOnlyNamedImports: ['ExecuteOptions'],
+    }), 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
@@ -289,9 +312,9 @@ export function generateSingleQueryHook(table) {
     sourceFile.addStatements('\n// ============================================================================');
     sourceFile.addStatements('// Types');
     sourceFile.addStatements('// ============================================================================\n');
-    // Variables interface
+    // Variables interface - use dynamic PK field name and type
     sourceFile.addInterface(createInterface(`${ucFirst(singularName)}QueryVariables`, [
-        { name: 'id', type: 'string' },
+        { name: pkName, type: pkTsType },
     ]));
     // Result interface
     sourceFile.addInterface(createInterface(`${ucFirst(singularName)}QueryResult`, [
@@ -301,60 +324,62 @@ export function generateSingleQueryHook(table) {
     sourceFile.addStatements('\n// ============================================================================');
     sourceFile.addStatements('// Query Key');
     sourceFile.addStatements('// ============================================================================\n');
-    // Query key factory
-    sourceFile.addVariableStatement(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<${ucFirst(singularName)}QueryResult, Error>, 'queryKey' | 'queryFn'>`,
-                hasQuestionToken: true,
-            },
-        ],
-        statements: `return useQuery({
-    queryKey: ${queryName}QueryKey(id),
+    // Query key factory - use dynamic PK field name and type
+    sourceFile.addVariableStatement(createConst(`${queryName}QueryKey`, `(${pkName}: ${pkTsType}) =>
+  ['${typeName.toLowerCase()}', 'detail', ${pkName}] as const`));
+    // Add React Query hook section (only if enabled)
+    if (reactQueryEnabled) {
+        sourceFile.addStatements('\n// ============================================================================');
+        sourceFile.addStatements('// Hook');
+        sourceFile.addStatements('// ============================================================================\n');
+        // Hook function - use dynamic PK field name and type
+        sourceFile.addFunction({
+            name: hookName,
+            isExported: true,
+            parameters: [
+                { name: pkName, type: pkTsType },
+                {
+                    name: 'options',
+                    type: `Omit<UseQueryOptions<${ucFirst(singularName)}QueryResult, Error>, 'queryKey' | 'queryFn'>`,
+                    hasQuestionToken: true,
+                },
+            ],
+            statements: `return useQuery({
+    queryKey: ${queryName}QueryKey(${pkName}),
     queryFn: () => execute<${ucFirst(singularName)}QueryResult, ${ucFirst(singularName)}QueryVariables>(
       ${queryName}QueryDocument,
-      { id }
+      { ${pkName} }
     ),
-    enabled: !!id && (options?.enabled !== false),
+    enabled: !!${pkName} && (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 primary key
 
 @example
 \`\`\`tsx
-const { data, isLoading } = ${hookName}('uuid-here');
+const { data, isLoading } = ${hookName}(${pkTsType === 'string' ? "'value-here'" : '123'});
 
 if (data?.${queryName}) {
-  console.log(data.${queryName}.id);
+  console.log(data.${queryName}.${pkName});
 }
 \`\`\``,
-            },
-        ],
-    });
+                },
+            ],
+        });
+    }
     // Add section comment for standalone functions
     sourceFile.addStatements('\n// ============================================================================');
     sourceFile.addStatements('// Standalone Functions (non-React)');
     sourceFile.addStatements('// ============================================================================\n');
-    // Fetch function (standalone, no React)
+    // Fetch function (standalone, no React) - use dynamic PK
     sourceFile.addFunction({
         name: `fetch${ucFirst(singularName)}Query`,
         isExported: true,
         isAsync: true,
         parameters: [
-            { name: 'id', type: 'string' },
+            { name: pkName, type: pkTsType },
             {
                 name: 'options',
                 type: 'ExecuteOptions',
@@ -364,54 +389,56 @@ if (data?.${queryName}) {
         returnType: `Promise<${ucFirst(singularName)}QueryResult>`,
         statements: `return execute<${ucFirst(singularName)}QueryResult, ${ucFirst(singularName)}QueryVariables>(
     ${queryName}QueryDocument,
-    { id },
+    { ${pkName} },
     options
   );`,
         docs: [
             {
-                description: `Fetch a single ${typeName} by ID without React hooks
+                description: `Fetch a single ${typeName} by primary key without React hooks
 
 @example
 \`\`\`ts
-const data = await fetch${ucFirst(singularName)}Query('uuid-here');
+const data = await fetch${ucFirst(singularName)}Query(${pkTsType === 'string' ? "'value-here'" : '123'});
 \`\`\``,
             },
         ],
     });
-    // Prefetch function (for SSR/QueryClient)
-    sourceFile.addFunction({
-        name: `prefetch${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),
+    // Prefetch function (for SSR/QueryClient) - only if React Query is enabled, use dynamic PK
+    if (reactQueryEnabled) {
+        sourceFile.addFunction({
+            name: `prefetch${ucFirst(singularName)}Query`,
+            isExported: true,
+            isAsync: true,
+            parameters: [
+                { name: 'queryClient', type: 'QueryClient' },
+                { name: pkName, type: pkTsType },
+                {
+                    name: 'options',
+                    type: 'ExecuteOptions',
+                    hasQuestionToken: true,
+                },
+            ],
+            returnType: 'Promise<void>',
+            statements: `await queryClient.prefetchQuery({
+    queryKey: ${queryName}QueryKey(${pkName}),
     queryFn: () => execute<${ucFirst(singularName)}QueryResult, ${ucFirst(singularName)}QueryVariables>(
       ${queryName}QueryDocument,
-      { id },
+      { ${pkName} },
       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${ucFirst(singularName)}Query(queryClient, 'uuid-here');
+await prefetch${ucFirst(singularName)}Query(queryClient, ${pkTsType === 'string' ? "'value-here'" : '123'});
 \`\`\``,
-            },
-        ],
-    });
+                },
+            ],
+        });
+    }
     return {
         fileName: getSingleQueryFileName(table),
         content: getFormattedOutput(sourceFile),
@@ -423,11 +450,11 @@ await prefetch${ucFirst(singularName)}Query(queryClient, 'uuid-here');
 /**
  * Generate all query hook files for all tables
  */
-export function generateAllQueryHooks(tables) {
+export 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/cli/codegen/scalars.d.ts

@@ -4,9 +4,11 @@
 export declare const SCALAR_TS_MAP: Record<string, string>;
 export declare const SCALAR_FILTER_MAP: Record<string, string>;
 export declare const SCALAR_NAMES: Set<string>;
-export interface ScalarToTsOptions {
+/** All base filter type names - skip these in schema-types.ts to avoid duplicates */
+export declare const BASE_FILTER_TYPE_NAMES: Set<string>;
+export declare function scalarToTsType(scalarName: string, options?: {
     unknownScalar?: 'unknown' | 'name';
     overrides?: Record<string, string>;
-}
-export declare function scalarToTsType(scalarName: string, options?: ScalarToTsOptions): string;
-export declare function scalarToFilterType(scalarName: string): string | null;
+}): string;
+/** Get the filter type for a scalar (handles both scalar and array types) */
+export declare function scalarToFilterType(scalarName: string, isArray?: boolean): string | null;

package/esm/cli/codegen/scalars.js

@@ -32,6 +32,8 @@ export const SCALAR_TS_MAP = {
     MacAddr: 'string',
     TsVector: 'string',
     TsQuery: 'string',
+    // File upload
+    Upload: 'File',
 };
 export const SCALAR_FILTER_MAP = {
     String: 'StringFilter',
@@ -52,15 +54,21 @@ export const SCALAR_FILTER_MAP = {
     Interval: 'StringFilter',
 };
 export const SCALAR_NAMES = new Set(Object.keys(SCALAR_TS_MAP));
+/** Scalars that have list filter variants (e.g., StringListFilter) */
+const LIST_FILTER_SCALARS = new Set(['String', 'Int', 'UUID']);
+/** All base filter type names - skip these in schema-types.ts to avoid duplicates */
+export const BASE_FILTER_TYPE_NAMES = new Set([
+    ...new Set(Object.values(SCALAR_FILTER_MAP)),
+    ...Array.from(LIST_FILTER_SCALARS).map((s) => `${s}ListFilter`),
+]);
 export function scalarToTsType(scalarName, options = {}) {
-    const override = options.overrides?.[scalarName];
-    if (override)
-        return override;
-    const mapped = SCALAR_TS_MAP[scalarName];
-    if (mapped)
-        return mapped;
-    return options.unknownScalar === 'unknown' ? 'unknown' : scalarName;
+    return options.overrides?.[scalarName] ?? SCALAR_TS_MAP[scalarName] ?? (options.unknownScalar === 'unknown' ? 'unknown' : scalarName);
 }
-export function scalarToFilterType(scalarName) {
+/** Get the filter type for a scalar (handles both scalar and array types) */
+export function scalarToFilterType(scalarName, isArray = false) {
+    const baseName = scalarName === 'ID' ? 'UUID' : scalarName;
+    if (isArray) {
+        return LIST_FILTER_SCALARS.has(baseName) ? `${baseName}ListFilter` : null;
+    }
     return SCALAR_FILTER_MAP[scalarName] ?? null;
 }

package/esm/cli/codegen/schema-types-generator.d.ts

@@ -0,0 +1,26 @@
+import type { TypeRegistry } from '../../types/schema';
+export interface GeneratedSchemaTypesFile {
+    fileName: string;
+    content: string;
+    /** List of enum type names that were generated */
+    generatedEnums: string[];
+    /** List of table entity types that are referenced */
+    referencedTableTypes: string[];
+}
+export interface GenerateSchemaTypesOptions {
+    /** The TypeRegistry containing all GraphQL types */
+    typeRegistry: TypeRegistry;
+    /** Type names that already exist in types.ts (table entity types) */
+    tableTypeNames: Set<string>;
+}
+export interface PayloadTypesResult {
+    generatedTypes: Set<string>;
+    referencedTableTypes: Set<string>;
+}
+/**
+ * Generate comprehensive schema-types.ts file using ts-morph AST
+ *
+ * This generates all Input/Payload/Enum types from the TypeRegistry
+ * that are needed by custom mutation/query hooks.
+ */
+export declare function generateSchemaTypesFile(options: GenerateSchemaTypesOptions): GeneratedSchemaTypesFile;