@weborigami/origami 0.4.2 → 0.5.0

package/main.js

@@ -3,13 +3,10 @@ export { toString } from "./src/common/utilities.js";
 export * from "./src/dev/dev.js";
 export { default as handlerBuiltins } from "./src/handlers/handlerBuiltins.js";
 export * from "./src/handlers/handlers.js";
-export * as image from "./src/image/image.js";
 export * from "./src/origami/origami.js";
-export { default as packageBuiltin } from "./src/protocols/package.js";
+export { default as origamiHighlightDefinition } from "./src/origami/origamiHighlightDefinition.js";
+export { default as package } from "./src/protocols/package.js";
 export * from "./src/server/server.js";
-export * from "./src/site/site.js";
-export { default as origamiHighlightDefinition } from "./src/text/origamiHighlightDefinition.js";
-export * from "./src/text/text.js";
 
-// TODO: Remove once these all moves to async-tree
+// TODO: Remove once these async-tree owns sole copy of all tree builtins
 export * from "./src/tree/tree.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@weborigami/origami",
-  "version": "0.4.2",
+  "version": "0.5.0",
   "description": "Web Origami language, CLI, framework, and server",
   "type": "module",
   "repository": {
@@ -13,25 +13,25 @@
   "main": "./main.js",
   "types": "./index.ts",
   "devDependencies": {
-    "@types/node": "22.13.13",
-    "typescript": "5.8.2"
+    "@types/node": "24.3.0",
+    "typescript": "5.9.2"
   },
   "dependencies": {
-    "@weborigami/async-tree": "0.4.2",
+    "@weborigami/async-tree": "0.5.0",
     "@weborigami/json-feed-to-rss": "1.0.0",
-    "@weborigami/language": "0.4.2",
-    "@weborigami/types": "0.4.2",
+    "@weborigami/language": "0.5.0",
+    "@weborigami/types": "0.5.0",
     "css-tree": "3.1.0",
     "exif-parser": "0.1.12",
     "graphviz-wasm": "3.0.2",
     "highlight.js": "11.11.1",
     "jsdom": "26.1.0",
-    "marked": "15.0.7",
-    "marked-gfm-heading-id": "4.1.1",
-    "marked-highlight": "2.2.1",
-    "marked-smartypants": "1.1.9",
-    "sharp": "0.33.5",
-    "yaml": "2.7.0"
+    "marked": "16.2.0",
+    "marked-gfm-heading-id": "4.1.2",
+    "marked-highlight": "2.2.2",
+    "marked-smartypants": "1.1.10",
+    "sharp": "0.34.3",
+    "yaml": "2.8.1"
   },
   "scripts": {
     "test": "node --test --test-reporter=spec",

package/src/builtinsProgram.js

@@ -1,87 +1,65 @@
-import { Tree } from "@weborigami/async-tree";
-import { attachWarning } from "@weborigami/language";
-import builtinsJse from "./builtinsJse.js";
+import { deepText, indent, json, text } from "@weborigami/async-tree";
+import { jsGlobals } from "@weborigami/language";
 import * as dev from "./dev/dev.js";
-import * as image from "./image/image.js";
+import help from "./dev/help.js";
+import handlerBuiltins from "./handlers/handlerBuiltins.js";
 import * as origami from "./origami/origami.js";
-import inherited from "./protocols/inherited.js";
-import js from "./protocols/js.js";
-import instantiate from "./protocols/new.js";
-import scope from "./protocols/scope.js";
-import * as site from "./site/site.js";
-import * as text from "./text/text.js";
+import explore from "./protocols/explore.js";
+import files from "./protocols/files.js";
+import http from "./protocols/http.js";
+import https from "./protocols/https.js";
+import httpstree from "./protocols/httpstree.js";
+import httptree from "./protocols/httptree.js";
+import node from "./protocols/node.js";
+import packageNamespace from "./protocols/package.js";
 import * as tree from "./tree/tree.js";
 
 let builtins;
 
 export default function builtinsProgram() {
   if (!builtins) {
+    const Tree = {
+      ...tree,
+      deepText,
+      indent,
+      json,
+      text,
+    };
+
+    const Protocol = {
+      explore,
+      files,
+      http,
+      https,
+      httpstree,
+      httptree,
+      node,
+      package: packageNamespace,
+    };
+
+    /** @type {any} */
     builtins = {
-      // All JSE builtins
-      ...builtinsJse(),
+      ...jsGlobals,
+
+      "explore:": explore,
+      "files:": files,
+      "help:": help,
+      "http:": http,
+      "https:": https,
+      "httpstree:": httpstree,
+      "httptree:": httptree,
+      "node:": node,
+      "package:": packageNamespace,
 
-      // // Old protocols to be deprecated
-      "dev:": deprecateFunctions(dev, "dev:", "Dev."),
-      "image:": deprecateFunctions(image, "image:", "Origami.image."),
-      "inherited:": inherited,
-      "js:": js,
-      "new:": instantiate,
-      "origami:": deprecateFunctions(origami, "origami:", "Origami."),
-      "scope:": scope,
-      "site:": deprecateFunctions(
-        adjustReservedWords(site),
-        "site:",
-        "Origami."
-      ),
-      "text:": deprecateFunctions(text, "text:", "Origami."),
-      "tree:": deprecateFunctions(tree, "tree:", "Tree."),
+      Dev: dev,
+      Tree,
+      Origami: origami,
+      Protocol,
 
-      // // For backward compat, include all methods at the top level
-      ...deprecateFunctions(dev, "", "Dev."),
-      ...deprecateFunctions(image, "", "Origami.image."),
-      ...deprecateFunctions(origami, "", "Origami."),
-      ...deprecateFunctions(adjustReservedWords(site), "site:", "Origami."),
-      ...deprecateFunctions(text, "", "Origami."),
-      ...deprecateFunctions(tree, "", "Tree."),
+      // Handlers need to be exposed at top level
+      ...handlerBuiltins(),
     };
   }
 
   return builtins;
 }
-
-function deprecateFunctions(fns, oldPrefix, newPrefix) {
-  const wrappedEntries = Object.entries(fns).map(([key, value]) => {
-    const wrappedFn =
-      /** @this {import("@weborigami/types").AsyncTree} */
-      async function (...args) {
-        const oldKey = key === "indent" ? key : `${oldPrefix}${key}()`;
-        const newKey =
-          key === "indent"
-            ? `Tree.indent`
-            : key === "json"
-            ? `Tree.json`
-            : `${newPrefix}${key}()`;
-        const result =
-          value instanceof Function
-            ? await value.apply(this, args)
-            : await Tree.traverseOrThrow.call(this, value, ...args);
-        return attachWarning(
-          result,
-          `${oldKey} is deprecated, use ${newKey} instead.`
-        );
-      };
-    Object.assign(wrappedFn, value);
-    return [key, wrappedFn];
-  });
-  return Object.fromEntries(wrappedEntries);
-}
-
-// Handle cases where a builtin name conflicts with a JS reserved word
-function adjustReservedWords(obj) {
-  const result = {};
-  for (const [key, value] of Object.entries(obj)) {
-    const name = value.key ?? key;
-    result[name] = value;
-  }
-  return result;
-}

package/src/builtinsShell.js

@@ -1,61 +1,16 @@
-import { text as treeText } from "@weborigami/async-tree";
-import builtinsJse from "./builtinsJse.js";
+import builtinsProgram from "./builtinsProgram.js";
 import * as dev from "./dev/dev.js";
-import * as image from "./image/image.js";
-import * as origami from "./origami/origami.js";
-import explore from "./protocols/explore.js";
-import files from "./protocols/files.js";
-import http from "./protocols/http.js";
-import https from "./protocols/https.js";
-import httpstree from "./protocols/httpstree.js";
-import httptree from "./protocols/httptree.js";
-import node from "./protocols/node.js";
-import packageNamespace from "./protocols/package.js";
-import * as site from "./site/site.js";
-import * as text from "./text/text.js";
-import * as tree from "./tree/tree.js";
 
 let builtins;
 
 export default function builtinsShell() {
   if (!builtins) {
-    const Tree = {
-      ...tree,
-      indent: text.indent,
-      json: origami.json,
-      text: treeText,
-    };
-
-    const Origami = {
-      image,
-      ...origami,
-      ...site,
-      static: site.staticBuiltin,
-      ...text,
-    };
-
-    const Protocol = {
-      explore,
-      files,
-      http,
-      https,
-      httpstree,
-      httptree,
-      node,
-      package: packageNamespace,
-    };
-
     builtins = {
-      // All JSE builtins
-      ...builtinsJse(),
+      // All program builtins
+      ...builtinsProgram(),
 
       // Dev builtins exposed at the top level in shell
       ...dev,
-
-      Dev: dev,
-      Origami,
-      Protocol,
-      Tree,
     };
   }
 

package/src/common/documentObject.js

@@ -1,10 +1,8 @@
 import { isPlainObject, isUnpackable, toString } from "@weborigami/async-tree";
-import { attachWarning } from "@weborigami/language";
 
 /**
- * In Origami, a text document object is any object with a `@text` property and
- * a pack() method that formats that object as text with YAML front matter. This
- * function is a helper for constructing such text document objects.
+ * In Origami, a text document object is any object with a `_body` property.
+ * This function is a helper for constructing such text document objects.
  *
  * @typedef {import("@weborigami/async-tree").StringLike} StringLike
  * @typedef {import("@weborigami/async-tree").PlainObject} PlainObject
@@ -22,7 +20,7 @@ export default async function documentObject(input, data) {
   }
 
   if (isPlainObject(input)) {
-    text = input._body ?? input["@text"];
+    text = input._body;
     inputData = input;
   } else {
     text = toString(input);
@@ -37,23 +35,13 @@ export default async function documentObject(input, data) {
   // };
   // const result = Object.create(base);
   const result = {};
-  // TODO: Deprecate @text
   Object.assign(result, inputData, data);
-  Object.defineProperty(result, "@text", {
-    configurable: true,
-    enumerable: true,
-    get() {
-      return attachWarning(
-        text,
-        "The @text property is deprecated. Use _body instead."
-      );
-    },
-  });
   Object.defineProperty(result, "_body", {
     configurable: true,
     enumerable: true,
     value: text,
     writable: true,
   });
+
   return result;
 }

package/src/common/utilities.js

@@ -87,15 +87,15 @@ export function toFunction(obj) {
 }
 
 /**
- * Extend the async-tree toString method: objects that have a `@text` property
+ * Extend the async-tree toString method: objects that have a `_body` property
  * will return the value of that property as a string.
  *
  * @param {any} object
  * @returns {string|null}
  */
 export function toString(object) {
-  if (isPlainObject(object) && ("@text" in object || "_body" in object)) {
-    object = object._body ?? object["@text"];
+  if (isPlainObject(object) && "_body" in object) {
+    object = object._body;
   }
   return asyncTreeToString(object);
 }

package/src/dev/ExplorableSiteTransform.js

@@ -1,6 +1,6 @@
 import { Tree, jsonKeys } from "@weborigami/async-tree";
 import { isTransformApplied, transformObject } from "../common/utilities.js";
-import indexPage from "../site/indexPage.js";
+import indexPage from "../origami/indexPage.js";
 
 /**
  * Wraps a tree (typically a SiteTree) to turn a standard site into an

package/src/dev/code.js

@@ -1,21 +1,23 @@
-import { symbols } from "@weborigami/language";
+import { toString } from "@weborigami/async-tree";
+import { compile } from "@weborigami/language";
 import getTreeArgument from "../common/getTreeArgument.js";
 
 /**
  * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
  *
  * @this {AsyncTree|null}
- * @param {any} value
+ * @param {import("@weborigami/async-tree").StringLike} input
  */
-export default async function code(value) {
-  if (value === undefined) {
-    value = await getTreeArgument(this, arguments, value, "dev:code");
+export default async function code(input) {
+  if (input === undefined) {
+    input = await getTreeArgument(this, arguments, input, "code");
   }
-  if (value === undefined) {
+  if (input === undefined) {
     return undefined;
   }
-  const code = value.code ?? value[symbols.codeSymbol];
-  return code ? functionNames(code) : undefined;
+  const text = toString(input);
+  const fn = compile.program(text);
+  return functionNames(fn.code);
 }
 
 function functionNames(code) {

package/src/dev/crawler/audit.js

@@ -15,7 +15,7 @@ import { getBaseUrl } from "./utilities.js";
  * @param {string} [baseHref]
  */
 export default async function audit(treelike, baseHref) {
-  const tree = await getTreeArgument(this, arguments, treelike, "site:audit");
+  const tree = await getTreeArgument(this, arguments, treelike, "audit");
   const baseUrl = getBaseUrl(baseHref, treelike);
 
   let errors = {};

package/src/dev/crawler/crawl.js

@@ -26,7 +26,7 @@ import { addValueToObject, getBaseUrl } from "./utilities.js";
  * @returns {Promise<AsyncTree>}
  */
 export default async function crawlBuiltin(treelike, baseHref) {
-  const tree = await getTreeArgument(this, arguments, treelike, "site:crawl");
+  const tree = await getTreeArgument(this, arguments, treelike, "crawl");
   const baseUrl = getBaseUrl(baseHref, treelike);
 
   const cache = {};

package/src/dev/debug.js

@@ -16,7 +16,7 @@ import OriCommandTransform from "./OriCommandTransform.js";
 export default async function debug(treelike) {
   // The debug command leaves the tree's existing scope intact; it does not
   // apply its own scope to the tree.
-  let tree = await getTreeArgument(this, arguments, treelike, "dev:debug");
+  let tree = await getTreeArgument(this, arguments, treelike, "debug");
 
   if (!isTransformApplied(DebugTransform, tree)) {
     tree = transformObject(DebugTransform, tree);

package/src/dev/dev.js

@@ -1,5 +1,5 @@
+export { default as indexPage } from "../origami/indexPage.js";
 export { default as yaml } from "../origami/yaml.js";
-export { default as indexPage } from "../site/indexPage.js";
 export { default as clear } from "../tree/clear.js";
 export { default as keys } from "../tree/keys.js";
 export { default as breakpoint } from "./breakpoint.js";

package/src/dev/explore.ori

@@ -3,13 +3,13 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width,initial-scale=1" />
-    <title>Web Origami Explorer</title>
+    <title>Origami Explorer</title>
     <style>${ <explore.css> }</style>
     <script>${ <explore.inline.js> }</script>
   </head>
   <body>
     <nav>
-    <div id="label">Web Origami Explorer</div>
+    <div id="label">Origami Explorer</div>
     <div id="scopeToolbar">
       <button id="buttonContent">Content</button>
       <button id="buttonIndex">Index</button>

package/src/dev/help.yaml

@@ -65,6 +65,9 @@ Origami:
       description: Create a document object with the text and data
     extension:
       description: Helpers for working with file extensions
+    fetch:
+      args: (url, options)
+      description: Fetch a resource from a URL with support for extensions
     image:
       description: Collection of functions for working with images
     indexPage:
@@ -73,6 +76,9 @@ Origami:
     inline:
       args: (text)
       description: Inline Origami expressions found in the text
+    json:
+      args: (obj)
+      description: Render the object in JSON format
     jsonKeys:
       args: (tree)
       description: Add .keys.json files to a tree
@@ -187,6 +193,9 @@ Tree:
     deepTake:
       args: (tree, n)
       description: The first n values from the deep tree
+    deepText:
+      args: (tree)
+      description: The text values of the deep tree
     deepValues:
       args: (tree)
       description: The in-order leaf values of the tree
@@ -238,8 +247,8 @@ Tree:
       args: (object)
       description: True if object can be coerced to a tree
     json:
-      args: (obj)
-      description: Render the object in JSON format
+      args: (tree)
+      description: Render the tree in JSON format
     keys:
       args: (tree)
       description: The keys of the tree

package/src/dev/serve.js

@@ -29,10 +29,12 @@ export default async function serve(treelike, port) {
     if (!isTransformApplied(ExplorableSiteTransform, tree)) {
       tree = transformObject(ExplorableSiteTransform, tree);
     }
-  } else {
+  } else if (arguments.length === 0) {
     // By default, watch the default tree and add default pages.
     const withDefaults = await debug.call(this);
     tree = await watch.call(this, withDefaults);
+  } else {
+    throw new Error("serve: no tree was provided to serve");
   }
 
   if (port === undefined) {

package/src/dev/svg.js

@@ -20,13 +20,7 @@ export default async function svg(treelike, options = {}) {
     await graphviz.loadWASM();
     graphvizLoaded = true;
   }
-  const tree = await getTreeArgument(
-    this,
-    arguments,
-    treelike,
-    "dev:svg",
-    true
-  );
+  const tree = await getTreeArgument(this, arguments, treelike, "svg", true);
   const dotText = await dot.call(this, tree, options);
   if (dotText === undefined) {
     return undefined;

package/src/dev/watch.js

@@ -16,12 +16,7 @@ import getTreeArgument from "../common/getTreeArgument.js";
  */
 export default async function watch(treelike, fn) {
   /** @type {any} */
-  const container = await getTreeArgument(
-    this,
-    arguments,
-    treelike,
-    "dev:watch"
-  );
+  const container = await getTreeArgument(this, arguments, treelike, "watch");
 
   // Watch the indicated tree.
   await /** @type {any} */ (container).watch?.();

package/src/handlers/handlerBuiltins.js

@@ -9,8 +9,9 @@ export default function handlerBuiltins() {
     "jpeg.handler": handlers.jpegHandler,
     "jpg.handler": handlers.jpgHandler,
     "js.handler": handlers.jsHandler,
-    "jse.handler": handlers.jseHandler,
-    "jsedocument.handler": handlers.jsedocumentHandler,
+    // TODO: Remove deprecated JSE extensions
+    "jse.handler": handlers.oriHandler,
+    "jsedocument.handler": handlers.oridocumentHandler,
     "json.handler": handlers.jsonHandler,
     "md.handler": handlers.mdHandler,
     "mjs.handler": handlers.mjsHandler,

package/src/handlers/handlers.js

@@ -14,12 +14,8 @@ export { default as tsHandler } from "./ts.handler.js";
 
 export { default as oriHandler } from "./ori.handler.js";
 
-export { default as jseHandler } from "./jse.handler.js";
-
 export { default as oridocumentHandler } from "./oridocument.handler.js";
 
-export { default as jsedocumentHandler } from "./jsedocument.handler.js";
-
 export { default as txtHandler } from "./txt.handler.js";
 
 export { default as cssHandler } from "./css.handler.js";

package/src/handlers/ori.handler.js

@@ -43,8 +43,10 @@ export default {
       ...config,
     };
 
-    const mode = options.mode ?? "program";
-    const fn = compiler(source, { globals, mode });
+    const fn = compiler(source, {
+      globals,
+      mode: "program",
+    });
 
     let result = await fn.call(parent);
 

package/src/handlers/oridocument.handler.js

@@ -1,6 +1,7 @@
 import { extension, trailingSlash } from "@weborigami/async-tree";
 import { compile } from "@weborigami/language";
 import builtinsProgram from "../builtinsProgram.js";
+import getConfig from "../cli/getConfig.js";
 import { toString } from "../common/utilities.js";
 import getParent from "./getParent.js";
 import processUnpackedContent from "./processUnpackedContent.js";
@@ -37,17 +38,16 @@ export default {
       url,
     };
 
-    let globals;
-    if (options.globals) {
-      globals = options.globals;
-    } else {
-      globals = builtinsProgram();
-    }
+    const config = getConfig(parent) ?? {};
+    const globals = {
+      ...(options.globals ?? builtinsProgram()),
+      ...config,
+    };
 
     const defineFn = compile.templateDocument(source, {
       front: options.front,
       globals,
-      mode: options.mode ?? "shell",
+      mode: "program",
     });
 
     // Invoke the definition to get back the template function

package/src/handlers/txt.handler.js

@@ -1,5 +1,5 @@
 import { isPacked, symbols } from "@weborigami/async-tree";
-import { attachWarning, compile } from "@weborigami/language";
+import { compile } from "@weborigami/language";
 import { parseYaml, toYaml } from "../common/serialize.js";
 import { toString } from "../common/utilities.js";
 import parseFrontMatter from "./parseFrontMatter.js";
@@ -17,7 +17,7 @@ import parseFrontMatter from "./parseFrontMatter.js";
  *
  * If there is front matter, any Origami expressions in the front matter will be
  * evaluated. The result will be a plain JavaScript object with the evaluated
- * data and a `@text` property containing the document text.
+ * data and a `_body` property containing the document text.
  */
 export default {
   mediaType: "text/plain",
@@ -26,7 +26,7 @@ export default {
    * If the input is already in some packed format, it will be returned as is.
    *
    * Otherwise, the properties of the object will be formatted as YAML. If the
-   * object has a `@text` property, that will be used as the body of the text
+   * object has a `_body` property, that will be used as the body of the text
    * document; otherwise, an empty string will be used.
    *
    * @param {any} object
@@ -39,13 +39,11 @@ export default {
       throw new TypeError("The input to pack must be a JavaScript object.");
     }
 
-    // TODO: Deprecate @text
-    const text = object._body ?? object["@text"] ?? "";
+    const text = object._body ?? "";
 
     /** @type {any} */
     const dataWithoutText = Object.assign({}, object);
     delete dataWithoutText._body;
-    delete dataWithoutText["@text"];
     if (Object.keys(dataWithoutText).length > 0) {
       const frontMatter = (await toYaml(dataWithoutText)).trimEnd();
       return `---\n${frontMatter}\n---\n${text}`;
@@ -74,18 +72,7 @@ export default {
       } else {
         frontData = parseYaml(frontText);
       }
-      // TODO: Deprecate @text
       unpacked = { ...frontData };
-      Object.defineProperty(unpacked, "@text", {
-        configurable: true,
-        enumerable: true,
-        get() {
-          return attachWarning(
-            body,
-            "The @text property is deprecated. Use _body instead."
-          );
-        },
-      });
       Object.defineProperty(unpacked, "_body", {
         configurable: true,
         enumerable: true,