@weborigami/origami 0.3.4-jse.7 → 0.3.4-jse.8

package/src/protocols/httptree.js

@@ -14,6 +14,6 @@ import constructSiteTree from "../common/constructSiteTree.js";
  * @param  {...string} keys
  */
 export default function httptree(host, ...keys) {
-  assertTreeIsDefined(this, "httptree:");
+  assertTreeIsDefined(this, "httptree");
   return constructSiteTree("http:", SiteTree, this, host, ...keys);
 }

package/src/protocols/inherited.js

@@ -1,4 +1,5 @@
 import { scope, Tree } from "@weborigami/async-tree";
+import { attachWarning } from "@weborigami/language";
 import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
 
 /**
@@ -10,12 +11,16 @@ import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
  * @param {string[]} keys
  */
 export default async function inherited(...keys) {
-  assertTreeIsDefined(this, "inherited:");
+  assertTreeIsDefined(this, "inherited");
   const key = keys.shift();
   if (!this?.parent) {
     return undefined;
   }
   const parentScope = scope(this.parent);
   const value = await parentScope.get(key);
-  return keys.length > 0 ? await Tree.traverse(value, ...keys) : value;
+  const result = keys.length > 0 ? await Tree.traverse(value, ...keys) : value;
+  return attachWarning(
+    result,
+    "The inherited protocol is deprecated. In most cases it can be dropped."
+  );
 }

package/src/protocols/js.js

@@ -0,0 +1,10 @@
+import { Tree } from "@weborigami/async-tree";
+import { attachWarning, jsGlobals } from "@weborigami/language";
+
+export default async function js(...keys) {
+  const result = await Tree.traverseOrThrow.call(this, jsGlobals, ...keys);
+  return attachWarning(
+    result,
+    "The js:<name> protocol is deprecated. Drop the js: and just use <name> instead."
+  );
+}

package/src/protocols/new.js

@@ -1,4 +1,5 @@
 import { isUnpackable, scope as scopeFn, Tree } from "@weborigami/async-tree";
+import { attachWarning } from "@weborigami/language";
 import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
 
 /**
@@ -11,7 +12,7 @@ import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
  * @param  {...any} keys
  */
 export default async function instantiate(...keys) {
-  assertTreeIsDefined(this, "new:");
+  assertTreeIsDefined(this, "new");
   let constructor;
 
   const scope = this ? scopeFn(this) : null;
@@ -33,7 +34,7 @@ export default async function instantiate(...keys) {
   }
   // Origami may pass `undefined` as the first argument to the constructor. We
   // don't pass that along, because constructors like `Date` don't like it.
-  return (...args) => {
+  const result = (...args) => {
     const object =
       args.length === 1 && args[0] === undefined
         ? new constructor()
@@ -43,4 +44,8 @@ export default async function instantiate(...keys) {
     }
     return object;
   };
+  return attachWarning(
+    result,
+    "The new:Class() syntax is deprecated. Use `new Class()` instead."
+  );
 }

package/src/protocols/scope.js

@@ -1,4 +1,5 @@
 import { Tree, scope as scopeFn } from "@weborigami/async-tree";
+import { attachWarning } from "@weborigami/language";
 
 /**
  * @typedef  {import("@weborigami/types").AsyncTree} AsyncTree
@@ -20,5 +21,9 @@ export default async function scope(...keys) {
       throw error;
     }
   }
-  return keys.length > 0 ? await Tree.traverse(value, ...keys) : value;
+  const result = keys.length > 0 ? await Tree.traverse(value, ...keys) : value;
+  return attachWarning(
+    result,
+    "The scope protocol is deprecated. In most cases it can be dropped."
+  );
 }

package/src/site/rss.js

@@ -10,7 +10,7 @@ import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
  * @param {any} options
  */
 export default async function rss(jsonFeedTree, options = {}) {
-  assertTreeIsDefined(this, "site:rss");
+  assertTreeIsDefined(this, "rss");
   const jsonFeed = await Tree.plain(jsonFeedTree);
   return jsonFeedToRss(jsonFeed, options);
 }

package/src/site/sitemap.js

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

package/src/text/document.js

@@ -10,6 +10,6 @@ import documentObject from "../common/documentObject.js";
  * @param {any} [data]
  */
 export default async function documentBuiltin(text, data) {
-  assertTreeIsDefined(this, "text:document");
+  assertTreeIsDefined(this, "document");
   return documentObject(text, data);
 }

package/src/text/inline.js

@@ -14,7 +14,7 @@ import { jsedocumentHandler } from "../handlers/handlers.js";
  * @param {StringLike} input
  */
 export default async function inline(input) {
-  assertTreeIsDefined(this, "text:inline");
+  assertTreeIsDefined(this, "inline");
 
   // Get the input text and any attached front matter.
   if (isUnpackable(input)) {

package/src/text/mdHtml.js

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

package/src/tree/cache.js

@@ -12,7 +12,7 @@ import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
  * @this {AsyncTree|null}
  */
 export default async function cacheBuiltin(sourceTreelike, cacheTreelike) {
-  assertTreeIsDefined(this, "tree:cache");
+  assertTreeIsDefined(this, "cache");
   /** @type {any} */
   const cacheTree = cacheTreelike
     ? Tree.from(cacheTreelike, { parent: this })

package/src/tree/concat.js

@@ -11,7 +11,7 @@ import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
  * @param {any[]} args
  */
 export default async function concat(...args) {
-  assertTreeIsDefined(this, "tree:concat");
+  assertTreeIsDefined(this, "concat");
   const tree = args.length === 0 ? this : Tree.from(args, { parent: this });
   return ops.concat.call(this, tree);
 }

package/src/tree/deepMerge.js

@@ -10,7 +10,7 @@ import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
  * @param {Treelike[]} trees
  */
 export default async function treeDeepMerge(...trees) {
-  assertTreeIsDefined(this, "tree:deepMerge");
+  assertTreeIsDefined(this, "deepMerge");
   // Merge the trees.
   const result = deepMerge(...trees);
   result.parent = this;

package/src/tree/filter.js

@@ -12,7 +12,7 @@ import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
  * @param {Treelike} filterTreelike
  */
 export default async function filterBuiltin(sourceTreelike, filterTreelike) {
-  assertTreeIsDefined(this, "tree:filter");
+  assertTreeIsDefined(this, "filter");
   const result = filter(sourceTreelike, filterTreelike);
   result.parent = this;
   return result;

package/src/tree/fromFn.js

@@ -13,7 +13,7 @@ import { toFunction } from "../common/utilities.js";
  * @param {Invocable} [invocable]
  */
 export default async function fromFn(invocable, keys = []) {
-  assertTreeIsDefined(this, "tree:fromFn");
+  assertTreeIsDefined(this, "fromFn");
   if (invocable === undefined) {
     throw new Error(
       "An Origami function was called with an initial argument, but its value is undefined."

package/src/tree/globKeys.js

@@ -12,7 +12,7 @@ import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
  * @this {AsyncTree|null}
  */
 export default async function globKeysBuiltin(tree) {
-  assertTreeIsDefined(this, "tree:globs");
+  assertTreeIsDefined(this, "globs");
   const result = globKeys(tree);
   setParent(this, result);
   return result;

package/src/tree/mask.js

@@ -12,7 +12,7 @@ import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
  * @param {Treelike} maskTreelike
  */
 export default async function maskBuiltin(sourceTreelike, maskTreelike) {
-  assertTreeIsDefined(this, "tree:mask");
+  assertTreeIsDefined(this, "mask");
   const result = mask(sourceTreelike, maskTreelike);
   result.parent = this;
   return result;

package/src/tree/match.js

@@ -24,7 +24,7 @@ import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
  * @param {Treelike} [keys]
  */
 export default function match(pattern, resultFn, keys = []) {
-  assertTreeIsDefined(this, "tree:match");
+  assertTreeIsDefined(this, "match");
   let regex;
   if (typeof pattern === "string") {
     // Convert the simple pattern format into a regular expression.

package/src/tree/merge.js

@@ -11,7 +11,7 @@ import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
  * @param {(Treelike|null)[]} trees
  */
 export default async function treeMerge(...trees) {
-  assertTreeIsDefined(this, "tree:merge");
+  assertTreeIsDefined(this, "merge");
 
   // Filter out null or undefined trees.
   /** @type {Treelike[]}

package/src/tree/regExpKeys.js

@@ -12,7 +12,7 @@ import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
  * @this {AsyncTree|null}
  */
 export default async function regExpKeysBuiltin(tree) {
-  assertTreeIsDefined(this, "tree:globs");
+  assertTreeIsDefined(this, "regExpKeys");
   const result = regExpKeys(tree);
   setParent(this, result);
   return result;

package/src/tree/tree.js

@@ -5,7 +5,6 @@ export { default as calendar } from "./calendar.js";
 export { default as clear } from "./clear.js";
 export { default as concat } from "./concat.js";
 export { default as constant } from "./constant.js";
-export { default as copy } from "./copy.js";
 export { default as deepMap } from "./deepMap.js";
 export { default as deepMerge } from "./deepMerge.js";
 export { default as deepReverse } from "./deepReverse.js";

package/src/BuiltinsTree.js

@@ -1,18 +0,0 @@
-import { trailingSlash } from "@weborigami/async-tree";
-
-// We create our own tree instead of using ObjectTree, since that binds the
-// functions would be bound to the object. We want to leave them unbound.
-export default class BuiltinsTree {
-  constructor(object) {
-    this.object = object;
-  }
-
-  async get(key) {
-    const normalizedKey = trailingSlash.remove(key);
-    return this.object[normalizedKey];
-  }
-
-  async keys() {
-    return Object.keys(this.object);
-  }
-}