@xpert-ai/chatkit-types 0.5.10 → 0.6.1
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 +76 -0
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -11,6 +11,12 @@ declare type ActionConfig = {
|
|
|
11
11
|
payload?: Record<string, unknown>;
|
|
12
12
|
};
|
|
13
13
|
|
|
14
|
+
export declare interface AgentPluginDiagnostic {
|
|
15
|
+
component: string;
|
|
16
|
+
code: string;
|
|
17
|
+
message: string;
|
|
18
|
+
}
|
|
19
|
+
|
|
14
20
|
declare type Alignment = 'start' | 'center' | 'end' | 'baseline' | 'stretch';
|
|
15
21
|
|
|
16
22
|
/**
|
|
@@ -382,6 +388,13 @@ export declare type ChatKitMcpAppsOptions = {
|
|
|
382
388
|
};
|
|
383
389
|
|
|
384
390
|
export declare interface ChatkitMessage {
|
|
391
|
+
createdAt?: string | Date | null;
|
|
392
|
+
updatedAt?: string | Date | null;
|
|
393
|
+
historical?: boolean;
|
|
394
|
+
branching?: {
|
|
395
|
+
available: boolean;
|
|
396
|
+
reason?: 'message_not_complete' | 'checkpoint_unavailable' | 'graph_changed' | 'state_not_supported';
|
|
397
|
+
};
|
|
385
398
|
status?: string;
|
|
386
399
|
content: TMessageItems | string;
|
|
387
400
|
reasoning?: TMessageContentReasoning[];
|
|
@@ -454,6 +467,11 @@ export declare type ChatKitOptions = {
|
|
|
454
467
|
* Message list quick navigation controls.
|
|
455
468
|
*/
|
|
456
469
|
messageNavigation?: ChatKitMessageNavigationOptions;
|
|
470
|
+
/** Message presentation only; never changes stored messages or model context. */
|
|
471
|
+
messagePresentation?: {
|
|
472
|
+
/** Collapse the process preceding each final assistant answer. Default: false. */
|
|
473
|
+
collapseProcess?: boolean;
|
|
474
|
+
};
|
|
457
475
|
/**
|
|
458
476
|
* Optional Xpert Remote Views workbench.
|
|
459
477
|
*
|
|
@@ -562,6 +580,8 @@ export declare type ChatKitOptions = {
|
|
|
562
580
|
promptsLayout?: 'cards' | 'list';
|
|
563
581
|
};
|
|
564
582
|
threadItemActions?: {
|
|
583
|
+
/** Show Branch in new chat when the server advertises a saved assistant boundary. Defaults to true. */
|
|
584
|
+
branch?: boolean;
|
|
565
585
|
/**
|
|
566
586
|
* Whether or not to show the response feedback buttons (thumbs up / thumbs
|
|
567
587
|
* down) in the response view. When the user clicks on one of the buttons, the
|
|
@@ -641,9 +661,19 @@ export declare type ChatKitOptions = {
|
|
|
641
661
|
/** Human-readable label for a locked Project scope. */
|
|
642
662
|
label?: string;
|
|
643
663
|
};
|
|
664
|
+
/** Unified conversation resource selector for plugins, middleware and experts. */
|
|
665
|
+
resources?: {
|
|
666
|
+
enabled?: boolean;
|
|
667
|
+
/** Opens the host's workspace Connector flow. Never returns credentials to ChatKit. */
|
|
668
|
+
onConnect?: WorkspaceConnectorConnectHandler;
|
|
669
|
+
};
|
|
644
670
|
/**
|
|
645
671
|
* Conversation-level Connector bindings for the current Xpert or Project.
|
|
646
672
|
* Disabled by default and ignored by custom APIs.
|
|
673
|
+
*
|
|
674
|
+
* @deprecated Prefer `composer.resources` for unified resource selection.
|
|
675
|
+
* Retained for compatibility; this option still controls native Connector
|
|
676
|
+
* capabilities until their migration to `composer.resources` is complete.
|
|
647
677
|
*/
|
|
648
678
|
connectors?: {
|
|
649
679
|
enabled?: boolean;
|
|
@@ -1949,6 +1979,39 @@ export declare type RuntimeCapabilitiesSelectionSet = {
|
|
|
1949
1979
|
};
|
|
1950
1980
|
};
|
|
1951
1981
|
|
|
1982
|
+
export declare interface RuntimeResourceCatalog {
|
|
1983
|
+
items: RuntimeResourceCatalogItem[];
|
|
1984
|
+
total: number;
|
|
1985
|
+
}
|
|
1986
|
+
|
|
1987
|
+
export declare interface RuntimeResourceCatalogItem extends RuntimeResourceReference {
|
|
1988
|
+
kind: RuntimeResourceKind;
|
|
1989
|
+
title: string;
|
|
1990
|
+
description?: LocalizedText;
|
|
1991
|
+
icon?: string;
|
|
1992
|
+
status: RuntimeResourceStatus;
|
|
1993
|
+
diagnostics: AgentPluginDiagnostic[];
|
|
1994
|
+
components: Array<{
|
|
1995
|
+
key: string;
|
|
1996
|
+
kind: 'skill' | 'mcp' | 'middleware' | 'external_xpert';
|
|
1997
|
+
status: RuntimeResourceStatus;
|
|
1998
|
+
}>;
|
|
1999
|
+
}
|
|
2000
|
+
|
|
2001
|
+
export declare type RuntimeResourceKind = 'agent_plugin' | 'middleware' | 'external_xpert';
|
|
2002
|
+
|
|
2003
|
+
export declare interface RuntimeResourceReference {
|
|
2004
|
+
bindingId: string;
|
|
2005
|
+
version: string;
|
|
2006
|
+
}
|
|
2007
|
+
|
|
2008
|
+
export declare interface RuntimeResourcesSelection {
|
|
2009
|
+
revision: number;
|
|
2010
|
+
resources: RuntimeResourceReference[];
|
|
2011
|
+
}
|
|
2012
|
+
|
|
2013
|
+
export declare type RuntimeResourceStatus = 'ready' | 'requires_auth' | 'configuration_required' | 'partial' | 'unavailable';
|
|
2014
|
+
|
|
1952
2015
|
export declare type Select = {
|
|
1953
2016
|
type: 'Select';
|
|
1954
2017
|
key?: string;
|
|
@@ -2081,6 +2144,7 @@ export declare type TChatRequestHuman = {
|
|
|
2081
2144
|
references?: ChatKitReference[];
|
|
2082
2145
|
referenceComposition?: ChatKitReferenceCompositionMode;
|
|
2083
2146
|
planMode?: boolean;
|
|
2147
|
+
runtimeResources?: RuntimeResourcesSelection;
|
|
2084
2148
|
runtimeCapabilities?: RuntimeCapabilitiesSelection;
|
|
2085
2149
|
commandSource?: ChatKitCommandSource;
|
|
2086
2150
|
[key: string]: unknown;
|
|
@@ -2706,6 +2770,18 @@ export declare type WorkflowTriggerParams = {
|
|
|
2706
2770
|
params?: Record<string, any>;
|
|
2707
2771
|
} | Record<string, any>;
|
|
2708
2772
|
|
|
2773
|
+
export declare type WorkspaceConnectorConnectHandler = (request: WorkspaceConnectorConnectRequest) => Promise<WorkspaceConnectorConnectResult>;
|
|
2774
|
+
|
|
2775
|
+
/** The host resolves the workspace and verifies configuration permission again. */
|
|
2776
|
+
export declare type WorkspaceConnectorConnectRequest = {
|
|
2777
|
+
assistantId: string;
|
|
2778
|
+
bindingId: string;
|
|
2779
|
+
};
|
|
2780
|
+
|
|
2781
|
+
export declare type WorkspaceConnectorConnectResult = {
|
|
2782
|
+
status: 'connected' | 'cancelled';
|
|
2783
|
+
};
|
|
2784
|
+
|
|
2709
2785
|
/**
|
|
2710
2786
|
* A Web Component that serves as the entry point for a ChatKit integration.
|
|
2711
2787
|
* * @noInheritDoc
|