@weborigami/origami 0.0.44 → 0.0.46

package/exports/buildExports.js

@@ -1,5 +1,5 @@
 /** @typedef {import("@weborigami/types").AsyncTree} AsyncTree */
-import { keyMapsForExtensions, map } from "@weborigami/async-tree";
+import { keyFunctionsForExtensions, map } from "@weborigami/async-tree";
 import unpackOrigamiTemplate from "../src/builtins/@loaders/ori.js";
 import { transformObject } from "../src/common/utilities.js";
 import PathTransform from "./PathTransform.js";
@@ -47,7 +47,8 @@ async function exportStatementForCode(codeBuffer, key) {
   const pathParts = path.split("/");
   pathParts.pop(); // Drop key
 
-  const exportsDefault = code.match(/^export default /m);
+  const exportsDefault =
+    code.match(/^export default /m) || code.match(/^export { default } /m);
   if (!exportsDefault) {
     // Export everything.
     return `export * from "../src/${path}";\n`;
@@ -76,12 +77,15 @@ async function exportStatementForCode(codeBuffer, key) {
     name = specialName;
   }
 
+  // Split the name into parts based on dots.
+  const nameParts = name.split(".");
+
   // Add the name to the parts.
-  exportIdentifierParts.push(name);
+  exportIdentifierParts.push(...nameParts);
 
-  // Remove the @ prefix from any parts, if present.
+  // Remove characters that can't be in JavaScript identifiers.
   exportIdentifierParts = exportIdentifierParts.map((part) =>
-    part.startsWith("@") ? part.slice(1) : part
+    part.replace(/[^a-zA-Z0-9]/g, "")
   );
 
   // Join the parts in camelCase to form the identifier.
@@ -101,8 +105,8 @@ function exportStatements(src) {
   // Map each source file to an export statement.
   const mapped = map({
     deep: true,
-    valueMap: exportStatementForCode,
-    ...keyMapsForExtensions({ sourceExtension: "js" }),
+    value: exportStatementForCode,
+    ...keyFunctionsForExtensions({ sourceExtension: "js" }),
   })(withPaths);
 
   return mapped;

package/exports/exports.js

@@ -38,26 +38,28 @@ export { default as js } from "../src/builtins/@js.js";
 export { default as json } from "../src/builtins/@json.js";
 export { default as keys } from "../src/builtins/@keys.js";
 export { default as keysJson } from "../src/builtins/@keysJson.js";
-export * from "../src/builtins/@loaders/css.js";
-export * from "../src/builtins/@loaders/htm.js";
-export * from "../src/builtins/@loaders/html.js";
+export { default as loadersCss } from "../src/builtins/@loaders/css.js";
+export { default as loadersHtm } from "../src/builtins/@loaders/htm.js";
+export { default as loadersHtml } from "../src/builtins/@loaders/html.js";
 export { default as loadersJpeg } from "../src/builtins/@loaders/jpeg.js";
-export * from "../src/builtins/@loaders/jpg.js";
+export { default as loadersJpg } from "../src/builtins/@loaders/jpg.js";
 export { default as loadersJs } from "../src/builtins/@loaders/js.js";
 export { default as loadersJson } from "../src/builtins/@loaders/json.js";
-export * from "../src/builtins/@loaders/md.js";
-export * from "../src/builtins/@loaders/mjs.js";
+export { default as loadersMd } from "../src/builtins/@loaders/md.js";
+export { default as loadersMjs } from "../src/builtins/@loaders/mjs.js";
 export { default as loadersOri } from "../src/builtins/@loaders/ori.js";
 export { default as loadersTxt } from "../src/builtins/@loaders/txt.js";
-export * from "../src/builtins/@loaders/xhtml.js";
+export { default as loadersWasm } from "../src/builtins/@loaders/wasm.js";
+export { default as loadersXhtml } from "../src/builtins/@loaders/xhtml.js";
 export { default as loadersYaml } from "../src/builtins/@loaders/yaml.js";
-export * from "../src/builtins/@loaders/yml.js";
+export { default as loadersYml } from "../src/builtins/@loaders/yml.js";
 export { default as map } from "../src/builtins/@map.js";
 export { default as mapDeep } from "../src/builtins/@mapDeep.js";
 export { default as match } from "../src/builtins/@match.js";
 export { default as mdHtml } from "../src/builtins/@mdHtml.js";
 export { default as merge } from "../src/builtins/@merge.js";
 export { default as mergeDeep } from "../src/builtins/@mergeDeep.js";
+export { default as mkdir } from "../src/builtins/@mkdir.js";
 export { default as node } from "../src/builtins/@node.js";
 export { default as not } from "../src/builtins/@not.js";
 export { default as once } from "../src/builtins/@once.js";

package/package.json

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

package/src/builtins/@cache.js

@@ -1,4 +1,4 @@
-import { cache, Tree } from "@weborigami/async-tree";
+import { Tree, cache } from "@weborigami/async-tree";
 import { Scope } from "@weborigami/language";
 import assertScopeIsDefined from "../misc/assertScopeIsDefined.js";
 
@@ -19,14 +19,10 @@ export default async function cacheBuiltin(
   filterTreelike
 ) {
   assertScopeIsDefined(this, "cache");
-
-  const sourceTree = Tree.from(sourceTreelike);
   /** @type {any} */
   const cacheTree = cacheTreelike ? Tree.from(cacheTreelike) : undefined;
-  const filterTree = filterTreelike ? Tree.from(filterTreelike) : undefined;
-
   /** @type {AsyncTree} */
-  let result = cache(sourceTree, cacheTree, filterTree);
+  let result = cache(sourceTreelike, cacheTree, filterTreelike);
   result = Scope.treeWithScope(result, this);
   return result;
 }

package/src/builtins/@loaders/json.js

@@ -1,8 +1,14 @@
+import * as utilities from "../../common/utilities.js";
+
 /**
  * Load a file as JSON.
  *
  * @type {import("@weborigami/language").FileUnpackFunction}
  */
 export default function unpackJson(input) {
-  return JSON.parse(String(input));
+  const json = utilities.toString(input);
+  if (!json) {
+    throw new Error("Tried to parse something as JSON but it wasn't text.");
+  }
+  return JSON.parse(json);
 }

package/src/builtins/@loaders/txt.js

@@ -1,5 +1,6 @@
 import TextDocument from "../../common/TextDocument.js";
 import { evaluateYaml } from "../../common/serialize.js";
+import * as utilities from "../../common/utilities.js";
 
 /**
  * Load a file as text document with possible front matter.
@@ -16,7 +17,10 @@ import { evaluateYaml } from "../../common/serialize.js";
  */
 export default async function unpackText(input, options = {}) {
   const parent = options.parent ?? null;
-  const text = String(input);
+  const text = utilities.toString(input);
+  if (!text) {
+    throw new Error("Tried to treat something as text but it wasn't text.");
+  }
   const regex =
     /^(---\r?\n(?<frontText>[\s\S]*?\r?\n)---\r?\n)(?<body>[\s\S]*$)/;
   const match = regex.exec(text);

package/src/builtins/@loaders/wasm.js

@@ -0,0 +1,11 @@
+import processUnpackedContent from "../../common/processUnpackedContent.js";
+
+/**
+ * Load a WebAssembly module and return its exports.
+ *
+ * @type {import("@weborigami/language").FileUnpackFunction}
+ */
+export default async function unpackWasm(buffer, options = {}) {
+  const wasmModule = await WebAssembly.instantiate(buffer);
+  return processUnpackedContent(wasmModule.instance.exports, options.parent);
+}

package/src/builtins/@loaders/yaml.js

@@ -1,6 +1,7 @@
 import * as YAMLModule from "yaml";
 import processUnpackedContent from "../../common/processUnpackedContent.js";
 import { evaluateYaml } from "../../common/serialize.js";
+import * as utilities from "../../common/utilities.js";
 
 // See notes at serialize.js
 // @ts-ignore
@@ -13,6 +14,10 @@ const YAML = YAMLModule.default ?? YAMLModule.YAML;
  */
 export default async function unpackYaml(input, options = {}) {
   const parent = options.parent ?? null;
-  const data = await evaluateYaml(String(input), options.parent);
+  const yaml = utilities.toString(input);
+  if (!yaml) {
+    throw new Error("Tried to parse something as YAML but it wasn't text.");
+  }
+  const data = await evaluateYaml(yaml, options.parent);
   return processUnpackedContent(data, parent);
 }

package/src/builtins/@map.js

@@ -1,8 +1,7 @@
 import {
-  cachedKeyMaps,
-  keyMapsForExtensions,
+  cachedKeyFunctions,
+  keyFunctionsForExtensions,
   map,
-  Tree,
 } from "@weborigami/async-tree";
 import { Scope } from "@weborigami/language";
 import addValueKeyToScope from "../common/addValueKeyToScope.js";
@@ -18,9 +17,9 @@ import { toFunction } from "../common/utilities.js";
  * @typedef {import("../../index.ts").TreelikeTransform} TreelikeTransform
  * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
  *
- * @typedef {{ deep?: boolean, description?: string, extensions?: string,
- * inverseKeyMap?: KeyFn, keyMap?: ValueKeyFn, valueMap?: ValueKeyFn }}
- * TreeMapOptions
+ * @typedef {{ deep?: boolean, description?: string, extension?: string,
+ * extensions?: string, inverseKey?: KeyFn, key?: ValueKeyFn, keyMap?:
+ * ValueKeyFn, value?: ValueKeyFn, valueFn?: ValueKeyFn }} TreeMapOptions
  *
  * @this {import("@weborigami/types").AsyncTree|null}
  *
@@ -43,7 +42,7 @@ import { toFunction } from "../common/utilities.js";
  * @returns {AsyncTree}
  */
 export default function treeMap(param1, param2) {
-  // Identify whether the valueMap/options are the first parameter
+  // Identify whether the valueFn/options are the first parameter
   // or the second.
   let source;
   let options;
@@ -62,37 +61,32 @@ export default function treeMap(param1, param2) {
     options = param2;
   }
 
-  // Identify whether the valueMap/options is a valueMap function
+  // Identify whether the valueFn/options is a valueFn function
   // or an options dictionary.
-  let valueMap;
+  let valueFn;
   if (
     typeof options === "function" ||
     typeof (/** @type {any} */ (options)?.unpack) === "function"
   ) {
-    valueMap = options;
+    valueFn = options;
     options = {};
   } else if (!options) {
     throw new TypeError(
-      `@map: You must specify a valueMap function or options dictionary.`
+      `@map: You must specify a value function or options dictionary.`
     );
   } else {
-    valueMap = options.valueMap;
+    valueFn = options.value ?? options.valueMap;
   }
 
-  let {
-    deep,
-    description,
-    extensions,
-    inverseKeyMap,
-    keyMap,
-    needsSourceValue,
-  } = options;
+  let { deep, description, inverseKey, needsSourceValue } = options;
+  let extension = options.extension ?? options.extensions;
+  let keyFn = options.keyMap ?? options.key;
 
-  description ??= `@map ${extensions ?? ""}`;
+  description ??= `@map ${extension ?? ""}`;
 
-  if (extensions && (keyMap || inverseKeyMap)) {
+  if (extension && (keyFn || inverseKey)) {
     throw new TypeError(
-      `@map: You can't specify both extensions and a keyMap or inverseKeyMap`
+      `@map: You can't specify extensions and also a key or inverseKey function`
     );
   }
 
@@ -100,8 +94,8 @@ export default function treeMap(param1, param2) {
 
   // Extend the value function to include the value and key in scope.
   let extendedValueFn;
-  if (valueMap) {
-    const resolvedValueFn = toFunction(valueMap);
+  if (valueFn) {
+    const resolvedValueFn = toFunction(valueFn);
     extendedValueFn = function (sourceValue, sourceKey, tree) {
       const scope = addValueKeyToScope(baseScope, sourceValue, sourceKey);
       return resolvedValueFn.call(scope, sourceValue, sourceKey, tree);
@@ -109,18 +103,18 @@ export default function treeMap(param1, param2) {
   }
 
   // Extend the key function to include the value and key in scope.
-  let extendedKeyMap;
-  let extendedInverseKeyMap;
-  if (extensions) {
-    let { resultExtension, sourceExtension } = parseExtensions(extensions);
-    const keyFns = keyMapsForExtensions({
+  let extendedKeyFn;
+  let extendedInverseKeyFn;
+  if (extension) {
+    let { resultExtension, sourceExtension } = parseExtensions(extension);
+    const keyFns = keyFunctionsForExtensions({
       resultExtension,
       sourceExtension,
     });
-    extendedKeyMap = keyFns.keyMap;
-    extendedInverseKeyMap = keyFns.inverseKeyMap;
-  } else if (keyMap) {
-    const resolvedKeyFn = toFunction(keyMap);
+    extendedKeyFn = keyFns.key;
+    extendedInverseKeyFn = keyFns.inverseKey;
+  } else if (keyFn) {
+    const resolvedKeyFn = toFunction(keyFn);
     async function scopedKeyFn(sourceKey, tree) {
       const sourceValue = await tree.get(sourceKey);
       const scope = addValueKeyToScope(baseScope, sourceValue, sourceKey);
@@ -132,25 +126,24 @@ export default function treeMap(param1, param2) {
       );
       return resultKey;
     }
-    const keyFns = cachedKeyMaps(scopedKeyFn);
-    extendedKeyMap = keyFns.keyMap;
-    extendedInverseKeyMap = keyFns.inverseKeyMap;
+    const keyFns = cachedKeyFunctions(scopedKeyFn);
+    extendedKeyFn = keyFns.key;
+    extendedInverseKeyFn = keyFns.inverseKey;
   } else {
-    // Use sidecar keyMap/inverseKeyMap functions if the valueMap defines them.
-    extendedKeyMap = valueMap?.keyMap;
-    extendedInverseKeyMap = valueMap?.inverseKeyMap;
+    // Use sidecar keyFn/inverseKey functions if the valueFn defines them.
+    extendedKeyFn = valueFn?.key;
+    extendedInverseKeyFn = valueFn?.inverseKey;
   }
 
   const transform = function mapTreelike(treelike) {
-    const tree = Tree.from(treelike);
     return map({
       deep,
       description,
-      inverseKeyMap: extendedInverseKeyMap,
-      keyMap: extendedKeyMap,
+      inverseKey: extendedInverseKeyFn,
+      key: extendedKeyFn,
       needsSourceValue,
-      valueMap: extendedValueFn,
-    })(tree);
+      value: extendedValueFn,
+    })(treelike);
   };
 
   return source ? transform(source) : transform;

package/src/builtins/@mapDeep.js

@@ -2,7 +2,7 @@ import { isPlainObject } from "@weborigami/async-tree";
 import treeMap from "./@map.js";
 
 export default function mapDeep(param1, param2) {
-  // Identify whether the valueMap/options are the first parameter
+  // Identify whether the valueFn/options are the first parameter
   // or the second.
   let source;
   let options;
@@ -13,7 +13,7 @@ export default function mapDeep(param1, param2) {
     if (isPlainObject(param2)) {
       options = param2;
     } else {
-      options = { valueMap: param2 };
+      options = { value: param2 };
     }
   }
 

package/src/builtins/@mdHtml.js

@@ -42,9 +42,8 @@ export default async function mdHtml(input) {
     : html;
 }
 
-mdHtml.keyMap = (sourceKey) => replaceExtension(sourceKey, ".md", ".html");
-mdHtml.inverseKeyMap = (resultKey) =>
-  replaceExtension(resultKey, ".html", ".md");
+mdHtml.key = (sourceKey) => replaceExtension(sourceKey, ".md", ".html");
+mdHtml.inverseKey = (resultKey) => replaceExtension(resultKey, ".html", ".md");
 
 mdHtml.usage = `@mdHtml <markdown>\tRender the markdown text as HTML`;
 mdHtml.documentation = "https://weborigami.org/language/@mdHtml.html";

package/src/builtins/@mkdir.js

@@ -0,0 +1,3 @@
+// For now this is a synonym for @files.
+// If we like it, it might replace @files.
+export { default } from "./@files.js";

package/src/builtins/@node.js

@@ -7,7 +7,8 @@ import url from "node:url";
 const patchedProcess = Object.create(null, {
   ...Object.getOwnPropertyDescriptors(process),
   env: {
-    value: function () {
+    enumerable: true,
+    get: function () {
       return Object.assign({}, process.env);
     },
   },

package/src/builtins/@ori.js

@@ -73,13 +73,13 @@ async function formatResult(result) {
     text = result;
   }
 
-  // If the result is a tree, attach the tree to the text output.
+  // If the result is treelike, attach it to the text output.
   if (Tree.isTreelike(result)) {
     if (typeof text === "string") {
       // @ts-ignore
       text = new String(text);
     }
-    /** @type {any} */ (text).unpack = () => Tree.from(result);
+    /** @type {any} */ (text).unpack = () => result;
   }
 
   return text;

package/src/builtins/map.d.ts

@@ -6,12 +6,12 @@ type TreeMapOptions = {
   deep?: boolean;
   description?: string;
   extensions?: string;
-  inverseKeyMap?: KeyFn;
-  keyMap?: ValueKeyFn;
-  valueMap?: ValueKeyFn;
+  inverseKey?: KeyFn;
+  key?: ValueKeyFn;
+  value?: ValueKeyFn;
 };
 
-export default function treeMap(valueMap: ValueKeyFn): TreelikeTransform;
+export default function treeMap(value: ValueKeyFn): TreelikeTransform;
 export default function treeMap(options: TreeMapOptions): TreelikeTransform;
-export default function treeMap(treelike: Treelike, valueMap: ValueKeyFn): AsyncTree;
+export default function treeMap(treelike: Treelike, value: ValueKeyFn): AsyncTree;
 export default function treeMap(treelike: Treelike, options: TreeMapOptions): AsyncTree;

package/src/common/arrowFunctionsMap.js

@@ -1,4 +1,4 @@
-import { cachedKeyMaps, map } from "@weborigami/async-tree";
+import { cachedKeyFunctions, map } from "@weborigami/async-tree";
 import { toFunction } from "./utilities.js";
 
 export default function arrowFunctionsMap() {
@@ -6,12 +6,12 @@ export default function arrowFunctionsMap() {
   return map({
     deep,
     description: "arrowFunctions",
-    valueMap,
-    ...cachedKeyMaps(keyMap, deep),
+    value: valueFn,
+    ...cachedKeyFunctions(keyFn, deep),
   });
 }
 
-function keyMap(sourceKey, tree) {
+function keyFn(sourceKey, tree) {
   return parseArrowKey(sourceKey) ?? sourceKey;
 }
 
@@ -23,7 +23,7 @@ function parseArrowKey(sourceKey) {
   return match?.groups.lhs;
 }
 
-function valueMap(sourceValue, sourceKey, tree) {
+function valueFn(sourceValue, sourceKey, tree) {
   let resultValue;
   if (parseArrowKey(sourceKey)) {
     // Treat the value as a function to be invoked.

package/src/misc/treeDot.js

@@ -78,7 +78,12 @@ async function statements(tree, nodePath, nodeLabel, options) {
     } else {
       const label = isStringLike(value)
         ? String(value)
-        : await serialize.toYaml(value);
+        : value != null
+        ? await serialize.toYaml(value)
+        : "";
+      if (value == null) {
+        isError = true;
+      }
       nodes[key] = { label };
       if (isError) {
         nodes[key].isError = true;

package/src/builtins/!.js

@@ -1,21 +0,0 @@
-/**
- * The `!` built-in returns `undefined`, and is intended for force function
- * invocation in the shell without requiring the use of parentheses. Parentheses
- * can't be used in the shell without quoting them, which is inconvenient.
- *
- * This parentheses form:
- *
- * ```
- * $ ori "fn1.js(fn2.js())"
- * ```
- *
- * Can be written as:
- *
- * ```
- * $ ori fn1.js fn2.js !
- * ```
- *
- * This forces the invocation of `fn2.js`, passing `undefined` as the argument.
- * The result of that invocation is then passed to `fn1.js`.
- */
-export default undefined;