@forge/migrations 0.6.3 → 0.7.0-experimental-9fa730f

package/CHANGELOG.md

@@ -1,5 +1,43 @@
 # @forge/migrations
 
+## 0.7.0-experimental-9fa730f
+
+### Patch Changes
+
+- Updated dependencies [ec0f3a4]
+  - @forge/api@3.9.1-experimental-9fa730f
+
+## 0.7.0
+
+### Minor Changes
+
+- 7416a51: Allowing migrating apps to produce migration logs
+
+### Patch Changes
+
+- d8fce0e: Add limit option to getContainers and getMappings
+- Updated dependencies [6c9b381]
+  - @forge/api@3.9.1
+
+## 0.7.0-next.2
+
+### Patch Changes
+
+- d8fce0e: Add limit option to getContainers and getMappings
+
+## 0.7.0-next.1
+
+### Minor Changes
+
+- 7416a51: Allowing migrating apps to produce migration logs
+
+## 0.6.4-next.0
+
+### Patch Changes
+
+- Updated dependencies [6c9b381]
+  - @forge/api@3.9.1-next.0
+
 ## 0.6.3
 
 ### Patch Changes

package/out/migration/index.d.ts

@@ -4,6 +4,7 @@ import { DefaultQueryBuilder } from './query-api';
 export declare const getMigrationInstance: (adapter: Migration) => {
     getMappingById: (transferId: string, namespace: string, keys: Array<string>) => Promise<import("./migration-adaptor").MappingResponse>;
     messageProcessed: (transferId: string, messageId: string) => Promise<void>;
+    addLog: (transferId: string, logMessage: string) => Promise<void>;
     getAppDataList: (transferId: string) => Promise<import("./migration-adaptor").AppDataListResponse>;
     getAppDataPayload: (s3Key: string) => Promise<import("@forge/api").APIResponse>;
     getMappings: (transferId: string, namespace: string) => DefaultQueryBuilder;
@@ -12,6 +13,7 @@ export declare const getMigrationInstance: (adapter: Migration) => {
 export declare const migration: {
     getMappingById: (transferId: string, namespace: string, keys: Array<string>) => Promise<import("./migration-adaptor").MappingResponse>;
     messageProcessed: (transferId: string, messageId: string) => Promise<void>;
+    addLog: (transferId: string, logMessage: string) => Promise<void>;
     getAppDataList: (transferId: string) => Promise<import("./migration-adaptor").AppDataListResponse>;
     getAppDataPayload: (s3Key: string) => Promise<import("@forge/api").APIResponse>;
     getMappings: (transferId: string, namespace: string) => DefaultQueryBuilder;

package/out/migration/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/migration/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAElD,eAAO,MAAM,oBAAoB,YAAa,SAAS;iCAEtB,MAAM,aAAa,MAAM,QAAQ,MAAM,MAAM,CAAC;mCAE5C,MAAM,aAAa,MAAM;iCAC3B,MAAM;+BACR,MAAM;8BACP,MAAM,aAAa,MAAM;gCAEvB,MAAM,iBAAiB,aAAa;CAGnE,CAAC;AAEF,eAAO,MAAM,SAAS;iCACS,MAAM,aAAa,MAAM,QAAQ,MAAM,MAAM,CAAC;mCAE5C,MAAM,aAAa,MAAM;iCAE3B,MAAM;+BACR,MAAM;8BACP,MAAM,aAAa,MAAM;gCAEvB,MAAM,iBAAiB,aAAa;CAEjE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/migration/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAElD,eAAO,MAAM,oBAAoB,YAAa,SAAS;iCAEtB,MAAM,aAAa,MAAM,QAAQ,MAAM,MAAM,CAAC;mCAE5C,MAAM,aAAa,MAAM;yBACnC,MAAM,cAAc,MAAM;iCAClB,MAAM;+BACR,MAAM;8BACP,MAAM,aAAa,MAAM;gCAEvB,MAAM,iBAAiB,aAAa;CAGnE,CAAC;AAEF,eAAO,MAAM,SAAS;iCACS,MAAM,aAAa,MAAM,QAAQ,MAAM,MAAM,CAAC;mCAE5C,MAAM,aAAa,MAAM;yBAEnC,MAAM,cAAc,MAAM;iCAElB,MAAM;+BACR,MAAM;8BACP,MAAM,aAAa,MAAM;gCAEvB,MAAM,iBAAiB,aAAa;CAEjE,CAAC"}

package/out/migration/index.js

@@ -7,6 +7,7 @@ const getMigrationInstance = (adapter) => {
     return {
         getMappingById: (transferId, namespace, keys) => adapter.getMappingById(transferId, namespace, keys),
         messageProcessed: (transferId, messageId) => adapter.messageProcessed(transferId, messageId),
+        addLog: (transferId, logMessage) => adapter.addLog(transferId, logMessage),
         getAppDataList: (transferId) => adapter.getAppDataList(transferId),
         getAppDataPayload: (s3Key) => adapter.getAppDataPayload(s3Key),
         getMappings: (transferId, namespace) => new query_api_1.DefaultQueryBuilder(adapter, { transferId: transferId, namespace: namespace }),
@@ -17,6 +18,7 @@ exports.getMigrationInstance = getMigrationInstance;
 exports.migration = {
     getMappingById: (transferId, namespace, keys) => (0, exports.getMigrationInstance)(new migration_1.Migration()).getMappingById(transferId, namespace, keys),
     messageProcessed: (transferId, messageId) => (0, exports.getMigrationInstance)(new migration_1.Migration()).messageProcessed(transferId, messageId),
+    addLog: (transferId, logMessage) => (0, exports.getMigrationInstance)(new migration_1.Migration()).addLog(transferId, logMessage),
     getAppDataList: (transferId) => (0, exports.getMigrationInstance)(new migration_1.Migration()).getAppDataList(transferId),
     getAppDataPayload: (s3Key) => (0, exports.getMigrationInstance)(new migration_1.Migration()).getAppDataPayload(s3Key),
     getMappings: (transferId, namespace) => (0, exports.getMigrationInstance)(new migration_1.Migration()).getMappings(transferId, namespace),

package/out/migration/migration-adaptor.d.ts

@@ -4,6 +4,7 @@ export interface MigrationAdapter {
     getAppDataList(transferId: string): Promise<AppDataListResponse>;
     getAppDataPayload(s3Key: string): Promise<APIResponse>;
     messageProcessed(transferId: string, messageId: string): Promise<void>;
+    addLog(transferId: string, logMessage: string): Promise<void>;
 }
 export interface MappingResponse {
     result: Map<string, string>;
@@ -37,6 +38,7 @@ export interface ListOptions {
     namespace?: string;
     containerType?: ContainerType;
     cursor?: string;
+    limit?: number;
 }
 export interface Result {
     key: string;
@@ -48,6 +50,7 @@ export interface ListResults {
 }
 export interface QueryBuilder {
     cursor(cursor: string): QueryBuilder;
+    limit(limit: number): QueryBuilder;
     getMany(): Promise<ListResults>;
     getOne(): Promise<Result | undefined>;
 }

package/out/migration/migration-adaptor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"migration-adaptor.d.ts","sourceRoot":"","sources":["../../src/migration/migration-adaptor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,MAAM,WAAW,gBAAgB;IAC/B,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IACrG,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACjE,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IACvD,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACxE;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,OAAO;IACtB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;CACtB;AAED,MAAM,WAAW,sBAAsB;IACrC,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,sBAAsB,CAAC;IAC7B,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC5B;AAED,UAAU,sBAAsB;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,2BAA2B;IAC1C,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC1B,IAAI,EAAE,sBAAsB,CAAC;CAC9B;AAED,oBAAY,aAAa,GAAG,iBAAiB,GAAG,aAAa,GAAG,MAAM,CAAC;AAEvE,MAAM,WAAW,WAAW;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,MAAM;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,CAAC;IACrC,OAAO,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC;IAChC,MAAM,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CACvC"}
+{"version":3,"file":"migration-adaptor.d.ts","sourceRoot":"","sources":["../../src/migration/migration-adaptor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,MAAM,WAAW,gBAAgB;IAC/B,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IACrG,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACjE,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IACvD,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACvE,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/D;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,OAAO;IACtB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;CACtB;AAED,MAAM,WAAW,sBAAsB;IACrC,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,sBAAsB,CAAC;IAC7B,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC5B;AAED,UAAU,sBAAsB;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,2BAA2B;IAC1C,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC1B,IAAI,EAAE,sBAAsB,CAAC;CAC9B;AAED,oBAAY,aAAa,GAAG,iBAAiB,GAAG,aAAa,GAAG,MAAM,CAAC;AAEvE,MAAM,WAAW,WAAW;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,MAAM;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,CAAC;IACrC,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,CAAC;IACnC,OAAO,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC;IAChC,MAAM,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CACvC"}

package/out/migration/migration.d.ts

@@ -6,6 +6,7 @@ export declare class Migration implements MigrationAdapter {
     getAppDataList: (transferId: string) => Promise<AppDataListResponse>;
     getAppDataPayload: (key: string) => Promise<APIResponse>;
     messageProcessed: (transferId: string, messageId: string) => Promise<void>;
+    addLog: (transferId: string, logMessage: string) => Promise<void>;
     getMappings: (transferId: string, namespace?: string, lastEntity?: string, pageSize?: number) => Promise<ListResults>;
     getContainers: (transferId: string, containerType?: string, lastEntity?: string, pageSize?: number) => Promise<ListResults>;
     list: (options: ListOptions, pageSize?: number) => Promise<ListResults>;

package/out/migration/migration.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"migration.d.ts","sourceRoot":"","sources":["../../src/migration/migration.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,eAAe,EACf,gBAAgB,EAChB,WAAW,EACX,WAAW,EAIZ,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAIzC,qBAAa,SAAU,YAAW,gBAAgB;IAChD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA6B;IAEtD,cAAc,eAAsB,MAAM,aAAa,MAAM,QAAQ,MAAM,MAAM,CAAC,KAAG,QAAQ,eAAe,CAAC,CAG3G;IAEF,cAAc,eAAsB,MAAM,KAAG,QAAQ,mBAAmB,CAAC,CAGvE;IAEF,iBAAiB,QAAe,MAAM,KAAG,QAAQ,WAAW,CAAC,CAE3D;IAEF,gBAAgB,eAAsB,MAAM,aAAa,MAAM,KAAG,QAAQ,IAAI,CAAC,CAO7E;IAEF,WAAW,eACG,MAAM,cACN,MAAM,eACL,MAAM,aACR,MAAM,KAChB,QAAQ,WAAW,CAAC,CAuBrB;IAEF,aAAa,eACC,MAAM,kBACF,MAAM,eACT,MAAM,aACR,MAAM,KAChB,QAAQ,WAAW,CAAC,CAsBrB;IAEF,IAAI,YAAmB,WAAW,aAAa,MAAM,KAAG,QAAQ,WAAW,CAAC,CAI1E;CACH"}
+{"version":3,"file":"migration.d.ts","sourceRoot":"","sources":["../../src/migration/migration.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,eAAe,EACf,gBAAgB,EAChB,WAAW,EACX,WAAW,EAIZ,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAIzC,qBAAa,SAAU,YAAW,gBAAgB;IAChD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA6B;IAEtD,cAAc,eAAsB,MAAM,aAAa,MAAM,QAAQ,MAAM,MAAM,CAAC,KAAG,QAAQ,eAAe,CAAC,CAG3G;IAEF,cAAc,eAAsB,MAAM,KAAG,QAAQ,mBAAmB,CAAC,CAGvE;IAEF,iBAAiB,QAAe,MAAM,KAAG,QAAQ,WAAW,CAAC,CAE3D;IAEF,gBAAgB,eAAsB,MAAM,aAAa,MAAM,KAAG,QAAQ,IAAI,CAAC,CAO7E;IAEF,MAAM,eAAsB,MAAM,cAAc,MAAM,KAAG,QAAQ,IAAI,CAAC,CAMpE;IAEF,WAAW,eACG,MAAM,cACN,MAAM,eACL,MAAM,aACR,MAAM,KAChB,QAAQ,WAAW,CAAC,CAuBrB;IAEF,aAAa,eACC,MAAM,kBACF,MAAM,eACT,MAAM,aACR,MAAM,KAChB,QAAQ,WAAW,CAAC,CAsBrB;IAEF,IAAI,YAAmB,WAAW,aAAa,MAAM,KAAG,QAAQ,WAAW,CAAC,CAI1E;CACH"}

package/out/migration/migration.js

@@ -23,6 +23,13 @@ class Migration {
         const result = await (0, utils_1.invokePOSTApi)(`${this.basePath}/message/${transferId}/status`, request);
         return (0, utils_1.getResponseBody)(result);
     };
+    addLog = async (transferId, logMessage) => {
+        const request = {
+            message: logMessage
+        };
+        const result = await (0, utils_1.invokePOSTApi)(`${this.basePath}/log/${transferId}`, request);
+        return (0, utils_1.getResponseBody)(result);
+    };
     getMappings = async (transferId, namespace, lastEntity, pageSize) => {
         let queryParams = `namespace=${namespace}`;
         if (pageSize != undefined) {

package/out/migration/query-api.d.ts

@@ -5,6 +5,7 @@ export declare class DefaultQueryBuilder implements QueryBuilder {
     private queryOptions;
     constructor(migration: Pick<Migration, 'list'>, queryOptions: ListOptions);
     cursor(cursor: string): QueryBuilder;
+    limit(limit: number): QueryBuilder;
     getOne(): Promise<Result | undefined>;
     getMany(): Promise<ListResults>;
 }

package/out/migration/query-api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"query-api.d.ts","sourceRoot":"","sources":["../../src/migration/query-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACrF,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,qBAAa,mBAAoB,YAAW,YAAY;IAEpD,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,YAAY;gBADZ,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,EAClC,YAAY,EAAE,WAAW;IAGnC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY;IAO9B,MAAM,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAOrC,OAAO,IAAI,OAAO,CAAC,WAAW,CAAC;CAGtC"}
+{"version":3,"file":"query-api.d.ts","sourceRoot":"","sources":["../../src/migration/query-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACrF,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,qBAAa,mBAAoB,YAAW,YAAY;IAEpD,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,YAAY;gBADZ,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,EAClC,YAAY,EAAE,WAAW;IAGnC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY;IAOpC,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY;IAO5B,MAAM,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAOrC,OAAO,IAAI,OAAO,CAAC,WAAW,CAAC;CAGtC"}

package/out/migration/query-api.js

@@ -14,6 +14,12 @@ class DefaultQueryBuilder {
             cursor
         });
     }
+    limit(limit) {
+        return new DefaultQueryBuilder(this.migration, {
+            ...this.queryOptions,
+            limit
+        });
+    }
     async getOne() {
         const listResults = await this.migration.list(this.queryOptions, 1);
         if (listResults.results && listResults.results.length > 0) {
@@ -21,7 +27,7 @@ class DefaultQueryBuilder {
         }
     }
     async getMany() {
-        return this.migration.list(this.queryOptions);
+        return this.migration.list(this.queryOptions, this.queryOptions.limit);
     }
 }
 exports.DefaultQueryBuilder = DefaultQueryBuilder;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/migrations",
-  "version": "0.6.3",
+  "version": "0.7.0-experimental-9fa730f",
   "description": "App migration methods for Forge app",
   "main": "out/index.js",
   "scripts": {
@@ -18,6 +18,6 @@
     "node-fetch": "2.7.0"
   },
   "dependencies": {
-    "@forge/api": "3.9.0"
+    "@forge/api": "3.9.1-experimental-9fa730f"
   }
 }