fix(json-to-csv): handle single object and flatten

Fix CorentinTh#1203

Author: sharevb

package.json

@@ -41,8 +41,8 @@
     "@tiptap/pm": "2.1.6",
     "@tiptap/starter-kit": "2.1.6",
     "@tiptap/vue-3": "2.0.3",
-    "@types/markdown-it": "^13.0.7",
     "@types/figlet": "^1.5.8",
+    "@types/markdown-it": "^13.0.7",
     "@vicons/material": "^0.12.0",
     "@vicons/tabler": "^0.12.0",
     "@vueuse/core": "^10.3.0",
@@ -62,6 +62,7 @@
     "emojilib": "^3.0.10",
     "figlet": "^1.7.0",
     "figue": "^1.2.0",
+    "flatten-anything": "^4.0.1",
     "fuse.js": "^6.6.2",
     "highlight.js": "^11.7.0",
     "iarna-toml-esm": "^3.0.5",

pnpm-lock.yaml

@@ -0,0 +1,7 @@
+declare module "flatten-anything" {
+    export function flatten(objectOrArray: {
+        [key in string]: any;
+    }, untilDepth?: number): {
+        [key in string]: any;
+    };
+}

src/tools/json-to-csv/flatten-anything.d.ts

@@ -3,6 +3,10 @@ import { convertArrayToCsv, getHeaders } from './json-to-csv.service';
 
 describe('json-to-csv service', () => {
   describe('getHeaders', () => {
+    it('extracts all the keys from the array of nested objects', () => {
+      expect(getHeaders({ array: [{ a: { c: 1, d: 1 }, b: 2 }, { a: 3, c: 4 }] })).toEqual(['a.c', 'a.d', 'b', 'a', 'c']);
+    });
+
     it('extracts all the keys from the array of objects', () => {
       expect(getHeaders({ array: [{ a: 1, b: 2 }, { a: 3, c: 4 }] })).toEqual(['a', 'b', 'c']);
     });
@@ -20,7 +24,7 @@ describe('json-to-csv service', () => {
 
       ];
 
-      expect(convertArrayToCsv({ array })).toMatchInlineSnapshot(`
+      expect(convertArrayToCsv({ arrayOrObject: array })).toMatchInlineSnapshot(`
         "a,b
         1,2
         3,4"
@@ -33,7 +37,7 @@ describe('json-to-csv service', () => {
         { a: 3, c: 4 },
       ];
 
-      expect(convertArrayToCsv({ array })).toMatchInlineSnapshot(`
+      expect(convertArrayToCsv({ arrayOrObject: array })).toMatchInlineSnapshot(`
         "a,b,c
         1,2,
         3,,4"
@@ -45,7 +49,7 @@ describe('json-to-csv service', () => {
         { a: null, b: 2 },
       ];
 
-      expect(convertArrayToCsv({ array })).toMatchInlineSnapshot(`
+      expect(convertArrayToCsv({ arrayOrObject: array })).toMatchInlineSnapshot(`
         "a,b
         null,2"
       `);
@@ -57,7 +61,7 @@ describe('json-to-csv service', () => {
         { b: 3 },
       ];
 
-      expect(convertArrayToCsv({ array })).toMatchInlineSnapshot(`
+      expect(convertArrayToCsv({ arrayOrObject: array })).toMatchInlineSnapshot(`
         "a,b
         ,2
         ,3"
@@ -69,7 +73,7 @@ describe('json-to-csv service', () => {
         { a: 'hello, world', b: 2 },
       ];
 
-      expect(convertArrayToCsv({ array })).toMatchInlineSnapshot(`
+      expect(convertArrayToCsv({ arrayOrObject: array })).toMatchInlineSnapshot(`
         "a,b
         \\"hello, world\\",2"
       `);
@@ -80,10 +84,32 @@ describe('json-to-csv service', () => {
         { a: 'hello "world"', b: 2 },
       ];
 
-      expect(convertArrayToCsv({ array })).toMatchInlineSnapshot(`
+      expect(convertArrayToCsv({ arrayOrObject: array })).toMatchInlineSnapshot(`
         "a,b
         hello \\\\\\"world\\\\\\",2"
       `);
     });
+
+    it('converts an array of nested objects to a CSV string', () => {
+      const array = [
+        { a: { c: 1, d: 1 }, b: 2 },
+        { a: 3, c: 4 },
+      ];
+
+      expect(convertArrayToCsv({ arrayOrObject: array })).toMatchInlineSnapshot(`
+        "a.c,a.d,b,a,c
+        1,1,2,,
+        ,,,3,4"
+      `);
+    });
+
+    it('converts an object to a CSV string', () => {
+      const obj = { a: { c: 1, d: 1 }, b: 2 };
+
+      expect(convertArrayToCsv({ arrayOrObject: obj })).toMatchInlineSnapshot(`
+        "a.c,a.d,b
+        1,1,2"
+      `);
+    });
   });
 });

src/tools/json-to-csv/json-to-csv.service.test.ts

@@ -1,9 +1,11 @@
+import { flatten } from 'flatten-anything';
+
 export { getHeaders, convertArrayToCsv };
 
 function getHeaders({ array }: { array: Record<string, unknown>[] }): string[] {
   const headers = new Set<string>();
 
-  array.forEach(item => Object.keys(item).forEach(key => headers.add(key)));
+  array.forEach(item => Object.keys(flatten(item)).forEach(key => headers.add(key)));
 
   return Array.from(headers);
 }
@@ -26,10 +28,12 @@ function serializeValue(value: unknown): string {
   return valueAsString;
 }
 
-function convertArrayToCsv({ array }: { array: Record<string, unknown>[] }): string {
+function convertArrayToCsv({ arrayOrObject }: { arrayOrObject: Record<string, unknown>[] | Record<string, unknown> }): string {
+  const array = !Array.isArray(arrayOrObject) ? [arrayOrObject] : arrayOrObject;
+
   const headers = getHeaders({ array });
 
-  const rows = array.map(item => headers.map(header => serializeValue(item[header])));
+  const rows = array.map(item => headers.map(header => serializeValue(flatten(item)[header])));
 
   return [headers.join(','), ...rows].join('\n');
 }

src/tools/json-to-csv/json-to-csv.service.ts

@@ -9,7 +9,7 @@ function transformer(value: string) {
     if (value === '') {
       return '';
     }
-    return convertArrayToCsv({ array: JSON5.parse(value) });
+    return convertArrayToCsv({ arrayOrObject: JSON5.parse(value) });
   }, '');
 }