@sqb/migrator 4.9.1 → 4.10.1

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

@@ -0,0 +1,19 @@
+const PATH_PATTERN = /^(?:file:\/\/)?(.+)$/;
+export 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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sqb/migrator",
   "description": "Database migrator for SQB",
-  "version": "4.9.1",
+  "version": "4.10.1",
   "author": "Panates",
   "contributors": [
     "Eray Hanoglu <e.hanoglu@panates.com>",
@@ -13,6 +13,10 @@
     "url": "https://github.com/sqbjs/sqb.git",
     "directory": "packages/migrator"
   },
+  "type": "module",
+  "module": "./esm/index.js",
+  "main": "./cjs/index.js",
+  "types": "./types/index.d.ts",
   "scripts": {
     "compile": "tsc",
     "prebuild": "npm run lint && npm run clean",
@@ -28,19 +32,13 @@
     "clean:dist": "rimraf ../../build/migrator",
     "clean:cover": "rimraf ../../coverage/migrator"
   },
-  "peerDependencies": {
-    "@sqb/builder": "^4.9.1",
-    "@sqb/connect": "^4.9.1"
+  "dependencies": {
+    "ts-gems": "^2.5.0"
   },
-  "type": "module",
-  "types": "esm/index.d.ts",
-  "exports": {
-    ".": {
-      "require": "./cjs/index.js",
-      "default": "./esm/index.js"
-    },
-    "./cjs": "./cjs/index.js",
-    "./esm": "./esm/index.js"
+  "peerDependencies": {
+    "@sqb/builder": "^4.10.1",
+    "@sqb/connect": "^4.10.1",
+    "@sqb/postgres": "^4.10.1"
   },
   "engines": {
     "node": ">=16.0",
@@ -50,6 +48,7 @@
     "bin/",
     "cjs/",
     "esm/",
+    "types/",
     "LICENSE",
     "README.md"
   ],

package/types/adapters/pg-migration-adapter.d.ts

@@ -0,0 +1,39 @@
+import { Connection } from 'postgresql-client';
+import type { DbMigratorOptions } from '../db-migrator.js';
+import { MigrationAdapter } from '../migration-adapter.js';
+import { MigrationTask } from '../migration-package.js';
+import { MigrationStatus } from '../types.js';
+export declare class PgMigrationAdapter extends MigrationAdapter {
+    protected _connection: Connection;
+    protected _infoSchema: string;
+    protected _packageName: string;
+    protected _version: number;
+    protected _status: MigrationStatus;
+    protected defaultVariables: {
+        tablespace: string;
+        schema: string;
+        owner: string;
+    };
+    readonly summaryTable = "migration_summary";
+    readonly eventTable = "migration_events";
+    get packageName(): string;
+    get version(): number;
+    get status(): MigrationStatus;
+    get infoSchema(): string;
+    get summaryTableFull(): string;
+    get eventTableFull(): string;
+    static create(options: DbMigratorOptions): Promise<PgMigrationAdapter>;
+    close(): Promise<void>;
+    refresh(): Promise<void>;
+    update(info: {
+        status?: MigrationStatus;
+        version?: number;
+    }): Promise<void>;
+    writeEvent(event: MigrationAdapter.Event): Promise<void>;
+    executeTask(task: MigrationTask, variables: Record<string, any>): Promise<void>;
+    backupDatabase(): Promise<void>;
+    lockSchema(): Promise<void>;
+    restoreDatabase(): Promise<void>;
+    unlockSchema(): Promise<void>;
+    protected rowToSql(tableName: string, row: Object): string;
+}

package/types/db-migrator.d.ts

@@ -0,0 +1,15 @@
+import { AsyncEventEmitter } from 'strict-typed-events';
+import { ClientConfiguration } from '@sqb/connect';
+import { MigrationAdapter } from './migration-adapter.js';
+import { MigrationPackage, MigrationPackageAsync } from './migration-package.js';
+export interface DbMigratorOptions {
+    connection: ClientConfiguration;
+    migrationPackage: MigrationPackage | MigrationPackageAsync;
+    infoSchema?: string;
+    scriptVariables?: Record<string, string>;
+    targetVersion?: number;
+}
+export declare class DbMigrator extends AsyncEventEmitter {
+    protected adapter: MigrationAdapter;
+    execute(options: DbMigratorOptions): Promise<boolean>;
+}

package/types/index.d.ts

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

package/types/migration-adapter.d.ts

@@ -0,0 +1,32 @@
+import type { MigrationTask } from './migration-package.js';
+import { MigrationStatus } from './types.js';
+export declare abstract class MigrationAdapter {
+    abstract readonly packageName: string;
+    abstract readonly status: MigrationStatus;
+    abstract readonly version: number;
+    abstract close(): Promise<void>;
+    abstract refresh(): Promise<void>;
+    abstract update(info: {
+        status?: MigrationStatus;
+        version?: number;
+    }): Promise<void>;
+    abstract writeEvent(event: MigrationAdapter.Event): Promise<void>;
+    abstract executeTask(task: MigrationTask, variables: Record<string, any>): Promise<void>;
+    abstract lockSchema(): Promise<void>;
+    abstract unlockSchema(): Promise<void>;
+    abstract backupDatabase(): Promise<void>;
+    abstract restoreDatabase(): Promise<void>;
+}
+export declare namespace MigrationAdapter {
+    enum EventKind {
+        started = "started",
+        success = "success",
+        error = "error"
+    }
+    interface Event {
+        event: EventKind;
+        version: number;
+        message: string;
+        details?: string;
+    }
+}

package/types/migration-package.d.ts

@@ -0,0 +1,44 @@
+import { StrictOmit } from 'ts-gems';
+import type { MigrationAdapter } from './migration-adapter.js';
+export interface MigrationPackage {
+    name: string;
+    description?: string;
+    migrations: Migration[];
+    informationTableName?: string;
+}
+export interface Migration {
+    version: number;
+    tasks: MigrationTask[];
+    dirname?: string;
+    backup?: boolean;
+}
+export type MigrationTask = SqlScriptMigrationTask | CustomMigrationTask | InsertDataMigrationTask;
+export interface BaseMigrationTask {
+    title: string;
+    filename?: string;
+}
+export interface SqlScriptMigrationTask extends BaseMigrationTask {
+    title: string;
+    script: string;
+}
+export interface InsertDataMigrationTask extends BaseMigrationTask {
+    title: string;
+    tableName: string;
+    rows: Record<string, any>[];
+}
+export interface CustomMigrationTask extends BaseMigrationTask {
+    title: string;
+    fn: (connection: any, adapter: MigrationAdapter) => void | Promise<void>;
+}
+export declare function isSqlScriptMigrationTask(x: any): x is SqlScriptMigrationTask;
+export declare function isInsertDataMigrationTask(x: any): x is InsertDataMigrationTask;
+export declare function isCustomMigrationTask(x: any): x is CustomMigrationTask;
+export interface MigrationPackageAsync extends StrictOmit<MigrationPackage, 'migrations'> {
+    migrations: (string | MigrationAsync | (() => MigrationAsync) | (() => Promise<MigrationAsync>))[];
+}
+export interface MigrationAsync extends StrictOmit<Migration, 'tasks'> {
+    tasks: (string | MigrationTask | (() => MigrationTask) | (() => Promise<MigrationTask>))[];
+}
+export declare namespace MigrationPackage {
+    function load(asyncConfig: MigrationPackageAsync): Promise<MigrationPackage>;
+}

package/types/types.d.ts

@@ -0,0 +1,9 @@
+export interface MigrationInfo {
+    packageName: string;
+    status: MigrationStatus;
+    version: number;
+}
+export declare enum MigrationStatus {
+    idle = "idle",
+    busy = "busy"
+}

package/types/utils/get-calling-filename.d.ts

@@ -0,0 +1 @@
+export declare function getCallingFilename(position?: number): string;

package/cjs/load-task-files.js

@@ -1,39 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadTaskFiles = void 0;
-const tslib_1 = require("tslib");
-const fast_glob_1 = tslib_1.__importDefault(require("fast-glob"));
-const fs_1 = tslib_1.__importDefault(require("fs"));
-const path_1 = tslib_1.__importDefault(require("path"));
-function loadTaskFiles(pattern) {
-    const out = [];
-    const files = fast_glob_1.default.sync(pattern.replace(/\\/g, '/'), { absolute: true, onlyFiles: true });
-    for (const filename of files) {
-        const ext = path_1.default.extname(filename).toLowerCase();
-        if (ext === '.sql') {
-            const script = fs_1.default.readFileSync(filename, 'utf-8');
-            out.push({
-                title: path_1.default.basename(filename),
-                script
-            });
-        }
-        else if (ext === '.json') {
-            try {
-                const json = JSON.parse(fs_1.default.readFileSync(filename, 'utf-8'));
-                if (typeof json === 'object' && json.tableName && json.rows) {
-                    if (!json.tableName) { // noinspection ExceptionCaughtLocallyJS
-                        throw new Error('"tableName" property does not exists');
-                    }
-                    json.title = json.title || 'Migrate data into ' + json.tableName;
-                    out.push(json);
-                }
-            }
-            catch (e) {
-                e.message = e.message + '\n' + filename;
-                throw e;
-            }
-        }
-    }
-    return out;
-}
-exports.loadTaskFiles = loadTaskFiles;

package/esm/db-migrator.d.ts

@@ -1,29 +0,0 @@
-import { Connection } from 'postgresql-client';
-import { InsertDataMigrationTask, Migration, MigrationPackage } from './types.js';
-export interface MigrationExecuteOptions {
-    connection: Connection;
-    migrationPackage: MigrationPackage;
-    schema: string;
-    owner?: string;
-    tablespace?: string;
-    targetVersion?: number;
-    eventListener?: (event: string, ...args: any[]) => void;
-}
-interface LoadedMigrationPackage {
-    minVersion: number;
-    maxVersion: number;
-    migrations: Migration[];
-}
-export declare class DbMigrator {
-    execute(options: MigrationExecuteOptions): Promise<boolean>;
-    static loadMigrationPackage(pkg: MigrationPackage): Promise<LoadedMigrationPackage>;
-    private _lockSchema;
-    private _unlockSchema;
-    private _backup;
-    private _restore;
-    private _getSchemaInfo;
-    static objectDataToSql(task: InsertDataMigrationTask & {
-        schema: string;
-    }): string;
-}
-export {};

package/esm/index.d.ts

@@ -1,2 +0,0 @@
-export * from './db-migrator.js';
-export * from './types.js';

package/esm/load-task-files.d.ts

@@ -1,2 +0,0 @@
-import { MigrationTask } from './types.js';
-export declare function loadTaskFiles(pattern: string): MigrationTask[];

package/esm/load-task-files.js

@@ -1,34 +0,0 @@
-import glob from 'fast-glob';
-import fs from 'fs';
-import path from 'path';
-export function loadTaskFiles(pattern) {
-    const out = [];
-    const files = glob.sync(pattern.replace(/\\/g, '/'), { absolute: true, onlyFiles: true });
-    for (const filename of files) {
-        const ext = path.extname(filename).toLowerCase();
-        if (ext === '.sql') {
-            const script = fs.readFileSync(filename, 'utf-8');
-            out.push({
-                title: path.basename(filename),
-                script
-            });
-        }
-        else if (ext === '.json') {
-            try {
-                const json = JSON.parse(fs.readFileSync(filename, 'utf-8'));
-                if (typeof json === 'object' && json.tableName && json.rows) {
-                    if (!json.tableName) { // noinspection ExceptionCaughtLocallyJS
-                        throw new Error('"tableName" property does not exists');
-                    }
-                    json.title = json.title || 'Migrate data into ' + json.tableName;
-                    out.push(json);
-                }
-            }
-            catch (e) {
-                e.message = e.message + '\n' + filename;
-                throw e;
-            }
-        }
-    }
-    return out;
-}

package/esm/types.d.ts

@@ -1,36 +0,0 @@
-export type MigrationsThunk = (string | Migration)[] | (() => (string | Migration)[]) | (() => Promise<(string | Migration)[]>);
-export interface MigrationPackage {
-    description: string;
-    informationTableName?: string;
-    migrations: MigrationsThunk | ((string | Migration)[]);
-}
-export interface SchemaOptions {
-    schema: string;
-    owner: string;
-    tablespace: string;
-    currentVersion: number;
-    targetVersion: number;
-}
-export interface Migration {
-    backup?: boolean;
-    version: number;
-    tasks: string[] | MigrationTask[];
-}
-export type MigrationTaskFunction = (connection: any) => void | Promise<void>;
-export type MigrationTask = SqlScriptMigrationTask | CustomMigrationTask | InsertDataMigrationTask;
-export interface BaseMigrationTask {
-    title: string;
-}
-export interface SqlScriptMigrationTask extends BaseMigrationTask {
-    title: string;
-    script: string;
-}
-export interface CustomMigrationTask extends BaseMigrationTask {
-    title: string;
-    fn: MigrationTaskFunction;
-}
-export interface InsertDataMigrationTask extends BaseMigrationTask {
-    title: string;
-    tableName: string;
-    rows: Record<string, any>[];
-}