@xpert-ai/chatkit-types 0.20.0 → 0.20.2
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 +28 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -363,6 +363,9 @@ export declare interface ChatKitElementEventMap {
|
|
|
363
363
|
'chatkit.connectors.change': CustomEvent<{
|
|
364
364
|
connectorBindingIds: string[];
|
|
365
365
|
}>;
|
|
366
|
+
'chatkit.pet.launcher.visibility.change': CustomEvent<{
|
|
367
|
+
visible: boolean;
|
|
368
|
+
}>;
|
|
366
369
|
'chatkit.log': CustomEvent<{
|
|
367
370
|
name: string;
|
|
368
371
|
data?: Record<string, unknown>;
|
|
@@ -413,13 +416,27 @@ export declare type ChatKitEvents = {
|
|
|
413
416
|
'chatkit.connectors.change': CustomEvent<{
|
|
414
417
|
connectorBindingIds: string[];
|
|
415
418
|
}>;
|
|
419
|
+
/** Emitted when the user closes or reopens the pet launcher. */
|
|
420
|
+
'chatkit.pet.launcher.visibility.change': CustomEvent<{
|
|
421
|
+
visible: boolean;
|
|
422
|
+
}>;
|
|
416
423
|
/** Emitted when ChatKit starts loading a thread (initial load or selected from history). */
|
|
417
424
|
'chatkit.thread.load.start': CustomEvent<{
|
|
418
425
|
threadId: string;
|
|
419
426
|
}>;
|
|
420
427
|
/** Emitted when ChatKit finished loading a thread. */
|
|
428
|
+
/** Metadata for the loaded branch; excludes messages, resources and execution internals. */
|
|
421
429
|
'chatkit.thread.load.end': CustomEvent<{
|
|
422
430
|
threadId: string;
|
|
431
|
+
conversation?: {
|
|
432
|
+
id: string;
|
|
433
|
+
threadId: string;
|
|
434
|
+
title?: string;
|
|
435
|
+
projectId?: string;
|
|
436
|
+
xpertId?: string;
|
|
437
|
+
from?: string;
|
|
438
|
+
status?: 'idle' | 'busy' | 'pausing' | 'paused' | 'interrupted' | 'error';
|
|
439
|
+
};
|
|
423
440
|
}>;
|
|
424
441
|
/** Diagnostic events that can be used for logging/analytics. */
|
|
425
442
|
'chatkit.log': CustomEvent<{
|
|
@@ -645,7 +662,8 @@ export declare type ChatKitOptions = {
|
|
|
645
662
|
* the host page viewport.
|
|
646
663
|
* Passing `true` enables the default built-in pet.
|
|
647
664
|
* Explicit `false` disables pets and local pet controls in chat mode,
|
|
648
|
-
* overriding saved user preferences.
|
|
665
|
+
* overriding saved user preferences. In pet display mode, omitting pet shows
|
|
666
|
+
* the launcher by default and false collapses it to the Show pet button.
|
|
649
667
|
*
|
|
650
668
|
* @default false
|
|
651
669
|
*/
|
|
@@ -696,6 +714,11 @@ export declare type ChatKitOptions = {
|
|
|
696
714
|
*/
|
|
697
715
|
header?: {
|
|
698
716
|
enabled?: boolean;
|
|
717
|
+
/** Inline avatar, title, and status block. Hidden by default; separate from the centered character. */
|
|
718
|
+
identity?: {
|
|
719
|
+
/** Show the identity block when the centered character is not displayed. Defaults to false. */
|
|
720
|
+
enabled?: boolean;
|
|
721
|
+
};
|
|
699
722
|
/** Center the published Assistant character in bubble mode. Defaults to true. */
|
|
700
723
|
character?: {
|
|
701
724
|
enabled?: boolean;
|
|
@@ -940,6 +963,10 @@ export declare type ChatKitPetOptions = {
|
|
|
940
963
|
* enabled is false. Host offline assets separately from the UI npm package.
|
|
941
964
|
*/
|
|
942
965
|
assetsBaseUrl?: string;
|
|
966
|
+
/** In pet display mode, false collapses the launcher to Show pet. Omit to
|
|
967
|
+
* start visible. Users can close and reopen the launcher. Hosts can persist
|
|
968
|
+
* those actions via `chatkit.pet.launcher.visibility.change`.
|
|
969
|
+
*/
|
|
943
970
|
enabled?: boolean;
|
|
944
971
|
character?: ChatKitPetCharacter;
|
|
945
972
|
position?: ChatKitPetPositionOptions;
|