@xpert-ai/chatkit-types 0.10.0 → 0.11.0

package/dist/index.d.ts

@@ -202,6 +202,15 @@ export declare type Button = {
     disabled?: boolean;
 };
 
+/** A persisted timeline event. It is never submitted as a model input. */
+export declare type CallEndedContent = {
+    type: 'call_ended';
+    sessionId: string;
+    startedAt: string | null;
+    endedAt: string;
+    durationSeconds: number;
+};
+
 export declare type Caption = {
     type: 'Caption';
     key?: string;
@@ -597,6 +606,8 @@ export declare type ChatKitOptions = {
      * @default false
      */
     pet?: boolean | ChatKitPetOptions;
+    /** Realtime voice controls in the assistant's appearance panel. */
+    realtimeVoice?: RealtimeVoiceOptions;
     /**
      * The ID of the thread to show when ChatKit is mounted or opened for the first time.
      * Passing `null` will show the new thread view.
@@ -1442,6 +1453,12 @@ export declare type Col = {
 
 export declare type ColorScheme = 'light' | 'dark';
 
+export declare type CompletedVoiceCall = {
+    id: string;
+    threadId: string;
+    content: CallEndedContent;
+};
+
 /** Reason codes emitted by context-compression events. */
 export declare type ContextCompressionReason = 'no_messages' | 'no_unprotected_history' | 'no_token_gain' | 'summary_invalid' | 'summary_input_budget' | 'summary_output_budget' | 'summary_work_limit' | 'summary_constraints_lost' | 'summary_service_error' | 'retry_deferred' | 'context_budget_exceeded' | 'context_validation_failed';
 
@@ -1937,6 +1954,8 @@ export declare type InterruptRequest = ToolCallRequest | ClientToolRequest | HIT
 
 export declare function isApprovalHostReference(value: unknown): value is ApprovalHostReference;
 
+export declare function isCallEndedContent(value: unknown): value is CallEndedContent;
+
 export declare function isClientToolInterrupt(value: unknown): value is ClientToolInterrupt;
 
 export declare function isClientToolInterruptPayload(value: unknown): value is ClientToolInterruptPayload;
@@ -2252,6 +2271,47 @@ export declare type RadioGroup = {
 
 declare type RadiusValue = '2xs' | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | '2xl' | '3xl' | '4xl' | 'full' | '100%' | 'none';
 
+export declare type RealtimeVoiceCall = {
+    id: string;
+    assistantId: string;
+    threadId: string | null;
+    name: string;
+    state: 'connecting' | 'listening' | 'speaking' | 'ended' | 'error';
+    muted: boolean;
+    startedAt?: string;
+    caption?: string;
+    /** Safe, localized host diagnostic; never a raw supplier error. */
+    notice?: string;
+    tasks?: {
+        id: string;
+        label: string;
+        text?: string;
+        pending?: boolean;
+    }[];
+};
+
+export declare type RealtimeVoiceCommand = {
+    type: 'start';
+    assistantId: string;
+    threadId: string | null;
+} | {
+    type: 'mute';
+    callId: string;
+    muted: boolean;
+} | {
+    type: 'interrupt' | 'end' | 'dismiss' | 'open';
+    callId: string;
+};
+
+/** The host owns audio and authentication; ChatKit owns the call surfaces. */
+export declare type RealtimeVoiceOptions = {
+    enabled: boolean;
+    call?: RealtimeVoiceCall | null;
+    /** Server-confirmed records, merged by ID until conversation history catches up. */
+    completed?: CompletedVoiceCall[];
+    onCommand: (command: RealtimeVoiceCommand) => void | Promise<void>;
+};
+
 export declare const REQUEST_USER_INPUT_RESULT_PURPOSE_IMPLEMENTATION_CONFIRMATION = "implementation_confirmation";
 
 export declare const REQUEST_USER_INPUT_RESULT_PURPOSE_PLAN_CLARIFICATION = "plan_clarification";
@@ -2853,7 +2913,7 @@ export declare type TMessageContent = string | TMessageContentComplex[];
 /**
  * Enhance {@link MessageContentComplex} in Langchain.js
  */
-export declare type TMessageContentComplex = (TMessageContentText | TMessageContentReasoning | MessageContentImageUrl | TMessageContentComponent | TMessageContentFileActivity | TMessageContentResourceCard | TMessageContentMemory | (Record<string, any> & {
+export declare type TMessageContentComplex = (CallEndedContent | TMessageContentText | TMessageContentReasoning | MessageContentImageUrl | TMessageContentComponent | TMessageContentFileActivity | TMessageContentResourceCard | TMessageContentMemory | (Record<string, any> & {
     type?: 'text' | 'image_url' | string;
 }) | (Record<string, any> & {
     type?: never;

package/dist/index.js

@@ -1110,6 +1110,9 @@ function countFileChangeLines(report) {
   }
   return { status: "ready", added: m - previous[m], removed: n - previous[m] };
 }
+function isCallEndedContent(value) {
+  return !!value && typeof value === "object" && "type" in value && value.type === "call_ended" && "sessionId" in value && typeof value.sessionId === "string" && "startedAt" in value && (value.startedAt === null || typeof value.startedAt === "string" && Number.isFinite(Date.parse(value.startedAt))) && "endedAt" in value && typeof value.endedAt === "string" && Number.isFinite(Date.parse(value.endedAt)) && "durationSeconds" in value && typeof value.durationSeconds === "number" && Number.isFinite(value.durationSeconds) && value.durationSeconds >= 0;
+}
 export {
   CHATKIT_ASSISTANT_CUSTOMIZE_EFFECT,
   CHATKIT_TASK_SUMMARY_OPEN_RESOURCE_EFFECT,
@@ -1142,6 +1145,7 @@ export {
   getMessageSkillUsages,
   getPinnedPetPosition,
   isApprovalHostReference,
+  isCallEndedContent,
   isClientToolInterrupt,
   isClientToolInterruptPayload,
   isClientToolInterruptTask,