@weborigami/origami 0.3.3-jse.3 → 0.3.4-jse.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@weborigami/origami",
-  "version": "0.3.3-jse.3",
+  "version": "0.3.4-jse.4",
   "description": "Web Origami language, CLI, framework, and server",
   "type": "module",
   "repository": {
@@ -17,10 +17,10 @@
     "typescript": "5.8.2"
   },
   "dependencies": {
-    "@weborigami/async-tree": "0.3.3-jse.3",
+    "@weborigami/async-tree": "0.3.4-jse.4",
     "@weborigami/json-feed-to-rss": "1.0.0",
-    "@weborigami/language": "0.3.3-jse.3",
-    "@weborigami/types": "0.3.3-jse.3",
+    "@weborigami/language": "0.3.4-jse.4",
+    "@weborigami/types": "0.3.4-jse.4",
     "css-tree": "3.1.0",
     "exif-parser": "0.1.12",
     "graphviz-wasm": "3.0.2",

package/src/builtinsJse.js

@@ -1,11 +1,9 @@
 import { text as treeText } from "@weborigami/async-tree";
 import { jsGlobals } from "@weborigami/language";
-import BuiltinsTree from "./BuiltinsTree.js";
 import * as dev from "./dev/dev.js";
 import handlerBuiltins from "./handlers/handlerBuiltins.js";
 import help from "./help/help.js";
 import * as image from "./image/image.js";
-import node from "./node.js";
 import * as origami from "./origami/origami.js";
 import explore from "./protocols/explore.js";
 import files from "./protocols/files.js";
@@ -14,33 +12,35 @@ import https from "./protocols/https.js";
 import httpstree from "./protocols/httpstree.js";
 import httptree from "./protocols/httptree.js";
 import inherited from "./protocols/inherited.js";
+import node from "./protocols/node.js";
 import packageNamespace from "./protocols/package.js";
 import scope from "./protocols/scope.js";
 import * as site from "./site/site.js";
 import * as text from "./text/text.js";
 import * as tree from "./tree/tree.js";
 
-let result;
+let builtins;
 
 export default function builtinsJse() {
-  if (!result) {
-    const Tree = new BuiltinsTree({
+  if (!builtins) {
+    const Tree = {
       ...tree,
       indent: text.indent,
       json: origami.json,
       text: treeText,
-    });
+    };
 
-    const Origami = new BuiltinsTree({
+    const Origami = {
       ...dev,
+      files,
       image,
       ...origami,
       ...site,
       ...text,
-    });
+    };
 
     /** @type {any} */
-    result = new BuiltinsTree({
+    builtins = {
       ...jsGlobals,
 
       "explore:": explore,
@@ -60,8 +60,8 @@ export default function builtinsJse() {
 
       // Handlers need to be exposed at top level
       ...handlerBuiltins(),
-    });
+    };
   }
 
-  return result;
+  return builtins;
 }

package/src/builtinsShell.js

@@ -1,75 +1,44 @@
 import { jsGlobals } from "@weborigami/language";
-import BuiltinsTree from "./BuiltinsTree.js";
+import builtinsJse from "./builtinsJse.js";
 import * as dev from "./dev/dev.js";
-import handlerBuiltins from "./handlers/handlerBuiltins.js";
-import help from "./help/help.js";
 import * as image from "./image/image.js";
-import node from "./node.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 inherited from "./protocols/inherited.js";
 import instantiate from "./protocols/new.js";
-import packageNamespace from "./protocols/package.js";
 import scope from "./protocols/scope.js";
 import * as site from "./site/site.js";
 import * as text from "./text/text.js";
 import * as tree from "./tree/tree.js";
 
-let result;
+let builtins;
 
 export default function builtinsShell() {
-  if (!result) {
-    const builtins = {
+  if (!builtins) {
+    builtins = {
+      // All JSE builtins
+      ...builtinsJse(),
+
+      // Old protocols to be deprecated
       "dev:": dev,
-      "explore:": explore,
-      "files:": files,
-      "help:": help,
-      "http:": http,
-      "https:": https,
-      "httpstree:": httpstree,
-      "httptree:": httptree,
       "image:": image,
-      "inherited:": inherited,
       "js:": jsGlobals,
       "new:": instantiate,
-      "node:": node,
       "origami:": origami,
-      "package:": packageNamespace,
       "scope:": scope,
       "site:": adjustReservedWords(site),
       "text:": text,
       "tree:": tree,
 
-      // Handlers need to be exposed at top level
-      ...handlerBuiltins(),
+      // For backward compat, include all methods at the top level
+      ...dev,
+      ...image,
+      ...origami,
+      ...adjustReservedWords(site),
+      ...text,
+      ...tree,
     };
-
-    // For all builtins like `tree:keys`, add a shorthand `keys`.
-    for (const [key, value] of Object.entries(builtins)) {
-      const isNamespace = key.endsWith(":");
-      if (isNamespace) {
-        for (const [subKey, subValue] of Object.entries(value)) {
-          // HACK: Skip description keys until we can make them all non-enumerable.
-          if (subKey === "description") {
-            continue;
-          }
-          if (subKey in builtins) {
-            throw new Error(`Internal Origami error: Duplicate key: ${subKey}`);
-          }
-          builtins[subKey] = subValue;
-        }
-      }
-    }
-
-    result = new BuiltinsTree(builtins);
   }
 
-  return result;
+  return builtins;
 }
 
 // Handle cases where a builtin name conflicts with a JS reserved word

package/src/common/documentObject.js

@@ -21,7 +21,7 @@ export default async function documentObject(input, data) {
   }
 
   if (isPlainObject(input)) {
-    text = input["@text"];
+    text = input["@text"] ?? input._body;
     inputData = input;
   } else {
     text = toString(input);

package/src/common/fetchAndHandleExtension.js

@@ -1,4 +1,4 @@
-import { handleExtension } from "@weborigami/language";
+import { getHandlers, handleExtension } from "@weborigami/language";
 
 /**
  * Fetch the resource at the given href.
@@ -19,7 +19,8 @@ export default async function fetchAndHandleExtension(href) {
   const url = new URL(href);
   const filename = url.pathname.split("/").pop();
   if (this && filename) {
-    buffer = await handleExtension(this, buffer, filename);
+    const handlers = getHandlers(this);
+    buffer = await handleExtension(this, buffer, filename, handlers);
   }
 
   return buffer;

package/src/common/utilities.js

@@ -94,8 +94,8 @@ export function toFunction(obj) {
  * @returns {string|null}
  */
 export function toString(object) {
-  if (isPlainObject(object) && "@text" in object) {
-    object = object["@text"];
+  if (isPlainObject(object) && ("@text" in object || "_body" in object)) {
+    object = object["@text"] ?? 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 index from "../site/index.js";
+import indexPage from "../site/indexPage.js";
 
 /**
  * Wraps a tree (typically a SiteTree) to turn a standard site into an
@@ -32,7 +32,7 @@ export default function ExplorableSiteTransform(Base) {
         // The tree doesn't have the key; try the defaults.
         if (key === "index.html") {
           // This tree is both the function call target and the parameter.
-          value = await index.call(this, this);
+          value = await indexPage.call(this, this);
         } else if (key === ".keys.json") {
           value = await jsonKeys.stringify(this);
         }

package/src/dev/explore.js.inline

@@ -3,7 +3,7 @@ let frame;
 
 const modes = {
   Content: "",
-  Index: "!index",
+  Index: "!indexPage",
   YAML: "!yaml",
   SVG: "!svg",
 };
@@ -15,7 +15,7 @@ function getPathFromHash() {
 
 function getModeFromLocation() {
   const href = document.location.href;
-  const match = /[\/](?<command>\!(?:index|yaml|svg))$/.exec(href);
+  const match = /[\/](?<command>\!(?:indexPage|yaml|svg))$/.exec(href);
   const command = match?.groups?.command ?? "";
   const mode =
     Object.keys(modes).find((key) => modes[key] === command) ?? "Content";

package/src/dev/explore.ori

@@ -4,8 +4,8 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width,initial-scale=1" />
     <title>Web Origami Explorer</title>
-    <style>${ explore.css }</style>
-    <script>${ explore.js.inline }</script>
+    <style>${ <explore.css> }</style>
+    <script>${ <explore.js.inline> }</script>
   </head>
   <body>
     <nav>
@@ -16,10 +16,10 @@
       <button id="buttonSVG">SVG</button>
       <button id="buttonYAML">YAML</button>
     </div>
-    ${ map(scope, (scopeTree) => `
+    ${ Tree.map(scope, (scopeTree) => `
       <ul>
-        <h2>${ scopeTree/name ?? "" }</h2>
-        ${ map(scopeTree/keys, (key) => `
+        <h2>${ scopeTree.name ?? "" }</h2>
+        ${ Tree.map(scopeTree.keys, (key) => `
         <li>
           <a href="./!explore/${ key }" target="frame">${ key }</a>
         </li>
@@ -30,4 +30,4 @@
     <iframe id="frame" name="frame"></iframe>
   </body>
 </html>
-`
+`

package/src/handlers/ori.handler.js

@@ -1,4 +1,3 @@
-import { merge } from "@weborigami/async-tree";
 import { compile } from "@weborigami/language";
 import builtinsShell from "../builtinsShell.js";
 import getConfig from "../cli/getConfig.js";
@@ -38,8 +37,11 @@ export default {
     // Compile the source code as an Origami program and evaluate it.
     const compiler = options.compiler ?? compile.program;
 
-    const config = getConfig(parent);
-    const globals = merge(options.globals ?? builtinsShell(), config);
+    const config = getConfig(parent) ?? {};
+    const globals = {
+      ...(options.globals ?? builtinsShell()),
+      ...config,
+    };
 
     const mode = options.mode ?? "shell";
     const fn = compiler(source, { globals, mode });

package/src/handlers/oridocument.handler.js

@@ -44,10 +44,10 @@ export default {
       globals = builtinsShell();
     }
 
-    const mode = options.mode ?? "shell";
     const defineFn = compile.templateDocument(source, {
+      front: options.front,
       globals,
-      mode,
+      mode: options.mode ?? "shell",
     });
 
     // Invoke the definition to get back the template function

package/src/help/help.yaml

@@ -135,17 +135,7 @@ new:
   description: Create instances of JavaScript classes
 
 node:
-  description: Node.js classes and modules
-  collection: true
-  commands:
-    Buffer:
-      description: Node.js Buffer class
-    path:
-      description: Node.js path module
-    process:
-      description: Node.js process object
-    url:
-      description: Node.js URL module
+  description: Node.js modules
 
 origami:
   description: Perform general Origami language functions

package/src/origami/config.js

@@ -14,5 +14,5 @@ import project from "./project.js";
 export default async function config(key) {
   const projectTree = await project.call(this);
   const projectConfig = projectTree.config;
-  return key === undefined ? projectConfig : projectConfig.get(key);
+  return key === undefined ? projectConfig : projectConfig[key];
 }

package/src/origami/ori.js

@@ -1,7 +1,6 @@
 import {
   Tree,
   getRealmObjectPrototype,
-  merge,
   toString,
 } from "@weborigami/async-tree";
 import { compile } from "@weborigami/language";
@@ -34,7 +33,12 @@ export default async function ori(
   const tree = this;
 
   const config = getConfig(tree);
-  const globals = merge(builtinsShell(), config);
+  const globals = config
+    ? {
+        ...builtinsShell(),
+        ...config,
+      }
+    : builtinsShell();
 
   // Compile the expression. Avoid caching scope references so that, e.g.,
   // passing a function to the `watch` builtin will always look the current

package/src/origami/project.js

@@ -1,5 +1,4 @@
 /** @typedef {import("@weborigami/types").AsyncTree} AsyncTree */
-import { merge } from "@weborigami/async-tree";
 import { OrigamiFiles } from "@weborigami/language";
 import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
 import handlerBuiltins from "../handlers/handlerBuiltins.js";
@@ -29,6 +28,7 @@ export default async function 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.
@@ -38,10 +38,11 @@ export default async function project() {
     root = foundConfig.container;
     // Unpack Origami configuration file
     const buffer = foundConfig.value;
-    root.config = await oriHandler.unpack(buffer, {
+    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(
@@ -58,7 +59,12 @@ export default async function project() {
   }
 
   // Merge config if present into handlers
-  root.handlers = merge(handlerBuiltins(), root.config);
+  root.handlers = config
+    ? {
+        ...handlerBuiltins(),
+        ...configHandlers(config),
+      }
+    : handlerBuiltins();
 
   return root;
 }
@@ -90,3 +96,14 @@ async function findAncestorFile(start, fileName) {
   // 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/origami/regexMatch.js

@@ -1,6 +1,10 @@
 const parsers = {};
 
+// TODO: Remove this deprecated function
 export default function regexMatch(text, regex) {
+  console.warn(
+    "warning: regexMatch is deprecated, use a JavaScript regular expression instead."
+  );
   if (!parsers[regex]) {
     const regexp = new RegExp(regex);
     parsers[regex] = (input) => input.match(regexp)?.groups;

package/src/protocols/new.js

@@ -13,12 +13,16 @@ import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
 export default async function instantiate(...keys) {
   assertTreeIsDefined(this, "new:");
   let constructor;
+
   const scope = this ? scopeFn(this) : null;
   if (
     keys.length === 1 &&
     (typeof keys[0] === "object" || typeof keys[0] === "function")
   ) {
     constructor = keys[0];
+  } else if (globalThis[keys[0]]) {
+    // Backward compat
+    constructor = globalThis[keys[0]];
   } else if (scope) {
     constructor = await Tree.traverseOrThrow(scope, ...keys);
   } else {

package/src/protocols/node.js

@@ -0,0 +1,13 @@
+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/site/{index.js → indexPage.js}

@@ -10,7 +10,7 @@ import { getDescriptor } from "../common/utilities.js";
  * @param {Treelike} [treelike]
  * @param {string} [basePath]
  */
-export default async function index(treelike, basePath) {
+export default async function indexPage(treelike, basePath) {
   const tree = await getTreeArgument(this, arguments, treelike, "site:index");
   const keys = Array.from(await tree.keys());
 

package/src/site/site.js

@@ -1,4 +1,4 @@
-export { default as index } from "./index.js";
+export { default as indexPage } from "./indexPage.js";
 export { default as jsonKeys } from "./jsonKeys.js";
 export { default as redirect } from "./redirect.js";
 export { default as rss } from "./rss.js";

package/src/site/sitemap.js

@@ -5,7 +5,7 @@ import { oriHandler } from "../handlers/handlers.js";
 
 const templateText = `(urls) => \`<?xml version="1.0" encoding="UTF-8"?>
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
-\${ map(urls, (url) => \`  <url>
+\${ Tree.map(urls, (url) => \`  <url>
     <loc>\${ url }</loc>
   </url>
 \`) }</urlset>

package/src/site/static.js

@@ -1,7 +1,7 @@
 import { Tree, jsonKeys } from "@weborigami/async-tree";
 import getTreeArgument from "../common/getTreeArgument.js";
 import { transformObject } from "../common/utilities.js";
-import index from "./index.js";
+import index from "./indexPage.js";
 
 /**
  * Expose common static keys (index.html, .keys.json) for a tree.

package/src/text/inline.js

@@ -1,12 +1,7 @@
-import {
-  isUnpackable,
-  ObjectTree,
-  symbols,
-  toString,
-} from "@weborigami/async-tree";
+import { isUnpackable, symbols, toString } from "@weborigami/async-tree";
 import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
 import documentObject from "../common/documentObject.js";
-import { oridocumentHandler } from "../handlers/handlers.js";
+import { jsedocumentHandler } from "../handlers/handlers.js";
 
 /**
  * Inline any Origami expressions found inside ${...} placeholders in the input
@@ -25,8 +20,11 @@ export default async function inline(input) {
   if (isUnpackable(input)) {
     input = await input.unpack();
   }
-  const inputIsDocument = input["@text"] !== undefined;
-  const origami = inputIsDocument ? input["@text"] : toString(input);
+  const inputIsDocument =
+    input["@text"] !== undefined || input._body !== undefined;
+  const origami = inputIsDocument
+    ? input["@text"] ?? input._body
+    : toString(input);
   if (origami === null) {
     return undefined;
   }
@@ -36,15 +34,22 @@ export default async function inline(input) {
     /** @type {any} */ (input)[symbols.parent] ??
     this;
 
-  let extendedParent = parent;
+  let front;
   if (inputIsDocument) {
-    extendedParent = new ObjectTree(input);
-    extendedParent.parent = parent;
+    // Collect all document properties except the body
+    front = Object.fromEntries(
+      Object.entries(input).filter(
+        ([key]) => key !== "@text" && key !== "_body"
+      )
+    );
+  } else {
+    front = null;
   }
 
   // @ts-ignore
-  let result = await oridocumentHandler.unpack(input, {
-    parent: extendedParent,
+  let result = await jsedocumentHandler.unpack(origami, {
+    front,
+    parent,
   });
 
   if (result instanceof Function) {

package/src/text/mdHtml.js

@@ -47,7 +47,8 @@ export default async function mdHtml(input) {
   if (isUnpackable(input)) {
     input = await input.unpack();
   }
-  const inputIsDocument = input["@text"] !== undefined;
+  const inputIsDocument =
+    input["@text"] !== undefined || input._body !== undefined;
   const markdown = toString(input);
   if (markdown === null) {
     throw new Error("mdHtml: The provided input couldn't be treated as text.");

package/src/node.js

@@ -1,22 +0,0 @@
-import path from "node:path";
-import process from "node:process";
-import url from "node:url";
-
-// Patch process.env to be a plain object. Among other things, this lets us dump
-// the complete environment to the terminal with `ori @node/process/env`.
-const patchedProcess = Object.create(null, {
-  ...Object.getOwnPropertyDescriptors(process),
-  env: {
-    enumerable: true,
-    get: function () {
-      return Object.assign({}, process.env);
-    },
-  },
-});
-
-export default {
-  Buffer,
-  path,
-  process: patchedProcess,
-  url,
-};