@constructive-io/graphql-codegen 2.22.1 → 2.23.0

package/cli/introspect/infer-tables.js

@@ -0,0 +1,550 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.inferTablesFromIntrospection = inferTablesFromIntrospection;
+const introspection_1 = require("../../types/introspection");
+const pluralize_1 = require("./pluralize");
+// ============================================================================
+// Pattern Matching Constants
+// ============================================================================
+/**
+ * PostGraphile naming patterns for type detection
+ */
+const PATTERNS = {
+    // Type suffixes
+    connection: /^(.+)Connection$/,
+    edge: /^(.+)Edge$/,
+    filter: /^(.+)Filter$/,
+    condition: /^(.+)Condition$/,
+    orderBy: /^(.+)OrderBy$/,
+    patch: /^(.+)Patch$/,
+    // Input type patterns
+    createInput: /^Create(.+)Input$/,
+    updateInput: /^Update(.+)Input$/,
+    deleteInput: /^Delete(.+)Input$/,
+    // Payload type patterns
+    createPayload: /^Create(.+)Payload$/,
+    updatePayload: /^Update(.+)Payload$/,
+    deletePayload: /^Delete(.+)Payload$/,
+    // Mutation name patterns (camelCase)
+    createMutation: /^create([A-Z][a-zA-Z0-9]*)$/,
+    updateMutation: /^update([A-Z][a-zA-Z0-9]*)$/,
+    deleteMutation: /^delete([A-Z][a-zA-Z0-9]*)$/,
+};
+/**
+ * Built-in GraphQL types to ignore
+ */
+const BUILTIN_TYPES = new Set([
+    'Query',
+    'Mutation',
+    'Subscription',
+    'String',
+    'Int',
+    'Float',
+    'Boolean',
+    'ID',
+    // PostGraphile built-in types
+    'Node',
+    'PageInfo',
+    'Cursor',
+    'UUID',
+    'Datetime',
+    'Date',
+    'Time',
+    'JSON',
+    'BigInt',
+    'BigFloat',
+]);
+/**
+ * Types that start with __ are internal GraphQL types
+ */
+function isInternalType(name) {
+    return name.startsWith('__');
+}
+/**
+ * Infer CleanTable[] from GraphQL introspection by recognizing PostGraphile patterns
+ *
+ * @param introspection - Standard GraphQL introspection response
+ * @param options - Optional configuration
+ * @returns Array of CleanTable objects compatible with existing generators
+ */
+function inferTablesFromIntrospection(introspection, options = {}) {
+    const { __schema: schema } = introspection;
+    const { types, queryType, mutationType } = schema;
+    // Build lookup maps for efficient access
+    const typeMap = buildTypeMap(types);
+    const queryFields = getTypeFields(typeMap.get(queryType.name));
+    const mutationFields = mutationType
+        ? getTypeFields(typeMap.get(mutationType.name))
+        : [];
+    // Step 1: Detect entity types by finding Connection types
+    const entityNames = detectEntityTypes(types);
+    // Step 2: Build CleanTable for each entity
+    const tables = [];
+    for (const entityName of entityNames) {
+        const entityType = typeMap.get(entityName);
+        if (!entityType)
+            continue;
+        // Infer all metadata for this entity
+        const { table, hasRealOperation } = buildCleanTable(entityName, entityType, typeMap, queryFields, mutationFields);
+        // Only include tables that have at least one real operation
+        if (hasRealOperation) {
+            tables.push(table);
+        }
+    }
+    return tables;
+}
+// ============================================================================
+// Entity Detection
+// ============================================================================
+/**
+ * Detect entity types by finding Connection types in the schema
+ *
+ * PostGraphile generates a {PluralName}Connection type for each table.
+ * From this, we can derive the entity type name.
+ */
+function detectEntityTypes(types) {
+    const entityNames = new Set();
+    const typeNames = new Set(types.map((t) => t.name));
+    for (const type of types) {
+        // Skip internal types
+        if (isInternalType(type.name))
+            continue;
+        if (BUILTIN_TYPES.has(type.name))
+            continue;
+        // Check for Connection pattern
+        const connectionMatch = type.name.match(PATTERNS.connection);
+        if (connectionMatch) {
+            const pluralName = connectionMatch[1]; // e.g., "Users" from "UsersConnection"
+            const singularName = (0, pluralize_1.singularize)(pluralName); // e.g., "User"
+            // Verify the entity type actually exists
+            if (typeNames.has(singularName)) {
+                entityNames.add(singularName);
+            }
+        }
+    }
+    return entityNames;
+}
+/**
+ * Build a complete CleanTable from an entity type
+ */
+function buildCleanTable(entityName, entityType, typeMap, queryFields, mutationFields) {
+    // Extract scalar fields from entity type
+    const fields = extractEntityFields(entityType, typeMap);
+    // Infer relations from entity fields
+    const relations = inferRelations(entityType, typeMap);
+    // Match query and mutation operations
+    const queryOps = matchQueryOperations(entityName, queryFields, typeMap);
+    const mutationOps = matchMutationOperations(entityName, mutationFields);
+    // Check if we found at least one real operation (not a fallback)
+    const hasRealOperation = !!(queryOps.all ||
+        queryOps.one ||
+        mutationOps.create ||
+        mutationOps.update ||
+        mutationOps.delete);
+    // Infer primary key from mutation inputs
+    const constraints = inferConstraints(entityName, typeMap);
+    // Build inflection map from discovered types
+    const inflection = buildInflection(entityName, typeMap);
+    // Combine query operations with fallbacks for UI purposes
+    // (but hasRealOperation indicates if we should include this table)
+    const query = {
+        all: queryOps.all ?? (0, pluralize_1.lcFirst)((0, pluralize_1.pluralize)(entityName)),
+        one: queryOps.one ?? (0, pluralize_1.lcFirst)(entityName),
+        create: mutationOps.create ?? `create${entityName}`,
+        update: mutationOps.update,
+        delete: mutationOps.delete,
+    };
+    return {
+        table: {
+            name: entityName,
+            fields,
+            relations,
+            inflection,
+            query,
+            constraints,
+        },
+        hasRealOperation,
+    };
+}
+// ============================================================================
+// Field Extraction
+// ============================================================================
+/**
+ * Extract scalar fields from an entity type
+ * Excludes relation fields (those returning other entity types or connections)
+ */
+function extractEntityFields(entityType, typeMap) {
+    const fields = [];
+    if (!entityType.fields)
+        return fields;
+    for (const field of entityType.fields) {
+        const baseTypeName = (0, introspection_1.getBaseTypeName)(field.type);
+        if (!baseTypeName)
+            continue;
+        // Skip relation fields (those returning other objects or connections)
+        const fieldType = typeMap.get(baseTypeName);
+        if (fieldType?.kind === 'OBJECT') {
+            // Check if it's a Connection type (hasMany) or entity type (belongsTo)
+            if (baseTypeName.endsWith('Connection') ||
+                isEntityType(baseTypeName, typeMap)) {
+                continue; // Skip relation fields
+            }
+        }
+        // Include scalar, enum, and other non-relation fields
+        fields.push({
+            name: field.name,
+            type: convertToCleanFieldType(field.type),
+        });
+    }
+    return fields;
+}
+/**
+ * Check if a type name is an entity type (has a corresponding Connection)
+ */
+function isEntityType(typeName, typeMap) {
+    const connectionName = `${(0, pluralize_1.pluralize)(typeName)}Connection`;
+    return typeMap.has(connectionName);
+}
+/**
+ * Convert IntrospectionTypeRef to CleanFieldType
+ */
+function convertToCleanFieldType(typeRef) {
+    const baseType = (0, introspection_1.unwrapType)(typeRef);
+    const isArray = (0, introspection_1.isList)(typeRef);
+    return {
+        gqlType: baseType.name ?? 'Unknown',
+        isArray,
+        // PostgreSQL-specific fields are not available from introspection
+        // They were optional anyway and not used by generators
+    };
+}
+// ============================================================================
+// Relation Inference
+// ============================================================================
+/**
+ * Infer relations from entity type fields
+ */
+function inferRelations(entityType, typeMap) {
+    const belongsTo = [];
+    const hasMany = [];
+    const manyToMany = [];
+    if (!entityType.fields) {
+        return { belongsTo, hasOne: [], hasMany, manyToMany };
+    }
+    for (const field of entityType.fields) {
+        const baseTypeName = (0, introspection_1.getBaseTypeName)(field.type);
+        if (!baseTypeName)
+            continue;
+        // Check for Connection type → hasMany or manyToMany
+        if (baseTypeName.endsWith('Connection')) {
+            const relation = inferHasManyOrManyToMany(field, baseTypeName, typeMap);
+            if (relation.type === 'manyToMany') {
+                manyToMany.push(relation.relation);
+            }
+            else {
+                hasMany.push(relation.relation);
+            }
+            continue;
+        }
+        // Check for entity type → belongsTo
+        if (isEntityType(baseTypeName, typeMap)) {
+            belongsTo.push({
+                fieldName: field.name,
+                isUnique: false, // Can't determine from introspection alone
+                referencesTable: baseTypeName,
+                type: baseTypeName,
+                keys: [], // Would need FK info to populate
+            });
+        }
+    }
+    return { belongsTo, hasOne: [], hasMany, manyToMany };
+}
+/**
+ * Determine if a Connection field is hasMany or manyToMany
+ *
+ * ManyToMany pattern: field name contains "By" and "And"
+ * e.g., "productsByOrderItemOrderIdAndProductId"
+ */
+function inferHasManyOrManyToMany(field, connectionTypeName, typeMap) {
+    // Extract the related entity name from Connection type
+    const match = connectionTypeName.match(PATTERNS.connection);
+    const relatedPluralName = match ? match[1] : connectionTypeName;
+    const relatedEntityName = (0, pluralize_1.singularize)(relatedPluralName);
+    // Check for manyToMany pattern in field name
+    const isManyToMany = field.name.includes('By') && field.name.includes('And');
+    if (isManyToMany) {
+        // For ManyToMany, extract the actual entity name from the field name prefix
+        // Field name pattern: {relatedEntities}By{JunctionTable}{Keys}
+        // e.g., "usersByMembershipActorIdAndEntityId" → "users" → "User"
+        // e.g., "productsByOrderItemOrderIdAndProductId" → "products" → "Product"
+        const prefixMatch = field.name.match(/^([a-z]+)By/i);
+        const actualEntityName = prefixMatch
+            ? (0, pluralize_1.singularize)((0, pluralize_1.ucFirst)(prefixMatch[1]))
+            : relatedEntityName;
+        // Try to extract junction table from field name
+        // Pattern: {relatedEntities}By{JunctionTable}{Keys}
+        // e.g., "productsByProductCategoryProductIdAndCategoryId" → "ProductCategory"
+        // The junction table name ends where the first field key begins (identified by capital letter after lowercase)
+        const junctionMatch = field.name.match(/By([A-Z][a-z]+(?:[A-Z][a-z]+)*?)(?:[A-Z][a-z]+Id)/);
+        const junctionTable = junctionMatch ? junctionMatch[1] : 'Unknown';
+        return {
+            type: 'manyToMany',
+            relation: {
+                fieldName: field.name,
+                rightTable: actualEntityName,
+                junctionTable,
+                type: connectionTypeName,
+            },
+        };
+    }
+    return {
+        type: 'hasMany',
+        relation: {
+            fieldName: field.name,
+            isUnique: false,
+            referencedByTable: relatedEntityName,
+            type: connectionTypeName,
+            keys: [],
+        },
+    };
+}
+/**
+ * Match query operations for an entity
+ *
+ * Looks for:
+ * - List query: returns {PluralName}Connection (e.g., users → UsersConnection)
+ * - Single query: returns {EntityName} with id/nodeId arg (e.g., user → User)
+ */
+function matchQueryOperations(entityName, queryFields, typeMap) {
+    const pluralName = (0, pluralize_1.pluralize)(entityName);
+    const connectionTypeName = `${pluralName}Connection`;
+    let all = null;
+    let one = null;
+    for (const field of queryFields) {
+        const returnTypeName = (0, introspection_1.getBaseTypeName)(field.type);
+        if (!returnTypeName)
+            continue;
+        // Match list query by return type (Connection)
+        if (returnTypeName === connectionTypeName) {
+            // Prefer the simple plural name, but accept any that returns the connection
+            if (!all || field.name === (0, pluralize_1.lcFirst)(pluralName)) {
+                all = field.name;
+            }
+        }
+        // Match single query by return type (Entity) and having an id-like arg
+        if (returnTypeName === entityName) {
+            const hasIdArg = field.args.some((arg) => arg.name === 'id' ||
+                arg.name === 'nodeId' ||
+                arg.name.toLowerCase().endsWith('id'));
+            if (hasIdArg) {
+                // Prefer exact match (e.g., "user" for "User")
+                if (!one || field.name === (0, pluralize_1.lcFirst)(entityName)) {
+                    one = field.name;
+                }
+            }
+        }
+    }
+    return { all, one };
+}
+/**
+ * Match mutation operations for an entity
+ *
+ * Looks for mutations named:
+ * - create{EntityName}
+ * - update{EntityName} or update{EntityName}ById
+ * - delete{EntityName} or delete{EntityName}ById
+ */
+function matchMutationOperations(entityName, mutationFields) {
+    let create = null;
+    let update = null;
+    let del = null;
+    const expectedCreate = `create${entityName}`;
+    const expectedUpdate = `update${entityName}`;
+    const expectedDelete = `delete${entityName}`;
+    for (const field of mutationFields) {
+        // Exact match for create
+        if (field.name === expectedCreate) {
+            create = field.name;
+        }
+        // Match update (could be updateUser or updateUserById)
+        if (field.name === expectedUpdate ||
+            field.name === `${expectedUpdate}ById`) {
+            // Prefer non-ById version
+            if (!update || field.name === expectedUpdate) {
+                update = field.name;
+            }
+        }
+        // Match delete (could be deleteUser or deleteUserById)
+        if (field.name === expectedDelete ||
+            field.name === `${expectedDelete}ById`) {
+            // Prefer non-ById version
+            if (!del || field.name === expectedDelete) {
+                del = field.name;
+            }
+        }
+    }
+    return { create, update, delete: del };
+}
+// ============================================================================
+// Constraint Inference
+// ============================================================================
+/**
+ * Infer constraints from mutation input types
+ *
+ * Primary key can be inferred from Update/Delete mutation input types,
+ * which typically have an 'id' field or similar.
+ */
+function inferConstraints(entityName, typeMap) {
+    const primaryKey = [];
+    // Try to find Update or Delete input type to extract PK
+    const updateInputName = `Update${entityName}Input`;
+    const deleteInputName = `Delete${entityName}Input`;
+    const updateInput = typeMap.get(updateInputName);
+    const deleteInput = typeMap.get(deleteInputName);
+    // Check update input for id field
+    const inputToCheck = updateInput || deleteInput;
+    if (inputToCheck?.inputFields) {
+        const idField = inputToCheck.inputFields.find((f) => f.name === 'id' || f.name === 'nodeId');
+        if (idField) {
+            primaryKey.push({
+                name: 'primary',
+                fields: [
+                    {
+                        name: idField.name,
+                        type: convertToCleanFieldType(idField.type),
+                    },
+                ],
+            });
+        }
+    }
+    // If no PK found from inputs, try to find 'id' field in entity type
+    if (primaryKey.length === 0) {
+        const entityType = typeMap.get(entityName);
+        if (entityType?.fields) {
+            const idField = entityType.fields.find((f) => f.name === 'id' || f.name === 'nodeId');
+            if (idField) {
+                primaryKey.push({
+                    name: 'primary',
+                    fields: [
+                        {
+                            name: idField.name,
+                            type: convertToCleanFieldType(idField.type),
+                        },
+                    ],
+                });
+            }
+        }
+    }
+    return {
+        primaryKey,
+        foreignKey: [], // Would need FK info to populate
+        unique: [], // Would need constraint info to populate
+    };
+}
+// ============================================================================
+// Inflection Building
+// ============================================================================
+/**
+ * Build inflection map from discovered types
+ */
+function buildInflection(entityName, typeMap) {
+    const pluralName = (0, pluralize_1.pluralize)(entityName);
+    const singularFieldName = (0, pluralize_1.lcFirst)(entityName);
+    const pluralFieldName = (0, pluralize_1.lcFirst)(pluralName);
+    // Check which types actually exist in the schema
+    const hasFilter = typeMap.has(`${entityName}Filter`);
+    const hasPatch = typeMap.has(`${entityName}Patch`);
+    const hasUpdatePayload = typeMap.has(`Update${entityName}Payload`);
+    // Detect the actual OrderBy type from schema
+    // PostGraphile typically generates {PluralName}OrderBy (e.g., AddressesOrderBy)
+    // but we check for the actual type in case of custom inflection
+    const expectedOrderByType = `${pluralName}OrderBy`;
+    const orderByType = findOrderByType(entityName, pluralName, typeMap) || expectedOrderByType;
+    return {
+        allRows: pluralFieldName,
+        allRowsSimple: pluralFieldName,
+        conditionType: `${entityName}Condition`,
+        connection: `${pluralName}Connection`,
+        createField: `create${entityName}`,
+        createInputType: `Create${entityName}Input`,
+        createPayloadType: `Create${entityName}Payload`,
+        deleteByPrimaryKey: `delete${entityName}`,
+        deletePayloadType: `Delete${entityName}Payload`,
+        edge: `${pluralName}Edge`,
+        edgeField: (0, pluralize_1.lcFirst)(pluralName),
+        enumType: `${entityName}Enum`,
+        filterType: hasFilter ? `${entityName}Filter` : null,
+        inputType: `${entityName}Input`,
+        orderByType,
+        patchField: singularFieldName,
+        patchType: hasPatch ? `${entityName}Patch` : null,
+        tableFieldName: singularFieldName,
+        tableType: entityName,
+        typeName: entityName,
+        updateByPrimaryKey: `update${entityName}`,
+        updatePayloadType: hasUpdatePayload ? `Update${entityName}Payload` : null,
+    };
+}
+/**
+ * Find the actual OrderBy enum type for an entity from the schema
+ *
+ * PostGraphile generates OrderBy enums with various patterns:
+ * - {PluralName}OrderBy (e.g., AddressesOrderBy, UsersOrderBy)
+ * - Sometimes with custom inflection (e.g., SchemataOrderBy for Schema)
+ *
+ * We search for the actual type in the schema to handle all cases.
+ */
+function findOrderByType(entityName, pluralName, typeMap) {
+    // Try the standard pattern first: {PluralName}OrderBy
+    const standardName = `${pluralName}OrderBy`;
+    if (typeMap.has(standardName)) {
+        return standardName;
+    }
+    // Build a list of candidate OrderBy names to check
+    // These are variations of the entity name with common plural suffixes
+    const candidates = [
+        `${entityName}sOrderBy`, // Simple 's' plural: User -> UsersOrderBy
+        `${entityName}esOrderBy`, // 'es' plural: Address -> AddressesOrderBy
+        `${entityName}OrderBy`, // No change (already plural or singular OK)
+    ];
+    // Check each candidate
+    for (const candidate of candidates) {
+        if (typeMap.has(candidate) && typeMap.get(candidate)?.kind === 'ENUM') {
+            return candidate;
+        }
+    }
+    // Fallback: search for an enum that EXACTLY matches the entity plural pattern
+    // We look for types that are the pluralized entity name + OrderBy
+    // This avoids matching SchemaGrantsOrderBy when looking for Schema's OrderBy
+    for (const [typeName, type] of typeMap) {
+        if (type.kind !== 'ENUM' || !typeName.endsWith('OrderBy'))
+            continue;
+        // Extract the base name (without OrderBy suffix)
+        const baseName = typeName.slice(0, -7); // Remove 'OrderBy'
+        // Check if singularizing the base name gives us the entity name
+        // e.g., 'Schemata' -> 'Schema', 'Users' -> 'User', 'Addresses' -> 'Address'
+        if ((0, pluralize_1.singularize)(baseName) === entityName) {
+            return typeName;
+        }
+    }
+    return null;
+}
+// ============================================================================
+// Utility Functions
+// ============================================================================
+/**
+ * Build a map of type name → IntrospectionType for efficient lookup
+ */
+function buildTypeMap(types) {
+    const map = new Map();
+    for (const type of types) {
+        map.set(type.name, type);
+    }
+    return map;
+}
+/**
+ * Get fields from a type, returning empty array if null
+ */
+function getTypeFields(type) {
+    return type?.fields ?? [];
+}

package/cli/introspect/pluralize.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Convert a word to its singular form
+ * @example "Users" → "User", "People" → "Person", "Schemata" → "Schema", "ApiSchemata" → "ApiSchema"
+ */
+export declare function singularize(word: string): string;
+/**
+ * Convert a word to its plural form
+ * @example "User" → "Users", "Person" → "People"
+ */
+export declare function pluralize(word: string): string;
+/**
+ * Convert PascalCase to camelCase
+ * @example "UserProfile" → "userProfile"
+ */
+export declare function lcFirst(str: string): string;
+/**
+ * Convert camelCase to PascalCase
+ * @example "userProfile" → "UserProfile"
+ */
+export declare function ucFirst(str: string): string;
+/**
+ * Convert a plural PascalCase type name to singular camelCase field name
+ * @example "Users" → "user", "OrderItems" → "orderItem"
+ */
+export declare function toFieldName(pluralTypeName: string): string;
+/**
+ * Convert a singular PascalCase type name to plural camelCase query name
+ * @example "User" → "users", "OrderItem" → "orderItems"
+ */
+export declare function toQueryName(singularTypeName: string): string;