@naturalcycles/nodejs-lib 12.89.0 → 12.90.0

package/dist/csv/csvWriter.d.ts

@@ -7,7 +7,7 @@ export interface CSVWriterConfig {
     /**
      * Array of columns
      */
-    columns: string[];
+    columns?: string[];
     /**
      * Default: true
      */
@@ -15,7 +15,9 @@ export interface CSVWriterConfig {
 }
 export declare class CSVWriter {
     constructor(cfg: CSVWriterConfig);
-    cfg: Required<CSVWriterConfig>;
+    cfg: CSVWriterConfig & {
+        delimiter: string;
+    };
     writeRows(rows: AnyObject[]): string;
     writeHeader(): string;
     writeRow(row: AnyObject): string;
@@ -23,4 +25,8 @@ export declare class CSVWriter {
     private quote;
     private shouldQuote;
 }
-export declare function arrayToCSVString(arr: AnyObject[], cfg: CSVWriterConfig): string;
+export declare function arrayToCSVString(arr: AnyObject[], cfg?: CSVWriterConfig): string;
+/**
+ * Iterates over the whole array and notes all possible columns.
+ */
+export declare function arrayToCSVColumns(arr: AnyObject[]): string[];

package/dist/csv/csvWriter.js

@@ -1,7 +1,8 @@
 "use strict";
 // Inspired by: https://github.com/ryu1kn/csv-writer/
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.arrayToCSVString = exports.CSVWriter = void 0;
+exports.arrayToCSVColumns = exports.arrayToCSVString = exports.CSVWriter = void 0;
+const js_lib_1 = require("@naturalcycles/js-lib");
 class CSVWriter {
     constructor(cfg) {
         this.cfg = {
@@ -13,14 +14,18 @@ class CSVWriter {
     writeRows(rows) {
         let s = '';
         if (this.cfg.includeHeader) {
+            // Detect columns based on content, if not defined upfront
+            this.cfg.columns ||= arrayToCSVColumns(rows);
             s += this.writeHeader() + '\n';
         }
         return s + rows.map(row => this.writeRow(row)).join('\n');
     }
     writeHeader() {
+        (0, js_lib_1._assert)(this.cfg.columns, 'CSVWriter cannot writeHeader, because columns were not provided');
         return this.cfg.columns.map(col => this.quoteIfNeeded(col)).join(this.cfg.delimiter);
     }
     writeRow(row) {
+        (0, js_lib_1._assert)(this.cfg.columns, 'CSVWriter cannot writeRow, because columns were not provided');
         return this.cfg.columns
             .map(col => this.quoteIfNeeded(String(row[col] ?? '')))
             .join(this.cfg.delimiter);
@@ -32,12 +37,21 @@ class CSVWriter {
         return `"${s.replace(/"/g, '""')}"`;
     }
     shouldQuote(s) {
-        return s.includes(this.cfg.delimiter) || s.includes('\r') || s.includes('\n') || s.includes('"');
+        return s.includes(this.cfg.delimiter) || s.includes('"') || s.includes('\n') || s.includes('\r');
     }
 }
 exports.CSVWriter = CSVWriter;
-function arrayToCSVString(arr, cfg) {
+function arrayToCSVString(arr, cfg = {}) {
     const writer = new CSVWriter(cfg);
     return writer.writeRows(arr);
 }
 exports.arrayToCSVString = arrayToCSVString;
+/**
+ * Iterates over the whole array and notes all possible columns.
+ */
+function arrayToCSVColumns(arr) {
+    const cols = new Set();
+    arr.forEach(row => Object.keys(row).forEach(col => cols.add(col)));
+    return [...cols];
+}
+exports.arrayToCSVColumns = arrayToCSVColumns;

package/dist/csv/transformToCSV.d.ts

@@ -12,4 +12,9 @@ export interface TransformToCSVOptions extends CSVWriterConfig {
 /**
  * Transforms objects (objectMode=true) into chunks \n-terminated CSV strings (readableObjectMode=false).
  */
-export declare function transformToCSV<IN extends AnyObject = any>(opt: TransformToCSVOptions): TransformTyped<IN, string>;
+export declare function transformToCSV<IN extends AnyObject = any>(opt: TransformToCSVOptions & {
+    /**
+     * Columns are required, as they cannot be detected on the fly.
+     */
+    columns: string[];
+}): TransformTyped<IN, string>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/nodejs-lib",
-  "version": "12.89.0",
+  "version": "12.90.0",
   "scripts": {
     "prepare": "husky install",
     "docs-serve": "vuepress dev docs",

package/src/csv/csvWriter.ts

@@ -1,6 +1,6 @@
 // Inspired by: https://github.com/ryu1kn/csv-writer/
 
-import { AnyObject } from '@naturalcycles/js-lib'
+import { _assert, AnyObject } from '@naturalcycles/js-lib'
 
 export interface CSVWriterConfig {
   /**
@@ -11,7 +11,7 @@ export interface CSVWriterConfig {
   /**
    * Array of columns
    */
-  columns: string[]
+  columns?: string[]
 
   /**
    * Default: true
@@ -28,21 +28,26 @@ export class CSVWriter {
     }
   }
 
-  public cfg: Required<CSVWriterConfig>
+  public cfg: CSVWriterConfig & { delimiter: string }
 
   writeRows(rows: AnyObject[]): string {
     let s = ''
     if (this.cfg.includeHeader) {
+      // Detect columns based on content, if not defined upfront
+      this.cfg.columns ||= arrayToCSVColumns(rows)
+
       s += this.writeHeader() + '\n'
     }
     return s + rows.map(row => this.writeRow(row)).join('\n')
   }
 
   writeHeader(): string {
+    _assert(this.cfg.columns, 'CSVWriter cannot writeHeader, because columns were not provided')
     return this.cfg.columns.map(col => this.quoteIfNeeded(col)).join(this.cfg.delimiter)
   }
 
   writeRow(row: AnyObject): string {
+    _assert(this.cfg.columns, 'CSVWriter cannot writeRow, because columns were not provided')
     return this.cfg.columns
       .map(col => this.quoteIfNeeded(String(row[col] ?? '')))
       .join(this.cfg.delimiter)
@@ -57,11 +62,20 @@ export class CSVWriter {
   }
 
   private shouldQuote(s: string): boolean {
-    return s.includes(this.cfg.delimiter) || s.includes('\r') || s.includes('\n') || s.includes('"')
+    return s.includes(this.cfg.delimiter) || s.includes('"') || s.includes('\n') || s.includes('\r')
   }
 }
 
-export function arrayToCSVString(arr: AnyObject[], cfg: CSVWriterConfig): string {
+export function arrayToCSVString(arr: AnyObject[], cfg: CSVWriterConfig = {}): string {
   const writer = new CSVWriter(cfg)
   return writer.writeRows(arr)
 }
+
+/**
+ * Iterates over the whole array and notes all possible columns.
+ */
+export function arrayToCSVColumns(arr: AnyObject[]): string[] {
+  const cols = new Set<string>()
+  arr.forEach(row => Object.keys(row).forEach(col => cols.add(col)))
+  return [...cols]
+}

package/src/csv/transformToCSV.ts

@@ -16,7 +16,12 @@ export interface TransformToCSVOptions extends CSVWriterConfig {
  * Transforms objects (objectMode=true) into chunks \n-terminated CSV strings (readableObjectMode=false).
  */
 export function transformToCSV<IN extends AnyObject = any>(
-  opt: TransformToCSVOptions,
+  opt: TransformToCSVOptions & {
+    /**
+     * Columns are required, as they cannot be detected on the fly.
+     */
+    columns: string[]
+  },
 ): TransformTyped<IN, string> {
   const { strict = true } = opt
   const writer = new CSVWriter(opt)