@weborigami/origami 0.4.1 → 0.5.0

package/src/origami/fetch.js

@@ -0,0 +1,22 @@
+import { getHandlers, handleExtension } from "@weborigami/language";
+
+/**
+ * @this {import("@weborigami/types").AsyncTree|null|undefined}
+ */
+export default async function fetchBuiltin(resource, options) {
+  const response = await fetch(resource, options);
+  if (!response.ok) {
+    return undefined;
+  }
+
+  const value = await response.arrayBuffer();
+  if (!this) {
+    // Can't get extension handlers
+    return value;
+  }
+
+  const handlers = getHandlers(this);
+  const url = new URL(resource);
+  const key = url.pathname;
+  return handleExtension(this, value, key, handlers);
+}

package/src/{image → origami/image}/format.js

@@ -1,5 +1,5 @@
-import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
-import imageFormatFn from "./formatFn.js";
+import sharp from "sharp";
+import assertTreeIsDefined from "../../common/assertTreeIsDefined.js";
 
 /**
  * Return the image in a different format.
@@ -14,5 +14,7 @@ import imageFormatFn from "./formatFn.js";
  */
 export default async function imageFormat(input, format, options) {
   assertTreeIsDefined(this, "format");
-  return imageFormatFn.call(this, format, options)(input);
+  return input instanceof Uint8Array || input instanceof ArrayBuffer
+    ? sharp(input).toFormat(format, options).toBuffer()
+    : undefined;
 }

package/src/{image → origami/image}/resize.js

@@ -1,5 +1,5 @@
 import sharp from "sharp";
-import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
+import assertTreeIsDefined from "../../common/assertTreeIsDefined.js";
 
 /**
  * Resize an image.

package/src/{site → origami}/indexPage.js

@@ -11,7 +11,7 @@ import { getDescriptor } from "../common/utilities.js";
  * @param {string} [basePath]
  */
 export default async function indexPage(treelike, basePath) {
-  const tree = await getTreeArgument(this, arguments, treelike, "site:index");
+  const tree = await getTreeArgument(this, arguments, treelike, "indexPage");
   const keys = Array.from(await tree.keys());
 
   // Skip system-ish files that start with a period. Also skip `index.html`.

package/src/{text → origami}/inline.js

@@ -1,7 +1,7 @@
 import { isUnpackable, symbols, toString } from "@weborigami/async-tree";
 import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
 import documentObject from "../common/documentObject.js";
-import { jsedocumentHandler } from "../handlers/handlers.js";
+import { oridocumentHandler } from "../handlers/handlers.js";
 
 /**
  * Inline any Origami expressions found inside ${...} placeholders in the input
@@ -20,11 +20,8 @@ export default async function inline(input) {
   if (isUnpackable(input)) {
     input = await input.unpack();
   }
-  const inputIsDocument =
-    input["@text"] !== undefined || input._body !== undefined;
-  const origami = inputIsDocument
-    ? input["@text"] ?? input._body
-    : toString(input);
+  const inputIsDocument = input._body !== undefined;
+  const origami = inputIsDocument ? input._body : toString(input);
   if (origami === null) {
     return undefined;
   }
@@ -38,16 +35,14 @@ export default async function inline(input) {
   if (inputIsDocument) {
     // Collect all document properties except the body
     front = Object.fromEntries(
-      Object.entries(input).filter(
-        ([key]) => key !== "@text" && key !== "_body"
-      )
+      Object.entries(input).filter(([key]) => key !== "_body")
     );
   } else {
     front = null;
   }
 
   // @ts-ignore
-  let result = await jsedocumentHandler.unpack(origami, {
+  let result = await oridocumentHandler.unpack(origami, {
     front,
     parent,
   });

package/src/{site → origami}/jsonKeys.js

@@ -1,6 +1,5 @@
 import { Tree, jsonKeys } from "@weborigami/async-tree";
 import getTreeArgument from "../common/getTreeArgument.js";
-import { transformObject } from "../common/utilities.js";
 
 /**
  * Expose .keys.json for a tree.
@@ -15,29 +14,29 @@ export default async function jsonKeysBuiltin(treelike) {
     this,
     arguments,
     treelike,
-    "site:jsonKeys",
+    "jsonKeys",
     true
   );
-  return transformObject(JsonKeysTransform, tree);
+  return jsonKeysTree(tree);
 }
 
-function JsonKeysTransform(Base) {
-  return class Static extends Base {
+function jsonKeysTree(tree) {
+  return Object.assign(Object.create(tree), {
     async get(key) {
-      let value = await super.get(key);
+      let value = await tree.get(key);
       if (value === undefined && key === ".keys.json") {
         value = await jsonKeys.stringify(this);
       } else if (Tree.isTreelike(value)) {
-        const tree = Tree.from(value, { deep: true, parent: this });
-        value = transformObject(JsonKeysTransform, tree);
+        const subtree = Tree.from(value, { deep: true, parent: this });
+        value = jsonKeysTree(subtree);
       }
       return value;
-    }
+    },
 
     async keys() {
-      const keys = new Set(await super.keys());
+      const keys = new Set(await tree.keys());
       keys.add(".keys.json");
       return keys;
-    }
-  };
+    },
+  });
 }

package/src/{text → origami}/mdHtml.js

@@ -47,8 +47,7 @@ export default async function mdHtml(input) {
   if (isUnpackable(input)) {
     input = await input.unpack();
   }
-  const inputIsDocument =
-    typeof input === "object" && ("_body" in input || "@text" in input);
+  const inputIsDocument = typeof input === "object" && "_body" in input;
   const markdown = toString(input);
   if (markdown === null) {
     throw new Error("mdHtml: The provided input couldn't be treated as text.");

package/src/origami/origami.js

@@ -1,10 +1,24 @@
 export { extension } from "@weborigami/async-tree";
 export { toFunction } from "../common/utilities.js";
-
 export { default as help } from "../dev/help.js"; // Alias
+export { default as document } from "../origami/document.js";
+export { default as htmlDom } from "../origami/htmlDom.js";
+export { default as indexPage } from "../origami/indexPage.js";
+export { default as inline } from "../origami/inline.js";
+export { default as jsonKeys } from "../origami/jsonKeys.js";
+export { default as mdHtml } from "../origami/mdHtml.js";
+export { default as redirect } from "../origami/redirect.js";
+export { default as rss } from "../origami/rss.js";
+export { default as sitemap } from "../origami/sitemap.js";
+export { default as slug } from "../origami/slug.js";
+export { default as static } from "../origami/static.js";
 export { default as basename } from "./basename.js";
 export { default as config } from "./config.js";
 export { default as csv } from "./csv.js";
+export { default as fetch } from "./fetch.js";
+export { default as format } from "./image/format.js";
+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 naturalOrder } from "./naturalOrder.js";
@@ -13,7 +27,6 @@ export { default as ori } from "./ori.js";
 export { default as pack } from "./pack.js";
 export { default as post } from "./post.js";
 export { default as project } from "./project.js";
-export { default as regexMatch } from "./regexMatch.js";
 export { default as repeat } from "./repeat.js";
 export { default as shell } from "./shell.js";
 export { default as slash } from "./slash.js";

package/src/{text → origami}/origamiHighlightDefinition.js

@@ -26,32 +26,17 @@ export default function origamiHighlightDefinition(hljs) {
           },
         ],
       },
-      {
-        // Treat namespaces as keywords
-        className: "keyword",
-        begin:
-          /\b(calc|dev|explore|files|http|https|httpstree|httptree|image|inherited|js|new|node|origami|package|scope|site|text|tree):\b/,
-      },
-      {
-        // Treat identifier containing a period before an open paren or backtick as a variable
-        className: "variable",
-        begin:
-          /\b[^(){}\[\]<>\?!\|=,/:\`"'«»\\→⇒… \t\n\r]+\.[^(){}\[\]<>\?!\|=,/:\`"'«»\\→⇒… \t\n\r]+(?=(\(|\`))\b/,
-      },
-      {
-        className: "built_in",
-        // Treat shorthands before open paren or backtick as a builtin
-        begin: /\b[A-Za-z][A-Za-z0-9]*(?=(\(|\`))\b/,
-      },
       {
         className: "operator",
         begin:
-          /===|!==|==|!=|<=|<|>=|>|\*|\*\*|\/|%|\+|-|=>|⇒|->|→|=|:|\.\.\.|…|&&|&|\|\||\||!|\^|~|\?\?|\?|#!/,
+          /===|!==|==|!=|<=|<|>=|>|\*|\*\*|\/|%|\+|-|=>|⇒|->|→|=|:|\.\.\.|&&|&|\|\||\||!|\^|~|\?\?|\?|#!/,
       },
       {
-        // Treat remaining identifiers as variables
         className: "variable",
-        begin: /\b[^(){}\[\]<>\?!\|=,/:\`"'«»\\→⇒… \t\n\r]+\b/,
+        // This is simpler than the corresponding definition in the VS Code
+        // extension; we couldn't figure out how to get the Unicode ID_Continue
+        // pattern to match.
+        begin: /[$_A-Za-z0-9\.~][$_A-Za-z0-9\.~@!+\-*%&|^]*/,
       },
     ],
   };

package/src/origami/project.js

@@ -36,6 +36,8 @@ export default async function project() {
   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, {

package/src/{site → origami}/sitemap.js

@@ -21,7 +21,7 @@ const templateText = `(urls) => \`<?xml version="1.0" encoding="UTF-8"?>
  */
 export default async function sitemap(treelike, baseHref = "") {
   assertTreeIsDefined(this, "sitemap");
-  const tree = await getTreeArgument(this, arguments, treelike, "site:sitemap");
+  const tree = await getTreeArgument(this, arguments, treelike, "sitemap");
 
   // We're only interested in keys that end in .html or with no extension.
   function test(key) {

package/src/{site → origami}/static.js

@@ -1,6 +1,5 @@
 import { Tree, jsonKeys } from "@weborigami/async-tree";
 import getTreeArgument from "../common/getTreeArgument.js";
-import { transformObject } from "../common/utilities.js";
 import index from "./indexPage.js";
 
 /**
@@ -12,8 +11,8 @@ import index from "./indexPage.js";
  * @param {Treelike} treelike
  */
 export default async function staticBuiltin(treelike) {
-  const tree = await getTreeArgument(this, arguments, treelike, "site:static");
-  const result = transformObject(StaticTransform, tree);
+  const tree = await getTreeArgument(this, arguments, treelike, "static");
+  const result = staticTree(tree);
   result.parent = this;
   return result;
 }
@@ -21,26 +20,26 @@ export default async function staticBuiltin(treelike) {
 // The name we'll register as a builtin
 staticBuiltin.key = "static";
 
-function StaticTransform(Base) {
-  return class Static extends Base {
+function staticTree(tree) {
+  return Object.assign(Object.create(tree), {
     async get(key) {
-      let value = await super.get(key);
+      let value = await tree.get(key);
       if (value === undefined && key === "index.html") {
         value = await index.call(this, this);
       } else if (value === undefined && key === ".keys.json") {
         value = await jsonKeys.stringify(this);
       } else if (Tree.isTreelike(value)) {
-        const tree = Tree.from(value, { parent: this });
-        value = transformObject(StaticTransform, tree);
+        const subtree = Tree.from(value, { parent: this });
+        value = staticTree(subtree);
       }
       return value;
-    }
+    },
 
     async keys() {
-      const keys = new Set(await super.keys());
+      const keys = new Set(await tree.keys());
       keys.add("index.html");
       keys.add(".keys.json");
       return keys;
-    }
-  };
+    },
+  });
 }

package/src/tree/addNextPrevious.js

@@ -14,7 +14,7 @@ export default async function addNextPreviousBuiltin(treelike) {
     this,
     arguments,
     treelike,
-    "tree:addNextPrevious"
+    "addNextPrevious"
   );
   const result = await addNextPrevious(tree);
   result[symbols.parent] = this;

package/src/tree/clear.js

@@ -8,7 +8,7 @@ import getTreeArgument from "../common/getTreeArgument.js";
  * @param {import("@weborigami/async-tree").Treelike} treelike
  */
 export default async function clear(treelike) {
-  const tree = await getTreeArgument(this, arguments, treelike, "tree:clear");
+  const tree = await getTreeArgument(this, arguments, treelike, "clear");
   if (!Tree.isAsyncMutableTree(tree)) {
     throw new TypeError("clean: the given tree is read-only.");
   }

package/src/tree/deepMap.js

@@ -19,7 +19,7 @@ export default async function deepMap(treelike, operation) {
     this,
     arguments,
     treelike,
-    "tree:deepMap",
+    "deepMap",
     true
   );
   /** @type {TreeMapOptions} */

package/src/tree/deepReverse.js

@@ -15,7 +15,7 @@ export default async function deepReverseBuiltin(treelike) {
     this,
     arguments,
     treelike,
-    "tree:deepReverse",
+    "deepReverse",
     true
   );
   const reversed = deepReverse(tree);

package/src/tree/deepTake.js

@@ -17,7 +17,7 @@ export default async function deepTake(treelike, count) {
     this,
     arguments,
     treelike,
-    "tree:deepTake",
+    "deepTake",
     true
   );
   const taken = await deepTakeTransform(tree, count);

package/src/tree/deepValues.js

@@ -15,7 +15,7 @@ export default async function deepValuesBuiltin(treelike) {
     this,
     arguments,
     treelike,
-    "tree:deepValues",
+    "deepValues",
     true
   );
   return deepValues(tree);

package/src/tree/defineds.js

@@ -11,12 +11,7 @@ import getTreeArgument from "../common/getTreeArgument.js";
  * @param {Treelike} treelike
  */
 export default async function defineds(treelike) {
-  const tree = await getTreeArgument(
-    this,
-    arguments,
-    treelike,
-    "tree:defineds"
-  );
+  const tree = await getTreeArgument(this, arguments, treelike, "defineds");
 
   const result = await Tree.mapReduce(tree, null, async (values, keys) => {
     const object = {};

package/src/tree/first.js

@@ -9,7 +9,7 @@ import getTreeArgument from "../common/getTreeArgument.js";
  * @param {Treelike} [treelike]
  */
 export default async function first(treelike) {
-  const tree = await getTreeArgument(this, arguments, treelike, "tree:first");
+  const tree = await getTreeArgument(this, arguments, treelike, "first");
   for (const key of await tree.keys()) {
     // Just return first value immediately.
     const value = await tree.get(key);

package/src/tree/group.js

@@ -13,7 +13,7 @@ import { toFunction } from "../common/utilities.js";
  * @param {import("../../index.ts").Invocable} groupKey
  */
 export default async function groupBuiltin(treelike, groupKey) {
-  const tree = await getTreeArgument(this, arguments, treelike, "tree:group");
+  const tree = await getTreeArgument(this, arguments, treelike, "group");
 
   const groupKeyFn = toFunction(groupKey);
   // Have the group key function run in this tree.

package/src/tree/inners.js

@@ -11,7 +11,7 @@ import getTreeArgument from "../common/getTreeArgument.js";
  * @param {Treelike} [treelike]
  */
 export default async function inners(treelike) {
-  const tree = await getTreeArgument(this, arguments, treelike, "tree:inners");
+  const tree = await getTreeArgument(this, arguments, treelike, "inners");
 
   const result = {
     async get(key) {

package/src/tree/keys.js

@@ -9,7 +9,7 @@ import getTreeArgument from "../common/getTreeArgument.js";
  * @param {Treelike} [treelike]
  */
 export default async function keys(treelike) {
-  const tree = await getTreeArgument(this, arguments, treelike, "tree:keys");
+  const tree = await getTreeArgument(this, arguments, treelike, "keys");
   const keys = await tree.keys();
   return Array.from(keys);
 }

package/src/tree/length.js

@@ -9,7 +9,7 @@ import getTreeArgument from "../common/getTreeArgument.js";
  * @param {Treelike} [treelike]
  */
 export default async function length(treelike) {
-  const tree = await getTreeArgument(this, arguments, treelike, "tree:length");
+  const tree = await getTreeArgument(this, arguments, treelike, "length");
   const keys = Array.from(await tree.keys());
   return keys.length;
 }

package/src/tree/map.js

@@ -31,7 +31,7 @@ export default async function map(treelike, operation) {
     this,
     arguments,
     treelike,
-    "tree:map",
+    "map",
     options?.deep
   );
 
@@ -67,6 +67,11 @@ function extendedOptions(context, operation) {
   ) {
     valueFn = operation;
     options = {};
+  } else if (operation === undefined) {
+    /** @type {any} */
+    const error = new TypeError(`map: The second parameter was undefined.`);
+    error.position = 1;
+    throw error;
   } else {
     throw new TypeError(
       `map: You must specify a value function or options dictionary as the second parameter.`

package/src/tree/paginate.js

@@ -13,12 +13,7 @@ import getTreeArgument from "../common/getTreeArgument.js";
  * @param {number} [size=10]
  */
 export default async function paginateBuiltin(treelike, size = 10) {
-  const tree = await getTreeArgument(
-    this,
-    arguments,
-    treelike,
-    "tree:paginate"
-  );
+  const tree = await getTreeArgument(this, arguments, treelike, "paginate");
   const paginated = await paginate(tree, size);
   paginated.parent = this;
   return paginated;

package/src/tree/parent.js

@@ -10,6 +10,6 @@ import getTreeArgument from "../common/getTreeArgument.js";
  * @param {Treelike} [treelike]
  */
 export default async function parent(treelike) {
-  const tree = await getTreeArgument(this, arguments, treelike, "tree:parent");
+  const tree = await getTreeArgument(this, arguments, treelike, "parent");
   return tree.parent;
 }

package/src/tree/plain.js

@@ -10,6 +10,6 @@ import getTreeArgument from "../common/getTreeArgument.js";
  * @param {Treelike} [treelike]
  */
 export default async function plain(treelike) {
-  const tree = await getTreeArgument(this, arguments, treelike, "tree:plain");
+  const tree = await getTreeArgument(this, arguments, treelike, "plain");
   return Tree.plain(tree);
 }

package/src/tree/reverse.js

@@ -11,7 +11,7 @@ import getTreeArgument from "../common/getTreeArgument.js";
  * @param {Treelike} [treelike]
  */
 export default async function reverseBuiltin(treelike) {
-  const tree = await getTreeArgument(this, arguments, treelike, "tree:reverse");
+  const tree = await getTreeArgument(this, arguments, treelike, "reverse");
   const reversed = reverse(tree);
   return reversed;
 }

package/src/tree/shuffle.js

@@ -23,7 +23,7 @@ export default async function shuffleTree(treelike, reshuffle = false) {
     return array;
   }
 
-  const tree = await getTreeArgument(this, arguments, treelike, "tree:shuffle");
+  const tree = await getTreeArgument(this, arguments, treelike, "shuffle");
 
   let keys;
   return {

package/src/tree/sort.js

@@ -23,7 +23,7 @@ import { toFunction } from "../common/utilities.js";
  * @param {SortOptions|ValueKeyFn} [options]
  */
 export default async function sortBuiltin(treelike, options) {
-  const tree = await getTreeArgument(this, arguments, treelike, "tree:sort");
+  const tree = await getTreeArgument(this, arguments, treelike, "sort");
 
   if (typeof options === "function") {
     // Take the function as the `sortKey` option

package/src/tree/take.js

@@ -12,7 +12,7 @@ import getTreeArgument from "../common/getTreeArgument.js";
  * @param {number} count
  */
 export default async function take(treelike, count) {
-  const tree = await getTreeArgument(this, arguments, treelike, "tree:take");
+  const tree = await getTreeArgument(this, arguments, treelike, "take");
   const taken = await takeTransform(tree, count);
   taken.parent = this;
   return taken;

package/src/tree/values.js

@@ -10,6 +10,6 @@ import getTreeArgument from "../common/getTreeArgument.js";
  * @param {Treelike} [treelike]
  */
 export default async function values(treelike) {
-  const tree = await getTreeArgument(this, arguments, treelike, "tree:values");
+  const tree = await getTreeArgument(this, arguments, treelike, "values");
   return Tree.values(tree);
 }

package/src/builtinsJse.js

@@ -1,77 +0,0 @@
-import { text as treeText } 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 image from "./image/image.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";
-import scope from "./protocols/scope.js";
-import * as site from "./site/site.js";
-import * as text from "./text/text.js";
-import * as tree from "./tree/tree.js";
-
-let builtins;
-
-export default function builtinsJse() {
-  if (!builtins) {
-    const Tree = {
-      ...tree,
-      indent: text.indent,
-      json: origami.json,
-      text: treeText,
-    };
-
-    const Origami = {
-      image,
-      ...origami,
-      ...site,
-      static: site.staticBuiltin,
-      ...text,
-    };
-
-    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,
-      "scope:": scope,
-
-      Dev: dev,
-      Tree,
-      Origami,
-      Protocol,
-
-      // Handlers need to be exposed at top level
-      ...handlerBuiltins(),
-    };
-  }
-
-  return builtins;
-}

package/src/handlers/jse.handler.js

@@ -1,17 +0,0 @@
-import builtinsJse from "../builtinsJse.js";
-import getParent from "./getParent.js";
-import { oriHandler } from "./handlers.js";
-
-export default {
-  ...oriHandler,
-
-  async unpack(packed, options = {}) {
-    const parent = getParent(packed, options);
-    return oriHandler.unpack(packed, {
-      ...options,
-      globals: builtinsJse(),
-      mode: "jse",
-      parent,
-    });
-  },
-};

package/src/handlers/jsedocument.handler.js

@@ -1,17 +0,0 @@
-import builtinsJse from "../builtinsJse.js";
-import getParent from "./getParent.js";
-import { oridocumentHandler } from "./handlers.js";
-
-export default {
-  ...oridocumentHandler,
-
-  async unpack(packed, options = {}) {
-    const parent = getParent(packed, options);
-    return oridocumentHandler.unpack(packed, {
-      ...options,
-      globals: builtinsJse(),
-      mode: "jse",
-      parent,
-    });
-  },
-};