@baasix/baasix 0.1.0

package/dist/services/MigrationService.d.ts

@@ -0,0 +1,243 @@
+import { getDatabase, getSqlClient } from "../utils/db.js";
+import { schemaManager } from "../utils/schemaManager.js";
+import env from "../utils/env.js";
+/**
+ * Migration status enum
+ */
+export type MigrationStatus = "pending" | "running" | "completed" | "failed" | "rolled_back";
+/**
+ * Migration type enum
+ */
+export type MigrationType = "system" | "schema" | "data" | "custom";
+/**
+ * Migration record interface
+ */
+export interface MigrationRecord {
+    id?: string;
+    version: string;
+    name: string;
+    description?: string;
+    type: MigrationType;
+    status: MigrationStatus;
+    batch?: number;
+    executedAt?: Date;
+    executionTimeMs?: number;
+    errorMessage?: string;
+    errorStack?: string;
+    metadata?: Record<string, any>;
+    checksum?: string;
+    canRollback?: boolean;
+    rolledBackAt?: Date;
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+/**
+ * Migration script interface
+ */
+export interface MigrationScript {
+    version: string;
+    name: string;
+    description?: string;
+    type?: MigrationType;
+    canRollback?: boolean;
+    /**
+     * The up function to run the migration
+     */
+    up: (context: MigrationContext) => Promise<MigrationResult>;
+    /**
+     * The down function to rollback the migration (optional)
+     */
+    down?: (context: MigrationContext) => Promise<MigrationResult>;
+}
+/**
+ * Migration context passed to migration scripts
+ */
+export interface MigrationContext {
+    db: ReturnType<typeof getDatabase>;
+    sql: ReturnType<typeof getSqlClient>;
+    schemaManager: typeof schemaManager;
+    env: typeof env;
+    log: (message: string) => void;
+}
+/**
+ * Migration result from a script execution
+ */
+export interface MigrationResult {
+    success: boolean;
+    message?: string;
+    metadata?: Record<string, any>;
+}
+/**
+ * Migration run options
+ */
+export interface MigrationRunOptions {
+    /** Run only specific migration version */
+    version?: string;
+    /** Run migrations up to and including this version */
+    toVersion?: string;
+    /** Number of migrations to run */
+    step?: number;
+    /** Only run pending migrations */
+    pendingOnly?: boolean;
+    /** Dry run - don't actually execute migrations */
+    dryRun?: boolean;
+}
+/**
+ * MigrationService - Handles database migration execution and tracking
+ */
+declare class MigrationService {
+    private initialized;
+    private migrationsDir;
+    private systemMigrationsDir;
+    private logs;
+    private isUpgradeFromSequelize;
+    constructor();
+    /**
+     * Detect if this is an upgrade from Sequelize version
+     * MUST be called BEFORE schemaManager.initialize() because that creates the migration table
+     *
+     * Detection logic:
+     * - If baasix_User exists but baasix_Migration does NOT exist → Sequelize upgrade
+     * - If neither exists → Fresh installation
+     * - If both exist → Already on Drizzle version
+     */
+    detectUpgradeBeforeSchemaInit(): Promise<boolean>;
+    /**
+     * Initialize the migration service
+     * @param isUpgradeFromSequelize - Pass true if detectUpgradeBeforeSchemaInit() returned true
+     */
+    init(isUpgradeFromSequelize?: boolean): Promise<void>;
+    /**
+     * Check if this instance is an upgrade from Sequelize
+     */
+    isSequelizeUpgrade(): boolean;
+    /**
+     * Ensure migration directories exist
+     */
+    private ensureMigrationDirs;
+    /**
+     * Get all recorded migrations from database
+     */
+    getMigrations(options?: {
+        status?: MigrationStatus;
+        type?: MigrationType;
+    }): Promise<MigrationRecord[]>;
+    /**
+     * Get the last executed migration
+     */
+    getLastMigration(): Promise<MigrationRecord | null>;
+    /**
+     * Get migration by version
+     */
+    getMigrationByVersion(version: string): Promise<MigrationRecord | null>;
+    /**
+     * Get pending migrations (scripts that haven't been executed)
+     */
+    getPendingMigrations(): Promise<MigrationScript[]>;
+    /**
+     * Load migration scripts from directory
+     */
+    loadMigrationScripts(directory?: string): Promise<MigrationScript[]>;
+    /**
+     * Load scripts from a specific directory
+     */
+    private loadScriptsFromDir;
+    /**
+     * Compare two version strings
+     * Supports semver (1.0.0, 1.0.0-alpha.1) and timestamp (20240101_001) formats
+     */
+    private compareVersions;
+    /**
+     * Calculate checksum for a migration script
+     */
+    private calculateChecksum;
+    /**
+     * Run pending migrations
+     */
+    runPendingMigrations(options?: MigrationRunOptions): Promise<MigrationRecord[]>;
+    /**
+     * Run a single migration
+     */
+    runMigration(script: MigrationScript, batch?: number, dryRun?: boolean): Promise<MigrationRecord>;
+    /**
+     * Rollback a migration
+     */
+    rollbackMigration(version: string): Promise<MigrationRecord | null>;
+    /**
+     * Rollback the last batch of migrations
+     */
+    rollbackLastBatch(): Promise<MigrationRecord[]>;
+    /**
+     * Get the next batch number
+     */
+    private getNextBatchNumber;
+    /**
+     * Get migration status summary
+     */
+    getStatus(): Promise<{
+        lastMigration: MigrationRecord | null;
+        pendingCount: number;
+        completedCount: number;
+        failedCount: number;
+        pending: MigrationScript[];
+    }>;
+    /**
+     * Create a new migration file
+     */
+    createMigration(name: string, options?: {
+        type?: MigrationType;
+        description?: string;
+        version?: string;
+    }): Promise<string>;
+    /**
+     * Check and run migrations on startup if enabled
+     * This should be called during app initialization
+     */
+    runStartupMigrations(): Promise<void>;
+    /**
+     * Handle upgrade from Sequelize version
+     * This runs the baseline migration (to handle fullName, etc.) and marks
+     * all other migrations up to the upgrade baseline as completed
+     */
+    private handleSequelizeUpgrade;
+    /**
+     * Set the user migrations directory
+     */
+    setMigrationsDir(dir: string): void;
+    /**
+     * Get the current migrations directory
+     */
+    getMigrationsDir(): string;
+    /**
+     * Mark a migration as completed without running it
+     * Useful for existing installations that already have the changes
+     */
+    markAsCompleted(version: string, options?: {
+        metadata?: Record<string, any>;
+    }): Promise<MigrationRecord | null>;
+    /**
+     * Mark all migrations up to a version as completed
+     * Useful for bringing an existing database up to date without running migrations
+     */
+    markAllAsCompleted(toVersion?: string): Promise<MigrationRecord[]>;
+    /**
+     * Get the current Baasix version from package.json
+     */
+    getCurrentBaasixVersion(): Promise<string>;
+    /**
+     * Check if database needs migrations based on current version
+     */
+    checkMigrationNeeded(): Promise<{
+        needed: boolean;
+        lastVersion: string | null;
+        currentVersion: string;
+        pendingCount: number;
+    }>;
+}
+declare global {
+    var __baasix_migrationService: MigrationService | undefined;
+}
+declare const migrationService: MigrationService;
+export default migrationService;
+export { MigrationService };
+//# sourceMappingURL=MigrationService.d.ts.map

package/dist/services/MigrationService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MigrationService.d.ts","sourceRoot":"","sources":["../../baasix/services/MigrationService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAK1D,OAAO,GAAG,MAAM,iBAAiB,CAAC;AAGlC;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,aAAa,CAAC;AAE7F;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAC;AAEpE;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,aAAa,CAAC;IACpB,MAAM,EAAE,eAAe,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,IAAI,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,YAAY,CAAC,EAAE,IAAI,CAAC;IACpB,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,SAAS,CAAC,EAAE,IAAI,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,aAAa,CAAC;IACrB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,EAAE,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,OAAO,CAAC,eAAe,CAAC,CAAC;IAC5D;;OAEG;IACH,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,OAAO,CAAC,eAAe,CAAC,CAAC;CAChE;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,UAAU,CAAC,OAAO,WAAW,CAAC,CAAC;IACnC,GAAG,EAAE,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC;IACrC,aAAa,EAAE,OAAO,aAAa,CAAC;IACpC,GAAG,EAAE,OAAO,GAAG,CAAC;IAChB,GAAG,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,0CAA0C;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,sDAAsD;IACtD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kCAAkC;IAClC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kCAAkC;IAClC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,kDAAkD;IAClD,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,cAAM,gBAAgB;IACpB,OAAO,CAAC,WAAW,CAAkB;IACrC,OAAO,CAAC,aAAa,CAAc;IACnC,OAAO,CAAC,mBAAmB,CAAc;IACzC,OAAO,CAAC,IAAI,CAAgB;IAC5B,OAAO,CAAC,sBAAsB,CAAkB;;IAShD;;;;;;;;OAQG;IACG,6BAA6B,IAAI,OAAO,CAAC,OAAO,CAAC;IAgDvD;;;OAGG;IACG,IAAI,CAAC,sBAAsB,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IA8B3D;;OAEG;IACH,kBAAkB,IAAI,OAAO;IAI7B;;OAEG;YACW,mBAAmB;IAcjC;;OAEG;IACG,aAAa,CAAC,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,eAAe,CAAC;QAAC,IAAI,CAAC,EAAE,aAAa,CAAA;KAAE,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IA0B7G;;OAEG;IACG,gBAAgB,IAAI,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IAkBzD;;OAEG;IACG,qBAAqB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IAiB7E;;OAEG;IACG,oBAAoB,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;IAYxD;;OAEG;IACG,oBAAoB,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAiB1E;;OAEG;YACW,kBAAkB;IA8ChC;;;OAGG;IACH,OAAO,CAAC,eAAe;IAyBvB;;OAEG;YACW,iBAAiB;IAK/B;;OAEG;IACG,oBAAoB,CAAC,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAmDrF;;OAEG;IACG,YAAY,CAChB,MAAM,EAAE,eAAe,EACvB,KAAK,CAAC,EAAE,MAAM,EACd,MAAM,GAAE,OAAe,GACtB,OAAO,CAAC,eAAe,CAAC;IAkH3B;;OAEG;IACG,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IAkGzE;;OAEG;IACG,iBAAiB,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;IA6CrD;;OAEG;YACW,kBAAkB;IAehC;;OAEG;IACG,SAAS,IAAI,OAAO,CAAC;QACzB,aAAa,EAAE,eAAe,GAAG,IAAI,CAAC;QACtC,YAAY,EAAE,MAAM,CAAC;QACrB,cAAc,EAAE,MAAM,CAAC;QACvB,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,EAAE,eAAe,EAAE,CAAC;KAC5B,CAAC;IAkBF;;OAEG;IACG,eAAe,CACnB,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE;QACR,IAAI,CAAC,EAAE,aAAa,CAAC;QACrB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,GACA,OAAO,CAAC,MAAM,CAAC;IAsFlB;;;OAGG;IACG,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC;IAsC3C;;;;OAIG;YACW,sBAAsB;IAyEpC;;OAEG;IACH,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAInC;;OAEG;IACH,gBAAgB,IAAI,MAAM;IAI1B;;;OAGG;IACG,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAC/C,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KAChC,GAAG,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IA4EnC;;;OAGG;IACG,kBAAkB,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IA2BxE;;OAEG;IACG,uBAAuB,IAAI,OAAO,CAAC,MAAM,CAAC;IAiBhD;;OAEG;IACG,oBAAoB,IAAI,OAAO,CAAC;QACpC,MAAM,EAAE,OAAO,CAAC;QAChB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAC3B,cAAc,EAAE,MAAM,CAAC;QACvB,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC;CAcH;AAGD,OAAO,CAAC,MAAM,CAAC;IACb,IAAI,yBAAyB,EAAE,gBAAgB,GAAG,SAAS,CAAC;CAC7D;AAOD,QAAA,MAAM,gBAAgB,kBAAuC,CAAC;AAC9D,eAAe,gBAAgB,CAAC;AAChC,OAAO,EAAE,gBAAgB,EAAE,CAAC"}