@xpert-ai/chatkit-types 0.0.1 → 0.0.3

package/README.md

@@ -7,7 +7,7 @@ Quick local publish (interactive)
 ```bash
 cd packages/chatkit
 # (optional) generate/verify type declarations
-pnpm run types
+pnpm run build
 # increment version (optional but recommended)
 pnpm version patch
 # publish (scoped packages require --access public)

package/dist/index.d.ts

@@ -0,0 +1,205 @@
+export declare interface ChatkitMessage {
+    status?: string
+    content: TMessageItems
+    reasoning?: TMessageContentReasoning[]
+    type: 'user' | 'assistant' | 'system' | 'tool' | 'event'
+    id: string
+}
+
+/**
+ * https://js.langchain.com/docs/how_to/streaming/#event-reference
+ */
+export declare enum ChatMessageEventTypeEnum {
+    ON_CONVERSATION_START = 'on_conversation_start',
+    ON_CONVERSATION_END = 'on_conversation_end',
+    ON_MESSAGE_START = 'on_message_start',
+    ON_MESSAGE_END = 'on_message_end',
+    ON_TOOL_START = 'on_tool_start',
+    ON_TOOL_END = 'on_tool_end',
+    ON_TOOL_ERROR = 'on_tool_error',
+    /**
+     * Step message in tool call
+     */
+    ON_TOOL_MESSAGE = 'on_tool_message',
+    ON_AGENT_START = 'on_agent_start',
+    ON_AGENT_END = 'on_agent_end',
+    ON_RETRIEVER_START = 'on_retriever_start',
+    ON_RETRIEVER_END = 'on_retriever_end',
+    ON_RETRIEVER_ERROR = 'on_retriever_error',
+    ON_INTERRUPT = 'on_interrupt',
+    ON_ERROR = 'on_error',
+    ON_CHAT_EVENT = 'on_chat_event',
+}
+
+/**
+ * Category of step message: determines the display components of computer use
+ */
+export declare enum ChatMessageStepCategory {
+    /**
+     * List of items: urls, files, etc.
+     */
+    List = 'list',
+    /**
+     * Websearch results
+     */
+    WebSearch = 'web_search',
+    /**
+     * Files list
+     */
+    Files = 'files',
+    /**
+     * View a file
+     */
+    File = 'file',
+    /**
+     * Program Execution
+     */
+    Program = 'program',
+    /**
+     * Iframe
+     */
+    Iframe = 'iframe',
+
+    Memory = 'memory',
+
+    Tasks = 'tasks',
+
+    /**
+     * Knowledges (knowledge base retriever results)
+     */
+    Knowledges = 'knowledges'
+}
+
+export declare enum ChatMessageTypeEnum {
+    // LOG = 'log',
+    MESSAGE = 'message',
+    EVENT = 'event'
+}
+
+export declare type ImageDetail = "auto" | "low" | "high";
+
+export declare type MessageContentImageUrl = {
+    type: "image_url";
+    image_url: string | {
+        url: string;
+        detail?: ImageDetail;
+    };
+};
+
+export declare type MessageContentText = {
+    type: "text";
+    text: string;
+};
+
+/**
+ * Data type for chat event message
+ */
+export declare type TChatEventMessage = {
+    type?: string
+    title?: string
+    message?: string
+    status?: 'success' | 'fail' | 'running'
+    created_date?: Date | string
+    end_date?: Date | string
+    error?: string
+}
+
+/**
+ * Step message type, in canvas and ai message.
+ */
+export declare type TChatMessageStep<T = any> = TMessageComponent<TMessageComponentStep<T>>
+
+/**
+ * Defines the data type of the sub-message of `component` type in the message `content` {@link MessageContentComplex}
+ */
+export declare type TMessageComponent<T extends object = object> = T & {
+    id?: string
+    category: 'Dashboard' | 'Computer' | 'Tool'
+    type?: string
+    created_date?: Date | string
+}
+
+export declare type TMessageComponentIframe = {
+    type: 'iframe'
+    title: string
+    url?: string
+    data?: {
+        url?: string
+    }
+}
+
+export declare type TMessageComponentStep<T = unknown> = {
+    type: ChatMessageStepCategory
+    toolset: string
+    toolset_id: string
+    tool?: string
+    title: string
+    message: string
+    status: 'success' | 'fail' | 'running'
+    created_date: Date | string
+    end_date: Date | string
+    error?: string
+    data?: T
+    input?: any
+    output?: string
+    artifact?: any
+}
+
+/**
+ * Enhance {@link MessageContent} in Langchain.js
+ * 
+ * @deprecated use {@link TMessageItems} instead
+ */
+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;
+}) | (Record<string, any> & {
+    type?: never;
+})) & {
+    id?: string
+    xpertName?: string
+    agentKey?: string;
+    created_date?: Date | string
+}
+
+/**
+ * Similar to {@link MessageContentText} | {@link MessageContentImageUrl}, which together form {@link MessageContentComplex}
+ */
+export declare type TMessageContentComponent<T extends object = object> = {
+    id: string
+    type: 'component'
+    data: TMessageComponent<T>
+    xpertName?: string
+    agentKey?: string;
+}
+
+export declare type TMessageContentMemory = {
+    id?: string
+    agentKey?: string
+    type: "memory";
+    data: any[];
+};
+
+export declare type TMessageContentReasoning = {
+    id?: string
+    xpertName?: string
+    agentKey?: string
+    type: "reasoning";
+    text: string;
+};
+
+export declare type TMessageContentText = {
+    id?: string
+    xpertName?: string
+    agentKey?: string
+    type: "text";
+    text: string;
+};
+
+export declare type TMessageItems = TMessageContentComplex[];
+
+export { }

package/dist/index.js

@@ -0,0 +1,42 @@
+var ChatMessageTypeEnum = /* @__PURE__ */ ((ChatMessageTypeEnum2) => {
+  ChatMessageTypeEnum2["MESSAGE"] = "message";
+  ChatMessageTypeEnum2["EVENT"] = "event";
+  return ChatMessageTypeEnum2;
+})(ChatMessageTypeEnum || {});
+var ChatMessageEventTypeEnum = /* @__PURE__ */ ((ChatMessageEventTypeEnum2) => {
+  ChatMessageEventTypeEnum2["ON_CONVERSATION_START"] = "on_conversation_start";
+  ChatMessageEventTypeEnum2["ON_CONVERSATION_END"] = "on_conversation_end";
+  ChatMessageEventTypeEnum2["ON_MESSAGE_START"] = "on_message_start";
+  ChatMessageEventTypeEnum2["ON_MESSAGE_END"] = "on_message_end";
+  ChatMessageEventTypeEnum2["ON_TOOL_START"] = "on_tool_start";
+  ChatMessageEventTypeEnum2["ON_TOOL_END"] = "on_tool_end";
+  ChatMessageEventTypeEnum2["ON_TOOL_ERROR"] = "on_tool_error";
+  ChatMessageEventTypeEnum2["ON_TOOL_MESSAGE"] = "on_tool_message";
+  ChatMessageEventTypeEnum2["ON_AGENT_START"] = "on_agent_start";
+  ChatMessageEventTypeEnum2["ON_AGENT_END"] = "on_agent_end";
+  ChatMessageEventTypeEnum2["ON_RETRIEVER_START"] = "on_retriever_start";
+  ChatMessageEventTypeEnum2["ON_RETRIEVER_END"] = "on_retriever_end";
+  ChatMessageEventTypeEnum2["ON_RETRIEVER_ERROR"] = "on_retriever_error";
+  ChatMessageEventTypeEnum2["ON_INTERRUPT"] = "on_interrupt";
+  ChatMessageEventTypeEnum2["ON_ERROR"] = "on_error";
+  ChatMessageEventTypeEnum2["ON_CHAT_EVENT"] = "on_chat_event";
+  return ChatMessageEventTypeEnum2;
+})(ChatMessageEventTypeEnum || {});
+var ChatMessageStepCategory = /* @__PURE__ */ ((ChatMessageStepCategory2) => {
+  ChatMessageStepCategory2["List"] = "list";
+  ChatMessageStepCategory2["WebSearch"] = "web_search";
+  ChatMessageStepCategory2["Files"] = "files";
+  ChatMessageStepCategory2["File"] = "file";
+  ChatMessageStepCategory2["Program"] = "program";
+  ChatMessageStepCategory2["Iframe"] = "iframe";
+  ChatMessageStepCategory2["Memory"] = "memory";
+  ChatMessageStepCategory2["Tasks"] = "tasks";
+  ChatMessageStepCategory2["Knowledges"] = "knowledges";
+  return ChatMessageStepCategory2;
+})(ChatMessageStepCategory || {});
+export {
+  ChatMessageEventTypeEnum,
+  ChatMessageStepCategory,
+  ChatMessageTypeEnum
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":["export 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\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 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[];"],"names":["ChatMessageTypeEnum","ChatMessageEventTypeEnum","ChatMessageStepCategory"],"mappings":"AAAO,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;AAnBN,SAAAA;AAAA,GAAA,4BAAA,CAAA,CAAA;AAyBL,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;"}

package/package.json

@@ -1,23 +1,27 @@
 {
   "name": "@xpert-ai/chatkit-types",
-  "version": "0.0.1",
-  "type": "module",
+  "version": "0.0.3",
   "description": "Type definitions for the ChatKit Web Component.",
   "sideEffects": false,
-  "files": [
-    "types",
-    "README.md",
-    "index.js"
-  ],
-  "types": "./types/index.d.ts",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
+    "./package.json": "./package.json",
     ".": {
-      "types": "./types/index.d.ts",
-      "import": "./index.js",
-      "default": "./index.js"
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
     }
   },
+  "files": [
+    "dist",
+    "README.md",
+    "!**/*.tsbuildinfo"
+  ],
   "scripts": {
+    "build": "vite build",
     "types": "tsc",
     "clean": "rimraf dist"
   },
@@ -33,5 +37,9 @@
   "peerDependencies": {
     "@langchain/core": "^1.0.2",
     "@langchain/langgraph-sdk": "^1.0.0"
+  },
+  "devDependencies": {
+    "vite": "^5.0.0",
+    "vite-plugin-dts": "^3.7.0"
   }
 }

package/index.js

@@ -1 +0,0 @@
-export * from './types/index.d'

package/types/index.d.ts

@@ -1,193 +0,0 @@
-export enum ChatMessageTypeEnum {
-  // LOG = 'log',
-  MESSAGE = 'message',
-  EVENT = 'event'
-}
-
-/**
- * https://js.langchain.com/docs/how_to/streaming/#event-reference
- */
-export enum ChatMessageEventTypeEnum {
-  ON_CONVERSATION_START = 'on_conversation_start',
-  ON_CONVERSATION_END = 'on_conversation_end',
-  ON_MESSAGE_START = 'on_message_start',
-  ON_MESSAGE_END = 'on_message_end',
-  ON_TOOL_START = 'on_tool_start',
-  ON_TOOL_END = 'on_tool_end',
-  ON_TOOL_ERROR = 'on_tool_error',
-  /**
-   * Step message in tool call
-   */
-  ON_TOOL_MESSAGE = 'on_tool_message',
-  ON_AGENT_START = 'on_agent_start',
-  ON_AGENT_END = 'on_agent_end',
-  ON_RETRIEVER_START = 'on_retriever_start',
-  ON_RETRIEVER_END = 'on_retriever_end',
-  ON_RETRIEVER_ERROR = 'on_retriever_error',
-  ON_INTERRUPT = 'on_interrupt',
-  ON_ERROR = 'on_error',
-  ON_CHAT_EVENT = 'on_chat_event',
-}
-
-/**
- * Category of step message: determines the display components of computer use
- */
-export enum ChatMessageStepCategory {
-  /**
-   * List of items: urls, files, etc.
-   */
-  List = 'list',
-  /**
-   * Websearch results
-   */
-  WebSearch = 'web_search',
-  /**
-   * Files list
-   */
-  Files = 'files',
-  /**
-   * View a file
-   */
-  File = 'file',
-  /**
-   * Program Execution
-   */
-  Program = 'program',
-  /**
-   * Iframe
-   */
-  Iframe = 'iframe',
-
-  Memory = 'memory',
-
-  Tasks = 'tasks',
-
-  /**
-   * Knowledges (knowledge base retriever results)
-   */
-  Knowledges = 'knowledges'
-}
-
-/**
- * Step message type, in canvas and ai message.
- */
-export type TChatMessageStep<T = any> = TMessageComponent<TMessageComponentStep<T>>
-
-export type ImageDetail = "auto" | "low" | "high";
-export type MessageContentText = {
-    type: "text";
-    text: string;
-};
-export type MessageContentImageUrl = {
-    type: "image_url";
-    image_url: string | {
-        url: string;
-        detail?: ImageDetail;
-    };
-};
-
-/**
- * Similar to {@link MessageContentText} | {@link MessageContentImageUrl}, which together form {@link MessageContentComplex}
- */
-export type TMessageContentComponent<T extends object = object> = {
-  id: string
-  type: 'component'
-  data: TMessageComponent<T>
-  xpertName?: string
-  agentKey?: string;
-}
-
-/**
- * Defines the data type of the sub-message of `component` type in the message `content` {@link MessageContentComplex}
- */
-export type TMessageComponent<T extends object = object> = T & {
-  id?: string
-  category: 'Dashboard' | 'Computer' | 'Tool'
-  type?: string
-  created_date?: Date | string
-}
-
-export type TMessageContentText = {
-  id?: string
-  xpertName?: string
-  agentKey?: string
-  type: "text";
-  text: string;
-};
-export type TMessageContentMemory = {
-  id?: string
-  agentKey?: string
-  type: "memory";
-  data: any[];
-};
-export type TMessageContentReasoning = {
-  id?: string
-  xpertName?: string
-  agentKey?: string
-  type: "reasoning";
-  text: string;
-};
-/**
- * Enhance {@link MessageContentComplex} in Langchain.js
- */
-export type TMessageContentComplex = (TMessageContentText | TMessageContentReasoning | MessageContentImageUrl | TMessageContentComponent | TMessageContentMemory | (Record<string, any> & {
-  type?: "text" | "image_url" | string;
-}) | (Record<string, any> & {
-  type?: never;
-})) & {
-  id?: string
-  xpertName?: string
-  agentKey?: string;
-  created_date?: Date | string
-}
-/**
- * Enhance {@link MessageContent} in Langchain.js
- */
-export type TMessageContent = string | TMessageContentComplex[];
-
-export type TMessageComponentIframe = {
-  type: 'iframe'
-  title: string
-  url?: string
-  data?: {
-    url?: string
-  }
-}
-
-export type TMessageComponentStep<T = unknown> = {
-  type: ChatMessageStepCategory
-  toolset: string
-  toolset_id: string
-  tool?: string
-  title: string
-  message: string
-  status: 'success' | 'fail' | 'running'
-  created_date: Date | string
-  end_date: Date | string
-  error?: string
-  data?: T
-  input?: any
-  output?: string
-  artifact?: any
-}
-
-/**
- * Data type for chat event message
- */
-export type TChatEventMessage = {
-  type?: string
-  title?: string
-  message?: string
-  status?: 'success' | 'fail' | 'running'
-  created_date?: Date | string
-  end_date?: Date | string
-  error?: string
-}
-
-export interface ChatkitMessage {
-  status?: string
-  content: TMessageContent
-  reasoning?: TMessageContentReasoning[]
-  type: 'user' | 'assistant' | 'system' | 'tool' | 'event'
-  id: string
-}