@weborigami/origami 0.5.4 → 0.5.6

package/src/origami/config.js

@@ -1,18 +0,0 @@
-import project from "./project.js";
-
-/**
- * Return the configuration for the current project.
- *
- * The configuration is the project's config.ori file (if defined in the project
- * root) plus the Origami builtins.
- *
- * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
- *
- * @this {AsyncTree|null}
- * @param {any} [key]
- */
-export default async function config(key) {
-  const projectTree = await project.call(this);
-  const projectConfig = projectTree.config;
-  return key === undefined ? projectConfig : projectConfig[key];
-}

package/src/origami/project.js

@@ -1,111 +0,0 @@
-/** @typedef {import("@weborigami/types").AsyncTree} AsyncTree */
-import { OrigamiFiles } from "@weborigami/language";
-import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
-import handlerBuiltins from "../handlers/handlerBuiltins.js";
-import { oriHandler } from "../handlers/handlers.js";
-
-const configFileName = "config.ori";
-
-/**
- * Return an object for the current project including
- *
- * `config`: the evaluated config.ori file
- * `root`: the project's root folder
- *
- * This searches the current directory and its ancestors for an Origami file
- * called `config.ori`. If an Origami configuration file is found, the
- * containing folder is considered to be the project root. This returns a tree
- * for that folder, with the exported configuration as the context for that
- * folder — that is, the tree exported by the configuration will be the scope.
- *
- * If no Origami configuration file is found, the current folder will be
- * returned as a tree, with the builtins as its parent.
- *
- * @this {AsyncTree|null}
- */
-export default async function project() {
-  assertTreeIsDefined(this, "project");
-
-  const dirname = process.cwd();
-  const currentTree = new OrigamiFiles(dirname);
-  let config;
-
-  // Search up the tree for the configuration file or package.json to determine
-  // the project root.
-  let root;
-  const foundConfig = await findAncestorFile(currentTree, configFileName);
-  if (foundConfig) {
-    root = foundConfig.container;
-    // Attach standard extension handlers so config can use them
-    root.handlers = handlerBuiltins();
-    // Unpack Origami configuration file
-    const buffer = foundConfig.value;
-    config = await oriHandler.unpack(buffer, {
-      key: configFileName,
-      parent: root,
-    });
-    root.config = config;
-  } else {
-    // No Origami configuration file, look for package.json
-    const foundPackageJson = await findAncestorFile(
-      currentTree,
-      "package.json"
-    );
-    if (foundPackageJson) {
-      // Found package.json; use its parent as the project root
-      root = foundPackageJson.container;
-    } else {
-      // No package.json found; use the current directory as root
-      root = currentTree;
-    }
-  }
-
-  // Merge config if present into handlers
-  root.handlers = config
-    ? {
-        ...handlerBuiltins(),
-        ...configHandlers(config),
-      }
-    : handlerBuiltins();
-
-  return root;
-}
-
-// Find the first ancestor of the given folder that contains a file with the
-// given name. Return the container and the file contents.
-async function findAncestorFile(start, fileName) {
-  let container = start;
-  while (container) {
-    const value = await container.get(fileName);
-    if (value) {
-      // Found the desired file
-      return {
-        container,
-        value,
-      };
-    }
-    // Not found; try the parent
-    const parent = await container.get("..");
-    if (
-      !parent ||
-      (parent.path && container.path && parent.path === container.path)
-    ) {
-      break;
-    }
-    container = parent;
-  }
-
-  // Not found
-  return null;
-}
-
-// Return an object with all `.handler` keys from the config
-function configHandlers(config) {
-  const handlers = {};
-  for (const key in config) {
-    if (key.endsWith(".handler")) {
-      handlers[key] = config[key];
-    }
-  }
-  return handlers;
-}

package/src/protocols/explore.js

@@ -1,19 +0,0 @@
-import { ExplorableSiteTree } from "@weborigami/async-tree";
-import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
-import constructSiteTree from "../common/constructSiteTree.js";
-
-/**
- * A site tree with JSON Keys via HTTPS.
- *
- * @typedef  {import("@weborigami/types").AsyncTree} AsyncTree
- * @typedef {import("@weborigami/async-tree").Treelike} Treelike
- * @typedef {import("../../index.ts").Invocable} Invocable
- *
- * @this {AsyncTree|null}
- * @param {string} host
- * @param  {...string} keys
- */
-export default function explore(host, ...keys) {
-  assertTreeIsDefined(this, "explore");
-  return constructSiteTree("https:", ExplorableSiteTree, this, host, ...keys);
-}

package/src/protocols/files.js

@@ -1,31 +0,0 @@
-import { OrigamiFiles, getHandlers } from "@weborigami/language";
-import os from "node:os";
-import path from "node:path";
-import process from "node:process";
-import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
-
-/**
- * @typedef  {import("@weborigami/types").AsyncTree} AsyncTree
- *
- * @this {AsyncTree|null}
- * @param {string[]} keys
- */
-export default async function files(...keys) {
-  assertTreeIsDefined(this, "files");
-
-  // If path begins with `~`, treat it relative to the home directory.
-  // Otherwise, treat it relative to the current working directory.
-  let relativePath = keys.join(path.sep);
-  let basePath;
-  if (relativePath.startsWith("~")) {
-    basePath = os.homedir();
-    relativePath = relativePath.slice(2);
-  } else {
-    basePath = process.cwd();
-  }
-  const resolved = path.resolve(basePath, relativePath);
-
-  const result = new OrigamiFiles(resolved);
-  /** @type {any} */ (result).handlers = getHandlers(this);
-  return result;
-}

package/src/protocols/http.js

@@ -1,18 +0,0 @@
-import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
-import constructHref from "../common/constructHref.js";
-import fetchAndHandleExtension from "../common/fetchAndHandleExtension.js";
-
-/**
- * Retrieve the indicated web resource via HTTP.
- *
- * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
- *
- * @this {AsyncTree|null}
- * @param {string} host
- * @param  {...string} keys
- */
-export default async function http(host, ...keys) {
-  assertTreeIsDefined(this, "http");
-  const href = constructHref("http:", host, ...keys);
-  return fetchAndHandleExtension.call(this, href);
-}

package/src/protocols/https.js

@@ -1,18 +0,0 @@
-import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
-import constructHref from "../common/constructHref.js";
-import fetchAndHandleExtension from "../common/fetchAndHandleExtension.js";
-
-/**
- * Retrieve the indicated web resource via HTTPS.
- *
- * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
- *
- * @this {AsyncTree|null}
- * @param {string} host
- * @param  {...string} keys
- */
-export default async function https(host, ...keys) {
-  assertTreeIsDefined(this, "https");
-  const href = constructHref("https:", host, ...keys);
-  return fetchAndHandleExtension.call(this, href);
-}

package/src/protocols/httpstree.js

@@ -1,19 +0,0 @@
-import { SiteTree } from "@weborigami/async-tree";
-import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
-import constructSiteTree from "../common/constructSiteTree.js";
-
-/**
- * Return a website tree via HTTPS.
- *
- * @typedef  {import("@weborigami/types").AsyncTree} AsyncTree
- * @typedef {import("@weborigami/async-tree").Treelike} Treelike
- * @typedef {import("../../index.ts").Invocable} Invocable
- *
- * @this {AsyncTree|null}
- * @param {string} host
- * @param  {...string} keys
- */
-export default function httpstree(host, ...keys) {
-  assertTreeIsDefined(this, "treehttps");
-  return constructSiteTree("https:", SiteTree, this, host, ...keys);
-}

package/src/protocols/httptree.js

@@ -1,19 +0,0 @@
-import { SiteTree } from "@weborigami/async-tree";
-import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
-import constructSiteTree from "../common/constructSiteTree.js";
-
-/**
- * Return a website tree via HTTP.
- *
- * @typedef  {import("@weborigami/types").AsyncTree} AsyncTree
- * @typedef {import("@weborigami/async-tree").Treelike} Treelike
- * @typedef {import("../../index.ts").Invocable} Invocable
- *
- * @this {AsyncTree|null}
- * @param {string} host
- * @param  {...string} keys
- */
-export default function httptree(host, ...keys) {
-  assertTreeIsDefined(this, "httptree");
-  return constructSiteTree("http:", SiteTree, this, host, ...keys);
-}

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/protocols/node.js

@@ -1,13 +0,0 @@
-import { trailingSlash, Tree } from "@weborigami/async-tree";
-
-/**
- * The node: protocol does a dynamic import from the `node:` namespace.
- *
- * @param {string[]} keys
- */
-export default async function node(...keys) {
-  const key = keys.shift();
-  const normalized = trailingSlash.remove(key);
-  const module = await import(`node:${normalized}`);
-  return keys.length > 0 ? Tree.traverse(module, ...keys) : module;
-}

package/src/protocols/package.js

@@ -1,70 +0,0 @@
-import { Tree, keysFromPath, scope } from "@weborigami/async-tree";
-import project from "../origami/project.js";
-
-/**
- * @this {import("@weborigami/types").AsyncTree|null}
- * @param {string[]} keys
- */
-export default async function packageNamespace(...keys) {
-  const parent = this ?? (await project.call(null));
-
-  let name = keys.shift();
-  let organization;
-  if (name?.startsWith("@")) {
-    // First key is an npm organization
-    organization = name;
-    if (keys.length === 0) {
-      // Return a function that will process the next key
-      return async (name, ...keys) =>
-        getPackage(parent, organization, name, keys);
-    }
-    name = keys.shift();
-  }
-
-  return getPackage(parent, organization, name, keys);
-}
-
-async function getPackage(parent, organization, name, keys) {
-  const packagePath = ["node_modules"];
-  if (organization) {
-    packagePath.push(organization);
-  }
-  packagePath.push(name);
-
-  const parentScope = scope(parent);
-  const packageRoot = await Tree.traverse(
-    // @ts-ignore
-    parentScope,
-    ...packagePath
-  );
-
-  if (!packageRoot) {
-    throw new Error(`Can't find ${packagePath.join("/")}`);
-  }
-
-  const mainPath = await Tree.traverse(packageRoot, "package.json", "main");
-  if (!mainPath) {
-    throw new Error(
-      `node_modules/${keys.join(
-        "/"
-      )} doesn't contain a package.json with a "main" entry.`
-    );
-  }
-
-  const mainKeys = keysFromPath(mainPath);
-  const mainContainerKeys = mainKeys.slice(0, -1);
-  const mainFileName = mainKeys[mainKeys.length - 1];
-  const mainContainer = await Tree.traverse(packageRoot, ...mainContainerKeys);
-  const packageExports = await mainContainer.import(mainFileName);
-
-  const result =
-    keys.length > 0
-      ? await Tree.traverse(packageExports, ...keys)
-      : packageExports;
-
-  if (Tree.isAsyncTree(result)) {
-    result.parent = parent;
-  }
-
-  return result;
-}

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