@thi.ng/hiccup 5.2.1 → 5.2.2

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-05-08T18:24:32Z
+- **Last updated**: 2024-06-21T19:34:38Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,12 @@ 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.
 
+### [5.2.2](https://github.com/thi-ng/umbrella/tree/@thi.ng/hiccup@5.2.2) (2024-06-21)
+
+#### ♻️ Refactoring
+
+- enforce uniform naming convention of internal functions ([56992b2](https://github.com/thi-ng/umbrella/commit/56992b2))
+
 ## [5.2.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/hiccup@5.2.0) (2024-04-25)
 
 #### 🚀 Features

package/README.md

@@ -7,7 +7,7 @@
 [![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi)
 
 > [!NOTE]
-> This is one of 192 standalone projects, maintained as part
+> This is one of 193 standalone projects, maintained as part
 > of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo
 > and anti-framework.
 >

package/api.js

@@ -20,14 +20,14 @@ const NO_SPANS = {
   textarea: 1,
   title: 1
 };
-const tagMap = (tags) => tags.split(" ").reduce((acc, x) => (acc[x] = true, acc), {});
-const SVG_TAGS = tagMap(
+const __tagMap = (tags) => tags.split(" ").reduce((acc, x) => (acc[x] = true, acc), {});
+const SVG_TAGS = __tagMap(
   "animate animateColor animateMotion animateTransform circle clipPath color-profile defs desc discard ellipse feBlend feColorMatrix feComponentTransfer feComposite feConvolveMatrix feDiffuseLighting feDisplacementMap feDistantLight feDropShadow feFlood feFuncA feFuncB feFuncG feFuncR feGaussianBlur feImage feMerge feMergeNode feMorphology feOffset fePointLight feSpecularLighting feSpotLight feTile feTurbulence filter font foreignObject g image line linearGradient marker mask metadata mpath path pattern polygon polyline radialGradient rect set stop style svg switch symbol text textPath title tref tspan use view"
 );
-const VOID_TAGS = tagMap(
+const VOID_TAGS = __tagMap(
   "area base br col command embed hr img input keygen link meta param source stop track use wbr ?xml"
 );
-const NO_CLOSE_EMPTY = tagMap(
+const NO_CLOSE_EMPTY = __tagMap(
   "animate circle ellipse line path polygon polyline rect"
 );
 const ATTRIB_JOIN_DELIMS = {

package/attribs.d.ts

@@ -14,16 +14,22 @@
  * indicate if the class should be added or removed from the existing set.
  *
  * @example
- * ```ts
+ * ```ts tangle:../export/merge-classes.ts
  * import { mergeClasses } from "@thi.ng/hiccup";
  *
- * mergeClasses("foo bar", { foo: false, baz: true })
+ * console.log(
+ *   mergeClasses("foo bar", { foo: false, baz: true })
+ * );
  * // "bar baz"
  *
- * mergeClasses("foo", ["bar", "baz"]);
+ * console.log(
+ *   mergeClasses("foo", ["bar", "baz"])
+ * );
  * // "foo bar baz"
  *
- * mergeClasses("foo bar", "baz");
+ * console.log(
+ *   mergeClasses("foo bar", "baz")
+ * );
  * // "foo bar baz"
  * ```
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/hiccup",
-  "version": "5.2.1",
+  "version": "5.2.2",
   "description": "HTML/SVG/XML serialization of nested data structures, iterables & closures",
   "type": "module",
   "module": "./index.js",
@@ -10,7 +10,7 @@
     "type": "git",
     "url": "https://github.com/thi-ng/umbrella.git"
   },
-  "homepage": "https://github.com/thi-ng/umbrella/tree/develop/packages/hiccup#readme",
+  "homepage": "https://thi.ng/hiccup",
   "funding": [
     {
       "type": "github",
@@ -36,17 +36,17 @@
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.11.2",
-    "@thi.ng/checks": "^3.6.4",
-    "@thi.ng/errors": "^2.5.7",
-    "@thi.ng/strings": "^3.7.33"
+    "@thi.ng/api": "^8.11.3",
+    "@thi.ng/checks": "^3.6.5",
+    "@thi.ng/errors": "^2.5.8",
+    "@thi.ng/strings": "^3.7.34"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.43.2",
-    "@thi.ng/atom": "^5.3.0",
-    "esbuild": "^0.21.1",
+    "@microsoft/api-extractor": "^7.47.0",
+    "@thi.ng/atom": "^5.3.1",
+    "esbuild": "^0.21.5",
     "typedoc": "^0.25.13",
-    "typescript": "^5.4.5"
+    "typescript": "^5.5.2"
   },
   "keywords": [
     "array",
@@ -128,5 +128,5 @@
     ],
     "year": 2016
   },
-  "gitHead": "df34b4a9e650cc7323575356de207d78933bdcf3\n"
+  "gitHead": "154c95cf9d6bab32174498ec3b5b5d87e42be7f9\n"
 }

package/prefix.d.ts

@@ -3,11 +3,13 @@
  * the RDFa `prefix` attribute.
  *
  * @example
- * ```ts
+ * ```ts tangle:../export/format-prefixes.ts
  * import { formatPrefixes } from "@thi.ng/hiccup";
  * import { foaf, xsd } from "@thi.ng/prefixes";
  *
- * formatPrefixes({ foaf, xsd })
+ * console.log(
+ *   formatPrefixes({ foaf, xsd })
+ * );
  * // "foaf: http://xmlns.com/foaf/0.1/ rdf: http://www.w3.org/2001/XMLSchema#"
  * ```
  *

package/serialize.js

@@ -29,43 +29,43 @@ const serialize = (tree, opts, path = [0]) => {
     ...opts
   };
   if (opts?.keys == null && $opts.span) $opts.keys = true;
-  return _serialize(tree, $opts, path);
+  return __serialize(tree, $opts, path);
 };
-const _serialize = (tree, opts, path) => tree == null ? "" : Array.isArray(tree) ? serializeElement(tree, opts, path) : isFunction(tree) ? _serialize(tree(opts.ctx), opts, path) : implementsFunction(tree, "toHiccup") ? _serialize(tree.toHiccup(opts.ctx), opts, path) : isDeref(tree) ? _serialize(tree.deref(), opts, path) : isNotStringAndIterable(tree) ? serializeIter(tree, opts, path) : (tree = __escape(String(tree), opts), opts.span) ? `<span${opts.keys ? ` key="${path.join("-")}"` : ""}>${tree}</span>` : tree;
-const serializeElement = (tree, opts, path) => {
+const __serialize = (tree, opts, path) => tree == null ? "" : Array.isArray(tree) ? __serializeElement(tree, opts, path) : isFunction(tree) ? __serialize(tree(opts.ctx), opts, path) : implementsFunction(tree, "toHiccup") ? __serialize(tree.toHiccup(opts.ctx), opts, path) : isDeref(tree) ? __serialize(tree.deref(), opts, path) : isNotStringAndIterable(tree) ? __serializeIter(tree, opts, path) : (tree = __escape(String(tree), opts), opts.span) ? `<span${opts.keys ? ` key="${path.join("-")}"` : ""}>${tree}</span>` : tree;
+const __serializeElement = (tree, opts, path) => {
   let tag = tree[0];
-  return !tree.length ? "" : isFunction(tag) ? _serialize(tag.apply(null, [opts.ctx, ...tree.slice(1)]), opts, path) : implementsFunction(tag, "render") ? _serialize(
+  return !tree.length ? "" : isFunction(tag) ? __serialize(tag.apply(null, [opts.ctx, ...tree.slice(1)]), opts, path) : implementsFunction(tag, "render") ? __serialize(
     tag.render.apply(null, [opts.ctx, ...tree.slice(1)]),
     opts,
     path
-  ) : tag === COMMENT ? serializeComment(tree) : tag == CDATA ? serializeCData(tree) : isString(tag) ? serializeTag(tree, opts, path) : isNotStringAndIterable(tree) ? serializeIter(tree, opts, path) : illegalArgs(`invalid tree node: ${tree}`);
+  ) : tag === COMMENT ? __serializeComment(tree) : tag == CDATA ? __serializeCData(tree) : isString(tag) ? __serializeTag(tree, opts, path) : isNotStringAndIterable(tree) ? __serializeIter(tree, opts, path) : illegalArgs(`invalid tree node: ${tree}`);
 };
-const serializeTag = (tree, opts, path) => {
+const __serializeTag = (tree, opts, path) => {
   tree = normalize(tree);
   const attribs = tree[1];
   if (attribs.__skip || attribs.__serialize === false) return "";
   opts.keys && attribs.key === void 0 && (attribs.key = path.join("-"));
   const tag = tree[0];
-  const body = tree[2] ? serializeBody(tag, tree[2], opts, path) : !VOID_TAGS[tag] && !NO_CLOSE_EMPTY[tag] ? `></${tag}>` : PROC_TAGS[tag] || "/>";
-  return `<${tag}${serializeAttribs(attribs, opts)}${body}`;
+  const body = tree[2] ? __serializeBody(tag, tree[2], opts, path) : !VOID_TAGS[tag] && !NO_CLOSE_EMPTY[tag] ? `></${tag}>` : PROC_TAGS[tag] || "/>";
+  return `<${tag}${__serializeAttribs(attribs, opts)}${body}`;
 };
-const serializeAttribs = (attribs, opts) => {
+const __serializeAttribs = (attribs, opts) => {
   let res = "";
   for (let a in attribs) {
     if (a.startsWith("__")) continue;
-    const v = serializeAttrib(attribs, a, deref(attribs[a]), opts);
+    const v = __serializeAttrib(attribs, a, deref(attribs[a]), opts);
     v != null && (res += v);
   }
   return res;
 };
-const serializeAttrib = (attribs, a, v, opts) => {
-  return v == null ? null : isFunction(v) && (/^on\w+/.test(a) || (v = v(attribs)) == null) ? null : v === true ? " " + a + (opts.xml ? `=""` : "") : v === false ? null : a === "data" ? serializeDataAttribs(v, opts) : attribPair(a, v, opts);
+const __serializeAttrib = (attribs, a, v, opts) => {
+  return v == null ? null : isFunction(v) && (/^on\w+/.test(a) || (v = v(attribs)) == null) ? null : v === true ? " " + a + (opts.xml ? `=""` : "") : v === false ? null : a === "data" ? __serializeDataAttribs(v, opts) : __attribPair(a, v, opts);
 };
-const attribPair = (a, v, opts) => {
+const __attribPair = (a, v, opts) => {
   v = a === "style" && isPlainObject(v) ? css(v) : a === "prefix" && isPlainObject(v) ? formatPrefixes(v) : isArray(v) ? v.join(ATTRIB_JOIN_DELIMS[a] || " ") : v.toString();
   return v.length ? ` ${a}="${__escape(v, opts)}"` : null;
 };
-const serializeDataAttribs = (data, opts) => {
+const __serializeDataAttribs = (data, opts) => {
   let res = "";
   for (let id in data) {
     let v = deref(data[id]);
@@ -74,7 +74,7 @@ const serializeDataAttribs = (data, opts) => {
   }
   return res;
 };
-const serializeBody = (tag, body, opts, path) => {
+const __serializeBody = (tag, body, opts, path) => {
   if (VOID_TAGS[tag]) {
     illegalArgs(`No body allowed in tag: ${tag}`);
   }
@@ -82,26 +82,26 @@ const serializeBody = (tag, body, opts, path) => {
   let res = proc ? " " : ">";
   if (opts.span && !proc && !NO_SPANS[tag]) opts = { ...opts, span: true };
   for (let i = 0, n = body.length; i < n; i++) {
-    res += _serialize(body[i], opts, [...path, i]);
+    res += __serialize(body[i], opts, [...path, i]);
   }
   return res + (proc || `</${tag}>`);
 };
-const serializeComment = (tree) => tree.length > 2 ? `
+const __serializeComment = (tree) => tree.length > 2 ? `
 <!--
 ${tree.slice(1).map((x) => "    " + x).join("\n")}
 -->
 ` : `
 <!-- ${tree[1]} -->
 `;
-const serializeCData = (tree) => `<![CDATA[
+const __serializeCData = (tree) => `<![CDATA[
 ${tree.slice(1).join("\n")}
 ]]>`;
-const serializeIter = (iter, opts, path) => {
+const __serializeIter = (iter, opts, path) => {
   const res = [];
   const p = path.slice(0, path.length - 1);
   let k = 0;
   for (let i of iter) {
-    res.push(_serialize(i, opts, [...p, k++]));
+    res.push(__serialize(i, opts, [...p, k++]));
   }
   return res.join("");
 };