@cfworker/csv 1.12.0 → 1.12.3

package/dist/encode.d.ts

@@ -1 +1,4 @@
-export declare function encode(rows: any[]): ReadableStream;
+export interface EncodeOptions {
+    columns?: Record<string, string>;
+}
+export declare function encode(rows: any[], { columns }?: EncodeOptions): ReadableStream;

package/dist/encode.js

@@ -3,25 +3,30 @@ const quoteRegex = /"/g;
 const delimiter = ',';
 const rowDelimiter = '\r\n';
 const requiresQuoteRegex = /["\r\n,]/;
-export function encode(rows) {
+export function encode(rows, { columns } = {}) {
     const { readable, writable } = new TransformStream();
     (async () => {
         const writer = writable.getWriter();
-        await writeRows(writer, rows);
+        if (rows.length > 0) {
+            if (!columns) {
+                columns = Object.keys(rows[0]).reduce((p, c) => {
+                    p[c] = c;
+                    return p;
+                }, {});
+            }
+            await writeRows(writer, rows, columns);
+        }
         await writer.close();
     })();
     return readable;
 }
-async function writeRows(writer, rows) {
+async function writeRows(writer, rows, columns) {
     const text = new TextEncoder();
     const utf8 = text.encode.bind(text);
     const write = writer.write.bind(writer);
-    let keys = undefined;
+    const keys = Object.keys(columns);
+    await write(utf8(keys.map(k => encodeValue(columns[k])).join(delimiter)));
     for (const row of rows) {
-        if (keys === undefined) {
-            keys = Object.keys(row);
-            await write(utf8(keys.map(encodeValue).join(delimiter)));
-        }
         await write(utf8(rowDelimiter));
         let s = '';
         let first = true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cfworker/csv",
-  "version": "1.12.0",
+  "version": "1.12.3",
   "description": "Streaming CSV encoding for Cloudflare Workers and service workers",
   "sideEffects": false,
   "main": "dist/index.js",
@@ -27,11 +27,11 @@
     "test": "cfworker test test/**/*.spec.ts"
   },
   "devDependencies": {
-    "@cfworker/dev": "^1.12.0",
-    "@types/chai": "^4.2.22",
-    "@types/mocha": "^9.0.0",
-    "chai": "^4.3.4",
-    "mocha": "^9.1.3",
-    "typescript": "^4.5.2"
+    "@cfworker/dev": "^1.14.0",
+    "@types/chai": "^4.3.0",
+    "@types/mocha": "^9.1.0",
+    "chai": "^4.3.6",
+    "mocha": "^9.2.1",
+    "typescript": "^4.5.5"
   }
 }

package/src/encode.ts

@@ -4,32 +4,58 @@ const delimiter = ',';
 const rowDelimiter = '\r\n';
 const requiresQuoteRegex = /["\r\n,]/;
 
-export function encode(rows: any[]): ReadableStream {
+export interface EncodeOptions {
+  /**
+   * Properties to include. Values will be used as column name.
+   */
+  columns?: Record<string, string>;
+}
+
+/**
+ * Encode an array of objects as a CSV
+ * @param rows An array of objects. Each item in the array represents a row.
+ * @param options
+ * @returns
+ */
+export function encode(
+  rows: any[],
+  { columns }: EncodeOptions = {}
+): ReadableStream {
   // Cloudflare Workers cannot construct a ReadableStream
   const { readable, writable } = new TransformStream();
-
   (async () => {
     const writer = writable.getWriter();
-    await writeRows(writer, rows);
+    if (rows.length > 0) {
+      if (!columns) {
+        columns = Object.keys(rows[0]).reduce<Record<string, string>>(
+          (p, c) => {
+            p[c] = c;
+            return p;
+          },
+          {}
+        );
+      }
+      await writeRows(writer, rows, columns);
+    }
     await writer.close();
   })();
 
   return readable;
 }
 
-async function writeRows(writer: WritableStreamDefaultWriter, rows: any[]) {
+async function writeRows(
+  writer: WritableStreamDefaultWriter,
+  rows: any[],
+  columns: Record<string, string>
+) {
   const text = new TextEncoder();
   const utf8 = text.encode.bind(text);
   const write = writer.write.bind(writer);
-  let keys: string[] | undefined = undefined;
+  const keys = Object.keys(columns);
+  // write header row
+  await write(utf8(keys.map(k => encodeValue(columns[k])).join(delimiter)));
 
   for (const row of rows) {
-    // write header row
-    if (keys === undefined) {
-      keys = Object.keys(row);
-      await write(utf8(keys.map(encodeValue).join(delimiter)));
-    }
-
     // write row delimiter
     await write(utf8(rowDelimiter));