@naturalcycles/nodejs-lib 12.88.0 → 12.90.0

package/dist/csv/csvReader.d.ts

@@ -0,0 +1,16 @@
+import { AnyObject } from '@naturalcycles/js-lib';
+export interface CSVReaderConfig {
+    /**
+     * Default: comma
+     */
+    /**
+     * Default: true
+     */
+    firstRowIsHeader?: boolean;
+    /**
+     * Array of columns, to be used if there is no header row.
+     */
+    columns?: string[];
+}
+export declare function csvStringParse<T extends AnyObject = any>(str: string, cfg?: CSVReaderConfig): T[];
+export declare function csvStringToArray(str: string): string[][];

package/dist/csv/csvReader.js

@@ -0,0 +1,49 @@
+"use strict";
+// Inspired by: https://gist.github.com/Jezternz/c8e9fafc2c114e079829974e3764db75
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.csvStringToArray = exports.csvStringParse = void 0;
+const js_lib_1 = require("@naturalcycles/js-lib");
+// export class CSVReader {
+//   constructor (cfg: CSVReaderConfig) {
+//     this.cfg = {
+//       delimiter: ',',
+//       includeHeader: true,
+//       ...cfg,
+//     }
+//   }
+//
+//   public cfg: Required<CSVReaderConfig>
+// }
+function csvStringParse(str, cfg = {}) {
+    const { firstRowIsHeader = true, columns } = cfg;
+    const arr = csvStringToArray(str);
+    let header = columns;
+    if (firstRowIsHeader) {
+        const firstRow = arr.shift();
+        header ||= firstRow;
+    }
+    (0, js_lib_1._assert)(header, `firstRowIsHeader or columns is required`);
+    return arr.map(row => {
+        // eslint-disable-next-line unicorn/no-array-reduce
+        return header.reduce((obj, col, i) => {
+            ;
+            obj[col] = row[i];
+            return obj;
+        }, {});
+    });
+}
+exports.csvStringParse = csvStringParse;
+function csvStringToArray(str) {
+    const objPattern = new RegExp('(,|\\r?\\n|\\r|^)(?:"([^"]*(?:""[^"]*)*)"|([^,\\r\\n]*))', 'gi');
+    let matches = null;
+    const arr = [[]];
+    // eslint-disable-next-line no-cond-assign
+    while ((matches = objPattern.exec(str))) {
+        if (matches[1].length && matches[1] !== ',') {
+            arr.push([]);
+        }
+        arr[arr.length - 1].push(matches[2] ? matches[2].replace(new RegExp('""', 'g'), '"') : matches[3]);
+    }
+    return arr;
+}
+exports.csvStringToArray = csvStringToArray;

package/dist/csv/csvWriter.d.ts

@@ -0,0 +1,32 @@
+import { AnyObject } from '@naturalcycles/js-lib';
+export interface CSVWriterConfig {
+    /**
+     * Default: comma
+     */
+    delimiter?: string;
+    /**
+     * Array of columns
+     */
+    columns?: string[];
+    /**
+     * Default: true
+     */
+    includeHeader?: boolean;
+}
+export declare class CSVWriter {
+    constructor(cfg: CSVWriterConfig);
+    cfg: CSVWriterConfig & {
+        delimiter: string;
+    };
+    writeRows(rows: AnyObject[]): string;
+    writeHeader(): string;
+    writeRow(row: AnyObject): string;
+    private quoteIfNeeded;
+    private quote;
+    private shouldQuote;
+}
+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

@@ -0,0 +1,57 @@
+"use strict";
+// Inspired by: https://github.com/ryu1kn/csv-writer/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.arrayToCSVColumns = exports.arrayToCSVString = exports.CSVWriter = void 0;
+const js_lib_1 = require("@naturalcycles/js-lib");
+class CSVWriter {
+    constructor(cfg) {
+        this.cfg = {
+            delimiter: ',',
+            includeHeader: true,
+            ...cfg,
+        };
+    }
+    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);
+    }
+    quoteIfNeeded(s) {
+        return this.shouldQuote(s) ? this.quote(s) : s;
+    }
+    quote(s) {
+        return `"${s.replace(/"/g, '""')}"`;
+    }
+    shouldQuote(s) {
+        return s.includes(this.cfg.delimiter) || s.includes('"') || s.includes('\n') || s.includes('\r');
+    }
+}
+exports.CSVWriter = CSVWriter;
+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

@@ -0,0 +1,20 @@
+import { AnyObject } from '@naturalcycles/js-lib';
+import { TransformTyped } from '../stream/stream.model';
+import { CSVWriterConfig } from './csvWriter';
+export interface TransformToCSVOptions extends CSVWriterConfig {
+    /**
+     * If true - will throw an error on stringify error
+     *
+     * @default true
+     */
+    strict?: boolean;
+}
+/**
+ * Transforms objects (objectMode=true) into chunks \n-terminated CSV strings (readableObjectMode=false).
+ */
+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/dist/csv/transformToCSV.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformToCSV = void 0;
+const node_stream_1 = require("node:stream");
+const csvWriter_1 = require("./csvWriter");
+/**
+ * Transforms objects (objectMode=true) into chunks \n-terminated CSV strings (readableObjectMode=false).
+ */
+function transformToCSV(opt) {
+    const { strict = true } = opt;
+    const writer = new csvWriter_1.CSVWriter(opt);
+    let firstRow = true;
+    return new node_stream_1.Transform({
+        writableObjectMode: true,
+        readableObjectMode: false,
+        transform(chunk, _, cb) {
+            try {
+                let s = '';
+                if (firstRow) {
+                    s = writer.writeHeader() + '\n';
+                    firstRow = false;
+                }
+                cb(null, s + writer.writeRow(chunk) + '\n');
+            }
+            catch (err) {
+                console.error(err);
+                if (strict) {
+                    cb(err); // emit error
+                }
+                else {
+                    cb(); // emit no error, but no result neither
+                }
+            }
+        },
+    });
+}
+exports.transformToCSV = transformToCSV;

package/dist/index.d.ts

@@ -58,6 +58,9 @@ export * from './stream/writable/writableForEach';
 export * from './stream/writable/writableFork';
 export * from './stream/writable/writablePushToArray';
 export * from './stream/writable/writableVoid';
+export * from './csv/csvWriter';
+export * from './csv/csvReader';
+export * from './csv/transformToCSV';
 export * from './string/inspectAny';
 export * from './util/env.util';
 export * from './util/lruMemoCache';

package/dist/index.js

@@ -63,6 +63,9 @@ tslib_1.__exportStar(require("./stream/writable/writableForEach"), exports);
 tslib_1.__exportStar(require("./stream/writable/writableFork"), exports);
 tslib_1.__exportStar(require("./stream/writable/writablePushToArray"), exports);
 tslib_1.__exportStar(require("./stream/writable/writableVoid"), exports);
+tslib_1.__exportStar(require("./csv/csvWriter"), exports);
+tslib_1.__exportStar(require("./csv/csvReader"), exports);
+tslib_1.__exportStar(require("./csv/transformToCSV"), exports);
 tslib_1.__exportStar(require("./string/inspectAny"), exports);
 tslib_1.__exportStar(require("./util/env.util"), exports);
 tslib_1.__exportStar(require("./util/lruMemoCache"), exports);

package/dist/stream/ndjson/transformToNDJson.d.ts

@@ -16,10 +16,6 @@ export interface TransformToNDJsonOptions {
      * @default `\n`
      */
     separator?: string;
-    /**
-     * @experimental
-     */
-    useFlatstr?: boolean;
 }
 /**
  * Transforms objects (objectMode=true) into chunks \n-terminated JSON strings (readableObjectMode=false).

package/dist/stream/ndjson/transformToNDJson.js

@@ -7,7 +7,7 @@ const js_lib_1 = require("@naturalcycles/js-lib");
  * Transforms objects (objectMode=true) into chunks \n-terminated JSON strings (readableObjectMode=false).
  */
 function transformToNDJson(opt = {}) {
-    const { strict = true, separator = '\n', sortObjects = false, useFlatstr = false } = opt;
+    const { strict = true, separator = '\n', sortObjects = false } = opt;
     return new node_stream_1.Transform({
         writableObjectMode: true,
         readableObjectMode: false,
@@ -16,12 +16,7 @@ function transformToNDJson(opt = {}) {
                 if (sortObjects) {
                     chunk = (0, js_lib_1._sortObjectDeep)(chunk);
                 }
-                if (useFlatstr) {
-                    cb(null, flatstr(JSON.stringify(chunk) + separator));
-                }
-                else {
-                    cb(null, JSON.stringify(chunk) + separator);
-                }
+                cb(null, JSON.stringify(chunk) + separator);
             }
             catch (err) {
                 console.error(err);
@@ -36,11 +31,3 @@ function transformToNDJson(opt = {}) {
     });
 }
 exports.transformToNDJson = transformToNDJson;
-/**
- * Based on: https://github.com/davidmarkclements/flatstr/blob/master/index.js
- */
-function flatstr(s) {
-    // eslint-disable-next-line
-    s | 0;
-    return s;
-}

package/package.json

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

package/src/csv/csvReader.ts

@@ -0,0 +1,72 @@
+// Inspired by: https://gist.github.com/Jezternz/c8e9fafc2c114e079829974e3764db75
+
+import { _assert, AnyObject } from '@naturalcycles/js-lib'
+
+export interface CSVReaderConfig {
+  /**
+   * Default: comma
+   */
+  // delimiter?: string
+
+  /**
+   * Default: true
+   */
+  firstRowIsHeader?: boolean
+
+  /**
+   * Array of columns, to be used if there is no header row.
+   */
+  columns?: string[]
+}
+
+// export class CSVReader {
+//   constructor (cfg: CSVReaderConfig) {
+//     this.cfg = {
+//       delimiter: ',',
+//       includeHeader: true,
+//       ...cfg,
+//     }
+//   }
+//
+//   public cfg: Required<CSVReaderConfig>
+// }
+
+export function csvStringParse<T extends AnyObject = any>(
+  str: string,
+  cfg: CSVReaderConfig = {},
+): T[] {
+  const { firstRowIsHeader = true, columns } = cfg
+  const arr = csvStringToArray(str)
+
+  let header = columns
+  if (firstRowIsHeader) {
+    const firstRow = arr.shift()
+    header ||= firstRow
+  }
+
+  _assert(header, `firstRowIsHeader or columns is required`)
+
+  return arr.map(row => {
+    // eslint-disable-next-line unicorn/no-array-reduce
+    return header!.reduce((obj, col, i) => {
+      ;(obj as any)[col] = row[i]
+      return obj
+    }, {} as T)
+  })
+}
+
+export function csvStringToArray(str: string): string[][] {
+  const objPattern = new RegExp('(,|\\r?\\n|\\r|^)(?:"([^"]*(?:""[^"]*)*)"|([^,\\r\\n]*))', 'gi')
+  let matches = null
+  const arr: any[][] = [[]]
+  // eslint-disable-next-line no-cond-assign
+  while ((matches = objPattern.exec(str))) {
+    if (matches[1]!.length && matches[1] !== ',') {
+      arr.push([])
+    }
+    arr[arr.length - 1]!.push(
+      matches[2] ? matches[2].replace(new RegExp('""', 'g'), '"') : matches[3],
+    )
+  }
+  return arr
+}

package/src/csv/csvWriter.ts

@@ -0,0 +1,81 @@
+// Inspired by: https://github.com/ryu1kn/csv-writer/
+
+import { _assert, AnyObject } from '@naturalcycles/js-lib'
+
+export interface CSVWriterConfig {
+  /**
+   * Default: comma
+   */
+  delimiter?: string
+
+  /**
+   * Array of columns
+   */
+  columns?: string[]
+
+  /**
+   * Default: true
+   */
+  includeHeader?: boolean
+}
+
+export class CSVWriter {
+  constructor(cfg: CSVWriterConfig) {
+    this.cfg = {
+      delimiter: ',',
+      includeHeader: true,
+      ...cfg,
+    }
+  }
+
+  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)
+  }
+
+  private quoteIfNeeded(s: string): string {
+    return this.shouldQuote(s) ? this.quote(s) : s
+  }
+
+  private quote(s: string): string {
+    return `"${s.replace(/"/g, '""')}"`
+  }
+
+  private shouldQuote(s: string): boolean {
+    return s.includes(this.cfg.delimiter) || s.includes('"') || s.includes('\n') || s.includes('\r')
+  }
+}
+
+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

@@ -0,0 +1,54 @@
+import { Transform } from 'node:stream'
+import { AnyObject } from '@naturalcycles/js-lib'
+import { TransformTyped } from '../stream/stream.model'
+import { CSVWriter, CSVWriterConfig } from './csvWriter'
+
+export interface TransformToCSVOptions extends CSVWriterConfig {
+  /**
+   * If true - will throw an error on stringify error
+   *
+   * @default true
+   */
+  strict?: boolean
+}
+
+/**
+ * Transforms objects (objectMode=true) into chunks \n-terminated CSV strings (readableObjectMode=false).
+ */
+export function transformToCSV<IN extends AnyObject = any>(
+  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)
+  let firstRow = true
+
+  return new Transform({
+    writableObjectMode: true,
+    readableObjectMode: false,
+    transform(chunk: IN, _, cb) {
+      try {
+        let s = ''
+
+        if (firstRow) {
+          s = writer.writeHeader() + '\n'
+          firstRow = false
+        }
+
+        cb(null, s + writer.writeRow(chunk) + '\n')
+      } catch (err) {
+        console.error(err)
+
+        if (strict) {
+          cb(err as Error) // emit error
+        } else {
+          cb() // emit no error, but no result neither
+        }
+      }
+    },
+  })
+}

package/src/index.ts

@@ -58,6 +58,9 @@ export * from './stream/writable/writableForEach'
 export * from './stream/writable/writableFork'
 export * from './stream/writable/writablePushToArray'
 export * from './stream/writable/writableVoid'
+export * from './csv/csvWriter'
+export * from './csv/csvReader'
+export * from './csv/transformToCSV'
 export * from './string/inspectAny'
 export * from './util/env.util'
 export * from './util/lruMemoCache'

package/src/stream/ndjson/transformToNDJson.ts

@@ -21,11 +21,6 @@ export interface TransformToNDJsonOptions {
    * @default `\n`
    */
   separator?: string
-
-  /**
-   * @experimental
-   */
-  useFlatstr?: boolean
 }
 
 /**
@@ -34,7 +29,7 @@ export interface TransformToNDJsonOptions {
 export function transformToNDJson<IN = any>(
   opt: TransformToNDJsonOptions = {},
 ): TransformTyped<IN, string> {
-  const { strict = true, separator = '\n', sortObjects = false, useFlatstr = false } = opt
+  const { strict = true, separator = '\n', sortObjects = false } = opt
 
   return new Transform({
     writableObjectMode: true,
@@ -45,11 +40,7 @@ export function transformToNDJson<IN = any>(
           chunk = _sortObjectDeep(chunk as any)
         }
 
-        if (useFlatstr) {
-          cb(null, flatstr(JSON.stringify(chunk) + separator))
-        } else {
-          cb(null, JSON.stringify(chunk) + separator)
-        }
+        cb(null, JSON.stringify(chunk) + separator)
       } catch (err) {
         console.error(err)
 
@@ -62,12 +53,3 @@ export function transformToNDJson<IN = any>(
     },
   })
 }
-
-/**
- * Based on: https://github.com/davidmarkclements/flatstr/blob/master/index.js
- */
-function flatstr(s: any): string {
-  // eslint-disable-next-line
-  s | 0
-  return s
-}