@contentstack/cli-cm-export-to-csv 1.3.9 → 1.3.11

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.3.9",
+  "version": "1.3.11",
   "commands": {
     "cm:export-to-csv": {
       "id": "cm:export-to-csv",
@@ -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",

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@contentstack/cli-cm-export-to-csv",
   "description": "Export entities to csv",
-  "version": "1.3.9",
+  "version": "1.3.11",
   "author": "Abhinav Gupta @abhinav-from-contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
-    "@contentstack/cli-command": "^1.2.9",
-    "@contentstack/cli-utilities": "^1.4.5",
+    "@contentstack/cli-command": "^1.2.10",
+    "@contentstack/cli-utilities": "^1.5.0",
     "chalk": "^4.1.0",
     "fast-csv": "^4.3.6",
     "inquirer": "8.2.4",
@@ -17,7 +17,7 @@
     "@oclif/test": "^2.2.10",
     "chai": "^4.2.0",
     "debug": "^4.3.1",
-    "eslint": "^8.18.0",
+    "eslint": "^7.32.0",
     "eslint-config-oclif": "^4.0.0",
     "globby": "^10.0.2",
     "mocha": "^10.0.0",
@@ -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"
   },
@@ -60,4 +61,4 @@
     }
   },
   "repository": "https://github.com/contentstack/cli"
-}
+}

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

@@ -33,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,
@@ -64,6 +70,7 @@ class ExportToCsvCommand extends Command {
           action: actionFlag,
           'org-name': orgName,
           'stack-name': stackName,
+          'stack-api-key': stackAPIKey,
           locale: locale,
           'content-type': contentTypesFlag,
           alias: managementTokenAlias,
@@ -119,8 +126,11 @@ 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);
@@ -156,6 +166,19 @@ class ExportToCsvCommand extends Command {
 
             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);
@@ -193,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;
         }
@@ -225,13 +247,13 @@ 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 || error.errorMessage) {
-              this.log(util.formatError(error));
+              cliux.error(util.formatError(error));
             }
           }
           break;
@@ -239,7 +261,7 @@ class ExportToCsvCommand extends Command {
       }
     } catch (error) {
       if (error.message || error.errorMessage) {
-        this.log(util.formatError(error));
+        cliux.error(util.formatError(error));
       }
     }
   }

package/src/util/index.js

@@ -8,7 +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 { cliux, configHandler } = require('@contentstack/cli-utilities');
 
 const directory = './data';
 const delimeter = os.platform() === 'win32' ? '\\' : '/';
@@ -59,8 +59,16 @@ async function getOrganizations(managementAPIClient) {
 }
 
 async function getOrganizationList(managementAPIClient, params, result = []) {
-  const organizations = await managementAPIClient.organization().fetchAll(params);
-  result = result.concat(organizations.items);
+  let organizations;
+  const configOrgUid = configHandler.get('oauthOrgUid');
+
+  if (configOrgUid) {
+    organizations = await managementAPIClient.organization(configOrgUid).fetch();
+    result = result.concat([organizations]);
+  } else {
+    organizations = await managementAPIClient.organization().fetchAll({ limit: 100 });
+    result = result.concat(organizations.items);
+  }
 
   if (!organizations.items || (organizations.items && organizations.items.length < params.limit)) {
     const orgMap = {};
@@ -76,35 +84,53 @@ async function getOrganizationList(managementAPIClient, params, result = []) {
   }
 }
 
-function getOrganizationsWhereUserIsAdmin(managementAPIClient) {
-  return new Promise((resolve, reject) => {
+async function getOrganizationsWhereUserIsAdmin(managementAPIClient) {
+  try {
     let result = {};
-    managementAPIClient
-      .getUser({ include_orgs_roles: true })
-      .then((response) => {
-        let organizations = response.organizations.filter((org) => {
-          if (org.org_roles) {
-            const org_role = org.org_roles.shift();
-            return org_role.admin;
-          }
-          return org.is_owner === true;
-        });
-        organizations.forEach((org) => {
-          result[org.name] = org.uid;
-        });
-        resolve(result);
-      })
-      .catch((error) => reject(error));
-  });
+    const configOrgUid = configHandler.get('oauthOrgUid');
+
+    if (configOrgUid) {
+      const response = await managementAPIClient.organization(configOrgUid).fetch();
+      result[response.name] = response.uid;
+    } else {
+      const response = await managementAPIClient.getUser({ include_orgs_roles: true });
+      const organizations = response.organizations.filter((org) => {
+        if (org.org_roles) {
+          const org_role = org.org_roles.shift();
+          return org_role.admin;
+        }
+        return org.is_owner === true;
+      });
+
+      organizations.forEach((org) => {
+        result[org.name] = org.uid;
+      });
+  }
+
+    return result;
+  } catch (error) {
+    throw error;
+  }
 }
 
-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',
@@ -242,7 +268,9 @@ function getContentTypes(stackAPIClient, skip) {
         });
         resolve(result);
       })
-      .catch((error) => reject(error));
+      .catch((error) => {
+        reject(error);
+      });
   });
 }
 
@@ -397,7 +425,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 });
 }