@opengeni/contracts 5.5.0 → 5.5.2-canary.40656248492001

package/dist/bots.d.ts

@@ -0,0 +1,583 @@
+import { z } from "zod";
+/**
+ * Bots. A bot is an ordinary long-lived chat: its title is its name, and any
+ * chat may also carry a short description and an avatar. Both are display
+ * metadata for people; they never reach the model. People and the chat's own
+ * agent may change them at any time.
+ *
+ * A bot template is where a new bot starts: a name, description and avatar,
+ * plus setup instructions that become the new chat's first message. The
+ * agent then sets itself up with its ordinary tools (Skills, connections,
+ * schedules, machines) and the chat simply continues. A workspace keeps the
+ * templates its people and agents save.
+ *
+ * This module must not import `./index`.
+ */
+export declare const SESSION_DESCRIPTION_MAX_LENGTH = 280;
+/** Curated icon names (the web maps each to a Lucide glyph). */
+export declare const SESSION_AVATAR_ICONS: readonly ["bot", "bug", "mail", "git-pull-request", "telescope", "chart-line", "file-text", "shield-check", "wrench", "search", "calendar-clock", "megaphone", "receipt", "rocket", "database", "code", "briefcase", "book-open", "flask-conical", "globe", "headset", "pen-tool", "users", "sparkles"];
+export declare const SessionAvatarIcon: z.ZodEnum<{
+    "book-open": "book-open";
+    bot: "bot";
+    briefcase: "briefcase";
+    bug: "bug";
+    "calendar-clock": "calendar-clock";
+    "chart-line": "chart-line";
+    code: "code";
+    database: "database";
+    "file-text": "file-text";
+    "flask-conical": "flask-conical";
+    "git-pull-request": "git-pull-request";
+    globe: "globe";
+    headset: "headset";
+    mail: "mail";
+    megaphone: "megaphone";
+    "pen-tool": "pen-tool";
+    receipt: "receipt";
+    rocket: "rocket";
+    search: "search";
+    "shield-check": "shield-check";
+    sparkles: "sparkles";
+    telescope: "telescope";
+    users: "users";
+    wrench: "wrench";
+}>;
+export type SessionAvatarIcon = z.infer<typeof SessionAvatarIcon>;
+/** True when `value` is exactly one user-perceived character that is an emoji. */
+export declare function isSingleSessionAvatarEmoji(value: string): boolean;
+/** Hue (0-359) of the avatar tile's background. */
+export declare const SessionAvatarHue: z.ZodNumber;
+/**
+ * What a chat looks like in lists and its header. `image` names an image file
+ * in the workspace (for example one the agent generated); each viewer opens it
+ * with their own access, and anyone who cannot sees the chat's initials.
+ */
+export declare const SessionAvatar: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    kind: z.ZodLiteral<"emoji">;
+    emoji: z.ZodString;
+    hue: z.ZodNumber;
+}, z.core.$strict>, z.ZodObject<{
+    kind: z.ZodLiteral<"icon">;
+    icon: z.ZodEnum<{
+        "book-open": "book-open";
+        bot: "bot";
+        briefcase: "briefcase";
+        bug: "bug";
+        "calendar-clock": "calendar-clock";
+        "chart-line": "chart-line";
+        code: "code";
+        database: "database";
+        "file-text": "file-text";
+        "flask-conical": "flask-conical";
+        "git-pull-request": "git-pull-request";
+        globe: "globe";
+        headset: "headset";
+        mail: "mail";
+        megaphone: "megaphone";
+        "pen-tool": "pen-tool";
+        receipt: "receipt";
+        rocket: "rocket";
+        search: "search";
+        "shield-check": "shield-check";
+        sparkles: "sparkles";
+        telescope: "telescope";
+        users: "users";
+        wrench: "wrench";
+    }>;
+    hue: z.ZodNumber;
+}, z.core.$strict>, z.ZodObject<{
+    kind: z.ZodLiteral<"letters">;
+    letters: z.ZodString;
+    hue: z.ZodNumber;
+}, z.core.$strict>, z.ZodObject<{
+    kind: z.ZodLiteral<"image">;
+    artifactId: z.ZodString;
+}, z.core.$strict>], "kind">;
+export type SessionAvatar = z.infer<typeof SessionAvatar>;
+/** An avatar a file can carry to another workspace: anything but an image. */
+export declare const PortableSessionAvatar: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    kind: z.ZodLiteral<"emoji">;
+    emoji: z.ZodString;
+    hue: z.ZodNumber;
+}, z.core.$strict>, z.ZodObject<{
+    kind: z.ZodLiteral<"icon">;
+    icon: z.ZodEnum<{
+        "book-open": "book-open";
+        bot: "bot";
+        briefcase: "briefcase";
+        bug: "bug";
+        "calendar-clock": "calendar-clock";
+        "chart-line": "chart-line";
+        code: "code";
+        database: "database";
+        "file-text": "file-text";
+        "flask-conical": "flask-conical";
+        "git-pull-request": "git-pull-request";
+        globe: "globe";
+        headset: "headset";
+        mail: "mail";
+        megaphone: "megaphone";
+        "pen-tool": "pen-tool";
+        receipt: "receipt";
+        rocket: "rocket";
+        search: "search";
+        "shield-check": "shield-check";
+        sparkles: "sparkles";
+        telescope: "telescope";
+        users: "users";
+        wrench: "wrench";
+    }>;
+    hue: z.ZodNumber;
+}, z.core.$strict>, z.ZodObject<{
+    kind: z.ZodLiteral<"letters">;
+    letters: z.ZodString;
+    hue: z.ZodNumber;
+}, z.core.$strict>, z.ZodObject<{
+    kind: z.ZodLiteral<"image">;
+    artifactId: z.ZodString;
+}, z.core.$strict>], "kind"> & z.ZodType<{
+    kind: "emoji";
+    emoji: string;
+    hue: number;
+} | {
+    kind: "icon";
+    icon: "book-open" | "bot" | "briefcase" | "bug" | "calendar-clock" | "chart-line" | "code" | "database" | "file-text" | "flask-conical" | "git-pull-request" | "globe" | "headset" | "mail" | "megaphone" | "pen-tool" | "receipt" | "rocket" | "search" | "shield-check" | "sparkles" | "telescope" | "users" | "wrench";
+    hue: number;
+} | {
+    kind: "letters";
+    letters: string;
+    hue: number;
+}, {
+    kind: "emoji";
+    emoji: string;
+    hue: number;
+} | {
+    kind: "icon";
+    icon: "book-open" | "bot" | "briefcase" | "bug" | "calendar-clock" | "chart-line" | "code" | "database" | "file-text" | "flask-conical" | "git-pull-request" | "globe" | "headset" | "mail" | "megaphone" | "pen-tool" | "receipt" | "rocket" | "search" | "shield-check" | "sparkles" | "telescope" | "users" | "wrench";
+    hue: number;
+} | {
+    kind: "letters";
+    letters: string;
+    hue: number;
+} | {
+    kind: "image";
+    artifactId: string;
+}, z.core.$ZodTypeInternals<{
+    kind: "emoji";
+    emoji: string;
+    hue: number;
+} | {
+    kind: "icon";
+    icon: "book-open" | "bot" | "briefcase" | "bug" | "calendar-clock" | "chart-line" | "code" | "database" | "file-text" | "flask-conical" | "git-pull-request" | "globe" | "headset" | "mail" | "megaphone" | "pen-tool" | "receipt" | "rocket" | "search" | "shield-check" | "sparkles" | "telescope" | "users" | "wrench";
+    hue: number;
+} | {
+    kind: "letters";
+    letters: string;
+    hue: number;
+}, {
+    kind: "emoji";
+    emoji: string;
+    hue: number;
+} | {
+    kind: "icon";
+    icon: "book-open" | "bot" | "briefcase" | "bug" | "calendar-clock" | "chart-line" | "code" | "database" | "file-text" | "flask-conical" | "git-pull-request" | "globe" | "headset" | "mail" | "megaphone" | "pen-tool" | "receipt" | "rocket" | "search" | "shield-check" | "sparkles" | "telescope" | "users" | "wrench";
+    hue: number;
+} | {
+    kind: "letters";
+    letters: string;
+    hue: number;
+} | {
+    kind: "image";
+    artifactId: string;
+}>>;
+/** Stored descriptions are trimmed; an empty one is no description. */
+export declare const SessionDescription: z.ZodPipe<z.ZodString, z.ZodTransform<string | null, string>>;
+export declare const BOT_TEMPLATE_NAME_MAX_LENGTH = 120;
+export declare const BOT_TEMPLATE_SETUP_INSTRUCTIONS_MAX_LENGTH = 20000;
+/** Saved templates a workspace keeps; saving another past this is refused. */
+export declare const BOT_TEMPLATES_PER_WORKSPACE_MAX = 200;
+/** A template saved in a workspace. */
+export declare const WorkspaceBotTemplate: z.ZodObject<{
+    id: z.ZodString;
+    workspaceId: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodString;
+    avatar: z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"emoji">;
+        emoji: z.ZodString;
+        hue: z.ZodNumber;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"icon">;
+        icon: z.ZodEnum<{
+            "book-open": "book-open";
+            bot: "bot";
+            briefcase: "briefcase";
+            bug: "bug";
+            "calendar-clock": "calendar-clock";
+            "chart-line": "chart-line";
+            code: "code";
+            database: "database";
+            "file-text": "file-text";
+            "flask-conical": "flask-conical";
+            "git-pull-request": "git-pull-request";
+            globe: "globe";
+            headset: "headset";
+            mail: "mail";
+            megaphone: "megaphone";
+            "pen-tool": "pen-tool";
+            receipt: "receipt";
+            rocket: "rocket";
+            search: "search";
+            "shield-check": "shield-check";
+            sparkles: "sparkles";
+            telescope: "telescope";
+            users: "users";
+            wrench: "wrench";
+        }>;
+        hue: z.ZodNumber;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"letters">;
+        letters: z.ZodString;
+        hue: z.ZodNumber;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"image">;
+        artifactId: z.ZodString;
+    }, z.core.$strict>], "kind">>;
+    setupInstructions: z.ZodString;
+    sourceSessionId: z.ZodNullable<z.ZodString>;
+    createdBySubjectId: z.ZodNullable<z.ZodString>;
+    viewerAccess: z.ZodEnum<{
+        manage: "manage";
+        use: "use";
+    }>;
+    createdAt: z.ZodString;
+    updatedAt: z.ZodString;
+}, z.core.$strip>;
+export type WorkspaceBotTemplate = z.output<typeof WorkspaceBotTemplate>;
+export declare const CreateBotTemplateRequest: z.ZodObject<{
+    name: z.ZodString;
+    description: z.ZodDefault<z.ZodString>;
+    avatar: z.ZodDefault<z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"emoji">;
+        emoji: z.ZodString;
+        hue: z.ZodNumber;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"icon">;
+        icon: z.ZodEnum<{
+            "book-open": "book-open";
+            bot: "bot";
+            briefcase: "briefcase";
+            bug: "bug";
+            "calendar-clock": "calendar-clock";
+            "chart-line": "chart-line";
+            code: "code";
+            database: "database";
+            "file-text": "file-text";
+            "flask-conical": "flask-conical";
+            "git-pull-request": "git-pull-request";
+            globe: "globe";
+            headset: "headset";
+            mail: "mail";
+            megaphone: "megaphone";
+            "pen-tool": "pen-tool";
+            receipt: "receipt";
+            rocket: "rocket";
+            search: "search";
+            "shield-check": "shield-check";
+            sparkles: "sparkles";
+            telescope: "telescope";
+            users: "users";
+            wrench: "wrench";
+        }>;
+        hue: z.ZodNumber;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"letters">;
+        letters: z.ZodString;
+        hue: z.ZodNumber;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"image">;
+        artifactId: z.ZodString;
+    }, z.core.$strict>], "kind">>>;
+    setupInstructions: z.ZodString;
+    sourceSessionId: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+}, z.core.$strict>;
+export type CreateBotTemplateRequest = z.input<typeof CreateBotTemplateRequest>;
+export type ParsedCreateBotTemplateRequest = z.output<typeof CreateBotTemplateRequest>;
+/** Changes only what it names. */
+export declare const UpdateBotTemplateRequest: z.ZodObject<{
+    name: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    avatar: z.ZodOptional<z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"emoji">;
+        emoji: z.ZodString;
+        hue: z.ZodNumber;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"icon">;
+        icon: z.ZodEnum<{
+            "book-open": "book-open";
+            bot: "bot";
+            briefcase: "briefcase";
+            bug: "bug";
+            "calendar-clock": "calendar-clock";
+            "chart-line": "chart-line";
+            code: "code";
+            database: "database";
+            "file-text": "file-text";
+            "flask-conical": "flask-conical";
+            "git-pull-request": "git-pull-request";
+            globe: "globe";
+            headset: "headset";
+            mail: "mail";
+            megaphone: "megaphone";
+            "pen-tool": "pen-tool";
+            receipt: "receipt";
+            rocket: "rocket";
+            search: "search";
+            "shield-check": "shield-check";
+            sparkles: "sparkles";
+            telescope: "telescope";
+            users: "users";
+            wrench: "wrench";
+        }>;
+        hue: z.ZodNumber;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"letters">;
+        letters: z.ZodString;
+        hue: z.ZodNumber;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"image">;
+        artifactId: z.ZodString;
+    }, z.core.$strict>], "kind">>>;
+    setupInstructions: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type UpdateBotTemplateRequest = z.input<typeof UpdateBotTemplateRequest>;
+export type ParsedUpdateBotTemplateRequest = z.output<typeof UpdateBotTemplateRequest>;
+export declare const ListBotTemplatesResponse: z.ZodObject<{
+    templates: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        workspaceId: z.ZodString;
+        name: z.ZodString;
+        description: z.ZodString;
+        avatar: z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<{
+            kind: z.ZodLiteral<"emoji">;
+            emoji: z.ZodString;
+            hue: z.ZodNumber;
+        }, z.core.$strict>, z.ZodObject<{
+            kind: z.ZodLiteral<"icon">;
+            icon: z.ZodEnum<{
+                "book-open": "book-open";
+                bot: "bot";
+                briefcase: "briefcase";
+                bug: "bug";
+                "calendar-clock": "calendar-clock";
+                "chart-line": "chart-line";
+                code: "code";
+                database: "database";
+                "file-text": "file-text";
+                "flask-conical": "flask-conical";
+                "git-pull-request": "git-pull-request";
+                globe: "globe";
+                headset: "headset";
+                mail: "mail";
+                megaphone: "megaphone";
+                "pen-tool": "pen-tool";
+                receipt: "receipt";
+                rocket: "rocket";
+                search: "search";
+                "shield-check": "shield-check";
+                sparkles: "sparkles";
+                telescope: "telescope";
+                users: "users";
+                wrench: "wrench";
+            }>;
+            hue: z.ZodNumber;
+        }, z.core.$strict>, z.ZodObject<{
+            kind: z.ZodLiteral<"letters">;
+            letters: z.ZodString;
+            hue: z.ZodNumber;
+        }, z.core.$strict>, z.ZodObject<{
+            kind: z.ZodLiteral<"image">;
+            artifactId: z.ZodString;
+        }, z.core.$strict>], "kind">>;
+        setupInstructions: z.ZodString;
+        sourceSessionId: z.ZodNullable<z.ZodString>;
+        createdBySubjectId: z.ZodNullable<z.ZodString>;
+        viewerAccess: z.ZodEnum<{
+            manage: "manage";
+            use: "use";
+        }>;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type ListBotTemplatesResponse = z.output<typeof ListBotTemplatesResponse>;
+export declare const BotTemplateResponse: z.ZodObject<{
+    template: z.ZodObject<{
+        id: z.ZodString;
+        workspaceId: z.ZodString;
+        name: z.ZodString;
+        description: z.ZodString;
+        avatar: z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<{
+            kind: z.ZodLiteral<"emoji">;
+            emoji: z.ZodString;
+            hue: z.ZodNumber;
+        }, z.core.$strict>, z.ZodObject<{
+            kind: z.ZodLiteral<"icon">;
+            icon: z.ZodEnum<{
+                "book-open": "book-open";
+                bot: "bot";
+                briefcase: "briefcase";
+                bug: "bug";
+                "calendar-clock": "calendar-clock";
+                "chart-line": "chart-line";
+                code: "code";
+                database: "database";
+                "file-text": "file-text";
+                "flask-conical": "flask-conical";
+                "git-pull-request": "git-pull-request";
+                globe: "globe";
+                headset: "headset";
+                mail: "mail";
+                megaphone: "megaphone";
+                "pen-tool": "pen-tool";
+                receipt: "receipt";
+                rocket: "rocket";
+                search: "search";
+                "shield-check": "shield-check";
+                sparkles: "sparkles";
+                telescope: "telescope";
+                users: "users";
+                wrench: "wrench";
+            }>;
+            hue: z.ZodNumber;
+        }, z.core.$strict>, z.ZodObject<{
+            kind: z.ZodLiteral<"letters">;
+            letters: z.ZodString;
+            hue: z.ZodNumber;
+        }, z.core.$strict>, z.ZodObject<{
+            kind: z.ZodLiteral<"image">;
+            artifactId: z.ZodString;
+        }, z.core.$strict>], "kind">>;
+        setupInstructions: z.ZodString;
+        sourceSessionId: z.ZodNullable<z.ZodString>;
+        createdBySubjectId: z.ZodNullable<z.ZodString>;
+        viewerAccess: z.ZodEnum<{
+            manage: "manage";
+            use: "use";
+        }>;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type BotTemplateResponse = z.output<typeof BotTemplateResponse>;
+export declare const BOT_TEMPLATE_FILE_FORMAT = "opengeni.bot-template";
+/**
+ * A template as a file, to share outside its workspace. It carries no ids,
+ * owner or image: importing it saves a new template in the importer's
+ * workspace, and an image avatar becomes the name's initials.
+ */
+export declare const BotTemplateFile: z.ZodObject<{
+    format: z.ZodLiteral<"opengeni.bot-template">;
+    version: z.ZodLiteral<1>;
+    name: z.ZodString;
+    description: z.ZodDefault<z.ZodString>;
+    avatar: z.ZodDefault<z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"emoji">;
+        emoji: z.ZodString;
+        hue: z.ZodNumber;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"icon">;
+        icon: z.ZodEnum<{
+            "book-open": "book-open";
+            bot: "bot";
+            briefcase: "briefcase";
+            bug: "bug";
+            "calendar-clock": "calendar-clock";
+            "chart-line": "chart-line";
+            code: "code";
+            database: "database";
+            "file-text": "file-text";
+            "flask-conical": "flask-conical";
+            "git-pull-request": "git-pull-request";
+            globe: "globe";
+            headset: "headset";
+            mail: "mail";
+            megaphone: "megaphone";
+            "pen-tool": "pen-tool";
+            receipt: "receipt";
+            rocket: "rocket";
+            search: "search";
+            "shield-check": "shield-check";
+            sparkles: "sparkles";
+            telescope: "telescope";
+            users: "users";
+            wrench: "wrench";
+        }>;
+        hue: z.ZodNumber;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"letters">;
+        letters: z.ZodString;
+        hue: z.ZodNumber;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"image">;
+        artifactId: z.ZodString;
+    }, z.core.$strict>], "kind"> & z.ZodType<{
+        kind: "emoji";
+        emoji: string;
+        hue: number;
+    } | {
+        kind: "icon";
+        icon: "book-open" | "bot" | "briefcase" | "bug" | "calendar-clock" | "chart-line" | "code" | "database" | "file-text" | "flask-conical" | "git-pull-request" | "globe" | "headset" | "mail" | "megaphone" | "pen-tool" | "receipt" | "rocket" | "search" | "shield-check" | "sparkles" | "telescope" | "users" | "wrench";
+        hue: number;
+    } | {
+        kind: "letters";
+        letters: string;
+        hue: number;
+    }, {
+        kind: "emoji";
+        emoji: string;
+        hue: number;
+    } | {
+        kind: "icon";
+        icon: "book-open" | "bot" | "briefcase" | "bug" | "calendar-clock" | "chart-line" | "code" | "database" | "file-text" | "flask-conical" | "git-pull-request" | "globe" | "headset" | "mail" | "megaphone" | "pen-tool" | "receipt" | "rocket" | "search" | "shield-check" | "sparkles" | "telescope" | "users" | "wrench";
+        hue: number;
+    } | {
+        kind: "letters";
+        letters: string;
+        hue: number;
+    } | {
+        kind: "image";
+        artifactId: string;
+    }, z.core.$ZodTypeInternals<{
+        kind: "emoji";
+        emoji: string;
+        hue: number;
+    } | {
+        kind: "icon";
+        icon: "book-open" | "bot" | "briefcase" | "bug" | "calendar-clock" | "chart-line" | "code" | "database" | "file-text" | "flask-conical" | "git-pull-request" | "globe" | "headset" | "mail" | "megaphone" | "pen-tool" | "receipt" | "rocket" | "search" | "shield-check" | "sparkles" | "telescope" | "users" | "wrench";
+        hue: number;
+    } | {
+        kind: "letters";
+        letters: string;
+        hue: number;
+    }, {
+        kind: "emoji";
+        emoji: string;
+        hue: number;
+    } | {
+        kind: "icon";
+        icon: "book-open" | "bot" | "briefcase" | "bug" | "calendar-clock" | "chart-line" | "code" | "database" | "file-text" | "flask-conical" | "git-pull-request" | "globe" | "headset" | "mail" | "megaphone" | "pen-tool" | "receipt" | "rocket" | "search" | "shield-check" | "sparkles" | "telescope" | "users" | "wrench";
+        hue: number;
+    } | {
+        kind: "letters";
+        letters: string;
+        hue: number;
+    } | {
+        kind: "image";
+        artifactId: string;
+    }>>>>;
+    setupInstructions: z.ZodString;
+}, z.core.$strict>;
+export type BotTemplateFile = z.input<typeof BotTemplateFile>;
+/** The file for a template; an image avatar is dropped (see {@link BotTemplateFile}). */
+export declare function botTemplateFile(template: Pick<WorkspaceBotTemplate, "name" | "description" | "avatar" | "setupInstructions">): z.output<typeof BotTemplateFile>;