@weborigami/origami 0.2.12 → 0.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@weborigami/origami",
-  "version": "0.2.12",
+  "version": "0.3.0",
   "description": "Web Origami language, CLI, framework, and server",
   "type": "module",
   "repository": {
@@ -17,10 +17,10 @@
     "typescript": "5.8.2"
   },
   "dependencies": {
-    "@weborigami/async-tree": "0.2.12",
-    "@weborigami/language": "0.2.12",
+    "@weborigami/async-tree": "0.3.0",
+    "@weborigami/language": "0.3.0",
     "@weborigami/json-feed-to-rss": "1.0.0",
-    "@weborigami/types": "0.2.12",
+    "@weborigami/types": "0.3.0",
     "exif-parser": "0.1.12",
     "graphviz-wasm": "3.0.2",
     "highlight.js": "11.11.1",

package/src/help/help.yaml

@@ -302,8 +302,8 @@ tree:
       args: (tree)
       description: The tree's [key, value] pairs
     filter:
-      args: (source, filter)
-      description: Filter the source tree using the filter tree
+      args: (source, options)
+      description: Filter the source tree
     first:
       args: (tree)
       description: The first value in the tree
@@ -352,6 +352,9 @@ tree:
     mapReduce:
       args: (tree, valueFn, reduceFn)
       description: Map values and reduce them
+    mask:
+      args: (source, mask)
+      description: Return the source tree with only the keys in the mask
     match:
       args: (pattern, fn, [keys])
       description: Matches simple patterns or regular expressions

package/src/tree/filter.js

@@ -2,7 +2,7 @@ import { filter } from "@weborigami/async-tree";
 import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
 
 /**
- * Apply a filter to a tree.
+ * Apply a filter to a tree
  *
  * @typedef  {import("@weborigami/types").AsyncTree} AsyncTree
  * @typedef {import("@weborigami/async-tree").Treelike} Treelike

package/src/tree/mask.js

@@ -0,0 +1,19 @@
+import { mask } from "@weborigami/async-tree";
+import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
+
+/**
+ * Apply a mask to a tree
+ *
+ * @typedef  {import("@weborigami/types").AsyncTree} AsyncTree
+ * @typedef {import("@weborigami/async-tree").Treelike} Treelike
+ *
+ * @this {AsyncTree|null}
+ * @param {Treelike} sourceTreelike
+ * @param {Treelike} maskTreelike
+ */
+export default async function maskBuiltin(sourceTreelike, maskTreelike) {
+  assertTreeIsDefined(this, "tree:mask");
+  const result = mask(sourceTreelike, maskTreelike);
+  result.parent = this;
+  return result;
+}

package/src/tree/tree.js

@@ -21,6 +21,7 @@ export { default as inners } from "./inners.js";
 export { default as keys } from "./keys.js";
 export { default as length } from "./length.js";
 export { default as map } from "./map.js";
+export { default as mask } from "./mask.js";
 export { default as match } from "./match.js";
 export { default as merge } from "./merge.js";
 export { default as paginate } from "./paginate.js";