@sqb/migrator 4.10.0 → 4.10.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sqb/migrator",
   "description": "Database migrator for SQB",
-  "version": "4.10.0",
+  "version": "4.10.1",
   "author": "Panates",
   "contributors": [
     "Eray Hanoglu <e.hanoglu@panates.com>",
@@ -36,9 +36,9 @@
     "ts-gems": "^2.5.0"
   },
   "peerDependencies": {
-    "@sqb/builder": "^4.10.0",
-    "@sqb/connect": "^4.10.0",
-    "@sqb/postgres": "^4.10.0"
+    "@sqb/builder": "^4.10.1",
+    "@sqb/connect": "^4.10.1",
+    "@sqb/postgres": "^4.10.1"
   },
   "engines": {
     "node": ">=16.0",
@@ -48,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;