@weborigami/origami 0.0.43 → 0.0.45

package/exports/exports.js

@@ -38,18 +38,21 @@ 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 { 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 * from "../src/builtins/@loaders/css.js";
+export * from "../src/builtins/@loaders/htm.js";
+export * 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 loadersJs } from "../src/builtins/@loaders/js.js";
 export { default as loadersJson } from "../src/builtins/@loaders/json.js";
-export { default as loadersMd } from "../src/builtins/@loaders/md.js";
-export { default as loadersMjs } from "../src/builtins/@loaders/mjs.js";
+export * from "../src/builtins/@loaders/md.js";
+export * 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 { default as loadersXhtml } from "../src/builtins/@loaders/xhtml.js";
+export { default as loadersWasm } from "../src/builtins/@loaders/wasm.js";
+export * from "../src/builtins/@loaders/xhtml.js";
 export { default as loadersYaml } from "../src/builtins/@loaders/yaml.js";
-export { default as loadersYml } from "../src/builtins/@loaders/yml.js";
+export * 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";

package/package.json

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

package/src/builtins/@arrows.js

@@ -1,8 +1,8 @@
 import { Scope, functionResultsMap } from "@weborigami/language";
-import builtins from "../../src/builtins/@builtins.js";
 import arrowFunctionsMap from "../common/arrowFunctionsMap.js";
 import { keySymbol } from "../common/utilities.js";
 import getTreeArgument from "../misc/getTreeArgument.js";
+import builtins from "./@builtins.js";
 
 /**
  * Interpret arrow keys in the tree as function calls.

package/src/builtins/@count.js

@@ -10,7 +10,7 @@ import getTreeArgument from "../misc/getTreeArgument.js";
  */
 export default async function count(treelike) {
   const tree = await getTreeArgument(this, arguments, treelike, "@count");
-  const keys = [...(await tree.keys())];
+  const keys = Array.from(await tree.keys());
   return keys.length;
 }
 

package/src/builtins/@inline.js

@@ -1,3 +1,4 @@
+import { Tree, isPlainObject } from "@weborigami/async-tree";
 import { compile } from "@weborigami/language";
 import unpackText from "../builtins/@loaders/txt.js";
 import assertScopeIsDefined from "../misc/assertScopeIsDefined.js";
@@ -28,7 +29,17 @@ export default async function inline(input) {
     inputDocument = await unpackText(input);
   }
 
+  // If the input document is a plain object or AsyncTree, we'll have it
+  // included in scope for the evaluated expression. We ignore other kinds of
+  // treelike inputs for this test: in particular, a Buffer will be interpreted
+  // as a tree, but we don't want to put a Buffer in scope.
+  const attachedData =
+    isPlainObject(inputDocument) || Tree.isAsyncTree(inputDocument)
+      ? inputDocument
+      : null;
+
   const templateFn = await unpackOrigamiExpression(inputDocument, {
+    attachedData,
     compiler: compile.templateDocument,
   });
   const templateResult = await templateFn(inputDocument);

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

@@ -1,4 +1,2 @@
-import unpackText from "./txt.js";
-
-// Load this file type as text with possible front matter.
-export default unpackText;
+// .css files use the .txt loader
+export { default } from "./txt.js";

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

@@ -1,4 +1,2 @@
-import unpackText from "./txt.js";
-
-// Load this file type as text with possible front matter.
-export default unpackText;
+// .htm files use the .txt loader
+export { default } from "./txt.js";

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

@@ -1,4 +1,2 @@
-import unpackText from "./txt.js";
-
-// Load this file type as text with possible front matter.
-export default unpackText;
+// .html files use the .txt loader
+export { default } from "./txt.js";

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

@@ -0,0 +1,55 @@
+import exifParser from "exif-parser";
+
+const exifDateTags = [
+  "ModifyDate",
+  "MDPrepDate",
+  "DateTimeOriginal",
+  "CreateDate",
+  "PreviewDateTime",
+  "GPSDateStamp",
+];
+
+/**
+ * Load Exif data from a JPEG file.
+ *
+ * @type {import("@weborigami/language").FileUnpackFunction}
+ */
+export default async function unpackJpeg(buffer, options) {
+  const parser = exifParser.create(buffer);
+  parser.enableTagNames(true);
+  parser.enableSimpleValues(true);
+  const parsed = await parser.parse();
+
+  // The exif-parser `enableSimpleValues` option should convert dates to
+  // JavaScript Date objects, but that doesn't seem to work. Ensure dates are
+  // Date objects.
+  const exif = parsed.tags;
+  for (const tag of exifDateTags) {
+    if (typeof exif[tag] === "number") {
+      exif[tag] = new Date(exif[tag] * 1000);
+    }
+  }
+
+  const result = {
+    height: parsed.imageSize.height,
+    width: parsed.imageSize.width,
+    exif,
+  };
+
+  // Promote some Exif properties to the top level.
+  const tagsToPromote = {
+    ImageDescription: "caption",
+    ModifyDate: "modified",
+    Orientation: "orientation",
+  };
+  for (const [tag, key] of Object.entries(tagsToPromote)) {
+    if (exif[tag] !== undefined) {
+      result[key] = exif[tag];
+    }
+  }
+
+  // Add aspect ratio for use with `aspect-ratio` CSS.
+  result.aspectRatio = result.width / result.height;
+
+  return result;
+}

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

@@ -0,0 +1,2 @@
+// .jpg extension is a synonym for .jpeg
+export { default } from "./jpeg.js";

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/md.js

@@ -1,4 +1,2 @@
-import unpackText from "./txt.js";
-
-// Load this file type as text with possible front matter.
-export default unpackText;
+// .md files use the .txt loader
+export { default } from "./txt.js";

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

@@ -1,4 +1,2 @@
-import unpackModule from "./js.js";
-
-// .mjs modules use the same loader as .js modules.
-export default unpackModule;
+// .mjs files use the .js loader
+export { default } from "./js.js";

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

@@ -1,5 +1,4 @@
-import { Scope } from "@weborigami/language";
-import * as compile from "../../../../language/src/compiler/compile.js";
+import { Scope, compile, symbols } from "@weborigami/language";
 import processUnpackedContent from "../../common/processUnpackedContent.js";
 import * as utilities from "../../common/utilities.js";
 import builtins from "../@builtins.js";
@@ -13,10 +12,11 @@ export default async function unpackOrigamiExpression(
   inputDocument,
   options = {}
 ) {
+  const attachedData = options.attachedData;
   const parent =
     options.parent ??
     /** @type {any} */ (inputDocument).parent ??
-    /** @type {any} */ (inputDocument)[utilities.parentSymbol];
+    /** @type {any} */ (inputDocument)[symbols.parent];
 
   // Construct an object to represent the source code.
   const sourceName = options.key;
@@ -41,5 +41,5 @@ export default async function unpackOrigamiExpression(
   const parentScope = parent ? Scope.getScope(parent) : builtins;
   let content = await fn.call(parentScope);
 
-  return processUnpackedContent(content, parent, inputDocument);
+  return processUnpackedContent(content, parent, attachedData);
 }

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 .js file as module's default export or 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/xhtml.js

@@ -1,4 +1,2 @@
-import unpackText from "./txt.js";
-
-// Load this file type as text with possible front matter.
-export default unpackText;
+// .xhtml files use the .txt loader
+export { default } from "./txt.js";

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 = 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/@loaders/yml.js

@@ -1,4 +1,2 @@
-import yaml from "./yaml.js";
-
-// .yml files uses the YAML loader
-export default yaml;
+// .yml extension is a synonym for .yaml
+export { default } from "./yaml.js";

package/src/builtins/@node.js

@@ -2,10 +2,21 @@ 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: {
+    value: function () {
+      return Object.assign({}, process.env);
+    },
+  },
+});
+
 const node = {
   Buffer,
   path,
-  process,
+  process: patchedProcess,
   url,
 };
 

package/src/builtins/@ori.js

@@ -1,5 +1,5 @@
 import { Tree, getRealmObjectPrototype } from "@weborigami/async-tree";
-import * as compile from "../../../language/src/compiler/compile.js";
+import { compile } from "@weborigami/language";
 import builtins from "../builtins/@builtins.js";
 import { toYaml } from "../common/serialize.js";
 import assertScopeIsDefined from "../misc/assertScopeIsDefined.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/@rss.js

@@ -18,7 +18,7 @@ export default async function rss(jsonFeedTree) {
   parts.push("rss.xml");
   const rssUrl = parts.join("/");
 
-  const itemsRss = items?.map((story) => itemRss(story)).join("\n") ?? [];
+  const itemsRss = items?.map((story) => itemRss(story)).join("") ?? [];
 
   return `<?xml version="1.0" ?>
 <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
@@ -27,7 +27,7 @@ export default async function rss(jsonFeedTree) {
     <title>${title}</title>
     <link>${home_page_url}</link>
     <description>${description}</description>
-  ${itemsRss}</channel>
+${itemsRss}</channel>
 </rss>`;
 }
 
@@ -36,12 +36,14 @@ function itemRss(jsonFeedItem) {
   // RSS wants dates in RFC-822.
   const date = date_published?.toUTCString() ?? null;
   const dateElement = date ? `      <pubDate>${date}</pubDate>\n` : "";
+  const guidElement = id ? `      <guid>${id}</guid>\n` : "";
+  const contentElement = content_html
+    ? `      <description><![CDATA[${content_html}]]></description>\n`
+    : "";
   return `    <item>
-      ${dateElement}<title>${title}</title>
+${dateElement}      <title>${title}</title>
       <link>${url}</link>
-      <guid>${id}</guid>
-      <description><![CDATA[${content_html}]]></description>
-    </item>
+${guidElement}${contentElement}    </item>
 `;
 }
 

package/src/common/CommandModulesTransform.js

@@ -27,7 +27,7 @@ export default function CommandsModulesTransform(Base) {
     }
 
     async keys() {
-      const keys = [...(await super.keys())];
+      const keys = Array.from(await super.keys());
       // If we find a key like "foo.js", then return "foo" as the key.
       return keys.map((key) =>
         key.endsWith(".js") ? path.basename(key, ".js") : key

package/src/common/TextDocument.js

@@ -1,4 +1,5 @@
 import { isStringLike } from "@weborigami/async-tree";
+import { symbols } from "@weborigami/language";
 import { toYaml } from "./serialize.js";
 import * as utilities from "./utilities.js";
 
@@ -22,7 +23,7 @@ export default class TextDocument {
   constructor(data, parent) {
     Object.assign(this, data);
     if (parent) {
-      this[utilities.parentSymbol] = parent;
+      this[symbols.parent] = parent;
     }
   }
 

package/src/common/processUnpackedContent.js

@@ -10,18 +10,20 @@ import builtins from "../builtins/@builtins.js";
  *
  * @param {any} content
  * @param {AsyncTree|null} parent
- * @param {any} [inputDocument]
+ * @param {any} [attachedData]
  * @returns
  */
-export default function processUnpackedContent(content, parent, inputDocument) {
+export default function processUnpackedContent(content, parent, attachedData) {
   if (typeof content === "function") {
     // Wrap the function such to add ambients to the scope.
     const fn = content;
 
     // Use the parent's scope, adding any attached data.
     const parentScope = parent ? Scope.getScope(parent) : builtins;
-    const extendedScope = Tree.isTreelike(inputDocument)
-      ? new Scope(inputDocument, parentScope)
+
+    // If there's attached data, include it in the scope.
+    const extendedScope = attachedData
+      ? new Scope(attachedData, parentScope)
       : parentScope;
 
     const boundFn = fn.bind(extendedScope);

package/src/common/utilities.d.ts

@@ -1,6 +1,5 @@
 
 export const keySymbol: unique symbol;
-export const parentSymbol: unique symbol;
 export function hasNonPrintableCharacters(text: string): boolean;
 export function isTransformApplied(Transform: Function, object: any): boolean;
 export function replaceExtension(key: string, sourceExtension: string, resultExtension: string): string;

package/src/common/utilities.js

@@ -30,8 +30,6 @@ export function isTransformApplied(Transform, obj) {
 
 export const keySymbol = Symbol("key");
 
-export const parentSymbol = Symbol("parent");
-
 /**
  * If the given key ends in the source extension (which will generally include a
  * period), replace that extension with the result extension (which again should

package/src/misc/yamlOrigamiTag.js

@@ -1,5 +1,5 @@
-import { expressionFunction } from "@weborigami/language";
-import * as compile from "../../../language/src/compiler/compile.js";
+import { compile, expressionFunction } from "@weborigami/language";
+
 /**
  * A YAML tag for an Origami expression.
  */