ts-prorm-orm 2.0.0 → 2.1.0

package/dist/decorators/database-settings.d.ts

@@ -10,6 +10,7 @@
  *
  * Usage:
  *
+ * ```ts
  *   // Disable FK checks for entire model
  *   @ForeignKeyChecks({ enabled: false })
  *   class ImportData extends Model {}
@@ -30,6 +31,7 @@
  *     // Bulk import without FK validation
  *     await prorm.setForeignKeyChecks(true);
  *   });
+ * ```
  */
 import 'reflect-metadata';
 /**
@@ -106,10 +108,12 @@ export interface ModelDatabaseSettings {
  *
  * Usage:
  *
+ * ```ts
  *   @ForeignKeyChecks({ enabled: false })
  *   class ImportData extends Model {
  *     // fields...
  *   }
+ * ```
  *
  * @param options - Foreign key check options
  */
@@ -122,12 +126,14 @@ export declare function ForeignKeyChecks(options?: ForeignKeyChecksOptions): Cla
  *
  * Usage:
  *
+ * ```ts
  *   @DatabaseSetting('unique_checks', false)
  *   @DatabaseSetting('autocommit', false)
  *   @DatabaseSetting('sql_mode', 'STRICT_TRANS_TABLES')
  *   class ImportData extends Model {
  *     // fields...
  *   }
+ * ```
  *
  * @param name - The setting name
  * @param value - The value to set

package/dist/decorators/database-settings.js

@@ -11,6 +11,7 @@
  *
  * Usage:
  *
+ * ```ts
  *   // Disable FK checks for entire model
  *   @ForeignKeyChecks({ enabled: false })
  *   class ImportData extends Model {}
@@ -31,6 +32,7 @@
  *     // Bulk import without FK validation
  *     await prorm.setForeignKeyChecks(true);
  *   });
+ * ```
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ForeignKeyChecks = ForeignKeyChecks;
@@ -54,10 +56,12 @@ const DATABASE_SETTINGS_KEY = Symbol('prorm:databaseSettings');
  *
  * Usage:
  *
+ * ```ts
  *   @ForeignKeyChecks({ enabled: false })
  *   class ImportData extends Model {
  *     // fields...
  *   }
+ * ```
  *
  * @param options - Foreign key check options
  */
@@ -74,12 +78,14 @@ function ForeignKeyChecks(options = { enabled: true }) {
  *
  * Usage:
  *
+ * ```ts
  *   @DatabaseSetting('unique_checks', false)
  *   @DatabaseSetting('autocommit', false)
  *   @DatabaseSetting('sql_mode', 'STRICT_TRANS_TABLES')
  *   class ImportData extends Model {
  *     // fields...
  *   }
+ * ```
  *
  * @param name - The setting name
  * @param value - The value to set

package/dist/decorators/default.d.ts

@@ -6,6 +6,7 @@
  *
  * Usage:
  *
+ * ```ts
  *   // Static values
  *   @Default(18)
  *   age: number;
@@ -46,6 +47,7 @@
  *   // Raw SQL only when needed
  *   @Default({ literal: "CURRENT_TIMESTAMP" })
  *   updatedAt: Date;
+ * ```
  */
 /**
  * Options for default value configuration.

package/dist/decorators/default.js

@@ -7,6 +7,7 @@
  *
  * Usage:
  *
+ * ```ts
  *   // Static values
  *   @Default(18)
  *   age: number;
@@ -47,6 +48,7 @@
  *   // Raw SQL only when needed
  *   @Default({ literal: "CURRENT_TIMESTAMP" })
  *   updatedAt: Date;
+ * ```
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getDefaultFields = getDefaultFields;

package/dist/decorators/encryption.d.ts

@@ -23,9 +23,11 @@
  *   }, { prorm });
  *   Secure('password')(User); // field decorator style
  *
+ * ```ts
  *   // Or use the decorator on the class definition (requires experimentalDecorators):
  *   @SecureField('password')
  *   class User extends Model { ... }
+ * ```
  */
 /**
  * Pluggable encryption adapter.
@@ -98,9 +100,11 @@ export declare function getSecureFields(target: Function): SecureFieldMeta[];
  *
  * This is a class decorator factory — pass the field name(s):
  *
+ * ```ts
  *   @SecureField('password')
  *   @SecureField('pin', { algorithm: 'bcrypt', adapter: myAdapter })
  *   class User extends Model { ... }
+ * ```
  *
  * The ORM will call hashSecureFields(instance) in a beforeCreate /
  * beforeUpdate hook to encrypt the field before it reaches the database.
@@ -109,8 +113,10 @@ export declare function SecureField(field: string, options?: SecureOptions): (ta
 /**
  * Alias for SecureField — preferred shorthand.
  *
+ * ```ts
  *   @Secure('password')
  *   class User extends Model { ... }
+ * ```
  */
 export declare const Secure: typeof SecureField;
 /**
@@ -133,7 +139,7 @@ export declare function hashSecureFields(instance: any): Promise<void>;
 export declare function verifySecureField(instance: any, field: string, plainText: string): Promise<boolean>;
 /**
  * Register beforeCreate and beforeUpdate hooks on a model so that
- * @Secure fields are automatically hashed whenever an instance is saved.
+ * `@Secure` fields are automatically hashed whenever an instance is saved.
  *
  * Call once per model after Model.init():
  *

package/dist/decorators/encryption.js

@@ -24,9 +24,11 @@
  *   }, { prorm });
  *   Secure('password')(User); // field decorator style
  *
+ * ```ts
  *   // Or use the decorator on the class definition (requires experimentalDecorators):
  *   @SecureField('password')
  *   class User extends Model { ... }
+ * ```
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Secure = void 0;
@@ -77,9 +79,11 @@ function getSecureFields(target) {
  *
  * This is a class decorator factory — pass the field name(s):
  *
+ * ```ts
  *   @SecureField('password')
  *   @SecureField('pin', { algorithm: 'bcrypt', adapter: myAdapter })
  *   class User extends Model { ... }
+ * ```
  *
  * The ORM will call hashSecureFields(instance) in a beforeCreate /
  * beforeUpdate hook to encrypt the field before it reaches the database.
@@ -95,8 +99,10 @@ function SecureField(field, options = {}) {
 /**
  * Alias for SecureField — preferred shorthand.
  *
+ * ```ts
  *   @Secure('password')
  *   class User extends Model { ... }
+ * ```
  */
 exports.Secure = SecureField;
 // ==================== Runtime Helpers ====================
@@ -161,7 +167,7 @@ async function verifySecureField(instance, field, plainText) {
 }
 /**
  * Register beforeCreate and beforeUpdate hooks on a model so that
- * @Secure fields are automatically hashed whenever an instance is saved.
+ * `@Secure` fields are automatically hashed whenever an instance is saved.
  *
  * Call once per model after Model.init():
  *

package/dist/decorators/engine.d.ts

@@ -15,6 +15,7 @@
  *
  * Example:
  *
+ * ```ts
  *   @Engine({
  *     mergeTreeEngine: { type: 'ReplacingMergeTree', version: 'updatedAt' },
  *     orderBy: ['id', 'createdAt'],
@@ -31,6 +32,7 @@
  *   await dialect.createTable('events', columns, {
  *     ...EngineRegistry.getTableOptions(Event),
  *   });
+ * ```
  */
 import type { MergeTreeEngineConfig, ProjectionDefinition } from '../dialects/clickhouse';
 export interface EngineOptions {
@@ -76,8 +78,10 @@ export declare function getEngineOptions(target: Function): EngineOptions | unde
  * Annotate a Model subclass with dialect-specific storage-engine
  * configuration.
  *
+ * ```ts
  *   @Engine({ mergeTreeEngine: { type: 'AggregatingMergeTree' }, orderBy: ['id'] })
  *   class Metrics extends Model { ... }
+ * ```
  */
 export declare function Engine(options: EngineOptions): (target: Function) => void;
 export declare const EngineRegistry: {

package/dist/decorators/engine.js

@@ -16,6 +16,7 @@
  *
  * Example:
  *
+ * ```ts
  *   @Engine({
  *     mergeTreeEngine: { type: 'ReplacingMergeTree', version: 'updatedAt' },
  *     orderBy: ['id', 'createdAt'],
@@ -32,6 +33,7 @@
  *   await dialect.createTable('events', columns, {
  *     ...EngineRegistry.getTableOptions(Event),
  *   });
+ * ```
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EngineRegistry = void 0;
@@ -51,8 +53,10 @@ function getEngineOptions(target) {
  * Annotate a Model subclass with dialect-specific storage-engine
  * configuration.
  *
+ * ```ts
  *   @Engine({ mergeTreeEngine: { type: 'AggregatingMergeTree' }, orderBy: ['id'] })
  *   class Metrics extends Model { ... }
+ * ```
  */
 function Engine(options) {
     return function (target) {

package/dist/decorators/fk-constraints.d.ts

@@ -13,15 +13,15 @@
  * Usage Examples:
  *
  * // Foreign Key cascade options
- * @OnDelete('CASCADE')
- * @OnUpdate('CASCADE')
- * @References({ model: Role, key: 'id' })
+ * `@OnDelete`('CASCADE')
+ * `@OnUpdate`('CASCADE')
+ * `@References`({ model: Role, key: 'id' })
  * roleId: number;
  *
  * // Multiple FK options with deferrable
- * @OnDelete('RESTRICT')
- * @OnUpdate('SET NULL')
- * @References({
+ * `@OnDelete`('RESTRICT')
+ * `@OnUpdate`('SET NULL')
+ * `@References`({
  *   model: User,
  *   key: 'id',
  *   deferrable: 'INITIALLY DEFERRED'
@@ -29,12 +29,12 @@
  * assignedTo: number;
  *
  * // Deferrable constraint
- * @Deferrable('INITIALLY DEFERRED')
- * @Unique('user_email')
+ * `@Deferrable`('INITIALLY DEFERRED')
+ * `@Unique`('user_email')
  * email: string;
  *
  * // AutoIncrement with custom settings
- * @AutoIncrement({
+ * `@AutoIncrement`({
  *   start: 1000,
  *   increment: 1,
  *   cache: 1000,
@@ -46,7 +46,7 @@
  * id: number;
  *
  * // Sequence-based identity (PostgreSQL)
- * @Identity({
+ * `@Identity`({
  *   type: 'ALWAYS',
  *   start: 1,
  *   increment: 1
@@ -54,14 +54,14 @@
  * id: number;
  *
  * // Generated column (PostgreSQL 12+)
- * @GeneratedAlways({
+ * `@GeneratedAlways`({
  *   as: 'id + 1',
  *   stored: true
  * })
  * sequenceNumber: number;
  *
  * // Exclusion constraint (PostgreSQL)
- * @Exclusion({
+ * `@Exclusion`({
  *   using: 'daterange',
  *   elements: ['daterange WITH &&']
  * })
@@ -193,30 +193,30 @@ export interface ExclusionMetadata {
     options: ExclusionOptions;
 }
 /**
- * @OnDelete - Specify foreign key ON DELETE action
+ * `@OnDelete` - Specify foreign key ON DELETE action
  *
- * @OnDelete('CASCADE')
+ * `@OnDelete`('CASCADE')
  * roleId: number;
  *
  * @param action - The delete action (CASCADE, RESTRICT, SET NULL, SET DEFAULT, NO ACTION)
  */
 export declare function OnDelete(action: ForeignKeyAction): PropertyDecorator;
 /**
- * @OnUpdate - Specify foreign key ON UPDATE action
+ * `@OnUpdate` - Specify foreign key ON UPDATE action
  *
- * @OnUpdate('CASCADE')
+ * `@OnUpdate`('CASCADE')
  * roleId: number;
  *
  * @param action - The update action (CASCADE, RESTRICT, SET NULL, SET DEFAULT, NO ACTION)
  */
 export declare function OnUpdate(action: ForeignKeyAction): PropertyDecorator;
 /**
- * @References - Define foreign key references
+ * `@References` - Define foreign key references
  *
- * @References({ model: Role, key: 'id' })
+ * `@References`({ model: Role, key: 'id' })
  * roleId: number;
  *
- * @References({
+ * `@References`({
  *   model: User,
  *   key: 'id',
  *   deferrable: 'INITIALLY DEFERRED'
@@ -227,13 +227,13 @@ export declare function OnUpdate(action: ForeignKeyAction): PropertyDecorator;
  */
 export declare function References(options: ReferencesOptions): PropertyDecorator;
 /**
- * @Deferrable - Make constraint deferrable
+ * `@Deferrable` - Make constraint deferrable
  *
- * @Deferrable('INITIALLY DEFERRED')
+ * `@Deferrable`('INITIALLY DEFERRED')
  * email: string;
  *
  * // With operation override
- * @Deferrable({
+ * `@Deferrable`({
  *   deferrable: 'INITIALLY IMMEDIATE',
  *   deferFor: 'NOT DEFERRABLE'
  * })
@@ -243,18 +243,18 @@ export declare function References(options: ReferencesOptions): PropertyDecorato
  */
 export declare function Deferrable(options: DeferrableType | DeferrableOptions): PropertyDecorator;
 /**
- * @Unique - Add unique constraint to a column
+ * `@Unique` - Add unique constraint to a column
  *
- * @Unique('user_email')
+ * `@Unique`('user_email')
  * email: string;
  *
  * @param name - Optional constraint name
  */
 export declare function Unique(name?: string): PropertyDecorator;
 /**
- * @AutoIncrement - Configure auto-increment with custom settings
+ * `@AutoIncrement` - Configure auto-increment with custom settings
  *
- * @AutoIncrement({
+ * `@AutoIncrement`({
  *   start: 1000,
  *   increment: 1,
  *   cache: 1000,
@@ -269,9 +269,9 @@ export declare function Unique(name?: string): PropertyDecorator;
  */
 export declare function AutoIncrement(options: AutoIncrementOptions): PropertyDecorator;
 /**
- * @Identity - Configure sequence-based identity (PostgreSQL)
+ * `@Identity` - Configure sequence-based identity (PostgreSQL)
  *
- * @Identity({
+ * `@Identity`({
  *   type: 'ALWAYS',
  *   start: 1,
  *   increment: 1
@@ -282,9 +282,9 @@ export declare function AutoIncrement(options: AutoIncrementOptions): PropertyDe
  */
 export declare function Identity(options: IdentityOptions): PropertyDecorator;
 /**
- * @GeneratedAlways - Define a generated column (PostgreSQL 12+)
+ * `@GeneratedAlways` - Define a generated column (PostgreSQL 12+)
  *
- * @GeneratedAlways({
+ * `@GeneratedAlways`({
  *   as: 'id + 1',
  *   stored: true
  * })
@@ -294,9 +294,9 @@ export declare function Identity(options: IdentityOptions): PropertyDecorator;
  */
 export declare function GeneratedAlways(options: GeneratedAlwaysOptions): PropertyDecorator;
 /**
- * @Exclusion - Define exclusion constraint (PostgreSQL)
+ * `@Exclusion` - Define exclusion constraint (PostgreSQL)
  *
- * @Exclusion({
+ * `@Exclusion`({
  *   using: 'daterange',
  *   elements: ['daterange WITH &&']
  * })

package/dist/decorators/fk-constraints.js

@@ -14,15 +14,15 @@
  * Usage Examples:
  *
  * // Foreign Key cascade options
- * @OnDelete('CASCADE')
- * @OnUpdate('CASCADE')
- * @References({ model: Role, key: 'id' })
+ * `@OnDelete`('CASCADE')
+ * `@OnUpdate`('CASCADE')
+ * `@References`({ model: Role, key: 'id' })
  * roleId: number;
  *
  * // Multiple FK options with deferrable
- * @OnDelete('RESTRICT')
- * @OnUpdate('SET NULL')
- * @References({
+ * `@OnDelete`('RESTRICT')
+ * `@OnUpdate`('SET NULL')
+ * `@References`({
  *   model: User,
  *   key: 'id',
  *   deferrable: 'INITIALLY DEFERRED'
@@ -30,12 +30,12 @@
  * assignedTo: number;
  *
  * // Deferrable constraint
- * @Deferrable('INITIALLY DEFERRED')
- * @Unique('user_email')
+ * `@Deferrable`('INITIALLY DEFERRED')
+ * `@Unique`('user_email')
  * email: string;
  *
  * // AutoIncrement with custom settings
- * @AutoIncrement({
+ * `@AutoIncrement`({
  *   start: 1000,
  *   increment: 1,
  *   cache: 1000,
@@ -47,7 +47,7 @@
  * id: number;
  *
  * // Sequence-based identity (PostgreSQL)
- * @Identity({
+ * `@Identity`({
  *   type: 'ALWAYS',
  *   start: 1,
  *   increment: 1
@@ -55,14 +55,14 @@
  * id: number;
  *
  * // Generated column (PostgreSQL 12+)
- * @GeneratedAlways({
+ * `@GeneratedAlways`({
  *   as: 'id + 1',
  *   stored: true
  * })
  * sequenceNumber: number;
  *
  * // Exclusion constraint (PostgreSQL)
- * @Exclusion({
+ * `@Exclusion`({
  *   using: 'daterange',
  *   elements: ['daterange WITH &&']
  * })
@@ -108,9 +108,9 @@ const GENERATED_ALWAYS_META_KEY = Symbol('orm:generatedAlways');
 const EXCLUSION_META_KEY = Symbol('orm:exclusion');
 // ==================== OnDelete Decorator ====================
 /**
- * @OnDelete - Specify foreign key ON DELETE action
+ * `@OnDelete` - Specify foreign key ON DELETE action
  *
- * @OnDelete('CASCADE')
+ * `@OnDelete`('CASCADE')
  * roleId: number;
  *
  * @param action - The delete action (CASCADE, RESTRICT, SET NULL, SET DEFAULT, NO ACTION)
@@ -126,9 +126,9 @@ function OnDelete(action) {
 }
 // ==================== OnUpdate Decorator ====================
 /**
- * @OnUpdate - Specify foreign key ON UPDATE action
+ * `@OnUpdate` - Specify foreign key ON UPDATE action
  *
- * @OnUpdate('CASCADE')
+ * `@OnUpdate`('CASCADE')
  * roleId: number;
  *
  * @param action - The update action (CASCADE, RESTRICT, SET NULL, SET DEFAULT, NO ACTION)
@@ -144,12 +144,12 @@ function OnUpdate(action) {
 }
 // ==================== References Decorator ====================
 /**
- * @References - Define foreign key references
+ * `@References` - Define foreign key references
  *
- * @References({ model: Role, key: 'id' })
+ * `@References`({ model: Role, key: 'id' })
  * roleId: number;
  *
- * @References({
+ * `@References`({
  *   model: User,
  *   key: 'id',
  *   deferrable: 'INITIALLY DEFERRED'
@@ -169,13 +169,13 @@ function References(options) {
 }
 // ==================== Deferrable Decorator ====================
 /**
- * @Deferrable - Make constraint deferrable
+ * `@Deferrable` - Make constraint deferrable
  *
- * @Deferrable('INITIALLY DEFERRED')
+ * `@Deferrable`('INITIALLY DEFERRED')
  * email: string;
  *
  * // With operation override
- * @Deferrable({
+ * `@Deferrable`({
  *   deferrable: 'INITIALLY IMMEDIATE',
  *   deferFor: 'NOT DEFERRABLE'
  * })
@@ -195,9 +195,9 @@ function Deferrable(options) {
 }
 // ==================== Unique Decorator ====================
 /**
- * @Unique - Add unique constraint to a column
+ * `@Unique` - Add unique constraint to a column
  *
- * @Unique('user_email')
+ * `@Unique`('user_email')
  * email: string;
  *
  * @param name - Optional constraint name
@@ -214,9 +214,9 @@ function Unique(name) {
 }
 // ==================== AutoIncrement Decorator ====================
 /**
- * @AutoIncrement - Configure auto-increment with custom settings
+ * `@AutoIncrement` - Configure auto-increment with custom settings
  *
- * @AutoIncrement({
+ * `@AutoIncrement`({
  *   start: 1000,
  *   increment: 1,
  *   cache: 1000,
@@ -241,9 +241,9 @@ function AutoIncrement(options) {
 }
 // ==================== Identity Decorator ====================
 /**
- * @Identity - Configure sequence-based identity (PostgreSQL)
+ * `@Identity` - Configure sequence-based identity (PostgreSQL)
  *
- * @Identity({
+ * `@Identity`({
  *   type: 'ALWAYS',
  *   start: 1,
  *   increment: 1
@@ -264,9 +264,9 @@ function Identity(options) {
 }
 // ==================== GeneratedAlways Decorator ====================
 /**
- * @GeneratedAlways - Define a generated column (PostgreSQL 12+)
+ * `@GeneratedAlways` - Define a generated column (PostgreSQL 12+)
  *
- * @GeneratedAlways({
+ * `@GeneratedAlways`({
  *   as: 'id + 1',
  *   stored: true
  * })
@@ -286,9 +286,9 @@ function GeneratedAlways(options) {
 }
 // ==================== Exclusion Decorator ====================
 /**
- * @Exclusion - Define exclusion constraint (PostgreSQL)
+ * `@Exclusion` - Define exclusion constraint (PostgreSQL)
  *
- * @Exclusion({
+ * `@Exclusion`({
  *   using: 'daterange',
  *   elements: ['daterange WITH &&']
  * })

package/dist/decorators/foreign-table.d.ts

@@ -1,5 +1,5 @@
 /**
- * @ForeignTable class decorator
+ * `@ForeignTable` class decorator
  * for PostgreSQL FOREIGN TABLE with Redis caching
  */
 import type { Prorm } from '../prorm';

package/dist/decorators/generated.d.ts

@@ -8,6 +8,7 @@
  *
  * Usage:
  *
+ * ```ts
  *   // Virtual computed column (default)
  *   @Generated()
  *   get fullName() {
@@ -36,6 +37,7 @@
  *     cache: 1000
  *   })
  *   id: number;
+ * ```
  */
 import 'reflect-metadata';
 /**
@@ -125,21 +127,25 @@ export interface GeneratedMetadata {
  *
  * Usage with getter (for computed properties):
  *
+ * ```ts
  *   class User extends Model {
  *     @Generated()
  *     get fullName() {
  *       return `${this.firstName} ${this.lastName}`;
  *     }
  *   }
+ * ```
  *
  * Usage with options:
  *
+ * ```ts
  *   @Generated({
  *     as: 'CONCAT(first_name, " ", last_name)',
  *     type: 'varchar(255)',
  *     stored: true
  *   })
  *   fullName: string;
+ * ```
  *
  * @param options - Generated column options or just storage type
  */
@@ -149,6 +155,7 @@ export declare function Generated(options?: GeneratedOptions | GeneratedType): P
  *
  * Usage:
  *
+ * ```ts
  *   @Generated({
  *     identity: true,
  *     start: 1,
@@ -156,6 +163,7 @@ export declare function Generated(options?: GeneratedOptions | GeneratedType): P
  *     cache: 1000
  *   })
  *   id: number;
+ * ```
  *
  * @param options - Identity configuration options
  */