@weborigami/origami 0.0.59 → 0.0.61

package/src/builtins/@help.js

@@ -1,6 +1,6 @@
 /** @typedef {import("@weborigami/types").AsyncTree} AsyncTree */
 import child_process from "node:child_process";
-import assertScopeIsDefined from "../misc/assertScopeIsDefined.js";
+import assertTreeIsDefined from "../misc/assertTreeIsDefined.js";
 
 const groupUrls = {
   "@cache": "https://weborigami.org/language/@cache.html",
@@ -15,7 +15,7 @@ const groupUrls = {
  * @param {string} [name]
  */
 export default async function help(name) {
-  assertScopeIsDefined(this, "help");
+  assertTreeIsDefined(this, "help");
   let url;
   const scope = this;
   if (scope && name) {

package/src/builtins/@http.js

@@ -1,5 +1,5 @@
 import { ops } from "@weborigami/language";
-import assertScopeIsDefined from "../misc/assertScopeIsDefined.js";
+import assertTreeIsDefined from "../misc/assertTreeIsDefined.js";
 
 /**
  * Retrieve the indicated web resource via HTTP.
@@ -11,7 +11,7 @@ import assertScopeIsDefined from "../misc/assertScopeIsDefined.js";
  * @param  {...string} keys
  */
 export default async function http(host, ...keys) {
-  assertScopeIsDefined(this, "http");
+  assertTreeIsDefined(this, "http");
   return ops.http.call(this, host, ...keys);
 }
 

package/src/builtins/@https.js

@@ -1,5 +1,5 @@
 import { ops } from "@weborigami/language";
-import assertScopeIsDefined from "../misc/assertScopeIsDefined.js";
+import assertTreeIsDefined from "../misc/assertTreeIsDefined.js";
 
 /**
  * Retrieve the indicated web resource via HTTPS.
@@ -11,7 +11,7 @@ import assertScopeIsDefined from "../misc/assertScopeIsDefined.js";
  * @param  {...string} keys
  */
 export default async function https(host, ...keys) {
-  assertScopeIsDefined(this, "https");
+  assertTreeIsDefined(this, "https");
   return ops.https.call(this, host, ...keys);
 }
 

package/src/builtins/@if.js

@@ -1,6 +1,6 @@
 /** @typedef {import("@weborigami/types").AsyncTree} AsyncTree */
 import { Tree } from "@weborigami/async-tree";
-import assertScopeIsDefined from "../misc/assertScopeIsDefined.js";
+import assertTreeIsDefined from "../misc/assertTreeIsDefined.js";
 
 /**
  * @this {AsyncTree|null}
@@ -9,7 +9,7 @@ import assertScopeIsDefined from "../misc/assertScopeIsDefined.js";
  * @param {any} [falseResult]
  */
 export default async function ifCommand(value, trueResult, falseResult) {
-  assertScopeIsDefined(this, "if");
+  assertTreeIsDefined(this, "if");
   let condition = await value;
   if (Tree.isAsyncTree(condition)) {
     const keys = Array.from(await condition.keys());

package/src/builtins/@image/format.js

@@ -1,4 +1,4 @@
-import assertScopeIsDefined from "../../misc/assertScopeIsDefined.js";
+import assertTreeIsDefined from "../../misc/assertTreeIsDefined.js";
 import imageFormatFn from "./formatFn.js";
 
 /**
@@ -13,6 +13,6 @@ import imageFormatFn from "./formatFn.js";
  * @param {any} options
  */
 export default async function imageFormat(input, format, options) {
-  assertScopeIsDefined(this, "image/format");
+  assertTreeIsDefined(this, "image/format");
   return imageFormatFn.call(this, format, options)(input);
 }

package/src/builtins/@image/formatFn.js

@@ -1,5 +1,5 @@
 import sharp from "sharp";
-import assertScopeIsDefined from "../../misc/assertScopeIsDefined.js";
+import assertTreeIsDefined from "../../misc/assertTreeIsDefined.js";
 
 /**
  * Return a function that transforms an input image to a different format.
@@ -10,6 +10,9 @@ import assertScopeIsDefined from "../../misc/assertScopeIsDefined.js";
  * @param {any} options
  */
 export default function imageFormatFn(format, options) {
-  assertScopeIsDefined(this, "image/formatFn");
-  return (buffer) => sharp(buffer).toFormat(format, options).toBuffer();
+  assertTreeIsDefined(this, "image/formatFn");
+  return (buffer) =>
+    buffer instanceof Uint8Array || buffer instanceof ArrayBuffer
+      ? sharp(buffer).toFormat(format, options).toBuffer()
+      : undefined;
 }

package/src/builtins/@image/resize.js

@@ -1,4 +1,4 @@
-import assertScopeIsDefined from "../../misc/assertScopeIsDefined.js";
+import assertTreeIsDefined from "../../misc/assertTreeIsDefined.js";
 import imageResizeFn from "./resizeFn.js";
 
 /**
@@ -9,6 +9,6 @@ import imageResizeFn from "./resizeFn.js";
  * @param {import("sharp").ResizeOptions} options
  */
 export default async function resize(input, options) {
-  assertScopeIsDefined(this, "image/resize");
+  assertTreeIsDefined(this, "image/resize");
   return imageResizeFn.call(this, options)(input);
 }

package/src/builtins/@image/resizeFn.js

@@ -1,5 +1,5 @@
 import sharp from "sharp";
-import assertScopeIsDefined from "../../misc/assertScopeIsDefined.js";
+import assertTreeIsDefined from "../../misc/assertTreeIsDefined.js";
 
 /**
  * Return a function that resizes an image.
@@ -8,7 +8,10 @@ import assertScopeIsDefined from "../../misc/assertScopeIsDefined.js";
  * @param {import("sharp").ResizeOptions} options
  */
 export default function imageResizeFn(options) {
-  assertScopeIsDefined(this, "image/resizeFn");
+  assertTreeIsDefined(this, "image/resizeFn");
   // Include `rotate()` to auto-rotate according to EXIF data.
-  return (buffer) => sharp(buffer).rotate().resize(options).toBuffer();
+  return (buffer) =>
+    buffer instanceof Uint8Array || buffer instanceof ArrayBuffer
+      ? sharp(buffer).rotate().resize(options).toBuffer()
+      : undefined;
 }

package/src/builtins/@inherited.js

@@ -1,6 +1,6 @@
 /** @typedef {import("@weborigami/types").AsyncTree} AsyncTree */
 import { ops } from "@weborigami/language";
-import assertScopeIsDefined from "../misc/assertScopeIsDefined.js";
+import assertTreeIsDefined from "../misc/assertTreeIsDefined.js";
 
 /**
  * Return the inherited value (if any) for the indicated key.
@@ -9,7 +9,7 @@ import assertScopeIsDefined from "../misc/assertScopeIsDefined.js";
  * @this {AsyncTree|null}
  */
 export default async function inherited(key) {
-  assertScopeIsDefined(this, "inherited");
+  assertTreeIsDefined(this, "inherited");
   return ops.inherited.call(this, key);
 }
 

package/src/builtins/@inline.js

@@ -1,8 +1,8 @@
-import { ObjectTree, isUnpackable, symbols } from "@weborigami/async-tree";
+import { isUnpackable, symbols } from "@weborigami/async-tree";
 import { compile } from "@weborigami/language";
 import documentObject from "../common/documentObject.js";
 import { toString } from "../common/utilities.js";
-import assertScopeIsDefined from "../misc/assertScopeIsDefined.js";
+import assertTreeIsDefined from "../misc/assertTreeIsDefined.js";
 import fileTypeOrigami from "./ori_handler.js";
 
 /**
@@ -16,7 +16,7 @@ import fileTypeOrigami from "./ori_handler.js";
  * @param {StringLike} input
  */
 export default async function inline(input) {
-  assertScopeIsDefined(this, "inline");
+  assertTreeIsDefined(this, "inline");
 
   // Get the input text and any attached front matter.
   if (isUnpackable(input)) {
@@ -25,12 +25,8 @@ export default async function inline(input) {
   const inputIsDocument = input["@text"] !== undefined;
   const origami = inputIsDocument ? input["@text"] : toString(input);
 
-  let parent = /** @type {any} */ (input).parent ?? input[symbols.parent];
-  if (!parent) {
-    // Construct a temporary parent that has the right scope.
-    parent = new ObjectTree({});
-    parent.scope = this;
-  }
+  const parent =
+    /** @type {any} */ (input).parent ?? input[symbols.parent] ?? this;
 
   // If the input document is a plain object, include it in scope for the
   // evaluated expression.

package/src/builtins/@inners.js

@@ -12,7 +12,6 @@ import getTreeArgument from "../misc/getTreeArgument.js";
 export default async function inners(treelike) {
   const tree = await getTreeArgument(this, arguments, treelike, "@inners");
 
-  /** @type {AsyncTree} */
   const result = {
     async get(key) {
       const value = await tree.get(key);

package/src/builtins/@invoke.js

@@ -1,6 +1,5 @@
 import { isUnpackable } from "@weborigami/async-tree";
-import assertScopeIsDefined from "../misc/assertScopeIsDefined.js";
-import builtins from "./@builtins.js";
+import assertTreeIsDefined from "../misc/assertTreeIsDefined.js";
 
 /**
  * Invoke the given text as an Origami function.
@@ -24,9 +23,8 @@ import builtins from "./@builtins.js";
  * @this {import("@weborigami/types").AsyncTree|null}
  */
 export default async function invoke(fn) {
-  assertScopeIsDefined(this, "invoke");
-  // A fragment of the logic from getTreeArgument.js
-  if (arguments.length > 0 && fn === undefined) {
+  assertTreeIsDefined(this, "invoke");
+  if (fn === undefined) {
     throw new Error(
       "An Origami function was called with an initial argument, but its value is undefined."
     );
@@ -34,6 +32,5 @@ export default async function invoke(fn) {
   if (isUnpackable(fn)) {
     fn = await fn.unpack();
   }
-  const scope = (await this?.get("@current")) ?? builtins;
-  return typeof fn === "function" ? fn.call(scope) : fn;
+  return typeof fn === "function" ? fn.call(this) : fn;
 }

package/src/builtins/@json.js

@@ -1,6 +1,6 @@
 /** @typedef {import("@weborigami/types").AsyncTree} AsyncTree */
 import { isUnpackable, toPlainValue } from "@weborigami/async-tree";
-import assertScopeIsDefined from "../misc/assertScopeIsDefined.js";
+import assertTreeIsDefined from "../misc/assertTreeIsDefined.js";
 
 /**
  * Render the given object in JSON format.
@@ -9,14 +9,14 @@ import assertScopeIsDefined from "../misc/assertScopeIsDefined.js";
  * @param {any} [obj]
  */
 export default async function json(obj) {
-  assertScopeIsDefined(this, "json");
+  assertTreeIsDefined(this, "json");
   // A fragment of the logic from getTreeArgument.js
   if (arguments.length > 0 && obj === undefined) {
     throw new Error(
       "An Origami function was called with an initial argument, but its value is undefined."
     );
   }
-  obj = obj ?? (await this?.get("@current"));
+  obj = obj ?? this;
   if (obj === undefined) {
     return undefined;
   }

package/src/builtins/@map.js

@@ -1,4 +1,4 @@
-import assertScopeIsDefined from "../misc/assertScopeIsDefined.js";
+import assertTreeIsDefined from "../misc/assertTreeIsDefined.js";
 import mapFn from "./@mapFn.js";
 
 /**
@@ -14,6 +14,6 @@ import mapFn from "./@mapFn.js";
  * @param {ValueKeyFn|TreeMapOptions} operation
  */
 export default function map(source, operation) {
-  assertScopeIsDefined(this, "map");
+  assertTreeIsDefined(this, "map");
   return mapFn.call(this, operation)(source);
 }

package/src/builtins/@mapFn.js

@@ -4,9 +4,8 @@ import {
   keyFunctionsForExtensions,
   mapFn,
 } from "@weborigami/async-tree";
-import { Scope } from "@weborigami/language";
 import { toFunction } from "../common/utilities.js";
-import assertScopeIsDefined from "../misc/assertScopeIsDefined.js";
+import assertTreeIsDefined from "../misc/assertTreeIsDefined.js";
 
 /**
  * Return a function that transforms a tree of keys and values to a new tree of
@@ -21,8 +20,8 @@ import assertScopeIsDefined from "../misc/assertScopeIsDefined.js";
  * @param {ValueKeyFn|TreeMapOptions} operation
  */
 export default function mapFnBuiltin(operation) {
-  assertScopeIsDefined(this, "map");
-  const scope = this;
+  assertTreeIsDefined(this, "map");
+  const tree = this;
 
   // Identify whether the map instructions take the form of a value function or
   // a dictionary of options.
@@ -63,11 +62,11 @@ export default function mapFnBuiltin(operation) {
   let extendedValueFn;
   if (valueFn) {
     const resolvedValueFn = toFunction(valueFn);
-    // Have the value function run in this scope.
-    extendedValueFn = resolvedValueFn.bind(scope);
+    // Have the value function run in this tree.
+    extendedValueFn = resolvedValueFn.bind(tree);
   }
 
-  // Extend the value function to run in scope.
+  // Extend the key functions to run in this tree.
   let extendedKeyFn;
   let extendedInverseKeyFn;
   if (extension) {
@@ -83,7 +82,7 @@ export default function mapFnBuiltin(operation) {
     async function scopedKeyFn(sourceKey, tree) {
       const sourceValue = await tree.get(sourceKey);
       const resultKey = await resolvedKeyFn.call(
-        scope,
+        tree,
         sourceValue,
         sourceKey,
         tree
@@ -110,8 +109,8 @@ export default function mapFnBuiltin(operation) {
 
   return (treelike) => {
     const mapped = fn(treelike);
-    const scoped = Scope.treeWithScope(mapped, scope);
-    return scoped;
+    mapped.parent = tree;
+    return mapped;
   };
 }
 

package/src/builtins/@match.js

@@ -1,6 +1,5 @@
-import { Tree } from "@weborigami/async-tree";
-import { Scope } from "@weborigami/language";
-import assertScopeIsDefined from "../misc/assertScopeIsDefined.js";
+import { ObjectTree, Tree } from "@weborigami/async-tree";
+import assertTreeIsDefined from "../misc/assertTreeIsDefined.js";
 
 /**
  * Return a tree with the indicated keys (if provided).
@@ -20,13 +19,13 @@ import assertScopeIsDefined from "../misc/assertScopeIsDefined.js";
  * @typedef {import("@weborigami/async-tree").Treelike} Treelike
  * @typedef {import("../../index.ts").Invocable} Invocable
  *
+ * @this {AsyncTree|null}
  * @param {string|RegExp} pattern
  * @param {Invocable} resultFn
  * @param {Treelike} [keys]
- * @this {AsyncTree|null}
  */
 export default function match(pattern, resultFn, keys = []) {
-  assertScopeIsDefined(this, "match");
+  assertTreeIsDefined(this, "match");
   let regex;
   if (typeof pattern === "string") {
     // Convert the simple pattern format into a regular expression.
@@ -41,11 +40,9 @@ export default function match(pattern, resultFn, keys = []) {
     throw new Error(`match(): Unsupported pattern`);
   }
 
-  // Remember the scope used to invoke this function so we can extend it below.
-  const scope = this;
+  const tree = this;
 
-  /** @type {AsyncTree} */
-  let result = {
+  const result = {
     async get(key) {
       const keyMatch = regex.exec(key);
       if (!keyMatch) {
@@ -63,15 +60,20 @@ export default function match(pattern, resultFn, keys = []) {
       // If the pattern contained named wildcards, extend the scope. It appears
       // that the `groups` property of a match is *not* a real plain object, so
       // we have to make one.
-      const bindings = keyMatch.groups
-        ? Object.fromEntries(Object.entries(keyMatch.groups))
-        : null;
-      const fnScope = bindings ? new Scope(bindings, scope) : scope;
+      let target;
+      if (keyMatch.groups) {
+        target = new ObjectTree(
+          Object.fromEntries(Object.entries(keyMatch.groups))
+        );
+        target.parent = tree;
+      } else {
+        target = tree;
+      }
 
       // Invoke the result function with the extended scope.
       let value;
       if (typeof resultFn === "function") {
-        value = await resultFn.call(fnScope);
+        value = await resultFn.call(target);
       } else {
         value = Object.create(resultFn);
       }
@@ -80,11 +82,10 @@ export default function match(pattern, resultFn, keys = []) {
     },
 
     async keys() {
-      return typeof keys === "function" ? await keys.call(scope) : keys;
+      return typeof keys === "function" ? await keys.call(tree) : keys;
     },
   };
 
-  result = Scope.treeWithScope(result, this);
   return result;
 }
 

package/src/builtins/@mdHtml.js

@@ -6,6 +6,9 @@ import { markedHighlight } from "marked-highlight";
 import { markedSmartypants } from "marked-smartypants";
 import documentObject from "../common/documentObject.js";
 import { replaceExtension, toString } from "../common/utilities.js";
+import origamiHighlightDefinition from "../misc/origamiHighlightDefinition.js";
+
+highlight.registerLanguage("ori", origamiHighlightDefinition);
 
 marked.use(
   markedGfmHeadingId(),
@@ -39,7 +42,10 @@ export default async function mdHtml(input) {
     input = await input.unpack();
   }
   const inputIsDocument = input["@text"] !== undefined;
-  const markdown = inputIsDocument ? input["@text"] : toString(input);
+  const markdown = toString(input);
+  if (markdown === null) {
+    throw new Error("@mdHtml: The provided input couldn't be treated as text.");
+  }
   const html = marked(markdown);
   return inputIsDocument ? documentObject(html, input) : html;
 }

package/src/builtins/@merge.js

@@ -1,6 +1,5 @@
 import { isPlainObject, isUnpackable, merge } from "@weborigami/async-tree";
-import { Scope } from "@weborigami/language";
-import assertScopeIsDefined from "../misc/assertScopeIsDefined.js";
+import assertTreeIsDefined from "../misc/assertTreeIsDefined.js";
 
 /**
  * Create a tree that's the result of merging the given trees.
@@ -12,7 +11,7 @@ import assertScopeIsDefined from "../misc/assertScopeIsDefined.js";
  * @param {(Treelike|null)[]} trees
  */
 export default async function treeMerge(...trees) {
-  assertScopeIsDefined(this, "merge");
+  assertTreeIsDefined(this, "merge");
 
   // Filter out null or undefined trees.
   /** @type {Treelike[]}
@@ -36,22 +35,8 @@ export default async function treeMerge(...trees) {
     return merge(...unpacked);
   }
 
-  // If a tree can take a scope, give it one that includes the other trees and
-  // the current scope.
-  const scopedTrees = unpacked.map((tree) => {
-    const otherTrees = unpacked.filter((g) => g !== tree);
-    const scope = new Scope(...otherTrees, this);
-    // Each tree will be included first in its own scope.
-    return Scope.treeWithScope(tree, scope);
-  });
-
   // Merge the trees.
-  const result = merge(...scopedTrees);
-
-  // Give the overall mixed tree a scope that includes the component trees and
-  // the current scope.
-  /** @type {any} */ (result).scope = new Scope(result, this);
-
+  const result = merge(...unpacked);
   return result;
 }
 

package/src/builtins/@once.js

@@ -1,4 +1,4 @@
-import assertScopeIsDefined from "../misc/assertScopeIsDefined.js";
+import assertTreeIsDefined from "../misc/assertTreeIsDefined.js";
 
 const fnPromiseMap = new WeakMap();
 
@@ -10,7 +10,7 @@ const fnPromiseMap = new WeakMap();
  * @param {Function} fn
  */
 export default async function once(fn) {
-  assertScopeIsDefined(this, "once");
+  assertTreeIsDefined(this, "once");
   if (!fnPromiseMap.has(fn)) {
     fnPromiseMap.set(fn, fn.call(this));
   }

package/src/builtins/@ori.js

@@ -1,8 +1,12 @@
-import { Tree, getRealmObjectPrototype } from "@weborigami/async-tree";
+import {
+  Tree,
+  getRealmObjectPrototype,
+  toString,
+} from "@weborigami/async-tree";
 import { compile } from "@weborigami/language";
 import builtins from "../builtins/@builtins.js";
 import { toYaml } from "../common/serialize.js";
-import assertScopeIsDefined from "../misc/assertScopeIsDefined.js";
+import assertTreeIsDefined from "../misc/assertTreeIsDefined.js";
 
 const TypedArray = Object.getPrototypeOf(Uint8Array);
 
@@ -19,23 +23,23 @@ export default async function ori(
   expression,
   options = { formatResult: true }
 ) {
-  assertScopeIsDefined(this, "ori");
+  assertTreeIsDefined(this, "ori");
 
   // In case expression has come from a file, cast it to a string.
-  expression = String(expression);
+  expression = toString(expression);
 
-  // Obtain the scope from `this` or builtins.
-  let scope = this ?? builtins;
+  // Run in the context of `this` if defined, otherwise use the builtins.
+  const tree = this ?? builtins;
 
   // Parse
   const fn = compile.expression(expression);
 
   // Execute
-  let result = await fn.call(scope);
+  let result = await fn.call(tree);
 
   // If result was a function, execute it.
   if (typeof result === "function") {
-    result = await result.call(scope);
+    result = await result.call(tree);
   }
 
   return options.formatResult ? await formatResult(result) : result;

package/src/builtins/@pack.js

@@ -1,4 +1,4 @@
-import assertScopeIsDefined from "../misc/assertScopeIsDefined.js";
+import assertTreeIsDefined from "../misc/assertTreeIsDefined.js";
 
 /**
  * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
@@ -8,6 +8,6 @@ import assertScopeIsDefined from "../misc/assertScopeIsDefined.js";
  * @returns
  */
 export default function pack(obj) {
-  assertScopeIsDefined(this, "pack");
+  assertTreeIsDefined(this, "pack");
   return obj?.pack?.();
 }

package/src/builtins/@package.js

@@ -1,5 +1,4 @@
-import { Tree, keysFromPath } from "@weborigami/async-tree";
-import { Scope } from "@weborigami/language";
+import { Tree, keysFromPath, scope } from "@weborigami/async-tree";
 import project from "./@project.js";
 
 /**
@@ -7,11 +6,8 @@ import project from "./@project.js";
  * @param {string[]} keys
  */
 export default async function packageBuiltin(...keys) {
-  let scope = this;
-  if (!scope) {
-    const projectRoot = await project.call(null);
-    scope = Scope.getScope(projectRoot);
-  }
+  const parent = this ?? (await project.call(null));
+  const parentScope = scope(parent);
 
   const packageKeys = [keys.shift()];
   if (packageKeys[0]?.startsWith("@")) {
@@ -21,7 +17,7 @@ export default async function packageBuiltin(...keys) {
 
   const packageRoot = await Tree.traverse(
     // @ts-ignore
-    scope,
+    parentScope,
     "node_modules",
     ...packageKeys
   );

package/src/builtins/@paginateFn.js

@@ -1,5 +1,4 @@
 import { Tree } from "@weborigami/async-tree";
-import { Scope } from "@weborigami/language";
 
 /**
  * Return a new grouping of the treelike's values into "pages" of the specified
@@ -12,7 +11,6 @@ import { Scope } from "@weborigami/language";
  * @param {number} [size=10]
  */
 export default function paginateFn(size = 10) {
-  const scope = this;
   /**
    * @param {Treelike} [treelike]
    */
@@ -21,7 +19,7 @@ export default function paginateFn(size = 10) {
     const keys = Array.from(await tree.keys());
     const pageCount = Math.ceil(keys.length / size);
 
-    const result = {
+    return {
       async get(pageKey) {
         // Note: page numbers are 1-based.
         const pageNumber = Number(pageKey);
@@ -54,8 +52,5 @@ export default function paginateFn(size = 10) {
         return Array.from({ length: pageCount }, (_, index) => index + 1);
       },
     };
-
-    const scoped = Scope.treeWithScope(result, scope);
-    return scoped;
   };
 }

package/src/builtins/@perf.js

@@ -1,4 +1,4 @@
-import assertScopeIsDefined from "../misc/assertScopeIsDefined.js";
+import assertTreeIsDefined from "../misc/assertTreeIsDefined.js";
 
 /**
  * Return the number of milliseconds required to execute the given function the
@@ -8,7 +8,7 @@ import assertScopeIsDefined from "../misc/assertScopeIsDefined.js";
  * @param {Function} fn
  */
 export default async function perf(fn, count = 1) {
-  assertScopeIsDefined(this, "perf");
+  assertTreeIsDefined(this, "perf");
   const start = performance.now();
   for (let i = 0; i < count; i++) {
     await fn.call(this);