@aiworkbench/vibe-types 0.0.4 → 0.0.6
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 +87 -1
- package/dist/index.d.ts.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
* The Host injects a bridge object into each mini-app based on
|
|
8
8
|
* the permissions declared in its manifest.json.
|
|
9
9
|
*/
|
|
10
|
-
export type BridgeCapability = "auth" | "api" | "navigation" | "theme" | "toast" | "storage" | "events";
|
|
10
|
+
export type BridgeCapability = "auth" | "api" | "navigation" | "theme" | "toast" | "storage" | "events" | "chat" | "voice";
|
|
11
11
|
export interface BridgeUser {
|
|
12
12
|
id: string;
|
|
13
13
|
name: string;
|
|
@@ -52,6 +52,81 @@ export interface EventsBridge {
|
|
|
52
52
|
/** Subscribe once, then auto-unsubscribe. Returns an unsubscribe function. */
|
|
53
53
|
once(event: string, handler: (payload: EventPayload) => void): () => void;
|
|
54
54
|
}
|
|
55
|
+
/** A single part within a chat message. */
|
|
56
|
+
export type ChatPart = {
|
|
57
|
+
type: "text";
|
|
58
|
+
text: string;
|
|
59
|
+
} | {
|
|
60
|
+
type: "data";
|
|
61
|
+
data: unknown;
|
|
62
|
+
} | {
|
|
63
|
+
type: "file";
|
|
64
|
+
file: {
|
|
65
|
+
name: string;
|
|
66
|
+
mimeType: string;
|
|
67
|
+
uri: string;
|
|
68
|
+
};
|
|
69
|
+
};
|
|
70
|
+
/** A server-sent event from the A2A stream. */
|
|
71
|
+
export interface ChatStreamEvent {
|
|
72
|
+
kind: string;
|
|
73
|
+
[key: string]: unknown;
|
|
74
|
+
}
|
|
75
|
+
/** Options for sending a chat message. */
|
|
76
|
+
export interface ChatSendOptions {
|
|
77
|
+
/** Conversation thread identifier. */
|
|
78
|
+
contextId?: string;
|
|
79
|
+
/** Caller-supplied message id. */
|
|
80
|
+
messageId?: string;
|
|
81
|
+
/** Arbitrary metadata forwarded to the agent. */
|
|
82
|
+
metadata?: unknown;
|
|
83
|
+
/** Abort signal to cancel the stream. */
|
|
84
|
+
signal?: AbortSignal;
|
|
85
|
+
}
|
|
86
|
+
/** An async-iterable stream of chat events with an abort handle. */
|
|
87
|
+
export interface ChatStream {
|
|
88
|
+
[Symbol.asyncIterator](): AsyncIterableIterator<ChatStreamEvent>;
|
|
89
|
+
/** Cancel the in-flight stream. */
|
|
90
|
+
abort(): void;
|
|
91
|
+
}
|
|
92
|
+
export interface ChatBridge {
|
|
93
|
+
/**
|
|
94
|
+
* Send a message to an A2A-compatible agent and stream the response.
|
|
95
|
+
*
|
|
96
|
+
* @param serverUrl - Base URL of the A2A agent server.
|
|
97
|
+
* @param parts - Message parts to send.
|
|
98
|
+
* @param options - Optional context, message id, metadata, abort signal.
|
|
99
|
+
* @returns An async-iterable stream of `ChatStreamEvent` objects.
|
|
100
|
+
*/
|
|
101
|
+
send(serverUrl: string, parts: ChatPart[], options?: ChatSendOptions): ChatStream;
|
|
102
|
+
}
|
|
103
|
+
export type VoiceAgentState = "connecting" | "initializing" | "listening" | "thinking" | "speaking" | "disconnected";
|
|
104
|
+
export interface VoiceTranscription {
|
|
105
|
+
participant: "user" | "agent";
|
|
106
|
+
text: string;
|
|
107
|
+
isFinal: boolean;
|
|
108
|
+
timestamp: number;
|
|
109
|
+
}
|
|
110
|
+
export interface VoiceAudioLevel {
|
|
111
|
+
participant: "user" | "agent";
|
|
112
|
+
level: number;
|
|
113
|
+
}
|
|
114
|
+
export interface VoiceConnectOptions {
|
|
115
|
+
metadata?: Record<string, unknown>;
|
|
116
|
+
}
|
|
117
|
+
export interface VoiceConnectionInfo {
|
|
118
|
+
roomName: string;
|
|
119
|
+
agentName: string;
|
|
120
|
+
}
|
|
121
|
+
export interface VoiceBridge {
|
|
122
|
+
connect(agentName: string, options?: VoiceConnectOptions): Promise<VoiceConnectionInfo>;
|
|
123
|
+
disconnect(): void;
|
|
124
|
+
setMicEnabled(enabled: boolean): void;
|
|
125
|
+
sendText(text: string): void;
|
|
126
|
+
onStateChange(handler: (state: VoiceAgentState) => void): () => void;
|
|
127
|
+
onTranscription(handler: (entry: VoiceTranscription) => void): () => void;
|
|
128
|
+
onAudioLevel(handler: (level: VoiceAudioLevel) => void): () => void;
|
|
129
|
+
}
|
|
55
130
|
export interface Bridge {
|
|
56
131
|
auth: AuthBridge;
|
|
57
132
|
navigation: NavigationBridge;
|
|
@@ -60,11 +135,21 @@ export interface Bridge {
|
|
|
60
135
|
api: ApiBridge;
|
|
61
136
|
storage: StorageBridge;
|
|
62
137
|
events: EventsBridge;
|
|
138
|
+
chat: ChatBridge;
|
|
139
|
+
voice: VoiceBridge;
|
|
63
140
|
}
|
|
64
141
|
/** Props passed to every mini-app component. */
|
|
65
142
|
export interface VibeProps {
|
|
66
143
|
bridge: Bridge;
|
|
67
144
|
}
|
|
145
|
+
export interface VibeApiProxyHostConfig {
|
|
146
|
+
/** Default upstream target used by hosts that support proxy overrides. */
|
|
147
|
+
defaultTarget?: string;
|
|
148
|
+
}
|
|
149
|
+
export interface VibeHostConfig {
|
|
150
|
+
/** Host-managed settings for API proxy configuration. */
|
|
151
|
+
apiProxy?: VibeApiProxyHostConfig;
|
|
152
|
+
}
|
|
68
153
|
/** Manifest schema for a mini-app. */
|
|
69
154
|
export interface VibeManifest {
|
|
70
155
|
id: string;
|
|
@@ -73,6 +158,7 @@ export interface VibeManifest {
|
|
|
73
158
|
permissions: BridgeCapability[];
|
|
74
159
|
description: string;
|
|
75
160
|
entry?: string;
|
|
161
|
+
hostConfig?: VibeHostConfig;
|
|
76
162
|
}
|
|
77
163
|
/** A published mini-app entry in the registry. */
|
|
78
164
|
export interface RegistryEntry extends VibeManifest {
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAMH,MAAM,MAAM,gBAAgB,GACxB,MAAM,GACN,KAAK,GACL,YAAY,GACZ,OAAO,GACP,OAAO,GACP,SAAS,GACT,QAAQ,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAMH,MAAM,MAAM,gBAAgB,GACxB,MAAM,GACN,KAAK,GACL,YAAY,GACZ,OAAO,GACP,OAAO,GACP,SAAS,GACT,QAAQ,GACR,MAAM,GACN,OAAO,CAAC;AAMZ,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,UAAU;IACzB,OAAO,IAAI,UAAU,CAAC;IACtB,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;CAC7B;AAMD,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAMD,MAAM,WAAW,WAAW;IAC1B,OAAO,IAAI,OAAO,GAAG,MAAM,CAAC;CAC7B;AAMD,MAAM,WAAW,WAAW;IAC1B,IAAI,CACF,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAA;KAAE,GAChD,IAAI,CAAC;CACT;AAMD,MAAM,WAAW,SAAS;IACxB,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;CACnE;AAMD,MAAM,WAAW,aAAa;IAC5B,qDAAqD;IACrD,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IACzC,4BAA4B;IAC5B,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/C,oBAAoB;IACpB,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,kDAAkD;IAClD,IAAI,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;CAC3B;AAMD,MAAM,WAAW,YAAY;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,YAAY;IAC3B,iCAAiC;IACjC,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,IAAI,CAAC;IAClD,0EAA0E;IAC1E,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,OAAO,EAAE,YAAY,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;IACxE,8EAA8E;IAC9E,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,OAAO,EAAE,YAAY,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;CAC3E;AAMD,2CAA2C;AAC3C,MAAM,MAAM,QAAQ,GAChB;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC9B;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,OAAO,CAAA;CAAE,GAC/B;IACE,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;CACvD,CAAC;AAEN,+CAA+C;AAC/C,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,0CAA0C;AAC1C,MAAM,WAAW,eAAe;IAC9B,sCAAsC;IACtC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kCAAkC;IAClC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iDAAiD;IACjD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,yCAAyC;IACzC,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,oEAAoE;AACpE,MAAM,WAAW,UAAU;IACzB,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,qBAAqB,CAAC,eAAe,CAAC,CAAC;IACjE,mCAAmC;IACnC,KAAK,IAAI,IAAI,CAAC;CACf;AAED,MAAM,WAAW,UAAU;IACzB;;;;;;;OAOG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,QAAQ,EAAE,EACjB,OAAO,CAAC,EAAE,eAAe,GACxB,UAAU,CAAC;CACf;AAMD,MAAM,MAAM,eAAe,GACvB,YAAY,GACZ,cAAc,GACd,WAAW,GACX,UAAU,GACV,UAAU,GACV,cAAc,CAAC;AAEnB,MAAM,WAAW,kBAAkB;IACjC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,eAAe;IAC9B,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC;IAC9B,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,CACL,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAChC,UAAU,IAAI,IAAI,CAAC;IACnB,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IACtC,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,aAAa,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;IACrE,eAAe,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,kBAAkB,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;IAC1E,YAAY,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;CACrE;AAMD,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,UAAU,CAAC;IACjB,UAAU,EAAE,gBAAgB,CAAC;IAC7B,KAAK,EAAE,WAAW,CAAC;IACnB,KAAK,EAAE,WAAW,CAAC;IACnB,GAAG,EAAE,SAAS,CAAC;IACf,OAAO,EAAE,aAAa,CAAC;IACvB,MAAM,EAAE,YAAY,CAAC;IACrB,IAAI,EAAE,UAAU,CAAC;IACjB,KAAK,EAAE,WAAW,CAAC;CACpB;AAED,gDAAgD;AAChD,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,sBAAsB;IACrC,0EAA0E;IAC1E,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,cAAc;IAC7B,yDAAyD;IACzD,QAAQ,CAAC,EAAE,sBAAsB,CAAC;CACnC;AAED,sCAAsC;AACtC,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,OAAO,GAAG,KAAK,GAAG,SAAS,CAAC;IACvC,WAAW,EAAE,gBAAgB,EAAE,CAAC;IAChC,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,cAAc,CAAC;CAC7B;AAMD,kDAAkD;AAClD,MAAM,WAAW,aAAc,SAAQ,YAAY;IACjD,8CAA8C;IAC9C,SAAS,EAAE,MAAM,CAAC;IAClB,2BAA2B;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,gCAAgC;IAChC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,kCAAkC;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,iDAAiD;IACjD,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,uEAAuE;AACvE,MAAM,MAAM,gBAAgB,GAAG,aAAa,EAAE,CAAC"}
|