@contentstack/cli-cm-import 1.12.1 → 1.13.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Contentstack
+Copyright (c) 2024 Contentstack
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -47,7 +47,7 @@ $ npm install -g @contentstack/cli-cm-import
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-cm-import/1.12.1 linux-x64 node-v18.19.0
+@contentstack/cli-cm-import/1.13.0 linux-x64 node-v18.19.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -82,6 +82,8 @@ FLAGS
   --import-webhook-status=<option>  [default: disable] [optional] Webhook state
                                     <options: disable|current>
   --replace-existing                Replaces the existing module in the target stack.
+  --skip-app-recreation             [optional] Skip private apps recreation if already exist
+  --skip-audit                      Skips the audit fix.
   --skip-existing                   Skips the module exists warning messages.
 
 DESCRIPTION
@@ -105,7 +107,7 @@ EXAMPLES
 
   $ csdx cm:stacks:import --alias <management_token_alias> --config <path/of/config/file>
 
-  $ csdx cm:stacks:import --branch <branch name>  --yes
+  $ csdx cm:stacks:import --branch <branch name>  --yes --skip-audit
 ```
 
 ## `csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]`
@@ -129,6 +131,8 @@ FLAGS
   --import-webhook-status=<option>  [default: disable] [optional] Webhook state
                                     <options: disable|current>
   --replace-existing                Replaces the existing module in the target stack.
+  --skip-app-recreation             [optional] Skip private apps recreation if already exist
+  --skip-audit                      Skips the audit fix.
   --skip-existing                   Skips the module exists warning messages.
 
 DESCRIPTION
@@ -152,7 +156,7 @@ EXAMPLES
 
   $ csdx cm:stacks:import --alias <management_token_alias> --config <path/of/config/file>
 
-  $ csdx cm:stacks:import --branch <branch name>  --yes
+  $ csdx cm:stacks:import --branch <branch name>  --yes --skip-audit
 ```
 
 _See code: [src/commands/cm/stacks/import.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-import/src/commands/cm/stacks/import.ts)_

package/lib/commands/cm/stacks/import.js

@@ -20,8 +20,10 @@ class ImportCommand extends cli_command_1.Command {
             backupDir = importConfig.backupDir;
             const managementAPIClient = await (0, cli_utilities_1.managementSDKClient)(importConfig);
             const moduleImporter = new import_1.ModuleImporter(managementAPIClient, importConfig);
-            await moduleImporter.start();
-            (0, utils_1.log)(importConfig, `The content has been imported to the stack ${importConfig.apiKey} successfully!`, 'success');
+            const result = await moduleImporter.start();
+            if (!(result === null || result === void 0 ? void 0 : result.noSuccessMsg)) {
+                (0, utils_1.log)(importConfig, `The content has been imported to the stack ${importConfig.apiKey} successfully!`, 'success');
+            }
             (0, utils_1.log)(importConfig, `The log has been stored at '${node_path_1.default.join(importConfig.backupDir, 'logs', 'import')}'`, 'success');
         }
         catch (error) {
@@ -40,7 +42,7 @@ ImportCommand.examples = [
     `csdx cm:stacks:import --alias <management_token_alias>`,
     `csdx cm:stacks:import --alias <management_token_alias> --data-dir <path/of/export/destination/dir>`,
     `csdx cm:stacks:import --alias <management_token_alias> --config <path/of/config/file>`,
-    `csdx cm:stacks:import --branch <branch name>  --yes`,
+    `csdx cm:stacks:import --branch <branch name>  --yes --skip-audit`,
 ];
 ImportCommand.flags = {
     config: cli_utilities_1.flags.string({
@@ -108,6 +110,9 @@ ImportCommand.flags = {
         required: false,
         description: '[optional] Override marketplace prompts',
     }),
+    'skip-app-recreation': cli_utilities_1.flags.boolean({
+        description: '[optional] Skip private apps recreation if already exist',
+    }),
     'replace-existing': cli_utilities_1.flags.boolean({
         required: false,
         description: 'Replaces the existing module in the target stack.',
@@ -117,6 +122,9 @@ ImportCommand.flags = {
         default: false,
         description: 'Skips the module exists warning messages.',
     }),
+    'skip-audit': cli_utilities_1.flags.boolean({
+        description: 'Skips the audit fix.',
+    }),
 };
 ImportCommand.aliases = ['cm:import'];
 ImportCommand.usage = 'cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]';

package/lib/import/module-importer.d.ts

@@ -1,4 +1,4 @@
-import { ContentstackClient } from '@contentstack/cli-utilities';
+import { ContentstackClient, Logger } from '@contentstack/cli-utilities';
 import { ImportConfig, Modules } from '../types';
 declare class ModuleImporter {
     private managementAPIClient;
@@ -9,5 +9,12 @@ declare class ModuleImporter {
     import(): Promise<any>;
     importByModuleByName(moduleName: Modules): Promise<any>;
     importAllModules(): Promise<any>;
+    /**
+     * The `auditImportData` function performs an audit process on imported data, using a specified
+     * configuration, and returns a boolean indicating whether a fix is needed.
+     * @returns The function `auditImportData()` returns a boolean value. It returns `true` if there is a
+     * fix available and the user confirms to proceed with the fix, otherwise it returns `false`.
+     */
+    auditImportData(logger: Logger): Promise<boolean>;
 }
 export default ModuleImporter;

package/lib/import/module-importer.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+const path_1 = require("path");
+const cli_audit_1 = require("@contentstack/cli-audit");
+const messages_1 = tslib_1.__importStar(require("@contentstack/cli-audit/lib/messages"));
 const cli_utilities_1 = require("@contentstack/cli-utilities");
 const modules_1 = tslib_1.__importDefault(require("./modules"));
 const modules_js_1 = tslib_1.__importDefault(require("./modules-js"));
@@ -18,16 +21,9 @@ class ModuleImporter {
         if (this.importConfig.branchName) {
             await (0, utils_1.validateBranch)(this.stackAPIClient, this.importConfig, this.importConfig.branchName);
         }
-        // Temporarily adding this api call to verify management token has read and write permissions
-        // TODO: CS-40354 - CLI | import rewrite | Migrate HTTP call to SDK call once fix is ready from SDK side
         if (this.importConfig.management_token) {
             await (0, cli_utilities_1.addLocale)(this.importConfig.apiKey, this.importConfig.management_token, this.importConfig.host);
         }
-        if (!this.importConfig.master_locale) {
-            let masterLocalResponse = await (0, utils_1.masterLocalDetails)(this.stackAPIClient);
-            this.importConfig['master_locale'] = { code: masterLocalResponse.code };
-            this.importConfig.masterLocale = { code: masterLocalResponse.code };
-        }
         const backupDir = await (0, utils_1.backupHandler)(this.importConfig);
         if (backupDir) {
             this.importConfig.backupDir = backupDir;
@@ -35,7 +31,20 @@ class ModuleImporter {
             this.importConfig.data = backupDir;
         }
         // NOTE init log
-        (0, utils_1.initLogger)(this.importConfig);
+        const logger = (0, utils_1.initLogger)(this.importConfig);
+        // NOTE audit and fix the import content.
+        if (!this.importConfig.skipAudit &&
+            (!this.importConfig.moduleName ||
+                ['content-types', 'global-fields', 'entries'].includes(this.importConfig.moduleName))) {
+            if (!(await this.auditImportData(logger))) {
+                return { noSuccessMsg: true };
+            }
+        }
+        if (!this.importConfig.master_locale) {
+            let masterLocalResponse = await (0, utils_1.masterLocalDetails)(this.stackAPIClient);
+            this.importConfig['master_locale'] = { code: masterLocalResponse.code };
+            this.importConfig.masterLocale = { code: masterLocalResponse.code };
+        }
         await (0, utils_1.sanitizeStack)(this.stackAPIClient);
         return this.import();
     }
@@ -76,5 +85,57 @@ class ModuleImporter {
             await this.importByModuleByName(moduleName);
         }
     }
+    /**
+     * The `auditImportData` function performs an audit process on imported data, using a specified
+     * configuration, and returns a boolean indicating whether a fix is needed.
+     * @returns The function `auditImportData()` returns a boolean value. It returns `true` if there is a
+     * fix available and the user confirms to proceed with the fix, otherwise it returns `false`.
+     */
+    async auditImportData(logger) {
+        const basePath = (0, path_1.resolve)(this.importConfig.backupDir, 'logs', 'audit');
+        const auditConfig = {
+            noLog: false,
+            skipConfirm: true,
+            returnResponse: true,
+            noTerminalOutput: false,
+            config: { basePath }, // To overwrite any build-in config. This config is equal to --config flag.
+        };
+        try {
+            const args = [
+                '--data-dir',
+                this.importConfig.backupDir,
+                '--external-config',
+                JSON.stringify(auditConfig),
+                '--report-path',
+                basePath,
+            ];
+            if (this.importConfig.moduleName) {
+                args.push('--modules', this.importConfig.moduleName);
+            }
+            (0, utils_1.log)(this.importConfig, 'Starting audit process', 'info');
+            const result = await cli_audit_1.AuditFix.run(args);
+            (0, utils_1.log)(this.importConfig, 'Audit process completed', 'info');
+            if (result) {
+                const { hasFix, config } = result;
+                if (hasFix) {
+                    logger.log((0, messages_1.$t)(messages_1.default.FINAL_REPORT_PATH, { path: config.reportPath }), 'warn');
+                    if (this.importConfig.forceStopMarketplaceAppsPrompt ||
+                        (await cli_utilities_1.cliux.inquire({
+                            type: 'confirm',
+                            name: 'confirmation',
+                            message: 'Can you check the fix on the given path and confirm if you would like to proceed with the fix?',
+                        }))) {
+                        return true;
+                    }
+                    return false;
+                }
+            }
+            return true;
+        }
+        catch (error) {
+            (0, utils_1.trace)(error);
+            (0, utils_1.log)(this.importConfig, `Audit failed with following error. ${error}`, 'error');
+        }
+    }
 }
 exports.default = ModuleImporter;

package/lib/import/modules/index.js

@@ -1,18 +1,31 @@
 "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 _a;
 Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const cli_utilities_1 = require("@contentstack/cli-utilities");
-const node_path_1 = require("node:path");
-const modules_js_1 = tslib_1.__importDefault(require("../modules-js"));
 async function startModuleImport(modulePayload) {
-    var _a;
-    // Todo: Remove below code when auto detect mechanism implemented for old and new module
-    if (modulePayload.moduleName === 'assets' &&
-        !new cli_utilities_1.FsUtility({ basePath: (0, node_path_1.join)((_a = modulePayload.importConfig) === null || _a === void 0 ? void 0 : _a.backupDir, 'assets') }).isNewFsStructure) {
-        return (0, modules_js_1.default)(modulePayload);
-    }
-    const { default: ModuleRunner } = await (_a = `./${modulePayload.moduleName}`, Promise.resolve().then(() => tslib_1.__importStar(require(_a))));
+    const { default: ModuleRunner } = await (_a = `./${modulePayload.moduleName}`, Promise.resolve().then(() => __importStar(require(_a))));
     const moduleRunner = new ModuleRunner(modulePayload);
     return moduleRunner.start();
 }

package/lib/import/modules/marketplace-apps.d.ts

@@ -1,43 +1,113 @@
-import { NodeCrypto, ContentstackClient } from '@contentstack/cli-utilities';
-import BaseClass from './base-class';
-import { ModuleClassParams } from '../../types';
-export default class ImportMarketplaceApps extends BaseClass {
+import { NodeCrypto, ContentstackMarketplaceClient } from '@contentstack/cli-utilities';
+import { ModuleClassParams, ImportConfig, Installation, Manifest } from '../../types';
+export default class ImportMarketplaceApps {
+    importConfig: ImportConfig;
     private mapperDirPath;
     private marketPlaceFolderPath;
     private marketPlaceUidMapperPath;
     private marketPlaceAppConfig;
     private marketplaceApps;
-    private httpClient;
     private appNameMapping;
     private appUidMapping;
     private installationUidMapping;
     private installedApps;
     private appOriginalName;
     developerHubBaseUrl: string;
-    sdkClient: ContentstackClient;
     nodeCrypto: NodeCrypto;
-    appSdkAxiosInstance: any;
-    constructor({ importConfig, stackAPIClient }: ModuleClassParams);
+    appSdk: ContentstackMarketplaceClient;
+    constructor({ importConfig }: ModuleClassParams);
     /**
-     * @method start
-     * @returns {Promise<void>} Promise<void>
+     * This function starts the process of importing marketplace apps.
+     * @returns The function `start()` returns a `Promise<void>`.
      */
     start(): Promise<void>;
-    setHttpClient(): Promise<void>;
     /**
-     * @method startInstallation
-     * @returns {Promise<void>}
+     * The function `importMarketplaceApps` installs marketplace apps, handles private app creation,
+     * validates app installation, and generates a UID mapper.
+     */
+    importMarketplaceApps(): Promise<void>;
+    /**
+     * The function `generateUidMapper` generates a mapping of extension UIDs from old metadata to new
+     * metadata based on the installed and marketplace apps.
+     * @returns The function `generateUidMapper` returns a Promise that resolves to a `Record<string,
+     * unknown>`.
      */
-    startInstallation(): Promise<void>;
     generateUidMapper(): Promise<Record<string, unknown>>;
+    /**
+     * The function `getAndValidateEncryptionKey` retrieves and validates an encryption key, with the
+     * option to retry a specified number of times.
+     * @param {string} defaultValue - The defaultValue parameter is a string that represents the default
+     * encryption key value to use if no valid encryption key is found in the marketplaceApps
+     * configuration.
+     * @param [retry=1] - The `retry` parameter is an optional parameter that specifies the number of
+     * times the function should retry getting and validating the encryption key if it fails. The default
+     * value is 1, meaning that if the function fails to get and validate the encryption key on the first
+     * attempt, it will not retry.
+     * @returns The function `getAndValidateEncryptionKey` returns a Promise that resolves to the
+     * encryption key.
+     */
     getAndValidateEncryptionKey(defaultValue: string, retry?: number): Promise<any>;
     /**
-     * @method handleAllPrivateAppsCreationProcess
-     * @returns {Promise<void>}
+     * The function `handleAllPrivateAppsCreationProcess` handles the creation process for all private
+     * apps in a developer hub, including checking for existing apps, getting confirmation from the user,
+     * and creating the apps if necessary.
+     * @returns a Promise that resolves to void.
      */
     handleAllPrivateAppsCreationProcess(): Promise<void>;
-    createPrivateApps(app: any, uidCleaned?: boolean, appSuffix?: number): Promise<any>;
-    updateManifestUILocations(locations: any, type?: string, appSuffix?: number): Promise<any[]>;
+    /**
+     * The function checks if a private app exists in the developer hub.
+     * @param {App} app - The `app` parameter is an object representing an application. It likely has
+     * properties such as `uid` which is a unique identifier for the app.
+     * @returns a boolean value. It returns true if the installation object is not empty, and false if
+     * the installation object is empty.
+     */
+    isPrivateAppExistInDeveloperHub(app: Installation): Promise<boolean>;
+    /**
+     * The function creates a private app in a marketplace, with an optional suffix for the app name and
+     * an option to update the UI location.
+     * @param {Manifest} app - The `app` parameter is an object that represents the manifest of the app
+     * being created. It contains various properties such as `name`, `ui_location`, and `uid`.
+     * @param [appSuffix=1] - The appSuffix parameter is an optional parameter that specifies a suffix to
+     * be added to the app's UI location. It is used when updating the UI location of the app.
+     * @param [updateUiLocation=false] - A boolean value indicating whether to update the UI location of
+     * the app.
+     * @returns the result of the `appCreationCallback` function, which takes in the `app`, `response`,
+     * and `appSuffix` as arguments.
+     */
+    createPrivateApp(app: Manifest, appSuffix?: number, updateUiLocation?: boolean): Promise<any>;
+    /**
+     * The function installs an app from a marketplace onto a target stack.
+     * @param {ImportConfig} config - The `config` parameter is an object that contains the configuration
+     * for the installation. It likely includes information such as the target stack UID and other
+     * relevant details.
+     * @param {string} [appManifestUid] - The `appManifestUid` parameter is the unique identifier of the
+     * app manifest. It is used to specify which app to install from the marketplace.
+     * @returns a Promise that resolves to an object.
+     */
+    installApp(config: ImportConfig, appManifestUid?: string): Promise<any>;
+    /**
+     * The function updates the names of locations in a manifest UI based on a given app suffix.
+     * @param {any} locations - An array of objects representing different locations in a manifest file.
+     * Each object has a "meta" property which is an array of objects representing metadata for that
+     * location.
+     * @param [appSuffix=1] - The `appSuffix` parameter is an optional parameter that specifies a suffix
+     * to be added to the app name. It is set to 1 by default.
+     * @returns The function `updateManifestUILocations` returns an updated array of `locations`.
+     */
+    updateManifestUILocations(locations: any, appSuffix?: number): any[];
+    /**
+     * The function `appCreationCallback` handles the creation of a new app and handles any conflicts or
+     * errors that may occur during the process.
+     * @param {any} app - The `app` parameter is an object representing the app that is being created. It
+     * contains various properties such as `uid` (unique identifier), `name`, and other app-specific
+     * details.
+     * @param {any} response - The `response` parameter is an object that contains the response received
+     * from an API call. It may have properties such as `statusText` and `message`.
+     * @param {number} appSuffix - The `appSuffix` parameter is a number that is used to generate a
+     * unique suffix for the app name in case of a name conflict. It is incremented each time a name
+     * conflict occurs to ensure that the new app name is unique.
+     * @returns a Promise.
+     */
     appCreationCallback(app: any, response: any, appSuffix: number): Promise<any>;
     /**
      * @method installApps
@@ -48,8 +118,10 @@ export default class ImportMarketplaceApps extends BaseClass {
      */
     installApps(app: any): Promise<void>;
     /**
-     * @method updateAppsConfig
-     * @returns {Promise<void>}
+     * The `updateAppsConfig` function updates the configuration and server configuration of an app in a
+     * marketplace.
+     * @param {Installation} app - The `app` parameter is an object that represents an installation of an
+     * app. It contains the following properties:
      */
-    updateAppsConfig(app: any): Promise<void>;
+    updateAppsConfig(app: Installation): Promise<void>;
 }