@squiz/dxp-cli-next 5.26.0-develop.4 → 5.26.0

package/lib/migration/next/next.spec.js

@@ -0,0 +1,186 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const nock_1 = __importDefault(require("nock"));
+const next_1 = __importDefault(require("./next"));
+const utils = __importStar(require("../utils/common"));
+const ApplicationStore = __importStar(require("../../ApplicationStore"));
+const nextStageModule = __importStar(require("../utils/nextStage"));
+jest.mock('../utils/common');
+jest.mock('../utils/nextStage');
+jest.mock('../../ApplicationStore');
+const mockUtils = utils;
+const mockNextStage = nextStageModule;
+const mockApplicationStore = ApplicationStore;
+describe('nextStageCommand', () => {
+    let logSpy;
+    let mockNextStageResponse;
+    beforeEach(() => {
+        nock_1.default.cleanAll();
+        jest.clearAllMocks();
+        jest.resetAllMocks();
+        logSpy = jest.spyOn(console, 'log').mockImplementation(() => { });
+        mockApplicationStore.getApplicationFile.mockResolvedValue('session-cookie');
+        mockUtils.throwErrorIfNotLoggedIn.mockResolvedValue(undefined);
+        mockNextStageResponse = {
+            message: 'Successfully started next stage',
+        };
+        mockNextStage.nextStage.mockResolvedValue(mockNextStageResponse);
+    });
+    afterEach(() => {
+        logSpy.mockRestore();
+    });
+    describe('successful next stage execution', () => {
+        it('should execute next stage successfully with required options', () => __awaiter(void 0, void 0, void 0, function* () {
+            const program = (0, next_1.default)();
+            yield program.parseAsync([
+                'node',
+                'dxp-cli',
+                'next',
+                '--migration-id',
+                'migration-123',
+                '--asset-id',
+                'asset-456',
+            ]);
+            expect(mockUtils.throwErrorIfNotLoggedIn).toHaveBeenCalledWith(program);
+            expect(mockNextStage.nextStage).toHaveBeenCalledWith({
+                migrationId: 'migration-123',
+                assetId: 'asset-456',
+            });
+            expect(mockNextStage.nextStage).toHaveBeenCalledTimes(1);
+            expect(mockUtils.handleCommandError).not.toHaveBeenCalled();
+        }));
+        it('should execute next stage with tenant option', () => __awaiter(void 0, void 0, void 0, function* () {
+            const program = (0, next_1.default)();
+            yield program.parseAsync([
+                'node',
+                'dxp-cli',
+                'next',
+                '--migration-id',
+                'migration-123',
+                '--asset-id',
+                'asset-456',
+                '--tenant',
+                'test-tenant',
+            ]);
+            expect(mockNextStage.nextStage).toHaveBeenCalledWith({
+                migrationId: 'migration-123',
+                assetId: 'asset-456',
+                tenant: 'test-tenant',
+            });
+        }));
+    });
+    describe('error scenarios', () => {
+        it('should handle nextStage API error', () => __awaiter(void 0, void 0, void 0, function* () {
+            const apiError = new Error('Failed to start next stage');
+            mockNextStage.nextStage.mockRejectedValue(apiError);
+            mockUtils.handleCommandError.mockImplementation(() => { });
+            const program = (0, next_1.default)();
+            yield program.parseAsync([
+                'node',
+                'dxp-cli',
+                'next',
+                '--migration-id',
+                'migration-123',
+                '--asset-id',
+                'asset-456',
+            ]);
+            expect(mockUtils.handleCommandError).toHaveBeenCalledWith(program, apiError);
+        }));
+        it('should handle network error', () => __awaiter(void 0, void 0, void 0, function* () {
+            const networkError = new Error('Network connection failed');
+            mockNextStage.nextStage.mockRejectedValue(networkError);
+            mockUtils.handleCommandError.mockImplementation(() => { });
+            const program = (0, next_1.default)();
+            yield program.parseAsync([
+                'node',
+                'dxp-cli',
+                'next',
+                '--migration-id',
+                'migration-123',
+                '--asset-id',
+                'asset-456',
+            ]);
+            expect(mockUtils.handleCommandError).toHaveBeenCalledWith(program, networkError);
+        }));
+    });
+    describe('required options validation', () => {
+        it('should require migration-id option', () => {
+            const program = (0, next_1.default)().exitOverride();
+            expect(() => {
+                program.parse(['node', 'dxp-cli', 'next', '--asset-id', 'asset-456']);
+            }).toThrow();
+        });
+        it('should require asset-id option', () => {
+            const program = (0, next_1.default)().exitOverride();
+            expect(() => {
+                program.parse([
+                    'node',
+                    'dxp-cli',
+                    'next',
+                    '--migration-id',
+                    'migration-123',
+                ]);
+            }).toThrow();
+        });
+    });
+    describe('command configuration', () => {
+        it('should have correct command name and description', () => {
+            const program = (0, next_1.default)();
+            expect(program.name()).toBe('next');
+            expect(program.description()).toBe('Triggers the next step of the migration, which will be decided based on the current asset migration stage and status');
+        });
+        it('should parse options correctly', () => {
+            const program = (0, next_1.default)();
+            program.parse([
+                'node',
+                'dxp-cli',
+                'next',
+                '--migration-id',
+                'migration-123',
+                '--asset-id',
+                'asset-456',
+                '--tenant',
+                'test-tenant',
+            ]);
+            const opts = program.opts();
+            expect(opts.migrationId).toBe('migration-123');
+            expect(opts.assetId).toBe('asset-456');
+            expect(opts.tenant).toBe('test-tenant');
+        });
+    });
+});

package/lib/migration/revert/revert.js

@@ -16,13 +16,14 @@ const chalk_1 = __importDefault(require("chalk"));
 const commander_1 = require("commander");
 const utils_1 = require("../utils");
 const ora_1 = __importDefault(require("ora"));
+const options_1 = require("../utils/options");
 const revertMigrationCommand = () => {
     const revertCommand = new commander_1.Command('revert')
         .name('revert')
         .description('Revert the current stage of a migration using the AI Page migration service')
-        .addOption(new commander_1.Option('--migration-id <string>', 'The ID of the migration to revert').makeOptionMandatory())
-        .addOption(new commander_1.Option('--asset-id <string>', 'The ID of the asset to revert the migration for'))
-        .addOption(new commander_1.Option('-t, --tenant <string>', 'Tenant ID to run against. If not provided will use configured tenant from login'))
+        .addOption((0, options_1.getParamOption)(options_1.OptionName.MIGRATION_ID))
+        .addOption((0, options_1.getParamOption)(options_1.OptionName.ASSET_ID, false))
+        .addOption((0, options_1.getParamOption)(options_1.OptionName.TENANT, false))
         .configureOutput({
         outputError(str, write) {
             write(chalk_1.default.red(str));
@@ -40,9 +41,7 @@ const revertMigrationCommand = () => {
             (0, utils_1.handleCommandError)(revertCommand, error);
         }
     }));
-    if (process.env.ENABLE_OVERRIDE_MIGRATION_URL === 'true') {
-        revertCommand.addOption(new commander_1.Option('-ou, --overrideUrl <string>', 'Developer option to override the entire migration url with a custom value'));
-    }
+    (0, options_1.addOverrideUrlOption)(revertCommand);
     return revertCommand;
 };
 exports.default = revertMigrationCommand;

package/lib/migration/revert/revert.spec.js

@@ -36,10 +36,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const revert_1 = __importDefault(require("./revert"));
-const utils = __importStar(require("../utils"));
-jest.mock('../utils');
+const utils = __importStar(require("../utils/common"));
+const revertMigration = __importStar(require("../utils/revertMigration"));
+jest.mock('../utils/common');
+jest.mock('../utils/revertMigration');
 jest.mock('../../ApplicationStore');
 const mockUtils = utils;
+const mockRevertMigration = revertMigration;
 describe('revertMigrationCommand', () => {
     beforeEach(() => {
         jest.clearAllMocks();
@@ -76,7 +79,7 @@ describe('revertMigrationCommand', () => {
     describe('command execution', () => {
         it('should revert migration successfully with required options', () => __awaiter(void 0, void 0, void 0, function* () {
             const mockResponse = { message: 'Migration reverted successfully' };
-            mockUtils.revertMigration.mockResolvedValue(mockResponse);
+            mockRevertMigration.revertMigration.mockResolvedValue(mockResponse);
             mockUtils.throwErrorIfNotLoggedIn.mockResolvedValue();
             const program = (0, revert_1.default)();
             yield program.parseAsync([
@@ -90,7 +93,7 @@ describe('revertMigrationCommand', () => {
                 'asset-456',
             ]);
             expect(mockUtils.throwErrorIfNotLoggedIn).toHaveBeenCalledWith(program);
-            expect(mockUtils.revertMigration).toHaveBeenCalledWith({
+            expect(mockRevertMigration.revertMigration).toHaveBeenCalledWith({
                 migrationId: 'migration-123',
                 assetId: 'asset-456',
             });
@@ -98,7 +101,7 @@ describe('revertMigrationCommand', () => {
         }));
         it('should revert migration with tenant option', () => __awaiter(void 0, void 0, void 0, function* () {
             const mockResponse = { message: 'Migration reverted successfully' };
-            mockUtils.revertMigration.mockResolvedValue(mockResponse);
+            mockRevertMigration.revertMigration.mockResolvedValue(mockResponse);
             mockUtils.throwErrorIfNotLoggedIn.mockResolvedValue();
             const program = (0, revert_1.default)();
             yield program.parseAsync([
@@ -113,7 +116,7 @@ describe('revertMigrationCommand', () => {
                 '--tenant',
                 'test-tenant',
             ]);
-            expect(mockUtils.revertMigration).toHaveBeenCalledWith({
+            expect(mockRevertMigration.revertMigration).toHaveBeenCalledWith({
                 migrationId: 'migration-123',
                 assetId: 'asset-456',
                 tenant: 'test-tenant',
@@ -121,7 +124,7 @@ describe('revertMigrationCommand', () => {
         }));
         it('should handle revert migration error', () => __awaiter(void 0, void 0, void 0, function* () {
             const error = new Error('Revert failed');
-            mockUtils.revertMigration.mockRejectedValue(error);
+            mockRevertMigration.revertMigration.mockRejectedValue(error);
             mockUtils.throwErrorIfNotLoggedIn.mockResolvedValue();
             const program = (0, revert_1.default)();
             yield program.parseAsync([

package/lib/migration/settings/{setMigrationSettings.js → settings.js}

@@ -16,14 +16,15 @@ const chalk_1 = __importDefault(require("chalk"));
 const commander_1 = require("commander");
 const utils_1 = require("../utils");
 const ora_1 = __importDefault(require("ora"));
+const options_1 = require("../utils/options");
 const setMigrationSettingsCommand = () => {
     const settingsCommand = new commander_1.Command('settings')
         .name('settings')
         .description('Set settings for the migration service')
-        .addOption(new commander_1.Option('--matrix-url <string>', 'The URL of the Matrix instance').makeOptionMandatory())
-        .addOption(new commander_1.Option('--matrix-identifier <string>', 'The component service identifier used by the asset and components being migrated').makeOptionMandatory())
-        .addOption(new commander_1.Option('--matrix-key <string>', 'The Asset Management API key for the Migrator API to interact with Matrix API').makeOptionMandatory())
-        .addOption(new commander_1.Option('-t, --tenant <string>', 'Tenant ID to run against. If not provided will use configured tenant from login'))
+        .addOption((0, utils_1.getParamOption)(utils_1.OptionName.MATRIX_URL))
+        .addOption((0, utils_1.getParamOption)(utils_1.OptionName.MATRIX_IDENTIFIER))
+        .addOption((0, utils_1.getParamOption)(utils_1.OptionName.MATRIX_KEY))
+        .addOption((0, utils_1.getParamOption)(utils_1.OptionName.TENANT, false))
         .configureOutput({
         outputError(str, write) {
             write(chalk_1.default.red(str));
@@ -33,7 +34,7 @@ const setMigrationSettingsCommand = () => {
         const spinner = (0, ora_1.default)('Setting migration configuration...').start();
         yield (0, utils_1.throwErrorIfNotLoggedIn)(settingsCommand);
         try {
-            const response = yield (0, utils_1.setMigrationSetting)(options);
+            const response = yield (0, utils_1.setMigrationSettings)(options);
             spinner.succeed(`Migration settings updated: ${JSON.stringify(response, null, 2)}`);
         }
         catch (error) {
@@ -41,9 +42,7 @@ const setMigrationSettingsCommand = () => {
             (0, utils_1.handleCommandError)(settingsCommand, error);
         }
     }));
-    if (process.env.ENABLE_OVERRIDE_MIGRATION_URL === 'true') {
-        settingsCommand.addOption(new commander_1.Option('-ou, --overrideUrl <string>', 'Developer option to override the entire migration url with a custom value'));
-    }
+    (0, options_1.addOverrideUrlOption)(settingsCommand);
     return settingsCommand;
 };
 exports.default = setMigrationSettingsCommand;

package/lib/migration/settings/{setMigrationSettings.spec.js → settings.spec.js}

@@ -35,13 +35,21 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const nock_1 = __importDefault(require("nock"));
-const setMigrationSettings_1 = __importDefault(require("./setMigrationSettings"));
-const utils = __importStar(require("../utils"));
+const settings_1 = __importDefault(require("./settings"));
+const Utils = __importStar(require("../utils/common"));
+const setMigrationSettings = __importStar(require("../utils/setMigrationSettings"));
 const ApplicationStore = __importStar(require("../../ApplicationStore"));
-jest.mock('../utils');
+const nock_1 = __importDefault(require("nock"));
+jest.mock('../../ApplicationConfig');
 jest.mock('../../ApplicationStore');
-const mockUtils = utils;
+jest.mock('../../ApiService');
+jest.mock('../utils/common');
+jest.mock('../utils/setMigrationSettings');
+// Mock global fetch
+const mockFetch = jest.fn();
+global.fetch = mockFetch;
+const mockSetMigrationSettings = setMigrationSettings;
+const mockUtils = Utils;
 const mockApplicationStore = ApplicationStore;
 describe('setMigrationSettingsCommand', () => {
     let logSpy;
@@ -58,14 +66,11 @@ describe('setMigrationSettingsCommand', () => {
             matrixIdentifier: '@user:matrix.example.com',
             matrixKey: '***********123',
         };
-        mockUtils.setMigrationSetting.mockResolvedValue(mockSetMigrationSettingResponse);
-    });
-    afterEach(() => {
-        logSpy.mockRestore();
+        mockSetMigrationSettings.setMigrationSettings.mockResolvedValue(mockSetMigrationSettingResponse);
     });
     describe('successful migration setting update', () => {
         it('should set migration settings successfully with required options', () => __awaiter(void 0, void 0, void 0, function* () {
-            const program = (0, setMigrationSettings_1.default)();
+            const program = (0, settings_1.default)();
             yield program.parseAsync([
                 'node',
                 'dxp-cli',
@@ -79,16 +84,16 @@ describe('setMigrationSettingsCommand', () => {
                 'secret-key-123',
             ]);
             expect(mockUtils.throwErrorIfNotLoggedIn).toHaveBeenCalledWith(program);
-            expect(mockUtils.setMigrationSetting).toHaveBeenCalledWith({
+            expect(mockSetMigrationSettings.setMigrationSettings).toHaveBeenCalledWith({
                 matrixUrl: 'https://matrix.example.com',
                 matrixIdentifier: '@user:matrix.example.com',
                 matrixKey: 'secret-key-123',
             });
-            expect(mockUtils.setMigrationSetting).toHaveBeenCalledTimes(1);
+            expect(mockSetMigrationSettings.setMigrationSettings).toHaveBeenCalledTimes(1);
             expect(mockUtils.handleCommandError).not.toHaveBeenCalled();
         }));
         it('should set migration settings with tenant option', () => __awaiter(void 0, void 0, void 0, function* () {
-            const program = (0, setMigrationSettings_1.default)();
+            const program = (0, settings_1.default)();
             yield program.parseAsync([
                 'node',
                 'dxp-cli',
@@ -103,7 +108,7 @@ describe('setMigrationSettingsCommand', () => {
                 '--tenant',
                 'test-tenant',
             ]);
-            expect(mockUtils.setMigrationSetting).toHaveBeenCalledWith({
+            expect(mockSetMigrationSettings.setMigrationSettings).toHaveBeenCalledWith({
                 matrixUrl: 'https://matrix.example.com',
                 matrixIdentifier: '@user:matrix.example.com',
                 matrixKey: 'secret-key-123',
@@ -113,7 +118,7 @@ describe('setMigrationSettingsCommand', () => {
         it('should set migration settings with override URL when environment variable is set', () => __awaiter(void 0, void 0, void 0, function* () {
             const originalEnv = process.env.ENABLE_OVERRIDE_MIGRATION_URL;
             process.env.ENABLE_OVERRIDE_MIGRATION_URL = 'true';
-            const program = (0, setMigrationSettings_1.default)();
+            const program = (0, settings_1.default)();
             yield program.parseAsync([
                 'node',
                 'dxp-cli',
@@ -128,7 +133,7 @@ describe('setMigrationSettingsCommand', () => {
                 '--overrideUrl',
                 'https://custom.migration.url',
             ]);
-            expect(mockUtils.setMigrationSetting).toHaveBeenCalledWith({
+            expect(mockSetMigrationSettings.setMigrationSettings).toHaveBeenCalledWith({
                 matrixUrl: 'https://matrix.example.com',
                 matrixIdentifier: '@user:matrix.example.com',
                 matrixKey: 'secret-key-123',
@@ -140,9 +145,9 @@ describe('setMigrationSettingsCommand', () => {
     describe('error scenarios', () => {
         it('should handle setMigrationSetting API error', () => __awaiter(void 0, void 0, void 0, function* () {
             const apiError = new Error('Settings update failed');
-            mockUtils.setMigrationSetting.mockRejectedValue(apiError);
+            mockSetMigrationSettings.setMigrationSettings.mockRejectedValue(apiError);
             mockUtils.handleCommandError.mockImplementation(() => { });
-            const program = (0, setMigrationSettings_1.default)();
+            const program = (0, settings_1.default)();
             yield program.parseAsync([
                 'node',
                 'dxp-cli',
@@ -159,9 +164,9 @@ describe('setMigrationSettingsCommand', () => {
         }));
         it('should handle network error', () => __awaiter(void 0, void 0, void 0, function* () {
             const networkError = new Error('Network connection failed');
-            mockUtils.setMigrationSetting.mockRejectedValue(networkError);
+            mockSetMigrationSettings.setMigrationSettings.mockRejectedValue(networkError);
             mockUtils.handleCommandError.mockImplementation(() => { });
-            const program = (0, setMigrationSettings_1.default)();
+            const program = (0, settings_1.default)();
             yield program.parseAsync([
                 'node',
                 'dxp-cli',
@@ -179,7 +184,7 @@ describe('setMigrationSettingsCommand', () => {
     });
     describe('required options validation', () => {
         it('should require matrixUrl option', () => {
-            const program = (0, setMigrationSettings_1.default)().exitOverride();
+            const program = (0, settings_1.default)().exitOverride();
             expect(() => {
                 program.parse([
                     'node',
@@ -194,7 +199,7 @@ describe('setMigrationSettingsCommand', () => {
             }).toThrow();
         });
         it('should require matrixIdentifier option', () => {
-            const program = (0, setMigrationSettings_1.default)().exitOverride();
+            const program = (0, settings_1.default)().exitOverride();
             expect(() => {
                 program.parse([
                     'node',
@@ -209,7 +214,7 @@ describe('setMigrationSettingsCommand', () => {
             }).toThrow();
         });
         it('should require matrixKey option', () => {
-            const program = (0, setMigrationSettings_1.default)().exitOverride();
+            const program = (0, settings_1.default)().exitOverride();
             expect(() => {
                 program.parse([
                     'node',
@@ -226,12 +231,12 @@ describe('setMigrationSettingsCommand', () => {
     });
     describe('command configuration', () => {
         it('should have correct command name and description', () => {
-            const program = (0, setMigrationSettings_1.default)();
+            const program = (0, settings_1.default)();
             expect(program.name()).toBe('settings');
             expect(program.description()).toBe('Set settings for the migration service');
         });
         it('should parse options correctly', () => {
-            const program = (0, setMigrationSettings_1.default)();
+            const program = (0, settings_1.default)();
             program.parse([
                 'node',
                 'dxp-cli',
@@ -253,7 +258,7 @@ describe('setMigrationSettingsCommand', () => {
             expect(opts.tenant).toBe('test-tenant');
         });
         it('should parse options with kebab-case to camelCase conversion', () => {
-            const program = (0, setMigrationSettings_1.default)();
+            const program = (0, settings_1.default)();
             program.parse([
                 'node',
                 'dxp-cli',
@@ -272,4 +277,7 @@ describe('setMigrationSettingsCommand', () => {
             expect(opts.matrixKey).toBe('secret-key-123');
         });
     });
+    afterEach(() => {
+        logSpy.mockRestore();
+    });
 });

package/lib/migration/types/common.types.d.ts

@@ -0,0 +1,19 @@
+export interface CommonCommandOptions {
+    tenant?: string;
+    overrideUrl?: string;
+}
+export interface AssetMigration {
+    migrationId: string;
+    assetId: string;
+    xmlFilePath: string;
+    matrixUrl: string;
+    previewAssetId: string;
+    previewPageAssetId?: string;
+    stage: string;
+    status: string;
+    stageDetails?: string;
+    created: number;
+    updated: number;
+    migrationIdAssetId: string;
+    componentsTarDownloadUrl?: string;
+}

package/lib/migration/types/createMigration.types.d.ts

@@ -0,0 +1,7 @@
+import { AssetMigration, CommonCommandOptions } from '.';
+export interface CreateMigrationOptions extends CommonCommandOptions, Pick<AssetMigration, 'assetId' | 'previewAssetId' | 'matrixUrl'> {
+}
+export interface CreateMigrationApiResponse {
+    assetMigration: AssetMigration;
+    uploadUrl: string;
+}

package/lib/migration/types/createMigration.types.js

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

package/lib/migration/types/getMigration.types.d.ts

@@ -0,0 +1,5 @@
+import { AssetMigration, CommonCommandOptions } from '.';
+export interface GetMigrationOptions extends CommonCommandOptions, Pick<AssetMigration, 'migrationId' | 'assetId'> {
+}
+export interface GetMigrationApiResponse extends AssetMigration {
+}

package/lib/migration/types/getMigration.types.js

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

package/lib/migration/types/index.d.ts

@@ -0,0 +1,6 @@
+export * from './common.types';
+export * from './createMigration.types';
+export * from './getMigration.types';
+export * from './nextStage.types';
+export * from './settings.types';
+export * from './revert.types';

package/lib/migration/types/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./common.types"), exports);
+__exportStar(require("./createMigration.types"), exports);
+__exportStar(require("./getMigration.types"), exports);
+__exportStar(require("./nextStage.types"), exports);
+__exportStar(require("./settings.types"), exports);
+__exportStar(require("./revert.types"), exports);

package/lib/migration/types/nextStage.types.d.ts

@@ -0,0 +1,6 @@
+import { AssetMigration, CommonCommandOptions } from '.';
+export interface NextStageOptions extends CommonCommandOptions, Pick<AssetMigration, 'migrationId' | 'assetId'> {
+}
+export interface NextStageApiResponse {
+    message: string;
+}

package/lib/migration/types/nextStage.types.js

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

package/lib/migration/types/revert.types.d.ts

@@ -0,0 +1,6 @@
+import { AssetMigration, CommonCommandOptions } from '.';
+export interface RevertMigrationOptions extends CommonCommandOptions, Pick<AssetMigration, 'migrationId' | 'assetId'> {
+}
+export interface RevertMigrationApiResponse {
+    message: string;
+}

package/lib/migration/types/revert.types.js

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

package/lib/migration/types/settings.types.d.ts

@@ -0,0 +1,10 @@
+import { CommonCommandOptions } from '.';
+export interface MatrixIdentifierSchema {
+    matrixUrl: string;
+    matrixIdentifier: string;
+    matrixKey: string;
+}
+export interface SetMigrationSettingOptions extends CommonCommandOptions, MatrixIdentifierSchema {
+}
+export interface SetMigrationSettingApiResponse extends MatrixIdentifierSchema {
+}

package/lib/migration/types/settings.types.js

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

package/lib/migration/utils/common.d.ts

@@ -0,0 +1,32 @@
+import { Command } from 'commander';
+/**
+ * The purpose of this file is to provide utilities in common
+ * such as functions that can be reused across the migration service.
+ */
+/**
+ * Handles errors from the migration service.
+ * @param command - The command that is being executed.
+ * @param error - The error that occurred.
+ */
+export declare function handleCommandError(command: Command, error: Error): void;
+/**
+ * Throws an error if the user is not logged in.
+ * @param command - The command that is being executed.
+ */
+export declare function throwErrorIfNotLoggedIn(command: Command): Promise<void>;
+/**
+ * Builds the migration URL.
+ * @param tenantID - The tenant ID.
+ * @param overrideUrl - The override URL.
+ * @returns The migration URL.
+ */
+export declare function buildMigrationUrl(tenantID?: string, overrideUrl?: string, baseDomain?: 'migrations' | 'settings'): Promise<string>;
+/**
+ * Validates the status of the axios request.
+ * @param status - The status of the axios request.
+ * @returns True if the status is less than 400, false otherwise.
+ */
+export declare function validateAxiosStatus(status: number): boolean;
+export declare function getMigrationHeaders(tenantID?: string, isJson?: boolean): Promise<Record<string, string>>;
+export declare function uploadFileToS3(uploadUrl: string, filePath: string, tenantID?: string): Promise<string>;
+export declare function redactKey(key: string, visibleChars?: number): string;