@contentstack/cli-cm-export 1.3.0 → 1.5.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

@@ -38,7 +38,7 @@ $ npm install -g @contentstack/cli-cm-export
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-cm-export/1.3.0 linux-x64 node-v16.19.0
+@contentstack/cli-cm-export/1.5.0 linux-x64 node-v16.20.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.3.0",
+  "version": "1.5.0",
   "commands": {
     "cm:stacks:export": {
       "id": "cm:stacks:export",

package/package.json

@@ -1,17 +1,18 @@
 {
   "name": "@contentstack/cli-cm-export",
   "description": "Contentstack CLI plugin to export content from stack",
-  "version": "1.3.0",
+  "version": "1.5.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.1",
+    "@contentstack/cli-utilities": "^1.2.1",
     "@oclif/command": "^1.8.16",
     "@oclif/config": "^1.18.3",
     "async": "^3.2.4",
     "big-json": "^3.2.0",
     "bluebird": "^3.7.2",
+    "chalk": "^4.1.2",
     "is-valid-path": "^0.1.1",
     "lodash": "^4.17.20",
     "mkdirp": "^1.0.4",
@@ -22,10 +23,9 @@
     "winston": "^3.7.2"
   },
   "devDependencies": {
-    "@contentstack/cli-auth": "^1.0.6",
-    "@contentstack/cli-config": "^1.0.4",
-    "@contentstack/cli-dev-dependencies": "^1.0.0",
-    "@oclif/dev-cli": "^1.26.10",
+    "@contentstack/cli-auth": "^1.2.1",
+    "@contentstack/cli-config": "^1.2.1",
+    "@contentstack/cli-dev-dependencies": "^1.2.0",
     "@oclif/plugin-help": "^5.1.19",
     "@oclif/test": "^1.2.6",
     "assert": "^2.0.0",
@@ -33,14 +33,15 @@
     "dotenv": "^16.0.1",
     "dotenv-expand": "^9.0.0",
     "eslint": "^8.18.0",
-    "eslint-config-oclif": "^3.1.0",
+    "eslint-config-oclif": "^4.0.0",
     "globby": "^10.0.2",
     "mocha": "10.1.0",
     "nyc": "^15.1.0",
-    "sinon": "^15.0.1"
+    "sinon": "^15.0.1",
+    "oclif": "^3.1.2"
   },
   "engines": {
-    "node": ">=8.0.0"
+    "node": ">=14.0.0"
   },
   "files": [
     "/npm-shrinkwrap.json",
@@ -60,6 +61,7 @@
     "prepack": "oclif manifest && oclif readme",
     "test": "nyc mocha --forbid-only \"test/**/*.test.js\"",
     "version": "oclif readme && git add README.md",
+    "clean": "rm -rf ./node_modules tsconfig.build.tsbuildinfo",
     "test:integration": "mocha --forbid-only \"test/run.test.js\" --integration-test",
     "test:unit": "mocha --forbid-only \"test/unit/*.test.js\" --unit-test"
   },
@@ -71,6 +73,10 @@
   "csdxConfig": {
     "expiredCommands": {
       "cm:export": "csdx cm:stacks:export"
+    },
+    "shortCommandName": {
+      "cm:stacks:export": "EXPRT",
+      "cm:export": "O-EXPRT"
     }
   },
   "main": "./src/commands/cm/stacks/export.js",

package/src/app.js

@@ -6,7 +6,7 @@ const util = require('./lib/util');
 const login = require('./lib/util/login');
 const setupBranches = require('./lib/util/setup-branches');
 const { addlogs, unlinkFileLogger } = require('./lib/util/log');
-const { managementSDKClient } = require('@contentstack/cli-utilities');
+const { managementSDKClient, isAuthenticated } = require('@contentstack/cli-utilities');
 
 exports.initial = async (config) => {
   return new Promise(async (resolve, reject) => {
@@ -56,7 +56,7 @@ exports.initial = async (config) => {
     if (
       (config.email && config.password) ||
       (!config.email && !config.password && config.source_stack && config.access_token) ||
-      (config.auth_token && !config.management_token)
+      (isAuthenticated() && !config.management_token)
     ) {
       login
         .login(config)

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

@@ -1,7 +1,5 @@
 /* eslint-disable complexity */
-const { Command, flags } = require('@contentstack/cli-command');
-const { printFlagDeprecation } = require('@contentstack/cli-utilities');
-
+const { Command } = require('@contentstack/cli-command');
 const {
   configWithMToken,
   parameterWithMToken,
@@ -11,7 +9,7 @@ const {
   withoutParametersWithAuthToken,
 } = require('../../../lib/util/export-flags');
 const config = require('../../../config/default');
-const { configHandler } = require('@contentstack/cli-utilities');
+const { configHandler, printFlagDeprecation, flags, isAuthenticated } = require('@contentstack/cli-utilities');
 
 class ExportCommand extends Command {
   async run() {
@@ -24,7 +22,6 @@ class ExportCommand extends Command {
     const moduleName = exportCommandFlags.module;
     const contentTypes = exportCommandFlags['content-types'];
     const branchName = exportCommandFlags.branch;
-    let _authToken = configHandler.get('authtoken');
     let host = this.region;
     let cmaHost = host.cma.split('//');
     let cdaHost = host.cda.split('//');
@@ -58,7 +55,6 @@ class ExportCommand extends Command {
             data,
             moduleName,
             host,
-            _authToken,
             contentTypes,
             branchName,
             securedAssets,
@@ -68,7 +64,6 @@ class ExportCommand extends Command {
             managementTokens,
             moduleName,
             host,
-            _authToken,
             contentTypes,
             branchName,
             securedAssets,
@@ -79,12 +74,11 @@ class ExportCommand extends Command {
       } else {
         this.log(alias + ' management token is not present, please add managment token first');
       }
-    } else if (_authToken) {
+    } else if (isAuthenticated()) {
       if (extConfig) {
-        await configWithAuthToken(extConfig, _authToken, moduleName, host, contentTypes, branchName, securedAssets);
+        await configWithAuthToken(extConfig, moduleName, host, contentTypes, branchName, securedAssets);
       } else if (sourceStack && data) {
         return await parametersWithAuthToken(
-          _authToken,
           sourceStack,
           data,
           moduleName,
@@ -94,7 +88,7 @@ class ExportCommand extends Command {
           securedAssets,
         );
       } else if (data === undefined && sourceStack === undefined) {
-        await withoutParametersWithAuthToken(_authToken, moduleName, host, contentTypes, branchName, securedAssets);
+        await withoutParametersWithAuthToken(moduleName, host, contentTypes, branchName, securedAssets);
       } else {
         this.log('Please provide a valid command. Run "csdx cm:export --help" command to view the command usage');
       }

package/src/config/default.js

@@ -33,6 +33,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/export/assets.js

@@ -11,7 +11,7 @@ const Promise = require('bluebird');
 const _ = require('lodash');
 const chalk = require('chalk');
 const progress = require('progress-stream');
-const { HttpClient } = require('@contentstack/cli-utilities');
+const { HttpClient, configHandler } = require('@contentstack/cli-utilities');
 
 const helper = require('../util/helper');
 const { addlogs } = require('../util/log');
@@ -350,7 +350,7 @@ module.exports = class ExportAssets {
       }
       self.assetStream = {
         url: self.config.securedAssets
-          ? `${asset.url}?authtoken=${self.config.authtoken || self.config.auth_token}`
+          ? `${asset.url}?authtoken=${configHandler.get('authtoken')}`
           : asset.url,
       };
 

package/src/lib/export/locales.js

@@ -7,14 +7,10 @@ class LocaleExport {
     this.stackAPIClient = stackAPIClient;
     this.exportConfig = exportConfig;
     this.localeConfig = exportConfig.modules.locales;
+    this.masterLocaleConfig = exportConfig.modules.masterLocale;
     this.qs = {
       include_count: true,
       asc: 'updated_at',
-      query: {
-        code: {
-          $nin: [exportConfig.master_locale.code],
-        },
-      },
       only: {
         BASE: this.localeConfig.requiredKeys,
       },
@@ -22,6 +18,7 @@ class LocaleExport {
 
     this.localesPath = path.resolve(exportConfig.data, exportConfig.branchName || '', this.localeConfig.dirName);
     this.locales = {};
+    this.masterLocale = {};
     this.fetchConcurrency = this.localeConfig.fetchConcurrency || this.exportConfig.fetchConcurrency;
     this.writeConcurrency = this.localeConfig.writeConcurrency || this.exportConfig.writeConcurrency;
   }
@@ -32,6 +29,7 @@ class LocaleExport {
       await fileHelper.makeDirectory(this.localesPath);
       await this.getLocales();
       await fileHelper.writeFile(path.join(this.localesPath, this.localeConfig.fileName), this.locales);
+      await fileHelper.writeFile(path.join(this.localesPath, this.masterLocaleConfig.fileName), this.masterLocale);
       addlogs(this.exportConfig, 'Completed locale export', 'success');
     } catch (error) {
       addlogs(this.exportConfig, chalk.red(`Failed to export locales ${formatError(error)}`), 'error');
@@ -61,7 +59,11 @@ class LocaleExport {
           delete locale[key];
         }
       }
-      this.locales[locale.uid] = locale;
+      if(locale.code === this.exportConfig.master_locale.code){
+        this.masterLocale[locale.uid] = locale;
+      }else{
+        this.locales[locale.uid] = locale;
+      }
     });
   }
 }

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

@@ -7,7 +7,14 @@ const _ = require('lodash');
 const path = require('path');
 const chalk = require('chalk');
 const mkdirp = require('mkdirp');
-const { cliux, HttpClient, NodeCrypto, managementSDKClient } = require('@contentstack/cli-utilities');
+const { 
+  cliux, 
+  HttpClient, 
+  NodeCrypto, 
+  managementSDKClient, 
+  isAuthenticated, 
+  configHandler 
+} = require('@contentstack/cli-utilities');
 
 const { formatError } = require('../util');
 const config = require('../../config/default');
@@ -29,9 +36,7 @@ module.exports = class ExportMarketplaceApps {
   }
 
   async start() {
-    this.developerHubBaseUrl = this.config.developerHubBaseUrl || (await getDeveloperHubUrl());
-
-    if (!this.config.auth_token) {
+    if (!isAuthenticated()) {
       cliux.print(
         'WARNING!!! To export Marketplace apps, you must be logged in. Please check csdx auth:login --help to log in',
         { color: 'yellow' },
@@ -39,10 +44,12 @@ module.exports = class ExportMarketplaceApps {
       return Promise.resolve();
     }
 
+    this.developerHubBaseUrl = this.config.developerHubBaseUrl || (await getDeveloperHubUrl());
+
     await this.getOrgUid();
 
     this.httpClient = new HttpClient().headers({
-      authtoken: this.config.auth_token,
+      authtoken: configHandler.get('authtoken'),
       organization_uid: this.config.org_uid,
     });
 
@@ -58,7 +65,7 @@ module.exports = class ExportMarketplaceApps {
   }
 
   async getOrgUid() {
-    if (this.config.auth_token) {
+    if (isAuthenticated()) {
       const tempAPIClient = await managementSDKClient({ host: this.config.host });
       const tempStackData = await tempAPIClient
         .stack({ api_key: this.config.source_stack })

package/src/lib/export/stack.js

@@ -10,7 +10,7 @@ const { merge } = require('lodash');
 const helper = require('../util/helper');
 const { addlogs } = require('../util/log');
 const config = require('../../config/default');
-const { managementSDKClient } = require('@contentstack/cli-utilities');
+const { managementSDKClient, isAuthenticated } = require('@contentstack/cli-utilities');
 module.exports = class ExportStack {
   stackConfig = config.modules.stack;
 
@@ -27,7 +27,7 @@ module.exports = class ExportStack {
 
   async start() {
     const self = this;
-    if (self.config.auth_token) {
+    if (isAuthenticated()) {
       const tempAPIClient = await managementSDKClient({ host: config.host });
       const tempStackData = await tempAPIClient
         .stack({ api_key: self.config.source_stack })

package/src/lib/util/export-flags.js

@@ -35,13 +35,11 @@ exports.parameterWithMToken = async function (
   data,
   moduleName,
   host,
-  _authToken,
   contentTypes,
   branchName,
   securedAssets,
 ) {
   defaultConfig.management_token = managementTokens.token;
-  defaultConfig.auth_token = _authToken;
   defaultConfig.host = host.cma;
   defaultConfig.cdn = host.cda;
   defaultConfig.branchName = branchName;
@@ -65,7 +63,6 @@ exports.withoutParameterMToken = async (
   managementTokens,
   moduleName,
   host,
-  _authToken,
   contentTypes,
   branchName,
   securedAssets,
@@ -76,7 +73,6 @@ exports.withoutParameterMToken = async (
   defaultConfig.host = host.cma;
   defaultConfig.cdn = host.cda;
   defaultConfig.branchName = branchName;
-  defaultConfig.auth_token = _authToken;
   defaultConfig.securedAssets = securedAssets;
   if (moduleName) {
     defaultConfig.moduleName = moduleName;
@@ -90,9 +86,8 @@ exports.withoutParameterMToken = async (
   await initial(defaultConfig);
 };
 
-exports.configWithAuthToken = async function (config, _authToken, moduleName, host, contentTypes, branchName, securedAssets) {
+exports.configWithAuthToken = async function (config, moduleName, host, contentTypes, branchName, securedAssets) {
   let externalConfig = helper.readFile(path.resolve(config));
-  defaultConfig.auth_token = _authToken;
   defaultConfig.host = host.cma;
   defaultConfig.cdn = host.cda;
   defaultConfig.branchName = branchName;
@@ -109,7 +104,6 @@ exports.configWithAuthToken = async function (config, _authToken, moduleName, ho
 };
 
 exports.parametersWithAuthToken = function (
-  _authToken,
   sourceStack,
   data,
   moduleName,
@@ -119,7 +113,6 @@ exports.parametersWithAuthToken = function (
   securedAssets,
 ) {
   return new Promise(async (resolve, reject) => {
-    defaultConfig.auth_token = _authToken;
     defaultConfig.source_stack = sourceStack;
     if (moduleName) {
       defaultConfig.moduleName = moduleName;
@@ -144,7 +137,6 @@ exports.parametersWithAuthToken = function (
 };
 
 exports.withoutParametersWithAuthToken = async (
-  _authToken,
   moduleName,
   host,
   contentTypes,
@@ -153,7 +145,6 @@ exports.withoutParametersWithAuthToken = async (
 ) => {
   const stackUid = await cliux.prompt(message.promptMessageList.promptSourceStack);
   const pathOfExport = await cliux.prompt(message.promptMessageList.promptPathStoredData);
-  defaultConfig.auth_token = _authToken;
   defaultConfig.source_stack = stackUid;
   defaultConfig.securedAssets = securedAssets;
   if (moduleName) {

package/src/lib/util/index.js

@@ -8,6 +8,7 @@ var _ = require('lodash');
 var defaultConfig = require('../../config/default');
 const chalk = require('chalk');
 const promiseLimit = require('promise-limit');
+const { isAuthenticated } = require('@contentstack/cli-utilities')
 
 exports.validateConfig = function (config) {
   if (!config.host || !config.cdn) {
@@ -22,7 +23,7 @@ exports.validateConfig = function (config) {
     !config.management_token &&
     config.source_stack &&
     !config.access_token &&
-    !config.auth_token
+    !isAuthenticated()
   ) {
     throw new Error('Kindly provide management_token or email and password');
   } else if (
@@ -31,7 +32,7 @@ exports.validateConfig = function (config) {
     !config.access_token &&
     config.source_stack &&
     !config.management_token &&
-    !config.auth_token
+    !isAuthenticated()
   ) {
     throw new Error('Kindly provide access_token or management_token');
   } else if (!config.email && !config.password && config.preserveStackVersion) {

package/src/lib/util/login.js

@@ -9,7 +9,7 @@
 
 const chalk = require('chalk');
 const { addlogs } = require('../util/log');
-const { managementSDKClient } = require('@contentstack/cli-utilities');
+const { managementSDKClient, isAuthenticated } = require('@contentstack/cli-utilities');
 
 module.exports.login = (config) => {
   return new Promise((resolve, reject) => {
@@ -22,11 +22,10 @@ module.exports.login = (config) => {
             .then((response) => {
               // eslint-disable-next-line no-console
               console.log(chalk.green('Contentstack account authenticated successfully!'));
-              config.authtoken = response.user.authtoken;
               config.headers = {
                 api_key: config.source_stack,
                 access_token: config.access_token,
-                authtoken: config.authtoken,
+                authtoken: response.user.authtoken,
                 'X-User-Agent': 'contentstack-export/v',
               };
               resolve(config);
@@ -34,7 +33,7 @@ module.exports.login = (config) => {
             .catch((error) => {
               reject(error);
             });
-        } else if (config.auth_token && !config.management_token) {
+        } else if (isAuthenticated() && !config.management_token) {
           const stackAPIClient = APIClient.stack({
             api_key: config.source_stack,
             management_token: config.management_token,

package/src/lib/util/setup-branches.js

@@ -1,6 +1,7 @@
 const mkdirp = require('mkdirp');
 const path = require('path');
 const helper = require('./helper');
+const {isAuthenticated, configHandler} = require('@contentstack/cli-utilities')
 
 const setupBranches = async (config, branch, stackAPIClient) => {
   if (typeof config !== 'object') {
@@ -9,8 +10,8 @@ const setupBranches = async (config, branch, stackAPIClient) => {
   let branches = [];
   const headers = { api_key: config.source_stack };
 
-  if (config.auth_token) {
-    headers['authtoken'] = config.auth_token;
+  if (isAuthenticated()) {
+    headers['authtoken'] = configHandler.get('authtoken');
   } else if (config.management_token) {
     headers['authorization'] = config.management_token;
   }