@weborigami/origami 0.0.73 → 0.2.0

package/src/builtins/@paginateFn.js

@@ -1,58 +0,0 @@
-import { Tree } from "@weborigami/async-tree";
-
-/**
- * Return a new grouping of the treelike's values into "pages" of the specified
- * size.
- *
- * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
- * @typedef {import("@weborigami/async-tree").Treelike} Treelike
- *
- * @this {AsyncTree|null}
- * @param {number} [size=10]
- */
-export default function paginateFn(size = 10) {
-  const parent = this;
-
-  /**
-   * @param {Treelike} [treelike]
-   */
-  return async function (treelike) {
-    const tree = Tree.from(treelike, { parent });
-    const keys = Array.from(await tree.keys());
-    const pageCount = Math.ceil(keys.length / size);
-
-    return {
-      async get(pageKey) {
-        // Note: page numbers are 1-based.
-        const pageNumber = Number(pageKey);
-        if (Number.isNaN(pageNumber)) {
-          return undefined;
-        }
-        const nextPage = pageNumber + 1 <= pageCount ? pageNumber + 1 : null;
-        const previousPage = pageNumber - 1 >= 1 ? pageNumber - 1 : null;
-        const items = {};
-        for (
-          let index = (pageNumber - 1) * size;
-          index < Math.min(keys.length, pageNumber * size);
-          index++
-        ) {
-          const key = keys[index];
-          items[key] = await tree.get(keys[index]);
-        }
-
-        return {
-          items,
-          nextPage,
-          pageCount,
-          pageNumber,
-          previousPage,
-        };
-      },
-
-      async keys() {
-        // Return an array from 1..totalPages
-        return Array.from({ length: pageCount }, (_, index) => index + 1);
-      },
-    };
-  };
-}

package/src/builtins/@repeat.js

@@ -1,8 +0,0 @@
-export default async function repeat(count, content) {
-  const array = new Array(count);
-  array.fill(content);
-  return array;
-}
-
-repeat.usage = `@repeat <count>, <content>\tRepeats the content the given number of times`;
-repeat.documentation = "https://weborigami.org/language/@repeat.html";

package/src/builtins/@sort.js

@@ -1,23 +0,0 @@
-import getTreeArgument from "../misc/getTreeArgument.js";
-import sortFn from "./@sortFn.js";
-
-/**
- * Return a new tree with the original's keys sorted.
- *
- * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
- * @typedef {import("@weborigami/async-tree").Treelike} Treelike
- * @typedef {import("@weborigami/async-tree").ValueKeyFn} ValueKeyFn
- * @typedef {{ compare?: (a: any, b: any) => number, sortKey?: ValueKeyFn }}
- * SortOptions
- *
- * @this {AsyncTree|null}
- * @param {Treelike} [treelike]
- * @param {ValueKeyFn|SortOptions} [options]
- */
-export default async function sortBuiltin(treelike, options) {
-  const tree = await getTreeArgument(this, arguments, treelike, "@sort");
-  return sortFn.call(this, options)(tree);
-}
-
-sortBuiltin.usage = `@sort <tree>, [options]\tReturn a new tree with the original's keys sorted`;
-sortBuiltin.documentation = "https://weborigami.org/builtins/@sort.html";

package/src/builtins/@table.js

@@ -1,69 +0,0 @@
-import { Tree } from "@weborigami/async-tree";
-import getTreeArgument from "../misc/getTreeArgument.js";
-
-/**
- * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
- * @typedef {import("@weborigami/async-tree").Treelike} Treelike
- * @this {AsyncTree|null}
- * @param {Treelike} treelike
- */
-export default async function table(treelike) {
-  const tree = await getTreeArgument(this, arguments, treelike, "@table");
-  const firstValue = await valueForFirstKey(tree);
-  if (Tree.isAsyncTree(firstValue)) {
-    return fullTable(tree, firstValue);
-  } else {
-    return simpleTable(tree);
-  }
-}
-
-// Tree's values are subtrees.
-//
-// Return an R x C table, where R is the number of top-level keys in the tree
-// (plus a header row), and C is the number of 2nd-level keys (plus a labeling
-// column).
-//
-// The 2nd-level keys are obtain by inspecting the given model object, which is
-// taken to represent top-level objects in the tree.
-async function fullTable(tree, model) {
-  // Construct the header.
-  const modelKeys = Array.from(await model.keys());
-  const header = " \t" + modelKeys.join("\t");
-  const rows = [header];
-
-  // Add a row for each top-level object.
-  for (const key of await tree.keys()) {
-    let row = key;
-    const value = await tree.get(key);
-    for (const modelKey of await model.keys()) {
-      const value2 = await value.get(modelKey);
-      row += `\t${value2}`;
-    }
-    rows.push(row);
-  }
-
-  return rows.join("\n");
-}
-
-// Tree's values are not subtrees.
-// Return the (key, value) pairs as a simple two-column table.
-async function simpleTable(tree) {
-  const header = `Key\tValue`;
-  const rows = [header];
-  for (const key of await tree.keys()) {
-    const value = await tree.get(key);
-    rows.push(`${key}\t${value}`);
-  }
-  const text = rows.join("\n");
-  return text;
-}
-
-// Return the value for the tree's first key.
-async function valueForFirstKey(tree) {
-  const [value] = await tree.keys();
-  return value;
-}
-
-table.usage =
-  "@table <tree>\tFormat the tree's top level as a tab-delimited table";
-table.documentation = "https://weborigami.org/cli/builtins.html#table";

package/src/builtins/@take.js

@@ -1,20 +0,0 @@
-import getTreeArgument from "../misc/getTreeArgument.js";
-import takeFn from "./@takeFn.js";
-
-/**
- * Given a tree, take the first n items from it.
- *
- * @typedef  {import("@weborigami/types").AsyncTree} AsyncTree
- * @typedef {import("@weborigami/async-tree").Treelike} Treelike
- *
- * @this {AsyncTree|null}
- * @param {Treelike} treelike
- * @param {number} n
- */
-export default async function take(treelike, n) {
-  const tree = await getTreeArgument(this, arguments, treelike, "@take");
-  return takeFn.call(this, n)(tree);
-}
-
-take.usage = `@take tree, n\tReturn the first n items from tree`;
-take.documentation = "https://weborigami.org/cli/builtins.html#take";

package/src/builtins/@takeFn.js

@@ -1,20 +0,0 @@
-import { takeFn } from "@weborigami/async-tree";
-import assertTreeIsDefined from "../misc/assertTreeIsDefined.js";
-
-/**
- * Limit the number of keys to the indicated count.
- *
- * @typedef  {import("@weborigami/types").AsyncTree} AsyncTree
- *
- * @this {AsyncTree|null}
- * @param {number} count
- */
-export default function takeFnBuiltin(count) {
-  assertTreeIsDefined(this, "takeFn");
-  const parent = this;
-  return (treelike) => {
-    const taken = takeFn(count)(treelike);
-    taken.parent = parent;
-    return taken;
-  };
-}

package/src/builtins/@tree.js

@@ -1,4 +0,0 @@
-/**
- * Tree utilities functions
- */
-export { Tree as default } from "@weborigami/async-tree";

package/src/builtins/@treeHttp.js

@@ -1,19 +0,0 @@
-import { ops } from "@weborigami/language";
-import assertTreeIsDefined from "../misc/assertTreeIsDefined.js";
-
-/**
- * @typedef  {import("@weborigami/types").AsyncTree} AsyncTree
- * @typedef {import("@weborigami/async-tree").Treelike} Treelike
- * @typedef {import("../../index.ts").Invocable} Invocable
- *
- * @this {AsyncTree|null}
- * @param {string} host
- * @param  {...string} keys
- */
-export default function treeHttp(host, ...keys) {
-  assertTreeIsDefined(this, "treeHttp");
-  return ops.treeHttp.call(this, host, ...keys);
-}
-
-treeHttp.usage = `@treeHttp <domain>, <...keys>\tA web site tree via HTTP`;
-treeHttp.documentation = "https://weborigami.org/language/@treeHttp.html";

package/src/builtins/@treeHttps.js

@@ -1,19 +0,0 @@
-import { ops } from "@weborigami/language";
-import assertTreeIsDefined from "../misc/assertTreeIsDefined.js";
-
-/**
- * @typedef  {import("@weborigami/types").AsyncTree} AsyncTree
- * @typedef {import("@weborigami/async-tree").Treelike} Treelike
- * @typedef {import("../../index.ts").Invocable} Invocable
- *
- * @this {AsyncTree|null}
- * @param {string} host
- * @param  {...string} keys
- */
-export default function treeHttps(host, ...keys) {
-  assertTreeIsDefined(this, "treeHttps");
-  return ops.treeHttps.call(this, host, ...keys);
-}
-
-treeHttps.usage = `@treeHttps <domain>, <...keys>\tA web site tree via HTTPS`;
-treeHttps.documentation = "https://weborigami.org/language/@treeHttps.html";

package/src/builtins/@true.js

@@ -1 +0,0 @@
-export default true;

package/src/builtins/mjs.handler.js

@@ -1,2 +0,0 @@
-// .mjs is a synonynm for .js
-export { default } from "./js.handler.js";

package/src/builtins/yml.handler.js

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

package/src/builtins/~.js

@@ -1,9 +0,0 @@
-import { OrigamiFiles } from "@weborigami/language";
-import os from "node:os";
-import builtins from "./@builtins.js";
-
-/** @type {import("@weborigami/types").AsyncTree} */
-const tree = new OrigamiFiles(os.homedir());
-tree.parent = builtins;
-
-export default tree;

package/src/cli/showUsage.js

@@ -1,86 +0,0 @@
-const groupDescriptions = {
-  "@cache": "Functions for caching data",
-  "@tree": "Functions for working with trees",
-  "@image": "Functions for working with images",
-  "@parse": "Parsing functions",
-  "@scope": "Functions for working with tree scopes",
-};
-
-export default async function showUsage(scope) {
-  console.log(`Usage: ori <expression>, which could be:
-- a string in single quotes, or a number
-- a file or folder name
-- an https: or http: URL
-- a name like "foo" that refers to an object/function exported by a project file foo.js
-- the name of a function below:
-`);
-
-  // Gather usages.
-  const usages = [];
-  for (const key of await scope.keys()) {
-    let command;
-    // We get the command associated with the key in a try/catch because
-    // we want to ignore any syntax errors.
-    try {
-      command = await scope.get(key);
-    } catch (error) {
-      if (error instanceof SyntaxError) {
-        continue;
-      }
-    }
-    if (groupDescriptions[key]) {
-      usages.push(`${key}\t${groupDescriptions[key]}`);
-    } else if (typeof command === "function") {
-      let usage = command?.usage;
-      if (!usage) {
-        usage = defaultUsage(key, command);
-      }
-      usages.push(usage);
-    }
-  }
-
-  // Case-insensitive sort
-  usages.sort(function (a, b) {
-    return a.toLowerCase().localeCompare(b.toLowerCase());
-  });
-
-  // Split into signatures and descriptions.
-  const signatures = [];
-  const descriptions = [];
-  usages.forEach((usage) => {
-    const [signature, description] = usage.split("\t");
-    signatures.push(signature);
-    descriptions.push(description || "");
-  });
-
-  // Calculate length of longest signature.
-  const lengths = signatures.map((signature) => signature.length);
-  const maxLength = Math.max(...lengths);
-
-  // Format lines, padding the descriptions to that length + gap.
-  const gap = 4;
-  const length = maxLength + gap;
-  const formatted = signatures.map(
-    (signature, index) => `${signature.padEnd(length)}${descriptions[index]}`
-  );
-
-  console.log(formatted.join("\n"));
-  console.log(
-    `\nMore details: "ori @help"; or get help on a function like @serve with "ori @help/@serve"`
-  );
-}
-
-function defaultUsage(name, fn) {
-  const arity = fn.length;
-  if (arity === 0) {
-    return `${name}()`;
-  } else if (arity === 1) {
-    return `${name}(arg)`;
-  } else {
-    let args = [];
-    for (let i = 0; i < arity; i++) {
-      args.push(`arg${i + 1}`);
-    }
-    return `${name}(${args.join(", ")})`;
-  }
-}

package/src/common/CommandModulesTransform.d.ts

@@ -1,5 +0,0 @@
-import { Mixin } from "@weborigami/language";
-
-declare const CommandModulesTransform: Mixin<{}>;
-
-export default CommandModulesTransform;

package/src/common/CommandModulesTransform.js

@@ -1,39 +0,0 @@
-import { trailingSlash } from "@weborigami/async-tree";
-import path from "node:path";
-
-/**
- * This mixin can be used to turn a collection of .js modules in a folder into a collection
- * of commands. For every module `foo.js`, the tree will expose a key `foo` with the value
- * of the module's export(s).
- *
- * @typedef {import("@weborigami/types").AsyncTree} AsyncTree
- * @typedef {import("../../index.ts").Constructor<AsyncTree & { import: function }>} BaseConstructor
- * @param {BaseConstructor} Base
- */
-export default function CommandsModulesTransform(Base) {
-  return class CommandModules extends Base {
-    async get(key) {
-      const value = await super.get(key);
-      if (value !== undefined) {
-        return value;
-      }
-
-      // See if we have a JS module for the requested key.
-      key = trailingSlash.remove(key);
-      if (key === undefined || key.endsWith?.(".js")) {
-        return undefined;
-      }
-
-      const moduleKey = `${key}.js`;
-      return this.import?.(moduleKey);
-    }
-
-    async keys() {
-      const keys = Array.from(await super.keys());
-      // If we find a key like "foo.js", then return "foo" as the key.
-      return keys.map((key) =>
-        key.endsWith(".js") ? path.basename(key, ".js") : key
-      );
-    }
-  };
-}

package/src/common/arrowsMapFn.js

@@ -1,35 +0,0 @@
-import { cachedKeyFunctions, mapFn } from "@weborigami/async-tree";
-import { toFunction } from "./utilities.js";
-
-export default function arrowsMapFn() {
-  const deep = true;
-  return mapFn({
-    deep,
-    description: "arrowFunctions",
-    value: valueFn,
-    ...cachedKeyFunctions(keyFn, deep),
-  });
-}
-
-function keyFn(sourceKey, tree) {
-  return parseArrowKey(sourceKey) ?? sourceKey;
-}
-
-// If the key is of the form "lhs←rhs", return "lhs".
-// Whitespace between the lhs and the arrow is ignored.
-function parseArrowKey(sourceKey) {
-  const regex = /^(?<lhs>.+?)\s*←.+$/;
-  const match = sourceKey.match(regex);
-  return match?.groups.lhs;
-}
-
-function valueFn(sourceValue, sourceKey, tree) {
-  let resultValue;
-  if (parseArrowKey(sourceKey)) {
-    // Treat the value as a function to be invoked.
-    resultValue = toFunction(sourceValue);
-  } else {
-    resultValue = sourceValue;
-  }
-  return resultValue;
-}

package/src/misc/origamiHighlightDefinition.js

@@ -1,36 +0,0 @@
-/**
- * Origami language definition for highlight.js
- */
-export default function origamiHighlightDefinition(hljs) {
-  return {
-    name: "Origami",
-    contains: [
-      hljs.C_LINE_COMMENT_MODE,
-      hljs.C_BLOCK_COMMENT_MODE,
-      hljs.C_NUMBER_MODE,
-      hljs.APOS_STRING_MODE,
-      hljs.QUOTE_STRING_MODE,
-      hljs.BACKSLASH_ESCAPE,
-      {
-        // Backtick template strings
-        className: "string",
-        begin: "`",
-        end: "`",
-        contains: [
-          hljs.BACKSLASH_ESCAPE,
-          {
-            className: "subst",
-            begin: "\\$\\{",
-            end: "\\}",
-            contains: [hljs.C_NUMBER_MODE, hljs.QUOTE_STRING_MODE],
-          },
-        ],
-      },
-      {
-        // Treat all `@` builtins as keywords.
-        className: "keyword",
-        begin: /@\w+\b/,
-      },
-    ],
-  };
-}