@forge/migrations 0.0.0 → 0.1.1-next.0

package/CHANGELOG.md

@@ -0,0 +1,20 @@
+# @forge/migrations
+
+## 0.1.1-next.0
+
+### Patch Changes
+
+- Updated dependencies [b3ee2973]
+  - @forge/api@2.7.0-next.0
+
+## 0.1.0
+
+### Minor Changes
+
+- 824eea3: Adding 2 paginated endpoints in query format to fetch mappings and container details from app migration platform
+
+## 0.1.0-next.0
+
+### Minor Changes
+
+- 824eea3: Adding 2 paginated endpoints in query format to fetch mappings and container details from app migration platform

package/out/__test__/errors.test.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const migration_1 = require("../migration");
+const errors_1 = require("../migration/errors");
 describe('APIError', () => {
     describe('forStatus', () => {
         it.each([
@@ -10,7 +10,7 @@ describe('APIError', () => {
             [404, 'Not Found'],
             [500, 'Internal server error']
         ])('should contain the correct error message for a code of %s', (status, message) => {
-            expect(migration_1.APIError.forStatus(status, message).message).toEqual(message);
+            expect(errors_1.APIError.forStatus(status, message).message).toEqual(message);
         });
     });
 });

package/out/__test__/migration.test.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+const errors_1 = require("../migration/errors");
 const migration_1 = require("../migration");
 const jest_when_1 = require("jest-when");
 const node_fetch_1 = tslib_1.__importDefault(require("node-fetch"));
@@ -63,7 +64,7 @@ describe('migration', () => {
         });
         it('should return 403 when sendProgress method called with invalid transferId', async () => {
             const returnedValue = migration_1.migration.sendProgress(invalidTransferId, progress);
-            await expect(returnedValue).rejects.toThrow(migration_1.APIError.forStatus(403, 'Forbidden'));
+            await expect(returnedValue).rejects.toThrow(errors_1.APIError.forStatus(403, 'Forbidden'));
         });
     });
     describe('getMappingById', () => {
@@ -117,7 +118,7 @@ describe('migration', () => {
         });
         it('should return 403 when getMappingById method called with invalid transferId', async () => {
             const returnedValue = migration_1.migration.getMappingById(invalidTransferId, namespace, keys);
-            await expect(returnedValue).rejects.toThrow(migration_1.APIError.forStatus(403, 'Forbidden'));
+            await expect(returnedValue).rejects.toThrow(errors_1.APIError.forStatus(403, 'Forbidden'));
         });
         it('should return MappingResponse except for invalid keys when getMappingById method called with valid transferId', async () => {
             const returnedValue = await migration_1.migration.getMappingById(transferId, namespace, invalidKeys);
@@ -147,7 +148,7 @@ describe('migration', () => {
         });
         it('should return 403 when getAppDataList method called with invalid transferId', async () => {
             const returnedValue = migration_1.migration.getAppDataList(invalidTransferId);
-            await expect(returnedValue).rejects.toThrow(migration_1.APIError.forStatus(403, 'Forbidden'));
+            await expect(returnedValue).rejects.toThrow(errors_1.APIError.forStatus(403, 'Forbidden'));
         });
     });
     describe('getAppDataPayload', () => {
@@ -177,7 +178,7 @@ describe('migration', () => {
         });
         it('should return 403 when getAppDataPayload method called with invalid S3Key', async () => {
             const returnedValue = migration_1.migration.getAppDataPayload(invalidS3Key);
-            await expect(returnedValue).rejects.toThrow(migration_1.APIError.forStatus(403, 'Forbidden'));
+            await expect(returnedValue).rejects.toThrow(errors_1.APIError.forStatus(403, 'Forbidden'));
         });
     });
     describe('updateFeedback', () => {
@@ -214,7 +215,7 @@ describe('migration', () => {
         });
         it('should return 403 when updateFeedback method called with invalid transferId', async () => {
             const returnedValue = migration_1.migration.updateFeedback(invalidTransferId, feedbackPayload);
-            await expect(returnedValue).rejects.toThrow(migration_1.APIError.forStatus(403, 'Forbidden'));
+            await expect(returnedValue).rejects.toThrow(errors_1.APIError.forStatus(403, 'Forbidden'));
         });
     });
 });

package/out/__test__/query-api.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=query-api.test.d.ts.map

package/out/__test__/query-api.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"query-api.test.d.ts","sourceRoot":"","sources":["../../src/__test__/query-api.test.ts"],"names":[],"mappings":""}

package/out/__test__/query-api.test.js

@@ -0,0 +1,144 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const jest_when_1 = require("jest-when");
+const migration_1 = require("../migration");
+describe('QueryApi', () => {
+    const transferId = '521ee36a-b673-3dc6-b60b-12460332c200';
+    global.api = {
+        asApp: jest.fn().mockReturnValue({
+            __requestAtlassian: jest.fn()
+        })
+    };
+    describe('getMappings', () => {
+        let expectedMappingsResultMany;
+        let expectedMappingsResultManyWithCursor;
+        let expectedMappingsResultSingle;
+        let lastEntityId;
+        beforeAll(() => {
+            lastEntityId = 'base64:ZW1haWwvYWRtaW5AZXhhbXBsZS5jb20vNg';
+            const mappingsResponse = `{"meta":{"pageSize":5000,"hasNext":false,"lastEntity":"${lastEntityId}"},"items":{"email/admin@example.com":"5a29c4ae20cfc31b0dc0eafe","confluence.userkey/2c9682714db22c7c014db22f51970002":"5a29c4ae20cfc31b0dc0eafe"}}`;
+            const mappingsResponseWithoutLastEntity = '{"meta":{"pageSize":5000,"hasNext":false,"lastEntity":null},"items":{"email/admin@example.com":"5a29c4ae20cfc31b0dc0eafe","confluence.userkey/2c9682714db22c7c014db22f51970002":"5a29c4ae20cfc31b0dc0eafe"}}';
+            const valueObject = '5a29c4ae20cfc31b0dc0eafe';
+            jest_when_1.when(global.api.asApp().__requestAtlassian)
+                .calledWith(`/app/migration/forge/v1/mapping/${transferId}/page?namespace=identity:user&lastEntity=${lastEntityId}`)
+                .mockReturnValue({
+                status: 200,
+                text: jest.fn().mockResolvedValue(mappingsResponseWithoutLastEntity),
+                json: jest.fn().mockResolvedValue(JSON.parse(mappingsResponseWithoutLastEntity))
+            })
+                .calledWith(`/app/migration/forge/v1/mapping/${transferId}/page?namespace=identity:user`)
+                .mockReturnValue({
+                status: 200,
+                text: jest.fn().mockResolvedValue(mappingsResponse),
+                json: jest.fn().mockResolvedValue(JSON.parse(mappingsResponse))
+            })
+                .calledWith(`/app/migration/forge/v1/mapping/${transferId}/page?namespace=identity:user&pageSize=1`)
+                .mockReturnValue({
+                status: 200,
+                text: jest.fn().mockResolvedValue(mappingsResponse),
+                json: jest.fn().mockResolvedValue(JSON.parse(mappingsResponse))
+            })
+                .calledWith(`/app/migration/forge/v1/mapping/${transferId}/page?namespace=identity:user&pageSize=1&lastEntity=${lastEntityId}`)
+                .mockReturnValue({
+                status: 200,
+                text: jest.fn().mockResolvedValue(mappingsResponse),
+                json: jest.fn().mockResolvedValue(JSON.parse(mappingsResponse))
+            });
+            expectedMappingsResultMany = {
+                results: [
+                    {
+                        key: 'email/admin@example.com',
+                        value: valueObject
+                    },
+                    { key: 'confluence.userkey/2c9682714db22c7c014db22f51970002', value: valueObject }
+                ],
+                nextCursor: undefined
+            };
+            expectedMappingsResultManyWithCursor = {
+                results: [
+                    { key: 'email/admin@example.com', value: valueObject },
+                    { key: 'confluence.userkey/2c9682714db22c7c014db22f51970002', value: valueObject }
+                ],
+                nextCursor: lastEntityId
+            };
+            expectedMappingsResultSingle = { key: 'email/admin@example.com', value: valueObject };
+        });
+        it('should fetch multiple values for getMappings', async () => {
+            const results = await migration_1.migration.getMappings(transferId, 'identity:user').getMany();
+            expect(results).toEqual(expectedMappingsResultManyWithCursor);
+        });
+        it('should allow specifying a cursor for getMappings with getMany', async () => {
+            const result = await migration_1.migration.getMappings(transferId, 'identity:user').cursor(lastEntityId).getMany();
+            expect(result).toEqual(expectedMappingsResultMany);
+        });
+        it('get single mapping when getMappings called with getOne', async () => {
+            const result = await migration_1.migration.getMappings(transferId, 'identity:user').getOne();
+            expect(result).toEqual(expectedMappingsResultSingle);
+        });
+        it('should allow specifying a cursor for getMappings with getOne', async () => {
+            const result = await migration_1.migration.getMappings(transferId, 'identity:user').cursor(lastEntityId).getOne();
+            expect(result).toEqual(expectedMappingsResultSingle);
+        });
+    });
+    describe('getContainers', () => {
+        let expectedResultContainersManyWithCursor;
+        let expectedResultContainersManyWithoutCursor;
+        let expectedResultContainersSingle;
+        let lastEntityId;
+        beforeAll(() => {
+            lastEntityId = 'db11c8af-c82b-3569-9a11-f288c9cc9535';
+            const containersResponse = `{"meta":{"pageSize":0,"hasNext":false,"lastEntity":"${lastEntityId}"},"containers":[{ "key": "TES", "sourceId": "884737", "type": "ConfluenceSpace" }]}`;
+            const containersResponseWithoutLastEntity = '{"meta":{"pageSize":0,"hasNext":false,"lastEntity":null},"containers":[{ "key": "TES", "sourceId": "884737", "type": "ConfluenceSpace" }]}';
+            expectedResultContainersManyWithCursor = {
+                results: [{ key: '0', value: { key: 'TES', sourceId: '884737', type: 'ConfluenceSpace' } }],
+                nextCursor: lastEntityId
+            };
+            expectedResultContainersManyWithoutCursor = {
+                results: [{ key: '0', value: { key: 'TES', sourceId: '884737', type: 'ConfluenceSpace' } }],
+                nextCursor: undefined
+            };
+            expectedResultContainersSingle = { key: '0', value: { key: 'TES', sourceId: '884737', type: 'ConfluenceSpace' } };
+            jest_when_1.when(global.api.asApp().__requestAtlassian)
+                .calledWith(`/app/migration/forge/v1/container/${transferId}/page?containerType=ConfluenceSpace&lastEntity=${lastEntityId}`)
+                .mockReturnValue({
+                status: 200,
+                text: jest.fn().mockResolvedValue(containersResponseWithoutLastEntity),
+                json: jest.fn().mockResolvedValue(JSON.parse(containersResponseWithoutLastEntity))
+            })
+                .calledWith(`/app/migration/forge/v1/container/${transferId}/page?containerType=ConfluenceSpace`)
+                .mockReturnValue({
+                status: 200,
+                text: jest.fn().mockResolvedValue(containersResponse),
+                json: jest.fn().mockResolvedValue(JSON.parse(containersResponse))
+            })
+                .calledWith(`/app/migration/forge/v1/container/${transferId}/page?containerType=ConfluenceSpace&pageSize=1`)
+                .mockReturnValue({
+                status: 200,
+                text: jest.fn().mockResolvedValue(containersResponse),
+                json: jest.fn().mockResolvedValue(JSON.parse(containersResponse))
+            })
+                .calledWith(`/app/migration/forge/v1/container/${transferId}/page?containerType=ConfluenceSpace&pageSize=1&lastEntity=${lastEntityId}`)
+                .mockReturnValue({
+                status: 200,
+                text: jest.fn().mockResolvedValue(containersResponse),
+                json: jest.fn().mockResolvedValue(JSON.parse(containersResponse))
+            });
+        });
+        it('should allow specifying a cursor for getContainers with getMany', async () => {
+            const result = await migration_1.migration.getContainers(transferId, 'ConfluenceSpace').cursor(lastEntityId).getMany();
+            expect(result).toEqual(expectedResultContainersManyWithoutCursor);
+        });
+        it('should fetch multiple values when getContainers is called with getMany', async () => {
+            const result = await migration_1.migration.getContainers(transferId, 'ConfluenceSpace').getMany();
+            expect(result).toEqual(expectedResultContainersManyWithCursor);
+        });
+        it('should allow specifying a cursor for getContainers with getOne', async () => {
+            const result = await migration_1.migration.getContainers(transferId, 'ConfluenceSpace').cursor(lastEntityId).getOne();
+            expect(result).toEqual(expectedResultContainersSingle);
+        });
+        it('get single mapping when getContainers called with getOne', async () => {
+            const result = await migration_1.migration.getContainers(transferId, 'ConfluenceSpace').getOne();
+            expect(result).toEqual(expectedResultContainersSingle);
+        });
+    });
+});

package/out/migration/index.d.ts

@@ -1,11 +1,14 @@
-import { MigrationAdapter, Progress } from './migration-adaptor';
-export { APIError } from './errors';
-export declare const getMigrationInstance: (adapter: MigrationAdapter) => {
+import { Migration } from './migration';
+import { Progress } from './migration-adaptor';
+import { DefaultQueryBuilder } from './query-api';
+export declare const getMigrationInstance: (adapter: Migration) => {
     sendProgress: (transferId: string, progress: Progress) => Promise<void>;
     getMappingById: (transferId: string, namespace: string, keys: Array<string>) => Promise<import("./migration-adaptor").MappingResponse>;
     updateFeedback: (transferId: string, feedback: object) => Promise<void>;
     getAppDataList: (transferId: string) => Promise<import("./migration-adaptor").AppDataListResponse>;
     getAppDataPayload: (s3Key: string) => Promise<import("node-fetch").Response>;
+    getMappings: (transferId: string, namespace: string) => DefaultQueryBuilder;
+    getContainers: (transferId: string, containerType: string) => DefaultQueryBuilder;
 };
 export declare const migration: {
     sendProgress: (transferId: string, progress: Progress) => Promise<void>;
@@ -13,5 +16,7 @@ export declare const migration: {
     updateFeedback: (transferId: string, feedback: object) => Promise<void>;
     getAppDataList: (transferId: string) => Promise<import("./migration-adaptor").AppDataListResponse>;
     getAppDataPayload: (s3Key: string) => Promise<import("node-fetch").Response>;
+    getMappings: (transferId: string, namespace: string) => DefaultQueryBuilder;
+    getContainers: (transferId: string, containerType: string) => DefaultQueryBuilder;
 };
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/migration/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAEpC,eAAO,MAAM,oBAAoB,YAAa,gBAAgB;+BAE/B,MAAM,YAAY,QAAQ;iCACxB,MAAM,aAAa,MAAM,QAAQ,KAAK,CAAC,MAAM,CAAC;iCAE9C,MAAM,YAAY,MAAM;iCACxB,MAAM;+BACR,MAAM;CAEpC,CAAC;AAEF,eAAO,MAAM,SAAS;+BACO,MAAM,YAAY,QAAQ;iCAExB,MAAM,aAAa,MAAM,QAAQ,KAAK,CAAC,MAAM,CAAC;iCAE9C,MAAM,YAAY,MAAM;iCAExB,MAAM;+BACR,MAAM;CAClC,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,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAElD,eAAO,MAAM,oBAAoB,YAAa,SAAS;+BAExB,MAAM,YAAY,QAAQ;iCACxB,MAAM,aAAa,MAAM,QAAQ,KAAK,CAAC,MAAM,CAAC;iCAE9C,MAAM,YAAY,MAAM;iCACxB,MAAM;+BACR,MAAM;8BACP,MAAM,aAAa,MAAM;gCAEvB,MAAM,iBAAiB,MAAM;CAG5D,CAAC;AAEF,eAAO,MAAM,SAAS;+BACO,MAAM,YAAY,QAAQ;iCAExB,MAAM,aAAa,MAAM,QAAQ,KAAK,CAAC,MAAM,CAAC;iCAE9C,MAAM,YAAY,MAAM;iCAExB,MAAM;+BACR,MAAM;8BACP,MAAM,aAAa,MAAM;gCAEvB,MAAM,iBAAiB,MAAM;CAE1D,CAAC"}

package/out/migration/index.js

@@ -2,15 +2,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.migration = exports.getMigrationInstance = void 0;
 const migration_1 = require("./migration");
-var errors_1 = require("./errors");
-Object.defineProperty(exports, "APIError", { enumerable: true, get: function () { return errors_1.APIError; } });
+const query_api_1 = require("./query-api");
 exports.getMigrationInstance = (adapter) => {
     return {
         sendProgress: (transferId, progress) => adapter.sendProgress(transferId, progress),
         getMappingById: (transferId, namespace, keys) => adapter.getMappingById(transferId, namespace, keys),
         updateFeedback: (transferId, feedback) => adapter.updateFeedback(transferId, feedback),
         getAppDataList: (transferId) => adapter.getAppDataList(transferId),
-        getAppDataPayload: (s3Key) => adapter.getAppDataPayload(s3Key)
+        getAppDataPayload: (s3Key) => adapter.getAppDataPayload(s3Key),
+        getMappings: (transferId, namespace) => new query_api_1.DefaultQueryBuilder(adapter, { transferId: transferId, namespace: namespace }),
+        getContainers: (transferId, containerType) => new query_api_1.DefaultQueryBuilder(adapter, { transferId: transferId, containerType: containerType })
     };
 };
 exports.migration = {
@@ -18,5 +19,7 @@ exports.migration = {
     getMappingById: (transferId, namespace, keys) => exports.getMigrationInstance(new migration_1.Migration()).getMappingById(transferId, namespace, keys),
     updateFeedback: (transferId, feedback) => exports.getMigrationInstance(new migration_1.Migration()).updateFeedback(transferId, feedback),
     getAppDataList: (transferId) => exports.getMigrationInstance(new migration_1.Migration()).getAppDataList(transferId),
-    getAppDataPayload: (s3Key) => exports.getMigrationInstance(new migration_1.Migration()).getAppDataPayload(s3Key)
+    getAppDataPayload: (s3Key) => exports.getMigrationInstance(new migration_1.Migration()).getAppDataPayload(s3Key),
+    getMappings: (transferId, namespace) => exports.getMigrationInstance(new migration_1.Migration()).getMappings(transferId, namespace),
+    getContainers: (transferId, containerType) => exports.getMigrationInstance(new migration_1.Migration()).getContainers(transferId, containerType)
 };

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

@@ -24,4 +24,37 @@ export interface Progress {
     percent: number;
     message: string;
 }
+export interface PaginationMappingResponse {
+    meta: PaginationResponseMeta;
+    items: Map<string, string>;
+}
+interface PaginationResponseMeta {
+    pageSize: number;
+    hasNext: boolean;
+    lastEntity?: string;
+}
+export interface PaginationContainerResponse {
+    containers: Array<object>;
+    meta: PaginationResponseMeta;
+}
+export interface ListOptions {
+    transferId: string;
+    namespace?: string;
+    containerType?: string;
+    cursor?: string;
+}
+export interface Result {
+    key: string;
+    value: object;
+}
+export interface ListResults {
+    results: Result[];
+    nextCursor?: string;
+}
+export interface QueryBuilder {
+    cursor(cursor: string): QueryBuilder;
+    getMany(): Promise<ListResults>;
+    getOne(): Promise<Result | undefined>;
+}
+export {};
 //# sourceMappingURL=migration-adaptor.d.ts.map

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,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,MAAM,WAAW,gBAAgB;IAC/B,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpE,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,QAAQ,CAAC,CAAC;IACpD,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACrE;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,OAAO;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,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,QAAQ;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB"}
+{"version":3,"file":"migration-adaptor.d.ts","sourceRoot":"","sources":["../../src/migration/migration-adaptor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,MAAM,WAAW,gBAAgB;IAC/B,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpE,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,QAAQ,CAAC,CAAC;IACpD,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACrE;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,OAAO;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,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,QAAQ;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB;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,MAAM,WAAW,WAAW;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,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"}

package/out/migration/migration.d.ts

@@ -1,5 +1,5 @@
 import { Response } from 'node-fetch';
-import { AppDataListResponse, MappingResponse, MigrationAdapter, Progress } from './migration-adaptor';
+import { AppDataListResponse, MappingResponse, MigrationAdapter, Progress, ListOptions, ListResults } from './migration-adaptor';
 export declare class Migration implements MigrationAdapter {
     private readonly basePath;
     sendProgress: (transferId: string, progress: Progress) => Promise<void>;
@@ -7,5 +7,8 @@ export declare class Migration implements MigrationAdapter {
     getAppDataList: (transferId: string) => Promise<AppDataListResponse>;
     getAppDataPayload: (s3Key: string) => Promise<Response>;
     updateFeedback: (transferId: string, feedback: object) => Promise<void>;
+    getMappings: (transferId: string, namespace?: string | undefined, lastEntity?: string | undefined, pageSize?: number | undefined) => Promise<ListResults>;
+    getContainers: (transferId: string, containerType?: string | undefined, lastEntity?: string | undefined, pageSize?: number | undefined) => Promise<ListResults>;
+    list: (options: ListOptions, pageSize?: number | undefined) => Promise<ListResults>;
 }
 //# sourceMappingURL=migration.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"migration.d.ts","sourceRoot":"","sources":["../../src/migration/migration.ts"],"names":[],"mappings":"AAAA,OAAc,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE7C,OAAO,EACL,mBAAmB,EAEnB,eAAe,EACf,gBAAgB,EAChB,QAAQ,EACT,MAAM,qBAAqB,CAAC;AAI7B,qBAAa,SAAU,YAAW,gBAAgB;IAChD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA6B;IAEtD,YAAY,eAAsB,MAAM,YAAY,QAAQ,KAAG,OAAO,CAAC,IAAI,CAAC,CAG1E;IAEF,cAAc,eAAsB,MAAM,aAAa,MAAM,QAAQ,KAAK,CAAC,MAAM,CAAC,KAAG,OAAO,CAAC,eAAe,CAAC,CAG3G;IAEF,cAAc,eAAsB,MAAM,KAAG,OAAO,CAAC,mBAAmB,CAAC,CAGvE;IAEF,iBAAiB,UAAiB,MAAM,KAAG,OAAO,CAAC,QAAQ,CAAC,CAI1D;IAEF,cAAc,eAAsB,MAAM,YAAY,MAAM,KAAG,OAAO,CAAC,IAAI,CAAC,CAG1E;CACH"}
+{"version":3,"file":"migration.d.ts","sourceRoot":"","sources":["../../src/migration/migration.ts"],"names":[],"mappings":"AAAA,OAAc,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE7C,OAAO,EACL,mBAAmB,EAEnB,eAAe,EACf,gBAAgB,EAChB,QAAQ,EACR,WAAW,EACX,WAAW,EAIZ,MAAM,qBAAqB,CAAC;AAI7B,qBAAa,SAAU,YAAW,gBAAgB;IAChD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA6B;IAEtD,YAAY,eAAsB,MAAM,YAAY,QAAQ,KAAG,OAAO,CAAC,IAAI,CAAC,CAG1E;IAEF,cAAc,eAAsB,MAAM,aAAa,MAAM,QAAQ,KAAK,CAAC,MAAM,CAAC,KAAG,OAAO,CAAC,eAAe,CAAC,CAG3G;IAEF,cAAc,eAAsB,MAAM,KAAG,OAAO,CAAC,mBAAmB,CAAC,CAGvE;IAEF,iBAAiB,UAAiB,MAAM,KAAG,OAAO,CAAC,QAAQ,CAAC,CAI1D;IAEF,cAAc,eAAsB,MAAM,YAAY,MAAM,KAAG,OAAO,CAAC,IAAI,CAAC,CAG1E;IAEF,WAAW,eACG,MAAM,qGAIjB,OAAO,CAAC,WAAW,CAAC,CAuBrB;IAEF,aAAa,eACC,MAAM,yGAIjB,OAAO,CAAC,WAAW,CAAC,CAsBrB;IAEF,IAAI,YAAmB,WAAW,oCAAsB,OAAO,CAAC,WAAW,CAAC,CAI1E;CACH"}

package/out/migration/migration.js

@@ -28,6 +28,54 @@ class Migration {
             const result = await utils_1.invokePOSTApi(`${this.basePath}/feedback/${transferId}`, feedback);
             return utils_1.getResponseBody(result);
         };
+        this.getMappings = async (transferId, namespace, lastEntity, pageSize) => {
+            let queryParams = `namespace=${namespace}`;
+            if (pageSize != undefined) {
+                queryParams = queryParams + `&pageSize=${pageSize}`;
+            }
+            if (lastEntity != undefined) {
+                queryParams = queryParams + `&lastEntity=${lastEntity}`;
+            }
+            const result = await utils_1.invokeGETApi(`${this.basePath}/mapping/${transferId}/page?${queryParams}`);
+            const mappingResponse = await utils_1.getResponseBody(result);
+            let results = [];
+            if (mappingResponse.items != null) {
+                results = Object.entries(mappingResponse.items).map((item) => {
+                    return { key: item[0], value: item[1] };
+                });
+            }
+            return {
+                results: results,
+                nextCursor: mappingResponse.meta.lastEntity != null ? mappingResponse.meta.lastEntity : undefined
+            };
+        };
+        this.getContainers = async (transferId, containerType, lastEntity, pageSize) => {
+            let queryParams = `containerType=${containerType}`;
+            if (pageSize != undefined) {
+                queryParams = queryParams + `&pageSize=${pageSize}`;
+            }
+            if (lastEntity != undefined) {
+                queryParams = queryParams + `&lastEntity=${lastEntity}`;
+            }
+            const result = await utils_1.invokeGETApi(`${this.basePath}/container/${transferId}/page?${queryParams}`);
+            const containerResponse = await utils_1.getResponseBody(result);
+            let results = [];
+            if (containerResponse.containers != null) {
+                results = Object.entries(containerResponse.containers).map((item) => {
+                    return { key: item[0], value: item[1] };
+                });
+            }
+            return {
+                results: results,
+                nextCursor: containerResponse.meta.lastEntity != null ? containerResponse.meta.lastEntity : undefined
+            };
+        };
+        this.list = async (options, pageSize) => {
+            if (options.namespace != undefined)
+                return this.getMappings(options.transferId, options.namespace, options.cursor, pageSize);
+            else
+                return this.getContainers(options.transferId, options.containerType, options.cursor, pageSize);
+        };
     }
 }
 exports.Migration = Migration;

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

@@ -0,0 +1,11 @@
+import { QueryBuilder, Result, ListOptions, ListResults } from './migration-adaptor';
+import { Migration } from './migration';
+export declare class DefaultQueryBuilder implements QueryBuilder {
+    private migration;
+    private queryOptions;
+    constructor(migration: Pick<Migration, 'list'>, queryOptions: ListOptions);
+    cursor(cursor: string): QueryBuilder;
+    getOne(): Promise<Result | undefined>;
+    getMany(): Promise<ListResults>;
+}
+//# sourceMappingURL=query-api.d.ts.map

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

@@ -0,0 +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;IAC1C,OAAO,CAAC,SAAS;IAA2B,OAAO,CAAC,YAAY;gBAAxD,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,EAAU,YAAY,EAAE,WAAW;IAEzF,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY;IAO9B,MAAM,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAOrC,OAAO,IAAI,OAAO,CAAC,WAAW,CAAC;CAGtC"}

package/out/migration/query-api.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultQueryBuilder = void 0;
+class DefaultQueryBuilder {
+    constructor(migration, queryOptions) {
+        this.migration = migration;
+        this.queryOptions = queryOptions;
+    }
+    cursor(cursor) {
+        return new DefaultQueryBuilder(this.migration, Object.assign(Object.assign({}, this.queryOptions), { cursor }));
+    }
+    async getOne() {
+        const listResults = await this.migration.list(this.queryOptions, 1);
+        if (listResults.results && listResults.results.length > 0) {
+            return listResults.results[0];
+        }
+    }
+    async getMany() {
+        return this.migration.list(this.queryOptions);
+    }
+}
+exports.DefaultQueryBuilder = DefaultQueryBuilder;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/migrations",
-  "version": "0.0.0",
+  "version": "0.1.1-next.0",
   "description": "App migration methods for Forge app",
   "main": "out/index.js",
   "scripts": {
@@ -16,6 +16,6 @@
     "node-fetch": "2.6.1"
   },
   "dependencies": {
-    "@forge/api": "^2.6.1"
+    "@forge/api": "^2.7.0-next.0"
   }
 }

package/src/__test__/errors.test.ts

@@ -1,4 +1,4 @@
-import { APIError } from '../migration';
+import { APIError } from '../migration/errors';
 
 describe('APIError', () => {
   describe('forStatus', () => {

package/src/__test__/migration.test.ts

@@ -1,4 +1,5 @@
-import { APIError, migration } from '../migration';
+import { APIError } from '../migration/errors';
+import { migration } from '../migration';
 import { Progress } from '../migration/migration-adaptor';
 import { when } from 'jest-when';
 import fetch, { Response } from 'node-fetch';

package/src/__test__/query-api.test.ts

@@ -0,0 +1,177 @@
+import { ListResults, Result } from '../migration/migration-adaptor';
+import { when } from 'jest-when';
+import { migration } from '../migration';
+
+describe('QueryApi', () => {
+  const transferId = '521ee36a-b673-3dc6-b60b-12460332c200';
+
+  (global as any).api = {
+    asApp: jest.fn().mockReturnValue({
+      __requestAtlassian: jest.fn()
+    })
+  };
+
+  describe('getMappings', () => {
+    let expectedMappingsResultMany: ListResults;
+    let expectedMappingsResultManyWithCursor: ListResults;
+    let expectedMappingsResultSingle: Result;
+    let lastEntityId: string;
+
+    beforeAll(() => {
+      lastEntityId = 'base64:ZW1haWwvYWRtaW5AZXhhbXBsZS5jb20vNg';
+      const mappingsResponse = `{"meta":{"pageSize":5000,"hasNext":false,"lastEntity":"${lastEntityId}"},"items":{"email/admin@example.com":"5a29c4ae20cfc31b0dc0eafe","confluence.userkey/2c9682714db22c7c014db22f51970002":"5a29c4ae20cfc31b0dc0eafe"}}`;
+
+      const mappingsResponseWithoutLastEntity =
+        '{"meta":{"pageSize":5000,"hasNext":false,"lastEntity":null},"items":{"email/admin@example.com":"5a29c4ae20cfc31b0dc0eafe","confluence.userkey/2c9682714db22c7c014db22f51970002":"5a29c4ae20cfc31b0dc0eafe"}}';
+
+      const valueObject = '5a29c4ae20cfc31b0dc0eafe' as any;
+      when((global as any).api.asApp().__requestAtlassian)
+        .calledWith(
+          `/app/migration/forge/v1/mapping/${transferId}/page?namespace=identity:user&lastEntity=${lastEntityId}`
+        )
+        .mockReturnValue({
+          status: 200,
+          text: jest.fn().mockResolvedValue(mappingsResponseWithoutLastEntity),
+          json: jest.fn().mockResolvedValue(JSON.parse(mappingsResponseWithoutLastEntity))
+        })
+        .calledWith(`/app/migration/forge/v1/mapping/${transferId}/page?namespace=identity:user`)
+        .mockReturnValue({
+          status: 200,
+          text: jest.fn().mockResolvedValue(mappingsResponse),
+          json: jest.fn().mockResolvedValue(JSON.parse(mappingsResponse))
+        })
+        .calledWith(`/app/migration/forge/v1/mapping/${transferId}/page?namespace=identity:user&pageSize=1`)
+        .mockReturnValue({
+          status: 200,
+          text: jest.fn().mockResolvedValue(mappingsResponse),
+          json: jest.fn().mockResolvedValue(JSON.parse(mappingsResponse))
+        })
+        .calledWith(
+          `/app/migration/forge/v1/mapping/${transferId}/page?namespace=identity:user&pageSize=1&lastEntity=${lastEntityId}`
+        )
+        .mockReturnValue({
+          status: 200,
+          text: jest.fn().mockResolvedValue(mappingsResponse),
+          json: jest.fn().mockResolvedValue(JSON.parse(mappingsResponse))
+        });
+
+      expectedMappingsResultMany = {
+        results: [
+          {
+            key: 'email/admin@example.com',
+            value: valueObject
+          },
+          { key: 'confluence.userkey/2c9682714db22c7c014db22f51970002', value: valueObject }
+        ],
+        nextCursor: undefined
+      };
+
+      expectedMappingsResultManyWithCursor = {
+        results: [
+          { key: 'email/admin@example.com', value: valueObject },
+          { key: 'confluence.userkey/2c9682714db22c7c014db22f51970002', value: valueObject }
+        ],
+        nextCursor: lastEntityId
+      };
+      expectedMappingsResultSingle = { key: 'email/admin@example.com', value: valueObject };
+    });
+
+    it('should fetch multiple values for getMappings', async () => {
+      const results = await migration.getMappings(transferId, 'identity:user').getMany();
+
+      expect(results).toEqual(expectedMappingsResultManyWithCursor);
+    });
+
+    it('should allow specifying a cursor for getMappings with getMany', async () => {
+      const result = await migration.getMappings(transferId, 'identity:user').cursor(lastEntityId).getMany();
+      expect(result).toEqual(expectedMappingsResultMany);
+    });
+
+    it('get single mapping when getMappings called with getOne', async () => {
+      const result = await migration.getMappings(transferId, 'identity:user').getOne();
+
+      expect(result).toEqual(expectedMappingsResultSingle);
+    });
+
+    it('should allow specifying a cursor for getMappings with getOne', async () => {
+      const result = await migration.getMappings(transferId, 'identity:user').cursor(lastEntityId).getOne();
+
+      expect(result).toEqual(expectedMappingsResultSingle);
+    });
+  });
+
+  describe('getContainers', () => {
+    let expectedResultContainersManyWithCursor: ListResults;
+    let expectedResultContainersManyWithoutCursor: ListResults;
+    let expectedResultContainersSingle: Result;
+    let lastEntityId: string;
+
+    beforeAll(() => {
+      lastEntityId = 'db11c8af-c82b-3569-9a11-f288c9cc9535';
+      const containersResponse = `{"meta":{"pageSize":0,"hasNext":false,"lastEntity":"${lastEntityId}"},"containers":[{ "key": "TES", "sourceId": "884737", "type": "ConfluenceSpace" }]}`;
+
+      const containersResponseWithoutLastEntity =
+        '{"meta":{"pageSize":0,"hasNext":false,"lastEntity":null},"containers":[{ "key": "TES", "sourceId": "884737", "type": "ConfluenceSpace" }]}';
+
+      expectedResultContainersManyWithCursor = {
+        results: [{ key: '0', value: { key: 'TES', sourceId: '884737', type: 'ConfluenceSpace' } }],
+        nextCursor: lastEntityId
+      };
+      expectedResultContainersManyWithoutCursor = {
+        results: [{ key: '0', value: { key: 'TES', sourceId: '884737', type: 'ConfluenceSpace' } }],
+        nextCursor: undefined
+      };
+      expectedResultContainersSingle = { key: '0', value: { key: 'TES', sourceId: '884737', type: 'ConfluenceSpace' } };
+
+      when((global as any).api.asApp().__requestAtlassian)
+        .calledWith(
+          `/app/migration/forge/v1/container/${transferId}/page?containerType=ConfluenceSpace&lastEntity=${lastEntityId}`
+        )
+        .mockReturnValue({
+          status: 200,
+          text: jest.fn().mockResolvedValue(containersResponseWithoutLastEntity),
+          json: jest.fn().mockResolvedValue(JSON.parse(containersResponseWithoutLastEntity))
+        })
+        .calledWith(`/app/migration/forge/v1/container/${transferId}/page?containerType=ConfluenceSpace`)
+        .mockReturnValue({
+          status: 200,
+          text: jest.fn().mockResolvedValue(containersResponse),
+          json: jest.fn().mockResolvedValue(JSON.parse(containersResponse))
+        })
+        .calledWith(`/app/migration/forge/v1/container/${transferId}/page?containerType=ConfluenceSpace&pageSize=1`)
+        .mockReturnValue({
+          status: 200,
+          text: jest.fn().mockResolvedValue(containersResponse),
+          json: jest.fn().mockResolvedValue(JSON.parse(containersResponse))
+        })
+        .calledWith(
+          `/app/migration/forge/v1/container/${transferId}/page?containerType=ConfluenceSpace&pageSize=1&lastEntity=${lastEntityId}`
+        )
+        .mockReturnValue({
+          status: 200,
+          text: jest.fn().mockResolvedValue(containersResponse),
+          json: jest.fn().mockResolvedValue(JSON.parse(containersResponse))
+        });
+    });
+
+    it('should allow specifying a cursor for getContainers with getMany', async () => {
+      const result = await migration.getContainers(transferId, 'ConfluenceSpace').cursor(lastEntityId).getMany();
+      expect(result).toEqual(expectedResultContainersManyWithoutCursor);
+    });
+
+    it('should fetch multiple values when getContainers is called with getMany', async () => {
+      const result = await migration.getContainers(transferId, 'ConfluenceSpace').getMany();
+      expect(result).toEqual(expectedResultContainersManyWithCursor);
+    });
+
+    it('should allow specifying a cursor for getContainers with getOne', async () => {
+      const result = await migration.getContainers(transferId, 'ConfluenceSpace').cursor(lastEntityId).getOne();
+      expect(result).toEqual(expectedResultContainersSingle);
+    });
+
+    it('get single mapping when getContainers called with getOne', async () => {
+      const result = await migration.getContainers(transferId, 'ConfluenceSpace').getOne();
+      expect(result).toEqual(expectedResultContainersSingle);
+    });
+  });
+});

package/src/migration/index.ts

@@ -1,16 +1,19 @@
 import { Migration } from './migration';
-import { MigrationAdapter, Progress } from './migration-adaptor';
+import { Progress } from './migration-adaptor';
+import { DefaultQueryBuilder } from './query-api';
 
-export { APIError } from './errors';
-
-export const getMigrationInstance = (adapter: MigrationAdapter) => {
+export const getMigrationInstance = (adapter: Migration) => {
   return {
     sendProgress: (transferId: string, progress: Progress) => adapter.sendProgress(transferId, progress),
     getMappingById: (transferId: string, namespace: string, keys: Array<string>) =>
       adapter.getMappingById(transferId, namespace, keys),
     updateFeedback: (transferId: string, feedback: object) => adapter.updateFeedback(transferId, feedback),
     getAppDataList: (transferId: string) => adapter.getAppDataList(transferId),
-    getAppDataPayload: (s3Key: string) => adapter.getAppDataPayload(s3Key)
+    getAppDataPayload: (s3Key: string) => adapter.getAppDataPayload(s3Key),
+    getMappings: (transferId: string, namespace: string) =>
+      new DefaultQueryBuilder(adapter, { transferId: transferId, namespace: namespace }),
+    getContainers: (transferId: string, containerType: string) =>
+      new DefaultQueryBuilder(adapter, { transferId: transferId, containerType: containerType })
   };
 };
 
@@ -22,5 +25,9 @@ export const migration = {
   updateFeedback: (transferId: string, feedback: object) =>
     getMigrationInstance(new Migration()).updateFeedback(transferId, feedback),
   getAppDataList: (transferId: string) => getMigrationInstance(new Migration()).getAppDataList(transferId),
-  getAppDataPayload: (s3Key: string) => getMigrationInstance(new Migration()).getAppDataPayload(s3Key)
+  getAppDataPayload: (s3Key: string) => getMigrationInstance(new Migration()).getAppDataPayload(s3Key),
+  getMappings: (transferId: string, namespace: string) =>
+    getMigrationInstance(new Migration()).getMappings(transferId, namespace),
+  getContainers: (transferId: string, containerType: string) =>
+    getMigrationInstance(new Migration()).getContainers(transferId, containerType)
 };

package/src/migration/migration-adaptor.ts

@@ -30,3 +30,42 @@ export interface Progress {
   percent: number;
   message: string;
 }
+
+export interface PaginationMappingResponse {
+  meta: PaginationResponseMeta;
+  items: Map<string, string>;
+}
+
+interface PaginationResponseMeta {
+  pageSize: number;
+  hasNext: boolean;
+  lastEntity?: string;
+}
+
+export interface PaginationContainerResponse {
+  containers: Array<object>;
+  meta: PaginationResponseMeta;
+}
+
+export interface ListOptions {
+  transferId: string;
+  namespace?: string;
+  containerType?: string;
+  cursor?: string;
+}
+
+export interface Result {
+  key: string;
+  value: object;
+}
+
+export interface ListResults {
+  results: Result[];
+  nextCursor?: string;
+}
+
+export interface QueryBuilder {
+  cursor(cursor: string): QueryBuilder;
+  getMany(): Promise<ListResults>;
+  getOne(): Promise<Result | undefined>;
+}

package/src/migration/migration.ts

@@ -5,7 +5,12 @@ import {
   AppDataPayloadResponse,
   MappingResponse,
   MigrationAdapter,
-  Progress
+  Progress,
+  ListOptions,
+  ListResults,
+  Result,
+  PaginationContainerResponse,
+  PaginationMappingResponse
 } from './migration-adaptor';
 
 import { getResponseBody, invokeGETApi, invokePOSTApi } from './utils';
@@ -38,4 +43,69 @@ export class Migration implements MigrationAdapter {
     const result = await invokePOSTApi(`${this.basePath}/feedback/${transferId}`, feedback);
     return getResponseBody(result);
   };
+
+  getMappings = async (
+    transferId: string,
+    namespace?: string,
+    lastEntity?: string,
+    pageSize?: number
+  ): Promise<ListResults> => {
+    let queryParams = `namespace=${namespace}`;
+    if (pageSize != undefined) {
+      queryParams = queryParams + `&pageSize=${pageSize}`;
+    }
+    if (lastEntity != undefined) {
+      queryParams = queryParams + `&lastEntity=${lastEntity}`;
+    }
+
+    const result = await invokeGETApi(`${this.basePath}/mapping/${transferId}/page?${queryParams}`);
+    const mappingResponse: PaginationMappingResponse = await getResponseBody(result);
+
+    let results: Result[] = [];
+    if (mappingResponse.items != null) {
+      results = Object.entries(mappingResponse.items).map((item) => {
+        return { key: item[0], value: item[1] as object };
+      });
+    }
+
+    return {
+      results: results,
+      nextCursor: mappingResponse.meta.lastEntity != null ? mappingResponse.meta.lastEntity : undefined
+    };
+  };
+
+  getContainers = async (
+    transferId: string,
+    containerType?: string,
+    lastEntity?: string,
+    pageSize?: number
+  ): Promise<ListResults> => {
+    let queryParams = `containerType=${containerType}`;
+    if (pageSize != undefined) {
+      queryParams = queryParams + `&pageSize=${pageSize}`;
+    }
+    if (lastEntity != undefined) {
+      queryParams = queryParams + `&lastEntity=${lastEntity}`;
+    }
+
+    const result = await invokeGETApi(`${this.basePath}/container/${transferId}/page?${queryParams}`);
+    const containerResponse: PaginationContainerResponse = await getResponseBody(result);
+    let results: Result[] = [];
+    if (containerResponse.containers != null) {
+      results = Object.entries(containerResponse.containers).map((item) => {
+        return { key: item[0], value: item[1] };
+      });
+    }
+
+    return {
+      results: results,
+      nextCursor: containerResponse.meta.lastEntity != null ? containerResponse.meta.lastEntity : undefined
+    };
+  };
+
+  list = async (options: ListOptions, pageSize?: number): Promise<ListResults> => {
+    if (options.namespace != undefined)
+      return this.getMappings(options.transferId, options.namespace, options.cursor, pageSize);
+    else return this.getContainers(options.transferId, options.containerType, options.cursor, pageSize);
+  };
 }

package/src/migration/query-api.ts

@@ -0,0 +1,24 @@
+import { QueryBuilder, Result, ListOptions, ListResults } from './migration-adaptor';
+import { Migration } from './migration';
+
+export class DefaultQueryBuilder implements QueryBuilder {
+  constructor(private migration: Pick<Migration, 'list'>, private queryOptions: ListOptions) {}
+
+  cursor(cursor: string): QueryBuilder {
+    return new DefaultQueryBuilder(this.migration, {
+      ...this.queryOptions,
+      cursor
+    });
+  }
+
+  async getOne(): Promise<Result | undefined> {
+    const listResults = await this.migration.list(this.queryOptions, 1);
+    if (listResults.results && listResults.results.length > 0) {
+      return listResults.results[0];
+    }
+  }
+
+  async getMany(): Promise<ListResults> {
+    return this.migration.list(this.queryOptions);
+  }
+}

package/tsconfig.tsbuildinfo

@@ -377,8 +377,8 @@
         "affectsGlobalScope": false
       },
       "./src/migration/migration-adaptor.ts": {
-        "version": "88613dcc9bb05fd5174af00c31283acc531b75920124ae046b2485210997af03",
-        "signature": "1e4bdc70d716dc5b0af95b1da81e393781f921f2083d5068126ea83d00bc17fa",
+        "version": "b56b0399bb9cb4b98565d61ca5edc4f682e114c778fec1178d22829bc40f9cd0",
+        "signature": "e4b45919b4b2b97ac6b7f782220947a2c1ddfddc407c1c8451dddf52749f739e",
         "affectsGlobalScope": false
       },
       "../forge-storage/out/queries.d.ts": {
@@ -462,13 +462,18 @@
         "affectsGlobalScope": false
       },
       "./src/migration/migration.ts": {
-        "version": "843e9c8d7022ead10c2a5215ae678d63321cb3d5c58277a82da500a6ed69b0da",
-        "signature": "48b43ae92d77eb0587f4dac5f8a47577e50acbf5b99642c8504a82201244d29a",
+        "version": "163399d53401973c8bb67681d25cd855765231bc8c4260585459b492d592fb0b",
+        "signature": "3b9596b98e61b6b1ec3011b5dab5da0a3481067c08d136ad29fb5ab577adc32c",
+        "affectsGlobalScope": false
+      },
+      "./src/migration/query-api.ts": {
+        "version": "8fdd39f2eba2deeb1da161859dd92e6abe8706c950bffa660500e5ad4418a34d",
+        "signature": "d03085a9c7a02899410eaea4e2ed1304b1ea35a9f86474a3a2b0b3551ca6b907",
         "affectsGlobalScope": false
       },
       "./src/migration/index.ts": {
-        "version": "e934a6242349369c2e5ae7e9508436d94c7313173a859ce0da03ef369212279c",
-        "signature": "054b83c5bad398e0ffc0a35198dc2de75be78d7e43f72dbb0cf45839ef7b257b",
+        "version": "aa7afc2eaa77e085b5ea50c5c2e29721b49c5eb0ef8750b46ac701fce7f2c744",
+        "signature": "7459ca986a330d5da97ff9379915ec691eaaabb19e93cab8003c4b0beac1a59d",
         "affectsGlobalScope": false
       },
       "./src/index.ts": {
@@ -477,7 +482,7 @@
         "affectsGlobalScope": false
       },
       "./src/__test__/errors.test.ts": {
-        "version": "e3e7f31ddd11686b6b4df341cfcde34ce6d4bf10f36411be3bc1bd8dfb9aa691",
+        "version": "d44a0989d278a27ee156a57eaa5aae11c1d21238f8026fb699c9301e5f95faa8",
         "signature": "b5d7523b42f6acd1ed17495b1dd8bf1ab3dbe63bf8e36eac4d93d7bcfda6e9cb",
         "affectsGlobalScope": false
       },
@@ -557,8 +562,8 @@
         "affectsGlobalScope": false
       },
       "../../node_modules/@types/yargs-parser/index.d.ts": {
-        "version": "f7e133b20ee2669b6c0e5d7f0cd510868c57cd64b283e68c7f598e30ce9d76d2",
-        "signature": "f7e133b20ee2669b6c0e5d7f0cd510868c57cd64b283e68c7f598e30ce9d76d2",
+        "version": "70e9a18da08294f75bf23e46c7d69e67634c0765d355887b9b41f0d959e1426e",
+        "signature": "70e9a18da08294f75bf23e46c7d69e67634c0765d355887b9b41f0d959e1426e",
         "affectsGlobalScope": false
       },
       "../../node_modules/@types/yargs/index.d.ts": {
@@ -596,9 +601,9 @@
         "signature": "7b80d25cee6eba0453aaeb22b9f56f61883154f93c31d7e3743cf6b262f6fb9d",
         "affectsGlobalScope": false
       },
-      "../../node_modules/@babel/types/lib/index.d.ts": {
-        "version": "d5d7b68f5369a210c235cd65458369888f8b839192d088c964f21cab3ac954db",
-        "signature": "d5d7b68f5369a210c235cd65458369888f8b839192d088c964f21cab3ac954db",
+      "../../node_modules/@types/babel__generator/node_modules/@babel/types/lib/index.d.ts": {
+        "version": "2ff9995137f3e5d68971388ec58af0c79721626323884513f9f5e2e996ac1fdd",
+        "signature": "2ff9995137f3e5d68971388ec58af0c79721626323884513f9f5e2e996ac1fdd",
         "affectsGlobalScope": false
       },
       "../../node_modules/@types/babel__generator/index.d.ts": {
@@ -606,9 +611,19 @@
         "signature": "cc957354aa3c94c9961ebf46282cfde1e81d107fc5785a61f62c67f1dd3ac2eb",
         "affectsGlobalScope": false
       },
+      "../../node_modules/@babel/types/lib/index.d.ts": {
+        "version": "d5d7b68f5369a210c235cd65458369888f8b839192d088c964f21cab3ac954db",
+        "signature": "d5d7b68f5369a210c235cd65458369888f8b839192d088c964f21cab3ac954db",
+        "affectsGlobalScope": false
+      },
       "../../node_modules/@babel/parser/typings/babel-parser.d.ts": {
-        "version": "64b867c61effed7b5bc0cc06b3d8eac23b067a3fba581fc7d3c292fa593e6a45",
-        "signature": "64b867c61effed7b5bc0cc06b3d8eac23b067a3fba581fc7d3c292fa593e6a45",
+        "version": "8670878e030b88a469db43b36ef90ffa208e74faf249416feeb8fbb6b646b4a9",
+        "signature": "8670878e030b88a469db43b36ef90ffa208e74faf249416feeb8fbb6b646b4a9",
+        "affectsGlobalScope": false
+      },
+      "../../node_modules/@types/babel__template/node_modules/@babel/types/lib/index.d.ts": {
+        "version": "2ff9995137f3e5d68971388ec58af0c79721626323884513f9f5e2e996ac1fdd",
+        "signature": "2ff9995137f3e5d68971388ec58af0c79721626323884513f9f5e2e996ac1fdd",
         "affectsGlobalScope": false
       },
       "../../node_modules/@types/babel__template/index.d.ts": {
@@ -616,14 +631,24 @@
         "signature": "93de1c6dab503f053efe8d304cb522bb3a89feab8c98f307a674a4fae04773e9",
         "affectsGlobalScope": false
       },
+      "../../node_modules/@types/babel__traverse/node_modules/@babel/types/lib/index.d.ts": {
+        "version": "2ff9995137f3e5d68971388ec58af0c79721626323884513f9f5e2e996ac1fdd",
+        "signature": "2ff9995137f3e5d68971388ec58af0c79721626323884513f9f5e2e996ac1fdd",
+        "affectsGlobalScope": false
+      },
       "../../node_modules/@types/babel__traverse/ts4.1/index.d.ts": {
-        "version": "5158403c4f6a1e0e86a5e43e9aaad3571ce270e02fcdd750b5b0ea8dc636dbe4",
-        "signature": "5158403c4f6a1e0e86a5e43e9aaad3571ce270e02fcdd750b5b0ea8dc636dbe4",
+        "version": "7ec562d20173996ab057cd17eb0af2e5de5fee1b1024ef20373c105b18020346",
+        "signature": "7ec562d20173996ab057cd17eb0af2e5de5fee1b1024ef20373c105b18020346",
+        "affectsGlobalScope": false
+      },
+      "../../node_modules/@types/babel__core/node_modules/@babel/types/lib/index.d.ts": {
+        "version": "2ff9995137f3e5d68971388ec58af0c79721626323884513f9f5e2e996ac1fdd",
+        "signature": "2ff9995137f3e5d68971388ec58af0c79721626323884513f9f5e2e996ac1fdd",
         "affectsGlobalScope": false
       },
       "../../node_modules/@types/babel__core/index.d.ts": {
-        "version": "dd5647a9ccccb2b074dca8a02b00948ac293091ebe73fdf2e6e98f718819f669",
-        "signature": "dd5647a9ccccb2b074dca8a02b00948ac293091ebe73fdf2e6e98f718819f669",
+        "version": "5426e62886b7be7806312d31a00e8f7dccd6fe63ba9bbefe99ee2eab29cc48a3",
+        "signature": "5426e62886b7be7806312d31a00e8f7dccd6fe63ba9bbefe99ee2eab29cc48a3",
         "affectsGlobalScope": false
       },
       "../../node_modules/ts-jest/dist/tsconfig-raw.d.ts": {
@@ -652,9 +677,14 @@
         "affectsGlobalScope": false
       },
       "./src/__test__/migration.test.ts": {
-        "version": "ca2f36c1371a3f8b81256f366eb7d81b67f2cdd0ddf9c282defd912eb3b05a9d",
+        "version": "56e44bcd47479953ecf4aece6ca7557824e9ba8517d3733c1751c0f77760264d",
         "signature": "00e64039b0b16d0a311c28c5ab9e1ec67f4d1cfc8bff56ff6c14d7c149362ec7",
         "affectsGlobalScope": false
+      },
+      "./src/__test__/query-api.test.ts": {
+        "version": "68bb3f47e22733bf4e516931b36a4fac2e73b94fa8385ecec47fee3e4c31f97f",
+        "signature": "992008f9ddb7bfac9925d559482bc234bde772c083ca134ae8a1d39d08d59b50",
+        "affectsGlobalScope": false
       }
     },
     "options": {
@@ -714,20 +744,20 @@
       ],
       "../../node_modules/@types/babel__core/index.d.ts": [
         "../../node_modules/@babel/parser/typings/babel-parser.d.ts",
-        "../../node_modules/@babel/types/lib/index.d.ts",
         "../../node_modules/@types/babel__generator/index.d.ts",
+        "../../node_modules/@types/babel__generator/node_modules/@babel/types/lib/index.d.ts",
         "../../node_modules/@types/babel__template/index.d.ts",
         "../../node_modules/@types/babel__traverse/ts4.1/index.d.ts"
       ],
       "../../node_modules/@types/babel__generator/index.d.ts": [
-        "../../node_modules/@babel/types/lib/index.d.ts"
+        "../../node_modules/@types/babel__generator/node_modules/@babel/types/lib/index.d.ts"
       ],
       "../../node_modules/@types/babel__template/index.d.ts": [
         "../../node_modules/@babel/parser/typings/babel-parser.d.ts",
-        "../../node_modules/@babel/types/lib/index.d.ts"
+        "../../node_modules/@types/babel__generator/node_modules/@babel/types/lib/index.d.ts"
       ],
       "../../node_modules/@types/babel__traverse/ts4.1/index.d.ts": [
-        "../../node_modules/@babel/types/lib/index.d.ts"
+        "../../node_modules/@types/babel__generator/node_modules/@babel/types/lib/index.d.ts"
       ],
       "../../node_modules/@types/istanbul-lib-report/index.d.ts": [
         "../../node_modules/@types/istanbul-lib-coverage/index.d.ts"
@@ -956,12 +986,18 @@
         "../forge-auth/out/types.d.ts"
       ],
       "./src/__test__/errors.test.ts": [
-        "./src/migration/index.ts"
+        "./src/migration/errors.ts"
       ],
       "./src/__test__/migration.test.ts": [
         "../../node_modules/@types/jest-when/index.d.ts",
         "../../node_modules/@types/node-fetch/index.d.ts",
         "../../node_modules/ts-jest/utils/index.d.ts",
+        "./src/migration/errors.ts",
+        "./src/migration/index.ts",
+        "./src/migration/migration-adaptor.ts"
+      ],
+      "./src/__test__/query-api.test.ts": [
+        "../../node_modules/@types/jest-when/index.d.ts",
         "./src/migration/index.ts",
         "./src/migration/migration-adaptor.ts"
       ],
@@ -969,9 +1005,9 @@
         "./src/migration/index.ts"
       ],
       "./src/migration/index.ts": [
-        "./src/migration/errors.ts",
         "./src/migration/migration-adaptor.ts",
-        "./src/migration/migration.ts"
+        "./src/migration/migration.ts",
+        "./src/migration/query-api.ts"
       ],
       "./src/migration/migration-adaptor.ts": [
         "../../node_modules/@types/node-fetch/index.d.ts"
@@ -981,6 +1017,10 @@
         "./src/migration/migration-adaptor.ts",
         "./src/migration/utils.ts"
       ],
+      "./src/migration/query-api.ts": [
+        "./src/migration/migration-adaptor.ts",
+        "./src/migration/migration.ts"
+      ],
       "./src/migration/utils.ts": [
         "../forge-api/out/index.d.ts",
         "./src/migration/errors.ts"
@@ -1034,20 +1074,20 @@
       ],
       "../../node_modules/@types/babel__core/index.d.ts": [
         "../../node_modules/@babel/parser/typings/babel-parser.d.ts",
-        "../../node_modules/@babel/types/lib/index.d.ts",
         "../../node_modules/@types/babel__generator/index.d.ts",
+        "../../node_modules/@types/babel__generator/node_modules/@babel/types/lib/index.d.ts",
         "../../node_modules/@types/babel__template/index.d.ts",
         "../../node_modules/@types/babel__traverse/ts4.1/index.d.ts"
       ],
       "../../node_modules/@types/babel__generator/index.d.ts": [
-        "../../node_modules/@babel/types/lib/index.d.ts"
+        "../../node_modules/@types/babel__generator/node_modules/@babel/types/lib/index.d.ts"
       ],
       "../../node_modules/@types/babel__template/index.d.ts": [
         "../../node_modules/@babel/parser/typings/babel-parser.d.ts",
-        "../../node_modules/@babel/types/lib/index.d.ts"
+        "../../node_modules/@types/babel__generator/node_modules/@babel/types/lib/index.d.ts"
       ],
       "../../node_modules/@types/babel__traverse/ts4.1/index.d.ts": [
-        "../../node_modules/@babel/types/lib/index.d.ts"
+        "../../node_modules/@types/babel__generator/node_modules/@babel/types/lib/index.d.ts"
       ],
       "../../node_modules/@types/istanbul-lib-report/index.d.ts": [
         "../../node_modules/@types/istanbul-lib-coverage/index.d.ts"
@@ -1280,8 +1320,9 @@
       ],
       "./src/migration/index.ts": [
         "../../node_modules/@types/node-fetch/index.d.ts",
-        "./src/migration/errors.ts",
-        "./src/migration/migration-adaptor.ts"
+        "./src/migration/migration-adaptor.ts",
+        "./src/migration/migration.ts",
+        "./src/migration/query-api.ts"
       ],
       "./src/migration/migration-adaptor.ts": [
         "../../node_modules/@types/node-fetch/index.d.ts"
@@ -1290,6 +1331,10 @@
         "../../node_modules/@types/node-fetch/index.d.ts",
         "./src/migration/migration-adaptor.ts"
       ],
+      "./src/migration/query-api.ts": [
+        "./src/migration/migration-adaptor.ts",
+        "./src/migration/migration.ts"
+      ],
       "./src/migration/utils.ts": [
         "../forge-api/out/index.d.ts"
       ],
@@ -1326,8 +1371,12 @@
       "../../node_modules/@jest/types/build/index.d.ts",
       "../../node_modules/@jest/types/node_modules/chalk/index.d.ts",
       "../../node_modules/@types/babel__core/index.d.ts",
+      "../../node_modules/@types/babel__core/node_modules/@babel/types/lib/index.d.ts",
       "../../node_modules/@types/babel__generator/index.d.ts",
+      "../../node_modules/@types/babel__generator/node_modules/@babel/types/lib/index.d.ts",
       "../../node_modules/@types/babel__template/index.d.ts",
+      "../../node_modules/@types/babel__template/node_modules/@babel/types/lib/index.d.ts",
+      "../../node_modules/@types/babel__traverse/node_modules/@babel/types/lib/index.d.ts",
       "../../node_modules/@types/babel__traverse/ts4.1/index.d.ts",
       "../../node_modules/@types/events/index.d.ts",
       "../../node_modules/@types/istanbul-lib-coverage/index.d.ts",
@@ -1434,11 +1483,13 @@
       "../forge-auth/out/types.d.ts",
       "./src/__test__/errors.test.ts",
       "./src/__test__/migration.test.ts",
+      "./src/__test__/query-api.test.ts",
       "./src/index.ts",
       "./src/migration/errors.ts",
       "./src/migration/index.ts",
       "./src/migration/migration-adaptor.ts",
       "./src/migration/migration.ts",
+      "./src/migration/query-api.ts",
       "./src/migration/utils.ts",
       "../forge-storage/out/conditions.d.ts",
       "../forge-storage/out/errors.d.ts",