@xpert-ai/chatkit-types 0.5.9 → 0.6.0
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 +66 -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
|
/**
|
|
@@ -641,9 +647,19 @@ export declare type ChatKitOptions = {
|
|
|
641
647
|
/** Human-readable label for a locked Project scope. */
|
|
642
648
|
label?: string;
|
|
643
649
|
};
|
|
650
|
+
/** Unified conversation resource selector for plugins, middleware and experts. */
|
|
651
|
+
resources?: {
|
|
652
|
+
enabled?: boolean;
|
|
653
|
+
/** Opens the host's workspace Connector flow. Never returns credentials to ChatKit. */
|
|
654
|
+
onConnect?: WorkspaceConnectorConnectHandler;
|
|
655
|
+
};
|
|
644
656
|
/**
|
|
645
657
|
* Conversation-level Connector bindings for the current Xpert or Project.
|
|
646
658
|
* Disabled by default and ignored by custom APIs.
|
|
659
|
+
*
|
|
660
|
+
* @deprecated Prefer `composer.resources` for unified resource selection.
|
|
661
|
+
* Retained for compatibility; this option still controls native Connector
|
|
662
|
+
* capabilities until their migration to `composer.resources` is complete.
|
|
647
663
|
*/
|
|
648
664
|
connectors?: {
|
|
649
665
|
enabled?: boolean;
|
|
@@ -917,6 +933,10 @@ export declare type ChatKitWorkbenchClientCommandRequest = {
|
|
|
917
933
|
};
|
|
918
934
|
|
|
919
935
|
export declare type ChatKitWorkbenchOptions = {
|
|
936
|
+
/** Show external Assistant executions in a native workbench tab. Enabled by default. */
|
|
937
|
+
externalAssistants?: {
|
|
938
|
+
enabled?: boolean;
|
|
939
|
+
};
|
|
920
940
|
/**
|
|
921
941
|
* Enables the right-side Xpert Remote Views workbench.
|
|
922
942
|
*
|
|
@@ -1945,6 +1965,39 @@ export declare type RuntimeCapabilitiesSelectionSet = {
|
|
|
1945
1965
|
};
|
|
1946
1966
|
};
|
|
1947
1967
|
|
|
1968
|
+
export declare interface RuntimeResourceCatalog {
|
|
1969
|
+
items: RuntimeResourceCatalogItem[];
|
|
1970
|
+
total: number;
|
|
1971
|
+
}
|
|
1972
|
+
|
|
1973
|
+
export declare interface RuntimeResourceCatalogItem extends RuntimeResourceReference {
|
|
1974
|
+
kind: RuntimeResourceKind;
|
|
1975
|
+
title: string;
|
|
1976
|
+
description?: LocalizedText;
|
|
1977
|
+
icon?: string;
|
|
1978
|
+
status: RuntimeResourceStatus;
|
|
1979
|
+
diagnostics: AgentPluginDiagnostic[];
|
|
1980
|
+
components: Array<{
|
|
1981
|
+
key: string;
|
|
1982
|
+
kind: 'skill' | 'mcp' | 'middleware' | 'external_xpert';
|
|
1983
|
+
status: RuntimeResourceStatus;
|
|
1984
|
+
}>;
|
|
1985
|
+
}
|
|
1986
|
+
|
|
1987
|
+
export declare type RuntimeResourceKind = 'agent_plugin' | 'middleware' | 'external_xpert';
|
|
1988
|
+
|
|
1989
|
+
export declare interface RuntimeResourceReference {
|
|
1990
|
+
bindingId: string;
|
|
1991
|
+
version: string;
|
|
1992
|
+
}
|
|
1993
|
+
|
|
1994
|
+
export declare interface RuntimeResourcesSelection {
|
|
1995
|
+
revision: number;
|
|
1996
|
+
resources: RuntimeResourceReference[];
|
|
1997
|
+
}
|
|
1998
|
+
|
|
1999
|
+
export declare type RuntimeResourceStatus = 'ready' | 'requires_auth' | 'configuration_required' | 'partial' | 'unavailable';
|
|
2000
|
+
|
|
1948
2001
|
export declare type Select = {
|
|
1949
2002
|
type: 'Select';
|
|
1950
2003
|
key?: string;
|
|
@@ -2077,6 +2130,7 @@ export declare type TChatRequestHuman = {
|
|
|
2077
2130
|
references?: ChatKitReference[];
|
|
2078
2131
|
referenceComposition?: ChatKitReferenceCompositionMode;
|
|
2079
2132
|
planMode?: boolean;
|
|
2133
|
+
runtimeResources?: RuntimeResourcesSelection;
|
|
2080
2134
|
runtimeCapabilities?: RuntimeCapabilitiesSelection;
|
|
2081
2135
|
commandSource?: ChatKitCommandSource;
|
|
2082
2136
|
[key: string]: unknown;
|
|
@@ -2702,6 +2756,18 @@ export declare type WorkflowTriggerParams = {
|
|
|
2702
2756
|
params?: Record<string, any>;
|
|
2703
2757
|
} | Record<string, any>;
|
|
2704
2758
|
|
|
2759
|
+
export declare type WorkspaceConnectorConnectHandler = (request: WorkspaceConnectorConnectRequest) => Promise<WorkspaceConnectorConnectResult>;
|
|
2760
|
+
|
|
2761
|
+
/** The host resolves the workspace and verifies configuration permission again. */
|
|
2762
|
+
export declare type WorkspaceConnectorConnectRequest = {
|
|
2763
|
+
assistantId: string;
|
|
2764
|
+
bindingId: string;
|
|
2765
|
+
};
|
|
2766
|
+
|
|
2767
|
+
export declare type WorkspaceConnectorConnectResult = {
|
|
2768
|
+
status: 'connected' | 'cancelled';
|
|
2769
|
+
};
|
|
2770
|
+
|
|
2705
2771
|
/**
|
|
2706
2772
|
* A Web Component that serves as the entry point for a ChatKit integration.
|
|
2707
2773
|
* * @noInheritDoc
|