@xpert-ai/chatkit-types 0.0.7 → 0.0.9

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,15 +1,9 @@
-# @xpert-ai/chatkit-types
+# ChatKit Types
 
-## Publishing
+This package is the type-definition library for ChatKit, providing unified, reusable API types for the ChatKit project.
 
-Quick local publish (interactive)
+## Role in the ChatKit project
 
-```bash
-cd packages/chatkit
-# (optional) generate/verify type declarations
-pnpm run build
-# increment version (optional but recommended)
-pnpm version patch
-# publish (scoped packages require --access public)
-npm publish --access public --otp=
-```
+- Exposes the interface signatures and event types of `XpertAIChatKit`, ensuring consistency between integrators and internal implementation.
+- Aggregates core chat-related types (such as `ChatKitOptions`, messages, attachments, widgets, interrupts) for reuse by the UI package and business side.
+- Serves as a standalone types package so that the ChatKit Web Component and the XpertAI platform can obtain type hints and validation without bringing in implementation code.

package/dist/index.d.ts

@@ -587,6 +587,12 @@ declare type CustomApiConfig = {
      * How attachments will be uploaded to your server. Required when attachments are enabled.
      */
     uploadStrategy?: FileUploadStrategy;
+    /**
+     * The base URL for the XpertAI platform hosted API. Used for accessing xpert agents
+     * and other platform features.
+     */
+    apiUrl: string;
+    xpertId?: string;
 };
 
 export declare type DatePicker = {
@@ -661,27 +667,6 @@ export declare type FileUploadStrategy = {
     uploadUrl: string;
 };
 
-/**
- * Filter out only the allowed options from a Playground config
- *
- * @param options - Full config copied from the playground
- * @returns An object containing only whitelisted options
- *
- * @example
- * ```ts
- * // Config copied from the playground
- * const playgroundConfig = {
- *   theme: { colorScheme: 'light', radius: 'pill' },
- *   threadItemActions: { feedback: true }, // will be filtered out
- *   startScreen: { greeting: 'Hello!' },
- * };
- *
- * const filtered = filterPlaygroundOptions(playgroundConfig);
- * // Result: { theme: { colorScheme: 'light', radius: 'pill' }, startScreen: { greeting: 'Hello!' } }
- * ```
- */
-export declare function filterPlaygroundOptions<T extends Partial<ChatKitOptions>>(options: T): PlaygroundAllowedOptions;
-
 export declare type FontObject = {
     family: string;
     src: string;
@@ -712,6 +697,12 @@ declare type HostedApiConfig = {
      * Function to get a client token or refresh if the current token is expired.
      */
     getClientSecret: (currentClientSecret: string | null) => Promise<string>;
+    /**
+     * The base URL for the XpertAI platform hosted API. Used for accessing xpert agents
+     * and other platform features.
+     */
+    apiUrl: string;
+    xpertId?: string;
 };
 
 export declare type Icon = {
@@ -853,33 +844,6 @@ export declare type Markdown = {
     streaming?: boolean;
 };
 
-/**
- * Merge Playground config with local config
- * Playground config overrides matching items in local config (whitelist only)
- *
- * @param localOptions - Base config in the local project (can include onClientTool, header, etc.)
- * @param playgroundOptions - Config copied from the playground
- * @returns Merged config
- *
- * @example
- * ```ts
- * const localConfig = {
- *   api: { getClientSecret: async () => '...' },
- *   onClientTool: async () => { ... },  // kept
- *   header: { enabled: true },          // kept
- * };
- *
- * const playgroundConfig = {
- *   theme: { colorScheme: 'dark' },
- *   threadItemActions: { feedback: true }, // filtered out
- * };
- *
- * const merged = mergeWithPlaygroundOptions(localConfig, playgroundConfig);
- * // Result: { api, onClientTool, header, theme }
- * ```
- */
-export declare function mergeWithPlaygroundOptions<T extends Partial<ChatKitOptions>>(localOptions: T, playgroundOptions: Partial<ChatKitOptions>): T & PlaygroundAllowedOptions;
-
 export declare type MessageContentImageUrl = {
     type: "image_url";
     image_url: string | {
@@ -906,20 +870,6 @@ export declare type ModelOption = {
     default?: boolean;
 };
 
-/**
- * Playground configuration whitelist - only allow these options to take effect when copied from the playground
- * Filters out: locale, initialThread, header, history, threadItemActions, disclaimer, entities, widgets, onClientTool
- */
-/**
- * Options allowed to be configured from Playground
- */
-export declare type PlaygroundAllowedOptions = {
-    api?: ChatKitOptions['api'];
-    theme?: ColorScheme | ChatKitTheme;
-    composer?: ChatKitOptions['composer'];
-    startScreen?: ChatKitOptions['startScreen'];
-};
-
 export declare type RadioGroup = {
     type: 'RadioGroup';
     key?: string;
@@ -966,6 +916,14 @@ export declare type Select = {
     disabled?: boolean;
 };
 
+export declare type SendUserMessageParams = {
+    text: string;
+    state?: Record<string, any>;
+    reply?: string;
+    attachments?: Attachment[];
+    newThread?: boolean;
+};
+
 export declare type Spacer = {
     type: 'Spacer';
     key?: string;
@@ -994,7 +952,7 @@ export declare const STATE_VARIABLE_HUMAN = "human";
  * All locales that are accepted by ChatKit without falling back to English.
  * Includes language codes that are resolved by ChatKit to a translated locale.
  */
-export declare type SupportedLocale = TranslatedLocale | 'bg' | 'bn' | 'bs' | 'ca' | 'cs' | 'da' | 'de' | 'el' | 'es' | 'et' | 'fi' | 'fr' | 'gu' | 'hi' | 'hr' | 'hu' | 'hy' | 'id' | 'is' | 'it' | 'ja' | 'ka' | 'kn' | 'ko' | 'lv' | 'mk' | 'mr' | 'ms' | 'my' | 'nb' | 'nl' | 'pl' | 'pt' | 'ro' | 'ru' | 'sk' | 'sl' | 'so' | 'sq' | 'sr' | 'sv' | 'sw' | 'ta' | 'te' | 'th' | 'tr' | 'uk' | 'vi' | 'zh' | 'zh-Hant' | 'en';
+export declare type SupportedLocale = TranslatedLocale | 'bg' | 'bn' | 'bs' | 'ca' | 'cs' | 'da' | 'de' | 'el' | 'es' | 'et' | 'fi' | 'fr' | 'gu' | 'hi' | 'hr' | 'hu' | 'hy' | 'id' | 'is' | 'it' | 'ja' | 'ka' | 'kn' | 'ko' | 'lv' | 'mk' | 'mr' | 'ms' | 'my' | 'nb' | 'nl' | 'pl' | 'pt' | 'ro' | 'ru' | 'sk' | 'sl' | 'so' | 'sq' | 'sr' | 'sv' | 'sw' | 'ta' | 'te' | 'th' | 'tr' | 'uk' | 'vi' | 'zh' | 'zh-Hans' | 'zh-CN' | 'zh-Hant' | 'en';
 
 export declare type SurfaceColors = {
     background: string;
@@ -1367,12 +1325,7 @@ export declare interface XpertAIChatKit extends HTMLElement {
      */
     itemId?: string): Promise<void>;
     /** Sends a user message. */
-    sendUserMessage(params: {
-        text: string;
-        reply?: string;
-        attachments?: Attachment[];
-        newThread?: boolean;
-    }): Promise<void>;
+    sendUserMessage(params: SendUserMessageParams): Promise<void>;
     /** Sets the composer's content without sending a message. */
     setComposerValue(params: {
         text: string;

package/dist/index.js

@@ -41,35 +41,11 @@ var ChatMessageStepCategory = /* @__PURE__ */ ((ChatMessageStepCategory2) => {
   return ChatMessageStepCategory2;
 })(ChatMessageStepCategory || {});
 const STATE_VARIABLE_HUMAN = "human";
-const ALLOWED_KEYS = [
-  "api",
-  "theme",
-  "composer",
-  "startScreen"
-];
-function filterPlaygroundOptions(options) {
-  const filtered = {};
-  for (const key of ALLOWED_KEYS) {
-    if (key in options && options[key] !== void 0) {
-      filtered[key] = options[key];
-    }
-  }
-  return filtered;
-}
-function mergeWithPlaygroundOptions(localOptions, playgroundOptions) {
-  const filteredPlayground = filterPlaygroundOptions(playgroundOptions);
-  return {
-    ...localOptions,
-    ...filteredPlayground
-  };
-}
 export {
   ChatMessageEventTypeEnum,
   ChatMessageStepCategory,
   ChatMessageTypeEnum,
   STATE_VARIABLE_HUMAN,
-  filterPlaygroundOptions,
-  isClientToolRequest,
-  mergeWithPlaygroundOptions
+  isClientToolRequest
 };
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../src/interrupt.ts","../src/message.ts","../src/filterPlaygroundOptions.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 * 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\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\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","import type { ChatKitOptions, ChatKitTheme, ColorScheme } from './options';\n\n/**\n * Playground configuration whitelist - only allow these options to take effect when copied from the playground\n * Filters out: locale, initialThread, header, history, threadItemActions, disclaimer, entities, widgets, onClientTool\n */\n\n/**\n * Options allowed to be configured from Playground\n */\nexport type PlaygroundAllowedOptions = {\n  api?: ChatKitOptions['api'];\n  theme?: ColorScheme | ChatKitTheme;\n  composer?: ChatKitOptions['composer'];\n  startScreen?: ChatKitOptions['startScreen'];\n};\n\n/**\n * Whitelist of allowed option keys\n */\nconst ALLOWED_KEYS: (keyof PlaygroundAllowedOptions)[] = [\n  'api',\n  'theme',\n  'composer',\n  'startScreen',\n];\n\n/**\n * Filter out only the allowed options from a Playground config\n *\n * @param options - Full config copied from the playground\n * @returns An object containing only whitelisted options\n *\n * @example\n * ```ts\n * // Config copied from the playground\n * const playgroundConfig = {\n *   theme: { colorScheme: 'light', radius: 'pill' },\n *   threadItemActions: { feedback: true }, // will be filtered out\n *   startScreen: { greeting: 'Hello!' },\n * };\n *\n * const filtered = filterPlaygroundOptions(playgroundConfig);\n * // Result: { theme: { colorScheme: 'light', radius: 'pill' }, startScreen: { greeting: 'Hello!' } }\n * ```\n */\nexport function filterPlaygroundOptions<T extends Partial<ChatKitOptions>>(\n  options: T\n): PlaygroundAllowedOptions {\n  const filtered: PlaygroundAllowedOptions = {};\n\n  for (const key of ALLOWED_KEYS) {\n    if (key in options && options[key] !== undefined) {\n      // @ts-expect-error - dynamic assignment\n      filtered[key] = options[key];\n    }\n  }\n\n  // fontSources is preserved - user must provide their own font URLs\n\n  return filtered;\n}\n\n/**\n * Merge Playground config with local config\n * Playground config overrides matching items in local config (whitelist only)\n *\n * @param localOptions - Base config in the local project (can include onClientTool, header, etc.)\n * @param playgroundOptions - Config copied from the playground\n * @returns Merged config\n *\n * @example\n * ```ts\n * const localConfig = {\n *   api: { getClientSecret: async () => '...' },\n *   onClientTool: async () => { ... },  // kept\n *   header: { enabled: true },          // kept\n * };\n *\n * const playgroundConfig = {\n *   theme: { colorScheme: 'dark' },\n *   threadItemActions: { feedback: true }, // filtered out\n * };\n *\n * const merged = mergeWithPlaygroundOptions(localConfig, playgroundConfig);\n * // Result: { api, onClientTool, header, theme }\n * ```\n */\nexport function mergeWithPlaygroundOptions<T extends Partial<ChatKitOptions>>(\n  localOptions: T,\n  playgroundOptions: Partial<ChatKitOptions>\n): T & PlaygroundAllowedOptions {\n  const filteredPlayground = filterPlaygroundOptions(playgroundOptions);\n\n  return {\n    ...localOptions,\n    ...filteredPlayground,\n  };\n}\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;AA2BL,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;AC1MpC,MAAM,eAAmD;AAAA,EACvD;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAqBO,SAAS,wBACd,SAC0B;AAC1B,QAAM,WAAqC,CAAA;AAE3C,aAAW,OAAO,cAAc;AAC9B,QAAI,OAAO,WAAW,QAAQ,GAAG,MAAM,QAAW;AAEhD,eAAS,GAAG,IAAI,QAAQ,GAAG;AAAA,IAC7B;AAAA,EACF;AAIA,SAAO;AACT;AA2BO,SAAS,2BACd,cACA,mBAC8B;AAC9B,QAAM,qBAAqB,wBAAwB,iBAAiB;AAEpE,SAAO;AAAA,IACL,GAAG;AAAA,IACH,GAAG;AAAA,EAAA;AAEP;"}
+{"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 * 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\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\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"],"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;AA2BL,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;"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@xpert-ai/chatkit-types",
-  "version": "0.0.7",
-  "description": "Type definitions for the ChatKit Web Component.",
+  "version": "0.0.9",
+  "description": "Type definitions for the ChatKit.",
   "sideEffects": false,
   "type": "module",
   "main": "./dist/index.js",
@@ -20,11 +20,6 @@
     "README.md",
     "!**/*.tsbuildinfo"
   ],
-  "scripts": {
-    "build": "vite build",
-    "types": "tsc",
-    "clean": "rimraf dist"
-  },
   "publishConfig": {
     "access": "public",
     "provenance": false
@@ -33,7 +28,6 @@
     "type": "git",
     "url": "https://github.com/xpert-ai/chatkit-js"
   },
-  "license": "MIT",
   "peerDependencies": {
     "@a2ui/lit": "^0.8.1",
     "@langchain/core": "^1.0.2",
@@ -42,5 +36,10 @@
   "devDependencies": {
     "vite": "^5.0.0",
     "vite-plugin-dts": "^3.7.0"
+  },
+  "scripts": {
+    "build": "vite build",
+    "types": "tsc",
+    "clean": "rimraf dist"
   }
-}
+}