@weborigami/origami 0.5.3 → 0.5.5

package/src/common/ConstantTree.js

@@ -1,18 +0,0 @@
-/**
- * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
- * @implements {AsyncTree}
- */
-export default class ConstantTree {
-  constructor(value) {
-    this.value = value;
-    this.parent = null;
-  }
-
-  async get(key) {
-    return this.value;
-  }
-
-  async keys() {
-    return [];
-  }
-}

package/src/protocols/js.js

@@ -1,13 +0,0 @@
-import { Tree } from "@weborigami/async-tree";
-import { attachWarning, jsGlobals } from "@weborigami/language";
-
-/**
- * @this {import("@weborigami/types").AsyncTree}
- */
-export default async function js(...keys) {
-  const result = await Tree.traverseOrThrow.call(this, jsGlobals, ...keys);
-  return attachWarning(
-    result,
-    "The js:<name> protocol is deprecated. Drop the js: and just use <name> instead."
-  );
-}

package/src/tree/addNextPrevious.js

@@ -1,22 +0,0 @@
-import { addNextPrevious, symbols } from "@weborigami/async-tree";
-import getTreeArgument from "../common/getTreeArgument.js";
-
-/**
- * Add nextKey/previousKey properties to values.
- *
- * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
- *
- * @this {AsyncTree|null}
- * @param {import("@weborigami/async-tree").Treelike} treelike
- */
-export default async function addNextPreviousBuiltin(treelike) {
-  const tree = await getTreeArgument(
-    this,
-    arguments,
-    treelike,
-    "addNextPrevious"
-  );
-  const result = await addNextPrevious(tree);
-  result[symbols.parent] = this;
-  return result;
-}

package/src/tree/cache.js

@@ -1,22 +0,0 @@
-import { Tree, cache } from "@weborigami/async-tree";
-import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
-
-/**
- * Caches tree values in a storable cache.
- *
- * @typedef  {import("@weborigami/types").AsyncTree} AsyncTree
- * @typedef  {import("@weborigami/types").AsyncMutableTree} AsyncMutableTree
- * @typedef {import("@weborigami/async-tree").Treelike} Treelike
- * @param {Treelike} sourceTreelike
- * @param {Treelike} [cacheTreelike]
- * @this {AsyncTree|null}
- */
-export default async function cacheBuiltin(sourceTreelike, cacheTreelike) {
-  assertTreeIsDefined(this, "cache");
-  /** @type {any} */
-  const cacheTree = cacheTreelike
-    ? Tree.from(cacheTreelike, { parent: this })
-    : undefined;
-  const result = cache(sourceTreelike, cacheTree);
-  return result;
-}

package/src/tree/calendar.js

@@ -1 +0,0 @@
-export { calendarTree as default } from "@weborigami/async-tree";

package/src/tree/clear.js

@@ -1,19 +0,0 @@
-import { Tree } from "@weborigami/async-tree";
-import getTreeArgument from "../common/getTreeArgument.js";
-
-/**
- * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
- *
- * @this {AsyncTree|null}
- * @param {import("@weborigami/async-tree").Treelike} treelike
- */
-export default async function clear(treelike) {
-  const tree = await getTreeArgument(this, arguments, treelike, "clear");
-  if (!Tree.isAsyncMutableTree(tree)) {
-    throw new TypeError("clean: the given tree is read-only.");
-  }
-  const keys = Array.from(await tree.keys());
-  const promises = keys.map((key) => tree.set(key, undefined));
-  await Promise.all(promises);
-  return tree;
-}

package/src/tree/concat.js

@@ -1,17 +0,0 @@
-import { Tree } from "@weborigami/async-tree";
-import { ops } from "@weborigami/language";
-import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
-
-/**
- * Concatenate the text content of objects or trees.
- *
- * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
- *
- * @this {AsyncTree|null}
- * @param {any[]} args
- */
-export default async function concat(...args) {
-  assertTreeIsDefined(this, "concat");
-  const tree = args.length === 0 ? this : Tree.from(args, { parent: this });
-  return ops.concat.call(this, tree);
-}

package/src/tree/constant.js

@@ -1 +0,0 @@
-export { constantTree as default } from "@weborigami/async-tree";

package/src/tree/deepMap.js

@@ -1,32 +0,0 @@
-import { isPlainObject } from "@weborigami/async-tree";
-import getTreeArgument from "../common/getTreeArgument.js";
-import map from "./map.js";
-
-/**
- * Shorthand for calling `map` with `deep: true` option.
- *
- * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
- * @typedef {import("@weborigami/async-tree").Treelike} Treelike
- * @typedef {import("@weborigami/async-tree").ValueKeyFn} ValueKeyFn
- * @typedef {import("./map.d.ts").TreeMapOptions} TreeMapOptions
- *
- * @this {AsyncTree|null}
- * @param {Treelike} treelike
- * @param {ValueKeyFn|TreeMapOptions} operation
- */
-export default async function deepMap(treelike, operation) {
-  const tree = await getTreeArgument(
-    this,
-    arguments,
-    treelike,
-    "deepMap",
-    true
-  );
-  /** @type {TreeMapOptions} */
-  const options = isPlainObject(operation)
-    ? // Dictionary
-      { ...operation, deep: true }
-    : // Function
-      { deep: true, value: operation };
-  return map.call(this, tree, options);
-}

package/src/tree/deepMerge.js

@@ -1,18 +0,0 @@
-import { deepMerge } from "@weborigami/async-tree";
-import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
-
-/**
- * Create a tree that's the result of deep merging the given trees.
- *
- * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
- * @typedef {import("@weborigami/async-tree").Treelike} Treelike
- * @this {AsyncTree|null}
- * @param {Treelike[]} trees
- */
-export default async function treeDeepMerge(...trees) {
-  assertTreeIsDefined(this, "deepMerge");
-  // Merge the trees.
-  const result = deepMerge(...trees);
-  result.parent = this;
-  return result;
-}

package/src/tree/deepReverse.js

@@ -1,23 +0,0 @@
-import { deepReverse } from "@weborigami/async-tree";
-import getTreeArgument from "../common/getTreeArgument.js";
-
-/**
- * Reverse the order of keys at all levels of the tree.
- *
- * @typedef  {import("@weborigami/types").AsyncTree} AsyncTree
- * @typedef {import("@weborigami/async-tree").Treelike} Treelike
- *
- * @this {AsyncTree|null}
- * @param {Treelike} [treelike]
- */
-export default async function deepReverseBuiltin(treelike) {
-  const tree = await getTreeArgument(
-    this,
-    arguments,
-    treelike,
-    "deepReverse",
-    true
-  );
-  const reversed = deepReverse(tree);
-  return reversed;
-}

package/src/tree/deepTake.js

@@ -1,26 +0,0 @@
-import { deepTake as deepTakeTransform } from "@weborigami/async-tree";
-import getTreeArgument from "../common/getTreeArgument.js";
-
-/**
- * Returns a function that traverses a tree deeply and returns the values of the
- * first `count` keys.
- *
- * @typedef  {import("@weborigami/types").AsyncTree} AsyncTree
- * @typedef {import("@weborigami/async-tree").Treelike} Treelike
- *
- * @this {AsyncTree|null}
- * @param {Treelike} treelike
- * @param {number} count
- */
-export default async function deepTake(treelike, count) {
-  const tree = await getTreeArgument(
-    this,
-    arguments,
-    treelike,
-    "deepTake",
-    true
-  );
-  const taken = await deepTakeTransform(tree, count);
-  taken.parent = this;
-  return taken;
-}

package/src/tree/deepValues.js

@@ -1,22 +0,0 @@
-import { deepValues } from "@weborigami/async-tree";
-import getTreeArgument from "../common/getTreeArgument.js";
-
-/**
- * Return the in-order exterior values of a tree as a flat array.
- *
- * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
- * @typedef {import("@weborigami/async-tree").Treelike} Treelike
- *
- * @this {AsyncTree|null}
- * @param {Treelike} [treelike]
- */
-export default async function deepValuesBuiltin(treelike) {
-  const tree = await getTreeArgument(
-    this,
-    arguments,
-    treelike,
-    "deepValues",
-    true
-  );
-  return deepValues(tree);
-}

package/src/tree/defineds.js

@@ -1,30 +0,0 @@
-import { Tree } from "@weborigami/async-tree";
-import getTreeArgument from "../common/getTreeArgument.js";
-
-/**
- * Return only the defined (not `undefined`) values in the tree.
- *
- * @typedef  {import("@weborigami/types").AsyncTree} AsyncTree
- * @typedef {import("@weborigami/async-tree").Treelike} Treelike
- *
- * @this {AsyncTree|null}
- * @param {Treelike} treelike
- */
-export default async function defineds(treelike) {
-  const tree = await getTreeArgument(this, arguments, treelike, "defineds");
-
-  const result = await Tree.mapReduce(tree, null, async (values, keys) => {
-    const object = {};
-    let someValuesExist = false;
-    for (let i = 0; i < keys.length; i++) {
-      const value = values[i];
-      if (value != null) {
-        someValuesExist = true;
-        object[keys[i]] = values[i];
-      }
-    }
-    return someValuesExist ? object : null;
-  });
-
-  return result;
-}

package/src/tree/filter.js

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

package/src/tree/first.js

@@ -1,19 +0,0 @@
-import getTreeArgument from "../common/getTreeArgument.js";
-
-/**
- * Return the first value in the tree.
- *
- * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
- * @typedef {import("@weborigami/async-tree").Treelike} Treelike
- * @this {AsyncTree|null}
- * @param {Treelike} [treelike]
- */
-export default async function first(treelike) {
-  const tree = await getTreeArgument(this, arguments, treelike, "first");
-  for (const key of await tree.keys()) {
-    // Just return first value immediately.
-    const value = await tree.get(key);
-    return value;
-  }
-  return undefined;
-}

package/src/tree/fromFn.js

@@ -1,29 +0,0 @@
-import { FunctionTree, isUnpackable } from "@weborigami/async-tree";
-import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
-import { toFunction } from "../common/utilities.js";
-
-/**
- * Create a tree from a function and a set of keys.
- *
- * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
- * @typedef {import("@weborigami/async-tree").Treelike} Treelike
- * @typedef {import("../../index.ts").Invocable} Invocable
- *
- * @this {AsyncTree|null}
- * @param {Invocable} [invocable]
- */
-export default async function fromFn(invocable, keys = []) {
-  assertTreeIsDefined(this, "fromFn");
-  if (invocable === undefined) {
-    throw new Error(
-      "An Origami function was called with an initial argument, but its value is undefined."
-    );
-  }
-  const fn = toFunction(invocable);
-  if (isUnpackable(keys)) {
-    keys = await keys.unpack();
-  }
-  const tree = new FunctionTree(fn, keys);
-  tree.parent = this;
-  return tree;
-}

package/src/tree/globKeys.js

@@ -1,19 +0,0 @@
-import { setParent } from "@weborigami/async-tree";
-import globKeys from "@weborigami/async-tree/src/operations/globKeys.js";
-import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
-
-/**
- * Define a tree whose keys are globs.
- *
- * @typedef  {import("@weborigami/types").AsyncTree} AsyncTree
- * @typedef {import("@weborigami/async-tree").Treelike} Treelike
- *
- * @param {Treelike} tree
- * @this {AsyncTree|null}
- */
-export default async function globKeysBuiltin(tree) {
-  assertTreeIsDefined(this, "globs");
-  const result = globKeys(tree);
-  setParent(this, result);
-  return result;
-}

package/src/tree/group.js

@@ -1,26 +0,0 @@
-import { group as groupTransform } from "@weborigami/async-tree";
-import getTreeArgument from "../common/getTreeArgument.js";
-import { toFunction } from "../common/utilities.js";
-
-/**
- * Map a tree to a new tree with the values from the original tree grouped by
- * the given function.
- *
- * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
- *
- * @this {AsyncTree|null}
- * @param {import("@weborigami/async-tree").Treelike} treelike
- * @param {import("../../index.ts").Invocable} groupKey
- */
-export default async function groupBuiltin(treelike, groupKey) {
-  const tree = await getTreeArgument(this, arguments, treelike, "group");
-
-  const groupKeyFn = toFunction(groupKey);
-  // Have the group key function run in this tree.
-  const extendedGroupKeyFn = groupKeyFn.bind(tree);
-
-  // @ts-ignore
-  const grouped = await groupTransform(tree, extendedGroupKeyFn);
-  grouped.parent = tree;
-  return grouped;
-}

package/src/tree/inners.js

@@ -1,30 +0,0 @@
-import { trailingSlash, Tree } from "@weborigami/async-tree";
-import getTreeArgument from "../common/getTreeArgument.js";
-
-/**
- * Return the interior nodes of the tree. This relies on subtree keys having
- * trailing slashes.
- *
- * @typedef  {import("@weborigami/types").AsyncTree} AsyncTree
- * @typedef {import("@weborigami/async-tree").Treelike} Treelike
- * @this {AsyncTree|null}
- * @param {Treelike} [treelike]
- */
-export default async function inners(treelike) {
-  const tree = await getTreeArgument(this, arguments, treelike, "inners");
-
-  const result = {
-    async get(key) {
-      const value = await tree.get(key);
-      return Tree.isAsyncTree(value) ? inners.call(this, value) : undefined;
-    },
-
-    async keys() {
-      const keys = [...(await tree.keys())];
-      const subtreeKeys = keys.filter(trailingSlash.has);
-      return subtreeKeys;
-    },
-  };
-
-  return result;
-}

package/src/tree/keys.js

@@ -1,15 +0,0 @@
-import getTreeArgument from "../common/getTreeArgument.js";
-
-/**
- * Return the top-level keys in the tree as an array.
- *
- * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
- * @typedef {import("@weborigami/async-tree").Treelike} Treelike
- * @this {AsyncTree|null}
- * @param {Treelike} [treelike]
- */
-export default async function keys(treelike) {
-  const tree = await getTreeArgument(this, arguments, treelike, "keys");
-  const keys = await tree.keys();
-  return Array.from(keys);
-}

package/src/tree/length.js

@@ -1,15 +0,0 @@
-import getTreeArgument from "../common/getTreeArgument.js";
-
-/**
- * Return the number of keys in the tree.
- *
- * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
- * @typedef {import("@weborigami/async-tree").Treelike} Treelike
- * @this {AsyncTree|null}
- * @param {Treelike} [treelike]
- */
-export default async function length(treelike) {
-  const tree = await getTreeArgument(this, arguments, treelike, "length");
-  const keys = Array.from(await tree.keys());
-  return keys.length;
-}

package/src/tree/map.d.ts

@@ -1,11 +0,0 @@
-import { TreeMapOptions as AsyncTreeMapOptions, Treelike, ValueKeyFn } from "@weborigami/async-tree";
-import { AsyncTree } from "@weborigami/types";
-
-/* Add more properties to TreeMapOptions */
-type TreeMapOptions = AsyncTreeMapOptions &{
-  description?: string;
-  extension?: string;
-  needsSourceValue?: boolean;
-};
-
-export default function treeMap(treelike: Treelike, options: ValueKeyFn | TreeMapOptions): AsyncTree;

package/src/tree/map.js

@@ -1,125 +0,0 @@
-import {
-  isPlainObject,
-  isUnpackable,
-  map as mapTransform,
-} from "@weborigami/async-tree";
-import getTreeArgument from "../common/getTreeArgument.js";
-import { toFunction } from "../common/utilities.js";
-
-/**
- * Map a hierarchical tree of keys and values to a new tree of keys and values.
- *
- * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
- * @typedef {import("@weborigami/async-tree").Treelike} Treelike
- * @typedef {import("@weborigami/async-tree").ValueKeyFn} ValueKeyFn
- * @typedef {import("./map.js").TreeMapOptions} TreeMapOptions
- *
- * @this {AsyncTree|null}
- * @param {Treelike} treelike
- * @param {ValueKeyFn|TreeMapOptions} operation
- */
-export default async function map(treelike, operation) {
-  if (isUnpackable(operation)) {
-    operation = await operation.unpack();
-  }
-  // The tree in which the map operation happens
-  const context = this;
-  const options = extendedOptions(context, operation);
-
-  // The tree we're going to map
-  const source = await getTreeArgument(
-    this,
-    arguments,
-    treelike,
-    "map",
-    options?.deep
-  );
-
-  const mapped = mapTransform(source, options);
-  mapped.parent = context;
-  return mapped;
-}
-
-/**
- * Return a function that transforms a tree of keys and values to a new tree of
- * keys and values.
- *
- * @param {AsyncTree|null} context
- * @param {ValueKeyFn|TreeMapOptions} operation
- */
-function extendedOptions(context, operation) {
-  // Identify whether the map instructions take the form of a value function or
-  // a dictionary of options.
-  /** @type {TreeMapOptions} */
-  let options;
-  /** @type {ValueKeyFn|undefined} */
-  let valueFn;
-  if (isPlainObject(operation)) {
-    // @ts-ignore
-    options = operation;
-    if (`value` in options && !options.value) {
-      throw new TypeError(`map: The value function is not defined.`);
-    }
-    valueFn = options?.value;
-  } else if (
-    typeof operation === "function" ||
-    typeof (/** @type {any} */ (operation)?.unpack) === "function"
-  ) {
-    valueFn = operation;
-    options = {};
-  } else if (operation === undefined) {
-    /** @type {any} */
-    const error = new TypeError(`map: The second parameter was undefined.`);
-    error.position = 1;
-    throw error;
-  } else {
-    throw new TypeError(
-      `map: You must specify a value function or options dictionary as the second parameter.`
-    );
-  }
-
-  const { deep, extension, needsSourceValue } = options;
-  const description = options.description ?? `map ${extension ?? ""}`;
-  let keyFn = options.key;
-  let inverseKeyFn = options.inverseKey;
-
-  if (valueFn) {
-    // @ts-ignore
-    valueFn = toFunction(valueFn);
-    // By default, run the value function in the context of this tree so that
-    // 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) {
-    if (keyFn) {
-      // Extend the key function to include a value parameter
-      keyFn = extendKeyFn(keyFn);
-    }
-  }
-
-  return {
-    deep,
-    description,
-    extension,
-    inverseKey: inverseKeyFn,
-    key: keyFn,
-    needsSourceValue,
-    value: valueFn,
-  };
-}
-
-// Extend the key function to include a value parameter
-function extendKeyFn(keyFn) {
-  keyFn = toFunction(keyFn);
-  return async function keyWithValueFn(sourceKey, sourceTree) {
-    const sourceValue = await sourceTree.get(sourceKey);
-    const resultKey = await keyFn(sourceValue, sourceKey, sourceTree);
-    return resultKey;
-  };
-}

package/src/tree/mask.js

@@ -1,19 +0,0 @@
-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, "mask");
-  const result = mask(sourceTreelike, maskTreelike);
-  result.parent = this;
-  return result;
-}