@wildix/wilma-voice-client 0.0.35 → 0.0.36

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.
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.VoiceCallEventInclude = exports.VoiceCommandType = exports.VoiceInputMode = exports.VoiceAudioEncoding = exports.VoiceCallToolPhase = exports.VoiceCallEndReason = exports.VoiceControlAction = exports.VoiceEventType = exports.VoicePronunciationEncoding = void 0;
3
+ exports.VoiceCommandType = exports.VoiceInputMode = exports.VoiceAudioEncoding = exports.VoiceCallToolPhase = exports.VoiceCallEndReason = exports.VoiceControlAction = exports.VoiceEventType = exports.VoicePronunciationEncoding = void 0;
4
4
  exports.VoicePronunciationEncoding = {
5
5
  ALIAS: "alias",
6
6
  IPA: "ipa",
@@ -51,7 +51,3 @@ exports.VoiceCommandType = {
51
51
  STOP: "stop",
52
52
  TRANSFER: "transfer",
53
53
  };
54
- exports.VoiceCallEventInclude = {
55
- COMMANDS: "commands",
56
- TOOLS: "tools",
57
- };
@@ -145,7 +145,6 @@ const _iM = "initialMessage";
145
145
  const _iMn = "inputMode";
146
146
  const _iWE = "interruptionWebsocketEvent";
147
147
  const _in = "interruptible";
148
- const _inc = "include";
149
148
  const _int = "interruption";
150
149
  const _l = "language";
151
150
  const _la = "languages";
@@ -450,8 +449,8 @@ exports.StopWebsocketCommand$ = [3, n1, _SWCt,
450
449
  ];
451
450
  exports.StreamCallEventsInput$ = [3, n1, _SCEI,
452
451
  0,
453
- [_cI, _compa, _inc],
454
- [[0, 1], [0, { [_hQ]: _compa }], [64 | 0, { [_hQ]: _inc }]], 1
452
+ [_cI, _compa],
453
+ [[0, 1], [0, { [_hQ]: _compa }]], 1
455
454
  ];
456
455
  exports.StreamCallEventsOutput$ = [3, n1, _SCEO,
457
456
  0,
@@ -567,7 +566,6 @@ var LanguageCodeList = 64 | 0;
567
566
  var VoicePronunciationList = [1, n2, _VPL,
568
567
  0, () => exports.VoicePronunciation$
569
568
  ];
570
- var VoiceCallEventIncludeList = 64 | 0;
571
569
  var VoiceList = [1, n1, _VL,
572
570
  0, () => exports.Voice$
573
571
  ];
@@ -48,7 +48,3 @@ export const VoiceCommandType = {
48
48
  STOP: "stop",
49
49
  TRANSFER: "transfer",
50
50
  };
51
- export const VoiceCallEventInclude = {
52
- COMMANDS: "commands",
53
- TOOLS: "tools",
54
- };
@@ -141,7 +141,6 @@ const _iM = "initialMessage";
141
141
  const _iMn = "inputMode";
142
142
  const _iWE = "interruptionWebsocketEvent";
143
143
  const _in = "interruptible";
144
- const _inc = "include";
145
144
  const _int = "interruption";
146
145
  const _l = "language";
147
146
  const _la = "languages";
@@ -446,8 +445,8 @@ export var StopWebsocketCommand$ = [3, n1, _SWCt,
446
445
  ];
447
446
  export var StreamCallEventsInput$ = [3, n1, _SCEI,
448
447
  0,
449
- [_cI, _compa, _inc],
450
- [[0, 1], [0, { [_hQ]: _compa }], [64 | 0, { [_hQ]: _inc }]], 1
448
+ [_cI, _compa],
449
+ [[0, 1], [0, { [_hQ]: _compa }]], 1
451
450
  ];
452
451
  export var StreamCallEventsOutput$ = [3, n1, _SCEO,
453
452
  0,
@@ -563,7 +562,6 @@ var LanguageCodeList = 64 | 0;
563
562
  var VoicePronunciationList = [1, n2, _VPL,
564
563
  0, () => VoicePronunciation$
565
564
  ];
566
- var VoiceCallEventIncludeList = 64 | 0;
567
565
  var VoiceList = [1, n1, _VL,
568
566
  0, () => Voice$
569
567
  ];
@@ -28,7 +28,7 @@ declare const StreamCallEventsCommand_base: {
28
28
  getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
29
29
  };
30
30
  /**
31
- * Tails a live call's events as Server-Sent Events (`text/event-stream`): the caller's recognised speech, the agent's spoken sentences, playback, interruptions, language switches and the session lifecycle. Live only — nothing before the subscription is replayed, and the stream is not a record of the call (the session trace is). Ends after an `ended` event whose reason is not `transfer`; after a transfer it stays open briefly for the next session of the same call. `include=tools` adds tool events and is honoured only for management-class callers.
31
+ * Tails a live call's events as Server-Sent Events (`text/event-stream`): the caller's recognised speech, the agent's spoken sentences, playback, interruptions, language switches and the session lifecycle. Live only — nothing before the subscription is replayed, and the stream is not a record of the call (the session trace is). Ends after an `ended` event whose reason is not `transfer`; after a transfer it stays open briefly for the next session of the same call. What the stream carries is decided HERE, by who is asking, and is not a request parameter: a caller signed in to the system receives everything, including the agent's own commands (`reply`, `say`, `playback`, `interruption`) and its tool calls, and chooses for itself what to show; a guest receives the transcript alone (`started`, `transcription`, `agentTranscription`, `language`, `ended`).
32
32
  * @example
33
33
  * Use a bare-bones client and the command you need to make an API call.
34
34
  * ```javascript
@@ -40,9 +40,6 @@ declare const StreamCallEventsCommand_base: {
40
40
  * const input = { // StreamCallEventsInput
41
41
  * callId: "STRING_VALUE", // required
42
42
  * company: "STRING_VALUE",
43
- * include: [ // VoiceCallEventIncludeList
44
- * "commands" || "tools",
45
- * ],
46
43
  * };
47
44
  * const command = new StreamCallEventsCommand(input);
48
45
  * const response = await client.send(command);
@@ -145,15 +145,3 @@ export declare const VoiceCommandType: {
145
145
  * @public
146
146
  */
147
147
  export type VoiceCommandType = (typeof VoiceCommandType)[keyof typeof VoiceCommandType];
148
- /**
149
- * @public
150
- * @enum
151
- */
152
- export declare const VoiceCallEventInclude: {
153
- readonly COMMANDS: "commands";
154
- readonly TOOLS: "tools";
155
- };
156
- /**
157
- * @public
158
- */
159
- export type VoiceCallEventInclude = (typeof VoiceCallEventInclude)[keyof typeof VoiceCallEventInclude];
@@ -1,5 +1,5 @@
1
1
  import type { DocumentType as __DocumentType, StreamingBlobTypes } from "@smithy/types";
2
- import type { VoiceAudioEncoding, VoiceCallEndReason, VoiceCallEventInclude, VoiceCallToolPhase, VoiceCommandType, VoiceControlAction, VoiceEventType, VoiceInputMode, VoicePronunciationEncoding } from "./enums";
2
+ import type { VoiceAudioEncoding, VoiceCallEndReason, VoiceCallToolPhase, VoiceCommandType, VoiceControlAction, VoiceEventType, VoiceInputMode, VoicePronunciationEncoding } from "./enums";
3
3
  /**
4
4
  * A pronunciation rule for one phrase. Belongs to a LANGUAGE, not to the agent: 'Wildix' is
5
5
  * respelled differently for an Italian and a German voice, so one list shared ACROSS languages
@@ -46,7 +46,7 @@ export interface AgentTranscriptionEvent {
46
46
  */
47
47
  confidence?: number | undefined;
48
48
  /**
49
- * True when this is the final transcript for the utterance rather than an interim hypothesis.
49
+ * True when this is the final transcript for the utterance rather than an interim hypothesis. An absent value is read as final, as on `TranscriptionEvent`.
50
50
  * @public
51
51
  */
52
52
  final?: boolean | undefined;
@@ -309,7 +309,7 @@ export interface VoiceCallStartedEvent {
309
309
  language?: string | undefined;
310
310
  }
311
311
  /**
312
- * A tool call the agent made during a turn. Name and phase only — arguments and results live in the trace. Sent only to management callers that asked for `include=tools`.
312
+ * A tool call the agent made during a turn. Name and phase only — arguments and results live in the trace. Sent to a caller signed in to the system; never to a guest.
313
313
  * @public
314
314
  */
315
315
  export interface VoiceCallToolEvent {
@@ -353,7 +353,7 @@ export interface VoiceCallTranscriptionEvent {
353
353
  time?: number | undefined;
354
354
  }
355
355
  /**
356
- * One event on a live call. The SSE frame's `event:` is the member name and `data:` the member's JSON.
356
+ * One event on a live call. The SSE frame's `event:` is the member name and `data:` this whole union document, so a frame reads `data: \{"say": \{...\}\}` — never the member's payload on its own.
357
357
  * @public
358
358
  */
359
359
  export type VoiceCallEvent = VoiceCallEvent.AgentTranscriptionMember | VoiceCallEvent.EndedMember | VoiceCallEvent.InterruptionMember | VoiceCallEvent.LanguageMember | VoiceCallEvent.PlaybackMember | VoiceCallEvent.ReplyMember | VoiceCallEvent.SayMember | VoiceCallEvent.StartedMember | VoiceCallEvent.ToolMember | VoiceCallEvent.TranscriptionMember | VoiceCallEvent.$UnknownMember;
@@ -498,7 +498,7 @@ export declare namespace VoiceCallEvent {
498
498
  $unknown?: never;
499
499
  }
500
500
  /**
501
- * A tool call the agent made during a turn. Name and phase only — arguments and results live in the trace. Sent only to management callers that asked for `include=tools`.
501
+ * A tool call the agent made during a turn. Name and phase only — arguments and results live in the trace. Sent to a caller signed in to the system; never to a guest.
502
502
  * @public
503
503
  */
504
504
  interface ToolMember {
@@ -1131,7 +1131,7 @@ export interface TranscriptionEvent {
1131
1131
  */
1132
1132
  confidence?: number | undefined;
1133
1133
  /**
1134
- * True when this is the final transcript for the utterance rather than an interim hypothesis.
1134
+ * True when this is the final transcript for the utterance rather than an interim hypothesis. An absent value is read as final: a client that does not distinguish interim results sends none.
1135
1135
  * @public
1136
1136
  */
1137
1137
  final?: boolean | undefined;
@@ -1470,7 +1470,6 @@ export interface StreamCallEventsInput {
1470
1470
  * @public
1471
1471
  */
1472
1472
  company?: string | undefined;
1473
- include?: VoiceCallEventInclude[] | undefined;
1474
1473
  }
1475
1474
  /**
1476
1475
  * @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.35",
4
+ "version": "0.0.36",
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",