@thi.ng/strings 3.4.13 → 3.6.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2023-08-27T11:20:59Z
+- **Last updated**: 2023-09-19T10:42:50Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,22 @@ 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.
 
+## [3.6.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/strings@3.6.0) (2023-09-19)
+
+#### 🚀 Features
+
+- add escapeEntitiesNum() ([f921491](https://github.com/thi-ng/umbrella/commit/f921491))
+
+## [3.5.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/strings@3.5.0) (2023-09-15)
+
+#### 🚀 Features
+
+- add more HTML entities ([9fa5d91](https://github.com/thi-ng/umbrella/commit/9fa5d91))
+- add support for numeric HTML entities ([8d942ba](https://github.com/thi-ng/umbrella/commit/8d942ba))
+  - add `RE_ENTITIES_NUM`
+  - update unescapeEntities() to also support numeric entities
+- add unitless() formatter ([d5025ce](https://github.com/thi-ng/umbrella/commit/d5025ce))
+
 ### [3.4.12](https://github.com/thi-ng/umbrella/tree/@thi.ng/strings@3.4.12) (2023-08-22)
 
 #### 🩹 Bug fixes

package/README.md

@@ -141,7 +141,7 @@ For Node.js REPL:
 const strings = await import("@thi.ng/strings");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 4.61 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 4.86 KB
 
 ## Dependencies
 
@@ -158,13 +158,16 @@ directory are using this package.
 
 A selection:
 
-| Screenshot                                                                                                                 | Description                                                            | Live demo                                                 | Source                                                                                 |
-|:---------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------|:----------------------------------------------------------|:---------------------------------------------------------------------------------------|
-| <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/big-font.png" width="240"/>            | Large ASCII font text generator using @thi.ng/rdom                     | [Demo](https://demo.thi.ng/umbrella/big-font/)            | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/big-font)            |
-| <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/crypto-chart.png" width="240"/>        | Basic crypto-currency candle chart with multiple moving averages plots | [Demo](https://demo.thi.ng/umbrella/crypto-chart/)        | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/crypto-chart)        |
-|                                                                                                                            | Basic SPA example with atom-based UI router                            | [Demo](https://demo.thi.ng/umbrella/login-form/)          | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/login-form)          |
-| <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/rstream-spreadsheet.png" width="240"/> | rstream based spreadsheet w/ S-expression formula DSL                  | [Demo](https://demo.thi.ng/umbrella/rstream-spreadsheet/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/rstream-spreadsheet) |
-| <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/xml-converter.png" width="240"/>       | XML/HTML/SVG to hiccup/JS conversion                                   | [Demo](https://demo.thi.ng/umbrella/xml-converter/)       | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/xml-converter)       |
+| Screenshot                                                                                                                 | Description                                                                                             | Live demo                                                 | Source                                                                                 |
+|:---------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------|:----------------------------------------------------------|:---------------------------------------------------------------------------------------|
+| <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/ascii-raymarch.jpg" width="240"/>      | ASCII art raymarching with thi.ng/shader-ast & thi.ng/text-canvas                                       | [Demo](https://demo.thi.ng/umbrella/ascii-raymarch/)      | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/ascii-raymarch)      |
+| <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/big-font.png" width="240"/>            | Large ASCII font text generator using @thi.ng/rdom                                                      | [Demo](https://demo.thi.ng/umbrella/big-font/)            | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/big-font)            |
+| <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/crypto-chart.png" width="240"/>        | Basic crypto-currency candle chart with multiple moving averages plots                                  | [Demo](https://demo.thi.ng/umbrella/crypto-chart/)        | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/crypto-chart)        |
+|                                                                                                                            | Basic SPA example with atom-based UI router                                                             | [Demo](https://demo.thi.ng/umbrella/login-form/)          | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/login-form)          |
+| <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/mastodon-feed.jpg" width="240"/>       | Mastodon API feed reader with support for different media types, fullscreen media modal, HTML rewriting | [Demo](https://demo.thi.ng/umbrella/mastodon-feed/)       | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/mastodon-feed)       |
+| <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/render-audio.png" width="240"/>        | Generative audio synth offline renderer and WAV file export                                             | [Demo](https://demo.thi.ng/umbrella/render-audio/)        | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/render-audio)        |
+| <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/rstream-spreadsheet.png" width="240"/> | rstream based spreadsheet w/ S-expression formula DSL                                                   | [Demo](https://demo.thi.ng/umbrella/rstream-spreadsheet/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/rstream-spreadsheet) |
+| <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/xml-converter.png" width="240"/>       | XML/HTML/SVG to hiccup/JS conversion                                                                    | [Demo](https://demo.thi.ng/umbrella/xml-converter/)       | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/xml-converter)       |
 
 ## API
 

package/entities.d.ts

@@ -8,6 +8,35 @@ export declare const ENTITIES: Record<string, string>;
 export declare const RE_ENTITIES: RegExp;
 export declare const ENTITIES_REV: Record<string, string>;
 export declare const RE_ENTITIES_REV: RegExp;
+export declare const RE_ENTITIES_NUM: RegExp;
+/**
+ * Replaces all occurrences of character keys in {@link ENTITIES} with their
+ * named HTML entities.
+ *
+ * @remarks
+ * Only use this function when targetting HTML output. For XML/SVG etc. use
+ * {@link escapeEntitiesNum}.
+ *
+ * @param src
+ */
 export declare const escapeEntities: (src: string) => string;
+/**
+ * Similar to {@link escapeEntities}, but only uses _named_ entities for `&`,
+ * `<`, `>`, `'`, `"` and numeric entities for all others.
+ *
+ * @remarks
+ * This function is used as default by thi.ng/hiccup `serialize()` to escape
+ * characters and ensure compatibility with XML (which by default only supports
+ * named entities for the above 5 characters).
+ *
+ * @param src
+ */
+export declare const escapeEntitiesNum: (src: string) => string;
+/**
+ * Replace all known named and numeric entities with their original characters.
+ * Opposite op of {@link escapeEntities} and {@link escapeEntitiesNum}.
+ *
+ * @param src
+ */
 export declare const unescapeEntities: (src: string) => string;
 //# sourceMappingURL=entities.d.ts.map

package/entities.js

@@ -20,11 +20,17 @@ export const ENTITIES = {
     "¢": "¢",
     "€": "€",
     "£": "£",
+    "¥": "¥",
+    "₹": "₹",
+    元: "元",
     "§": "§",
     "¶": "¶",
     "©": "©",
     "®": "®",
     "™": "™",
+    "℃": "℃",
+    "℉": "℉",
+    K: "K",
     "◂": "◂",
     "▸": "▸",
     "▴": "▴",
@@ -42,6 +48,25 @@ export const ENTITIES = {
     "¹": "¹",
     "²": "²",
     "³": "³",
+    "½": "½",
+    "⅓": "⅓",
+    "⅔": "⅔",
+    "¼": "¼",
+    "¾": "¾",
+    "⅕": "⅕",
+    "⅙": "⅙",
+    "⅛": "⅛",
+    Ä: "Ä",
+    Ë: "Ë",
+    Ï: "Ï",
+    Ö: "Ö",
+    Ü: "Ü",
+    ä: "ä",
+    ë: "ë",
+    ï: "ï",
+    ö: "ö",
+    ü: "ü",
+    ß: "ß",
     α: "α",
     β: "β",
     γ: "γ",
@@ -88,6 +113,39 @@ export const ENTITIES = {
 export const RE_ENTITIES = new RegExp(`[${Object.keys(ENTITIES).join("")}]`, "gu");
 export const ENTITIES_REV = Object.entries(ENTITIES).reduce((acc, [k, v]) => ((acc[v] = k), acc), {});
 export const RE_ENTITIES_REV = new RegExp(`(${Object.keys(ENTITIES_REV).join("|")})`, "g");
-const $esc = (re, index) => (src) => src.replace(re, (x) => index[x]);
-export const escapeEntities = $esc(RE_ENTITIES, ENTITIES);
-export const unescapeEntities = $esc(RE_ENTITIES_REV, ENTITIES_REV);
+export const RE_ENTITIES_NUM = /&#(x?)([0-9a-f]+);/gi;
+/**
+ * Replaces all occurrences of character keys in {@link ENTITIES} with their
+ * named HTML entities.
+ *
+ * @remarks
+ * Only use this function when targetting HTML output. For XML/SVG etc. use
+ * {@link escapeEntitiesNum}.
+ *
+ * @param src
+ */
+export const escapeEntities = (src) => src.replace(RE_ENTITIES, (x) => ENTITIES[x]);
+/**
+ * Similar to {@link escapeEntities}, but only uses _named_ entities for `&`,
+ * `<`, `>`, `'`, `"` and numeric entities for all others.
+ *
+ * @remarks
+ * This function is used as default by thi.ng/hiccup `serialize()` to escape
+ * characters and ensure compatibility with XML (which by default only supports
+ * named entities for the above 5 characters).
+ *
+ * @param src
+ */
+export const escapeEntitiesNum = (src) => src.replace(RE_ENTITIES, (x) => {
+    const code = x.charCodeAt(0);
+    return code < 128 ? ENTITIES[x] : `&#x${code.toString(16)};`;
+});
+/**
+ * Replace all known named and numeric entities with their original characters.
+ * Opposite op of {@link escapeEntities} and {@link escapeEntitiesNum}.
+ *
+ * @param src
+ */
+export const unescapeEntities = (src) => src
+    .replace(RE_ENTITIES_REV, (x) => ENTITIES_REV[x])
+    .replace(RE_ENTITIES_NUM, (_, hex, x) => String.fromCharCode(parseInt(x, hex ? 16 : 10)));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/strings",
-  "version": "3.4.13",
+  "version": "3.6.0",
   "description": "Various string formatting & utility functions",
   "type": "module",
   "module": "./index.js",
@@ -200,5 +200,5 @@
   "thi.ng": {
     "year": 2015
   },
-  "gitHead": "5929dd20497668496af13415cdf784a4d6f69aa3\n"
+  "gitHead": "c22e8996cee284ebe8ea88582beb1ab5fc6ee503\n"
 }

package/units.d.ts

@@ -6,5 +6,6 @@ export declare const bytes: Stringer<number>;
 export declare const seconds: Stringer<number>;
 export declare const meters: Stringer<number>;
 export declare const grams: Stringer<number>;
+export declare const unitless: Stringer<number>;
 export {};
 //# sourceMappingURL=units.d.ts.map

package/units.js

@@ -66,3 +66,16 @@ export const grams = units([
     [1e9, " kt"],
     [1e12, " Mt"],
 ], " g", 2);
+export const unitless = units([
+    [1e-15, "f", 1],
+    [1e-12, "p", 1],
+    [1e-9, "n", 1],
+    [1e-6, "µ", 1],
+    [1e-3, "m", 1],
+    [1, ""],
+    [1e3, "k", 1],
+    [1e6, "M", 1],
+    [1e9, "G", 1],
+    [1e12, "T", 1],
+    [1e15, "P", 1],
+], "", 0);