@contentstack/cli-cm-import 1.12.2 → 1.13.1

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.2 linux-x64 node-v18.19.0
+@contentstack/cli-cm-import/1.13.1 linux-x64 node-v18.19.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -83,6 +83,7 @@ FLAGS
                                     <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
@@ -106,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]`
@@ -131,6 +132,7 @@ FLAGS
                                     <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
@@ -154,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({
@@ -120,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,63 @@ 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);
+            }
+            else if (this.importConfig.modules.types.length) {
+                this.importConfig.modules.types
+                    .filter((val) => ['content-types', 'global-fields', 'entries'].includes(val))
+                    .forEach((val) => {
+                    args.push('--modules', val);
+                });
+            }
+            (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.log)(this.importConfig, `Audit failed with following error. ${error}`, 'error');
+        }
+    }
 }
 exports.default = ModuleImporter;

package/lib/types/import-config.d.ts

@@ -45,6 +45,7 @@ export default interface ImportConfig extends DefaultConfig, ExternalConfig {
     contentVersion: number;
     replaceExisting?: boolean;
     skipExisting?: boolean;
+    skipAudit?: boolean;
 }
 type branch = {
     uid: string;

package/lib/utils/content-type-helper.js

@@ -147,6 +147,15 @@ const removeReferenceFields = async function (schema, flag = { supressed: false
             flag.supressed = true;
             schema[i].reference_to = ['sys_assets'];
         }
+        else if (
+        // handling entry references in rte
+        schema[i].data_type === 'text' &&
+            schema[i].field_metadata.rich_text_type &&
+            schema[i].field_metadata.embed_entry &&
+            schema[i].reference_to.length >= 1) {
+            flag.supressed = true;
+            schema[i].reference_to = ['sys_assets'];
+        }
     }
 };
 exports.removeReferenceFields = removeReferenceFields;

package/lib/utils/import-config-handler.js

@@ -60,8 +60,9 @@ const setupConfig = async (importCmdFlags) => {
     config.isAuthenticated = (0, cli_utilities_1.isAuthenticated)();
     //Note to support the old key
     config.source_stack = config.apiKey;
-    config.importWebhookStatus = importCmdFlags['import-webhook-status'];
+    config.skipAudit = importCmdFlags['skip-audit'];
     config.forceStopMarketplaceAppsPrompt = importCmdFlags.yes;
+    config.importWebhookStatus = importCmdFlags['import-webhook-status'];
     config.skipPrivateAppRecreationIfExist = importCmdFlags['skip-app-recreation'];
     if (importCmdFlags['branch']) {
         config.branchName = importCmdFlags['branch'];

package/lib/utils/log.d.ts

@@ -2,9 +2,11 @@ import { LogEntry } from 'winston/index';
 import { Logger } from '@contentstack/cli-utilities';
 import { LogsType, MessageType } from '@contentstack/cli-utilities/lib/logger';
 import { ImportConfig } from '../types';
+declare let logger: Logger;
 export declare function isImportConfig(config: ImportConfig | MessageType): config is ImportConfig;
 export declare function log(entry: LogEntry): void;
 export declare function log(error: MessageType, logType: LogsType): void;
 export declare function log(error: MessageType, logType: 'error', hidden: boolean): void;
 export declare function initLogger(config?: ImportConfig | undefined): Logger;
+export { logger };
 export declare const trace: typeof log;

package/lib/utils/log.js

@@ -1,15 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.trace = exports.initLogger = exports.log = exports.isImportConfig = void 0;
+exports.trace = exports.logger = exports.initLogger = exports.log = exports.isImportConfig = void 0;
 const path_1 = require("path");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
 let logger;
+exports.logger = logger;
 function isImportConfig(config) {
     return config.data !== undefined && (config === null || config === void 0 ? void 0 : config.contentVersion) !== undefined;
 }
 exports.isImportConfig = isImportConfig;
 function log(entryOrMessage, logType, hidden) {
-    logger = initLogger();
+    exports.logger = logger = initLogger();
     if (logType === 'error') {
         logger.log(entryOrMessage, logType, hidden);
     }
@@ -22,7 +23,7 @@ function initLogger(config) {
     var _a;
     if (!logger) {
         const basePath = (0, path_1.join)((_a = config === null || config === void 0 ? void 0 : config.data) !== null && _a !== void 0 ? _a : process.cwd(), 'logs', 'import');
-        logger = new cli_utilities_1.Logger(Object.assign(config !== null && config !== void 0 ? config : {}, { basePath }));
+        exports.logger = logger = new cli_utilities_1.Logger(Object.assign(config !== null && config !== void 0 ? config : {}, { basePath }));
     }
     return logger;
 }

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.12.2",
+  "version": "1.13.1",
   "commands": {
     "cm:stacks:import": {
       "id": "cm:stacks:import",
@@ -20,7 +20,7 @@
         "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"
       ],
       "flags": {
         "config": {
@@ -142,6 +142,12 @@
           "description": "Skips the module exists warning messages.",
           "required": false,
           "allowNo": false
+        },
+        "skip-audit": {
+          "name": "skip-audit",
+          "type": "boolean",
+          "description": "Skips the audit fix.",
+          "allowNo": false
         }
       },
       "args": {}

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@contentstack/cli-cm-import",
   "description": "Contentstack CLI plugin to import content into stack",
-  "version": "1.12.2",
+  "version": "1.13.1",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
+    "@contentstack/cli-audit": "^1.3.2",
     "@contentstack/cli-command": "~1.2.16",
-    "@contentstack/cli-utilities": "~1.5.9",
+    "@contentstack/cli-utilities": "~1.5.10",
     "@contentstack/management": "~1.13.0",
     "@oclif/core": "^2.9.3",
-    "axios": "^1.6.0",
     "big-json": "^3.2.0",
     "bluebird": "^3.7.2",
     "chalk": "^4.1.2",
@@ -99,4 +99,4 @@
     }
   },
   "repository": "https://github.com/contentstack/cli"
-}
+}