ts-prorm-orm 2.0.0 → 2.1.0

package/dist/decorators/generated.js

@@ -9,6 +9,7 @@
  *
  * Usage:
  *
+ * ```ts
  *   // Virtual computed column (default)
  *   @Generated()
  *   get fullName() {
@@ -37,6 +38,7 @@
  *     cache: 1000
  *   })
  *   id: number;
+ * ```
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Generated = Generated;
@@ -65,21 +67,25 @@ const IDENTITY_METADATA_KEY = Symbol('prorm:identity');
  *
  * 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
  */
@@ -103,6 +109,7 @@ function Generated(options) {
  *
  * Usage:
  *
+ * ```ts
  *   @Generated({
  *     identity: true,
  *     start: 1,
@@ -110,6 +117,7 @@ function Generated(options) {
  *     cache: 1000
  *   })
  *   id: number;
+ * ```
  *
  * @param options - Identity configuration options
  */

package/dist/decorators/hstore.d.ts

@@ -6,6 +6,7 @@
  *
  * Usage:
  *
+ * ```ts
  *   // Basic HStore column
  *   @HStore()
  *   attributes: Record<string, string>;
@@ -13,6 +14,7 @@
  *   // With options
  *   @HStore({ allowNull: false })
  *   metadata: Record<string, any>;
+ * ```
  */
 /**
  * Options for HStore column type
@@ -43,14 +45,18 @@ export interface HStoreMetadata {
  * @example
  * // Basic HStore column
  * class Product extends Model {
+ * ```ts
  *   @HStore()
  *   attributes: Record<string, string>;
+ * ```
  * }
  *
  * // With options
  * class Product extends Model {
+ * ```ts
  *   @HStore({ allowNull: false })
  *   metadata: Record<string, any>;
+ * ```
  * }
  */
 export declare function HStore(options?: HStoreDecoratorOptions): PropertyDecorator;

package/dist/decorators/hstore.js

@@ -7,6 +7,7 @@
  *
  * Usage:
  *
+ * ```ts
  *   // Basic HStore column
  *   @HStore()
  *   attributes: Record<string, string>;
@@ -14,6 +15,7 @@
  *   // With options
  *   @HStore({ allowNull: false })
  *   metadata: Record<string, any>;
+ * ```
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HStore = HStore;
@@ -33,14 +35,18 @@ const hstoreMetadataMap = new Map();
  * @example
  * // Basic HStore column
  * class Product extends Model {
+ * ```ts
  *   @HStore()
  *   attributes: Record<string, string>;
+ * ```
  * }
  *
  * // With options
  * class Product extends Model {
+ * ```ts
  *   @HStore({ allowNull: false })
  *   metadata: Record<string, any>;
+ * ```
  * }
  */
 function HStore(options) {

package/dist/decorators/json-column.d.ts

@@ -3,11 +3,13 @@
  *
  * @example
  * class Document extends Model {
+ * ```ts
  *   @JSONColumn()
  *   data: DataTypes.JSONCOLUMN;
  *
  *   @JSONColumn({ validate: true })
  *   config: DataTypes.JSONCOLUMN;
+ * ```
  * }
  */
 import { JSONColumnOptions } from '../types';

package/dist/decorators/json-column.js

@@ -4,11 +4,13 @@
  *
  * @example
  * class Document extends Model {
+ * ```ts
  *   @JSONColumn()
  *   data: DataTypes.JSONCOLUMN;
  *
  *   @JSONColumn({ validate: true })
  *   config: DataTypes.JSONCOLUMN;
+ * ```
  * }
  */
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/decorators/jsonb.d.ts

@@ -6,6 +6,7 @@
  *
  * Usage:
  *
+ * ```ts
  *   // Basic JSONB column
  *   @JSONB()
  *   metadata: object;
@@ -13,6 +14,7 @@
  *   // With validation
  *   @JSONB({ validate: true })
  *   config: object;
+ * ```
  */
 /**
  * Options for JSONB column type
@@ -43,14 +45,18 @@ export interface JSONBMetadata {
  * @example
  * // Basic JSONB column
  * class Document extends Model {
+ * ```ts
  *   @JSONB()
  *   data: object;
+ * ```
  * }
  *
  * // With validation
  * class Config extends Model {
+ * ```ts
  *   @JSONB({ validate: true })
  *   settings: object;
+ * ```
  * }
  */
 export declare function JSONB(options?: JSONBDecoratorOptions): PropertyDecorator;

package/dist/decorators/jsonb.js

@@ -7,6 +7,7 @@
  *
  * Usage:
  *
+ * ```ts
  *   // Basic JSONB column
  *   @JSONB()
  *   metadata: object;
@@ -14,6 +15,7 @@
  *   // With validation
  *   @JSONB({ validate: true })
  *   config: object;
+ * ```
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.JSONB = JSONB;
@@ -31,14 +33,18 @@ const jsonbMetadataMap = new Map();
  * @example
  * // Basic JSONB column
  * class Document extends Model {
+ * ```ts
  *   @JSONB()
  *   data: object;
+ * ```
  * }
  *
  * // With validation
  * class Config extends Model {
+ * ```ts
  *   @JSONB({ validate: true })
  *   settings: object;
+ * ```
  * }
  */
 function JSONB(options) {

package/dist/decorators/permissions.d.ts

@@ -10,11 +10,13 @@
  * Quick Reference
  * ──────────────────────────────────────────────────────────────────────────
  *
+ * ```ts
  *  @CanView('admin', 'manager')     — only these roles can read the field/model
  *  @CannotView('guest')             — these roles are DENIED read access
  *  @CanWrite('admin')               — only these roles can write the field
  *  @CannotWrite('guest')            — these roles are DENIED write access
  *  @Permission({ ... })             — full control with explicit allow/deny lists
+ * ```
  *
  * ──────────────────────────────────────────────────────────────────────────
  * Example
@@ -25,6 +27,7 @@
  *   PermissionRegistry.addFieldRule(User, 'salary',   { canView: ['admin', 'hr'] });
  *   PermissionRegistry.addFieldRule(User, 'password', { canView: [] });  // nobody
  *
+ * ```ts
  *   // Class-level permission (applied via decorator):
  *   @CanView('admin', 'manager')
  *   class AuditLog extends Model { ... }
@@ -38,6 +41,7 @@
  *   // Or get the allowed attribute list for a findAll() call:
  *   const attrs = getAllowedAttributes(User, currentRole);
  *   const users = await User.findAll({ attributes: attrs });
+ * ```
  */
 export interface PermissionRule {
     /**
@@ -144,22 +148,28 @@ export declare function filterWriteByPermissions(data: Record<string, any>, role
  * Allow only the listed roles to VIEW the decorated class (all fields) or
  * use PermissionRegistry.addFieldRule() for per-field control.
  *
+ * ```ts
  *   @CanView('admin', 'manager')
  *   class AuditLog extends Model { ... }
+ * ```
  */
 export declare function CanView(...roles: string[]): (target: Function) => void;
 /**
  * Deny the listed roles from viewing the decorated class.
  *
+ * ```ts
  *   @CannotView('guest', 'public')
  *   class SensitiveReport extends Model { ... }
+ * ```
  */
 export declare function CannotView(...roles: string[]): (target: Function) => void;
 /**
  * Allow only the listed roles to WRITE to the decorated class.
  *
+ * ```ts
  *   @CanWrite('admin')
  *   class Settings extends Model { ... }
+ * ```
  */
 export declare function CanWrite(...roles: string[]): (target: Function) => void;
 /**
@@ -169,8 +179,10 @@ export declare function CannotWrite(...roles: string[]): (target: Function) => v
 /**
  * Full permission decorator — applies read and write rules at the model level.
  *
+ * ```ts
  *   @Permission({ canView: ['admin', 'manager'], canWrite: ['admin'] })
  *   class Invoice extends Model { ... }
+ * ```
  */
 export declare function Permission(options: PermissionOptions): (target: Function) => void;
 /**

package/dist/decorators/permissions.js

@@ -11,11 +11,13 @@
  * Quick Reference
  * ──────────────────────────────────────────────────────────────────────────
  *
+ * ```ts
  *  @CanView('admin', 'manager')     — only these roles can read the field/model
  *  @CannotView('guest')             — these roles are DENIED read access
  *  @CanWrite('admin')               — only these roles can write the field
  *  @CannotWrite('guest')            — these roles are DENIED write access
  *  @Permission({ ... })             — full control with explicit allow/deny lists
+ * ```
  *
  * ──────────────────────────────────────────────────────────────────────────
  * Example
@@ -26,6 +28,7 @@
  *   PermissionRegistry.addFieldRule(User, 'salary',   { canView: ['admin', 'hr'] });
  *   PermissionRegistry.addFieldRule(User, 'password', { canView: [] });  // nobody
  *
+ * ```ts
  *   // Class-level permission (applied via decorator):
  *   @CanView('admin', 'manager')
  *   class AuditLog extends Model { ... }
@@ -39,6 +42,7 @@
  *   // Or get the allowed attribute list for a findAll() call:
  *   const attrs = getAllowedAttributes(User, currentRole);
  *   const users = await User.findAll({ attributes: attrs });
+ * ```
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PermissionRegistry = void 0;
@@ -213,8 +217,10 @@ function filterWriteByPermissions(data, role, ModelClass) {
  * Allow only the listed roles to VIEW the decorated class (all fields) or
  * use PermissionRegistry.addFieldRule() for per-field control.
  *
+ * ```ts
  *   @CanView('admin', 'manager')
  *   class AuditLog extends Model { ... }
+ * ```
  */
 function CanView(...roles) {
     return function (target) {
@@ -224,8 +230,10 @@ function CanView(...roles) {
 /**
  * Deny the listed roles from viewing the decorated class.
  *
+ * ```ts
  *   @CannotView('guest', 'public')
  *   class SensitiveReport extends Model { ... }
+ * ```
  */
 function CannotView(...roles) {
     return function (target) {
@@ -235,8 +243,10 @@ function CannotView(...roles) {
 /**
  * Allow only the listed roles to WRITE to the decorated class.
  *
+ * ```ts
  *   @CanWrite('admin')
  *   class Settings extends Model { ... }
+ * ```
  */
 function CanWrite(...roles) {
     return function (target) {
@@ -254,8 +264,10 @@ function CannotWrite(...roles) {
 /**
  * Full permission decorator — applies read and write rules at the model level.
  *
+ * ```ts
  *   @Permission({ canView: ['admin', 'manager'], canWrite: ['admin'] })
  *   class Invoice extends Model { ... }
+ * ```
  */
 function Permission(options) {
     return function (target) {

package/dist/decorators/procedure.d.ts

@@ -1,12 +1,12 @@
 /**
  * TypeScript decorators for SQL Stored Procedures and SQL Functions.
  *
- * @Procedure  — annotate a class method (or standalone function wrapper) so
+ * `@Procedure`  — annotate a class method (or standalone function wrapper) so
  *               it is understood by the ORM as a stored procedure.
  *               The ORM can generate the CREATE PROCEDURE SQL and register
  *               a callable wrapper on your Prorm instance.
  *
- * @SqlFunction — like @Procedure but for database functions that RETURN a
+ * `@SqlFunction` — like @Procedure but for database functions that RETURN a
  *                value and can be called inside SELECT / WHERE clauses.
  *
  * Both decorators store metadata in a registry. Register the class with
@@ -24,6 +24,7 @@
  *
  * Example:
  *
+ * ```ts
  *   class UserProcedures {
  *     @Procedure({
  *       name: 'get_user_by_email',
@@ -53,6 +54,7 @@
  *
  *   // Or use the auto-call helper
  *   const rows = await ProcedureRegistry.call(prorm, UserProcedures, 'getUserByEmail', ['john@example.com']);
+ * ```
  */
 import type { Prorm } from '../prorm';
 export type ProcedureParamMode = 'IN' | 'OUT' | 'INOUT';

package/dist/decorators/procedure.js

@@ -2,12 +2,12 @@
 /**
  * TypeScript decorators for SQL Stored Procedures and SQL Functions.
  *
- * @Procedure  — annotate a class method (or standalone function wrapper) so
+ * `@Procedure`  — annotate a class method (or standalone function wrapper) so
  *               it is understood by the ORM as a stored procedure.
  *               The ORM can generate the CREATE PROCEDURE SQL and register
  *               a callable wrapper on your Prorm instance.
  *
- * @SqlFunction — like @Procedure but for database functions that RETURN a
+ * `@SqlFunction` — like @Procedure but for database functions that RETURN a
  *                value and can be called inside SELECT / WHERE clauses.
  *
  * Both decorators store metadata in a registry. Register the class with
@@ -25,6 +25,7 @@
  *
  * Example:
  *
+ * ```ts
  *   class UserProcedures {
  *     @Procedure({
  *       name: 'get_user_by_email',
@@ -54,6 +55,7 @@
  *
  *   // Or use the auto-call helper
  *   const rows = await ProcedureRegistry.call(prorm, UserProcedures, 'getUserByEmail', ['john@example.com']);
+ * ```
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ProcedureRegistry = void 0;

package/dist/decorators/query-options.d.ts

@@ -13,6 +13,7 @@
  *
  * Usage:
  *
+ * ```ts
  *   // Index hints
  *   @UseIndex('idx_name')
  *   @ForceIndex('idx_name')
@@ -39,6 +40,7 @@
  *   // TABLESAMPLE
  *   @Tablesample({ method: 'BERNOULLI', percentage: 50 })
  *   async *getSampleUsers() { ... }
+ * ```
  */
 import 'reflect-metadata';
 /**
@@ -238,9 +240,11 @@ export interface QueryOptions {
  *
  * Usage:
  *
+ * ```ts
  *   @UseIndex('idx_user_email')
  *   @UseIndex(['idx_user_email', 'idx_user_status'])
  *   class User extends Model {}
+ * ```
  *
  * @param index - Index name or array of index names
  */
@@ -251,8 +255,10 @@ export declare function UseIndex(index: string | string[]): ClassDecorator;
  *
  * Usage:
  *
+ * ```ts
  *   @ForceIndex('idx_user_email')
  *   class User extends Model {}
+ * ```
  *
  * @param index - Index name
  */
@@ -263,8 +269,10 @@ export declare function ForceIndex(index: string | string[]): ClassDecorator;
  *
  * Usage:
  *
+ * ```ts
  *   @IgnoreIndex('idx_user_email')
  *   class User extends Model {}
+ * ```
  *
  * @param index - Index name
  */
@@ -275,11 +283,13 @@ export declare function IgnoreIndex(index: string | string[]): ClassDecorator;
  *
  * Usage:
  *
+ * ```ts
  *   @Tablesample({ method: 'BERNOULLI', percentage: 50 })
  *   class User extends Model {}
  *
  *   @Tablesample({ method: 'SYSTEM', pages: 100 })
  *   class User extends Model {}
+ * ```
  *
  * @param options - Tablesample options
  */
@@ -289,11 +299,13 @@ export declare function Tablesample(options: TablesampleOptions): ClassDecorator
  *
  * Usage:
  *
+ * ```ts
  *   @Distinct
  *   class User extends Model {}
  *
  *   @DistinctOn(['email'])
  *   class User extends Model {}
+ * ```
  *
  * @param columns - Columns for DISTINCT ON (optional)
  */
@@ -308,11 +320,13 @@ export declare const DistinctOn: typeof Distinct;
  *
  * Usage:
  *
+ * ```ts
  *   @WithLock({ mode: 'UPDATE', timeout: 5000, skipLocked: true })
  *   async processOrder(id: number) {
  *     const order = await Order.findByPk(id, { lock: 'UPDATE' });
  *     // process order
  *   }
+ * ```
  *
  * @param options - Lock options
  */
@@ -323,10 +337,12 @@ export declare function WithLock(options?: WithLockOptions): MethodDecorator;
  *
  * Usage:
  *
+ * ```ts
  *   @StatementTimeout(30000)  // 30 seconds
  *   async runLongQuery() {
  *     return await this.query('SELECT * FROM large_table');
  *   }
+ * ```
  *
  * @param timeout - Timeout in milliseconds
  */
@@ -337,10 +353,12 @@ export declare function StatementTimeout(timeout: number): MethodDecorator;
  *
  * Usage:
  *
+ * ```ts
  *   @IdleInTransactionTimeout(60000)  // 1 minute
  *   async runTransaction() {
  *     // long running transaction
  *   }
+ * ```
  *
  * @param timeout - Timeout in milliseconds
  */
@@ -351,12 +369,14 @@ export declare function IdleInTransactionTimeout(timeout: number): MethodDecorat
  *
  * Usage:
  *
+ * ```ts
  *   @Cursor({ holdable: true })
  *   async *getAllUsers() {
  *     for await (const user of this.findAll({ cursor: true })) {
  *       yield user;
  *     }
  *   }
+ * ```
  *
  * @param options - Cursor options
  */
@@ -367,10 +387,12 @@ export declare function Cursor(options?: CursorOptions): MethodDecorator;
  *
  * Usage:
  *
+ * ```ts
  *   @Fetch(100)
  *   async *getTopUsers() {
  *     return await User.findAll({ limit: 100 });
  *   }
+ * ```
  *
  * @param limit - Number of rows to fetch
  */
@@ -381,10 +403,12 @@ export declare function Fetch(limit: number): MethodDecorator;
  *
  * Usage:
  *
+ * ```ts
  *   @Fetch({ first: 100, offset: 50 })
  *   async *getPageUsers() {
  *     return await User.findAll({ offset: 50, limit: 100 });
  *   }
+ * ```
  *
  * @param options - Fetch options with limit and optional offset
  */