Enable Export with Excel Format

.changeset/silly-months-unite.md

@@ -0,0 +1,5 @@
+---
+'contexture-export': minor
+---
+
+Enable Excel Export Option

packages/export/package.json

@@ -34,7 +34,9 @@
     "contexture-client": "^2.53.7",
     "futil": "^1.76.4",
     "lodash": "^4.17.21",
-    "minimal-csv-formatter": "^1.0.15"
+    "minimal-csv-formatter": "^1.0.15",
+    "read-excel-file": "^5.8.1",
+    "write-excel-file": "^2.0.1"
   },
   "packageManager": "yarn@3.3.1"
 }

packages/export/src/csv.js

@@ -11,7 +11,8 @@ export default ({
   // and key of the record.
   // [{ key: string(supports lodash dot notation), label: string, display: function(value, {key, record, transform})}...]
   transform,
-  headers = null, // array of strings to use as headers, array or arrays for multi-line headers
+  //TODO: support multi-line headers in excel and csv when implemented
+  headers = null, // array of strings to use as headers
   onWrite = _.noop, // function to intercept writing a page of records
 }) => {
   stream.write(csv(headers || transformLabels(transform)))
@@ -39,6 +40,7 @@ export default ({
         recordsWritten = recordsWritten + _.getOr(1, 'recordCount', r)
         await onWrite({ recordsWritten, record: r })
       }
+      await onWrite({ recordsWritten: recordsWritten, isStreamDone: true })
       await stream.end()
     })(),
     cancel() {

packages/export/src/excel.js

@@ -0,0 +1,78 @@
+import _ from 'lodash/fp.js'
+import writeXlsxFile from 'write-excel-file/node'
+
+const convertToExcelCell = (value) => {
+  return {
+    type: String,
+    typeof: 'string',
+    wrap: true,
+    value: `${value}`,
+  }
+}
+
+export const writeStreamData = async (stream, readStream) => {
+  for await (const chunk of readStream) {
+    stream.write(chunk)
+  }
+}
+
+let transformLabels = _.map(_.get('label'))
+
+export default ({
+  stream, // writable stream target stream
+  iterableData, // iterator for each page of an array of objects
+  // order list of which indicates the header label,
+  // display function for the field,
+  // and key of the record.
+  // [{ key: string(supports lodash dot notation), label: string, display: function(value, {key, record, transform})}...]
+  transform,
+  //TODO: support multi-line headers in excel and csv when implemented
+  headers = null, // array of strings to use as headers
+  onWrite = _.noop, // function to intercept writing a page of records
+}) => {
+  const excelData = [
+    _.map(
+      (value) => ({ value, fontWeight: 'bold' }),
+      headers || transformLabels(transform)
+    ),
+  ]
+
+  let cancel = false
+  let recordsWritten = 0
+
+  return {
+    promise: (async () => {
+      for await (let r of iterableData) {
+        if (cancel) break
+        excelData.push(
+          _.map(
+            (t) =>
+              convertToExcelCell(
+                t.display(_.get(t.key, r), {
+                  key: t.key,
+                  record: r,
+                  transform,
+                })
+              ),
+            transform
+          )
+        )
+        recordsWritten = recordsWritten + _.getOr(1, 'recordCount', r)
+        await onWrite({ recordsWritten })
+      }
+      let columns = _.map(
+        () => ({
+          width: 50,
+        }),
+        excelData[1]
+      )
+      const readStream = await writeXlsxFile(excelData, { columns })
+      await writeStreamData(stream, readStream)
+      await onWrite({ recordsWritten: recordsWritten, isStreamDone: true })
+      await stream.end()
+    })(),
+    cancel() {
+      cancel = true
+    },
+  }
+}

packages/export/src/excel.test.js

@@ -0,0 +1,66 @@
+import _ from 'lodash/fp.js'
+import { PassThrough } from 'stream'
+import writeXlsxFile from 'write-excel-file/node'
+import readXlsxFile from 'read-excel-file/node'
+import { writeStreamData } from './excel.js'
+
+const testDate = new Date()
+
+const HEADER_ROW = [
+  {
+    value: 'Name',
+    fontWeight: 'bold',
+  },
+  {
+    value: 'Date of Birth',
+    fontWeight: 'bold',
+  },
+  {
+    value: 'Cost',
+    fontWeight: 'bold',
+  },
+  {
+    value: 'Paid',
+    fontWeight: 'bold',
+  },
+]
+
+const DATA_ROW_1 = [
+  {
+    type: String,
+    value: 'John Smith',
+  },
+  {
+    type: Date,
+    value: testDate,
+    format: 'mm/dd/yyyy',
+  },
+  {
+    type: Number,
+    value: 1800,
+  },
+  {
+    type: Boolean,
+    value: true,
+  },
+]
+
+const expectedFileContents = [
+  ['Name', 'Date of Birth', 'Cost', 'Paid'],
+  ['John Smith', testDate, 1800, true],
+]
+
+const excelData = [HEADER_ROW, DATA_ROW_1]
+
+// These are skipped on purpose as they actual write CSVs
+describe('Excel Stream Test', () => {
+  it('Export to Excel and Validate', async () => {
+    const writeStream = new PassThrough()
+    const readStream = await writeXlsxFile(excelData)
+    await writeStreamData(writeStream, readStream)
+    const rows = await readXlsxFile(writeStream)
+    console.log(rows)
+    console.log(expectedFileContents)
+    expect(rows).toStrictEqual(expectedFileContents)
+  })
+})

packages/export/src/index.js

@@ -1,5 +1,6 @@
 import csv from './csv.js'
+import excel from './excel.js'
 import * as nodes from './nodes/index.js'
 
-export { nodes, csv }
+export { nodes, csv, excel }
 export * from './utils.js'