@weborigami/origami 0.3.2 → 0.3.3-jse.1

package/main.js

@@ -1,4 +1,3 @@
-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";

package/package.json

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

package/src/builtins.js

@@ -1,4 +1,3 @@
-import * as calc from "./calc/calc.js";
 import * as dev from "./dev/dev.js";
 import * as handlers from "./handlers/handlers.js";
 import help from "./help/help.js";
@@ -22,7 +21,6 @@ import * as tree from "./tree/tree.js";
 
 /** @type {any} */
 export default {
-  "calc:": adjustReservedWords(calc),
   "dev:": dev,
   "explore:": explore,
   "files:": files,

package/src/builtinsNew.js

@@ -0,0 +1,84 @@
+import {
+  ObjectTree,
+  trailingSlash,
+  text as treeText,
+} from "@weborigami/async-tree";
+import * as dev from "./dev/dev.js";
+import * as handlers from "./handlers/handlers.js";
+import help from "./help/help.js";
+import * as image from "./image/image.js";
+import js from "./js.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";
+
+// See notes in builtinsTree.js
+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);
+  }
+}
+
+const Tree = new BuiltinsTree({
+  ...tree,
+  indent: text.indent,
+  json: origami.json,
+  text: treeText,
+});
+
+const Origami = new BuiltinsTree({
+  ...dev,
+  ...origami,
+  ...site,
+  ...text,
+});
+
+const Image = new BuiltinsTree({
+  ...image,
+});
+
+/** @type {any} */
+export default new ObjectTree({
+  "explore:": explore,
+  "files:": files,
+  "help:": help,
+  "http:": http,
+  "https:": https,
+  "httpstree:": httpstree,
+  "httptree:": httptree,
+  "inherited:": inherited,
+  "new:": instantiate,
+  "node:": node,
+  "package:": packageNamespace,
+  "scope:": scope,
+
+  ...js,
+
+  Tree,
+  Origami,
+  Image,
+
+  // Some builtins need to be exposed at top level
+  ...handlers.default,
+});

package/src/common/documentObject.js

@@ -37,6 +37,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/handlers/handlers.js

@@ -11,6 +11,8 @@ 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 jseHandler from "./jse.handler.js";
+import jseDocumentHandler from "./jsedocument.handler.js";
 import jsonHandler from "./json.handler.js";
 import mdHandler from "./md.handler.js";
 import mjsHandler from "./mjs.handler.js";
@@ -27,6 +29,9 @@ export default {
   "jpeg.handler": jpegHandler,
   "jpg.handler": jpgHandler,
   "js.handler": jsHandler,
+  "jse.handler": jseHandler,
+  "jsep.handler": jseHandler,
+  "jsedocument.handler": jseDocumentHandler,
   "json.handler": jsonHandler,
   "md.handler": mdHandler,
   "mjs.handler": mjsHandler,

package/src/handlers/jse.handler.js

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

package/src/handlers/jseModeParent.js

@@ -0,0 +1,30 @@
+import { FileTree, ObjectTree } from "@weborigami/async-tree";
+
+let builtinsNew;
+
+// Adapt the existing parent chain to use the new builtins
+export default async function jseModeParent(parent) {
+  builtinsNew ??= (await import("../builtinsNew.js")).default;
+  return cloneParent(parent);
+}
+
+function cloneParent(parent) {
+  let clone;
+  // We expect the parent to be a FileTree (or a subclass), ObjectTree (or a
+  // subclass), or builtins.
+  if (!parent) {
+    return null;
+  } else if (parent instanceof FileTree) {
+    clone = Reflect.construct(parent.constructor, [parent.path]);
+  } else if (parent instanceof ObjectTree) {
+    clone = Reflect.construct(parent.constructor, [parent.object]);
+  } else if (!parent.parent) {
+    // Builtins
+    clone = builtinsNew;
+  } else {
+    // Maybe a map? Skip it and hope for the best.
+    return cloneParent(parent.parent);
+  }
+  clone.parent = cloneParent(parent.parent);
+  return clone;
+}

package/src/handlers/jsedocument.handler.js

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

package/src/handlers/ori.handler.js

@@ -34,7 +34,8 @@ export default {
 
     // Compile the source code as an Origami program and evaluate it.
     const compiler = options.compiler ?? compile.program;
-    const fn = compiler(source);
+    const mode = options.mode ?? "shell";
+    const fn = compiler(source, { mode });
     const target = parent ?? builtinsTree;
     let content = await fn.call(target);
 

package/src/handlers/oridocument.handler.js

@@ -35,7 +35,8 @@ export default {
       text,
       url,
     };
-    const defineFn = compile.templateDocument(source);
+    const mode = options.mode ?? "shell";
+    const defineFn = compile.templateDocument(source, { mode });
 
     // Invoke the definition to get back the template function
     const result = await defineFn.call(parent);

package/src/handlers/txt.handler.js

@@ -39,7 +39,8 @@ export default {
       throw new TypeError("The input to pack must be a JavaScript object.");
     }
 
-    const text = object["@text"] ?? "";
+    // TODO: Deprecate @text
+    const text = object._body ?? object["@text"] ?? "";
 
     /** @type {any} */
     const dataWithoutText = Object.assign({}, object);
@@ -72,7 +73,14 @@ export default {
       } else {
         frontData = parseYaml(frontText);
       }
+      // TODO: Deprecate @text
       unpacked = Object.assign({}, frontData, { "@text": body });
+      Object.defineProperty(unpacked, "_body", {
+        configurable: true,
+        value: text,
+        enumerable: false, // TODO: Make enumerable
+        writable: true,
+      });
     } else {
       // Plain text
       unpacked = new String(text);

package/src/internal.js

@@ -15,6 +15,10 @@ export { default as oriHandler } from "./handlers/ori.handler.js";
 
 export { default as oridocumentHandler } from "./handlers/oridocument.handler.js";
 
+export { default as jseHandler } from "./handlers/jse.handler.js";
+
+export { default as jsedocumentHandler } from "./handlers/jsedocument.handler.js";
+
 export { default as processUnpackedContent } from "./common/processUnpackedContent.js";
 
 export { default as wasmHandler } from "./handlers/wasm.handler.js";

package/src/js.js

@@ -1,38 +1,79 @@
-async function fetchWrapper(resource, options) {
-  const response = await fetch(resource, options);
-  return response.ok ? await response.arrayBuffer() : undefined;
-}
-
+/**
+ * The complete set of support JavaScript globals and global-like values.
+ *
+ * See
+ * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects.
+ * That page lists some things like `TypedArrays` which are not globals so are
+ * omitted here.
+ */
 export default {
+  AggregateError,
   Array,
+  ArrayBuffer,
+  Atomics,
   BigInt,
+  BigInt64Array,
+  BigUint64Array,
   Boolean,
+  DataView,
   Date,
   Error,
+  EvalError,
+  FinalizationRegistry,
+  Float32Array,
+  Float64Array,
+  Function,
   Infinity,
+  Int16Array,
+  Int32Array,
+  Int8Array,
   Intl,
+  // @ts-ignore Iterator does exist despite what TypeScript thinks
+  Iterator,
   JSON,
   Map,
   Math,
   NaN,
   Number,
   Object,
+  Promise,
+  Proxy,
+  RangeError,
+  ReferenceError,
+  Reflect,
   RegExp,
-  Response,
   Set,
+  SharedArrayBuffer,
   String,
   Symbol,
+  SyntaxError,
+  TypeError,
+  URIError,
+  Uint16Array,
+  Uint32Array,
+  Uint8Array,
+  Uint8ClampedArray,
+  WeakMap,
+  WeakRef,
+  WeakSet,
   decodeURI,
   decodeURIComponent,
   encodeURI,
   encodeURIComponent,
-  false: false,
-  fetch: fetchWrapper,
+  eval,
+  false: false, // treat like a global
+  fetch: fetchWrapper, // special case
+  globalThis,
   isFinite,
   isNaN,
-  null: null,
+  null: null, // treat like a global
   parseFloat,
   parseInt,
-  true: true,
-  undefined: undefined,
+  true: true, // treat like a global
+  undefined,
 };
+
+async function fetchWrapper(resource, options) {
+  const response = await fetch(resource, options);
+  return response.ok ? await response.arrayBuffer() : undefined;
+}

package/src/calc/calc.js

@@ -1,81 +0,0 @@
-import { Tree } from "@weborigami/async-tree";
-import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
-
-export function add(...args) {
-  console.warn(`Warning: "add" is deprecated. Use the "+" operator instead.`);
-  const numbers = args.map((arg) => Number(arg));
-  return numbers.reduce((acc, val) => acc + val, 0);
-}
-
-export function and(...args) {
-  console.warn(`Warning: "and" is deprecated. Use the "&&" operator instead.`);
-  return args.every((arg) => arg);
-}
-
-export function divide(a, b) {
-  console.warn(
-    `Warning: "divide" is deprecated. Use the "/" operator instead.`
-  );
-  return Number(a) / Number(b);
-}
-
-export function equals(a, b) {
-  console.warn(
-    `Warning: "equals" is deprecated. Use the "===" operator instead.`
-  );
-  return a === b;
-}
-
-/**
- * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
- *
- * @this {AsyncTree|null}
- * @param {any} value
- * @param {any} trueResult
- * @param {any} [falseResult]
- */
-export async function ifBuiltin(value, trueResult, falseResult) {
-  console.warn(
-    `Warning: "if" is deprecated. Use the conditional "a ? b : c" operator instead.`
-  );
-
-  assertTreeIsDefined(this, "calc:if");
-  let condition = await value;
-  if (Tree.isAsyncTree(condition)) {
-    const keys = Array.from(await condition.keys());
-    condition = keys.length > 0;
-  }
-
-  // 0 is true, null/undefined/false is false
-  let result = condition || condition === 0 ? trueResult : falseResult;
-  if (typeof result === "function") {
-    result = await result.call(this);
-  }
-  return result;
-}
-ifBuiltin.key = "if";
-
-export function multiply(...args) {
-  console.warn(
-    `Warning: "multiply" is deprecated. Use the "*" operator instead.`
-  );
-  const numbers = args.map((arg) => Number(arg));
-  return numbers.reduce((acc, val) => acc * val, 1);
-}
-
-export function not(value) {
-  console.warn(`Warning: "not" is deprecated. Use the "!" operator instead.`);
-  return !value;
-}
-
-export function or(...args) {
-  console.warn(`Warning: "or" is deprecated. Use the "||" operator instead.`);
-  return args.find((arg) => arg);
-}
-
-export function subtract(a, b) {
-  console.warn(
-    `Warning: "subtract" is deprecated. Use the "-" operator instead.`
-  );
-  return Number(a) - Number(b);
-}