@wildix/wilma-voice-client 0.0.6 → 0.0.8

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.
@@ -57,8 +57,7 @@ const _VCP = "VoiceConnectParams";
57
57
  const _VE = "ValidationException";
58
58
  const _VEE = "VoiceErrorEvent";
59
59
  const _a = "action";
60
- const _aD = "agentDeployment";
61
- const _aDg = "agentDraft";
60
+ const _aD = "agentDraft";
62
61
  const _aI = "agentId";
63
62
  const _aN = "agentName";
64
63
  const _aV = "agentVersion";
@@ -120,6 +119,7 @@ const _sWC = "sayWebsocketCommand";
120
119
  const _sWCt = "stopWebsocketCommand";
121
120
  const _se = "seq";
122
121
  const _t = "type";
122
+ const _tI = "traceId";
123
123
  const _tWC = "transferWebsocketCommand";
124
124
  const _tWE = "transcriptionWebsocketEvent";
125
125
  const _te = "text";
@@ -329,8 +329,8 @@ exports.SessionEndedWebsocketEvent$ = [3, n1, _SEWE,
329
329
  ];
330
330
  exports.SessionStartedEvent$ = [3, n1, _SSE,
331
331
  0,
332
- [_t, _ti, _sIe, _aI, _aV, _aN, _ca, _gI, _iA, _oA],
333
- [0, 1, 0, 0, 1, 0, 0, 0, () => exports.VoiceAudioFormat$, () => exports.VoiceAudioFormat$], 4
332
+ [_t, _ti, _sIe, _aI, _aV, _tI, _aN, _ca, _gI, _iA, _oA],
333
+ [0, 1, 0, 0, 1, 0, 0, 0, 0, () => exports.VoiceAudioFormat$, () => exports.VoiceAudioFormat$], 4
334
334
  ];
335
335
  exports.SessionStartedWebsocketEvent$ = [3, n1, _SSWE,
336
336
  0,
@@ -374,8 +374,8 @@ exports.VoiceAudioFormat$ = [3, n1, _VAF,
374
374
  ];
375
375
  exports.VoiceConnectParams$ = [3, n1, _VCP,
376
376
  0,
377
- [_sIe, _aI, _pV, _aD, _aV, _aDg, _cI, _l, _cN, _cNa, _cE, _cC, _v, _iM, _va, _iMn, _iA, _oA],
378
- [0, 0, 1, 0, 1, 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, () => exports.VoiceAudioFormat$, () => exports.VoiceAudioFormat$], 2
377
+ [_sIe, _aI, _pV, _aV, _aD, _cI, _l, _cN, _cNa, _cE, _cC, _v, _iM, _va, _iMn, _iA, _oA],
378
+ [0, 0, 1, 1, 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, () => exports.VoiceAudioFormat$, () => exports.VoiceAudioFormat$], 2
379
379
  ];
380
380
  exports.VoiceErrorEvent$ = [3, n1, _VEE,
381
381
  0,
@@ -53,8 +53,7 @@ const _VCP = "VoiceConnectParams";
53
53
  const _VE = "ValidationException";
54
54
  const _VEE = "VoiceErrorEvent";
55
55
  const _a = "action";
56
- const _aD = "agentDeployment";
57
- const _aDg = "agentDraft";
56
+ const _aD = "agentDraft";
58
57
  const _aI = "agentId";
59
58
  const _aN = "agentName";
60
59
  const _aV = "agentVersion";
@@ -116,6 +115,7 @@ const _sWC = "sayWebsocketCommand";
116
115
  const _sWCt = "stopWebsocketCommand";
117
116
  const _se = "seq";
118
117
  const _t = "type";
118
+ const _tI = "traceId";
119
119
  const _tWC = "transferWebsocketCommand";
120
120
  const _tWE = "transcriptionWebsocketEvent";
121
121
  const _te = "text";
@@ -325,8 +325,8 @@ export var SessionEndedWebsocketEvent$ = [3, n1, _SEWE,
325
325
  ];
326
326
  export var SessionStartedEvent$ = [3, n1, _SSE,
327
327
  0,
328
- [_t, _ti, _sIe, _aI, _aV, _aN, _ca, _gI, _iA, _oA],
329
- [0, 1, 0, 0, 1, 0, 0, 0, () => VoiceAudioFormat$, () => VoiceAudioFormat$], 4
328
+ [_t, _ti, _sIe, _aI, _aV, _tI, _aN, _ca, _gI, _iA, _oA],
329
+ [0, 1, 0, 0, 1, 0, 0, 0, 0, () => VoiceAudioFormat$, () => VoiceAudioFormat$], 4
330
330
  ];
331
331
  export var SessionStartedWebsocketEvent$ = [3, n1, _SSWE,
332
332
  0,
@@ -370,8 +370,8 @@ export var VoiceAudioFormat$ = [3, n1, _VAF,
370
370
  ];
371
371
  export var VoiceConnectParams$ = [3, n1, _VCP,
372
372
  0,
373
- [_sIe, _aI, _pV, _aD, _aV, _aDg, _cI, _l, _cN, _cNa, _cE, _cC, _v, _iM, _va, _iMn, _iA, _oA],
374
- [0, 0, 1, 0, 1, 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, () => VoiceAudioFormat$, () => VoiceAudioFormat$], 2
373
+ [_sIe, _aI, _pV, _aV, _aD, _cI, _l, _cN, _cNa, _cE, _cC, _v, _iM, _va, _iMn, _iA, _oA],
374
+ [0, 0, 1, 1, 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, () => VoiceAudioFormat$, () => VoiceAudioFormat$], 2
375
375
  ];
376
376
  export var VoiceErrorEvent$ = [3, n1, _VEE,
377
377
  0,
@@ -52,15 +52,14 @@ export interface WilmaVoice {
52
52
  * (engine, instructions, capabilities and channels.voice settings). This is a runtime only: there
53
53
  * is no agent/bot CRUD here — agents are authored and versioned in wilma-agents.
54
54
  *
55
- * The WebSocket (transport host `wilma-voice-ws.wildix.com`) preserves the wim-voicebots message
56
- * protocol so existing PBX clients work unchanged: the PBX transcribes caller speech and sends
57
- * `transcription` / `reply` text, and the service returns `say` / `play` / `stop` / `hangup` /
58
- * `transfer`. In addition, web/app clients connect with inputMode=AUDIO and push raw caller `audio`
59
- * chunks, which the service transcribes server-side. Every WebSocket message shape (connect params,
60
- * events and commands) is declared as a structure and enumerated by DescribeVoiceProtocol so the
61
- * generated SDKs carry the types and (de)serializers; the WebSocket transport itself is hand-coded,
62
- * as in wim-voicebots. The HTTP Send* operations push the same commands into a live session
63
- * out-of-band.
55
+ * On the WebSocket (transport host `wilma-voice-ws.wildix.com`), PBX clients transcribe caller
56
+ * speech themselves and send `transcription` / `reply` text, while web/app clients connect with
57
+ * inputMode=AUDIO and push raw caller `audio` chunks that the service transcribes server-side;
58
+ * the service returns `say` / `play` / `stop` / `hangup` / `transfer`. Every WebSocket message
59
+ * shape (connect params, events and commands) is declared as a structure and enumerated by
60
+ * DescribeVoiceProtocol so the generated SDKs carry the types and (de)serializers; the WebSocket
61
+ * transport itself is hand-coded. The HTTP Send* operations push the same commands into a live
62
+ * session out-of-band.
64
63
  *
65
64
  * Session observability and history are recorded in wilma-traces; this service does not expose
66
65
  * bot configuration, traces or listing.
@@ -156,15 +156,14 @@ export interface WilmaVoiceClientResolvedConfig extends WilmaVoiceClientResolved
156
156
  * (engine, instructions, capabilities and channels.voice settings). This is a runtime only: there
157
157
  * is no agent/bot CRUD here — agents are authored and versioned in wilma-agents.
158
158
  *
159
- * The WebSocket (transport host `wilma-voice-ws.wildix.com`) preserves the wim-voicebots message
160
- * protocol so existing PBX clients work unchanged: the PBX transcribes caller speech and sends
161
- * `transcription` / `reply` text, and the service returns `say` / `play` / `stop` / `hangup` /
162
- * `transfer`. In addition, web/app clients connect with inputMode=AUDIO and push raw caller `audio`
163
- * chunks, which the service transcribes server-side. Every WebSocket message shape (connect params,
164
- * events and commands) is declared as a structure and enumerated by DescribeVoiceProtocol so the
165
- * generated SDKs carry the types and (de)serializers; the WebSocket transport itself is hand-coded,
166
- * as in wim-voicebots. The HTTP Send* operations push the same commands into a live session
167
- * out-of-band.
159
+ * On the WebSocket (transport host `wilma-voice-ws.wildix.com`), PBX clients transcribe caller
160
+ * speech themselves and send `transcription` / `reply` text, while web/app clients connect with
161
+ * inputMode=AUDIO and push raw caller `audio` chunks that the service transcribes server-side;
162
+ * the service returns `say` / `play` / `stop` / `hangup` / `transfer`. Every WebSocket message
163
+ * shape (connect params, events and commands) is declared as a structure and enumerated by
164
+ * DescribeVoiceProtocol so the generated SDKs carry the types and (de)serializers; the WebSocket
165
+ * transport itself is hand-coded. The HTTP Send* operations push the same commands into a live
166
+ * session out-of-band.
168
167
  *
169
168
  * Session observability and history are recorded in wilma-traces; this service does not expose
170
169
  * bot configuration, traces or listing.
@@ -44,7 +44,6 @@ declare const DescribeVoiceProtocolCommand_base: {
44
44
  * // protocolVersion: Number("int"),
45
45
  * // sessionId: "STRING_VALUE", // required
46
46
  * // agentId: "STRING_VALUE", // required
47
- * // agentDeployment: "STRING_VALUE",
48
47
  * // agentVersion: Number("int"),
49
48
  * // agentDraft: true || false,
50
49
  * // callId: "STRING_VALUE",
@@ -141,6 +140,7 @@ declare const DescribeVoiceProtocolCommand_base: {
141
140
  * // sessionId: "STRING_VALUE", // required
142
141
  * // agentId: "STRING_VALUE", // required
143
142
  * // agentVersion: Number("int"),
143
+ * // traceId: "STRING_VALUE",
144
144
  * // agentName: "STRING_VALUE",
145
145
  * // category: "STRING_VALUE",
146
146
  * // groupId: "STRING_VALUE",
@@ -5,15 +5,14 @@
5
5
  * (engine, instructions, capabilities and channels.voice settings). This is a runtime only: there
6
6
  * is no agent/bot CRUD here — agents are authored and versioned in wilma-agents.
7
7
  *
8
- * The WebSocket (transport host `wilma-voice-ws.wildix.com`) preserves the wim-voicebots message
9
- * protocol so existing PBX clients work unchanged: the PBX transcribes caller speech and sends
10
- * `transcription` / `reply` text, and the service returns `say` / `play` / `stop` / `hangup` /
11
- * `transfer`. In addition, web/app clients connect with inputMode=AUDIO and push raw caller `audio`
12
- * chunks, which the service transcribes server-side. Every WebSocket message shape (connect params,
13
- * events and commands) is declared as a structure and enumerated by DescribeVoiceProtocol so the
14
- * generated SDKs carry the types and (de)serializers; the WebSocket transport itself is hand-coded,
15
- * as in wim-voicebots. The HTTP Send* operations push the same commands into a live session
16
- * out-of-band.
8
+ * On the WebSocket (transport host `wilma-voice-ws.wildix.com`), PBX clients transcribe caller
9
+ * speech themselves and send `transcription` / `reply` text, while web/app clients connect with
10
+ * inputMode=AUDIO and push raw caller `audio` chunks that the service transcribes server-side;
11
+ * the service returns `say` / `play` / `stop` / `hangup` / `transfer`. Every WebSocket message
12
+ * shape (connect params, events and commands) is declared as a structure and enumerated by
13
+ * DescribeVoiceProtocol so the generated SDKs carry the types and (de)serializers; the WebSocket
14
+ * transport itself is hand-coded. The HTTP Send* operations push the same commands into a live
15
+ * session out-of-band.
17
16
  *
18
17
  * Session observability and history are recorded in wilma-traces; this service does not expose
19
18
  * bot configuration, traces or listing.
@@ -76,7 +76,7 @@ export declare const VoiceInputMode: {
76
76
  */
77
77
  readonly AUDIO: "audio";
78
78
  /**
79
- * The client sends `transcription` / `reply` text events; it performs speech-to-text itself (PBX behaviour, same as wim-voicebots).
79
+ * The client sends `transcription` / `reply` text events; it performs speech-to-text itself (PBX behaviour).
80
80
  */
81
81
  readonly TRANSCRIPTION: "transcription";
82
82
  };
@@ -117,7 +117,7 @@ export interface VoiceAudioFormat {
117
117
  */
118
118
  export interface VoiceConnectParams {
119
119
  /**
120
- * Protocol version advertised by the client (wim-voicebots `v`). 0 (or absent) is the legacy PBX protocol; >= 1 enables the sessionStarted event.
120
+ * Protocol version advertised by the client (query parameter `v`). 0 (or absent) is the legacy PBX protocol; >= 1 enables the sessionStarted event.
121
121
  * @public
122
122
  */
123
123
  protocolVersion?: number | undefined;
@@ -132,17 +132,12 @@ export interface VoiceConnectParams {
132
132
  */
133
133
  agentId: string;
134
134
  /**
135
- * Deployment used to resolve the published agent version. Defaults to 'production'. Mutually exclusive with agentVersion and agentDraft.
136
- * @public
137
- */
138
- agentDeployment?: string | undefined;
139
- /**
140
- * Published agent version to run. Mutually exclusive with agentDeployment and agentDraft.
135
+ * Published agent version to run. Mutually exclusive with agentDraft. When neither is set, the agent's deployment configuration selects the version.
141
136
  * @public
142
137
  */
143
138
  agentVersion?: number | undefined;
144
139
  /**
145
- * Run the agent's current draft (for testing). Mutually exclusive with agentDeployment and agentVersion.
140
+ * Run the agent's current draft (for testing). Mutually exclusive with agentVersion.
146
141
  * @public
147
142
  */
148
143
  agentDraft?: boolean | undefined;
@@ -488,6 +483,17 @@ export interface SessionStartedEvent {
488
483
  * @public
489
484
  */
490
485
  agentVersion?: number | undefined;
486
+ /**
487
+ * Trace recording this voice session in wilma-traces — the caller's transcribed phrases, the
488
+ * model calls they drove and the tools the agent ran. Read it with the wilma-traces GetTrace
489
+ * operation, or tail it live with StreamTrace to follow a call while it is in progress.
490
+ *
491
+ * Sent once at handshake and stable for the connection: a call is one trace. A caller who
492
+ * redials gets a new session and therefore a new trace, since the trace is keyed on the session
493
+ * id supplied at connect.
494
+ * @public
495
+ */
496
+ traceId?: string | undefined;
491
497
  /**
492
498
  * Agent display name.
493
499
  * @public
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@wildix/wilma-voice-client",
3
3
  "description": "@wildix/wilma-voice-client client",
4
- "version": "0.0.6",
4
+ "version": "0.0.8",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",