@contentstack/cli-cm-import 1.3.0 → 1.4.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Contentstack
+Copyright (c) 2023 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

@@ -37,7 +37,7 @@ $ npm install -g @contentstack/cli-cm-import
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-cm-import/1.3.0 linux-x64 node-v16.19.0
+@contentstack/cli-cm-import/1.4.0 linux-x64 node-v16.19.1
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.3.0",
+  "version": "1.4.0",
   "commands": {
     "cm:stacks:import": {
       "id": "cm:stacks:import",

package/package.json

@@ -1,15 +1,16 @@
 {
   "name": "@contentstack/cli-cm-import",
   "description": "Contentstack CLI plugin to import content into stack",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
-    "@contentstack/cli-command": "^1.1.0",
-    "@contentstack/cli-utilities": "^1.1.0",
+    "@contentstack/cli-command": "^1.2.0",
+    "@contentstack/cli-utilities": "^1.2.0",
     "@oclif/config": "^1.18.3",
     "big-json": "^3.2.0",
     "bluebird": "^3.7.2",
+    "chalk": "^4.1.2",
     "debug": "^4.1.0",
     "lodash": "^4.17.20",
     "marked": "^4.0.17",
@@ -19,17 +20,17 @@
     "winston": "^3.7.2"
   },
   "devDependencies": {
-    "oclif": "^3.1.2",
     "@oclif/test": "^1.2.6",
     "chai": "^4.2.0",
     "eslint": "^8.18.0",
-    "eslint-config-oclif": "^3.1.0",
+    "eslint-config-oclif": "^4.0.0",
     "globby": "^10.0.2",
     "mocha": "^10.0.0",
-    "nyc": "^15.1.0"
+    "nyc": "^15.1.0",
+    "oclif": "^3.1.2"
   },
   "engines": {
-    "node": ">=8.0.0"
+    "node": ">=14.0.0"
   },
   "files": [
     "/npm-shrinkwrap.json",
@@ -48,7 +49,8 @@
     "postpack": "rm -f oclif.manifest.json",
     "prepack": "oclif manifest && oclif readme",
     "test": "nyc mocha --forbid-only \"test/**/*.test.js\"",
-    "version": "oclif readme && git add README.md"
+    "version": "oclif readme && git add README.md",
+    "clean": "rm -rf ./node_modules tsconfig.build.tsbuildinfo"
   },
   "csdxConfig": {
     "expiredCommands": {

package/src/app.js

@@ -48,7 +48,7 @@ exports.initial = (configData) => {
           })
           .catch((error) => {
             addlogs(config, `Failed to import contents ${util.formatError(error)}`, 'error');
-            reject(e);
+            reject(error);
             process.exit(1);
           });
       } else {

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

@@ -1,7 +1,7 @@
 const _ = require('lodash');
 const defaultConfig = require('../../../config/default');
-const { Command, flags } = require('@contentstack/cli-command');
-const { configHandler } = require('@contentstack/cli-utilities');
+const { Command } = require('@contentstack/cli-command');
+const { configHandler, flags, printFlagDeprecation } = require('@contentstack/cli-utilities');
 const {
   configWithMToken,
   parameterWithMToken,
@@ -10,7 +10,6 @@ const {
   parametersWithAuthToken,
   withoutParametersWithAuthToken,
 } = require('../../../lib/util/import-flags');
-const { printFlagDeprecation } = require('@contentstack/cli-utilities');
 
 class ImportCommand extends Command {
   async run() {

package/src/config/default.js

@@ -35,6 +35,11 @@ module.exports = {
       fileName: 'locales.json',
       requiredKeys: ['code', 'uid', 'name', 'fallback_locale'],
     },
+    masterLocale: {
+      dirName: 'locales',
+      fileName: 'master-locale.json',
+      requiredKeys: ['code', 'uid', 'name'],
+    },
     customRoles: {
       dirName: 'custom-roles',
       fileName: 'custom-roles.json',

package/src/lib/import/locales.js

@@ -11,6 +11,7 @@ let chalk = require('chalk');
 let mkdirp = require('mkdirp');
 let Promise = require('bluebird');
 let { isEmpty, merge, cloneDeep } = require('lodash');
+const { cliux } = require('@contentstack/cli-utilities');
 
 let helper = require('../util/fs');
 let { addlogs } = require('../util/log');
@@ -23,6 +24,7 @@ module.exports = class ImportLanguages {
   langUidMapper = {};
   masterLanguage = config.master_locale;
   langConfig = config.modules.locales;
+  sourceMasterLangConfig = config.modules.masterLocale;
   reqConcurrency = config.concurrency || config.fetchConcurrency || 1;
 
   constructor(importConfig, stackAPIClient) {
@@ -37,9 +39,10 @@ module.exports = class ImportLanguages {
     let langMapperPath = path.resolve(this.config.data, 'mapper', 'languages');
     let langFolderPath = path.resolve(this.config.data, this.langConfig.dirName);
     let langFailsPath = path.resolve(this.config.data, 'mapper', 'languages', 'fails.json');
-    let langSuccessPath = path.resolve(this.config.data, 'mapper', 'languages', 'success.json');
     let langUidMapperPath = path.resolve(this.config.data, 'mapper', 'languages', 'uid-mapper.json');
+    self.langSuccessPath = path.resolve(this.config.data, 'mapper', 'languages', 'success.json');
     self.languages = helper.readFileSync(path.resolve(langFolderPath, this.langConfig.fileName));
+    self.sourceMasterLanguages = helper.readFileSync(path.resolve(langFolderPath, this.sourceMasterLangConfig.fileName));
 
     mkdirp.sync(langMapperPath);
 
@@ -48,11 +51,22 @@ module.exports = class ImportLanguages {
       self.langUidMapper = self.langUidMapper || {};
     }
 
-    return new Promise(function (resolve, reject) {
+    return new Promise(async function (resolve, reject) {
       if (self.languages === undefined || isEmpty(self.languages)) {
         addlogs(self.config, chalk.white('No Languages Found'), 'success');
         return resolve({ empty: true });
       }
+
+      let sourceMasterLangDetails = self.sourceMasterLanguages && Object.values(self.sourceMasterLanguages);
+      if (sourceMasterLangDetails &&
+        sourceMasterLangDetails[0] &&
+        sourceMasterLangDetails[0]["code"] &&
+        self.masterLanguage["code"] === sourceMasterLangDetails[0]["code"]) {
+        await self.checkAndUpdateMasterLocaleName(sourceMasterLangDetails).catch((error) => {
+          addlogs(self.config, formatError(error), 'warn');
+        })
+      }
+
       let langUids = Object.keys(self.languages);
       return Promise.map(
         langUids,
@@ -98,7 +112,7 @@ module.exports = class ImportLanguages {
           self
             .updateLocales(langUids)
             .then(() => {
-              helper.writeFileSync(langSuccessPath, self.success);
+              helper.writeFileSync(self.langSuccessPath, self.success);
               addlogs(self.config, chalk.green('Languages have been imported successfully!'), 'success');
               resolve();
             })
@@ -142,4 +156,58 @@ module.exports = class ImportLanguages {
         });
     });
   }
+
+  checkAndUpdateMasterLocaleName(sourceMasterLangDetails) {
+    let self = this;
+    return new Promise(async function (resolve, reject) {
+      let masterLangDetails = await self.stackAPIClient.locale(self.masterLanguage["code"]).fetch()
+        .catch((error) => {
+          addlogs(self.config, formatError(error), 'warn');
+        })
+      if (masterLangDetails &&
+        masterLangDetails["name"] &&
+        sourceMasterLangDetails[0]["name"] &&
+        masterLangDetails["name"].toString().toUpperCase() !== sourceMasterLangDetails[0]["name"].toString().toUpperCase()
+      ) {
+        cliux.print(
+          'WARNING!!! The master language name for the source and destination is different.',
+          { color: 'yellow' },
+        );
+        cliux.print(
+          `Old Master language name: ${masterLangDetails["name"]}`,
+          { color: 'red' },
+        );
+        cliux.print(
+          `New Master language name: ${sourceMasterLangDetails[0]["name"]}`,
+          { color: 'green' },
+        );
+        let confirm = await cliux.inquire({
+          type: 'confirm',
+          message: 'Are you sure you want to update name of master language?',
+          name: 'confirmation',
+        })
+
+        if (confirm) {
+          let languid = sourceMasterLangDetails[0] && sourceMasterLangDetails[0]["uid"];
+          let lang = self.sourceMasterLanguages[languid];
+          if (!lang) return reject('Locale not found.!');
+          const langObj = self.stackAPIClient.locale(lang.code);
+          Object.assign(langObj, { name: lang.name });
+          langObj.update()
+            .then(() => {
+              helper.writeFileSync(self.langSuccessPath, self.success);
+              addlogs(self.config, chalk.green('Master Languages name have been updated successfully!'), 'success');
+              resolve();
+            })
+            .catch(function (error) {
+              reject(error);
+            });
+        } else {
+          resolve();
+        }
+      } else {
+        resolve();
+      }
+    });
+  }
 };

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

@@ -35,8 +35,6 @@ module.exports = class ImportMarketplaceApps {
   }
 
   async start() {
-    this.developerHubBaseUrl = this.config.developerHubBaseUrl || (await getDeveloperHubUrl(this.config));
-    this.client = contentstack.client({ authtoken: this.config.auth_token, endpoint: this.developerHubBaseUrl });
     this.mapperDirPath = path.resolve(this.config.data, 'mapper', 'marketplace_apps');
     this.uidMapperPath = path.join(this.mapperDirPath, 'uid-mapping.json');
     this.marketplaceAppFolderPath = path.resolve(this.config.data, this.marketplaceAppConfig.dirName);
@@ -54,6 +52,9 @@ module.exports = class ImportMarketplaceApps {
       return Promise.resolve();
     }
 
+    this.developerHubBaseUrl = this.config.developerHubBaseUrl || (await getDeveloperHubUrl(this.config));
+    this.client = contentstack.client({ authtoken: this.config.auth_token, endpoint: this.developerHubBaseUrl });
+
     await this.getOrgUid();
 
     this.httpClient = new HttpClient({
@@ -210,18 +211,14 @@ module.exports = class ImportMarketplaceApps {
 
     for (let app of privateApps) {
       // NOTE keys can be passed to install new app in the developer hub
-      app.manifest = _.pick(app.manifest, [
-        'uid',
-        'name',
-        'description',
-        'icon',
-        'target_type',
-        'ui_location',
-        'webhook',
-        'oauth',
-      ]);
+      app.manifest = _.pick(app.manifest, ['uid', 'name', 'description', 'icon', 'target_type', 'webhook', 'oauth']);
       this.appOrginalName = app.manifest.name;
-      await this.createPrivateApps(app.manifest);
+      await this.createPrivateApps({
+        oauth: app.oauth,
+        webhook: app.webhook,
+        ui_location: app.ui_location,
+        ...app.manifest,
+      });
     }
 
     this.appOrginalName = undefined;
@@ -264,9 +261,9 @@ module.exports = class ImportMarketplaceApps {
     let locations = app.ui_location && app.ui_location.locations;
 
     if (!uidCleaned && !_.isEmpty(locations)) {
-      app.ui_location.locations = this.uodateManifestUILocations(locations, 'uid');
+      app.ui_location.locations = this.updateManifestUILocations(locations, 'uid');
     } else if (uidCleaned && !_.isEmpty(locations)) {
-      app.ui_location.locations = this.uodateManifestUILocations(locations, 'name', appSuffix);
+      app.ui_location.locations = this.updateManifestUILocations(locations, 'name', appSuffix);
     }
 
     if (app.name > 20) {
@@ -328,7 +325,7 @@ module.exports = class ImportMarketplaceApps {
     return this.createPrivateApps(app, true, appSuffix + 1);
   }
 
-  uodateManifestUILocations(locations, type = 'uid', appSuffix = 1) {
+  updateManifestUILocations(locations, type = 'uid', appSuffix = 1) {
     switch (type) {
       case 'uid':
         return _.map(locations, (location) => {
@@ -389,7 +386,10 @@ module.exports = class ImportMarketplaceApps {
         .catch((error) => error);
 
       if (installation.installation_uid) {
-        log(this.config, `${app.manifest.name} app installed successfully.!`, 'success');
+        let appName = (this.appNameMapping[app.manifest.name]) ? 
+          this.appNameMapping[app.manifest.name] : 
+        app.manifest.name ;
+        log(this.config, `${appName} app installed successfully.!`, 'success');
         await this.makeRedirectUrlCall(installation, app.manifest.name);
         this.installationUidMapping[app.uid] = installation.installation_uid;
         updateParam = { manifest: app.manifest, ...installation, configuration, server_configuration };

package/src/lib/util/fs.js

@@ -118,3 +118,7 @@ exports.readdirSync = function (dirPath) {
     return [];
   }
 };
+
+exports.fileExistsSync = function (path) {
+  return fs.existsSync(path);
+};

package/src/lib/util/lookupReplaceAssets.js

@@ -219,7 +219,9 @@ module.exports = function (data, mappedAssetUids, mappedAssetUrls, assetUidMappe
         [data.entry.uid]: matchedUids,
       };
     }
-    helper.writeFile(path.join(assetUidMapperPath, 'matched-asset-uids.json'));
+    if (!helper.fileExistsSync(path.join(assetUidMapperPath, 'matched-asset-uids.json'))) {
+      helper.writeFile(path.join(assetUidMapperPath, 'matched-asset-uids.json'));
+    }
   }
 
   if (unmatchedUids.length) {