drizzle-docs-generator 0.1.1 → 0.3.0

package/dist/formatter/mermaid.d.ts

@@ -0,0 +1,102 @@
+import { IntermediateSchema } from '../types';
+import { OutputFormatter, FormatterOptions } from './types';
+/**
+ * Options for MermaidErDiagramFormatter
+ */
+export interface MermaidFormatterOptions extends FormatterOptions {
+    /**
+     * Whether to include column types in the diagram
+     * @default true
+     */
+    includeColumnTypes?: boolean;
+}
+/**
+ * MermaidErDiagramFormatter generates Mermaid ER diagram syntax from IntermediateSchema
+ *
+ * This formatter creates Mermaid-compatible ER diagrams that can be rendered
+ * in GitHub, GitLab, or any Mermaid-supporting platform.
+ *
+ * @example
+ * ```typescript
+ * const formatter = new MermaidErDiagramFormatter();
+ * const mermaid = formatter.format(schema);
+ * // Output:
+ * // erDiagram
+ * //     users ||--o{ posts : "author_id"
+ * //     users {
+ * //         int id PK
+ * //         varchar username
+ * //     }
+ * ```
+ *
+ * @see https://mermaid.js.org/syntax/entityRelationshipDiagram.html
+ */
+export declare class MermaidErDiagramFormatter implements OutputFormatter {
+    private options;
+    /**
+     * Create a new MermaidErDiagramFormatter
+     *
+     * @param options - Formatter options
+     */
+    constructor(options?: MermaidFormatterOptions);
+    /**
+     * Format the intermediate schema into a Mermaid ER diagram
+     *
+     * @param schema - The intermediate schema to format
+     * @returns Mermaid ER diagram string
+     */
+    format(schema: IntermediateSchema): string;
+    /**
+     * Format a focused ER diagram showing only a specific table and its related tables
+     *
+     * @param schema - The intermediate schema
+     * @param tableName - The name of the table to focus on
+     * @returns Mermaid ER diagram string showing only the focused table and its relations
+     */
+    formatFocused(schema: IntermediateSchema, tableName: string): string;
+    /**
+     * Collect foreign key columns from relations for FK marker assignment
+     */
+    private collectForeignKeyColumns;
+    /**
+     * Format a table definition to Mermaid syntax
+     */
+    private formatTable;
+    /**
+     * Format a column definition to Mermaid syntax
+     */
+    private formatColumn;
+    /**
+     * Simplify SQL type for Mermaid display
+     *
+     * Mermaid ER diagrams work best with simple type names
+     */
+    private simplifyType;
+    /**
+     * Format a relation definition to Mermaid syntax
+     *
+     * Mermaid ER diagram relation syntax:
+     * - ||--|| : one-to-one
+     * - ||--o{ : one-to-many
+     * - }o--|| : many-to-one
+     * - }o--o{ : many-to-many
+     */
+    private formatRelation;
+    /**
+     * Convert IntermediateRelationType to Mermaid relation symbol
+     *
+     * @see https://mermaid.js.org/syntax/entityRelationshipDiagram.html#relationship-syntax
+     */
+    private getRelationSymbol;
+    /**
+     * Escape a name for Mermaid if it contains special characters
+     *
+     * Mermaid entity names should be alphanumeric with underscores
+     */
+    private escapeName;
+    /**
+     * Escape a string for use in Mermaid quoted strings
+     */
+    private escapeString;
+}
+//# sourceMappingURL=mermaid.d.ts.map

package/dist/formatter/mermaid.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mermaid.d.ts","sourceRoot":"","sources":["../../src/formatter/mermaid.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,EAInB,MAAM,UAAU,CAAC;AAClB,OAAO,KAAK,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAEjE;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,gBAAgB;IAC/D;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAYD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,yBAA0B,YAAW,eAAe;IAC/D,OAAO,CAAC,OAAO,CAAoC;IAEnD;;;;OAIG;gBACS,OAAO,GAAE,uBAA4B;IAIjD;;;;;OAKG;IACH,MAAM,CAAC,MAAM,EAAE,kBAAkB,GAAG,MAAM;IA4B1C;;;;;;OAMG;IACH,aAAa,CAAC,MAAM,EAAE,kBAAkB,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM;IAiDpE;;OAEG;IACH,OAAO,CAAC,wBAAwB;IAgBhC;;OAEG;IACH,OAAO,CAAC,WAAW;IAiBnB;;OAEG;IACH,OAAO,CAAC,YAAY;IAmCpB;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAkCpB;;;;;;;;OAQG;IACH,OAAO,CAAC,cAAc;IAStB;;;;OAIG;IACH,OAAO,CAAC,iBAAiB;IAazB;;;;OAIG;IACH,OAAO,CAAC,UAAU;IAUlB;;OAEG;IACH,OAAO,CAAC,YAAY;CAGrB"}

package/dist/formatter/mermaid.js

@@ -0,0 +1,177 @@
+const c = {
+  includeComments: !0,
+  includeIndexes: !0,
+  includeConstraints: !0,
+  includeColumnTypes: !0
+};
+class f {
+  options;
+  /**
+   * Create a new MermaidErDiagramFormatter
+   *
+   * @param options - Formatter options
+   */
+  constructor(e = {}) {
+    this.options = { ...c, ...e };
+  }
+  /**
+   * Format the intermediate schema into a Mermaid ER diagram
+   *
+   * @param schema - The intermediate schema to format
+   * @returns Mermaid ER diagram string
+   */
+  format(e) {
+    const t = ["erDiagram"], o = this.collectForeignKeyColumns(e.relations);
+    for (const n of e.relations) {
+      const s = this.formatRelation(n);
+      s && t.push(`    ${s}`);
+    }
+    e.relations.length > 0 && e.tables.length > 0 && t.push("");
+    for (const n of e.tables) {
+      const s = this.formatTable(n, o);
+      t.push(...s);
+    }
+    return t.join(`
+`);
+  }
+  /**
+   * Format a focused ER diagram showing only a specific table and its related tables
+   *
+   * @param schema - The intermediate schema
+   * @param tableName - The name of the table to focus on
+   * @returns Mermaid ER diagram string showing only the focused table and its relations
+   */
+  formatFocused(e, t) {
+    if (!e.tables.find((a) => a.name === t))
+      return "erDiagram";
+    const n = /* @__PURE__ */ new Set([t]), s = [];
+    for (const a of e.relations)
+      (a.fromTable === t || a.toTable === t) && (n.add(a.fromTable), n.add(a.toTable), s.push(a));
+    const r = e.tables.filter((a) => n.has(a.name)), m = this.collectForeignKeyColumns(s), i = ["erDiagram"];
+    for (const a of s) {
+      const l = this.formatRelation(a);
+      l && i.push(`    ${l}`);
+    }
+    s.length > 0 && r.length > 0 && i.push("");
+    for (const a of r) {
+      const l = this.formatTable(a, m);
+      i.push(...l);
+    }
+    return i.join(`
+`);
+  }
+  /**
+   * Collect foreign key columns from relations for FK marker assignment
+   */
+  collectForeignKeyColumns(e) {
+    const t = /* @__PURE__ */ new Map();
+    for (const o of e) {
+      t.has(o.fromTable) || t.set(o.fromTable, /* @__PURE__ */ new Set());
+      for (const n of o.fromColumns)
+        t.get(o.fromTable).add(n);
+    }
+    return t;
+  }
+  /**
+   * Format a table definition to Mermaid syntax
+   */
+  formatTable(e, t) {
+    const o = [], n = this.escapeName(e.name), s = t.get(e.name) || /* @__PURE__ */ new Set();
+    o.push(`    ${n} {`);
+    for (const r of e.columns) {
+      const m = this.formatColumn(r, s);
+      o.push(`        ${m}`);
+    }
+    return o.push("    }"), o;
+  }
+  /**
+   * Format a column definition to Mermaid syntax
+   */
+  formatColumn(e, t) {
+    const o = [];
+    this.options.includeColumnTypes && o.push(this.simplifyType(e.type)), o.push(this.escapeName(e.name));
+    const n = [];
+    return e.primaryKey && n.push("PK"), t.has(e.name) && n.push("FK"), e.unique && !e.primaryKey && n.push("UK"), n.length > 0 && o.push(n.join(",")), this.options.includeComments && e.comment && o.push(`"${this.escapeString(e.comment)}"`), o.join(" ");
+  }
+  /**
+   * Simplify SQL type for Mermaid display
+   *
+   * Mermaid ER diagrams work best with simple type names
+   */
+  simplifyType(e) {
+    const t = e.replace(/\([^)]*\)/g, "").toLowerCase();
+    return {
+      integer: "int",
+      bigint: "bigint",
+      smallint: "smallint",
+      serial: "serial",
+      bigserial: "bigserial",
+      text: "text",
+      varchar: "varchar",
+      char: "char",
+      boolean: "boolean",
+      timestamp: "timestamp",
+      timestamptz: "timestamptz",
+      date: "date",
+      time: "time",
+      json: "json",
+      jsonb: "jsonb",
+      uuid: "uuid",
+      real: "real",
+      float: "float",
+      double: "double",
+      decimal: "decimal",
+      numeric: "numeric",
+      blob: "blob",
+      bytea: "bytea"
+    }[t] || t;
+  }
+  /**
+   * Format a relation definition to Mermaid syntax
+   *
+   * Mermaid ER diagram relation syntax:
+   * - ||--|| : one-to-one
+   * - ||--o{ : one-to-many
+   * - }o--|| : many-to-one
+   * - }o--o{ : many-to-many
+   */
+  formatRelation(e) {
+    const t = this.escapeName(e.fromTable), o = this.escapeName(e.toTable), n = this.getRelationSymbol(e.type), s = e.fromColumns.join(", ");
+    return `${t} ${n} ${o} : "${s}"`;
+  }
+  /**
+   * Convert IntermediateRelationType to Mermaid relation symbol
+   *
+   * @see https://mermaid.js.org/syntax/entityRelationshipDiagram.html#relationship-syntax
+   */
+  getRelationSymbol(e) {
+    switch (e) {
+      case "one-to-one":
+        return "||--||";
+      case "one-to-many":
+        return "||--o{";
+      case "many-to-one":
+        return "}o--||";
+      case "many-to-many":
+        return "}o--o{";
+    }
+  }
+  /**
+   * Escape a name for Mermaid if it contains special characters
+   *
+   * Mermaid entity names should be alphanumeric with underscores
+   */
+  escapeName(e) {
+    return /^[a-zA-Z_][a-zA-Z0-9_]*$/.test(e) ? e : e.replace(/[^a-zA-Z0-9_]/g, "_");
+  }
+  /**
+   * Escape a string for use in Mermaid quoted strings
+   */
+  escapeString(e) {
+    return e.replace(/\\/g, "\\\\").replace(/"/g, '\\"').replace(/\n/g, " ");
+  }
+}
+export {
+  f as MermaidErDiagramFormatter
+};
+//# sourceMappingURL=mermaid.js.map

package/dist/formatter/mermaid.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mermaid.js","sources":["../../src/formatter/mermaid.ts"],"sourcesContent":["import type {\n  IntermediateSchema,\n  TableDefinition,\n  ColumnDefinition,\n  RelationDefinition,\n} from \"../types\";\nimport type { OutputFormatter, FormatterOptions } from \"./types\";\n\n/**\n * Options for MermaidErDiagramFormatter\n */\nexport interface MermaidFormatterOptions extends FormatterOptions {\n  /**\n   * Whether to include column types in the diagram\n   * @default true\n   */\n  includeColumnTypes?: boolean;\n}\n\n/**\n * Default formatter options\n */\nconst DEFAULT_OPTIONS: Required<MermaidFormatterOptions> = {\n  includeComments: true,\n  includeIndexes: true,\n  includeConstraints: true,\n  includeColumnTypes: true,\n};\n\n/**\n * MermaidErDiagramFormatter generates Mermaid ER diagram syntax from IntermediateSchema\n *\n * This formatter creates Mermaid-compatible ER diagrams that can be rendered\n * in GitHub, GitLab, or any Mermaid-supporting platform.\n *\n * @example\n * ```typescript\n * const formatter = new MermaidErDiagramFormatter();\n * const mermaid = formatter.format(schema);\n * // Output:\n * // erDiagram\n * //     users ||--o{ posts : \"author_id\"\n * //     users {\n * //         int id PK\n * //         varchar username\n * //     }\n * ```\n *\n * @see https://mermaid.js.org/syntax/entityRelationshipDiagram.html\n */\nexport class MermaidErDiagramFormatter implements OutputFormatter {\n  private options: Required<MermaidFormatterOptions>;\n\n  /**\n   * Create a new MermaidErDiagramFormatter\n   *\n   * @param options - Formatter options\n   */\n  constructor(options: MermaidFormatterOptions = {}) {\n    this.options = { ...DEFAULT_OPTIONS, ...options };\n  }\n\n  /**\n   * Format the intermediate schema into a Mermaid ER diagram\n   *\n   * @param schema - The intermediate schema to format\n   * @returns Mermaid ER diagram string\n   */\n  format(schema: IntermediateSchema): string {\n    const lines: string[] = [\"erDiagram\"];\n\n    // Collect foreign key columns for FK markers\n    const fkColumns = this.collectForeignKeyColumns(schema.relations);\n\n    // Generate relations first (at the top of the diagram)\n    for (const relation of schema.relations) {\n      const relationLine = this.formatRelation(relation);\n      if (relationLine) {\n        lines.push(`    ${relationLine}`);\n      }\n    }\n\n    // Add blank line between relations and tables if there are both\n    if (schema.relations.length > 0 && schema.tables.length > 0) {\n      lines.push(\"\");\n    }\n\n    // Generate tables\n    for (const table of schema.tables) {\n      const tableLines = this.formatTable(table, fkColumns);\n      lines.push(...tableLines);\n    }\n\n    return lines.join(\"\\n\");\n  }\n\n  /**\n   * Format a focused ER diagram showing only a specific table and its related tables\n   *\n   * @param schema - The intermediate schema\n   * @param tableName - The name of the table to focus on\n   * @returns Mermaid ER diagram string showing only the focused table and its relations\n   */\n  formatFocused(schema: IntermediateSchema, tableName: string): string {\n    // Find the target table\n    const targetTable = schema.tables.find((t) => t.name === tableName);\n    if (!targetTable) {\n      return \"erDiagram\";\n    }\n\n    // Find related tables through relations\n    const relatedTableNames = new Set<string>([tableName]);\n    const relevantRelations: RelationDefinition[] = [];\n\n    for (const relation of schema.relations) {\n      if (relation.fromTable === tableName || relation.toTable === tableName) {\n        relatedTableNames.add(relation.fromTable);\n        relatedTableNames.add(relation.toTable);\n        relevantRelations.push(relation);\n      }\n    }\n\n    // Filter tables to only include related ones\n    const relevantTables = schema.tables.filter((t) => relatedTableNames.has(t.name));\n\n    // Collect foreign key columns for FK markers\n    const fkColumns = this.collectForeignKeyColumns(relevantRelations);\n\n    const lines: string[] = [\"erDiagram\"];\n\n    // Generate relations\n    for (const relation of relevantRelations) {\n      const relationLine = this.formatRelation(relation);\n      if (relationLine) {\n        lines.push(`    ${relationLine}`);\n      }\n    }\n\n    // Add blank line between relations and tables if there are both\n    if (relevantRelations.length > 0 && relevantTables.length > 0) {\n      lines.push(\"\");\n    }\n\n    // Generate tables\n    for (const table of relevantTables) {\n      const tableLines = this.formatTable(table, fkColumns);\n      lines.push(...tableLines);\n    }\n\n    return lines.join(\"\\n\");\n  }\n\n  /**\n   * Collect foreign key columns from relations for FK marker assignment\n   */\n  private collectForeignKeyColumns(relations: RelationDefinition[]): Map<string, Set<string>> {\n    const fkColumns = new Map<string, Set<string>>();\n\n    for (const relation of relations) {\n      // The \"from\" side of the relation has the FK column\n      if (!fkColumns.has(relation.fromTable)) {\n        fkColumns.set(relation.fromTable, new Set());\n      }\n      for (const col of relation.fromColumns) {\n        fkColumns.get(relation.fromTable)!.add(col);\n      }\n    }\n\n    return fkColumns;\n  }\n\n  /**\n   * Format a table definition to Mermaid syntax\n   */\n  private formatTable(table: TableDefinition, fkColumns: Map<string, Set<string>>): string[] {\n    const lines: string[] = [];\n    const tableName = this.escapeName(table.name);\n    const tableFkColumns = fkColumns.get(table.name) || new Set();\n\n    lines.push(`    ${tableName} {`);\n\n    for (const column of table.columns) {\n      const columnLine = this.formatColumn(column, tableFkColumns);\n      lines.push(`        ${columnLine}`);\n    }\n\n    lines.push(\"    }\");\n\n    return lines;\n  }\n\n  /**\n   * Format a column definition to Mermaid syntax\n   */\n  private formatColumn(column: ColumnDefinition, fkColumns: Set<string>): string {\n    const parts: string[] = [];\n\n    // Column type (simplified for Mermaid)\n    if (this.options.includeColumnTypes) {\n      parts.push(this.simplifyType(column.type));\n    }\n\n    // Column name\n    parts.push(this.escapeName(column.name));\n\n    // PK/FK markers\n    const markers: string[] = [];\n    if (column.primaryKey) {\n      markers.push(\"PK\");\n    }\n    if (fkColumns.has(column.name)) {\n      markers.push(\"FK\");\n    }\n    if (column.unique && !column.primaryKey) {\n      markers.push(\"UK\");\n    }\n\n    if (markers.length > 0) {\n      parts.push(markers.join(\",\"));\n    }\n\n    // Add comment as Mermaid comment (quoted string after markers)\n    if (this.options.includeComments && column.comment) {\n      parts.push(`\"${this.escapeString(column.comment)}\"`);\n    }\n\n    return parts.join(\" \");\n  }\n\n  /**\n   * Simplify SQL type for Mermaid display\n   *\n   * Mermaid ER diagrams work best with simple type names\n   */\n  private simplifyType(type: string): string {\n    // Remove parentheses content for cleaner display (e.g., varchar(255) -> varchar)\n    const simplified = type.replace(/\\([^)]*\\)/g, \"\").toLowerCase();\n\n    // Map common types to shorter versions\n    const typeMap: Record<string, string> = {\n      integer: \"int\",\n      bigint: \"bigint\",\n      smallint: \"smallint\",\n      serial: \"serial\",\n      bigserial: \"bigserial\",\n      text: \"text\",\n      varchar: \"varchar\",\n      char: \"char\",\n      boolean: \"boolean\",\n      timestamp: \"timestamp\",\n      timestamptz: \"timestamptz\",\n      date: \"date\",\n      time: \"time\",\n      json: \"json\",\n      jsonb: \"jsonb\",\n      uuid: \"uuid\",\n      real: \"real\",\n      float: \"float\",\n      double: \"double\",\n      decimal: \"decimal\",\n      numeric: \"numeric\",\n      blob: \"blob\",\n      bytea: \"bytea\",\n    };\n\n    return typeMap[simplified] || simplified;\n  }\n\n  /**\n   * Format a relation definition to Mermaid syntax\n   *\n   * Mermaid ER diagram relation syntax:\n   * - ||--|| : one-to-one\n   * - ||--o{ : one-to-many\n   * - }o--|| : many-to-one\n   * - }o--o{ : many-to-many\n   */\n  private formatRelation(relation: RelationDefinition): string {\n    const fromTable = this.escapeName(relation.fromTable);\n    const toTable = this.escapeName(relation.toTable);\n    const symbol = this.getRelationSymbol(relation.type);\n    const label = relation.fromColumns.join(\", \");\n\n    return `${fromTable} ${symbol} ${toTable} : \"${label}\"`;\n  }\n\n  /**\n   * Convert IntermediateRelationType to Mermaid relation symbol\n   *\n   * @see https://mermaid.js.org/syntax/entityRelationshipDiagram.html#relationship-syntax\n   */\n  private getRelationSymbol(type: RelationDefinition[\"type\"]): string {\n    switch (type) {\n      case \"one-to-one\":\n        return \"||--||\";\n      case \"one-to-many\":\n        return \"||--o{\";\n      case \"many-to-one\":\n        return \"}o--||\";\n      case \"many-to-many\":\n        return \"}o--o{\";\n    }\n  }\n\n  /**\n   * Escape a name for Mermaid if it contains special characters\n   *\n   * Mermaid entity names should be alphanumeric with underscores\n   */\n  private escapeName(name: string): string {\n    // Mermaid accepts alphanumeric and underscores\n    // For names with special characters, we need to quote them\n    if (/^[a-zA-Z_][a-zA-Z0-9_]*$/.test(name)) {\n      return name;\n    }\n    // Replace special characters with underscores for Mermaid compatibility\n    return name.replace(/[^a-zA-Z0-9_]/g, \"_\");\n  }\n\n  /**\n   * Escape a string for use in Mermaid quoted strings\n   */\n  private escapeString(str: string): string {\n    return str.replace(/\\\\/g, \"\\\\\\\\\").replace(/\"/g, '\\\\\"').replace(/\\n/g, \" \");\n  }\n}\n"],"names":["DEFAULT_OPTIONS","MermaidErDiagramFormatter","options","schema","lines","fkColumns","relation","relationLine","table","tableLines","tableName","t","relatedTableNames","relevantRelations","relevantTables","relations","col","tableFkColumns","column","columnLine","parts","markers","type","simplified","fromTable","toTable","symbol","label","name","str"],"mappings":"AAsBA,MAAMA,IAAqD;AAAA,EACzD,iBAAiB;AAAA,EACjB,gBAAgB;AAAA,EAChB,oBAAoB;AAAA,EACpB,oBAAoB;AACtB;AAuBO,MAAMC,EAAqD;AAAA,EACxD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOR,YAAYC,IAAmC,IAAI;AACjD,SAAK,UAAU,EAAE,GAAGF,GAAiB,GAAGE,EAAA;AAAA,EAC1C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,OAAOC,GAAoC;AACzC,UAAMC,IAAkB,CAAC,WAAW,GAG9BC,IAAY,KAAK,yBAAyBF,EAAO,SAAS;AAGhE,eAAWG,KAAYH,EAAO,WAAW;AACvC,YAAMI,IAAe,KAAK,eAAeD,CAAQ;AACjD,MAAIC,KACFH,EAAM,KAAK,OAAOG,CAAY,EAAE;AAAA,IAEpC;AAGA,IAAIJ,EAAO,UAAU,SAAS,KAAKA,EAAO,OAAO,SAAS,KACxDC,EAAM,KAAK,EAAE;AAIf,eAAWI,KAASL,EAAO,QAAQ;AACjC,YAAMM,IAAa,KAAK,YAAYD,GAAOH,CAAS;AACpD,MAAAD,EAAM,KAAK,GAAGK,CAAU;AAAA,IAC1B;AAEA,WAAOL,EAAM,KAAK;AAAA,CAAI;AAAA,EACxB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,cAAcD,GAA4BO,GAA2B;AAGnE,QAAI,CADgBP,EAAO,OAAO,KAAK,CAACQ,MAAMA,EAAE,SAASD,CAAS;AAEhE,aAAO;AAIT,UAAME,IAAoB,oBAAI,IAAY,CAACF,CAAS,CAAC,GAC/CG,IAA0C,CAAA;AAEhD,eAAWP,KAAYH,EAAO;AAC5B,OAAIG,EAAS,cAAcI,KAAaJ,EAAS,YAAYI,OAC3DE,EAAkB,IAAIN,EAAS,SAAS,GACxCM,EAAkB,IAAIN,EAAS,OAAO,GACtCO,EAAkB,KAAKP,CAAQ;AAKnC,UAAMQ,IAAiBX,EAAO,OAAO,OAAO,CAACQ,MAAMC,EAAkB,IAAID,EAAE,IAAI,CAAC,GAG1EN,IAAY,KAAK,yBAAyBQ,CAAiB,GAE3DT,IAAkB,CAAC,WAAW;AAGpC,eAAWE,KAAYO,GAAmB;AACxC,YAAMN,IAAe,KAAK,eAAeD,CAAQ;AACjD,MAAIC,KACFH,EAAM,KAAK,OAAOG,CAAY,EAAE;AAAA,IAEpC;AAGA,IAAIM,EAAkB,SAAS,KAAKC,EAAe,SAAS,KAC1DV,EAAM,KAAK,EAAE;AAIf,eAAWI,KAASM,GAAgB;AAClC,YAAML,IAAa,KAAK,YAAYD,GAAOH,CAAS;AACpD,MAAAD,EAAM,KAAK,GAAGK,CAAU;AAAA,IAC1B;AAEA,WAAOL,EAAM,KAAK;AAAA,CAAI;AAAA,EACxB;AAAA;AAAA;AAAA;AAAA,EAKQ,yBAAyBW,GAA2D;AAC1F,UAAMV,wBAAgB,IAAA;AAEtB,eAAWC,KAAYS,GAAW;AAEhC,MAAKV,EAAU,IAAIC,EAAS,SAAS,KACnCD,EAAU,IAAIC,EAAS,WAAW,oBAAI,KAAK;AAE7C,iBAAWU,KAAOV,EAAS;AACzB,QAAAD,EAAU,IAAIC,EAAS,SAAS,EAAG,IAAIU,CAAG;AAAA,IAE9C;AAEA,WAAOX;AAAA,EACT;AAAA;AAAA;AAAA;AAAA,EAKQ,YAAYG,GAAwBH,GAA+C;AACzF,UAAMD,IAAkB,CAAA,GAClBM,IAAY,KAAK,WAAWF,EAAM,IAAI,GACtCS,IAAiBZ,EAAU,IAAIG,EAAM,IAAI,yBAAS,IAAA;AAExD,IAAAJ,EAAM,KAAK,OAAOM,CAAS,IAAI;AAE/B,eAAWQ,KAAUV,EAAM,SAAS;AAClC,YAAMW,IAAa,KAAK,aAAaD,GAAQD,CAAc;AAC3D,MAAAb,EAAM,KAAK,WAAWe,CAAU,EAAE;AAAA,IACpC;AAEA,WAAAf,EAAM,KAAK,OAAO,GAEXA;AAAA,EACT;AAAA;AAAA;AAAA;AAAA,EAKQ,aAAac,GAA0Bb,GAAgC;AAC7E,UAAMe,IAAkB,CAAA;AAGxB,IAAI,KAAK,QAAQ,sBACfA,EAAM,KAAK,KAAK,aAAaF,EAAO,IAAI,CAAC,GAI3CE,EAAM,KAAK,KAAK,WAAWF,EAAO,IAAI,CAAC;AAGvC,UAAMG,IAAoB,CAAA;AAC1B,WAAIH,EAAO,cACTG,EAAQ,KAAK,IAAI,GAEfhB,EAAU,IAAIa,EAAO,IAAI,KAC3BG,EAAQ,KAAK,IAAI,GAEfH,EAAO,UAAU,CAACA,EAAO,cAC3BG,EAAQ,KAAK,IAAI,GAGfA,EAAQ,SAAS,KACnBD,EAAM,KAAKC,EAAQ,KAAK,GAAG,CAAC,GAI1B,KAAK,QAAQ,mBAAmBH,EAAO,WACzCE,EAAM,KAAK,IAAI,KAAK,aAAaF,EAAO,OAAO,CAAC,GAAG,GAG9CE,EAAM,KAAK,GAAG;AAAA,EACvB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOQ,aAAaE,GAAsB;AAEzC,UAAMC,IAAaD,EAAK,QAAQ,cAAc,EAAE,EAAE,YAAA;AA6BlD,WA1BwC;AAAA,MACtC,SAAS;AAAA,MACT,QAAQ;AAAA,MACR,UAAU;AAAA,MACV,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,MAAM;AAAA,MACN,SAAS;AAAA,MACT,MAAM;AAAA,MACN,SAAS;AAAA,MACT,WAAW;AAAA,MACX,aAAa;AAAA,MACb,MAAM;AAAA,MACN,MAAM;AAAA,MACN,MAAM;AAAA,MACN,OAAO;AAAA,MACP,MAAM;AAAA,MACN,MAAM;AAAA,MACN,OAAO;AAAA,MACP,QAAQ;AAAA,MACR,SAAS;AAAA,MACT,SAAS;AAAA,MACT,MAAM;AAAA,MACN,OAAO;AAAA,IAAA,EAGMC,CAAU,KAAKA;AAAA,EAChC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWQ,eAAejB,GAAsC;AAC3D,UAAMkB,IAAY,KAAK,WAAWlB,EAAS,SAAS,GAC9CmB,IAAU,KAAK,WAAWnB,EAAS,OAAO,GAC1CoB,IAAS,KAAK,kBAAkBpB,EAAS,IAAI,GAC7CqB,IAAQrB,EAAS,YAAY,KAAK,IAAI;AAE5C,WAAO,GAAGkB,CAAS,IAAIE,CAAM,IAAID,CAAO,OAAOE,CAAK;AAAA,EACtD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOQ,kBAAkBL,GAA0C;AAClE,YAAQA,GAAA;AAAA,MACN,KAAK;AACH,eAAO;AAAA,MACT,KAAK;AACH,eAAO;AAAA,MACT,KAAK;AACH,eAAO;AAAA,MACT,KAAK;AACH,eAAO;AAAA,IAAA;AAAA,EAEb;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOQ,WAAWM,GAAsB;AAGvC,WAAI,2BAA2B,KAAKA,CAAI,IAC/BA,IAGFA,EAAK,QAAQ,kBAAkB,GAAG;AAAA,EAC3C;AAAA;AAAA;AAAA;AAAA,EAKQ,aAAaC,GAAqB;AACxC,WAAOA,EAAI,QAAQ,OAAO,MAAM,EAAE,QAAQ,MAAM,KAAK,EAAE,QAAQ,OAAO,GAAG;AAAA,EAC3E;AACF;"}

package/dist/formatter/types.d.ts

@@ -0,0 +1,37 @@
+import { IntermediateSchema } from '../types';
+/**
+ * Options for output formatters
+ */
+export interface FormatterOptions {
+    /**
+     * Whether to include table/column comments in the output
+     * @default true
+     */
+    includeComments?: boolean;
+    /**
+     * Whether to include indexes in the output
+     * @default true
+     */
+    includeIndexes?: boolean;
+    /**
+     * Whether to include constraints in the output
+     * @default true
+     */
+    includeConstraints?: boolean;
+}
+/**
+ * OutputFormatter interface for generating various output formats from IntermediateSchema
+ *
+ * Implementations of this interface convert the database-agnostic IntermediateSchema
+ * representation into specific output formats (DBML, Markdown, JSON, etc.)
+ */
+export interface OutputFormatter {
+    /**
+     * Format the intermediate schema into the target output format
+     *
+     * @param schema - The intermediate schema representation to format
+     * @returns The formatted output as a string
+     */
+    format(schema: IntermediateSchema): string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/formatter/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/formatter/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;OAKG;IACH,MAAM,CAAC,MAAM,EAAE,kBAAkB,GAAG,MAAM,CAAC;CAC5C"}