@weborigami/origami 0.2.12 → 0.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@weborigami/origami",
-  "version": "0.2.12",
+  "version": "0.3.1",
   "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.1",
+    "@weborigami/language": "0.3.1",
     "@weborigami/json-feed-to-rss": "1.0.0",
-    "@weborigami/types": "0.2.12",
+    "@weborigami/types": "0.3.1",
     "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/origami/csv.js

@@ -12,11 +12,16 @@ import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
  */
 export default async function csv(object) {
   assertTreeIsDefined(this, "origami:csv");
+  object = object ?? this;
+  if (object === undefined) {
+    return undefined;
+  }
   if (isUnpackable(object)) {
     object = await object.unpack();
   }
   const value = await toPlainValue(object);
-  const text = formatCsv(value);
+  const array = Array.isArray(value) ? value : Object.values(value);
+  const text = formatCsv(array);
   return text;
 }
 

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

@@ -1,13 +1,10 @@
 import {
-  cachedKeyFunctions,
-  extensionKeyFunctions,
   isPlainObject,
   isUnpackable,
   map as mapTransform,
 } from "@weborigami/async-tree";
 import getTreeArgument from "../common/getTreeArgument.js";
 import { toFunction } from "../common/utilities.js";
-import parseExtensions from "./parseExtensions.js";
 
 /**
  * Map a hierarchical tree of keys and values to a new tree of keys and values.
@@ -81,12 +78,6 @@ function extendedOptions(context, operation) {
   let keyFn = options.key;
   let inverseKeyFn = options.inverseKey;
 
-  if (extension && (keyFn || inverseKeyFn)) {
-    throw new TypeError(
-      `map: You can't specify extensions and also a key or inverseKey function`
-    );
-  }
-
   if (valueFn) {
     // @ts-ignore
     valueFn = toFunction(valueFn);
@@ -94,36 +85,23 @@ function extendedOptions(context, operation) {
     // Origami builtins can be used as value functions.
     // @ts-ignore
     const bound = valueFn.bind(context);
+    // Transfer sidecar functions
     // @ts-ignore
     Object.assign(bound, valueFn);
     valueFn = bound;
   }
 
-  if (extension) {
-    // Generate key/inverseKey functions from the extension
-    let { resultExtension, sourceExtension } = parseExtensions(extension);
-    const keyFns = extensionKeyFunctions(sourceExtension, resultExtension);
-    keyFn = keyFns.key;
-    inverseKeyFn = keyFns.inverseKey;
-  } else if (keyFn) {
-    // Extend the key function to include a value parameter
-    keyFn = extendKeyFn(keyFn);
-  } else {
-    // Use sidecar key/inverseKey functions if the valueFn defines them
-    keyFn = /** @type {any} */ (valueFn)?.key;
-    inverseKeyFn = /** @type {any} */ (valueFn)?.inverseKey;
-  }
-
-  if (keyFn && !inverseKeyFn) {
-    // Only keyFn was provided, so we need to generate the inverseKeyFn
-    const keyFns = cachedKeyFunctions(keyFn, deep);
-    keyFn = keyFns.key;
-    inverseKeyFn = keyFns.inverseKey;
+  if (!extension) {
+    if (keyFn) {
+      // Extend the key function to include a value parameter
+      keyFn = extendKeyFn(keyFn);
+    }
   }
 
   return {
     deep,
     description,
+    extension,
     inverseKey: inverseKeyFn,
     key: keyFn,
     needsSourceValue,

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";

package/src/tree/parseExtensions.js

@@ -1,44 +0,0 @@
-/**
- * Given a string specifying an extension or a mapping of one extension to another,
- * return the source and result extensions.
- *
- * Syntax:
- *   .foo           source and result extension are the same
- *   .foo→.bar      Unicode Rightwards Arrow
- *   .foo→          Unicode Rightwards Arrow, no result extension
- *   →.bar          Unicode Rightwards Arrow, no source extension
- *   .foo->.bar     hyphen and greater-than sign
- *
- * @param {string} specifier
- */
-export default function parseExtensions(specifier) {
-  const lowercase = specifier?.toLowerCase() ?? "";
-  const extensionRegex =
-    /^((?<sourceExtension>\/|\.\S*)?\s*(→|->)\s*(?<resultExtension>\/|\.\S*)?)|(?<extension>\/|\.\S*)$/;
-  const match = lowercase.match(extensionRegex);
-  if (!match) {
-    throw new Error(`Invalid file extension specifier "${specifier}".`);
-  }
-
-  // @ts-ignore
-  let { extension, resultExtension, sourceExtension } = match.groups;
-  if (extension) {
-    // foo
-    return {
-      resultExtension: extension,
-      sourceExtension: extension,
-    };
-  } else {
-    // foo→bar
-
-    if (resultExtension === undefined && sourceExtension === undefined) {
-      throw new Error(
-        `A file extension mapping must indicate a source or result extension: "${specifier}".`
-      );
-    }
-
-    resultExtension ??= "";
-    sourceExtension ??= "";
-    return { resultExtension, sourceExtension };
-  }
-}