@weborigami/origami 0.3.3 → 0.3.4-jse.5

package/main.js

@@ -1,11 +1,9 @@
-export * from "./src/calc/calc.js";
 export { default as documentObject } from "./src/common/documentObject.js";
 export { toString } from "./src/common/utilities.js";
 export * from "./src/dev/dev.js";
-export * from "./src/handlers/handlerExports.js";
+export { default as handlerBuiltins } from "./src/handlers/handlerBuiltins.js";
 export * from "./src/handlers/handlers.js";
 export * from "./src/image/image.js";
-export { builtinsTree } from "./src/internal.js";
 export * from "./src/origami/origami.js";
 export { default as packageBuiltin } from "./src/protocols/package.js";
 export * from "./src/server/server.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@weborigami/origami",
-  "version": "0.3.3",
+  "version": "0.3.4-jse.5",
   "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",
+    "@weborigami/async-tree": "0.3.4-jse.5",
     "@weborigami/json-feed-to-rss": "1.0.0",
-    "@weborigami/language": "0.3.3",
-    "@weborigami/types": "0.3.3",
+    "@weborigami/language": "0.3.4-jse.5",
+    "@weborigami/types": "0.3.4-jse.5",
     "css-tree": "3.1.0",
     "exif-parser": "0.1.12",
     "graphviz-wasm": "3.0.2",

package/src/BuiltinsTree.js

@@ -0,0 +1,18 @@
+import { trailingSlash } from "@weborigami/async-tree";
+
+// We create our own tree instead of using ObjectTree, since that binds the
+// functions would be bound to the object. We want to leave them unbound.
+export default class BuiltinsTree {
+  constructor(object) {
+    this.object = object;
+  }
+
+  async get(key) {
+    const normalizedKey = trailingSlash.remove(key);
+    return this.object[normalizedKey];
+  }
+
+  async keys() {
+    return Object.keys(this.object);
+  }
+}

package/src/builtinsJse.js

@@ -0,0 +1,67 @@
+import { text as treeText } from "@weborigami/async-tree";
+import { jsGlobals } from "@weborigami/language";
+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 * 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 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 builtins;
+
+export default function builtinsJse() {
+  if (!builtins) {
+    const Tree = {
+      ...tree,
+      indent: text.indent,
+      json: origami.json,
+      text: treeText,
+    };
+
+    const Origami = {
+      ...dev,
+      files,
+      image,
+      ...origami,
+      ...site,
+      ...text,
+    };
+
+    /** @type {any} */
+    builtins = {
+      ...jsGlobals,
+
+      "explore:": explore,
+      "files:": files,
+      "help:": help,
+      "http:": http,
+      "https:": https,
+      "httpstree:": httpstree,
+      "httptree:": httptree,
+      "inherited:": inherited,
+      "node:": node,
+      "package:": packageNamespace,
+      "scope:": scope,
+
+      Tree,
+      Origami,
+
+      // Handlers need to be exposed at top level
+      ...handlerBuiltins(),
+    };
+  }
+
+  return builtins;
+}

package/src/builtinsShell.js

@@ -0,0 +1,52 @@
+import { jsGlobals } from "@weborigami/language";
+import builtinsJse from "./builtinsJse.js";
+import * as dev from "./dev/dev.js";
+import * as image from "./image/image.js";
+import * as origami from "./origami/origami.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 * as tree from "./tree/tree.js";
+
+let builtins;
+
+export default function builtinsShell() {
+  if (!builtins) {
+    builtins = {
+      // All JSE builtins
+      ...builtinsJse(),
+
+      // Old protocols to be deprecated
+      "dev:": dev,
+      "image:": image,
+      "js:": jsGlobals,
+      "new:": instantiate,
+      "origami:": origami,
+      "scope:": scope,
+      "site:": adjustReservedWords(site),
+      "text:": text,
+      "tree:": tree,
+
+      // For backward compat, include all methods at the top level
+      ...dev,
+      ...image,
+      ...origami,
+      ...adjustReservedWords(site),
+      ...text,
+      ...tree,
+    };
+  }
+
+  return builtins;
+}
+
+// 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/cli/getConfig.js

@@ -0,0 +1,10 @@
+import { Tree } from "@weborigami/async-tree";
+
+// Return the config for the given tree
+export default function getConfig(tree) {
+  if (!tree) {
+    return null;
+  }
+  const root = Tree.root(tree);
+  return root.config;
+}

package/src/common/documentObject.js

@@ -1,5 +1,4 @@
 import { isPlainObject, isUnpackable, toString } from "@weborigami/async-tree";
-// import txtHandler from "../builtins/txt.handler.js";
 
 /**
  * In Origami, a text document object is any object with a `@text` property and
@@ -22,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);
@@ -37,6 +36,13 @@ export default async function documentObject(input, data) {
   // };
   // const result = Object.create(base);
   const result = {};
+  // TODO: Deprecate @text
   Object.assign(result, inputData, data, { "@text": text });
+  Object.defineProperty(result, "_body", {
+    configurable: true,
+    value: text,
+    enumerable: false, // TODO: Make enumerable
+    writable: true,
+  });
   return result;
 }

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/crawler/crawlResources.js

@@ -130,7 +130,7 @@ async function processPath(tree, path, baseUrl) {
 
   // Traverse tree to get value.
   let value;
-  let normalizedKeys;
+  let normalizedKeys = [];
   let normalizedPath;
   try {
     value = await Tree.traverse(tree, ...keys);

package/src/dev/crawler/pathsInHtml.js

@@ -5,7 +5,9 @@ import { addHref } from "./utilities.js";
 
 export default function pathsInHtml(html) {
   const paths = {
+    /** @type {string[]} */
     crawlablePaths: [],
+    /** @type {string[]} */
     resourcePaths: [],
   };
 

package/src/dev/explore.js

@@ -5,7 +5,7 @@ import path from "node:path";
 import { fileURLToPath } from "node:url";
 import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
 import { getDescriptor } from "../common/utilities.js";
-import { builtinsTree } from "../internal.js";
+import oriHandler from "../handlers/ori.handler.js";
 import debug from "./debug.js";
 
 let templatePromise;
@@ -44,7 +44,7 @@ export default async function explore(...keys) {
     const data = await getScopeData(scope(tree));
     templatePromise ??= loadTemplate();
     const template = await templatePromise;
-    const text = await template(data);
+    const text = await template.call(this, data);
 
     result = new String(text);
     result.unpack = () => debug.call(tree, tree);
@@ -57,10 +57,6 @@ async function getScopeData(scope) {
   const trees = scope.trees ?? [scope];
   const data = [];
   for (const tree of trees) {
-    if (tree.parent === undefined) {
-      // Skip builtins.
-      continue;
-    }
     const name = getDescriptor(tree);
     const treeKeys = Array.from(await tree.keys());
     // Skip system-ish files that start with a period.
@@ -73,8 +69,7 @@ async function getScopeData(scope) {
 async function loadTemplate() {
   const folderPath = path.resolve(fileURLToPath(import.meta.url), "..");
   const folder = new OrigamiFiles(folderPath);
-  folder.parent = builtinsTree;
   const templateFile = await folder.get("explore.ori");
-  const template = await templateFile.unpack();
+  const template = await oriHandler.unpack(templateFile, { parent: folder });
   return template;
 }

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/css.handler.js

@@ -1,7 +1,7 @@
 // .css files use the .txt loader
-import fileTypeText from "./txt.handler.js";
+import { txtHandler } from "./handlers.js";
 
 export default {
-  ...fileTypeText,
+  ...txtHandler,
   mediaType: "text/css",
 };

package/src/handlers/handlerBuiltins.js

@@ -0,0 +1,26 @@
+import * as handlers from "./handlers.js";
+
+export default function handlerBuiltins() {
+  return {
+    "css.handler": handlers.cssHandler,
+    "csv.handler": handlers.csvHandler,
+    "htm.handler": handlers.htmHandler,
+    "html.handler": handlers.htmlHandler,
+    "jpeg.handler": handlers.jpegHandler,
+    "jpg.handler": handlers.jpgHandler,
+    "js.handler": handlers.jsHandler,
+    "jse.handler": handlers.jseHandler,
+    "jsedocument.handler": handlers.jsedocumentHandler,
+    "json.handler": handlers.jsonHandler,
+    "md.handler": handlers.mdHandler,
+    "mjs.handler": handlers.mjsHandler,
+    "ori.handler": handlers.oriHandler,
+    "oridocument.handler": handlers.oridocumentHandler,
+    "ts.handler": handlers.tsHandler,
+    "txt.handler": handlers.txtHandler,
+    "wasm.handler": handlers.wasmHandler,
+    "xhtml.handler": handlers.xhtmlHandler,
+    "yaml.handler": handlers.yamlHandler,
+    "yml.handler": handlers.ymlHandler,
+  };
+}

package/src/handlers/handlers.js

@@ -1,41 +1,37 @@
-import {
-  jsHandler,
-  oriHandler,
-  oridocumentHandler,
-  wasmHandler,
-  yamlHandler,
-} from "../internal.js";
-import cssHandler from "./css.handler.js";
-import csvHandler from "./csv.handler.js";
-import htmHandler from "./htm.handler.js";
-import htmlHandler from "./html.handler.js";
-import jpegHandler from "./jpeg.handler.js";
-import jpgHandler from "./jpg.handler.js";
-import jsonHandler from "./json.handler.js";
-import mdHandler from "./md.handler.js";
-import mjsHandler from "./mjs.handler.js";
-import tsHandler from "./ts.handler.js";
-import txtHandler from "./txt.handler.js";
-import xhtmlHandler from "./xhtml.handler.js";
-import ymlHandler from "./yml.handler.js";
+//
+// This library includes a number of modules with circular dependencies. This
+// module exists to explicitly set the loading order for those modules. To
+// enforce use of this loading order, other modules should only load the modules
+// below via this module.
+//
+// About this pattern:
+// https://medium.com/visual-development/how-to-fix-nasty-circular-dependency-issues-once-and-for-all-in-javascript-typescript-a04c987cf0de
+//
+// Note: to avoid having VS Code auto-sort the imports, keep lines between them.
 
-export default {
-  "css.handler": cssHandler,
-  "csv.handler": csvHandler,
-  "htm.handler": htmHandler,
-  "html.handler": htmlHandler,
-  "jpeg.handler": jpegHandler,
-  "jpg.handler": jpgHandler,
-  "js.handler": jsHandler,
-  "json.handler": jsonHandler,
-  "md.handler": mdHandler,
-  "mjs.handler": mjsHandler,
-  "ori.handler": oriHandler,
-  "oridocument.handler": oridocumentHandler,
-  "ts.handler": tsHandler,
-  "txt.handler": txtHandler,
-  "wasm.handler": wasmHandler,
-  "xhtml.handler": xhtmlHandler,
-  "yaml.handler": yamlHandler,
-  "yml.handler": ymlHandler,
-};
+export { default as jsHandler } from "./js.handler.js";
+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";
+export { default as csvHandler } from "./csv.handler.js";
+export { default as htmHandler } from "./htm.handler.js";
+export { default as htmlHandler } from "./html.handler.js";
+export { default as jpegHandler } from "./jpeg.handler.js";
+export { default as jpgHandler } from "./jpg.handler.js";
+export { default as jsonHandler } from "./json.handler.js";
+export { default as mdHandler } from "./md.handler.js";
+export { default as mjsHandler } from "./mjs.handler.js";
+export { default as wasmHandler } from "./wasm.handler.js";
+export { default as xhtmlHandler } from "./xhtml.handler.js";
+export { default as yamlHandler } from "./yaml.handler.js";
+export { default as ymlHandler } from "./yml.handler.js";

package/src/handlers/htm.handler.js

@@ -1,2 +1,2 @@
 // .htm is a synonynm for .html
-export { default } from "./html.handler.js";
+export { htmlHandler as default } from "./handlers.js";

package/src/handlers/html.handler.js

@@ -1,7 +1,7 @@
 // .html files use the .txt loader
-import fileTypeText from "./txt.handler.js";
+import { txtHandler } from "./handlers.js";
 
 export default {
-  ...fileTypeText,
+  ...txtHandler,
   mediaType: "text/html",
 };

package/src/handlers/jpg.handler.js

@@ -1,2 +1,2 @@
 // .jpg is a synonym for .jpeg
-export { default } from "./jpeg.handler.js";
+export { jpegHandler as default } from "./handlers.js";

package/src/handlers/js.handler.js

@@ -1,4 +1,4 @@
-import { processUnpackedContent } from "../internal.js";
+import processUnpackedContent from "./processUnpackedContent.js";
 
 /**
  * A JavaScript file

package/src/handlers/jse.handler.js

@@ -0,0 +1,17 @@
+import builtinsJse from "../builtinsJse.js";
+import getParent from "./getParent.js";
+import { oriHandler } from "./handlers.js";
+
+export default {
+  ...oriHandler,
+
+  async unpack(packed, options = {}) {
+    const parent = getParent(packed, options);
+    return oriHandler.unpack(packed, {
+      ...options,
+      globals: builtinsJse(),
+      mode: "jse",
+      parent,
+    });
+  },
+};

package/src/handlers/jsedocument.handler.js

@@ -0,0 +1,17 @@
+import builtinsJse from "../builtinsJse.js";
+import getParent from "./getParent.js";
+import { oridocumentHandler } from "./handlers.js";
+
+export default {
+  ...oridocumentHandler,
+
+  async unpack(packed, options = {}) {
+    const parent = getParent(packed, options);
+    return oridocumentHandler.unpack(packed, {
+      ...options,
+      globals: builtinsJse(),
+      mode: "jse",
+      parent,
+    });
+  },
+};

package/src/handlers/md.handler.js

@@ -1,7 +1,7 @@
 // .md files use the .txt loader
-import fileTypeText from "./txt.handler.js";
+import { txtHandler } from "./handlers.js";
 
 export default {
-  ...fileTypeText,
+  ...txtHandler,
   mediaType: "text/markdown",
 };

package/src/handlers/mjs.handler.js

@@ -1,2 +1,2 @@
 // .mjs is a synonynm for .js
-export { jsHandler as default } from "../internal.js";
+export { jsHandler as default } from "./handlers.js";

package/src/handlers/ori.handler.js

@@ -1,7 +1,9 @@
 import { compile } from "@weborigami/language";
+import builtinsShell from "../builtinsShell.js";
+import getConfig from "../cli/getConfig.js";
 import * as utilities from "../common/utilities.js";
-import { builtinsTree, processUnpackedContent } from "../internal.js";
 import getParent from "./getParent.js";
+import processUnpackedContent from "./processUnpackedContent.js";
 
 /**
  * An Origami expression file
@@ -34,10 +36,18 @@ export default {
 
     // Compile the source code as an Origami program and evaluate it.
     const compiler = options.compiler ?? compile.program;
-    const fn = compiler(source);
-    const target = parent ?? builtinsTree;
-    let content = await fn.call(target);
 
-    return processUnpackedContent(content, parent);
+    const config = getConfig(parent) ?? {};
+    const globals = {
+      ...(options.globals ?? builtinsShell()),
+      ...config,
+    };
+
+    const mode = options.mode ?? "shell";
+    const fn = compiler(source, { globals, mode });
+
+    let result = await fn.call(parent);
+
+    return processUnpackedContent(result, parent);
   },
 };

package/src/handlers/oridocument.handler.js

@@ -1,8 +1,9 @@
 import { extension, trailingSlash } from "@weborigami/async-tree";
 import { compile } from "@weborigami/language";
+import builtinsShell from "../builtinsShell.js";
 import { toString } from "../common/utilities.js";
-import { processUnpackedContent } from "../internal.js";
 import getParent from "./getParent.js";
+import processUnpackedContent from "./processUnpackedContent.js";
 
 /**
  * An Origami template document: a plain text file that contains Origami
@@ -35,7 +36,19 @@ export default {
       text,
       url,
     };
-    const defineFn = compile.templateDocument(source);
+
+    let globals;
+    if (options.globals) {
+      globals = options.globals;
+    } else {
+      globals = builtinsShell();
+    }
+
+    const defineFn = compile.templateDocument(source, {
+      front: options.front,
+      globals,
+      mode: options.mode ?? "shell",
+    });
 
     // Invoke the definition to get back the template function
     const result = await defineFn.call(parent);

package/src/{common → handlers}/processUnpackedContent.js

@@ -1,5 +1,4 @@
 import { symbols, Tree } from "@weborigami/async-tree";
-import { builtinsTree } from "../internal.js";
 
 /**
  * Perform any necessary post-processing on the unpacked content of a file. This
@@ -14,8 +13,7 @@ import { builtinsTree } from "../internal.js";
 export default function processUnpackedContent(content, parent) {
   if (typeof content === "function") {
     // Bind the function to the parent as the `this` context.
-    const target = parent ?? builtinsTree;
-    const result = content.bind(target);
+    const result = content.bind(parent);
     // Copy over any properties that were attached to the function
     Object.assign(result, content);
     return result;