@constructive-io/graphql-codegen 2.18.0 → 2.20.0

package/cli/codegen/types.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateTypesFile = generateTypesFile;
+exports.generateMinimalEntityType = generateMinimalEntityType;
+const ts_ast_1 = require("./ts-ast");
+const utils_1 = require("./utils");
+const filters_1 = require("./filters");
+/**
+ * Generate types.ts content with all entity interfaces and base filter types
+ */
+function generateTypesFile(tables) {
+    const project = (0, ts_ast_1.createProject)();
+    const sourceFile = (0, ts_ast_1.createSourceFile)(project, 'types.ts');
+    // Add file header
+    sourceFile.insertText(0, (0, ts_ast_1.createFileHeader)('Entity types and filter types') + '\n\n');
+    // Add section comment
+    sourceFile.addStatements('// ============================================================================');
+    sourceFile.addStatements('// Entity types');
+    sourceFile.addStatements('// ============================================================================\n');
+    // Generate entity interfaces
+    for (const table of tables) {
+        const scalarFields = (0, utils_1.getScalarFields)(table);
+        const properties = scalarFields.map((field) => ({
+            name: field.name,
+            type: `${(0, utils_1.fieldTypeToTs)(field.type)} | null`,
+        }));
+        sourceFile.addInterface((0, ts_ast_1.createInterface)(table.name, properties));
+    }
+    // Add section comment for filters
+    sourceFile.addStatements('\n// ============================================================================');
+    sourceFile.addStatements('// Filter types (shared)');
+    sourceFile.addStatements('// ============================================================================\n');
+    // Add base filter types (using string concat for complex types - acceptable for static definitions)
+    const filterTypesContent = (0, filters_1.generateBaseFilterTypes)();
+    // Extract just the interfaces part (skip the header)
+    const filterInterfaces = filterTypesContent
+        .split('\n')
+        .slice(6) // Skip header lines
+        .join('\n');
+    sourceFile.addStatements(filterInterfaces);
+    return (0, ts_ast_1.getFormattedOutput)(sourceFile);
+}
+/**
+ * Generate a minimal entity type (just id and display fields)
+ */
+function generateMinimalEntityType(table) {
+    const project = (0, ts_ast_1.createProject)();
+    const sourceFile = (0, ts_ast_1.createSourceFile)(project, 'minimal.ts');
+    const scalarFields = (0, utils_1.getScalarFields)(table);
+    // Find id and likely display fields
+    const displayFields = scalarFields.filter((f) => {
+        const name = f.name.toLowerCase();
+        return (name === 'id' ||
+            name === 'name' ||
+            name === 'title' ||
+            name === 'label' ||
+            name === 'email' ||
+            name.endsWith('name') ||
+            name.endsWith('title'));
+    });
+    // If no display fields found, take first 5 scalar fields
+    const fieldsToUse = displayFields.length > 0 ? displayFields : scalarFields.slice(0, 5);
+    const properties = fieldsToUse.map((field) => ({
+        name: field.name,
+        type: `${(0, utils_1.fieldTypeToTs)(field.type)} | null`,
+    }));
+    sourceFile.addInterface((0, ts_ast_1.createInterface)(`${table.name}Minimal`, properties));
+    return (0, ts_ast_1.getFormattedOutput)(sourceFile);
+}

package/cli/codegen/utils.d.ts

@@ -0,0 +1,163 @@
+/**
+ * Codegen utilities - naming conventions, type mapping, and helpers
+ */
+import type { CleanTable, CleanField, CleanFieldType } from '../../types/schema';
+/** Lowercase first character */
+export declare function lcFirst(str: string): string;
+/** Uppercase first character */
+export declare function ucFirst(str: string): string;
+/** Convert to camelCase */
+export declare function toCamelCase(str: string): string;
+/** Convert to PascalCase */
+export declare function toPascalCase(str: string): string;
+/** Convert to SCREAMING_SNAKE_CASE */
+export declare function toScreamingSnake(str: string): string;
+export interface TableNames {
+    /** PascalCase singular (e.g., "Car") */
+    typeName: string;
+    /** camelCase singular (e.g., "car") */
+    singularName: string;
+    /** camelCase plural (e.g., "cars") */
+    pluralName: string;
+    /** PascalCase plural (e.g., "Cars") */
+    pluralTypeName: string;
+}
+/**
+ * Derive all naming variants from a table
+ */
+export declare function getTableNames(table: CleanTable): TableNames;
+/**
+ * Generate hook function name for list query
+ * e.g., "useCarsQuery"
+ */
+export declare function getListQueryHookName(table: CleanTable): string;
+/**
+ * Generate hook function name for single item query
+ * e.g., "useCarQuery"
+ */
+export declare function getSingleQueryHookName(table: CleanTable): string;
+/**
+ * Generate hook function name for create mutation
+ * e.g., "useCreateCarMutation"
+ */
+export declare function getCreateMutationHookName(table: CleanTable): string;
+/**
+ * Generate hook function name for update mutation
+ * e.g., "useUpdateCarMutation"
+ */
+export declare function getUpdateMutationHookName(table: CleanTable): string;
+/**
+ * Generate hook function name for delete mutation
+ * e.g., "useDeleteCarMutation"
+ */
+export declare function getDeleteMutationHookName(table: CleanTable): string;
+/**
+ * Generate file name for list query hook
+ * e.g., "useCarsQuery.ts"
+ */
+export declare function getListQueryFileName(table: CleanTable): string;
+/**
+ * Generate file name for single query hook
+ * e.g., "useCarQuery.ts"
+ */
+export declare function getSingleQueryFileName(table: CleanTable): string;
+/**
+ * Generate file name for create mutation hook
+ */
+export declare function getCreateMutationFileName(table: CleanTable): string;
+/**
+ * Generate file name for update mutation hook
+ */
+export declare function getUpdateMutationFileName(table: CleanTable): string;
+/**
+ * Generate file name for delete mutation hook
+ */
+export declare function getDeleteMutationFileName(table: CleanTable): string;
+/**
+ * Get the GraphQL query name for fetching all rows
+ * Uses inflection from _meta, falls back to convention
+ */
+export declare function getAllRowsQueryName(table: CleanTable): string;
+/**
+ * Get the GraphQL query name for fetching single row
+ */
+export declare function getSingleRowQueryName(table: CleanTable): string;
+/**
+ * Get the GraphQL mutation name for creating
+ */
+export declare function getCreateMutationName(table: CleanTable): string;
+/**
+ * Get the GraphQL mutation name for updating
+ */
+export declare function getUpdateMutationName(table: CleanTable): string;
+/**
+ * Get the GraphQL mutation name for deleting
+ */
+export declare function getDeleteMutationName(table: CleanTable): string;
+/**
+ * Get PostGraphile filter type name
+ * e.g., "CarFilter"
+ */
+export declare function getFilterTypeName(table: CleanTable): string;
+/**
+ * Get PostGraphile OrderBy enum type name
+ * e.g., "CarsOrderBy"
+ */
+export declare function getOrderByTypeName(table: CleanTable): string;
+/**
+ * Get PostGraphile create input type name
+ * e.g., "CreateCarInput"
+ */
+export declare function getCreateInputTypeName(table: CleanTable): string;
+/**
+ * Get PostGraphile patch type name for updates
+ * e.g., "CarPatch"
+ */
+export declare function getPatchTypeName(table: CleanTable): string;
+/**
+ * Get PostGraphile update input type name
+ * e.g., "UpdateCarInput"
+ */
+export declare function getUpdateInputTypeName(table: CleanTable): string;
+/**
+ * Get PostGraphile delete input type name
+ * e.g., "DeleteCarInput"
+ */
+export declare function getDeleteInputTypeName(table: CleanTable): string;
+/**
+ * Convert GraphQL type to TypeScript type
+ */
+export declare function gqlTypeToTs(gqlType: string, isArray?: boolean): string;
+/**
+ * Convert CleanFieldType to TypeScript type string
+ */
+export declare function fieldTypeToTs(fieldType: CleanFieldType): string;
+/**
+ * Get the PostGraphile filter type for a GraphQL scalar
+ */
+export declare function getScalarFilterType(gqlType: string): string | null;
+/**
+ * Check if a field is a relation field (not a scalar)
+ */
+export declare function isRelationField(fieldName: string, table: CleanTable): boolean;
+/**
+ * Get only scalar fields (non-relation fields)
+ */
+export declare function getScalarFields(table: CleanTable): CleanField[];
+/**
+ * Get primary key field names
+ */
+export declare function getPrimaryKeyFields(table: CleanTable): string[];
+/**
+ * Generate query key prefix for a table
+ * e.g., "cars" for list queries, "car" for detail queries
+ */
+export declare function getQueryKeyPrefix(table: CleanTable): string;
+/**
+ * Generate a doc comment header for generated files
+ */
+export declare function getGeneratedFileHeader(description: string): string;
+/**
+ * Indent a multi-line string
+ */
+export declare function indent(str: string, spaces?: number): string;

package/cli/codegen/utils.js

@@ -0,0 +1,326 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.lcFirst = lcFirst;
+exports.ucFirst = ucFirst;
+exports.toCamelCase = toCamelCase;
+exports.toPascalCase = toPascalCase;
+exports.toScreamingSnake = toScreamingSnake;
+exports.getTableNames = getTableNames;
+exports.getListQueryHookName = getListQueryHookName;
+exports.getSingleQueryHookName = getSingleQueryHookName;
+exports.getCreateMutationHookName = getCreateMutationHookName;
+exports.getUpdateMutationHookName = getUpdateMutationHookName;
+exports.getDeleteMutationHookName = getDeleteMutationHookName;
+exports.getListQueryFileName = getListQueryFileName;
+exports.getSingleQueryFileName = getSingleQueryFileName;
+exports.getCreateMutationFileName = getCreateMutationFileName;
+exports.getUpdateMutationFileName = getUpdateMutationFileName;
+exports.getDeleteMutationFileName = getDeleteMutationFileName;
+exports.getAllRowsQueryName = getAllRowsQueryName;
+exports.getSingleRowQueryName = getSingleRowQueryName;
+exports.getCreateMutationName = getCreateMutationName;
+exports.getUpdateMutationName = getUpdateMutationName;
+exports.getDeleteMutationName = getDeleteMutationName;
+exports.getFilterTypeName = getFilterTypeName;
+exports.getOrderByTypeName = getOrderByTypeName;
+exports.getCreateInputTypeName = getCreateInputTypeName;
+exports.getPatchTypeName = getPatchTypeName;
+exports.getUpdateInputTypeName = getUpdateInputTypeName;
+exports.getDeleteInputTypeName = getDeleteInputTypeName;
+exports.gqlTypeToTs = gqlTypeToTs;
+exports.fieldTypeToTs = fieldTypeToTs;
+exports.getScalarFilterType = getScalarFilterType;
+exports.isRelationField = isRelationField;
+exports.getScalarFields = getScalarFields;
+exports.getPrimaryKeyFields = getPrimaryKeyFields;
+exports.getQueryKeyPrefix = getQueryKeyPrefix;
+exports.getGeneratedFileHeader = getGeneratedFileHeader;
+exports.indent = indent;
+const scalars_1 = require("./scalars");
+// ============================================================================
+// String manipulation
+// ============================================================================
+/** Lowercase first character */
+function lcFirst(str) {
+    return str.charAt(0).toLowerCase() + str.slice(1);
+}
+/** Uppercase first character */
+function ucFirst(str) {
+    return str.charAt(0).toUpperCase() + str.slice(1);
+}
+/** Convert to camelCase */
+function toCamelCase(str) {
+    return str
+        .replace(/[-_](.)/g, (_, char) => char.toUpperCase())
+        .replace(/^(.)/, (_, char) => char.toLowerCase());
+}
+/** Convert to PascalCase */
+function toPascalCase(str) {
+    return str
+        .replace(/[-_](.)/g, (_, char) => char.toUpperCase())
+        .replace(/^(.)/, (_, char) => char.toUpperCase());
+}
+/** Convert to SCREAMING_SNAKE_CASE */
+function toScreamingSnake(str) {
+    return str
+        .replace(/([A-Z])/g, '_$1')
+        .replace(/[-\s]/g, '_')
+        .toUpperCase()
+        .replace(/^_/, '');
+}
+/**
+ * Derive all naming variants from a table
+ */
+function getTableNames(table) {
+    const typeName = table.name;
+    const singularName = table.inflection?.tableFieldName || lcFirst(typeName);
+    const pluralName = table.query?.all || table.inflection?.allRows || singularName + 's';
+    const pluralTypeName = ucFirst(pluralName);
+    return {
+        typeName,
+        singularName,
+        pluralName,
+        pluralTypeName,
+    };
+}
+/**
+ * Generate hook function name for list query
+ * e.g., "useCarsQuery"
+ */
+function getListQueryHookName(table) {
+    const { pluralName } = getTableNames(table);
+    return `use${ucFirst(pluralName)}Query`;
+}
+/**
+ * Generate hook function name for single item query
+ * e.g., "useCarQuery"
+ */
+function getSingleQueryHookName(table) {
+    const { singularName } = getTableNames(table);
+    return `use${ucFirst(singularName)}Query`;
+}
+/**
+ * Generate hook function name for create mutation
+ * e.g., "useCreateCarMutation"
+ */
+function getCreateMutationHookName(table) {
+    const { typeName } = getTableNames(table);
+    return `useCreate${typeName}Mutation`;
+}
+/**
+ * Generate hook function name for update mutation
+ * e.g., "useUpdateCarMutation"
+ */
+function getUpdateMutationHookName(table) {
+    const { typeName } = getTableNames(table);
+    return `useUpdate${typeName}Mutation`;
+}
+/**
+ * Generate hook function name for delete mutation
+ * e.g., "useDeleteCarMutation"
+ */
+function getDeleteMutationHookName(table) {
+    const { typeName } = getTableNames(table);
+    return `useDelete${typeName}Mutation`;
+}
+/**
+ * Generate file name for list query hook
+ * e.g., "useCarsQuery.ts"
+ */
+function getListQueryFileName(table) {
+    return `${getListQueryHookName(table)}.ts`;
+}
+/**
+ * Generate file name for single query hook
+ * e.g., "useCarQuery.ts"
+ */
+function getSingleQueryFileName(table) {
+    return `${getSingleQueryHookName(table)}.ts`;
+}
+/**
+ * Generate file name for create mutation hook
+ */
+function getCreateMutationFileName(table) {
+    return `${getCreateMutationHookName(table)}.ts`;
+}
+/**
+ * Generate file name for update mutation hook
+ */
+function getUpdateMutationFileName(table) {
+    return `${getUpdateMutationHookName(table)}.ts`;
+}
+/**
+ * Generate file name for delete mutation hook
+ */
+function getDeleteMutationFileName(table) {
+    return `${getDeleteMutationHookName(table)}.ts`;
+}
+// ============================================================================
+// GraphQL operation names
+// ============================================================================
+/**
+ * Get the GraphQL query name for fetching all rows
+ * Uses inflection from _meta, falls back to convention
+ */
+function getAllRowsQueryName(table) {
+    return table.query?.all || table.inflection?.allRows || lcFirst(table.name) + 's';
+}
+/**
+ * Get the GraphQL query name for fetching single row
+ */
+function getSingleRowQueryName(table) {
+    return table.query?.one || table.inflection?.tableFieldName || lcFirst(table.name);
+}
+/**
+ * Get the GraphQL mutation name for creating
+ */
+function getCreateMutationName(table) {
+    return table.query?.create || `create${table.name}`;
+}
+/**
+ * Get the GraphQL mutation name for updating
+ */
+function getUpdateMutationName(table) {
+    return table.query?.update || `update${table.name}`;
+}
+/**
+ * Get the GraphQL mutation name for deleting
+ */
+function getDeleteMutationName(table) {
+    return table.query?.delete || `delete${table.name}`;
+}
+// ============================================================================
+// Type names
+// ============================================================================
+/**
+ * Get PostGraphile filter type name
+ * e.g., "CarFilter"
+ */
+function getFilterTypeName(table) {
+    return table.inflection?.filterType || `${table.name}Filter`;
+}
+/**
+ * Get PostGraphile OrderBy enum type name
+ * e.g., "CarsOrderBy"
+ */
+function getOrderByTypeName(table) {
+    return table.inflection?.orderByType || `${table.name}sOrderBy`;
+}
+/**
+ * Get PostGraphile create input type name
+ * e.g., "CreateCarInput"
+ */
+function getCreateInputTypeName(table) {
+    return table.inflection?.createInputType || `Create${table.name}Input`;
+}
+/**
+ * Get PostGraphile patch type name for updates
+ * e.g., "CarPatch"
+ */
+function getPatchTypeName(table) {
+    return table.inflection?.patchType || `${table.name}Patch`;
+}
+/**
+ * Get PostGraphile update input type name
+ * e.g., "UpdateCarInput"
+ */
+function getUpdateInputTypeName(table) {
+    return `Update${table.name}Input`;
+}
+/**
+ * Get PostGraphile delete input type name
+ * e.g., "DeleteCarInput"
+ */
+function getDeleteInputTypeName(table) {
+    return `Delete${table.name}Input`;
+}
+// ============================================================================
+// Type mapping: GraphQL → TypeScript
+// ============================================================================
+/**
+ * Convert GraphQL type to TypeScript type
+ */
+function gqlTypeToTs(gqlType, isArray = false) {
+    // Remove non-null markers
+    const cleanType = gqlType.replace(/!/g, '');
+    // Look up in map, fallback to the type name itself (custom type)
+    const tsType = (0, scalars_1.scalarToTsType)(cleanType, { unknownScalar: 'name' });
+    return isArray ? `${tsType}[]` : tsType;
+}
+/**
+ * Convert CleanFieldType to TypeScript type string
+ */
+function fieldTypeToTs(fieldType) {
+    return gqlTypeToTs(fieldType.gqlType, fieldType.isArray);
+}
+// ============================================================================
+// Type mapping: GraphQL → Filter type
+// ============================================================================
+/**
+ * Get the PostGraphile filter type for a GraphQL scalar
+ */
+function getScalarFilterType(gqlType) {
+    const cleanType = gqlType.replace(/!/g, '');
+    return (0, scalars_1.scalarToFilterType)(cleanType);
+}
+// ============================================================================
+// Field filtering utilities
+// ============================================================================
+/**
+ * Check if a field is a relation field (not a scalar)
+ */
+function isRelationField(fieldName, table) {
+    const { belongsTo, hasOne, hasMany, manyToMany } = table.relations;
+    return (belongsTo.some((r) => r.fieldName === fieldName) ||
+        hasOne.some((r) => r.fieldName === fieldName) ||
+        hasMany.some((r) => r.fieldName === fieldName) ||
+        manyToMany.some((r) => r.fieldName === fieldName));
+}
+/**
+ * Get only scalar fields (non-relation fields)
+ */
+function getScalarFields(table) {
+    return table.fields.filter((f) => !isRelationField(f.name, table));
+}
+/**
+ * Get primary key field names
+ */
+function getPrimaryKeyFields(table) {
+    const pk = table.constraints?.primaryKey?.[0];
+    if (!pk)
+        return ['id']; // Default assumption
+    return pk.fields.map((f) => f.name);
+}
+// ============================================================================
+// Query key generation
+// ============================================================================
+/**
+ * Generate query key prefix for a table
+ * e.g., "cars" for list queries, "car" for detail queries
+ */
+function getQueryKeyPrefix(table) {
+    return lcFirst(table.name);
+}
+// ============================================================================
+// Code generation helpers
+// ============================================================================
+/**
+ * Generate a doc comment header for generated files
+ */
+function getGeneratedFileHeader(description) {
+    return `/**
+ * ${description}
+ * @generated by @constructive-io/graphql-codegen
+ * DO NOT EDIT - changes will be overwritten
+ */`;
+}
+/**
+ * Indent a multi-line string
+ */
+function indent(str, spaces = 2) {
+    const pad = ' '.repeat(spaces);
+    return str
+        .split('\n')
+        .map((line) => (line.trim() ? pad + line : line))
+        .join('\n');
+}

package/cli/commands/generate-orm.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Generate ORM command - generates Prisma-like ORM client
+ *
+ * This command:
+ * 1. Fetches _meta query for table-based CRUD operations
+ * 2. Fetches __schema introspection for custom operations
+ * 3. Generates a Prisma-like ORM client with fluent API
+ */
+export interface GenerateOrmOptions {
+    /** Path to config file */
+    config?: string;
+    /** GraphQL endpoint URL (overrides config) */
+    endpoint?: string;
+    /** Output directory (overrides config) */
+    output?: string;
+    /** Authorization header */
+    authorization?: string;
+    /** Verbose output */
+    verbose?: boolean;
+    /** Dry run - don't write files */
+    dryRun?: boolean;
+    /** Skip custom operations (only generate table CRUD) */
+    skipCustomOperations?: boolean;
+}
+export interface GenerateOrmResult {
+    success: boolean;
+    message: string;
+    tables?: string[];
+    customQueries?: string[];
+    customMutations?: string[];
+    filesWritten?: string[];
+    errors?: string[];
+}
+/**
+ * Execute the generate-orm command
+ */
+export declare function generateOrmCommand(options?: GenerateOrmOptions): Promise<GenerateOrmResult>;