@weborigami/origami 0.0.54 → 0.0.56

package/exports/buildExports.js

@@ -6,11 +6,9 @@ import PathTransform from "./PathTransform.js";
 
 // For builtins that should be renamed or not exported
 const specialBuiltinNames = {
-  "!": null,
-  "@false": null,
-  "@new": null,
-  "@true": null,
-  "~": "homeFiles",
+  constructor: null,
+  false: null,
+  true: null,
 };
 
 // Top-level template for the export file
@@ -44,8 +42,6 @@ async function exportStatementForCode(codeBuffer, key) {
 
   // @ts-ignore
   const path = codeBuffer[PathTransform.pathKey] ?? "";
-  const pathParts = path.split("/");
-  pathParts.pop(); // Drop key
 
   const exportsDefault =
     code.match(/^export default /m) || code.match(/^export { default } /m);
@@ -54,47 +50,46 @@ async function exportStatementForCode(codeBuffer, key) {
     return `export * from "../src/${path}";\n`;
   }
 
-  // Export a single default export.
+  // Single export
 
   // We construct an identifier for the export based on the path to the file and
   // the file name. This omits the first part of the path, which is the name of
-  // a folder that's a direct child of the `src` folder. The remaining parts are
-  // joined in camelCase to form the export name. We remove the `@` prefix from
-  // any parts that start with it. As an example, the file inside the src folder
-  // at `builtins/@tree/concat.js` will be identified as `treeConcat`.
-  let exportIdentifierParts = pathParts.slice(1);
+  // a folder that's a direct child of the `src` folder. We omit the `.js`
+  // extension, and remove any characters that aren't valid in JS identifiers.
+  // We use camelCase to combine the parts. As an example, the file inside the
+  // src folder at `builtins/@image/format.js` will be identified as
+  // `imageFormat`.
 
-  // The file name is the last part of the path; remove the .js extension.
-  let name = key.slice(0, -3);
+  // Split the name into parts wherever there are characters that can't be in
+  // JavaScript identifiers; drop any empty parts.
+  const parts = path.split(/[^a-zA-Z0-9]/g).filter(Boolean);
+
+  // Drop the first (folder) part and the last (`.js`) part.
+  parts.shift();
+  parts.pop();
+
+  // Join the parts in camelCase to form the identifier.
+  let identifier = parts
+    .map((part, index) =>
+      index === 0 ? part : part[0].toUpperCase() + part.slice(1)
+    )
+    .join("");
+
+  if (!identifier) {
+    // Name is entirely non-JS characters, like `~`. For now we ignore it.
+    return "";
+  }
 
   // Ignore certain builtins like `@true` and `@false` that would conflict with
   // JavaScript keywords. Developers can use those JavaScript keywords directly.
-  const specialName = specialBuiltinNames[name];
+  const specialName = specialBuiltinNames[identifier];
   if (specialName === null) {
     return "";
   }
   if (specialName) {
-    name = specialName;
+    identifier = specialName;
   }
 
-  // Split the name into parts based on dots.
-  const nameParts = name.split(".");
-
-  // Add the name to the parts.
-  exportIdentifierParts.push(...nameParts);
-
-  // Remove characters that can't be in JavaScript identifiers.
-  exportIdentifierParts = exportIdentifierParts.map((part) =>
-    part.replace(/[^a-zA-Z0-9]/g, "")
-  );
-
-  // Join the parts in camelCase to form the identifier.
-  const identifier = exportIdentifierParts
-    .map((part, index) =>
-      index === 0 ? part : part[0].toUpperCase() + part.slice(1)
-    )
-    .join("");
-
   return `export { default as ${identifier} } from "../src/${path}";\n`;
 }
 

package/exports/exports.js

@@ -8,7 +8,6 @@ export { default as changes } from "../src/builtins/@changes.js";
 export { default as clean } from "../src/builtins/@clean.js";
 export { default as concat } from "../src/builtins/@concat.js";
 export { default as config } from "../src/builtins/@config.js";
-export { default as constructor } from "../src/builtins/@constructor.js";
 export { default as copy } from "../src/builtins/@copy.js";
 export { default as crawl } from "../src/builtins/@crawl.js";
 export { default as debug } from "../src/builtins/@debug.js";
@@ -106,22 +105,21 @@ export { default as values } from "../src/builtins/@values.js";
 export { default as watch } from "../src/builtins/@watch.js";
 export { default as yaml } from "../src/builtins/@yaml.js";
 export { default as yamlParse } from "../src/builtins/@yamlParse.js";
-export { default as homeFiles } from "../src/builtins/~.js";
-export { default as csshandler } from "../src/builtins/css_handler.js";
-export { default as htmhandler } from "../src/builtins/htm_handler.js";
-export { default as htmlhandler } from "../src/builtins/html_handler.js";
-export { default as jpeghandler } from "../src/builtins/jpeg_handler.js";
-export { default as jpghandler } from "../src/builtins/jpg_handler.js";
-export { default as jshandler } from "../src/builtins/js_handler.js";
-export { default as jsonhandler } from "../src/builtins/json_handler.js";
-export { default as mdhandler } from "../src/builtins/md_handler.js";
-export { default as mjshandler } from "../src/builtins/mjs_handler.js";
-export { default as orihandler } from "../src/builtins/ori_handler.js";
-export { default as txthandler } from "../src/builtins/txt_handler.js";
-export { default as wasmhandler } from "../src/builtins/wasm_handler.js";
-export { default as xhtmlhandler } from "../src/builtins/xhtml_handler.js";
-export { default as yamlhandler } from "../src/builtins/yaml_handler.js";
-export { default as ymlhandler } from "../src/builtins/yml_handler.js";
+export { default as cssHandler } from "../src/builtins/css_handler.js";
+export { default as htmHandler } from "../src/builtins/htm_handler.js";
+export { default as htmlHandler } from "../src/builtins/html_handler.js";
+export { default as jpegHandler } from "../src/builtins/jpeg_handler.js";
+export { default as jpgHandler } from "../src/builtins/jpg_handler.js";
+export { default as jsHandler } from "../src/builtins/js_handler.js";
+export { default as jsonHandler } from "../src/builtins/json_handler.js";
+export { default as mdHandler } from "../src/builtins/md_handler.js";
+export { default as mjsHandler } from "../src/builtins/mjs_handler.js";
+export { default as oriHandler } from "../src/builtins/ori_handler.js";
+export { default as txtHandler } from "../src/builtins/txt_handler.js";
+export { default as wasmHandler } from "../src/builtins/wasm_handler.js";
+export { default as xhtmlHandler } from "../src/builtins/xhtml_handler.js";
+export { default as yamlHandler } from "../src/builtins/yaml_handler.js";
+export { default as ymlHandler } from "../src/builtins/yml_handler.js";
 export { default as defaultModuleExport } from "../src/cli/defaultModuleExport.js";
 export { default as showUsage } from "../src/cli/showUsage.js";
 export { default as addValueKeyToScope } from "../src/common/addValueKeyToScope.js";
@@ -140,7 +138,6 @@ export { default as assertScopeIsDefined } from "../src/misc/assertScopeIsDefine
 export { default as getTreeArgument } from "../src/misc/getTreeArgument.js";
 export { default as OriCommandTransform } from "../src/misc/OriCommandTransform.js";
 export { default as treeDot } from "../src/misc/treeDot.js";
-export { default as yamlOrigamiTag } from "../src/misc/yamlOrigamiTag.js";
 export { default as constructResponse } from "../src/server/constructResponse.js";
 export * from "../src/server/mediaTypes.js";
 export * from "../src/server/server.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@weborigami/origami",
-  "version": "0.0.54",
+  "version": "0.0.56",
   "description": "Web Origami language, CLI, framework, and server",
   "type": "module",
   "repository": {
@@ -17,9 +17,9 @@
     "typescript": "5.4.5"
   },
   "dependencies": {
-    "@weborigami/async-tree": "0.0.54",
-    "@weborigami/language": "0.0.54",
-    "@weborigami/types": "0.0.54",
+    "@weborigami/async-tree": "0.0.56",
+    "@weborigami/language": "0.0.56",
+    "@weborigami/types": "0.0.56",
     "exif-parser": "0.1.12",
     "graphviz-wasm": "3.0.2",
     "highlight.js": "11.9.0",

package/src/builtins/@clean.js

@@ -8,7 +8,7 @@ import getTreeArgument from "../misc/getTreeArgument.js";
  * @param {import("@weborigami/async-tree").Treelike} treelike
  */
 export default async function clean(treelike) {
-  const tree = await getTreeArgument(this, arguments, treelike, "@sequence");
+  const tree = await getTreeArgument(this, arguments, treelike, "@clean");
   if (!Tree.isAsyncMutableTree(tree)) {
     throw new TypeError("@clean: the given tree is read-only.");
   }

package/src/builtins/@deepReverse.js

@@ -1,13 +1,19 @@
-import reverse from "./@reverse.js";
+import { deepReverse } from "@weborigami/async-tree";
+import { Scope } from "@weborigami/language";
+import getTreeArgument from "../misc/getTreeArgument.js";
 
 /**
- * Shorthand for reversing a tree with the `deep` option set to true.
- * 
- * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
-
-* @this {AsyncTree|null}
- * @param {*} treelike 
+ * Reverse the order of keys at all levels of the tree.
+ *
+ * @typedef  {import("@weborigami/types").AsyncTree} AsyncTree
+ * @typedef {import("@weborigami/async-tree").Treelike} Treelike
+ *
+ * @this {AsyncTree|null}
+ * @param {Treelike} [treelike]
  */
-export default function deepReverse(treelike) {
-  return reverse.call(this, treelike, { deep: true });
+export default async function deepReverseBuiltin(treelike) {
+  const tree = await getTreeArgument(this, arguments, treelike, "@deepReverse");
+  let reversed = deepReverse(tree);
+  reversed = Scope.treeWithScope(reversed, this);
+  return reversed;
 }

package/src/builtins/@merge.js

@@ -55,25 +55,5 @@ export default async function treeMerge(...trees) {
   return result;
 }
 
-/**
- * Merge the indicated plain objects. If a key is present in multiple objects,
- * the value from the first object is used.
- *
- * This is similar to calling Object.assign() with the objects in reverse order,
- * but we want to ensure the keys end up in the same order they're encountered
- * in the objects.
- *
- * @param  {...any} objects
- */
-function mergeObjects(...objects) {
-  const result = {};
-  for (const obj of objects) {
-    for (const key of Object.keys(obj)) {
-      result[key] ??= obj[key];
-    }
-  }
-  return result;
-}
-
 treeMerge.usage = `@merge <...trees>\tMerge the given trees`;
 treeMerge.documentation = "https://weborigami.org/cli/builtins.html#@merge";

package/src/builtins/@reverse.js

@@ -1,4 +1,4 @@
-import { Tree } from "@weborigami/async-tree";
+import { reverse } from "@weborigami/async-tree";
 import { Scope } from "@weborigami/language";
 import getTreeArgument from "../misc/getTreeArgument.js";
 
@@ -7,40 +7,16 @@ import getTreeArgument from "../misc/getTreeArgument.js";
  *
  * @typedef  {import("@weborigami/types").AsyncTree} AsyncTree
  * @typedef {import("@weborigami/async-tree").Treelike} Treelike
- * @typedef {import("@weborigami/async-tree").PlainObject} PlainObject
  *
  * @this {AsyncTree|null}
  * @param {Treelike} [treelike]
- * @param {PlainObject} [options]
  */
-export default async function reverse(treelike, options = {}) {
+export default async function reverseBuiltin(treelike) {
   const tree = await getTreeArgument(this, arguments, treelike, "@reverse");
-  const scope = this;
-  const deep = options.deep ?? false;
-
-  /** @type {AsyncTree} */
-  let reversed = {
-    async get(key) {
-      let value = await tree.get(key);
-
-      if (deep && Tree.isAsyncTree(value)) {
-        value = reverse.call(scope, value, options);
-      }
-
-      return value;
-    },
-
-    async keys() {
-      const keys = Array.from(await tree.keys());
-      keys.reverse();
-      return keys;
-    },
-  };
-
+  let reversed = reverse(tree);
   reversed = Scope.treeWithScope(reversed, this);
-
   return reversed;
 }
 
-reverse.usage = `@reverse <tree>\tReverses the order of the tree's top-level keys`;
-reverse.documentation = "https://weborigami.org/cli/builtins.html#reverse";
+reverseBuiltin.usage = `@reverse <tree>\tReverses the order of the tree's top-level keys`;
+reverseBuiltin.documentation = "https://weborigami.org/builtins/@reverse.html";

package/src/builtins/txt_handler.js

@@ -1,5 +1,5 @@
 import { isPacked, symbols } from "@weborigami/async-tree";
-import { evaluateYaml, toYaml } from "../common/serialize.js";
+import { parseYaml, toYaml } from "../common/serialize.js";
 import * as utilities from "../common/utilities.js";
 
 /**
@@ -51,7 +51,7 @@ export default {
   },
 
   /** @type {import("@weborigami/language").UnpackFunction} */
-  async unpack(packed, options = {}) {
+  unpack(packed, options = {}) {
     const parent = options.parent ?? null;
     const text = utilities.toString(packed);
     if (text === null) {
@@ -65,7 +65,7 @@ export default {
     if (match) {
       // Document object with front matter
       const { body, frontText } = /** @type {any} */ (match.groups);
-      const frontData = await evaluateYaml(frontText, parent);
+      const frontData = parseYaml(frontText);
       unpacked = Object.assign({}, frontData, { "@text": body });
     } else {
       // Plain text

package/src/builtins/yaml_handler.js

@@ -1,6 +1,6 @@
 import * as YAMLModule from "yaml";
 import processUnpackedContent from "../common/processUnpackedContent.js";
-import { evaluateYaml } from "../common/serialize.js";
+import { parseYaml } from "../common/serialize.js";
 import * as utilities from "../common/utilities.js";
 
 // See notes at serialize.js
@@ -17,13 +17,13 @@ export default {
   mediaType: "application/yaml",
 
   /** @type {import("@weborigami/language").UnpackFunction} */
-  async unpack(packed, options = {}) {
+  unpack(packed, options = {}) {
     const parent = options.parent ?? null;
     const yaml = utilities.toString(packed);
     if (!yaml) {
       throw new Error("Tried to parse something as YAML but it wasn't text.");
     }
-    const data = await evaluateYaml(yaml, options.parent);
+    const data = parseYaml(yaml);
     return processUnpackedContent(data, parent);
   },
 };

package/src/common/serialize.js

@@ -5,10 +5,8 @@
  * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
  */
 
-import { Tree, isPlainObject, isStringLike } from "@weborigami/async-tree";
-import { OrigamiTree } from "@weborigami/language";
+import { Tree, isStringLike } from "@weborigami/async-tree";
 import * as YAMLModule from "yaml";
-import yamlOrigamiTag from "../misc/yamlOrigamiTag.js";
 
 const textDecoder = new TextDecoder();
 const TypedArray = Object.getPrototypeOf(Uint8Array);
@@ -48,35 +46,12 @@ function isJsonValue(obj) {
   );
 }
 
-// Return true if the given object has any functions in it.
-function objectContainsFunctions(obj) {
-  for (const key in obj) {
-    const value = obj[key];
-    if (typeof value === "function") {
-      return true;
-    } else if (isPlainObject(value)) {
-      const valueContainsExpression = objectContainsFunctions(value);
-      if (valueContainsExpression) {
-        return true;
-      }
-    }
-  }
-  return false;
-}
-
 /**
  * @param {string} text
  * @returns {JsonValue|AsyncTree}
  */
 export function parseYaml(text) {
-  const data = YAML.parse(text, {
-    customTags: [yamlOrigamiTag],
-  });
-  if (objectContainsFunctions(data)) {
-    return new OrigamiTree(data);
-  } else {
-    return data;
-  }
+  return YAML.parse(text);
 }
 
 /**

package/src/common/utilities.js

@@ -1,13 +1,10 @@
 import {
   Tree,
+  toString as asyncTreeToString,
   isPlainObject,
-  isStringLike,
   isUnpackable,
 } from "@weborigami/async-tree";
 
-const textDecoder = new TextDecoder();
-const TypedArray = Object.getPrototypeOf(Uint8Array);
-
 // Return true if the text appears to contain non-printable binary characters;
 // used to infer whether a file is binary or text.
 export function hasNonPrintableCharacters(text) {
@@ -86,17 +83,8 @@ export function toFunction(obj) {
 }
 
 /**
- * Return a string form of the object, handling two cases not generally handled
- * by a .toString() method:
- *
- * 1. If the object is a plain JavaScript object with a `@text` property, return
- *    the value of that property.
- * 2. If the object is an ArrayBuffer or TypedArray, decode the array as UTF-8.
- *
- * Finally, if the object is otherwise a plain JavaScript object with the
- * useless default toString() method, return null instead of "[object Object]".
- * In practice, it's generally more useful to have this method fail than to
- * return a useless string.
+ * Extend the async-tree toString method: objects that have a `@text` property
+ * will return the value of that property as a string.
  *
  * @param {any} object
  * @returns {string|null}
@@ -104,15 +92,8 @@ export function toFunction(obj) {
 export function toString(object) {
   if (isPlainObject(object) && "@text" in object) {
     return object["@text"];
-  } else if (object instanceof ArrayBuffer || object instanceof TypedArray) {
-    // Treat the buffer as UTF-8 text.
-    const decoded = textDecoder.decode(object);
-    // If the result has non-printable characters, it's probably not a string.
-    return hasNonPrintableCharacters(decoded) ? null : decoded;
-  } else if (isStringLike(object)) {
-    return String(object);
   } else {
-    return null;
+    return asyncTreeToString(object);
   }
 }
 

package/src/misc/treeDot.js

@@ -1,7 +1,11 @@
-import { Tree, isPlainObject, isStringLike } from "@weborigami/async-tree";
-import { extname } from "@weborigami/language";
+import {
+  Tree,
+  isPlainObject,
+  isStringLike,
+  toString,
+} from "@weborigami/async-tree";
 import * as serialize from "../common/serialize.js";
-import { hasNonPrintableCharacters, keySymbol } from "../common/utilities.js";
+import { keySymbol } from "../common/utilities.js";
 
 /**
  * Render a tree in DOT format.
@@ -61,23 +65,15 @@ async function statements(tree, nodePath, nodeLabel, options) {
           : error.name ?? error.message ?? error;
     }
 
-    // We expand certain types of files known to contain trees.
-    const extension = key ? extname(key).toLowerCase() : "";
-    const expand =
-      {
-        ".json": true,
-        ".yaml": true,
-      }[extension] ?? extension === "";
-
     const expandable =
       value instanceof Array || isPlainObject(value) || Tree.isAsyncTree(value);
-    if (expand && expandable) {
+    if (expandable) {
       const subtree = Tree.from(value);
       const subStatements = await statements(subtree, destPath, null, options);
       result = result.concat(subStatements);
     } else {
       const label = isStringLike(value)
-        ? String(value)
+        ? toString(value)
         : value !== undefined
         ? await serialize.toYaml(value)
         : "";
@@ -102,8 +98,8 @@ async function statements(tree, nodePath, nodeLabel, options) {
   // Trim labels.
   let i = 0;
   for (const key of Object.keys(nodes)) {
-    let label = String(nodes[key].label);
-    if (hasNonPrintableCharacters(label)) {
+    let label = nodes[key].label;
+    if (label === null) {
       nodes[key].label = "[binary data]";
     } else if (label) {
       let clippedStart = false;

package/src/misc/yamlOrigamiTag.js

@@ -1,17 +0,0 @@
-import { compile, expressionFunction } from "@weborigami/language";
-
-/**
- * A YAML tag for an Origami expression.
- */
-export default {
-  identify: expressionFunction.isExpressionFunction,
-
-  resolve(str) {
-    const code = compile.expression(str);
-    return code instanceof Array
-      ? expressionFunction.createExpressionFunction(code)
-      : code;
-  },
-
-  tag: "!ori",
-};