drizzle-docs-generator 0.2.0 → 0.4.0

package/dist/types.d.ts

@@ -1,6 +1,4 @@
-import { AnyColumn, Table } from 'drizzle-orm';
 import { SchemaComments } from './parser/comments';
-export type { AnyColumn, Table };
 /**
  * Options for DBML generation
  */
@@ -9,8 +7,6 @@ export interface GenerateOptions<TSchema extends Record<string, unknown>> {
     schema: TSchema;
     /** Output file path. If provided, DBML will be written to this file */
     out?: string;
-    /** If true, uses relations() definitions instead of foreign keys for references */
-    relational?: boolean;
     /**
      * Path to the source schema file or directory for extracting JSDoc comments and relations.
      * If a directory is provided, all .ts files will be processed recursively.
@@ -23,10 +19,6 @@ export interface GenerateOptions<TSchema extends Record<string, unknown>> {
      */
     comments?: SchemaComments;
 }
-/**
- * Supported relation types in DBML
- */
-export type RelationType = "one-to-one" | "one-to-many" | "many-to-one";
 /**
  * Internal representation of a reference/relationship
  */
@@ -40,14 +32,134 @@ export interface GeneratedRef {
     onUpdate?: string;
 }
 /**
- * Column constraint attributes for DBML output
+ * Supported database types
+ *
+ * @remarks
+ * TODO: Unify with `Dialect` type in `src/cli/index.ts` when implementing CLI --format option (#59)
+ */
+export type DatabaseType = "postgresql" | "mysql" | "sqlite";
+/**
+ * Column definition in the intermediate schema
+ */
+export interface ColumnDefinition {
+    /** Column name */
+    name: string;
+    /** SQL data type (e.g., "varchar(255)", "integer", "timestamp") */
+    type: string;
+    /** Whether the column allows NULL values */
+    nullable: boolean;
+    /** Default value expression (e.g., "now()", "'active'") */
+    defaultValue?: string;
+    /** Whether this column is a primary key */
+    primaryKey: boolean;
+    /** Whether this column has a unique constraint */
+    unique: boolean;
+    /** Whether this column auto-increments */
+    autoIncrement?: boolean;
+    /** JSDoc comment or description for this column */
+    comment?: string;
+}
+/**
+ * Index definition in the intermediate schema
+ */
+export interface IndexDefinition {
+    /** Index name */
+    name: string;
+    /** Columns included in the index */
+    columns: string[];
+    /** Whether this is a unique index */
+    unique: boolean;
+    /** Index type (e.g., "btree", "hash", "gin") - database specific */
+    type?: string;
+}
+/**
+ * Constraint types
+ */
+export type ConstraintType = "primary_key" | "foreign_key" | "unique" | "check" | "not_null";
+/**
+ * Constraint definition in the intermediate schema
+ */
+export interface ConstraintDefinition {
+    /** Constraint name */
+    name: string;
+    /** Type of constraint */
+    type: ConstraintType;
+    /** Columns involved in the constraint */
+    columns: string[];
+    /** SQL definition or expression (for CHECK constraints) */
+    definition?: string;
+    /** Referenced table (for foreign keys) */
+    referencedTable?: string;
+    /** Referenced columns (for foreign keys) */
+    referencedColumns?: string[];
+}
+/**
+ * Table definition in the intermediate schema
+ */
+export interface TableDefinition {
+    /** Table name */
+    name: string;
+    /** Schema name (e.g., "public" for PostgreSQL) */
+    schema?: string;
+    /** JSDoc comment or description for this table */
+    comment?: string;
+    /** Column definitions */
+    columns: ColumnDefinition[];
+    /** Index definitions */
+    indexes: IndexDefinition[];
+    /** Constraint definitions */
+    constraints: ConstraintDefinition[];
+}
+/**
+ * Relation types for intermediate schema
+ */
+export type IntermediateRelationType = "one-to-one" | "one-to-many" | "many-to-one" | "many-to-many";
+/**
+ * Relation/Reference definition in the intermediate schema
+ */
+export interface RelationDefinition {
+    /** Optional relation name */
+    name?: string;
+    /** Source table name */
+    fromTable: string;
+    /** Source column names */
+    fromColumns: string[];
+    /** Target table name */
+    toTable: string;
+    /** Target column names */
+    toColumns: string[];
+    /** Relation cardinality */
+    type: IntermediateRelationType;
+    /** ON DELETE action */
+    onDelete?: string;
+    /** ON UPDATE action */
+    onUpdate?: string;
+}
+/**
+ * Enum definition in the intermediate schema (PostgreSQL specific)
+ */
+export interface EnumDefinition {
+    /** Enum type name */
+    name: string;
+    /** Schema name (e.g., "public" for PostgreSQL) */
+    schema?: string;
+    /** Enum values */
+    values: string[];
+}
+/**
+ * The complete intermediate schema representation
+ *
+ * This is a database-agnostic representation of a schema that can be
+ * used to generate various output formats (DBML, Markdown, JSON, etc.)
  */
-export interface ColumnAttributes {
-    primaryKey?: boolean;
-    notNull?: boolean;
-    unique?: boolean;
-    increment?: boolean;
-    default?: string;
-    note?: string;
+export interface IntermediateSchema {
+    /** Database type that this schema was extracted from */
+    databaseType: DatabaseType;
+    /** Table definitions */
+    tables: TableDefinition[];
+    /** Relation/Reference definitions */
+    relations: RelationDefinition[];
+    /** Enum definitions (PostgreSQL specific) */
+    enums: EnumDefinition[];
 }
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAGxD,YAAY,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;AAEjC;;GAEG;AACH,MAAM,WAAW,eAAe,CAAC,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACtE,2EAA2E;IAC3E,MAAM,EAAE,OAAO,CAAC;IAChB,uEAAuE;IACvE,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,mFAAmF;IACnF,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,YAAY,GAAG,aAAa,GAAG,aAAa,CAAC;AAExE;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,IAAI,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,eAAe,CAAC,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACtE,2EAA2E;IAC3E,MAAM,EAAE,OAAO,CAAC;IAChB,uEAAuE;IACvE,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,IAAI,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAQD;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,YAAY,GAAG,OAAO,GAAG,QAAQ,CAAC;AAE7D;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,kBAAkB;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,mEAAmE;IACnE,IAAI,EAAE,MAAM,CAAC;IACb,4CAA4C;IAC5C,QAAQ,EAAE,OAAO,CAAC;IAClB,2DAA2D;IAC3D,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,2CAA2C;IAC3C,UAAU,EAAE,OAAO,CAAC;IACpB,kDAAkD;IAClD,MAAM,EAAE,OAAO,CAAC;IAChB,0CAA0C;IAC1C,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,mDAAmD;IACnD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,oCAAoC;IACpC,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,qCAAqC;IACrC,MAAM,EAAE,OAAO,CAAC;IAChB,oEAAoE;IACpE,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG,aAAa,GAAG,QAAQ,GAAG,OAAO,GAAG,UAAU,CAAC;AAE7F;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,sBAAsB;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,yBAAyB;IACzB,IAAI,EAAE,cAAc,CAAC;IACrB,yCAAyC;IACzC,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,2DAA2D;IAC3D,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,0CAA0C;IAC1C,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,4CAA4C;IAC5C,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,kDAAkD;IAClD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kDAAkD;IAClD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yBAAyB;IACzB,OAAO,EAAE,gBAAgB,EAAE,CAAC;IAC5B,wBAAwB;IACxB,OAAO,EAAE,eAAe,EAAE,CAAC;IAC3B,6BAA6B;IAC7B,WAAW,EAAE,oBAAoB,EAAE,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAChC,YAAY,GACZ,aAAa,GACb,aAAa,GACb,cAAc,CAAC;AAEnB;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,6BAA6B;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,wBAAwB;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,0BAA0B;IAC1B,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,wBAAwB;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,0BAA0B;IAC1B,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,2BAA2B;IAC3B,IAAI,EAAE,wBAAwB,CAAC;IAC/B,uBAAuB;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,uBAAuB;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,qBAAqB;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,kDAAkD;IAClD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kBAAkB;IAClB,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,wDAAwD;IACxD,YAAY,EAAE,YAAY,CAAC;IAC3B,wBAAwB;IACxB,MAAM,EAAE,eAAe,EAAE,CAAC;IAC1B,qCAAqC;IACrC,SAAS,EAAE,kBAAkB,EAAE,CAAC;IAChC,6CAA6C;IAC7C,KAAK,EAAE,cAAc,EAAE,CAAC;CACzB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "drizzle-docs-generator",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "A CLI tool that generates DBML files from Drizzle ORM schema definitions.",
   "keywords": [
     "cli",
@@ -65,6 +65,7 @@
     "lint": "oxlint",
     "format": "oxfmt --write",
     "format:check": "oxfmt --check",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "tsc --noEmit",
+    "generate:examples": "node dist/cli/index.js generate examples/pg/schema.ts -d postgresql -f dbml -o examples/pg/schema.dbml --force && node dist/cli/index.js generate examples/pg/schema.ts -d postgresql -f markdown -o examples/pg/markdown --force && node dist/cli/index.js generate examples/mysql/schema.ts -d mysql -f dbml -o examples/mysql/schema.dbml --force && node dist/cli/index.js generate examples/mysql/schema.ts -d mysql -f markdown -o examples/mysql/markdown --force && node dist/cli/index.js generate examples/sqlite/schema.ts -d sqlite -f dbml -o examples/sqlite/schema.dbml --force && node dist/cli/index.js generate examples/sqlite/schema.ts -d sqlite -f markdown -o examples/sqlite/markdown --force"
   }
 }

package/dist/generator/index.d.ts

@@ -1,15 +0,0 @@
-/**
- * DBML Generator Module
- *
- * Provides functions to generate DBML from Drizzle ORM schema definitions.
- * Supports PostgreSQL, MySQL, and SQLite dialects.
- *
- * JSDoc comments can be extracted from source files and included as DBML Note clauses.
- * Use the `source` option to specify the schema source file or directory, or pass pre-extracted
- * comments via the `comments` option.
- */
-export { pgGenerate, PgGenerator } from './pg';
-export { mysqlGenerate, MySqlGenerator } from './mysql';
-export { sqliteGenerate, SqliteGenerator } from './sqlite';
-export { BaseGenerator, DbmlBuilder, writeDbmlFile } from './common';
-//# sourceMappingURL=index.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/generator/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,MAAM,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC"}

package/dist/parser/index.d.ts

@@ -1,5 +0,0 @@
-export { extractComments } from './comments';
-export type { SchemaComments, TableComment, ColumnComment } from './comments';
-export { extractRelations } from './relations';
-export type { ParsedRelation, SchemaRelations } from './relations';
-//# sourceMappingURL=index.d.ts.map

package/dist/parser/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/parser/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC7C,YAAY,EAAE,cAAc,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAG9E,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/C,YAAY,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC"}

package/dist/test-utils/index.d.ts

@@ -1,7 +0,0 @@
-/**
- * Test utilities for integration testing
- */
-export { runCli, runGenerate } from './cli-runner.js';
-export type { CliResult } from './cli-runner.js';
-export { hasAllTables, hasAllColumns, hasReference, hasIndexes, hasTableNote, countTables, countRefs, } from './dbml-validator.js';
-//# sourceMappingURL=index.d.ts.map

package/dist/test-utils/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/test-utils/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACtD,YAAY,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EACL,YAAY,EACZ,aAAa,EACb,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,WAAW,EACX,SAAS,GACV,MAAM,qBAAqB,CAAC"}