@inkeep/agents-ui-js 0.0.0-dev-20260402200940 → 0.0.0-dev-20260403205747
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/embed.js +10 -10
- package/dist/types.d.ts +9 -116
- package/package.json +2 -2
package/dist/types.d.ts
CHANGED
|
@@ -71,7 +71,7 @@ export declare interface AIChatFunctions {
|
|
|
71
71
|
|
|
72
72
|
/**
|
|
73
73
|
* Resets the chat to its initial state.
|
|
74
|
-
* Removes all messages and resets
|
|
74
|
+
* Removes all messages and resets the chat.
|
|
75
75
|
*/
|
|
76
76
|
clearChat: () => void
|
|
77
77
|
|
|
@@ -879,9 +879,17 @@ export declare interface InkeepAIChatSettings {
|
|
|
879
879
|
/**
|
|
880
880
|
* Unique identifier for loading a specific conversation.
|
|
881
881
|
* Use this to restore a previous conversation state.
|
|
882
|
+
* If the conversation is not found, a new conversation is started.
|
|
882
883
|
*/
|
|
883
884
|
conversationId?: string
|
|
884
885
|
|
|
886
|
+
/**
|
|
887
|
+
* @deprecated Internal use only. Bypasses conversation loading and sets the
|
|
888
|
+
* conversation ID directly without fetching. Use `conversationId` instead to
|
|
889
|
+
* restore a previous conversation state.
|
|
890
|
+
*/
|
|
891
|
+
conversationIdOverride?: string
|
|
892
|
+
|
|
885
893
|
/**
|
|
886
894
|
* When enabled, prevents users from sending new messages.
|
|
887
895
|
* Useful for displaying archived or shared chat sessions.
|
|
@@ -932,17 +940,6 @@ export declare interface InkeepAIChatSettings {
|
|
|
932
940
|
*/
|
|
933
941
|
messageActions?: CustomMessageAction[]
|
|
934
942
|
|
|
935
|
-
/**
|
|
936
|
-
* Custom heading text for the workflows section.
|
|
937
|
-
* Use this to describe available automated processes or guided flows.
|
|
938
|
-
*/
|
|
939
|
-
workflowsHeader?: string
|
|
940
|
-
|
|
941
|
-
/**
|
|
942
|
-
* Collection of interactive workflows that can be triggered during chat.
|
|
943
|
-
* These can guide users through complex processes or data collection.
|
|
944
|
-
*/
|
|
945
|
-
// workflows?: Workflow[]
|
|
946
943
|
|
|
947
944
|
/**
|
|
948
945
|
* Custom labels for the chat interface's action buttons.
|
|
@@ -1456,24 +1453,6 @@ export declare type Message = UIMessage<unknown, DataParts>
|
|
|
1456
1453
|
|
|
1457
1454
|
export declare type MessageAction = 'copy' | 'upvote' | 'downvote'
|
|
1458
1455
|
|
|
1459
|
-
export declare interface MessageAttachment {
|
|
1460
|
-
contentType: MessageAttachmentContentType
|
|
1461
|
-
title: string
|
|
1462
|
-
content: string
|
|
1463
|
-
id: string
|
|
1464
|
-
context?: string[]
|
|
1465
|
-
}
|
|
1466
|
-
|
|
1467
|
-
/**
|
|
1468
|
-
* MessageAttachmentContentType represents possible type of information that can be attached to a Workflow.
|
|
1469
|
-
*/
|
|
1470
|
-
export declare type MessageAttachmentContentType = WorkflowCodeContentType | WorkflowTextContentType
|
|
1471
|
-
|
|
1472
|
-
export declare interface MessageAttributes {
|
|
1473
|
-
attachments?: MessageAttachment[]
|
|
1474
|
-
workflow?: Workflow
|
|
1475
|
-
}
|
|
1476
|
-
|
|
1477
1456
|
declare type MessageChatAction = ExpandUnion<InvokeMessageCallbackAction | OpenFormAction | OpenUrlAction>
|
|
1478
1457
|
|
|
1479
1458
|
export declare interface MessageFeedback {
|
|
@@ -1483,11 +1462,6 @@ export declare interface MessageFeedback {
|
|
|
1483
1462
|
irrelevant_citations: boolean
|
|
1484
1463
|
}
|
|
1485
1464
|
|
|
1486
|
-
export declare interface MessageMetadata {
|
|
1487
|
-
attributes?: MessageAttributes
|
|
1488
|
-
context?: string
|
|
1489
|
-
}
|
|
1490
|
-
|
|
1491
1465
|
export declare interface ModalClosedEvent {
|
|
1492
1466
|
eventName: 'modal_closed'
|
|
1493
1467
|
properties: {}
|
|
@@ -2097,87 +2071,6 @@ export declare interface WidgetView {
|
|
|
2097
2071
|
askAICardLabel?: string
|
|
2098
2072
|
}
|
|
2099
2073
|
|
|
2100
|
-
/**
|
|
2101
|
-
* Workflow defines the interaction steps for the AI bot.
|
|
2102
|
-
*/
|
|
2103
|
-
export declare interface Workflow {
|
|
2104
|
-
id: string
|
|
2105
|
-
displayName: string
|
|
2106
|
-
goals: string[]
|
|
2107
|
-
informationToCollect: WorkflowInformationToCollect[]
|
|
2108
|
-
botPersona?: string
|
|
2109
|
-
// userPersonna?: string;
|
|
2110
|
-
context?: string[]
|
|
2111
|
-
guidance?: string[]
|
|
2112
|
-
initialReplyMessage: string
|
|
2113
|
-
supportedInputs?: WorkflowInputTypes[]
|
|
2114
|
-
}
|
|
2115
|
-
|
|
2116
|
-
/**
|
|
2117
|
-
* BaseType is a base interface for data types.
|
|
2118
|
-
*/
|
|
2119
|
-
declare interface WorkflowBaseContentType {
|
|
2120
|
-
type: string
|
|
2121
|
-
contentInputLabel: string // for serialization
|
|
2122
|
-
attachmentIcon?: InkeepCustomIcon // icon next to the title in the attachment item
|
|
2123
|
-
}
|
|
2124
|
-
|
|
2125
|
-
/**
|
|
2126
|
-
* WorkflowInputType defines the type of attachments in a Workflow.
|
|
2127
|
-
*/
|
|
2128
|
-
export declare interface WorkflowBaseInputTypes {
|
|
2129
|
-
id: string
|
|
2130
|
-
type: string
|
|
2131
|
-
displayName: string // button label
|
|
2132
|
-
}
|
|
2133
|
-
|
|
2134
|
-
export declare interface WorkflowCodeContentType extends WorkflowBaseContentType {
|
|
2135
|
-
type: 'CODE'
|
|
2136
|
-
language: string
|
|
2137
|
-
}
|
|
2138
|
-
|
|
2139
|
-
/**
|
|
2140
|
-
* WorkflowFunctionalMultiInput represents a function to be called when the attachment is invoked.
|
|
2141
|
-
*/
|
|
2142
|
-
export declare interface WorkflowFunctionalMultiInput extends WorkflowBaseInputTypes {
|
|
2143
|
-
type: 'FUNCTIONAL_MULTI_ATTACHMENT'
|
|
2144
|
-
onInvoke: (
|
|
2145
|
-
workflow: Workflow,
|
|
2146
|
-
selectedInputType: WorkflowInputTypes,
|
|
2147
|
-
callback: (messageAttachments: MessageAttachment[]) => void,
|
|
2148
|
-
currentMessageAttachments: MessageAttachment[],
|
|
2149
|
-
) => void
|
|
2150
|
-
}
|
|
2151
|
-
|
|
2152
|
-
export declare interface WorkflowInformationToCollect {
|
|
2153
|
-
description: string
|
|
2154
|
-
required: boolean
|
|
2155
|
-
}
|
|
2156
|
-
|
|
2157
|
-
/**
|
|
2158
|
-
* WorkflowInputTypes represents possible ways of collecting attachments in a Workflow.
|
|
2159
|
-
*/
|
|
2160
|
-
export declare type WorkflowInputTypes = WorkflowFunctionalMultiInput | WorkflowModalSingleInput
|
|
2161
|
-
|
|
2162
|
-
export declare interface WorkflowModalProps {
|
|
2163
|
-
titleInputLabel?: string // defaults to 'Title'
|
|
2164
|
-
modalHelpText?: string // help text for the modal
|
|
2165
|
-
modalHelpElement?: React.ReactElement // help element for the modal
|
|
2166
|
-
}
|
|
2167
|
-
|
|
2168
|
-
/**
|
|
2169
|
-
* WorkflowModalSingleInput represents a modal input type.
|
|
2170
|
-
*/
|
|
2171
|
-
export declare interface WorkflowModalSingleInput extends WorkflowBaseInputTypes {
|
|
2172
|
-
type: 'MODAL'
|
|
2173
|
-
contentType: MessageAttachmentContentType
|
|
2174
|
-
workflowModalProps?: WorkflowModalProps
|
|
2175
|
-
}
|
|
2176
|
-
|
|
2177
|
-
export declare interface WorkflowTextContentType extends WorkflowBaseContentType {
|
|
2178
|
-
type: 'text'
|
|
2179
|
-
}
|
|
2180
|
-
|
|
2181
2074
|
export { }
|
|
2182
2075
|
|
|
2183
2076
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@inkeep/agents-ui-js",
|
|
3
|
-
"version": "0.0.0-dev-
|
|
3
|
+
"version": "0.0.0-dev-20260403205747",
|
|
4
4
|
"description": "",
|
|
5
5
|
"license": "Inkeep, Inc. Customer License (IICL) v1.1",
|
|
6
6
|
"homepage": "",
|
|
@@ -55,7 +55,7 @@
|
|
|
55
55
|
"vite": "5.4.11",
|
|
56
56
|
"vite-bundle-visualizer": "^1.2.1",
|
|
57
57
|
"vite-plugin-dts": "4.4.0",
|
|
58
|
-
"@inkeep/agents-ui": "0.0.0-dev-
|
|
58
|
+
"@inkeep/agents-ui": "0.0.0-dev-20260403205747"
|
|
59
59
|
},
|
|
60
60
|
"module": "./dist/embed.js",
|
|
61
61
|
"types": "./dist/types.d.ts",
|