drizzle-docs-generator 0.1.0

package/dist/generator/common.d.ts

@@ -0,0 +1,393 @@
+import { AnyColumn, Table } from 'drizzle-orm';
+import { TableRelationalConfig } from 'drizzle-orm/relations';
+import { GeneratedRef, GenerateOptions } from '../types';
+import { SchemaComments } from '../parser/comments';
+import { SchemaRelations } from '../parser/relations';
+/**
+ * Legacy v0 Relations type (for backward compatibility with relations())
+ * This is a simplified type - the actual structure is more complex
+ */
+type LegacyRelations = {
+    table: Table;
+    config: Record<string, unknown>;
+};
+/**
+ * Simple DBML string builder
+ */
+export declare class DbmlBuilder {
+    private lines;
+    private indentLevel;
+    /**
+     * Increase the indentation level by one
+     * @returns This instance for method chaining
+     */
+    indent(): this;
+    /**
+     * Decrease the indentation level by one (minimum 0)
+     * @returns This instance for method chaining
+     */
+    dedent(): this;
+    /**
+     * Add a line with the current indentation level
+     * @param content - The content to add (empty string adds a blank line)
+     * @returns This instance for method chaining
+     */
+    line(content?: string): this;
+    /**
+     * Build the final DBML string from all added lines
+     * @returns The complete DBML content as a string
+     */
+    build(): string;
+}
+/**
+ * Configuration for different database dialects
+ */
+export interface DialectConfig {
+    escapeName: (name: string) => string;
+    isIncrement: (column: AnyColumn) => boolean;
+}
+/**
+ * Table configuration extracted from Drizzle tables
+ * Using 'any' types for dialect-agnostic handling
+ */
+export interface TableConfig {
+    indexes: unknown[];
+    primaryKeys: unknown[];
+    uniqueConstraints: unknown[];
+    foreignKeys: unknown[];
+}
+/**
+ * Base generator class for DBML generation
+ */
+export declare abstract class BaseGenerator<TSchema extends Record<string, unknown> = Record<string, unknown>> {
+    protected schema: TSchema;
+    protected relational: boolean;
+    protected generatedRefs: GeneratedRef[];
+    protected comments: SchemaComments | undefined;
+    protected parsedRelations: SchemaRelations | undefined;
+    protected source: string | undefined;
+    protected abstract dialectConfig: DialectConfig;
+    /**
+     * Create a new generator instance
+     * @param options - Configuration options including schema, relational mode, source code, and comments
+     */
+    constructor(options: GenerateOptions<TSchema>);
+    /**
+     * Generate complete DBML output from the schema
+     *
+     * Creates DBML representation including:
+     * - Table definitions with columns, indexes, and constraints
+     * - Foreign key references (from table config or relations)
+     * - Comments for tables and columns
+     *
+     * @returns The complete DBML string
+     */
+    generate(): string;
+    /**
+     * Get all tables from schema
+     *
+     * Extracts all Drizzle table objects from the schema by checking each value
+     * with isTable() method.
+     *
+     * @returns Array of table objects
+     */
+    protected getTables(): Table[];
+    /**
+     * Check if a value is a Drizzle table
+     *
+     * Validates whether a value is a table instance from any supported dialect
+     * (PostgreSQL, MySQL, or SQLite).
+     *
+     * @param value - The value to check
+     * @returns True if value is a Drizzle table
+     */
+    protected isTable(value: unknown): boolean;
+    /**
+     * Get all v0 relations from schema (legacy relations() API)
+     *
+     * Extracts legacy relations defined using the old relations() API.
+     * These are identified by having 'table' and 'config' properties.
+     *
+     * @returns Array of legacy relation objects
+     */
+    protected getV0Relations(): LegacyRelations[];
+    /**
+     * Check if a value is a Drizzle v0 relations object (from relations())
+     *
+     * Validates the legacy relations() format by checking for 'table' and 'config' properties.
+     *
+     * @param value - The value to check
+     * @returns True if value is a legacy relations object
+     */
+    protected isV0Relations(value: unknown): boolean;
+    /**
+     * Check if a value is a v1 relation entry (from defineRelations())
+     *
+     * Uses official Drizzle v1 types: TableRelationalConfig with Relation instances.
+     * Validates the structure has 'table', 'name', and 'relations' properties with valid types.
+     *
+     * @param value - The value to check
+     * @returns True if value is a v1 relation entry
+     */
+    protected isV1RelationEntry(value: unknown): value is TableRelationalConfig;
+    /**
+     * Get all v1 relation entries from schema (defineRelations() API)
+     *
+     * Handles both individual entries and the full defineRelations() result object.
+     * Extracts relation configurations that use the modern v1 API with official types.
+     *
+     * @returns Array of v1 relation entries
+     */
+    protected getV1RelationEntries(): TableRelationalConfig[];
+    /**
+     * Check if a value is a full v1 defineRelations() result object
+     *
+     * This is an object where all values are TableRelationalConfig objects.
+     * Used to detect the full result of calling defineRelations() in v1.
+     *
+     * @param value - The value to check
+     * @returns True if value is a full defineRelations() result
+     */
+    protected isV1DefineRelationsResult(value: unknown): boolean;
+    /**
+     * Generate a table definition in DBML format
+     *
+     * Creates the complete table definition including columns, indexes, constraints,
+     * and table-level comments. Also collects foreign keys if not in relational mode.
+     *
+     * @param dbml - The DBML builder to add the table to
+     * @param table - The Drizzle table to generate
+     */
+    protected generateTable(dbml: DbmlBuilder, table: Table): void;
+    /**
+     * Get table configuration from a Drizzle table
+     *
+     * Extracts indexes, primary keys, unique constraints, and foreign keys
+     * from the table using the appropriate dialect-specific config getter.
+     *
+     * @param table - The Drizzle table to get configuration from
+     * @returns Table configuration or undefined if dialect is not supported
+     */
+    protected getTableConfig(table: Table): TableConfig | undefined;
+    /**
+     * Generate a column definition in DBML format
+     *
+     * Creates a column line with type and attributes (primary key, not null, unique, etc.)
+     * and includes column-level comments if available.
+     *
+     * @param dbml - The DBML builder to add the column to
+     * @param column - The Drizzle column to generate
+     * @param tableName - Optional table name for looking up comments
+     */
+    protected generateColumn(dbml: DbmlBuilder, column: AnyColumn, tableName?: string): void;
+    /**
+     * Get the SQL type for a column
+     *
+     * @param column - The column to get the SQL type from
+     * @returns The SQL type string (e.g., "varchar", "integer")
+     */
+    protected getColumnType(column: AnyColumn): string;
+    /**
+     * Get column attributes for DBML
+     *
+     * Extracts attributes like primary key, not null, unique, increment, default value,
+     * and note from the column. Uses column metadata and comments if available.
+     *
+     * @param column - The column to get attributes from
+     * @param tableName - Optional table name for looking up comments
+     * @returns Array of attribute strings for DBML format
+     */
+    protected getColumnAttributes(column: AnyColumn, tableName?: string): string[];
+    /**
+     * Format attributes into a string
+     *
+     * @param attrs - Array of attribute strings
+     * @returns Comma-separated attribute string
+     */
+    protected formatAttributes(attrs: string[]): string;
+    /**
+     * Get the default value for a column
+     *
+     * Extracts and formats the default value from a column, handling SQL expressions,
+     * objects, and primitive values. Returns undefined if no default value exists.
+     *
+     * @param column - The column to get the default value from
+     * @returns Formatted default value string or undefined
+     */
+    protected getDefaultValue(column: AnyColumn): string | undefined;
+    /**
+     * Generate indexes block from table configuration
+     *
+     * Creates the indexes block containing primary keys, unique constraints,
+     * and regular indexes with their respective attributes.
+     *
+     * @param dbml - The DBML builder to add the indexes block to
+     * @param tableConfig - The table configuration containing index information
+     */
+    protected generateIndexesBlock(dbml: DbmlBuilder, tableConfig: TableConfig): void;
+    /**
+     * Collect foreign keys from table configuration
+     *
+     * Parses all foreign key definitions from the table config and adds them
+     * to the generatedRefs collection for later output.
+     *
+     * @param tableName - The name of the source table
+     * @param foreignKeys - Array of foreign key definitions from table config
+     */
+    protected collectForeignKeysFromConfig(tableName: string, foreignKeys: unknown[]): void;
+    /**
+     * Parse a foreign key into a GeneratedRef
+     *
+     * Extracts foreign key information (source/target tables and columns, actions)
+     * and converts it to a GeneratedRef object for DBML output.
+     *
+     * @param tableName - The name of the source table
+     * @param fk - The foreign key definition to parse
+     * @returns GeneratedRef object or undefined if parsing fails
+     */
+    protected parseForeignKey(tableName: string, fk: unknown): GeneratedRef | undefined;
+    /**
+     * Get a mapping from variable names to table names in the schema
+     *
+     * Creates a map from TypeScript variable names (e.g., "usersTable") to
+     * actual database table names (e.g., "users").
+     *
+     * @returns Map of variable names to table names
+     */
+    protected getTableNameMapping(): Map<string, string>;
+    /**
+     * Get a mapping from TypeScript property names to database column names for a table
+     *
+     * Creates a map from TypeScript property names (e.g., "authorId") to
+     * actual database column names (e.g., "author_id").
+     *
+     * @param tableVarName - The variable name of the table in the schema
+     * @returns Map of property names to column names
+     */
+    protected getColumnNameMapping(tableVarName: string): Map<string, string>;
+    /**
+     * Check if there's a reverse one() relation (B->A when we have A->B)
+     *
+     * Used to detect one-to-one relationships by checking if both tables
+     * have one() relations pointing to each other.
+     *
+     * @param sourceTable - The source table variable name
+     * @param targetTable - The target table variable name
+     * @param sourceFields - The source table's field names
+     * @param targetReferences - The target table's reference column names
+     * @returns True if a reverse one() relation exists
+     */
+    protected hasReverseOneRelation(sourceTable: string, targetTable: string, sourceFields: string[], targetReferences: string[]): boolean;
+    /**
+     * Helper to check if two arrays are equal
+     *
+     * @param a - First array
+     * @param b - Second array
+     * @returns True if arrays have same length and same elements in order
+     */
+    private arraysEqual;
+    /**
+     * Generate references from v0 relations() API
+     *
+     * Uses TypeScript Compiler API to parse relations() definitions from source file
+     * and extract fields/references to generate DBML Ref lines.
+     *
+     * Detects one-to-one relationships when bidirectional one() relations exist.
+     */
+    protected generateRelationalRefsFromV0(): void;
+    /**
+     * Generate references from v1 defineRelations() entries
+     *
+     * Uses official Drizzle v1 types (TableRelationalConfig, Relation, One).
+     * Processes One relations to extract foreign key information and generates
+     * DBML Ref lines. Detects one-to-one relationships with bidirectional checks.
+     *
+     * @param entries - Array of v1 relation entries from defineRelations()
+     */
+    protected generateRelationalRefsFromV1(entries: TableRelationalConfig[]): void;
+    /**
+     * Check if there's a reverse One relation in v1 entries
+     *
+     * Detects one-to-one relationships by checking if the target table
+     * has a matching One relation pointing back to the source table.
+     *
+     * @param entries - All v1 relation entries
+     * @param fromTableName - The table to search for reverse relation
+     * @param toTableName - The expected target table of the reverse relation
+     * @param fromColumns - The expected source columns of the reverse relation
+     * @param toColumns - The expected target columns of the reverse relation
+     * @returns True if a matching reverse One relation exists
+     */
+    protected hasV1ReverseOneRelation(entries: TableRelationalConfig[], fromTableName: string, toTableName: string, fromColumns: string[], toColumns: string[]): boolean;
+    /**
+     * Get unique key for a relation to avoid duplicates
+     *
+     * Creates a consistent key by sorting table names alphabetically.
+     *
+     * @param tableName - The source table name
+     * @param relation - The relation object
+     * @returns A unique key string for the relation
+     */
+    protected getRelationKey(tableName: string, relation: unknown): string;
+    /**
+     * Parse a relation into a GeneratedRef
+     *
+     * Extracts relation information from a legacy relation object and converts
+     * it to a GeneratedRef for DBML output.
+     *
+     * @param tableName - The source table name
+     * @param relation - The relation object to parse
+     * @returns GeneratedRef object or undefined if parsing fails
+     */
+    protected parseRelation(tableName: string, relation: unknown): GeneratedRef | undefined;
+    /**
+     * Generate a reference line in DBML format
+     *
+     * Creates a Ref line showing the relationship between tables with optional
+     * onDelete and onUpdate actions.
+     *
+     * @param dbml - The DBML builder to add the reference to
+     * @param ref - The reference definition to generate
+     */
+    protected generateRef(dbml: DbmlBuilder, ref: GeneratedRef): void;
+    /**
+     * Get column names from an index definition
+     *
+     * @param idx - The index definition to extract columns from
+     * @returns Array of column names in the index
+     */
+    protected getIndexColumns(idx: unknown): string[];
+    /**
+     * Check if an index is unique
+     *
+     * @param idx - The index definition to check
+     * @returns True if the index has the unique flag
+     */
+    protected isUniqueIndex(idx: unknown): boolean;
+    /**
+     * Get column names from a primary key constraint
+     *
+     * @param pk - The primary key definition to extract columns from
+     * @returns Array of column names in the primary key
+     */
+    protected getPrimaryKeyColumns(pk: unknown): string[];
+    /**
+     * Get column names from a unique constraint
+     *
+     * @param uc - The unique constraint definition to extract columns from
+     * @returns Array of column names in the unique constraint
+     */
+    protected getUniqueConstraintColumns(uc: unknown): string[];
+}
+/**
+ * Write DBML content to a file
+ *
+ * Creates the directory if it doesn't exist and writes the DBML content
+ * to the specified file path.
+ *
+ * @param filePath - The path to write the DBML file to
+ * @param content - The DBML content to write
+ */
+export declare function writeDbmlFile(filePath: string, content: string): void;
+export {};
+//# sourceMappingURL=common.d.ts.map

package/dist/generator/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/generator/common.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,SAAS,EACd,KAAK,KAAK,EAMX,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EAAe,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAGhF;;;GAGG;AACH,KAAK,eAAe,GAAG;IACrB,KAAK,EAAE,KAAK,CAAC;IACb,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACjC,CAAC;AAKF,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAC9D,OAAO,EAAmB,KAAK,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAC1E,OAAO,EAAoB,KAAK,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAE7E;;GAEG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,KAAK,CAAgB;IAC7B,OAAO,CAAC,WAAW,CAAK;IAExB;;;OAGG;IACH,MAAM,IAAI,IAAI;IAKd;;;OAGG;IACH,MAAM,IAAI,IAAI;IAKd;;;;OAIG;IACH,IAAI,CAAC,OAAO,GAAE,MAAW,GAAG,IAAI;IAMhC;;;OAGG;IACH,KAAK,IAAI,MAAM;CAGhB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,UAAU,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IACrC,WAAW,EAAE,CAAC,MAAM,EAAE,SAAS,KAAK,OAAO,CAAC;CAC7C;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,OAAO,EAAE,CAAC;IACnB,WAAW,EAAE,OAAO,EAAE,CAAC;IACvB,iBAAiB,EAAE,OAAO,EAAE,CAAC;IAC7B,WAAW,EAAE,OAAO,EAAE,CAAC;CACxB;AAMD;;GAEG;AACH,8BAAsB,aAAa,CACjC,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAEjE,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC;IAC1B,SAAS,CAAC,UAAU,EAAE,OAAO,CAAC;IAC9B,SAAS,CAAC,aAAa,EAAE,YAAY,EAAE,CAAM;IAC7C,SAAS,CAAC,QAAQ,EAAE,cAAc,GAAG,SAAS,CAAC;IAC/C,SAAS,CAAC,eAAe,EAAE,eAAe,GAAG,SAAS,CAAC;IACvD,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC;IAEhD;;;OAGG;gBACS,OAAO,EAAE,eAAe,CAAC,OAAO,CAAC;IAkB7C;;;;;;;;;OASG;IACH,QAAQ,IAAI,MAAM;IAgClB;;;;;;;OAOG;IACH,SAAS,CAAC,SAAS,IAAI,KAAK,EAAE;IAU9B;;;;;;;;OAQG;IACH,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAI1C;;;;;;;OAOG;IACH,SAAS,CAAC,cAAc,IAAI,eAAe,EAAE;IAU7C;;;;;;;OAOG;IACH,SAAS,CAAC,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAYhD;;;;;;;;OAQG;IACH,SAAS,CAAC,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,qBAAqB;IA0B3E;;;;;;;OAOG;IACH,SAAS,CAAC,oBAAoB,IAAI,qBAAqB,EAAE;IAoBzD;;;;;;;;OAQG;IACH,SAAS,CAAC,yBAAyB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAU5D;;;;;;;;OAQG;IACH,SAAS,CAAC,aAAa,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI;IAqC9D;;;;;;;;OAQG;IACH,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,KAAK,GAAG,WAAW,GAAG,SAAS;IAgC/D;;;;;;;;;OASG;IACH,SAAS,CAAC,cAAc,CAAC,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI;IAaxF;;;;;OAKG;IACH,SAAS,CAAC,aAAa,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM;IAIlD;;;;;;;;;OASG;IACH,SAAS,CAAC,mBAAmB,CAAC,MAAM,EAAE,SAAS,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE;IAgC9E;;;;;OAKG;IACH,SAAS,CAAC,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM;IAInD;;;;;;;;OAQG;IACH,SAAS,CAAC,eAAe,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS;IAgDhE;;;;;;;;OAQG;IACH,SAAS,CAAC,oBAAoB,CAAC,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,GAAG,IAAI;IA+CjF;;;;;;;;OAQG;IACH,SAAS,CAAC,4BAA4B,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,IAAI;IASvF;;;;;;;;;OASG;IACH,SAAS,CAAC,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,GAAG,YAAY,GAAG,SAAS;IA8BnF;;;;;;;OAOG;IACH,SAAS,CAAC,mBAAmB,IAAI,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC;IAWpD;;;;;;;;OAQG;IACH,SAAS,CAAC,oBAAoB,CAAC,YAAY,EAAE,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC;IAYzE;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,qBAAqB,CAC7B,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,MAAM,EAAE,EACtB,gBAAgB,EAAE,MAAM,EAAE,GACzB,OAAO;IA+BV;;;;;;OAMG;IACH,OAAO,CAAC,WAAW;IAKnB;;;;;;;OAOG;IACH,SAAS,CAAC,4BAA4B,IAAI,IAAI;IAoE9C;;;;;;;;OAQG;IACH,SAAS,CAAC,4BAA4B,CAAC,OAAO,EAAE,qBAAqB,EAAE,GAAG,IAAI;IA4D9E;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,uBAAuB,CAC/B,OAAO,EAAE,qBAAqB,EAAE,EAChC,aAAa,EAAE,MAAM,EACrB,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,MAAM,EAAE,EACrB,SAAS,EAAE,MAAM,EAAE,GAClB,OAAO;IAkCV;;;;;;;;OAQG;IACH,SAAS,CAAC,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,GAAG,MAAM;IAOtE;;;;;;;;;OASG;IACH,SAAS,CAAC,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,GAAG,YAAY,GAAG,SAAS;IA6CvF;;;;;;;;OAQG;IACH,SAAS,CAAC,WAAW,CAAC,IAAI,EAAE,WAAW,EAAE,GAAG,EAAE,YAAY,GAAG,IAAI;IAuBjE;;;;;OAKG;IACH,SAAS,CAAC,eAAe,CAAC,GAAG,EAAE,OAAO,GAAG,MAAM,EAAE;IAgBjD;;;;;OAKG;IACH,SAAS,CAAC,aAAa,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO;IAS9C;;;;;OAKG;IACH,SAAS,CAAC,oBAAoB,CAAC,EAAE,EAAE,OAAO,GAAG,MAAM,EAAE;IASrD;;;;;OAKG;IACH,SAAS,CAAC,0BAA0B,CAAC,EAAE,EAAE,OAAO,GAAG,MAAM,EAAE;CAQ5D;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAKrE"}