@weborigami/origami 0.6.14 → 0.6.16

package/src/origami/htmlParse.js

@@ -0,0 +1,22 @@
+import { args } from "@weborigami/async-tree";
+import loadJsDom from "../common/loadJsDom.js";
+import domNodeToObject from "./domNodeToObject.js";
+
+/**
+ * Return the DOM structure for the given HTML as a plain object.
+ *
+ * @param {import("@weborigami/async-tree").Stringlike} html
+ */
+export default async function htmlParse(html) {
+  html = args.stringlike(html, "Origami.htmlParse");
+  const { JSDOM } = await loadJsDom();
+  const dom = JSDOM.fragment(html);
+  let object = domNodeToObject(dom);
+  if (
+    (object.name === "#document" || object.name === "#document-fragment") &&
+    object.children.length === 1
+  ) {
+    object = object.children[0];
+  }
+  return object;
+}

package/src/origami/mdOutline.js

@@ -22,18 +22,29 @@ export default async function mdOutline(input) {
   const outline = {};
   const stack = [];
   let sectionText = "";
+  let sectionTextTrimmed = null;
   /** @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();
+      sectionTextTrimmed = sectionText.trim();
+      if (sectionTextTrimmed) {
+        current._text = sectionTextTrimmed;
         sectionText = "";
       }
 
-      // Pop the stack to find the right level for this heading
       const { depth, text: headingText } = token;
+
+      // Did we skip a heading level? If so, create `_skip<n>` nodes
+      while (stack.length < depth - 1) {
+        const skipNode = {};
+        current[`_skip${stack.length + 1}`] = skipNode;
+        stack.push(current);
+        current = skipNode;
+      }
+
+      // Pop the stack to find the right level for this heading
       while (stack.length >= depth) {
         current = stack.pop();
         consolidateText(current);
@@ -51,8 +62,9 @@ export default async function mdOutline(input) {
   }
 
   // Any remaining section text gets added as content for the current node.
-  if (sectionText) {
-    current._text = sectionText.trim();
+  sectionTextTrimmed = sectionText.trim();
+  if (sectionTextTrimmed) {
+    current._text = sectionTextTrimmed;
     current = stack.pop();
     if (current) {
       consolidateText(current);

package/src/origami/origami.js

@@ -4,8 +4,8 @@ export { default as basename } from "./basename.js";
 export { default as csv } from "./csv.js";
 export { default as document } from "./document.js";
 export { default as fetch } from "./fetch.js";
-export { default as htmlDom } from "./htmlDom.js";
 export { default as htmlEscape } from "./htmlEscape.js";
+export { default as htmlParse } from "./htmlParse.js";
 export { default as format } from "./image/format.js";
 export * as image from "./image/image.js";
 export { default as resize } from "./image/resize.js";
@@ -34,5 +34,6 @@ export { default as static } from "./static.js";
 export { default as string } from "./string.js";
 export { default as tsv } from "./tsv.js";
 export { default as unpack } from "./unpack.js";
+export { default as xmlParse } from "./xmlParse.js";
 export { default as yaml } from "./yaml.js";
 export { default as yamlParse } from "./yamlParse.js";

package/src/origami/xmlParse.js

@@ -0,0 +1,33 @@
+import { args } from "@weborigami/async-tree";
+import loadJsDom from "../common/loadJsDom.js";
+import domNodeToObject from "./domNodeToObject.js";
+
+let parser;
+
+/**
+ * Return the DOM for the given XML as a plain object.
+ *
+ * @param {import("@weborigami/async-tree").Stringlike} xml
+ */
+export default async function xmlParse(xml) {
+  xml = args.stringlike(xml, "Origami.xmlParse");
+  const parser = await getParser();
+  const dom = parser.parseFromString(xml, "application/xml");
+  let object = domNodeToObject(dom);
+  if (
+    (object.name === "#document" || object.name === "#document-fragment") &&
+    object.children.length === 1
+  ) {
+    object = object.children[0];
+  }
+  return object;
+}
+
+async function getParser() {
+  if (!parser) {
+    const { JSDOM } = await loadJsDom();
+    const dom = new JSDOM();
+    parser = new dom.window.DOMParser();
+  }
+  return parser;
+}

package/src/server/server.js

@@ -1,4 +1,9 @@
-import { Tree, keysFromPath, trailingSlash } from "@weborigami/async-tree";
+import {
+  TraverseError,
+  Tree,
+  keysFromPath,
+  trailingSlash,
+} from "@weborigami/async-tree";
 import { formatError } from "@weborigami/language";
 import { ServerResponse } from "node:http";
 import constructResponse from "./constructResponse.js";
@@ -83,7 +88,14 @@ export async function handleRequest(request, response, map) {
 
 export function keysFromUrl(url) {
   const encodedKeys = keysFromPath(url.pathname);
-  const keys = encodedKeys.map((key) => decodeURIComponent(key));
+  // Decode the keys, but stop decoding if we encounter an Origami debugger command
+  let foundCommand = false;
+  const keys = encodedKeys.map((key) => {
+    if (key.startsWith("!")) {
+      foundCommand = true;
+    }
+    return foundCommand ? key : decodeURIComponent(key);
+  });
 
   // If the keys array is empty (the path was just a trailing slash) or if the
   // path ended with a slash, add "index.html" to the end of the keys.
@@ -99,12 +111,17 @@ export function keysFromUrl(url) {
  * https.createServer calls, letting you serve an async tree as a set of pages.
  *
  * @typedef {import("@weborigami/async-tree").Maplike} Maplike
+ * @param {object} options
+ * @param {boolean} [options.quiet] If true, suppresses logging of incoming requests.
  * @param {Maplike} maplike
  */
-export function requestListener(maplike) {
+export function requestListener(maplike, options = {}) {
+  const quiet = options.quiet ?? false;
   const tree = Tree.from(maplike);
   return async function (request, response) {
-    console.log(decodeURI(request.url));
+    if (!quiet) {
+      console.log(decodeURI(request.url));
+    }
     const handled = await handleRequest(request, response, tree);
     if (!handled) {
       // Not found, return a 404.
@@ -138,9 +155,16 @@ ${message}
 </body>
 </html>
 `;
-  response.writeHead(500, { "Content-Type": "text/html" });
+  response.writeHead(500, {
+    "Content-Type": "text/html",
+    "x-error-details": encodeURIComponent(message),
+  });
   response.end(html, "utf-8");
-  console.error(message);
+
+  // Don't log traverse errors for requests like favicon.ico, com.chrome.devtools.json, etc.
+  if (!(error instanceof TraverseError)) {
+    console.error(message);
+  }
 }
 
 // Asynchronous tree router as Express middleware.

package/src/origami/htmlDom.js

@@ -1,14 +0,0 @@
-import { args } from "@weborigami/async-tree";
-import loadJsDom from "../common/loadJsDom.js";
-
-/**
- * Return the DOM for the given HTML string.
- *
- * @param {import("@weborigami/async-tree").Stringlike} html
- */
-export default async function htmlDom(html) {
-  html = args.stringlike(html, "Origami.htmlDom");
-  const { JSDOM } = await loadJsDom();
-  const dom = JSDOM.fragment(html);
-  return dom;
-}