@antelopejs/dms-ai 0.0.1

package/sidecar/dist/protocol/messages.d.ts

@@ -0,0 +1,644 @@
+import { z } from "zod";
+export declare const ROLES: readonly ["iframe", "host"];
+export type Role = (typeof ROLES)[number];
+export declare const ROLE: {
+    readonly IFRAME: "iframe";
+    readonly HOST: "host";
+};
+export declare const MESSAGE_TYPES: {
+    readonly HELLO: "hello";
+    readonly ECHO: "echo";
+    readonly ECHO_REPLY: "echo_reply";
+    readonly USER_MESSAGE: "user_message";
+    readonly PERMISSION_RESPONSE: "permission_response";
+    readonly QUESTION_RESPONSE: "question_response";
+    readonly HOST_STATE_UPDATE: "host_state_update";
+    readonly HOST_NAVIGATION_COMPLETE: "host_navigation_complete";
+    readonly LIST_CONVERSATIONS: "list_conversations";
+    readonly DELETE_CONVERSATION: "delete_conversation";
+    readonly SET_SETTINGS: "set_settings";
+    readonly REQUEST_HOST_NAVIGATE: "request_host_navigate";
+    readonly INTERRUPT_TURN: "interrupt_turn";
+    readonly QUEUE_ENQUEUE: "queue_enqueue";
+    readonly QUEUE_CANCEL: "queue_cancel";
+};
+export declare const MAX_QUEUED_MESSAGES = 100;
+export declare const PERMISSION_DECISION_VALUES: readonly ["allow_once", "allow_session", "deny"];
+export declare const ClientHelloMsg: z.ZodObject<{
+    type: z.ZodLiteral<"hello">;
+    role: z.ZodEnum<["iframe", "host"]>;
+    conversationId: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    type: "hello";
+    role: "iframe" | "host";
+    conversationId?: string | undefined;
+}, {
+    type: "hello";
+    role: "iframe" | "host";
+    conversationId?: string | undefined;
+}>;
+export declare const EchoMsg: z.ZodObject<{
+    type: z.ZodLiteral<"echo">;
+    payload: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "echo";
+    payload: string;
+}, {
+    type: "echo";
+    payload: string;
+}>;
+export declare const ServerEchoReplyMsg: z.ZodObject<{
+    type: z.ZodLiteral<"echo_reply">;
+    payload: z.ZodString;
+    serverTimeMs: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    type: "echo_reply";
+    payload: string;
+    serverTimeMs: number;
+}, {
+    type: "echo_reply";
+    payload: string;
+    serverTimeMs: number;
+}>;
+export declare const AttachmentSchema: z.ZodObject<{
+    name: z.ZodString;
+    mimeType: z.ZodString;
+    size: z.ZodNumber;
+    data: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    mimeType: string;
+    size: number;
+    data: string;
+}, {
+    name: string;
+    mimeType: string;
+    size: number;
+    data: string;
+}>;
+export declare const UserMessageMsg: z.ZodObject<{
+    type: z.ZodLiteral<"user_message">;
+    conversationId: z.ZodString;
+    content: z.ZodString;
+    attachments: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        mimeType: z.ZodString;
+        size: z.ZodNumber;
+        data: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        mimeType: string;
+        size: number;
+        data: string;
+    }, {
+        name: string;
+        mimeType: string;
+        size: number;
+        data: string;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    type: "user_message";
+    conversationId: string;
+    content: string;
+    attachments?: {
+        name: string;
+        mimeType: string;
+        size: number;
+        data: string;
+    }[] | undefined;
+}, {
+    type: "user_message";
+    conversationId: string;
+    content: string;
+    attachments?: {
+        name: string;
+        mimeType: string;
+        size: number;
+        data: string;
+    }[] | undefined;
+}>;
+export declare const QueuedItemSchema: z.ZodObject<{
+    id: z.ZodString;
+    content: z.ZodString;
+    attachments: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        mimeType: z.ZodString;
+        size: z.ZodNumber;
+        data: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        mimeType: string;
+        size: number;
+        data: string;
+    }, {
+        name: string;
+        mimeType: string;
+        size: number;
+        data: string;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    content: string;
+    id: string;
+    attachments?: {
+        name: string;
+        mimeType: string;
+        size: number;
+        data: string;
+    }[] | undefined;
+}, {
+    content: string;
+    id: string;
+    attachments?: {
+        name: string;
+        mimeType: string;
+        size: number;
+        data: string;
+    }[] | undefined;
+}>;
+export declare const QueueEnqueueMsg: z.ZodObject<{
+    type: z.ZodLiteral<"queue_enqueue">;
+    conversationId: z.ZodString;
+    item: z.ZodObject<{
+        id: z.ZodString;
+        content: z.ZodString;
+        attachments: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            mimeType: z.ZodString;
+            size: z.ZodNumber;
+            data: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            mimeType: string;
+            size: number;
+            data: string;
+        }, {
+            name: string;
+            mimeType: string;
+            size: number;
+            data: string;
+        }>, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        content: string;
+        id: string;
+        attachments?: {
+            name: string;
+            mimeType: string;
+            size: number;
+            data: string;
+        }[] | undefined;
+    }, {
+        content: string;
+        id: string;
+        attachments?: {
+            name: string;
+            mimeType: string;
+            size: number;
+            data: string;
+        }[] | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "queue_enqueue";
+    conversationId: string;
+    item: {
+        content: string;
+        id: string;
+        attachments?: {
+            name: string;
+            mimeType: string;
+            size: number;
+            data: string;
+        }[] | undefined;
+    };
+}, {
+    type: "queue_enqueue";
+    conversationId: string;
+    item: {
+        content: string;
+        id: string;
+        attachments?: {
+            name: string;
+            mimeType: string;
+            size: number;
+            data: string;
+        }[] | undefined;
+    };
+}>;
+export declare const QueueCancelMsg: z.ZodObject<{
+    type: z.ZodLiteral<"queue_cancel">;
+    conversationId: z.ZodString;
+    id: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "queue_cancel";
+    conversationId: string;
+    id: string;
+}, {
+    type: "queue_cancel";
+    conversationId: string;
+    id: string;
+}>;
+export declare const PermissionResponseMsg: z.ZodObject<{
+    type: z.ZodLiteral<"permission_response">;
+    conversationId: z.ZodString;
+    requestId: z.ZodString;
+    decision: z.ZodEnum<["allow_once", "allow_session", "deny"]>;
+}, "strip", z.ZodTypeAny, {
+    type: "permission_response";
+    conversationId: string;
+    requestId: string;
+    decision: "allow_once" | "allow_session" | "deny";
+}, {
+    type: "permission_response";
+    conversationId: string;
+    requestId: string;
+    decision: "allow_once" | "allow_session" | "deny";
+}>;
+export declare const QuestionResponseMsg: z.ZodObject<{
+    type: z.ZodLiteral<"question_response">;
+    conversationId: z.ZodString;
+    requestId: z.ZodString;
+    answers: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    type: "question_response";
+    conversationId: string;
+    requestId: string;
+    answers: string[];
+}, {
+    type: "question_response";
+    conversationId: string;
+    requestId: string;
+    answers: string[];
+}>;
+export declare const HostStateUpdateMsg: z.ZodObject<{
+    type: z.ZodLiteral<"host_state_update">;
+    currentPage: z.ZodObject<{
+        path: z.ZodString;
+        filepath: z.ZodOptional<z.ZodString>;
+        title: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        path: string;
+        filepath?: string | undefined;
+        title?: string | undefined;
+    }, {
+        path: string;
+        filepath?: string | undefined;
+        title?: string | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "host_state_update";
+    currentPage: {
+        path: string;
+        filepath?: string | undefined;
+        title?: string | undefined;
+    };
+}, {
+    type: "host_state_update";
+    currentPage: {
+        path: string;
+        filepath?: string | undefined;
+        title?: string | undefined;
+    };
+}>;
+export declare const HostNavigationCompleteMsg: z.ZodObject<{
+    type: z.ZodLiteral<"host_navigation_complete">;
+    path: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "host_navigation_complete";
+    path: string;
+}, {
+    type: "host_navigation_complete";
+    path: string;
+}>;
+export declare const ListConversationsMsg: z.ZodObject<{
+    type: z.ZodLiteral<"list_conversations">;
+}, "strip", z.ZodTypeAny, {
+    type: "list_conversations";
+}, {
+    type: "list_conversations";
+}>;
+export declare const DeleteConversationMsg: z.ZodObject<{
+    type: z.ZodLiteral<"delete_conversation">;
+    conversationId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "delete_conversation";
+    conversationId: string;
+}, {
+    type: "delete_conversation";
+    conversationId: string;
+}>;
+export declare const SetSettingsMsg: z.ZodObject<{
+    type: z.ZodLiteral<"set_settings">;
+    mode: z.ZodEnum<["normal", "acceptEdits", "plan", "auto"]>;
+    thinking: z.ZodEnum<["off", "low", "medium", "high"]>;
+    generationMode: z.ZodDefault<z.ZodEnum<["safe", "vibe"]>>;
+    allowLocalSkills: z.ZodDefault<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    type: "set_settings";
+    mode: "normal" | "acceptEdits" | "plan" | "auto";
+    thinking: "off" | "low" | "medium" | "high";
+    generationMode: "safe" | "vibe";
+    allowLocalSkills: boolean;
+}, {
+    type: "set_settings";
+    mode: "normal" | "acceptEdits" | "plan" | "auto";
+    thinking: "off" | "low" | "medium" | "high";
+    generationMode?: "safe" | "vibe" | undefined;
+    allowLocalSkills?: boolean | undefined;
+}>;
+export declare const RequestHostNavigateMsg: z.ZodObject<{
+    type: z.ZodLiteral<"request_host_navigate">;
+    path: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "request_host_navigate";
+    path: string;
+}, {
+    type: "request_host_navigate";
+    path: string;
+}>;
+export declare const InterruptTurnMsg: z.ZodObject<{
+    type: z.ZodLiteral<"interrupt_turn">;
+    conversationId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "interrupt_turn";
+    conversationId: string;
+}, {
+    type: "interrupt_turn";
+    conversationId: string;
+}>;
+export declare const AnyClientMessage: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+    type: z.ZodLiteral<"hello">;
+    role: z.ZodEnum<["iframe", "host"]>;
+    conversationId: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    type: "hello";
+    role: "iframe" | "host";
+    conversationId?: string | undefined;
+}, {
+    type: "hello";
+    role: "iframe" | "host";
+    conversationId?: string | undefined;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"echo">;
+    payload: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "echo";
+    payload: string;
+}, {
+    type: "echo";
+    payload: string;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"user_message">;
+    conversationId: z.ZodString;
+    content: z.ZodString;
+    attachments: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        mimeType: z.ZodString;
+        size: z.ZodNumber;
+        data: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        mimeType: string;
+        size: number;
+        data: string;
+    }, {
+        name: string;
+        mimeType: string;
+        size: number;
+        data: string;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    type: "user_message";
+    conversationId: string;
+    content: string;
+    attachments?: {
+        name: string;
+        mimeType: string;
+        size: number;
+        data: string;
+    }[] | undefined;
+}, {
+    type: "user_message";
+    conversationId: string;
+    content: string;
+    attachments?: {
+        name: string;
+        mimeType: string;
+        size: number;
+        data: string;
+    }[] | undefined;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"permission_response">;
+    conversationId: z.ZodString;
+    requestId: z.ZodString;
+    decision: z.ZodEnum<["allow_once", "allow_session", "deny"]>;
+}, "strip", z.ZodTypeAny, {
+    type: "permission_response";
+    conversationId: string;
+    requestId: string;
+    decision: "allow_once" | "allow_session" | "deny";
+}, {
+    type: "permission_response";
+    conversationId: string;
+    requestId: string;
+    decision: "allow_once" | "allow_session" | "deny";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"question_response">;
+    conversationId: z.ZodString;
+    requestId: z.ZodString;
+    answers: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    type: "question_response";
+    conversationId: string;
+    requestId: string;
+    answers: string[];
+}, {
+    type: "question_response";
+    conversationId: string;
+    requestId: string;
+    answers: string[];
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"host_state_update">;
+    currentPage: z.ZodObject<{
+        path: z.ZodString;
+        filepath: z.ZodOptional<z.ZodString>;
+        title: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        path: string;
+        filepath?: string | undefined;
+        title?: string | undefined;
+    }, {
+        path: string;
+        filepath?: string | undefined;
+        title?: string | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "host_state_update";
+    currentPage: {
+        path: string;
+        filepath?: string | undefined;
+        title?: string | undefined;
+    };
+}, {
+    type: "host_state_update";
+    currentPage: {
+        path: string;
+        filepath?: string | undefined;
+        title?: string | undefined;
+    };
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"host_navigation_complete">;
+    path: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "host_navigation_complete";
+    path: string;
+}, {
+    type: "host_navigation_complete";
+    path: string;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"list_conversations">;
+}, "strip", z.ZodTypeAny, {
+    type: "list_conversations";
+}, {
+    type: "list_conversations";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"delete_conversation">;
+    conversationId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "delete_conversation";
+    conversationId: string;
+}, {
+    type: "delete_conversation";
+    conversationId: string;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"set_settings">;
+    mode: z.ZodEnum<["normal", "acceptEdits", "plan", "auto"]>;
+    thinking: z.ZodEnum<["off", "low", "medium", "high"]>;
+    generationMode: z.ZodDefault<z.ZodEnum<["safe", "vibe"]>>;
+    allowLocalSkills: z.ZodDefault<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    type: "set_settings";
+    mode: "normal" | "acceptEdits" | "plan" | "auto";
+    thinking: "off" | "low" | "medium" | "high";
+    generationMode: "safe" | "vibe";
+    allowLocalSkills: boolean;
+}, {
+    type: "set_settings";
+    mode: "normal" | "acceptEdits" | "plan" | "auto";
+    thinking: "off" | "low" | "medium" | "high";
+    generationMode?: "safe" | "vibe" | undefined;
+    allowLocalSkills?: boolean | undefined;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"request_host_navigate">;
+    path: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "request_host_navigate";
+    path: string;
+}, {
+    type: "request_host_navigate";
+    path: string;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"interrupt_turn">;
+    conversationId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "interrupt_turn";
+    conversationId: string;
+}, {
+    type: "interrupt_turn";
+    conversationId: string;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"queue_enqueue">;
+    conversationId: z.ZodString;
+    item: z.ZodObject<{
+        id: z.ZodString;
+        content: z.ZodString;
+        attachments: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            mimeType: z.ZodString;
+            size: z.ZodNumber;
+            data: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            mimeType: string;
+            size: number;
+            data: string;
+        }, {
+            name: string;
+            mimeType: string;
+            size: number;
+            data: string;
+        }>, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        content: string;
+        id: string;
+        attachments?: {
+            name: string;
+            mimeType: string;
+            size: number;
+            data: string;
+        }[] | undefined;
+    }, {
+        content: string;
+        id: string;
+        attachments?: {
+            name: string;
+            mimeType: string;
+            size: number;
+            data: string;
+        }[] | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "queue_enqueue";
+    conversationId: string;
+    item: {
+        content: string;
+        id: string;
+        attachments?: {
+            name: string;
+            mimeType: string;
+            size: number;
+            data: string;
+        }[] | undefined;
+    };
+}, {
+    type: "queue_enqueue";
+    conversationId: string;
+    item: {
+        content: string;
+        id: string;
+        attachments?: {
+            name: string;
+            mimeType: string;
+            size: number;
+            data: string;
+        }[] | undefined;
+    };
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"queue_cancel">;
+    conversationId: z.ZodString;
+    id: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "queue_cancel";
+    conversationId: string;
+    id: string;
+}, {
+    type: "queue_cancel";
+    conversationId: string;
+    id: string;
+}>]>;
+export type AnyClientMessageType = z.infer<typeof AnyClientMessage>;
+export type ClientHelloMsgType = z.infer<typeof ClientHelloMsg>;
+export type EchoMsgType = z.infer<typeof EchoMsg>;
+export type ServerEchoReplyMsgType = z.infer<typeof ServerEchoReplyMsg>;
+export type UserMessageMsgType = z.infer<typeof UserMessageMsg>;
+export type AttachmentType = z.infer<typeof AttachmentSchema>;
+export type PermissionResponseMsgType = z.infer<typeof PermissionResponseMsg>;
+export type QuestionResponseMsgType = z.infer<typeof QuestionResponseMsg>;
+export type HostStateUpdateMsgType = z.infer<typeof HostStateUpdateMsg>;
+export type HostNavigationCompleteMsgType = z.infer<typeof HostNavigationCompleteMsg>;
+export type ListConversationsMsgType = z.infer<typeof ListConversationsMsg>;
+export type DeleteConversationMsgType = z.infer<typeof DeleteConversationMsg>;
+export type SetSettingsMsgType = z.infer<typeof SetSettingsMsg>;
+export type RequestHostNavigateMsgType = z.infer<typeof RequestHostNavigateMsg>;
+export type InterruptTurnMsgType = z.infer<typeof InterruptTurnMsg>;
+export type QueuedItemType = z.infer<typeof QueuedItemSchema>;
+export type QueueEnqueueMsgType = z.infer<typeof QueueEnqueueMsg>;
+export type QueueCancelMsgType = z.infer<typeof QueueCancelMsg>;