@contentstack/cli-cm-import 1.2.2 → 1.2.4

package/README.md

@@ -37,7 +37,7 @@ $ npm install -g @contentstack/cli-cm-import
 $ csdx COMMAND
 running command...
 $ csdx (-v|--version|version)
-@contentstack/cli-cm-import/1.2.2 darwin-x64 node-v18.12.1
+@contentstack/cli-cm-import/1.2.4 linux-x64 node-v16.18.1
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -68,7 +68,7 @@ OPTIONS
   -k, --stack-api-key=stack-api-key        API key of the target stack
   -m, --module=module                      [optional] specific module name
   -y, --yes                                [optional] Override marketplace prompts
-  --import-webhook-status=disable|current  [default: disable] Webhook state
+  --import-webhook-status=disable|current  [default: disable] [optional] Webhook state
 
 DESCRIPTION
   ...

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"1.2.2","commands":{"cm:stacks:import":{"id":"cm:stacks:import","description":"Import script for importing the content into the new stack\n...\nOnce you export content from the source stack, import it to your destination stack by using the cm:stacks:import command.\n","usage":"cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]","pluginName":"@contentstack/cli-cm-import","pluginType":"core","aliases":["cm:import"],"examples":["csdx cm:stacks:import --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>","csdx cm:stacks:import --config <path/of/config/dir>","csdx cm:stacks:import --module <single module name>","csdx cm:stacks:import --module <single module name> --backup-dir <backup dir>","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"],"flags":{"config":{"name":"config","type":"option","char":"c","description":"[optional] path of config file"},"stack-uid":{"name":"stack-uid","type":"option","char":"s","description":"API key of the target stack","hidden":true},"stack-api-key":{"name":"stack-api-key","type":"option","char":"k","description":"API key of the target stack"},"data":{"name":"data","type":"option","description":"path and location where data is stored","hidden":true},"data-dir":{"name":"data-dir","type":"option","char":"d","description":"path and location where data is stored"},"alias":{"name":"alias","type":"option","char":"a","description":"alias of the management token"},"management-token-alias":{"name":"management-token-alias","type":"option","description":"alias of the management token","hidden":true},"auth-token":{"name":"auth-token","type":"boolean","char":"A","description":"to use auth token","hidden":true,"allowNo":false},"module":{"name":"module","type":"option","char":"m","description":"[optional] specific module name"},"backup-dir":{"name":"backup-dir","type":"option","char":"b","description":"[optional] backup directory name when using specific module"},"branch":{"name":"branch","type":"option","char":"B","description":"[optional] branch name"},"import-webhook-status":{"name":"import-webhook-status","type":"option","description":"Webhook state","required":false,"options":["disable","current"],"default":"disable"},"yes":{"name":"yes","type":"boolean","char":"y","description":"[optional] Override marketplace prompts","required":false,"allowNo":false}},"args":[]}}}
+{"version":"1.2.4","commands":{"cm:stacks:import":{"id":"cm:stacks:import","description":"Import script for importing the content into the new stack\n...\nOnce you export content from the source stack, import it to your destination stack by using the cm:stacks:import command.\n","usage":"cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]","pluginName":"@contentstack/cli-cm-import","pluginType":"core","aliases":["cm:import"],"examples":["csdx cm:stacks:import --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>","csdx cm:stacks:import --config <path/of/config/dir>","csdx cm:stacks:import --module <single module name>","csdx cm:stacks:import --module <single module name> --backup-dir <backup dir>","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"],"flags":{"config":{"name":"config","type":"option","char":"c","description":"[optional] path of config file"},"stack-uid":{"name":"stack-uid","type":"option","char":"s","description":"API key of the target stack","hidden":true},"stack-api-key":{"name":"stack-api-key","type":"option","char":"k","description":"API key of the target stack"},"data":{"name":"data","type":"option","description":"path and location where data is stored","hidden":true},"data-dir":{"name":"data-dir","type":"option","char":"d","description":"path and location where data is stored"},"alias":{"name":"alias","type":"option","char":"a","description":"alias of the management token"},"management-token-alias":{"name":"management-token-alias","type":"option","description":"alias of the management token","hidden":true},"auth-token":{"name":"auth-token","type":"boolean","char":"A","description":"to use auth token","hidden":true,"allowNo":false},"module":{"name":"module","type":"option","char":"m","description":"[optional] specific module name"},"backup-dir":{"name":"backup-dir","type":"option","char":"b","description":"[optional] backup directory name when using specific module"},"branch":{"name":"branch","type":"option","char":"B","description":"[optional] branch name"},"import-webhook-status":{"name":"import-webhook-status","type":"option","description":"[optional] Webhook state","required":false,"options":["disable","current"],"default":"disable"},"yes":{"name":"yes","type":"boolean","char":"y","description":"[optional] Override marketplace prompts","required":false,"allowNo":false}},"args":[]}}}

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@contentstack/cli-cm-import",
   "description": "Contentstack CLI plugin to import content into stack",
-  "version": "1.2.2",
+  "version": "1.2.4",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
-    "@contentstack/cli-command": "^1.0.2",
-    "@contentstack/management": "^1.3.0",
-    "@contentstack/cli-utilities": "^1.0.3",
+    "@contentstack/cli-command": "^1.0.4",
+    "@contentstack/management": "^1.6.0",
+    "@contentstack/cli-utilities": "^1.0.5",
     "@oclif/command": "^1.8.16",
     "@oclif/config": "^1.18.3",
     "big-json": "^3.2.0",
@@ -22,7 +22,6 @@
   },
   "devDependencies": {
     "@oclif/dev-cli": "^1.22.2",
-    "@oclif/plugin-help": "^5.1.12",
     "@oclif/test": "^1.2.6",
     "chai": "^4.2.0",
     "eslint": "^8.18.0",
@@ -63,9 +62,6 @@
   "oclif": {
     "commands": "./src/commands",
     "bin": "csdx",
-    "devPlugins": [
-      "@oclif/plugin-help"
-    ],
     "repositoryPrefix": "<%- repo %>/blob/main/packages/contentstack-import/<%- commandPath %>"
   },
   "repository": "https://github.com/contentstack/cli"

package/src/app.js

@@ -137,14 +137,24 @@ let allImport = async (config, types) => {
       );
       addlogs(config, 'The log for this is stored at ' + path.join(config.data, 'logs', 'import'), 'success');
     } else {
-      addlogs(config, chalk.green('Stack: ' + config.target_stack + ' has been imported succesfully!'), 'success');
+      addlogs(
+        config,
+        chalk.green(
+          'Data has been imported to stack ' + (config.destinationStackName || config.target_stack) + '  succesfully!',
+        ),
+        'success',
+      );
       addlogs(config, 'The log for this is stored at ' + path.join(config.oldPath, 'logs', 'import'), 'success');
     }
     return true;
   } catch (error) {
     addlogs(
       config,
-      chalk.red('Failed to migrate stack: ' + config.target_stack + '. Please check error logs for more info'),
+      chalk.red(
+        'Failed to migrate stack: ' +
+          (config.destinationStackName || config.target_stack) +
+          '. Please check error logs for more info',
+      ),
       'error',
     );
     addlogs(config, formatError(error), 'error');

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

@@ -34,7 +34,7 @@ class ImportCommand extends Command {
         defaultConfig.data = data;
       }
 
-      defaultConfig.forceMarketplaceAppsImport = importCommandFlags.yes
+      defaultConfig.forceStopMarketplaceAppsPrompt = importCommandFlags.yes;
 
       if (alias) {
         let managementTokens = self.getToken(alias);
@@ -173,7 +173,7 @@ ImportCommand.flags = {
     parse: printFlagDeprecation(['-B'], ['--branch']),
   }),
   'import-webhook-status': flags.string({
-    description: 'Webhook state',
+    description: '[optional] Webhook state',
     options: ['disable', 'current'],
     required: false,
     default: 'disable',
@@ -181,8 +181,8 @@ ImportCommand.flags = {
   yes: flags.boolean({
     char: 'y',
     required: false,
-    description: '[optional] Override marketplace prompts'
-  })
+    description: '[optional] Override marketplace prompts',
+  }),
 };
 
 ImportCommand.aliases = ['cm:import'];

package/src/config/default.js

@@ -336,6 +336,9 @@ module.exports = {
   importConcurrency: 5,
   fetchConcurrency: 5,
   writeConcurrency: 5,
+  developerHubBaseUrl: '',
+  marketplaceAppEncryptionKey: 'nF2ejRQcTv',
+  getEncryptionKeyMaxRetry: 3,
   // useBackedupDir: '',
   // backupConcurrency: 10,
 };

package/src/lib/import/custom-roles.js

@@ -103,13 +103,17 @@ module.exports = class ImportCustomRoles {
         } catch (error) {
           self.fails.push(customRole);
 
-          if (error && error.errors && error.errors.name) {
-            addlogs(self.config, chalk.red(`custom-role: ${customRole.name} already exists`), 'error');
+          if (((error && error.errors && error.errors.name) || '').includes('is not a unique.')) {
+            addlogs(self.config, chalk.red(`${customRole.name} role already exists`), 'info');
           } else {
-            addlogs(self.config, chalk.red(`custom-role: ${customRole.name} failed`), 'error');
-          }
+            if (!(error && error.errors && error.errors.name)) {
+              addlogs(self.config, chalk.red(`custom-role: ${customRole.name} already exists`), 'error');
+            } else {
+              addlogs(self.config, chalk.red(`custom-role: ${customRole.name} failed`), 'error');
+            }
 
-          addlogs(self.config, formatError(error), 'error');
+            addlogs(self.config, formatError(error), 'error');
+          }
         }
       }
       addlogs(self.config, chalk.green('Custom-roles have been imported successfully!'), 'success');

package/src/lib/import/entries.js

@@ -780,19 +780,6 @@ EntriesImport.prototype = {
             }
           }
 
-          if (flag.jsonRte) {
-            self.ctJsonRte.push(uid);
-            if (flag.jsonRteEmbeddedEntries) {
-              self.ctJsonRteWithEntryRefs.push(uid);
-              // pushing ct uid to refSchemas, because
-              // repostEntries uses refSchemas content types for
-              // reposting entries
-              if (self.refSchemas.indexOf(uid) === -1) {
-                self.refSchemas.push(uid);
-              }
-            }
-          }
-
           // Replace extensions with new UID
           extension_suppress(contentTypeSchema.schema, config.preserveStackVersion, self.installedExtensions);
         }
@@ -1356,8 +1343,8 @@ EntriesImport.prototype = {
 
               if (entryRefs.length > 0) {
                 entryRefs.forEach((entryRef) => {
-                  if (!_.isEmpty(entry[entryRef.uid]) && entry[entryRef.uid].children) {
-                    entry[entryRef.uid].children.splice(entryRef.index, 0, entryRef.value);
+                  if (!_.isEmpty(entry[element.uid]) && entry[element.uid].children) {
+                    entry[element.uid].children.splice(entryRef.index, 0, entryRef.value);
                   }
                 });
               }

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

@@ -30,7 +30,7 @@ module.exports = class ImportMarketplaceApps {
 
   async start() {
     this.client = sdk.Client(this.config);
-    this.developerHubBaseUrl = await getDeveloperHubUrl();
+    this.developerHubBaseUrl = this.config.developerHubBaseUrl || (await getDeveloperHubUrl());
     this.marketplaceAppFolderPath = path.resolve(this.config.data, this.marketplaceAppConfig.dirName);
     this.marketplaceApps = _.uniqBy(
       readFileSync(path.resolve(this.marketplaceAppFolderPath, this.marketplaceAppConfig.fileName)),
@@ -74,18 +74,68 @@ module.exports = class ImportMarketplaceApps {
     }
   };
 
+  async getEncryptionKeyAndValidate(defaultValue, retry = 1) {
+    const appConfig =
+      _.find(this.marketplaceApps, 'configuration') ||
+      _.find(this.marketplaceApps, 'server_configuration.configuration');
+
+    if (appConfig) {
+      const encryptionKey = await cliux.inquire({
+        type: 'input',
+        name: 'name',
+        default: defaultValue,
+        validate: (key) => {
+          if (!key) return "Encryption key can't be empty.";
+
+          return true;
+        },
+        message: 'Enter marketplace app configurations encryption key',
+      });
+
+      try {
+        const nodeCrypto = new NodeCrypto({ encryptionKey });
+        nodeCrypto.decrypt(appConfig.configuration || appConfig.server_configuration);
+      } catch (error) {
+        if (retry < this.config.getEncryptionKeyMaxRetry && error.code === 'ERR_OSSL_EVP_BAD_DECRYPT') {
+          cliux.print('Provided encryption key is not valid or your data might be corrupted.!', { color: 'red' });
+          // NOTE max retry limit is 3
+          return this.getEncryptionKeyAndValidate(encryptionKey, retry + 1);
+        } else {
+          cliux.print('Maximum retry limit exceeded. Closing the process, please try again.!', { color: 'red' });
+          process.exit(1);
+        }
+      }
+
+      return encryptionKey;
+    }
+
+    return defaultValue;
+  }
+
   /**
    * @method handleInstallationProcess
    * @returns {Promise<void>}
    */
   handleInstallationProcess = async () => {
     const self = this;
+    const cryptoArgs = {};
     const headers = {
       authtoken: self.config.auth_token,
       organization_uid: self.config.org_uid,
     };
+
+    if (self.config.marketplaceAppEncryptionKey) {
+      cryptoArgs['encryptionKey'] = self.config.marketplaceAppEncryptionKey;
+    }
+
+    if (self.config.forceStopMarketplaceAppsPrompt) {
+      cryptoArgs['encryptionKey'] = self.config.marketplaceAppEncryptionKey;
+    } else {
+      cryptoArgs['encryptionKey'] = await self.getEncryptionKeyAndValidate(self.config.marketplaceAppEncryptionKey);
+    }
+
     const httpClient = new HttpClient().headers(headers);
-    const nodeCrypto = new NodeCrypto();
+    const nodeCrypto = new NodeCrypto(cryptoArgs);
 
     // NOTE install all private apps which is not available for stack.
     await this.handleAllPrivateAppsCreationProcess({ httpClient });
@@ -148,7 +198,7 @@ module.exports = class ImportMarketplaceApps {
       (app) => !_.includes(_.map(installedDeveloperHubApps, 'uid'), app.app_uid),
     );
 
-    if (!_.isEmpty(listOfNotInstalledPrivateApps) && !self.config.forceMarketplaceAppsImport) {
+    if (!_.isEmpty(listOfNotInstalledPrivateApps) && !self.config.forceStopMarketplaceAppsPrompt) {
       const confirmation = await cliux.confirm(
         chalk.yellow(
           `WARNING!!! The listed apps are private apps that are not available in the destination stack: \n\n${_.map(
@@ -258,12 +308,12 @@ module.exports = class ImportMarketplaceApps {
             log(self.config, message, 'error');
 
             if (_.toLower(error) === 'conflict') {
-              const appName = self.config.forceMarketplaceAppsImport
+              const appName = self.config.forceStopMarketplaceAppsPrompt
                 ? self.getAppName(app.manifest.name, appSuffix)
                 : await cliux.inquire({
                     type: 'input',
                     name: 'name',
-                    default: `${app.manifest.name}-1`,
+                    default: self.getAppName(app.manifest.name, appSuffix),
                     validate: this.validateAppName,
                     message: `${message}. Enter a new name to create an app.?`,
                   });
@@ -274,7 +324,7 @@ module.exports = class ImportMarketplaceApps {
                 .then(resolve)
                 .catch(resolve);
             } else {
-              if (self.config.forceMarketplaceAppsImport) return resolve();
+              if (self.config.forceStopMarketplaceAppsPrompt) return resolve();
 
               const confirmation = await cliux.confirm(
                 chalk.yellow(
@@ -369,7 +419,7 @@ module.exports = class ImportMarketplaceApps {
                   { color: 'yellow' },
                 );
 
-                const configOption = self.config.forceMarketplaceAppsImport
+                const configOption = self.config.forceStopMarketplaceAppsPrompt
                   ? 'Update it with the new configuration.'
                   : await cliux.inquire({
                       choices: [
@@ -394,7 +444,7 @@ module.exports = class ImportMarketplaceApps {
                 }
               }
             } else {
-              if (!self.config.forceMarketplaceAppsImport) {
+              if (!self.config.forceStopMarketplaceAppsPrompt) {
                 cliux.print(`WARNING!!! ${message || error_message}`, { color: 'yellow' });
                 const confirmation = await cliux.confirm(
                   chalk.yellow(
@@ -431,6 +481,27 @@ module.exports = class ImportMarketplaceApps {
     });
   };
 
+  updateConfigData(config) {
+    const configKeyMapper = {};
+    const serverConfigKeyMapper = {
+      cmsApiKey: this.config.target_stack,
+    };
+
+    if (!_.isEmpty(config.configuration) && !_.isEmpty(configKeyMapper)) {
+      _.forEach(_.keys(configKeyMapper), (key) => {
+        config.configuration[key] = configKeyMapper[key];
+      });
+    }
+
+    if (!_.isEmpty(config.server_configuration) && !_.isEmpty(serverConfigKeyMapper)) {
+      _.forEach(_.keys(serverConfigKeyMapper), (key) => {
+        config.server_configuration[key] = serverConfigKeyMapper[key];
+      });
+    }
+
+    return config;
+  }
+
   /**
    * @method updateAppsConfig
    * @param {Object<{ data, app, httpClient, nodeCrypto }>} param
@@ -439,7 +510,7 @@ module.exports = class ImportMarketplaceApps {
   updateAppsConfig = ({ data, app, httpClient, nodeCrypto }) => {
     const self = this;
     return new Promise((resolve, reject) => {
-      const payload = {};
+      let payload = {};
       const { title, configuration, server_configuration } = app;
 
       if (!_.isEmpty(configuration)) {
@@ -449,6 +520,8 @@ module.exports = class ImportMarketplaceApps {
         payload['server_configuration'] = nodeCrypto.decrypt(server_configuration);
       }
 
+      payload = self.updateConfigData(payload);
+
       if (_.isEmpty(data) || _.isEmpty(payload) || !data.installation_uid) {
         resolve();
       } else {

package/src/lib/util/marketplace-app-helper.js

@@ -3,13 +3,13 @@ const sdk = require('./contentstack-management-sdk');
 const { cliux, HttpClient, configHandler } = require('@contentstack/cli-utilities');
 
 const getInstalledExtensions = (config) => {
-  const client = sdk.Client(config)
+  const client = sdk.Client(config);
 
   return new Promise((resolve, reject) => {
     const queryRequestOptions = {
-      include_marketplace_extensions: true
-    }
-    const { target_stack: api_key, management_token, auth_token } = config || {}
+      include_marketplace_extensions: true,
+    };
+    const { target_stack: api_key, management_token, auth_token } = config || {};
 
     if (api_key && management_token) {
       return client
@@ -18,21 +18,22 @@ const getInstalledExtensions = (config) => {
         .query(queryRequestOptions)
         .find()
         .then(({ items }) => resolve(items))
-        .catch(reject)
+        .catch(reject);
     } else if (api_key && auth_token) {
       const { cma } = configHandler.get('region') || {};
       const headers = {
         api_key,
-        authtoken: auth_token
-      }
+        authtoken: auth_token,
+      };
       const httpClient = new HttpClient().headers(headers);
-      httpClient.get(`${cma}/v3/extensions/?include_marketplace_extensions=true`)
-        .then(({ data: { extensions } }) => resolve(extensions))
+      httpClient
+        .get(`${cma}/v3/extensions/?include_marketplace_extensions=true`)
+        .then(({ data: { extensions } }) => resolve(extensions));
     } else {
-      resolve([])
+      resolve([]);
     }
-  })
-}
+  });
+};
 
 const getDeveloperHubUrl = async () => {
   const { cma, name } = configHandler.get('region') || {};
@@ -47,11 +48,11 @@ const getDeveloperHubUrl = async () => {
 
         return true;
       },
-      message: `Enter the developer-hub base URL for the ${name} region - `,
+      message: `Enter the developer-hub base URL for the ${name} region -`,
     });
   }
 
   return developerHubBaseUrl.startsWith('http') ? developerHubBaseUrl : `https://${developerHubBaseUrl}`;
-}
+};
 
-module.exports = { getInstalledExtensions, getDeveloperHubUrl }
+module.exports = { getInstalledExtensions, getDeveloperHubUrl };