@forge/migrations 0.0.0

package/README.md

@@ -0,0 +1,22 @@
+# Forge Migrations
+
+API methods exposed to perform app migrations in Forge apps. These include methods to simplify calls to app migration platform.
+
+## Requirements
+
+See [Set up Forge](https://developer.atlassian.com/platform/forge/set-up-forge/) for details of the software required to develop Forge apps.
+
+## Usage
+
+In your Forge app, include the following:
+
+```
+
+import migration from '@forge/migrations';
+
+```
+
+
+## Support
+
+See [Get help](https://developer.atlassian.com/platform/forge/get-help/) for how to get help and provide feedback.

package/out/__test__/errors.test.d.ts

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

package/out/__test__/errors.test.d.ts.map

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

package/out/__test__/errors.test.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const migration_1 = require("../migration");
+describe('APIError', () => {
+    describe('forStatus', () => {
+        it.each([
+            [400, 'Bad request'],
+            [401, 'Unauthorized'],
+            [403, 'Forbidden'],
+            [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);
+        });
+    });
+});

package/out/__test__/migration.test.d.ts

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

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

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

package/out/__test__/migration.test.js

@@ -0,0 +1,220 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const migration_1 = require("../migration");
+const jest_when_1 = require("jest-when");
+const node_fetch_1 = tslib_1.__importDefault(require("node-fetch"));
+const utils_1 = require("ts-jest/utils");
+let transferId;
+let invalidTransferId;
+let progress;
+let keys;
+let invalidKeys;
+let namespace;
+let mappingByKeyResponseWithKeys;
+let mappingByKeyResponseWithInvalidKeys;
+let s3Key;
+let invalidS3Key;
+let feedbackPayload;
+let appDataListResponse;
+let appDataPayloadResponse;
+jest.mock('node-fetch');
+describe('migration', () => {
+    beforeAll(() => {
+        global.api = {
+            asApp: jest.fn().mockReturnValue({
+                __requestAtlassian: jest.fn()
+            })
+        };
+        transferId = '521ee36a-b673-3dc6-b60b-12460332c200';
+        invalidTransferId = '521ee36a-b673-3dc6-b60b-12460332c001';
+    });
+    describe('sendMigrationProgress', () => {
+        beforeAll(() => {
+            progress = { status: 'IN_PROGRESS', percent: 10, message: 'reporting' };
+            jest_when_1.when(global.api.asApp().__requestAtlassian)
+                .calledWith(`/app/migration/forge/v1/progress/${transferId}`, {
+                method: 'POST',
+                headers: {
+                    'content-type': 'application/json'
+                },
+                body: JSON.stringify(progress)
+            })
+                .mockReturnValue({
+                status: 200,
+                text: jest.fn().mockImplementationOnce(() => Promise.resolve()),
+                json: jest.fn().mockImplementationOnce(() => Promise.resolve())
+            })
+                .calledWith(`/app/migration/forge/v1/progress/${invalidTransferId}`, {
+                method: 'POST',
+                headers: {
+                    'content-type': 'application/json'
+                },
+                body: JSON.stringify(progress)
+            })
+                .mockReturnValue({
+                status: 403,
+                statusText: 'Forbidden'
+            });
+        });
+        it('should update progress when sendProgress method called with valid transferId', async () => {
+            const returnedValue = migration_1.migration.sendProgress(transferId, progress);
+            await expect(returnedValue).resolves.toBeUndefined();
+        });
+        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'));
+        });
+    });
+    describe('getMappingById', () => {
+        beforeAll(() => {
+            keys = ['email/abc@example.com', 'email/admin@example.com'];
+            invalidKeys = ['email/abc@example.com', 'email/admin@example'];
+            namespace = 'identity:user';
+            mappingByKeyResponseWithKeys =
+                '{"email/abc@example.com":"5a20a4d7c6bd4a32df3a711","email/admin@example.com":"5a29c4ae20cfc31b0dc0e112"}';
+            mappingByKeyResponseWithInvalidKeys = '{"email/abc@example.com":"5a20a4d7c6bd4a32df3a711"}';
+            jest_when_1.when(global.api.asApp().__requestAtlassian)
+                .calledWith(`/app/migration/forge/v1/mapping/${transferId}/find?namespace=${namespace}`, {
+                method: 'POST',
+                headers: {
+                    'content-type': 'application/json'
+                },
+                body: JSON.stringify(keys)
+            })
+                .mockReturnValue({
+                status: 200,
+                text: jest.fn().mockResolvedValue(mappingByKeyResponseWithKeys),
+                json: jest.fn().mockResolvedValue(JSON.parse(mappingByKeyResponseWithKeys))
+            })
+                .calledWith(`/app/migration/forge/v1/mapping/${transferId}/find?namespace=${namespace}`, {
+                method: 'POST',
+                headers: {
+                    'content-type': 'application/json'
+                },
+                body: JSON.stringify(invalidKeys)
+            })
+                .mockReturnValue({
+                status: 200,
+                text: jest.fn().mockResolvedValue(mappingByKeyResponseWithInvalidKeys),
+                json: jest.fn().mockResolvedValue(JSON.parse(mappingByKeyResponseWithInvalidKeys))
+            })
+                .calledWith(`/app/migration/forge/v1/mapping/${invalidTransferId}/find?namespace=${namespace}`, {
+                method: 'POST',
+                headers: {
+                    'content-type': 'application/json'
+                },
+                body: JSON.stringify(keys)
+            })
+                .mockReturnValue({
+                status: 403,
+                statusText: 'Forbidden'
+            });
+        });
+        it('should return MappingResponse when getMappingById method called with valid transferId', async () => {
+            const returnedValue = await migration_1.migration.getMappingById(transferId, namespace, keys);
+            expect(JSON.stringify(returnedValue)).toEqual(mappingByKeyResponseWithKeys);
+        });
+        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'));
+        });
+        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);
+            expect(JSON.stringify(returnedValue)).toEqual(mappingByKeyResponseWithInvalidKeys);
+        });
+    });
+    describe('getAppDataList', () => {
+        beforeAll(() => {
+            appDataListResponse =
+                '[{"s3Key":"2ea231e3-ab0d-4236-97f7-26f951df1c11","label":null},{"s3Key":"317a3631-2fef-4940-a418-7096e971eb11","label":null}]';
+            jest_when_1.when(global.api.asApp().__requestAtlassian)
+                .calledWith(`/app/migration/forge/v1/data/${transferId}/all`)
+                .mockReturnValue({
+                status: 200,
+                text: jest.fn().mockResolvedValue(appDataListResponse),
+                json: jest.fn().mockResolvedValue(JSON.parse(appDataListResponse))
+            })
+                .calledWith(`/app/migration/forge/v1/data/${invalidTransferId}/all`)
+                .mockReturnValue({
+                status: 403,
+                statusText: 'Forbidden'
+            });
+        });
+        it('should return AppDataListResponse when getAppDataList method called with valid transferId', async () => {
+            const returnedValue = await migration_1.migration.getAppDataList(transferId);
+            expect(returnedValue).toEqual(JSON.parse(appDataListResponse));
+        });
+        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'));
+        });
+    });
+    describe('getAppDataPayload', () => {
+        beforeAll(() => {
+            s3Key = '7941b65d-094b-4305-97f2-e2b412c6db0a';
+            invalidS3Key = '7941b65d-094b-4305-97f2-e2b412c000';
+            appDataPayloadResponse = '{ "url": "https://rps--stg-east--app-migration-service--ams.s3.amazonaws.com/test"}';
+            utils_1.mocked(node_fetch_1.default).mockImplementation(() => Promise.resolve({
+                text: () => Promise.resolve('Sample app data')
+            }));
+            jest_when_1.when(global.api.asApp().__requestAtlassian)
+                .calledWith(`/app/migration/forge/v1/data/${s3Key}`)
+                .mockReturnValue({
+                status: 200,
+                text: jest.fn().mockResolvedValue(JSON.stringify(appDataPayloadResponse)),
+                json: jest.fn().mockResolvedValue(JSON.parse(appDataPayloadResponse))
+            })
+                .calledWith(`/app/migration/forge/v1/data/${invalidS3Key}`)
+                .mockReturnValue({
+                status: 403,
+                statusText: 'Forbidden'
+            });
+        });
+        it('should return Response when getAppDataPayload method called with valid S3Key', async () => {
+            const returnedValue = await migration_1.migration.getAppDataPayload(s3Key);
+            await expect(returnedValue.text()).resolves.toBe('Sample app data');
+        });
+        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'));
+        });
+    });
+    describe('updateFeedback', () => {
+        beforeAll(() => {
+            feedbackPayload = { transferId: transferId, msg: 'Current Data processed, send next' };
+            jest_when_1.when(global.api.asApp().__requestAtlassian)
+                .calledWith(`/app/migration/forge/v1/feedback/${transferId}`, {
+                method: 'POST',
+                headers: {
+                    'content-type': 'application/json'
+                },
+                body: JSON.stringify(feedbackPayload)
+            })
+                .mockReturnValue({
+                status: 200,
+                text: jest.fn().mockImplementationOnce(() => Promise.resolve()),
+                json: jest.fn().mockImplementationOnce(() => Promise.resolve())
+            })
+                .calledWith(`/app/migration/forge/v1/feedback/${invalidTransferId}`, {
+                method: 'POST',
+                headers: {
+                    'content-type': 'application/json'
+                },
+                body: JSON.stringify(feedbackPayload)
+            })
+                .mockReturnValue({
+                status: 403,
+                statusText: 'Forbidden'
+            });
+        });
+        it('should send feedback when updateFeedback method called with valid transferId', async () => {
+            const returnedValue = migration_1.migration.updateFeedback(transferId, feedbackPayload);
+            await expect(returnedValue).resolves.toBeUndefined();
+        });
+        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'));
+        });
+    });
+});

package/out/index.d.ts

@@ -0,0 +1,3 @@
+import { migration } from './migration';
+export { migration };
+//# sourceMappingURL=index.d.ts.map

package/out/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,OAAO,EAAE,SAAS,EAAE,CAAC"}

package/out/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.migration = void 0;
+const migration_1 = require("./migration");
+Object.defineProperty(exports, "migration", { enumerable: true, get: function () { return migration_1.migration; } });

package/out/migration/errors.d.ts

@@ -0,0 +1,6 @@
+export declare class APIError extends Error {
+    private constructor();
+    static forStatus(status: number, message: string): APIError;
+    static forUnexpected(message: string): APIError;
+}
+//# sourceMappingURL=errors.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/migration/errors.ts"],"names":[],"mappings":"AAAA,qBAAa,QAAS,SAAQ,KAAK;IACjC,OAAO;WAIO,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,QAAQ;WAIpD,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,QAAQ;CAGvD"}

package/out/migration/errors.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.APIError = void 0;
+class APIError extends Error {
+    constructor(message) {
+        super(message);
+    }
+    static forStatus(status, message) {
+        return new APIError(message);
+    }
+    static forUnexpected(message) {
+        return new APIError(message);
+    }
+}
+exports.APIError = APIError;

package/out/migration/index.d.ts

@@ -0,0 +1,17 @@
+import { MigrationAdapter, Progress } from './migration-adaptor';
+export { APIError } from './errors';
+export declare const getMigrationInstance: (adapter: MigrationAdapter) => {
+    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>;
+};
+export declare const 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>;
+};
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +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"}

package/out/migration/index.js

@@ -0,0 +1,22 @@
+"use strict";
+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; } });
+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)
+    };
+};
+exports.migration = {
+    sendProgress: (transferId, progress) => exports.getMigrationInstance(new migration_1.Migration()).sendProgress(transferId, progress),
+    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)
+};

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

@@ -0,0 +1,27 @@
+import { Response } from 'node-fetch';
+export interface MigrationAdapter {
+    sendProgress(transferId: string, progress: Progress): Promise<void>;
+    getMappingById(transferId: string, namespace: string, keys: Array<string>): Promise<MappingResponse>;
+    getAppDataList(transferId: string): Promise<AppDataListResponse>;
+    getAppDataPayload(s3Key: string): Promise<Response>;
+    updateFeedback(transferId: string, feedback: object): Promise<void>;
+}
+export interface MappingResponse {
+    result: Map<string, string>;
+}
+export interface AppData {
+    s3Key: string;
+    label: string;
+}
+export interface AppDataListResponse {
+    result: Set<AppData>;
+}
+export interface AppDataPayloadResponse {
+    url: string;
+}
+export interface Progress {
+    status: string;
+    percent: number;
+    message: string;
+}
+//# sourceMappingURL=migration-adaptor.d.ts.map

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

@@ -0,0 +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"}

package/out/migration/migration-adaptor.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/out/migration/migration.d.ts

@@ -0,0 +1,11 @@
+import { Response } from 'node-fetch';
+import { AppDataListResponse, MappingResponse, MigrationAdapter, Progress } from './migration-adaptor';
+export declare class Migration implements MigrationAdapter {
+    private readonly basePath;
+    sendProgress: (transferId: string, progress: Progress) => Promise<void>;
+    getMappingById: (transferId: string, namespace: string, keys: Array<string>) => Promise<MappingResponse>;
+    getAppDataList: (transferId: string) => Promise<AppDataListResponse>;
+    getAppDataPayload: (s3Key: string) => Promise<Response>;
+    updateFeedback: (transferId: string, feedback: object) => Promise<void>;
+}
+//# sourceMappingURL=migration.d.ts.map

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

@@ -0,0 +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"}

package/out/migration/migration.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Migration = void 0;
+const tslib_1 = require("tslib");
+const node_fetch_1 = tslib_1.__importDefault(require("node-fetch"));
+const utils_1 = require("./utils");
+class Migration {
+    constructor() {
+        this.basePath = '/app/migration/forge/v1';
+        this.sendProgress = async (transferId, progress) => {
+            const result = await utils_1.invokePOSTApi(`${this.basePath}/progress/${transferId}`, progress);
+            return utils_1.getResponseBody(result);
+        };
+        this.getMappingById = async (transferId, namespace, keys) => {
+            const result = await utils_1.invokePOSTApi(`${this.basePath}/mapping/${transferId}/find?namespace=${namespace}`, keys);
+            return utils_1.getResponseBody(result);
+        };
+        this.getAppDataList = async (transferId) => {
+            const result = await utils_1.invokeGETApi(`${this.basePath}/data/${transferId}/all`);
+            return utils_1.getResponseBody(result);
+        };
+        this.getAppDataPayload = async (s3Key) => {
+            const result = await utils_1.invokeGETApi(`${this.basePath}/data/${s3Key}`);
+            const responseBody = await utils_1.getResponseBody(result);
+            return node_fetch_1.default(responseBody.url);
+        };
+        this.updateFeedback = async (transferId, feedback) => {
+            const result = await utils_1.invokePOSTApi(`${this.basePath}/feedback/${transferId}`, feedback);
+            return utils_1.getResponseBody(result);
+        };
+    }
+}
+exports.Migration = Migration;

package/out/migration/utils.d.ts

@@ -0,0 +1,5 @@
+import { APIResponse } from '@forge/api';
+export declare function getResponseBody(response: APIResponse): Promise<any>;
+export declare function invokePOSTApi(url: string, payload: any): Promise<APIResponse>;
+export declare function invokeGETApi(url: string): Promise<APIResponse>;
+//# sourceMappingURL=utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/migration/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAGzC,wBAAsB,eAAe,CAAC,QAAQ,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAazE;AAED,wBAAsB,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,WAAW,CAAC,CAQnF;AAED,wBAAsB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAEpE"}

package/out/migration/utils.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.invokeGETApi = exports.invokePOSTApi = exports.getResponseBody = void 0;
+const errors_1 = require("./errors");
+async function getResponseBody(response) {
+    if (response.status !== 200) {
+        throw errors_1.APIError.forStatus(response.status, response.statusText);
+    }
+    const responseText = await response.text();
+    try {
+        if (responseText !== '' && responseText !== undefined) {
+            return JSON.parse(responseText);
+        }
+    }
+    catch (error) {
+        throw errors_1.APIError.forUnexpected(`Response text was not a valid JSON: ${responseText}`);
+    }
+}
+exports.getResponseBody = getResponseBody;
+async function invokePOSTApi(url, payload) {
+    return global.api.asApp().__requestAtlassian(url, {
+        method: 'POST',
+        headers: {
+            'content-type': 'application/json'
+        },
+        body: JSON.stringify(payload)
+    });
+}
+exports.invokePOSTApi = invokePOSTApi;
+async function invokeGETApi(url) {
+    return global.api.asApp().__requestAtlassian(url);
+}
+exports.invokeGETApi = invokeGETApi;

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@forge/migrations",
+  "version": "0.0.0",
+  "description": "App migration methods for Forge app",
+  "main": "out/index.js",
+  "scripts": {
+    "build": "yarn run clean && yarn run compile",
+    "clean": "rm -rf ./out && rm -f tsconfig.tsbuildinfo",
+    "compile": "tsc -b -v"
+  },
+  "author": "Atlassian",
+  "license": "UNLICENSED",
+  "devDependencies": {
+    "@types/node": "^12.12.63",
+    "@types/node-fetch": "^2.5.7",
+    "node-fetch": "2.6.1"
+  },
+  "dependencies": {
+    "@forge/api": "^2.6.1"
+  }
+}

package/src/__test__/errors.test.ts

@@ -0,0 +1,15 @@
+import { APIError } from '../migration';
+
+describe('APIError', () => {
+  describe('forStatus', () => {
+    it.each([
+      [400, 'Bad request'],
+      [401, 'Unauthorized'],
+      [403, 'Forbidden'],
+      [404, 'Not Found'],
+      [500, 'Internal server error']
+    ] as const)('should contain the correct error message for a code of %s', (status, message) => {
+      expect(APIError.forStatus(status, message).message).toEqual(message);
+    });
+  });
+});