@squiz/dxp-cli-next 5.27.0-develop.1 → 5.27.0-develop.2

package/lib/migration/next/next.js

@@ -8,6 +8,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -23,6 +34,7 @@ const nextStageCommand = () => {
         .addOption((0, utils_1.getParamOption)(utils_1.OptionName.MIGRATION_ID))
         .addOption((0, utils_1.getParamOption)(utils_1.OptionName.ASSET_ID))
         .addOption((0, utils_1.getParamOption)(utils_1.OptionName.TENANT, false))
+        .addOption((0, utils_1.getParamOption)(utils_1.OptionName.STAGE_OPTIONS, false))
         .configureOutput({
         outputError(str, write) {
             write(chalk_1.default.red(str));
@@ -32,7 +44,9 @@ const nextStageCommand = () => {
         yield (0, utils_1.throwErrorIfNotLoggedIn)(nextCommand);
         const spinner = (0, ora_1.default)('Starting next stage').start();
         try {
-            const response = yield (0, utils_1.nextStage)(options);
+            const { stageOptions: stageOptionsPath } = options, otherOptions = __rest(options, ["stageOptions"]);
+            const stageOptions = (0, utils_1.loadStageOptionsFromFile)(stageOptionsPath);
+            const response = yield (0, utils_1.nextStage)(Object.assign(Object.assign({}, otherOptions), (stageOptions && { stageOptions })));
             spinner.succeed(response.message);
         }
         catch (error) {

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

@@ -103,6 +103,29 @@ describe('nextStageCommand', () => {
                 tenant: 'test-tenant',
             });
         }));
+        it('should execute next stage with stageOptions from JSON file', () => __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',
+                '--stage-options',
+                './src/__tests__/migration/stageOptionsInput.json',
+            ]);
+            expect(mockNextStage.nextStage).toHaveBeenCalledWith({
+                migrationId: 'migration-123',
+                assetId: 'asset-456',
+                stageOptions: {
+                    'cct-to-cmp': {
+                        overwriteSuccessful: false,
+                    },
+                },
+            });
+        }));
     });
     describe('error scenarios', () => {
         it('should handle nextStage API error', () => __awaiter(void 0, void 0, void 0, function* () {

package/lib/migration/settings/settings.js

@@ -8,6 +8,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -26,17 +37,19 @@ const setMigrationSettingsCommand = () => {
         .addOption((0, utils_1.getParamOption)(utils_1.OptionName.MATRIX_KEY))
         .addOption((0, utils_1.getParamOption)(utils_1.OptionName.CONTENT_API_KEY))
         .addOption((0, utils_1.getParamOption)(utils_1.OptionName.TENANT, false))
+        .addOption((0, utils_1.getParamOption)(utils_1.OptionName.STAGE_OPTIONS, false))
         .configureOutput({
         outputError(str, write) {
             write(chalk_1.default.red(str));
         },
     })
         .action((options) => __awaiter(void 0, void 0, void 0, function* () {
-        console.log('options', options);
         const spinner = (0, ora_1.default)('Setting migration configuration...').start();
         yield (0, utils_1.throwErrorIfNotLoggedIn)(settingsCommand);
         try {
-            const response = yield (0, utils_1.setMigrationSettings)(options);
+            const { stageOptions: stageOptionsPath } = options, otherOptions = __rest(options, ["stageOptions"]);
+            const stageOptions = (0, utils_1.loadStageOptionsFromFile)(stageOptionsPath);
+            const response = yield (0, utils_1.setMigrationSettings)(Object.assign(Object.assign({}, otherOptions), (stageOptions && { stageOptions })));
             spinner.succeed(`Migration settings updated: ${JSON.stringify(response, null, 2)}`);
         }
         catch (error) {

package/lib/migration/settings/settings.spec.js

@@ -122,6 +122,36 @@ describe('setMigrationSettingsCommand', () => {
                 contentApiKey: 'content-api-key-456',
             });
         }));
+        it('should set migration settings with stageOptions from JSON file', () => __awaiter(void 0, void 0, void 0, function* () {
+            const program = (0, settings_1.default)();
+            yield program.parseAsync([
+                'node',
+                'dxp-cli',
+                'migration',
+                'settings',
+                '--matrix-url',
+                'https://matrix.example.com',
+                '--matrix-identifier',
+                '@user:matrix.example.com',
+                '--matrix-key',
+                'secret-key-123',
+                '--content-api-key',
+                'content-api-key-456',
+                '--stage-options',
+                './src/__tests__/migration/stageOptionsInput.json',
+            ]);
+            expect(mockSetMigrationSettings.setMigrationSettings).toHaveBeenCalledWith({
+                matrixUrl: 'https://matrix.example.com',
+                matrixIdentifier: '@user:matrix.example.com',
+                matrixKey: 'secret-key-123',
+                contentApiKey: 'content-api-key-456',
+                stageOptions: {
+                    'cct-to-cmp': {
+                        overwriteSuccessful: false,
+                    },
+                },
+            });
+        }));
         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';

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

@@ -1,5 +1,9 @@
 import { AssetMigration, CommonCommandOptions } from '.';
 export interface NextStageOptions extends CommonCommandOptions, Pick<AssetMigration, 'migrationId' | 'assetId'> {
+    stageOptions?: string;
+}
+export interface NextStageParsedOptions extends Omit<NextStageOptions, 'stageOptions'> {
+    stageOptions?: Record<string, any>;
 }
 export interface NextStageApiResponse {
     message: string;

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

@@ -6,6 +6,10 @@ export interface MatrixIdentifierSchema {
     contentApiKey: string;
 }
 export interface SetMigrationSettingOptions extends CommonCommandOptions, MatrixIdentifierSchema {
+    stageOptions?: string;
+}
+export interface SetMigrationSettingParsedOptions extends Omit<SetMigrationSettingOptions, 'stageOptions'>, MatrixIdentifierSchema {
+    stageOptions?: Record<string, any>;
 }
 export interface SetMigrationSettingApiResponse extends MatrixIdentifierSchema {
 }

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

@@ -5,3 +5,4 @@ export * from './getMigration';
 export * from './nextStage';
 export * from './setMigrationSettings';
 export * from './revertMigration';
+export * from './loadStageOptionsFromFile';

package/lib/migration/utils/index.js

@@ -21,3 +21,4 @@ __exportStar(require("./getMigration"), exports);
 __exportStar(require("./nextStage"), exports);
 __exportStar(require("./setMigrationSettings"), exports);
 __exportStar(require("./revertMigration"), exports);
+__exportStar(require("./loadStageOptionsFromFile"), exports);

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

@@ -0,0 +1 @@
+export declare const loadStageOptionsFromFile: (filePath?: string) => any;

package/lib/migration/utils/loadStageOptionsFromFile.js

@@ -0,0 +1,32 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadStageOptionsFromFile = void 0;
+const fs_1 = __importDefault(require("fs"));
+const loadStageOptionsFromFile = (filePath) => {
+    if (!filePath) {
+        return undefined;
+    }
+    try {
+        if (!fs_1.default.existsSync(filePath)) {
+            throw new Error(`Stage options file not found: ${filePath}`);
+        }
+        const fileContent = fs_1.default.readFileSync(filePath, 'utf8');
+        const stageOptions = JSON.parse(fileContent);
+        if (typeof stageOptions !== 'object' ||
+            stageOptions === null ||
+            Array.isArray(stageOptions)) {
+            throw new Error('Stage options file must contain a valid JSON object');
+        }
+        return stageOptions;
+    }
+    catch (error) {
+        if (error instanceof Error) {
+            throw new Error(`Failed to load stage options from file: ${error.message}`);
+        }
+        throw new Error(`Failed to load stage options from file: ${error}`);
+    }
+};
+exports.loadStageOptionsFromFile = loadStageOptionsFromFile;

package/lib/migration/utils/loadStageOptionsFromFile.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/migration/utils/loadStageOptionsFromFile.spec.js

@@ -0,0 +1,77 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+const loadStageOptionsFromFile_1 = require("./loadStageOptionsFromFile");
+jest.mock('fs');
+const mockFs = fs_1.default;
+describe('loadStageOptionsFromFile', () => {
+    beforeEach(() => {
+        jest.clearAllMocks();
+    });
+    it('should return undefined when no file path is provided', () => {
+        const result = (0, loadStageOptionsFromFile_1.loadStageOptionsFromFile)();
+        expect(result).toBeUndefined();
+    });
+    it('should load and parse valid JSON file', () => {
+        const mockFilePath = '/test/path/options.json';
+        const mockJsonContent = '{"option1": "value1", "option2": "value2"}';
+        const expectedResult = { option1: 'value1', option2: 'value2' };
+        mockFs.existsSync.mockReturnValue(true);
+        mockFs.readFileSync.mockReturnValue(mockJsonContent);
+        const result = (0, loadStageOptionsFromFile_1.loadStageOptionsFromFile)(mockFilePath);
+        expect(mockFs.existsSync).toHaveBeenCalledWith(mockFilePath);
+        expect(mockFs.readFileSync).toHaveBeenCalledWith(mockFilePath, 'utf8');
+        expect(result).toEqual(expectedResult);
+    });
+    it('should throw error when file does not exist', () => {
+        const mockFilePath = '/test/path/nonexistent.json';
+        mockFs.existsSync.mockReturnValue(false);
+        expect(() => (0, loadStageOptionsFromFile_1.loadStageOptionsFromFile)(mockFilePath)).toThrow(`Stage options file not found: ${mockFilePath}`);
+    });
+    it('should throw error when JSON is invalid', () => {
+        const mockFilePath = '/test/path/invalid.json';
+        const invalidJson = '{"invalid": json}';
+        mockFs.existsSync.mockReturnValue(true);
+        mockFs.readFileSync.mockReturnValue(invalidJson);
+        expect(() => (0, loadStageOptionsFromFile_1.loadStageOptionsFromFile)(mockFilePath)).toThrow('Failed to load stage options from file:');
+    });
+    it('should throw error when JSON is not an object', () => {
+        const mockFilePath = '/test/path/array.json';
+        const arrayJson = '["item1", "item2"]';
+        mockFs.existsSync.mockReturnValue(true);
+        mockFs.readFileSync.mockReturnValue(arrayJson);
+        expect(() => (0, loadStageOptionsFromFile_1.loadStageOptionsFromFile)(mockFilePath)).toThrow('Stage options file must contain a valid JSON object');
+    });
+    it('should throw error when JSON is null', () => {
+        const mockFilePath = '/test/path/null.json';
+        const nullJson = 'null';
+        mockFs.existsSync.mockReturnValue(true);
+        mockFs.readFileSync.mockReturnValue(nullJson);
+        expect(() => (0, loadStageOptionsFromFile_1.loadStageOptionsFromFile)(mockFilePath)).toThrow('Stage options file must contain a valid JSON object');
+    });
+    it('should handle complex nested objects', () => {
+        const mockFilePath = '/test/path/complex.json';
+        const complexJson = JSON.stringify({
+            option1: 'value1',
+            nestedOption: {
+                subOption1: 'subValue1',
+                subOption2: 'subValue2',
+            },
+            arrayOption: ['item1', 'item2'],
+        });
+        mockFs.existsSync.mockReturnValue(true);
+        mockFs.readFileSync.mockReturnValue(complexJson);
+        const result = (0, loadStageOptionsFromFile_1.loadStageOptionsFromFile)(mockFilePath);
+        expect(result).toEqual({
+            option1: 'value1',
+            nestedOption: {
+                subOption1: 'subValue1',
+                subOption2: 'subValue2',
+            },
+            arrayOption: ['item1', 'item2'],
+        });
+    });
+});

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

@@ -1,2 +1,2 @@
-import { NextStageApiResponse, NextStageOptions } from '../types';
-export declare function nextStage(options: NextStageOptions): Promise<NextStageApiResponse>;
+import { NextStageApiResponse, NextStageParsedOptions } from '../types';
+export declare function nextStage(options: NextStageParsedOptions): Promise<NextStageApiResponse>;

package/lib/migration/utils/nextStage.js

@@ -19,7 +19,8 @@ function nextStage(options) {
         });
         const migrationUrl = yield (0, _1.buildMigrationUrl)(options.tenant, options.overrideUrl);
         try {
-            const response = yield apiService.client.post(`${migrationUrl}/${options.migrationId}/assets/${options.assetId}/next`, {}, {
+            const payload = Object.assign({}, (options.stageOptions && { stageOptions: options.stageOptions }));
+            const response = yield apiService.client.post(`${migrationUrl}/${options.migrationId}/assets/${options.assetId}/next`, payload, {
                 headers: yield (0, _1.getMigrationHeaders)(options.tenant),
             });
             if (response.status !== 202) {

package/lib/migration/utils/nextStage.spec.js

@@ -97,7 +97,7 @@ describe('nextStage', () => {
             data: {},
         };
         mockApiServiceInstance.client.post.mockResolvedValue(mockResponse);
-        yield expect((0, nextStage_1.nextStage)(mockOptions)).rejects.toThrow('Invalid response format from next stage');
+        yield expect((0, nextStage_1.nextStage)(Object.assign(Object.assign({}, mockOptions), { stageOptions: {} }))).rejects.toThrow('Invalid response format from next stage');
     }));
     it('handles API service errors', () => __awaiter(void 0, void 0, void 0, function* () {
         const error = new Error('Network error');

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

@@ -7,7 +7,8 @@ export declare enum OptionName {
     MIGRATION_ID = "migration-id",
     MATRIX_IDENTIFIER = "matrix-identifier",
     MATRIX_KEY = "matrix-key",
-    CONTENT_API_KEY = "content-api-key"
+    CONTENT_API_KEY = "content-api-key",
+    STAGE_OPTIONS = "stage-options"
 }
 export declare const getParamOption: (param: OptionName, makeOptionMandatory?: boolean) => Option;
 export declare const addOverrideUrlOption: (command: Command) => void;

package/lib/migration/utils/options.js

@@ -12,6 +12,7 @@ var OptionName;
     OptionName["MATRIX_IDENTIFIER"] = "matrix-identifier";
     OptionName["MATRIX_KEY"] = "matrix-key";
     OptionName["CONTENT_API_KEY"] = "content-api-key";
+    OptionName["STAGE_OPTIONS"] = "stage-options";
 })(OptionName = exports.OptionName || (exports.OptionName = {}));
 const params = new Map([
     [
@@ -70,6 +71,13 @@ const params = new Map([
             description: 'The Content API key for the Migrator API to interact with Content API',
         },
     ],
+    [
+        OptionName.STAGE_OPTIONS,
+        {
+            flags: '--stage-options <path>',
+            description: 'Path to a JSON file containing stage options',
+        },
+    ],
 ]);
 const getParamOption = (param, makeOptionMandatory = true) => {
     const paramInfo = params.get(param);

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

@@ -1,2 +1,2 @@
-import { SetMigrationSettingOptions, SetMigrationSettingApiResponse } from '../types';
-export declare function setMigrationSettings(options: SetMigrationSettingOptions): Promise<SetMigrationSettingApiResponse>;
+import { SetMigrationSettingParsedOptions, SetMigrationSettingApiResponse } from '../types';
+export declare function setMigrationSettings(options: SetMigrationSettingParsedOptions): Promise<SetMigrationSettingApiResponse>;

package/lib/migration/utils/setMigrationSettings.js

@@ -19,13 +19,7 @@ function setMigrationSettings(options) {
         });
         const migrationUrl = yield (0, _1.buildMigrationUrl)(options.tenant, options.overrideUrl, 'settings');
         try {
-            const payload = {
-                matrixUrl: options.matrixUrl,
-                matrixIdentifier: options.matrixIdentifier,
-                matrixKey: options.matrixKey,
-                contentApiKey: options.contentApiKey,
-            };
-            console.log('payload', payload);
+            const payload = Object.assign({ matrixUrl: options.matrixUrl, matrixIdentifier: options.matrixIdentifier, matrixKey: options.matrixKey, contentApiKey: options.contentApiKey }, (options.stageOptions && { stageOptions: options.stageOptions }));
             const response = yield apiService.client.post(migrationUrl, payload, {
                 headers: yield (0, _1.getMigrationHeaders)(options.tenant),
             });

package/lib/migration/utils/setMigrationSettings.spec.js

@@ -68,7 +68,7 @@ describe('setMigrationSettings', () => {
             },
         };
         mockApiServiceInstance.client.post.mockResolvedValue(mockResponse);
-        const result = yield (0, setMigrationSettings_1.setMigrationSettings)(mockOptions);
+        const result = yield (0, setMigrationSettings_1.setMigrationSettings)(Object.assign(Object.assign({}, mockOptions), { stageOptions: {} }));
         expect(result).toEqual({
             matrixUrl: 'https://matrix.example.com',
             matrixIdentifier: 'test-identifier',
@@ -82,6 +82,7 @@ describe('setMigrationSettings', () => {
             matrixIdentifier: 'test-identifier',
             matrixKey: 'test-key-123',
             contentApiKey: 'test-content-api-key-456',
+            stageOptions: {},
         }, {
             headers: {
                 'Content-Type': 'application/json',
@@ -102,7 +103,7 @@ describe('setMigrationSettings', () => {
             },
         };
         mockApiServiceInstance.client.post.mockResolvedValue(mockResponse);
-        yield (0, setMigrationSettings_1.setMigrationSettings)(optionsWithOverride);
+        yield (0, setMigrationSettings_1.setMigrationSettings)(Object.assign(Object.assign({}, optionsWithOverride), { stageOptions: {} }));
         expect(mockBuildMigrationUrl).toHaveBeenCalledWith('test-tenant', 'https://custom.migration.url', 'settings');
     }));
     it('should handle non-success status codes', () => __awaiter(void 0, void 0, void 0, function* () {
@@ -111,7 +112,7 @@ describe('setMigrationSettings', () => {
             data: {},
         };
         mockApiServiceInstance.client.post.mockResolvedValue(mockResponse);
-        yield expect((0, setMigrationSettings_1.setMigrationSettings)(mockOptions)).rejects.toThrow('Migration settings update failed with status: 400');
+        yield expect((0, setMigrationSettings_1.setMigrationSettings)(Object.assign(Object.assign({}, mockOptions), { stageOptions: {} }))).rejects.toThrow('Migration settings update failed with status: 400');
     }));
     it('should handle missing response data', () => __awaiter(void 0, void 0, void 0, function* () {
         const mockResponse = {
@@ -119,16 +120,16 @@ describe('setMigrationSettings', () => {
             data: null,
         };
         mockApiServiceInstance.client.post.mockResolvedValue(mockResponse);
-        yield expect((0, setMigrationSettings_1.setMigrationSettings)(mockOptions)).rejects.toThrow('No data returned from migration service');
+        yield expect((0, setMigrationSettings_1.setMigrationSettings)(Object.assign(Object.assign({}, mockOptions), { stageOptions: {} }))).rejects.toThrow('No data returned from migration service');
     }));
     it('should handle API service errors', () => __awaiter(void 0, void 0, void 0, function* () {
         const error = new Error('Network error');
         mockApiServiceInstance.client.post.mockRejectedValue(error);
-        yield expect((0, setMigrationSettings_1.setMigrationSettings)(mockOptions)).rejects.toThrow('Network error');
+        yield expect((0, setMigrationSettings_1.setMigrationSettings)(Object.assign(Object.assign({}, mockOptions), { stageOptions: {} }))).rejects.toThrow('Network error');
     }));
     it('should handle unknown errors', () => __awaiter(void 0, void 0, void 0, function* () {
         mockApiServiceInstance.client.post.mockRejectedValue('Unknown error');
-        yield expect((0, setMigrationSettings_1.setMigrationSettings)(mockOptions)).rejects.toThrow('Failed to set migration settings: Unknown error');
+        yield expect((0, setMigrationSettings_1.setMigrationSettings)(Object.assign(Object.assign({}, mockOptions), { stageOptions: {} }))).rejects.toThrow('Failed to set migration settings: Unknown error');
     }));
     it('should redact matrix key in response', () => __awaiter(void 0, void 0, void 0, function* () {
         const mockResponse = {
@@ -142,7 +143,7 @@ describe('setMigrationSettings', () => {
         };
         mockApiServiceInstance.client.post.mockResolvedValue(mockResponse);
         mockRedactKey.mockReturnValue('***123');
-        const result = yield (0, setMigrationSettings_1.setMigrationSettings)(mockOptions);
+        const result = yield (0, setMigrationSettings_1.setMigrationSettings)(Object.assign(Object.assign({}, mockOptions), { stageOptions: {} }));
         expect(result.matrixKey).toBe('***123');
         expect(mockRedactKey).toHaveBeenCalledWith('test-key-123', 3);
     }));
@@ -155,7 +156,7 @@ describe('setMigrationSettings', () => {
             },
         };
         mockApiServiceInstance.client.post.mockResolvedValue(mockResponse);
-        const result = yield (0, setMigrationSettings_1.setMigrationSettings)(mockOptions);
+        const result = yield (0, setMigrationSettings_1.setMigrationSettings)(Object.assign(Object.assign({}, mockOptions), { stageOptions: {} }));
         expect(result.matrixKey).toBe('');
         expect(mockRedactKey).not.toHaveBeenCalled();
     }));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/dxp-cli-next",
-  "version": "5.27.0-develop.1",
+  "version": "5.27.0-develop.2",
   "repository": {
     "url": "https://gitlab.squiz.net/dxp/dxp-cli-next"
   },