ts-prorm-orm 1.1.0

package/dist/decorators/jsonb.js

@@ -0,0 +1,101 @@
+"use strict";
+/**
+ * JSONB Decorator for the ORM
+ *
+ * Provides PostgreSQL JSONB type support.
+ * JSONB is different from JSON - it's stored in binary format and is indexable.
+ *
+ * Usage:
+ *
+ *   // Basic JSONB column
+ *   @JSONB()
+ *   metadata: object;
+ *
+ *   // With validation
+ *   @JSONB({ validate: true })
+ *   config: object;
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JSONB = JSONB;
+exports.getJSONBMetadata = getJSONBMetadata;
+exports.getAllJSONBMetadata = getAllJSONBMetadata;
+exports.isJSONBColumn = isJSONBColumn;
+exports.clearJSONBMetadata = clearJSONBMetadata;
+// ==================== Registry ====================
+const jsonbMetadataMap = new Map();
+/**
+ * JSONB decorator for PostgreSQL JSONB columns
+ *
+ * @param options - Optional JSONB column options
+ *
+ * @example
+ * // Basic JSONB column
+ * class Document extends Model {
+ *   @JSONB()
+ *   data: object;
+ * }
+ *
+ * // With validation
+ * class Config extends Model {
+ *   @JSONB({ validate: true })
+ *   settings: object;
+ * }
+ */
+function JSONB(options) {
+    return function (target, propertyKey) {
+        const decoratorOptions = {
+            allowNull: true,
+            validate: false,
+            ...options,
+        };
+        // Get or create metadata map for this class
+        if (!jsonbMetadataMap.has(target.constructor)) {
+            jsonbMetadataMap.set(target.constructor, new Map());
+        }
+        const metadataMap = jsonbMetadataMap.get(target.constructor);
+        // Store metadata
+        metadataMap.set(propertyKey, {
+            options: decoratorOptions,
+        });
+    };
+}
+/**
+ * Get JSONB metadata for a property
+ *
+ * @param target - The target class
+ * @param propertyKey - The property name
+ * @returns JSONB metadata or undefined if not found
+ */
+function getJSONBMetadata(target, propertyKey) {
+    const metadataMap = jsonbMetadataMap.get(target.constructor);
+    if (!metadataMap) {
+        return undefined;
+    }
+    return metadataMap.get(propertyKey);
+}
+/**
+ * Get all JSONB metadata for a class
+ *
+ * @param target - The target class
+ * @returns Map of property names to JSONB metadata
+ */
+function getAllJSONBMetadata(target) {
+    return jsonbMetadataMap.get(target.constructor) || new Map();
+}
+/**
+ * Check if a property is a JSONB column
+ *
+ * @param target - The target class
+ * @param propertyKey - The property name
+ * @returns True if the property is a JSONB column
+ */
+function isJSONBColumn(target, propertyKey) {
+    const metadata = getJSONBMetadata(target, propertyKey);
+    return metadata !== undefined;
+}
+/**
+ * Clear JSONB metadata (useful for testing)
+ */
+function clearJSONBMetadata() {
+    jsonbMetadataMap.clear();
+}

package/dist/decorators/orm-decorators.js

@@ -0,0 +1,425 @@
+"use strict";
+/**
+ * ORM Decorators Registry
+ *
+ * Central registry of all decorator names used in the ORM.
+ * Useful for documentation, tooling, and reflection-based operations.
+ *
+ * Usage:
+ *
+ *   import { ORMDecorators } from './orm-decorators';
+ *
+ *   // Access decorator names
+ *   console.log(ORMDecorators.Table); // 'Table'
+ *   console.log(ORMDecorators.Column); // 'Column'
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SETTINGS_DECORATORS = exports.POSTGRES_DECORATORS = exports.VALIDATION_DECORATORS = exports.HOOK_DECORATORS = exports.ASSOCIATION_DECORATORS = exports.CONSTRAINT_DECORATORS = exports.MODEL_DECORATORS = exports.ALL_DECORATORS = exports.ORMDecorators = void 0;
+// ==================== Enum-like Constant ====================
+/**
+ * All ORM decorator names organized by category.
+ *
+ * This constant provides a centralized registry of decorator names
+ * used throughout the ORM for documentation, tooling, and reflection.
+ */
+exports.ORMDecorators = {
+    // ─────────────────────────────────────────────────────────────────
+    // Model Definition
+    // ─────────────────────────────────────────────────────────────────
+    /** Model/table decorator */
+    Table: 'Table',
+    /** Schema/database schema decorator */
+    Schema: 'Schema',
+    /** Column/property decorator */
+    Column: 'Column',
+    /** Primary key decorator */
+    PrimaryKey: 'PrimaryKey',
+    // ─────────────────────────────────────────────────────────────────
+    // Constraints
+    // ─────────────────────────────────────────────────────────────────
+    /** Check constraint decorator */
+    Check: 'Check',
+    /** Unique constraint decorator */
+    Unique: 'Unique',
+    /** Default value decorator */
+    Default: 'Default',
+    /** Foreign key decorator */
+    ForeignKey: 'ForeignKey',
+    /** Index decorator */
+    Index: 'Index',
+    /** Partition decorator */
+    Partition: 'Partition',
+    // ─────────────────────────────────────────────────────────────────
+    // Associations
+    // ─────────────────────────────────────────────────────────────────
+    /** BelongsTo association decorator */
+    BelongsTo: 'BelongsTo',
+    /** HasOne association decorator */
+    HasOne: 'HasOne',
+    /** HasMany association decorator */
+    HasMany: 'HasMany',
+    /** Many-to-many (junction) association decorator */
+    BelongsToMany: 'BelongsToMany',
+    // ─────────────────────────────────────────────────────────────────
+    // Lifecycle Hooks - Before
+    // ─────────────────────────────────────────────────────────────────
+    /** Before create hook */
+    BeforeCreate: 'BeforeCreate',
+    /** Before bulk create hook */
+    BeforeBulkCreate: 'BeforeBulkCreate',
+    /** Before update hook */
+    BeforeUpdate: 'BeforeUpdate',
+    /** Before bulk update hook */
+    BeforeBulkUpdate: 'BeforeBulkUpdate',
+    /** Before delete hook */
+    BeforeDelete: 'BeforeDelete',
+    /** Before bulk delete hook */
+    BeforeBulkDelete: 'BeforeBulkDelete',
+    /** Before find hook */
+    BeforeFind: 'BeforeFind',
+    /** Before find after expand options hook */
+    BeforeFindAfterExpandOptions: 'BeforeFindAfterExpandOptions',
+    /** Before find after distribution hook */
+    BeforeFindAfterSetup: 'BeforeFindAfterSetup',
+    /** Before init hook */
+    BeforeInit: 'BeforeInit',
+    /** Before connect hook */
+    BeforeConnect: 'BeforeConnect',
+    /** Before query hook */
+    BeforeQuery: 'BeforeQuery',
+    /** Before sync hook */
+    BeforeSync: 'BeforeSync',
+    // ─────────────────────────────────────────────────────────────────
+    // Lifecycle Hooks - After
+    // ─────────────────────────────────────────────────────────────────
+    /** After create hook */
+    AfterCreate: 'AfterCreate',
+    /** After bulk create hook */
+    AfterBulkCreate: 'AfterBulkCreate',
+    /** After update hook */
+    AfterUpdate: 'AfterUpdate',
+    /** After bulk update hook */
+    AfterBulkUpdate: 'AfterBulkUpdate',
+    /** After delete hook */
+    AfterDelete: 'AfterDelete',
+    /** After bulk delete hook */
+    AfterBulkDelete: 'AfterBulkDelete',
+    /** After find hook */
+    AfterFind: 'AfterFind',
+    /** After init hook */
+    AfterInit: 'AfterInit',
+    /** After connect hook */
+    AfterConnect: 'AfterConnect',
+    /** After query hook */
+    AfterQuery: 'AfterQuery',
+    /** After sync hook */
+    AfterSync: 'AfterSync',
+    // ─────────────────────────────────────────────────────────────────
+    // Advanced Column Types
+    // ─────────────────────────────────────────────────────────────────
+    /** Virtual/computed column decorator */
+    Virtual: 'Virtual',
+    /** Generated column decorator */
+    Generated: 'Generated',
+    /** Identity/auto-increment decorator */
+    Identity: 'Identity',
+    // ─────────────────────────────────────────────────────────────────
+    // Scopes
+    // ─────────────────────────────────────────────────────────────────
+    /** Default scope decorator */
+    DefaultScope: 'DefaultScope',
+    /** Named scopes decorator */
+    Scopes: 'Scopes',
+    /** Scope decorator (single) */
+    Scope: 'Scope',
+    // ─────────────────────────────────────────────────────────────────
+    // Soft Deletes / Paranoid
+    // ─────────────────────────────────────────────────────────────────
+    /** Paranoid (soft delete) decorator */
+    Paranoid: 'Paranoid',
+    // ─────────────────────────────────────────────────────────────────
+    // Timestamps
+    // ─────────────────────────────────────────────────────────────────
+    /** CreatedAt timestamp decorator */
+    CreatedAt: 'CreatedAt',
+    /** UpdatedAt timestamp decorator */
+    UpdatedAt: 'UpdatedAt',
+    /** DeletedAt timestamp decorator */
+    DeletedAt: 'DeletedAt',
+    // ─────────────────────────────────────────────────────────────────
+    // Versioning
+    // ─────────────────────────────────────────────────────────────────
+    /** Version (optimistic locking) decorator */
+    Version: 'Version',
+    // ─────────────────────────────────────────────────────────────────
+    // PostgreSQL Specific
+    // ─────────────────────────────────────────────────────────────────
+    /** Trigger decorator */
+    Trigger: 'Trigger',
+    /** Stored procedure decorator */
+    Procedure: 'Procedure',
+    /** SQL function decorator */
+    Function: 'Function',
+    /** Function: 'Function' (alias for clarity) */
+    SqlFunction: 'SqlFunction',
+    /** Sequence decorator */
+    Sequence: 'Sequence',
+    /** Extension decorator */
+    Extension: 'Extension',
+    /** Row-level security decorator */
+    RowLevelSecurity: 'RowLevelSecurity',
+    /** Policy decorator */
+    Policy: 'Policy',
+    /** Table inheritance decorator */
+    Inheritance: 'Inheritance',
+    /** Partition decorator (PostgreSQL specific) */
+    PartitionPostgres: 'Partition',
+    // ─────────────────────────────────────────────────────────────────
+    // MySQL/MariaDB Specific
+    // ─────────────────────────────────────────────────────────────────
+    /** Event decorator (MySQL/MariaDB) */
+    Event: 'Event',
+    /** Stored routine decorator */
+    Routine: 'Routine',
+    // ─────────────────────────────────────────────────────────────────
+    // SQLite Specific
+    // ─────────────────────────────────────────────────────────────────
+    /** Foreign table decorator (SQLite FDW) */
+    ForeignTable: 'ForeignTable',
+    // ─────────────────────────────────────────────────────────────────
+    // Views
+    // ─────────────────────────────────────────────────────────────────
+    /** View decorator */
+    View: 'View',
+    // ─────────────────────────────────────────────────────────────────
+    // Database Settings
+    // ─────────────────────────────────────────────────────────────────
+    /** Foreign key checks setting decorator */
+    ForeignKeyChecks: 'ForeignKeyChecks',
+    /** Database setting decorator */
+    DatabaseSetting: 'DatabaseSetting',
+    // ─────────────────────────────────────────────────────────────────
+    // Comment
+    // ─────────────────────────────────────────────────────────────────
+    /** Comment decorator */
+    Comment: 'Comment',
+    // ─────────────────────────────────────────────────────────────────
+    // Encryption / Security
+    // ─────────────────────────────────────────────────────────────────
+    /** Secure field decorator */
+    Secure: 'Secure',
+    /** Secure field decorator (alias) */
+    SecureField: 'SecureField',
+    // ─────────────────────────────────────────────────────────────────
+    // Permissions
+    // ─────────────────────────────────────────────────────────────────
+    /** Permission decorator */
+    Permission: 'Permission',
+    /** Can view decorator */
+    CanView: 'CanView',
+    /** Cannot view decorator */
+    CannotView: 'CannotView',
+    /** Can write decorator */
+    CanWrite: 'CanWrite',
+    /** Cannot write decorator */
+    CannotWrite: 'CannotWrite',
+    // ─────────────────────────────────────────────────────────────────
+    // Audit
+    // ─────────────────────────────────────────────────────────────────
+    /** Audit decorator */
+    Audit: 'Audit',
+    /** AuditChange decorator */
+    AuditChange: 'AuditChange',
+    /** AuditLog decorator */
+    AuditLog: 'AuditLog',
+    // ─────────────────────────────────────────────────────────────────
+    // Validation
+    // ─────────────────────────────────────────────────────────────────
+    /** Validate decorator */
+    Validate: 'Validate',
+    /** Is decorator (validation rule) */
+    Is: 'Is',
+    /** IsAlpha decorator */
+    IsAlpha: 'IsAlpha',
+    /** IsAlphanumeric decorator */
+    IsAlphanumeric: 'IsAlphanumeric',
+    /** IsNumeric decorator */
+    IsNumeric: 'IsNumeric',
+    /** IsEmail decorator */
+    IsEmail: 'IsEmail',
+    /** IsURL decorator */
+    IsURL: 'IsURL',
+    /** IsIP decorator */
+    IsIP: 'IsIP',
+    /** IsDate decorator */
+    IsDate: 'IsDate',
+    /** IsInt decorator */
+    IsInt: 'IsInt',
+    /** IsFloat decorator */
+    IsFloat: 'IsFloat',
+    /** IsBoolean decorator */
+    IsBoolean: 'IsBoolean',
+    /** IsUUID decorator */
+    IsUUID: 'IsUUID',
+    /** IsJSON decorator */
+    IsJSON: 'IsJSON',
+    /** IsNull decorator */
+    IsNull: 'IsNull',
+    /** NotEmpty decorator */
+    NotEmpty: 'NotEmpty',
+    /** Len decorator (length validation) */
+    Len: 'Len',
+    /** Min decorator */
+    Min: 'Min',
+    /** Max decorator */
+    Max: 'Max',
+    /** IsIn decorator */
+    IsIn: 'IsIn',
+    /** NotIn decorator */
+    NotIn: 'NotIn',
+    /** Regexp decorator */
+    Regexp: 'Regexp',
+    /** NotRegexp decorator */
+    NotRegexp: 'NotRegexp',
+    /** IsCreditCard decorator */
+    IsCreditCard: 'IsCreditCard',
+    /** IsISBN decorator */
+    IsISBN: 'IsISBN',
+    /** IsMobilePhone decorator */
+    IsMobilePhone: 'IsMobilePhone',
+    /** IsPostalCode decorator */
+    IsPostalCode: 'IsPostalCode',
+    /** IsCurrency decorator */
+    IsCurrency: 'IsCurrency',
+    /** IsOctal decorator */
+    IsOctal: 'IsOctal',
+    /** IsDivisibleBy decorator */
+    IsDivisibleBy: 'IsDivisibleBy',
+    // ─────────────────────────────────────────────────────────────────
+    // Additional Utilities
+    // ─────────────────────────────────────────────────────────────────
+    /** Index (alias for backward compatibility) */
+    IndexAlt: 'Index',
+    /** Raw decorator for raw SQL */
+    Raw: 'Raw',
+};
+/**
+ * Get all decorator names as an array
+ */
+exports.ALL_DECORATORS = Object.values(exports.ORMDecorators);
+/**
+ * Get all model definition decorators
+ */
+exports.MODEL_DECORATORS = [
+    exports.ORMDecorators.Table,
+    exports.ORMDecorators.Schema,
+    exports.ORMDecorators.Column,
+    exports.ORMDecorators.PrimaryKey,
+];
+/**
+ * Get all constraint decorators
+ */
+exports.CONSTRAINT_DECORATORS = [
+    exports.ORMDecorators.Check,
+    exports.ORMDecorators.Unique,
+    exports.ORMDecorators.Default,
+    exports.ORMDecorators.ForeignKey,
+    exports.ORMDecorators.Index,
+    exports.ORMDecorators.Partition,
+];
+/**
+ * Get all association decorators
+ */
+exports.ASSOCIATION_DECORATORS = [
+    exports.ORMDecorators.BelongsTo,
+    exports.ORMDecorators.HasOne,
+    exports.ORMDecorators.HasMany,
+    exports.ORMDecorators.BelongsToMany,
+];
+/**
+ * Get all hook decorators (before and after)
+ */
+exports.HOOK_DECORATORS = [
+    // Before hooks
+    exports.ORMDecorators.BeforeCreate,
+    exports.ORMDecorators.BeforeBulkCreate,
+    exports.ORMDecorators.BeforeUpdate,
+    exports.ORMDecorators.BeforeBulkUpdate,
+    exports.ORMDecorators.BeforeDelete,
+    exports.ORMDecorators.BeforeBulkDelete,
+    exports.ORMDecorators.BeforeFind,
+    exports.ORMDecorators.BeforeFindAfterExpandOptions,
+    exports.ORMDecorators.BeforeFindAfterSetup,
+    exports.ORMDecorators.BeforeInit,
+    exports.ORMDecorators.BeforeConnect,
+    exports.ORMDecorators.BeforeQuery,
+    exports.ORMDecorators.BeforeSync,
+    // After hooks
+    exports.ORMDecorators.AfterCreate,
+    exports.ORMDecorators.AfterBulkCreate,
+    exports.ORMDecorators.AfterUpdate,
+    exports.ORMDecorators.AfterBulkUpdate,
+    exports.ORMDecorators.AfterDelete,
+    exports.ORMDecorators.AfterBulkDelete,
+    exports.ORMDecorators.AfterFind,
+    exports.ORMDecorators.AfterInit,
+    exports.ORMDecorators.AfterConnect,
+    exports.ORMDecorators.AfterQuery,
+    exports.ORMDecorators.AfterSync,
+];
+/**
+ * Get all validation decorators
+ */
+exports.VALIDATION_DECORATORS = [
+    exports.ORMDecorators.Validate,
+    exports.ORMDecorators.Is,
+    exports.ORMDecorators.IsAlpha,
+    exports.ORMDecorators.IsAlphanumeric,
+    exports.ORMDecorators.IsNumeric,
+    exports.ORMDecorators.IsEmail,
+    exports.ORMDecorators.IsURL,
+    exports.ORMDecorators.IsIP,
+    exports.ORMDecorators.IsDate,
+    exports.ORMDecorators.IsInt,
+    exports.ORMDecorators.IsFloat,
+    exports.ORMDecorators.IsBoolean,
+    exports.ORMDecorators.IsUUID,
+    exports.ORMDecorators.IsJSON,
+    exports.ORMDecorators.IsNull,
+    exports.ORMDecorators.NotEmpty,
+    exports.ORMDecorators.Len,
+    exports.ORMDecorators.Min,
+    exports.ORMDecorators.Max,
+    exports.ORMDecorators.IsIn,
+    exports.ORMDecorators.NotIn,
+    exports.ORMDecorators.Regexp,
+    exports.ORMDecorators.NotRegexp,
+    exports.ORMDecorators.IsCreditCard,
+    exports.ORMDecorators.IsISBN,
+    exports.ORMDecorators.IsMobilePhone,
+    exports.ORMDecorators.IsPostalCode,
+    exports.ORMDecorators.IsCurrency,
+    exports.ORMDecorators.IsOctal,
+    exports.ORMDecorators.IsDivisibleBy,
+];
+/**
+ * Get all PostgreSQL-specific decorators
+ */
+exports.POSTGRES_DECORATORS = [
+    exports.ORMDecorators.Trigger,
+    exports.ORMDecorators.Procedure,
+    exports.ORMDecorators.Function,
+    exports.ORMDecorators.SqlFunction,
+    exports.ORMDecorators.Sequence,
+    exports.ORMDecorators.Extension,
+    exports.ORMDecorators.RowLevelSecurity,
+    exports.ORMDecorators.Policy,
+    exports.ORMDecorators.Inheritance,
+];
+/**
+ * Get all database setting decorators
+ */
+exports.SETTINGS_DECORATORS = [
+    exports.ORMDecorators.ForeignKeyChecks,
+    exports.ORMDecorators.DatabaseSetting,
+];