@squiz/dxp-cli-next 5.33.0-develop.2 → 5.33.0-develop.4

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

@@ -1,15 +1,16 @@
 import { Command } from 'commander';
-import { AssetMigration } from '../types';
+import { CreateMigrationApiResponse } from '../types';
 /**
  * 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.
+ * Formats and displays the error message, then terminates the process.
  * @param command - The command that is being executed.
  * @param error - The error that occurred.
  */
-export declare function handleCommandError(command: Command, error: Error): void;
+export declare function handleCommandError(command: Command, error: unknown): never;
 /**
  * Throws an error if the user is not logged in.
  * @param command - The command that is being executed.
@@ -30,10 +31,23 @@ export declare function buildMigrationUrl(tenantID?: string, overrideUrl?: strin
 export declare function validateAxiosStatus(status: number): boolean;
 export declare function getMigrationHeaders(tenantID?: string, isJson?: boolean): Promise<Record<string, string>>;
 export declare function redactKey(key: string, visibleChars?: number): string;
+/**
+ * Formats batch operation results (batch-next, batch-revert) into a human-readable string.
+ * @param success - Array of successful operations with asset IDs and messages.
+ * @param failed - Array of failed operations with asset IDs and error messages.
+ * @returns Formatted string with colored output.
+ */
+export declare function formatBatchOperationResult(success: {
+    assetIds: string[];
+    message: string;
+}[], failed: {
+    assetIds: string[];
+    error: string;
+}[]): string;
 /**
  * Builds a success message for migration creation.
  * @param label - The label for the migration type (e.g., "migration" or "pre-migration").
  * @param assetMigration - The asset migration response.
  * @returns The formatted success message.
  */
-export declare function buildMigrationSuccessMessage(label: string, assetMigration: AssetMigration): string;
+export declare function buildMigrationSuccessMessage(label: string, response: CreateMigrationApiResponse): string;

package/lib/migration/utils/common.js

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildMigrationSuccessMessage = exports.redactKey = exports.getMigrationHeaders = exports.validateAxiosStatus = exports.buildMigrationUrl = exports.throwErrorIfNotLoggedIn = exports.handleCommandError = void 0;
+exports.buildMigrationSuccessMessage = exports.formatBatchOperationResult = exports.redactKey = exports.getMigrationHeaders = exports.validateAxiosStatus = exports.buildMigrationUrl = exports.throwErrorIfNotLoggedIn = exports.handleCommandError = void 0;
 const chalk_1 = __importDefault(require("chalk"));
 const ApplicationConfig_1 = require("../../ApplicationConfig");
 const axios_1 = __importDefault(require("axios"));
@@ -23,31 +23,41 @@ const ApplicationStore_1 = require("../../ApplicationStore");
  */
 /**
  * Handles errors from the migration service.
+ * Formats and displays the error message, then terminates the process.
  * @param command - The command that is being executed.
  * @param error - The error that occurred.
  */
 function handleCommandError(command, error) {
     var _a, _b, _c, _d;
+    let message;
     if (axios_1.default.isAxiosError(error)) {
-        let message = `${error.message}`;
+        // Build message from AxiosError components
+        const parts = [error.message];
         if ((_b = (_a = error.response) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.message) {
-            message += `: ${error.response.data.message}`;
+            parts.push(error.response.data.message);
         }
         if ((_d = (_c = error.response) === null || _c === void 0 ? void 0 : _c.data) === null || _d === void 0 ? void 0 : _d.details) {
-            message += ` - ${error.response.data.details}`;
+            const details = error.response.data.details;
+            parts.push(typeof details === 'string' ? details : JSON.stringify(details, null, 2));
         }
-        command.error(chalk_1.default.red(message));
+        // Handle network errors (no response received from server)
+        if (!error.response && error.request) {
+            parts.push('No response received from server');
+        }
+        message = parts.join(': ');
+    }
+    else if (error instanceof Error) {
+        message = error.message || 'An unknown error occurred';
     }
     else {
-        if (!!process.env.DEBUG && error.stack) {
-            command.error(error.stack);
-        }
-        if (error.message) {
-            command.error(chalk_1.default.red(error.message));
-        }
-        else {
-            command.error(chalk_1.default.red('An unknown error occurred'));
-        }
+        message = 'An unknown error occurred';
+    }
+    // Show stack trace in DEBUG mode, otherwise just the message
+    if (process.env.DEBUG && error instanceof Error && error.stack) {
+        command.error(chalk_1.default.red(`${message}\n\nStack trace:\n${error.stack}`));
+    }
+    else {
+        command.error(chalk_1.default.red(message));
     }
 }
 exports.handleCommandError = handleCommandError;
@@ -114,21 +124,43 @@ function redactKey(key, visibleChars = 3) {
     return masked + key.slice(-visibleChars);
 }
 exports.redactKey = redactKey;
+/**
+ * Formats batch operation results (batch-next, batch-revert) into a human-readable string.
+ * @param success - Array of successful operations with asset IDs and messages.
+ * @param failed - Array of failed operations with asset IDs and error messages.
+ * @returns Formatted string with colored output.
+ */
+function formatBatchOperationResult(success, failed) {
+    const lines = [];
+    if (success.length > 0) {
+        lines.push(chalk_1.default.green('Successful:'));
+        success.forEach(({ assetIds, message }) => {
+            const idsStr = chalk_1.default.cyan(assetIds.join(', '));
+            lines.push(message ? `  ${idsStr}: ${message}` : `  ${idsStr}`);
+        });
+    }
+    if (failed.length > 0) {
+        if (lines.length > 0)
+            lines.push('');
+        lines.push(chalk_1.default.red('Failed:'));
+        failed.forEach(({ assetIds, error }) => {
+            lines.push(`  ${chalk_1.default.cyan(assetIds.join(', '))}: ${error}`);
+        });
+    }
+    if (lines.length === 0) {
+        return 'No assets were processed';
+    }
+    return lines.join('\n');
+}
+exports.formatBatchOperationResult = formatBatchOperationResult;
 /**
  * Builds a success message for migration creation.
  * @param label - The label for the migration type (e.g., "migration" or "pre-migration").
  * @param assetMigration - The asset migration response.
  * @returns The formatted success message.
  */
-function buildMigrationSuccessMessage(label, assetMigration) {
-    const { isPreMigration, cctIds, migrationId, assetId, stage, status } = assetMigration;
-    return `Successfully created ${label}: ${JSON.stringify({
-        isPreMigration,
-        migrationId,
-        assetId,
-        stage,
-        status,
-        cctIds: (cctIds === null || cctIds === void 0 ? void 0 : cctIds.length) ? JSON.stringify(cctIds).substring(0, 100) : '[]',
-    })}`;
+function buildMigrationSuccessMessage(label, response) {
+    const formattedResponse = JSON.stringify(response, null, 2);
+    return `Successfully created ${label}:\n${formattedResponse}`;
 }
 exports.buildMigrationSuccessMessage = buildMigrationSuccessMessage;

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

@@ -56,7 +56,7 @@ describe('Migration Utils', () => {
             };
             mockAxios.isAxiosError.mockReturnValue(true);
             (0, _1.handleCommandError)(mockCommand, axiosError);
-            expect(mockCommand.error).toHaveBeenCalledWith(expect.stringContaining('Network Error: Server Error - Additional details'));
+            expect(mockCommand.error).toHaveBeenCalledWith(expect.stringContaining('Network Error: Server Error: Additional details'));
         });
         it('handles axios errors without response data', () => {
             const axiosError = {
@@ -86,7 +86,9 @@ describe('Migration Utils', () => {
             error.stack = 'Error stack trace';
             mockAxios.isAxiosError.mockReturnValue(false);
             (0, _1.handleCommandError)(mockCommand, error);
-            expect(mockCommand.error).toHaveBeenCalledWith('Error stack trace');
+            expect(mockCommand.error).toHaveBeenCalledWith(expect.stringContaining('Test error'));
+            expect(mockCommand.error).toHaveBeenCalledWith(expect.stringContaining('Stack trace:'));
+            expect(mockCommand.error).toHaveBeenCalledWith(expect.stringContaining('Error stack trace'));
             process.env.DEBUG = originalDebug;
         });
     });
@@ -162,4 +164,73 @@ describe('Migration Utils', () => {
             expect((0, _1.redactKey)('1234567890', 10)).toBe('**********');
         });
     });
+    describe('formatBatchOperationResult', () => {
+        it('formats successful results correctly', () => {
+            const success = [
+                { assetIds: ['asset-1', 'asset-2'], message: 'Stage completed' },
+            ];
+            const failed = [];
+            const result = (0, _1.formatBatchOperationResult)(success, failed);
+            expect(result).toContain('Successful:');
+            expect(result).toContain('asset-1, asset-2');
+            expect(result).toContain('Stage completed');
+        });
+        it('formats failed results correctly', () => {
+            const success = [];
+            const failed = [{ assetIds: ['asset-3'], error: 'Migration failed' }];
+            const result = (0, _1.formatBatchOperationResult)(success, failed);
+            expect(result).toContain('Failed:');
+            expect(result).toContain('asset-3');
+            expect(result).toContain('Migration failed');
+        });
+        it('formats mixed success and failed results correctly', () => {
+            const success = [{ assetIds: ['asset-1'], message: 'Completed' }];
+            const failed = [{ assetIds: ['asset-2'], error: 'Failed to process' }];
+            const result = (0, _1.formatBatchOperationResult)(success, failed);
+            expect(result).toContain('Successful:');
+            expect(result).toContain('asset-1');
+            expect(result).toContain('Completed');
+            expect(result).toContain('Failed:');
+            expect(result).toContain('asset-2');
+            expect(result).toContain('Failed to process');
+        });
+        it('returns empty message when no results', () => {
+            const success = [];
+            const failed = [];
+            const result = (0, _1.formatBatchOperationResult)(success, failed);
+            expect(result).toBe('No assets were processed');
+        });
+        it('handles multiple asset IDs in a single result', () => {
+            const success = [
+                {
+                    assetIds: ['asset-1', 'asset-2', 'asset-3'],
+                    message: 'All processed',
+                },
+            ];
+            const failed = [];
+            const result = (0, _1.formatBatchOperationResult)(success, failed);
+            expect(result).toContain('asset-1, asset-2, asset-3');
+        });
+        it('handles multiple success entries', () => {
+            const success = [
+                { assetIds: ['asset-1'], message: 'First batch' },
+                { assetIds: ['asset-2'], message: 'Second batch' },
+            ];
+            const failed = [];
+            const result = (0, _1.formatBatchOperationResult)(success, failed);
+            expect(result).toContain('asset-1');
+            expect(result).toContain('First batch');
+            expect(result).toContain('asset-2');
+            expect(result).toContain('Second batch');
+        });
+        it('handles empty message gracefully', () => {
+            const success = [{ assetIds: ['asset-1'], message: '' }];
+            const failed = [];
+            const result = (0, _1.formatBatchOperationResult)(success, failed);
+            expect(result).toContain('Successful:');
+            expect(result).toContain('asset-1');
+            // Should not have a trailing colon when message is empty
+            expect(result).not.toContain('asset-1:');
+        });
+    });
 });

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

@@ -1,29 +1,12 @@
-import { CommonCommandOptions, CreateMigrationApiResponse } from '../types';
-export interface CreateMigrationInput extends CommonCommandOptions {
-    /**
-     * Optional for pre-migrations, required for migrations.
-     */
-    assetId?: string;
-    /**
-     * Optional for pre-migrations, required for migrations.
-     */
-    previewAssetId?: string;
-    /**
-     * Required for both migrations and pre-migrations.
-     */
-    matrixUrl: string;
-    /**
-     * Optional for migrations, required for pre-migrations.
-     */
-    cctIds?: string[];
-}
+import { CreateMigrationInput, CreateMigrationApiResponse } from '../types';
 /**
- * Creates a new migration or pre-migration using the AI Page Migration service.
+ * Creates a new single asset migration, bulk migration, or pre-migration using the AI Page Migration service.
  * Pre-migrations are used to generate specs for CCTs so they can be converted and deployed in advance.
+ * Bulk migrations are used to migrate multiple assets at once, and they all share the same migration ID.
  * @param {CreateMigrationInput} input - The input parameters for the migration/pre-migration creation.
  * @returns {Promise<CreateMigrationApiResponse>}
  */
-export declare function createMigration({ tenant, overrideUrl, assetId, previewAssetId, matrixUrl, cctIds, }: CreateMigrationInput): Promise<CreateMigrationApiResponse>;
+export declare function createMigration({ tenant, overrideUrl, assetIds, previewAssetId, matrixUrl, cctIds, stageOptions, triggerNextStage, }: CreateMigrationInput): Promise<CreateMigrationApiResponse>;
 export declare function validateExportFolder(exportPath: string): void;
 /**
  * Creates a tar file from the export path.

package/lib/migration/utils/createMigration.js

@@ -19,48 +19,39 @@ const ApiService_1 = require("../../ApiService");
 const _1 = require(".");
 const child_process_1 = require("child_process");
 /**
- * Creates a new migration or pre-migration using the AI Page Migration service.
+ * Creates a new single asset migration, bulk migration, or pre-migration using the AI Page Migration service.
  * Pre-migrations are used to generate specs for CCTs so they can be converted and deployed in advance.
+ * Bulk migrations are used to migrate multiple assets at once, and they all share the same migration ID.
  * @param {CreateMigrationInput} input - The input parameters for the migration/pre-migration creation.
  * @returns {Promise<CreateMigrationApiResponse>}
  */
-function createMigration({ tenant, overrideUrl, assetId, previewAssetId, matrixUrl, cctIds, }) {
+function createMigration({ tenant, overrideUrl, assetIds, previewAssetId, matrixUrl, cctIds, stageOptions, triggerNextStage, }) {
     return __awaiter(this, void 0, void 0, function* () {
         const apiService = new ApiService_1.ApiService({
             validateStatus: _1.validateAxiosStatus,
         });
         const migrationUrl = yield (0, _1.buildMigrationUrl)(tenant, overrideUrl);
-        try {
-            const payload = {
-                assetId,
-                previewAssetId,
-                matrixUrl,
-                cctIds,
-            };
-            const response = yield apiService.client.post(`${migrationUrl}`, payload, {
-                headers: yield (0, _1.getMigrationHeaders)(tenant),
-            });
-            if (response.status !== 200 && response.status !== 201) {
-                throw new Error(`Migration creation failed with status: ${response.status}`);
-            }
-            // Validate response structure
-            const { assetMigration } = response.data || {};
-            if (!(assetMigration === null || assetMigration === void 0 ? void 0 : assetMigration.migrationId) ||
-                !(assetMigration === null || assetMigration === void 0 ? void 0 : assetMigration.assetId) ||
-                !(assetMigration === null || assetMigration === void 0 ? void 0 : assetMigration.stage) ||
-                !(assetMigration === null || assetMigration === void 0 ? void 0 : assetMigration.status)) {
-                throw new Error('Invalid response format from migration service');
-            }
-            return {
-                assetMigration,
-            };
-        }
-        catch (error) {
-            if (error instanceof Error) {
-                throw error;
-            }
-            throw new Error(`Failed to create migration: ${error}`);
+        const payload = {
+            assetIds,
+            previewAssetId,
+            matrixUrl,
+            cctIds,
+            stageOptions,
+            triggerNextStage,
+        };
+        const response = yield apiService.client.post(`${migrationUrl}`, payload, {
+            headers: yield (0, _1.getMigrationHeaders)(tenant),
+        });
+        // Validate response structure
+        const { assetMigration, summary, nextStageResults } = response.data || {};
+        if (!assetMigration && !summary && !nextStageResults) {
+            throw new Error('Invalid response format from migration service.');
         }
+        return {
+            assetMigration,
+            summary,
+            nextStageResults,
+        };
     });
 }
 exports.createMigration = createMigration;

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

@@ -134,7 +134,7 @@ describe('createMigration', () => {
                 };
                 mockApiService.mockImplementation(() => mockApiServiceInstance);
                 mockOptions = {
-                    assetId: 'asset-123',
+                    assetIds: ['asset-123'],
                     previewAssetId: 'preview-456',
                     matrixUrl: 'https://matrix.example.com',
                     tenant: 'test-tenant',
@@ -167,9 +167,12 @@ describe('createMigration', () => {
                 const result = yield (0, _1.createMigration)(mockOptions);
                 expect(result).toEqual(mockResponse.data);
                 expect(mockApiServiceInstance.client.post).toHaveBeenCalledWith('https://example.com/__dxp/service/aiapps/migration/migrations', {
-                    assetId: 'asset-123',
+                    assetIds: ['asset-123'],
                     previewAssetId: 'preview-456',
                     matrixUrl: 'https://matrix.example.com',
+                    cctIds: undefined,
+                    stageOptions: undefined,
+                    triggerNextStage: undefined,
                 }, {
                     headers: {
                         'Content-Type': 'application/json',
@@ -177,36 +180,34 @@ describe('createMigration', () => {
                     },
                 });
             }));
-            it('handles non-success status codes', () => __awaiter(void 0, void 0, void 0, function* () {
-                const mockResponse = {
+            it('handles API errors (4xx/5xx status codes)', () => __awaiter(void 0, void 0, void 0, function* () {
+                // In production, Axios throws AxiosError for 4xx/5xx status codes
+                const axiosError = new Error('Request failed with status code 400');
+                axiosError.isAxiosError = true;
+                axiosError.response = {
                     status: 400,
-                    data: {},
+                    data: { message: 'Bad Request' },
                 };
-                mockApiServiceInstance.client.post.mockResolvedValue(mockResponse);
-                yield expect((0, _1.createMigration)(mockOptions)).rejects.toThrow('Migration creation failed with status: 400');
+                mockApiServiceInstance.client.post.mockRejectedValue(axiosError);
+                yield expect((0, _1.createMigration)(mockOptions)).rejects.toThrow('Request failed with status code 400');
             }));
-            it('handles invalid response format - missing migrationId', () => __awaiter(void 0, void 0, void 0, function* () {
+            it('handles invalid response format - missing required fields', () => __awaiter(void 0, void 0, void 0, function* () {
                 const mockResponse = {
                     status: 200,
-                    data: {
-                        assetMigration: {
-                            assetId: 'asset-123',
-                            stage: 'pending',
-                            status: 'created',
-                        },
-                    },
+                    data: {},
                 };
                 mockApiServiceInstance.client.post.mockResolvedValue(mockResponse);
-                yield expect((0, _1.createMigration)(mockOptions)).rejects.toThrow('Invalid response format from migration service');
+                yield expect((0, _1.createMigration)(mockOptions)).rejects.toThrow('Invalid response format from migration service.');
             }));
             it('handles 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, _1.createMigration)(mockOptions)).rejects.toThrow('Network error');
             }));
-            it('handles unknown errors', () => __awaiter(void 0, void 0, void 0, function* () {
+            it('propagates rejected values as-is', () => __awaiter(void 0, void 0, void 0, function* () {
+                // Non-Error values are propagated without wrapping
                 mockApiServiceInstance.client.post.mockRejectedValue('Unknown error');
-                yield expect((0, _1.createMigration)(mockOptions)).rejects.toThrow('Failed to create migration: Unknown error');
+                yield expect((0, _1.createMigration)(mockOptions)).rejects.toBe('Unknown error');
             }));
         });
         describe('createTarFile', () => {

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

@@ -1,2 +1,3 @@
-import { GetMigrationOptions, GetMigrationApiResponse } from '../types';
+import { GetMigrationOptions, GetMigrationApiResponse, BatchGetMigrationOptions, BatchGetMigrationApiResponse } from '../types';
 export declare function getMigration(options: GetMigrationOptions): Promise<GetMigrationApiResponse>;
+export declare function batchGetMigration(options: BatchGetMigrationOptions): Promise<BatchGetMigrationApiResponse>;

package/lib/migration/utils/getMigration.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getMigration = void 0;
+exports.batchGetMigration = exports.getMigration = void 0;
 const ApiService_1 = require("../../ApiService");
 const _1 = require(".");
 function getMigration(options) {
@@ -18,24 +18,29 @@ function getMigration(options) {
             validateStatus: _1.validateAxiosStatus,
         });
         const migrationUrl = yield (0, _1.buildMigrationUrl)(options.tenant, options.overrideUrl);
-        try {
-            const response = yield apiService.client.get(`${migrationUrl}/${options.migrationId}/assets/${options.assetId}`, {
-                headers: yield (0, _1.getMigrationHeaders)(options.tenant),
-            });
-            if (response.status !== 200) {
-                throw new Error(`Failed to get migration: ${response.status}`);
-            }
-            if (!(response === null || response === void 0 ? void 0 : response.data)) {
-                throw new Error('No data returned from migration service');
-            }
-            return response.data;
-        }
-        catch (error) {
-            if (error instanceof Error) {
-                throw error;
-            }
-            throw new Error(`Failed to get migration: ${error}`);
+        const response = yield apiService.client.get(`${migrationUrl}/${options.migrationId}/assets/${options.assetId}`, {
+            headers: yield (0, _1.getMigrationHeaders)(options.tenant),
+        });
+        if (!(response === null || response === void 0 ? void 0 : response.data)) {
+            throw new Error('No data returned from migration service');
         }
+        return response.data;
     });
 }
 exports.getMigration = getMigration;
+function batchGetMigration(options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const apiService = new ApiService_1.ApiService({
+            validateStatus: _1.validateAxiosStatus,
+        });
+        const migrationUrl = yield (0, _1.buildMigrationUrl)(options.tenant, options.overrideUrl);
+        const response = yield apiService.client.get(`${migrationUrl}/${options.migrationId}`, {
+            headers: yield (0, _1.getMigrationHeaders)(options.tenant),
+        });
+        if (!(response === null || response === void 0 ? void 0 : response.data)) {
+            throw new Error('No data returned from migration service');
+        }
+        return response.data;
+    });
+}
+exports.batchGetMigration = batchGetMigration;