@inkeep/cxkit-types 0.5.36 → 0.5.38

package/dist/index.d.ts

@@ -1,6 +1,8 @@
+import { ChatCompletionMessageToolCall } from 'openai/resources/chat/completions';
 import { ComponentType } from 'react';
 import { HTMLProps } from 'react';
 import { ReactNode } from 'react';
+import { RunnableToolFunction } from 'openai/lib/RunnableFunction';
 
 export declare interface AIChatDisclaimerSettings {
     /**
@@ -174,6 +176,21 @@ export declare interface BaseFormField {
     description?: string;
 }
 
+export declare interface BaseToolFunction<Args extends object | string> {
+    /**
+     * Function that takes the tool arguments and execution result and returns buttons
+     * that can be displayed in the chat message
+     * @param params Object containing the tool arguments and execution result
+     * @param params.args The parsed arguments passed to the tool function
+     * @param params.execution The result returned by executing the tool function
+     * @returns Array of actions that will be exposed to the user interface
+     */
+    renderMessageButtons?: (params: {
+        args: Args;
+        execution: unknown;
+    }) => ToolCallAction[];
+}
+
 declare type ChatAction = InvokeCallbackAction | OpenFormAction | OpenUrlAction;
 
 export declare type ChatActionType = ChatAction['type'];
@@ -294,7 +311,7 @@ export declare interface ConversationMessage {
     links: SourceItem[];
     properties: Record<string, unknown>;
     userProperties: Record<string, unknown>;
-    tool_calls: unknown[];
+    tool_calls: ChatCompletionMessageToolCall[] | null | undefined;
 }
 
 export declare interface ConversationResponse {
@@ -419,7 +436,7 @@ export declare interface IncludeChatSessionField extends BaseFormField {
     defaultValue?: boolean;
 }
 
-export declare interface InkeepAIChatSettings {
+export declare interface InkeepAIChatSettings extends ToolConfig {
     /**
      * The placeholder text to display in the chat input field when empty.
      * Use this to provide guidance on what kind of questions users can ask.
@@ -974,6 +991,118 @@ declare interface InvokeCallbackArgs {
     conversation: ConversationResponse;
 }
 
+export declare interface JSONSchema {
+    $id?: string | undefined;
+    $comment?: string | undefined;
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.1
+     */
+    type?: JSONSchemaTypeName | JSONSchemaTypeName[] | undefined;
+    enum?: JSONSchemaType[] | undefined;
+    const?: JSONSchemaType | undefined;
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.2
+     */
+    multipleOf?: number | undefined;
+    maximum?: number | undefined;
+    exclusiveMaximum?: number | undefined;
+    minimum?: number | undefined;
+    exclusiveMinimum?: number | undefined;
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.3
+     */
+    maxLength?: number | undefined;
+    minLength?: number | undefined;
+    pattern?: string | undefined;
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.4
+     */
+    items?: JSONSchemaDefinition | JSONSchemaDefinition[] | undefined;
+    additionalItems?: JSONSchemaDefinition | undefined;
+    maxItems?: number | undefined;
+    minItems?: number | undefined;
+    uniqueItems?: boolean | undefined;
+    contains?: JSONSchemaDefinition | undefined;
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.5
+     */
+    maxProperties?: number | undefined;
+    minProperties?: number | undefined;
+    required?: string[] | undefined;
+    properties?: {
+        [key: string]: JSONSchemaDefinition;
+    } | undefined;
+    patternProperties?: {
+        [key: string]: JSONSchemaDefinition;
+    } | undefined;
+    additionalProperties?: JSONSchemaDefinition | undefined;
+    propertyNames?: JSONSchemaDefinition | undefined;
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.6
+     */
+    if?: JSONSchemaDefinition | undefined;
+    then?: JSONSchemaDefinition | undefined;
+    else?: JSONSchemaDefinition | undefined;
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.7
+     */
+    allOf?: JSONSchemaDefinition[] | undefined;
+    anyOf?: JSONSchemaDefinition[] | undefined;
+    oneOf?: JSONSchemaDefinition[] | undefined;
+    not?: JSONSchemaDefinition | undefined;
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-7
+     */
+    format?: string | undefined;
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-10
+     */
+    title?: string | undefined;
+    description?: string | undefined;
+    default?: JSONSchemaType | undefined;
+    readOnly?: boolean | undefined;
+    writeOnly?: boolean | undefined;
+    examples?: JSONSchemaType | undefined;
+}
+
+export declare interface JSONSchemaArray extends Array<JSONSchemaType> {
+}
+
+/**
+ * JSON Schema v7
+ * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01
+ */
+export declare type JSONSchemaDefinition = JSONSchema | boolean;
+
+export declare interface JSONSchemaObject {
+    [key: string]: JSONSchemaType;
+}
+
+/**
+ * Primitive type
+ * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.1.1
+ */
+export declare type JSONSchemaType = string | number | boolean | JSONSchemaObject | JSONSchemaArray | null;
+
+/**
+ * Primitive type
+ * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.1.1
+ */
+export declare type JSONSchemaTypeName = ({} & string) | 'string' | 'number' | 'integer' | 'boolean' | 'object' | 'array' | 'null';
+
+/**
+ * Meta schema
+ *
+ * Recommended values:
+ * - 'http://json-schema.org/schema#'
+ * - 'http://json-schema.org/hyper-schema#'
+ * - 'http://json-schema.org/draft-07/schema#'
+ * - 'http://json-schema.org/draft-07/hyper-schema#'
+ *
+ * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-5
+ */
+export declare type JSONSchemaVersion = string;
+
 export declare type Message = AssistantMessage | UserMessage | SystemMessage;
 
 export declare type MessageAction = 'copy' | 'upvote' | 'downvote';
@@ -1000,6 +1129,7 @@ declare interface MessageBase {
     content: ConversationResponse['messages'][number]['content'];
     id: string;
     metadata?: MessageMetadata;
+    toolCalls?: ConversationMessage['tool_calls'];
 }
 
 export declare interface MessageFeedback {
@@ -1365,21 +1495,6 @@ declare interface TextField extends BaseFormField {
     placeholder?: string;
 }
 
-export declare interface Tool {
-    type: 'function';
-    function: {
-        name: string;
-        description: string;
-        parameters: ToolsJSONSchema | unknown;
-    };
-}
-
-export declare interface ToolCall {
-    name: string;
-    arguments: string;
-    index: number;
-}
-
 export declare interface ToolCallAction {
     label?: string;
     icon?: InkeepCustomIcon;
@@ -1388,38 +1503,18 @@ export declare interface ToolCallAction {
 
 export declare interface ToolConfig {
     /**
-     * Array of custom function tools that can be called by the AI assistant during chat interactions.
-     * Each tool must have a type (currently only 'function' is supported), a unique name, description,
-     * and a JSON Schema defining its parameters. Tools enable the AI to trigger actions in your application
-     * based on its responses, such as opening forms, links, or performing callbacks.
-     */
-    tools?: Tool[];
-    /**
-     * Callback function that handles tool calls triggered by the AI assistant.
-     * @param toolCall - Object containing the tool call details:
-     *   - name: The name of the function being called
-     *   - arguments: JSON string containing the arguments passed to the function
-     *   - index: The index of the tool call
-     * @returns A ToolCallAction object defining the action to perform (e.g., opening a link, displaying a form),
-     *          or undefined if no action should be taken
+     * Function that allows dynamic generation of tools based on the current conversation context.
+     * @param conversation - Array of messages representing the current chat conversation
+     * @returns An array of Tool objects that will be available to the AI assistant
      */
-    onToolCall?: (toolCall: ToolCall) => ToolCallAction | undefined;
+    getTools?: (ctx: ToolContext) => ToolFunction<any>[];
 }
 
-export declare type ToolsJSONSchema = {
-    type: string;
-    properties?: Record<string, unknown>;
-    items?: unknown;
-    required?: string[];
-    description?: string;
-    enum?: unknown[];
-    const?: unknown;
-    anyOf?: unknown[];
-    allOf?: unknown[];
-    oneOf?: unknown[];
-    not?: unknown;
-    [key: string]: unknown;
-};
+export declare interface ToolContext {
+    conversation: ConversationResponse;
+}
+
+export declare type ToolFunction<Args extends object | string> = RunnableToolFunction<Args> extends never ? never : RunnableToolFunction<Args> & BaseToolFunction<Args>;
 
 export declare interface TopLevelHeading {
     anchor?: string | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inkeep/cxkit-types",
-  "version": "0.5.36",
+  "version": "0.5.38",
   "description": "",
   "license": "Inkeep, Inc. Customer License (IICL) v1.1",
   "homepage": "",
@@ -25,6 +25,7 @@
     "chokidar": "4.0.3",
     "clean-package": "2.2.0",
     "globby": "14.0.2",
+    "openai": "4.78.1",
     "react": "^19.0.0",
     "typescript": "5.7.3",
     "vite": "5.4.11",