@contentstack/cli-cm-export-to-csv 1.3.8 → 1.3.10

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.3.8",
+  "version": "1.3.10",
   "commands": {
     "cm:export-to-csv": {
       "id": "cm:export-to-csv",
@@ -15,8 +15,8 @@
         "Exporting entries to csv",
         "csdx cm:export-to-csv --action <entries> --locale <locale> --alias <management-token-alias> --content-type <content-type>",
         "",
-        "Exporting entries to csv with stack name provided",
-        "csdx cm:export-to-csv --action <entries> --locale <locale> --alias <management-token-alias> --content-type <content-type> --stack-name <stack-name>",
+        "Exporting entries to csv with stack name provided and branch name provided",
+        "csdx cm:export-to-csv --action <entries> --locale <locale> --alias <management-token-alias> --content-type <content-type> --stack-name <stack-name> --branch <branch-name>",
         "",
         "Exporting organization users to csv",
         "csdx cm:export-to-csv --action <users> --org <org-uid>",
@@ -58,6 +58,14 @@
           "required": false,
           "multiple": false
         },
+        "stack-api-key": {
+          "name": "stack-api-key",
+          "type": "option",
+          "char": "k",
+          "description": "API key of the source stack",
+          "required": false,
+          "multiple": false
+        },
         "org-name": {
           "name": "org-name",
           "type": "option",
@@ -78,6 +86,13 @@
           "description": "Content type for which entries needs to be exported",
           "required": false,
           "multiple": false
+        },
+        "branch": {
+          "name": "branch",
+          "type": "option",
+          "description": "Branch from which entries need to be exported",
+          "required": false,
+          "multiple": false
         }
       },
       "args": {}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@contentstack/cli-cm-export-to-csv",
   "description": "Export entities to csv",
-  "version": "1.3.8",
+  "version": "1.3.10",
   "author": "Abhinav Gupta @abhinav-from-contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
-    "@contentstack/cli-command": "^1.2.8",
-    "@contentstack/cli-utilities": "^1.4.4",
+    "@contentstack/cli-command": "^1.2.9",
+    "@contentstack/cli-utilities": "^1.4.5",
     "chalk": "^4.1.0",
     "fast-csv": "^4.3.6",
     "inquirer": "8.2.4",
@@ -44,6 +44,7 @@
     "postpack": "rm -f oclif.manifest.json",
     "prepack": "oclif manifest && oclif readme",
     "test": "nyc mocha --forbid-only \"test/**/*.test.js\"",
+    "test:unit": "nyc mocha --timeout 10000 --forbid-only \"test/unit/**/*.test.js\"",
     "version": "oclif readme && git add README.md",
     "clean": "rm -rf ./node_modules tsconfig.build.tsbuildinfo"
   },

package/src/commands/cm/export-to-csv.js

@@ -1,5 +1,12 @@
 const { Command } = require('@contentstack/cli-command');
-const { configHandler, managementSDKClient, flags, isAuthenticated } = require('@contentstack/cli-utilities');
+const {
+  configHandler,
+  managementSDKClient,
+  flags,
+  isAuthenticated,
+  cliux,
+  doesBranchExist,
+} = require('@contentstack/cli-utilities');
 const util = require('../../util');
 const config = require('../../util/config');
 
@@ -26,6 +33,12 @@ class ExportToCsvCommand extends Command {
       required: false,
       description: 'Name of the stack that needs to be created as csv filename.',
     }),
+    'stack-api-key': flags.string({
+      char: 'k',
+      multiple: false,
+      required: false,
+      description: 'API key of the source stack',
+    }),
     'org-name': flags.string({
       multiple: false,
       required: false,
@@ -41,6 +54,11 @@ class ExportToCsvCommand extends Command {
       required: false,
       multiple: false,
     }),
+    branch: flags.string({
+      description: 'Branch from which entries need to be exported',
+      multiple: false,
+      required: false,
+    }),
   };
 
   async run() {
@@ -52,9 +70,11 @@ class ExportToCsvCommand extends Command {
           action: actionFlag,
           'org-name': orgName,
           'stack-name': stackName,
+          'stack-api-key': stackAPIKey,
           locale: locale,
           'content-type': contentTypesFlag,
           alias: managementTokenAlias,
+          branch: branchUid,
         },
       } = await this.parse(ExportToCsvCommand);
 
@@ -76,6 +96,7 @@ class ExportToCsvCommand extends Command {
             let stackAPIClient;
             let language;
             let contentTypes = [];
+            let stackBranches;
             const listOfTokens = configHandler.get('tokens');
 
             if (managementTokenAlias && listOfTokens[managementTokenAlias]) {
@@ -105,16 +126,59 @@ class ExportToCsvCommand extends Command {
               } else {
                 organization = await util.chooseOrganization(managementAPIClient); // prompt for organization
               }
-
-              stack = await util.chooseStack(managementAPIClient, organization.uid); // prompt for stack
+              if (!stackAPIKey) {
+                stack = await util.chooseStack(managementAPIClient, organization.uid); // prompt for stack
+              } else {
+                stack = await util.chooseStack(managementAPIClient, organization.uid, stackAPIKey);
+              }
             }
 
             stackAPIClient = this.getStackClient(managementAPIClient, stack);
+
+            if (branchUid) {
+              try {
+                const branchExists = await doesBranchExist(stackAPIClient, branchUid);
+                if (branchExists?.errorCode) {
+                  throw new Error(branchExists.errorMessage);
+                }
+                stack.branch_uid = branchUid;
+                stackAPIClient = this.getStackClient(managementAPIClient, stack);
+              } catch (error) {
+                if (error.message || error.errorMessage) {
+                  cliux.error(util.formatError(error));
+                  this.exit();
+                }
+              }
+            } else {
+              stackBranches = await this.getStackBranches(stackAPIClient);
+              if (stackBranches === undefined) {
+                stackAPIClient = this.getStackClient(managementAPIClient, stack);
+              } else {
+                const { branch } = await util.chooseBranch(stackBranches);
+                stack.branch_uid = branch;
+                stackAPIClient = this.getStackClient(managementAPIClient, stack);
+              }
+            }
+
             const contentTypeCount = await util.getContentTypeCount(stackAPIClient);
+
             const environments = await util.getEnvironments(stackAPIClient); // fetch environments, because in publish details only env uid are available and we need env names
 
             if (contentTypesFlag) {
               contentTypes = contentTypesFlag.split(',').map(this.snakeCase);
+              const contentTypesArray = await stackAPIClient
+                .contentType()
+                .query()
+                .find()
+                .then((res) => res.items.map((contentType) => contentType.uid));
+
+              const doesContentTypeExist = contentTypesArray.includes(contentTypesFlag);
+
+              if (!doesContentTypeExist) {
+                throw new Error(
+                  `The Content Type ${contentTypesFlag} was not found. Please try again. Content Type is not valid.`,
+                );
+              }
             } else {
               for (let index = 0; index <= contentTypeCount / 100; index++) {
                 const contentTypesMap = await util.getContentTypes(stackAPIClient, index);
@@ -152,12 +216,11 @@ class ExportToCsvCommand extends Command {
                 );
                 flatEntries = flatEntries.concat(flatEntriesResult);
               }
-              let fileName = `${stack.name}_${contentType}_${language.code}_entries_export.csv`;
-
+              let fileName = `${stackName ? stackName : stack.name}_${contentType}_${language.code}_entries_export.csv`;
               util.write(this, flatEntries, fileName, 'entries'); // write to file
             }
           } catch (error) {
-            this.log(util.formatError(error));
+            cliux.error(util.formatError(error));
           }
           break;
         }
@@ -184,21 +247,21 @@ class ExportToCsvCommand extends Command {
             const mappedRoles = util.getMappedRoles(orgRoles);
             const listOfUsers = util.cleanOrgUsers(orgUsers, mappedUsers, mappedRoles);
             const fileName = `${util.kebabize(
-              organization.name.replace(config.organizationNameRegex, ''),
+              (orgName ? orgName : organization.name).replace(config.organizationNameRegex, ''),
             )}_users_export.csv`;
 
             util.write(this, listOfUsers, fileName, 'organization details');
           } catch (error) {
-            if (error.message) {
-              this.log(util.formatError(error));
+            if (error.message || error.errorMessage) {
+              cliux.error(util.formatError(error));
             }
           }
           break;
         }
       }
     } catch (error) {
-      if (error.message) {
-        this.log(util.formatError(error));
+      if (error.message || error.errorMessage) {
+        cliux.error(util.formatError(error));
       }
     }
   }
@@ -208,13 +271,26 @@ class ExportToCsvCommand extends Command {
   }
 
   getStackClient(managementAPIClient, stack) {
+    const stackInit = {
+      api_key: stack.apiKey,
+      branch_uid: stack.branch_uid,
+    };
     if (stack.token) {
       return managementAPIClient.stack({
-        api_key: stack.apiKey,
+        ...stackInit,
         management_token: stack.token,
       });
     }
-    return managementAPIClient.stack({ api_key: stack.apiKey });
+    return managementAPIClient.stack(stackInit);
+  }
+
+  getStackBranches(stackAPIClient) {
+    return stackAPIClient
+      .branch()
+      .query()
+      .find()
+      .then(({ items }) => (items !== undefined ? items : []))
+      .catch((_err) => {});
   }
 }
 
@@ -226,8 +302,8 @@ ExportToCsvCommand.examples = [
   'Exporting entries to csv',
   'csdx cm:export-to-csv --action <entries> --locale <locale> --alias <management-token-alias> --content-type <content-type>',
   '',
-  'Exporting entries to csv with stack name provided',
-  'csdx cm:export-to-csv --action <entries> --locale <locale> --alias <management-token-alias> --content-type <content-type> --stack-name <stack-name>',
+  'Exporting entries to csv with stack name provided and branch name provided',
+  'csdx cm:export-to-csv --action <entries> --locale <locale> --alias <management-token-alias> --content-type <content-type> --stack-name <stack-name> --branch <branch-name>',
   '',
   'Exporting organization users to csv',
   'csdx cm:export-to-csv --action <users> --org <org-uid>',

package/src/util/index.js

@@ -8,6 +8,7 @@ const debug = require('debug')('export-to-csv');
 const checkboxPlus = require('inquirer-checkbox-plus-prompt');
 
 const config = require('./config.js');
+const { cliux } = require('@contentstack/cli-utilities');
 
 const directory = './data';
 const delimeter = os.platform() === 'win32' ? '\\' : '/';
@@ -97,13 +98,24 @@ function getOrganizationsWhereUserIsAdmin(managementAPIClient) {
   });
 }
 
-function chooseStack(managementAPIClient, orgUid) {
+function chooseStack(managementAPIClient, orgUid, stackApiKey) {
   return new Promise(async (resolve, reject) => {
     try {
       let stacks = await getStacks(managementAPIClient, orgUid);
+
+      if (stackApiKey) {
+        const stackName = Object.keys(stacks).find((key) => stacks[key] === stackApiKey);
+
+        if (stackName) {
+          resolve({ name: stackName, apiKey: stackApiKey });
+        } else {
+          throw new Error('Could not find stack');
+        }
+        return;
+      }
+
       let stackList = Object.keys(stacks);
       stackList.push(config.cancelString);
-
       let _chooseStack = [
         {
           type: 'list',
@@ -126,6 +138,26 @@ function chooseStack(managementAPIClient, orgUid) {
   });
 }
 
+async function chooseBranch(branchList) {
+  try {
+    const branches = await branchList;
+
+    const branchesArray = branches.map((branch) => branch.uid);
+
+    let _chooseBranch = [
+      {
+        type: 'list',
+        name: 'branch',
+        message: 'Choose a Branch',
+        choices: branchesArray,
+      },
+    ];
+    return await inquirer.prompt(_chooseBranch);
+  } catch (err) {
+    cliux.error(err);
+  }
+}
+
 function getStacks(managementAPIClient, orgUid) {
   return new Promise((resolve, reject) => {
     let result = {};
@@ -167,7 +199,7 @@ function chooseContentType(stackAPIClient, skip) {
 }
 
 function chooseInMemContentTypes(contentTypesList) {
-  return new Promise(async (resolve, reject) => {
+  return new Promise((resolve, reject) => {
     let _chooseContentType = [
       {
         type: 'checkbox-plus',
@@ -213,7 +245,7 @@ function getContentTypes(stackAPIClient, skip) {
     let result = {};
     stackAPIClient
       .contentType()
-      .query({ skip: skip * 100 })
+      .query({ skip: skip * 100, include_branch: true })
       .find()
       .then((contentTypes) => {
         contentTypes.items.forEach((contentType) => {
@@ -221,7 +253,9 @@ function getContentTypes(stackAPIClient, skip) {
         });
         resolve(result);
       })
-      .catch((error) => reject(error));
+      .catch((error) => {
+        reject(error);
+      });
   });
 }
 
@@ -376,7 +410,7 @@ function write(command, entries, fileName, message) {
     process.chdir(directory);
   }
   // eslint-disable-next-line no-undef
-  command.log(`Writing ${message} to file: ${process.cwd()}${delimeter}${fileName}`);
+  cliux.print(`Writing ${message} to file: ${process.cwd()}${delimeter}${fileName}`);
   fastcsv.writeToPath(fileName, entries, { headers: true });
 }
 
@@ -400,7 +434,7 @@ function startupQuestions() {
   });
 }
 
-function getOrgUsers(managementAPIClient, orgUid, ecsv) {
+function getOrgUsers(managementAPIClient, orgUid) {
   return new Promise((resolve, reject) => {
     managementAPIClient
       .getUser({ include_orgs_roles: true })
@@ -442,10 +476,7 @@ async function getUsers(managementAPIClient, organization, params, result = [])
       await wait(200);
       return getUsers(managementAPIClient, organization, params, result);
     }
-  } catch (error) {
-    console.error(error);
-    throw error;
-  }
+  } catch (error) {}
 }
 
 function getMappedUsers(users) {
@@ -612,6 +643,7 @@ function wait(time) {
 module.exports = {
   chooseOrganization: chooseOrganization,
   chooseStack: chooseStack,
+  chooseBranch: chooseBranch,
   chooseContentType: chooseContentType,
   chooseLanguage: chooseLanguage,
   getEntries: getEntries,