@weborigami/async-tree 0.2.2 → 0.2.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Jan Miksovsky and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "@weborigami/async-tree",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "description": "Asynchronous tree drivers based on standard JavaScript classes",
   "type": "module",
   "main": "./main.js",
   "browser": "./browser.js",
   "types": "./index.ts",
   "devDependencies": {
-    "@types/node": "22.7.4",
-    "typescript": "5.6.2"
+    "@types/node": "22.10.2",
+    "typescript": "5.7.2"
   },
   "dependencies": {
-    "@weborigami/types": "0.2.2"
+    "@weborigami/types": "0.2.3"
   },
   "scripts": {
     "test": "node --test --test-reporter=spec",

package/src/drivers/ObjectTree.js

@@ -66,6 +66,11 @@ export default class ObjectTree {
    * Enumerate the object's keys.
    */
   async keys() {
+    // Defer to symbols.keys if defined
+    if (typeof this.object[symbols.keys] === "function") {
+      return this.object[symbols.keys]();
+    }
+
     // Walk up the prototype chain to realm's Object.prototype.
     let obj = this.object;
     const objectPrototype = getRealmObjectPrototype(obj);

package/src/symbols.js

@@ -1,2 +1,3 @@
 export const deep = Symbol("deep");
+export const keys = Symbol("keys");
 export const parent = Symbol("parent");

package/test/browser/assert.js

@@ -44,11 +44,11 @@ assert.deepEqual = (actual, expected) => {
   throw new Error(`Expected ${expected} but got ${actual}`);
 };
 
-assert.rejects = async (promise) => {
+assert.rejects = async (fn) => {
   try {
-    await promise;
-    throw new Error("Expected promise to reject but it resolved");
+    await fn();
   } catch (error) {
     return;
   }
+  throw new Error("Expected promise to reject but it resolved");
 };

package/test/browser/index.html

@@ -13,22 +13,22 @@
     </script>
     <!-- Omit FileTree.test.js, which is Node.js only -->
     <!-- Omit SiteTree.test.js, which requires mocks -->
-    <script type="module" src="../BrowserFileTree.test.js"></script>
-    <script type="module" src="../DeferredTree.test.js"></script>
-    <script type="module" src="../FunctionTree.test.js"></script>
-    <script type="module" src="../MapTree.test.js"></script>
-    <script type="module" src="../ObjectTree.test.js"></script>
-    <script type="module" src="../SetTree.test.js"></script>
     <script type="module" src="../Tree.test.js"></script>
+    <script type="module" src="../drivers/BrowserFileTree.test.js"></script>
+    <script type="module" src="../drivers/DeferredTree.test.js"></script>
+    <script type="module" src="../drivers/FunctionTree.test.js"></script>
+    <script type="module" src="../drivers/MapTree.test.js"></script>
+    <script type="module" src="../drivers/ObjectTree.test.js"></script>
+    <script type="module" src="../drivers/SetTree.test.js"></script>
     <script type="module" src="../operations/cache.test.js"></script>
     <script type="module" src="../operations/merge.test.js"></script>
     <script type="module" src="../operations/deepMerge.test.js"></script>
-    <script type="module" src="../transforms/cachedKeyMaps.test.js"></script>
+    <script type="module" src="../operations/cachedKeyFunctions.test.js"></script>
     <script
       type="module"
-      src="../transforms/keyFunctionsForExtensions.test.js"
+      src="../operations/keyFunctionsForExtensions.test.js"
     ></script>
-    <script type="module" src="../transforms/mapFn.test.js"></script>
+    <script type="module" src="../operations/map.test.js"></script>
     <script type="module" src="../utilities.test.js"></script>
   </head>
   <body></body>

package/test/drivers/BrowserFileTree.test.js

@@ -145,7 +145,12 @@ async function createFixture() {
 }
 
 async function strings(tree) {
-  return Tree.plain(Tree.map(tree, (value) => text(value)));
+  return Tree.plain(
+    Tree.map(tree, {
+      deep: true,
+      value: (value) => text(value),
+    })
+  );
 }
 
 function text(arrayBuffer) {

package/test/drivers/ObjectTree.test.js

@@ -145,6 +145,13 @@ describe("ObjectTree", () => {
     const method = await tree.get("toString");
     assert.equal(method(), "123");
   });
+
+  test("defers to symbols.keys for keys if defined", async () => {
+    const tree = new ObjectTree({
+      [symbols.keys]: () => ["a", "b", "c"],
+    });
+    assert.deepEqual(Array.from(await tree.keys()), ["a", "b", "c"]);
+  });
 });
 
 function createFixture() {