@contentstack/cli-cm-import 1.19.3 → 1.19.5

package/README.md

@@ -2,7 +2,7 @@
 
 It is Contentstack’s CLI plugin to import content in the stack. To learn how to export and import content in Contentstack, refer to the [Migration guide](https://www.contentstack.com/docs/developers/cli/migration/).
 
-[![License](https://img.shields.io/npm/l/@contentstack/cli)](https://github.com/contentstack/cli/blob/main/LICENSE)it -m 
+[![License](https://img.shields.io/npm/l/@contentstack/cli)](https://github.com/contentstack/cli/blob/main/LICENSE)it -m
 
 <!-- toc -->
 * [Usage](#usage)
@@ -47,7 +47,7 @@ $ npm install -g @contentstack/cli-cm-import
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-cm-import/1.19.3 linux-x64 node-v18.20.5
+@contentstack/cli-cm-import/1.19.5 linux-x64 node-v22.14.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -75,13 +75,14 @@ FLAGS
                                       the branch name, then by default the content will be imported to the main branch.
   -a, --alias=<value>                 The management token of the destination stack where you will import the content.
   -b, --backup-dir=<value>            [optional] Backup directory name when using specific module.
-  -c, --config=<value>                [optional] Path of config file.
+  -c, --config=<value>                [optional] The path of the configuration JSON file containing all the options for
+                                      a single run.
   -d, --data-dir=<value>              The path or the location in your file system where the content, you intend to
                                       import, is stored. For example, -d "C:\Users\Name\Desktop\cli\content". If the
                                       export folder has branches involved, then the path should point till the
                                       particular branch. For example, “-d
                                       "C:\Users\Name\Desktop\cli\content\branch_name"
-  -k, --stack-api-key=<value>         API key of the target stack
+  -k, --stack-api-key=<value>         API Key of the target stack
   -m, --module=<value>                [optional] Specify the module to import into the target stack. If not specified,
                                       the import command will import all the modules into the stack. The available
                                       modules are assets, content-types, entries, environments, extensions,
@@ -89,12 +90,12 @@ FLAGS
                                       custom-roles, and taxonomies.
   -y, --yes                           [optional] Force override all Marketplace prompts.
   --exclude-global-modules            Excludes the branch-independent module from the import operation.
-  --import-webhook-status=<option>    [default: disable] [optional] This webhook state keeps the same state of webhooks
-                                      as the source stack.
+  --import-webhook-status=<option>    [default: disable] [default: disable] (optional) This webhook state keeps the same
+                                      state of webhooks as the source stack. <options: disable|current>
                                       <options: disable|current>
-  --personalize-project-name=<value>  Personalize project name.
+  --personalize-project-name=<value>  (optional) Provide a unique name for the Personalize project.
   --replace-existing                  Replaces the existing module in the target stack.
-  --skip-app-recreation               [optional] Skip private apps recreation if already exist
+  --skip-app-recreation               (optional) Skips the recreation of private apps if they already exist.
   --skip-audit                        Skips the audit fix that occurs during an import operation.
   --skip-existing                     Skips the module exists warning messages.
 
@@ -136,13 +137,14 @@ FLAGS
                                       the branch name, then by default the content will be imported to the main branch.
   -a, --alias=<value>                 The management token of the destination stack where you will import the content.
   -b, --backup-dir=<value>            [optional] Backup directory name when using specific module.
-  -c, --config=<value>                [optional] Path of config file.
+  -c, --config=<value>                [optional] The path of the configuration JSON file containing all the options for
+                                      a single run.
   -d, --data-dir=<value>              The path or the location in your file system where the content, you intend to
                                       import, is stored. For example, -d "C:\Users\Name\Desktop\cli\content". If the
                                       export folder has branches involved, then the path should point till the
                                       particular branch. For example, “-d
                                       "C:\Users\Name\Desktop\cli\content\branch_name"
-  -k, --stack-api-key=<value>         API key of the target stack
+  -k, --stack-api-key=<value>         API Key of the target stack
   -m, --module=<value>                [optional] Specify the module to import into the target stack. If not specified,
                                       the import command will import all the modules into the stack. The available
                                       modules are assets, content-types, entries, environments, extensions,
@@ -150,12 +152,12 @@ FLAGS
                                       custom-roles, and taxonomies.
   -y, --yes                           [optional] Force override all Marketplace prompts.
   --exclude-global-modules            Excludes the branch-independent module from the import operation.
-  --import-webhook-status=<option>    [default: disable] [optional] This webhook state keeps the same state of webhooks
-                                      as the source stack.
+  --import-webhook-status=<option>    [default: disable] [default: disable] (optional) This webhook state keeps the same
+                                      state of webhooks as the source stack. <options: disable|current>
                                       <options: disable|current>
-  --personalize-project-name=<value>  Personalize project name.
+  --personalize-project-name=<value>  (optional) Provide a unique name for the Personalize project.
   --replace-existing                  Replaces the existing module in the target stack.
-  --skip-app-recreation               [optional] Skip private apps recreation if already exist
+  --skip-app-recreation               (optional) Skips the recreation of private apps if they already exist.
   --skip-audit                        Skips the audit fix that occurs during an import operation.
   --skip-existing                     Skips the module exists warning messages.
 

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

@@ -55,7 +55,7 @@ ImportCommand.examples = [
 ImportCommand.flags = {
     config: cli_utilities_1.flags.string({
         char: 'c',
-        description: '[optional] Path of config file.',
+        description: '[optional] The path of the configuration JSON file containing all the options for a single run.',
     }),
     'stack-uid': cli_utilities_1.flags.string({
         char: 's',
@@ -65,7 +65,7 @@ ImportCommand.flags = {
     }),
     'stack-api-key': cli_utilities_1.flags.string({
         char: 'k',
-        description: 'API key of the target stack',
+        description: 'API Key of the target stack',
     }),
     data: cli_utilities_1.flags.string({
         description: 'path and location where data is stored',
@@ -108,7 +108,7 @@ ImportCommand.flags = {
         parse: (0, cli_utilities_1.printFlagDeprecation)(['-B'], ['--branch']),
     }),
     'import-webhook-status': cli_utilities_1.flags.string({
-        description: '[optional] This webhook state keeps the same state of webhooks as the source stack.',
+        description: '[default: disable] (optional) This webhook state keeps the same state of webhooks as the source stack. <options: disable|current>',
         options: ['disable', 'current'],
         required: false,
         default: 'disable',
@@ -119,7 +119,7 @@ ImportCommand.flags = {
         description: '[optional] Force override all Marketplace prompts.',
     }),
     'skip-app-recreation': cli_utilities_1.flags.boolean({
-        description: '[optional] Skip private apps recreation if already exist',
+        description: '(optional) Skips the recreation of private apps if they already exist.',
     }),
     'replace-existing': cli_utilities_1.flags.boolean({
         required: false,
@@ -132,7 +132,7 @@ ImportCommand.flags = {
     }),
     'personalize-project-name': cli_utilities_1.flags.string({
         required: false,
-        description: 'Personalize project name.',
+        description: '(optional) Provide a unique name for the Personalize project.',
     }),
     'skip-audit': cli_utilities_1.flags.boolean({
         description: 'Skips the audit fix that occurs during an import operation.',

package/lib/config/index.js

@@ -428,7 +428,7 @@ const config = {
     getEncryptionKeyMaxRetry: 3,
     // useBackedupDir: '',
     // backupConcurrency: 10,
-    onlyTSModules: ['taxonomies'],
+    onlyTSModules: ['taxonomies', 'personalize'],
     auditConfig: {
         noLog: false,
         skipConfirm: true,

package/lib/import/modules/entries.js

@@ -757,26 +757,34 @@ class EntriesImport extends base_class_1.default {
                 let apiContentDuplicate = [];
                 apiContentDuplicate = apiContent.flatMap((content) => {
                     var _a;
-                    return (_a = content === null || content === void 0 ? void 0 : content.publish_details) === null || _a === void 0 ? void 0 : _a.map((publish) => (Object.assign(Object.assign({}, content), { locale: publish.locale, publish_details: [publish] })));
+                    if (((_a = content === null || content === void 0 ? void 0 : content.publish_details) === null || _a === void 0 ? void 0 : _a.length) > 0) {
+                        return content.publish_details.map((publish) => (Object.assign(Object.assign({}, content), { locale: publish.locale, publish_details: [publish] })));
+                    }
+                    return []; // Return an empty array if publish_details is empty
                 });
                 apiContent = apiContentDuplicate;
-                await this.makeConcurrentCall({
-                    apiContent,
-                    processName,
-                    indexerCount,
-                    currentIndexer: +index,
-                    apiParams: {
-                        reject: onReject,
-                        resolve: onSuccess,
-                        entity: 'publish-entries',
-                        includeParamOnCompletion: true,
-                        serializeData: this.serializePublishEntries.bind(this),
-                        additionalInfo: { contentType, locale, cTUid },
-                    },
-                    concurrencyLimit: this.importConcurrency,
-                }).then(() => {
-                    (0, utils_1.log)(this.importConfig, `Published entries for content type ${cTUid} in locale ${locale}`, 'success');
-                });
+                if ((apiContent === null || apiContent === void 0 ? void 0 : apiContent.length) === 0) {
+                    continue;
+                }
+                else {
+                    await this.makeConcurrentCall({
+                        apiContent,
+                        processName,
+                        indexerCount,
+                        currentIndexer: +index,
+                        apiParams: {
+                            reject: onReject,
+                            resolve: onSuccess,
+                            entity: 'publish-entries',
+                            includeParamOnCompletion: true,
+                            serializeData: this.serializePublishEntries.bind(this),
+                            additionalInfo: { contentType, locale, cTUid },
+                        },
+                        concurrencyLimit: this.importConcurrency,
+                    }).then(() => {
+                        (0, utils_1.log)(this.importConfig, `Published entries for content type ${cTUid} in locale ${locale}`, 'success');
+                    });
+                }
             }
         }
     }

package/lib/import/modules/marketplace-apps.js

@@ -210,7 +210,8 @@ class ImportMarketplaceApps {
             .marketplace(this.importConfig.org_uid)
             .installation(app.uid)
             .fetch()
-            .catch(() => { }); // NOTE Keeping this to avoid Unhandled exception
+            .catch(() => { }); // NOTE Keeping this to avoid Unhandled exce
+        // ption
         return !(0, isEmpty_1.default)(installation);
     }
     /**

package/lib/utils/entries-helper.js

@@ -11,6 +11,7 @@ const _ = tslib_1.__importStar(require("lodash"));
 const config_1 = tslib_1.__importDefault(require("../config"));
 const fileHelper = tslib_1.__importStar(require("./file-helper"));
 const cli_utilities_1 = require("@contentstack/cli-utilities");
+const log_1 = require("./log");
 // update references in entry object
 const lookupEntries = function (data, mappedUids, uidMapperPath) {
     let parent = [];
@@ -212,6 +213,9 @@ const lookupEntries = function (data, mappedUids, uidMapperPath) {
                 entry = entry.replace(uidRegex, escapedMappedUid);
                 mapped.push(uid);
             }
+            else {
+                (0, log_1.log)(`Skipping the entry uid ${uid} since the regex is not valid`, 'warn');
+            }
         }
         else {
             unmapped.push(uid);

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.19.3",
+  "version": "1.19.5",
   "commands": {
     "cm:stacks:import": {
       "id": "cm:stacks:import",
@@ -28,7 +28,7 @@
           "name": "config",
           "type": "option",
           "char": "c",
-          "description": "[optional] Path of config file.",
+          "description": "[optional] The path of the configuration JSON file containing all the options for a single run.",
           "multiple": false
         },
         "stack-uid": {
@@ -43,7 +43,7 @@
           "name": "stack-api-key",
           "type": "option",
           "char": "k",
-          "description": "API key of the target stack",
+          "description": "API Key of the target stack",
           "multiple": false
         },
         "data": {
@@ -107,7 +107,7 @@
         "import-webhook-status": {
           "name": "import-webhook-status",
           "type": "option",
-          "description": "[optional] This webhook state keeps the same state of webhooks as the source stack.",
+          "description": "[default: disable] (optional) This webhook state keeps the same state of webhooks as the source stack. <options: disable|current>",
           "required": false,
           "multiple": false,
           "options": [
@@ -127,7 +127,7 @@
         "skip-app-recreation": {
           "name": "skip-app-recreation",
           "type": "boolean",
-          "description": "[optional] Skip private apps recreation if already exist",
+          "description": "(optional) Skips the recreation of private apps if they already exist.",
           "allowNo": false
         },
         "replace-existing": {
@@ -147,7 +147,7 @@
         "personalize-project-name": {
           "name": "personalize-project-name",
           "type": "option",
-          "description": "Personalize project name.",
+          "description": "(optional) Provide a unique name for the Personalize project.",
           "required": false,
           "multiple": false
         },

package/package.json

@@ -1,53 +1,45 @@
 {
   "name": "@contentstack/cli-cm-import",
   "description": "Contentstack CLI plugin to import content into stack",
-  "version": "1.19.3",
+  "version": "1.19.5",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
-    "@contentstack/cli-audit": "~1.7.3",
-    "@contentstack/cli-command": "~1.3.2",
-    "@contentstack/cli-utilities": "~1.8.0",
-    "@contentstack/management": "~1.18.3",
-    "@contentstack/cli-variants": "~1.1.3",
+    "@contentstack/cli-audit": "~1.7.5",
+    "@contentstack/cli-command": "~1.3.3",
+    "@contentstack/cli-utilities": "~1.8.2",
+    "@contentstack/management": "~1.18.4",
+    "@contentstack/cli-variants": "~1.1.5",
     "@oclif/core": "^3.27.0",
     "big-json": "^3.2.0",
     "bluebird": "^3.7.2",
     "chalk": "^4.1.2",
-    "debug": "^4.3.7",
+    "debug": "^4.4.0",
     "fs-extra": "^11.2.0",
     "lodash": "^4.17.21",
     "marked": "^4.3.0",
     "merge": "^2.1.1",
     "mkdirp": "^1.0.4",
     "promise-limit": "^2.7.0",
-    "tslib": "^2.8.1",
     "uuid": "^9.0.1",
     "winston": "^3.17.0"
   },
   "devDependencies": {
-    "@oclif/test": "^4.1.0",
+    "@oclif/test": "^4.1.6",
     "@types/big-json": "^3.2.5",
     "@types/bluebird": "^3.5.42",
-    "@types/chai": "^4.3.20",
     "@types/fs-extra": "^11.0.4",
     "@types/mkdirp": "^1.0.2",
     "@types/mocha": "^8.2.3",
     "@types/node": "^14.18.63",
-    "@types/sinon": "^10.0.20",
     "@types/tar": "^6.1.13",
     "@types/uuid": "^9.0.8",
     "@typescript-eslint/eslint-plugin": "^5.62.0",
-    "chai": "^4.5.0",
     "eslint": "^8.57.1",
     "eslint-config-oclif": "^4.0.0",
-    "globby": "^10.0.2",
     "mocha": "^10.8.2",
     "nyc": "^15.1.0",
     "oclif": "^3.17.2",
-    "rimraf": "^2.7.1",
-    "sinon": "^19.0.2",
-    "tmp": "^0.2.3",
     "ts-node": "^10.9.2",
     "typescript": "^4.9.5"
   },