@constructive-io/graphql-codegen 2.23.3 → 2.24.1

package/esm/cli/codegen/mutation-keys.js

@@ -0,0 +1,211 @@
+import { getTableNames, getGeneratedFileHeader, lcFirst } from './utils';
+import * as t from '@babel/types';
+import { generateCode, addJSDocComment, asConst, constArray, typedParam, } from './babel-ast';
+/**
+ * Generate mutation keys declaration for a single table entity
+ */
+function generateEntityMutationKeysDeclaration(table, relationships) {
+    const { typeName, singularName } = getTableNames(table);
+    const entityKey = typeName.toLowerCase();
+    const keysName = `${lcFirst(typeName)}MutationKeys`;
+    const relationship = relationships[entityKey];
+    const properties = [];
+    // all property
+    const allProp = t.objectProperty(t.identifier('all'), constArray([t.stringLiteral('mutation'), t.stringLiteral(entityKey)]));
+    addJSDocComment(allProp, [`All ${singularName} mutation keys`]);
+    properties.push(allProp);
+    // create property
+    let createProp;
+    if (relationship) {
+        const fkParam = t.identifier(relationship.foreignKey);
+        fkParam.optional = true;
+        fkParam.typeAnnotation = t.tsTypeAnnotation(t.tsStringKeyword());
+        const arrowFn = t.arrowFunctionExpression([fkParam], t.conditionalExpression(t.identifier(relationship.foreignKey), constArray([
+            t.stringLiteral('mutation'),
+            t.stringLiteral(entityKey),
+            t.stringLiteral('create'),
+            t.objectExpression([
+                t.objectProperty(t.identifier(relationship.foreignKey), t.identifier(relationship.foreignKey), false, true)
+            ]),
+        ]), constArray([
+            t.stringLiteral('mutation'),
+            t.stringLiteral(entityKey),
+            t.stringLiteral('create'),
+        ])));
+        createProp = t.objectProperty(t.identifier('create'), arrowFn);
+    }
+    else {
+        const arrowFn = t.arrowFunctionExpression([], constArray([
+            t.stringLiteral('mutation'),
+            t.stringLiteral(entityKey),
+            t.stringLiteral('create'),
+        ]));
+        createProp = t.objectProperty(t.identifier('create'), arrowFn);
+    }
+    addJSDocComment(createProp, [`Create ${singularName} mutation key`]);
+    properties.push(createProp);
+    // update property
+    const updateArrowFn = t.arrowFunctionExpression([typedParam('id', t.tsUnionType([t.tsStringKeyword(), t.tsNumberKeyword()]))], constArray([
+        t.stringLiteral('mutation'),
+        t.stringLiteral(entityKey),
+        t.stringLiteral('update'),
+        t.identifier('id'),
+    ]));
+    const updateProp = t.objectProperty(t.identifier('update'), updateArrowFn);
+    addJSDocComment(updateProp, [`Update ${singularName} mutation key`]);
+    properties.push(updateProp);
+    // delete property
+    const deleteArrowFn = t.arrowFunctionExpression([typedParam('id', t.tsUnionType([t.tsStringKeyword(), t.tsNumberKeyword()]))], constArray([
+        t.stringLiteral('mutation'),
+        t.stringLiteral(entityKey),
+        t.stringLiteral('delete'),
+        t.identifier('id'),
+    ]));
+    const deleteProp = t.objectProperty(t.identifier('delete'), deleteArrowFn);
+    addJSDocComment(deleteProp, [`Delete ${singularName} mutation key`]);
+    properties.push(deleteProp);
+    return t.exportNamedDeclaration(t.variableDeclaration('const', [
+        t.variableDeclarator(t.identifier(keysName), asConst(t.objectExpression(properties)))
+    ]));
+}
+/**
+ * Generate custom mutation keys declaration
+ */
+function generateCustomMutationKeysDeclaration(operations) {
+    if (operations.length === 0)
+        return null;
+    const properties = [];
+    for (const op of operations) {
+        const hasArgs = op.args.length > 0;
+        let prop;
+        if (hasArgs) {
+            const identifierParam = t.identifier('identifier');
+            identifierParam.optional = true;
+            identifierParam.typeAnnotation = t.tsTypeAnnotation(t.tsStringKeyword());
+            const arrowFn = t.arrowFunctionExpression([identifierParam], t.conditionalExpression(t.identifier('identifier'), constArray([
+                t.stringLiteral('mutation'),
+                t.stringLiteral(op.name),
+                t.identifier('identifier'),
+            ]), constArray([t.stringLiteral('mutation'), t.stringLiteral(op.name)])));
+            prop = t.objectProperty(t.identifier(op.name), arrowFn);
+        }
+        else {
+            const arrowFn = t.arrowFunctionExpression([], constArray([t.stringLiteral('mutation'), t.stringLiteral(op.name)]));
+            prop = t.objectProperty(t.identifier(op.name), arrowFn);
+        }
+        addJSDocComment(prop, [`Mutation key for ${op.name}`]);
+        properties.push(prop);
+    }
+    return t.exportNamedDeclaration(t.variableDeclaration('const', [
+        t.variableDeclarator(t.identifier('customMutationKeys'), asConst(t.objectExpression(properties)))
+    ]));
+}
+/**
+ * Generate the unified mutation keys store declaration
+ */
+function generateUnifiedMutationStoreDeclaration(tables, hasCustomMutations) {
+    const properties = [];
+    for (const table of tables) {
+        const { typeName } = getTableNames(table);
+        const keysName = `${lcFirst(typeName)}MutationKeys`;
+        properties.push(t.objectProperty(t.identifier(lcFirst(typeName)), t.identifier(keysName)));
+    }
+    if (hasCustomMutations) {
+        properties.push(t.objectProperty(t.identifier('custom'), t.identifier('customMutationKeys')));
+    }
+    const decl = t.exportNamedDeclaration(t.variableDeclaration('const', [
+        t.variableDeclarator(t.identifier('mutationKeys'), asConst(t.objectExpression(properties)))
+    ]));
+    addJSDocComment(decl, [
+        'Unified mutation key store',
+        '',
+        'Use this for tracking in-flight mutations with useIsMutating.',
+        '',
+        '@example',
+        '```ts',
+        "import { useIsMutating } from '@tanstack/react-query';",
+        "import { mutationKeys } from './generated';",
+        '',
+        '// Check if any user mutations are in progress',
+        'const isMutatingUser = useIsMutating({ mutationKey: mutationKeys.user.all });',
+        '',
+        '// Check if a specific user is being updated',
+        'const isUpdating = useIsMutating({ mutationKey: mutationKeys.user.update(userId) });',
+        '```',
+    ]);
+    return decl;
+}
+/**
+ * Generate the complete mutation-keys.ts file
+ */
+export function generateMutationKeysFile(options) {
+    const { tables, customMutations, config } = options;
+    const { relationships } = config;
+    const statements = [];
+    // Generate entity mutation keys
+    for (const table of tables) {
+        statements.push(generateEntityMutationKeysDeclaration(table, relationships));
+    }
+    // Generate custom mutation keys
+    const mutationOperations = customMutations.filter((op) => op.kind === 'mutation');
+    const customKeysDecl = generateCustomMutationKeysDeclaration(mutationOperations);
+    if (customKeysDecl) {
+        statements.push(customKeysDecl);
+    }
+    // Generate unified store
+    statements.push(generateUnifiedMutationStoreDeclaration(tables, mutationOperations.length > 0));
+    // Generate code from AST
+    const code = generateCode(statements);
+    // Build final content with header and section comments
+    const header = getGeneratedFileHeader('Centralized mutation key factory');
+    const description = `// ============================================================================
+// Mutation keys for tracking in-flight mutations
+//
+// Benefits:
+// - Track mutation state with useIsMutating
+// - Implement optimistic updates with proper rollback
+// - Deduplicate identical mutations
+// - Coordinate related mutations
+// ============================================================================`;
+    let content = `${header}
+
+${description}
+
+// ============================================================================
+// Entity Mutation Keys
+// ============================================================================
+
+`;
+    // Insert section comments into the generated code
+    const codeLines = code.split('\n');
+    let addedCustomSection = false;
+    let addedUnifiedSection = false;
+    for (let i = 0; i < codeLines.length; i++) {
+        const line = codeLines[i];
+        // Detect custom mutation keys section
+        if (!addedCustomSection && line.startsWith('export const customMutationKeys')) {
+            content += `
+// ============================================================================
+// Custom Mutation Keys
+// ============================================================================
+
+`;
+            addedCustomSection = true;
+        }
+        // Detect unified store section
+        if (!addedUnifiedSection && line.includes('* Unified mutation key store')) {
+            content += `
+// ============================================================================
+// Unified Mutation Key Store
+// ============================================================================
+
+`;
+            addedUnifiedSection = true;
+        }
+        content += line + '\n';
+    }
+    return {
+        fileName: 'mutation-keys.ts',
+        content,
+    };
+}

package/esm/cli/codegen/mutations.d.ts

@@ -1,5 +1,5 @@
 /**
- * Mutation hook generators using AST-based code generation
+ * Mutation hook generators using Babel AST-based code generation
  *
  * Output structure:
  * mutations/
@@ -13,28 +13,14 @@ export interface GeneratedMutationFile {
     content: string;
 }
 export interface MutationGeneratorOptions {
-    /** Whether to generate React Query hooks (default: true for backwards compatibility) */
     reactQueryEnabled?: boolean;
-    /** Enum type names that are available from schema-types.ts */
     enumsFromSchemaTypes?: string[];
+    useCentralizedKeys?: boolean;
+    hasRelationships?: boolean;
+    /** All table type names for determining which types to import from types.ts vs schema-types.ts */
+    tableTypeNames?: Set<string>;
 }
-/**
- * Generate create mutation hook file content using AST
- * When reactQueryEnabled is false, returns null since mutations require React Query
- */
 export declare function generateCreateMutationHook(table: CleanTable, options?: MutationGeneratorOptions): GeneratedMutationFile | null;
-/**
- * Generate update mutation hook file content using AST
- * When reactQueryEnabled is false, returns null since mutations require React Query
- */
 export declare function generateUpdateMutationHook(table: CleanTable, options?: MutationGeneratorOptions): GeneratedMutationFile | null;
-/**
- * Generate delete mutation hook file content using AST
- * When reactQueryEnabled is false, returns null since mutations require React Query
- */
 export declare function generateDeleteMutationHook(table: CleanTable, options?: MutationGeneratorOptions): GeneratedMutationFile | null;
-/**
- * Generate all mutation hook files for all tables
- * When reactQueryEnabled is false, returns empty array since mutations require React Query
- */
 export declare function generateAllMutationHooks(tables: CleanTable[], options?: MutationGeneratorOptions): GeneratedMutationFile[];