@contentstack/cli-cm-export-to-csv 1.4.0 → 1.4.2

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "@contentstack/cli-cm-export-to-csv",
   "description": "Export entities to csv",
-  "version": "1.4.0",
+  "version": "1.4.2",
   "author": "Abhinav Gupta @abhinav-from-contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
-    "@contentstack/cli-command": "~1.2.11",
-    "@contentstack/cli-utilities": "~1.5.1",
+    "@contentstack/cli-command": "~1.2.12",
+    "@contentstack/cli-utilities": "~1.5.2",
     "chalk": "^4.1.0",
     "fast-csv": "^4.3.6",
     "inquirer": "8.2.4",
     "inquirer-checkbox-plus-prompt": "1.0.1",
-    "mkdirp": "^1.0.4"
+    "mkdirp": "^3.0.1"
   },
   "devDependencies": {
     "@oclif/test": "^2.2.10",

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

@@ -207,7 +207,7 @@ class ExportToCsvCommand extends Command {
               const entriesCount = await util.getEntriesCount(stackAPIClient, contentType, language.code);
               let flatEntries = [];
               for (let index = 0; index < entriesCount / 100; index++) {
-                const entriesResult = await util.getEntries(stackAPIClient, contentType, language.code, index);
+                const entriesResult = await util.getEntries(stackAPIClient, contentType, language.code, index, 100);
                 const flatEntriesResult = util.cleanEntries(
                   entriesResult.items,
                   language.code,

package/src/util/index.js

@@ -199,7 +199,7 @@ function chooseContentType(stackAPIClient, skip) {
     let _chooseContentType = [
       {
         type: 'checkbox',
-        message: 'Choose Content Type',
+        message: 'Choose Content Type (Press Space to select the content types) ',
         choices: contentTypesList,
         name: 'chosenContentTypes',
         loop: false,
@@ -218,7 +218,7 @@ function chooseInMemContentTypes(contentTypesList) {
     let _chooseContentType = [
       {
         type: 'checkbox-plus',
-        message: 'Choose Content Type',
+        message: 'Choose Content Type (Press Space to select the content types)',
         choices: contentTypesList,
         name: 'chosenContentTypes',
         loop: false,
@@ -316,12 +316,12 @@ function getLanguages(stackAPIClient) {
   });
 }
 
-function getEntries(stackAPIClient, contentType, language, skip) {
+function getEntries(stackAPIClient, contentType, language, skip, limit) {
   return new Promise((resolve, reject) => {
     stackAPIClient
       .contentType(contentType)
       .entry()
-      .query({ include_publish_details: true, locale: language, skip: skip * 100 })
+      .query({ include_publish_details: true, locale: language, skip: skip * 100, limit: limit, include_workflow: true })
       .find()
       .then((entries) => resolve(entries))
       .catch((error) => reject(error));
@@ -371,27 +371,50 @@ function exitProgram() {
   process.exit();
 }
 
+function sanitizeEntries(flatEntry) {
+  // sanitize against CSV Injections
+  const CSVRegex = /^[\\+\\=@\\-]/
+  for (key in flatEntry) {
+    if (typeof flatEntry[key] === 'string' && flatEntry[key].match(CSVRegex)) {
+      flatEntry[key] = flatEntry[key].replace(/\"/g, "\"\"");
+      flatEntry[key] = `"'${flatEntry[key]}"`
+    } else if (typeof flatEntry[key] === 'object') {
+      // convert any objects or arrays to string
+      // to store this data correctly in csv
+      flatEntry[key] = JSON.stringify(flatEntry[key]);
+    }
+  }
+  return flatEntry;
+}
+
 function cleanEntries(entries, language, environments, contentTypeUid) {
   const filteredEntries = entries.filter((entry) => {
-    return entry['locale'] === language && entry.publish_details.length > 0;
+    return entry['locale'] === language;
   });
-
   return filteredEntries.map((entry) => {
     let workflow = '';
     const envArr = [];
-    entry.publish_details.forEach((env) => {
-      envArr.push(JSON.stringify([environments[env['environment']], env['locale'], env['time']]));
-    });
+    if(entry.publish_details.length) {
+      entry.publish_details.forEach((env) => {
+        envArr.push(JSON.stringify([environments[env['environment']], env['locale'], env['time']]));
+      });
+    }
+
     delete entry.publish_details;
+    delete entry.setWorkflowStage;
     if ('_workflow' in entry) {
-      workflow = entry['_workflow']['name'];
-      delete entry['_workflow'];
+        if(entry._workflow?.name) {
+          workflow = entry['_workflow']['name'];
+          delete entry['_workflow'];
+        }
     }
     entry = flatten(entry);
+    entry = sanitizeEntries(entry);
     entry['publish_details'] = envArr;
     entry['_workflow'] = workflow;
     entry['ACL'] = JSON.stringify({}); // setting ACL to empty obj
     entry['content_type_uid'] = contentTypeUid; // content_type_uid is being returned as 'uid' from the sdk for some reason
+
     // entry['url'] might also be wrong
     delete entry.stackHeaders;
     delete entry.update;