@squiz/dxp-cli-next 5.33.0-develop.5 → 5.33.0-develop.7

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

@@ -1,48 +0,0 @@
-import { AssetMigration, BatchNextStageResults, CommonCommandOptions, StageOptions, AssetMigrationSummary } from '.';
-export interface CreateMigrationOptions extends CommonCommandOptions, Pick<AssetMigration, 'previewAssetId' | 'matrixUrl'> {
-    /**
-     * Optional for bulk migrations, required for single asset migrations.
-     */
-    assetId?: string;
-    /**
-     * The path to a JSON file containing the IDs of the assets to be migrated. Required for bulk migrations, optional for single asset migrations.
-     */
-    assetIds?: string;
-    /**
-     * 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;
-    /**
-     * The path to a JSON file containing stage options for the next stage of the migration.
-     */
-    stageOptions?: string;
-    /**
-     * Whether to trigger the next stage of the migration automatically.
-     * This will automatically be set to true for pre and bulk migrations.
-     * For single asset migrations, it will be set to false by default but can be overridden by the user.
-     */
-    triggerNextStage?: boolean;
-}
-export interface CreateMigrationInput extends Omit<CreateMigrationOptions, 'stageOptions' | 'cctIds' | 'assetId' | 'assetIds' | 'previewAssetId'> {
-    /**
-     * The IDs of the assets to be migrated.
-     */
-    assetIds?: string[];
-    /**
-     * The CCT IDs to be skipped in a migration (because they were already converted and deployed).
-     */
-    cctIds?: string[];
-    /**
-     * Stage options for the next stage of the migration.
-     */
-    stageOptions?: StageOptions;
-    /**
-     * The ID of the folder that will be used as the parent of the migrated asset generated during the Preview stage.
-     */
-    previewAssetId?: string;
-}
-export interface CreateMigrationApiResponse {
-    assetMigration?: AssetMigration;
-    summary?: AssetMigrationSummary;
-    nextStageResults?: BatchNextStageResults;
-}

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,9 +0,0 @@
-import { AssetMigration, CommonCommandOptions, AssetMigrationSummary } from '.';
-export interface GetMigrationOptions extends CommonCommandOptions, Pick<AssetMigration, 'migrationId' | 'assetId'> {
-}
-export interface GetMigrationApiResponse extends AssetMigration {
-}
-export interface BatchGetMigrationOptions extends CommonCommandOptions, Pick<AssetMigration, 'migrationId'> {
-}
-export interface BatchGetMigrationApiResponse extends AssetMigrationSummary {
-}

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,8 +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';
-export * from './markDeployed.types';

package/lib/migration/types/index.js

@@ -1,24 +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);
-__exportStar(require("./markDeployed.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/markDeployed.types.d.ts

@@ -1,20 +0,0 @@
-import { CommonCommandOptions } from '.';
-export interface MarkDeployedOptions extends CommonCommandOptions {
-    /**
-     * Path to a JSON file containing the CCT IDs to mark as deployed
-     */
-    cctIds: string;
-}
-export interface MarkDeployedInput extends CommonCommandOptions {
-    /**
-     * The CCT IDs to mark as deployed
-     */
-    cctIds: string[];
-}
-export interface MarkDeployedApiResponse {
-    success: string[];
-    failed: {
-        cctId: string;
-        error: string;
-    }[];
-}

package/lib/migration/types/markDeployed.types.js

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

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

@@ -1,31 +0,0 @@
-import { AssetMigration, CommonCommandOptions } from '.';
-export interface StageOptions {
-    [key: string]: unknown;
-}
-export interface NextStageOptions extends CommonCommandOptions, Pick<AssetMigration, 'migrationId' | 'assetId'> {
-    stageOptions?: string;
-}
-export interface NextStageParsedOptions extends Omit<NextStageOptions, 'stageOptions'> {
-    stageOptions?: StageOptions;
-}
-export interface NextStageApiResponse {
-    message: string;
-}
-export interface BatchNextStageResults {
-    success: {
-        assetIds: string[];
-        message: string;
-    }[];
-    failed: {
-        assetIds: string[];
-        error: string;
-    }[];
-}
-export interface BatchNextStageApiResponse extends BatchNextStageResults {
-}
-export interface BatchNextStageOptions extends CommonCommandOptions, Pick<AssetMigration, 'migrationId' | 'stage'> {
-    stageOptions?: string;
-}
-export interface BatchNextStageParsedOptions extends Omit<BatchNextStageOptions, 'stageOptions'> {
-    stageOptions?: StageOptions;
-}

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,18 +0,0 @@
-import { AssetMigration, CommonCommandOptions } from '.';
-export interface RevertMigrationOptions extends CommonCommandOptions, Pick<AssetMigration, 'migrationId' | 'assetId'> {
-}
-export interface RevertMigrationApiResponse {
-    message: string;
-}
-export interface BatchRevertMigrationOptions extends CommonCommandOptions, Pick<AssetMigration, 'migrationId'> {
-}
-export interface BatchRevertMigrationApiResponse {
-    success: {
-        assetIds: string[];
-        message: string;
-    }[];
-    failed: {
-        assetIds: string[];
-        error: 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,53 +0,0 @@
-import { Command } from 'commander';
-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: unknown): never;
-/**
- * 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;
-/**
- * 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, response: CreateMigrationApiResponse): string;

package/lib/migration/utils/common.js

@@ -1,166 +0,0 @@
-"use strict";
-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 });
-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"));
-const ApplicationStore_1 = require("../../ApplicationStore");
-/**
- * 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.
- */
-function handleCommandError(command, error) {
-    var _a, _b, _c, _d;
-    let message;
-    if (axios_1.default.isAxiosError(error)) {
-        // 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) {
-            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) {
-            const details = error.response.data.details;
-            parts.push(typeof details === 'string' ? details : JSON.stringify(details, null, 2));
-        }
-        // 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 {
-        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;
-/**
- * Throws an error if the user is not logged in.
- * @param command - The command that is being executed.
- */
-function throwErrorIfNotLoggedIn(command) {
-    return __awaiter(this, void 0, void 0, function* () {
-        if (!(yield (0, ApplicationStore_1.getApplicationFile)(ApplicationStore_1.STORE_FILES.sessionCookie))) {
-            command.error(chalk_1.default.red('You must login to interact with the migration service. See `dxp-next auth login`'));
-        }
-    });
-}
-exports.throwErrorIfNotLoggedIn = throwErrorIfNotLoggedIn;
-/**
- * Builds the migration URL.
- * @param tenantID - The tenant ID.
- * @param overrideUrl - The override URL.
- * @returns The migration URL.
- */
-function buildMigrationUrl(tenantID, overrideUrl, baseDomain = 'migrations') {
-    return __awaiter(this, void 0, void 0, function* () {
-        if (!overrideUrl) {
-            const existingConfig = yield (0, ApplicationConfig_1.fetchApplicationConfig)(tenantID);
-            return `${existingConfig.baseUrl}/__dxp/service/aiapps/migration/${baseDomain}`;
-        }
-        else {
-            return `${overrideUrl}/${baseDomain}`;
-        }
-    });
-}
-exports.buildMigrationUrl = buildMigrationUrl;
-/**
- * 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.
- */
-function validateAxiosStatus(status) {
-    return status < 400;
-}
-exports.validateAxiosStatus = validateAxiosStatus;
-function getMigrationHeaders(tenantID, isJson = true) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const existingConfig = yield (0, ApplicationConfig_1.fetchApplicationConfig)(tenantID);
-        return isJson
-            ? {
-                'Content-Type': 'application/json',
-                'x-dxp-tenant': existingConfig.tenant,
-            }
-            : {
-                'x-dxp-tenant': existingConfig.tenant,
-            };
-    });
-}
-exports.getMigrationHeaders = getMigrationHeaders;
-function redactKey(key, visibleChars = 3) {
-    if (!key)
-        return '';
-    const len = key.length;
-    if (len <= visibleChars)
-        return '*'.repeat(len);
-    const masked = '*'.repeat(len - visibleChars);
-    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, response) {
-    const formattedResponse = JSON.stringify(response, null, 2);
-    return `Successfully created ${label}:\n${formattedResponse}`;
-}
-exports.buildMigrationSuccessMessage = buildMigrationSuccessMessage;

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

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