@webiny/data-migration 0.0.0-unstable.13771d80a8

package/package.json

@@ -0,0 +1,60 @@
+{
+	"name": "@webiny/data-migration",
+	"version": "0.0.0-unstable.13771d80a8",
+	"main": "index.js",
+	"types": "types.ts",
+	"license": "MIT",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/webiny/webiny-js.git"
+	},
+	"description": "Tools to author and execute data migrations.",
+	"author": "Webiny Ltd.",
+	"dependencies": {
+		"@babel/runtime": "7.20.13",
+		"@elastic/elasticsearch": "7.12.0",
+		"@types/pino": "7.0.5",
+		"@webiny/db-dynamodb": "0.0.0-unstable.13771d80a8",
+		"@webiny/handler-aws": "0.0.0-unstable.13771d80a8",
+		"@webiny/ioc": "0.0.0-unstable.13771d80a8",
+		"center-align": "1.0.1",
+		"chalk": "4.1.2",
+		"dynamodb-toolbox": "0.3.5",
+		"mdbid": "1.0.0",
+		"minimatch": "5.1.6",
+		"p-retry": "4.6.2",
+		"pino": "8.11.0",
+		"pino-pretty": "9.4.0",
+		"semver": "6.3.0"
+	},
+	"devDependencies": {
+		"@babel/cli": "^7.19.3",
+		"@babel/core": "^7.19.3",
+		"@babel/preset-env": "^7.19.4",
+		"@types/center-align": "^1.0.0",
+		"@types/semver": "^7.3.4",
+		"@webiny/cli": "^0.0.0-unstable.13771d80a8",
+		"@webiny/project-utils": "^0.0.0-unstable.13771d80a8",
+		"jest": "^28.1.0",
+		"jest-dynalite": "^3.2.0",
+		"jest-mock-console": "^1.0.0",
+		"rimraf": "^3.0.2",
+		"typescript": "4.7.4"
+	},
+	"publishConfig": {
+		"access": "public",
+		"directory": "dist"
+	},
+	"scripts": {
+		"build": "yarn webiny run build",
+		"watch": "yarn webiny run watch"
+	},
+	"adio": {
+		"ignore": {
+			"dependencies": [
+				"@types/pino"
+			]
+		}
+	},
+	"gitHead": "13771d80a8ae3195c9ea1485bf8c01f6667a129e"
+}

package/repository/createStandardEntity.d.ts

@@ -0,0 +1,5 @@
+import { Table, Entity } from "dynamodb-toolbox";
+export declare const createStandardEntity: ({ table, name }: {
+    table: Table;
+    name: string;
+}) => Entity<{}>;

package/repository/createStandardEntity.js

@@ -0,0 +1,37 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createStandardEntity = void 0;
+var _dynamodbToolbox = require("dynamodb-toolbox");
+const createStandardEntity = ({
+  table,
+  name
+}) => {
+  return new _dynamodbToolbox.Entity({
+    name,
+    table,
+    attributes: {
+      PK: {
+        partitionKey: true
+      },
+      SK: {
+        sortKey: true
+      },
+      GSI1_PK: {
+        type: "string"
+      },
+      GSI1_SK: {
+        type: "string"
+      },
+      TYPE: {
+        type: "string"
+      },
+      data: {
+        type: "map"
+      }
+    }
+  });
+};
+exports.createStandardEntity = createStandardEntity;

package/repository/createStandardEntity.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["createStandardEntity","table","name","Entity","attributes","PK","partitionKey","SK","sortKey","GSI1_PK","type","GSI1_SK","TYPE","data"],"sources":["createStandardEntity.ts"],"sourcesContent":["import { Table, Entity } from \"dynamodb-toolbox\";\n\nexport const createStandardEntity = ({ table, name }: { table: Table; name: string }) => {\n    return new Entity({\n        name,\n        table,\n        attributes: {\n            PK: {\n                partitionKey: true\n            },\n            SK: {\n                sortKey: true\n            },\n            GSI1_PK: {\n                type: \"string\"\n            },\n            GSI1_SK: {\n                type: \"string\"\n            },\n            TYPE: {\n                type: \"string\"\n            },\n            data: {\n                type: \"map\"\n            }\n        }\n    });\n};\n"],"mappings":";;;;;;AAAA;AAEO,MAAMA,oBAAoB,GAAG,CAAC;EAAEC,KAAK;EAAEC;AAAqC,CAAC,KAAK;EACrF,OAAO,IAAIC,uBAAM,CAAC;IACdD,IAAI;IACJD,KAAK;IACLG,UAAU,EAAE;MACRC,EAAE,EAAE;QACAC,YAAY,EAAE;MAClB,CAAC;MACDC,EAAE,EAAE;QACAC,OAAO,EAAE;MACb,CAAC;MACDC,OAAO,EAAE;QACLC,IAAI,EAAE;MACV,CAAC;MACDC,OAAO,EAAE;QACLD,IAAI,EAAE;MACV,CAAC;MACDE,IAAI,EAAE;QACFF,IAAI,EAAE;MACV,CAAC;MACDG,IAAI,EAAE;QACFH,IAAI,EAAE;MACV;IACJ;EACJ,CAAC,CAAC;AACN,CAAC;AAAC"}

package/repository/migrations.repository.d.ts

@@ -0,0 +1,17 @@
+import { Table } from "dynamodb-toolbox";
+import { MigrationItem, MigrationRepository, MigrationRun } from "../types";
+export declare class MigrationRepositoryImpl implements MigrationRepository {
+    private readonly run;
+    private readonly migration;
+    private readonly checkpoint;
+    constructor(table: Table);
+    getLastRun(): Promise<MigrationRun | null>;
+    saveRun(run: MigrationRun): Promise<void>;
+    listMigrations(params?: {
+        limit: number;
+    }): Promise<MigrationItem[]>;
+    logMigration(migration: MigrationItem): Promise<void>;
+    createCheckpoint(id: string, data: unknown): Promise<void>;
+    deleteCheckpoint(id: string): Promise<void>;
+    getCheckpoint(id: string): Promise<unknown | null>;
+}

package/repository/migrations.repository.js

@@ -0,0 +1,108 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.MigrationRepositoryImpl = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _query = require("@webiny/db-dynamodb/utils/query");
+var _ioc = require("@webiny/ioc");
+var _symbols = require("../symbols");
+var _createStandardEntity = require("./createStandardEntity");
+class MigrationRepositoryImpl {
+  constructor(table) {
+    (0, _defineProperty2.default)(this, "run", void 0);
+    (0, _defineProperty2.default)(this, "migration", void 0);
+    (0, _defineProperty2.default)(this, "checkpoint", void 0);
+    this.run = (0, _createStandardEntity.createStandardEntity)({
+      table,
+      name: "MigrationRun"
+    });
+    this.migration = (0, _createStandardEntity.createStandardEntity)({
+      table,
+      name: "Migration"
+    });
+    this.checkpoint = (0, _createStandardEntity.createStandardEntity)({
+      table,
+      name: "MigrationCheckpoint"
+    });
+  }
+  async getLastRun() {
+    const result = await (0, _query.queryOne)({
+      entity: this.run,
+      partitionKey: "MIGRATION_RUNS",
+      options: {
+        index: "GSI1",
+        gt: " ",
+        reverse: true
+      }
+    });
+    return result ? result.data : null;
+  }
+  async saveRun(run) {
+    await this.run.put({
+      PK: `MIGRATION_RUN#${run.id}`,
+      SK: "A",
+      TYPE: "migration.run",
+      GSI1_PK: "MIGRATION_RUNS",
+      GSI1_SK: run.id,
+      data: run
+    });
+  }
+  async listMigrations(params) {
+    const {
+      limit
+    } = params || {};
+    const result = await (0, _query.queryAll)({
+      entity: this.migration,
+      partitionKey: "MIGRATIONS",
+      options: {
+        index: "GSI1",
+        gt: " ",
+        limit,
+        // Sort by GSI1_SK in descending order.
+        reverse: true
+      }
+    });
+    return result.map(item => item.data);
+  }
+  async logMigration(migration) {
+    await this.migration.put({
+      PK: `MIGRATION#${migration.id}`,
+      SK: "A",
+      TYPE: "migration",
+      GSI1_PK: "MIGRATIONS",
+      GSI1_SK: migration.id,
+      data: migration
+    });
+  }
+  async createCheckpoint(id, data) {
+    await this.checkpoint.put({
+      PK: `MIGRATION_CHECKPOINT#${id}`,
+      SK: "A",
+      TYPE: "migration.checkpoint",
+      GSI1_PK: "MIGRATION_CHECKPOINTS",
+      GSI1_SK: id,
+      data
+    });
+  }
+  deleteCheckpoint(id) {
+    return this.checkpoint.delete({
+      PK: `MIGRATION_CHECKPOINT#${id}`,
+      SK: "A"
+    });
+  }
+  async getCheckpoint(id) {
+    const record = await this.checkpoint.get({
+      PK: `MIGRATION_CHECKPOINT#${id}`,
+      SK: "A"
+    });
+    if (!record || !record.Item) {
+      return null;
+    }
+    return record.Item.data;
+  }
+}
+exports.MigrationRepositoryImpl = MigrationRepositoryImpl;
+(0, _ioc.makeInjectable)(MigrationRepositoryImpl, [(0, _ioc.inject)(_symbols.PrimaryDynamoTableSymbol)]);

package/repository/migrations.repository.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["MigrationRepositoryImpl","constructor","table","run","createStandardEntity","name","migration","checkpoint","getLastRun","result","queryOne","entity","partitionKey","options","index","gt","reverse","data","saveRun","put","PK","id","SK","TYPE","GSI1_PK","GSI1_SK","listMigrations","params","limit","queryAll","map","item","logMigration","createCheckpoint","deleteCheckpoint","delete","getCheckpoint","record","get","Item","makeInjectable","inject","PrimaryDynamoTableSymbol"],"sources":["migrations.repository.ts"],"sourcesContent":["import { Table, Entity } from \"dynamodb-toolbox\";\nimport { queryAll, queryOne } from \"@webiny/db-dynamodb/utils/query\";\nimport { MigrationItem, MigrationRepository, MigrationRun } from \"~/types\";\nimport { inject, makeInjectable } from \"@webiny/ioc\";\nimport { PrimaryDynamoTableSymbol } from \"~/symbols\";\nimport { createStandardEntity } from \"./createStandardEntity\";\n\nexport class MigrationRepositoryImpl implements MigrationRepository {\n    private readonly run: Entity<any>;\n    private readonly migration: Entity<any>;\n    private readonly checkpoint: Entity<any>;\n\n    constructor(table: Table) {\n        this.run = createStandardEntity({ table, name: \"MigrationRun\" });\n        this.migration = createStandardEntity({ table, name: \"Migration\" });\n        this.checkpoint = createStandardEntity({ table, name: \"MigrationCheckpoint\" });\n    }\n\n    async getLastRun(): Promise<MigrationRun | null> {\n        const result = await queryOne<{ data: MigrationRun }>({\n            entity: this.run,\n            partitionKey: \"MIGRATION_RUNS\",\n            options: {\n                index: \"GSI1\",\n                gt: \" \",\n                reverse: true\n            }\n        });\n\n        return result ? result.data : null;\n    }\n\n    async saveRun(run: MigrationRun): Promise<void> {\n        await this.run.put({\n            PK: `MIGRATION_RUN#${run.id}`,\n            SK: \"A\",\n            TYPE: \"migration.run\",\n            GSI1_PK: \"MIGRATION_RUNS\",\n            GSI1_SK: run.id,\n            data: run\n        });\n    }\n\n    async listMigrations(params?: { limit: number }): Promise<MigrationItem[]> {\n        const { limit } = params || {};\n        const result = await queryAll<{ data: MigrationItem }>({\n            entity: this.migration,\n            partitionKey: \"MIGRATIONS\",\n            options: {\n                index: \"GSI1\",\n                gt: \" \",\n                limit,\n                // Sort by GSI1_SK in descending order.\n                reverse: true\n            }\n        });\n\n        return result.map(item => item.data);\n    }\n\n    async logMigration(migration: MigrationItem): Promise<void> {\n        await this.migration.put({\n            PK: `MIGRATION#${migration.id}`,\n            SK: \"A\",\n            TYPE: \"migration\",\n            GSI1_PK: \"MIGRATIONS\",\n            GSI1_SK: migration.id,\n            data: migration\n        });\n    }\n\n    async createCheckpoint(id: string, data: unknown): Promise<void> {\n        await this.checkpoint.put({\n            PK: `MIGRATION_CHECKPOINT#${id}`,\n            SK: \"A\",\n            TYPE: \"migration.checkpoint\",\n            GSI1_PK: \"MIGRATION_CHECKPOINTS\",\n            GSI1_SK: id,\n            data\n        });\n    }\n\n    deleteCheckpoint(id: string): Promise<void> {\n        return this.checkpoint.delete({\n            PK: `MIGRATION_CHECKPOINT#${id}`,\n            SK: \"A\"\n        });\n    }\n\n    async getCheckpoint(id: string): Promise<unknown | null> {\n        const record = await this.checkpoint.get({\n            PK: `MIGRATION_CHECKPOINT#${id}`,\n            SK: \"A\"\n        });\n\n        if (!record || !record.Item) {\n            return null;\n        }\n        return record.Item.data;\n    }\n}\n\nmakeInjectable(MigrationRepositoryImpl, [inject(PrimaryDynamoTableSymbol)]);\n"],"mappings":";;;;;;;;AACA;AAEA;AACA;AACA;AAEO,MAAMA,uBAAuB,CAAgC;EAKhEC,WAAW,CAACC,KAAY,EAAE;IAAA;IAAA;IAAA;IACtB,IAAI,CAACC,GAAG,GAAG,IAAAC,0CAAoB,EAAC;MAAEF,KAAK;MAAEG,IAAI,EAAE;IAAe,CAAC,CAAC;IAChE,IAAI,CAACC,SAAS,GAAG,IAAAF,0CAAoB,EAAC;MAAEF,KAAK;MAAEG,IAAI,EAAE;IAAY,CAAC,CAAC;IACnE,IAAI,CAACE,UAAU,GAAG,IAAAH,0CAAoB,EAAC;MAAEF,KAAK;MAAEG,IAAI,EAAE;IAAsB,CAAC,CAAC;EAClF;EAEA,MAAMG,UAAU,GAAiC;IAC7C,MAAMC,MAAM,GAAG,MAAM,IAAAC,eAAQ,EAAyB;MAClDC,MAAM,EAAE,IAAI,CAACR,GAAG;MAChBS,YAAY,EAAE,gBAAgB;MAC9BC,OAAO,EAAE;QACLC,KAAK,EAAE,MAAM;QACbC,EAAE,EAAE,GAAG;QACPC,OAAO,EAAE;MACb;IACJ,CAAC,CAAC;IAEF,OAAOP,MAAM,GAAGA,MAAM,CAACQ,IAAI,GAAG,IAAI;EACtC;EAEA,MAAMC,OAAO,CAACf,GAAiB,EAAiB;IAC5C,MAAM,IAAI,CAACA,GAAG,CAACgB,GAAG,CAAC;MACfC,EAAE,EAAG,iBAAgBjB,GAAG,CAACkB,EAAG,EAAC;MAC7BC,EAAE,EAAE,GAAG;MACPC,IAAI,EAAE,eAAe;MACrBC,OAAO,EAAE,gBAAgB;MACzBC,OAAO,EAAEtB,GAAG,CAACkB,EAAE;MACfJ,IAAI,EAAEd;IACV,CAAC,CAAC;EACN;EAEA,MAAMuB,cAAc,CAACC,MAA0B,EAA4B;IACvE,MAAM;MAAEC;IAAM,CAAC,GAAGD,MAAM,IAAI,CAAC,CAAC;IAC9B,MAAMlB,MAAM,GAAG,MAAM,IAAAoB,eAAQ,EAA0B;MACnDlB,MAAM,EAAE,IAAI,CAACL,SAAS;MACtBM,YAAY,EAAE,YAAY;MAC1BC,OAAO,EAAE;QACLC,KAAK,EAAE,MAAM;QACbC,EAAE,EAAE,GAAG;QACPa,KAAK;QACL;QACAZ,OAAO,EAAE;MACb;IACJ,CAAC,CAAC;IAEF,OAAOP,MAAM,CAACqB,GAAG,CAACC,IAAI,IAAIA,IAAI,CAACd,IAAI,CAAC;EACxC;EAEA,MAAMe,YAAY,CAAC1B,SAAwB,EAAiB;IACxD,MAAM,IAAI,CAACA,SAAS,CAACa,GAAG,CAAC;MACrBC,EAAE,EAAG,aAAYd,SAAS,CAACe,EAAG,EAAC;MAC/BC,EAAE,EAAE,GAAG;MACPC,IAAI,EAAE,WAAW;MACjBC,OAAO,EAAE,YAAY;MACrBC,OAAO,EAAEnB,SAAS,CAACe,EAAE;MACrBJ,IAAI,EAAEX;IACV,CAAC,CAAC;EACN;EAEA,MAAM2B,gBAAgB,CAACZ,EAAU,EAAEJ,IAAa,EAAiB;IAC7D,MAAM,IAAI,CAACV,UAAU,CAACY,GAAG,CAAC;MACtBC,EAAE,EAAG,wBAAuBC,EAAG,EAAC;MAChCC,EAAE,EAAE,GAAG;MACPC,IAAI,EAAE,sBAAsB;MAC5BC,OAAO,EAAE,uBAAuB;MAChCC,OAAO,EAAEJ,EAAE;MACXJ;IACJ,CAAC,CAAC;EACN;EAEAiB,gBAAgB,CAACb,EAAU,EAAiB;IACxC,OAAO,IAAI,CAACd,UAAU,CAAC4B,MAAM,CAAC;MAC1Bf,EAAE,EAAG,wBAAuBC,EAAG,EAAC;MAChCC,EAAE,EAAE;IACR,CAAC,CAAC;EACN;EAEA,MAAMc,aAAa,CAACf,EAAU,EAA2B;IACrD,MAAMgB,MAAM,GAAG,MAAM,IAAI,CAAC9B,UAAU,CAAC+B,GAAG,CAAC;MACrClB,EAAE,EAAG,wBAAuBC,EAAG,EAAC;MAChCC,EAAE,EAAE;IACR,CAAC,CAAC;IAEF,IAAI,CAACe,MAAM,IAAI,CAACA,MAAM,CAACE,IAAI,EAAE;MACzB,OAAO,IAAI;IACf;IACA,OAAOF,MAAM,CAACE,IAAI,CAACtB,IAAI;EAC3B;AACJ;AAAC;AAED,IAAAuB,mBAAc,EAACxC,uBAAuB,EAAE,CAAC,IAAAyC,WAAM,EAACC,iCAAwB,CAAC,CAAC,CAAC"}

package/symbols.d.ts

@@ -0,0 +1,7 @@
+export declare const LoggerSymbol: unique symbol;
+export declare const MigrationSymbol: unique symbol;
+export declare const MigrationRepositorySymbol: unique symbol;
+export declare const ElasticsearchClientSymbol: unique symbol;
+export declare const PrimaryDynamoTableSymbol: unique symbol;
+export declare const ElasticsearchDynamoTableSymbol: unique symbol;
+export declare const ExecutionTimeLimiterSymbol: unique symbol;

package/symbols.js

@@ -0,0 +1,20 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.PrimaryDynamoTableSymbol = exports.MigrationSymbol = exports.MigrationRepositorySymbol = exports.LoggerSymbol = exports.ExecutionTimeLimiterSymbol = exports.ElasticsearchDynamoTableSymbol = exports.ElasticsearchClientSymbol = void 0;
+const LoggerSymbol = Symbol.for("PinoLogger");
+exports.LoggerSymbol = LoggerSymbol;
+const MigrationSymbol = Symbol.for("Migration");
+exports.MigrationSymbol = MigrationSymbol;
+const MigrationRepositorySymbol = Symbol.for("MigrationRepository");
+exports.MigrationRepositorySymbol = MigrationRepositorySymbol;
+const ElasticsearchClientSymbol = Symbol.for("ElasticsearchClient");
+exports.ElasticsearchClientSymbol = ElasticsearchClientSymbol;
+const PrimaryDynamoTableSymbol = Symbol.for("PrimaryDynamoTable");
+exports.PrimaryDynamoTableSymbol = PrimaryDynamoTableSymbol;
+const ElasticsearchDynamoTableSymbol = Symbol.for("ElasticsearchDynamoTable");
+exports.ElasticsearchDynamoTableSymbol = ElasticsearchDynamoTableSymbol;
+const ExecutionTimeLimiterSymbol = Symbol.for("ExecutionTimeLimiter");
+exports.ExecutionTimeLimiterSymbol = ExecutionTimeLimiterSymbol;

package/symbols.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["LoggerSymbol","Symbol","for","MigrationSymbol","MigrationRepositorySymbol","ElasticsearchClientSymbol","PrimaryDynamoTableSymbol","ElasticsearchDynamoTableSymbol","ExecutionTimeLimiterSymbol"],"sources":["symbols.ts"],"sourcesContent":["export const LoggerSymbol = Symbol.for(\"PinoLogger\");\nexport const MigrationSymbol = Symbol.for(\"Migration\");\nexport const MigrationRepositorySymbol = Symbol.for(\"MigrationRepository\");\nexport const ElasticsearchClientSymbol = Symbol.for(\"ElasticsearchClient\");\nexport const PrimaryDynamoTableSymbol = Symbol.for(\"PrimaryDynamoTable\");\nexport const ElasticsearchDynamoTableSymbol = Symbol.for(\"ElasticsearchDynamoTable\");\nexport const ExecutionTimeLimiterSymbol = Symbol.for(\"ExecutionTimeLimiter\");\n"],"mappings":";;;;;;AAAO,MAAMA,YAAY,GAAGC,MAAM,CAACC,GAAG,CAAC,YAAY,CAAC;AAAC;AAC9C,MAAMC,eAAe,GAAGF,MAAM,CAACC,GAAG,CAAC,WAAW,CAAC;AAAC;AAChD,MAAME,yBAAyB,GAAGH,MAAM,CAACC,GAAG,CAAC,qBAAqB,CAAC;AAAC;AACpE,MAAMG,yBAAyB,GAAGJ,MAAM,CAACC,GAAG,CAAC,qBAAqB,CAAC;AAAC;AACpE,MAAMI,wBAAwB,GAAGL,MAAM,CAACC,GAAG,CAAC,oBAAoB,CAAC;AAAC;AAClE,MAAMK,8BAA8B,GAAGN,MAAM,CAACC,GAAG,CAAC,0BAA0B,CAAC;AAAC;AAC9E,MAAMM,0BAA0B,GAAGP,MAAM,CAACC,GAAG,CAAC,sBAAsB,CAAC;AAAC"}

package/types.d.ts

@@ -0,0 +1,80 @@
+import { Logger } from "pino";
+export { Logger };
+export interface MigrationItem {
+    id: string;
+    description: string;
+    reason: string;
+    startedOn?: string;
+    finishedOn?: string;
+}
+export interface MigrationRun {
+    id: string;
+    startedOn: string;
+    finishedOn: string;
+    status: "init" | "running" | "pending" | "done" | "error";
+    migrations: MigrationRunItem[];
+    error?: {
+        message: string;
+        name?: string;
+        code?: string;
+        data?: Record<string, any>;
+        stack?: string;
+    };
+}
+export interface MigrationRunItem {
+    id: string;
+    status: "done" | "running" | "skipped" | "pending" | "not-applicable" | "error";
+    startedOn?: string;
+    finishedOn?: string;
+}
+export interface MigrationRepository {
+    getLastRun(): Promise<MigrationRun | null>;
+    saveRun(run: MigrationRun): Promise<void>;
+    listMigrations(params?: {
+        limit: number;
+    }): Promise<MigrationItem[]>;
+    logMigration(migration: MigrationItem): Promise<void>;
+    createCheckpoint(id: string, data: unknown): Promise<void>;
+    getCheckpoint(id: string): Promise<unknown>;
+    deleteCheckpoint(id: string): Promise<void>;
+}
+export interface DataMigrationContext<TCheckpoint = any> {
+    projectVersion: string;
+    logger: Logger;
+    checkpoint?: TCheckpoint;
+    runningOutOfTime: () => boolean;
+    createCheckpoint: (data: TCheckpoint) => void;
+    createCheckpointAndExit: (data: TCheckpoint) => void;
+}
+export interface DataMigration<TCheckpoint = any> {
+    getId(): string;
+    getDescription(): string;
+    shouldExecute(context: DataMigrationContext<TCheckpoint>): Promise<boolean>;
+    execute(context: DataMigrationContext<TCheckpoint>): Promise<void>;
+}
+/**
+ * Migration execution time limiter (in milliseconds).
+ */
+export declare type ExecutionTimeLimiter = () => number;
+export interface MigrationEventPayload {
+    command: "status" | "execute";
+    version?: string;
+    pattern?: string;
+}
+export declare type MigrationEventHandlerResponse = undefined | MigrationStatusResponse | MigrationInvocationErrorResponse;
+export interface MigrationInvocationErrorResponse {
+    error: {
+        message: string;
+    };
+    data?: undefined;
+}
+export interface MigrationStatusRunItem extends MigrationRunItem {
+    description: string;
+}
+export interface MigrationStatus extends MigrationRun {
+    migrations: MigrationStatusRunItem[];
+}
+export interface MigrationStatusResponse {
+    data: MigrationStatus;
+    error?: undefined;
+}

package/types.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "Logger", {
+  enumerable: true,
+  get: function () {
+    return _pino.Logger;
+  }
+});
+var _pino = require("pino");

package/types.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["types.ts"],"sourcesContent":["import { Logger } from \"pino\";\n\nexport { Logger };\n\nexport interface MigrationItem {\n    id: string;\n    description: string;\n    reason: string;\n    startedOn?: string;\n    finishedOn?: string;\n}\n\nexport interface MigrationRun {\n    id: string;\n    startedOn: string;\n    finishedOn: string;\n    status: \"init\" | \"running\" | \"pending\" | \"done\" | \"error\";\n    migrations: MigrationRunItem[];\n    error?: {\n        message: string;\n        name?: string;\n        code?: string;\n        data?: Record<string, any>;\n        stack?: string;\n    };\n}\n\nexport interface MigrationRunItem {\n    id: string;\n    status: \"done\" | \"running\" | \"skipped\" | \"pending\" | \"not-applicable\" | \"error\";\n    startedOn?: string;\n    finishedOn?: string;\n}\n\nexport interface MigrationRepository {\n    getLastRun(): Promise<MigrationRun | null>;\n    saveRun(run: MigrationRun): Promise<void>;\n    listMigrations(params?: { limit: number }): Promise<MigrationItem[]>;\n    logMigration(migration: MigrationItem): Promise<void>;\n    createCheckpoint(id: string, data: unknown): Promise<void>;\n    getCheckpoint(id: string): Promise<unknown>;\n    deleteCheckpoint(id: string): Promise<void>;\n}\n\nexport interface DataMigrationContext<TCheckpoint = any> {\n    projectVersion: string;\n    logger: Logger;\n    checkpoint?: TCheckpoint;\n    runningOutOfTime: () => boolean;\n    createCheckpoint: (data: TCheckpoint) => void;\n    createCheckpointAndExit: (data: TCheckpoint) => void;\n}\n\nexport interface DataMigration<TCheckpoint = any> {\n    getId(): string;\n    getDescription(): string;\n    // This function should check of the migration needs to apply some changes to the system.\n    // Returning `false` means \"everything is ok, mark this migration as executed\".\n    shouldExecute(context: DataMigrationContext<TCheckpoint>): Promise<boolean>;\n    execute(context: DataMigrationContext<TCheckpoint>): Promise<void>;\n}\n\n/**\n * Migration execution time limiter (in milliseconds).\n */\nexport type ExecutionTimeLimiter = () => number;\n\nexport interface MigrationEventPayload {\n    command: \"status\" | \"execute\";\n    version?: string;\n    pattern?: string;\n}\n\nexport type MigrationEventHandlerResponse =\n    // When migration is triggered (via `Event` invocation type), it simply gets invoked, and returns nothing.\n    | undefined\n    // Last migration run state.\n    | MigrationStatusResponse\n    // If an unhandled error is thrown, return the error object.\n    | MigrationInvocationErrorResponse;\n\nexport interface MigrationInvocationErrorResponse {\n    error: { message: string };\n    data?: undefined;\n}\n\nexport interface MigrationStatusRunItem extends MigrationRunItem {\n    description: string;\n}\n\nexport interface MigrationStatus extends MigrationRun {\n    migrations: MigrationStatusRunItem[];\n}\n\nexport interface MigrationStatusResponse {\n    data: MigrationStatus;\n    error?: undefined;\n}\n"],"mappings":";;;;;;;;;;;AAAA"}