@xpert-ai/chatkit-types 0.5.5 → 0.5.7
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 +48 -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,34 @@ 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
|
+
* Allow the user to request Project creation from the selector.
|
|
625
|
+
* Defaults to true when Project selection is enabled. Set this to false
|
|
626
|
+
* when the host only supports selecting existing Projects.
|
|
627
|
+
*/
|
|
628
|
+
createEnabled?: boolean;
|
|
629
|
+
/**
|
|
630
|
+
* Show the configured Project as a fixed composer scope instead of a
|
|
631
|
+
* selector. Intended for Project-owned workbenches where the host pins
|
|
632
|
+
* every conversation to one Project.
|
|
633
|
+
*/
|
|
634
|
+
locked?: boolean;
|
|
635
|
+
/** Human-readable label for a locked Project scope. */
|
|
636
|
+
label?: string;
|
|
637
|
+
};
|
|
638
|
+
/**
|
|
639
|
+
* Conversation-level Connector bindings for the current Xpert or Project.
|
|
640
|
+
* Disabled by default and ignored by custom APIs.
|
|
641
|
+
*/
|
|
642
|
+
connectors?: {
|
|
643
|
+
enabled?: boolean;
|
|
644
|
+
};
|
|
602
645
|
/**
|
|
603
646
|
* When provided a list of tool options, the user will be able to select a tool
|
|
604
647
|
* from a menu in the composer.
|
|
@@ -1839,6 +1882,8 @@ export declare type Row = {
|
|
|
1839
1882
|
|
|
1840
1883
|
export declare type RuntimeCapabilitiesSelection = RuntimeCapabilitiesSelectionSet & {
|
|
1841
1884
|
mode: 'allowlist';
|
|
1885
|
+
/** Keep the Xpert's normal capabilities while applying an independent selection such as Connectors. */
|
|
1886
|
+
inheritUnselected?: boolean;
|
|
1842
1887
|
recommended?: RuntimeCapabilitiesSelectionSet;
|
|
1843
1888
|
};
|
|
1844
1889
|
|
|
@@ -1853,6 +1898,9 @@ export declare type RuntimeCapabilitiesSelectionSet = {
|
|
|
1853
1898
|
subAgents?: {
|
|
1854
1899
|
nodeKeys: string[];
|
|
1855
1900
|
};
|
|
1901
|
+
connectors?: {
|
|
1902
|
+
bindingIds: string[];
|
|
1903
|
+
};
|
|
1856
1904
|
};
|
|
1857
1905
|
|
|
1858
1906
|
export declare type Select = {
|