@xpert-ai/chatkit-types 0.0.17 → 0.1.1

package/dist/index.d.ts

@@ -169,6 +169,8 @@ declare type CardAction = {
     action: ActionConfig;
 };
 
+export declare const CHAT_EVENT_TYPE_FOLLOW_UP_CONSUMED: "follow_up_consumed";
+
 /**
  * Encapsulate multi-agent message events
  */
@@ -186,6 +188,15 @@ export declare type ChatKitClientSecretObject = {
 
 export declare type ChatKitClientSecretResult = string | ChatKitClientSecretObject;
 
+export declare type ChatKitCodeReference = ChatKitReferenceBase & {
+    type: 'code';
+    path: string;
+    startLine: number;
+    endLine: number;
+    language?: string;
+    taskId?: string;
+};
+
 export declare interface ChatKitElementEventMap {
     'chatkit.error': CustomEvent<{
         error: Error;
@@ -239,12 +250,27 @@ export declare type ChatKitEvents = {
     }>;
 };
 
+export declare type ChatKitImageReference = ChatKitReferenceBase & {
+    type: 'image';
+    fileId?: string;
+    url?: string;
+    mimeType?: string;
+    name?: string;
+    size?: number;
+    width?: number;
+    height?: number;
+};
+
 export declare interface ChatkitMessage {
     status?: string;
     content: TMessageItems | string;
     reasoning?: TMessageContentReasoning[];
     type: 'user' | 'assistant' | 'system' | 'tool' | 'event';
     id: string;
+    followUpMode?: FollowUpBehavior;
+    followUpStatus?: 'pending' | 'consumed' | 'canceled';
+    targetExecutionId?: string | null;
+    visibleAt?: string | Date | null;
 }
 
 export declare type ChatKitOptions = {
@@ -438,6 +464,22 @@ export declare type ChatKitOptions = {
     };
 };
 
+export declare type ChatKitQuoteReference = ChatKitReferenceBase & {
+    type: 'quote';
+    messageId?: string;
+    source?: string;
+};
+
+export declare type ChatKitReference = ChatKitCodeReference | ChatKitQuoteReference | ChatKitImageReference;
+
+export declare type ChatKitReferenceBase = {
+    id?: string;
+    label?: string;
+    text: string;
+};
+
+export declare type ChatKitReferenceCompositionMode = 'compose' | 'preserve';
+
 export declare type ChatKitRequestContext = {
     /**
      * Request-scoped runtime env overrides.
@@ -721,6 +763,8 @@ export declare type FileUploadStrategy = {
     uploadUrl: string;
 };
 
+export declare type FollowUpBehavior = 'queue' | 'steer';
+
 export declare type FontObject = {
     family: string;
     src: string;
@@ -787,7 +831,7 @@ declare type Image_2 = {
 } & BlockProps;
 export { Image_2 as Image }
 
-export declare type ImageDetail = "auto" | "low" | "high";
+export declare type ImageDetail = 'auto' | 'low' | 'high';
 
 export declare type Input = {
     type: 'Input';
@@ -901,7 +945,7 @@ export declare type Markdown = {
 };
 
 export declare type MessageContentImageUrl = {
-    type: "image_url";
+    type: 'image_url';
     image_url: string | {
         url: string;
         detail?: ImageDetail;
@@ -909,7 +953,7 @@ export declare type MessageContentImageUrl = {
 };
 
 export declare type MessageContentText = {
-    type: "text";
+    type: 'text';
     text: string;
 };
 
@@ -973,11 +1017,14 @@ export declare type Select = {
 };
 
 export declare type SendUserMessageParams = {
-    text: string;
+    text?: string;
     state?: Record<string, any>;
     reply?: string;
     attachments?: Attachment[];
     newThread?: boolean;
+    references?: ChatKitReference[];
+    referenceComposition?: ChatKitReferenceCompositionMode;
+    followUpMode?: 'default' | FollowUpBehavior;
 };
 
 export declare type Spacer = {
@@ -1053,6 +1100,7 @@ export declare type TChatRequest = {
     confirm?: boolean;
     command?: TInterruptCommand;
     retry?: boolean;
+    followUpMode?: FollowUpBehavior;
     /**
      * PRO: Sandbox Environment Id
      * PRO: @description Sandbox environment ID to force using the specified container.
@@ -1066,6 +1114,8 @@ export declare type TChatRequest = {
 export declare type TChatRequestHuman = {
     input?: string;
     files?: Partial<File>[];
+    references?: ChatKitReference[];
+    referenceComposition?: ChatKitReferenceCompositionMode;
     [key: string]: unknown;
 };
 
@@ -1128,6 +1178,15 @@ export declare type TextComponent = {
 
 declare type TextSize = 'xs' | 'sm' | 'md' | 'lg' | 'xl';
 
+export declare type TFollowUpConsumedEvent = TChatEventMessage & {
+    type: typeof CHAT_EVENT_TYPE_FOLLOW_UP_CONSUMED;
+    mode: 'queue' | 'steer';
+    messageIds: string[];
+    clientMessageIds?: string[];
+    executionId?: string | null;
+    visibleAt?: string | null;
+};
+
 declare type ThemeColor = {
     dark: string;
     light: string;
@@ -1184,7 +1243,7 @@ export declare type TMessageComponentStep<T = unknown> = {
     error?: string;
     data?: T;
     input?: any;
-    output?: string;
+    output?: unknown;
     artifact?: any;
 };
 
@@ -1214,7 +1273,7 @@ export declare type TMessageContent = string | TMessageContentComplex[];
  * Enhance {@link MessageContentComplex} in Langchain.js
  */
 export declare type TMessageContentComplex = (TMessageContentText | TMessageContentReasoning | MessageContentImageUrl | TMessageContentComponent | TMessageContentMemory | (Record<string, any> & {
-    type?: "text" | "image_url" | string;
+    type?: 'text' | 'image_url' | string;
 }) | (Record<string, any> & {
     type?: never;
 })) & {
@@ -1238,7 +1297,7 @@ export declare type TMessageContentComponent<T extends object = object> = {
 export declare type TMessageContentMemory = {
     id?: string;
     agentKey?: string;
-    type: "memory";
+    type: 'memory';
     data: any[];
 };
 
@@ -1246,7 +1305,7 @@ export declare type TMessageContentReasoning = {
     id?: string;
     xpertName?: string;
     agentKey?: string;
-    type: "reasoning";
+    type: 'reasoning';
     text: string;
 };
 
@@ -1254,7 +1313,7 @@ export declare type TMessageContentText = {
     id?: string;
     xpertName?: string;
     agentKey?: string;
-    type: "text";
+    type: 'text';
     text: string;
 };
 
@@ -1408,9 +1467,13 @@ export declare interface XpertAIChatKit extends HTMLElement {
     sendUserMessage(params: SendUserMessageParams): Promise<void>;
     /** Sets the composer's content without sending a message. */
     setComposerValue(params: {
-        text: string;
+        text?: string;
         reply?: string;
         attachments?: Attachment[];
+        references?: ChatKitReference[];
+        appendReferences?: boolean;
+        selectedToolId?: string | null;
+        selectedModelId?: string | null;
     }): Promise<void>;
     /**
      * Manually fetches updates from the server.

package/dist/index.js

@@ -41,7 +41,9 @@ var ChatMessageStepCategory = /* @__PURE__ */ ((ChatMessageStepCategory2) => {
   return ChatMessageStepCategory2;
 })(ChatMessageStepCategory || {});
 const STATE_VARIABLE_HUMAN = "human";
+const CHAT_EVENT_TYPE_FOLLOW_UP_CONSUMED = "follow_up_consumed";
 export {
+  CHAT_EVENT_TYPE_FOLLOW_UP_CONSUMED,
   ChatMessageEventTypeEnum,
   ChatMessageStepCategory,
   ChatMessageTypeEnum,

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../src/interrupt.ts","../src/message.ts"],"sourcesContent":["import { type ToolCall } from '@langchain/core/messages/tool';\n\n/**\n * When an interrupt occurs during task execution, the system generates an InterruptPayload.\n```json\n{\n  \"type\": \"event\",\n  \"event\": \"on_interrupt\",\n  \"data\": {\n    \"tasks\": [\n      {\n        \"id\": \"9c4d2ac5-8808-5b6f-855c-4d48aa3d77a7\",\n        \"name\": \"Middleware_wPzR2bIXqE_after_model\",\n        \"path\": [\"__pregel_pull\", \"Middleware_wPzR2bIXqE_after_model\"],\n        \"interrupts\": [\n          {\n            \"id\": \"b42f7887d65e57ed11cf08b8927763db\",\n            \"value\": {\n              \"toolCalls\": [\n                {\n                  \"name\": \"getUserStation\",\n                  \"args\": {\n                    \"input\": \"Query the site selected by the user\"\n                  },\n                  \"id\": \"call_00_swcaUjIaACXOHHaZyNmQB3Vm\",\n                  \"type\": \"tool_call\"\n                }\n              ]\n            }\n          }\n        ]\n      }\n    ]\n  }\n}\n```\n */\nexport interface InterruptPayload {\n  tasks: Array<{\n    id: string;\n    name: string;\n    path: string[];\n    interrupts: Array<{\n      id: string;\n      value: ClientToolRequest\n    }>;\n  }>;\n}\n\nexport interface ClientToolRequest {\n  clientToolCalls: ToolCall[];\n}\n\nexport interface ClientToolMessageInput {\n  content: unknown\n  name?: string\n  tool_call_id?: string\n  status?: 'success' | 'error'\n  artifact?: unknown\n}\n\nexport interface ClientToolResponse {\n  toolMessages: ClientToolMessageInput[]\n}\n\nexport function isClientToolRequest(value: any): value is ClientToolRequest {\n  return (\n    value &&\n    Array.isArray(value.clientToolCalls)\n  );\n}","import type { ToolCall } from \"@langchain/core/messages/tool\";\nimport { Types } from '@a2ui/lit/0.8';\n\nexport enum ChatMessageTypeEnum {\n  // LOG = 'log',\n  MESSAGE = 'message',\n  EVENT = 'event'\n}\n\n/**\n * https://js.langchain.com/docs/how_to/streaming/#event-reference\n */\nexport enum ChatMessageEventTypeEnum {\n  ON_CONVERSATION_START = 'on_conversation_start',\n  ON_CONVERSATION_END = 'on_conversation_end',\n  ON_MESSAGE_START = 'on_message_start',\n  ON_MESSAGE_END = 'on_message_end',\n  ON_TOOL_START = 'on_tool_start',\n  ON_TOOL_END = 'on_tool_end',\n  ON_TOOL_ERROR = 'on_tool_error',\n  /**\n   * Step message in tool call\n   */\n  ON_TOOL_MESSAGE = 'on_tool_message',\n  ON_AGENT_START = 'on_agent_start',\n  ON_AGENT_END = 'on_agent_end',\n  ON_RETRIEVER_START = 'on_retriever_start',\n  ON_RETRIEVER_END = 'on_retriever_end',\n  ON_RETRIEVER_ERROR = 'on_retriever_error',\n  ON_INTERRUPT = 'on_interrupt',\n  ON_ERROR = 'on_error',\n  ON_CHAT_EVENT = 'on_chat_event',\n\n  ON_CLIENT_EFFECT = 'on_client_effect',\n}\n\n/**\n * Encapsulate multi-agent message events\n */\nexport interface ChatEventEnvelope<T = unknown> {\n  type: ChatMessageTypeEnum\n  event?: ChatMessageEventTypeEnum\n  tags: string[]\n\tdata: T\n}\n\n/**\n * Category of step message: determines the display components of computer use\n */\nexport enum ChatMessageStepCategory {\n  /**\n   * List of items: urls, files, etc.\n   */\n  List = 'list',\n  /**\n   * Websearch results\n   */\n  WebSearch = 'web_search',\n  /**\n   * Files list\n   */\n  Files = 'files',\n  /**\n   * View a file\n   */\n  File = 'file',\n  /**\n   * Program Execution\n   */\n  Program = 'program',\n  /**\n   * Iframe\n   */\n  Iframe = 'iframe',\n\n  Memory = 'memory',\n\n  Tasks = 'tasks',\n\n  /**\n   * Knowledges (knowledge base retriever results)\n   */\n  Knowledges = 'knowledges'\n}\n\n/**\n * Step message type, in canvas and ai message.\n */\nexport type TChatMessageStep<T = any> = TMessageComponent<TMessageComponentStep<T>>\n\nexport type ImageDetail = \"auto\" | \"low\" | \"high\";\nexport type MessageContentText = {\n    type: \"text\";\n    text: string;\n};\nexport type MessageContentImageUrl = {\n    type: \"image_url\";\n    image_url: string | {\n        url: string;\n        detail?: ImageDetail;\n    };\n};\n\n/**\n * Similar to {@link MessageContentText} | {@link MessageContentImageUrl}, which together form {@link MessageContentComplex}\n */\nexport type TMessageContentComponent<T extends object = object> = {\n  id: string\n  type: 'component'\n  data: TMessageComponent<T>\n  xpertName?: string\n  agentKey?: string;\n}\n\n/**\n * Defines the data type of the sub-message of `component` type in the message `content` {@link MessageContentComplex}\n */\nexport type TMessageComponent<T extends object = object> = T & {\n  id?: string\n  category: 'Dashboard' | 'Computer' | 'Tool'\n  type?: string\n  created_date?: Date | string\n}\n\nexport type TMessageComponentWidgetItem = {\n  name: string\n  config: Types.Surface\n  values?: Record<string, unknown>\n}\n\nexport type TMessageComponentWidgetData = {\n  type: 'Widget'\n  mode?: string\n  widgets: TMessageComponentWidgetItem[]\n  executionId?: string\n}\n\nexport type TMessageComponentWidget = TMessageComponent<TMessageComponentWidgetData>\n\nexport type TMessageContentWidget = TMessageContentComponent<TMessageComponentWidgetData>\n\nexport type TMessageContentText = {\n  id?: string\n  xpertName?: string\n  agentKey?: string\n  type: \"text\";\n  text: string;\n};\nexport type TMessageContentMemory = {\n  id?: string\n  agentKey?: string\n  type: \"memory\";\n  data: any[];\n};\nexport type TMessageContentReasoning = {\n  id?: string\n  xpertName?: string\n  agentKey?: string\n  type: \"reasoning\";\n  text: string;\n};\n/**\n * Enhance {@link MessageContentComplex} in Langchain.js\n */\nexport type TMessageContentComplex = (TMessageContentText | TMessageContentReasoning | MessageContentImageUrl | TMessageContentComponent | TMessageContentMemory | (Record<string, any> & {\n  type?: \"text\" | \"image_url\" | string;\n}) | (Record<string, any> & {\n  type?: never;\n})) & {\n  id?: string\n  xpertName?: string\n  agentKey?: string;\n  created_date?: Date | string\n}\n\n/**\n * Enhance {@link MessageContent} in Langchain.js\n * \n * @deprecated use {@link TMessageItems} instead\n */\nexport type TMessageContent = string | TMessageContentComplex[];\n\nexport type TMessageComponentIframe = {\n  type: 'iframe'\n  title: string\n  url?: string\n  data?: {\n    url?: string\n  }\n}\n\nexport type TMessageComponentStep<T = unknown> = {\n  type: ChatMessageStepCategory\n  toolset: string\n  toolset_id: string\n  tool?: string\n  title: string\n  message: string\n  status: 'success' | 'fail' | 'running'\n  created_date: Date | string\n  end_date: Date | string\n  error?: string\n  data?: T\n  input?: any\n  output?: string\n  artifact?: any\n}\n\n/**\n * Data type for chat event message\n */\nexport type TChatEventMessage = {\n  type?: string\n  title?: string\n  message?: string\n  status?: 'success' | 'fail' | 'running'\n  created_date?: Date | string\n  end_date?: Date | string\n  error?: string\n}\n\nexport interface ChatkitMessage {\n  status?: string\n  content: TMessageItems | string\n  reasoning?: TMessageContentReasoning[]\n  type: 'user' | 'assistant' | 'system' | 'tool' | 'event'\n  id: string\n}\n\nexport type TMessageItems = TMessageContentComplex[];\n\n\nexport const STATE_VARIABLE_HUMAN = 'human'\n\n/**\n * Human input message, include parameters and attachments\n */\nexport type TChatRequestHuman = {\n  input?: string\n  files?: Partial<File>[]\n  [key: string]: unknown\n}\n\n/**\n * Command to resume with streaming after human decision\n */\nexport type TInterruptCommand = {\n  resume?: any\n  update?: any\n  toolCalls?: ToolCall[]\n  agentKey?: string\n}\n\nexport type TChatRequest = {\n  /**\n   * The human input, include parameters\n   */\n  input: TChatRequestHuman\n  /**\n   * Custom graph state\n   */\n  state?: {[STATE_VARIABLE_HUMAN]: TChatRequestHuman} & Record<string, any>\n  agentKey?: string\n  projectId?: string\n  conversationId?: string\n  environmentId?: string\n  id?: string\n  executionId?: string\n  confirm?: boolean\n  command?: TInterruptCommand\n  retry?: boolean\n  /**\n   * PRO: Sandbox Environment Id\n   * PRO: @description Sandbox environment ID to force using the specified container.\n   */\n  sandboxEnvironmentId?: string;\n}\n\n/**\n * Data type for client effect message\n */\nexport type TClientEeffectMessage = {\n  name: string\n  args: Record<string, any>\n  tool_call_id?: string\n  agentKey?: string;\n  created_date?: Date | string\n}\n\n// Thread context usage\nexport type TThreadContextUsageMetrics = {\n  contextTokens: number\n  inputTokens: number\n  outputTokens: number\n  totalTokens: number\n  embedTokens?: number\n  totalPrice?: number\n  currency?: string | null\n}\n\nexport type TThreadContextUsageEvent = {\n  type: 'thread_context_usage'\n  threadId: string\n  runId: string | null\n  agentKey: string\n  updatedAt: string\n  usage: TThreadContextUsageMetrics\n}"],"names":["ChatMessageTypeEnum","ChatMessageEventTypeEnum","ChatMessageStepCategory"],"mappings":";;AAiEO,SAAS,oBAAoB,OAAwC;AAC1E,SACE,SACA,MAAM,QAAQ,MAAM,eAAe;AAEvC;ACnEO,IAAK,wCAAAA,yBAAL;AAELA,uBAAA,SAAA,IAAU;AACVA,uBAAA,OAAA,IAAQ;AAHE,SAAAA;AAAA,GAAA,uBAAA,CAAA,CAAA;AASL,IAAK,6CAAAC,8BAAL;AACLA,4BAAA,uBAAA,IAAwB;AACxBA,4BAAA,qBAAA,IAAsB;AACtBA,4BAAA,kBAAA,IAAmB;AACnBA,4BAAA,gBAAA,IAAiB;AACjBA,4BAAA,eAAA,IAAgB;AAChBA,4BAAA,aAAA,IAAc;AACdA,4BAAA,eAAA,IAAgB;AAIhBA,4BAAA,iBAAA,IAAkB;AAClBA,4BAAA,gBAAA,IAAiB;AACjBA,4BAAA,cAAA,IAAe;AACfA,4BAAA,oBAAA,IAAqB;AACrBA,4BAAA,kBAAA,IAAmB;AACnBA,4BAAA,oBAAA,IAAqB;AACrBA,4BAAA,cAAA,IAAe;AACfA,4BAAA,UAAA,IAAW;AACXA,4BAAA,eAAA,IAAgB;AAEhBA,4BAAA,kBAAA,IAAmB;AArBT,SAAAA;AAAA,GAAA,4BAAA,CAAA,CAAA;AAqCL,IAAK,4CAAAC,6BAAL;AAILA,2BAAA,MAAA,IAAO;AAIPA,2BAAA,WAAA,IAAY;AAIZA,2BAAA,OAAA,IAAQ;AAIRA,2BAAA,MAAA,IAAO;AAIPA,2BAAA,SAAA,IAAU;AAIVA,2BAAA,QAAA,IAAS;AAETA,2BAAA,QAAA,IAAS;AAETA,2BAAA,OAAA,IAAQ;AAKRA,2BAAA,YAAA,IAAa;AAjCH,SAAAA;AAAA,GAAA,2BAAA,CAAA,CAAA;AAuLL,MAAM,uBAAuB;"}
+{"version":3,"file":"index.js","sources":["../src/interrupt.ts","../src/message.ts"],"sourcesContent":["import { type ToolCall } from '@langchain/core/messages/tool';\n\n/**\n * When an interrupt occurs during task execution, the system generates an InterruptPayload.\n```json\n{\n  \"type\": \"event\",\n  \"event\": \"on_interrupt\",\n  \"data\": {\n    \"tasks\": [\n      {\n        \"id\": \"9c4d2ac5-8808-5b6f-855c-4d48aa3d77a7\",\n        \"name\": \"Middleware_wPzR2bIXqE_after_model\",\n        \"path\": [\"__pregel_pull\", \"Middleware_wPzR2bIXqE_after_model\"],\n        \"interrupts\": [\n          {\n            \"id\": \"b42f7887d65e57ed11cf08b8927763db\",\n            \"value\": {\n              \"toolCalls\": [\n                {\n                  \"name\": \"getUserStation\",\n                  \"args\": {\n                    \"input\": \"Query the site selected by the user\"\n                  },\n                  \"id\": \"call_00_swcaUjIaACXOHHaZyNmQB3Vm\",\n                  \"type\": \"tool_call\"\n                }\n              ]\n            }\n          }\n        ]\n      }\n    ]\n  }\n}\n```\n */\nexport interface InterruptPayload {\n  tasks: Array<{\n    id: string;\n    name: string;\n    path: string[];\n    interrupts: Array<{\n      id: string;\n      value: ClientToolRequest\n    }>;\n  }>;\n}\n\nexport interface ClientToolRequest {\n  clientToolCalls: ToolCall[];\n}\n\nexport interface ClientToolMessageInput {\n  content: unknown\n  name?: string\n  tool_call_id?: string\n  status?: 'success' | 'error'\n  artifact?: unknown\n}\n\nexport interface ClientToolResponse {\n  toolMessages: ClientToolMessageInput[]\n}\n\nexport function isClientToolRequest(value: any): value is ClientToolRequest {\n  return (\n    value &&\n    Array.isArray(value.clientToolCalls)\n  );\n}","import type { ToolCall } from '@langchain/core/messages/tool';\nimport { Types } from '@a2ui/lit/0.8';\nimport type { FollowUpBehavior } from './options';\n\nexport enum ChatMessageTypeEnum {\n  // LOG = 'log',\n  MESSAGE = 'message',\n  EVENT = 'event',\n}\n\n/**\n * https://js.langchain.com/docs/how_to/streaming/#event-reference\n */\nexport enum ChatMessageEventTypeEnum {\n  ON_CONVERSATION_START = 'on_conversation_start',\n  ON_CONVERSATION_END = 'on_conversation_end',\n  ON_MESSAGE_START = 'on_message_start',\n  ON_MESSAGE_END = 'on_message_end',\n  ON_TOOL_START = 'on_tool_start',\n  ON_TOOL_END = 'on_tool_end',\n  ON_TOOL_ERROR = 'on_tool_error',\n  /**\n   * Step message in tool call\n   */\n  ON_TOOL_MESSAGE = 'on_tool_message',\n  ON_AGENT_START = 'on_agent_start',\n  ON_AGENT_END = 'on_agent_end',\n  ON_RETRIEVER_START = 'on_retriever_start',\n  ON_RETRIEVER_END = 'on_retriever_end',\n  ON_RETRIEVER_ERROR = 'on_retriever_error',\n  ON_INTERRUPT = 'on_interrupt',\n  ON_ERROR = 'on_error',\n  ON_CHAT_EVENT = 'on_chat_event',\n\n  ON_CLIENT_EFFECT = 'on_client_effect',\n}\n\n/**\n * Encapsulate multi-agent message events\n */\nexport interface ChatEventEnvelope<T = unknown> {\n  type: ChatMessageTypeEnum;\n  event?: ChatMessageEventTypeEnum;\n  tags: string[];\n  data: T;\n}\n\n/**\n * Category of step message: determines the display components of computer use\n */\nexport enum ChatMessageStepCategory {\n  /**\n   * List of items: urls, files, etc.\n   */\n  List = 'list',\n  /**\n   * Websearch results\n   */\n  WebSearch = 'web_search',\n  /**\n   * Files list\n   */\n  Files = 'files',\n  /**\n   * View a file\n   */\n  File = 'file',\n  /**\n   * Program Execution\n   */\n  Program = 'program',\n  /**\n   * Iframe\n   */\n  Iframe = 'iframe',\n\n  Memory = 'memory',\n\n  Tasks = 'tasks',\n\n  /**\n   * Knowledges (knowledge base retriever results)\n   */\n  Knowledges = 'knowledges',\n}\n\n/**\n * Step message type, in canvas and ai message.\n */\nexport type TChatMessageStep<T = any> = TMessageComponent<\n  TMessageComponentStep<T>\n>;\n\nexport type ImageDetail = 'auto' | 'low' | 'high';\nexport type MessageContentText = {\n  type: 'text';\n  text: string;\n};\nexport type MessageContentImageUrl = {\n  type: 'image_url';\n  image_url:\n    | string\n    | {\n        url: string;\n        detail?: ImageDetail;\n      };\n};\n\n/**\n * Similar to {@link MessageContentText} | {@link MessageContentImageUrl}, which together form {@link MessageContentComplex}\n */\nexport type TMessageContentComponent<T extends object = object> = {\n  id: string;\n  type: 'component';\n  data: TMessageComponent<T>;\n  xpertName?: string;\n  agentKey?: string;\n};\n\n/**\n * Defines the data type of the sub-message of `component` type in the message `content` {@link MessageContentComplex}\n */\nexport type TMessageComponent<T extends object = object> = T & {\n  id?: string;\n  category: 'Dashboard' | 'Computer' | 'Tool';\n  type?: string;\n  created_date?: Date | string;\n};\n\nexport type TMessageComponentWidgetItem = {\n  name: string;\n  config: Types.Surface;\n  values?: Record<string, unknown>;\n};\n\nexport type TMessageComponentWidgetData = {\n  type: 'Widget';\n  mode?: string;\n  widgets: TMessageComponentWidgetItem[];\n  executionId?: string;\n};\n\nexport type TMessageComponentWidget =\n  TMessageComponent<TMessageComponentWidgetData>;\n\nexport type TMessageContentWidget =\n  TMessageContentComponent<TMessageComponentWidgetData>;\n\nexport type TMessageContentText = {\n  id?: string;\n  xpertName?: string;\n  agentKey?: string;\n  type: 'text';\n  text: string;\n};\nexport type TMessageContentMemory = {\n  id?: string;\n  agentKey?: string;\n  type: 'memory';\n  data: any[];\n};\nexport type TMessageContentReasoning = {\n  id?: string;\n  xpertName?: string;\n  agentKey?: string;\n  type: 'reasoning';\n  text: string;\n};\n/**\n * Enhance {@link MessageContentComplex} in Langchain.js\n */\nexport type TMessageContentComplex = (\n  | TMessageContentText\n  | TMessageContentReasoning\n  | MessageContentImageUrl\n  | TMessageContentComponent\n  | TMessageContentMemory\n  | (Record<string, any> & {\n      type?: 'text' | 'image_url' | string;\n    })\n  | (Record<string, any> & {\n      type?: never;\n    })\n) & {\n  id?: string;\n  xpertName?: string;\n  agentKey?: string;\n  created_date?: Date | string;\n};\n\n/**\n * Enhance {@link MessageContent} in Langchain.js\n *\n * @deprecated use {@link TMessageItems} instead\n */\nexport type TMessageContent = string | TMessageContentComplex[];\n\nexport type TMessageComponentIframe = {\n  type: 'iframe';\n  title: string;\n  url?: string;\n  data?: {\n    url?: string;\n  };\n};\n\nexport type TMessageComponentStep<T = unknown> = {\n  type: ChatMessageStepCategory;\n  toolset: string;\n  toolset_id: string;\n  tool?: string;\n  title: string;\n  message: string;\n  status: 'success' | 'fail' | 'running';\n  created_date: Date | string;\n  end_date: Date | string;\n  error?: string;\n  data?: T;\n  input?: any;\n  output?: unknown;\n  artifact?: any;\n};\n\n/**\n * Data type for chat event message\n */\nexport type TChatEventMessage = {\n  type?: string;\n  title?: string;\n  message?: string;\n  status?: 'success' | 'fail' | 'running';\n  created_date?: Date | string;\n  end_date?: Date | string;\n  error?: string;\n};\n\nexport interface ChatkitMessage {\n  status?: string;\n  content: TMessageItems | string;\n  reasoning?: TMessageContentReasoning[];\n  type: 'user' | 'assistant' | 'system' | 'tool' | 'event';\n  id: string;\n  followUpMode?: FollowUpBehavior;\n  followUpStatus?: 'pending' | 'consumed' | 'canceled';\n  targetExecutionId?: string | null;\n  visibleAt?: string | Date | null;\n}\n\nexport type TMessageItems = TMessageContentComplex[];\n\nexport type ChatKitReferenceBase = {\n  id?: string;\n  label?: string;\n  text: string;\n};\n\nexport type ChatKitCodeReference = ChatKitReferenceBase & {\n  type: 'code';\n  path: string;\n  startLine: number;\n  endLine: number;\n  language?: string;\n  taskId?: string;\n};\n\nexport type ChatKitQuoteReference = ChatKitReferenceBase & {\n  type: 'quote';\n  messageId?: string;\n  source?: string;\n};\n\nexport type ChatKitImageReference = ChatKitReferenceBase & {\n  type: 'image';\n  fileId?: string;\n  url?: string;\n  mimeType?: string;\n  name?: string;\n  size?: number;\n  width?: number;\n  height?: number;\n};\n\nexport type ChatKitReference =\n  | ChatKitCodeReference\n  | ChatKitQuoteReference\n  | ChatKitImageReference;\n\nexport type ChatKitReferenceCompositionMode = 'compose' | 'preserve';\n\nexport const STATE_VARIABLE_HUMAN = 'human';\n\n/**\n * Human input message, include parameters and attachments\n */\nexport type TChatRequestHuman = {\n  input?: string;\n  files?: Partial<File>[];\n  references?: ChatKitReference[];\n  referenceComposition?: ChatKitReferenceCompositionMode;\n  [key: string]: unknown;\n};\n\n/**\n * Command to resume with streaming after human decision\n */\nexport type TInterruptCommand = {\n  resume?: any;\n  update?: any;\n  toolCalls?: ToolCall[];\n  agentKey?: string;\n};\n\nexport type TChatRequest = {\n  /**\n   * The human input, include parameters\n   */\n  input: TChatRequestHuman;\n  /**\n   * Custom graph state\n   */\n  state?: { [STATE_VARIABLE_HUMAN]: TChatRequestHuman } & Record<string, any>;\n  agentKey?: string;\n  projectId?: string;\n  conversationId?: string;\n  environmentId?: string;\n  id?: string;\n  executionId?: string;\n  confirm?: boolean;\n  command?: TInterruptCommand;\n  retry?: boolean;\n  followUpMode?: FollowUpBehavior;\n  /**\n   * PRO: Sandbox Environment Id\n   * PRO: @description Sandbox environment ID to force using the specified container.\n   */\n  sandboxEnvironmentId?: string;\n};\n\n/**\n * Data type for client effect message\n */\nexport type TClientEeffectMessage = {\n  name: string;\n  args: Record<string, any>;\n  tool_call_id?: string;\n  agentKey?: string;\n  created_date?: Date | string;\n};\n\n// Thread context usage\nexport type TThreadContextUsageMetrics = {\n  contextTokens: number;\n  inputTokens: number;\n  outputTokens: number;\n  totalTokens: number;\n  embedTokens?: number;\n  totalPrice?: number;\n  currency?: string | null;\n};\n\nexport type TThreadContextUsageEvent = {\n  type: 'thread_context_usage';\n  threadId: string;\n  runId: string | null;\n  agentKey: string;\n  updatedAt: string;\n  usage: TThreadContextUsageMetrics;\n};\n\nexport const CHAT_EVENT_TYPE_FOLLOW_UP_CONSUMED = 'follow_up_consumed' as const;\n\nexport type TFollowUpConsumedEvent = TChatEventMessage & {\n  type: typeof CHAT_EVENT_TYPE_FOLLOW_UP_CONSUMED;\n  mode: 'queue' | 'steer';\n  messageIds: string[];\n  clientMessageIds?: string[];\n  executionId?: string | null;\n  visibleAt?: string | null;\n};\n"],"names":["ChatMessageTypeEnum","ChatMessageEventTypeEnum","ChatMessageStepCategory"],"mappings":";;AAiEO,SAAS,oBAAoB,OAAwC;AAC1E,SACE,SACA,MAAM,QAAQ,MAAM,eAAe;AAEvC;AClEO,IAAK,wCAAAA,yBAAL;AAELA,uBAAA,SAAA,IAAU;AACVA,uBAAA,OAAA,IAAQ;AAHE,SAAAA;AAAA,GAAA,uBAAA,CAAA,CAAA;AASL,IAAK,6CAAAC,8BAAL;AACLA,4BAAA,uBAAA,IAAwB;AACxBA,4BAAA,qBAAA,IAAsB;AACtBA,4BAAA,kBAAA,IAAmB;AACnBA,4BAAA,gBAAA,IAAiB;AACjBA,4BAAA,eAAA,IAAgB;AAChBA,4BAAA,aAAA,IAAc;AACdA,4BAAA,eAAA,IAAgB;AAIhBA,4BAAA,iBAAA,IAAkB;AAClBA,4BAAA,gBAAA,IAAiB;AACjBA,4BAAA,cAAA,IAAe;AACfA,4BAAA,oBAAA,IAAqB;AACrBA,4BAAA,kBAAA,IAAmB;AACnBA,4BAAA,oBAAA,IAAqB;AACrBA,4BAAA,cAAA,IAAe;AACfA,4BAAA,UAAA,IAAW;AACXA,4BAAA,eAAA,IAAgB;AAEhBA,4BAAA,kBAAA,IAAmB;AArBT,SAAAA;AAAA,GAAA,4BAAA,CAAA,CAAA;AAqCL,IAAK,4CAAAC,6BAAL;AAILA,2BAAA,MAAA,IAAO;AAIPA,2BAAA,WAAA,IAAY;AAIZA,2BAAA,OAAA,IAAQ;AAIRA,2BAAA,MAAA,IAAO;AAIPA,2BAAA,SAAA,IAAU;AAIVA,2BAAA,QAAA,IAAS;AAETA,2BAAA,QAAA,IAAS;AAETA,2BAAA,OAAA,IAAQ;AAKRA,2BAAA,YAAA,IAAa;AAjCH,SAAAA;AAAA,GAAA,2BAAA,CAAA,CAAA;AA+OL,MAAM,uBAAuB;AAgF7B,MAAM,qCAAqC;"}

package/package.json

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