ts-prorm-orm 1.2.2 → 2.0.0

package/dist/diagrams/class-diagram.js

@@ -1,9 +1,9 @@
 "use strict";
 /**
- * ClassDiagram — renders one or more classes as UML class boxes.
+ * ClassDiagram - renders one or more classes as UML class boxes.
  *
  * Each class box has three compartments:
- *  - a title bar (class name + optional «stereotype»),
+ *  - a title bar (class name + optional <<stereotype>>),
  *  - an attributes compartment (`+ name: type`, with +/-/# visibility markers),
  *  - a methods compartment (`+ name(args): returnType`).
  *
@@ -12,12 +12,8 @@
  * (hollow triangle arrowhead) is drawn to its parent; when it declares plain
  * associations, a simple line connector is drawn instead.
  *
- * `--theme light|dark` drives canvas/box/text colors and `--color <name|hex>`
- * drives the accent used for title bars — both genuinely change fill/stroke
- * values in the generated SVG.
- *
  * Usage:
- *   const diag = new ClassDiagram({ classes: [ … ] });
+ *   const diag = new ClassDiagram({ classes: [...] });
  *   diag.save('./diagrams/classes.svg');
  *   // or:
  *   const svgString = diag.generate();
@@ -59,17 +55,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ClassDiagram = void 0;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
-const palette_1 = require("./palette");
-const svg_dom_1 = require("./svg-dom");
-// ─── Industry design system ────────────────────────────────────────────────
-// Barlow / JetBrains Mono typography, hairline borders and square "blueprint"
-// corners are fixed by the Industry spec; accent + surface colours still route
-// through resolveAccent / resolveTheme so --color / --theme keep working.
-const IND_FONT_HEAD = '"Barlow Condensed", system-ui, sans-serif';
-const IND_FONT_BODY = '"Barlow", system-ui, sans-serif';
-const IND_FONT_MONO = 'ui-monospace, "JetBrains Mono", "SF Mono", Menlo, monospace';
-const IND_HAIRLINE = 'rgba(29,31,32,0.16)';
-const IND_FONT_IMPORT = "@import url('https://fonts.googleapis.com/css2?family=Barlow:wght@400;500;700&family=Barlow+Condensed:wght@400;600&family=JetBrains+Mono&display=swap');";
+const svg_1 = require("./core/svg");
+const theme_1 = require("./core/theme");
 const VIS_MARK = {
     public: '+',
     private: '-',
@@ -78,7 +65,6 @@ const VIS_MARK = {
 function visMark(v) {
     return VIS_MARK[v ?? 'public'] ?? '+';
 }
-// ─── Main class ────────────────────────────────────────────────────────────
 class ClassDiagram {
     constructor(options) {
         this.opts = {
@@ -143,11 +129,9 @@ class ClassDiagram {
         });
         return { placed, byName, cols, rowHeights };
     }
-    generate() {
-        const { title, theme, color } = this.opts;
-        const accent = (0, palette_1.resolveAccent)(color);
-        const t = (0, palette_1.resolveTheme)(theme);
-        const { placed, byName, cols } = this.layout();
+    build() {
+        const { title } = this.opts;
+        const { placed, byName } = this.layout();
         // Compute canvas bounds from placed boxes.
         let maxRight = 0;
         let maxBottom = 0;
@@ -157,52 +141,47 @@ class ClassDiagram {
         }
         const svgW = maxRight + ClassDiagram.PAD;
         const svgH = maxBottom + ClassDiagram.PAD;
-        const doc = new svg_dom_1.SvgDocument(svgW, svgH);
+        const doc = new svg_1.SvgDocument(svgW, svgH);
         const svg = doc.root;
-        // Background + embedded Industry web-fonts.
-        svg.child('rect', { width: svgW, height: svgH, fill: t.canvasBg });
-        svg.child('style').text(IND_FONT_IMPORT);
-        // Blueprint style: solid accent header bars + hairline frames, no gradients.
-        // Optional diagram title.
+        svg.child('rect', { width: svgW, height: svgH, fill: theme_1.INK.ground });
         if (title) {
             svg
                 .child('text', {
                 x: ClassDiagram.PAD,
                 y: ClassDiagram.PAD + 8,
-                'font-family': IND_FONT_HEAD,
-                'font-size': 20,
-                'font-weight': 600,
-                fill: t.textPrimary,
+                'font-family': theme_1.FONT.family,
+                'font-size': theme_1.FONT.title + 7,
+                'font-weight': 'bold',
+                fill: theme_1.INK.line,
             })
                 .text(title);
         }
-        // ── Connectors (drawn first, under the boxes) ─────────────────────────
+        // Connectors, drawn first so they sit under the boxes.
         for (const p of placed) {
             const cls = p.cls;
-            // Inheritance: hollow triangle at the parent.
             if (cls.extends && byName.has(cls.extends)) {
                 const parent = byName.get(cls.extends);
-                this.drawInheritance(svg, p, parent, t, accent);
+                this.drawInheritance(svg, p, parent);
             }
-            // Associations: plain line.
             for (const assoc of cls.associations ?? []) {
                 const other = byName.get(assoc);
                 if (other && other !== p) {
-                    this.drawAssociation(svg, p, other, t);
+                    this.drawAssociation(svg, p, other);
                 }
             }
         }
-        // ── Class boxes (drawn on top of connectors) ──────────────────────────
         for (const p of placed) {
-            this.drawClassBox(doc, svg, p, t, accent);
+            this.drawClassBox(svg, p);
         }
-        void cols;
-        return doc.toString('Generated by ts-prorm-orm ClassDiagram');
+        return doc;
+    }
+    generate() {
+        return this.build().toString('Generated by ts-prorm-orm ClassDiagram');
     }
     center(p) {
         return { x: p.x + p.w / 2, y: p.y + p.h / 2 };
     }
-    drawAssociation(svg, a, b, t) {
+    drawAssociation(svg, a, b) {
         const c1 = this.center(a);
         const c2 = this.center(b);
         svg.child('line', {
@@ -210,11 +189,11 @@ class ClassDiagram {
             y1: c1.y,
             x2: c2.x,
             y2: c2.y,
-            stroke: t.textSecondary,
-            'stroke-width': 1.5,
+            stroke: theme_1.INK.line,
+            'stroke-width': theme_1.STROKE.hair,
         });
     }
-    drawInheritance(svg, child, parent, t, accent) {
+    drawInheritance(svg, child, parent) {
         const from = this.center(child);
         const to = this.center(parent);
         const dx = to.x - from.x;
@@ -223,7 +202,6 @@ class ClassDiagram {
         const ux = dx / len;
         const uy = dy / len;
         // Stop the line short of the parent so the arrowhead sits at the edge.
-        void parent;
         const size = 12;
         const lineEndX = to.x - ux * size * 1.6;
         const lineEndY = to.y - uy * size * 1.6;
@@ -232,12 +210,11 @@ class ClassDiagram {
             y1: from.y,
             x2: lineEndX,
             y2: lineEndY,
-            stroke: accent.mid,
-            'stroke-width': 1.8,
+            stroke: theme_1.INK.line,
+            'stroke-width': theme_1.STROKE.heavy,
         });
         // Hollow triangle arrowhead pointing at the parent center.
         const tip = { x: to.x - ux * 2, y: to.y - uy * 2 };
-        // Perpendicular unit vector.
         const px = -uy;
         const py = ux;
         const baseX = tip.x - ux * size;
@@ -246,32 +223,34 @@ class ClassDiagram {
         const p2 = { x: baseX - px * (size * 0.7), y: baseY - py * (size * 0.7) };
         svg.child('polygon', {
             points: `${tip.x},${tip.y} ${p1.x},${p1.y} ${p2.x},${p2.y}`,
-            fill: t.cardBg,
-            stroke: accent.mid,
-            'stroke-width': 1.8,
+            fill: theme_1.INK.ground,
+            stroke: theme_1.INK.line,
+            'stroke-width': theme_1.STROKE.heavy,
         });
     }
-    drawClassBox(doc, svg, p, t, accent) {
+    drawClassBox(svg, p) {
         const { cls, x, y, w, h, titleH, attrH } = p;
         const attrs = cls.attributes ?? [];
         const methods = cls.methods ?? [];
-        // Outer box (white interior, hairline border, square corners).
+        // Outer box (hairline border, square corners).
         svg.child('rect', {
             x,
             y,
             width: w,
             height: h,
-            fill: t.cardBg,
-            stroke: t.border,
-            'stroke-width': 1,
+            fill: theme_1.INK.ground,
+            stroke: theme_1.INK.line,
+            'stroke-width': theme_1.STROKE.hair,
         });
-        // Title bar (solid accent — blueprint label bar).
+        // Title bar.
         svg.child('rect', {
             x,
             y,
             width: w,
             height: titleH,
-            fill: accent.mid,
+            fill: theme_1.INK.wash,
+            stroke: theme_1.INK.line,
+            'stroke-width': theme_1.STROKE.hair,
         });
         let titleTextY = y + 26;
         if (cls.stereotype) {
@@ -279,36 +258,36 @@ class ClassDiagram {
                 .child('text', {
                 x: x + w / 2,
                 y: y + 18,
-                'font-family': IND_FONT_BODY,
-                'font-size': 11,
+                'font-family': theme_1.FONT.family,
+                'font-size': theme_1.FONT.small + 2,
                 'font-style': 'italic',
-                fill: 'rgba(255,255,255,0.85)',
+                fill: theme_1.INK.muted,
                 'text-anchor': 'middle',
             })
-                .text(`«${cls.stereotype}»`);
+                .text(`<<${cls.stereotype}>>`);
             titleTextY = y + 34;
         }
         svg
             .child('text', {
             x: x + w / 2,
             y: titleTextY,
-            'font-family': IND_FONT_HEAD,
-            'font-size': 15,
-            'font-weight': 600,
-            fill: '#FFFFFF',
+            'font-family': theme_1.FONT.family,
+            'font-size': theme_1.FONT.body + 4,
+            'font-weight': 'bold',
+            fill: theme_1.INK.line,
             'text-anchor': 'middle',
         })
             .text(cls.name);
         // Attributes compartment.
         const attrTop = y + titleH;
-        svg.child('rect', { x, y: attrTop, width: w, height: attrH, fill: t.rowAlt });
+        svg.child('rect', { x, y: attrTop, width: w, height: attrH, fill: theme_1.INK.wash });
         svg.child('line', {
             x1: x,
             y1: attrTop,
             x2: x + w,
             y2: attrTop,
-            stroke: t.border,
-            'stroke-width': 1,
+            stroke: theme_1.INK.line,
+            'stroke-width': theme_1.STROKE.hair,
         });
         attrs.forEach((a, i) => {
             const rowY = attrTop + ClassDiagram.COMPARTMENT_PAD + i * ClassDiagram.ROW_H + 15;
@@ -318,24 +297,24 @@ class ClassDiagram {
                 .child('text', {
                 x: x + 12,
                 y: rowY,
-                'font-family': IND_FONT_MONO,
-                'font-size': 12,
+                'font-family': theme_1.FONT.mono,
+                'font-size': theme_1.FONT.body + 1,
                 'font-weight': 500,
                 'text-decoration': a.static ? 'underline' : undefined,
-                fill: t.textPrimary,
+                fill: theme_1.INK.line,
             })
                 .text(label);
         });
         // Methods compartment.
         const methodTop = attrTop + attrH;
-        svg.child('rect', { x, y: methodTop, width: w, height: h - titleH - attrH, fill: t.cardBg });
+        svg.child('rect', { x, y: methodTop, width: w, height: h - titleH - attrH, fill: theme_1.INK.ground });
         svg.child('line', {
             x1: x,
             y1: methodTop,
             x2: x + w,
             y2: methodTop,
-            stroke: t.border,
-            'stroke-width': 1,
+            stroke: theme_1.INK.line,
+            'stroke-width': theme_1.STROKE.hair,
         });
         methods.forEach((m, i) => {
             const rowY = methodTop + ClassDiagram.COMPARTMENT_PAD + i * ClassDiagram.ROW_H + 15;
@@ -345,14 +324,13 @@ class ClassDiagram {
                 .child('text', {
                 x: x + 12,
                 y: rowY,
-                'font-family': IND_FONT_MONO,
-                'font-size': 12,
+                'font-family': theme_1.FONT.mono,
+                'font-size': theme_1.FONT.body + 1,
                 'font-weight': 500,
-                fill: t.textSecondary,
+                fill: theme_1.INK.muted,
             })
                 .text(label);
         });
-        void doc;
     }
     /**
      * Write the SVG to a file. Creates parent directories if needed.

package/dist/diagrams/core/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Diagram core: the minimal set every generator builds on.
+ *
+ * - `svg`    DOM-backed element builder and document serializer
+ * - `theme`  one monochrome hairline theme
+ * - `layout` text measurement, panels, edges, grid packing
+ */
+export { El, SvgDocument } from './svg';
+export type { AttrValue, Attrs } from './svg';
+export { INK, STROKE, FONT, SPACE, ROW_HEIGHT, THEME } from './theme';
+export type { Theme } from './theme';
+export { measureText, truncate, rect, line, text, panel, panelSize, defineArrowhead, edge, gridPack, documentTitle, footer, } from './layout';
+export type { Box, PanelRow, PanelOptions, TextOptions } from './layout';

package/dist/diagrams/core/index.js

@@ -0,0 +1,33 @@
+"use strict";
+/**
+ * Diagram core: the minimal set every generator builds on.
+ *
+ * - `svg`    DOM-backed element builder and document serializer
+ * - `theme`  one monochrome hairline theme
+ * - `layout` text measurement, panels, edges, grid packing
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.footer = exports.documentTitle = exports.gridPack = exports.edge = exports.defineArrowhead = exports.panelSize = exports.panel = exports.text = exports.line = exports.rect = exports.truncate = exports.measureText = exports.THEME = exports.ROW_HEIGHT = exports.SPACE = exports.FONT = exports.STROKE = exports.INK = exports.SvgDocument = exports.El = void 0;
+var svg_1 = require("./svg");
+Object.defineProperty(exports, "El", { enumerable: true, get: function () { return svg_1.El; } });
+Object.defineProperty(exports, "SvgDocument", { enumerable: true, get: function () { return svg_1.SvgDocument; } });
+var theme_1 = require("./theme");
+Object.defineProperty(exports, "INK", { enumerable: true, get: function () { return theme_1.INK; } });
+Object.defineProperty(exports, "STROKE", { enumerable: true, get: function () { return theme_1.STROKE; } });
+Object.defineProperty(exports, "FONT", { enumerable: true, get: function () { return theme_1.FONT; } });
+Object.defineProperty(exports, "SPACE", { enumerable: true, get: function () { return theme_1.SPACE; } });
+Object.defineProperty(exports, "ROW_HEIGHT", { enumerable: true, get: function () { return theme_1.ROW_HEIGHT; } });
+Object.defineProperty(exports, "THEME", { enumerable: true, get: function () { return theme_1.THEME; } });
+var layout_1 = require("./layout");
+Object.defineProperty(exports, "measureText", { enumerable: true, get: function () { return layout_1.measureText; } });
+Object.defineProperty(exports, "truncate", { enumerable: true, get: function () { return layout_1.truncate; } });
+Object.defineProperty(exports, "rect", { enumerable: true, get: function () { return layout_1.rect; } });
+Object.defineProperty(exports, "line", { enumerable: true, get: function () { return layout_1.line; } });
+Object.defineProperty(exports, "text", { enumerable: true, get: function () { return layout_1.text; } });
+Object.defineProperty(exports, "panel", { enumerable: true, get: function () { return layout_1.panel; } });
+Object.defineProperty(exports, "panelSize", { enumerable: true, get: function () { return layout_1.panelSize; } });
+Object.defineProperty(exports, "defineArrowhead", { enumerable: true, get: function () { return layout_1.defineArrowhead; } });
+Object.defineProperty(exports, "edge", { enumerable: true, get: function () { return layout_1.edge; } });
+Object.defineProperty(exports, "gridPack", { enumerable: true, get: function () { return layout_1.gridPack; } });
+Object.defineProperty(exports, "documentTitle", { enumerable: true, get: function () { return layout_1.documentTitle; } });
+Object.defineProperty(exports, "footer", { enumerable: true, get: function () { return layout_1.footer; } });

package/dist/diagrams/core/layout.d.ts

@@ -0,0 +1,104 @@
+/**
+ * Layout primitives shared by every generator.
+ *
+ * Each generator previously carried its own text measurement, box drawing,
+ * arrow routing and footer code. These are the pieces that were duplicated,
+ * factored once so a change to how a panel or an edge looks lands everywhere.
+ */
+import { El } from './svg';
+/**
+ * Approximate rendered width of a string.
+ *
+ * SVG has no text metrics without a layout engine, so this is the usual
+ * average-advance estimate. It is deliberately slightly generous: under-
+ * measuring clips text, over-measuring only adds whitespace.
+ */
+export declare function measureText(text: string, size?: number, mono?: boolean): number;
+/** Truncate to fit `maxWidth`, appending a single-character ellipsis. */
+export declare function truncate(text: string, maxWidth: number, size?: number, mono?: boolean): string;
+/** A laid-out rectangle. */
+export interface Box {
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+}
+/** Draw a plain hairline rectangle. */
+export declare function rect(parent: El, box: Box, fill?: string): El;
+/** Draw a hairline between two points. */
+export declare function line(parent: El, x1: number, y1: number, x2: number, y2: number, dashed?: boolean): El;
+/** Options for a single run of text. */
+export interface TextOptions {
+    size?: number;
+    mono?: boolean;
+    fill?: string;
+    anchor?: 'start' | 'middle' | 'end';
+    weight?: 'normal' | 'bold';
+}
+/** Draw a run of text. */
+export declare function text(parent: El, x: number, y: number, value: string, opts?: TextOptions): El;
+/** One row inside a panel. */
+export interface PanelRow {
+    /** Left-hand label (field name, column, step). */
+    label: string;
+    /** Optional right-hand detail (type, value). */
+    detail?: string;
+    /** Optional short marker rendered before the label (PK, FK, +, -). */
+    marker?: string;
+    /** Draw a rule above this row, for grouping. */
+    rule?: boolean;
+}
+/** A titled box with a header bar and a list of rows - the workhorse shape. */
+export interface PanelOptions {
+    title: string;
+    subtitle?: string;
+    rows?: PanelRow[];
+    /** Minimum width; the panel grows to fit its content. */
+    minWidth?: number;
+}
+/** Compute a panel's size without drawing it, for layout passes. */
+export declare function panelSize(opts: PanelOptions): {
+    w: number;
+    h: number;
+};
+/**
+ * Draw a titled panel at `x,y` and return the box it occupies.
+ *
+ * The header is a washed bar with a hairline under it; rows are plain text with
+ * the detail column right-aligned.
+ */
+export declare function panel(parent: El, x: number, y: number, opts: PanelOptions): Box;
+/** Register the single arrowhead marker. Call once per document. */
+export declare function defineArrowhead(defs: El, id?: string): void;
+/** Draw a straight edge, optionally arrowed and/or dashed, with a label. */
+export declare function edge(parent: El, from: {
+    x: number;
+    y: number;
+}, to: {
+    x: number;
+    y: number;
+}, opts?: {
+    arrow?: boolean;
+    dashed?: boolean;
+    label?: string;
+    markerId?: string;
+}): El;
+/** Pack boxes into a grid, returning positions and the total canvas size. */
+export declare function gridPack(sizes: Array<{
+    w: number;
+    h: number;
+}>, columns: number, gap?: number, origin?: {
+    x: 24;
+    y: 24;
+}): {
+    positions: Array<{
+        x: number;
+        y: number;
+    }>;
+    width: number;
+    height: number;
+};
+/** Draw a title at the top of a document. Returns the y to continue from. */
+export declare function documentTitle(parent: El, x: number, y: number, title: string): number;
+/** Draw a footer line. Plain text, no separators or glyphs. */
+export declare function footer(parent: El, x: number, y: number, parts: string[]): El;