dce-reactkit 4.1.2 → 4.1.3

package/dist/esm/types/helpers/genCSV.d.ts

@@ -2,7 +2,10 @@
  * Generate a CSV file
  * @author Gabe Abrams
  * @param data list of row data in the form of json objects
- * @param columns list of columns to include in the csv
+ * @param columns list of columns to include in the csv where each column is an object with:
+ * - title: the column title
+ * - param: the key in the data object to use for this column
+ * - textIfUndefined: optional text to use if the value is undefined (defaults to empty string)
  * @returns multiline csv string
  */
 declare const genCSV: (data: {
@@ -10,5 +13,6 @@ declare const genCSV: (data: {
 }[], columns: {
     title: string;
     param: string;
+    textIfUndefined?: string;
 }[]) => string;
 export default genCSV;

package/dist/index.d.ts

@@ -1269,7 +1269,10 @@ declare const getMonthName: (month: number) => {
  * Generate a CSV file
  * @author Gabe Abrams
  * @param data list of row data in the form of json objects
- * @param columns list of columns to include in the csv
+ * @param columns list of columns to include in the csv where each column is an object with:
+ * - title: the column title
+ * - param: the key in the data object to use for this column
+ * - textIfUndefined: optional text to use if the value is undefined (defaults to empty string)
  * @returns multiline csv string
  */
 declare const genCSV: (data: {
@@ -1277,6 +1280,7 @@ declare const genCSV: (data: {
 }[], columns: {
     title: string;
     param: string;
+    textIfUndefined?: string;
 }[]) => string;
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dce-reactkit",
-  "version": "4.1.2",
+  "version": "4.1.3",
   "description": "Shared components for Harvard DCE apps",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

package/src/helpers/genCSV.test.ts

@@ -23,7 +23,7 @@ describe('genCSV', () => {
       { name: 'Bob', age: 30, email: 'bob@example.com' },
       { name: 'Charlie', age: 35, email: 'charlie@example.com' },
     ];
-    const expected = `Name,Age,Email\nAlice,25,alice@example.com\nBob,30,bob@example.com\nCharlie,35,charlie@example.com`;
+    const expected = 'Name,Age,Email\nAlice,25,alice@example.com\nBob,30,bob@example.com\nCharlie,35,charlie@example.com';
     const result = genCSV(data, columns);
     expect(result).toEqual(expected);
   });
@@ -39,7 +39,7 @@ describe('genCSV', () => {
       { name: 'Bob', age: null, email: 'bob@example.com' },
       { name: 'Charlie', age: 35, email: undefined },
     ];
-    const expected = `Name,Age,Email\nAlice,,\nBob,,bob@example.com\nCharlie,35,`;
+    const expected = 'Name,Age,Email\nAlice,,\nBob,,bob@example.com\nCharlie,35,';
     const result = genCSV(data, columns);
     expect(result).toEqual(expected);
   });
@@ -54,8 +54,22 @@ describe('genCSV', () => {
       { name: 'Bob', data: [1, 2, 3] },
       { name: 'Charlie', data: null },
     ];
-    const expected = `Name,Data\nAlice,"{""foo"":""bar""}"\nBob,"[1,2,3]"\nCharlie,`;
+    const expected = 'Name,Data\nAlice,"{""foo"":""bar""}"\nBob,"[1,2,3]"\nCharlie,';
     const result = genCSV(data, columns);
     expect(result).toEqual(expected);
   });
-});
+
+  it('should use textIfUndefined for undefined values', () => {
+    const columns = [
+      { title: 'Name', param: 'name' },
+      { title: 'Age', param: 'age', textIfUndefined: 'N/A' },
+    ];
+    const data = [
+      { name: 'Alice', age: undefined },
+      { name: 'Bob', age: 30 },
+    ];
+    const expected = 'Name,Age\nAlice,N/A\nBob,30';
+    const result = genCSV(data, columns);
+    expect(result).toEqual(expected);
+  });
+});

package/src/helpers/genCSV.ts

@@ -21,7 +21,10 @@ const escapeCellText = (text: string): string => {
  * Generate a CSV file
  * @author Gabe Abrams
  * @param data list of row data in the form of json objects
- * @param columns list of columns to include in the csv
+ * @param columns list of columns to include in the csv where each column is an object with:
+ * - title: the column title
+ * - param: the key in the data object to use for this column
+ * - textIfUndefined: optional text to use if the value is undefined (defaults to empty string)
  * @returns multiline csv string
  */
 const genCSV = (
@@ -31,6 +34,7 @@ const genCSV = (
   columns: {
     title: string,
     param: string,
+    textIfUndefined?: string,
   }[],
 ): string => {
   let csv = '';
@@ -57,11 +61,13 @@ const genCSV = (
             || typeof cell === 'number'
           ) {
             contents = String(cell);
-          } else if (
-            typeof cell === 'undefined'
-            || cell === null
-          ) {
+          } else if (cell === null) {
             contents = '';
+          } else if (typeof cell === 'undefined') {
+            contents = (
+              column.textIfUndefined
+              ?? ''
+            );
           } else if (typeof cell === 'object') {
             contents = JSON.stringify(cell);
           } else {