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

package/main.js

@@ -3,10 +3,13 @@ export { toString } from "./src/common/utilities.js";
 export * from "./src/dev/dev.js";
 export { default as handlerBuiltins } from "./src/handlers/handlerBuiltins.js";
 export * from "./src/handlers/handlers.js";
-export * from "./src/image/image.js";
+export * as image from "./src/image/image.js";
 export * from "./src/origami/origami.js";
 export { default as packageBuiltin } from "./src/protocols/package.js";
 export * from "./src/server/server.js";
 export * from "./src/site/site.js";
+export { default as origamiHighlightDefinition } from "./src/text/origamiHighlightDefinition.js";
 export * from "./src/text/text.js";
+
+// TODO: Remove once these all moves to async-tree
 export * from "./src/tree/tree.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@weborigami/origami",
-  "version": "0.3.4-jse.7",
+  "version": "0.3.4-jse.8",
   "description": "Web Origami language, CLI, framework, and server",
   "type": "module",
   "repository": {
@@ -17,10 +17,10 @@
     "typescript": "5.8.2"
   },
   "dependencies": {
-    "@weborigami/async-tree": "0.3.4-jse.7",
+    "@weborigami/async-tree": "0.3.4-jse.8",
     "@weborigami/json-feed-to-rss": "1.0.0",
-    "@weborigami/language": "0.3.4-jse.7",
-    "@weborigami/types": "0.3.4-jse.7",
+    "@weborigami/language": "0.3.4-jse.8",
+    "@weborigami/types": "0.3.4-jse.8",
     "css-tree": "3.1.0",
     "exif-parser": "0.1.12",
     "graphviz-wasm": "3.0.2",

package/src/builtinsJse.js

@@ -1,8 +1,8 @@
 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 help from "./help/help.js";
 import * as image from "./image/image.js";
 import * as origami from "./origami/origami.js";
 import explore from "./protocols/explore.js";
@@ -11,7 +11,6 @@ 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 inherited from "./protocols/inherited.js";
 import node from "./protocols/node.js";
 import packageNamespace from "./protocols/package.js";
 import scope from "./protocols/scope.js";
@@ -31,14 +30,24 @@ export default function builtinsJse() {
     };
 
     const Origami = {
-      ...dev,
-      files,
       image,
       ...origami,
       ...site,
+      static: site.staticBuiltin,
       ...text,
     };
 
+    const Protocol = {
+      explore,
+      files,
+      http,
+      https,
+      httpstree,
+      httptree,
+      node,
+      package: packageNamespace,
+    };
+
     /** @type {any} */
     builtins = {
       ...jsGlobals,
@@ -50,13 +59,14 @@ export default function builtinsJse() {
       "https:": https,
       "httpstree:": httpstree,
       "httptree:": httptree,
-      "inherited:": inherited,
       "node:": node,
       "package:": packageNamespace,
       "scope:": scope,
 
+      Dev: dev,
       Tree,
       Origami,
+      Protocol,
 
       // Handlers need to be exposed at top level
       ...handlerBuiltins(),

package/src/builtinsProgram.js

@@ -0,0 +1,81 @@
+import { Tree } from "@weborigami/async-tree";
+import { attachWarning } from "@weborigami/language";
+import builtinsJse from "./builtinsJse.js";
+import * as dev from "./dev/dev.js";
+import * as image from "./image/image.js";
+import * as origami from "./origami/origami.js";
+import inherited from "./protocols/inherited.js";
+import js from "./protocols/js.js";
+import instantiate from "./protocols/new.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 builtinsProgram() {
+  if (!builtins) {
+    builtins = {
+      // All JSE builtins
+      ...builtinsJse(),
+
+      // // Old protocols to be deprecated
+      "dev:": deprecateFunctions(dev, "dev:", "Dev."),
+      "image:": deprecateFunctions(image, "image:", "Origami.image."),
+      "inherited:": inherited,
+      "js:": js,
+      "new:": instantiate,
+      "origami:": deprecateFunctions(origami, "origami:", "Origami."),
+      "scope:": scope,
+      "site:": deprecateFunctions(
+        adjustReservedWords(site),
+        "site:",
+        "Origami."
+      ),
+      "text:": deprecateFunctions(text, "text:", "Origami."),
+      "tree:": deprecateFunctions(tree, "tree:", "Tree."),
+
+      // // For backward compat, include all methods at the top level
+      ...deprecateFunctions(dev, "", "Dev."),
+      ...deprecateFunctions(image, "", "Origami.image."),
+      ...deprecateFunctions(origami, "", "Origami."),
+      ...deprecateFunctions(adjustReservedWords(site), "site:", "Origami."),
+      ...deprecateFunctions(text, "", "Origami."),
+      ...deprecateFunctions(tree, "", "Tree."),
+    };
+  }
+
+  return builtins;
+}
+
+function deprecateFunctions(fns, oldPrefix, newPrefix) {
+  const wrappedEntries = Object.entries(fns).map(([key, value]) => {
+    const wrappedFn = async function (...args) {
+      const oldKey = key === "indent" ? key : `${oldPrefix}${key}()`;
+      const newKey =
+        key === "indent" ? `${newPrefix}${key}` : `${newPrefix}${key}()`;
+      const result =
+        value instanceof Function
+          ? await value.apply(this, args)
+          : await Tree.traverseOrThrow.call(this, value, ...args);
+      return attachWarning(
+        result,
+        `${oldKey} is deprecated, use ${newKey} instead.`
+      );
+    };
+    Object.assign(wrappedFn, value);
+    return [key, wrappedFn];
+  });
+  return Object.fromEntries(wrappedEntries);
+}
+
+// Handle cases where a builtin name conflicts with a JS reserved word
+function adjustReservedWords(obj) {
+  const result = {};
+  for (const [key, value] of Object.entries(obj)) {
+    const name = value.key ?? key;
+    result[name] = value;
+  }
+  return result;
+}

package/src/builtinsShell.js

@@ -1,10 +1,16 @@
-import { jsGlobals } from "@weborigami/language";
+import { text as treeText } from "@weborigami/async-tree";
 import builtinsJse from "./builtinsJse.js";
 import * as dev from "./dev/dev.js";
 import * as image from "./image/image.js";
 import * as origami from "./origami/origami.js";
-import instantiate from "./protocols/new.js";
-import scope from "./protocols/scope.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 * as site from "./site/site.js";
 import * as text from "./text/text.js";
 import * as tree from "./tree/tree.js";
@@ -13,40 +19,45 @@ let builtins;
 
 export default function builtinsShell() {
   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,
+    };
+
     builtins = {
       // All JSE builtins
       ...builtinsJse(),
 
-      // Old protocols to be deprecated
-      "dev:": dev,
-      "image:": image,
-      "js:": jsGlobals,
-      "new:": instantiate,
-      "origami:": origami,
-      "scope:": scope,
-      "site:": adjustReservedWords(site),
-      "text:": text,
-      "tree:": tree,
-
-      // For backward compat, include all methods at the top level
+      // Dev builtins exposed at the top level in shell
       ...dev,
-      ...image,
-      ...origami,
-      ...adjustReservedWords(site),
-      ...text,
-      ...tree,
+
+      Dev: dev,
+      Origami,
+      Protocol,
+      Tree,
     };
   }
 
   return builtins;
 }
-
-// Handle cases where a builtin name conflicts with a JS reserved word
-function adjustReservedWords(obj) {
-  const result = {};
-  for (const [key, value] of Object.entries(obj)) {
-    const name = value.key ?? key;
-    result[name] = value;
-  }
-  return result;
-}

package/src/cli/cli.js

@@ -4,7 +4,7 @@ import { Tree } from "@weborigami/async-tree";
 import { formatError } from "@weborigami/language";
 import path from "node:path";
 import process, { stdout } from "node:process";
-import help from "../help/help.js";
+import help from "../dev/help.js";
 import ori from "../origami/ori.js";
 import project from "../origami/project.js";
 

package/src/common/documentObject.js

@@ -1,4 +1,5 @@
 import { isPlainObject, isUnpackable, toString } from "@weborigami/async-tree";
+import { attachWarning } from "@weborigami/language";
 
 /**
  * In Origami, a text document object is any object with a `@text` property and
@@ -21,7 +22,7 @@ export default async function documentObject(input, data) {
   }
 
   if (isPlainObject(input)) {
-    text = input["@text"] ?? input._body;
+    text = input._body ?? input["@text"];
     inputData = input;
   } else {
     text = toString(input);
@@ -37,11 +38,21 @@ export default async function documentObject(input, data) {
   // const result = Object.create(base);
   const result = {};
   // TODO: Deprecate @text
-  Object.assign(result, inputData, data, { "@text": text });
+  Object.assign(result, inputData, data);
+  Object.defineProperty(result, "@text", {
+    configurable: true,
+    enumerable: true,
+    get() {
+      return attachWarning(
+        text,
+        "The @text property is deprecated. Use _body instead."
+      );
+    },
+  });
   Object.defineProperty(result, "_body", {
     configurable: true,
+    enumerable: true,
     value: text,
-    enumerable: false, // TODO: Make enumerable
     writable: true,
   });
   return result;

package/src/common/utilities.js

@@ -95,7 +95,7 @@ export function toFunction(obj) {
  */
 export function toString(object) {
   if (isPlainObject(object) && ("@text" in object || "_body" in object)) {
-    object = object["@text"] ?? object._body;
+    object = object._body ?? object["@text"];
   }
   return asyncTreeToString(object);
 }

package/src/{tree → dev}/copy.js

@@ -3,7 +3,7 @@ import { formatError } from "@weborigami/language";
 import process, { stdout } from "node:process";
 import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
 import { transformObject } from "../common/utilities.js";
-import setDeep from "./setDeep.js";
+import setDeep from "../tree/setDeep.js";
 
 /**
  * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
@@ -14,7 +14,7 @@ import setDeep from "./setDeep.js";
  * @param {Treelike} target
  */
 export default async function copy(source, target) {
-  assertTreeIsDefined(this, "tree:copy");
+  assertTreeIsDefined(this, "copy");
   const sourceTree = Tree.from(source, { parent: this });
   /** @type {any} */ let targetTree = Tree.from(target, { parent: this });
 

package/src/dev/dev.js

@@ -1,11 +1,17 @@
+export { default as clear } from "../tree/clear.js";
+export { default as keys } from "../tree/keys.js";
 export { default as breakpoint } from "./breakpoint.js";
 export { default as changes } from "./changes.js";
 export { default as code } from "./code.js";
+export { default as copy } from "./copy.js";
 export { default as audit } from "./crawler/audit.js";
 export { default as crawl } from "./crawler/crawl.js";
 export { default as debug } from "./debug.js";
 export { default as explore } from "./explore.js";
+export { default as help } from "./help.js";
 export { default as log } from "./log.js";
 export { default as serve } from "./serve.js";
+export { default as stdin } from "./stdin.js";
 export { default as svg } from "./svg.js";
+export { default as version } from "./version.js";
 export { default as watch } from "./watch.js";

package/src/dev/explore.js

@@ -5,7 +5,7 @@ import path from "node:path";
 import { fileURLToPath } from "node:url";
 import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
 import { getDescriptor } from "../common/utilities.js";
-import oriHandler from "../handlers/ori.handler.js";
+import { oriHandler } from "../handlers/handlers.js";
 import debug from "./debug.js";
 
 let templatePromise;
@@ -14,7 +14,7 @@ let templatePromise;
  * @this {AsyncTree|null}
  */
 export default async function explore(...keys) {
-  assertTreeIsDefined(this, "origami:explore");
+  assertTreeIsDefined(this, "explore");
   if (!this) {
     return undefined;
   }

package/src/{help → dev}/help.js

@@ -3,7 +3,7 @@ import path from "node:path";
 import { fileURLToPath } from "url";
 import YAML from "yaml";
 import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
-import version from "../origami/version.js";
+import version from "./version.js";
 
 /**
  * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
@@ -12,7 +12,7 @@ import version from "../origami/version.js";
  * @param {string} [key]
  */
 export default async function help(key) {
-  assertTreeIsDefined(this, "help:");
+  assertTreeIsDefined(this, "help");
 
   const helpFilename = path.resolve(
     fileURLToPath(import.meta.url),
@@ -57,7 +57,7 @@ async function commandDescription(commandHelp, namespace, command) {
 
 function formatCommandDescription(commandHelp, namespace, command) {
   const { args, description } = commandHelp;
-  return `  ${namespace}:${command}${args ?? ""} - ${description}`;
+  return `  ${namespace}.${command}${args ?? ""} - ${description}`;
 }
 
 async function namespaceCommands(namespaceHelp, namespace) {
@@ -71,7 +71,7 @@ async function namespaceCommands(namespaceHelp, namespace) {
       const description = namespaceHelp.description;
       const lowercase = description[0].toLowerCase() + description.slice(1);
       text.push(
-        `The "${namespace}" namespace contains commands to ${lowercase}.`
+        `The ${namespace} namespace contains commands to ${lowercase}.`
       );
     }
     text.push("");
@@ -97,7 +97,7 @@ async function namespaceDescriptions(helpData) {
     }
   }
   text.push(
-    `\nType "ori help:<namespace>" for more or visit https://weborigami.org/builtins\n`
+    `\nType "ori help/<namespace>" for more or visit https://weborigami.org/builtins\n`
   );
   return text.join("\n");
 }