@contentstack/cli-cm-export-to-csv 1.0.4 → 1.2.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/oclif.manifest.json

@@ -1 +1,86 @@
-{"version":"1.0.4","commands":{"cm:export-to-csv":{"id":"cm:export-to-csv","description":"Export entries or organization users to csv using this command","pluginName":"@contentstack/cli-cm-export-to-csv","pluginType":"core","aliases":[],"examples":["csdx cm:export-to-csv","","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 organization users to csv","csdx cm:export-to-csv --action <users> --org <org-uid>","","Exporting organization users to csv with organization name provided","csdx cm:export-to-csv --action <users> --org <org-uid> --org-name <org-name>"],"flags":{"action":{"name":"action","type":"option","description":"Option to export data (entries, users)","required":false,"options":["entries","users"]},"alias":{"name":"alias","type":"option","char":"a","description":"Alias of the management token"},"org":{"name":"org","type":"option","description":"Provide organization UID to clone org users","required":false},"stack-name":{"name":"stack-name","type":"option","char":"n","description":"Name of the stack that needs to be created as csv filename.","required":false},"org-name":{"name":"org-name","type":"option","description":"Name of the organization that needs to be created as csv filename.","required":false},"locale":{"name":"locale","type":"option","description":"Locale for which entries need to be exported","required":false},"content-type":{"name":"content-type","type":"option","description":"Content type for which entries needs to be exported","required":false}},"args":[]}}}
+{
+  "version": "1.2.0",
+  "commands": {
+    "cm:export-to-csv": {
+      "id": "cm:export-to-csv",
+      "description": "Export entries or organization users to csv using this command",
+      "strict": true,
+      "pluginName": "@contentstack/cli-cm-export-to-csv",
+      "pluginAlias": "@contentstack/cli-cm-export-to-csv",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "csdx cm:export-to-csv",
+        "",
+        "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 organization users to csv",
+        "csdx cm:export-to-csv --action <users> --org <org-uid>",
+        "",
+        "Exporting organization users to csv with organization name provided",
+        "csdx cm:export-to-csv --action <users> --org <org-uid> --org-name <org-name>"
+      ],
+      "flags": {
+        "action": {
+          "name": "action",
+          "type": "option",
+          "description": "Option to export data (entries, users)",
+          "required": false,
+          "multiple": false,
+          "options": [
+            "entries",
+            "users"
+          ]
+        },
+        "alias": {
+          "name": "alias",
+          "type": "option",
+          "char": "a",
+          "description": "Alias of the management token",
+          "multiple": false
+        },
+        "org": {
+          "name": "org",
+          "type": "option",
+          "description": "Provide organization UID to clone org users",
+          "required": false,
+          "multiple": false
+        },
+        "stack-name": {
+          "name": "stack-name",
+          "type": "option",
+          "char": "n",
+          "description": "Name of the stack that needs to be created as csv filename.",
+          "required": false,
+          "multiple": false
+        },
+        "org-name": {
+          "name": "org-name",
+          "type": "option",
+          "description": "Name of the organization that needs to be created as csv filename.",
+          "required": false,
+          "multiple": false
+        },
+        "locale": {
+          "name": "locale",
+          "type": "option",
+          "description": "Locale for which entries need to be exported",
+          "required": false,
+          "multiple": false
+        },
+        "content-type": {
+          "name": "content-type",
+          "type": "option",
+          "description": "Content type for which entries needs to be exported",
+          "required": false,
+          "multiple": false
+        }
+      },
+      "args": {}
+    }
+  }
+}

package/package.json

@@ -1,15 +1,12 @@
 {
   "name": "@contentstack/cli-cm-export-to-csv",
   "description": "Export entities to csv",
-  "version": "1.0.4",
+  "version": "1.2.0",
   "author": "Abhinav Gupta @abhinav-from-contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
-    "@contentstack/cli-command": "^1.0.4",
-    "@contentstack/cli-utilities": "^1.0.5",
-    "@contentstack/management": "^1.6.0",
-    "@oclif/command": "^1.8.16",
-    "@oclif/config": "^1.18.3",
+    "@contentstack/cli-command": "^1.2.0",
+    "@contentstack/cli-utilities": "^1.2.0",
     "chalk": "^4.1.0",
     "fast-csv": "^4.3.6",
     "inquirer": "8.2.4",
@@ -17,18 +14,18 @@
     "mkdirp": "^1.0.4"
   },
   "devDependencies": {
-    "@oclif/dev-cli": "^1.26.0",
-    "@oclif/test": "^1.2.8",
+    "@oclif/test": "^2.2.10",
     "chai": "^4.2.0",
     "debug": "^4.3.1",
     "eslint": "^8.18.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",
@@ -45,9 +42,10 @@
   "scripts": {
     "pack": "npm pack && mv *.tgz ../../build",
     "postpack": "rm -f oclif.manifest.json",
-    "prepack": "oclif-dev manifest && oclif-dev readme",
+    "prepack": "oclif manifest && oclif readme",
     "test": "nyc mocha --forbid-only \"test/**/*.test.js\"",
-    "version": "oclif-dev readme && git add README.md"
+    "version": "oclif readme && git add README.md",
+    "clean": "rm -rf ./node_modules tsconfig.build.tsbuildinfo"
   },
   "csdxConfig": {
     "expiredCommands": {}

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

@@ -1,6 +1,5 @@
-const { Command, flags } = require('@contentstack/cli-command');
-const { configHandler } = require('@contentstack/cli-utilities');
-const ContentstackManagementSDK = require('@contentstack/management');
+const { Command } = require('@contentstack/cli-command');
+const { configHandler, managementSDKClient, flags } = require('@contentstack/cli-utilities');
 const util = require('../../util');
 const config = require('../../util/config');
 
@@ -44,22 +43,9 @@ class ExportToCsvCommand extends Command {
     }),
   };
 
-  get getAuthToken() {
-    try {
-      return this.authToken;
-    } catch (error) {
-      return undefined;
-    }
-  }
-
-  get managementAPIClient() {
-    this._managementAPIClient = ContentstackManagementSDK.client({ host: this.cmaHost, authtoken: this.getAuthToken });
-    return this._managementAPIClient;
-  }
-
   async run() {
     try {
-      let action;
+      let action, managementAPIClient;
       const {
         flags: {
           org,
@@ -70,7 +56,11 @@ class ExportToCsvCommand extends Command {
           'content-type': contentTypesFlag,
           alias: managementTokenAlias,
         },
-      } = this.parse(ExportToCsvCommand);
+      } = await this.parse(ExportToCsvCommand);
+
+      if (!managementTokenAlias) {
+        managementAPIClient = await managementSDKClient({ host: this.cmaHost });
+      }
 
       if (actionFlag) {
         action = actionFlag;
@@ -83,12 +73,16 @@ class ExportToCsvCommand extends Command {
         case 'entries': {
           try {
             let stack;
-            let stackClient;
+            let stackAPIClient;
             let language;
             let contentTypes = [];
             const listOfTokens = configHandler.get('tokens');
 
             if (managementTokenAlias && listOfTokens[managementTokenAlias]) {
+              managementAPIClient = await managementSDKClient({
+                host: this.cmaHost,
+                management_token: listOfTokens[managementTokenAlias].token,
+              });
               stack = {
                 name: stackName || managementTokenAlias,
                 apiKey: listOfTokens[managementTokenAlias].apiKey,
@@ -99,7 +93,7 @@ class ExportToCsvCommand extends Command {
             } else {
               let organization;
 
-              if (!this.getAuthToken) {
+              if (!this.isAuthenticated()) {
                 this.error(config.CLI_EXPORT_CSV_ENTRIES_ERROR, {
                   exit: 2,
                   suggestions: ['https://www.contentstack.com/docs/developers/cli/authentication/'],
@@ -109,21 +103,21 @@ class ExportToCsvCommand extends Command {
               if (org) {
                 organization = { uid: org };
               } else {
-                organization = await util.chooseOrganization(this.managementAPIClient); // prompt for organization
+                organization = await util.chooseOrganization(managementAPIClient); // prompt for organization
               }
 
-              stack = await util.chooseStack(this.managementAPIClient, organization.uid); // prompt for stack
+              stack = await util.chooseStack(managementAPIClient, organization.uid); // prompt for stack
             }
 
-            stackClient = this.getStackClient(stack);
-            const contentTypeCount = await util.getContentTypeCount(stackClient);
-            const environments = await util.getEnvironments(stackClient); // fetch environments, because in publish details only env uid are available and we need env names
+            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);
             } else {
               for (let index = 0; index <= contentTypeCount / 100; index++) {
-                const contentTypesMap = await util.getContentTypes(stackClient, index);
+                const contentTypesMap = await util.getContentTypes(stackAPIClient, index);
                 contentTypes = contentTypes.concat(Object.values(contentTypesMap)); // prompt for content Type
               }
             }
@@ -140,16 +134,16 @@ class ExportToCsvCommand extends Command {
             if (locale) {
               language = { code: locale };
             } else {
-              language = await util.chooseLanguage(stackClient); // prompt for language
+              language = await util.chooseLanguage(stackAPIClient); // prompt for language
             }
 
             while (contentTypes.length > 0) {
               let contentType = contentTypes.pop();
 
-              const entriesCount = await util.getEntriesCount(stackClient, contentType, language.code);
+              const entriesCount = await util.getEntriesCount(stackAPIClient, contentType, language.code);
               let flatEntries = [];
               for (let index = 0; index < entriesCount / 100; index++) {
-                const entriesResult = await util.getEntries(stackClient, contentType, language.code, index);
+                const entriesResult = await util.getEntries(stackAPIClient, contentType, language.code, index);
                 const flatEntriesResult = util.cleanEntries(
                   entriesResult.items,
                   language.code,
@@ -170,7 +164,7 @@ class ExportToCsvCommand extends Command {
         case config.exportUsers:
         case 'users': {
           try {
-            if (!this.getAuthToken) {
+            if (!this.isAuthenticated()) {
               this.error(config.CLI_EXPORT_CSV_LOGIN_FAILED, {
                 exit: 2,
                 suggestions: ['https://www.contentstack.com/docs/developers/cli/authentication/'],
@@ -181,11 +175,11 @@ class ExportToCsvCommand extends Command {
             if (org) {
               organization = { uid: org, name: orgName || org };
             } else {
-              organization = await util.chooseOrganization(this.managementAPIClient, action); // prompt for organization
+              organization = await util.chooseOrganization(managementAPIClient, action); // prompt for organization
             }
 
-            const orgUsers = await util.getOrgUsers(this.managementAPIClient, organization.uid, this);
-            const orgRoles = await util.getOrgRoles(this.managementAPIClient, organization.uid, this);
+            const orgUsers = await util.getOrgUsers(managementAPIClient, organization.uid, this);
+            const orgRoles = await util.getOrgRoles(managementAPIClient, organization.uid, this);
             const mappedUsers = util.getMappedUsers(orgUsers);
             const mappedRoles = util.getMappedRoles(orgRoles);
             const listOfUsers = util.cleanOrgUsers(orgUsers, mappedUsers, mappedRoles);
@@ -213,14 +207,14 @@ class ExportToCsvCommand extends Command {
     return (string || '').split(' ').join('_').toLowerCase();
   }
 
-  getStackClient(stack) {
+  getStackClient(managementAPIClient, stack) {
     if (stack.token) {
-      return ContentstackManagementSDK.client({ host: this.cmaHost }).stack({
+      return managementAPIClient.stack({
         api_key: stack.apiKey,
         management_token: stack.token,
       });
     }
-    return this.managementAPIClient.stack({ api_key: stack.apiKey });
+    return managementAPIClient.stack({ api_key: stack.apiKey });
   }
 }
 

package/src/util/index.js

@@ -1,5 +1,4 @@
 const inquirer = require('inquirer');
-const { HttpClient } = require('@contentstack/cli-utilities');
 const os = require('os');
 const checkboxPlus = require('inquirer-checkbox-plus-prompt');
 const config = require('./config.js');
@@ -33,10 +32,13 @@ function chooseOrganization(managementAPIClient, action) {
           loop: false,
         },
       ];
-      inquirer.prompt(_chooseOrganization).then(({ chosenOrg }) => {
-        if (chosenOrg === config.cancelString) exitProgram();
-        resolve({ name: chosenOrg, uid: organizations[chosenOrg] });
-      });
+      inquirer
+        .prompt(_chooseOrganization)
+        .then(({ chosenOrg }) => {
+          if (chosenOrg === config.cancelString) exitProgram();
+          resolve({ name: chosenOrg, uid: organizations[chosenOrg] });
+        })
+        .catch(reject);
     } catch (error) {
       reject(error);
     }
@@ -98,10 +100,13 @@ function chooseStack(managementAPIClient, orgUid) {
         },
       ];
 
-      inquirer.prompt(_chooseStack).then(({ chosenStack }) => {
-        if (chosenStack === config.cancelString) exitProgram();
-        resolve({ name: chosenStack, apiKey: stacks[chosenStack] });
-      });
+      inquirer
+        .prompt(_chooseStack)
+        .then(({ chosenStack }) => {
+          if (chosenStack === config.cancelString) exitProgram();
+          resolve({ name: chosenStack, apiKey: stacks[chosenStack] });
+        })
+        .catch(reject);
     } catch (error) {
       reject(error);
     }
@@ -109,9 +114,6 @@ function chooseStack(managementAPIClient, orgUid) {
 }
 
 function getStacks(managementAPIClient, orgUid) {
-  // Adding a query object in query, because it throws an error
-  // the error is coming from query function lib/entity.js, @contentstack/management pacakge
-  // where params.query is being set
   return new Promise((resolve, reject) => {
     let result = {};
     managementAPIClient
@@ -130,12 +132,10 @@ function getStacks(managementAPIClient, orgUid) {
   });
 }
 
-function chooseContentType(stack, skip) {
-  return new Promise(async (resolve) => {
-    let contentTypes = await getContentTypes(stack, skip);
+function chooseContentType(stackAPIClient, skip) {
+  return new Promise(async (resolve, reject) => {
+    let contentTypes = await getContentTypes(stackAPIClient, skip);
     let contentTypesList = Object.values(contentTypes);
-    // contentTypesList.push(config.cancelString)
-
     let _chooseContentType = [
       {
         type: 'checkbox',
@@ -146,9 +146,10 @@ function chooseContentType(stack, skip) {
       },
     ];
 
-    inquirer.prompt(_chooseContentType).then(({ chosenContentTypes }) => {
-      resolve(chosenContentTypes);
-    });
+    inquirer
+      .prompt(_chooseContentType)
+      .then(({ chosenContentTypes }) => resolve(chosenContentTypes))
+      .catch(reject);
   });
 }
 
@@ -182,19 +183,22 @@ function chooseInMemContentTypes(contentTypesList) {
         },
       },
     ];
-    inquirer.prompt(_chooseContentType).then(({ chosenContentTypes }) => {
-      if (chosenContentTypes.length === 0) {
-        reject('Please select atleast one content type.');
-      }
-      resolve(chosenContentTypes);
-    });
+    inquirer
+      .prompt(_chooseContentType)
+      .then(({ chosenContentTypes }) => {
+        if (chosenContentTypes.length === 0) {
+          reject('Please select atleast one content type.');
+        }
+        resolve(chosenContentTypes);
+      })
+      .catch(reject);
   });
 }
 
-function getContentTypes(stack, skip) {
+function getContentTypes(stackAPIClient, skip) {
   return new Promise((resolve, reject) => {
     let result = {};
-    stack
+    stackAPIClient
       .contentType()
       .query({ skip: skip * 100 })
       .find()
@@ -208,9 +212,9 @@ function getContentTypes(stack, skip) {
   });
 }
 
-function chooseLanguage(stack) {
-  return new Promise(async (resolve) => {
-    let languages = await getLanguages(stack);
+function chooseLanguage(stackAPIClient) {
+  return new Promise(async (resolve, reject) => {
+    let languages = await getLanguages(stackAPIClient);
     let languagesList = Object.keys(languages);
     languagesList.push(config.cancelString);
 
@@ -223,17 +227,20 @@ function chooseLanguage(stack) {
       },
     ];
 
-    inquirer.prompt(_chooseLanguage).then(({ chosenLanguage }) => {
-      if (chosenLanguage === config.cancelString) exitProgram();
-      resolve({ name: chosenLanguage, code: languages[chosenLanguage] });
-    });
+    inquirer
+      .prompt(_chooseLanguage)
+      .then(({ chosenLanguage }) => {
+        if (chosenLanguage === config.cancelString) exitProgram();
+        resolve({ name: chosenLanguage, code: languages[chosenLanguage] });
+      })
+      .catch(reject);
   });
 }
 
-function getLanguages(stack) {
+function getLanguages(stackAPIClient) {
   return new Promise((resolve, reject) => {
     let result = {};
-    stack
+    stackAPIClient
       .locale()
       .query()
       .find()
@@ -247,9 +254,9 @@ function getLanguages(stack) {
   });
 }
 
-function getEntries(stack, contentType, language, skip) {
+function getEntries(stackAPIClient, contentType, language, skip) {
   return new Promise((resolve, reject) => {
-    stack
+    stackAPIClient
       .contentType(contentType)
       .entry()
       .query({ include_publish_details: true, locale: language, skip: skip * 100 })
@@ -259,9 +266,9 @@ function getEntries(stack, contentType, language, skip) {
   });
 }
 
-function getEntriesCount(stack, contentType, language) {
+function getEntriesCount(stackAPIClient, contentType, language) {
   return new Promise((resolve, reject) => {
-    stack
+    stackAPIClient
       .contentType(contentType)
       .entry()
       .query({ include_publish_details: true, locale: language })
@@ -271,9 +278,9 @@ function getEntriesCount(stack, contentType, language) {
   });
 }
 
-function getEnvironments(stack) {
+function getEnvironments(stackAPIClient) {
   let result = {};
-  return stack
+  return stackAPIClient
     .environment()
     .query()
     .find()
@@ -285,15 +292,13 @@ function getEnvironments(stack) {
     });
 }
 
-function getContentTypeCount(stack) {
+function getContentTypeCount(stackAPIClient) {
   return new Promise((resolve, reject) => {
-    stack
+    stackAPIClient
       .contentType()
       .query()
       .count()
-      .then((contentTypes) => {
-        resolve(contentTypes.content_types);
-      })
+      .then((contentTypes) => resolve(contentTypes.content_types))
       .catch((error) => reject(error));
   });
 }
@@ -363,7 +368,7 @@ function write(command, entries, fileName, message) {
 }
 
 function startupQuestions() {
-  return new Promise((resolve) => {
+  return new Promise((resolve, reject) => {
     let actions = [
       {
         type: 'list',
@@ -372,10 +377,13 @@ function startupQuestions() {
         choices: [config.exportEntries, config.exportUsers, 'Exit'],
       },
     ];
-    inquirer.prompt(actions).then((answers) => {
-      if (answers.action === 'Exit') exitProgram();
-      resolve(answers.action);
-    });
+    inquirer
+      .prompt(actions)
+      .then((answers) => {
+        if (answers.action === 'Exit') exitProgram();
+        resolve(answers.action);
+      })
+      .catch(reject);
   });
 }
 
@@ -386,12 +394,17 @@ function getOrgUsers(managementAPIClient, orgUid, ecsv) {
       .then(async (response) => {
         let organization = response.organizations.filter((org) => org.uid === orgUid).pop();
         if (organization.is_owner === true) {
-          let cma = ecsv.region.cma;
-          let authtoken = ecsv.authToken;
-          return HttpClient.create()
-            .headers({ authtoken: authtoken })
-            .get(`${cma}/v3/organizations/${organization.uid}/share`)
-            .then((_response) => resolve({ items: _response.data.shares }));
+          return managementAPIClient
+            .organization(organization.uid)
+            .fetch()
+            .then((_response) => {
+              _response
+                .getInvitations()
+                .then((_data) => {
+                  resolve({ items: _data.items });
+                })
+                .catch(reject);
+            });
         }
         if (!organization.getInvitations) {
           return reject(new Error(config.adminError));
@@ -420,6 +433,7 @@ async function getUsers(organization, params, result = []) {
       return getUsers(organization, params, result);
     }
   } catch (error) {
+    console.error(error);
     throw error;
   }
 }
@@ -448,16 +462,25 @@ function getOrgRoles(managementAPIClient, orgUid, ecsv) {
       .then((response) => {
         let organization = response.organizations.filter((org) => org.uid === orgUid).pop();
         if (organization.is_owner === true) {
-          let cma = ecsv.region.cma;
-          let authtoken = ecsv.authToken;
-          return axios
-            .get(`${cma}/v3/organizations/${organization.uid}/roles`, { headers: { authtoken: authtoken } })
-            .then((_response) => resolve({ items: _response.data.roles }));
+          return managementAPIClient
+            .organization(organization.uid)
+            .fetch()
+            .then((_response) => {
+              _response
+                .roles()
+                .then((_data) => {
+                  resolve({ items: _data.items });
+                })
+                .catch(reject);
+            });
         }
         if (!organization.roles) {
           return reject(new Error(config.adminError));
         }
-        organization.roles().then((roles) => resolve(roles));
+        organization
+          .roles()
+          .then((roles) => resolve(roles))
+          .catch(reject);
       })
       .catch((error) => reject(error));
   });
@@ -540,10 +563,20 @@ function formatError(error) {
   if (error.errors && Object.keys(error.errors).length > 0) {
     Object.keys(error.errors).forEach((e) => {
       let entity = e;
-      if (e === 'authorization') entity = 'Management Token';
-      if (e === 'api_key') entity = 'Stack API key';
-      if (e === 'uid') entity = 'Content Type';
-      if (e === 'access_token') entity = 'Delivery Token';
+      switch (e) {
+        case 'authorization':
+          entity = 'Management Token';
+          break;
+        case 'api_key':
+          entity = 'Stack API key';
+          break;
+        case 'uid':
+          entity = 'Content Type';
+          break;
+        case 'access_token':
+          entity = 'Delivery Token';
+          break;
+      }
       message += ' ' + [entity, error.errors[e]].join(' ');
     });
   }
@@ -551,7 +584,7 @@ function formatError(error) {
 }
 
 function wait(time) {
-  return new Promise(res => {
+  return new Promise((res) => {
     setTimeout(res, time);
   });
 }