ts-prorm-orm 1.1.0 → 1.2.1

package/dist/index.js

@@ -42,10 +42,11 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VARBINARY = exports.BINARY = exports.BLOB = exports.JSONB = exports.JSON = exports.UUIDV4 = exports.UUID = exports.TIME = exports.NOW = exports.DATEONLY = exports.DATE = exports.BOOLEAN = exports.DECIMAL = exports.DOUBLE = exports.FLOAT = exports.BIGINT = exports.INTEGER = exports.TEXT = exports.CHAR = exports.VARCHAR = exports.STRING = exports.BelongsToMany = exports.BelongsTo = exports.HasMany = exports.HasOne = exports.clearMetadata = exports.getModelAttributes = exports.getAttributeMetadata = exports.getModelMetadata = exports.Comment = exports.Unique = exports.Default = exports.NotNull = exports.AutoIncrement = exports.PrimaryKey = exports.AllowNull = exports.Column = exports.Attribute = exports.Table = exports.Model = exports.AbstractDataType = exports.DataTypes = exports.createConnectionManager = exports.ConnectionManager = exports.StreamIterator = exports.BatchTransform = exports.FilterTransform = exports.MapTransform = exports.QueryTypes = exports.Prorm = void 0;
 exports.BaseDialect = exports.ReplicaManager = exports.Transaction = exports.isOrderExpression = exports.random = exports.desc = exports.asc = exports.overlap = exports.contains = exports.isNotNull = exports.isNull = exports.notBetween = exports.between = exports.notIn = exports.inOp = exports.in = exports.notIRegexp = exports.iRegexp = exports.notRegexp = exports.regexp = exports.match = exports.notSubstring = exports.substring = exports.notEndsWith = exports.endsWith = exports.notStartsWith = exports.startsWith = exports.notILike = exports.iLike = exports.notLike = exports.like = exports.lte = exports.lt = exports.gte = exports.gt = exports.ne = exports.eq = exports.not = exports.or = exports.and = exports.where = exports.operatorToWhereKey = exports.getOperatorString = exports.OpAliases = exports.Operators = exports.Op = exports.GEOGRAPHY = exports.GEOMETRY = exports.ARRAY = exports.ENUM = void 0;
-exports.trimStart = exports.rtrim = exports.ltrim = exports.trim = exports.capitalizeWords = exports.capitalize = exports.lowerCase = exports.upperCase = exports.spliceStr = exports.formatDefaultValue = exports.toDefaultValue = exports.removeTicks = exports.addTicks = exports.escapeLike = exports.pad = exports.truncate = exports.coalesce = exports.isEmpty = exports.formatWhere = exports.escapeId = exports.escapeString = exports.formatValue = exports.formatValues = exports.isValidUUID = exports.generateShortUUID = exports.generateUUID = exports.omit = exports.pick = exports.merge = exports.cloneDeep = exports.singularize = exports.pluralize = exports.snakeCase = exports.camelize = exports.kebabToCamel = exports.camelToKebab = exports.snakeToCamel = exports.camelToSnake = exports.ModelManager = exports.ScopeManager = exports.createPool = exports.PooledConnection = exports.DatabaseConnectionPool = exports.ConnectionPool = exports.createMSSQLDialect = exports.MSSQLDialect = exports.createOracleDialect = exports.OracleDialect = exports.SQLiteDialect = exports.DialectRegistry = void 0;
-exports.KNOWN_FDWS = exports.ForeignDataManager = exports.generateERDiagramFromFile = exports.generateModelDiagramFromFile = exports.generateERDiagram = exports.generateModelDiagram = exports.ERDiagram = exports.ModelDiagram = exports.removeGeneratedModel = exports.listModels = exports.setOutputDir = exports.getOutputDir = exports.configureCLI = exports.generateModels = exports.model = exports.CLI = exports.utils = exports.isEmptyResultError = exports.isConstraintError = exports.isConnectionError = exports.isValidationError = exports.isPrormError = exports.ErrorCodes = exports.EmptyResultError = exports.AssociationError = exports.BulkRecordError = exports.ResourceLockedError = exports.TimeoutError = exports.ExclusionConstraintError = exports.ForeignKeyConstraintError = exports.UniqueConstraintError = exports.ValidationError = exports.DatabaseError = exports.ConnectionError = exports.PrormError = exports.setDefaultLogger = exports.getDefaultLogger = exports.createSilentLogger = exports.createLogger = exports.LogLevelStrings = exports.LogLevel = exports.Logger = exports.createQueryInterface = exports.CreateQueryInterface = exports.stringUtils = exports.regex = exports.truncateStr = exports.padEnd = exports.padStart = exports.trimEnd = void 0;
-exports.length = exports.lower = exports.upper = exports.concat = exports.least = exports.greatest = exports.mod = exports.sign = exports.abs = exports.sqrt = exports.power = exports.floor = exports.ceil = exports.round = exports.jsonTypeOf = exports.jsonKeys = exports.jsonExtract = exports.fullTextRank = exports.fullTextMatch = exports.currentTimestamp = exports.currentDate = exports.dateDiff = exports.dateSub = exports.dateAdd = exports.dateTrunc = exports.caseOf = exports.caseWhen = exports.SimpleCaseBuilder = exports.CaseBuilder = exports.arrayAgg = exports.stringAgg = exports.max = exports.min = exports.avg = exports.countDistinct = exports.count = exports.IsolationLevelEnum = exports.getConstantsForDialect = exports.SQLITE = exports.POSTGRES = exports.MARIADB = exports.MYSQL = exports.SQL = exports.createSQLiteAdvanced = exports.SQLiteAdvanced = exports.PRIVILEGE_LEVELS = exports.UserManager = exports.DatabaseSecurityDecorator = exports.Database = exports.buildOptionsClause = void 0;
-exports.sqlSum = exports.sqlReverse = exports.sqlRepeat = exports.sqlNow = exports.sqlFormatDate = exports.sqlJsonHasKey = exports.sqlJsonContains = exports.sqlRtrim = exports.sqlLtrim = exports.sqlTrim = exports.sqlSubstring = exports.sqlTruncate = exports.sqlRandom = exports.NullsOrder = exports.windowFn = exports.maxOver = exports.minOver = exports.countOver = exports.avgOver = exports.sumOver = exports.nthValue = exports.lastValue = exports.firstValue = exports.lead = exports.lag = exports.ntile = exports.cumeDist = exports.percentRank = exports.denseRank = exports.rank = exports.rowNumber = exports.WindowFunctionBuilder = exports.split = exports.rpad = exports.lpad = exports.replace = void 0;
+exports.lowerCase = exports.upperCase = exports.spliceStr = exports.formatDefaultValue = exports.toDefaultValue = exports.removeTicks = exports.addTicks = exports.escapeLike = exports.pad = exports.truncate = exports.coalesce = exports.isEmpty = exports.formatWhere = exports.escapeId = exports.escapeString = exports.formatValue = exports.formatValues = exports.isValidUUID = exports.generateShortUUID = exports.generateUUID = exports.omit = exports.pick = exports.merge = exports.cloneDeep = exports.singularize = exports.pluralize = exports.snakeCase = exports.camelize = exports.kebabToCamel = exports.camelToKebab = exports.snakeToCamel = exports.camelToSnake = exports.ModelManager = exports.ScopeManager = exports.createPool = exports.PooledConnection = exports.DatabaseConnectionPool = exports.ConnectionPool = exports.createMSSQLDialect = exports.MSSQLDialect = exports.createOracleDialect = exports.OracleDialect = exports.SQLiteDialect = exports.registerGraphDialects = exports.GRAPH_DIALECTS = exports.DgraphGraphDialect = exports.GremlinGraphDialect = exports.Neo4jGraphDialect = exports.BaseGraphDialect = exports.DialectRegistry = void 0;
+exports.ModelDiagram = exports.removeGeneratedModel = exports.listModels = exports.setOutputDir = exports.getOutputDir = exports.configureCLI = exports.generateModels = exports.model = exports.CLI = exports.utils = exports.isEmptyResultError = exports.isConstraintError = exports.isConnectionError = exports.isValidationError = exports.isPrormError = exports.ErrorCodes = exports.EmptyResultError = exports.EagerLoadError = exports.AssociationError = exports.BulkRecordError = exports.ResourceLockedError = exports.TimeoutError = exports.ExclusionConstraintError = exports.ForeignKeyConstraintError = exports.UniqueConstraintError = exports.ValidationError = exports.DatabaseError = exports.ConnectionError = exports.PrormError = exports.setDefaultLogger = exports.getDefaultLogger = exports.createSilentLogger = exports.createLogger = exports.LogLevelStrings = exports.LogLevel = exports.Logger = exports.createQueryInterface = exports.CreateQueryInterface = exports.stringUtils = exports.regex = exports.truncateStr = exports.padEnd = exports.padStart = exports.trimEnd = exports.trimStart = exports.rtrim = exports.ltrim = exports.trim = exports.capitalizeWords = exports.capitalize = void 0;
+exports.jsonExtract = exports.fullTextRank = exports.fullTextMatch = exports.currentTimestamp = exports.currentDate = exports.dateDiff = exports.dateSub = exports.dateAdd = exports.dateTrunc = exports.caseOf = exports.caseWhen = exports.SimpleCaseBuilder = exports.CaseBuilder = exports.arrayAgg = exports.stringAgg = exports.max = exports.min = exports.avg = exports.countDistinct = exports.count = exports.IsolationLevelEnum = exports.getConstantsForDialect = exports.SQLITE = exports.POSTGRES = exports.MARIADB = exports.MYSQL = exports.SQL = exports.createSQLiteAdvanced = exports.SQLiteAdvanced = exports.PRIVILEGE_LEVELS = exports.UserManager = exports.DatabaseSecurityDecorator = exports.Database = exports.buildCreateFullTextIndexSQL = exports.buildDropPolicySQL = exports.buildCreatePolicySQL = exports.buildEnableRowLevelSecuritySQL = exports.buildDropTriggerSQL = exports.buildCreateTriggerStatements = exports.buildDropSequenceSQL = exports.buildCreateSequenceSQL = exports.UnsupportedSchemaObjectError = exports.buildOptionsClause = exports.KNOWN_FDWS = exports.ForeignDataManager = exports.generateERDiagramFromFile = exports.generateModelDiagramFromFile = exports.generateERDiagram = exports.generateModelDiagram = exports.ERDiagram = void 0;
+exports.sqlRepeat = exports.sqlNow = exports.sqlFormatDate = exports.sqlJsonHasKey = exports.sqlJsonContains = exports.sqlRtrim = exports.sqlLtrim = exports.sqlTrim = exports.sqlSubstring = exports.sqlTruncate = exports.sqlRandom = exports.NullsOrder = exports.windowFn = exports.maxOver = exports.minOver = exports.countOver = exports.avgOver = exports.sumOver = exports.nthValue = exports.lastValue = exports.firstValue = exports.lead = exports.lag = exports.ntile = exports.cumeDist = exports.percentRank = exports.denseRank = exports.rank = exports.rowNumber = exports.WindowFunctionBuilder = exports.split = exports.rpad = exports.lpad = exports.replace = exports.length = exports.lower = exports.upper = exports.concat = exports.least = exports.greatest = exports.mod = exports.sign = exports.abs = exports.sqrt = exports.power = exports.floor = exports.ceil = exports.round = exports.jsonTypeOf = exports.jsonKeys = void 0;
+exports.sqlSum = exports.sqlReverse = void 0;
 // Re-export Prorm class and query types
 var prorm_1 = require("./prorm");
 Object.defineProperty(exports, "Prorm", { enumerable: true, get: function () { return prorm_1.Prorm; } });
@@ -197,6 +198,19 @@ Object.defineProperty(exports, "ReplicaManager", { enumerable: true, get: functi
 var dialect_1 = require("./dialects/dialect");
 Object.defineProperty(exports, "BaseDialect", { enumerable: true, get: function () { return dialect_1.BaseDialect; } });
 Object.defineProperty(exports, "DialectRegistry", { enumerable: true, get: function () { return dialect_1.DialectRegistry; } });
+// Graph / object-database dialects (Cypher / Gremlin / Dgraph). Re-export the
+// concrete dialects + helper, then register them with the shared registry so
+// `neo4j`, `gremlin`, `neptune`, and `dgraph` resolve like any built-in dialect.
+var graph_1 = require("./graph");
+Object.defineProperty(exports, "BaseGraphDialect", { enumerable: true, get: function () { return graph_1.BaseGraphDialect; } });
+Object.defineProperty(exports, "Neo4jGraphDialect", { enumerable: true, get: function () { return graph_1.Neo4jGraphDialect; } });
+Object.defineProperty(exports, "GremlinGraphDialect", { enumerable: true, get: function () { return graph_1.GremlinGraphDialect; } });
+Object.defineProperty(exports, "DgraphGraphDialect", { enumerable: true, get: function () { return graph_1.DgraphGraphDialect; } });
+Object.defineProperty(exports, "GRAPH_DIALECTS", { enumerable: true, get: function () { return graph_1.GRAPH_DIALECTS; } });
+Object.defineProperty(exports, "registerGraphDialects", { enumerable: true, get: function () { return graph_1.registerGraphDialects; } });
+const dialect_2 = require("./dialects/dialect");
+const graph_2 = require("./graph");
+(0, graph_2.registerGraphDialects)(dialect_2.DialectRegistry);
 // Re-export SQLite dialect
 var sqlite_1 = require("./dialects/sqlite");
 Object.defineProperty(exports, "SQLiteDialect", { enumerable: true, get: function () { return sqlite_1.SQLiteDialect; } });
@@ -299,6 +313,7 @@ Object.defineProperty(exports, "TimeoutError", { enumerable: true, get: function
 Object.defineProperty(exports, "ResourceLockedError", { enumerable: true, get: function () { return errors_1.ResourceLockedError; } });
 Object.defineProperty(exports, "BulkRecordError", { enumerable: true, get: function () { return errors_1.BulkRecordError; } });
 Object.defineProperty(exports, "AssociationError", { enumerable: true, get: function () { return errors_1.AssociationError; } });
+Object.defineProperty(exports, "EagerLoadError", { enumerable: true, get: function () { return errors_1.EagerLoadError; } });
 Object.defineProperty(exports, "EmptyResultError", { enumerable: true, get: function () { return errors_1.EmptyResultError; } });
 Object.defineProperty(exports, "ErrorCodes", { enumerable: true, get: function () { return errors_1.ErrorCodes; } });
 Object.defineProperty(exports, "isPrormError", { enumerable: true, get: function () { return errors_1.isPrormError; } });
@@ -337,6 +352,23 @@ var foreign_data_1 = require("./foreign-data");
 Object.defineProperty(exports, "ForeignDataManager", { enumerable: true, get: function () { return foreign_data_1.ForeignDataManager; } });
 Object.defineProperty(exports, "KNOWN_FDWS", { enumerable: true, get: function () { return foreign_data_1.KNOWN_FDWS; } });
 Object.defineProperty(exports, "buildOptionsClause", { enumerable: true, get: function () { return foreign_data_1.buildOptionsClause; } });
+// Export external fields (@ExternalField + store registry)
+__exportStar(require("./external-fields"), exports);
+// Export schema-object builders and their options, so callers can catch
+// UnsupportedSchemaObjectError and type the QueryInterface arguments.
+// `SequenceOptions` and `PolicyOptions` already exist in './types' with
+// different shapes, so the schema-object ones are aliased rather than
+// shadowing names existing consumers may already import.
+var schema_objects_1 = require("./schema-objects");
+Object.defineProperty(exports, "UnsupportedSchemaObjectError", { enumerable: true, get: function () { return schema_objects_1.UnsupportedSchemaObjectError; } });
+Object.defineProperty(exports, "buildCreateSequenceSQL", { enumerable: true, get: function () { return schema_objects_1.buildCreateSequenceSQL; } });
+Object.defineProperty(exports, "buildDropSequenceSQL", { enumerable: true, get: function () { return schema_objects_1.buildDropSequenceSQL; } });
+Object.defineProperty(exports, "buildCreateTriggerStatements", { enumerable: true, get: function () { return schema_objects_1.buildCreateTriggerStatements; } });
+Object.defineProperty(exports, "buildDropTriggerSQL", { enumerable: true, get: function () { return schema_objects_1.buildDropTriggerSQL; } });
+Object.defineProperty(exports, "buildEnableRowLevelSecuritySQL", { enumerable: true, get: function () { return schema_objects_1.buildEnableRowLevelSecuritySQL; } });
+Object.defineProperty(exports, "buildCreatePolicySQL", { enumerable: true, get: function () { return schema_objects_1.buildCreatePolicySQL; } });
+Object.defineProperty(exports, "buildDropPolicySQL", { enumerable: true, get: function () { return schema_objects_1.buildDropPolicySQL; } });
+Object.defineProperty(exports, "buildCreateFullTextIndexSQL", { enumerable: true, get: function () { return schema_objects_1.buildCreateFullTextIndexSQL; } });
 // Export decorators / annotations
 __exportStar(require("./decorators"), exports);
 // './decorators' (collate.ts) and './compliance' (security-decorator.ts) both export a

package/dist/logging.d.ts

@@ -0,0 +1,183 @@
+/**
+ * Logging system for the ORM
+ * Provides configurable logging with different levels and custom logger support
+ */
+import { EventEmitter } from 'events';
+/**
+ * Log levels
+ */
+export declare enum LogLevel {
+    DEBUG = 0,
+    INFO = 1,
+    WARN = 2,
+    ERROR = 3,
+    QUIET = 4
+}
+/**
+ * Log level string mapping
+ */
+export declare const LogLevelStrings: {
+    readonly debug: LogLevel.DEBUG;
+    readonly info: LogLevel.INFO;
+    readonly warn: LogLevel.WARN;
+    readonly error: LogLevel.ERROR;
+    readonly quiet: LogLevel.QUIET;
+};
+/**
+ * Log entry structure
+ */
+export interface LogEntry {
+    level: LogLevel;
+    levelName: string;
+    message: string;
+    timestamp: Date;
+    meta?: Record<string, unknown>;
+}
+/**
+ * Logger options
+ */
+export interface LoggerOptions {
+    /** Minimum log level to output */
+    level?: LogLevel | keyof typeof LogLevelStrings;
+    /** Whether to log SQL queries */
+    logSQL?: boolean;
+    /** Threshold in ms for slow queries */
+    slowQueryThreshold?: number;
+    /** Whether to log slow queries */
+    logSlowQueries?: boolean;
+    /** Custom logger instance (message, debug) */
+    logging?: (message: string, debug?: boolean) => void;
+    /** Prorm-style logger (sql, timing) */
+    prormLogging?: (sql: string, timing?: number) => void;
+    /** Whether to use colors in output (default: true in Node) */
+    colors?: boolean;
+}
+/**
+ * Logger event types
+ */
+export interface LoggerEvents {
+    log: (entry: LogEntry) => void;
+    query: (sql: string, duration: number) => void;
+    slowQuery: (sql: string, duration: number) => void;
+    error: (error: Error) => void;
+}
+/**
+ * Logger class for the ORM
+ * Supports multiple log levels, custom loggers, and SQL query logging
+ */
+export declare class Logger extends EventEmitter {
+    private level;
+    private logSQL;
+    private slowQueryThreshold;
+    private logSlowQueries;
+    private customLogger?;
+    private prormLogger?;
+    private useColors;
+    private static readonly colors;
+    constructor(options?: LoggerOptions);
+    /**
+     * Set the minimum log level
+     */
+    setLevel(level: LogLevel | keyof typeof LogLevelStrings): void;
+    /**
+     * Get the current log level
+     */
+    getLevel(): LogLevel;
+    /**
+     * Get the current log level name
+     */
+    getLevelName(): string;
+    /**
+     * Log a debug message
+     */
+    debug(message: string, meta?: Record<string, unknown>): void;
+    /**
+     * Log an info message
+     */
+    info(message: string, meta?: Record<string, unknown>): void;
+    /**
+     * Log a warning message
+     */
+    warn(message: string, meta?: Record<string, unknown>): void;
+    /**
+     * Log an error message
+     */
+    error(message: string, meta?: Record<string, unknown>): void;
+    /**
+     * Core log method
+     */
+    private log;
+    /**
+     * Output log message
+     */
+    private output;
+    /**
+     * Default console output
+     */
+    private defaultOutput;
+    /**
+     * Get color for log level
+     */
+    private getLevelColor;
+    /**
+     * Format log prefix
+     */
+    private formatPrefix;
+    /**
+     * Log a SQL query with timing
+     */
+    logQuery(sql: string, duration?: number): void;
+    /**
+     * Set whether to log SQL queries
+     */
+    setLogSQL(logSQL: boolean): void;
+    /**
+     * Set slow query threshold
+     */
+    setSlowQueryThreshold(threshold: number): void;
+    /**
+     * Check if logging is enabled for a level
+     */
+    isLevelEnabled(level: LogLevel): boolean;
+    /**
+     * Create a child logger with additional context
+     */
+    child(meta: Record<string, unknown>): Logger;
+}
+/**
+ * Create a default logger instance
+ */
+export declare function createLogger(options?: LoggerOptions): Logger;
+/**
+ * Create a no-op logger (for testing)
+ */
+export declare function createSilentLogger(): Logger;
+/**
+ * Get or create the default logger
+ */
+export declare function getDefaultLogger(options?: LoggerOptions): Logger;
+/**
+ * Set the default logger
+ */
+export declare function setDefaultLogger(logger: Logger): void;
+/**
+ * Reset the default logger
+ */
+export declare function resetDefaultLogger(): void;
+declare const _default: {
+    Logger: typeof Logger;
+    LogLevel: typeof LogLevel;
+    LogLevelStrings: {
+        readonly debug: LogLevel.DEBUG;
+        readonly info: LogLevel.INFO;
+        readonly warn: LogLevel.WARN;
+        readonly error: LogLevel.ERROR;
+        readonly quiet: LogLevel.QUIET;
+    };
+    createLogger: typeof createLogger;
+    createSilentLogger: typeof createSilentLogger;
+    getDefaultLogger: typeof getDefaultLogger;
+    setDefaultLogger: typeof setDefaultLogger;
+    resetDefaultLogger: typeof resetDefaultLogger;
+};
+export default _default;

package/dist/migrations/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Migration System - Main entry point for all migration-related exports
+ * Provides migration management capabilities for the TypeScript ORM
+ */
+export { Migration, MigrationFunction, MigrationMeta, createMigrationTemplate, buildMigrationTemplate, } from './migration';
+export { Migrator, MigratorOptions, MigrationStatus, MigratorResult, createMigrator, createMigration, } from './migrator';
+export { QueryInterface, TableDescriptor, ColumnDescription, IndexDescription, ForeignKeyDescription, ConstraintDescription, createQueryInterface, } from './query-interface';
+export { PrormMigration, PrormMigrationOptions } from './prormmigration';
+export * from '../schema';

package/dist/migrations/migration.d.ts

@@ -0,0 +1,143 @@
+/**
+ * Migration class - Base class for all migrations
+ * Stores migration metadata including name, batch number, and timestamp
+ */
+import { QueryInterface } from './query-interface';
+/**
+ * Migration function type - defines up and down operations
+ */
+export type MigrationFunction = (queryInterface: QueryInterface, prorm: any) => Promise<void>;
+/**
+ * Migration metadata interface
+ */
+export interface MigrationMeta {
+    /**
+     * Unique identifier for the migration
+     */
+    id?: number;
+    /**
+     * Name of the migration
+     */
+    name: string;
+    /**
+     * Timestamp when the migration was executed
+     */
+    timestamp: number;
+    /**
+     * Batch number for grouping migrations
+     */
+    batch: number;
+}
+/**
+ * Migration class representing a single database migration
+ */
+export declare class Migration {
+    /**
+     * The migration name
+     */
+    name: string;
+    /**
+     * Timestamp when the migration was created
+     */
+    timestamp: number;
+    /**
+     * Batch number for the migration
+     */
+    batch: number;
+    /**
+     * Internal ID in the database
+     */
+    id?: number;
+    /**
+     * The up migration function
+     */
+    private migrationUp;
+    /**
+     * The down migration function
+     */
+    private migrationDown;
+    /**
+     * Create a new Migration instance
+     * @param options - Migration options
+     */
+    constructor(options: {
+        name: string;
+        up?: MigrationFunction;
+        down?: MigrationFunction;
+    });
+    /**
+     * Get the up migration function
+     */
+    get up(): MigrationFunction | undefined;
+    /**
+     * Get the down migration function
+     */
+    get down(): MigrationFunction | undefined;
+    /**
+     * Set the up migration function
+     */
+    setUp(up: MigrationFunction): void;
+    /**
+     * Set the down migration function
+     */
+    setDown(down: MigrationFunction): void;
+    /**
+     * Execute the migration (run up)
+     * @param queryInterface - The query interface to use
+     * @param prorm - The prorm instance
+     */
+    runUp(queryInterface: QueryInterface, prorm: any): Promise<void>;
+    /**
+     * Revert the migration (run down)
+     * @param queryInterface - The query interface to use
+     * @param prorm - The prorm instance
+     */
+    runDown(queryInterface: QueryInterface, prorm: any): Promise<void>;
+    /**
+     * Get migration metadata
+     */
+    getMeta(): MigrationMeta;
+    /**
+     * Set migration metadata from database record
+     */
+    setMeta(meta: MigrationMeta): void;
+    /**
+     * Check if migration has been executed
+     */
+    isExecuted(): boolean;
+    /**
+     * Get a timestamp string for the migration name
+     */
+    static getTimestamp(): string;
+    /**
+     * Generate a migration file name with timestamp
+     */
+    static generateFileName(name: string): string;
+    /**
+     * Parse migration file name to extract timestamp and name
+     */
+    static parseFileName(filename: string): {
+        timestamp: string;
+        name: string;
+    } | null;
+}
+/**
+ * The single canonical migration file template used by every migration
+ * generator in this codebase (Migrator.createMigration, MigrationCli.create,
+ * cli.ts migration:create). Produces a CommonJS `module.exports = { up, down }`
+ * file, which is the format `Migrator.loadMigrationFile()` requires via
+ * `require()` (for `.ts` files this is transpiled on the fly via ts-node).
+ *
+ * Keeping exactly one template in one place means the loader and the
+ * generator can never drift out of sync again.
+ */
+export declare function buildMigrationTemplate(name: string): string;
+/**
+ * @deprecated Use `buildMigrationTemplate` instead. This used to emit an
+ * ESM-style (`export const up = ...`) template that was incompatible with
+ * `Migrator.loadMigrationFile()`, which only ever loaded migrations via
+ * CommonJS `require()`. It now delegates to the canonical CommonJS template
+ * so any existing callers keep working, but new code should call
+ * `buildMigrationTemplate` directly.
+ */
+export declare function createMigrationTemplate(name: string): string;

package/dist/migrations/migrator.d.ts

@@ -0,0 +1,199 @@
+/**
+ * Migrator class - Manages the migration workflow
+ * Handles registering, running, and reverting migrations
+ */
+import { Migration } from './migration';
+import { PrormMigration } from './prormmigration';
+import { QueryInterface } from './query-interface';
+import { Prorm } from '../prorm';
+/**
+ * Migrator options
+ */
+export interface MigratorOptions {
+    /**
+     * Path to migration files
+     */
+    path?: string;
+    /**
+     * Prorm instance
+     */
+    prorm: Prorm;
+    /**
+     * Table name for migrations
+     */
+    tableName?: string;
+    /**
+     * Schema for migrations table
+     */
+    schema?: string;
+    /**
+     * Filter for migration files
+     */
+    filter?: (filename: string) => boolean;
+    /**
+     * Migration file extension
+     */
+    extension?: string;
+}
+/**
+ * Migration status
+ */
+export interface MigrationStatus {
+    /**
+     * Name of the migration
+     */
+    name: string;
+    /**
+     * Current status: pending, up, down
+     */
+    status: 'pending' | 'up' | 'down';
+    /**
+     * Batch number (if executed)
+     */
+    batch?: number;
+    /**
+     * Timestamp (if executed)
+     */
+    timestamp?: number;
+}
+/**
+ * MigratorResult result
+ */
+export interface MigratorResult {
+    /**
+     * Number of migrations executed
+     */
+    executed: number;
+    /**
+     * Number of migrations reverted
+     */
+    reverted: number;
+    /**
+     * Array of migration names
+     */
+    migrations: string[];
+}
+/**
+ * Migrator class - Manages database migrations
+ */
+export declare class Migrator {
+    private prorm;
+    private PrormMigration;
+    private migrations;
+    private path;
+    private extension;
+    private filter;
+    /**
+     * Create a new Migrator instance
+     * @param options - Configuration options
+     */
+    constructor(options: MigratorOptions);
+    /**
+     * Default filter for migration files
+     */
+    private defaultFilter;
+    /**
+     * Get the PrormMigration instance
+     */
+    getPrormMigration(): PrormMigration;
+    /**
+     * Get the QueryInterface
+     */
+    getQueryInterface(): QueryInterface;
+    /**
+     * Register a migration file
+     * @param migrationPath - Path to the migration file
+     */
+    migration(migrationPath: string): Promise<void>;
+    /**
+     * Whether ts-node/register has already been registered in this process.
+     * Registering more than once is harmless but wasteful, so we only do it once.
+     */
+    private static tsNodeRegistered;
+    /**
+     * Ensure TypeScript migration files can be loaded via require().
+     * Lazily registers ts-node/register the first time a .ts migration is loaded.
+     */
+    private ensureTsNodeRegistered;
+    /**
+     * Load a migration file
+     * @param filePath - Path to the migration file
+     */
+    private loadMigrationFile;
+    /**
+     * Find and register all migration files in a directory
+     */
+    findMigrations(): Promise<void>;
+    /**
+     * Get all registered migrations
+     */
+    getMigrations(): Migration[];
+    /**
+     * Get migration by name
+     */
+    getMigration(name: string): Migration | undefined;
+    /**
+     * List pending (not yet executed) migrations
+     */
+    pending(): Promise<Migration[]>;
+    /**
+     * List all executed migrations
+     */
+    executed(): Promise<Migration[]>;
+    /**
+     * Get migration status for all migrations
+     */
+    status(): Promise<MigrationStatus[]>;
+    /**
+     * Run all pending migrations
+     * @param options - Migration options
+     */
+    up(options?: {
+        migration?: string;
+        batch?: number;
+    }): Promise<MigratorResult>;
+    /**
+     * Revert migrations
+     * @param options - Revert options
+     */
+    down(options?: {
+        migration?: string;
+        steps?: number;
+    }): Promise<MigratorResult>;
+    /**
+     * Revert all executed migrations with a batch number greater than
+     * `targetBatch`, actually running each migration's `down()` function
+     * (loaded the same way `up()` is) before removing its tracking row.
+     * @param targetBatch - Batch number to revert down to
+     */
+    downToBatch(targetBatch: number): Promise<MigratorResult>;
+    /**
+     * Get database version
+     */
+    getDatabaseVersion(): Promise<string>;
+    /**
+     * Sync the migrations table
+     */
+    syncMigrationsTable(): Promise<void>;
+    /**
+     * Set the migration path
+     */
+    setPath(newPath: string): void;
+    /**
+     * Get the current migration path
+     */
+    getPath(): string;
+}
+/**
+ * Create a Migrator instance
+ */
+export declare function createMigrator(options: MigratorOptions): Migrator;
+/**
+ * Create migration file template
+ * @param name - Migration name
+ * @param options - Template options
+ */
+export declare function createMigration(name: string, options?: {
+    path?: string;
+    extension?: string;
+}): string;