@weborigami/origami 0.5.4 → 0.5.6

package/src/handlers/csv.handler.js

@@ -1,126 +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);
-    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);
-  },
-};

package/src/handlers/oridocument.handler.js

@@ -1,78 +0,0 @@
-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 processUnpackedContent from "./processUnpackedContent.js";
-
-/**
- * An Origami template document: a plain text file that contains Origami
- * expressions.
- */
-export default {
-  mediaType: "text/plain",
-
-  /** @type {import("@weborigami/async-tree").UnpackFunction} */
-  async unpack(packed, options = {}) {
-    const parent = getParent(packed, options);
-
-    // Unpack as a text document
-    const text = toString(packed);
-
-    // See if we can construct a URL to use in error messages
-    const key = options.key;
-    let url;
-    if (key && /** @type {any} */ (parent)?.url) {
-      let parentHref = /** @type {any} */ (parent).url.href;
-      if (!parentHref.endsWith("/")) {
-        parentHref += "/";
-      }
-      url = new URL(key, parentHref);
-    }
-
-    // Compile the text as an Origami template document
-    const source = {
-      name: key,
-      text,
-      url,
-    };
-
-    const config = getConfig(parent) ?? {};
-    const globals = {
-      ...(options.globals ?? builtinsProgram()),
-      ...config,
-    };
-
-    const defineFn = compile.templateDocument(source, {
-      front: options.front,
-      globals,
-      mode: "program",
-    });
-
-    // Invoke the definition to get back the template function
-    const result = await defineFn.call(parent);
-
-    const resultExtension = key ? extension.extname(key) : null;
-    if (resultExtension && Object.isExtensible(result)) {
-      // Add sidecar function so this template can be used in a map.
-      result.key = addExtension(resultExtension);
-    }
-
-    return processUnpackedContent(result, parent);
-  },
-};
-
-// Return a function that adds the given extension
-function addExtension(resultExtension) {
-  return (sourceKey) => {
-    if (sourceKey === undefined) {
-      return undefined;
-    }
-    const normalizedKey = trailingSlash.remove(sourceKey);
-    const sourceExtension = extension.extname(normalizedKey);
-    const resultKey = sourceExtension
-      ? extension.replace(normalizedKey, sourceExtension, resultExtension)
-      : normalizedKey + resultExtension;
-    return resultKey;
-  };
-}

package/src/handlers/parseFrontMatter.js

@@ -1,16 +0,0 @@
-import { isOrigamiFrontMatter } from "@weborigami/language";
-
-export default function parseFrontMatter(text) {
-  const regex =
-    /^(---\r?\n(?<frontText>[\s\S]*?\r?\n?)---\r?\n)(?<body>[\s\S]*$)/;
-  const match = regex.exec(text);
-  if (!match?.groups) {
-    return null;
-  }
-  const isOrigami = isOrigamiFrontMatter(match.groups.frontText);
-  return {
-    body: match.groups.body,
-    frontText: match.groups.frontText,
-    isOrigami,
-  };
-}

package/src/handlers/processUnpackedContent.js

@@ -1,35 +0,0 @@
-import { symbols, Tree } from "@weborigami/async-tree";
-
-/**
- * Perform any necessary post-processing on the unpacked content of a file. This
- * lets treat the contents of various file types consistently.
- *
- * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
- *
- * @param {any} content
- * @param {AsyncTree|null} parent
- * @returns
- */
-export default function processUnpackedContent(content, parent) {
-  if (typeof content === "function") {
-    // Bind the function to the parent as the `this` context.
-    const result = content.bind(parent);
-    // Copy over any properties that were attached to the function
-    Object.assign(result, content);
-    return result;
-  } else if (Tree.isAsyncTree(content) && !content.parent) {
-    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/handlers/ts.handler.js

@@ -1 +0,0 @@
-export { jsHandler as default } from "./handlers.js";

package/src/handlers/txt.handler.js

@@ -1,91 +0,0 @@
-import { isPacked, symbols } from "@weborigami/async-tree";
-import { compile } from "@weborigami/language";
-import { parseYaml, toYaml } from "../common/serialize.js";
-import { toString } from "../common/utilities.js";
-import parseFrontMatter from "./parseFrontMatter.js";
-
-/**
- * A text file with possible front matter
- *
- * The unpacking process will parse out any YAML or JSON front matter and attach
- * it to the document as data. The first line of the text must be "---",
- * followed by a block of JSON or YAML, followed by another line of "---". Any
- * lines following will be treated as the document text.
- *
- * If there is no front matter, the document will be treated as plain text and
- * returned as a String object.
- *
- * If there is front matter, any Origami expressions in the front matter will be
- * evaluated. The result will be a plain JavaScript object with the evaluated
- * data and a `_body` property containing the document text.
- */
-export default {
-  mediaType: "text/plain",
-
-  /**
-   * If the input is already in some packed format, it will be returned as is.
-   *
-   * Otherwise, the properties of the object will be formatted as YAML. If the
-   * object has a `_body` property, that will be used as the body of the text
-   * document; otherwise, an empty string will be used.
-   *
-   * @param {any} object
-   * @returns {Promise<import("@weborigami/async-tree").Packed>}
-   */
-  async pack(object) {
-    if (isPacked(object)) {
-      return object;
-    } else if (!object || typeof object !== "object") {
-      throw new TypeError("The input to pack must be a JavaScript object.");
-    }
-
-    const text = object._body ?? "";
-
-    /** @type {any} */
-    const dataWithoutText = Object.assign({}, object);
-    delete dataWithoutText._body;
-    if (Object.keys(dataWithoutText).length > 0) {
-      const frontMatter = (await toYaml(dataWithoutText)).trimEnd();
-      return `---\n${frontMatter}\n---\n${text}`;
-    } else {
-      return text;
-    }
-  },
-
-  /** @type {import("@weborigami/async-tree").UnpackFunction} */
-  async unpack(packed, options = {}) {
-    const parent = options.parent ?? null;
-    const text = toString(packed);
-    if (text === null) {
-      throw new Error("Tried to treat a file as text but it wasn't text.");
-    }
-
-    const parsed = parseFrontMatter(text);
-    let unpacked;
-    if (parsed) {
-      // Document object with front matter
-      const { body, frontText, isOrigami } = parsed;
-      let frontData;
-      if (isOrigami) {
-        const compiled = compile.expression(frontText.trim());
-        frontData = await compiled.call(parent);
-      } else {
-        frontData = parseYaml(frontText);
-      }
-      unpacked = { ...frontData };
-      Object.defineProperty(unpacked, "_body", {
-        configurable: true,
-        enumerable: true,
-        value: body,
-        writable: true,
-      });
-    } else {
-      // Plain text
-      unpacked = new String(text);
-    }
-
-    unpacked[symbols.parent] = parent;
-
-    return unpacked;
-  },
-};

package/src/handlers/wasm.handler.js

@@ -1,17 +0,0 @@
-import processUnpackedContent from "./processUnpackedContent.js";
-
-/**
- * A WebAssembly module
- *
- * Unpacking a WebAssembly module returns its exports.
- */
-export default {
-  mediaType: "application/wasm",
-
-  /** @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.
-    return processUnpackedContent(wasmModule.instance.exports, options.parent);
-  },
-};

package/src/handlers/xhtml.handler.js

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

package/src/handlers/yaml.handler.js

@@ -1,36 +0,0 @@
-import { symbols } from "@weborigami/async-tree";
-import * as YAMLModule from "yaml";
-import { parseYaml } from "../common/serialize.js";
-import * as utilities from "../common/utilities.js";
-import processUnpackedContent from "./processUnpackedContent.js";
-
-// See notes at serialize.js
-// @ts-ignore
-const YAML = YAMLModule.default ?? YAMLModule.YAML;
-
-/**
- * A YAML file
- *
- * Unpacking a YAML file returns the parsed data.
- *
- */
-export default {
-  mediaType: "application/yaml",
-
-  /** @type {import("@weborigami/async-tree").UnpackFunction} */
-  unpack(packed, options = {}) {
-    const parent = options.parent ?? null;
-    const yaml = utilities.toString(packed);
-    if (!yaml) {
-      throw new Error("Tried to parse something as YAML but it wasn't text.");
-    }
-    const data = parseYaml(yaml);
-    if (data && typeof data === "object" && Object.isExtensible(data)) {
-      Object.defineProperty(data, symbols.deep, {
-        enumerable: false,
-        value: true,
-      });
-    }
-    return processUnpackedContent(data, parent);
-  },
-};

package/src/handlers/yml.handler.js

@@ -1,2 +0,0 @@
-// .yml is a synonym for .yaml
-export { yamlHandler as default } from "./handlers.js";