@sqb/migrator 4.20.6 → 4.21.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sqb/migrator",
   "description": "Database migrator for SQB",
-  "version": "4.20.6",
+  "version": "4.21.0",
   "author": "Panates",
   "license": "Apache-2.0",
   "dependencies": {
@@ -12,28 +12,23 @@
     "tslib": "^2.8.1"
   },
   "peerDependencies": {
-    "@sqb/builder": "^4.20.6",
-    "@sqb/connect": "^4.20.6",
-    "@sqb/postgres": "^4.20.6"
+    "@sqb/builder": "^4.21.0",
+    "@sqb/connect": "^4.21.0",
+    "@sqb/postgres": "^4.21.0"
   },
   "type": "module",
+  "module": "./index.js",
+  "types": "./index.d.ts",
   "exports": {
     ".": {
-      "import": {
-        "types": "./types/index.d.ts",
-        "default": "./esm/index.js"
-      },
-      "require": {
-        "types": "./types/index.d.cts",
-        "default": "./cjs/index.js"
-      },
-      "default": "./esm/index.js"
+      "types": "./index.d.ts",
+      "default": "./index.js"
     },
     "./package.json": "./package.json"
   },
-  "main": "./cjs/index.js",
-  "module": "./esm/index.js",
-  "types": "./types/index.d.ts",
+  "engines": {
+    "node": ">=20.0"
+  },
   "contributors": [
     "Eray Hanoglu <e.hanoglu@panates.com>",
     "Ilker Gurelli <i.gurelli@panates.com>"
@@ -43,17 +38,6 @@
     "url": "https://github.com/panates/sqb.git",
     "directory": "packages/migrator"
   },
-  "engines": {
-    "node": ">=18.0"
-  },
-  "files": [
-    "bin/",
-    "cjs/",
-    "esm/",
-    "types/",
-    "LICENSE",
-    "README.md"
-  ],
   "keywords": [
     "sqb",
     "sql",

package/cjs/adapters/pg-migration-adapter.js

@@ -1,234 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PgMigrationAdapter = void 0;
-const tslib_1 = require("tslib");
-const postgres_1 = require("@sqb/postgres");
-const path_1 = tslib_1.__importDefault(require("path"));
-const postgrejs_1 = require("postgrejs");
-const migration_adapter_js_1 = require("../migration-adapter.js");
-const migration_package_js_1 = require("../migration-package.js");
-const types_js_1 = require("../types.js");
-const pgAdapter = new postgres_1.PgAdapter();
-class PgMigrationAdapter extends migration_adapter_js_1.MigrationAdapter {
-    _infoSchema = 'public';
-    _version = 0;
-    _status = types_js_1.MigrationStatus.idle;
-    defaultVariables = {
-        tablespace: 'pg_default',
-        schema: 'public',
-        owner: 'postgres',
-    };
-    summaryTable = 'migration_summary';
-    eventTable = 'migration_events';
-    get packageName() {
-        return this._migrationPackage.name;
-    }
-    get version() {
-        return this._version;
-    }
-    get status() {
-        return this._status;
-    }
-    get infoSchema() {
-        return this._infoSchema;
-    }
-    get summaryTableFull() {
-        return this.infoSchema + '.' + this.summaryTable;
-    }
-    get eventTableFull() {
-        return this.infoSchema + '.' + this.eventTable;
-    }
-    static async create(options) {
-        // Create connection
-        const connection = (await pgAdapter.connect(options.connection))
-            .intlcon;
-        try {
-            const adapter = new PgMigrationAdapter();
-            adapter._connection = connection;
-            adapter._migrationPackage = options.migrationPackage;
-            adapter._infoSchema = options.infoSchema || '__migration';
-            adapter.defaultVariables.schema = options.connection.schema || '';
-            if (!adapter.defaultVariables.schema) {
-                const r = await connection.query('SELECT CURRENT_SCHEMA ', {
-                    objectRows: true,
-                });
-                adapter.defaultVariables.schema =
-                    r.rows?.[0]?.current_schema || 'public';
-            }
-            // Check if migration schema
-            await connection.query(`CREATE SCHEMA IF NOT EXISTS ${adapter.infoSchema} AUTHORIZATION postgres;`);
-            // Create summary table if not exists
-            await connection.execute(`
-CREATE TABLE IF NOT EXISTS ${adapter.summaryTableFull}
-(
-    package_name varchar not null,
-    status varchar(16) not null,
-    current_version integer not null default 0,
-    created_at timestamp without time zone not null default current_timestamp,
-    updated_at timestamp without time zone,
-    CONSTRAINT pk_${adapter.summaryTable} PRIMARY KEY (package_name)
-)`);
-            // Create events table if not exists
-            await connection.execute(`
-CREATE TABLE IF NOT EXISTS ${adapter.eventTableFull}
-(
-    id serial not null,
-    package_name varchar not null,           
-    version integer not null default 0,
-    event varchar(16) not null,
-    event_time timestamp without time zone not null,
-    title text,
-    message text not null,          
-    filename text,
-    details text,
-    CONSTRAINT pk_${adapter.eventTable} PRIMARY KEY (id)
-)`);
-            // Insert summary record if not exists
-            const r = await connection.query(`SELECT status FROM ${adapter.summaryTableFull} WHERE package_name = $1`, {
-                params: [adapter.packageName],
-                objectRows: true,
-            });
-            if (!(r && r.rows?.length)) {
-                await connection.query(`insert into ${adapter.summaryTableFull} (package_name, status) values ($1, $2)`, {
-                    params: [adapter.packageName, types_js_1.MigrationStatus.idle],
-                });
-            }
-            await adapter.refresh();
-            return adapter;
-        }
-        catch (e) {
-            await connection.close(0);
-            throw e;
-        }
-    }
-    async close() {
-        await this._connection.close();
-    }
-    async refresh() {
-        const r = await this._connection.query(`SELECT * FROM ${this.summaryTableFull} WHERE package_name = $1`, {
-            params: [this.packageName],
-            objectRows: true,
-        });
-        const row = r.rows && r.rows[0];
-        if (!row)
-            throw new Error('Summary record did not created');
-        this._version = row.current_version;
-        this._status = row.status;
-    }
-    async update(info) {
-        let sql = '';
-        const params = [];
-        if (info.status && info.status !== this.status) {
-            params.push(info.status);
-            sql += ',\n  status = $' + params.length;
-        }
-        if (info.version && info.version !== this.version) {
-            params.push(info.version);
-            sql += ',\n  current_version = $' + params.length;
-        }
-        if (sql) {
-            params.push(this.packageName);
-            sql =
-                `update ${this.summaryTableFull} set updated_at = current_timestamp` +
-                    sql +
-                    `\n where package_name =$` +
-                    params.length;
-            await this._connection.query(sql, { params });
-            if (info.status)
-                this._status = info.status;
-            if (info.version)
-                this._version = info.version;
-        }
-    }
-    async writeEvent(event) {
-        const sql = `insert into ${this.eventTableFull} ` +
-            '(package_name, version, event, event_time, title, message, filename, details) ' +
-            'values ($1, $2, $3, CURRENT_TIMESTAMP, $4, $5, $6, $7)';
-        await this._connection.query(sql, {
-            params: [
-                this.packageName,
-                event.version,
-                event.event,
-                event.title,
-                event.message,
-                event.filename,
-                event.details,
-            ],
-        });
-    }
-    async executeTask(migrationPackage, migration, task, variables) {
-        variables = {
-            ...this.defaultVariables,
-            ...variables,
-        };
-        if ((0, migration_package_js_1.isSqlScriptMigrationTask)(task)) {
-            try {
-                let script;
-                if (typeof task.script === 'function') {
-                    script = await task.script({
-                        migrationPackage,
-                        migration,
-                        task,
-                        variables,
-                    });
-                }
-                else
-                    script = task.script;
-                if (typeof script !== 'string')
-                    return;
-                script = this.replaceVariables(script, variables);
-                await this._connection.execute(script);
-            }
-            catch (e) {
-                let msg = `Error in task "${task.title}"`;
-                if (task.filename)
-                    msg +=
-                        '\n at ' + path_1.default.relative(migrationPackage.baseDir, task.filename);
-                if (e.lineNr) {
-                    if (!task.filename)
-                        e.message += '\n at';
-                    msg += ` (${e.lineNr},${e.colNr}):\n` + e.line;
-                    if (e.colNr)
-                        msg += '\n' + ' '.repeat(e.colNr - 1) + '^';
-                }
-                e.message = msg + '\n\n' + e.message;
-                throw e;
-            }
-            return;
-        }
-        if ((0, migration_package_js_1.isCustomMigrationTask)(task)) {
-            await task.fn(this._connection, this);
-            return;
-        }
-        if ((0, migration_package_js_1.isInsertDataMigrationTask)(task)) {
-            const tableName = this.replaceVariables(task.tableName, variables);
-            const script = task.rows
-                .map(row => this.rowToSql(tableName, row))
-                .join('\n');
-            await this._connection.execute(script);
-        }
-    }
-    backupDatabase() {
-        return Promise.resolve(undefined);
-    }
-    lockSchema() {
-        return Promise.resolve(undefined);
-    }
-    restoreDatabase() {
-        return Promise.resolve(undefined);
-    }
-    unlockSchema() {
-        return Promise.resolve(undefined);
-    }
-    rowToSql(tableName, row) {
-        let sql = '';
-        const keys = Object.keys(row);
-        sql += `insert into ${tableName} (${keys}) values (`;
-        for (let i = 0; i < keys.length; i++) {
-            sql += (i ? ', ' : '') + (0, postgrejs_1.stringifyValueForSQL)(row[keys[i]]);
-        }
-        sql += ');\n';
-        return sql;
-    }
-}
-exports.PgMigrationAdapter = PgMigrationAdapter;

package/cjs/db-migrator.js

@@ -1,144 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DbMigrator = void 0;
-const strict_typed_events_1 = require("strict-typed-events");
-const pg_migration_adapter_js_1 = require("./adapters/pg-migration-adapter.js");
-const migration_adapter_js_1 = require("./migration-adapter.js");
-const migration_package_js_1 = require("./migration-package.js");
-const types_js_1 = require("./types.js");
-class DbMigrator extends strict_typed_events_1.AsyncEventEmitter {
-    async execute(options) {
-        if (!options.connection.dialect)
-            throw new TypeError(`You must provide connection.dialect`);
-        const migrationPackage = await migration_package_js_1.MigrationPackage.load(options.migrationPackage);
-        let minVersion = migrationPackage.migrations.reduce((a, m) => Math.min(a, m.version), Number.MAX_SAFE_INTEGER);
-        if (minVersion === Number.MAX_SAFE_INTEGER)
-            minVersion = 0;
-        const maxVersion = migrationPackage.migrations.reduce((a, m) => Math.max(a, m.version), 0);
-        const targetVersion = Math.min(options?.targetVersion || Number.MAX_SAFE_INTEGER, maxVersion);
-        if (targetVersion && targetVersion < minVersion) {
-            // noinspection ExceptionCaughtLocallyJS
-            throw new Error(`Version mismatch. Target schema version (${targetVersion}) is lower than ` +
-                `migration package min version (${minVersion})`);
-        }
-        let migrationAdapter;
-        switch (options.connection.dialect) {
-            case 'postgres': {
-                migrationAdapter = await pg_migration_adapter_js_1.PgMigrationAdapter.create({
-                    ...options,
-                    migrationPackage,
-                });
-                break;
-            }
-            default:
-                throw new TypeError(`Migration adapter for "${options.connection.dialect}" dialect is not implemented yet`);
-        }
-        let needBackup = false;
-        try {
-            if (migrationAdapter.version &&
-                migrationAdapter.version < minVersion - 1) {
-                // noinspection ExceptionCaughtLocallyJS
-                throw new Error(`This package can migrate starting from ${minVersion - 1} but current version is ${migrationAdapter.version}`);
-            }
-            const { migrations } = migrationPackage;
-            // calculate total scripts;
-            const total = migrations.reduce((i, x) => i + x.tasks.length, 0);
-            needBackup = !!migrations.find(x => !!x.backup);
-            await this.emitAsync('start');
-            let task;
-            await migrationAdapter.lockSchema();
-            if (needBackup) {
-                await this.emitAsync('backup');
-                await migrationAdapter.backupDatabase();
-            }
-            // Execute migration tasks
-            let migrationIndex = -1;
-            for (const migration of migrations) {
-                migrationIndex++;
-                if (migration.version > targetVersion ||
-                    migrationAdapter.version >= migration.version)
-                    continue;
-                await this.emitAsync('migration-start', {
-                    migration,
-                    total: migrations.length,
-                    index: migrationIndex,
-                });
-                for (let index = 0; index < migration.tasks.length; index++) {
-                    task = migration.tasks[index];
-                    await this.emitAsync('task-start', { migration, task, total, index });
-                    await migrationAdapter.update({ status: types_js_1.MigrationStatus.busy });
-                    await migrationAdapter.writeEvent({
-                        event: migration_adapter_js_1.MigrationAdapter.EventKind.started,
-                        version: migration.version,
-                        title: task.title,
-                        filename: task.filename,
-                        message: `Task "${task.title}" started`,
-                    });
-                    try {
-                        await migrationAdapter.executeTask(migrationPackage, migration, task, {
-                            schema: options.connection.schema,
-                            ...options.scriptVariables,
-                        });
-                        await migrationAdapter.writeEvent({
-                            event: migration_adapter_js_1.MigrationAdapter.EventKind.success,
-                            version: migration.version,
-                            title: task.title,
-                            filename: task.filename,
-                            message: `Task "${task.title}" completed`,
-                        });
-                    }
-                    catch (e) {
-                        await migrationAdapter.writeEvent({
-                            event: migration_adapter_js_1.MigrationAdapter.EventKind.error,
-                            version: migration.version,
-                            title: task.title,
-                            filename: task.filename,
-                            message: String(e),
-                            details: e.message +
-                                '\n\n' +
-                                Object.keys(e)
-                                    .filter(k => e[k] != null)
-                                    .map(k => k + ': ' + e[k])
-                                    .join('\n'),
-                        });
-                        // noinspection ExceptionCaughtLocallyJS
-                        throw e;
-                    }
-                    await this.emitAsync('task-finish', {
-                        migration,
-                        task,
-                        total,
-                        index,
-                    });
-                }
-                await migrationAdapter.update({
-                    version: migration.version,
-                    status: types_js_1.MigrationStatus.idle,
-                });
-                await this.emitAsync('migration-finish', {
-                    migration,
-                    total: migrations.length,
-                    index: migrationIndex,
-                });
-            }
-        }
-        catch (e) {
-            if (needBackup) {
-                await this.emitAsync('restore');
-                await migrationAdapter.restoreDatabase();
-            }
-            throw e;
-        }
-        finally {
-            try {
-                await migrationAdapter.unlockSchema();
-            }
-            finally {
-                await migrationAdapter.close();
-            }
-        }
-        await this.emitAsync('finish');
-        return true;
-    }
-}
-exports.DbMigrator = DbMigrator;

package/cjs/index.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./db-migrator.js"), exports);
-tslib_1.__exportStar(require("./migration-adapter.js"), exports);
-tslib_1.__exportStar(require("./migration-package.js"), exports);
-tslib_1.__exportStar(require("./types.js"), exports);

package/cjs/migration-adapter.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MigrationAdapter = void 0;
-class MigrationAdapter {
-    replaceVariables(text, variables) {
-        return text.replace(/(\$\((\w+)\))/g, (s, ...args) => variables[args[1]] || s);
-    }
-}
-exports.MigrationAdapter = MigrationAdapter;
-(function (MigrationAdapter) {
-    let EventKind;
-    (function (EventKind) {
-        EventKind["started"] = "started";
-        EventKind["success"] = "success";
-        EventKind["error"] = "error";
-    })(EventKind = MigrationAdapter.EventKind || (MigrationAdapter.EventKind = {}));
-})(MigrationAdapter || (exports.MigrationAdapter = MigrationAdapter = {}));

package/cjs/migration-package.js

@@ -1,159 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MigrationPackage = void 0;
-exports.isSqlScriptMigrationTask = isSqlScriptMigrationTask;
-exports.isInsertDataMigrationTask = isInsertDataMigrationTask;
-exports.isCustomMigrationTask = isCustomMigrationTask;
-const tslib_1 = require("tslib");
-const fast_glob_1 = tslib_1.__importDefault(require("fast-glob"));
-const promises_1 = tslib_1.__importDefault(require("fs/promises"));
-const path_1 = tslib_1.__importDefault(require("path"));
-const get_calling_filename_js_1 = require("./utils/get-calling-filename.js");
-function isSqlScriptMigrationTask(x) {
-    return (typeof x === 'object' &&
-        (typeof x.script === 'string' || typeof x.script === 'function'));
-}
-function isInsertDataMigrationTask(x) {
-    return (typeof x === 'object' &&
-        typeof x.tableName === 'string' &&
-        Array.isArray(x.rows));
-}
-function isCustomMigrationTask(x) {
-    return typeof x === 'object' && typeof x.fn === 'function';
-}
-var MigrationPackage;
-(function (MigrationPackage) {
-    async function load(asyncConfig) {
-        const baseDir = asyncConfig.baseDir || path_1.default.dirname((0, get_calling_filename_js_1.getCallingFilename)(1));
-        const out = {
-            ...asyncConfig,
-            baseDir,
-            migrations: [],
-        };
-        if (!Array.isArray(asyncConfig.migrations)) {
-            throw new TypeError('You must provide array of MigrationConfig in "migrations" property');
-        }
-        if (asyncConfig.migrations?.length) {
-            const srcMigrations = [];
-            const trgMigrations = [];
-            out.migrations = trgMigrations;
-            let x;
-            for (x of asyncConfig.migrations) {
-                x = typeof x === 'function' ? await x() : x;
-                if (typeof x === 'object' && x.tasks)
-                    srcMigrations.push(x);
-                else if (typeof x === 'string') {
-                    srcMigrations.push(...(await loadMigrations(baseDir, x.replace(/\\/g, '/'))));
-                }
-            }
-            srcMigrations.sort((a, b) => a.version - b.version);
-            for (const migration of srcMigrations) {
-                const trgMigration = {
-                    baseDir: '',
-                    ...migration,
-                    tasks: [],
-                };
-                trgMigrations.push(trgMigration);
-                const srcTasks = migration.tasks;
-                trgMigration.tasks = [];
-                for (const t of srcTasks) {
-                    if (typeof t === 'object') {
-                        trgMigration.tasks.push(t);
-                    }
-                    else if (typeof t === 'string') {
-                        let pattern = t.replace(/\\/g, '/');
-                        pattern = path_1.default.resolve(path_1.default.join(baseDir, trgMigration.baseDir, pattern));
-                        const files = await (0, fast_glob_1.default)(pattern, {
-                            absolute: true,
-                            onlyFiles: true,
-                        });
-                        files.sort();
-                        for (const filename of files) {
-                            const ext = path_1.default.extname(filename).toLowerCase();
-                            if (!path_1.default.basename(filename, ext).endsWith('.task'))
-                                continue;
-                            if (ext === '.sql') {
-                                const script = await promises_1.default.readFile(filename, 'utf-8');
-                                trgMigration.tasks.push({
-                                    title: path_1.default.basename(filename, ext),
-                                    filename,
-                                    script,
-                                });
-                            }
-                            else if (['.json', '.js', '.ts', '.cjs', '.mjs'].includes(ext)) {
-                                try {
-                                    let json = ext === '.json'
-                                        ? JSON.parse(await promises_1.default.readFile(filename, 'utf-8'))
-                                        : await Promise.resolve(`${filename}`).then(s => tslib_1.__importStar(require(s)));
-                                    if (typeof json !== 'object')
-                                        continue;
-                                    if (json.__esModule)
-                                        json = json.default;
-                                    if (json.script) {
-                                        json.title = json.title || 'Run sql script';
-                                        json.filename = filename;
-                                        trgMigration.tasks.push(json);
-                                        continue;
-                                    }
-                                    if (json.tableName && json.rows) {
-                                        json.title =
-                                            json.title || 'Migrate data into ' + json.tableName;
-                                        json.filename = filename;
-                                        trgMigration.tasks.push(json);
-                                        continue;
-                                    }
-                                    if (typeof json.fn === 'function') {
-                                        json.title = json.title || 'Run custom function';
-                                        json.filename = filename;
-                                        trgMigration.tasks.push(json);
-                                    }
-                                }
-                                catch (e) {
-                                    e.message = `Error in ${filename}\n` + e.message;
-                                    throw e;
-                                }
-                            }
-                        }
-                    }
-                }
-            }
-        }
-        return out;
-    }
-    MigrationPackage.load = load;
-})(MigrationPackage || (exports.MigrationPackage = MigrationPackage = {}));
-async function loadMigrations(baseDir, pattern) {
-    const out = [];
-    const files = await (0, fast_glob_1.default)(path_1.default.join(baseDir, pattern), {
-        absolute: true,
-        onlyFiles: true,
-    });
-    for (const filename of files) {
-        const ext = path_1.default.extname(filename).toLowerCase();
-        if (path_1.default.basename(filename, ext) !== 'migration')
-            continue;
-        let json;
-        if (['.js', '.ts', '.cjs', '.mjs', 'mts', 'cts'].includes(ext)) {
-            json = await Promise.resolve(`${filename}`).then(s => tslib_1.__importStar(require(s)));
-            if (json.default?.version)
-                json = json.default;
-        }
-        else if (ext === '.json') {
-            try {
-                json = JSON.parse(await promises_1.default.readFile(filename, 'utf-8'));
-            }
-            catch (e) {
-                e.message = `Error in ${filename}\n` + e.message;
-                throw e;
-            }
-        }
-        if (json &&
-            typeof json === 'object' &&
-            json.version &&
-            Array.isArray(json.tasks)) {
-            json.baseDir = path_1.default.relative(baseDir, path_1.default.dirname(filename));
-            out.push(json);
-        }
-    }
-    return out;
-}

package/cjs/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "commonjs"
-}

package/cjs/types.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MigrationStatus = void 0;
-var MigrationStatus;
-(function (MigrationStatus) {
-    MigrationStatus["idle"] = "idle";
-    MigrationStatus["busy"] = "busy";
-})(MigrationStatus || (exports.MigrationStatus = MigrationStatus = {}));

package/cjs/utils/get-calling-filename.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCallingFilename = getCallingFilename;
-const PATH_PATTERN = /^(?:file:\/\/)?(.+)$/;
-function getCallingFilename(position = 0) {
-    position++;
-    if (position >= Error.stackTraceLimit)
-        return '';
-    const oldPrepareStackTrace = Error.prepareStackTrace;
-    Error.prepareStackTrace = (_, stack) => stack;
-    const stack = new Error().stack;
-    Error.prepareStackTrace = oldPrepareStackTrace;
-    if (stack !== null && typeof stack === 'object') {
-        // stack[0] holds this file
-        // stack[1] holds where this function was called
-        const s = stack[position]
-            ? stack[position].getFileName()
-            : undefined;
-        const m = s ? PATH_PATTERN.exec(s) : undefined;
-        return m ? m[1] : '';
-    }
-    return '';
-}

package/esm/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "module"
-}

package/types/index.d.cts

@@ -1,4 +0,0 @@
-export * from './db-migrator.js';
-export * from './migration-adapter.js';
-export * from './migration-package.js';
-export * from './types.js';