@weborigami/async-tree 0.0.63 → 0.0.64-beta.2

package/index.ts

@@ -25,7 +25,7 @@ export type PlainObject = {
   [key: string]: any;
 };
 
-export type ReduceFn = (values: any[], keys: any[]) => Promise<any>;
+export type ReduceFn = (values: any[], keys: any[], tree: AsyncTree) => Promise<any>;
 
 export type StringLike = string | HasString;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@weborigami/async-tree",
-  "version": "0.0.63",
+  "version": "0.0.64-beta.2",
   "description": "Asynchronous tree drivers based on standard JavaScript classes",
   "type": "module",
   "main": "./main.js",
@@ -11,7 +11,7 @@
     "typescript": "5.5.3"
   },
   "dependencies": {
-    "@weborigami/types": "0.0.63"
+    "@weborigami/types": "0.0.64-beta.2"
   },
   "scripts": {
     "test": "node --test --test-reporter=spec",

package/src/Tree.d.ts

@@ -14,7 +14,7 @@ export function isTraversable(obj: any): boolean;
 export function isTreelike(obj: any): obj is Treelike;
 export function map(tree: Treelike, valueFn: ValueKeyFn): AsyncTree;
 export function mapReduce(tree: Treelike, mapFn: ValueKeyFn | null, reduceFn: ReduceFn): Promise<any>;
-export function paths(tree: Treelike, base: string): string[];
+export function paths(tree: Treelike, base?: string): string[];
 export function plain(tree: Treelike): Promise<PlainObject>;
 export function remove(AsyncTree: AsyncMutableTree, key: any): Promise<boolean>;
 export function toFunction(tree: Treelike): Function;

package/src/Tree.js

@@ -166,7 +166,14 @@ export async function has(tree, key) {
  * @returns {obj is AsyncTree}
  */
 export function isAsyncTree(obj) {
-  return obj && typeof obj.get === "function" && typeof obj.keys === "function";
+  return (
+    obj &&
+    typeof obj.get === "function" &&
+    typeof obj.keys === "function" &&
+    // JavaScript Map look like trees but can't be extended the same way, so we
+    // report false.
+    !(obj instanceof Map)
+  );
 }
 
 /**
@@ -231,8 +238,9 @@ export function isTraversable(object) {
 export function isTreelike(obj) {
   return (
     isAsyncTree(obj) ||
-    obj instanceof Function ||
     obj instanceof Array ||
+    obj instanceof Function ||
+    obj instanceof Map ||
     obj instanceof Set ||
     isPlainObject(obj)
   );
@@ -286,14 +294,14 @@ export async function mapReduce(treelike, valueFn, reduceFn) {
   const values = await Promise.all(promises);
 
   // Reduce the values to a single result.
-  return reduceFn(values, keys);
+  return reduceFn(values, keys, tree);
 }
 
 /**
  * Returns slash-separated paths for all values in the tree.
  *
  * @param {Treelike} treelike
- * @param {string} base
+ * @param {string?} base
  */
 export async function paths(treelike, base = "") {
   const tree = from(treelike);
@@ -310,6 +318,7 @@ export async function paths(treelike, base = "") {
   }
   return result;
 }
+
 /**
  * Converts an asynchronous tree into a synchronous plain JavaScript object.
  *
@@ -320,7 +329,11 @@ export async function paths(treelike, base = "") {
  * @returns {Promise<PlainObject|Array>}
  */
 export async function plain(treelike) {
-  return mapReduce(treelike, null, (values, keys) => {
+  return mapReduce(treelike, null, (values, keys, tree) => {
+    // Special case for an empty tree: if based on array, return array.
+    if (tree instanceof ObjectTree && keys.length === 0) {
+      return tree.object instanceof Array ? [] : {};
+    }
     const object = {};
     for (let i = 0; i < keys.length; i++) {
       object[keys[i]] = values[i];

package/test/MapTree.test.js

@@ -1,6 +1,7 @@
 import assert from "node:assert";
 import { describe, test } from "node:test";
 import MapTree from "../src/MapTree.js";
+import * as symbols from "../src/symbols.js";
 
 describe("MapTree", () => {
   test("can get the keys of the tree", async () => {
@@ -18,7 +19,7 @@ describe("MapTree", () => {
     const map = new Map([["more", new Map([["a", 1]])]]);
     const fixture = new MapTree(map);
     const more = await fixture.get("more");
-    assert.equal(more.parent, fixture);
+    assert.equal(more[symbols.parent], fixture);
   });
 
   test("getting an unsupported key returns undefined", async () => {

package/test/Tree.test.js

@@ -261,6 +261,13 @@ describe("Tree", () => {
     assert.deepEqual(plain, original);
   });
 
+  test("plain() returns empty array or object for ObjectTree as necessary", async () => {
+    const tree = new ObjectTree({});
+    assert.deepEqual(await Tree.plain(tree), {});
+    const arrayTree = new ObjectTree([]);
+    assert.deepEqual(await Tree.plain(arrayTree), []);
+  });
+
   test("plain() awaits async properties", async () => {
     const object = {
       get name() {