@xpert-ai/chatkit-types 0.20.1 → 0.20.3
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 +23 -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,6 +416,10 @@ 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;
|
|
@@ -655,7 +662,8 @@ export declare type ChatKitOptions = {
|
|
|
655
662
|
* the host page viewport.
|
|
656
663
|
* Passing `true` enables the default built-in pet.
|
|
657
664
|
* Explicit `false` disables pets and local pet controls in chat mode,
|
|
658
|
-
* 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.
|
|
659
667
|
*
|
|
660
668
|
* @default false
|
|
661
669
|
*/
|
|
@@ -955,6 +963,10 @@ export declare type ChatKitPetOptions = {
|
|
|
955
963
|
* enabled is false. Host offline assets separately from the UI npm package.
|
|
956
964
|
*/
|
|
957
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
|
+
*/
|
|
958
970
|
enabled?: boolean;
|
|
959
971
|
character?: ChatKitPetCharacter;
|
|
960
972
|
position?: ChatKitPetPositionOptions;
|
|
@@ -1842,6 +1854,16 @@ export declare type GrayscaleOptions = {
|
|
|
1842
1854
|
shade?: -4 | -3 | -2 | -1 | 0 | 1 | 2 | 3 | 4;
|
|
1843
1855
|
};
|
|
1844
1856
|
|
|
1857
|
+
/** HTTP 400 contract shared with Xpert's ChatGroupProjectRequiredError. No message was accepted. */
|
|
1858
|
+
export declare type GroupProjectRequiredError = {
|
|
1859
|
+
statusCode: 400;
|
|
1860
|
+
error: 'Bad Request';
|
|
1861
|
+
code: 'GROUP_PROJECT_REQUIRED';
|
|
1862
|
+
message: string;
|
|
1863
|
+
groupId: string;
|
|
1864
|
+
participantIds: string[];
|
|
1865
|
+
};
|
|
1866
|
+
|
|
1845
1867
|
export declare type HeaderIcon = 'sidebar-left' | 'sidebar-right' | 'sidebar-open-left' | 'sidebar-open-right' | 'sidebar-open-left-alt' | 'sidebar-open-right-alt' | 'sidebar-floating-left' | 'sidebar-floating-right' | 'sidebar-floating-open-left' | 'sidebar-floating-open-right' | 'sidebar-collapse-left' | 'sidebar-collapse-right' | 'collapse-left' | 'collapse-right' | 'open-left' | 'open-right' | 'double-chevron-left' | 'double-chevron-right' | 'home' | 'home-alt' | 'back-small' | 'back-large' | 'expand-large' | 'collapse-large' | 'expand-small' | 'collapse-small' | 'star' | 'star-filled' | 'chat-temporary' | 'settings-cog' | 'grid' | 'dots-horizontal' | 'dots-vertical' | 'dots-horizontal-circle' | 'dots-vertical-circle' | 'menu' | 'menu-inverted' | 'hamburger' | 'compose' | 'light-mode' | 'dark-mode' | 'close';
|
|
1846
1868
|
|
|
1847
1869
|
export declare const HITL_DECISION_TYPES: readonly ["approve", "edit", "reject", "respond"];
|