@skillcdn/console 0.4.0 → 0.4.2

package/dist/plugin/rest-schemas.d.ts

@@ -0,0 +1,556 @@
+import * as z from "zod/mini";
+import { ARG_TYPES } from "./args.js";
+/** How long a secret an administrator sets for a plugin may be. */
+export declare const MAX_PLUGIN_SECRET_LENGTH = 4096;
+/** How many grants one plugin holds. */
+export declare const MAX_PLUGIN_GRANTS = 1000;
+/** An argument of a command or a query, as the console describes it for help and forms. */
+export declare const restPluginArgSchema: z.ZodMiniType<RestPluginArg>;
+export interface RestPluginArg {
+    readonly type: (typeof ARG_TYPES)[number];
+    readonly about?: string | undefined;
+    readonly optional: boolean;
+    readonly positional: boolean;
+    readonly secret?: boolean | undefined;
+    readonly max?: number | undefined;
+    readonly min?: number | undefined;
+    readonly integer?: boolean | undefined;
+    readonly options?: readonly string[] | undefined;
+    readonly collection?: string | undefined;
+    readonly of?: RestPluginArg | undefined;
+}
+/** A command or a query of a plugin, as `GET /api/v1/plugins/<key>` lists them. */
+export declare const restPluginOperationSchema: z.ZodMiniObject<{
+    name: z.ZodMiniString<string>;
+    kind: z.ZodMiniEnum<{
+        command: "command";
+        query: "query";
+    }>;
+    about: z.ZodMiniString<string>;
+    args: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniType<RestPluginArg, unknown, z.core.$ZodTypeInternals<RestPluginArg, unknown>>>;
+    roles: z.ZodMiniNullable<z.ZodMiniArray<z.ZodMiniString<string>>>;
+}, z.core.$strip>;
+export type RestPluginOperation = z.infer<typeof restPluginOperationSchema>;
+export declare const restPluginPageSchema: z.ZodMiniObject<{
+    key: z.ZodMiniString<string>;
+    name: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
+    level: z.ZodMiniEnum<{
+        project: "project";
+        workspace: "workspace";
+    }>;
+    wide: z.ZodMiniBoolean<boolean>;
+}, z.core.$strip>;
+export type RestPluginPage = z.infer<typeof restPluginPageSchema>;
+export declare const restPluginWidgetSchema: 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";
+    }>;
+}, z.core.$strip>;
+export type RestPluginWidget = z.infer<typeof restPluginWidgetSchema>;
+/** A plugin as a member may know of it: what it is, how it stands, and what the member may do with it. */
+export declare const restPluginSchema: 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.ZodMiniNullable<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>>;
+    version: z.ZodMiniString<string>;
+    state: z.ZodMiniEnum<{
+        disabled: "disabled";
+        enabled: "enabled";
+        failed: "failed";
+        installed: "installed";
+        needs_consent: "needs_consent";
+        orphaned: "orphaned";
+    }>;
+    problems: z.ZodMiniArray<z.ZodMiniString<string>>;
+    roles: z.ZodMiniArray<z.ZodMiniString<string>>;
+    declaredRoles: z.ZodMiniArray<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.$strip>>;
+    defaultRole: z.ZodMiniNullable<z.ZodMiniString<string>>;
+    menu: z.ZodMiniNullable<z.ZodMiniObject<{
+        group: z.ZodMiniString<string>;
+        order: z.ZodMiniInt;
+        name: z.ZodMiniNullable<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>>;
+    }, z.core.$strip>>;
+    pages: z.ZodMiniArray<z.ZodMiniObject<{
+        key: z.ZodMiniString<string>;
+        name: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
+        level: z.ZodMiniEnum<{
+            project: "project";
+            workspace: "workspace";
+        }>;
+        wide: z.ZodMiniBoolean<boolean>;
+    }, z.core.$strip>>;
+    widgets: 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";
+        }>;
+    }, z.core.$strip>>;
+    board: z.ZodMiniNullable<z.ZodMiniObject<{
+        key: z.ZodMiniString<string>;
+        name: z.ZodMiniString<string>;
+    }, z.core.$strip>>;
+    boardNeeds: z.ZodMiniEnum<{
+        none: "none";
+        optional: "optional";
+        required: "required";
+    }>;
+    capabilities: z.ZodMiniArray<z.ZodMiniString<string>>;
+    consent: z.ZodMiniNullable<z.ZodMiniArray<z.ZodMiniString<string>>>;
+    projects: z.ZodMiniNullable<z.ZodMiniUnion<readonly [z.ZodMiniLiteral<"all">, z.ZodMiniArray<z.ZodMiniString<string>>]>>;
+    requires: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
+    dataVersion: z.ZodMiniInt;
+    enabledAt: z.ZodMiniNullable<z.ZodMiniISODateTime>;
+}, z.core.$strip>;
+export type RestPlugin = z.infer<typeof restPluginSchema>;
+export declare const restPluginsSchema: z.ZodMiniObject<{
+    items: z.ZodMiniArray<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.ZodMiniNullable<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>>;
+        version: z.ZodMiniString<string>;
+        state: z.ZodMiniEnum<{
+            disabled: "disabled";
+            enabled: "enabled";
+            failed: "failed";
+            installed: "installed";
+            needs_consent: "needs_consent";
+            orphaned: "orphaned";
+        }>;
+        problems: z.ZodMiniArray<z.ZodMiniString<string>>;
+        roles: z.ZodMiniArray<z.ZodMiniString<string>>;
+        declaredRoles: z.ZodMiniArray<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.$strip>>;
+        defaultRole: z.ZodMiniNullable<z.ZodMiniString<string>>;
+        menu: z.ZodMiniNullable<z.ZodMiniObject<{
+            group: z.ZodMiniString<string>;
+            order: z.ZodMiniInt;
+            name: z.ZodMiniNullable<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>>;
+        }, z.core.$strip>>;
+        pages: z.ZodMiniArray<z.ZodMiniObject<{
+            key: z.ZodMiniString<string>;
+            name: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
+            level: z.ZodMiniEnum<{
+                project: "project";
+                workspace: "workspace";
+            }>;
+            wide: z.ZodMiniBoolean<boolean>;
+        }, z.core.$strip>>;
+        widgets: 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";
+            }>;
+        }, z.core.$strip>>;
+        board: z.ZodMiniNullable<z.ZodMiniObject<{
+            key: z.ZodMiniString<string>;
+            name: z.ZodMiniString<string>;
+        }, z.core.$strip>>;
+        boardNeeds: z.ZodMiniEnum<{
+            none: "none";
+            optional: "optional";
+            required: "required";
+        }>;
+        capabilities: z.ZodMiniArray<z.ZodMiniString<string>>;
+        consent: z.ZodMiniNullable<z.ZodMiniArray<z.ZodMiniString<string>>>;
+        projects: z.ZodMiniNullable<z.ZodMiniUnion<readonly [z.ZodMiniLiteral<"all">, z.ZodMiniArray<z.ZodMiniString<string>>]>>;
+        requires: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
+        dataVersion: z.ZodMiniInt;
+        enabledAt: z.ZodMiniNullable<z.ZodMiniISODateTime>;
+    }, z.core.$strip>>;
+    sql: z.ZodMiniBoolean<boolean>;
+}, z.core.$strip>;
+export type RestPlugins = z.infer<typeof restPluginsSchema>;
+/** A setting as the pages draw its form: the manifest's declaration, and whether and what it holds. */
+export declare const restPluginSettingSchema: 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.ZodMiniNullable<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>>;
+    required: z.ZodMiniBoolean<boolean>;
+    default: z.ZodMiniNullable<z.ZodMiniUnknown>;
+    min: z.ZodMiniNullable<z.ZodMiniNumber<number>>;
+    max: z.ZodMiniNullable<z.ZodMiniNumber<number>>;
+    options: z.ZodMiniNullable<z.ZodMiniArray<z.ZodMiniObject<{
+        value: z.ZodMiniString<string>;
+        name: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
+    }, z.core.$strip>>>;
+    of: z.ZodMiniNullable<z.ZodMiniString<string>>;
+    set: z.ZodMiniBoolean<boolean>;
+    value: z.ZodMiniNullable<z.ZodMiniUnknown>;
+    setAt: z.ZodMiniNullable<z.ZodMiniISODateTime>;
+}, z.core.$strip>;
+export type RestPluginSetting = z.infer<typeof restPluginSettingSchema>;
+/** A grant of a role: to a person, to the members of a project, or to everyone. */
+export declare const restPluginGrantSchema: z.ZodMiniObject<{
+    id: z.ZodMiniUUID;
+    role: z.ZodMiniString<string>;
+    person: z.ZodMiniNullable<z.ZodMiniObject<{
+        id: z.ZodMiniUUID;
+        login: z.ZodMiniString<string>;
+        name: z.ZodMiniNullable<z.ZodMiniString<string>>;
+    }, z.core.$strip>>;
+    project: z.ZodMiniNullable<z.ZodMiniObject<{
+        key: z.ZodMiniString<string>;
+        name: z.ZodMiniString<string>;
+    }, z.core.$strip>>;
+    everyone: z.ZodMiniBoolean<boolean>;
+    createdAt: z.ZodMiniISODateTime;
+}, z.core.$strip>;
+export type RestPluginGrant = z.infer<typeof restPluginGrantSchema>;
+export declare const restPluginGrantsSchema: z.ZodMiniObject<{
+    items: z.ZodMiniArray<z.ZodMiniObject<{
+        id: z.ZodMiniUUID;
+        role: z.ZodMiniString<string>;
+        person: z.ZodMiniNullable<z.ZodMiniObject<{
+            id: z.ZodMiniUUID;
+            login: z.ZodMiniString<string>;
+            name: z.ZodMiniNullable<z.ZodMiniString<string>>;
+        }, z.core.$strip>>;
+        project: z.ZodMiniNullable<z.ZodMiniObject<{
+            key: z.ZodMiniString<string>;
+            name: z.ZodMiniString<string>;
+        }, z.core.$strip>>;
+        everyone: z.ZodMiniBoolean<boolean>;
+        createdAt: z.ZodMiniISODateTime;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type RestPluginGrants = z.infer<typeof restPluginGrantsSchema>;
+/** One plugin whole, for `GET /api/v1/plugins/<key>`: the listing's fields, and what agents and administrators need. */
+export declare const restPluginDetailSchema: 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.ZodMiniNullable<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>>;
+    version: z.ZodMiniString<string>;
+    state: z.ZodMiniEnum<{
+        disabled: "disabled";
+        enabled: "enabled";
+        failed: "failed";
+        installed: "installed";
+        needs_consent: "needs_consent";
+        orphaned: "orphaned";
+    }>;
+    problems: z.ZodMiniArray<z.ZodMiniString<string>>;
+    roles: z.ZodMiniArray<z.ZodMiniString<string>>;
+    declaredRoles: z.ZodMiniArray<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.$strip>>;
+    defaultRole: z.ZodMiniNullable<z.ZodMiniString<string>>;
+    menu: z.ZodMiniNullable<z.ZodMiniObject<{
+        group: z.ZodMiniString<string>;
+        order: z.ZodMiniInt;
+        name: z.ZodMiniNullable<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>>;
+    }, z.core.$strip>>;
+    pages: z.ZodMiniArray<z.ZodMiniObject<{
+        key: z.ZodMiniString<string>;
+        name: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
+        level: z.ZodMiniEnum<{
+            project: "project";
+            workspace: "workspace";
+        }>;
+        wide: z.ZodMiniBoolean<boolean>;
+    }, z.core.$strip>>;
+    widgets: 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";
+        }>;
+    }, z.core.$strip>>;
+    board: z.ZodMiniNullable<z.ZodMiniObject<{
+        key: z.ZodMiniString<string>;
+        name: z.ZodMiniString<string>;
+    }, z.core.$strip>>;
+    boardNeeds: z.ZodMiniEnum<{
+        none: "none";
+        optional: "optional";
+        required: "required";
+    }>;
+    capabilities: z.ZodMiniArray<z.ZodMiniString<string>>;
+    consent: z.ZodMiniNullable<z.ZodMiniArray<z.ZodMiniString<string>>>;
+    projects: z.ZodMiniNullable<z.ZodMiniUnion<readonly [z.ZodMiniLiteral<"all">, z.ZodMiniArray<z.ZodMiniString<string>>]>>;
+    requires: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
+    dataVersion: z.ZodMiniInt;
+    enabledAt: z.ZodMiniNullable<z.ZodMiniISODateTime>;
+    operations: z.ZodMiniArray<z.ZodMiniObject<{
+        name: z.ZodMiniString<string>;
+        kind: z.ZodMiniEnum<{
+            command: "command";
+            query: "query";
+        }>;
+        about: z.ZodMiniString<string>;
+        args: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniType<RestPluginArg, unknown, z.core.$ZodTypeInternals<RestPluginArg, unknown>>>;
+        roles: z.ZodMiniNullable<z.ZodMiniArray<z.ZodMiniString<string>>>;
+    }, z.core.$strip>>;
+    skills: z.ZodMiniNullable<z.ZodMiniString<string>>;
+    boardDefaults: z.ZodMiniNullable<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.$strip>>;
+    settings: 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.ZodMiniNullable<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>>;
+        required: z.ZodMiniBoolean<boolean>;
+        default: z.ZodMiniNullable<z.ZodMiniUnknown>;
+        min: z.ZodMiniNullable<z.ZodMiniNumber<number>>;
+        max: z.ZodMiniNullable<z.ZodMiniNumber<number>>;
+        options: z.ZodMiniNullable<z.ZodMiniArray<z.ZodMiniObject<{
+            value: z.ZodMiniString<string>;
+            name: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
+        }, z.core.$strip>>>;
+        of: z.ZodMiniNullable<z.ZodMiniString<string>>;
+        set: z.ZodMiniBoolean<boolean>;
+        value: z.ZodMiniNullable<z.ZodMiniUnknown>;
+        setAt: z.ZodMiniNullable<z.ZodMiniISODateTime>;
+    }, z.core.$strip>>;
+    grants: z.ZodMiniNullable<z.ZodMiniArray<z.ZodMiniObject<{
+        id: z.ZodMiniUUID;
+        role: z.ZodMiniString<string>;
+        person: z.ZodMiniNullable<z.ZodMiniObject<{
+            id: z.ZodMiniUUID;
+            login: z.ZodMiniString<string>;
+            name: z.ZodMiniNullable<z.ZodMiniString<string>>;
+        }, z.core.$strip>>;
+        project: z.ZodMiniNullable<z.ZodMiniObject<{
+            key: z.ZodMiniString<string>;
+            name: z.ZodMiniString<string>;
+        }, z.core.$strip>>;
+        everyone: z.ZodMiniBoolean<boolean>;
+        createdAt: z.ZodMiniISODateTime;
+    }, z.core.$strip>>>;
+    events: z.ZodMiniString<string>;
+}, z.core.$strip>;
+export type RestPluginDetail = z.infer<typeof restPluginDetailSchema>;
+/** What `POST /api/v1/plugins/<key>/enable` is sent. */
+export declare const restPluginEnableInputSchema: z.ZodMiniObject<{
+    consent: z.ZodMiniArray<z.ZodMiniString<string>>;
+    board: z.ZodMiniNullable<z.ZodMiniUnion<readonly [z.ZodMiniObject<{
+        create: z.ZodMiniObject<{
+            key: z.ZodMiniString<string>;
+            name: z.ZodMiniString<string>;
+            description: z.ZodMiniString<string>;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodMiniObject<{
+        project: z.ZodMiniString<string>;
+    }, z.core.$strip>]>>;
+    projects: z.ZodMiniUnion<readonly [z.ZodMiniLiteral<"all">, z.ZodMiniArray<z.ZodMiniString<string>>]>;
+    settings: z.ZodMiniOptional<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniUnknown>>;
+}, z.core.$strip>;
+export type RestPluginEnableInput = z.infer<typeof restPluginEnableInputSchema>;
+/** What `PATCH /api/v1/plugins/<key>/settings` is sent: the values that change; `null` clears one. */
+export declare const restPluginSettingsPatchSchema: z.ZodMiniObject<{
+    values: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniUnknown>;
+}, z.core.$strip>;
+export type RestPluginSettingsPatch = z.infer<typeof restPluginSettingsPatchSchema>;
+/** What `PUT /api/v1/plugins/<key>/secrets/<name>` is sent. */
+export declare const restPluginSecretInputSchema: z.ZodMiniObject<{
+    value: z.ZodMiniString<string>;
+}, z.core.$strip>;
+export type RestPluginSecretInput = z.infer<typeof restPluginSecretInputSchema>;
+/** What `POST /api/v1/plugins/<key>/grants` is sent: a role, and exactly one of whom. */
+export declare const restPluginGrantInputSchema: z.ZodMiniObject<{
+    role: z.ZodMiniString<string>;
+    person: z.ZodMiniOptional<z.ZodMiniUUID>;
+    project: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    everyone: z.ZodMiniOptional<z.ZodMiniLiteral<true>>;
+}, z.core.$strip>;
+export type RestPluginGrantInput = z.infer<typeof restPluginGrantInputSchema>;
+/** A file a person uploaded for a command (`POST .../files`): the handle a `file` argument takes, good for an hour. */
+export declare const restPluginFileHandleSchema: z.ZodMiniObject<{
+    handle: z.ZodMiniString<string>;
+    name: z.ZodMiniString<string>;
+    type: z.ZodMiniString<string>;
+    bytes: z.ZodMiniInt;
+}, z.core.$strip>;
+export type RestPluginFileHandle = z.infer<typeof restPluginFileHandleSchema>;
+/**
+ * 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 declare const restPluginInvokeInputSchema: z.ZodMiniObject<{
+    argv: z.ZodMiniArray<z.ZodMiniString<string>>;
+    files: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
+    project: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    run: z.ZodMiniOptional<z.ZodMiniUUID>;
+}, z.core.$strip>;
+export type RestPluginInvokeInput = z.infer<typeof restPluginInvokeInputSchema>;
+/** What `POST /api/v1/plugins/<key>/commands/<name>` is sent: the arguments as JSON, by name. */
+export declare const restPluginCommandInputSchema: z.ZodMiniObject<{
+    args: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniUnknown>;
+    project: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    run: z.ZodMiniOptional<z.ZodMiniUUID>;
+}, z.core.$strip>;
+export type RestPluginCommandInput = z.infer<typeof restPluginCommandInputSchema>;
+/**
+ * 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 declare const restPluginInvocationSchema: z.ZodMiniObject<{
+    kind: z.ZodMiniEnum<{
+        command: "command";
+        query: "query";
+    }>;
+    text: z.ZodMiniString<string>;
+    data: z.ZodMiniUnknown;
+    waiting: z.ZodMiniNullable<z.ZodMiniString<string>>;
+}, z.core.$strip>;
+export type RestPluginInvocation = z.infer<typeof restPluginInvocationSchema>;
+/** A record of a plugin's collection, as `GET .../records/<collection>` lists them. */
+export declare const restPluginRecordSchema: z.ZodMiniObject<{
+    id: z.ZodMiniUUID;
+    collection: z.ZodMiniString<string>;
+    project: z.ZodMiniNullable<z.ZodMiniString<string>>;
+    owner: z.ZodMiniNullable<z.ZodMiniString<string>>;
+    data: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniUnknown>;
+    version: z.ZodMiniInt;
+    createdAt: z.ZodMiniISODateTime;
+    updatedAt: z.ZodMiniISODateTime;
+    createdBy: z.ZodMiniNullable<z.ZodMiniString<string>>;
+    updatedBy: z.ZodMiniNullable<z.ZodMiniString<string>>;
+    archivedAt: z.ZodMiniNullable<z.ZodMiniISODateTime>;
+}, z.core.$strip>;
+export type RestPluginRecord = z.infer<typeof restPluginRecordSchema>;
+/** A page of records, and the cursor `after` continues with, or `null` on the last. */
+export declare const restPluginRecordPageSchema: z.ZodMiniObject<{
+    items: z.ZodMiniArray<z.ZodMiniObject<{
+        id: z.ZodMiniUUID;
+        collection: z.ZodMiniString<string>;
+        project: z.ZodMiniNullable<z.ZodMiniString<string>>;
+        owner: z.ZodMiniNullable<z.ZodMiniString<string>>;
+        data: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniUnknown>;
+        version: z.ZodMiniInt;
+        createdAt: z.ZodMiniISODateTime;
+        updatedAt: z.ZodMiniISODateTime;
+        createdBy: z.ZodMiniNullable<z.ZodMiniString<string>>;
+        updatedBy: z.ZodMiniNullable<z.ZodMiniString<string>>;
+        archivedAt: z.ZodMiniNullable<z.ZodMiniISODateTime>;
+    }, z.core.$strip>>;
+    after: z.ZodMiniNullable<z.ZodMiniString<string>>;
+}, z.core.$strip>;
+export type RestPluginRecordPage = z.infer<typeof restPluginRecordPageSchema>;
+/** One version of a record, as it was. */
+export declare const restPluginRecordVersionSchema: z.ZodMiniObject<{
+    version: z.ZodMiniInt;
+    data: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniUnknown>;
+    at: z.ZodMiniISODateTime;
+    by: z.ZodMiniNullable<z.ZodMiniString<string>>;
+}, z.core.$strip>;
+export type RestPluginRecordVersion = z.infer<typeof restPluginRecordVersionSchema>;
+/** What `GET .../records/<collection>/<id>[?version=]` answers: the record, or one version of it. */
+export declare const restPluginRecordReadSchema: z.ZodMiniUnion<readonly [z.ZodMiniObject<{
+    id: z.ZodMiniUUID;
+    collection: z.ZodMiniString<string>;
+    project: z.ZodMiniNullable<z.ZodMiniString<string>>;
+    owner: z.ZodMiniNullable<z.ZodMiniString<string>>;
+    data: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniUnknown>;
+    version: z.ZodMiniInt;
+    createdAt: z.ZodMiniISODateTime;
+    updatedAt: z.ZodMiniISODateTime;
+    createdBy: z.ZodMiniNullable<z.ZodMiniString<string>>;
+    updatedBy: z.ZodMiniNullable<z.ZodMiniString<string>>;
+    archivedAt: z.ZodMiniNullable<z.ZodMiniISODateTime>;
+}, z.core.$strip>, z.ZodMiniObject<{
+    version: z.ZodMiniInt;
+    data: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniUnknown>;
+    at: z.ZodMiniISODateTime;
+    by: z.ZodMiniNullable<z.ZodMiniString<string>>;
+}, z.core.$strip>]>;
+export type RestPluginRecordRead = z.infer<typeof restPluginRecordReadSchema>;
+export declare const restPluginRecordVersionsSchema: z.ZodMiniObject<{
+    items: z.ZodMiniArray<z.ZodMiniObject<{
+        version: z.ZodMiniInt;
+        data: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniUnknown>;
+        at: z.ZodMiniISODateTime;
+        by: z.ZodMiniNullable<z.ZodMiniString<string>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type RestPluginRecordVersions = z.infer<typeof restPluginRecordVersionsSchema>;
+/** 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 declare const restPluginEventSchema: z.ZodMiniObject<{
+    id: z.ZodMiniInt;
+    kind: z.ZodMiniString<string>;
+    data: z.ZodMiniUnknown;
+    at: z.ZodMiniISODateTime;
+}, z.core.$strip>;
+export type RestPluginEvent = z.infer<typeof restPluginEventSchema>;
+export declare const restPluginEventsSchema: z.ZodMiniObject<{
+    items: z.ZodMiniArray<z.ZodMiniObject<{
+        id: z.ZodMiniInt;
+        kind: z.ZodMiniString<string>;
+        data: z.ZodMiniUnknown;
+        at: z.ZodMiniISODateTime;
+    }, z.core.$strip>>;
+    more: z.ZodMiniBoolean<boolean>;
+}, z.core.$strip>;
+export type RestPluginEvents = z.infer<typeof restPluginEventsSchema>;
+/** What `POST /api/v1/plugins/<key>/purge` is sent: the key again. */
+export declare const restPluginPurgeInputSchema: z.ZodMiniObject<{
+    confirm: z.ZodMiniString<string>;
+}, z.core.$strip>;
+export type RestPluginPurgeInput = z.infer<typeof restPluginPurgeInputSchema>;
+//# sourceMappingURL=rest-schemas.d.ts.map

package/dist/plugin/rest-schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rest-schemas.d.ts","sourceRoot":"","sources":["../../src/plugin/rest-schemas.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;AAO9B,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAgBtC,mEAAmE;AACnE,eAAO,MAAM,wBAAwB,OAAO,CAAC;AAC7C,wCAAwC;AACxC,eAAO,MAAM,iBAAiB,OAAO,CAAC;AAUtC,2FAA2F;AAC3F,eAAO,MAAM,mBAAmB,EAAE,CAAC,CAAC,WAAW,CAAC,aAAa,CAc3D,CAAC;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,IAAI,EAAE,CAAC,OAAO,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;IAC1C,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACtC,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACvC,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,CAAC;IACjD,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzC,QAAQ,CAAC,EAAE,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;CACzC;AAED,mFAAmF;AACnF,eAAO,MAAM,yBAAyB;;;;;;;;;iBAOpC,CAAC;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E,eAAO,MAAM,oBAAoB;;;;;;;;iBAK/B,CAAC;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAElE,eAAO,MAAM,sBAAsB;;;;;;;;;;;;iBAKjC,CAAC;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE,0GAA0G;AAC1G,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA+B3B,CAAC;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAE1D,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAI5B,CAAC;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D,uGAAuG;AACvG,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAgBlC,CAAC;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAExE,mFAAmF;AACnF,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;iBAOhC,CAAC;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEpE,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;iBAAsD,CAAC;AAC1F,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE,wHAAwH;AACxH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAWjC,CAAC;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE,wDAAwD;AACxD,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;iBAoBtC,CAAC;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEhF,sGAAsG;AACtG,eAAO,MAAM,6BAA6B;;iBAExC,CAAC;AACH,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAC;AAEpF,+DAA+D;AAC/D,eAAO,MAAM,2BAA2B;;iBAEtC,CAAC;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEhF,yFAAyF;AACzF,eAAO,MAAM,0BAA0B;;;;;iBAepC,CAAC;AACJ,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE9E,uHAAuH;AACvH,eAAO,MAAM,0BAA0B;;;;;iBAKrC,CAAC;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAK9E;;;;GAIG;AACH,eAAO,MAAM,2BAA2B;;;;;iBAOtC,CAAC;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEhF,iGAAiG;AACjG,eAAO,MAAM,4BAA4B;;;;iBAIvC,CAAC;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAElF;;;GAGG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;iBAKrC,CAAC;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE9E,uFAAuF;AACvF,eAAO,MAAM,sBAAsB;;;;;;;;;;;;iBAcjC,CAAC;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE,uFAAuF;AACvF,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;iBAGrC,CAAC;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE9E,0CAA0C;AAC1C,eAAO,MAAM,6BAA6B;;;;;iBAKxC,CAAC;AACH,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAC;AAEpF,qGAAqG;AACrG,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;mBAGrC,CAAC;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE9E,eAAO,MAAM,8BAA8B;;;;;;;iBAEzC,CAAC;AACH,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAC;AAEtF,sKAAsK;AACtK,eAAO,MAAM,qBAAqB;;;;;iBAKhC,CAAC;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEpE,eAAO,MAAM,sBAAsB;;;;;;;;iBAGjC,CAAC;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE,sEAAsE;AACtE,eAAO,MAAM,0BAA0B;;iBAAmC,CAAC;AAC3E,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC"}