@skillcdn/console 0.4.1 → 0.4.3

package/dist/plugin/rest-schemas.js

@@ -0,0 +1,262 @@
+// The REST shapes of the plugins' routes (docs/specs/plugins.md, "REST"): what the console
+// answers about its plugins and what an administrator sends to enable, configure and grant. In
+// the mini build of zod, as every REST schema is, and part of the snapshot the contract is held
+// to (ADR-0043). What a plugin's own command or query carries is the plugin's, and not here.
+import * as z from "zod/mini";
+import { MAX_PROJECT_DESCRIPTION_LENGTH, MAX_PROJECT_KEY_LENGTH, MAX_PROJECT_NAME_LENGTH, } from "../limits.js";
+import { PLUGIN_STATES } from "../vocabulary.js";
+import { ARG_TYPES } from "./args.js";
+import { MAX_PLUGIN_ARGV_WORD_LENGTH, MAX_PLUGIN_ARGV_WORDS, MAX_PLUGIN_COMMAND_FILES, } from "./limits.js";
+import { PLUGIN_BOARD_NEEDS, PLUGIN_KEY_PATTERN, PLUGIN_PAGE_LEVELS, PLUGIN_SETTING_TYPES, PLUGIN_WIDGET_PLACES, PLUGIN_WIDGET_SIZES, SETTING_KEY_PATTERN, } from "./manifest.js";
+/** How long a secret an administrator sets for a plugin may be. */
+export const MAX_PLUGIN_SECRET_LENGTH = 4096;
+/** How many grants one plugin holds. */
+export const MAX_PLUGIN_GRANTS = 1000;
+const uuid = z.uuid();
+const instant = z.iso.datetime();
+const pluginKey = z.string().check(z.regex(PLUGIN_KEY_PATTERN));
+const settingKey = z.string().check(z.regex(SETTING_KEY_PATTERN));
+const projectKey = z.string().check(z.minLength(1), z.maxLength(MAX_PROJECT_KEY_LENGTH));
+/** A text per language, as the manifest has it. */
+const localized = z.record(z.string(), z.string());
+/** An argument of a command or a query, as the console describes it for help and forms. */
+export const restPluginArgSchema = z.object({
+    type: z.enum(ARG_TYPES),
+    about: z.optional(z.string()),
+    optional: z.boolean(),
+    positional: z.boolean(),
+    secret: z.optional(z.boolean()),
+    max: z.optional(z.number()),
+    min: z.optional(z.number()),
+    integer: z.optional(z.boolean()),
+    options: z.optional(z.array(z.string())),
+    collection: z.optional(z.string()),
+    get of() {
+        return z.optional(restPluginArgSchema);
+    },
+});
+/** A command or a query of a plugin, as `GET /api/v1/plugins/<key>` lists them. */
+export const restPluginOperationSchema = z.object({
+    name: z.string(),
+    kind: z.enum(["command", "query"]),
+    about: z.string(),
+    args: z.record(z.string(), restPluginArgSchema),
+    /** The roles that may run it, or `null` for every member. */
+    roles: z.nullable(z.array(z.string())),
+});
+export const restPluginPageSchema = z.object({
+    key: z.string(),
+    name: localized,
+    level: z.enum(PLUGIN_PAGE_LEVELS),
+    wide: z.boolean(),
+});
+export const restPluginWidgetSchema = z.object({
+    key: z.string(),
+    name: localized,
+    place: z.enum(PLUGIN_WIDGET_PLACES),
+    size: z.enum(PLUGIN_WIDGET_SIZES),
+});
+/** A plugin as a member may know of it: what it is, how it stands, and what the member may do with it. */
+export const restPluginSchema = z.object({
+    key: z.string(),
+    name: localized,
+    description: localized,
+    /** The sentence agents read with the rules, or `null` for the description. */
+    agentNote: z.nullable(localized),
+    version: z.string(),
+    state: z.enum(PLUGIN_STATES),
+    /** Why the plugin failed, or waits for consent; empty otherwise. */
+    problems: z.array(z.string()),
+    /** The asker's roles in the plugin; every role for an administrator. */
+    roles: z.array(z.string()),
+    /** The roles the plugin declares, by key, with their names. */
+    declaredRoles: z.array(z.object({ key: z.string(), name: localized, description: localized })),
+    /** The role every member holds without a grant, or `null` where the manifest names none. */
+    defaultRole: z.nullable(z.string()),
+    menu: z.nullable(z.object({ group: z.string(), order: z.int(), name: z.nullable(localized) })),
+    /** The pages and widgets the asker may see. */
+    pages: z.array(restPluginPageSchema),
+    widgets: z.array(restPluginWidgetSchema),
+    /** The board project, or `null` for none. */
+    board: z.nullable(z.object({ key: z.string(), name: z.string() })),
+    boardNeeds: z.enum(PLUGIN_BOARD_NEEDS),
+    /** What the plugin asks, and what was consented to; `consent` is `null` to a member. */
+    capabilities: z.array(z.string()),
+    consent: z.nullable(z.array(z.string())),
+    /** The projects the plugin is on: all, their keys, or `null` to a member. */
+    projects: z.nullable(z.union([z.literal("all"), z.array(z.string())])),
+    requires: z.record(z.string(), z.string()),
+    dataVersion: z.int(),
+    enabledAt: z.nullable(instant),
+});
+export const restPluginsSchema = z.object({
+    items: z.array(restPluginSchema),
+    /** Whether this deployment can give a plugin a schema of its own (`storage:sql`). */
+    sql: z.boolean(),
+});
+/** A setting as the pages draw its form: the manifest's declaration, and whether and what it holds. */
+export const restPluginSettingSchema = z.object({
+    key: z.string(),
+    type: z.enum(PLUGIN_SETTING_TYPES),
+    name: localized,
+    description: z.nullable(localized),
+    required: z.boolean(),
+    default: z.nullable(z.unknown()),
+    min: z.nullable(z.number()),
+    max: z.nullable(z.number()),
+    options: z.nullable(z.array(z.object({ value: z.string(), name: localized }))),
+    of: z.nullable(z.string()),
+    /** Whether a value is set; a secret's value is never here. */
+    set: z.boolean(),
+    value: z.nullable(z.unknown()),
+    /** When a secret was set, or `null`. */
+    setAt: z.nullable(instant),
+});
+/** A grant of a role: to a person, to the members of a project, or to everyone. */
+export const restPluginGrantSchema = z.object({
+    id: uuid,
+    role: z.string(),
+    person: z.nullable(z.object({ id: uuid, login: z.string(), name: z.nullable(z.string()) })),
+    project: z.nullable(z.object({ key: z.string(), name: z.string() })),
+    everyone: z.boolean(),
+    createdAt: instant,
+});
+export const restPluginGrantsSchema = z.object({ items: z.array(restPluginGrantSchema) });
+/** One plugin whole, for `GET /api/v1/plugins/<key>`: the listing's fields, and what agents and administrators need. */
+export const restPluginDetailSchema = z.extend(restPluginSchema, {
+    operations: z.array(restPluginOperationSchema),
+    /** Where the plugin's skills are read, or `null` for none. */
+    skills: z.nullable(z.string()),
+    /** The board project the manifest proposes, for an administrator who makes it; `null` where it proposes none. */
+    boardDefaults: z.nullable(z.object({ key: z.string(), name: localized, description: localized })),
+    settings: z.array(restPluginSettingSchema),
+    /** The grants, to an administrator; `null` to a member. */
+    grants: z.nullable(z.array(restPluginGrantSchema)),
+    /** The plugin's own events are at this path. */
+    events: z.string(),
+});
+/** What `POST /api/v1/plugins/<key>/enable` is sent. */
+export const restPluginEnableInputSchema = z.object({
+    /** Every capability the manifest asks, named again: consent. */
+    consent: z.array(z.string().check(z.maxLength(300))).check(z.maxLength(50)),
+    /** The board project: one to make, one that exists, or none. */
+    board: z.nullable(z.union([
+        z.object({
+            create: z.object({
+                key: z.string().check(z.minLength(1), z.maxLength(MAX_PROJECT_KEY_LENGTH)),
+                name: z.string().check(z.minLength(1), z.maxLength(MAX_PROJECT_NAME_LENGTH)),
+                description: z.string().check(z.maxLength(MAX_PROJECT_DESCRIPTION_LENGTH)),
+            }),
+        }),
+        z.object({ project: projectKey }),
+    ])),
+    /** The projects the plugin is on. */
+    projects: z.union([z.literal("all"), z.array(projectKey).check(z.maxLength(500))]),
+    /** The settings' values, without secrets. */
+    settings: z.optional(z.record(settingKey, z.unknown())),
+});
+/** What `PATCH /api/v1/plugins/<key>/settings` is sent: the values that change; `null` clears one. */
+export const restPluginSettingsPatchSchema = z.object({
+    values: z.record(settingKey, z.unknown()),
+});
+/** What `PUT /api/v1/plugins/<key>/secrets/<name>` is sent. */
+export const restPluginSecretInputSchema = z.object({
+    value: z.string().check(z.minLength(1), z.maxLength(MAX_PLUGIN_SECRET_LENGTH)),
+});
+/** What `POST /api/v1/plugins/<key>/grants` is sent: a role, and exactly one of whom. */
+export const restPluginGrantInputSchema = z
+    .object({
+    role: pluginKey,
+    person: z.optional(uuid),
+    project: z.optional(projectKey),
+    everyone: z.optional(z.literal(true)),
+})
+    .check(z.refine((input) => [input.person !== undefined, input.project !== undefined, input.everyone === true].filter(Boolean).length === 1, "names a person, a project or everyone, one of the three"));
+/** A file a person uploaded for a command (`POST .../files`): the handle a `file` argument takes, good for an hour. */
+export const restPluginFileHandleSchema = z.object({
+    handle: z.string(),
+    name: z.string(),
+    type: z.string(),
+    bytes: z.int(),
+});
+/** A handle as a command line names one: what `POST .../files` answered. */
+const handle = z.string().check(z.minLength(1), z.maxLength(254));
+/**
+ * What `POST /api/v1/plugins/<key>/invoke` is sent: the words as typed, the command's or the
+ * query's name first, the handles of the files uploaded for it, the project the call is on, and
+ * the run it is for where the caller has several open.
+ */
+export const restPluginInvokeInputSchema = z.object({
+    argv: z
+        .array(z.string().check(z.maxLength(MAX_PLUGIN_ARGV_WORD_LENGTH)))
+        .check(z.minLength(1), z.maxLength(MAX_PLUGIN_ARGV_WORDS)),
+    files: z.optional(z.array(handle).check(z.maxLength(MAX_PLUGIN_COMMAND_FILES))),
+    project: z.optional(projectKey),
+    run: z.optional(uuid),
+});
+/** What `POST /api/v1/plugins/<key>/commands/<name>` is sent: the arguments as JSON, by name. */
+export const restPluginCommandInputSchema = z.object({
+    args: z.record(z.string(), z.unknown()),
+    project: z.optional(projectKey),
+    run: z.optional(uuid),
+});
+/**
+ * What a command or a query answered: `text` is what the command prints, `data` what `--json`
+ * prints (a query's whole answer), `waiting` the id of a decision the caller now waits for.
+ */
+export const restPluginInvocationSchema = z.object({
+    kind: z.enum(["command", "query"]),
+    text: z.string(),
+    data: z.unknown(),
+    waiting: z.nullable(z.string()),
+});
+/** A record of a plugin's collection, as `GET .../records/<collection>` lists them. */
+export const restPluginRecordSchema = z.object({
+    id: uuid,
+    collection: z.string(),
+    /** The id of the project the record is linked to, or `null`. */
+    project: z.nullable(z.string()),
+    /** The id of the person the record is about, where the collection has an owner. */
+    owner: z.nullable(z.string()),
+    data: z.record(z.string(), z.unknown()),
+    version: z.int(),
+    createdAt: instant,
+    updatedAt: instant,
+    createdBy: z.nullable(z.string()),
+    updatedBy: z.nullable(z.string()),
+    archivedAt: z.nullable(instant),
+});
+/** A page of records, and the cursor `after` continues with, or `null` on the last. */
+export const restPluginRecordPageSchema = z.object({
+    items: z.array(restPluginRecordSchema),
+    after: z.nullable(z.string()),
+});
+/** One version of a record, as it was. */
+export const restPluginRecordVersionSchema = z.object({
+    version: z.int(),
+    data: z.record(z.string(), z.unknown()),
+    at: instant,
+    by: z.nullable(z.string()),
+});
+/** What `GET .../records/<collection>/<id>[?version=]` answers: the record, or one version of it. */
+export const restPluginRecordReadSchema = z.union([
+    restPluginRecordSchema,
+    restPluginRecordVersionSchema,
+]);
+export const restPluginRecordVersionsSchema = z.object({
+    items: z.array(restPluginRecordVersionSchema),
+});
+/** An event a plugin emitted (`ctx.events.emit`), as `GET .../plugin-events?after=` lists them for its frames: its number in the stream, its kind, its data, when. */
+export const restPluginEventSchema = z.object({
+    id: z.int(),
+    kind: z.string(),
+    data: z.unknown(),
+    at: instant,
+});
+export const restPluginEventsSchema = z.object({
+    items: z.array(restPluginEventSchema),
+    more: z.boolean(),
+});
+/** What `POST /api/v1/plugins/<key>/purge` is sent: the key again. */
+export const restPluginPurgeInputSchema = z.object({ confirm: pluginKey });
+//# sourceMappingURL=rest-schemas.js.map

package/dist/plugin/rest-schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rest-schemas.js","sourceRoot":"","sources":["../../src/plugin/rest-schemas.ts"],"names":[],"mappings":"AAAA,2FAA2F;AAC3F,+FAA+F;AAC/F,gGAAgG;AAChG,6FAA6F;AAC7F,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;AAC9B,OAAO,EACL,8BAA8B,EAC9B,sBAAsB,EACtB,uBAAuB,GACxB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EACL,2BAA2B,EAC3B,qBAAqB,EACrB,wBAAwB,GACzB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,kBAAkB,EAClB,kBAAkB,EAClB,kBAAkB,EAClB,oBAAoB,EACpB,oBAAoB,EACpB,mBAAmB,EACnB,mBAAmB,GACpB,MAAM,eAAe,CAAC;AAEvB,mEAAmE;AACnE,MAAM,CAAC,MAAM,wBAAwB,GAAG,IAAI,CAAC;AAC7C,wCAAwC;AACxC,MAAM,CAAC,MAAM,iBAAiB,GAAG,IAAI,CAAC;AAEtC,MAAM,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;AACtB,MAAM,OAAO,GAAG,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;AACjC,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,CAAC;AAChE,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC;AAClE,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,sBAAsB,CAAC,CAAC,CAAC;AACzF,mDAAmD;AACnD,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;AAEnD,2FAA2F;AAC3F,MAAM,CAAC,MAAM,mBAAmB,GAAiC,CAAC,CAAC,MAAM,CAAC;IACxE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;IACvB,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC7B,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;IACrB,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE;IACvB,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IAC/B,GAAG,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC3B,GAAG,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC3B,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IAChC,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IACxC,UAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAClC,IAAI,EAAE;QACJ,OAAO,CAAC,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IACzC,CAAC;CACF,CAAC,CAAC;AAeH,mFAAmF;AACnF,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAClC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,mBAAmB,CAAC;IAC/C,6DAA6D;IAC7D,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;CACvC,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,IAAI,EAAE,SAAS;IACf,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC;IACjC,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE;CAClB,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7C,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,IAAI,EAAE,SAAS;IACf,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC;IACnC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC;CAClC,CAAC,CAAC;AAGH,0GAA0G;AAC1G,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,IAAI,EAAE,SAAS;IACf,WAAW,EAAE,SAAS;IACtB,8EAA8E;IAC9E,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC;IAChC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC;IAC5B,oEAAoE;IACpE,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC7B,wEAAwE;IACxE,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC1B,+DAA+D;IAC/D,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC,CAAC;IAC9F,4FAA4F;IAC5F,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACnC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IAC9F,+CAA+C;IAC/C,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC;IACpC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,sBAAsB,CAAC;IACxC,6CAA6C;IAC7C,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAClE,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC;IACtC,wFAAwF;IACxF,YAAY,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACjC,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IACxC,6EAA6E;IAC7E,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IACtE,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;IAC1C,WAAW,EAAE,CAAC,CAAC,GAAG,EAAE;IACpB,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC;CAC/B,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC;IAChC,qFAAqF;IACrF,GAAG,EAAE,CAAC,CAAC,OAAO,EAAE;CACjB,CAAC,CAAC;AAGH,uGAAuG;AACvG,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC;IAClC,IAAI,EAAE,SAAS;IACf,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC;IAClC,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;IACrB,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IAChC,GAAG,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC3B,GAAG,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC3B,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;IAC9E,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC1B,8DAA8D;IAC9D,GAAG,EAAE,CAAC,CAAC,OAAO,EAAE;IAChB,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IAC9B,wCAAwC;IACxC,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC;CAC3B,CAAC,CAAC;AAGH,mFAAmF;AACnF,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,EAAE,EAAE,IAAI;IACR,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC;IAC3F,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IACpE,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;IACrB,SAAS,EAAE,OAAO;CACnB,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAC;AAG1F,wHAAwH;AACxH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC,gBAAgB,EAAE;IAC/D,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,yBAAyB,CAAC;IAC9C,8DAA8D;IAC9D,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC9B,iHAAiH;IACjH,aAAa,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC,CAAC;IACjG,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,uBAAuB,CAAC;IAC1C,2DAA2D;IAC3D,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAClD,gDAAgD;IAChD,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;CACnB,CAAC,CAAC;AAGH,wDAAwD;AACxD,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,gEAAgE;IAChE,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IAC3E,gEAAgE;IAChE,KAAK,EAAE,CAAC,CAAC,QAAQ,CACf,CAAC,CAAC,KAAK,CAAC;QACN,CAAC,CAAC,MAAM,CAAC;YACP,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC;gBACf,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,sBAAsB,CAAC,CAAC;gBAC1E,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,uBAAuB,CAAC,CAAC;gBAC5E,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,8BAA8B,CAAC,CAAC;aAC3E,CAAC;SACH,CAAC;QACF,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;KAClC,CAAC,CACH;IACD,qCAAqC;IACrC,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAClF,6CAA6C;IAC7C,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;CACxD,CAAC,CAAC;AAGH,sGAAsG;AACtG,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC,MAAM,CAAC;IACpD,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;CAC1C,CAAC,CAAC;AAGH,+DAA+D;AAC/D,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,wBAAwB,CAAC,CAAC;CAC/E,CAAC,CAAC;AAGH,yFAAyF;AACzF,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC;KACxC,MAAM,CAAC;IACN,IAAI,EAAE,SAAS;IACf,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;IACxB,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC;IAC/B,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;CACtC,CAAC;KACD,KAAK,CACJ,CAAC,CAAC,MAAM,CACN,CAAC,KAAK,EAAE,EAAE,CACR,CAAC,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE,KAAK,CAAC,QAAQ,KAAK,IAAI,CAAC,CAAC,MAAM,CACvF,OAAO,CACR,CAAC,MAAM,KAAK,CAAC,EAChB,yDAAyD,CAC1D,CACF,CAAC;AAGJ,uHAAuH;AACvH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,KAAK,EAAE,CAAC,CAAC,GAAG,EAAE;CACf,CAAC,CAAC;AAGH,4EAA4E;AAC5E,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;AAElE;;;;GAIG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,IAAI,EAAE,CAAC;SACJ,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,2BAA2B,CAAC,CAAC,CAAC;SACjE,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC;IAC5D,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,wBAAwB,CAAC,CAAC,CAAC;IAC/E,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC;IAC/B,GAAG,EAAE,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;CACtB,CAAC,CAAC;AAGH,iGAAiG;AACjG,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;IACvC,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC;IAC/B,GAAG,EAAE,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;CACtB,CAAC,CAAC;AAGH;;;GAGG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAClC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE;IACjB,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;CAChC,CAAC,CAAC;AAGH,uFAAuF;AACvF,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7C,EAAE,EAAE,IAAI;IACR,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,gEAAgE;IAChE,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC/B,mFAAmF;IACnF,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC7B,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;IACvC,OAAO,EAAE,CAAC,CAAC,GAAG,EAAE;IAChB,SAAS,EAAE,OAAO;IAClB,SAAS,EAAE,OAAO;IAClB,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACjC,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACjC,UAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC;CAChC,CAAC,CAAC;AAGH,uFAAuF;AACvF,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,sBAAsB,CAAC;IACtC,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;CAC9B,CAAC,CAAC;AAGH,0CAA0C;AAC1C,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC,MAAM,CAAC;IACpD,OAAO,EAAE,CAAC,CAAC,GAAG,EAAE;IAChB,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;IACvC,EAAE,EAAE,OAAO;IACX,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;CAC3B,CAAC,CAAC;AAGH,qGAAqG;AACrG,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC;IAChD,sBAAsB;IACtB,6BAA6B;CAC9B,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,CAAC,MAAM,CAAC;IACrD,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,6BAA6B,CAAC;CAC9C,CAAC,CAAC;AAGH,sKAAsK;AACtK,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE;IACX,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE;IACjB,EAAE,EAAE,OAAO;CACZ,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7C,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC;IACrC,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE;CAClB,CAAC,CAAC;AAGH,sEAAsE;AACtE,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC"}

package/dist/plugin/sandbox.d.ts

@@ -0,0 +1,23 @@
+/** The built-in modules a plugin's thread may not load, with or without the `node:` prefix. */
+export declare const FORBIDDEN_BUILTINS: readonly string[];
+/** The globals a plugin's thread does without: the network, and the way under the module system. */
+export declare const REMOVED_GLOBALS: readonly string[];
+/** True when a module specifier names a built-in the host refuses. */
+export declare function isForbiddenBuiltin(specifier: string): boolean;
+/** The built-ins a bundle's text imports or requires that the host refuses, each once, as written. */
+export declare function forbiddenImportsIn(source: string): string[];
+/** The removed globals a bundle's text calls, each once; a plugin that calls them fails at runtime. */
+export declare function removedGlobalsIn(source: string): string[];
+/** What the thread looks like after hardening, for a test to assert on. */
+export interface HardenedThread {
+    readonly removed: readonly string[];
+}
+/** The module hook: refuses the forbidden built-ins and lets everything else resolve as it would. */
+export declare function forbiddingResolve<C, R>(specifier: string, context: C, nextResolve: (specifier: string, context: C) => R): R;
+/**
+ * Hardens the current thread: refuses the forbidden built-ins through the module hooks, removes
+ * the globals, empties the environment, and blocks `process.binding`. Call it in a worker thread
+ * before importing plugin code; it reaches nothing outside that thread.
+ */
+export declare function hardenThread(moduleApi: Pick<typeof import("node:module"), "registerHooks">): HardenedThread;
+//# sourceMappingURL=sandbox.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sandbox.d.ts","sourceRoot":"","sources":["../../src/plugin/sandbox.ts"],"names":[],"mappings":"AAKA,+FAA+F;AAC/F,eAAO,MAAM,kBAAkB,EAAE,SAAS,MAAM,EAkB/C,CAAC;AAEF,oGAAoG;AACpG,eAAO,MAAM,eAAe,EAAE,SAAS,MAAM,EAA0C,CAAC;AAExF,sEAAsE;AACtE,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAI7D;AAKD,sGAAsG;AACtG,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAS3D;AAID,uGAAuG;AACvG,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAQzD;AAED,2EAA2E;AAC3E,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;CACrC;AAED,qGAAqG;AACrG,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,CAAC,EACpC,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,CAAC,EACV,WAAW,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,KAAK,CAAC,GAChD,CAAC,CASH;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAC1B,SAAS,EAAE,IAAI,CAAC,cAAc,aAAa,CAAC,EAAE,eAAe,CAAC,GAC7D,cAAc,CA8BhB"}

package/dist/plugin/sandbox.js

@@ -0,0 +1,99 @@
+// The hardening of a thread that runs plugin code (docs/specs/plugins.md, "The host"): the
+// built-ins the host refuses, the globals it removes, and a scan of a bundle's text for the same,
+// so that `console-plugin check` says before the host does. Defence in depth: the permission model
+// of the host process is the first line; this is the second.
+/** The built-in modules a plugin's thread may not load, with or without the `node:` prefix. */
+export const FORBIDDEN_BUILTINS = [
+    "net",
+    "http",
+    "https",
+    "http2",
+    "tls",
+    "dgram",
+    "dns",
+    "dns/promises",
+    "child_process",
+    "cluster",
+    "worker_threads",
+    "vm",
+    "inspector",
+    "inspector/promises",
+    "repl",
+    "wasi",
+    "v8",
+];
+/** The globals a plugin's thread does without: the network, and the way under the module system. */
+export const REMOVED_GLOBALS = ["fetch", "WebSocket", "EventSource"];
+/** True when a module specifier names a built-in the host refuses. */
+export function isForbiddenBuiltin(specifier) {
+    return FORBIDDEN_BUILTINS.includes(specifier.startsWith("node:") ? specifier.slice(5) : specifier);
+}
+const IMPORT_OR_REQUIRE = /(?:\bfrom\s*|\bimport\s*\(?\s*|\brequire\s*\(\s*|\bprocess\.getBuiltinModule\s*\(\s*)["'`](node:)?([a-z_/]+)["'`]/g;
+/** The built-ins a bundle's text imports or requires that the host refuses, each once, as written. */
+export function forbiddenImportsIn(source) {
+    const found = new Set();
+    for (const match of source.matchAll(IMPORT_OR_REQUIRE)) {
+        const specifier = `${match[1] ?? ""}${match[2] ?? ""}`;
+        if (isForbiddenBuiltin(specifier)) {
+            found.add(specifier);
+        }
+    }
+    return [...found];
+}
+const GLOBAL_USES = /\b(fetch|WebSocket|EventSource|process\.binding|process\.dlopen)\s*\(/g;
+/** The removed globals a bundle's text calls, each once; a plugin that calls them fails at runtime. */
+export function removedGlobalsIn(source) {
+    const found = new Set();
+    for (const match of source.matchAll(GLOBAL_USES)) {
+        if (match[1] !== undefined) {
+            found.add(match[1]);
+        }
+    }
+    return [...found];
+}
+/** The module hook: refuses the forbidden built-ins and lets everything else resolve as it would. */
+export function forbiddingResolve(specifier, context, nextResolve) {
+    if (isForbiddenBuiltin(specifier)) {
+        const error = new Error(`the host refuses ${specifier}: a plugin reaches the console through ctx alone`);
+        error.code = "ERR_PLUGIN_FORBIDDEN_BUILTIN";
+        throw error;
+    }
+    return nextResolve(specifier, context);
+}
+/**
+ * Hardens the current thread: refuses the forbidden built-ins through the module hooks, removes
+ * the globals, empties the environment, and blocks `process.binding`. Call it in a worker thread
+ * before importing plugin code; it reaches nothing outside that thread.
+ */
+export function hardenThread(moduleApi) {
+    moduleApi.registerHooks({ resolve: forbiddingResolve });
+    const removed = [];
+    const global = globalThis;
+    for (const name of REMOVED_GLOBALS) {
+        if (name in global) {
+            Object.defineProperty(global, name, {
+                value: undefined,
+                writable: false,
+                configurable: false,
+            });
+            removed.push(name);
+        }
+    }
+    const proc = global.process;
+    if (proc !== undefined) {
+        const refuse = () => {
+            throw new Error("the host refuses process.binding");
+        };
+        for (const name of ["binding", "_linkedBinding", "dlopen"]) {
+            Object.defineProperty(proc, name, { value: refuse, writable: false, configurable: false });
+        }
+        const env = proc.env;
+        if (env !== undefined) {
+            for (const key of Object.keys(env)) {
+                delete env[key];
+            }
+        }
+    }
+    return { removed };
+}
+//# sourceMappingURL=sandbox.js.map

package/dist/plugin/sandbox.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sandbox.js","sourceRoot":"","sources":["../../src/plugin/sandbox.ts"],"names":[],"mappings":"AAAA,2FAA2F;AAC3F,kGAAkG;AAClG,mGAAmG;AACnG,6DAA6D;AAE7D,+FAA+F;AAC/F,MAAM,CAAC,MAAM,kBAAkB,GAAsB;IACnD,KAAK;IACL,MAAM;IACN,OAAO;IACP,OAAO;IACP,KAAK;IACL,OAAO;IACP,KAAK;IACL,cAAc;IACd,eAAe;IACf,SAAS;IACT,gBAAgB;IAChB,IAAI;IACJ,WAAW;IACX,oBAAoB;IACpB,MAAM;IACN,MAAM;IACN,IAAI;CACL,CAAC;AAEF,oGAAoG;AACpG,MAAM,CAAC,MAAM,eAAe,GAAsB,CAAC,OAAO,EAAE,WAAW,EAAE,aAAa,CAAC,CAAC;AAExF,sEAAsE;AACtE,MAAM,UAAU,kBAAkB,CAAC,SAAiB;IAClD,OAAO,kBAAkB,CAAC,QAAQ,CAChC,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAC/D,CAAC;AACJ,CAAC;AAED,MAAM,iBAAiB,GACrB,oHAAoH,CAAC;AAEvH,sGAAsG;AACtG,MAAM,UAAU,kBAAkB,CAAC,MAAc;IAC/C,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;IAChC,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,CAAC;QACvD,MAAM,SAAS,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;QACvD,IAAI,kBAAkB,CAAC,SAAS,CAAC,EAAE,CAAC;YAClC,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACvB,CAAC;IACH,CAAC;IACD,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC;AACpB,CAAC;AAED,MAAM,WAAW,GAAG,wEAAwE,CAAC;AAE7F,uGAAuG;AACvG,MAAM,UAAU,gBAAgB,CAAC,MAAc;IAC7C,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;IAChC,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;QACjD,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;YAC3B,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QACtB,CAAC;IACH,CAAC;IACD,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC;AACpB,CAAC;AAOD,qGAAqG;AACrG,MAAM,UAAU,iBAAiB,CAC/B,SAAiB,EACjB,OAAU,EACV,WAAiD;IAEjD,IAAI,kBAAkB,CAAC,SAAS,CAAC,EAAE,CAAC;QAClC,MAAM,KAAK,GAAG,IAAI,KAAK,CACrB,oBAAoB,SAAS,kDAAkD,CAChF,CAAC;QACD,KAA2B,CAAC,IAAI,GAAG,8BAA8B,CAAC;QACnE,MAAM,KAAK,CAAC;IACd,CAAC;IACD,OAAO,WAAW,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;AACzC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAC1B,SAA8D;IAE9D,SAAS,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC,CAAC;IACxD,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,MAAM,MAAM,GAAG,UAAqC,CAAC;IACrD,KAAK,MAAM,IAAI,IAAI,eAAe,EAAE,CAAC;QACnC,IAAI,IAAI,IAAI,MAAM,EAAE,CAAC;YACnB,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE;gBAClC,KAAK,EAAE,SAAS;gBAChB,QAAQ,EAAE,KAAK;gBACf,YAAY,EAAE,KAAK;aACpB,CAAC,CAAC;YACH,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,CAAC,OAA8C,CAAC;IACnE,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,MAAM,MAAM,GAAG,GAAG,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;QACtD,CAAC,CAAC;QACF,KAAK,MAAM,IAAI,IAAI,CAAC,SAAS,EAAE,gBAAgB,EAAE,QAAQ,CAAC,EAAE,CAAC;YAC3D,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,CAAC;QAC7F,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,GAA0C,CAAC;QAC5D,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YACtB,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBACnC,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC;YAClB,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,EAAE,OAAO,EAAE,CAAC;AACrB,CAAC"}

package/dist/plugin/testing.d.ts

@@ -0,0 +1,45 @@
+import type { CollectionDefinition, OtherPlugin, PluginCaller, PluginConsole, PluginContext, PluginFetchInit, PluginFetchResponse, PluginInfo, PluginRecord, PluginSql } from "./context.js";
+export interface TestConsoleOptions {
+    readonly workspace?: PluginConsole["workspace"];
+    readonly people?: Partial<PluginConsole["people"]>;
+    readonly projects?: Partial<PluginConsole["projects"]>;
+    readonly tasks?: Partial<PluginConsole["tasks"]>;
+    readonly decisions?: Partial<PluginConsole["decisions"]>;
+    readonly documents?: Partial<PluginConsole["documents"]>;
+    readonly runs?: Partial<PluginConsole["runs"]>;
+}
+export interface TestContextOptions {
+    readonly plugin?: Partial<PluginInfo>;
+    readonly caller?: PluginCaller;
+    /** The collections, so that writes are checked against their schemas and `where` against their indexes. */
+    readonly collections?: readonly CollectionDefinition[];
+    /** What the console answers; what is left out is refused as `plugin.forbidden`. */
+    readonly console?: TestConsoleOptions;
+    readonly sql?: PluginSql;
+    readonly fetch?: (url: string, init?: PluginFetchInit) => Promise<PluginFetchResponse>;
+    /** The secrets by name; `sign` and `verify` use them, and never hand them over. */
+    readonly secrets?: Readonly<Record<string, string>>;
+    readonly plugins?: Readonly<Record<string, OtherPlugin>>;
+    readonly now?: () => Date;
+    readonly language?: string;
+}
+export interface LoggedLine {
+    readonly level: "info" | "warn" | "error";
+    readonly message: string;
+    readonly fields: Readonly<Record<string, unknown>> | undefined;
+}
+export interface TestContext extends PluginContext {
+    /** What the plugin emitted with `ctx.events.emit`, in order. */
+    readonly emitted: readonly {
+        readonly kind: string;
+        readonly data: unknown;
+    }[];
+    readonly logged: readonly LoggedLine[];
+    /** Every record of a collection, archived ones included, for assertions. */
+    all(collection: string): readonly PluginRecord[];
+    /** The same store, as another caller. */
+    as(caller: PluginCaller): TestContext;
+}
+/** A context for a plugin's tests: records in memory, the console refusing what is not given. */
+export declare function createTestContext(options?: TestContextOptions): TestContext;
+//# sourceMappingURL=testing.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"testing.d.ts","sourceRoot":"","sources":["../../src/plugin/testing.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EACV,oBAAoB,EAEpB,WAAW,EACX,YAAY,EACZ,aAAa,EACb,aAAa,EACb,eAAe,EACf,mBAAmB,EACnB,UAAU,EACV,YAAY,EAEZ,SAAS,EAYV,MAAM,cAAc,CAAC;AAStB,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,SAAS,CAAC,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC;IAChD,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC;IACnD,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,CAAC;IACvD,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;IACjD,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC;IACzD,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC;IACzD,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;CAChD;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;IACtC,QAAQ,CAAC,MAAM,CAAC,EAAE,YAAY,CAAC;IAC/B,2GAA2G;IAC3G,QAAQ,CAAC,WAAW,CAAC,EAAE,SAAS,oBAAoB,EAAE,CAAC;IACvD,mFAAmF;IACnF,QAAQ,CAAC,OAAO,CAAC,EAAE,kBAAkB,CAAC;IACtC,QAAQ,CAAC,GAAG,CAAC,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,eAAe,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACvF,mFAAmF;IACnF,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACpD,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC;IACzD,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,IAAI,CAAC;IAC1B,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IAC1C,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;CAChE;AAED,MAAM,WAAW,WAAY,SAAQ,aAAa;IAChD,gEAAgE;IAChE,QAAQ,CAAC,OAAO,EAAE,SAAS;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;KAAE,EAAE,CAAC;IAC/E,QAAQ,CAAC,MAAM,EAAE,SAAS,UAAU,EAAE,CAAC;IACvC,4EAA4E;IAC5E,GAAG,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,YAAY,EAAE,CAAC;IACjD,yCAAyC;IACzC,EAAE,CAAC,MAAM,EAAE,YAAY,GAAG,WAAW,CAAC;CACvC;AAkhBD,iGAAiG;AACjG,wBAAgB,iBAAiB,CAAC,OAAO,GAAE,kBAAuB,GAAG,WAAW,CAG/E"}