@weborigami/origami 0.0.61 → 0.0.62

package/exports/exports.js

@@ -98,6 +98,7 @@ export { default as treeHttp } from "../src/builtins/@treeHttp.js";
 export { default as treeHttps } from "../src/builtins/@treeHttps.js";
 export { default as unpack } from "../src/builtins/@unpack.js";
 export { default as values } from "../src/builtins/@values.js";
+export { default as version } from "../src/builtins/@version.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";
@@ -110,6 +111,7 @@ 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 oriDocumentHandler } from "../src/builtins/ori_document_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";

package/package.json

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

package/src/builtins/@changes.js

@@ -3,8 +3,8 @@ import { Tree } from "@weborigami/async-tree";
 // Given an old tree and a new tree, return a tree of changes indicated
 // by the values: "added", "changed", or "deleted".
 export default async function changes(oldTreelike, newTreelike) {
-  const oldTree = Tree.from(oldTreelike);
-  const newTree = Tree.from(newTreelike);
+  const oldTree = Tree.from(oldTreelike, { deep: true });
+  const newTree = Tree.from(newTreelike, { deep: true });
 
   const oldKeys = Array.from(await oldTree.keys());
   const newKeys = Array.from(await newTree.keys());

package/src/builtins/@deepValues.js

@@ -11,7 +11,13 @@ import getTreeArgument from "../misc/getTreeArgument.js";
  * @param {Treelike} [treelike]
  */
 export default async function deepValuesBuiltin(treelike) {
-  const tree = await getTreeArgument(this, arguments, treelike, "@valuesDeep");
+  const tree = await getTreeArgument(
+    this,
+    arguments,
+    treelike,
+    "@valuesDeep",
+    true
+  );
   return deepValues(tree);
 }
 

package/src/builtins/@rss.js

@@ -41,9 +41,9 @@ export default async function rss(jsonFeedTree, options = {}) {
 
   const itemsRss = items?.map((story) => itemRss(story)).join("") ?? [];
 
-  const titleElement = title ? `    <title>![CDATA[${title}]]</title>\n` : "";
+  const titleElement = title ? `    <title>${escapeXml(title)}</title>\n` : "";
   const descriptionElement = description
-    ? `    <description>${description}</description>\n`
+    ? `    <description>${escapeXml(description)}</description>\n`
     : "";
   const linkElement = home_page_url
     ? `    <link>${home_page_url}</link>\n`
@@ -78,13 +78,13 @@ function itemRss(jsonFeedItem) {
     id !== undefined && !URL.canParse(id) ? ` isPermaLink="false"` : "";
   const guidElement = id ? `      <guid${isPermaLink}>${id}</guid>\n` : "";
   const descriptionElement = summary
-    ? `      <description><![CDATA[${summary}]]></description>\n`
+    ? `      <description>${escapeXml(summary)}</description>\n`
     : "";
   const contentElement = content_html
     ? `      <content:encoded><![CDATA[${content_html}]]></content:encoded>\n`
     : "";
   const titleElement = title
-    ? `      <title><![CDATA[${title}]]></title>\n`
+    ? `      <title>${escapeXml(title)}</title>\n`
     : "";
   const linkElement = url ? `      <link>${url}</link>\n` : "";
 
@@ -93,6 +93,16 @@ ${dateElement}${titleElement}${linkElement}${guidElement}${descriptionElement}${
 `;
 }
 
+// Escape XML entities for in the text.
+function escapeXml(text) {
+  return text
+    .replace(/&/g, "&amp;")
+    .replace(/</g, "&lt;")
+    .replace(/>/g, "&gt;")
+    .replace(/"/g, "&quot;")
+    .replace(/'/g, "&apos;");
+}
+
 // RSS wants dates in RFC-822.
 function toRFC822Date(date) {
   const day = days[date.getUTCDay()];

package/src/builtins/@version.js

@@ -0,0 +1,13 @@
+// When this is no longer experimental in Node:
+// import packageJson from "../../package.json" with { type: "json" };
+
+import fs from "node:fs/promises";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+
+const dirname = path.dirname(fileURLToPath(import.meta.url));
+const packageJsonPath = path.resolve(dirname, "../../package.json");
+const buffer = await fs.readFile(packageJsonPath);
+const data = JSON.parse(String(buffer));
+
+export default data.version;

package/src/builtins/ori_document_handler.js

@@ -0,0 +1,43 @@
+import { symbols } from "@weborigami/async-tree";
+import { compile } from "@weborigami/language";
+import processUnpackedContent from "../common/processUnpackedContent.js";
+import * as utilities from "../common/utilities.js";
+
+/**
+ * An Origami template document: a plain text file that contains Origami
+ * expressions.
+ */
+export default {
+  mediaType: "text/plain",
+
+  /** @type {import("@weborigami/language").UnpackFunction} */
+  async unpack(packed, options = {}) {
+    const parent =
+      options.parent ??
+      /** @type {any} */ (packed).parent ??
+      /** @type {any} */ (packed)[symbols.parent];
+
+    // Construct an object to represent the source code.
+    const sourceName = options.key;
+    let url;
+    if (sourceName && parent?.url) {
+      let parentHref = parent.url.href;
+      if (!parentHref.endsWith("/")) {
+        parentHref += "/";
+      }
+      url = new URL(sourceName, parentHref);
+    }
+
+    const source = {
+      text: utilities.toString(packed),
+      name: options.key,
+      url,
+    };
+
+    // Compile the text as an Origami template document.
+    const templateDefineFn = compile.templateDocument(source);
+    const templateFn = await templateDefineFn.call(parent);
+
+    return processUnpackedContent(templateFn, parent);
+  },
+};

package/src/common/processUnpackedContent.js

@@ -1,4 +1,4 @@
-import { Tree } from "@weborigami/async-tree";
+import { symbols, Tree } from "@weborigami/async-tree";
 import builtins from "../builtins/@builtins.js";
 
 /**
@@ -29,6 +29,14 @@ export default function processUnpackedContent(content, parent, attachedData) {
     const result = Object.create(content);
     result.parent = parent;
     return result;
+  } else if (Object.isExtensible(content) && !content[symbols.parent]) {
+    Object.defineProperty(content, symbols.parent, {
+      configurable: true,
+      enumerable: false,
+      value: parent,
+      writable: true,
+    });
+    return content;
   } else {
     return content;
   }

package/src/misc/getTreeArgument.js

@@ -18,13 +18,15 @@ import assertTreeIsDefined from "./assertTreeIsDefined.js";
  * @param {IArguments} args
  * @param {Treelike|undefined} treelike
  * @param {string} methodName
+ * @param {boolean} [deep]
  * @returns {Promise<AsyncTree>}
  */
 export default async function getTreeArgument(
   parent,
   args,
   treelike,
-  methodName
+  methodName,
+  deep = false
 ) {
   assertTreeIsDefined(parent, methodName);
 
@@ -33,7 +35,7 @@ export default async function getTreeArgument(
       treelike = await treelike.unpack();
     }
     if (isTreelike(treelike)) {
-      let tree = Tree.from(treelike);
+      let tree = Tree.from(treelike, { deep });
       // If the tree was created from a treelike object and does not yet have a
       // parent, make the current tree its parent.
       if (!tree.parent) {