@webiny/data-migration 0.0.0-unstable.e3f4727c56 → 0.0.0-unstable.eb196ccd2f

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@webiny/data-migration",
-	"version": "0.0.0-unstable.e3f4727c56",
+	"version": "0.0.0-unstable.eb196ccd2f",
 	"main": "index.js",
 	"types": "types.ts",
 	"license": "MIT",
@@ -11,46 +11,37 @@
 	"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.e3f4727c56",
-		"@webiny/handler-aws": "0.0.0-unstable.e3f4727c56",
-		"@webiny/ioc": "0.0.0-unstable.e3f4727c56",
+		"@webiny/aws-sdk": "0.0.0-unstable.eb196ccd2f",
+		"@webiny/cli": "0.0.0-unstable.eb196ccd2f",
+		"@webiny/db-dynamodb": "0.0.0-unstable.eb196ccd2f",
+		"@webiny/handler-aws": "0.0.0-unstable.eb196ccd2f",
+		"@webiny/ioc": "0.0.0-unstable.eb196ccd2f",
+		"@webiny/logger": "0.0.0-unstable.eb196ccd2f",
+		"@webiny/utils": "0.0.0-unstable.eb196ccd2f",
+		"center-align": "1.0.1",
 		"chalk": "4.1.2",
-		"dynamodb-toolbox": "0.3.5",
 		"minimatch": "5.1.6",
-		"pino": "8.11.0",
 		"pino-pretty": "9.4.0",
-		"semver": "6.3.0"
+		"semver": "7.6.3"
 	},
 	"devDependencies": {
-		"@babel/cli": "^7.19.3",
-		"@babel/core": "^7.19.3",
-		"@babel/preset-env": "^7.19.4",
-		"@types/semver": "^7.3.4",
-		"@webiny/cli": "^0.0.0-unstable.e3f4727c56",
-		"@webiny/project-utils": "^0.0.0-unstable.e3f4727c56",
-		"jest": "^28.1.0",
-		"jest-dynalite": "^3.2.0",
-		"jest-mock-console": "^1.0.0",
-		"rimraf": "^3.0.2",
-		"typescript": "4.7.4"
+		"@types/center-align": "1.0.0",
+		"@types/semver": "7.3.13",
+		"@webiny/project-utils": "0.0.0-unstable.eb196ccd2f",
+		"jest": "29.7.0",
+		"jest-dynalite": "3.6.1",
+		"jest-mock-console": "2.0.0",
+		"rimraf": "6.0.1",
+		"typescript": "5.3.3"
 	},
 	"publishConfig": {
 		"access": "public",
 		"directory": "dist"
 	},
 	"scripts": {
-		"build": "yarn webiny run build",
-		"watch": "yarn webiny run watch"
+		"build": "node ../cli/bin.js run build",
+		"watch": "node ../cli/bin.js run watch"
 	},
-	"adio": {
-		"ignore": {
-			"dependencies": [
-				"@types/pino"
-			]
-		}
-	},
-	"gitHead": "e3f4727c567484dc53e1efceacfb37dbacd7f4de"
+	"gitHead": "eb196ccd2f32296e10f7add6dd7220d4e3abece4"
 }

package/repository/createStandardEntity.d.ts

@@ -0,0 +1,52 @@
+import type { Table } from "@webiny/db-dynamodb/toolbox";
+import { Entity } from "@webiny/db-dynamodb/toolbox";
+export declare const createStandardEntity: ({ table, name }: {
+    table: Table<string, string, string>;
+    name: string;
+}) => Entity<string, import("dynamodb-toolbox/dist/cjs/classes/Entity").Overlay, import("dynamodb-toolbox/dist/cjs/classes/Entity").Overlay, Table<string, string, string>, boolean, boolean, boolean, string, string, string, boolean, {
+    PK: {
+        partitionKey: true;
+    };
+    SK: {
+        sortKey: true;
+    };
+    GSI1_PK: {
+        type: "string";
+    };
+    GSI1_SK: {
+        type: "string";
+    };
+    TYPE: {
+        type: "string";
+    };
+    data: {
+        type: "map";
+    };
+}, {
+    PK: {
+        partitionKey: true;
+    };
+    SK: {
+        sortKey: true;
+    };
+    GSI1_PK: {
+        type: "string";
+    };
+    GSI1_SK: {
+        type: "string";
+    };
+    TYPE: {
+        type: "string";
+    };
+    data: {
+        type: "map";
+    };
+}, import("dynamodb-toolbox/dist/cjs/classes/Entity").ParsedAttributes<import("ts-toolbelt/out/Any/Key").Key>, any, {
+    [x: string]: any;
+    [x: number]: any;
+    [x: symbol]: any;
+}, {
+    [x: string]: any;
+    [x: number]: any;
+    [x: symbol]: any;
+}>;

package/repository/{migrations.entity.js → createStandardEntity.js}

@@ -3,13 +3,14 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.createMigrationsEntity = void 0;
-var _dynamodbToolbox = require("dynamodb-toolbox");
-const createMigrationsEntity = ({
-  table
+exports.createStandardEntity = void 0;
+var _toolbox = require("@webiny/db-dynamodb/toolbox");
+const createStandardEntity = ({
+  table,
+  name
 }) => {
-  return new _dynamodbToolbox.Entity({
-    name: "Migrations",
+  return new _toolbox.Entity({
+    name,
     table,
     attributes: {
       PK: {
@@ -33,4 +34,6 @@ const createMigrationsEntity = ({
     }
   });
 };
-exports.createMigrationsEntity = createMigrationsEntity;
+exports.createStandardEntity = createStandardEntity;
+
+//# sourceMappingURL=createStandardEntity.js.map

package/repository/createStandardEntity.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_toolbox","require","createStandardEntity","table","name","Entity","attributes","PK","partitionKey","SK","sortKey","GSI1_PK","type","GSI1_SK","TYPE","data","exports"],"sources":["createStandardEntity.ts"],"sourcesContent":["import type { Table } from \"@webiny/db-dynamodb/toolbox\";\nimport { Entity } from \"@webiny/db-dynamodb/toolbox\";\n\nexport const createStandardEntity = ({\n    table,\n    name\n}: {\n    table: Table<string, string, string>;\n    name: string;\n}) => {\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":";;;;;;AACA,IAAAA,QAAA,GAAAC,OAAA;AAEO,MAAMC,oBAAoB,GAAGA,CAAC;EACjCC,KAAK;EACLC;AAIJ,CAAC,KAAK;EACF,OAAO,IAAIC,eAAM,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;AAACI,OAAA,CAAAd,oBAAA,GAAAA,oBAAA","ignoreList":[]}

package/repository/migrations.repository.d.ts

@@ -1,10 +1,17 @@
-import { Table } from "dynamodb-toolbox";
-import { MigrationItem, MigrationRepository } from "../types";
+import type { Table } from "@webiny/db-dynamodb/toolbox";
+import type { MigrationItem, MigrationRepository, MigrationRun } from "../types";
 export declare class MigrationRepositoryImpl implements MigrationRepository {
-    private readonly entity;
-    constructor(table: Table);
+    private readonly run;
+    private readonly migration;
+    private readonly checkpoint;
+    constructor(table: Table<string, string, string>);
+    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

@@ -1,20 +1,52 @@
 "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 _migrations = require("./migrations.entity");
 var _ioc = require("@webiny/ioc");
 var _symbols = require("../symbols");
+var _createStandardEntity = require("./createStandardEntity");
+var _dbDynamodb = require("@webiny/db-dynamodb");
 class MigrationRepositoryImpl {
   constructor(table) {
-    (0, _defineProperty2.default)(this, "entity", void 0);
-    this.entity = (0, _migrations.createMigrationsEntity)({
-      table
+    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 (0, _dbDynamodb.put)({
+      entity: this.run,
+      item: {
+        PK: `MIGRATION_RUN#${run.id}`,
+        SK: "A",
+        TYPE: "migration.run",
+        GSI1_PK: "MIGRATION_RUNS",
+        GSI1_SK: run.id,
+        data: run
+      }
     });
   }
   async listMigrations(params) {
@@ -22,7 +54,7 @@ class MigrationRepositoryImpl {
       limit
     } = params || {};
     const result = await (0, _query.queryAll)({
-      entity: this.entity,
+      entity: this.migration,
       partitionKey: "MIGRATIONS",
       options: {
         index: "GSI1",
@@ -35,15 +67,55 @@ class MigrationRepositoryImpl {
     return result.map(item => item.data);
   }
   async logMigration(migration) {
-    await this.entity.put({
-      PK: `MIGRATION#${migration.id}`,
-      SK: "A",
-      TYPE: "migration",
-      GSI1_PK: "MIGRATIONS",
-      GSI1_SK: migration.id,
-      data: migration
+    await (0, _dbDynamodb.put)({
+      entity: this.migration,
+      item: {
+        PK: `MIGRATION#${migration.id}`,
+        SK: "A",
+        TYPE: "migration",
+        GSI1_PK: "MIGRATIONS",
+        GSI1_SK: migration.id,
+        data: migration
+      }
+    });
+  }
+  async createCheckpoint(id, data) {
+    await (0, _dbDynamodb.put)({
+      entity: this.checkpoint,
+      item: {
+        PK: `MIGRATION_CHECKPOINT#${id}`,
+        SK: "A",
+        TYPE: "migration.checkpoint",
+        GSI1_PK: "MIGRATION_CHECKPOINTS",
+        GSI1_SK: id,
+        data
+      }
     });
   }
+  async deleteCheckpoint(id) {
+    await (0, _dbDynamodb.deleteItem)({
+      entity: this.checkpoint,
+      keys: {
+        PK: `MIGRATION_CHECKPOINT#${id}`,
+        SK: "A"
+      }
+    });
+  }
+  async getCheckpoint(id) {
+    const record = await (0, _dbDynamodb.get)({
+      entity: this.checkpoint,
+      keys: {
+        PK: `MIGRATION_CHECKPOINT#${id}`,
+        SK: "A"
+      }
+    });
+    if (!record) {
+      return null;
+    }
+    return record.data;
+  }
 }
 exports.MigrationRepositoryImpl = MigrationRepositoryImpl;
-(0, _ioc.makeInjectable)(MigrationRepositoryImpl, [(0, _ioc.inject)(_symbols.PrimaryDynamoTableSymbol)]);
+(0, _ioc.makeInjectable)(MigrationRepositoryImpl, [(0, _ioc.inject)(_symbols.PrimaryDynamoTableSymbol)]);
+
+//# sourceMappingURL=migrations.repository.js.map

package/repository/migrations.repository.js.map

@@ -1 +1 @@
-{"version":3,"names":["MigrationRepositoryImpl","constructor","table","entity","createMigrationsEntity","listMigrations","params","limit","result","queryAll","partitionKey","options","index","gt","reverse","map","item","data","logMigration","migration","put","PK","id","SK","TYPE","GSI1_PK","GSI1_SK","makeInjectable","inject","PrimaryDynamoTableSymbol"],"sources":["migrations.repository.ts"],"sourcesContent":["import { Table, Entity } from \"dynamodb-toolbox\";\nimport { queryAll } from \"@webiny/db-dynamodb/utils/query\";\nimport { MigrationItem, MigrationRepository } from \"~/types\";\nimport { createMigrationsEntity } from \"~/repository/migrations.entity\";\nimport { inject, makeInjectable } from \"@webiny/ioc\";\nimport { PrimaryDynamoTableSymbol } from \"~/symbols\";\n\nexport class MigrationRepositoryImpl implements MigrationRepository {\n    private readonly entity: Entity<any>;\n\n    constructor(table: Table) {\n        this.entity = createMigrationsEntity({ table });\n    }\n\n    async listMigrations(params?: { limit: number }): Promise<MigrationItem[]> {\n        const { limit } = params || {};\n        const result = await queryAll<{ data: MigrationItem }>({\n            entity: this.entity,\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.entity.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\nmakeInjectable(MigrationRepositoryImpl, [inject(PrimaryDynamoTableSymbol)]);\n"],"mappings":";;;;;;;;AACA;AAEA;AACA;AACA;AAEO,MAAMA,uBAAuB,CAAgC;EAGhEC,WAAW,CAACC,KAAY,EAAE;IAAA;IACtB,IAAI,CAACC,MAAM,GAAG,IAAAC,kCAAsB,EAAC;MAAEF;IAAM,CAAC,CAAC;EACnD;EAEA,MAAMG,cAAc,CAACC,MAA0B,EAA4B;IACvE,MAAM;MAAEC;IAAM,CAAC,GAAGD,MAAM,IAAI,CAAC,CAAC;IAC9B,MAAME,MAAM,GAAG,MAAM,IAAAC,eAAQ,EAA0B;MACnDN,MAAM,EAAE,IAAI,CAACA,MAAM;MACnBO,YAAY,EAAE,YAAY;MAC1BC,OAAO,EAAE;QACLC,KAAK,EAAE,MAAM;QACbC,EAAE,EAAE,GAAG;QACPN,KAAK;QACL;QACAO,OAAO,EAAE;MACb;IACJ,CAAC,CAAC;IAEF,OAAON,MAAM,CAACO,GAAG,CAACC,IAAI,IAAIA,IAAI,CAACC,IAAI,CAAC;EACxC;EAEA,MAAMC,YAAY,CAACC,SAAwB,EAAiB;IACxD,MAAM,IAAI,CAAChB,MAAM,CAACiB,GAAG,CAAC;MAClBC,EAAE,EAAG,aAAYF,SAAS,CAACG,EAAG,EAAC;MAC/BC,EAAE,EAAE,GAAG;MACPC,IAAI,EAAE,WAAW;MACjBC,OAAO,EAAE,YAAY;MACrBC,OAAO,EAAEP,SAAS,CAACG,EAAE;MACrBL,IAAI,EAAEE;IACV,CAAC,CAAC;EACN;AACJ;AAAC;AAED,IAAAQ,mBAAc,EAAC3B,uBAAuB,EAAE,CAAC,IAAA4B,WAAM,EAACC,iCAAwB,CAAC,CAAC,CAAC"}
+{"version":3,"names":["_query","require","_ioc","_symbols","_createStandardEntity","_dbDynamodb","MigrationRepositoryImpl","constructor","table","run","createStandardEntity","name","migration","checkpoint","getLastRun","result","queryOne","entity","partitionKey","options","index","gt","reverse","data","saveRun","put","item","PK","id","SK","TYPE","GSI1_PK","GSI1_SK","listMigrations","params","limit","queryAll","map","logMigration","createCheckpoint","deleteCheckpoint","deleteItem","keys","getCheckpoint","record","get","exports","makeInjectable","inject","PrimaryDynamoTableSymbol"],"sources":["migrations.repository.ts"],"sourcesContent":["import type { Entity, Table } from \"@webiny/db-dynamodb/toolbox\";\nimport { queryAll, queryOne } from \"@webiny/db-dynamodb/utils/query\";\nimport type { MigrationItem, MigrationRepository, MigrationRun } from \"~/types\";\nimport { inject, makeInjectable } from \"@webiny/ioc\";\nimport { PrimaryDynamoTableSymbol } from \"~/symbols\";\nimport { createStandardEntity } from \"./createStandardEntity\";\nimport { deleteItem, get, put } from \"@webiny/db-dynamodb\";\n\ninterface MigrationCheckpoint {\n    data: unknown;\n}\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<string, string, string>) {\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 put({\n            entity: this.run,\n            item: {\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\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 put({\n            entity: this.migration,\n            item: {\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\n    async createCheckpoint(id: string, data: unknown): Promise<void> {\n        await put({\n            entity: this.checkpoint,\n            item: {\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\n    async deleteCheckpoint(id: string): Promise<void> {\n        await deleteItem({\n            entity: this.checkpoint,\n            keys: {\n                PK: `MIGRATION_CHECKPOINT#${id}`,\n                SK: \"A\"\n            }\n        });\n    }\n\n    async getCheckpoint(id: string): Promise<unknown | null> {\n        const record = await get<MigrationCheckpoint>({\n            entity: this.checkpoint,\n            keys: {\n                PK: `MIGRATION_CHECKPOINT#${id}`,\n                SK: \"A\"\n            }\n        });\n\n        if (!record) {\n            return null;\n        }\n        return record.data;\n    }\n}\n\nmakeInjectable(MigrationRepositoryImpl, [inject(PrimaryDynamoTableSymbol)]);\n"],"mappings":";;;;;;AACA,IAAAA,MAAA,GAAAC,OAAA;AAEA,IAAAC,IAAA,GAAAD,OAAA;AACA,IAAAE,QAAA,GAAAF,OAAA;AACA,IAAAG,qBAAA,GAAAH,OAAA;AACA,IAAAI,WAAA,GAAAJ,OAAA;AAMO,MAAMK,uBAAuB,CAAgC;EAKhEC,WAAWA,CAACC,KAAoC,EAAE;IAC9C,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,UAAUA,CAAA,EAAiC;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,OAAOA,CAACf,GAAiB,EAAiB;IAC5C,MAAM,IAAAgB,eAAG,EAAC;MACNR,MAAM,EAAE,IAAI,CAACR,GAAG;MAChBiB,IAAI,EAAE;QACFC,EAAE,EAAE,iBAAiBlB,GAAG,CAACmB,EAAE,EAAE;QAC7BC,EAAE,EAAE,GAAG;QACPC,IAAI,EAAE,eAAe;QACrBC,OAAO,EAAE,gBAAgB;QACzBC,OAAO,EAAEvB,GAAG,CAACmB,EAAE;QACfL,IAAI,EAAEd;MACV;IACJ,CAAC,CAAC;EACN;EAEA,MAAMwB,cAAcA,CAACC,MAA0B,EAA4B;IACvE,MAAM;MAAEC;IAAM,CAAC,GAAGD,MAAM,IAAI,CAAC,CAAC;IAC9B,MAAMnB,MAAM,GAAG,MAAM,IAAAqB,eAAQ,EAA0B;MACnDnB,MAAM,EAAE,IAAI,CAACL,SAAS;MACtBM,YAAY,EAAE,YAAY;MAC1BC,OAAO,EAAE;QACLC,KAAK,EAAE,MAAM;QACbC,EAAE,EAAE,GAAG;QACPc,KAAK;QACL;QACAb,OAAO,EAAE;MACb;IACJ,CAAC,CAAC;IAEF,OAAOP,MAAM,CAACsB,GAAG,CAACX,IAAI,IAAIA,IAAI,CAACH,IAAI,CAAC;EACxC;EAEA,MAAMe,YAAYA,CAAC1B,SAAwB,EAAiB;IACxD,MAAM,IAAAa,eAAG,EAAC;MACNR,MAAM,EAAE,IAAI,CAACL,SAAS;MACtBc,IAAI,EAAE;QACFC,EAAE,EAAE,aAAaf,SAAS,CAACgB,EAAE,EAAE;QAC/BC,EAAE,EAAE,GAAG;QACPC,IAAI,EAAE,WAAW;QACjBC,OAAO,EAAE,YAAY;QACrBC,OAAO,EAAEpB,SAAS,CAACgB,EAAE;QACrBL,IAAI,EAAEX;MACV;IACJ,CAAC,CAAC;EACN;EAEA,MAAM2B,gBAAgBA,CAACX,EAAU,EAAEL,IAAa,EAAiB;IAC7D,MAAM,IAAAE,eAAG,EAAC;MACNR,MAAM,EAAE,IAAI,CAACJ,UAAU;MACvBa,IAAI,EAAE;QACFC,EAAE,EAAE,wBAAwBC,EAAE,EAAE;QAChCC,EAAE,EAAE,GAAG;QACPC,IAAI,EAAE,sBAAsB;QAC5BC,OAAO,EAAE,uBAAuB;QAChCC,OAAO,EAAEJ,EAAE;QACXL;MACJ;IACJ,CAAC,CAAC;EACN;EAEA,MAAMiB,gBAAgBA,CAACZ,EAAU,EAAiB;IAC9C,MAAM,IAAAa,sBAAU,EAAC;MACbxB,MAAM,EAAE,IAAI,CAACJ,UAAU;MACvB6B,IAAI,EAAE;QACFf,EAAE,EAAE,wBAAwBC,EAAE,EAAE;QAChCC,EAAE,EAAE;MACR;IACJ,CAAC,CAAC;EACN;EAEA,MAAMc,aAAaA,CAACf,EAAU,EAA2B;IACrD,MAAMgB,MAAM,GAAG,MAAM,IAAAC,eAAG,EAAsB;MAC1C5B,MAAM,EAAE,IAAI,CAACJ,UAAU;MACvB6B,IAAI,EAAE;QACFf,EAAE,EAAE,wBAAwBC,EAAE,EAAE;QAChCC,EAAE,EAAE;MACR;IACJ,CAAC,CAAC;IAEF,IAAI,CAACe,MAAM,EAAE;MACT,OAAO,IAAI;IACf;IACA,OAAOA,MAAM,CAACrB,IAAI;EACtB;AACJ;AAACuB,OAAA,CAAAxC,uBAAA,GAAAA,uBAAA;AAED,IAAAyC,mBAAc,EAACzC,uBAAuB,EAAE,CAAC,IAAA0C,WAAM,EAACC,iCAAwB,CAAC,CAAC,CAAC","ignoreList":[]}

package/symbols.d.ts

@@ -4,3 +4,4 @@ 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

@@ -3,16 +3,13 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.PrimaryDynamoTableSymbol = exports.MigrationSymbol = exports.MigrationRepositorySymbol = exports.LoggerSymbol = 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;
+exports.PrimaryDynamoTableSymbol = exports.MigrationSymbol = exports.MigrationRepositorySymbol = exports.LoggerSymbol = exports.ExecutionTimeLimiterSymbol = exports.ElasticsearchDynamoTableSymbol = exports.ElasticsearchClientSymbol = void 0;
+const LoggerSymbol = exports.LoggerSymbol = Symbol.for("PinoLogger");
+const MigrationSymbol = exports.MigrationSymbol = Symbol.for("Migration");
+const MigrationRepositorySymbol = exports.MigrationRepositorySymbol = Symbol.for("MigrationRepository");
+const ElasticsearchClientSymbol = exports.ElasticsearchClientSymbol = Symbol.for("ElasticsearchClient");
+const PrimaryDynamoTableSymbol = exports.PrimaryDynamoTableSymbol = Symbol.for("PrimaryDynamoTable");
+const ElasticsearchDynamoTableSymbol = exports.ElasticsearchDynamoTableSymbol = Symbol.for("ElasticsearchDynamoTable");
+const ExecutionTimeLimiterSymbol = exports.ExecutionTimeLimiterSymbol = Symbol.for("ExecutionTimeLimiter");
+
+//# sourceMappingURL=symbols.js.map

package/symbols.js.map

@@ -1 +1 @@
-{"version":3,"names":["LoggerSymbol","Symbol","for","MigrationSymbol","MigrationRepositorySymbol","ElasticsearchClientSymbol","PrimaryDynamoTableSymbol","ElasticsearchDynamoTableSymbol"],"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\");\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"}
+{"version":3,"names":["LoggerSymbol","exports","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,GAAAC,OAAA,CAAAD,YAAA,GAAGE,MAAM,CAACC,GAAG,CAAC,YAAY,CAAC;AAC7C,MAAMC,eAAe,GAAAH,OAAA,CAAAG,eAAA,GAAGF,MAAM,CAACC,GAAG,CAAC,WAAW,CAAC;AAC/C,MAAME,yBAAyB,GAAAJ,OAAA,CAAAI,yBAAA,GAAGH,MAAM,CAACC,GAAG,CAAC,qBAAqB,CAAC;AACnE,MAAMG,yBAAyB,GAAAL,OAAA,CAAAK,yBAAA,GAAGJ,MAAM,CAACC,GAAG,CAAC,qBAAqB,CAAC;AACnE,MAAMI,wBAAwB,GAAAN,OAAA,CAAAM,wBAAA,GAAGL,MAAM,CAACC,GAAG,CAAC,oBAAoB,CAAC;AACjE,MAAMK,8BAA8B,GAAAP,OAAA,CAAAO,8BAAA,GAAGN,MAAM,CAACC,GAAG,CAAC,0BAA0B,CAAC;AAC7E,MAAMM,0BAA0B,GAAAR,OAAA,CAAAQ,0BAAA,GAAGP,MAAM,CAACC,GAAG,CAAC,sBAAsB,CAAC","ignoreList":[]}

package/types.d.ts

@@ -1,57 +1,83 @@
-import { Logger, LogEvent } from "pino";
-export { Logger };
+import type { Logger } from "@webiny/logger";
+export type { Logger };
 export interface MigrationItem {
     id: string;
     description: string;
-    createdOn: string;
-    duration: number;
     reason: string;
+    startedOn?: string;
+    finishedOn?: string;
+}
+export interface MigrationRun {
+    id: string;
+    startedOn: string;
+    finishedOn: string;
+    status: "init" | "running" | "pending" | "done" | "error";
+    migrations: MigrationRunItem[];
+    context?: Record<string, any>;
+    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 {
+export interface DataMigrationContext<TCheckpoint = any> {
     projectVersion: string;
     logger: Logger;
+    checkpoint?: TCheckpoint;
+    forceExecute: boolean;
+    runningOutOfTime: () => boolean;
+    createCheckpoint: (data: TCheckpoint) => Promise<void>;
+    createCheckpointAndExit: (data: TCheckpoint) => Promise<void>;
 }
-export interface DataMigration {
+export interface DataMigration<TCheckpoint = any> {
     getId(): string;
     getDescription(): string;
-    shouldExecute(context: DataMigrationContext): Promise<boolean>;
-    execute(context: DataMigrationContext): Promise<void>;
-}
-export interface MigrationResult {
-    success: boolean;
-    logs: LogEvent[];
-    duration: number;
-}
-export interface ExecutedMigrationResponse {
-    id: string;
-    description: string;
-    result: MigrationResult;
-}
-export interface SkippedMigrationResponse {
-    id: string;
-    description: string;
-    reason: string;
+    shouldExecute(context: DataMigrationContext<TCheckpoint>): Promise<boolean>;
+    execute(context: DataMigrationContext<TCheckpoint>): Promise<void>;
 }
+/**
+ * Migration execution time limiter (in milliseconds).
+ */
+export type ExecutionTimeLimiter = () => number;
 export interface MigrationEventPayload {
+    command: "status" | "execute";
     version?: string;
     pattern?: string;
+    force?: boolean;
 }
-export declare type MigrationEventHandlerResponse = {
+export type MigrationEventHandlerResponse = undefined | MigrationStatusResponse | MigrationInvocationErrorResponse;
+export interface MigrationInvocationErrorResponse {
     error: {
         message: string;
     };
-    data?: never;
-} | {
-    data: {
-        executed: ExecutedMigrationResponse[];
-        skipped: SkippedMigrationResponse[];
-        notApplicable: SkippedMigrationResponse[];
-    };
-    error?: never;
-};
+    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

@@ -3,10 +3,5 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-Object.defineProperty(exports, "Logger", {
-  enumerable: true,
-  get: function () {
-    return _pino.Logger;
-  }
-});
-var _pino = require("pino");
+
+//# sourceMappingURL=types.js.map

package/types.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["types.ts"],"sourcesContent":["import { Logger, LogEvent } from \"pino\";\n\nexport { Logger };\n\nexport interface MigrationItem {\n    id: string;\n    description: string;\n    createdOn: string;\n    duration: number;\n    reason: string;\n}\n\nexport interface MigrationRepository {\n    listMigrations(params?: { limit: number }): Promise<MigrationItem[]>;\n    logMigration(migration: MigrationItem): Promise<void>;\n}\n\nexport interface DataMigrationContext {\n    projectVersion: string;\n    logger: Logger;\n}\n\nexport interface DataMigration {\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): Promise<boolean>;\n    execute(context: DataMigrationContext): Promise<void>;\n}\n\nexport interface MigrationResult {\n    success: boolean;\n    logs: LogEvent[];\n    duration: number;\n}\n\nexport interface ExecutedMigrationResponse {\n    id: string;\n    description: string;\n    result: MigrationResult;\n}\n\nexport interface SkippedMigrationResponse {\n    id: string;\n    description: string;\n    reason: string;\n}\n\nexport interface MigrationEventPayload {\n    version?: string;\n    pattern?: string;\n}\n\nexport type MigrationEventHandlerResponse =\n    // We can either have a `data`, or `error`, but never both.\n    | {\n          error: {\n              message: string;\n          };\n          data?: never;\n      }\n    | {\n          data: {\n              // Executed migrations\n              executed: ExecutedMigrationResponse[];\n              // Applicable, but the migration itself decided it should not be executed.\n              skipped: SkippedMigrationResponse[];\n              // Not applicable; either out of version range, or already applied.\n              notApplicable: SkippedMigrationResponse[];\n          };\n          error?: never;\n      };\n"],"mappings":";;;;;;;;;;;AAAA"}
+{"version":3,"names":[],"sources":["types.ts"],"sourcesContent":["import type { Logger } from \"@webiny/logger\";\n\nexport type { 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    context?: Record<string, any>;\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    forceExecute: boolean;\n    runningOutOfTime: () => boolean;\n    createCheckpoint: (data: TCheckpoint) => Promise<void>;\n    createCheckpointAndExit: (data: TCheckpoint) => Promise<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    force?: boolean;\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":"","ignoreList":[]}

package/repository/migrations.entity.d.ts

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

package/repository/migrations.entity.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["createMigrationsEntity","table","Entity","name","attributes","PK","partitionKey","SK","sortKey","GSI1_PK","type","GSI1_SK","TYPE","data"],"sources":["migrations.entity.ts"],"sourcesContent":["import { Table, Entity } from \"dynamodb-toolbox\";\n\nexport const createMigrationsEntity = ({ table }: { table: Table }) => {\n    return new Entity({\n        name: \"Migrations\",\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,sBAAsB,GAAG,CAAC;EAAEC;AAAwB,CAAC,KAAK;EACnE,OAAO,IAAIC,uBAAM,CAAC;IACdC,IAAI,EAAE,YAAY;IAClBF,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"}