@thi.ng/text-canvas 3.0.23 → 3.0.24

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-05-08T18:24:31Z
+- **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.
 
+### [3.0.24](https://github.com/thi-ng/umbrella/tree/@thi.ng/text-canvas@3.0.24) (2024-06-21)
+
+#### ♻️ Refactoring
+
+- enforce uniform naming convention of internal functions ([56992b2](https://github.com/thi-ng/umbrella/commit/56992b2))
+
 ### [3.0.3](https://github.com/thi-ng/umbrella/tree/@thi.ng/text-canvas@3.0.3) (2024-02-22)
 
 #### ♻️ Refactoring

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/bars.js

@@ -32,9 +32,9 @@ const barChartHLines = (width, vals, min, max) => {
   return [...map((x) => barHorizontal(width, x, min, max), $vals)];
 };
 const barChartHStr = (width, vals, min, max) => barChartHLines(width, vals, min, max).join("\n");
-const barHorizontal = (width, x, min = 0, max = 1) => bar(BARS_H, width, false, x, min, max, "");
-const barVertical = (height, x, min = 0, max = 1, delim = "\n") => bar(BARS_V, height, true, x, min, max, delim);
-const bar = (chars, size, left, x, min, max, delim) => {
+const barHorizontal = (width, x, min = 0, max = 1) => __bar(BARS_H, width, false, x, min, max, "");
+const barVertical = (height, x, min = 0, max = 1, delim = "\n") => __bar(BARS_V, height, true, x, min, max, delim);
+const __bar = (chars, size, left, x, min, max, delim) => {
   x = fitClamped(x, min, max, 0, size);
   const f = fract(x) * 9 | 0;
   const full = repeat(chars[8] + delim, x | 0);

package/canvas.js

@@ -138,8 +138,8 @@ const beginClip = (canvas2, x, y, w, h) => {
     )
   );
 };
-const pop = (stack) => stack.length > 1 && stack.pop();
-const endClip = (canvas2) => pop(canvas2.clipRects);
+const __pop = (stack) => stack.length > 1 && stack.pop();
+const endClip = (canvas2) => __pop(canvas2.clipRects);
 const withClip = (canvas2, x, y, w, h, fn) => {
   beginClip(canvas2, x, y, w, h);
   fn();
@@ -148,7 +148,7 @@ const withClip = (canvas2, x, y, w, h, fn) => {
 const beginStyle = (canvas2, style) => {
   canvas2.styles.push(style);
 };
-const endStyle = (canvas2) => pop(canvas2.styles);
+const endStyle = (canvas2) => __pop(canvas2.styles);
 const withStyle = (canvas2, style, fn) => {
   canvas2.styles.push(style);
   fn();

package/image.d.ts

@@ -16,7 +16,7 @@ export declare const blit: (dest: Canvas, src: Canvas, x?: number, y?: number) =
  * pixels/chars will be copied. Supports region clipping.
  *
  * @example
- * ```ts
+ * ```ts tangle:../export/blit-mask.ts
  * import {
  *   blitMask, canvas, canvasFromText, clear, formatCanvas
  * } from "@thi.ng/text-canvas";
@@ -30,17 +30,19 @@ export declare const blit: (dest: Canvas, src: Canvas, x?: number, y?: number) =
  *   "###==###",
  * ]);
  *
+ * console.log(formatCanvas(a));
+ *
  * // destination canvas (filled w/ "-")
  * const b = canvas(12,7);
  * clear(b, true, "-");
  *
  * // paste `a` several times into `b` using "#" as mask
- * blitMask(b, -4, -2, a, "#"); // top-left (partially outside)
- * blitMask(b, 2, 1, a, "#");   // center
- * blitMask(b, 8, 4, a, "#");   // bottom-right (part outside)
+ * blitMask(b, a, -4, -2, "#"); // top-left (partially outside)
+ * blitMask(b, a, 2, 1, "#"); // center
+ * blitMask(b, a, 8, 4, "#"); // bottom-right (part outside)
  *
  * // show result
- * console.log(formatCanvas(b))
+ * console.log(formatCanvas(b));
  * // ===---------
  * // ==---==-----
  * // =---====----

package/image.js

@@ -297,7 +297,7 @@ const image = (canvas2, x, y, w, h, pixels, opts = {}) => {
     sy,
     w: iw,
     h: ih
-  } = imgRect(canvas2, x, y, w, h);
+  } = __imgRect(canvas2, x, y, w, h);
   if (!iw || !ih) return;
   const {
     chars = SHADES_BLOCK,
@@ -335,7 +335,7 @@ const imageRaw = (canvas2, x, y, w, h, pixels, char = "\u2588") => {
     sy,
     w: iw,
     h: ih
-  } = imgRect(canvas2, x, y, w, h);
+  } = __imgRect(canvas2, x, y, w, h);
   if (!iw || !ih) return;
   const code = char.charCodeAt(0);
   for (let yy = sy, dy = y1; dy < y2; yy++, dy++) {
@@ -361,7 +361,7 @@ const imageRawFmtOnly = (canvas2, x, y, w, h, pixels) => {
     sy,
     w: iw,
     h: ih
-  } = imgRect(canvas2, x, y, w, h);
+  } = __imgRect(canvas2, x, y, w, h);
   if (!iw || !ih) return;
   for (let yy = sy, dy = y1; dy < y2; yy++, dy++) {
     let sidx = sx + yy * w;
@@ -388,7 +388,7 @@ const imageBraille = (canvas2, x, y, w, h, pixels, thresh, format) => {
     sy,
     w: iw,
     h: ih
-  } = imgRect(canvas2, x, y, w >> 1, h >> 2);
+  } = __imgRect(canvas2, x, y, w >> 1, h >> 2);
   if (!iw || !ih) return;
   const w2 = w * 2;
   const w3 = w * 3;
@@ -413,7 +413,7 @@ const imageCanvas565 = (src, char) => {
   return dest;
 };
 const imageString565 = (src, char, fmt = FMT_ANSI565) => formatCanvas(imageCanvas565(src, char), fmt);
-const imgRect = (canvas2, x, y, w, h) => {
+const __imgRect = (canvas2, x, y, w, h) => {
   const rect = intersectRect(
     { x1: x, y1: y, x2: x + w, y2: y + h, w, h },
     peek(canvas2.clipRects)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/text-canvas",
-  "version": "3.0.23",
+  "version": "3.0.24",
   "description": "Text based canvas, drawing, plotting, tables with arbitrary formatting (incl. ANSI/HTML)",
   "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/text-canvas#readme",
+  "homepage": "https://thi.ng/text-canvas",
   "funding": [
     {
       "type": "github",
@@ -36,22 +36,22 @@
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.11.2",
-    "@thi.ng/arrays": "^2.9.6",
-    "@thi.ng/checks": "^3.6.4",
-    "@thi.ng/errors": "^2.5.7",
-    "@thi.ng/geom-clip-line": "^2.3.89",
-    "@thi.ng/math": "^5.10.13",
-    "@thi.ng/strings": "^3.7.33",
-    "@thi.ng/text-format": "^2.2.5",
-    "@thi.ng/transducers": "^9.0.5"
+    "@thi.ng/api": "^8.11.3",
+    "@thi.ng/arrays": "^2.9.7",
+    "@thi.ng/checks": "^3.6.5",
+    "@thi.ng/errors": "^2.5.8",
+    "@thi.ng/geom-clip-line": "^2.3.90",
+    "@thi.ng/math": "^5.11.0",
+    "@thi.ng/strings": "^3.7.34",
+    "@thi.ng/text-format": "^2.2.6",
+    "@thi.ng/transducers": "^9.0.6"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.43.2",
-    "esbuild": "^0.21.1",
-    "tslib": "^2.6.2",
+    "@microsoft/api-extractor": "^7.47.0",
+    "esbuild": "^0.21.5",
+    "tslib": "^2.6.3",
     "typedoc": "^0.25.13",
-    "typescript": "^5.4.5"
+    "typescript": "^5.5.2"
   },
   "keywords": [
     "4bit",
@@ -147,5 +147,5 @@
     ],
     "year": 2020
   },
-  "gitHead": "df34b4a9e650cc7323575356de207d78933bdcf3\n"
+  "gitHead": "154c95cf9d6bab32174498ec3b5b5d87e42be7f9\n"
 }

package/utils.js

@@ -6,8 +6,8 @@ const intersectRect = (a, b) => {
   const y2 = Math.min(a.y2, b.y2);
   return { x1, y1, x2, y2, w: Math.max(x2 - x1, 0), h: Math.max(y2 - y1, 0) };
 };
-const axis = (a, b, c) => (a < b ? a - b : a > b + c ? a - b - c : 0) ** 2;
-const intersectRectCircle = (x, y, w, h, cx, cy, r) => axis(cx, x, w) + axis(cy, y, h) <= r * r;
+const __axis = (a, b, c) => (a < b ? a - b : a > b + c ? a - b - c : 0) ** 2;
+const intersectRectCircle = (x, y, w, h, cx, cy, r) => __axis(cx, x, w) + __axis(cy, y, h) <= r * r;
 export {
   charCode,
   intersectRect,