@squiz/dxp-cli-next 5.33.0-develop.1 → 5.33.0-develop.11

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

@@ -1,339 +0,0 @@
-"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 settings_1 = __importDefault(require("./settings"));
-const Utils = __importStar(require("../utils/common"));
-const setMigrationSettings = __importStar(require("../utils/setMigrationSettings"));
-const ApplicationStore = __importStar(require("../../ApplicationStore"));
-const nock_1 = __importDefault(require("nock"));
-jest.mock('../../ApplicationConfig');
-jest.mock('../../ApplicationStore');
-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;
-    let mockSetMigrationSettingResponse;
-    beforeEach(() => {
-        nock_1.default.cleanAll();
-        jest.clearAllMocks();
-        jest.resetAllMocks();
-        logSpy = jest.spyOn(console, 'log').mockImplementation(() => { });
-        mockApplicationStore.getApplicationFile.mockResolvedValue('session-cookie');
-        mockUtils.throwErrorIfNotLoggedIn.mockResolvedValue(undefined);
-        mockSetMigrationSettingResponse = {
-            matrixUrl: 'https://matrix.example.com',
-            matrixIdentifier: '@user:matrix.example.com',
-            matrixKey: '***********123',
-            contentApiKey: '***********456',
-        };
-        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, 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',
-            ]);
-            expect(mockUtils.throwErrorIfNotLoggedIn).toHaveBeenCalledWith(program);
-            expect(mockSetMigrationSettings.setMigrationSettings).toHaveBeenCalledWith({
-                matrixUrl: 'https://matrix.example.com',
-                matrixIdentifier: '@user:matrix.example.com',
-                matrixKey: 'secret-key-123',
-                contentApiKey: 'content-api-key-456',
-            });
-            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, 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',
-                '--tenant',
-                'test-tenant',
-                '--content-api-key',
-                'content-api-key-456',
-            ]);
-            expect(mockSetMigrationSettings.setMigrationSettings).toHaveBeenCalledWith({
-                matrixUrl: 'https://matrix.example.com',
-                matrixIdentifier: '@user:matrix.example.com',
-                matrixKey: 'secret-key-123',
-                tenant: 'test-tenant',
-                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';
-            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',
-                '--overrideUrl',
-                'https://custom.migration.url',
-                '--content-api-key',
-                'content-api-key-456',
-            ]);
-            expect(mockSetMigrationSettings.setMigrationSettings).toHaveBeenCalledWith({
-                matrixUrl: 'https://matrix.example.com',
-                matrixIdentifier: '@user:matrix.example.com',
-                matrixKey: 'secret-key-123',
-                overrideUrl: 'https://custom.migration.url',
-                contentApiKey: 'content-api-key-456',
-            });
-            process.env.ENABLE_OVERRIDE_MIGRATION_URL = originalEnv;
-        }));
-    });
-    describe('error scenarios', () => {
-        it('should handle setMigrationSetting API error', () => __awaiter(void 0, void 0, void 0, function* () {
-            const apiError = new Error('Settings update failed');
-            mockSetMigrationSettings.setMigrationSettings.mockRejectedValue(apiError);
-            mockUtils.handleCommandError.mockImplementation(() => { });
-            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',
-            ]);
-            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');
-            mockSetMigrationSettings.setMigrationSettings.mockRejectedValue(networkError);
-            mockUtils.handleCommandError.mockImplementation(() => { });
-            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',
-            ]);
-            expect(mockUtils.handleCommandError).toHaveBeenCalledWith(program, networkError);
-        }));
-    });
-    describe('required options validation', () => {
-        it('should require matrixUrl option', () => {
-            const program = (0, settings_1.default)().exitOverride();
-            expect(() => {
-                program.parse([
-                    'node',
-                    'dxp-cli',
-                    'migration',
-                    'settings',
-                    '--matrix-identifier',
-                    '@user:matrix.example.com',
-                    '--matrix-key',
-                    'secret-key-123',
-                    '--content-api-key',
-                    'content-api-key-456',
-                ]);
-            }).toThrow();
-        });
-        it('should require matrixIdentifier option', () => {
-            const program = (0, settings_1.default)().exitOverride();
-            expect(() => {
-                program.parse([
-                    'node',
-                    'dxp-cli',
-                    'migration',
-                    'settings',
-                    '--matrix-url',
-                    'https://matrix.example.com',
-                    '--matrix-key',
-                    'secret-key-123',
-                    '--content-api-key',
-                    'content-api-key-456',
-                ]);
-            }).toThrow();
-        });
-        it('should require matrixKey option', () => {
-            const program = (0, settings_1.default)().exitOverride();
-            expect(() => {
-                program.parse([
-                    'node',
-                    'dxp-cli',
-                    'migration',
-                    'settings',
-                    '--matrix-url',
-                    'https://matrix.example.com',
-                    '--matrix-identifier',
-                    '@user:matrix.example.com',
-                    '--content-api-key',
-                    'content-api-key-456',
-                ]);
-            }).toThrow();
-        });
-    });
-    describe('command configuration', () => {
-        it('should have correct command name and description', () => {
-            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, settings_1.default)();
-            program.parse([
-                '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',
-                '--tenant',
-                'test-tenant',
-            ]);
-            const opts = program.opts();
-            expect(opts.matrixUrl).toBe('https://matrix.example.com');
-            expect(opts.matrixIdentifier).toBe('@user:matrix.example.com');
-            expect(opts.matrixKey).toBe('secret-key-123');
-            expect(opts.contentApiKey).toBe('content-api-key-456');
-            expect(opts.tenant).toBe('test-tenant');
-        });
-        it('should parse options with kebab-case to camelCase conversion', () => {
-            const program = (0, settings_1.default)();
-            program.parse([
-                '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',
-            ]);
-            const opts = program.opts();
-            expect(opts.matrixUrl).toBe('https://matrix.example.com');
-            expect(opts.matrixIdentifier).toBe('@user:matrix.example.com');
-            expect(opts.matrixKey).toBe('secret-key-123');
-            expect(opts.contentApiKey).toBe('content-api-key-456');
-        });
-    });
-    afterEach(() => {
-        logSpy.mockRestore();
-    });
-});

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

@@ -1,29 +0,0 @@
-export interface CommonCommandOptions {
-    tenant?: string;
-    overrideUrl?: string;
-}
-export interface AssetMigration {
-    /**
-     * Will be programmatically set while creating a migration or pre-migration,
-     * depending on whether assetId and cctIds are provided.
-     */
-    isPreMigration?: boolean;
-    /**
-     * In pre-migrations, this will be the CCT IDs to generate specs for.
-     * In migrations, this will be the CCT IDs to be skipped (because they were already converted and deployed).
-     */
-    cctIds?: string[];
-    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/common.types.js

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

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

@@ -1,10 +0,0 @@
-import { AssetMigration, CommonCommandOptions } from '.';
-export interface CreateMigrationOptions extends CommonCommandOptions, Pick<AssetMigration, 'assetId' | 'previewAssetId' | 'matrixUrl'> {
-    /**
-     * The path to a JSON file containing the CCT IDs to be skipped in a migration (because they were already converted and deployed)
-     */
-    cctIds?: string;
-}
-export interface CreateMigrationApiResponse {
-    assetMigration: AssetMigration;
-}

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

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

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

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

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

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

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

package/lib/migration/types/index.js

@@ -1,23 +0,0 @@
-"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("./preMigration.types"), exports);
-__exportStar(require("./settings.types"), exports);
-__exportStar(require("./revert.types"), exports);

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

@@ -1,2 +0,0 @@
-import { AssetMigration } from '.';
-export declare type ListMigrationsApiElement = Pick<AssetMigration, 'migrationId' | 'assetId' | 'stage' | 'status' | 'created' | 'updated'>;

package/lib/migration/types/listMigrations.types.js

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

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

@@ -1,10 +0,0 @@
-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/nextStage.types.js

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

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

@@ -1,10 +0,0 @@
-import { AssetMigration, CommonCommandOptions } from '.';
-export interface PreMigrationOptions extends CommonCommandOptions, Pick<AssetMigration, 'matrixUrl'> {
-    /**
-     * The path to a JSON file containing the CCT IDs to generate specs
-     */
-    cctIds: string;
-}
-export interface PreMigrationApiResponse {
-    assetMigration: AssetMigration;
-}

package/lib/migration/types/preMigration.types.js

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

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

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

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

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

@@ -1,15 +0,0 @@
-import { CommonCommandOptions } from '.';
-export interface MatrixIdentifierSchema {
-    matrixUrl: string;
-    matrixIdentifier: string;
-    matrixKey: string;
-    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/types/settings.types.js

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

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

@@ -1,39 +0,0 @@
-import { Command } from 'commander';
-import { AssetMigration } 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.
- * @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 redactKey(key: string, visibleChars?: number): 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;