@xpert-ai/chatkit-types 0.3.10 → 0.3.11

package/dist/index.d.ts

@@ -261,6 +261,37 @@ export declare type ChatKitEvents = {
     }>;
 };
 
+export declare type ChatKitGoalAdapter = {
+    getGoal: (params: {
+        threadId: string;
+        signal?: AbortSignal;
+    }) => Promise<ThreadGoal | null>;
+    setGoal: (params: {
+        threadId?: string | null;
+        assistantId: string;
+        objective: string;
+        runtimeCapabilities?: RuntimeCapabilitiesSelection | null;
+        signal?: AbortSignal;
+    }) => Promise<ChatKitGoalSetResult>;
+    updateGoal: (params: {
+        threadId: string;
+        objective?: string;
+        status?: ChatKitGoalCommandStatus;
+        signal?: AbortSignal;
+    }) => Promise<ThreadGoal>;
+    clearGoal: (params: {
+        threadId: string;
+        signal?: AbortSignal;
+    }) => Promise<ThreadGoal | null>;
+};
+
+export declare type ChatKitGoalCommandStatus = Extract<ThreadGoalStatus, 'active' | 'paused'>;
+
+export declare type ChatKitGoalSetResult = {
+    threadId: string;
+    goal: ThreadGoal;
+};
+
 export declare type ChatKitI18nText = LocalizedText;
 
 export declare type ChatKitImageReference = ChatKitReferenceBase & {
@@ -305,6 +336,12 @@ export declare type ChatKitOptions = {
      * from this ChatKit instance.
      */
     request?: ChatKitRequestOptions;
+    /**
+     * Optional persistent goal adapter used by runtime `/goal` commands.
+     * When omitted, ChatKit may use a platform-specific default adapter if the
+     * active client exposes one.
+     */
+    goal?: ChatKitGoalAdapter;
     /**
      * Locale override for ChatKit UI. If not provided, the browser's locale
      * will be used. If the locale is not supported, will fall back to English.
@@ -1687,6 +1724,22 @@ declare type ThemeColor = {
     light: string;
 };
 
+export declare type ThreadGoal = {
+    id?: string;
+    conversationId?: string;
+    threadId: string;
+    objective: string;
+    status: ThreadGoalStatus;
+    tokensUsed: number;
+    elapsedSeconds: number;
+    continuationCount: number;
+    statusUpdatedAt?: string | Date | null;
+    completedAt?: string | Date | null;
+    blockedAt?: string | Date | null;
+};
+
+export declare type ThreadGoalStatus = 'active' | 'paused' | 'blocked' | 'usage_limited' | 'budget_limited' | 'complete';
+
 /**
  * Command to resume with streaming after human decision
  */
@@ -1899,6 +1952,21 @@ export declare type TThreadContextUsageMetrics = {
     currency?: string | null;
 };
 
+export declare type TThreadGoalClearedEvent = {
+    type: 'thread_goal_cleared';
+    conversationId?: string;
+    threadId: string;
+    updatedAt: string;
+};
+
+export declare type TThreadGoalUpdatedEvent = {
+    type: 'thread_goal_updated';
+    conversationId?: string;
+    threadId: string;
+    goal: ThreadGoal;
+    updatedAt: string;
+};
+
 export declare type TXpertChatInterruptPatch = Pick<TInterruptCommand, 'agentKey' | 'toolCalls' | 'update'>;
 
 export declare type TXpertChatResumeDecision = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xpert-ai/chatkit-types",
-  "version": "0.3.10",
+  "version": "0.3.11",
   "description": "Type definitions for the ChatKit.",
   "sideEffects": false,
   "type": "module",