ts-prorm-orm 2.0.0 → 2.1.0

package/dist/compliance/security-decorator.d.ts

@@ -5,6 +5,7 @@
  * based on a list of security frameworks. Works with the 12 compliance classes.
  *
  * Usage:
+ * ```ts
  *   @Security({
  *     frameworks: ['GDPR', 'HIPAA', 'PCI_DSS'],
  *     audit: true,
@@ -19,6 +20,7 @@
  *     immutable: true,
  *   })
  *   class FinancialRecord extends Model { ... }
+ * ```
  */
 import { RetentionDuration } from './data-retention';
 /**
@@ -260,6 +262,7 @@ export interface SecurityOptions {
  * @param options - Security configuration
  *
  * @example
+ * ```ts
  *   @Security({
  *     frameworks: ['GDPR', 'HIPAA', 'PCI_DSS'],
  *     audit: true,
@@ -269,6 +272,7 @@ export interface SecurityOptions {
  *     autoClassify: true,
  *   })
  *   class Patient extends Model { ... }
+ * ```
  */
 export declare function Security(options: SecurityOptions): (target: any) => void;
 /**
@@ -313,12 +317,14 @@ export interface TableSecurityOptions {
  * Apply table-level security metadata.
  *
  * @example
+ * ```ts
  *   @Table({
  *     schema: 'financial',
  *     classification: 'CONFIDENTIAL',
  *     rlsEnabled: true,
  *   })
  *   class Transaction extends Model { ... }
+ * ```
  */
 export declare function Table(options?: TableSecurityOptions): (target: any) => void;
 export interface DatabaseSecurityOptions {
@@ -355,6 +361,7 @@ export interface DatabaseSecurityOptions {
  * Apply database-level security metadata.
  *
  * @example
+ * ```ts
  *   @Database({
  *     name: 'healthcare_db',
  *     region: 'us-east-1',
@@ -364,6 +371,7 @@ export interface DatabaseSecurityOptions {
  *     allowedCountries: ['US'],
  *   })
  *   class HealthcareDB extends Model { ... }
+ * ```
  */
 export declare function Database(options: DatabaseSecurityOptions): (target: any) => void;
 /**

package/dist/compliance/security-decorator.js

@@ -6,6 +6,7 @@
  * based on a list of security frameworks. Works with the 12 compliance classes.
  *
  * Usage:
+ * ```ts
  *   @Security({
  *     frameworks: ['GDPR', 'HIPAA', 'PCI_DSS'],
  *     audit: true,
@@ -20,6 +21,7 @@
  *     immutable: true,
  *   })
  *   class FinancialRecord extends Model { ... }
+ * ```
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FrameworkRequirements = exports.FrameworkCount = exports.FrameworkCategories = exports.AllFrameworks = exports.SecurityFramework = void 0;
@@ -324,6 +326,7 @@ exports.FrameworkRequirements = {
  * @param options - Security configuration
  *
  * @example
+ * ```ts
  *   @Security({
  *     frameworks: ['GDPR', 'HIPAA', 'PCI_DSS'],
  *     audit: true,
@@ -333,6 +336,7 @@ exports.FrameworkRequirements = {
  *     autoClassify: true,
  *   })
  *   class Patient extends Model { ... }
+ * ```
  */
 function Security(options) {
     return function (target) {
@@ -510,12 +514,14 @@ function setupAllSecurity(prorm) {
  * Apply table-level security metadata.
  *
  * @example
+ * ```ts
  *   @Table({
  *     schema: 'financial',
  *     classification: 'CONFIDENTIAL',
  *     rlsEnabled: true,
  *   })
  *   class Transaction extends Model { ... }
+ * ```
  */
 function Table(options = {}) {
     return function (target) {
@@ -526,6 +532,7 @@ function Table(options = {}) {
  * Apply database-level security metadata.
  *
  * @example
+ * ```ts
  *   @Database({
  *     name: 'healthcare_db',
  *     region: 'us-east-1',
@@ -535,6 +542,7 @@ function Table(options = {}) {
  *     allowedCountries: ['US'],
  *   })
  *   class HealthcareDB extends Model { ... }
+ * ```
  */
 function Database(options) {
     return function (target) {

package/dist/compliance/session-isolation.d.ts

@@ -28,9 +28,11 @@
  *     return db.User.findAll();
  *   });
  *
+ * ```ts
  *   // Use the decorator on models:
  *   @TenantIsolation({ tenantId: 'tenantId', auditEnabled: true })
  *   class Document extends Model { ... }
+ * ```
  */
 export interface TenantContext {
     /** The tenant identifier */
@@ -234,11 +236,13 @@ export declare class SessionIsolation {
 /**
  * Decorator to apply tenant isolation to a model.
  *
+ * ```ts
  *   @TenantIsolation({ tenantId: 'tenantId', auditEnabled: true })
  *   class Document extends Model {
  *     tenantId: string;
  *     title: string;
  *   }
+ * ```
  *
  * @param options - Tenant isolation options
  */

package/dist/compliance/session-isolation.js

@@ -29,9 +29,11 @@
  *     return db.User.findAll();
  *   });
  *
+ * ```ts
  *   // Use the decorator on models:
  *   @TenantIsolation({ tenantId: 'tenantId', auditEnabled: true })
  *   class Document extends Model { ... }
+ * ```
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TenantIsolationManager = exports.SessionIsolation = void 0;
@@ -347,11 +349,13 @@ exports.SessionIsolation = SessionIsolation;
 /**
  * Decorator to apply tenant isolation to a model.
  *
+ * ```ts
  *   @TenantIsolation({ tenantId: 'tenantId', auditEnabled: true })
  *   class Document extends Model {
  *     tenantId: string;
  *     title: string;
  *   }
+ * ```
  *
  * @param options - Tenant isolation options
  */

package/dist/compliance/worm-storage.d.ts

@@ -30,9 +30,11 @@
  *   // Enforce retention policy:
  *   await WORMStorage.enforceRetention(FinancialRecord, prorm);
  *
+ * ```ts
  *   // Using the decorator:
  *   @WORM({ retentionPeriod: { years: 7 }, tamperEvident: true })
  *   class FinancialRecord extends Model { ... }
+ * ```
  */
 import { ModelStatic, Prorm } from '../prorm';
 import { RetentionDuration } from './data-retention';
@@ -91,8 +93,10 @@ interface WORMConfig {
 /**
  * Decorator to mark a model for WORM storage.
  *
+ * ```ts
  *   @WORM({ retentionPeriod: { years: 7 }, tamperEvident: true })
  *   class FinancialRecord extends Model { ... }
+ * ```
  */
 export declare function WORM(options: WORMOptions): (target: Function) => void;
 /**

package/dist/compliance/worm-storage.js

@@ -31,9 +31,11 @@
  *   // Enforce retention policy:
  *   await WORMStorage.enforceRetention(FinancialRecord, prorm);
  *
+ * ```ts
  *   // Using the decorator:
  *   @WORM({ retentionPeriod: { years: 7 }, tamperEvident: true })
  *   class FinancialRecord extends Model { ... }
+ * ```
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WORMStorage = void 0;
@@ -173,8 +175,10 @@ function createWORMTamperLogModel(prorm, tableName) {
 /**
  * Decorator to mark a model for WORM storage.
  *
+ * ```ts
  *   @WORM({ retentionPeriod: { years: 7 }, tamperEvident: true })
  *   class FinancialRecord extends Model { ... }
+ * ```
  */
 function WORM(options) {
     return function (target) {

package/dist/decorators/audit.d.ts

@@ -1,5 +1,5 @@
 /**
- * @Audit class decorator — automatically record model lifecycle events to an
+ * `@Audit` class decorator — automatically record model lifecycle events to an
  * in-memory audit log.
  *
  * When applied to a model class the decorator registers beforeCreate,
@@ -8,12 +8,14 @@
  *
  * Example:
  *
+ * ```ts
  *   @Audit({ tableName: 'audit_log', trackFields: ['name', 'email'] })
  *   class User extends Model { ... }
  *
  *   // After create/update/destroy hooks fire:
  *   const log = getAuditLog(User);
  *   clearAuditLog(User);
+ * ```
  */
 export interface AuditOptions {
     /** Name of the conceptual audit table (used as label in entries). Default: 'audit_log'. */

package/dist/decorators/audit.js

@@ -1,6 +1,6 @@
 "use strict";
 /**
- * @Audit class decorator — automatically record model lifecycle events to an
+ * `@Audit` class decorator — automatically record model lifecycle events to an
  * in-memory audit log.
  *
  * When applied to a model class the decorator registers beforeCreate,
@@ -9,12 +9,14 @@
  *
  * Example:
  *
+ * ```ts
  *   @Audit({ tableName: 'audit_log', trackFields: ['name', 'email'] })
  *   class User extends Model { ... }
  *
  *   // After create/update/destroy hooks fire:
  *   const log = getAuditLog(User);
  *   clearAuditLog(User);
+ * ```
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getAuditLog = getAuditLog;

package/dist/decorators/check.d.ts

@@ -1,34 +1,34 @@
 /**
- * @Check decorator for the ORM — generates CHECK constraints without writing raw SQL.
+ * `@Check` decorator for the ORM — generates CHECK constraints without writing raw SQL.
  *
  * Supports ORM-native operator syntax that gets converted to SQL CHECK expressions.
  *
  * Usage Examples:
  *
  * // Column-level check with ORM operators
- * @Check({ age: { $gte: 18 } })
+ * `@Check`({ age: { $gte: 18 } })
  * age: number;
  *
  * // Multiple column checks
- * @Check({
+ * `@Check`({
  *   status: { $in: ['active', 'pending', 'draft'] },
  *   email: { $regex: '^[^@]+@[^@]+$' }
  * })
  * email: string;
  *
  * // Custom condition with message
- * @Check({
+ * `@Check`({
  *   condition: (row) => row.startDate < row.endDate,
  *   message: 'Start date must be before end date'
  * })
  * startDate: Date;
  *
  * // Column-level check (explicit column)
- * @CheckColumn('price', { $gte: 0 }, 'Price must be positive')
- * @CheckColumn('quantity', { $gt: 0 }, 'Quantity must be greater than zero')
+ * `@CheckColumn`('price', { $gte: 0 }, 'Price must be positive')
+ * `@CheckColumn`('quantity', { $gt: 0 }, 'Quantity must be greater than zero')
  *
  * // Table-level check (multiple columns)
- * @CheckTable({
+ * `@CheckTable`({
  *   condition: (row) => row.quantity * row.price >= row.minimumOrder,
  *   message: 'Total must meet minimum order amount'
  * })
@@ -155,21 +155,21 @@ export type CheckDialect = 'mysql' | 'mariadb' | 'postgres' | 'mssql' | 'oracle'
  */
 export declare function operatorToSQL(fieldName: string, operator: CheckOperator, dialect?: CheckDialect): string;
 /**
- * @Check decorator — attach CHECK constraints to a column or multiple columns.
+ * `@Check` decorator — attach CHECK constraints to a column or multiple columns.
  *
  * For column-level use (on class property):
- * @Check({ age: { $gte: 18 } })
+ * `@Check`({ age: { $gte: 18 } })
  * age: number;
  *
  * For multiple checks:
- * @Check({
+ * `@Check`({
  *   status: { $in: ['active', 'pending'] },
  *   email: { $regex: '^[^@]+@[^@]+$' }
  * })
  * email: string;
  *
  * For row-level condition:
- * @Check({
+ * `@Check`({
  *   condition: (row) => row.startDate < row.endDate,
  *   message: 'Start date must be before end date'
  * })
@@ -177,16 +177,16 @@ export declare function operatorToSQL(fieldName: string, operator: CheckOperator
  */
 export declare function Check(options: CheckConstraintOptions): PropertyDecorator;
 /**
- * @CheckColumn decorator — explicit column-level CHECK constraint.
+ * `@CheckColumn` decorator — explicit column-level CHECK constraint.
  *
- * @CheckColumn('price', { $gte: 0 }, 'Price must be positive')
+ * `@CheckColumn`('price', { $gte: 0 }, 'Price must be positive')
  * price: number;
  */
 export declare function CheckColumn(column: string, operator: CheckOperator, message?: string): PropertyDecorator;
 /**
- * @CheckTable decorator — table-level CHECK constraint with multi-column conditions.
+ * `@CheckTable` decorator — table-level CHECK constraint with multi-column conditions.
  *
- * @CheckTable({
+ * `@CheckTable`({
  *   condition: (row) => row.quantity * row.price >= row.minimumOrder,
  *   message: 'Total must meet minimum order amount'
  * })

package/dist/decorators/check.js

@@ -1,35 +1,35 @@
 "use strict";
 /**
- * @Check decorator for the ORM — generates CHECK constraints without writing raw SQL.
+ * `@Check` decorator for the ORM — generates CHECK constraints without writing raw SQL.
  *
  * Supports ORM-native operator syntax that gets converted to SQL CHECK expressions.
  *
  * Usage Examples:
  *
  * // Column-level check with ORM operators
- * @Check({ age: { $gte: 18 } })
+ * `@Check`({ age: { $gte: 18 } })
  * age: number;
  *
  * // Multiple column checks
- * @Check({
+ * `@Check`({
  *   status: { $in: ['active', 'pending', 'draft'] },
  *   email: { $regex: '^[^@]+@[^@]+$' }
  * })
  * email: string;
  *
  * // Custom condition with message
- * @Check({
+ * `@Check`({
  *   condition: (row) => row.startDate < row.endDate,
  *   message: 'Start date must be before end date'
  * })
  * startDate: Date;
  *
  * // Column-level check (explicit column)
- * @CheckColumn('price', { $gte: 0 }, 'Price must be positive')
- * @CheckColumn('quantity', { $gt: 0 }, 'Quantity must be greater than zero')
+ * `@CheckColumn`('price', { $gte: 0 }, 'Price must be positive')
+ * `@CheckColumn`('quantity', { $gt: 0 }, 'Quantity must be greater than zero')
  *
  * // Table-level check (multiple columns)
- * @CheckTable({
+ * `@CheckTable`({
  *   condition: (row) => row.quantity * row.price >= row.minimumOrder,
  *   message: 'Total must meet minimum order amount'
  * })
@@ -270,21 +270,21 @@ function conditionToSQL(condition, paramNames) {
 }
 // ==================== Decorators ====================
 /**
- * @Check decorator — attach CHECK constraints to a column or multiple columns.
+ * `@Check` decorator — attach CHECK constraints to a column or multiple columns.
  *
  * For column-level use (on class property):
- * @Check({ age: { $gte: 18 } })
+ * `@Check`({ age: { $gte: 18 } })
  * age: number;
  *
  * For multiple checks:
- * @Check({
+ * `@Check`({
  *   status: { $in: ['active', 'pending'] },
  *   email: { $regex: '^[^@]+@[^@]+$' }
  * })
  * email: string;
  *
  * For row-level condition:
- * @Check({
+ * `@Check`({
  *   condition: (row) => row.startDate < row.endDate,
  *   message: 'Start date must be before end date'
  * })
@@ -328,9 +328,9 @@ function Check(options) {
     };
 }
 /**
- * @CheckColumn decorator — explicit column-level CHECK constraint.
+ * `@CheckColumn` decorator — explicit column-level CHECK constraint.
  *
- * @CheckColumn('price', { $gte: 0 }, 'Price must be positive')
+ * `@CheckColumn`('price', { $gte: 0 }, 'Price must be positive')
  * price: number;
  */
 function CheckColumn(column, operator, message) {
@@ -348,9 +348,9 @@ function CheckColumn(column, operator, message) {
     };
 }
 /**
- * @CheckTable decorator — table-level CHECK constraint with multi-column conditions.
+ * `@CheckTable` decorator — table-level CHECK constraint with multi-column conditions.
  *
- * @CheckTable({
+ * `@CheckTable`({
  *   condition: (row) => row.quantity * row.price >= row.minimumOrder,
  *   message: 'Total must meet minimum order amount'
  * })

package/dist/decorators/collate.d.ts

@@ -6,6 +6,7 @@
  *
  * Usage:
  *
+ * ```ts
  *   // Column-level collation
  *   class User extends Model {
  *     @SetCollate(CollateEnum.UTF8MB4_UNICODE_CI)
@@ -38,6 +39,7 @@
  *     lcCtype: 'es_ES.UTF-8',
  *     template: 'template0',
  *   });
+ * ```
  */
 /**
  * MySQL/MariaDB collation constants
@@ -255,33 +257,42 @@ export interface OrderByOptions {
  * Decorator to set column-level collation
  *
  * Usage:
+ * ```ts
  *   @Collate(Collate.UTF8MB4_UNICODE_CI)
  *   @Column
  *   name: string;
+ * ```
  *
  * Or with options:
+ * ```ts
  *   @Collate({ collate: Collate.UTF8MB4_BIN, unique: true })
  *   @Column
  *   email: string;
+ * ```
  */
 /**
  * Decorator to set column-level collation
  *
  * Usage:
+ * ```ts
  *   @SetCollate(CollateEnum.UTF8MB4_UNICODE_CI)
  *   @Column
  *   name: string;
+ * ```
  *
  * Or with options:
+ * ```ts
  *   @SetCollate({ collate: CollateEnum.UTF8MB4_BIN, unique: true })
  *   @Column
  *   email: string;
+ * ```
  */
 export declare function SetCollate(collation: string | CollateOptions): ClassDecorator & PropertyDecorator;
 /**
  * Decorator to set database-level options
  *
  * Usage:
+ * ```ts
  *   @Database({
  *     name: 'miapp',
  *     encoding: 'UTF8',
@@ -290,22 +301,27 @@ export declare function SetCollate(collation: string | CollateOptions): ClassDec
  *     connectionLimit: 25,
  *   })
  *   class Config extends Model {}
+ * ```
  */
 export declare function Database(options: DatabaseOptions): ClassDecorator;
 /**
  * Decorator to set table-level collation and options
  *
  * Usage:
+ * ```ts
  *   @TableCollate({ collate: 'utf8mb4_spanish_ci', engine: 'InnoDB' })
  *   class User extends Model {}
+ * ```
  */
 export declare function TableCollate(options: TableCollateOptions): ClassDecorator;
 /**
  * Decorator to specify order by with collation
  *
  * Usage:
+ * ```ts
  *   @OrderBy('name', 'ASC', Collate.UTF8MB4_SPANISH_CI)
  *   class User extends Model {}
+ * ```
  */
 export declare function OrderBy(column: string, direction?: 'ASC' | 'DESC', collate?: string): ClassDecorator;
 /**

package/dist/decorators/collate.js

@@ -7,6 +7,7 @@
  *
  * Usage:
  *
+ * ```ts
  *   // Column-level collation
  *   class User extends Model {
  *     @SetCollate(CollateEnum.UTF8MB4_UNICODE_CI)
@@ -39,6 +40,7 @@
  *     lcCtype: 'es_ES.UTF-8',
  *     template: 'template0',
  *   });
+ * ```
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Locale = exports.LocaleEnum = exports.Collate = exports.CollateEnum = void 0;
@@ -158,27 +160,35 @@ const orderByMetadata = new Map();
  * Decorator to set column-level collation
  *
  * Usage:
+ * ```ts
  *   @Collate(Collate.UTF8MB4_UNICODE_CI)
  *   @Column
  *   name: string;
+ * ```
  *
  * Or with options:
+ * ```ts
  *   @Collate({ collate: Collate.UTF8MB4_BIN, unique: true })
  *   @Column
  *   email: string;
+ * ```
  */
 /**
  * Decorator to set column-level collation
  *
  * Usage:
+ * ```ts
  *   @SetCollate(CollateEnum.UTF8MB4_UNICODE_CI)
  *   @Column
  *   name: string;
+ * ```
  *
  * Or with options:
+ * ```ts
  *   @SetCollate({ collate: CollateEnum.UTF8MB4_BIN, unique: true })
  *   @Column
  *   email: string;
+ * ```
  */
 function SetCollate(collation) {
     return function (target, propertyKey) {
@@ -202,6 +212,7 @@ function SetCollate(collation) {
  * Decorator to set database-level options
  *
  * Usage:
+ * ```ts
  *   @Database({
  *     name: 'miapp',
  *     encoding: 'UTF8',
@@ -210,6 +221,7 @@ function SetCollate(collation) {
  *     connectionLimit: 25,
  *   })
  *   class Config extends Model {}
+ * ```
  */
 function Database(options) {
     return function (target) {
@@ -220,8 +232,10 @@ function Database(options) {
  * Decorator to set table-level collation and options
  *
  * Usage:
+ * ```ts
  *   @TableCollate({ collate: 'utf8mb4_spanish_ci', engine: 'InnoDB' })
  *   class User extends Model {}
+ * ```
  */
 function TableCollate(options) {
     return function (target) {
@@ -232,8 +246,10 @@ function TableCollate(options) {
  * Decorator to specify order by with collation
  *
  * Usage:
+ * ```ts
  *   @OrderBy('name', 'ASC', Collate.UTF8MB4_SPANISH_CI)
  *   class User extends Model {}
+ * ```
  */
 function OrderBy(column, direction = 'ASC', collate) {
     return function (target) {

package/dist/decorators/comment.d.ts

@@ -1,5 +1,5 @@
 /**
- * @Comment decorator for database schema annotations
+ * `@Comment` decorator for database schema annotations
  *
  * Provides the ability to add comments to various database objects:
  * - Table-level comments (on model classes)
@@ -9,6 +9,7 @@
  *
  * Usage:
  *
+ * ```ts
  *  @Comment('This table stores user information')
  *  class User extends Model { ... }
  *
@@ -19,6 +20,7 @@
  *  @Column
  *  @Comment('User email address')
  *  email: string;
+ * ```
  */
 export interface CommentOptions {
     value: string;

package/dist/decorators/comment.js

@@ -1,6 +1,6 @@
 "use strict";
 /**
- * @Comment decorator for database schema annotations
+ * `@Comment` decorator for database schema annotations
  *
  * Provides the ability to add comments to various database objects:
  * - Table-level comments (on model classes)
@@ -10,6 +10,7 @@
  *
  * Usage:
  *
+ * ```ts
  *  @Comment('This table stores user information')
  *  class User extends Model { ... }
  *
@@ -20,6 +21,7 @@
  *  @Column
  *  @Comment('User email address')
  *  email: string;
+ * ```
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommentRegistry = void 0;