@constructive-io/graphql-codegen 3.2.1 → 3.3.0

package/core/codegen/client.js

@@ -35,45 +35,31 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateClientFile = generateClientFile;
 /**
- * Client generator - generates client.ts with configure() and execute()
+ * Client generator - generates client.ts as ORM client wrapper
  *
- * Reads from template files in the templates/ directory for proper type checking.
+ * Uses template-copy pattern: reads hooks-client.ts from templates/
+ * and writes it to the output directory with a generated file header.
  */
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const utils_1 = require("./utils");
-/**
- * Find a template file path.
- * Templates are at ./templates/ relative to this file in both src/ and dist/.
- */
 function findTemplateFile(templateName) {
     const templatePath = path.join(__dirname, 'templates', templateName);
     if (fs.existsSync(templatePath)) {
         return templatePath;
     }
-    throw new Error(`Could not find template file: ${templateName}. ` +
-        `Searched in: ${templatePath}`);
+    throw new Error(`Could not find template file: ${templateName}. Searched in: ${templatePath}`);
 }
-/**
- * Read a template file and replace the header with generated file header
- */
 function readTemplateFile(templateName, description) {
     const templatePath = findTemplateFile(templateName);
     let content = fs.readFileSync(templatePath, 'utf-8');
-    // Replace the source file header comment with the generated file header
-    // Match the header pattern used in template files
     const headerPattern = /\/\*\*[\s\S]*?\* NOTE: This file is read at codegen time and written to output\.[\s\S]*?\*\/\n*/;
     content = content.replace(headerPattern, (0, utils_1.getGeneratedFileHeader)(description) + '\n');
     return content;
 }
 /**
- * Generate client.ts content
- * @param options - Generation options
+ * Generate client.ts content - ORM client wrapper with configure/getClient
  */
-function generateClientFile(options = {}) {
-    const { browserCompatible = true } = options;
-    const templateName = browserCompatible
-        ? 'client.browser.ts'
-        : 'client.node.ts';
-    return readTemplateFile(templateName, 'GraphQL client configuration and execution');
+function generateClientFile() {
+    return readTemplateFile('hooks-client.ts', 'ORM client wrapper for React Query hooks');
 }

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

@@ -1,15 +1,3 @@
-/**
- * Custom mutation hook generators for non-table operations
- *
- * Generates hooks for operations discovered via schema introspection
- * that are NOT table CRUD operations (e.g., login, register, etc.)
- *
- * Output structure:
- * mutations/
- *   useLoginMutation.ts
- *   useRegisterMutation.ts
- *   ...
- */
 import type { CleanOperation, TypeRegistry } from '../../types/schema';
 export interface GeneratedCustomMutationFile {
     fileName: string;
@@ -19,7 +7,6 @@ export interface GeneratedCustomMutationFile {
 export interface GenerateCustomMutationHookOptions {
     operation: CleanOperation;
     typeRegistry: TypeRegistry;
-    maxDepth?: number;
     skipQueryField?: boolean;
     reactQueryEnabled?: boolean;
     tableTypeNames?: Set<string>;
@@ -29,7 +16,6 @@ export declare function generateCustomMutationHook(options: GenerateCustomMutati
 export interface GenerateAllCustomMutationHooksOptions {
     operations: CleanOperation[];
     typeRegistry: TypeRegistry;
-    maxDepth?: number;
     skipQueryField?: boolean;
     reactQueryEnabled?: boolean;
     tableTypeNames?: Set<string>;

package/core/codegen/custom-mutations.js

@@ -35,19 +35,26 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateCustomMutationHook = generateCustomMutationHook;
 exports.generateAllCustomMutationHooks = generateAllCustomMutationHooks;
+/**
+ * Custom mutation hook generators for non-table operations (Babel AST-based)
+ *
+ * Generates hooks for operations discovered via schema introspection
+ * that are NOT table CRUD operations (e.g., login, register, etc.)
+ *
+ * Delegates to ORM custom mutation operations:
+ *   getClient().mutation.operationName(args, { select }).unwrap()
+ *
+ * Output structure:
+ * mutations/
+ *   useLoginMutation.ts
+ *   useRegisterMutation.ts
+ *   ...
+ */
 const t = __importStar(require("@babel/types"));
-const babel_ast_1 = require("./babel-ast");
-const schema_gql_ast_1 = require("./schema-gql-ast");
+const hooks_ast_1 = require("./hooks-ast");
+const select_helpers_1 = require("./select-helpers");
 const type_resolver_1 = require("./type-resolver");
 const utils_1 = require("./utils");
-function generateVariablesProperties(args, tracker) {
-    return args.map((arg) => ({
-        name: arg.name,
-        type: (0, type_resolver_1.typeRefToTsType)(arg.type, tracker),
-        optional: !(0, type_resolver_1.isTypeRequired)(arg.type),
-        docs: arg.description ? [arg.description] : undefined,
-    }));
-}
 function generateCustomMutationHook(options) {
     const { operation, reactQueryEnabled = true } = options;
     if (!reactQueryEnabled) {
@@ -63,95 +70,140 @@ function generateCustomMutationHook(options) {
     }
 }
 function generateCustomMutationHookInternal(options) {
-    const { operation, typeRegistry, maxDepth = 2, skipQueryField = true, tableTypeNames, useCentralizedKeys = true, } = options;
+    const { operation, typeRegistry, tableTypeNames, useCentralizedKeys = true, } = options;
     const hookName = (0, type_resolver_1.getOperationHookName)(operation.name, 'mutation');
     const fileName = (0, type_resolver_1.getOperationFileName)(operation.name, 'mutation');
-    const variablesTypeName = (0, type_resolver_1.getOperationVariablesTypeName)(operation.name, 'mutation');
-    const resultTypeName = (0, type_resolver_1.getOperationResultTypeName)(operation.name, 'mutation');
-    const documentConstName = (0, type_resolver_1.getDocumentConstName)(operation.name, 'mutation');
+    const varTypeName = `${(0, utils_1.ucFirst)(operation.name)}Variables`;
     const tracker = (0, type_resolver_1.createTypeTracker)({ tableTypeNames });
-    const mutationDocument = (0, schema_gql_ast_1.buildCustomMutationString)({
-        operation,
-        typeRegistry,
-        maxDepth,
-        skipQueryField,
-    });
+    const hasArgs = operation.args.length > 0;
+    (0, type_resolver_1.typeRefToTsType)(operation.returnType, tracker);
+    for (const arg of operation.args) {
+        (0, type_resolver_1.typeRefToTsType)(arg.type, tracker);
+    }
+    const selectTypeName = (0, select_helpers_1.getSelectTypeName)(operation.returnType);
+    const payloadTypeName = (0, type_resolver_1.getTypeBaseName)(operation.returnType);
+    const hasSelect = !!selectTypeName && !!payloadTypeName;
     const statements = [];
-    const variablesProps = operation.args.length > 0
-        ? generateVariablesProperties(operation.args, tracker)
-        : [];
-    const resultType = (0, type_resolver_1.typeRefToTsType)(operation.returnType, tracker);
-    const schemaTypes = tracker.getImportableTypes();
-    const tableTypes = tracker.getTableTypes();
-    const reactQueryImport = t.importDeclaration([t.importSpecifier(t.identifier('useMutation'), t.identifier('useMutation'))], t.stringLiteral('@tanstack/react-query'));
-    statements.push(reactQueryImport);
-    const reactQueryTypeImport = t.importDeclaration([t.importSpecifier(t.identifier('UseMutationOptions'), t.identifier('UseMutationOptions'))], t.stringLiteral('@tanstack/react-query'));
-    reactQueryTypeImport.importKind = 'type';
-    statements.push(reactQueryTypeImport);
-    const clientImport = t.importDeclaration([t.importSpecifier(t.identifier('execute'), t.identifier('execute'))], t.stringLiteral('../client'));
-    statements.push(clientImport);
-    if (tableTypes.length > 0) {
-        const typesImport = t.importDeclaration(tableTypes.map((tt) => t.importSpecifier(t.identifier(tt), t.identifier(tt))), t.stringLiteral('../types'));
-        typesImport.importKind = 'type';
-        statements.push(typesImport);
+    // Imports
+    statements.push((0, hooks_ast_1.createImportDeclaration)('@tanstack/react-query', ['useMutation']));
+    statements.push((0, hooks_ast_1.createImportDeclaration)('@tanstack/react-query', ['UseMutationOptions', 'UseMutationResult'], true));
+    statements.push((0, hooks_ast_1.createImportDeclaration)('../client', ['getClient']));
+    statements.push((0, hooks_ast_1.createImportDeclaration)('../selection', ['buildSelectionArgs']));
+    statements.push((0, hooks_ast_1.createImportDeclaration)('../selection', ['SelectionConfig'], true));
+    if (useCentralizedKeys) {
+        statements.push((0, hooks_ast_1.createImportDeclaration)('../mutation-keys', ['customMutationKeys']));
     }
-    if (schemaTypes.length > 0) {
-        const schemaTypesImport = t.importDeclaration(schemaTypes.map((st) => t.importSpecifier(t.identifier(st), t.identifier(st))), t.stringLiteral('../schema-types'));
-        schemaTypesImport.importKind = 'type';
-        statements.push(schemaTypesImport);
+    if (hasArgs) {
+        statements.push((0, hooks_ast_1.createImportDeclaration)('../../orm/mutation', [varTypeName], true));
     }
-    if (useCentralizedKeys) {
-        const mutationKeyImport = t.importDeclaration([t.importSpecifier(t.identifier('customMutationKeys'), t.identifier('customMutationKeys'))], t.stringLiteral('../mutation-keys'));
-        statements.push(mutationKeyImport);
+    const inputTypeImports = [];
+    if (hasSelect) {
+        inputTypeImports.push(selectTypeName);
+        inputTypeImports.push(payloadTypeName);
     }
-    const mutationDocConst = t.variableDeclaration('const', [
-        t.variableDeclarator(t.identifier(documentConstName), t.templateLiteral([t.templateElement({ raw: '\n' + mutationDocument, cooked: '\n' + mutationDocument }, true)], [])),
-    ]);
-    const mutationDocExport = t.exportNamedDeclaration(mutationDocConst);
-    (0, babel_ast_1.addJSDocComment)(mutationDocExport, ['GraphQL mutation document']);
-    statements.push(mutationDocExport);
-    if (operation.args.length > 0) {
-        const variablesInterfaceProps = variablesProps.map((vp) => {
-            const prop = t.tsPropertySignature(t.identifier(vp.name), t.tsTypeAnnotation(t.tsTypeReference(t.identifier(vp.type))));
-            prop.optional = vp.optional;
-            return prop;
-        });
-        const variablesInterface = t.tsInterfaceDeclaration(t.identifier(variablesTypeName), null, null, t.tsInterfaceBody(variablesInterfaceProps));
-        statements.push(t.exportNamedDeclaration(variablesInterface));
+    else {
+        for (const refType of tracker.referencedTypes) {
+            if (!inputTypeImports.includes(refType)) {
+                inputTypeImports.push(refType);
+            }
+        }
     }
-    const resultInterfaceBody = t.tsInterfaceBody([
-        t.tsPropertySignature(t.identifier(operation.name), t.tsTypeAnnotation(t.tsTypeReference(t.identifier(resultType)))),
-    ]);
-    const resultInterface = t.tsInterfaceDeclaration(t.identifier(resultTypeName), null, null, resultInterfaceBody);
-    statements.push(t.exportNamedDeclaration(resultInterface));
-    const hasArgs = operation.args.length > 0;
-    const hookBodyStatements = [];
-    const mutationOptions = [];
-    if (useCentralizedKeys) {
-        mutationOptions.push(t.objectProperty(t.identifier('mutationKey'), t.callExpression(t.memberExpression(t.identifier('customMutationKeys'), t.identifier(operation.name)), [])));
+    if (inputTypeImports.length > 0) {
+        statements.push((0, hooks_ast_1.createImportDeclaration)('../../orm/input-types', inputTypeImports, true));
     }
+    if (hasSelect) {
+        statements.push((0, hooks_ast_1.createImportDeclaration)('../../orm/select-types', ['InferSelectResult', 'StrictSelect'], true));
+    }
+    // Re-exports
     if (hasArgs) {
-        mutationOptions.push(t.objectProperty(t.identifier('mutationFn'), t.arrowFunctionExpression([(0, babel_ast_1.typedParam)('variables', t.tsTypeReference(t.identifier(variablesTypeName)))], (0, babel_ast_1.createTypedCallExpression)(t.identifier('execute'), [t.identifier(documentConstName), t.identifier('variables')], [
-            t.tsTypeReference(t.identifier(resultTypeName)),
-            t.tsTypeReference(t.identifier(variablesTypeName)),
-        ]))));
+        statements.push((0, hooks_ast_1.createTypeReExport)([varTypeName], '../../orm/mutation'));
+    }
+    if (hasSelect) {
+        statements.push((0, hooks_ast_1.createTypeReExport)([selectTypeName], '../../orm/input-types'));
+    }
+    // Hook
+    if (hasSelect) {
+        const mutationVarType = hasArgs
+            ? (0, hooks_ast_1.typeRef)(varTypeName)
+            : t.tsVoidKeyword();
+        const selectedResultType = (sel) => (0, hooks_ast_1.customSelectResultTypeLiteral)(operation.name, operation.returnType, payloadTypeName, sel);
+        // Overload 1: with selection.fields
+        const o1ParamType = t.tsIntersectionType([
+            t.tsTypeLiteral([
+                t.tsPropertySignature(t.identifier('selection'), t.tsTypeAnnotation(t.tsParenthesizedType(t.tsIntersectionType([
+                    t.tsTypeLiteral([
+                        t.tsPropertySignature(t.identifier('fields'), t.tsTypeAnnotation((0, hooks_ast_1.sRef)())),
+                    ]),
+                    (0, hooks_ast_1.typeRef)('StrictSelect', [(0, hooks_ast_1.sRef)(), (0, hooks_ast_1.typeRef)(selectTypeName)]),
+                ])))),
+            ]),
+            (0, hooks_ast_1.useMutationOptionsType)(selectedResultType((0, hooks_ast_1.sRef)()), mutationVarType),
+        ]);
+        statements.push((0, hooks_ast_1.exportDeclareFunction)(hookName, (0, hooks_ast_1.createSTypeParam)(selectTypeName), [(0, hooks_ast_1.createFunctionParam)('params', o1ParamType)], (0, hooks_ast_1.useMutationResultType)(selectedResultType((0, hooks_ast_1.sRef)()), mutationVarType)));
+        // Implementation
+        const implSelProp = t.tsPropertySignature(t.identifier('selection'), t.tsTypeAnnotation((0, hooks_ast_1.selectionConfigType)((0, hooks_ast_1.typeRef)(selectTypeName))));
+        const implParamType = t.tsIntersectionType([
+            t.tsTypeLiteral([implSelProp]),
+            (0, hooks_ast_1.omitType)((0, hooks_ast_1.typeRef)('UseMutationOptions', [
+                t.tsAnyKeyword(),
+                (0, hooks_ast_1.typeRef)('Error'),
+                mutationVarType,
+            ]), ['mutationFn']),
+        ]);
+        const body = [];
+        body.push((0, hooks_ast_1.buildSelectionArgsCall)(selectTypeName));
+        body.push((0, hooks_ast_1.destructureParamsWithSelection)('mutationOptions'));
+        body.push((0, hooks_ast_1.voidStatement)('_selection'));
+        const mutationKeyExpr = useCentralizedKeys
+            ? (0, hooks_ast_1.callExpr)(t.memberExpression(t.identifier('customMutationKeys'), t.identifier(operation.name)), [])
+            : undefined;
+        const selectArgExpr = t.objectExpression([
+            (0, hooks_ast_1.objectProp)('select', t.memberExpression(t.identifier('args'), t.identifier('select'))),
+        ]);
+        let mutationFnExpr;
+        if (hasArgs) {
+            const variablesParam = (0, hooks_ast_1.createFunctionParam)('variables', (0, hooks_ast_1.typeRef)(varTypeName));
+            mutationFnExpr = t.arrowFunctionExpression([variablesParam], (0, hooks_ast_1.getClientCustomCallUnwrap)('mutation', operation.name, [t.identifier('variables')], selectArgExpr));
+        }
+        else {
+            mutationFnExpr = t.arrowFunctionExpression([], (0, hooks_ast_1.getClientCustomCallUnwrap)('mutation', operation.name, [], selectArgExpr));
+        }
+        body.push((0, hooks_ast_1.returnUseMutation)(mutationFnExpr, [(0, hooks_ast_1.spreadObj)(t.identifier('mutationOptions'))], mutationKeyExpr));
+        statements.push((0, hooks_ast_1.exportFunction)(hookName, null, [(0, hooks_ast_1.createFunctionParam)('params', implParamType)], body));
     }
     else {
-        mutationOptions.push(t.objectProperty(t.identifier('mutationFn'), t.arrowFunctionExpression([], (0, babel_ast_1.createTypedCallExpression)(t.identifier('execute'), [t.identifier(documentConstName)], [t.tsTypeReference(t.identifier(resultTypeName))]))));
+        // Without select: simple hook (scalar return type)
+        const resultTypeStr = (0, type_resolver_1.typeRefToTsType)(operation.returnType, tracker);
+        const resultTypeLiteral = t.tsTypeLiteral([
+            t.tsPropertySignature(t.identifier(operation.name), t.tsTypeAnnotation((0, hooks_ast_1.typeRef)(resultTypeStr))),
+        ]);
+        const mutationVarType = hasArgs
+            ? (0, hooks_ast_1.typeRef)(varTypeName)
+            : t.tsVoidKeyword();
+        const optionsType = (0, hooks_ast_1.omitType)((0, hooks_ast_1.typeRef)('UseMutationOptions', [
+            resultTypeLiteral,
+            (0, hooks_ast_1.typeRef)('Error'),
+            mutationVarType,
+        ]), ['mutationFn']);
+        const body = [];
+        body.push((0, hooks_ast_1.constDecl)('mutationOptions', t.logicalExpression('??', t.identifier('params'), t.objectExpression([]))));
+        const mutationKeyExpr = useCentralizedKeys
+            ? (0, hooks_ast_1.callExpr)(t.memberExpression(t.identifier('customMutationKeys'), t.identifier(operation.name)), [])
+            : undefined;
+        let mutationFnExpr;
+        if (hasArgs) {
+            const variablesParam = (0, hooks_ast_1.createFunctionParam)('variables', (0, hooks_ast_1.typeRef)(varTypeName));
+            mutationFnExpr = t.arrowFunctionExpression([variablesParam], (0, hooks_ast_1.getClientCustomCallUnwrap)('mutation', operation.name, [
+                t.identifier('variables'),
+            ]));
+        }
+        else {
+            mutationFnExpr = t.arrowFunctionExpression([], (0, hooks_ast_1.getClientCustomCallUnwrap)('mutation', operation.name, []));
+        }
+        body.push((0, hooks_ast_1.returnUseMutation)(mutationFnExpr, [(0, hooks_ast_1.spreadObj)(t.identifier('mutationOptions'))], mutationKeyExpr));
+        statements.push((0, hooks_ast_1.exportFunction)(hookName, null, [(0, hooks_ast_1.createFunctionParam)('params', optionsType, true)], body));
     }
-    mutationOptions.push(t.spreadElement(t.identifier('options')));
-    hookBodyStatements.push(t.returnStatement(t.callExpression(t.identifier('useMutation'), [t.objectExpression(mutationOptions)])));
-    const optionsType = hasArgs
-        ? `Omit<UseMutationOptions<${resultTypeName}, Error, ${variablesTypeName}>, 'mutationFn'>`
-        : `Omit<UseMutationOptions<${resultTypeName}, Error, void>, 'mutationFn'>`;
-    const optionsParam = t.identifier('options');
-    optionsParam.optional = true;
-    optionsParam.typeAnnotation = t.tsTypeAnnotation(t.tsTypeReference(t.identifier(optionsType)));
-    const hookFunc = t.functionDeclaration(t.identifier(hookName), [optionsParam], t.blockStatement(hookBodyStatements));
-    const hookExport = t.exportNamedDeclaration(hookFunc);
-    statements.push(hookExport);
-    const code = (0, babel_ast_1.generateCode)(statements);
-    const content = (0, utils_1.getGeneratedFileHeader)(`Custom mutation hook for ${operation.name}`) + '\n\n' + code;
+    const content = (0, hooks_ast_1.generateHookFileCode)(`Custom mutation hook for ${operation.name}`, statements);
     return {
         fileName,
         content,
@@ -159,13 +211,12 @@ function generateCustomMutationHookInternal(options) {
     };
 }
 function generateAllCustomMutationHooks(options) {
-    const { operations, typeRegistry, maxDepth = 2, skipQueryField = true, reactQueryEnabled = true, tableTypeNames, useCentralizedKeys = true, } = options;
+    const { operations, typeRegistry, skipQueryField = true, reactQueryEnabled = true, tableTypeNames, useCentralizedKeys = true, } = options;
     return operations
         .filter((op) => op.kind === 'mutation')
         .map((operation) => generateCustomMutationHook({
         operation,
         typeRegistry,
-        maxDepth,
         skipQueryField,
         reactQueryEnabled,
         tableTypeNames,

package/core/codegen/custom-queries.d.ts

@@ -1,15 +1,3 @@
-/**
- * Custom query hook generators for non-table operations
- *
- * Generates hooks for operations discovered via schema introspection
- * that are NOT table CRUD operations (e.g., currentUser, nodeById, etc.)
- *
- * Output structure:
- * queries/
- *   useCurrentUserQuery.ts
- *   useNodeQuery.ts
- *   ...
- */
 import type { CleanOperation, TypeRegistry } from '../../types/schema';
 export interface GeneratedCustomQueryFile {
     fileName: string;
@@ -19,7 +7,6 @@ export interface GeneratedCustomQueryFile {
 export interface GenerateCustomQueryHookOptions {
     operation: CleanOperation;
     typeRegistry: TypeRegistry;
-    maxDepth?: number;
     skipQueryField?: boolean;
     reactQueryEnabled?: boolean;
     tableTypeNames?: Set<string>;
@@ -29,7 +16,6 @@ export declare function generateCustomQueryHook(options: GenerateCustomQueryHook
 export interface GenerateAllCustomQueryHooksOptions {
     operations: CleanOperation[];
     typeRegistry: TypeRegistry;
-    maxDepth?: number;
     skipQueryField?: boolean;
     reactQueryEnabled?: boolean;
     tableTypeNames?: Set<string>;