@inkeep/agents-ui-js 0.15.26 → 0.15.28
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 +24 -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
|
|
|
@@ -273,6 +273,13 @@ export declare type AvailableBuiltInIcons =
|
|
|
273
273
|
| 'LuCalendar'
|
|
274
274
|
| 'LuHeadset'
|
|
275
275
|
| 'LuSend'
|
|
276
|
+
| 'LuPaperclip'
|
|
277
|
+
| 'PiFileCsv'
|
|
278
|
+
| 'PiFileText'
|
|
279
|
+
| 'PiFileHtml'
|
|
280
|
+
| 'PiFileMarkdown'
|
|
281
|
+
| 'PiFileLog'
|
|
282
|
+
| 'PiFileJson'
|
|
276
283
|
|
|
277
284
|
export declare interface BaseFormField {
|
|
278
285
|
name: string // input name -- must be unique
|
|
@@ -515,6 +522,14 @@ export declare interface CustomIcons {
|
|
|
515
522
|
chatHistory: string
|
|
516
523
|
chatHistoryPanel: string
|
|
517
524
|
backToChat: string
|
|
525
|
+
fileUpload: string
|
|
526
|
+
filePdf: string
|
|
527
|
+
fileText: string
|
|
528
|
+
fileMarkdown: string
|
|
529
|
+
fileHtml: string
|
|
530
|
+
fileCsv: string
|
|
531
|
+
fileLog: string
|
|
532
|
+
fileJson: string
|
|
518
533
|
}
|
|
519
534
|
|
|
520
535
|
export declare interface CustomMessageAction {
|
|
@@ -864,9 +879,17 @@ export declare interface InkeepAIChatSettings {
|
|
|
864
879
|
/**
|
|
865
880
|
* Unique identifier for loading a specific conversation.
|
|
866
881
|
* Use this to restore a previous conversation state.
|
|
882
|
+
* If the conversation is not found, a new conversation is started.
|
|
867
883
|
*/
|
|
868
884
|
conversationId?: string
|
|
869
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
|
+
|
|
870
893
|
/**
|
|
871
894
|
* When enabled, prevents users from sending new messages.
|
|
872
895
|
* Useful for displaying archived or shared chat sessions.
|
|
@@ -917,17 +940,6 @@ export declare interface InkeepAIChatSettings {
|
|
|
917
940
|
*/
|
|
918
941
|
messageActions?: CustomMessageAction[]
|
|
919
942
|
|
|
920
|
-
/**
|
|
921
|
-
* Custom heading text for the workflows section.
|
|
922
|
-
* Use this to describe available automated processes or guided flows.
|
|
923
|
-
*/
|
|
924
|
-
workflowsHeader?: string
|
|
925
|
-
|
|
926
|
-
/**
|
|
927
|
-
* Collection of interactive workflows that can be triggered during chat.
|
|
928
|
-
* These can guide users through complex processes or data collection.
|
|
929
|
-
*/
|
|
930
|
-
// workflows?: Workflow[]
|
|
931
943
|
|
|
932
944
|
/**
|
|
933
945
|
* Custom labels for the chat interface's action buttons.
|
|
@@ -1441,24 +1453,6 @@ export declare type Message = UIMessage<unknown, DataParts>
|
|
|
1441
1453
|
|
|
1442
1454
|
export declare type MessageAction = 'copy' | 'upvote' | 'downvote'
|
|
1443
1455
|
|
|
1444
|
-
export declare interface MessageAttachment {
|
|
1445
|
-
contentType: MessageAttachmentContentType
|
|
1446
|
-
title: string
|
|
1447
|
-
content: string
|
|
1448
|
-
id: string
|
|
1449
|
-
context?: string[]
|
|
1450
|
-
}
|
|
1451
|
-
|
|
1452
|
-
/**
|
|
1453
|
-
* MessageAttachmentContentType represents possible type of information that can be attached to a Workflow.
|
|
1454
|
-
*/
|
|
1455
|
-
export declare type MessageAttachmentContentType = WorkflowCodeContentType | WorkflowTextContentType
|
|
1456
|
-
|
|
1457
|
-
export declare interface MessageAttributes {
|
|
1458
|
-
attachments?: MessageAttachment[]
|
|
1459
|
-
workflow?: Workflow
|
|
1460
|
-
}
|
|
1461
|
-
|
|
1462
1456
|
declare type MessageChatAction = ExpandUnion<InvokeMessageCallbackAction | OpenFormAction | OpenUrlAction>
|
|
1463
1457
|
|
|
1464
1458
|
export declare interface MessageFeedback {
|
|
@@ -1468,11 +1462,6 @@ export declare interface MessageFeedback {
|
|
|
1468
1462
|
irrelevant_citations: boolean
|
|
1469
1463
|
}
|
|
1470
1464
|
|
|
1471
|
-
export declare interface MessageMetadata {
|
|
1472
|
-
attributes?: MessageAttributes
|
|
1473
|
-
context?: string
|
|
1474
|
-
}
|
|
1475
|
-
|
|
1476
1465
|
export declare interface ModalClosedEvent {
|
|
1477
1466
|
eventName: 'modal_closed'
|
|
1478
1467
|
properties: {}
|
|
@@ -2082,87 +2071,6 @@ export declare interface WidgetView {
|
|
|
2082
2071
|
askAICardLabel?: string
|
|
2083
2072
|
}
|
|
2084
2073
|
|
|
2085
|
-
/**
|
|
2086
|
-
* Workflow defines the interaction steps for the AI bot.
|
|
2087
|
-
*/
|
|
2088
|
-
export declare interface Workflow {
|
|
2089
|
-
id: string
|
|
2090
|
-
displayName: string
|
|
2091
|
-
goals: string[]
|
|
2092
|
-
informationToCollect: WorkflowInformationToCollect[]
|
|
2093
|
-
botPersona?: string
|
|
2094
|
-
// userPersonna?: string;
|
|
2095
|
-
context?: string[]
|
|
2096
|
-
guidance?: string[]
|
|
2097
|
-
initialReplyMessage: string
|
|
2098
|
-
supportedInputs?: WorkflowInputTypes[]
|
|
2099
|
-
}
|
|
2100
|
-
|
|
2101
|
-
/**
|
|
2102
|
-
* BaseType is a base interface for data types.
|
|
2103
|
-
*/
|
|
2104
|
-
declare interface WorkflowBaseContentType {
|
|
2105
|
-
type: string
|
|
2106
|
-
contentInputLabel: string // for serialization
|
|
2107
|
-
attachmentIcon?: InkeepCustomIcon // icon next to the title in the attachment item
|
|
2108
|
-
}
|
|
2109
|
-
|
|
2110
|
-
/**
|
|
2111
|
-
* WorkflowInputType defines the type of attachments in a Workflow.
|
|
2112
|
-
*/
|
|
2113
|
-
export declare interface WorkflowBaseInputTypes {
|
|
2114
|
-
id: string
|
|
2115
|
-
type: string
|
|
2116
|
-
displayName: string // button label
|
|
2117
|
-
}
|
|
2118
|
-
|
|
2119
|
-
export declare interface WorkflowCodeContentType extends WorkflowBaseContentType {
|
|
2120
|
-
type: 'CODE'
|
|
2121
|
-
language: string
|
|
2122
|
-
}
|
|
2123
|
-
|
|
2124
|
-
/**
|
|
2125
|
-
* WorkflowFunctionalMultiInput represents a function to be called when the attachment is invoked.
|
|
2126
|
-
*/
|
|
2127
|
-
export declare interface WorkflowFunctionalMultiInput extends WorkflowBaseInputTypes {
|
|
2128
|
-
type: 'FUNCTIONAL_MULTI_ATTACHMENT'
|
|
2129
|
-
onInvoke: (
|
|
2130
|
-
workflow: Workflow,
|
|
2131
|
-
selectedInputType: WorkflowInputTypes,
|
|
2132
|
-
callback: (messageAttachments: MessageAttachment[]) => void,
|
|
2133
|
-
currentMessageAttachments: MessageAttachment[],
|
|
2134
|
-
) => void
|
|
2135
|
-
}
|
|
2136
|
-
|
|
2137
|
-
export declare interface WorkflowInformationToCollect {
|
|
2138
|
-
description: string
|
|
2139
|
-
required: boolean
|
|
2140
|
-
}
|
|
2141
|
-
|
|
2142
|
-
/**
|
|
2143
|
-
* WorkflowInputTypes represents possible ways of collecting attachments in a Workflow.
|
|
2144
|
-
*/
|
|
2145
|
-
export declare type WorkflowInputTypes = WorkflowFunctionalMultiInput | WorkflowModalSingleInput
|
|
2146
|
-
|
|
2147
|
-
export declare interface WorkflowModalProps {
|
|
2148
|
-
titleInputLabel?: string // defaults to 'Title'
|
|
2149
|
-
modalHelpText?: string // help text for the modal
|
|
2150
|
-
modalHelpElement?: React.ReactElement // help element for the modal
|
|
2151
|
-
}
|
|
2152
|
-
|
|
2153
|
-
/**
|
|
2154
|
-
* WorkflowModalSingleInput represents a modal input type.
|
|
2155
|
-
*/
|
|
2156
|
-
export declare interface WorkflowModalSingleInput extends WorkflowBaseInputTypes {
|
|
2157
|
-
type: 'MODAL'
|
|
2158
|
-
contentType: MessageAttachmentContentType
|
|
2159
|
-
workflowModalProps?: WorkflowModalProps
|
|
2160
|
-
}
|
|
2161
|
-
|
|
2162
|
-
export declare interface WorkflowTextContentType extends WorkflowBaseContentType {
|
|
2163
|
-
type: 'text'
|
|
2164
|
-
}
|
|
2165
|
-
|
|
2166
2074
|
export { }
|
|
2167
2075
|
|
|
2168
2076
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@inkeep/agents-ui-js",
|
|
3
|
-
"version": "0.15.
|
|
3
|
+
"version": "0.15.28",
|
|
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.15.
|
|
58
|
+
"@inkeep/agents-ui": "0.15.28"
|
|
59
59
|
},
|
|
60
60
|
"module": "./dist/embed.js",
|
|
61
61
|
"types": "./dist/types.d.ts",
|