ts-prorm-orm 1.2.3 → 2.1.0

package/dist/decorators/query-options.js

@@ -14,6 +14,7 @@
  *
  * Usage:
  *
+ * ```ts
  *   // Index hints
  *   @UseIndex('idx_name')
  *   @ForceIndex('idx_name')
@@ -40,6 +41,7 @@
  *   // TABLESAMPLE
  *   @Tablesample({ method: 'BERNOULLI', percentage: 50 })
  *   async *getSampleUsers() { ... }
+ * ```
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DistinctOn = void 0;
@@ -88,9 +90,11 @@ const DISTINCT_KEY = Symbol('prorm:distinct');
  *
  * 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
  */
@@ -108,8 +112,10 @@ function UseIndex(index) {
  *
  * Usage:
  *
+ * ```ts
  *   @ForceIndex('idx_user_email')
  *   class User extends Model {}
+ * ```
  *
  * @param index - Index name
  */
@@ -127,8 +133,10 @@ function ForceIndex(index) {
  *
  * Usage:
  *
+ * ```ts
  *   @IgnoreIndex('idx_user_email')
  *   class User extends Model {}
+ * ```
  *
  * @param index - Index name
  */
@@ -146,11 +154,13 @@ function IgnoreIndex(index) {
  *
  * Usage:
  *
+ * ```ts
  *   @Tablesample({ method: 'BERNOULLI', percentage: 50 })
  *   class User extends Model {}
  *
  *   @Tablesample({ method: 'SYSTEM', pages: 100 })
  *   class User extends Model {}
+ * ```
  *
  * @param options - Tablesample options
  */
@@ -164,11 +174,13 @@ function Tablesample(options) {
  *
  * Usage:
  *
+ * ```ts
  *   @Distinct
  *   class User extends Model {}
  *
  *   @DistinctOn(['email'])
  *   class User extends Model {}
+ * ```
  *
  * @param columns - Columns for DISTINCT ON (optional)
  */
@@ -193,11 +205,13 @@ exports.DistinctOn = 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
  */
@@ -226,10 +240,12 @@ function WithLock(options = {}) {
  *
  * Usage:
  *
+ * ```ts
  *   @StatementTimeout(30000)  // 30 seconds
  *   async runLongQuery() {
  *     return await this.query('SELECT * FROM large_table');
  *   }
+ * ```
  *
  * @param timeout - Timeout in milliseconds
  */
@@ -252,10 +268,12 @@ function StatementTimeout(timeout) {
  *
  * Usage:
  *
+ * ```ts
  *   @IdleInTransactionTimeout(60000)  // 1 minute
  *   async runTransaction() {
  *     // long running transaction
  *   }
+ * ```
  *
  * @param timeout - Timeout in milliseconds
  */
@@ -271,12 +289,14 @@ function IdleInTransactionTimeout(timeout) {
  *
  * Usage:
  *
+ * ```ts
  *   @Cursor({ holdable: true })
  *   async *getAllUsers() {
  *     for await (const user of this.findAll({ cursor: true })) {
  *       yield user;
  *     }
  *   }
+ * ```
  *
  * @param options - Cursor options
  */
@@ -297,10 +317,12 @@ function Cursor(options = {}) {
  *
  * Usage:
  *
+ * ```ts
  *   @Fetch(100)
  *   async *getTopUsers() {
  *     return await User.findAll({ limit: 100 });
  *   }
+ * ```
  *
  * @param limit - Number of rows to fetch
  */
@@ -316,10 +338,12 @@ function Fetch(limit) {
  *
  * 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
  */

package/dist/decorators/range.d.ts

@@ -6,6 +6,7 @@
  *
  * Usage:
  *
+ * ```ts
  *   // Timestamp range
  *   @Range('tsrange')
  *   duration: [Date, Date];
@@ -17,6 +18,7 @@
  *   // Date range
  *   @Range('daterange')
  *   dates: [string, string];
+ * ```
  */
 import type { RangeSubtype } from '../types';
 /**
@@ -52,20 +54,26 @@ export interface RangeMetadata {
  * @example
  * // Timestamp range
  * class Reservation extends Model {
+ * ```ts
  *   @Range({ subtype: 'tsrange' })
  *   during: [Date, Date];
+ * ```
  * }
  *
  * // Date range
  * class Event extends Model {
+ * ```ts
  *   @Range({ subtype: 'daterange' })
  *   dates: [string, string];
+ * ```
  * }
  *
  * // Integer range
  * class Inventory extends Model {
+ * ```ts
  *   @Range({ subtype: 'int4range', allowNull: false })
  *   quantity: [number, number];
+ * ```
  * }
  */
 export declare function Range(options: RangeDecoratorOptions): PropertyDecorator;

package/dist/decorators/range.js

@@ -7,6 +7,7 @@
  *
  * Usage:
  *
+ * ```ts
  *   // Timestamp range
  *   @Range('tsrange')
  *   duration: [Date, Date];
@@ -18,6 +19,7 @@
  *   // Date range
  *   @Range('daterange')
  *   dates: [string, string];
+ * ```
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Range = Range;
@@ -38,20 +40,26 @@ const rangeMetadataMap = new Map();
  * @example
  * // Timestamp range
  * class Reservation extends Model {
+ * ```ts
  *   @Range({ subtype: 'tsrange' })
  *   during: [Date, Date];
+ * ```
  * }
  *
  * // Date range
  * class Event extends Model {
+ * ```ts
  *   @Range({ subtype: 'daterange' })
  *   dates: [string, string];
+ * ```
  * }
  *
  * // Integer range
  * class Inventory extends Model {
+ * ```ts
  *   @Range({ subtype: 'int4range', allowNull: false })
  *   quantity: [number, number];
+ * ```
  * }
  */
 function Range(options) {

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

@@ -3,11 +3,13 @@
  *
  * @example
  * class Options extends Model {
+ * ```ts
  *   @SetColumn(['red', 'green', 'blue'])
  *   colors: DataTypes.SET;
  *
  *   @SetColumn('a', 'b', 'c')
  *   flags: DataTypes.SET;
+ * ```
  * }
  */
 import { SetColumnOptions } from '../types';

package/dist/decorators/set-column.js

@@ -4,11 +4,13 @@
  *
  * @example
  * class Options extends Model {
+ * ```ts
  *   @SetColumn(['red', 'green', 'blue'])
  *   colors: DataTypes.SET;
  *
  *   @SetColumn('a', 'b', 'c')
  *   flags: DataTypes.SET;
+ * ```
  * }
  */
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/decorators/spatial.d.ts

@@ -3,11 +3,13 @@
  *
  * @example
  * class Location extends Model {
+ * ```ts
  *   @Spatial('POINT', 4326)
  *   point: DataTypes.POINT;
  *
  *   @Spatial('POLYGON')
  *   area: DataTypes.POLYGON;
+ * ```
  * }
  */
 import { SpatialType } from '../types';

package/dist/decorators/spatial.js

@@ -4,11 +4,13 @@
  *
  * @example
  * class Location extends Model {
+ * ```ts
  *   @Spatial('POINT', 4326)
  *   point: DataTypes.POINT;
  *
  *   @Spatial('POLYGON')
  *   area: DataTypes.POLYGON;
+ * ```
  * }
  */
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/decorators/storage.d.ts

@@ -14,6 +14,7 @@
  *
  * Usage:
  *
+ * ```ts
  *   // MySQL/MariaDB storage engine
  *   @Storage({ engine: 'InnoDB', rowFormat: 'DYNAMIC' })
  *   class Order extends Model {}
@@ -40,6 +41,7 @@
  *   // PostgreSQL replica identity
  *   @ReplicaIdentity('FULL')
  *   class SensitiveData extends Model {}
+ * ```
  */
 import 'reflect-metadata';
 /**
@@ -270,11 +272,13 @@ export interface ColumnStorageOptions {
  *
  * Usage:
  *
+ * ```ts
  *   @Storage({ engine: 'InnoDB', rowFormat: 'DYNAMIC' })
  *   class Order extends Model {}
  *
  *   @Storage({ engine: 'MyISAM', rowFormat: 'FIXED' })
  *   class LogData extends Model {}
+ * ```
  *
  * @param options - Storage configuration options
  */
@@ -284,9 +288,11 @@ export declare function Storage(options?: StorageOptions): ClassDecorator;
  *
  * Usage:
  *
+ * ```ts
  *   @Tablespace('fast_storage')
  *   @Table
  *   class LargeTable extends Model {}
+ * ```
  *
  * @param name - Tablespace name
  */
@@ -296,9 +302,11 @@ export declare function Tablespace(name: string): ClassDecorator;
  *
  * Usage:
  *
+ * ```ts
  *   @Tablespace({ name: 'fast_storage', indexTablespace: 'idx_space' })
  *   @Table
  *   class LargeTable extends Model {}
+ * ```
  *
  * @param options - Tablespace options
  */
@@ -308,6 +316,7 @@ export declare function TablespaceOptions(options: TablespaceOptions): ClassDeco
  *
  * Usage:
  *
+ * ```ts
  *   @Clustered(true)
  *   @Index({ columns: ['id'] })
  *   class Data extends Model {}
@@ -315,6 +324,7 @@ export declare function TablespaceOptions(options: TablespaceOptions): ClassDeco
  *   @Clustered({ type: 'nonclustered', include: ['name', 'email'] })
  *   @Index({ columns: ['id'] })
  *   class UserData extends Model {}
+ * ```
  *
  * @param options - Cluster options
  */
@@ -324,9 +334,11 @@ export declare function Clustered(options?: boolean | ClusteredOptions): ClassDe
  *
  * Usage:
  *
+ * ```ts
  *   @Compression({ algorithm: 'lz4', level: 6 })
  *   @Table
  *   class LargeTable extends Model {}
+ * ```
  *
  * @param options - Compression options
  */
@@ -336,11 +348,13 @@ export declare function Compression(options?: CompressionOptions): ClassDecorato
  *
  * Usage:
  *
+ * ```ts
  *   @ReplicaIdentity('FULL')
  *   class SensitiveData extends Model {}
  *
  *   @ReplicaIdentity({ type: 'INDEX', index: 'idx_user_email' })
  *   class UserData extends Model {}
+ * ```
  *
  * @param options - Replica identity type or options
  */
@@ -350,9 +364,11 @@ export declare function ReplicaIdentity(options: string | ReplicaIdentityOptions
  *
  * Usage:
  *
+ * ```ts
  *   @Statistics({ for: 'columns', target: 500 })
  *   @Table
  *   class UserData extends Model {}
+ * ```
  *
  * @param options - Statistics options
  */
@@ -362,9 +378,11 @@ export declare function Statistics(options?: StatisticsOptions): ClassDecorator;
  *
  * Usage:
  *
+ * ```ts
  *   @OnCommit('PRESERVE ROWS')
  *   @Table({ temporary: true })
  *   class TempData extends Model {}
+ * ```
  *
  * @param option - ON COMMIT option
  */
@@ -374,11 +392,13 @@ export declare function OnCommit(option: OnCommitOption): ClassDecorator;
  *
  * Usage:
  *
+ * ```ts
  *   @Inherits('parent_table')
  *   class ChildTable extends Model {}
  *
  *   @Inherits({ parentTable: 'parent', only: true })
  *   class ChildOnlyTable extends Model {}
+ * ```
  *
  * @param options - Inheritance options (table name string or options object)
  */
@@ -388,6 +408,7 @@ export declare function Inherits(options: string | InheritsOptions): ClassDecora
  *
  * Usage:
  *
+ * ```ts
  *   // Range partition by date
  *   @Partition({ type: 'range', column: 'order_date' })
  *   @Table
@@ -402,6 +423,7 @@ export declare function Inherits(options: string | InheritsOptions): ClassDecora
  *   @Partition({ type: 'hash', column: 'id' })
  *   @Table
  *   class Log extends Model {}
+ * ```
  *
  * @param options - Partition configuration options
  */
@@ -411,9 +433,11 @@ export declare function Partition(options: PartitionOptionsInternal): ClassDecor
  *
  * Usage:
  *
+ * ```ts
  *   @Column(DataTypes.BLOB)
  *   @ColumnStorage({ compression: 'pglz' })
  *   blobData: Buffer;
+ * ```
  *
  * @param options - Column storage options
  */

package/dist/decorators/storage.js

@@ -15,6 +15,7 @@
  *
  * Usage:
  *
+ * ```ts
  *   // MySQL/MariaDB storage engine
  *   @Storage({ engine: 'InnoDB', rowFormat: 'DYNAMIC' })
  *   class Order extends Model {}
@@ -41,6 +42,7 @@
  *   // PostgreSQL replica identity
  *   @ReplicaIdentity('FULL')
  *   class SensitiveData extends Model {}
+ * ```
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Storage = Storage;
@@ -91,11 +93,13 @@ const PARTITION_KEY = Symbol('prorm:partition');
  *
  * Usage:
  *
+ * ```ts
  *   @Storage({ engine: 'InnoDB', rowFormat: 'DYNAMIC' })
  *   class Order extends Model {}
  *
  *   @Storage({ engine: 'MyISAM', rowFormat: 'FIXED' })
  *   class LogData extends Model {}
+ * ```
  *
  * @param options - Storage configuration options
  */
@@ -119,9 +123,11 @@ function Storage(options = {}) {
  *
  * Usage:
  *
+ * ```ts
  *   @Tablespace('fast_storage')
  *   @Table
  *   class LargeTable extends Model {}
+ * ```
  *
  * @param name - Tablespace name
  */
@@ -135,9 +141,11 @@ function Tablespace(name) {
  *
  * Usage:
  *
+ * ```ts
  *   @Tablespace({ name: 'fast_storage', indexTablespace: 'idx_space' })
  *   @Table
  *   class LargeTable extends Model {}
+ * ```
  *
  * @param options - Tablespace options
  */
@@ -151,6 +159,7 @@ function TablespaceOptions(options) {
  *
  * Usage:
  *
+ * ```ts
  *   @Clustered(true)
  *   @Index({ columns: ['id'] })
  *   class Data extends Model {}
@@ -158,6 +167,7 @@ function TablespaceOptions(options) {
  *   @Clustered({ type: 'nonclustered', include: ['name', 'email'] })
  *   @Index({ columns: ['id'] })
  *   class UserData extends Model {}
+ * ```
  *
  * @param options - Cluster options
  */
@@ -172,9 +182,11 @@ function Clustered(options = true) {
  *
  * Usage:
  *
+ * ```ts
  *   @Compression({ algorithm: 'lz4', level: 6 })
  *   @Table
  *   class LargeTable extends Model {}
+ * ```
  *
  * @param options - Compression options
  */
@@ -192,11 +204,13 @@ function Compression(options = {}) {
  *
  * Usage:
  *
+ * ```ts
  *   @ReplicaIdentity('FULL')
  *   class SensitiveData extends Model {}
  *
  *   @ReplicaIdentity({ type: 'INDEX', index: 'idx_user_email' })
  *   class UserData extends Model {}
+ * ```
  *
  * @param options - Replica identity type or options
  */
@@ -211,9 +225,11 @@ function ReplicaIdentity(options) {
  *
  * Usage:
  *
+ * ```ts
  *   @Statistics({ for: 'columns', target: 500 })
  *   @Table
  *   class UserData extends Model {}
+ * ```
  *
  * @param options - Statistics options
  */
@@ -231,9 +247,11 @@ function Statistics(options = {}) {
  *
  * Usage:
  *
+ * ```ts
  *   @OnCommit('PRESERVE ROWS')
  *   @Table({ temporary: true })
  *   class TempData extends Model {}
+ * ```
  *
  * @param option - ON COMMIT option
  */
@@ -247,11 +265,13 @@ function OnCommit(option) {
  *
  * Usage:
  *
+ * ```ts
  *   @Inherits('parent_table')
  *   class ChildTable extends Model {}
  *
  *   @Inherits({ parentTable: 'parent', only: true })
  *   class ChildOnlyTable extends Model {}
+ * ```
  *
  * @param options - Inheritance options (table name string or options object)
  */
@@ -266,6 +286,7 @@ function Inherits(options) {
  *
  * Usage:
  *
+ * ```ts
  *   // Range partition by date
  *   @Partition({ type: 'range', column: 'order_date' })
  *   @Table
@@ -280,6 +301,7 @@ function Inherits(options) {
  *   @Partition({ type: 'hash', column: 'id' })
  *   @Table
  *   class Log extends Model {}
+ * ```
  *
  * @param options - Partition configuration options
  */
@@ -294,9 +316,11 @@ function Partition(options) {
  *
  * Usage:
  *
+ * ```ts
  *   @Column(DataTypes.BLOB)
  *   @ColumnStorage({ compression: 'pglz' })
  *   blobData: Buffer;
+ * ```
  *
  * @param options - Column storage options
  */

package/dist/decorators/timezone.d.ts

@@ -7,21 +7,21 @@
  * Usage:
  *
  * // Column-level timezone
- * @Timezone('UTC')  // Store as UTC, convert on read/write
+ * `@Timezone`('UTC')  // Store as UTC, convert on read/write
  * createdAt: Date;
  *
- * @Timezone('America/New_York')  // Eastern time
+ * `@Timezone`('America/New_York')  // Eastern time
  * orderPlacedAt: Date;
  *
- * @Timezone('Europe/London')  // British time
+ * `@Timezone`('Europe/London')  // British time
  * updatedAt: Date;
  *
  * // Auto-detect from user context
- * @Timezone({ from: 'user' })
+ * `@Timezone`({ from: 'user' })
  * lastLoginAt: Date;
  *
  * // With format options
- * @Timezone({
+ * `@Timezone`({
  *   zone: 'UTC',
  *   format: 'ISO',  // 'ISO', 'DATE', 'DATETIME', 'TIMESTAMP'
  *   storeAs: 'utc'  // 'utc', 'local', 'string'
@@ -29,11 +29,11 @@
  * timestamp: Date;
  *
  * // Table-level default timezone
- * @Table({ timezone: 'America/Los_Angeles' })
+ * `@Table`({ timezone: 'America/Los_Angeles' })
  * class WestCoastOrder extends Model {}
  *
  * // Database-level timezone setting
- * @DatabaseSetting('timezone', 'UTC')
+ * `@DatabaseSetting`('timezone', 'UTC')
  */
 import 'reflect-metadata';
 /**

package/dist/decorators/timezone.js

@@ -8,21 +8,21 @@
  * Usage:
  *
  * // Column-level timezone
- * @Timezone('UTC')  // Store as UTC, convert on read/write
+ * `@Timezone`('UTC')  // Store as UTC, convert on read/write
  * createdAt: Date;
  *
- * @Timezone('America/New_York')  // Eastern time
+ * `@Timezone`('America/New_York')  // Eastern time
  * orderPlacedAt: Date;
  *
- * @Timezone('Europe/London')  // British time
+ * `@Timezone`('Europe/London')  // British time
  * updatedAt: Date;
  *
  * // Auto-detect from user context
- * @Timezone({ from: 'user' })
+ * `@Timezone`({ from: 'user' })
  * lastLoginAt: Date;
  *
  * // With format options
- * @Timezone({
+ * `@Timezone`({
  *   zone: 'UTC',
  *   format: 'ISO',  // 'ISO', 'DATE', 'DATETIME', 'TIMESTAMP'
  *   storeAs: 'utc'  // 'utc', 'local', 'string'
@@ -30,11 +30,11 @@
  * timestamp: Date;
  *
  * // Table-level default timezone
- * @Table({ timezone: 'America/Los_Angeles' })
+ * `@Table`({ timezone: 'America/Los_Angeles' })
  * class WestCoastOrder extends Model {}
  *
  * // Database-level timezone setting
- * @DatabaseSetting('timezone', 'UTC')
+ * `@DatabaseSetting`('timezone', 'UTC')
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TimezoneEnum = void 0;