@thi.ng/csv 2.4.5 → 2.5.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2025-07-30T22:32:35Z
+- **Last updated**: 2025-08-06T11:29:19Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -11,6 +11,15 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+## [2.5.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/csv@2.5.0) (2025-08-06)
+
+#### 🚀 Features
+
+- add support for column default values ([e105548](https://github.com/thi-ng/umbrella/commit/e105548))
+  - update `ColumnSpec`
+  - update `parseCSV()` to support & validate column specs w/ default values
+  - add tests
+
 ## [2.4.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/csv@2.4.0) (2025-07-12)
 
 #### 🚀 Features

package/README.md

@@ -87,12 +87,13 @@ For Node.js REPL:
 const csv = await import("@thi.ng/csv");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 1.56 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 1.71 KB
 
 ## Dependencies
 
 - [@thi.ng/api](https://github.com/thi-ng/umbrella/tree/develop/packages/api)
 - [@thi.ng/checks](https://github.com/thi-ng/umbrella/tree/develop/packages/checks)
+- [@thi.ng/errors](https://github.com/thi-ng/umbrella/tree/develop/packages/errors)
 - [@thi.ng/strings](https://github.com/thi-ng/umbrella/tree/develop/packages/strings)
 - [@thi.ng/transducers](https://github.com/thi-ng/umbrella/tree/develop/packages/transducers)
 

package/api.d.ts

@@ -16,7 +16,9 @@ export type CSVRecord = Record<string, any>;
 export type CellTransform = Fn2<string, any, any>;
 export interface ColumnSpec {
     /**
-     * Rename column to given name in result objects.
+     * Rename column to given name in result objects. MUST be given if
+     * {@link ColumnSpec.default} is defined and column specs are provided to
+     * {@link parseCSV} as array (rather than as object).
      */
     alias?: string;
     /**
@@ -25,6 +27,13 @@ export interface ColumnSpec {
      * actual value for the cell.
      */
     tx?: CellTransform;
+    /**
+     * Default value to use if column is missing.
+     *
+     * @remarks
+     * Also see note about {@link ColumnSpec.alias}.
+     */
+    default?: any;
 }
 export type ColumnSpecs = Record<string, ColumnSpec>;
 export interface CommonCSVOpts {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/csv",
-  "version": "2.4.5",
+  "version": "2.5.0",
   "description": "Customizable, transducer-based CSV parser/object mapper and transformer",
   "type": "module",
   "module": "./index.js",
@@ -39,15 +39,16 @@
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.11.33",
-    "@thi.ng/checks": "^3.7.13",
-    "@thi.ng/strings": "^3.9.19",
-    "@thi.ng/transducers": "^9.6.4"
+    "@thi.ng/api": "^8.12.1",
+    "@thi.ng/checks": "^3.7.15",
+    "@thi.ng/errors": "^2.5.41",
+    "@thi.ng/strings": "^3.9.21",
+    "@thi.ng/transducers": "^9.6.6"
   },
   "devDependencies": {
     "esbuild": "^0.25.8",
-    "typedoc": "^0.28.7",
-    "typescript": "^5.8.3"
+    "typedoc": "^0.28.9",
+    "typescript": "^5.9.2"
   },
   "keywords": [
     "csv",
@@ -87,5 +88,5 @@
   "thi.ng": {
     "year": 2014
   },
-  "gitHead": "1df8a3a9061257ea73ccf1ab9cdf63c81a9f519f\n"
+  "gitHead": "c31170bdfc63c127350968b05341c0955b2b9d5f\n"
 }

package/parse.js

@@ -1,6 +1,7 @@
 import { isArray } from "@thi.ng/checks/is-array";
 import { isFunction } from "@thi.ng/checks/is-function";
 import { isIterable } from "@thi.ng/checks/is-iterable";
+import { illegalArgs } from "@thi.ng/errors/illegal-arguments";
 import { ESCAPES } from "@thi.ng/strings/escape";
 import { split } from "@thi.ng/strings/split";
 import { compR } from "@thi.ng/transducers/compr";
@@ -28,12 +29,16 @@ function parseCSV(opts, src) {
     const reduce = rfn[2];
     let index;
     let revIndex;
+    let defaults;
     let first = true;
     let isQuoted = false;
     let record = [];
     const init = (header2) => {
-      cols && (index = __initIndex(header2, cols));
-      all && (revIndex = __initRevIndex(header2));
+      if (cols) {
+        index = __initIndex(header2, cols);
+        defaults = __initDefaults(cols);
+      }
+      if (all) revIndex = __initRevIndex(header2);
       first = false;
     };
     const collectAll = (row) => record.reduce(
@@ -49,6 +54,10 @@ function parseCSV(opts, src) {
       }
       return acc;
     }, row);
+    const collectDefaults = (row) => defaults.reduce((acc, { alias, default: val }) => {
+      if (acc[alias] === void 0) acc[alias] = val;
+      return acc;
+    }, row);
     header && init(header);
     return compR(rfn, (acc, line) => {
       if ((!line.length || line.startsWith(comment)) && !isQuoted)
@@ -65,6 +74,7 @@ function parseCSV(opts, src) {
         const row = {};
         all && collectAll(row);
         index && collectIndexed(row);
+        defaults && collectDefaults(row);
         record = [];
         return reduce(acc, row);
       } else {
@@ -185,6 +195,25 @@ const __initIndex = (line, cols) => isArray(cols) ? cols.reduce((acc, spec, i) =
   {}
 );
 const __initRevIndex = (line) => line.reduce((acc, x, i) => (acc[i] = x, acc), {});
+const __initDefaults = (cols) => {
+  const defaults = isArray(cols) ? cols.filter((c) => {
+    if (!c || c.default == void 0) return false;
+    if (!c.alias)
+      illegalArgs(
+        `missing column alias for default: ${c.default}`
+      );
+    return true;
+  }) : Object.entries(cols).reduce((acc, [k, v]) => {
+    if (v.default !== void 0) {
+      acc.push({
+        alias: v.alias ?? k,
+        default: v.default
+      });
+    }
+    return acc;
+  }, []);
+  return defaults.length ? defaults : void 0;
+};
 export {
   parseCSV,
   parseCSVFromString,