@xpert-ai/chatkit-types 0.5.4 → 0.5.6
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/index.d.ts +51 -0
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -224,6 +224,12 @@ export declare interface ChatKitElementEventMap {
|
|
|
224
224
|
'chatkit.thread.change': CustomEvent<{
|
|
225
225
|
threadId: string | null;
|
|
226
226
|
}>;
|
|
227
|
+
'chatkit.project.change': CustomEvent<{
|
|
228
|
+
projectId: string | null;
|
|
229
|
+
}>;
|
|
230
|
+
'chatkit.connectors.change': CustomEvent<{
|
|
231
|
+
connectorBindingIds: string[];
|
|
232
|
+
}>;
|
|
227
233
|
'chatkit.log': CustomEvent<{
|
|
228
234
|
name: string;
|
|
229
235
|
data?: Record<string, unknown>;
|
|
@@ -265,6 +271,14 @@ export declare type ChatKitEvents = {
|
|
|
265
271
|
'chatkit.thread.change': CustomEvent<{
|
|
266
272
|
threadId: string | null;
|
|
267
273
|
}>;
|
|
274
|
+
/** Emitted when the user changes the active Xpert project in the composer. */
|
|
275
|
+
'chatkit.project.change': CustomEvent<{
|
|
276
|
+
projectId: string | null;
|
|
277
|
+
}>;
|
|
278
|
+
/** Emitted when the user changes the Connector bindings selected for the conversation. */
|
|
279
|
+
'chatkit.connectors.change': CustomEvent<{
|
|
280
|
+
connectorBindingIds: string[];
|
|
281
|
+
}>;
|
|
268
282
|
/** Emitted when ChatKit starts loading a thread (initial load or selected from history). */
|
|
269
283
|
'chatkit.thread.load.start': CustomEvent<{
|
|
270
284
|
threadId: string;
|
|
@@ -302,6 +316,7 @@ export declare type ChatKitGoalAdapter = {
|
|
|
302
316
|
setGoal: (params: {
|
|
303
317
|
threadId?: string | null;
|
|
304
318
|
assistantId: string;
|
|
319
|
+
projectId?: string | null;
|
|
305
320
|
objective: string;
|
|
306
321
|
runtimeCapabilities?: RuntimeCapabilitiesSelection | null;
|
|
307
322
|
signal?: AbortSignal;
|
|
@@ -599,6 +614,28 @@ export declare type ChatKitOptions = {
|
|
|
599
614
|
*/
|
|
600
615
|
accept?: Record<string, string[]>;
|
|
601
616
|
};
|
|
617
|
+
/**
|
|
618
|
+
* Project selector backed by the Xpert hosted API.
|
|
619
|
+
* Disabled by default and ignored by custom APIs.
|
|
620
|
+
*/
|
|
621
|
+
projects?: {
|
|
622
|
+
enabled?: boolean;
|
|
623
|
+
/**
|
|
624
|
+
* Show the configured Project as a fixed composer scope instead of a
|
|
625
|
+
* selector. Intended for Project-owned workbenches where the host pins
|
|
626
|
+
* every conversation to one Project.
|
|
627
|
+
*/
|
|
628
|
+
locked?: boolean;
|
|
629
|
+
/** Human-readable label for a locked Project scope. */
|
|
630
|
+
label?: string;
|
|
631
|
+
};
|
|
632
|
+
/**
|
|
633
|
+
* Conversation-level Connector bindings for the current Xpert or Project.
|
|
634
|
+
* Disabled by default and ignored by custom APIs.
|
|
635
|
+
*/
|
|
636
|
+
connectors?: {
|
|
637
|
+
enabled?: boolean;
|
|
638
|
+
};
|
|
602
639
|
/**
|
|
603
640
|
* When provided a list of tool options, the user will be able to select a tool
|
|
604
641
|
* from a menu in the composer.
|
|
@@ -1631,6 +1668,13 @@ export declare type ModelOption = {
|
|
|
1631
1668
|
label: string;
|
|
1632
1669
|
/** Optional helper text shown with the option. */
|
|
1633
1670
|
description?: string;
|
|
1671
|
+
/** Copilot model provider avatar shown in model picker clients. */
|
|
1672
|
+
avatar?: {
|
|
1673
|
+
/** Public URL for the provider's small icon. */
|
|
1674
|
+
url?: string;
|
|
1675
|
+
/** Provider-defined background color used behind transparent icons. */
|
|
1676
|
+
background?: string;
|
|
1677
|
+
};
|
|
1634
1678
|
/** When true the option is visible but cannot be selected. */
|
|
1635
1679
|
disabled?: boolean;
|
|
1636
1680
|
/** Determines if the model should be the default selected option. */
|
|
@@ -1832,6 +1876,8 @@ export declare type Row = {
|
|
|
1832
1876
|
|
|
1833
1877
|
export declare type RuntimeCapabilitiesSelection = RuntimeCapabilitiesSelectionSet & {
|
|
1834
1878
|
mode: 'allowlist';
|
|
1879
|
+
/** Keep the Xpert's normal capabilities while applying an independent selection such as Connectors. */
|
|
1880
|
+
inheritUnselected?: boolean;
|
|
1835
1881
|
recommended?: RuntimeCapabilitiesSelectionSet;
|
|
1836
1882
|
};
|
|
1837
1883
|
|
|
@@ -1846,6 +1892,9 @@ export declare type RuntimeCapabilitiesSelectionSet = {
|
|
|
1846
1892
|
subAgents?: {
|
|
1847
1893
|
nodeKeys: string[];
|
|
1848
1894
|
};
|
|
1895
|
+
connectors?: {
|
|
1896
|
+
bindingIds: string[];
|
|
1897
|
+
};
|
|
1849
1898
|
};
|
|
1850
1899
|
|
|
1851
1900
|
export declare type Select = {
|
|
@@ -1969,6 +2018,8 @@ export declare type TChatRequest = {
|
|
|
1969
2018
|
*/
|
|
1970
2019
|
export declare type TChatRequestHuman = {
|
|
1971
2020
|
input?: string;
|
|
2021
|
+
/** Opaque Assistant-scoped model id returned by the model catalog API. */
|
|
2022
|
+
model?: string;
|
|
1972
2023
|
/**
|
|
1973
2024
|
* Uploaded file handles submitted with the message. ChatKit UI now sends
|
|
1974
2025
|
* AgentFile/FileAsset-shaped objects here; raw browser File objects should be
|