@forge/migrations 0.1.0 → 0.1.1

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @forge/migrations
 
+## 0.1.1
+
+### Patch Changes
+
+- cf5eb2a: Added .npmignore file to forge-migrations package
+- Updated dependencies [b3ee297]
+  - @forge/api@2.7.0
+
+## 0.1.1-next.1
+
+### Patch Changes
+
+- cf5eb2af: Added .npmignore file to forge-migrations package
+
+## 0.1.1-next.0
+
+### Patch Changes
+
+- Updated dependencies [b3ee2973]
+  - @forge/api@2.7.0-next.0
+
 ## 0.1.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/migrations",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "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"
   }
 }

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

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

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

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

package/out/__test__/errors.test.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const errors_1 = require("../migration/errors");
-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(errors_1.APIError.forStatus(status, message).message).toEqual(message);
-        });
-    });
-});

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

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

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

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

package/out/__test__/migration.test.js

@@ -1,221 +0,0 @@
-"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"));
-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(errors_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(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);
-            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(errors_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(errors_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(errors_1.APIError.forStatus(403, 'Forbidden'));
-        });
-    });
-});

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

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

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

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

@@ -1,144 +0,0 @@
-"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/src/__test__/errors.test.ts

@@ -1,15 +0,0 @@
-import { APIError } from '../migration/errors';
-
-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);
-    });
-  });
-});