@weborigami/origami 0.0.60 → 0.0.62

package/exports/exports.js

@@ -1,6 +1,5 @@
 // This file is generated by running buildExports.js -- do not edit by hand.
 export { default as addNextPrevious } from "../src/builtins/@addNextPrevious.js";
-export { default as arrowsMap } from "../src/builtins/@arrowsMap.js";
 export { default as basename } from "../src/builtins/@basename.js";
 export { default as breakpoint } from "../src/builtins/@breakpoint.js";
 export { default as builtins } from "../src/builtins/@builtins.js";
@@ -99,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";
@@ -111,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";
@@ -133,6 +134,7 @@ export * from "../src/common/utilities.js";
 export { default as assertTreeIsDefined } from "../src/misc/assertTreeIsDefined.js";
 export { default as getTreeArgument } from "../src/misc/getTreeArgument.js";
 export { default as OriCommandTransform } from "../src/misc/OriCommandTransform.js";
+export { default as origamiHighlightDefinition } from "../src/misc/origamiHighlightDefinition.js";
 export { default as treeDot } from "../src/misc/treeDot.js";
 export { default as constructResponse } from "../src/server/constructResponse.js";
 export * from "../src/server/mediaTypes.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@weborigami/origami",
-  "version": "0.0.60",
+  "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.60",
-    "@weborigami/language": "0.0.60",
-    "@weborigami/types": "0.0.60",
+    "@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/@mdHtml.js

@@ -6,6 +6,9 @@ import { markedHighlight } from "marked-highlight";
 import { markedSmartypants } from "marked-smartypants";
 import documentObject from "../common/documentObject.js";
 import { replaceExtension, toString } from "../common/utilities.js";
+import origamiHighlightDefinition from "../misc/origamiHighlightDefinition.js";
+
+highlight.registerLanguage("ori", origamiHighlightDefinition);
 
 marked.use(
   markedGfmHeadingId(),

package/src/builtins/@ori.js

@@ -1,4 +1,8 @@
-import { Tree, getRealmObjectPrototype } from "@weborigami/async-tree";
+import {
+  Tree,
+  getRealmObjectPrototype,
+  toString,
+} from "@weborigami/async-tree";
 import { compile } from "@weborigami/language";
 import builtins from "../builtins/@builtins.js";
 import { toYaml } from "../common/serialize.js";
@@ -22,7 +26,7 @@ export default async function ori(
   assertTreeIsDefined(this, "ori");
 
   // In case expression has come from a file, cast it to a string.
-  expression = String(expression);
+  expression = toString(expression);
 
   // Run in the context of `this` if defined, otherwise use the builtins.
   const tree = this ?? builtins;

package/src/builtins/@rss.js

@@ -1,55 +1,119 @@
 import { Tree } from "@weborigami/async-tree";
 import assertTreeIsDefined from "../misc/assertTreeIsDefined.js";
 
+const days = ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"];
+const months = [
+  "Jan",
+  "Feb",
+  "Mar",
+  "Apr",
+  "May",
+  "Jun",
+  "Jul",
+  "Aug",
+  "Sep",
+  "Oct",
+  "Nov",
+  "Dec",
+];
+
 /**
  * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
  * @typedef {import("@weborigami/async-tree").Treelike} Treelike
  * @this {AsyncTree|null}
  * @param {Treelike} jsonFeedTree
+ * @param {any} options
  */
-export default async function rss(jsonFeedTree) {
+export default async function rss(jsonFeedTree, options = {}) {
   assertTreeIsDefined(this, "rss");
   const jsonFeed = await Tree.plain(jsonFeedTree);
-  const { description, home_page_url, items, feed_url, title } = jsonFeed;
+  const { description, home_page_url, items, title } = jsonFeed;
 
-  // Presume that the RSS feed lives in same location as feed_url.
-  const parts = feed_url.split("/");
-  parts.pop();
-  parts.push("rss.xml");
-  const rssUrl = parts.join("/");
+  let { feed_url, language } = options;
+  if (!feed_url && jsonFeed.feed_url) {
+    // Presume that the RSS feed lives in same location as feed_url
+    // but with a .xml extension.
+    feed_url = jsonFeed.feed_url;
+    if (feed_url.endsWith(".json")) {
+      feed_url = feed_url.replace(".json", ".xml");
+    }
+  }
 
   const itemsRss = items?.map((story) => itemRss(story)).join("") ?? [];
 
+  const titleElement = title ? `    <title>${escapeXml(title)}</title>\n` : "";
+  const descriptionElement = description
+    ? `    <description>${escapeXml(description)}</description>\n`
+    : "";
+  const linkElement = home_page_url
+    ? `    <link>${home_page_url}</link>\n`
+    : "";
+  const languageElement = language
+    ? `    <language>${language}</language>\n`
+    : "";
+  const feedLinkElement = `    <atom:link href="${feed_url}" rel="self" type="application/rss+xml"/>\n`;
+  // const feedLinkElement = `    <link rel="self" type="application/atom+xml" href="${feed_url}"/>\n`;
+
   return `<?xml version="1.0" ?>
-<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
+<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:content="http://purl.org/rss/1.0/modules/content/">
   <channel>
-    <atom:link href="${rssUrl}" rel="self" type="application/rss+xml"/>
-    <title><![CDATA[${title}]]></title>
-    <link>${home_page_url}</link>
-    <description>${description}</description>
-${itemsRss}</channel>
+${titleElement}${descriptionElement}${linkElement}${languageElement}${feedLinkElement}${itemsRss}  </channel>
 </rss>`;
 }
 
 function itemRss(jsonFeedItem) {
-  const { content_html, date_published, id, title, url } = jsonFeedItem;
-  // RSS wants dates in RFC-822, essentially the same as ISO 8601.
+  const { content_html, id, summary, title, url } = jsonFeedItem;
+  let { date_published } = jsonFeedItem;
+  if (typeof date_published === "string") {
+    // Parse as ISO 8601 date.
+    date_published = new Date(date_published);
+  }
   const date =
     date_published instanceof Date
-      ? date_published.toUTCString()
+      ? toRFC822Date(date_published)
       : date_published;
+
   const dateElement = date ? `      <pubDate>${date}</pubDate>\n` : "";
-  const guidElement = id ? `      <guid>${id}</guid>\n` : "";
+  const isPermaLink =
+    id !== undefined && !URL.canParse(id) ? ` isPermaLink="false"` : "";
+  const guidElement = id ? `      <guid${isPermaLink}>${id}</guid>\n` : "";
+  const descriptionElement = summary
+    ? `      <description>${escapeXml(summary)}</description>\n`
+    : "";
   const contentElement = content_html
-    ? `      <description><![CDATA[${content_html}]]></description>\n`
+    ? `      <content:encoded><![CDATA[${content_html}]]></content:encoded>\n`
     : "";
-  const titleElement = `<![CDATA[${title}]]>`;
+  const titleElement = title
+    ? `      <title>${escapeXml(title)}</title>\n`
+    : "";
+  const linkElement = url ? `      <link>${url}</link>\n` : "";
+
   return `    <item>
-${dateElement}      <title>${titleElement}</title>
-      <link>${url}</link>
-${guidElement}${contentElement}    </item>
+${dateElement}${titleElement}${linkElement}${guidElement}${descriptionElement}${contentElement}    </item>
 `;
 }
 
+// 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()];
+  const dayOfMonth = date.getUTCDate().toString().padStart(2, "0");
+  const month = months[date.getUTCMonth()];
+  const year = date.getUTCFullYear();
+  const hours = date.getUTCHours().toString().padStart(2, "0");
+  const minutes = date.getUTCMinutes().toString().padStart(2, "0");
+  const seconds = date.getUTCSeconds().toString().padStart(2, "0");
+  return `${day}, ${dayOfMonth} ${month} ${year} ${hours}:${minutes}:${seconds} GMT`;
+}
+
 rss.usage = `@rss <feed>\tTransforms a JSON Feed tree to RSS XML`;
 rss.documentation = "https://weborigami.org/language/@rss.html";

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/common/utilities.js

@@ -91,10 +91,9 @@ export function toFunction(obj) {
  */
 export function toString(object) {
   if (isPlainObject(object) && "@text" in object) {
-    return object["@text"];
-  } else {
-    return asyncTreeToString(object);
+    object = object["@text"];
   }
+  return asyncTreeToString(object);
 }
 
 /**

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) {

package/src/misc/origamiHighlightDefinition.js

@@ -0,0 +1,36 @@
+/**
+ * Origami language definition for highlight.js
+ */
+export default function origamiHighlightDefinition(hljs) {
+  return {
+    name: "Origami",
+    contains: [
+      hljs.C_LINE_COMMENT_MODE,
+      hljs.C_BLOCK_COMMENT_MODE,
+      hljs.C_NUMBER_MODE,
+      hljs.APOS_STRING_MODE,
+      hljs.QUOTE_STRING_MODE,
+      hljs.BACKSLASH_ESCAPE,
+      {
+        // Backtick template strings
+        className: "string",
+        begin: "`",
+        end: "`",
+        contains: [
+          hljs.BACKSLASH_ESCAPE,
+          {
+            className: "subst",
+            begin: "\\$\\{",
+            end: "\\}",
+            contains: [hljs.C_NUMBER_MODE, hljs.QUOTE_STRING_MODE],
+          },
+        ],
+      },
+      {
+        // Treat all `@` builtins as keywords.
+        className: "keyword",
+        begin: /@\w+\b/,
+      },
+    ],
+  };
+}

package/src/builtins/@arrowsMap.js

@@ -1,24 +0,0 @@
-import { functionResultsMap } from "@weborigami/language";
-import arrowsMapFn from "../common/arrowsMapFn.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.
- *
- * @typedef  {import("@weborigami/types").AsyncTree} AsyncTree
- * @typedef {import("@weborigami/async-tree").Treelike} Treelike
- * @this {AsyncTree|null}
- * @param {Treelike} [treelike]
- */
-export default async function arrowsMap(treelike) {
-  const tree = await getTreeArgument(this, arguments, treelike, "arrowsMap");
-  const mapped = functionResultsMap(arrowsMapFn()(tree));
-  mapped.parent = this ?? builtins;
-  mapped[keySymbol] = "@arrowsMap";
-  return mapped;
-}
-
-arrowsMap.usage = `@arrowsMap <obj>\tInterpret arrow keys in the tree as function calls`;
-arrowsMap.documentation = "https://weborigami.org/language/@arrowsMap.html";