@constructive-io/graphql-codegen 2.19.0 → 2.20.0

package/esm/cli/codegen/barrel.js

@@ -0,0 +1,156 @@
+import { createFileHeader } from './ts-ast';
+import { getListQueryHookName, getSingleQueryHookName, getCreateMutationHookName, getUpdateMutationHookName, getDeleteMutationHookName, } from './utils';
+import { getOperationHookName } from './type-resolver';
+/**
+ * Generate the queries/index.ts barrel file
+ */
+export function generateQueriesBarrel(tables) {
+    const lines = [
+        createFileHeader('Query hooks barrel export'),
+        '',
+    ];
+    // Export all query hooks
+    for (const table of tables) {
+        const listHookName = getListQueryHookName(table);
+        const singleHookName = getSingleQueryHookName(table);
+        lines.push(`export * from './${listHookName}';`);
+        lines.push(`export * from './${singleHookName}';`);
+    }
+    return lines.join('\n') + '\n';
+}
+/**
+ * Generate the mutations/index.ts barrel file
+ */
+export function generateMutationsBarrel(tables) {
+    const lines = [
+        createFileHeader('Mutation hooks barrel export'),
+        '',
+    ];
+    // Export all mutation hooks
+    for (const table of tables) {
+        const createHookName = getCreateMutationHookName(table);
+        const updateHookName = getUpdateMutationHookName(table);
+        const deleteHookName = getDeleteMutationHookName(table);
+        lines.push(`export * from './${createHookName}';`);
+        // Only add update/delete if they exist
+        if (table.query?.update !== null) {
+            lines.push(`export * from './${updateHookName}';`);
+        }
+        if (table.query?.delete !== null) {
+            lines.push(`export * from './${deleteHookName}';`);
+        }
+    }
+    return lines.join('\n') + '\n';
+}
+/**
+ * Generate the main index.ts barrel file
+ */
+export function generateMainBarrel(tables) {
+    const tableNames = tables.map((t) => t.name).join(', ');
+    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';
+
+// Query hooks
+export * from './queries';
+
+// Mutation hooks
+export * from './mutations';
+`;
+}
+// ============================================================================
+// Custom operation barrels (includes both table and custom hooks)
+// ============================================================================
+/**
+ * Generate queries barrel including custom query operations
+ */
+export function generateCustomQueriesBarrel(tables, customQueryNames) {
+    const lines = [
+        createFileHeader('Query hooks barrel export'),
+        '',
+        '// Table-based query hooks',
+    ];
+    // Export all table query hooks
+    for (const table of tables) {
+        const listHookName = getListQueryHookName(table);
+        const singleHookName = getSingleQueryHookName(table);
+        lines.push(`export * from './${listHookName}';`);
+        lines.push(`export * from './${singleHookName}';`);
+    }
+    // Add custom query hooks
+    if (customQueryNames.length > 0) {
+        lines.push('');
+        lines.push('// Custom query hooks');
+        for (const name of customQueryNames) {
+            const hookName = getOperationHookName(name, 'query');
+            lines.push(`export * from './${hookName}';`);
+        }
+    }
+    return lines.join('\n') + '\n';
+}
+/**
+ * Generate mutations barrel including custom mutation operations
+ */
+export function generateCustomMutationsBarrel(tables, customMutationNames) {
+    const lines = [
+        createFileHeader('Mutation hooks barrel export'),
+        '',
+        '// Table-based mutation hooks',
+    ];
+    // Export all table mutation hooks
+    for (const table of tables) {
+        const createHookName = getCreateMutationHookName(table);
+        const updateHookName = getUpdateMutationHookName(table);
+        const deleteHookName = getDeleteMutationHookName(table);
+        lines.push(`export * from './${createHookName}';`);
+        // Only add update/delete if they exist
+        if (table.query?.update !== null) {
+            lines.push(`export * from './${updateHookName}';`);
+        }
+        if (table.query?.delete !== null) {
+            lines.push(`export * from './${deleteHookName}';`);
+        }
+    }
+    // Add custom mutation hooks
+    if (customMutationNames.length > 0) {
+        lines.push('');
+        lines.push('// Custom mutation hooks');
+        for (const name of customMutationNames) {
+            const hookName = getOperationHookName(name, 'mutation');
+            lines.push(`export * from './${hookName}';`);
+        }
+    }
+    return lines.join('\n') + '\n';
+}

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

@@ -0,0 +1,4 @@
+/**
+ * Generate client.ts content
+ */
+export declare function generateClientFile(): string;

package/esm/cli/codegen/client.js

@@ -0,0 +1,167 @@
+/**
+ * Client generator - generates client.ts with configure() and execute()
+ */
+import { getGeneratedFileHeader } from './utils';
+/**
+ * Generate client.ts content
+ */
+export function generateClientFile() {
+    return `${getGeneratedFileHeader('GraphQL client configuration and execution')}
+
+// ============================================================================
+// Configuration
+// ============================================================================
+
+export interface GraphQLClientConfig {
+  /** GraphQL endpoint URL */
+  endpoint: string;
+  /** Default headers to include in all requests */
+  headers?: Record<string, string>;
+}
+
+let globalConfig: GraphQLClientConfig | null = null;
+
+/**
+ * Configure the GraphQL client
+ *
+ * @example
+ * \`\`\`ts
+ * import { configure } from './generated';
+ *
+ * configure({
+ *   endpoint: 'https://api.example.com/graphql',
+ *   headers: {
+ *     Authorization: 'Bearer <token>',
+ *   },
+ * });
+ * \`\`\`
+ */
+export function configure(config: GraphQLClientConfig): void {
+  globalConfig = config;
+}
+
+/**
+ * Get the current configuration
+ * @throws Error if not configured
+ */
+export function getConfig(): GraphQLClientConfig {
+  if (!globalConfig) {
+    throw new Error(
+      'GraphQL client not configured. Call configure() before making requests.'
+    );
+  }
+  return globalConfig;
+}
+
+// ============================================================================
+// Error handling
+// ============================================================================
+
+export interface GraphQLError {
+  message: string;
+  locations?: Array<{ line: number; column: number }>;
+  path?: Array<string | number>;
+  extensions?: Record<string, unknown>;
+}
+
+export class GraphQLClientError extends Error {
+  constructor(
+    message: string,
+    public errors: GraphQLError[],
+    public response?: Response
+  ) {
+    super(message);
+    this.name = 'GraphQLClientError';
+  }
+}
+
+// ============================================================================
+// Execution
+// ============================================================================
+
+export interface ExecuteOptions {
+  /** Override headers for this request */
+  headers?: Record<string, string>;
+  /** AbortSignal for request cancellation */
+  signal?: AbortSignal;
+}
+
+/**
+ * Execute a GraphQL operation
+ *
+ * @example
+ * \`\`\`ts
+ * const result = await execute<CarsQueryResult, CarsQueryVariables>(
+ *   carsQueryDocument,
+ *   { first: 10 }
+ * );
+ * \`\`\`
+ */
+export async function execute<TData = unknown, TVariables = Record<string, unknown>>(
+  document: string,
+  variables?: TVariables,
+  options?: ExecuteOptions
+): Promise<TData> {
+  const config = getConfig();
+
+  const response = await fetch(config.endpoint, {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json',
+      ...config.headers,
+      ...options?.headers,
+    },
+    body: JSON.stringify({
+      query: document,
+      variables,
+    }),
+    signal: options?.signal,
+  });
+
+  const json = await response.json();
+
+  if (json.errors && json.errors.length > 0) {
+    throw new GraphQLClientError(
+      json.errors[0].message || 'GraphQL request failed',
+      json.errors,
+      response
+    );
+  }
+
+  return json.data as TData;
+}
+
+/**
+ * Execute a GraphQL operation with full response (data + errors)
+ * Useful when you want to handle partial data with errors
+ */
+export async function executeWithErrors<TData = unknown, TVariables = Record<string, unknown>>(
+  document: string,
+  variables?: TVariables,
+  options?: ExecuteOptions
+): Promise<{ data: TData | null; errors: GraphQLError[] | null }> {
+  const config = getConfig();
+
+  const response = await fetch(config.endpoint, {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json',
+      ...config.headers,
+      ...options?.headers,
+    },
+    body: JSON.stringify({
+      query: document,
+      variables,
+    }),
+    signal: options?.signal,
+  });
+
+  const json = await response.json();
+
+  return {
+    data: json.data ?? null,
+    errors: json.errors ?? null,
+  };
+}
+`;
+}

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

@@ -0,0 +1,38 @@
+/**
+ * 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;
+    content: string;
+    operationName: string;
+}
+export interface GenerateCustomMutationHookOptions {
+    operation: CleanOperation;
+    typeRegistry: TypeRegistry;
+    maxDepth?: number;
+    skipQueryField?: boolean;
+}
+/**
+ * Generate a custom mutation hook file
+ */
+export declare function generateCustomMutationHook(options: GenerateCustomMutationHookOptions): GeneratedCustomMutationFile;
+export interface GenerateAllCustomMutationHooksOptions {
+    operations: CleanOperation[];
+    typeRegistry: TypeRegistry;
+    maxDepth?: number;
+    skipQueryField?: boolean;
+}
+/**
+ * Generate all custom mutation hook files
+ */
+export declare function generateAllCustomMutationHooks(options: GenerateAllCustomMutationHooksOptions): GeneratedCustomMutationFile[];

package/esm/cli/codegen/custom-mutations.js

@@ -0,0 +1,145 @@
+import { createProject, createSourceFile, getFormattedOutput, createFileHeader, createImport, createInterface, createConst, } from './ts-ast';
+import { buildCustomMutationString } from './schema-gql-ast';
+import { typeRefToTsType, isTypeRequired, getOperationHookName, getOperationFileName, getOperationVariablesTypeName, getOperationResultTypeName, getDocumentConstName, } from './type-resolver';
+/**
+ * Generate a custom mutation hook file
+ */
+export function generateCustomMutationHook(options) {
+    const { operation } = options;
+    try {
+        return generateCustomMutationHookInternal(options);
+    }
+    catch (err) {
+        console.error(`Error generating hook for mutation: ${operation.name}`);
+        console.error(`  Args: ${operation.args.length}, Return type: ${operation.returnType.kind}/${operation.returnType.name}`);
+        throw err;
+    }
+}
+function generateCustomMutationHookInternal(options) {
+    const { operation, typeRegistry, maxDepth = 2, skipQueryField = true } = options;
+    const project = createProject();
+    const hookName = getOperationHookName(operation.name, 'mutation');
+    const fileName = getOperationFileName(operation.name, 'mutation');
+    const variablesTypeName = getOperationVariablesTypeName(operation.name, 'mutation');
+    const resultTypeName = getOperationResultTypeName(operation.name, 'mutation');
+    const documentConstName = getDocumentConstName(operation.name, 'mutation');
+    // Generate GraphQL document
+    const mutationDocument = buildCustomMutationString({
+        operation,
+        typeRegistry,
+        maxDepth,
+        skipQueryField,
+    });
+    const sourceFile = createSourceFile(project, fileName);
+    // Add file header
+    sourceFile.insertText(0, createFileHeader(`Custom mutation hook for ${operation.name}`) + '\n\n');
+    // Add imports
+    sourceFile.addImportDeclarations([
+        createImport({
+            moduleSpecifier: '@tanstack/react-query',
+            namedImports: ['useMutation'],
+            typeOnlyNamedImports: ['UseMutationOptions'],
+        }),
+        createImport({
+            moduleSpecifier: '../client',
+            namedImports: ['execute'],
+        }),
+    ]);
+    // Add mutation document constant
+    sourceFile.addVariableStatement(createConst(documentConstName, '`\n' + mutationDocument + '`', {
+        docs: ['GraphQL mutation document'],
+    }));
+    // Generate variables interface if there are arguments
+    if (operation.args.length > 0) {
+        const variablesProps = generateVariablesProperties(operation.args);
+        sourceFile.addInterface(createInterface(variablesTypeName, variablesProps));
+    }
+    // Generate result interface
+    const resultType = typeRefToTsType(operation.returnType);
+    const resultProps = [
+        { name: operation.name, type: resultType },
+    ];
+    sourceFile.addInterface(createInterface(resultTypeName, resultProps));
+    // Generate hook function
+    const hookParams = generateHookParameters(operation, variablesTypeName, resultTypeName);
+    const hookBody = generateHookBody(operation, documentConstName, variablesTypeName, resultTypeName);
+    // Note: docs can cause ts-morph issues with certain content, so we skip them
+    sourceFile.addFunction({
+        name: hookName,
+        isExported: true,
+        parameters: hookParams,
+        statements: hookBody,
+    });
+    return {
+        fileName,
+        content: getFormattedOutput(sourceFile),
+        operationName: operation.name,
+    };
+}
+// ============================================================================
+// Helper functions
+// ============================================================================
+/**
+ * Generate interface properties from CleanArguments
+ */
+function generateVariablesProperties(args) {
+    return args.map((arg) => ({
+        name: arg.name,
+        type: typeRefToTsType(arg.type),
+        optional: !isTypeRequired(arg.type),
+        docs: arg.description ? [arg.description] : undefined,
+    }));
+}
+/**
+ * Generate hook function parameters
+ */
+function generateHookParameters(operation, variablesTypeName, resultTypeName) {
+    const hasArgs = operation.args.length > 0;
+    // Mutation hooks use UseMutationOptions with variables as the second type param
+    const optionsType = hasArgs
+        ? `Omit<UseMutationOptions<${resultTypeName}, Error, ${variablesTypeName}>, 'mutationFn'>`
+        : `Omit<UseMutationOptions<${resultTypeName}, Error, void>, 'mutationFn'>`;
+    return [
+        {
+            name: 'options',
+            type: optionsType,
+            hasQuestionToken: true,
+        },
+    ];
+}
+/**
+ * Generate hook function body
+ */
+function generateHookBody(operation, documentConstName, variablesTypeName, resultTypeName) {
+    const hasArgs = operation.args.length > 0;
+    if (hasArgs) {
+        return `return useMutation({
+    mutationFn: (variables: ${variablesTypeName}) =>
+      execute<${resultTypeName}, ${variablesTypeName}>(
+        ${documentConstName},
+        variables
+      ),
+    ...options,
+  });`;
+    }
+    else {
+        return `return useMutation({
+    mutationFn: () => execute<${resultTypeName}>(${documentConstName}),
+    ...options,
+  });`;
+    }
+}
+/**
+ * Generate all custom mutation hook files
+ */
+export function generateAllCustomMutationHooks(options) {
+    const { operations, typeRegistry, maxDepth = 2, skipQueryField = true } = options;
+    return operations
+        .filter((op) => op.kind === 'mutation')
+        .map((operation) => generateCustomMutationHook({
+        operation,
+        typeRegistry,
+        maxDepth,
+        skipQueryField,
+    }));
+}

package/esm/cli/codegen/custom-queries.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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;
+    content: string;
+    operationName: string;
+}
+export interface GenerateCustomQueryHookOptions {
+    operation: CleanOperation;
+    typeRegistry: TypeRegistry;
+    maxDepth?: number;
+    skipQueryField?: boolean;
+}
+/**
+ * Generate a custom query hook file
+ */
+export declare function generateCustomQueryHook(options: GenerateCustomQueryHookOptions): GeneratedCustomQueryFile;
+export interface GenerateAllCustomQueryHooksOptions {
+    operations: CleanOperation[];
+    typeRegistry: TypeRegistry;
+    maxDepth?: number;
+    skipQueryField?: boolean;
+}
+/**
+ * Generate all custom query hook files
+ */
+export declare function generateAllCustomQueryHooks(options: GenerateAllCustomQueryHooksOptions): GeneratedCustomQueryFile[];