@weborigami/origami 0.5.5 → 0.5.6

package/src/origami/yaml.js

@@ -1,23 +1,19 @@
 /** @typedef {import("@weborigami/types").AsyncTree} AsyncTree */
 import { isUnpackable, toPlainValue } from "@weborigami/async-tree";
 import YAML from "yaml";
-import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
 
 /**
  * Render the object as text in YAML format.
  *
- * @this {AsyncTree|null}
  * @param {any} [obj]
  */
-export default async function toYaml(obj) {
-  assertTreeIsDefined(this, "yaml");
+export default async function yamlBuiltin(obj) {
   // A fragment of the logic from getTreeArgument.js
   if (arguments.length > 0 && obj === undefined) {
     throw new Error(
       "An Origami function was called with an initial argument, but its value is undefined."
     );
   }
-  obj = obj ?? this;
   if (obj === undefined) {
     return undefined;
   }

package/src/origami/yamlParse.js

@@ -1,5 +1,5 @@
+import { toString } from "@weborigami/async-tree";
 import * as serialize from "../common/serialize.js";
-import { toString } from "../common/utilities.js";
 
 export default async function yamlParse(input) {
   const text = toString(input);

package/src/server/constructResponse.js

@@ -4,10 +4,10 @@ import {
   isPlainObject,
   isStringlike,
   SiteTree,
+  toString,
   Tree,
 } from "@weborigami/async-tree";
 import * as serialize from "../common/serialize.js";
-import { toString } from "../common/utilities.js";
 import { mediaTypeForExtension } from "./mediaTypes.js";
 
 /**

package/src/server/server.js

@@ -81,35 +81,15 @@ export async function handleRequest(request, response, tree) {
 }
 
 function keysFromUrl(url) {
-  // Split on occurrences of `/!`, which represent Origami debug commands.
-  // Command arguments can contain slashes; don't treat those as path keys.
-  const parts = url.pathname.split(/\/!/);
-
-  // Split everything before the first command by slashes and decode those.
-  let path = parts.shift();
-  if (parts.length > 0) {
-    // HACK: Add back trailing slash that was removed by split
-    path += "/";
-  }
-  const pathKeys = keysFromPath(path).map((key) => decodeURIComponent(key));
-  if (parts.length > 0 && pathKeys.at(-1) === "") {
-    // HACK part 2: Remove empty string that was added for trailing slash
-    pathKeys.pop();
-  }
+  const encodedKeys = keysFromPath(url.pathname);
+  const keys = encodedKeys.map((key) => decodeURIComponent(key));
 
-  // If there are no commands, and the path ends with a trailing slash, the
-  // final key will be an empty string. Change that to "index.html".
-  if (parts.length === 0 && pathKeys[pathKeys.length - 1] === "") {
-    pathKeys[pathKeys.length - 1] = "index.html";
+  // If the path ends with a trailing slash, the final key will be an empty
+  // string. Change that to "index.html".
+  if (keys.at(-1) === "") {
+    keys[keys.length - 1] = "index.html";
   }
 
-  // Decode the text of the commands, prefix spaces with a backslash, and add
-  // back the `!` character.
-  const commandKeys = parts.map(
-    (command) => `!${decodeURIComponent(command).replace(/ /g, "\\ ")}`
-  );
-
-  const keys = [...pathKeys, ...commandKeys];
   return keys;
 }
 

package/src/builtinsProgram.js

@@ -1,56 +0,0 @@
-import { Tree } from "@weborigami/async-tree";
-import { jsGlobals } from "@weborigami/language";
-import * as dev from "./dev/dev.js";
-import help from "./dev/help.js";
-import handlerBuiltins from "./handlers/handlerBuiltins.js";
-import * as origami from "./origami/origami.js";
-import explore from "./protocols/explore.js";
-import files from "./protocols/files.js";
-import http from "./protocols/http.js";
-import https from "./protocols/https.js";
-import httpstree from "./protocols/httpstree.js";
-import httptree from "./protocols/httptree.js";
-import node from "./protocols/node.js";
-import packageNamespace from "./protocols/package.js";
-
-let builtins;
-
-export default function builtinsProgram() {
-  if (!builtins) {
-    const Protocol = {
-      explore,
-      files,
-      http,
-      https,
-      httpstree,
-      httptree,
-      node,
-      package: packageNamespace,
-    };
-
-    /** @type {any} */
-    builtins = {
-      ...jsGlobals,
-
-      "explore:": explore,
-      "files:": files,
-      "help:": help,
-      "http:": http,
-      "https:": https,
-      "httpstree:": httpstree,
-      "httptree:": httptree,
-      "node:": node,
-      "package:": packageNamespace,
-
-      Dev: dev,
-      Tree,
-      Origami: origami,
-      Protocol,
-
-      // Handlers need to be exposed at top level
-      ...handlerBuiltins(),
-    };
-  }
-
-  return builtins;
-}

package/src/builtinsShell.js

@@ -1,18 +0,0 @@
-import builtinsProgram from "./builtinsProgram.js";
-import * as dev from "./dev/dev.js";
-
-let builtins;
-
-export default function builtinsShell() {
-  if (!builtins) {
-    builtins = {
-      // All program builtins
-      ...builtinsProgram(),
-
-      // Dev builtins exposed at the top level in shell
-      ...dev,
-    };
-  }
-
-  return builtins;
-}

package/src/cli/getConfig.js

@@ -1,11 +0,0 @@
-import { Tree } from "@weborigami/async-tree";
-
-// Return the config for the given tree
-export default function getConfig(tree) {
-  if (!tree) {
-    return null;
-  }
-  /** @type {any} */
-  const root = Tree.root(tree);
-  return root.config;
-}

package/src/common/constructHref.js

@@ -1,20 +0,0 @@
-import { pathFromKeys } from "@weborigami/async-tree";
-
-/**
- * Given a protocol, a host, and a list of keys, construct an href.
- *
- * @param {string} protocol
- * @param {string} host
- * @param  {string[]} keys
- */
-export default function constructHref(protocol, host, ...keys) {
-  const path = pathFromKeys(keys);
-  let href = [host, path].join("/");
-  if (!href.startsWith(protocol)) {
-    if (!href.startsWith("//")) {
-      href = `//${href}`;
-    }
-    href = `${protocol}${href}`;
-  }
-  return href;
-}

package/src/common/constructSiteTree.js

@@ -1,34 +0,0 @@
-import { trailingSlash } from "@weborigami/async-tree";
-import { HandleExtensionsTransform } from "@weborigami/language";
-import constructHref from "./constructHref.js";
-
-/**
- * Given a protocol, a host, and a list of keys, construct an href.
- *
- * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
- *
- * @param {string} protocol
- * @param {import("../../index.ts").Constructor<AsyncTree>} treeClass
- * @param {AsyncTree|null} parent
- * @param {string} host
- * @param  {string[]} keys
- */
-export default function constructSiteTree(
-  protocol,
-  treeClass,
-  parent,
-  host,
-  ...keys
-) {
-  // If the last key doesn't end in a slash, remove it for now.
-  let lastKey;
-  if (keys.length > 0 && keys.at(-1) && !trailingSlash.has(keys.at(-1))) {
-    lastKey = keys.pop();
-  }
-
-  const href = constructHref(protocol, host, ...keys);
-  let result = new (HandleExtensionsTransform(treeClass))(href);
-  result.parent = parent;
-
-  return lastKey ? result.get(lastKey) : result;
-}

package/src/common/fetchAndHandleExtension.js

@@ -1,27 +0,0 @@
-import { getHandlers, handleExtension } from "@weborigami/language";
-
-/**
- * Fetch the resource at the given href.
- *
- * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
- *
- * @this {AsyncTree|null}
- * @param {string} href
- */
-export default async function fetchAndHandleExtension(href) {
-  const response = await fetch(href);
-  if (!response.ok) {
-    return undefined;
-  }
-  let buffer = await response.arrayBuffer();
-
-  // Attach any loader defined for the file type.
-  const url = new URL(href);
-  const filename = url.pathname.split("/").pop();
-  if (this && filename) {
-    const handlers = getHandlers(this);
-    buffer = await handleExtension(this, buffer, filename, handlers);
-  }
-
-  return buffer;
-}

package/src/handlers/css.handler.js

@@ -1,7 +0,0 @@
-// .css files use the .txt loader
-import { txtHandler } from "./handlers.js";
-
-export default {
-  ...txtHandler,
-  mediaType: "text/css",
-};

package/src/handlers/csv.handler.js

@@ -1,129 +0,0 @@
-import { symbols, toString } from "@weborigami/async-tree";
-
-export default {
-  mediaType: "text/csv",
-
-  unpack(packed, options = {}) {
-    const parent = options.parent ?? null;
-    const text = toString(packed);
-    if (text === null) {
-      throw new TypeError("CSV handler can only unpack text");
-    }
-    const data = csvParse(text);
-    // Define `parent` as non-enumerable property
-    Object.defineProperty(data, symbols.parent, {
-      configurable: true,
-      enumerable: false,
-      value: parent,
-      writable: true,
-    });
-    return data;
-  },
-};
-
-/**
- * Parse text as CSV following RFC 4180
- *
- * This assumes the presence of a header row, and accepts both CRLF and LF line
- * endings.
- *
- * @param {string} text
- * @returns {any[]}
- */
-function csvParse(text) {
-  const rows = [];
-  let currentRow = [];
-  let currentField = "";
-
-  const pushField = () => {
-    // Push the completed field and reset for the next field.
-    currentRow.push(currentField);
-    currentField = "";
-  };
-
-  const pushRow = () => {
-    // Push the row if there is at least one field (accounts for potential trailing newline)
-    rows.push(currentRow);
-    currentRow = [];
-  };
-
-  // Main state machine
-  let i = 0;
-  let inQuotes = false;
-  while (i < text.length) {
-    const char = text[i];
-
-    if (inQuotes) {
-      // In a quoted field
-      if (char === '"') {
-        // Check if next character is also a quote
-        if (i + 1 < text.length && text[i + 1] === '"') {
-          // Append a literal double quote and skip the next character
-          currentField += '"';
-          i += 2;
-          continue;
-        } else {
-          // End of the quoted field
-          inQuotes = false;
-          i++;
-          continue;
-        }
-      } else {
-        // All other characters within quotes are taken literally.
-        currentField += char;
-        i++;
-        continue;
-      }
-    } else if (char === '"') {
-      // Start of a quoted field
-      inQuotes = true;
-      i++;
-      continue;
-    } else if (char === ",") {
-      // End of field
-      pushField();
-      i++;
-      continue;
-    } else if (char === "\n" || (char === "\r" && text[i + 1] === "\n")) {
-      // End of row: push the last field, then row.
-      pushField();
-      pushRow();
-      if (char === "\r" && text[i + 1] === "\n") {
-        i++; // Handle CRLF line endings
-      }
-      i++;
-      continue;
-    } else {
-      // Regular character
-      currentField += char;
-      i++;
-      continue;
-    }
-  }
-
-  // Handle any remaining data after the loop.
-  // This will capture the last field/row if the text did not end with a newline.
-  if (inQuotes) {
-    // Mismatched quotes: you might choose to throw an error or handle it gracefully.
-    throw new Error("CSV parsing error: unmatched quote in the input.");
-  }
-  if (currentField !== "" || text.at(-1) === ",") {
-    pushField();
-  }
-  if (currentRow.length > 0) {
-    pushRow();
-  }
-
-  // The first row is assumed to be the header.
-  if (rows.length === 0) {
-    return [];
-  }
-
-  const header = rows.shift();
-
-  const data = rows.map((row) =>
-    Object.fromEntries(row.map((value, index) => [header[index], value]))
-  );
-
-  return data;
-}

package/src/handlers/handlerBuiltins.js

@@ -1,27 +0,0 @@
-import * as handlers from "./handlers.js";
-
-export default function handlerBuiltins() {
-  return {
-    "css.handler": handlers.cssHandler,
-    "csv.handler": handlers.csvHandler,
-    "htm.handler": handlers.htmHandler,
-    "html.handler": handlers.htmlHandler,
-    "jpeg.handler": handlers.jpegHandler,
-    "jpg.handler": handlers.jpgHandler,
-    "js.handler": handlers.jsHandler,
-    // TODO: Remove deprecated JSE extensions
-    "jse.handler": handlers.oriHandler,
-    "jsedocument.handler": handlers.oridocumentHandler,
-    "json.handler": handlers.jsonHandler,
-    "md.handler": handlers.mdHandler,
-    "mjs.handler": handlers.mjsHandler,
-    "ori.handler": handlers.oriHandler,
-    "oridocument.handler": handlers.oridocumentHandler,
-    "ts.handler": handlers.tsHandler,
-    "txt.handler": handlers.txtHandler,
-    "wasm.handler": handlers.wasmHandler,
-    "xhtml.handler": handlers.xhtmlHandler,
-    "yaml.handler": handlers.yamlHandler,
-    "yml.handler": handlers.ymlHandler,
-  };
-}

package/src/handlers/handlers.js

@@ -1,33 +0,0 @@
-//
-// This library includes a number of modules with circular dependencies. This
-// module exists to explicitly set the loading order for those modules. To
-// enforce use of this loading order, other modules should only load the modules
-// below via this module.
-//
-// About this pattern:
-// https://medium.com/visual-development/how-to-fix-nasty-circular-dependency-issues-once-and-for-all-in-javascript-typescript-a04c987cf0de
-//
-// Note: to avoid having VS Code auto-sort the imports, keep lines between them.
-
-export { default as jsHandler } from "./js.handler.js";
-export { default as tsHandler } from "./ts.handler.js";
-
-export { default as oriHandler } from "./ori.handler.js";
-
-export { default as oridocumentHandler } from "./oridocument.handler.js";
-
-export { default as txtHandler } from "./txt.handler.js";
-
-export { default as cssHandler } from "./css.handler.js";
-export { default as csvHandler } from "./csv.handler.js";
-export { default as htmHandler } from "./htm.handler.js";
-export { default as htmlHandler } from "./html.handler.js";
-export { default as jpegHandler } from "./jpeg.handler.js";
-export { default as jpgHandler } from "./jpg.handler.js";
-export { default as jsonHandler } from "./json.handler.js";
-export { default as mdHandler } from "./md.handler.js";
-export { default as mjsHandler } from "./mjs.handler.js";
-export { default as wasmHandler } from "./wasm.handler.js";
-export { default as xhtmlHandler } from "./xhtml.handler.js";
-export { default as yamlHandler } from "./yaml.handler.js";
-export { default as ymlHandler } from "./yml.handler.js";

package/src/handlers/htm.handler.js

@@ -1,2 +0,0 @@
-// .htm is a synonynm for .html
-export { htmlHandler as default } from "./handlers.js";

package/src/handlers/html.handler.js

@@ -1,7 +0,0 @@
-// .html files use the .txt loader
-import { txtHandler } from "./handlers.js";
-
-export default {
-  ...txtHandler,
-  mediaType: "text/html",
-};

package/src/handlers/jpeg.handler.js

@@ -1,62 +0,0 @@
-import exifParser from "exif-parser";
-
-const exifDateTags = [
-  "ModifyDate",
-  "MDPrepDate",
-  "DateTimeOriginal",
-  "CreateDate",
-  "PreviewDateTime",
-  "GPSDateStamp",
-];
-
-/**
- * A JPEG file with possible Exif metadata
- */
-export default {
-  mediaType: "image/jpeg",
-
-  /** @type {import("@weborigami/async-tree").UnpackFunction} */
-  async unpack(packed, options) {
-    if (packed instanceof Uint8Array) {
-      // Downgrade to old Node Buffer for exif-parser.
-      packed = Buffer.from(packed);
-    }
-    const parser = exifParser.create(packed);
-    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/handlers/jpg.handler.js

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

package/src/handlers/js.handler.js

@@ -1,20 +0,0 @@
-import processUnpackedContent from "./processUnpackedContent.js";
-
-/**
- * A JavaScript file
- *
- * Unpacking a JavaScript file returns its default export, or its set of exports
- * if there is more than one.
- */
-export default {
-  mediaType: "application/javascript",
-
-  /** @type {import("@weborigami/async-tree").UnpackFunction} */
-  async unpack(packed, options = {}) {
-    const { key, parent } = options;
-    if (parent && "import" in parent) {
-      const content = await /** @type {any} */ (parent).import?.(key);
-      return processUnpackedContent(content, parent);
-    }
-  },
-};

package/src/handlers/json.handler.js

@@ -1,27 +0,0 @@
-import { symbols } from "@weborigami/async-tree";
-import * as utilities from "../common/utilities.js";
-
-/**
- * A JSON file
- *
- * Unpacking a JSON file returns the parsed data.
- */
-export default {
-  mediaType: "application/json",
-
-  /** @type {import("@weborigami/async-tree").UnpackFunction} */
-  unpack(packed) {
-    const json = utilities.toString(packed);
-    if (!json) {
-      throw new Error("Tried to parse something as JSON but it wasn't text.");
-    }
-    const data = JSON.parse(json);
-    if (data && typeof data === "object" && Object.isExtensible(data)) {
-      Object.defineProperty(data, symbols.deep, {
-        enumerable: false,
-        value: true,
-      });
-    }
-    return data;
-  },
-};

package/src/handlers/md.handler.js

@@ -1,7 +0,0 @@
-// .md files use the .txt loader
-import { txtHandler } from "./handlers.js";
-
-export default {
-  ...txtHandler,
-  mediaType: "text/markdown",
-};

package/src/handlers/mjs.handler.js

@@ -1,2 +0,0 @@
-// .mjs is a synonynm for .js
-export { jsHandler as default } from "./handlers.js";

package/src/handlers/ori.handler.js

@@ -1,55 +0,0 @@
-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 processUnpackedContent from "./processUnpackedContent.js";
-
-/**
- * An Origami expression file
- *
- * Unpacking an Origami file returns the result of evaluating the expression.
- */
-export default {
-  mediaType: "text/plain",
-
-  /** @type {import("@weborigami/async-tree").UnpackFunction} */
-  async unpack(packed, options = {}) {
-    const parent = getParent(packed, options);
-
-    // Construct an object to represent the source code.
-    const sourceName = options.key;
-    let url;
-    if (sourceName && /** @type {any} */ (parent)?.url) {
-      let parentHref = /** @type {any} */ (parent).url.href;
-      if (!parentHref.endsWith("/")) {
-        parentHref += "/";
-      }
-      url = new URL(sourceName, parentHref);
-    }
-
-    const source = {
-      text: utilities.toString(packed),
-      name: options.key,
-      url,
-    };
-
-    // Compile the source code as an Origami program and evaluate it.
-    const compiler = options.compiler ?? compile.program;
-
-    const config = getConfig(parent) ?? {};
-    const globals = {
-      ...(options.globals ?? builtinsProgram()),
-      ...config,
-    };
-
-    const fn = compiler(source, {
-      globals,
-      mode: "program",
-    });
-
-    let result = await fn.call(parent);
-
-    return processUnpackedContent(result, parent);
-  },
-};