ts-prorm-orm 1.2.3 → 2.1.0

package/dist/decorators/trigger.d.ts

@@ -1,11 +1,12 @@
 /**
- * @Trigger class decorator — declare a database trigger on a model class.
+ * `@Trigger` class decorator — declare a database trigger on a model class.
  *
  * Stores trigger metadata using plain class properties (no reflect-metadata
  * dependency) consistent with the rest of this decorator suite.
  *
  * Example:
  *
+ * ```ts
  *   @Trigger({
  *     name: 'trg_users_audit',
  *     timing: 'AFTER',
@@ -20,6 +21,7 @@
  *
  *   // Generate DDL:
  *   const sql = buildCreateTriggerSQL('users', triggers[0], 'mysql');
+ * ```
  */
 export interface TriggerOptions {
     /** The trigger name in the database. */

package/dist/decorators/trigger.js

@@ -1,12 +1,13 @@
 "use strict";
 /**
- * @Trigger class decorator — declare a database trigger on a model class.
+ * `@Trigger` class decorator — declare a database trigger on a model class.
  *
  * Stores trigger metadata using plain class properties (no reflect-metadata
  * dependency) consistent with the rest of this decorator suite.
  *
  * Example:
  *
+ * ```ts
  *   @Trigger({
  *     name: 'trg_users_audit',
  *     timing: 'AFTER',
@@ -21,6 +22,7 @@
  *
  *   // Generate DDL:
  *   const sql = buildCreateTriggerSQL('users', triggers[0], 'mysql');
+ * ```
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Trigger = Trigger;

package/dist/decorators/uuid.d.ts

@@ -6,6 +6,7 @@
  *
  * Usage:
  *
+ * ```ts
  *   // Auto-generate UUID using gen_random_uuid() (PostgreSQL 13+)
  *   @UUID()
  *   id: string;
@@ -17,6 +18,7 @@
  *   // With custom default
  *   @UUID({ defaultValue: 'gen_random_uuid' })
  *   id: string;
+ * ```
  */
 /**
  * Options for UUID column type
@@ -49,14 +51,18 @@ export interface UUIDMetadata {
  * @example
  * // Auto-generate UUID
  * class User extends Model {
+ * ```ts
  *   @UUID()
  *   id: string;
+ * ```
  * }
  *
  * // With specific default
  * class User extends Model {
+ * ```ts
  *   @UUID({ defaultValue: 'uuid_generate_v4' })
  *   id: string;
+ * ```
  * }
  */
 export declare function UUID(options?: UUIDDecoratorOptions): PropertyDecorator;

package/dist/decorators/uuid.js

@@ -7,6 +7,7 @@
  *
  * Usage:
  *
+ * ```ts
  *   // Auto-generate UUID using gen_random_uuid() (PostgreSQL 13+)
  *   @UUID()
  *   id: string;
@@ -18,6 +19,7 @@
  *   // With custom default
  *   @UUID({ defaultValue: 'gen_random_uuid' })
  *   id: string;
+ * ```
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UUID = UUID;
@@ -37,14 +39,18 @@ const uuidMetadataMap = new Map();
  * @example
  * // Auto-generate UUID
  * class User extends Model {
+ * ```ts
  *   @UUID()
  *   id: string;
+ * ```
  * }
  *
  * // With specific default
  * class User extends Model {
+ * ```ts
  *   @UUID({ defaultValue: 'uuid_generate_v4' })
  *   id: string;
+ * ```
  * }
  */
 function UUID(options) {

package/dist/decorators/view.d.ts

@@ -1,10 +1,11 @@
 /**
- * @View class decorator — annotate a Model class so it maps to a database view
+ * `@View` class decorator — annotate a Model class so it maps to a database view
  * instead of a base table. The ORM stores the view definition and can generate
  * the CREATE VIEW DDL for you.
  *
  * Example:
  *
+ * ```ts
  *   @View({
  *     name: 'active_users_view',
  *     query: `
@@ -30,6 +31,7 @@
  *
  *   // Query it just like a normal model:
  *   const users = await ActiveUser.findAll({ where: { name: 'Alice' } });
+ * ```
  */
 import type { Prorm } from '../prorm';
 export interface ViewOptions {
@@ -83,8 +85,10 @@ export declare function getViewOptions(target: Function): ViewOptions | undefine
  * - Sets the `tableName` option to the view name so findAll() etc. work correctly.
  * - Registers view metadata so the ORM can generate CREATE VIEW DDL.
  *
+ * ```ts
  *   @View({ name: 'active_users_view', query: 'SELECT ...' })
  *   class ActiveUser extends Model { ... }
+ * ```
  */
 export declare function View(options: ViewOptions): (target: Function) => void;
 export declare const ViewRegistry: {
@@ -166,6 +170,7 @@ export declare function getMaterializedViewOptions(target: Function): Materializ
  * - Registers materialized view metadata so the ORM can generate CREATE MATERIALIZED VIEW DDL.
  * - Adds a `refresh()` static method for refreshing the view data.
  *
+ * ```ts
  *   @MaterializedView({
  *     name: 'user_stats_view',
  *     query: `
@@ -194,6 +199,7 @@ export declare function getMaterializedViewOptions(target: Function): Materializ
  *   await UserStats.refresh();
  *   // Or concurrently (requires unique index):
  *   await UserStats.refresh({ concurrently: true });
+ * ```
  */
 export declare function MaterializedView(options: MaterializedViewDecoratorOptions): (target: Function) => void;
 export declare const MaterializedViewRegistry: {

package/dist/decorators/view.js

@@ -1,11 +1,12 @@
 "use strict";
 /**
- * @View class decorator — annotate a Model class so it maps to a database view
+ * `@View` class decorator — annotate a Model class so it maps to a database view
  * instead of a base table. The ORM stores the view definition and can generate
  * the CREATE VIEW DDL for you.
  *
  * Example:
  *
+ * ```ts
  *   @View({
  *     name: 'active_users_view',
  *     query: `
@@ -31,6 +32,7 @@
  *
  *   // Query it just like a normal model:
  *   const users = await ActiveUser.findAll({ where: { name: 'Alice' } });
+ * ```
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MaterializedViewRegistry = exports.ViewRegistry = void 0;
@@ -54,8 +56,10 @@ function getViewOptions(target) {
  * - Sets the `tableName` option to the view name so findAll() etc. work correctly.
  * - Registers view metadata so the ORM can generate CREATE VIEW DDL.
  *
+ * ```ts
  *   @View({ name: 'active_users_view', query: 'SELECT ...' })
  *   class ActiveUser extends Model { ... }
+ * ```
  */
 function View(options) {
     return function (target) {
@@ -143,6 +147,7 @@ function getMaterializedViewOptions(target) {
  * - Registers materialized view metadata so the ORM can generate CREATE MATERIALIZED VIEW DDL.
  * - Adds a `refresh()` static method for refreshing the view data.
  *
+ * ```ts
  *   @MaterializedView({
  *     name: 'user_stats_view',
  *     query: `
@@ -171,6 +176,7 @@ function getMaterializedViewOptions(target) {
  *   await UserStats.refresh();
  *   // Or concurrently (requires unique index):
  *   await UserStats.refresh({ concurrently: true });
+ * ```
  */
 function MaterializedView(options) {
     return function (target) {

package/dist/diagrams/chen-diagram.d.ts

@@ -1,19 +1,16 @@
 /**
- * ChenDiagram — renders a classic Chen-notation Entity-Relationship diagram
- * as SVG, built against a real DOM document (via svg-dom) rather than
- * concatenated markup.
+ * ChenDiagram - renders a classic Chen-notation Entity-Relationship diagram
+ * as SVG, built against a real DOM document rather than concatenated markup.
  *
  * Chen notation (distinct from crow's-foot):
- *   - Entities       → rectangles (weak entities get a double border)
- *   - Relationships  → diamonds placed between the two entities they connect,
- *                      with cardinality labels (1, N, M) on the connecting lines
- *   - Attributes     → ellipses connected to their entity by a line; key
- *                      attributes have underlined text, multivalued get a double
- *                      ellipse, derived get a dashed ellipse.
+ *   - Entities       -> rectangles (weak entities get a double border)
+ *   - Relationships  -> diamonds placed between the two entities they connect,
+ *                       with cardinality labels (1, N, M) on the connecting lines
+ *   - Attributes     -> ellipses connected to their entity by a line; key
+ *                       attributes have underlined text, multivalued get a
+ *                       double ellipse, derived get a dashed ellipse.
  *
- * Options honor `theme` (light|dark canvas/text) and `color` (accent for
- * entities/diamonds) via resolveTheme/resolveAccent, so both flags change the
- * generated output. The viewBox is auto-sized to the laid-out geometry.
+ * The viewBox is auto-sized to the laid-out geometry.
  *
  * Usage:
  *   const diag = new ChenDiagram({ entities: [...], relationships: [...] });
@@ -41,7 +38,12 @@ export interface ChenDiagramOptions {
     entities: ChenEntity[];
     relationships?: ChenRelationship[];
     title?: string;
+    /**
+     * Accepted for backward compatibility and ignored: diagrams render in a
+     * single monochrome theme.
+     */
     theme?: 'light' | 'dark';
+    /** Accepted for backward compatibility and ignored. */
     color?: string;
 }
 export declare class ChenDiagram {
@@ -62,6 +64,7 @@ export declare class ChenDiagram {
     private drawAttribute;
     private drawEntity;
     private drawRelationship;
+    private build;
     generate(): string;
     /**
      * Write the SVG to a file. Creates parent directories if needed.

package/dist/diagrams/chen-diagram.js

@@ -1,20 +1,17 @@
 "use strict";
 /**
- * ChenDiagram — renders a classic Chen-notation Entity-Relationship diagram
- * as SVG, built against a real DOM document (via svg-dom) rather than
- * concatenated markup.
+ * ChenDiagram - renders a classic Chen-notation Entity-Relationship diagram
+ * as SVG, built against a real DOM document rather than concatenated markup.
  *
  * Chen notation (distinct from crow's-foot):
- *   - Entities       → rectangles (weak entities get a double border)
- *   - Relationships  → diamonds placed between the two entities they connect,
- *                      with cardinality labels (1, N, M) on the connecting lines
- *   - Attributes     → ellipses connected to their entity by a line; key
- *                      attributes have underlined text, multivalued get a double
- *                      ellipse, derived get a dashed ellipse.
+ *   - Entities       -> rectangles (weak entities get a double border)
+ *   - Relationships  -> diamonds placed between the two entities they connect,
+ *                       with cardinality labels (1, N, M) on the connecting lines
+ *   - Attributes     -> ellipses connected to their entity by a line; key
+ *                       attributes have underlined text, multivalued get a
+ *                       double ellipse, derived get a dashed ellipse.
  *
- * Options honor `theme` (light|dark canvas/text) and `color` (accent for
- * entities/diamonds) via resolveTheme/resolveAccent, so both flags change the
- * generated output. The viewBox is auto-sized to the laid-out geometry.
+ * The viewBox is auto-sized to the laid-out geometry.
  *
  * Usage:
  *   const diag = new ChenDiagram({ entities: [...], relationships: [...] });
@@ -57,8 +54,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ChenDiagram = void 0;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
-const palette_1 = require("./palette");
-const svg_dom_1 = require("./svg-dom");
+const svg_1 = require("./core/svg");
+const theme_1 = require("./core/theme");
+const layout_1 = require("./core/layout");
 class ChenDiagram {
     constructor(options) {
         this.opts = {
@@ -69,7 +67,7 @@ class ChenDiagram {
             color: options.color ?? '',
         };
     }
-    // ── Attribute anchor positions radially around an entity center ──────────
+    // -- Attribute anchor positions radially around an entity center ------------
     attributePositions(center, count) {
         const D = ChenDiagram.ATTR_DIST;
         const pts = [];
@@ -86,15 +84,15 @@ class ChenDiagram {
         }
         return pts;
     }
-    drawAttribute(svg, from, at, attr, accent, t) {
-        // connector line entity → attribute
+    drawAttribute(svg, from, at, attr) {
+        // connector line entity -> attribute
         svg.child('line', {
             x1: from.x,
             y1: from.y,
             x2: at.x,
             y2: at.y,
-            stroke: t.textSecondary,
-            'stroke-width': 1.5,
+            stroke: theme_1.INK.line,
+            'stroke-width': theme_1.STROKE.hair,
         });
         const rx = ChenDiagram.ATTR_RX;
         const ry = ChenDiagram.ATTR_RY;
@@ -108,8 +106,8 @@ class ChenDiagram {
                 rx: rx + 5,
                 ry: ry + 5,
                 fill: 'none',
-                stroke: accent.mid,
-                'stroke-width': 1.5,
+                stroke: theme_1.INK.line,
+                'stroke-width': theme_1.STROKE.hair,
                 'stroke-dasharray': strokeDash,
             });
         }
@@ -118,42 +116,40 @@ class ChenDiagram {
             cy: at.y,
             rx,
             ry,
-            fill: t.cardBg,
-            stroke: accent.mid,
-            'stroke-width': 1.6,
+            fill: theme_1.INK.ground,
+            stroke: theme_1.INK.line,
+            'stroke-width': theme_1.STROKE.hair,
             'stroke-dasharray': strokeDash,
         });
-        const label = attr.name.length > 14 ? attr.name.slice(0, 13) + '…' : attr.name;
         svg
             .child('text', {
             x: at.x,
             y: at.y + 4,
-            'font-family': palette_1.FONTS.body,
-            'font-size': 12,
+            'font-family': theme_1.FONT.family,
+            'font-size': theme_1.FONT.body + 1,
             'font-weight': attr.key ? 600 : 400,
-            fill: t.textPrimary,
+            fill: theme_1.INK.line,
             'text-anchor': 'middle',
             // key attributes are underlined in Chen notation
             'text-decoration': attr.key ? 'underline' : undefined,
         })
-            .text(label);
+            .text((0, layout_1.truncate)(attr.name, rx * 2 - 8, theme_1.FONT.body + 1));
     }
-    drawEntity(svg, p, accent, t) {
+    drawEntity(svg, p) {
         const W = ChenDiagram.ENT_W;
         const H = ChenDiagram.ENT_H;
         const x = p.center.x - W / 2;
         const y = p.center.y - H / 2;
-        // weak entities → double rectangle border
+        // weak entities -> double rectangle border
         if (p.entity.weak) {
             svg.child('rect', {
                 x: x - 5,
                 y: y - 5,
                 width: W + 10,
                 height: H + 10,
-                rx: 0,
                 fill: 'none',
-                stroke: accent.mid,
-                'stroke-width': 1.4,
+                stroke: theme_1.INK.line,
+                'stroke-width': theme_1.STROKE.hair,
             });
         }
         svg.child('rect', {
@@ -161,45 +157,44 @@ class ChenDiagram {
             y,
             width: W,
             height: H,
-            rx: 0,
-            fill: accent.light,
-            stroke: accent.mid,
-            'stroke-width': 1.6,
+            fill: theme_1.INK.wash,
+            stroke: theme_1.INK.line,
+            'stroke-width': theme_1.STROKE.hair,
         });
         svg
             .child('text', {
             x: p.center.x,
             y: p.center.y + 5,
-            'font-family': palette_1.FONTS.heading,
-            'font-size': 17,
-            'font-weight': 600,
-            fill: accent.text,
+            'font-family': theme_1.FONT.family,
+            'font-size': theme_1.FONT.title + 4,
+            'font-weight': 'bold',
+            fill: theme_1.INK.line,
             'text-anchor': 'middle',
         })
             .text(p.entity.name);
     }
-    drawRelationship(svg, rel, a, b, accent, t) {
+    drawRelationship(svg, rel, a, b) {
         const mid = { x: (a.x + b.x) / 2, y: (a.y + b.y) / 2 };
         const DW = ChenDiagram.DIA_W;
         const DH = ChenDiagram.DIA_H;
-        // connecting lines: entity-a → diamond → entity-b
+        // connecting lines: entity-a -> diamond -> entity-b
         svg.child('line', {
             x1: a.x,
             y1: a.y,
             x2: mid.x,
             y2: mid.y,
-            stroke: palette_1.INDUSTRY.neutral[600],
-            'stroke-width': 1.4,
+            stroke: theme_1.INK.line,
+            'stroke-width': theme_1.STROKE.hair,
         });
         svg.child('line', {
             x1: mid.x,
             y1: mid.y,
             x2: b.x,
             y2: b.y,
-            stroke: palette_1.INDUSTRY.neutral[600],
-            'stroke-width': 1.4,
+            stroke: theme_1.INK.line,
+            'stroke-width': theme_1.STROKE.hair,
         });
-        // diamond (polygon) centered on mid — solid accent fill, white label
+        // diamond (polygon) centered on mid.
         const pts = [
             `${mid.x},${mid.y - DH / 2}`,
             `${mid.x + DW / 2},${mid.y}`,
@@ -208,18 +203,18 @@ class ChenDiagram {
         ].join(' ');
         svg.child('polygon', {
             points: pts,
-            fill: accent.mid,
-            stroke: accent.text,
-            'stroke-width': 1.4,
+            fill: theme_1.INK.wash,
+            stroke: theme_1.INK.line,
+            'stroke-width': theme_1.STROKE.hair,
         });
         svg
             .child('text', {
             x: mid.x,
             y: mid.y + 5,
-            'font-family': palette_1.FONTS.heading,
-            'font-size': 14,
-            'font-weight': 600,
-            fill: '#FFFFFF',
+            'font-family': theme_1.FONT.family,
+            'font-size': theme_1.FONT.body + 3,
+            'font-weight': 'bold',
+            fill: theme_1.INK.line,
             'text-anchor': 'middle',
         })
             .text(rel.name);
@@ -233,10 +228,10 @@ class ChenDiagram {
                 .child('text', {
                 x: lx,
                 y: ly,
-                'font-family': palette_1.FONTS.mono,
-                'font-size': 13,
-                'font-weight': 600,
-                fill: t.textPrimary,
+                'font-family': theme_1.FONT.mono,
+                'font-size': theme_1.FONT.body + 2,
+                'font-weight': 'bold',
+                fill: theme_1.INK.line,
                 'text-anchor': 'middle',
             })
                 .text(card);
@@ -244,15 +239,12 @@ class ChenDiagram {
         label(a, rel.fromCardinality);
         label(b, rel.toCardinality);
     }
-    // ── Generate the full SVG string (built via a real DOM document) ──────────
-    generate() {
-        const { entities, relationships, title, theme, color } = this.opts;
-        const accent = (0, palette_1.resolveAccent)(color);
-        const t = (0, palette_1.resolveTheme)(theme);
+    build() {
+        const { entities, relationships, title } = this.opts;
         const PAD = ChenDiagram.PAD;
         const COL_GAP = ChenDiagram.COL_GAP;
         const ROW_GAP = ChenDiagram.ROW_GAP;
-        // ── Place entities on a grid (2 per row) ────────────────────────────
+        // Place entities on a grid (2 per row).
         const perRow = Math.min(2, Math.max(1, entities.length));
         const originX = PAD + COL_GAP / 2;
         const originY = PAD + (title ? ChenDiagram.TITLE_H : 0) + ROW_GAP / 2;
@@ -267,7 +259,7 @@ class ChenDiagram {
         const byName = new Map();
         for (const p of placed)
             byName.set(p.entity.name, p);
-        // ── Compute bounds (attributes extend furthest) ─────────────────────
+        // Compute bounds (attributes extend furthest).
         let maxX = 0;
         let maxY = 0;
         const attrTargets = [];
@@ -294,40 +286,39 @@ class ChenDiagram {
         }
         const svgW = Math.ceil(maxX + PAD);
         const svgH = Math.ceil(maxY + PAD);
-        const doc = new svg_dom_1.SvgDocument(svgW, svgH);
+        const doc = new svg_1.SvgDocument(svgW, svgH);
         const svg = doc.root;
-        // Web fonts for browser renderers.
-        doc.style(palette_1.FONT_IMPORT);
-        // ── Ground ──────────────────────────────────────────────────────────
-        svg.child('rect', { width: svgW, height: svgH, fill: t.canvasBg });
-        // ── Title ───────────────────────────────────────────────────────────
+        svg.child('rect', { width: svgW, height: svgH, fill: theme_1.INK.ground });
         if (title) {
             svg
                 .child('text', {
                 x: PAD,
                 y: PAD,
-                'font-family': palette_1.FONTS.heading,
-                'font-size': 24,
-                'font-weight': 600,
-                fill: t.textPrimary,
+                'font-family': theme_1.FONT.family,
+                'font-size': theme_1.FONT.title + 13,
+                'font-weight': 'bold',
+                fill: theme_1.INK.line,
             })
                 .text(title);
         }
-        // ── Relationships first (so lines/diamonds sit under entities) ──────
+        // Relationships first, so lines/diamonds sit under entities.
         for (const rel of relationships) {
             const A = byName.get(rel.from);
             const B = byName.get(rel.to);
             if (A && B)
-                this.drawRelationship(svg, rel, A.center, B.center, accent, t);
+                this.drawRelationship(svg, rel, A.center, B.center);
         }
-        // ── Attributes (connectors + ellipses) ──────────────────────────────
+        // Attributes (connectors + ellipses).
         for (const target of attrTargets) {
-            this.drawAttribute(svg, target.from, target.at, target.attr, accent, t);
+            this.drawAttribute(svg, target.from, target.at, target.attr);
         }
-        // ── Entities on top ─────────────────────────────────────────────────
+        // Entities on top.
         for (const p of placed)
-            this.drawEntity(svg, p, accent, t);
-        return doc.toString('Generated by ts-prorm-orm ChenDiagram');
+            this.drawEntity(svg, p);
+        return doc;
+    }
+    generate() {
+        return this.build().toString('Generated by ts-prorm-orm ChenDiagram');
     }
     /**
      * Write the SVG to a file. Creates parent directories if needed.
@@ -351,6 +342,6 @@ ChenDiagram.DIA_W = 130;
 ChenDiagram.DIA_H = 74;
 ChenDiagram.ATTR_RX = 52;
 ChenDiagram.ATTR_RY = 24;
-ChenDiagram.ATTR_DIST = 96; // center-of-entity → center-of-attribute
+ChenDiagram.ATTR_DIST = 96; // center-of-entity to center-of-attribute
 ChenDiagram.COL_GAP = 300; // horizontal spacing between entity centers
 ChenDiagram.ROW_GAP = 320; // vertical spacing between entity rows

package/dist/diagrams/class-diagram.d.ts

@@ -1,8 +1,8 @@
 /**
- * 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`).
  *
@@ -11,12 +11,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();
@@ -46,8 +42,12 @@ export interface UmlClass {
 export interface ClassDiagramOptions {
     classes: UmlClass[];
     title?: string;
+    /**
+     * Accepted for backward compatibility and ignored: diagrams render in a
+     * single monochrome theme.
+     */
     theme?: 'light' | 'dark';
-    /** Named palette (e.g. "emerald") or a hex color string. */
+    /** Accepted for backward compatibility and ignored. */
     color?: string;
     /** Number of columns before wrapping. Defaults to an auto value. */
     columns?: number;
@@ -66,6 +66,7 @@ export declare class ClassDiagram {
     constructor(options: ClassDiagramOptions);
     private boxHeight;
     private layout;
+    private build;
     generate(): string;
     private center;
     private drawAssociation;