@thi.ng/hiccup 4.2.26 → 4.2.28

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2022-12-16T12:52:25Z
+- **Last updated**: 2022-12-22T21:47:07Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/README.md

@@ -41,7 +41,7 @@ This project is part of the
 
 ## About
 
-HTML/SVG/XML serialization of nested data structures, iterables & closures
+HTML/SVG/XML serialization of nested data structures, iterables & closures.
 
 Inspired by [Hiccup](https://github.com/weavejester/hiccup) and
 [Reagent](http://reagent-project.github.io/) for Clojure/ClojureScript.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/hiccup",
-  "version": "4.2.26",
+  "version": "4.2.28",
   "description": "HTML/SVG/XML serialization of nested data structures, iterables & closures",
   "type": "module",
   "module": "./index.js",
@@ -34,15 +34,15 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.6.0",
-    "@thi.ng/checks": "^3.3.5",
-    "@thi.ng/errors": "^2.2.6",
-    "@thi.ng/strings": "^3.3.20"
+    "@thi.ng/api": "^8.6.2",
+    "@thi.ng/checks": "^3.3.6",
+    "@thi.ng/errors": "^2.2.7",
+    "@thi.ng/strings": "^3.3.22"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.33.7",
-    "@thi.ng/atom": "^5.1.25",
-    "@thi.ng/testament": "^0.3.7",
+    "@thi.ng/atom": "^5.1.27",
+    "@thi.ng/testament": "^0.3.8",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
     "typedoc": "^0.23.22",
@@ -120,5 +120,5 @@
     ],
     "year": 2016
   },
-  "gitHead": "f445a9cc8022bcdebbf6ff91fd66ced016d72f01\n"
+  "gitHead": "bc6f7f5e2765bb96fe64db804eaf4b2443b47fc6\n"
 }

package/serialize.d.ts

@@ -1,10 +1,9 @@
 /**
- * Recursively normalizes and serializes given tree as HTML/SVG/XML
- * string. Expands any embedded component functions with their results.
+ * Recursively normalizes and serializes given tree as HTML/SVG/XML string.
+ * Expands any embedded component functions with their results.
  *
  * @remarks
- * Each node of the input tree can have one of the following input
- * forms:
+ * Each node of the input tree can have one of the following input forms:
  *
  * ```js
  * ["tag", ...]
@@ -22,14 +21,13 @@
  * ["div#foo.bar.baz", "hi"] // <div id="foo" class="bar baz">hi</div>
  * ```
  *
- * The presence of the attributes object (2nd array index) is optional.
- * Any attribute values, incl. functions are allowed. If the latter, the
- * function is called with the full attribs object as argument and the
- * return value is used for the attribute. This allows for the dynamic
- * creation of attrib values based on other attribs. The only exception
- * to this are event attributes, i.e. attribute names starting with
- * "on". Function values assigned to event attributes will be omitted
- * from the output.
+ * The presence of the attributes object (2nd array index) is optional. Any
+ * attribute values, incl. functions are allowed. If the latter, the function is
+ * called with the full attribs object as argument and the return value is used
+ * for the attribute. This allows for the dynamic creation of attrib values
+ * based on other attribs. The only exception to this are event attributes, i.e.
+ * attribute names starting with "on". Function values assigned to event
+ * attributes will be omitted from the output.
  *
  * ```js
  * ["div#foo", { bar: (attribs) => attribs.id + "-bar" }]
@@ -43,23 +41,24 @@
  * // <div style="color:red;background:#000;"></div>
  * ```
  *
- * Boolean attribs are serialized in HTML5 syntax (present or not).
- * `null`, `undefined` or empty string attrib values are ignored.
+ * Boolean attribs are serialized in HTML5 syntax (present or not). `null`,
+ * `undefined` or empty string attrib values are ignored.
  *
- * Any `null` or `undefined` array values (other than in head position)
- * will also be removed, unless a function is in head position.
+ * Any `null` or `undefined` array values (other than in head position) will
+ * also be removed, unless a function is in head position.
  *
- * A function in head position of a node acts as a mechanism for
- * component composition & delayed execution. The function will only be
- * executed at serialization time. In this case the optional global
- * context object and all other elements of that node / array are passed
- * as arguments when that function is called. The return value the
- * function MUST be a valid new tree (or `undefined`).
+ * A function in head position of a node acts as a mechanism for component
+ * composition & delayed execution. The function will only be executed at
+ * serialization time. In this case the optional global context object and all
+ * other elements of that node / array are passed as arguments when that
+ * function is called. The return value the function MUST be a valid new tree
+ * (or `undefined`).
  *
  * If the `ctx` object it'll be passed to each embedded component fns.
- * Optionally call {@link derefContext} prior to {@link serialize} to
- * auto-deref context keys with values implementing the
- * {@link @thi.ng/api#IDeref} interface.
+ * Optionally call {@link derefContext} prior to {@link serialize} to auto-deref
+ * context keys with values implementing the
+ * [`IDeref`](https://docs.thi.ng/umbrella/api/interfaces/IDeref.html)
+ * interface.
  *
  * ```js
  * const foo = (ctx, a, b) => ["div#" + a, ctx.foo, b];
@@ -68,29 +67,28 @@
  * // <div id="id" class="black">body</div>
  * ```
  *
- * Functions located in other positions are called ONLY with the global
- * context arg and can return any (serializable) value (i.e. new trees,
- * strings, numbers, iterables or any type with a suitable
- * `.toString()`, `.toHiccup()` or `.deref()` implementation).
+ * Functions located in other positions are called ONLY with the global context
+ * arg and can return any (serializable) value (i.e. new trees, strings,
+ * numbers, iterables or any type with a suitable `.toString()`, `.toHiccup()`
+ * or `.deref()` implementation).
  *
- * If the optional `span` flag is true (default: false), all text
- * content will be wrapped in <span> elements (this is to ensure DOM
- * compatibility with hdom). The only elements for spans are never
- * created are listed in `NO_SPANS` in `api.ts`.
+ * If the optional `span` flag is true (default: false), all text content will
+ * be wrapped in <span> elements (this is to ensure DOM compatibility with
+ * hdom). The only elements for spans are never created are listed in `NO_SPANS`
+ * in `api.ts`.
  *
- * If the optional `keys` flag is true (default: false), all elements
- * will have an autogenerated `key` attribute injected. If `span` is
- * enabled, `keys` will be enabled by default too (since in this case we
- * assume the output is meant to be compatible with
- * {@link @thi.ng/hdom# | @thi.ng/hdom}).
+ * If the optional `keys` flag is true (default: false), all elements will have
+ * an autogenerated `key` attribute injected. If `span` is enabled, `keys` will
+ * be enabled by default too (since in this case we assume the output is meant
+ * to be compatible with [`thi.ng/hdom`](https://thi.ng/hdom)).
  *
- * hiccup & hdom control attributes (i.e. attrib names prefixed with
- * `__`) will be omitted from the output. The only control attrib
- * supported by this package is `__serialize`. If set to `false`, the
- * entire tree branch will be excluded from the output.
+ * hiccup & hdom control attributes (i.e. attrib names prefixed with `__`) will
+ * be omitted from the output. The only control attrib supported by this package
+ * is `__serialize`. If set to `false`, the entire tree branch will be excluded
+ * from the output.
  *
- * Single or multiline comments can be included using the special
- * `COMMENT` tag (`__COMMENT__`) (always WITHOUT attributes!).
+ * Single or multiline comments can be included using the special `COMMENT` tag
+ * (`__COMMENT__`) (always WITHOUT attributes!).
  *
  * ```
  * [COMMENT, "Hello world"]
@@ -111,8 +109,8 @@
  * - `!ENTITY`
  * - `!ATTLIST`
  *
- * These are used as follows (attribs are only allowed for `?xml`, all
- * others only accept a body string which is taken as is):
+ * These are used as follows (attribs are only allowed for `?xml`, all others
+ * only accept a body string which is taken as is):
  *
  * ```
  * ["?xml", { version: "1.0", standalone: "yes" }]

package/serialize.js

@@ -12,12 +12,11 @@ import { css } from "./css.js";
 import { normalize } from "./normalize.js";
 import { formatPrefixes } from "./prefix.js";
 /**
- * Recursively normalizes and serializes given tree as HTML/SVG/XML
- * string. Expands any embedded component functions with their results.
+ * Recursively normalizes and serializes given tree as HTML/SVG/XML string.
+ * Expands any embedded component functions with their results.
  *
  * @remarks
- * Each node of the input tree can have one of the following input
- * forms:
+ * Each node of the input tree can have one of the following input forms:
  *
  * ```js
  * ["tag", ...]
@@ -35,14 +34,13 @@ import { formatPrefixes } from "./prefix.js";
  * ["div#foo.bar.baz", "hi"] // <div id="foo" class="bar baz">hi</div>
  * ```
  *
- * The presence of the attributes object (2nd array index) is optional.
- * Any attribute values, incl. functions are allowed. If the latter, the
- * function is called with the full attribs object as argument and the
- * return value is used for the attribute. This allows for the dynamic
- * creation of attrib values based on other attribs. The only exception
- * to this are event attributes, i.e. attribute names starting with
- * "on". Function values assigned to event attributes will be omitted
- * from the output.
+ * The presence of the attributes object (2nd array index) is optional. Any
+ * attribute values, incl. functions are allowed. If the latter, the function is
+ * called with the full attribs object as argument and the return value is used
+ * for the attribute. This allows for the dynamic creation of attrib values
+ * based on other attribs. The only exception to this are event attributes, i.e.
+ * attribute names starting with "on". Function values assigned to event
+ * attributes will be omitted from the output.
  *
  * ```js
  * ["div#foo", { bar: (attribs) => attribs.id + "-bar" }]
@@ -56,23 +54,24 @@ import { formatPrefixes } from "./prefix.js";
  * // <div style="color:red;background:#000;"></div>
  * ```
  *
- * Boolean attribs are serialized in HTML5 syntax (present or not).
- * `null`, `undefined` or empty string attrib values are ignored.
+ * Boolean attribs are serialized in HTML5 syntax (present or not). `null`,
+ * `undefined` or empty string attrib values are ignored.
  *
- * Any `null` or `undefined` array values (other than in head position)
- * will also be removed, unless a function is in head position.
+ * Any `null` or `undefined` array values (other than in head position) will
+ * also be removed, unless a function is in head position.
  *
- * A function in head position of a node acts as a mechanism for
- * component composition & delayed execution. The function will only be
- * executed at serialization time. In this case the optional global
- * context object and all other elements of that node / array are passed
- * as arguments when that function is called. The return value the
- * function MUST be a valid new tree (or `undefined`).
+ * A function in head position of a node acts as a mechanism for component
+ * composition & delayed execution. The function will only be executed at
+ * serialization time. In this case the optional global context object and all
+ * other elements of that node / array are passed as arguments when that
+ * function is called. The return value the function MUST be a valid new tree
+ * (or `undefined`).
  *
  * If the `ctx` object it'll be passed to each embedded component fns.
- * Optionally call {@link derefContext} prior to {@link serialize} to
- * auto-deref context keys with values implementing the
- * {@link @thi.ng/api#IDeref} interface.
+ * Optionally call {@link derefContext} prior to {@link serialize} to auto-deref
+ * context keys with values implementing the
+ * [`IDeref`](https://docs.thi.ng/umbrella/api/interfaces/IDeref.html)
+ * interface.
  *
  * ```js
  * const foo = (ctx, a, b) => ["div#" + a, ctx.foo, b];
@@ -81,29 +80,28 @@ import { formatPrefixes } from "./prefix.js";
  * // <div id="id" class="black">body</div>
  * ```
  *
- * Functions located in other positions are called ONLY with the global
- * context arg and can return any (serializable) value (i.e. new trees,
- * strings, numbers, iterables or any type with a suitable
- * `.toString()`, `.toHiccup()` or `.deref()` implementation).
+ * Functions located in other positions are called ONLY with the global context
+ * arg and can return any (serializable) value (i.e. new trees, strings,
+ * numbers, iterables or any type with a suitable `.toString()`, `.toHiccup()`
+ * or `.deref()` implementation).
  *
- * If the optional `span` flag is true (default: false), all text
- * content will be wrapped in <span> elements (this is to ensure DOM
- * compatibility with hdom). The only elements for spans are never
- * created are listed in `NO_SPANS` in `api.ts`.
+ * If the optional `span` flag is true (default: false), all text content will
+ * be wrapped in <span> elements (this is to ensure DOM compatibility with
+ * hdom). The only elements for spans are never created are listed in `NO_SPANS`
+ * in `api.ts`.
  *
- * If the optional `keys` flag is true (default: false), all elements
- * will have an autogenerated `key` attribute injected. If `span` is
- * enabled, `keys` will be enabled by default too (since in this case we
- * assume the output is meant to be compatible with
- * {@link @thi.ng/hdom# | @thi.ng/hdom}).
+ * If the optional `keys` flag is true (default: false), all elements will have
+ * an autogenerated `key` attribute injected. If `span` is enabled, `keys` will
+ * be enabled by default too (since in this case we assume the output is meant
+ * to be compatible with [`thi.ng/hdom`](https://thi.ng/hdom)).
  *
- * hiccup & hdom control attributes (i.e. attrib names prefixed with
- * `__`) will be omitted from the output. The only control attrib
- * supported by this package is `__serialize`. If set to `false`, the
- * entire tree branch will be excluded from the output.
+ * hiccup & hdom control attributes (i.e. attrib names prefixed with `__`) will
+ * be omitted from the output. The only control attrib supported by this package
+ * is `__serialize`. If set to `false`, the entire tree branch will be excluded
+ * from the output.
  *
- * Single or multiline comments can be included using the special
- * `COMMENT` tag (`__COMMENT__`) (always WITHOUT attributes!).
+ * Single or multiline comments can be included using the special `COMMENT` tag
+ * (`__COMMENT__`) (always WITHOUT attributes!).
  *
  * ```
  * [COMMENT, "Hello world"]
@@ -124,8 +122,8 @@ import { formatPrefixes } from "./prefix.js";
  * - `!ENTITY`
  * - `!ATTLIST`
  *
- * These are used as follows (attribs are only allowed for `?xml`, all
- * others only accept a body string which is taken as is):
+ * These are used as follows (attribs are only allowed for `?xml`, all others
+ * only accept a body string which is taken as is):
  *
  * ```
  * ["?xml", { version: "1.0", standalone: "yes" }]