@weborigami/async-tree 0.3.2 → 0.3.3-jse.1

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@weborigami/async-tree",
-  "version": "0.3.2",
+  "version": "0.3.3-jse.1",
   "description": "Asynchronous tree drivers based on standard JavaScript classes",
   "type": "module",
   "main": "./main.js",
   "browser": "./browser.js",
   "types": "./index.ts",
   "dependencies": {
-    "@weborigami/types": "0.3.2"
+    "@weborigami/types": "0.3.3-jse.1"
   },
   "devDependencies": {
     "@types/node": "22.13.13",

package/shared.js

@@ -14,7 +14,6 @@ export * as jsonKeys from "./src/jsonKeys.js";
 export { default as addNextPrevious } from "./src/operations/addNextPrevious.js";
 export { default as cache } from "./src/operations/cache.js";
 export { default as cachedKeyFunctions } from "./src/operations/cachedKeyFunctions.js";
-export { default as concat } from "./src/operations/concat.js";
 export { default as deepMerge } from "./src/operations/deepMerge.js";
 export { default as deepReverse } from "./src/operations/deepReverse.js";
 export { default as deepTake } from "./src/operations/deepTake.js";
@@ -34,6 +33,7 @@ export { default as reverse } from "./src/operations/reverse.js";
 export { default as scope } from "./src/operations/scope.js";
 export { default as sort } from "./src/operations/sort.js";
 export { default as take } from "./src/operations/take.js";
+export { default as text } from "./src/operations/text.js";
 export * as symbols from "./src/symbols.js";
 export * as trailingSlash from "./src/trailingSlash.js";
 export { default as TraverseError } from "./src/TraverseError.js";

package/src/operations/deepText.js

@@ -1,25 +1,29 @@
-import { Tree } from "../internal.js";
-import { toString } from "../utilities.js";
-import concat from "./concat.js";
+import { assertIsTreelike, toString } from "../utilities.js";
+import deepValuesIterator from "./deepValuesIterator.js";
 
 /**
- * A tagged template literal function that concatenate the deep text values in a
- * tree. Any treelike values will be concatenated using `concat`.
+ * Concatenate the deep text values in a tree.
  *
- * @param {TemplateStringsArray} strings
- * @param  {...any} values
+ * @param {import("../../index.ts").Treelike} treelike
  */
-export default async function deepText(strings, ...values) {
-  // Convert all the values to strings
-  const valueTexts = await Promise.all(
-    values.map((value) =>
-      Tree.isTreelike(value) ? concat(value) : toString(value)
-    )
-  );
-  // Splice all the strings together
-  let result = strings[0];
-  for (let i = 0; i < valueTexts.length; i++) {
-    result += valueTexts[i] + strings[i + 1];
+export default async function deepText(treelike) {
+  assertIsTreelike(treelike, "text");
+
+  const strings = [];
+  for await (const value of deepValuesIterator(treelike, { expand: true })) {
+    let string;
+    if (value === null) {
+      string = "null";
+    } else if (value === undefined) {
+      string = "undefined";
+    } else {
+      string = toString(value);
+    }
+    if (value === null || value === undefined) {
+      const message = `Warning: a template encountered a ${string} value. To locate where this happened, build your project and search your build output for the text "${string}".`;
+      console.warn(message);
+    }
+    strings.push(string);
   }
-  return result;
+  return strings.join("");
 }

package/src/operations/text.js

@@ -0,0 +1,25 @@
+import { Tree } from "../internal.js";
+import { toString } from "../utilities.js";
+import deepText from "./deepText.js";
+
+/**
+ * A tagged template literal function that concatenate the deep text values in a
+ * tree. Any treelike values will be concatenated using `deepText`.
+ *
+ * @param {TemplateStringsArray} strings
+ * @param  {...any} values
+ */
+export default async function text(strings, ...values) {
+  // Convert all the values to strings
+  const valueTexts = await Promise.all(
+    values.map((value) =>
+      Tree.isTreelike(value) ? deepText(value) : toString(value)
+    )
+  );
+  // Splice all the strings together
+  let result = strings[0];
+  for (let i = 0; i < valueTexts.length; i++) {
+    result += valueTexts[i] + strings[i + 1];
+  }
+  return result;
+}

package/test/operations/deepText.test.js

@@ -1,12 +1,34 @@
 import assert from "node:assert";
 import { describe, test } from "node:test";
+import FunctionTree from "../../src/drivers/FunctionTree.js";
+import { Tree } from "../../src/internal.js";
 import deepText from "../../src/operations/deepText.js";
 
 describe("deepText", () => {
-  test("joins strings and values together", async () => {
-    const array = [1, 2, 3];
-    const object = { person1: "Alice", person2: "Bob" };
-    const result = await deepText`a ${array} b ${object} c`;
-    assert.equal(result, "a 123 b AliceBob c");
+  test("concatenates deep tree values", async () => {
+    const tree = Tree.from({
+      a: "A",
+      b: "B",
+      c: "C",
+      more: {
+        d: "D",
+        e: "E",
+      },
+    });
+    const result = await deepText(tree);
+    assert.equal(result, "ABCDE");
+  });
+
+  test("concatenates deep tree-like values", async () => {
+    const letters = ["a", "b", "c"];
+    const specimens = new FunctionTree(
+      (letter) => ({
+        lowercase: letter,
+        uppercase: letter.toUpperCase(),
+      }),
+      letters
+    );
+    const result = await deepText(specimens);
+    assert.equal(result, "aAbBcC");
   });
 });

package/test/operations/text.test.js

@@ -0,0 +1,12 @@
+import assert from "node:assert";
+import { describe, test } from "node:test";
+import text from "../../src/operations/text.js";
+
+describe("text template literal function", () => {
+  test("joins strings and values together", async () => {
+    const array = [1, 2, 3];
+    const object = { person1: "Alice", person2: "Bob" };
+    const result = await text`a ${array} b ${object} c`;
+    assert.equal(result, "a 123 b AliceBob c");
+  });
+});

package/src/operations/concat.js

@@ -1,29 +0,0 @@
-import { assertIsTreelike, toString } from "../utilities.js";
-import deepValuesIterator from "./deepValuesIterator.js";
-
-/**
- * Concatenate the deep text values in a tree.
- *
- * @param {import("../../index.ts").Treelike} treelike
- */
-export default async function concat(treelike) {
-  assertIsTreelike(treelike, "concat");
-
-  const strings = [];
-  for await (const value of deepValuesIterator(treelike, { expand: true })) {
-    let string;
-    if (value === null) {
-      string = "null";
-    } else if (value === undefined) {
-      string = "undefined";
-    } else {
-      string = toString(value);
-    }
-    if (value === null || value === undefined) {
-      const message = `Warning: Origami template encountered a ${string} value. To locate where this happened, build your project and search your build output for the text "${string}".`;
-      console.warn(message);
-    }
-    strings.push(string);
-  }
-  return strings.join("");
-}

package/test/operations/concat.test.js

@@ -1,34 +0,0 @@
-import assert from "node:assert";
-import { describe, test } from "node:test";
-import FunctionTree from "../../src/drivers/FunctionTree.js";
-import { Tree } from "../../src/internal.js";
-import concat from "../../src/operations/concat.js";
-
-describe("concat", () => {
-  test("concatenates deep tree values", async () => {
-    const tree = Tree.from({
-      a: "A",
-      b: "B",
-      c: "C",
-      more: {
-        d: "D",
-        e: "E",
-      },
-    });
-    const result = await concat.call(null, tree);
-    assert.equal(result, "ABCDE");
-  });
-
-  test("concatenates deep tree-like values", async () => {
-    const letters = ["a", "b", "c"];
-    const specimens = new FunctionTree(
-      (letter) => ({
-        lowercase: letter,
-        uppercase: letter.toUpperCase(),
-      }),
-      letters
-    );
-    const result = await concat.call(null, specimens);
-    assert.equal(result, "aAbBcC");
-  });
-});