npm - @weborigami/origami - Versions diffs - 0.5.5 → 0.5.6 - Mend

@weborigami/origami 0.5.5 → 0.5.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (66) hide show

package/main.js +2 -26
package/package.json +4 -5
package/src/cli/cli.js +10 -8
package/src/common/documentObject.js +1 -1
package/src/common/utilities.d.ts +0 -1
package/src/common/utilities.js +1 -19
package/src/dev/ExplorableSiteTransform.js +2 -2
package/src/dev/OriCommandTransform.js +25 -7
package/src/dev/explore.js +17 -40
package/src/dev/help.yaml +4 -1
package/src/dev/log.js +1 -1
package/src/dev/svg.js +5 -5
package/src/initializeBuiltins.js +23 -0
package/src/origami/fetch.js +4 -8
package/src/origami/indexPage.js +4 -4
package/src/origami/inline.js +3 -4
package/src/origami/jsonParse.js +1 -1
package/src/origami/mdHtml.js +3 -7
package/src/origami/mdOutline.js +3 -3
package/src/origami/ori.js +16 -24
package/src/origami/origami.js +0 -2
package/src/origami/sitemap.js +2 -2
package/src/origami/static.js +2 -2
package/src/origami/string.js +1 -10
package/src/origami/yaml.js +1 -5
package/src/origami/yamlParse.js +1 -1
package/src/server/constructResponse.js +1 -1
package/src/server/server.js +6 -26
package/src/builtinsProgram.js +0 -56
package/src/builtinsShell.js +0 -18
package/src/cli/getConfig.js +0 -11
package/src/common/constructHref.js +0 -20
package/src/common/constructSiteTree.js +0 -34
package/src/common/fetchAndHandleExtension.js +0 -27
package/src/handlers/css.handler.js +0 -7
package/src/handlers/csv.handler.js +0 -129
package/src/handlers/handlerBuiltins.js +0 -27
package/src/handlers/handlers.js +0 -33
package/src/handlers/htm.handler.js +0 -2
package/src/handlers/html.handler.js +0 -7
package/src/handlers/jpeg.handler.js +0 -62
package/src/handlers/jpg.handler.js +0 -2
package/src/handlers/js.handler.js +0 -20
package/src/handlers/json.handler.js +0 -27
package/src/handlers/md.handler.js +0 -7
package/src/handlers/mjs.handler.js +0 -2
package/src/handlers/ori.handler.js +0 -55
package/src/handlers/oridocument.handler.js +0 -78
package/src/handlers/parseFrontMatter.js +0 -16
package/src/handlers/processUnpackedContent.js +0 -35
package/src/handlers/ts.handler.js +0 -1
package/src/handlers/txt.handler.js +0 -91
package/src/handlers/wasm.handler.js +0 -17
package/src/handlers/xhtml.handler.js +0 -2
package/src/handlers/yaml.handler.js +0 -36
package/src/handlers/yml.handler.js +0 -2
package/src/origami/config.js +0 -18
package/src/origami/project.js +0 -111
package/src/protocols/explore.js +0 -17
package/src/protocols/files.js +0 -31
package/src/protocols/http.js +0 -18
package/src/protocols/https.js +0 -18
package/src/protocols/httpstree.js +0 -17
package/src/protocols/httptree.js +0 -17
package/src/protocols/node.js +0 -13
package/src/protocols/package.js +0 -70

package/src/handlers/oridocument.handler.js DELETED Viewed

@@ -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 (sourceValue, 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 DELETED Viewed

@@ -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 DELETED Viewed

@@ -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 DELETED Viewed

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

package/src/handlers/txt.handler.js DELETED Viewed

@@ -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 DELETED Viewed

@@ -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 DELETED Viewed

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

package/src/handlers/yaml.handler.js DELETED Viewed

@@ -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 DELETED Viewed

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

package/src/origami/config.js DELETED Viewed

@@ -1,18 +0,0 @@
-import project from "./project.js";
-/**
- * Return the configuration for the current project.
- *
- * The configuration is the project's config.ori file (if defined in the project
- * root) plus the Origami builtins.
- *
- * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
- *
- * @this {AsyncTree|null}
- * @param {any} [key]
- */
-export default async function config(key) {
-  const projectTree = await project.call(this);
-  const projectConfig = projectTree.config;
-  return key === undefined ? projectConfig : projectConfig[key];
-}

package/src/origami/project.js DELETED Viewed

@@ -1,111 +0,0 @@
-/** @typedef {import("@weborigami/types").AsyncTree} AsyncTree */
-import { OrigamiFiles } from "@weborigami/language";
-import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
-import handlerBuiltins from "../handlers/handlerBuiltins.js";
-import { oriHandler } from "../handlers/handlers.js";
-const configFileName = "config.ori";
-/**
- * Return an object for the current project including
- *
- * `config`: the evaluated config.ori file
- * `root`: the project's root folder
- *
- * This searches the current directory and its ancestors for an Origami file
- * called `config.ori`. If an Origami configuration file is found, the
- * containing folder is considered to be the project root. This returns a tree
- * for that folder, with the exported configuration as the context for that
- * folder — that is, the tree exported by the configuration will be the scope.
- *
- * If no Origami configuration file is found, the current folder will be
- * returned as a tree, with the builtins as its parent.
- *
- * @this {AsyncTree|null}
- */
-export default async function project() {
-  assertTreeIsDefined(this, "project");
-  const dirname = process.cwd();
-  const currentTree = new OrigamiFiles(dirname);
-  let config;
-  // Search up the tree for the configuration file or package.json to determine
-  // the project root.
-  let root;
-  const foundConfig = await findAncestorFile(currentTree, configFileName);
-  if (foundConfig) {
-    root = foundConfig.container;
-    // Attach standard extension handlers so config can use them
-    root.handlers = handlerBuiltins();
-    // Unpack Origami configuration file
-    const buffer = foundConfig.value;
-    config = await oriHandler.unpack(buffer, {
-      key: configFileName,
-      parent: root,
-    });
-    root.config = config;
-  } else {
-    // No Origami configuration file, look for package.json
-    const foundPackageJson = await findAncestorFile(
-      currentTree,
-      "package.json"
-    );
-    if (foundPackageJson) {
-      // Found package.json; use its parent as the project root
-      root = foundPackageJson.container;
-    } else {
-      // No package.json found; use the current directory as root
-      root = currentTree;
-    }
-  }
-  // Merge config if present into handlers
-  root.handlers = config
-    ? {
-        ...handlerBuiltins(),
-        ...configHandlers(config),
-      }
-    : handlerBuiltins();
-  return root;
-}
-// Find the first ancestor of the given folder that contains a file with the
-// given name. Return the container and the file contents.
-async function findAncestorFile(start, fileName) {
-  let container = start;
-  while (container) {
-    const value = await container.get(fileName);
-    if (value) {
-      // Found the desired file
-      return {
-        container,
-        value,
-      };
-    }
-    // Not found; try the parent
-    const parent = await container.get("..");
-    if (
-      !parent ||
-      (parent.path && container.path && parent.path === container.path)
-    ) {
-      break;
-    }
-    container = parent;
-  }
-  // Not found
-  return null;
-}
-// Return an object with all `.handler` keys from the config
-function configHandlers(config) {
-  const handlers = {};
-  for (const key in config) {
-    if (key.endsWith(".handler")) {
-      handlers[key] = config[key];
-    }
-  }
-  return handlers;
-}

package/src/protocols/explore.js DELETED Viewed

@@ -1,17 +0,0 @@
-import { ExplorableSiteTree } from "@weborigami/async-tree";
-import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
-import constructSiteTree from "../common/constructSiteTree.js";
-/**
- * A site tree with JSON Keys via HTTPS.
- *
- * @typedef  {import("@weborigami/types").AsyncTree} AsyncTree
- *
- * @this {AsyncTree|null}
- * @param {string} host
- * @param  {...string} keys
- */
-export default function explore(host, ...keys) {
-  assertTreeIsDefined(this, "explore");
-  return constructSiteTree("https:", ExplorableSiteTree, this, host, ...keys);
-}

package/src/protocols/files.js DELETED Viewed

@@ -1,31 +0,0 @@
-import { OrigamiFiles, getHandlers } from "@weborigami/language";
-import os from "node:os";
-import path from "node:path";
-import process from "node:process";
-import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
-/**
- * @typedef  {import("@weborigami/types").AsyncTree} AsyncTree
- *
- * @this {AsyncTree|null}
- * @param {string[]} keys
- */
-export default async function files(...keys) {
-  assertTreeIsDefined(this, "files");
-  // If path begins with `~`, treat it relative to the home directory.
-  // Otherwise, treat it relative to the current working directory.
-  let relativePath = keys.join(path.sep);
-  let basePath;
-  if (relativePath.startsWith("~")) {
-    basePath = os.homedir();
-    relativePath = relativePath.slice(2);
-  } else {
-    basePath = process.cwd();
-  }
-  const resolved = path.resolve(basePath, relativePath);
-  const result = new OrigamiFiles(resolved);
-  /** @type {any} */ (result).handlers = getHandlers(this);
-  return result;
-}

package/src/protocols/http.js DELETED Viewed

@@ -1,18 +0,0 @@
-import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
-import constructHref from "../common/constructHref.js";
-import fetchAndHandleExtension from "../common/fetchAndHandleExtension.js";
-/**
- * Retrieve the indicated web resource via HTTP.
- *
- * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
- *
- * @this {AsyncTree|null}
- * @param {string} host
- * @param  {...string} keys
- */
-export default async function http(host, ...keys) {
-  assertTreeIsDefined(this, "http");
-  const href = constructHref("http:", host, ...keys);
-  return fetchAndHandleExtension.call(this, href);
-}

package/src/protocols/https.js DELETED Viewed

@@ -1,18 +0,0 @@
-import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
-import constructHref from "../common/constructHref.js";
-import fetchAndHandleExtension from "../common/fetchAndHandleExtension.js";
-/**
- * Retrieve the indicated web resource via HTTPS.
- *
- * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
- *
- * @this {AsyncTree|null}
- * @param {string} host
- * @param  {...string} keys
- */
-export default async function https(host, ...keys) {
-  assertTreeIsDefined(this, "https");
-  const href = constructHref("https:", host, ...keys);
-  return fetchAndHandleExtension.call(this, href);
-}

package/src/protocols/httpstree.js DELETED Viewed

@@ -1,17 +0,0 @@
-import { SiteTree } from "@weborigami/async-tree";
-import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
-import constructSiteTree from "../common/constructSiteTree.js";
-/**
- * Return a website tree via HTTPS.
- *
- * @typedef  {import("@weborigami/types").AsyncTree} AsyncTree
- *
- * @this {AsyncTree|null}
- * @param {string} host
- * @param  {...string} keys
- */
-export default function httpstree(host, ...keys) {
-  assertTreeIsDefined(this, "treehttps");
-  return constructSiteTree("https:", SiteTree, this, host, ...keys);
-}

package/src/protocols/httptree.js DELETED Viewed

@@ -1,17 +0,0 @@
-import { SiteTree } from "@weborigami/async-tree";
-import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
-import constructSiteTree from "../common/constructSiteTree.js";
-/**
- * Return a website tree via HTTP.
- *
- * @typedef  {import("@weborigami/types").AsyncTree} AsyncTree
- *
- * @this {AsyncTree|null}
- * @param {string} host
- * @param  {...string} keys
- */
-export default function httptree(host, ...keys) {
-  assertTreeIsDefined(this, "httptree");
-  return constructSiteTree("http:", SiteTree, this, host, ...keys);
-}

package/src/protocols/node.js DELETED Viewed

@@ -1,13 +0,0 @@
-import { trailingSlash, Tree } from "@weborigami/async-tree";
-/**
- * The node: protocol does a dynamic import from the `node:` namespace.
- *
- * @param {string[]} keys
- */
-export default async function node(...keys) {
-  const key = keys.shift();
-  const normalized = trailingSlash.remove(key);
-  const module = await import(`node:${normalized}`);
-  return keys.length > 0 ? Tree.traverse(module, ...keys) : module;
-}

package/src/protocols/package.js DELETED Viewed

@@ -1,70 +0,0 @@
-import { Tree, keysFromPath } from "@weborigami/async-tree";
-import project from "../origami/project.js";
-/**
- * @this {import("@weborigami/types").AsyncTree|null}
- * @param {string[]} keys
- */
-export default async function packageNamespace(...keys) {
-  const parent = this ?? (await project.call(null));
-  let name = keys.shift();
-  let organization;
-  if (name?.startsWith("@")) {
-    // First key is an npm organization
-    organization = name;
-    if (keys.length === 0) {
-      // Return a function that will process the next key
-      return async (name, ...keys) =>
-        getPackage(parent, organization, name, keys);
-    }
-    name = keys.shift();
-  }
-  return getPackage(parent, organization, name, keys);
-}
-async function getPackage(parent, organization, name, keys) {
-  const packagePath = ["node_modules"];
-  if (organization) {
-    packagePath.push(organization);
-  }
-  packagePath.push(name);
-  const parentScope = await Tree.scope(parent);
-  const packageRoot = await Tree.traverse(
-    // @ts-ignore
-    parentScope,
-    ...packagePath
-  );
-  if (!packageRoot) {
-    throw new Error(`Can't find ${packagePath.join("/")}`);
-  }
-  const mainPath = await Tree.traverse(packageRoot, "package.json", "main");
-  if (!mainPath) {
-    throw new Error(
-      `node_modules/${keys.join(
-        "/"
-      )} doesn't contain a package.json with a "main" entry.`
-    );
-  }
-  const mainKeys = keysFromPath(mainPath);
-  const mainContainerKeys = mainKeys.slice(0, -1);
-  const mainFileName = mainKeys[mainKeys.length - 1];
-  const mainContainer = await Tree.traverse(packageRoot, ...mainContainerKeys);
-  const packageExports = await mainContainer.import(mainFileName);
-  const result =
-    keys.length > 0
-      ? await Tree.traverse(packageExports, ...keys)
-      : packageExports;
-  if (Tree.isAsyncTree(result)) {
-    result.parent = parent;
-  }
-  return result;
-}