@skillcdn/console 0.4.1 → 0.4.3

package/dist/plugin/limits.js

@@ -0,0 +1,70 @@
+// How much a plugin may ask of a console (docs/specs/plugins.md, "Limits and refusals"): the
+// bounds the manifest's schema, the definers, the host and the pages hold a plugin to. One source,
+// so that `console-plugin check` says before an administrator finds out.
+/** A plugin's name in one language, its description, and the sentence agents read with the rules. */
+export const MAX_PLUGIN_NAME_LENGTH = 40;
+export const MAX_PLUGIN_DESCRIPTION_LENGTH = 200;
+export const MAX_PLUGIN_AGENT_NOTE_LENGTH = 200;
+/** A plugin's key, a role's, a page's, a widget's, a setting's, a collection's, a command's: `^[a-z][a-z0-9-]{1,31}$`. */
+export const MAX_PLUGIN_KEY_LENGTH = 32;
+/** How many roles, settings, pages and widgets one manifest declares. */
+export const MAX_PLUGIN_ROLES = 10;
+export const MAX_PLUGIN_SETTINGS = 50;
+export const MAX_PLUGIN_PAGES = 12;
+export const MAX_PLUGIN_WIDGETS = 4;
+/** How many collections, commands and queries together, endpoints, and indexes of one collection a server module defines. */
+export const MAX_PLUGIN_COLLECTIONS = 50;
+export const MAX_PLUGIN_OPERATIONS = 100;
+export const MAX_PLUGIN_ENDPOINTS = 20;
+export const MAX_PLUGIN_INDEXES = 8;
+/** One line about a command, a query, a job or an argument, as help prints it. */
+export const MAX_PLUGIN_ABOUT_LENGTH = 200;
+/** The options of an `enum` setting or argument. */
+export const MAX_PLUGIN_OPTIONS = 50;
+/** A record, how many a plugin keeps, and how many versions one record keeps. */
+export const MAX_PLUGIN_RECORD_BYTES = 64 * 1024;
+export const MAX_PLUGIN_RECORDS = 100_000;
+export const MAX_PLUGIN_RECORD_VERSIONS = 100;
+/** A message between the host and the parent, a query's answer, an endpoint's answer. */
+export const MAX_PLUGIN_MESSAGE_BYTES = 4 * 1024 * 1024;
+/** What an endpoint takes in. */
+export const MAX_PLUGIN_ENDPOINT_BODY_BYTES = 1024 * 1024;
+/** The words of one command line sent to `invoke`, and the characters of one word. */
+export const MAX_PLUGIN_ARGV_WORDS = 200;
+export const MAX_PLUGIN_ARGV_WORD_LENGTH = 50_000;
+/** The files one command takes at once. */
+export const MAX_PLUGIN_COMMAND_FILES = 20;
+/** An event of the plugin's own, how many are kept, and for how long. */
+export const MAX_PLUGIN_EVENT_BYTES = 16 * 1024;
+export const PLUGIN_EVENTS_KEPT = 100_000;
+export const PLUGIN_EVENT_DAYS = 90;
+/** How many records one page of a list carries at most. */
+export const PLUGIN_LIST_LIMIT = 200;
+/** How long plugin code may run: a command; a query or an endpoint; a hook; a job; `onEnable`, `onDisable` and an upgrade. */
+export const PLUGIN_COMMAND_MS = 30_000;
+export const PLUGIN_QUERY_MS = 10_000;
+export const PLUGIN_ENDPOINT_MS = 10_000;
+export const PLUGIN_HOOK_MS = 30_000;
+export const PLUGIN_JOB_MS = 5 * 60_000;
+export const PLUGIN_LIFECYCLE_MS = 10 * 60_000;
+/** A job runs no more often than this. */
+export const MIN_PLUGIN_JOB_INTERVAL_MS = 5 * 60_000;
+/** Outbound requests a minute per plugin, the bytes of an answer, and its time. */
+export const PLUGIN_OUTBOUND_PER_MINUTE = 60;
+export const MAX_PLUGIN_OUTBOUND_BYTES = 10 * 1024 * 1024;
+export const PLUGIN_OUTBOUND_MS = 10_000;
+/** Webhook requests a minute per plugin. */
+export const PLUGIN_WEBHOOKS_PER_MINUTE = 600;
+/** Lines `ctx.log` writes a minute. */
+export const PLUGIN_LOG_LINES_PER_MINUTE = 100;
+/** SQL, with `storage:sql`: a statement's time, a result's rows, the connections of the plugin's role. */
+export const PLUGIN_SQL_STATEMENT_MS = 10_000;
+export const MAX_PLUGIN_SQL_ROWS = 10_000;
+export const PLUGIN_SQL_CONNECTIONS = 4;
+/** The memory a plugin's thread may hold, in megabytes, where the deployment says nothing. */
+export const DEFAULT_PLUGIN_MEMORY_MB = 256;
+/** How tall a widget's frame may grow, in pixels. */
+export const MAX_PLUGIN_WIDGET_HEIGHT = 480;
+/** How many retries a hook gets before its event is skipped with a `plugin.failed` event. */
+export const PLUGIN_HOOK_RETRIES = 5;
+//# sourceMappingURL=limits.js.map

package/dist/plugin/limits.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"limits.js","sourceRoot":"","sources":["../../src/plugin/limits.ts"],"names":[],"mappings":"AAAA,6FAA6F;AAC7F,mGAAmG;AACnG,yEAAyE;AAEzE,qGAAqG;AACrG,MAAM,CAAC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AACzC,MAAM,CAAC,MAAM,6BAA6B,GAAG,GAAG,CAAC;AACjD,MAAM,CAAC,MAAM,4BAA4B,GAAG,GAAG,CAAC;AAChD,0HAA0H;AAC1H,MAAM,CAAC,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACxC,yEAAyE;AACzE,MAAM,CAAC,MAAM,gBAAgB,GAAG,EAAE,CAAC;AACnC,MAAM,CAAC,MAAM,mBAAmB,GAAG,EAAE,CAAC;AACtC,MAAM,CAAC,MAAM,gBAAgB,GAAG,EAAE,CAAC;AACnC,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC;AACpC,6HAA6H;AAC7H,MAAM,CAAC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AACzC,MAAM,CAAC,MAAM,qBAAqB,GAAG,GAAG,CAAC;AACzC,MAAM,CAAC,MAAM,oBAAoB,GAAG,EAAE,CAAC;AACvC,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC;AACpC,kFAAkF;AAClF,MAAM,CAAC,MAAM,uBAAuB,GAAG,GAAG,CAAC;AAC3C,oDAAoD;AACpD,MAAM,CAAC,MAAM,kBAAkB,GAAG,EAAE,CAAC;AACrC,iFAAiF;AACjF,MAAM,CAAC,MAAM,uBAAuB,GAAG,EAAE,GAAG,IAAI,CAAC;AACjD,MAAM,CAAC,MAAM,kBAAkB,GAAG,OAAO,CAAC;AAC1C,MAAM,CAAC,MAAM,0BAA0B,GAAG,GAAG,CAAC;AAC9C,yFAAyF;AACzF,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC;AACxD,iCAAiC;AACjC,MAAM,CAAC,MAAM,8BAA8B,GAAG,IAAI,GAAG,IAAI,CAAC;AAC1D,sFAAsF;AACtF,MAAM,CAAC,MAAM,qBAAqB,GAAG,GAAG,CAAC;AACzC,MAAM,CAAC,MAAM,2BAA2B,GAAG,MAAM,CAAC;AAClD,2CAA2C;AAC3C,MAAM,CAAC,MAAM,wBAAwB,GAAG,EAAE,CAAC;AAC3C,yEAAyE;AACzE,MAAM,CAAC,MAAM,sBAAsB,GAAG,EAAE,GAAG,IAAI,CAAC;AAChD,MAAM,CAAC,MAAM,kBAAkB,GAAG,OAAO,CAAC;AAC1C,MAAM,CAAC,MAAM,iBAAiB,GAAG,EAAE,CAAC;AACpC,2DAA2D;AAC3D,MAAM,CAAC,MAAM,iBAAiB,GAAG,GAAG,CAAC;AACrC,8HAA8H;AAC9H,MAAM,CAAC,MAAM,iBAAiB,GAAG,MAAM,CAAC;AACxC,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC;AACtC,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC;AACzC,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAC;AACrC,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,GAAG,MAAM,CAAC;AACxC,MAAM,CAAC,MAAM,mBAAmB,GAAG,EAAE,GAAG,MAAM,CAAC;AAC/C,0CAA0C;AAC1C,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,GAAG,MAAM,CAAC;AACrD,mFAAmF;AACnF,MAAM,CAAC,MAAM,0BAA0B,GAAG,EAAE,CAAC;AAC7C,MAAM,CAAC,MAAM,yBAAyB,GAAG,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC;AAC1D,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC;AACzC,4CAA4C;AAC5C,MAAM,CAAC,MAAM,0BAA0B,GAAG,GAAG,CAAC;AAC9C,uCAAuC;AACvC,MAAM,CAAC,MAAM,2BAA2B,GAAG,GAAG,CAAC;AAC/C,0GAA0G;AAC1G,MAAM,CAAC,MAAM,uBAAuB,GAAG,MAAM,CAAC;AAC9C,MAAM,CAAC,MAAM,mBAAmB,GAAG,MAAM,CAAC;AAC1C,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC;AACxC,8FAA8F;AAC9F,MAAM,CAAC,MAAM,wBAAwB,GAAG,GAAG,CAAC;AAC5C,qDAAqD;AACrD,MAAM,CAAC,MAAM,wBAAwB,GAAG,GAAG,CAAC;AAC5C,6FAA6F;AAC7F,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC"}

package/dist/plugin/load-worker.d.ts

@@ -0,0 +1,7 @@
+export interface LoadOutcome {
+    readonly ok: boolean;
+    readonly description?: unknown;
+    readonly error?: string;
+    readonly problems?: readonly string[];
+}
+//# sourceMappingURL=load-worker.d.ts.map

package/dist/plugin/load-worker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"load-worker.d.ts","sourceRoot":"","sources":["../../src/plugin/load-worker.ts"],"names":[],"mappings":"AAYA,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;IAC/B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACvC"}

package/dist/plugin/load-worker.js

@@ -0,0 +1,41 @@
+// The thread a server module is loaded in to be described (docs/specs/plugins.md, "The host" and
+// "Authoring"): hardened first, then the module imported and its default export described as
+// JSON for the parent. `console-plugin check` runs this; the host loads plugins the same way and
+// then keeps the thread. Nothing of the console is reachable from here: no database, no
+// configuration, an empty environment.
+import * as moduleApi from "node:module";
+import { pathToFileURL } from "node:url";
+import { parentPort, workerData } from "node:worker_threads";
+import { describePlugin, isPluginDefinition } from "./define.js";
+import { PluginDefinitionError } from "./definition-error.js";
+import { hardenThread } from "./sandbox.js";
+function errorText(error) {
+    if (error instanceof PluginDefinitionError) {
+        return { error: "the definition is invalid", problems: error.problems };
+    }
+    if (error instanceof Error) {
+        const code = error.code;
+        return { error: typeof code === "string" ? `${code}: ${error.message}` : error.message };
+    }
+    return { error: String(error) };
+}
+const { file } = workerData;
+let outcome;
+try {
+    if (typeof moduleApi.registerHooks !== "function") {
+        throw new Error("the host needs Node.js 24 or newer, which has module hooks that run in a thread");
+    }
+    hardenThread(moduleApi);
+    const loaded = (await import(pathToFileURL(file).href));
+    if (!isPluginDefinition(loaded.default)) {
+        outcome = { ok: false, error: "the default export is not what definePlugin({...}) yields" };
+    }
+    else {
+        outcome = { ok: true, description: describePlugin(loaded.default) };
+    }
+}
+catch (error) {
+    outcome = { ok: false, ...errorText(error) };
+}
+parentPort?.postMessage(outcome);
+//# sourceMappingURL=load-worker.js.map

package/dist/plugin/load-worker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"load-worker.js","sourceRoot":"","sources":["../../src/plugin/load-worker.ts"],"names":[],"mappings":"AAAA,iGAAiG;AACjG,6FAA6F;AAC7F,iGAAiG;AACjG,wFAAwF;AACxF,uCAAuC;AACvC,OAAO,KAAK,SAAS,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAS5C,SAAS,SAAS,CAAC,KAAc;IAC/B,IAAI,KAAK,YAAY,qBAAqB,EAAE,CAAC;QAC3C,OAAO,EAAE,KAAK,EAAE,2BAA2B,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC;IAC1E,CAAC;IACD,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,MAAM,IAAI,GAAI,KAA4B,CAAC,IAAI,CAAC;QAChD,OAAO,EAAE,KAAK,EAAE,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;IAC3F,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;AAClC,CAAC;AAED,MAAM,EAAE,IAAI,EAAE,GAAG,UAA8B,CAAC;AAEhD,IAAI,OAAoB,CAAC;AACzB,IAAI,CAAC;IACH,IAAI,OAAO,SAAS,CAAC,aAAa,KAAK,UAAU,EAAE,CAAC;QAClD,MAAM,IAAI,KAAK,CACb,iFAAiF,CAClF,CAAC;IACJ,CAAC;IACD,YAAY,CAAC,SAAS,CAAC,CAAC;IACxB,MAAM,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAA0B,CAAC;IACjF,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;QACxC,OAAO,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,2DAA2D,EAAE,CAAC;IAC9F,CAAC;SAAM,CAAC;QACN,OAAO,GAAG,EAAE,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,cAAc,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;IACtE,CAAC;AACH,CAAC;AAAC,OAAO,KAAK,EAAE,CAAC;IACf,OAAO,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;AAC/C,CAAC;AACD,UAAU,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC"}

package/dist/plugin/load.d.ts

@@ -0,0 +1,18 @@
+import type { PluginDescription } from "./define.js";
+export type ServerLoad = {
+    readonly ok: true;
+    readonly description: PluginDescription;
+} | {
+    readonly ok: false;
+    readonly error: string;
+    readonly problems: readonly string[];
+};
+export interface LoadOptions {
+    /** How long the module gets to load; ten seconds unless said. */
+    readonly timeoutMs?: number;
+    /** The memory the thread may hold, in megabytes. */
+    readonly memoryMb?: number;
+}
+/** The description of the server module at `file`, loaded in a thread of its own under the host's hardening. */
+export declare function loadServerModule(file: string, options?: LoadOptions): Promise<ServerLoad>;
+//# sourceMappingURL=load.d.ts.map

package/dist/plugin/load.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"load.d.ts","sourceRoot":"","sources":["../../src/plugin/load.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAGrD,MAAM,MAAM,UAAU,GAClB;IAAE,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC;IAAC,QAAQ,CAAC,WAAW,EAAE,iBAAiB,CAAA;CAAE,GAC9D;IAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAA;CAAE,CAAC;AAEzF,MAAM,WAAW,WAAW;IAC1B,iEAAiE;IACjE,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,oDAAoD;IACpD,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B;AAID,gHAAgH;AAChH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,UAAU,CAAC,CA4D7F"}

package/dist/plugin/load.js

@@ -0,0 +1,62 @@
+// Loads a plugin's server module in a hardened worker thread and answers its description, or why
+// it did not load. What `console-plugin check` does to a package; the host does the same before
+// keeping the thread. Node only.
+import { Worker } from "node:worker_threads";
+import { DEFAULT_PLUGIN_MEMORY_MB } from "./limits.js";
+const DEFAULT_LOAD_MS = 10_000;
+/** The description of the server module at `file`, loaded in a thread of its own under the host's hardening. */
+export function loadServerModule(file, options = {}) {
+    const timeoutMs = options.timeoutMs ?? DEFAULT_LOAD_MS;
+    return new Promise((resolve) => {
+        let settled = false;
+        const settle = (load) => {
+            if (!settled) {
+                settled = true;
+                clearTimeout(timer);
+                resolve(load);
+            }
+        };
+        const worker = new Worker(new URL("./load-worker.js", import.meta.url), {
+            workerData: { file },
+            env: {},
+            resourceLimits: { maxOldGenerationSizeMb: options.memoryMb ?? DEFAULT_PLUGIN_MEMORY_MB },
+            stdout: true,
+            stderr: true,
+        });
+        // What the module prints while loading goes nowhere: the check speaks for itself.
+        worker.stdout.resume();
+        worker.stderr.resume();
+        const timer = setTimeout(() => {
+            settle({
+                ok: false,
+                error: `the server module did not load within ${timeoutMs} ms`,
+                problems: [],
+            });
+            void worker.terminate();
+        }, timeoutMs);
+        worker.on("message", (outcome) => {
+            if (outcome.ok && outcome.description !== undefined) {
+                settle({ ok: true, description: outcome.description });
+            }
+            else {
+                settle({
+                    ok: false,
+                    error: outcome.error ?? "the server module did not load",
+                    problems: outcome.problems ?? [],
+                });
+            }
+            void worker.terminate();
+        });
+        worker.on("error", (error) => {
+            settle({ ok: false, error: error.message, problems: [] });
+        });
+        worker.on("exit", (code) => {
+            settle({
+                ok: false,
+                error: `the server module's thread ended with ${code} before describing it`,
+                problems: [],
+            });
+        });
+    });
+}
+//# sourceMappingURL=load.js.map

package/dist/plugin/load.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"load.js","sourceRoot":"","sources":["../../src/plugin/load.ts"],"names":[],"mappings":"AAAA,iGAAiG;AACjG,gGAAgG;AAChG,iCAAiC;AACjC,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAE7C,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AAavD,MAAM,eAAe,GAAG,MAAM,CAAC;AAE/B,gHAAgH;AAChH,MAAM,UAAU,gBAAgB,CAAC,IAAY,EAAE,OAAO,GAAgB,EAAE;IACtE,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,eAAe,CAAC;IACvD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,MAAM,MAAM,GAAG,CAAC,IAAgB,EAAE,EAAE;YAClC,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,OAAO,GAAG,IAAI,CAAC;gBACf,YAAY,CAAC,KAAK,CAAC,CAAC;gBACpB,OAAO,CAAC,IAAI,CAAC,CAAC;YAChB,CAAC;QACH,CAAC,CAAC;QACF,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,GAAG,CAAC,kBAAkB,EAAE,OAAO,IAAI,CAAC,GAAG,CAAC,EAAE;YACtE,UAAU,EAAE,EAAE,IAAI,EAAE;YACpB,GAAG,EAAE,EAAE;YACP,cAAc,EAAE,EAAE,sBAAsB,EAAE,OAAO,CAAC,QAAQ,IAAI,wBAAwB,EAAE;YACxF,MAAM,EAAE,IAAI;YACZ,MAAM,EAAE,IAAI;SACb,CAAC,CAAC;QACH,kFAAkF;QAClF,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACvB,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACvB,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;YAC5B,MAAM,CAAC;gBACL,EAAE,EAAE,KAAK;gBACT,KAAK,EAAE,yCAAyC,SAAS,KAAK;gBAC9D,QAAQ,EAAE,EAAE;aACb,CAAC,CAAC;YACH,KAAK,MAAM,CAAC,SAAS,EAAE,CAAC;QAC1B,CAAC,EAAE,SAAS,CAAC,CAAC;QACd,MAAM,CAAC,EAAE,CACP,SAAS,EACT,CAAC,OAKA,EAAE,EAAE;YACH,IAAI,OAAO,CAAC,EAAE,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;gBACpD,MAAM,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;YACzD,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC;oBACL,EAAE,EAAE,KAAK;oBACT,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,gCAAgC;oBACxD,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,EAAE;iBACjC,CAAC,CAAC;YACL,CAAC;YACD,KAAK,MAAM,CAAC,SAAS,EAAE,CAAC;QAC1B,CAAC,CACF,CAAC;QACF,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAC3B,MAAM,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC;QAC5D,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;YACzB,MAAM,CAAC;gBACL,EAAE,EAAE,KAAK;gBACT,KAAK,EAAE,yCAAyC,IAAI,uBAAuB;gBAC3E,QAAQ,EAAE,EAAE;aACb,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/plugin/manifest.d.ts

@@ -0,0 +1,237 @@
+import * as z from "zod/mini";
+/** A plugin's key, and every key within a plugin: a role's, a page's, a widget's, a setting's, a collection's, a command's. */
+export declare const PLUGIN_KEY_PATTERN: RegExp;
+export declare function isPluginKey(value: string): boolean;
+/** The majors of the plugin API this package speaks, and the one a new plugin is written against. */
+export declare const PLUGIN_API_MAJORS: readonly [1];
+export declare const CURRENT_PLUGIN_API = 1;
+/**
+ * Words no plugin's key may be: the console's own paths and the command's own words, so that
+ * `/plugins/<key>` and `console plugin <key>` never read as something else.
+ */
+export declare const RESERVED_PLUGIN_KEYS: readonly string[];
+/** Words a page's key may not be: the routes beside the pages under a plugin's path. */
+export declare const RESERVED_PAGE_KEYS: readonly string[];
+/** Words an argument may not be named: the flags `console plugin <key> <command>` keeps for itself. */
+export declare const RESERVED_ARG_NAMES: readonly string[];
+/** Words a command's or a query's name may not be: the subcommands of `console plugin <key>`. */
+export declare const RESERVED_COMMAND_NAMES: readonly string[];
+/** The groups of tabs the console knows; a plugin may declare another, with a name. */
+export declare const PLUGIN_MENU_GROUPS: readonly ["people", "customers", "money", "operations", "marketing", "engineering", "reports"];
+export type PluginMenuGroup = (typeof PLUGIN_MENU_GROUPS)[number];
+export declare const PLUGIN_SETTING_TYPES: readonly ["text", "markdown", "number", "boolean", "enum", "day", "person", "project", "secret", "list"];
+export type PluginSettingType = (typeof PLUGIN_SETTING_TYPES)[number];
+export declare const PLUGIN_PAGE_LEVELS: readonly ["workspace", "project"];
+export type PluginPageLevel = (typeof PLUGIN_PAGE_LEVELS)[number];
+export declare const PLUGIN_WIDGET_PLACES: readonly ["home:top", "home:bottom"];
+export type PluginWidgetPlace = (typeof PLUGIN_WIDGET_PLACES)[number];
+export declare const PLUGIN_WIDGET_SIZES: readonly ["third", "half", "full"];
+export type PluginWidgetSize = (typeof PLUGIN_WIDGET_SIZES)[number];
+export declare const PLUGIN_BOARD_NEEDS: readonly ["required", "optional", "none"];
+export type PluginBoardNeeds = (typeof PLUGIN_BOARD_NEEDS)[number];
+/** A text per language, `en` always among them. */
+export type Localized = Readonly<Record<string, string>>;
+/** A setting's key, as code and `--set` name it: a lowercase letter, then letters and digits. */
+export declare const SETTING_KEY_PATTERN: RegExp;
+declare const pluginSettingSchema: z.ZodMiniObject<{
+    key: z.ZodMiniString<string>;
+    type: z.ZodMiniEnum<{
+        boolean: "boolean";
+        day: "day";
+        enum: "enum";
+        list: "list";
+        markdown: "markdown";
+        number: "number";
+        person: "person";
+        project: "project";
+        secret: "secret";
+        text: "text";
+    }>;
+    name: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
+    description: z.ZodMiniOptional<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>>;
+    required: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
+    default: z.ZodMiniOptional<z.ZodMiniUnknown>;
+    min: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+    max: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+    options: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniObject<{
+        value: z.ZodMiniString<string>;
+        name: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
+    }, z.core.$strict>>>;
+    of: z.ZodMiniOptional<z.ZodMiniEnum<{
+        boolean: "boolean";
+        day: "day";
+        enum: "enum";
+        markdown: "markdown";
+        number: "number";
+        person: "person";
+        project: "project";
+        text: "text";
+    }>>;
+}, z.core.$strict>;
+export type PluginSetting = z.infer<typeof pluginSettingSchema>;
+declare const pluginPageSchema: z.ZodMiniObject<{
+    key: z.ZodMiniString<string>;
+    name: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
+    level: z.ZodMiniEnum<{
+        project: "project";
+        workspace: "workspace";
+    }>;
+    roles: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
+    wide: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
+}, z.core.$strict>;
+export type PluginPage = z.infer<typeof pluginPageSchema>;
+declare const pluginWidgetSchema: z.ZodMiniObject<{
+    key: z.ZodMiniString<string>;
+    name: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
+    place: z.ZodMiniEnum<{
+        "home:bottom": "home:bottom";
+        "home:top": "home:top";
+    }>;
+    size: z.ZodMiniEnum<{
+        full: "full";
+        half: "half";
+        third: "third";
+    }>;
+    roles: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
+}, z.core.$strict>;
+export type PluginWidget = z.infer<typeof pluginWidgetSchema>;
+declare const pluginMenuSchema: z.ZodMiniObject<{
+    group: z.ZodMiniString<string>;
+    order: z.ZodMiniOptional<z.ZodMiniInt>;
+    name: z.ZodMiniOptional<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>>;
+}, z.core.$strict>;
+export type PluginMenu = z.infer<typeof pluginMenuSchema>;
+declare const pluginBoardSchema: z.ZodMiniObject<{
+    needs: z.ZodMiniEnum<{
+        none: "none";
+        optional: "optional";
+        required: "required";
+    }>;
+    defaults: z.ZodMiniOptional<z.ZodMiniObject<{
+        key: z.ZodMiniString<string>;
+        name: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
+        description: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type PluginBoard = z.infer<typeof pluginBoardSchema>;
+declare const pluginRoleSchema: z.ZodMiniObject<{
+    name: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
+    description: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
+}, z.core.$strict>;
+export type PluginRole = z.infer<typeof pluginRoleSchema>;
+/** The manifest as a plugin writes it; `parsePluginManifest` fills what it leaves out. */
+export declare const pluginManifestSchema: z.ZodMiniObject<{
+    key: z.ZodMiniString<string>;
+    name: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
+    description: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
+    agentNote: z.ZodMiniOptional<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>>;
+    pluginApi: z.ZodMiniInt;
+    server: z.ZodMiniString<string>;
+    web: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    skills: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    migrations: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    capabilities: z.ZodMiniDefault<z.ZodMiniArray<z.ZodMiniString<string>>>;
+    roles: z.ZodMiniDefault<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniObject<{
+        name: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
+        description: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
+    }, z.core.$strict>>>;
+    defaultRole: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    requires: z.ZodMiniDefault<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>>;
+    board: z.ZodMiniDefault<z.ZodMiniObject<{
+        needs: z.ZodMiniEnum<{
+            none: "none";
+            optional: "optional";
+            required: "required";
+        }>;
+        defaults: z.ZodMiniOptional<z.ZodMiniObject<{
+            key: z.ZodMiniString<string>;
+            name: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
+            description: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+    settings: z.ZodMiniDefault<z.ZodMiniArray<z.ZodMiniObject<{
+        key: z.ZodMiniString<string>;
+        type: z.ZodMiniEnum<{
+            boolean: "boolean";
+            day: "day";
+            enum: "enum";
+            list: "list";
+            markdown: "markdown";
+            number: "number";
+            person: "person";
+            project: "project";
+            secret: "secret";
+            text: "text";
+        }>;
+        name: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
+        description: z.ZodMiniOptional<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>>;
+        required: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
+        default: z.ZodMiniOptional<z.ZodMiniUnknown>;
+        min: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+        max: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+        options: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniObject<{
+            value: z.ZodMiniString<string>;
+            name: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
+        }, z.core.$strict>>>;
+        of: z.ZodMiniOptional<z.ZodMiniEnum<{
+            boolean: "boolean";
+            day: "day";
+            enum: "enum";
+            markdown: "markdown";
+            number: "number";
+            person: "person";
+            project: "project";
+            text: "text";
+        }>>;
+    }, z.core.$strict>>>;
+    menu: z.ZodMiniOptional<z.ZodMiniObject<{
+        group: z.ZodMiniString<string>;
+        order: z.ZodMiniOptional<z.ZodMiniInt>;
+        name: z.ZodMiniOptional<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>>;
+    }, z.core.$strict>>;
+    pages: z.ZodMiniDefault<z.ZodMiniArray<z.ZodMiniObject<{
+        key: z.ZodMiniString<string>;
+        name: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
+        level: z.ZodMiniEnum<{
+            project: "project";
+            workspace: "workspace";
+        }>;
+        roles: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
+        wide: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
+    }, z.core.$strict>>>;
+    widgets: z.ZodMiniDefault<z.ZodMiniArray<z.ZodMiniObject<{
+        key: z.ZodMiniString<string>;
+        name: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
+        place: z.ZodMiniEnum<{
+            "home:bottom": "home:bottom";
+            "home:top": "home:top";
+        }>;
+        size: z.ZodMiniEnum<{
+            full: "full";
+            half: "half";
+            third: "third";
+        }>;
+        roles: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
+    }, z.core.$strict>>>;
+    dataVersion: z.ZodMiniDefault<z.ZodMiniInt>;
+    store: z.ZodMiniOptional<z.ZodMiniObject<{
+        homepage: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        repository: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        keywords: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
+        icon: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type PluginManifest = z.infer<typeof pluginManifestSchema>;
+export type ManifestParse = {
+    readonly ok: true;
+    readonly manifest: PluginManifest;
+} | {
+    readonly ok: false;
+    readonly problems: readonly string[];
+};
+/** The manifest from what `console-plugin.json` held, filled in, or every problem with it in words. */
+export declare function parsePluginManifest(value: unknown): ManifestParse;
+/** The text in the person's language, else in English, else the first there is. */
+export declare function localizedText(texts: Localized, language: string): string;
+export {};
+//# sourceMappingURL=manifest.d.ts.map

package/dist/plugin/manifest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"manifest.d.ts","sourceRoot":"","sources":["../../src/plugin/manifest.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;AAmB9B,+HAA+H;AAC/H,eAAO,MAAM,kBAAkB,QAA2B,CAAC;AAE3D,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAElD;AAED,qGAAqG;AACrG,eAAO,MAAM,iBAAiB,YAAI,CAAC,CAAU,CAAC;AAC9C,eAAO,MAAM,kBAAkB,IAAI,CAAC;AAEpC;;;GAGG;AACH,eAAO,MAAM,oBAAoB,EAAE,SAAS,MAAM,EAmDjD,CAAC;AAEF,wFAAwF;AACxF,eAAO,MAAM,kBAAkB,EAAE,SAAS,MAAM,EAA0B,CAAC;AAE3E,uGAAuG;AACvG,eAAO,MAAM,kBAAkB,EAAE,SAAS,MAAM,EAO/C,CAAC;AAEF,iGAAiG;AACjG,eAAO,MAAM,sBAAsB,EAAE,SAAS,MAAM,EAWnD,CAAC;AAEF,uFAAuF;AACvF,eAAO,MAAM,kBAAkB,YAC7B,QAAQ,EACR,WAAW,EACX,OAAO,EACP,YAAY,EACZ,WAAW,EACX,aAAa,EACb,SAAS,CACD,CAAC;AAEX,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC;AAElE,eAAO,MAAM,oBAAoB,YAC/B,MAAM,EACN,UAAU,EACV,QAAQ,EACR,SAAS,EACT,MAAM,EACN,KAAK,EACL,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,MAAM,CACE,CAAC;AAEX,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEtE,eAAO,MAAM,kBAAkB,YAAI,WAAW,EAAE,SAAS,CAAU,CAAC;AACpE,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC;AAElE,eAAO,MAAM,oBAAoB,YAAI,UAAU,EAAE,aAAa,CAAU,CAAC;AACzE,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEtE,eAAO,MAAM,mBAAmB,YAAI,OAAO,EAAE,MAAM,EAAE,MAAM,CAAU,CAAC;AACtE,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEpE,eAAO,MAAM,kBAAkB,YAAI,UAAU,EAAE,UAAU,EAAE,MAAM,CAAU,CAAC;AAC5E,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC;AAgCnE,mDAAmD;AACnD,MAAM,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAkBzD,iGAAiG;AACjG,eAAO,MAAM,mBAAmB,QAA6B,CAAC;AAW9D,QAAA,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAqBtB,CAAC;AAEJ,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAmFhE,QAAA,MAAM,gBAAgB;;;;;;;;;kBAQpB,CAAC;AAEH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAE1D,QAAA,MAAM,kBAAkB;;;;;;;;;;;;;kBAMtB,CAAC;AAEH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE9D,QAAA,MAAM,gBAAgB;;;;kBAYnB,CAAC;AAEJ,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAE1D,QAAA,MAAM,iBAAiB;;;;;;;;;;;kBAqBpB,CAAC;AAEJ,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D,QAAA,MAAM,gBAAgB;;;kBAGpB,CAAC;AAEH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAS1D,0FAA0F;AAC1F,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAqC9B,CAAC;AAEJ,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AA0FlE,MAAM,MAAM,aAAa,GACrB;IAAE,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC;IAAC,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAA;CAAE,GACxD;IAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAA;CAAE,CAAC;AAEjE,uGAAuG;AACvG,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,OAAO,GAAG,aAAa,CAajE;AAED,mFAAmF;AACnF,wBAAgB,aAAa,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAQxE"}