@weborigami/origami 0.5.1 → 0.5.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@weborigami/origami",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "description": "Web Origami language, CLI, framework, and server",
   "type": "module",
   "repository": {
@@ -17,10 +17,10 @@
     "typescript": "5.9.2"
   },
   "dependencies": {
-    "@weborigami/async-tree": "0.5.1",
+    "@weborigami/async-tree": "0.5.2",
     "@weborigami/json-feed-to-rss": "1.0.0",
-    "@weborigami/language": "0.5.1",
-    "@weborigami/types": "0.5.1",
+    "@weborigami/language": "0.5.2",
+    "@weborigami/types": "0.5.2",
     "css-tree": "3.1.0",
     "exif-parser": "0.1.12",
     "graphviz-wasm": "3.0.2",

package/src/dev/help.yaml

@@ -88,6 +88,9 @@ Origami:
     mdHtml:
       args: (markdown)
       description: Render the markdown as HTML
+    mdOutline:
+      args: (markdown)
+      description: The outline structure of the markdown document
     naturalOrder:
       description: A comparison function for natural sort order
     once:

package/src/handlers/jpeg.handler.js

@@ -15,7 +15,7 @@ const exifDateTags = [
 export default {
   mediaType: "image/jpeg",
 
-  /** @type {import("@weborigami/language").UnpackFunction} */
+  /** @type {import("@weborigami/async-tree").UnpackFunction} */
   async unpack(packed, options) {
     if (packed instanceof Uint8Array) {
       // Downgrade to old Node Buffer for exif-parser.

package/src/handlers/js.handler.js

@@ -9,7 +9,7 @@ import processUnpackedContent from "./processUnpackedContent.js";
 export default {
   mediaType: "application/javascript",
 
-  /** @type {import("@weborigami/language").UnpackFunction} */
+  /** @type {import("@weborigami/async-tree").UnpackFunction} */
   async unpack(packed, options = {}) {
     const { key, parent } = options;
     if (parent && "import" in parent) {

package/src/handlers/json.handler.js

@@ -9,7 +9,7 @@ import * as utilities from "../common/utilities.js";
 export default {
   mediaType: "application/json",
 
-  /** @type {import("@weborigami/language").UnpackFunction} */
+  /** @type {import("@weborigami/async-tree").UnpackFunction} */
   unpack(packed) {
     const json = utilities.toString(packed);
     if (!json) {

package/src/handlers/ori.handler.js

@@ -1,8 +1,8 @@
+import { getParent } from "@weborigami/async-tree";
 import { compile } from "@weborigami/language";
 import builtinsProgram from "../builtinsProgram.js";
 import getConfig from "../cli/getConfig.js";
 import * as utilities from "../common/utilities.js";
-import getParent from "./getParent.js";
 import processUnpackedContent from "./processUnpackedContent.js";
 
 /**
@@ -13,7 +13,7 @@ import processUnpackedContent from "./processUnpackedContent.js";
 export default {
   mediaType: "text/plain",
 
-  /** @type {import("@weborigami/language").UnpackFunction} */
+  /** @type {import("@weborigami/async-tree").UnpackFunction} */
   async unpack(packed, options = {}) {
     const parent = getParent(packed, options);
 

package/src/handlers/oridocument.handler.js

@@ -1,9 +1,8 @@
-import { extension, trailingSlash } from "@weborigami/async-tree";
+import { extension, getParent, trailingSlash } from "@weborigami/async-tree";
 import { compile } from "@weborigami/language";
 import builtinsProgram from "../builtinsProgram.js";
 import getConfig from "../cli/getConfig.js";
 import { toString } from "../common/utilities.js";
-import getParent from "./getParent.js";
 import processUnpackedContent from "./processUnpackedContent.js";
 
 /**
@@ -13,7 +12,7 @@ import processUnpackedContent from "./processUnpackedContent.js";
 export default {
   mediaType: "text/plain",
 
-  /** @type {import("@weborigami/language").UnpackFunction} */
+  /** @type {import("@weborigami/async-tree").UnpackFunction} */
   async unpack(packed, options = {}) {
     const parent = getParent(packed, options);
 

package/src/handlers/txt.handler.js

@@ -52,7 +52,7 @@ export default {
     }
   },
 
-  /** @type {import("@weborigami/language").UnpackFunction} */
+  /** @type {import("@weborigami/async-tree").UnpackFunction} */
   async unpack(packed, options = {}) {
     const parent = options.parent ?? null;
     const text = toString(packed);

package/src/handlers/wasm.handler.js

@@ -8,7 +8,7 @@ import processUnpackedContent from "./processUnpackedContent.js";
 export default {
   mediaType: "application/wasm",
 
-  /** @type {import("@weborigami/language").UnpackFunction} */
+  /** @type {import("@weborigami/async-tree").UnpackFunction} */
   async unpack(packed, options = {}) {
     const wasmModule = await WebAssembly.instantiate(packed);
     // @ts-ignore TypeScript thinks wasmModule is already an Instance.

package/src/handlers/yaml.handler.js

@@ -17,7 +17,7 @@ const YAML = YAMLModule.default ?? YAMLModule.YAML;
 export default {
   mediaType: "application/yaml",
 
-  /** @type {import("@weborigami/language").UnpackFunction} */
+  /** @type {import("@weborigami/async-tree").UnpackFunction} */
   unpack(packed, options = {}) {
     const parent = options.parent ?? null;
     const yaml = utilities.toString(packed);

package/src/origami/mdOutline.js

@@ -0,0 +1,80 @@
+import { isUnpackable } from "@weborigami/async-tree";
+import { Marked } from "marked";
+import { toString } from "../common/utilities.js";
+
+export default async function mdOutline(input) {
+  if (isUnpackable(input)) {
+    input = await input.unpack();
+  }
+  const markdown = toString(input);
+  if (markdown === null) {
+    throw new Error("mdHtml: The provided input couldn't be treated as text.");
+  }
+
+  // Call the marked lexer to parse the markdown into tokens
+  const marked = new Marked();
+  const lexer = new marked.Lexer();
+  const tokens = lexer.lex(markdown);
+
+  // Turn the linear list of tokens into a hierarchical outline
+  const outline = {};
+  const stack = [];
+  let sectionText = "";
+  /** @type {any} */
+  let current = outline;
+  for (const token of tokens) {
+    if (token.type === "heading") {
+      // Current section text gets added as content for the current node.
+      if (sectionText) {
+        current._text = sectionText.trim();
+        sectionText = "";
+      }
+
+      // Pop the stack to find the right level for this heading
+      const { depth, text: headingText } = token;
+      while (stack.length >= depth) {
+        current = stack.pop();
+        consolidateText(current);
+      }
+
+      // Start a new node for this heading
+      const newNode = {};
+      current[headingText] = newNode;
+      stack.push(current);
+      current = newNode;
+    } else {
+      // Body element, accumulate text
+      sectionText += token.raw;
+    }
+  }
+
+  // Any remaining section text gets added as content for the current node.
+  if (sectionText) {
+    current._text = sectionText.trim();
+    current = stack.pop();
+    if (current) {
+      consolidateText(current);
+    }
+  }
+
+  return outline;
+}
+
+function consolidateText(node) {
+  // If the node's last property value is an object with only a _text property,
+  // destructively edit the value to be just the text.
+  const keys = Object.keys(node);
+  if (keys.length === 0) {
+    return;
+  }
+  const lastKey = keys[keys.length - 1];
+  const lastValue = node[lastKey];
+  if (
+    typeof lastValue === "object" &&
+    lastValue !== null &&
+    Object.keys(lastValue).length === 1 &&
+    typeof lastValue._text === "string"
+  ) {
+    node[lastKey] = lastValue._text;
+  }
+}

package/src/origami/origami.js

@@ -21,6 +21,7 @@ export * as image from "./image/image.js";
 export { default as resize } from "./image/resize.js";
 export { default as json } from "./json.js";
 export { default as jsonParse } from "./jsonParse.js";
+export { default as mdOutline } from "./mdOutline.js";
 export { default as naturalOrder } from "./naturalOrder.js";
 export { default as once } from "./once.js";
 export { default as ori } from "./ori.js";

package/src/origami/sitemap.js

@@ -17,9 +17,9 @@ const templateText = `(urls) => \`<?xml version="1.0" encoding="UTF-8"?>
  * @typedef {import("@weborigami/async-tree").Treelike} Treelike
  * @this {AsyncTree|null}
  * @param {Treelike} treelike
- * @param {string} [baseHref ]
+ * @param {{ assumeSlashes?: boolean, base?: string }} options
  */
-export default async function sitemap(treelike, baseHref = "") {
+export default async function sitemap(treelike, options = {}) {
   assertTreeIsDefined(this, "sitemap");
   const tree = await getTreeArgument(this, arguments, treelike, "sitemap");
 
@@ -38,7 +38,7 @@ export default async function sitemap(treelike, baseHref = "") {
     },
   };
 
-  const treePaths = await Tree.paths(filterTree, baseHref);
+  const treePaths = await Tree.paths(filterTree, options);
 
   // For simplicity, we assume that HTML pages will end in .html.
   // If the page is named index.html, we remove index.html from

package/src/handlers/getParent.js

@@ -1,29 +0,0 @@
-import { symbols } from "@weborigami/async-tree";
-
-/**
- * Return a suitable parent for the packed file.
- *
- * @param {any} packed
- * @param {any} options
- * @returns {import("@weborigami/types").AsyncTree|null}
- */
-export default function getParent(packed, options) {
-  // Prefer parent set on options
-  if (options?.parent) {
-    return options.parent;
-  }
-
-  // If the packed object has a `parent` property, use that. Exception: Node
-  // Buffer objects have a `parent` property that we ignore.
-  if (packed.parent && !(packed instanceof Buffer)) {
-    return packed.parent;
-  }
-
-  // If the packed object has a parent symbol, use that.
-  if (packed[symbols.parent]) {
-    return packed[symbols.parent];
-  }
-
-  // Otherwise, return null.
-  return null;
-}