ts-prorm-orm 1.2.2 → 2.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-prorm-orm",
-  "version": "1.2.2",
+  "version": "2.0.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "author": "Malcolm Stone",
@@ -29,16 +29,36 @@
       "require": "./dist/index.js",
       "types": "./dist/index.d.ts"
     },
+    "./cache": {
+      "types": "./dist/cache/index.d.ts",
+      "import": "./dist/cache/index.js",
+      "require": "./dist/cache/index.js"
+    },
+    "./audit": {
+      "types": "./dist/audit/index.d.ts",
+      "import": "./dist/audit/index.js",
+      "require": "./dist/audit/index.js"
+    },
+    "./graph": {
+      "types": "./dist/graph/index.d.ts",
+      "import": "./dist/graph/index.js",
+      "require": "./dist/graph/index.js"
+    },
+    "./prisma-migrate": {
+      "types": "./dist/prisma-migrate/index.d.ts",
+      "import": "./dist/prisma-migrate/index.js",
+      "require": "./dist/prisma-migrate/index.js"
+    },
     "./package.json": "./package.json"
   },
   "scripts": {
-    "build": "tsc",
+    "build": "npm run clean && tsc",
     "clean": "rm -rf dist",
     "dev": "tsc --watch",
     "test": "jest",
     "test:legacy": "node dist/test.js",
     "test:watch": "jest --watch",
-    "test:coverage": "jest --coverage",
+    "test:coverage": "jest --coverage --maxWorkers=50%",
     "model:create": "ts-node src/cli.ts model:create",
     "model:create:help": "ts-node src/cli.ts help",
     "diagram:model": "ts-node src/cli.ts diagram:model",
@@ -55,7 +75,8 @@
     "prepublishOnly": "npm run build && npm run check:package && npm run test",
     "prepare": "husky",
     "docs:reference": "typedoc",
-    "check:package": "node scripts/check-package.mjs"
+    "check:package": "node scripts/check-package.mjs",
+    "build:incremental": "tsc"
   },
   "bin": {
     "prorm": "dist/cli.js",
@@ -180,7 +201,13 @@
       "jest-junit"
     ],
     "workerIdleMemoryLimit": "256MB",
-    "coverageProvider": "v8"
+    "coverageProvider": "v8",
+    "collectCoverageFrom": [
+      "src/**/*.ts",
+      "!src/test.ts",
+      "!src/models/virtual-field-example.ts",
+      "!src/**/*.d.ts"
+    ]
   },
   "jest-junit": {
     "outputDirectory": ".",

package/dist/decorators/belongs-to-many.js

@@ -1,115 +0,0 @@
-"use strict";
-/**
- * BelongsToMany decorator for the ORM.
- *
- * Defines a many-to-many relationship between models via a join table/model.
- *
- * Usage:
- *
- *   @BelongsToMany(() => Role, { through: 'user_roles' })
- *   roles: Role[];
- *
- *   @BelongsToMany(() => Role, { through: UserRole, as: 'assignedRoles' })
- *   assignedRoles: Role[];
- *
- *   // With options
- *   @BelongsToMany(() => Tag, {
- *     through: 'post_tags',
- *     foreignKey: 'post_id',
- *     otherKey: 'tag_id',
- *     onDelete: 'CASCADE'
- *   })
- *   tags: Tag[];
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getBelongsToMany = getBelongsToMany;
-exports.getAllBelongsToMany = getAllBelongsToMany;
-exports.BelongsToMany = BelongsToMany;
-exports.processBelongsToManyDecorators = processBelongsToManyDecorators;
-// ==================== Metadata Storage ====================
-const BELONGS_TO_MANY_KEY = '__orm_belongs_to_many__';
-/**
- * Get all @BelongsToMany annotations attached to a model constructor.
- */
-function getBelongsToMany(target) {
-    return target[BELONGS_TO_MANY_KEY] || [];
-}
-/**
- * Get all belongsToMany associations including inherited ones.
- */
-function getAllBelongsToMany(target) {
-    const associations = [];
-    let current = target;
-    while (current && current.prototype) {
-        const meta = getBelongsToMany(current);
-        associations.push(...meta);
-        current = Object.getPrototypeOf(current);
-        if (current === Object.prototype)
-            break;
-    }
-    return associations;
-}
-// ==================== Decorator ====================
-/**
- * Define a many-to-many relationship.
- *
- * This decorator stores metadata on the model class that can be used
- * by the ORM to establish the association at model initialization time.
- *
- * @param target - A function that returns the target model class
- * @param options - Configuration for the association (through is required)
- */
-function BelongsToMany(target, options) {
-    return function (prototype, propertyKey) {
-        const ModelClass = prototype.constructor;
-        if (!ModelClass[BELONGS_TO_MANY_KEY]) {
-            ModelClass[BELONGS_TO_MANY_KEY] = [];
-        }
-        ModelClass[BELONGS_TO_MANY_KEY].push({
-            target,
-            options: {
-                as: options.as || propertyKey.toString(),
-                through: options.through,
-                foreignKey: options.foreignKey,
-                otherKey: options.otherKey,
-                constraints: options.constraints,
-                onDelete: options.onDelete,
-                onUpdate: options.onUpdate,
-                targetKey: options.targetKey,
-                sourceKey: options.sourceKey,
-            },
-        });
-    };
-}
-/**
- * Process @BelongsToMany decorators and create association configuration.
- *
- * Call this to get the raw association definitions from decorators.
- *
- * @param ModelClass - The model class with @BelongsToMany decorators
- * @returns Array of association configurations
- */
-function processBelongsToManyDecorators(ModelClass) {
-    const decorators = getAllBelongsToMany(ModelClass);
-    return decorators.map(({ target, options }) => {
-        const targetModel = target();
-        const foreignKey = typeof options.foreignKey === 'string'
-            ? options.foreignKey
-            : options.foreignKey?.name
-                ? options.foreignKey.name
-                : `${ModelClass.name}Id`;
-        return {
-            source: ModelClass,
-            target: targetModel,
-            foreignKey,
-            as: options.as || '',
-            options,
-        };
-    });
-}
-exports.default = {
-    BelongsToMany,
-    getBelongsToMany,
-    getAllBelongsToMany,
-    processBelongsToManyDecorators,
-};

package/dist/decorators/belongs-to.js

@@ -1,115 +0,0 @@
-"use strict";
-/**
- * BelongsTo decorator for the ORM.
- *
- * Defines a many-to-one (inverse of hasOne/hasMany) relationship between models.
- *
- * Usage:
- *
- *   @BelongsTo(() => User)
- *   user: User;
- *
- *   @BelongsTo(() => User, { as: 'author' })
- *   author: User;
- *
- *   // With options
- *   @BelongsTo(() => Category, {
- *     foreignKey: { name: 'category_id', allowNull: false },
- *     onDelete: 'CASCADE'
- *   })
- *   category: Category;
- *
- *   // Self-referential
- *   @BelongsTo(() => User, { as: 'manager', foreignKey: 'manager_id' })
- *   manager: User;
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getBelongsTo = getBelongsTo;
-exports.getAllBelongsTo = getAllBelongsTo;
-exports.BelongsTo = BelongsTo;
-exports.processBelongsToDecorators = processBelongsToDecorators;
-// ==================== Metadata Storage ====================
-const BELONGS_TO_KEY = '__orm_belongs_to__';
-/**
- * Get all @BelongsTo annotations attached to a model constructor.
- */
-function getBelongsTo(target) {
-    return target[BELONGS_TO_KEY] || [];
-}
-/**
- * Get all belongsTo associations including inherited ones.
- */
-function getAllBelongsTo(target) {
-    const associations = [];
-    let current = target;
-    while (current && current.prototype) {
-        const meta = getBelongsTo(current);
-        associations.push(...meta);
-        current = Object.getPrototypeOf(current);
-        if (current === Object.prototype)
-            break;
-    }
-    return associations;
-}
-// ==================== Decorator ====================
-/**
- * Define a many-to-one relationship.
- *
- * This decorator stores metadata on the model class that can be used
- * by the ORM to establish the association at model initialization time.
- *
- * @param target - A function that returns the target model class
- * @param options - Optional configuration for the association
- */
-function BelongsTo(target, options = {}) {
-    return function (prototype, propertyKey) {
-        const ModelClass = prototype.constructor;
-        if (!ModelClass[BELONGS_TO_KEY]) {
-            ModelClass[BELONGS_TO_KEY] = [];
-        }
-        ModelClass[BELONGS_TO_KEY].push({
-            target,
-            options: {
-                as: options.as || propertyKey.toString(),
-                foreignKey: options.foreignKey,
-                constraints: options.constraints,
-                onDelete: options.onDelete,
-                onUpdate: options.onUpdate,
-                targetKey: options.targetKey,
-                sourceKey: options.sourceKey,
-            },
-        });
-    };
-}
-/**
- * Process @BelongsTo decorators and create association configuration.
- *
- * Call this to get the raw association definitions from decorators.
- *
- * @param ModelClass - The model class with @BelongsTo decorators
- * @returns Array of association configurations
- */
-function processBelongsToDecorators(ModelClass) {
-    const decorators = getAllBelongsTo(ModelClass);
-    return decorators.map(({ target, options }) => {
-        const targetModel = target();
-        const foreignKey = typeof options.foreignKey === 'string'
-            ? options.foreignKey
-            : options.foreignKey?.name
-                ? options.foreignKey.name
-                : `${targetModel.name}Id`;
-        return {
-            source: ModelClass,
-            target: targetModel,
-            foreignKey,
-            as: options.as || '',
-            options,
-        };
-    });
-}
-exports.default = {
-    BelongsTo,
-    getBelongsTo,
-    getAllBelongsTo,
-    processBelongsToDecorators,
-};

package/dist/decorators/has-many.js

@@ -1,127 +0,0 @@
-"use strict";
-/**
- * HasMany decorator for the ORM.
- *
- * Defines a one-to-many relationship between models.
- *
- * Usage:
- *
- *   @HasMany(() => Post)
- *   posts: Post[];
- *
- *   @HasMany(() => Post, { as: 'articles' })
- *   articles: Post[];
- *
- *   // With options
- *   @HasMany(() => Order, {
- *     foreignKey: { name: 'user_id', allowNull: false },
- *     onDelete: 'CASCADE',
- *     through: 'user_orders'  // For belongsToMany
- *   })
- *   orders: Order[];
- *
- *   // Self-referential
- *   @HasMany(() => Category, { as: 'children', foreignKey: 'parent_id' })
- *   children: Category[];
- *
- *   // Nested hasMany with scope
- *   @HasMany(() => Comment, {
- *     as: 'replies',
- *     foreignKey: 'parent_id',
- *     scope: { deleted: false }
- *   })
- *   replies: Comment[];
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getHasMany = getHasMany;
-exports.getAllHasMany = getAllHasMany;
-exports.HasMany = HasMany;
-exports.processHasManyDecorators = processHasManyDecorators;
-// ==================== Metadata Storage ====================
-const HAS_MANY_KEY = '__orm_has_many__';
-/**
- * Get all @HasMany annotations attached to a model constructor.
- */
-function getHasMany(target) {
-    return target[HAS_MANY_KEY] || [];
-}
-/**
- * Get all hasMany associations including inherited ones.
- */
-function getAllHasMany(target) {
-    const associations = [];
-    let current = target;
-    while (current && current.prototype) {
-        const meta = getHasMany(current);
-        associations.push(...meta);
-        current = Object.getPrototypeOf(current);
-        if (current === Object.prototype)
-            break;
-    }
-    return associations;
-}
-// ==================== Decorator ====================
-/**
- * Define a one-to-many relationship.
- *
- * This decorator stores metadata on the model class that can be used
- * by the ORM to establish the association at model initialization time.
- *
- * @param target - A function that returns the target model class
- * @param options - Optional configuration for the association
- */
-function HasMany(target, options = {}) {
-    return function (prototype, propertyKey) {
-        const ModelClass = prototype.constructor;
-        if (!ModelClass[HAS_MANY_KEY]) {
-            ModelClass[HAS_MANY_KEY] = [];
-        }
-        ModelClass[HAS_MANY_KEY].push({
-            target,
-            options: {
-                as: options.as || propertyKey.toString(),
-                foreignKey: options.foreignKey,
-                constraints: options.constraints,
-                onDelete: options.onDelete,
-                onUpdate: options.onUpdate,
-                targetKey: options.targetKey,
-                sourceKey: options.sourceKey,
-                scope: options.scope,
-                through: options.through,
-                inverse: options.inverse,
-            },
-        });
-    };
-}
-/**
- * Process @HasMany decorators and create association configuration.
- *
- * Call this to get the raw association definitions from decorators.
- *
- * @param ModelClass - The model class with @HasMany decorators
- * @returns Array of association configurations
- */
-function processHasManyDecorators(ModelClass) {
-    const decorators = getAllHasMany(ModelClass);
-    return decorators.map(({ target, options }) => {
-        const targetModel = target();
-        const foreignKey = typeof options.foreignKey === 'string'
-            ? options.foreignKey
-            : options.foreignKey?.name
-                ? options.foreignKey.name
-                : `${ModelClass.name}Id`;
-        return {
-            source: ModelClass,
-            target: targetModel,
-            foreignKey,
-            as: options.as || '',
-            options,
-        };
-    });
-}
-exports.default = {
-    HasMany,
-    getHasMany,
-    getAllHasMany,
-    processHasManyDecorators,
-};

package/dist/decorators/has-one.js

@@ -1,116 +0,0 @@
-"use strict";
-/**
- * HasOne decorator for the ORM.
- *
- * Defines a one-to-one relationship between models.
- *
- * Usage:
- *
- *   @HasOne(() => Profile)
- *   profile: Profile;
- *
- *   @HasOne(() => Profile, { as: 'userProfile' })
- *   userProfile: Profile;
- *
- *   // With options
- *   @HasOne(() => Profile, {
- *     foreignKey: { name: 'user_id', allowNull: false },
- *     onDelete: 'CASCADE'
- *   })
- *   profile: Profile;
- *
- *   // Self-referential
- *   @HasOne(() => User, { as: 'manager', foreignKey: 'manager_id' })
- *   manager: User;
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getHasOne = getHasOne;
-exports.getAllHasOne = getAllHasOne;
-exports.HasOne = HasOne;
-exports.processHasOneDecorators = processHasOneDecorators;
-// ==================== Metadata Storage ====================
-const HAS_ONE_KEY = '__orm_has_one__';
-/**
- * Get all @HasOne annotations attached to a model constructor.
- */
-function getHasOne(target) {
-    return target[HAS_ONE_KEY] || [];
-}
-/**
- * Get all hasOne associations including inherited ones.
- */
-function getAllHasOne(target) {
-    const associations = [];
-    let current = target;
-    while (current && current.prototype) {
-        const meta = getHasOne(current);
-        associations.push(...meta);
-        current = Object.getPrototypeOf(current);
-        if (current === Object.prototype)
-            break;
-    }
-    return associations;
-}
-// ==================== Decorator ====================
-/**
- * Define a one-to-one relationship.
- *
- * This decorator stores metadata on the model class that can be used
- * by the ORM to establish the association at model initialization time.
- *
- * @param target - A function that returns the target model class
- * @param options - Optional configuration for the association
- */
-function HasOne(target, options = {}) {
-    return function (prototype, propertyKey) {
-        const ModelClass = prototype.constructor;
-        if (!ModelClass[HAS_ONE_KEY]) {
-            ModelClass[HAS_ONE_KEY] = [];
-        }
-        ModelClass[HAS_ONE_KEY].push({
-            target,
-            options: {
-                as: options.as || propertyKey.toString(),
-                foreignKey: options.foreignKey,
-                constraints: options.constraints,
-                onDelete: options.onDelete,
-                onUpdate: options.onUpdate,
-                targetKey: options.targetKey,
-                sourceKey: options.sourceKey,
-                inverse: options.inverse,
-            },
-        });
-    };
-}
-/**
- * Process @HasOne decorators and create association configuration.
- *
- * Call this to get the raw association definitions from decorators.
- *
- * @param ModelClass - The model class with @HasOne decorators
- * @returns Array of association configurations
- */
-function processHasOneDecorators(ModelClass) {
-    const decorators = getAllHasOne(ModelClass);
-    return decorators.map(({ target, options }) => {
-        const targetModel = target();
-        const foreignKey = typeof options.foreignKey === 'string'
-            ? options.foreignKey
-            : options.foreignKey?.name
-                ? options.foreignKey.name
-                : `${ModelClass.name}Id`;
-        return {
-            source: ModelClass,
-            target: targetModel,
-            foreignKey,
-            as: options.as || '',
-            options,
-        };
-    });
-}
-exports.default = {
-    HasOne,
-    getHasOne,
-    getAllHasOne,
-    processHasOneDecorators,
-};

package/dist/diagrams/palette.d.ts

@@ -1,138 +0,0 @@
-/**
- * Shared accent-color and theme resolution for the diagram generators.
- *
- * `--color <name>` (or a custom hex string) picks an accent palette used for
- * header bars / banners / entity colors.
- * `--theme light|dark` picks a background/text theme.
- *
- * Both are genuinely applied by ModelDiagram, ERDiagram, RelationalDiagram,
- * SchemaDocDiagram, ChenDiagram (and MigrationDiagram) — changing either flag
- * changes real fill/stroke values in the generated SVG.
- *
- * ─── Industry design system ────────────────────────────────────────────────
- * The DEFAULT look is the "Industry" blueprint design: a #f2f2f3 ground, white
- * cards, hairline dividers, square corners, a solid #5980a6 accent header bar,
- * and Barlow / Barlow Condensed / JetBrains Mono typography. The old vibrant
- * multi-stop gradient palettes are retained as explicit `--color` overrides,
- * but `industry` is now `ACCENT_PALETTES[0]` (the fallback of `resolveAccent`).
- *
- * The exported API is intentionally stable — `AccentPalette` / `ThemeColors`
- * keep their existing fields (new fields are additive & optional), and
- * `resolveAccent` / `resolveTheme` / `rotatedPalettes` keep their signatures —
- * so sibling generators and other callers that import them keep working.
- */
-export interface AccentPalette {
-    name: string;
-    /** Darkest gradient stop / primary header color (also used as a solid fill) */
-    from: string;
-    /** Mid gradient stop — the canonical solid accent fill in the Industry look */
-    mid: string;
-    /** Lightest gradient stop (used for 3-stop gradients / light accents) */
-    to: string;
-    /** Light background tint (badges, footers) */
-    light: string;
-    /** Readable text color on `light` background */
-    text: string;
-    /** Secondary accent (blueprint two-tone; FK marks, alt entities) */
-    accent2?: string;
-    /** Light tint of the secondary accent */
-    accent2Light?: string;
-    /** Readable text on `accent2Light` */
-    accent2Text?: string;
-}
-export declare const INDUSTRY: {
-    readonly ground: "#f2f2f3";
-    readonly surface: "#e9e9ea";
-    readonly card: "#ffffff";
-    readonly text: "#1d1f20";
-    readonly muted: "#7a7a7d";
-    readonly accent: "#5980a6";
-    readonly accent2: "#728fab";
-    readonly accentLight: "#eef6ff";
-    readonly accentText: "#2c455d";
-    readonly accent2Light: "#d6ebff";
-    readonly accent2Text: "#314457";
-    /** Hairline divider — rgba(29,31,32,0.16) */
-    readonly divider: "rgba(29,31,32,0.16)";
-    readonly neutral: {
-        readonly 100: "#f5f5f8";
-        readonly 200: "#e7e7ea";
-        readonly 300: "#d4d4d7";
-        readonly 400: "#b7b7ba";
-        readonly 500: "#98989b";
-        readonly 600: "#7a7a7d";
-        readonly 700: "#5d5d60";
-        readonly 800: "#424244";
-        readonly 900: "#2b2b2d";
-    };
-};
-export declare const FONTS: {
-    /** headings & labels */
-    readonly heading: "\"Barlow Condensed\", system-ui, sans-serif";
-    /** body copy */
-    readonly body: "\"Barlow\", system-ui, sans-serif";
-    /** code / types / mono */
-    readonly mono: "ui-monospace, \"JetBrains Mono\", \"SF Mono\", Menlo, monospace";
-};
-/**
- * A Google-Fonts @import so browser-rendered SVGs pick up Barlow / Barlow
- * Condensed / JetBrains Mono. Non-browser renderers fall back to the system
- * fonts declared alongside each family in `FONTS`.
- */
-export declare const FONT_IMPORT = "@import url('https://fonts.googleapis.com/css2?family=Barlow:wght@400;500;600;700&family=Barlow+Condensed:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500;600;700&display=swap');";
-/** Constraint / cardinality badge tints in the Industry system. */
-export declare const BADGE_TINTS: {
-    /** PK / UQ — accent tint */
-    readonly accent: {
-        readonly bg: "#eef6ff";
-        readonly fg: "#2c455d";
-    };
-    /** FK — accent-2 tint */
-    readonly accent2: {
-        readonly bg: "#d6ebff";
-        readonly fg: "#314457";
-    };
-    /** NN / AI / TS — neutral tint */
-    readonly neutral: {
-        readonly bg: "#f5f5f8";
-        readonly fg: "#424244";
-    };
-};
-export declare const ACCENT_PALETTES: AccentPalette[];
-/**
- * Resolve a `--color` flag value to a concrete palette.
- * Accepts a named palette (case-insensitive) or a hex color string.
- * Falls back to the default Industry palette.
- */
-export declare function resolveAccent(color?: string): AccentPalette;
-/** The secondary accent for a resolved palette, with an Industry fallback. */
-export declare function accent2Of(p: AccentPalette): {
-    color: string;
-    light: string;
-    text: string;
-};
-/**
- * Rotate the palette list so it starts at the resolved accent (used by
- * ERDiagram / RelationalDiagram to color multiple entities while still honoring
- * --color for the first/primary entity).
- */
-export declare function rotatedPalettes(color?: string): AccentPalette[];
-export interface ThemeColors {
-    /** Outer page/canvas background */
-    canvasBg: string;
-    /** Card / entity-box background */
-    cardBg: string;
-    /** Alternating row background (even rows use cardBg) */
-    rowAlt: string;
-    /** Column-header strip background */
-    colHeaderBg: string;
-    /** Primary body text color */
-    textPrimary: string;
-    /** Secondary/muted text color */
-    textSecondary: string;
-    /** Hairline border/divider color */
-    border: string;
-    /** Footer bar background */
-    footerBg: string;
-}
-export declare function resolveTheme(theme?: 'light' | 'dark'): ThemeColors;