spice-js 2.7.26 → 2.7.27

package/build/utility/RestHelper.js

@@ -140,6 +140,31 @@ class RestHelper {
               numeric: true,
               sensitivity: "base"
             }));
+
+            // Filter flattened fields to only include requested columns
+            var rawUrl = ctx.originalUrl || ctx.request.url || "";
+            var urlColumnsMatch = rawUrl.match(/[?&]columns=([^&]*)/);
+            var requestedColumns = urlColumnsMatch ? decodeURIComponent(urlColumnsMatch[1]) : null;
+            if (requestedColumns) {
+              var specs = requestedColumns.split(",").map(c => c.trim()).filter(c => c !== "");
+              var filtered = [];
+              for (var spec of specs) {
+                if (!spec.includes(".")) {
+                  // Simple field: exact match
+                  if (fields.includes(spec)) filtered.push(spec);
+                } else {
+                  // Nested field: build regex that allows numeric array indices between segments
+                  // and optionally matches all descendant fields.
+                  var segments = spec.split(".");
+                  var pattern = segments.map(s => s.replace(/[.*+?^${}()|[\]\\]/g, "\\$&")).join("(\\.\\d+)?\\.");
+                  var re = new RegExp("^" + pattern + "(\\..+)?$");
+                  for (var f of fields) {
+                    if (re.test(f)) filtered.push(f);
+                  }
+                }
+              }
+              fields = filtered.length > 0 ? filtered : fields;
+            }
             var csv = parse(flatRows, {
               fields,
               defaultValue: "",
@@ -154,7 +179,7 @@ class RestHelper {
             ctx.status = 200;
             var csvStream = fs.createReadStream(filePath);
             // Delete file after stream is finished
-            csvStream.on('close', () => {
+            csvStream.on("close", () => {
               fs.promises.unlink(filePath).catch(() => {});
             });
             ctx.body = csvStream;
@@ -174,7 +199,7 @@ class RestHelper {
         ctx.status = 200;
         var jsonStream = fs.createReadStream(filePath);
         // Delete file after stream is finished
-        jsonStream.on('close', () => {
+        jsonStream.on("close", () => {
           fs.promises.unlink(filePath).catch(() => {});
         });
         ctx.body = jsonStream;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spice-js",
-  "version": "2.7.26",
+  "version": "2.7.27",
   "description": "spice",
   "main": "build/index.js",
   "repository": {

package/src/utility/RestHelper.js

@@ -24,7 +24,7 @@ export default class RestHelper {
           RestHelper.SUCCESS,
           ctx.data,
           ctx.errors,
-          ctx.token
+          ctx.token,
         );
       }
       ctx.status = 200;
@@ -44,7 +44,7 @@ export default class RestHelper {
     const makeDirectory = (dir) => {
       if (!fs.existsSync(dir)) fs.mkdirSync(dir, { recursive: true });
     };
-  
+
     const deepTrimStrings = (val) => {
       if (Array.isArray(val)) return val.map(deepTrimStrings);
       if (val && typeof val === "object") {
@@ -54,9 +54,10 @@ export default class RestHelper {
       }
       return typeof val === "string" ? val.trim() : val;
     };
-  
+
     const stripTopLevel = (obj, { removeId }) => {
-      if (Array.isArray(obj)) return obj.map((i) => stripTopLevel(i, { removeId }));
+      if (Array.isArray(obj))
+        return obj.map((i) => stripTopLevel(i, { removeId }));
       if (obj && typeof obj === "object") {
         const copy = { ...obj };
         if (removeId) delete copy.id;
@@ -65,7 +66,7 @@ export default class RestHelper {
       }
       return obj;
     };
-  
+
     const normalizeEmptyArraysForCsv = (val) => {
       if (Array.isArray(val)) {
         if (val.length === 0) return undefined;
@@ -81,7 +82,7 @@ export default class RestHelper {
       }
       return val;
     };
-  
+
     const safeJSONStringify = (value, space = 2) => {
       const seen = new WeakSet();
       const replacer = (_k, v) => {
@@ -95,31 +96,72 @@ export default class RestHelper {
       };
       return JSON.stringify(value, replacer, space);
     };
-  
+
     try {
       const download_type = (ctx.request.query.format || "csv").toLowerCase();
       const include_id = ctx.request.query.include_id;
-  
+
       const original = _.cloneDeep(ctx.data);
-      const trimmed  = deepTrimStrings(original);
-      const cleaned  = stripTopLevel(trimmed, { removeId: !include_id || include_id === "false" });
-  
+      const trimmed = deepTrimStrings(original);
+      const cleaned = stripTopLevel(trimmed, {
+        removeId: !include_id || include_id === "false",
+      });
+
       let filename, filePath;
-  
+
       if (download_type === "csv") {
         const { flatten } = await import("flat");
         const rows = Array.isArray(cleaned) ? cleaned : [cleaned];
-  
+
         const csvReady = rows.map(normalizeEmptyArraysForCsv);
-        const flatRows = csvReady.map((row) => flatten(row, { safe: false, delimiter: "." }));
-  
+        const flatRows = csvReady.map((row) =>
+          flatten(row, { safe: false, delimiter: "." }),
+        );
+
         const fieldSet = new Set();
-        for (const r of flatRows) Object.keys(r).forEach((k) => fieldSet.add(k));
-        const fields = Array.from(fieldSet).sort((a, b) =>
-          a.localeCompare(b, undefined, { numeric: true, sensitivity: "base" })
+        for (const r of flatRows)
+          Object.keys(r).forEach((k) => fieldSet.add(k));
+        let fields = Array.from(fieldSet).sort((a, b) =>
+          a.localeCompare(b, undefined, { numeric: true, sensitivity: "base" }),
         );
-  
-      const csv = parse(flatRows, { fields, defaultValue: "", excelStrings: true });
+
+        // Filter flattened fields to only include requested columns
+        const rawUrl = ctx.originalUrl || ctx.request.url || "";
+        const urlColumnsMatch = rawUrl.match(/[?&]columns=([^&]*)/);
+        const requestedColumns = urlColumnsMatch
+          ? decodeURIComponent(urlColumnsMatch[1])
+          : null;
+        if (requestedColumns) {
+          const specs = requestedColumns
+            .split(",")
+            .map((c) => c.trim())
+            .filter((c) => c !== "");
+          const filtered = [];
+          for (const spec of specs) {
+            if (!spec.includes(".")) {
+              // Simple field: exact match
+              if (fields.includes(spec)) filtered.push(spec);
+            } else {
+              // Nested field: build regex that allows numeric array indices between segments
+              // and optionally matches all descendant fields.
+              const segments = spec.split(".");
+              const pattern = segments
+                .map((s) => s.replace(/[.*+?^${}()|[\]\\]/g, "\\$&"))
+                .join("(\\.\\d+)?\\.");
+              const re = new RegExp("^" + pattern + "(\\..+)?$");
+              for (const f of fields) {
+                if (re.test(f)) filtered.push(f);
+              }
+            }
+          }
+          fields = filtered.length > 0 ? filtered : fields;
+        }
+
+        const csv = parse(flatRows, {
+          fields,
+          defaultValue: "",
+          excelStrings: true,
+        });
 
         makeDirectory(`./storage/exports/csv`);
         filename = `${RestHelper.makeid(9)}.csv`;
@@ -131,7 +173,7 @@ export default class RestHelper {
         ctx.status = 200;
         const csvStream = fs.createReadStream(filePath);
         // Delete file after stream is finished
-        csvStream.on('close', () => {
+        csvStream.on("close", () => {
           fs.promises.unlink(filePath).catch(() => {});
         });
         ctx.body = csvStream;
@@ -139,7 +181,7 @@ export default class RestHelper {
       }
 
       const jsonText = safeJSONStringify(cleaned, 2);
-  
+
       makeDirectory(`./storage/exports/json`);
       filename = `${RestHelper.makeid(9)}.json`;
       filePath = path.resolve(`./storage/exports/json/${filename}`);
@@ -149,11 +191,10 @@ export default class RestHelper {
       ctx.status = 200;
       const jsonStream = fs.createReadStream(filePath);
       // Delete file after stream is finished
-      jsonStream.on('close', () => {
+      jsonStream.on("close", () => {
         fs.promises.unlink(filePath).catch(() => {});
       });
       ctx.body = jsonStream;
-  
     } catch (e) {
       console.error(e.stack);
       ctx.status = 400;
@@ -179,7 +220,7 @@ export default class RestHelper {
     obj = {
       data: [],
       total: null,
-    }
+    },
   ) {
     var data = {
       status: status,
@@ -267,4 +308,3 @@ export default class RestHelper {
     return false;
   }
 }
-