@thi.ng/csv 2.1.1 → 2.2.2

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2021-11-19T07:59:50Z
+- **Last updated**: 2021-12-13T10:26:00Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,16 @@ 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.2.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/csv@2.2.0) (2021-12-02)
+
+#### 🚀 Features
+
+- add more cell transforms, add docs ([23646bf](https://github.com/thi-ng/umbrella/commit/23646bf))
+  - add epoch(), date(), url() transforms
+  - add formatPercent()
+  - update readme
+- add currency formatters ([52b7340](https://github.com/thi-ng/umbrella/commit/52b7340))
+
 ## [2.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/csv@2.1.0) (2021-11-17)
 
 #### 🚀 Features

package/README.md

@@ -51,7 +51,7 @@ for more details/ideas.
 ### Planned features
 
 - [x] Simple CSV row parsing w/o object mapping (`parseCSVSimple()`)
-- [ ] CSV output from structured data
+- [x] CSV output from structured data
 - [ ] CSVW support (#257)
 - [ ] Integration with thi.ng/egf
 
@@ -78,7 +78,7 @@ node --experimental-repl-await
 > const csv = await import("@thi.ng/csv");
 ```
 
-Package sizes (gzipped, pre-treeshake): ESM: 1.53 KB
+Package sizes (gzipped, pre-treeshake): ESM: 1.65 KB
 
 ## Dependencies
 
@@ -103,8 +103,8 @@ import { parseCSV, upper, float } from "@thi.ng/csv";
     all: false,
     cols: {
       "country": { tx: upper },
-      "latitude": { alias: "lat", tx: float(0) },
-      "longitude": { alias: "lon", tx: float(0) },
+      "latitude": { alias: "lat", tx: float() },
+      "longitude": { alias: "lon", tx: float() },
     }
   },
   [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/csv",
-  "version": "2.1.1",
+  "version": "2.2.2",
   "description": "Customizable, transducer-based CSV parser/object mapper and transformer",
   "type": "module",
   "module": "./index.js",
@@ -34,18 +34,18 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.3.1",
-    "@thi.ng/checks": "^3.1.1",
-    "@thi.ng/strings": "^3.2.1",
-    "@thi.ng/transducers": "^8.1.1"
+    "@thi.ng/api": "^8.3.3",
+    "@thi.ng/checks": "^3.1.3",
+    "@thi.ng/strings": "^3.3.1",
+    "@thi.ng/transducers": "^8.2.0"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.18.19",
-    "@thi.ng/testament": "^0.2.1",
+    "@microsoft/api-extractor": "^7.19.2",
+    "@thi.ng/testament": "^0.2.3",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
-    "typedoc": "^0.22.9",
-    "typescript": "^4.5.2"
+    "typedoc": "^0.22.10",
+    "typescript": "^4.5.3"
   },
   "keywords": [
     "csv",
@@ -85,5 +85,5 @@
   "thi.ng": {
     "year": 2014
   },
-  "gitHead": "8bd27c8bde0b770e7c001943f11c951cd345d668\n"
+  "gitHead": "1ba92c6b9509e74e509b4c0b875fc380a97bbbc1\n"
 }

package/transforms.d.ts

@@ -1,9 +1,64 @@
 import type { CellTransform } from "./api.js";
+/**
+ * Cell parse value transform. Returns uppercased version of given input.
+ *
+ * @param x
+ */
 export declare const upper: CellTransform;
+/**
+ * Cell parse value transform. Returns lowercased version of given input.
+ *
+ * @param x
+ */
 export declare const lower: CellTransform;
+/**
+ * Higher-order cell parse value transform. Attempts to parse cell values as
+ * floating point number or returns `defaultVal` if not possible.
+ *
+ * @param defaultVal
+ */
 export declare const float: (defaultVal?: number) => CellTransform;
+/**
+ * Higher-order cell parse value transform. Attempts to parse cell values as
+ * integer or returns `defaultVal` if not possible.
+ *
+ * @param defaultVal
+ */
 export declare const int: (defaultVal?: number) => CellTransform;
+/**
+ * Higher-order cell parse value transform. Attempts to parse cell values as
+ * hexadecimal integer or returns `defaultVal` if not possible.
+ *
+ * @param defaultVal
+ */
 export declare const hex: (defaultVal?: number) => CellTransform;
+export declare const percent: CellTransform;
+/**
+ * Higher-order cell parse value transform. Attempts to parse cell values as
+ * Unix epoch/timestamp or returns `defaultVal` if not possible.
+ *
+ * @param defaultVal
+ */
+export declare const epoch: (defaultVal?: number) => CellTransform;
+/**
+ * Higher-order cell parse value transform. Attempts to parse cell values as JS
+ * `Date` instance or returns `defaultVal` if not possible.
+ *
+ * @param defaultVal
+ */
+export declare const date: (defaultVal?: Date | undefined) => CellTransform;
+/**
+ * Cell parse value transform. Attempts to parse cell values as JS `URL`
+ * instances.
+ *
+ * @param x
+ */
+export declare const url: CellTransform;
 export declare const zeroPad: (digits: number) => (x: any, length?: number | undefined) => string;
 export declare const formatFloat: (prec?: number) => (x: number) => string;
+/**
+ * Higher order cell value formatter. Takes normalized values and formats them
+ * as percentage with given `precision` (number of fractional digits).
+ */
+export declare const formatPercent: (prec?: number | undefined) => import("@thi.ng/strings").Stringer<number>;
 //# sourceMappingURL=transforms.d.ts.map

package/transforms.js

@@ -1,10 +1,76 @@
 import { padLeft } from "@thi.ng/strings/pad-left";
+import { percent as $percent } from "@thi.ng/strings/percent";
 import { maybeParseFloat, maybeParseInt } from "@thi.ng/strings/parse";
+/**
+ * Cell parse value transform. Returns uppercased version of given input.
+ *
+ * @param x
+ */
 export const upper = (x) => x.toUpperCase();
+/**
+ * Cell parse value transform. Returns lowercased version of given input.
+ *
+ * @param x
+ */
 export const lower = (x) => x.toLowerCase();
+/**
+ * Higher-order cell parse value transform. Attempts to parse cell values as
+ * floating point number or returns `defaultVal` if not possible.
+ *
+ * @param defaultVal
+ */
 export const float = (defaultVal = 0) => (x) => maybeParseFloat(x, defaultVal);
+/**
+ * Higher-order cell parse value transform. Attempts to parse cell values as
+ * integer or returns `defaultVal` if not possible.
+ *
+ * @param defaultVal
+ */
 export const int = (defaultVal = 0) => (x) => maybeParseInt(x, defaultVal, 10);
+/**
+ * Higher-order cell parse value transform. Attempts to parse cell values as
+ * hexadecimal integer or returns `defaultVal` if not possible.
+ *
+ * @param defaultVal
+ */
 export const hex = (defaultVal = 0) => (x) => maybeParseInt(x, defaultVal, 16);
+export const percent = (x) => maybeParseFloat(x) * 0.01;
+/**
+ * Higher-order cell parse value transform. Attempts to parse cell values as
+ * Unix epoch/timestamp or returns `defaultVal` if not possible.
+ *
+ * @param defaultVal
+ */
+export const epoch = (defaultVal = 0) => (x) => {
+    const res = Date.parse(x);
+    return isNaN(res) ? defaultVal : res;
+};
+/**
+ * Higher-order cell parse value transform. Attempts to parse cell values as JS
+ * `Date` instance or returns `defaultVal` if not possible.
+ *
+ * @param defaultVal
+ */
+export const date = (defaultVal) => (x) => {
+    const epoch = Date.parse(x);
+    if (isNaN(epoch))
+        return defaultVal;
+    const res = new Date();
+    res.setTime(epoch);
+    return res;
+};
+/**
+ * Cell parse value transform. Attempts to parse cell values as JS `URL`
+ * instances.
+ *
+ * @param x
+ */
+export const url = (x) => new URL(x);
 // formatters
 export const zeroPad = (digits) => padLeft(digits, "0");
 export const formatFloat = (prec = 2) => (x) => x.toFixed(prec);
+/**
+ * Higher order cell value formatter. Takes normalized values and formats them
+ * as percentage with given `precision` (number of fractional digits).
+ */
+export const formatPercent = $percent;