@voctiv/agent-sdk 0.2.0 → 0.2.2

package/dist/index.d.ts

@@ -2,6 +2,8 @@
  * @packageDocumentation
  * **Agent scripting SDK** for `node-asr-tts-connector`: typed **`defineScript`** context,
  * {@link import('./types/media-channel').MediaChannel}, ASR/TTS, LLM, SIP, and Voctiv platform (LE-compat) helpers.
+ * These exports are types plus the `defineScript` identity helper; behavior is provided by
+ * the `apps/api` scripting runtime that loads and executes your script.
  *
  * ### Selecting ASR/TTS credentials by `key_storage.name` (Voctiv platform)
  *
@@ -15,11 +17,14 @@
  * - {@link import('./types/mixer').PlayOptions.name} or **`ttsConfig.name`** on **`say`/`play`/`presay`**
  *
  * Channel defaults **`defaultAsrName`** / **`defaultTtsName`** apply when **`name`** is omitted.
+ *
+ * Legacy platform APIs (`platform.nlu`, `platform.call`, messaging sends, dialog writes, and phrase
+ * records) require `context.legacyV3Compat === true` in the current API runtime.
  */
 export { defineScript } from './define-script';
 export type { ScriptContext, ScriptDialogContext, ScriptRunTime, ScriptResult, PersistedScriptResult, ScriptError, ScriptFn, NluScriptApi, PlatformApi, DialogApi, ScheduleCallOptions, SendMessageOptions, InboundMessage, MessagingApi, } from './define-script';
 export type { ScriptLogger } from './types/logger';
-export type { MediaChannel, ChannelAudio, ChannelEvents, ChannelLlm, ChannelSip, LlmOptions, LlmStreamChunk, ExtractOptions, PersistentLlmStreamHandle, } from './types/media-channel';
+export type { MediaChannel, ChannelAudio, ChannelEvents, ChannelLlm, ChannelSip, SipState, SipProgressEvent, LlmOptions, LlmStreamChunk, ExtractOptions, PersistentLlmStreamHandle, } from './types/media-channel';
 export type { AsrHandle, AsrConfig, AsrVadConfig, AsrSmartTurnConfig } from './types/asr-handle';
 export type { MixerQueueControl, PlayOptions, TtsStrategy, TtsVendor } from './types/mixer';
 export type { LegacyPhraseRecord, LegacyGetRecordsParams, LegacySavePhraseOptions, } from './types/legacy-phrase';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,YAAY,EACV,aAAa,EACb,mBAAmB,EACnB,aAAa,EACb,YAAY,EACZ,qBAAqB,EACrB,WAAW,EACX,QAAQ,EACR,YAAY,EACZ,WAAW,EACX,SAAS,EACT,mBAAmB,EACnB,kBAAkB,EAClB,cAAc,EACd,YAAY,GACb,MAAM,iBAAiB,CAAC;AACzB,YAAY,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,YAAY,EACV,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,UAAU,EACV,UAAU,EACV,UAAU,EACV,cAAc,EACd,cAAc,EACd,yBAAyB,GAC1B,MAAM,uBAAuB,CAAC;AAC/B,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACjG,YAAY,EAAE,iBAAiB,EAAE,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC5F,YAAY,EACV,kBAAkB,EAClB,sBAAsB,EACtB,uBAAuB,GACxB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,0BAA0B,EAC1B,oBAAoB,GACrB,MAAM,uBAAuB,CAAC;AAC/B,YAAY,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACpD,YAAY,EACV,SAAS,EACT,OAAO,EACP,SAAS,EACT,WAAW,GACZ,MAAM,gBAAgB,CAAC;AACxB,YAAY,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,YAAY,EACV,aAAa,EACb,mBAAmB,EACnB,aAAa,EACb,YAAY,EACZ,qBAAqB,EACrB,WAAW,EACX,QAAQ,EACR,YAAY,EACZ,WAAW,EACX,SAAS,EACT,mBAAmB,EACnB,kBAAkB,EAClB,cAAc,EACd,YAAY,GACb,MAAM,iBAAiB,CAAC;AACzB,YAAY,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,YAAY,EACV,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,UAAU,EACV,UAAU,EACV,QAAQ,EACR,gBAAgB,EAChB,UAAU,EACV,cAAc,EACd,cAAc,EACd,yBAAyB,GAC1B,MAAM,uBAAuB,CAAC;AAC/B,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACjG,YAAY,EAAE,iBAAiB,EAAE,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC5F,YAAY,EACV,kBAAkB,EAClB,sBAAsB,EACtB,uBAAuB,GACxB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,0BAA0B,EAC1B,oBAAoB,GACrB,MAAM,uBAAuB,CAAC;AAC/B,YAAY,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACpD,YAAY,EACV,SAAS,EACT,OAAO,EACP,SAAS,EACT,WAAW,GACZ,MAAM,gBAAgB,CAAC;AACxB,YAAY,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC"}

package/dist/index.js

@@ -3,6 +3,8 @@
  * @packageDocumentation
  * **Agent scripting SDK** for `node-asr-tts-connector`: typed **`defineScript`** context,
  * {@link import('./types/media-channel').MediaChannel}, ASR/TTS, LLM, SIP, and Voctiv platform (LE-compat) helpers.
+ * These exports are types plus the `defineScript` identity helper; behavior is provided by
+ * the `apps/api` scripting runtime that loads and executes your script.
  *
  * ### Selecting ASR/TTS credentials by `key_storage.name` (Voctiv platform)
  *
@@ -16,6 +18,9 @@
  * - {@link import('./types/mixer').PlayOptions.name} or **`ttsConfig.name`** on **`say`/`play`/`presay`**
  *
  * Channel defaults **`defaultAsrName`** / **`defaultTtsName`** apply when **`name`** is omitted.
+ *
+ * Legacy platform APIs (`platform.nlu`, `platform.call`, messaging sends, dialog writes, and phrase
+ * records) require `context.legacyV3Compat === true` in the current API runtime.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isLegacyPhraseRecord = exports.LEGACY_PHRASE_RECORD_BRAND = exports.defineScript = void 0;

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;GAiBG;;;AAEH,iDAA+C;AAAtC,6GAAA,YAAY,OAAA;AAqCrB,uDAG+B;AAF7B,2HAAA,0BAA0B,OAAA;AAC1B,qHAAA,oBAAoB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;;;AAEH,iDAA+C;AAAtC,6GAAA,YAAY,OAAA;AAuCrB,uDAG+B;AAF7B,2HAAA,0BAA0B,OAAA;AAC1B,qHAAA,oBAAoB,OAAA"}

package/dist/types/asr-handle.d.ts

@@ -1,7 +1,11 @@
 import { Observable } from 'rxjs';
 /**
- * Voice Activity Detection (VAD) tuning — used when the runtime attaches an energy/Silero-based
- * VAD in front of the ASR connector. Exact semantics depend on the telephony VAD implementation.
+ * Voice Activity Detection (VAD) tuning.
+ *
+ * SIP sessions use the call-level telephony VAD when available. WS sessions create one
+ * VAD instance for the whole socket session on the first `createAsr()` call and merge
+ * these options with runtime defaults. When no VAD is available, audio is forwarded to
+ * ASR continuously and most VAD observables are empty.
  */
 export interface AsrVadConfig {
     /** Energy threshold to start speech detection (0.0–1.0). */
@@ -14,14 +18,19 @@ export interface AsrVadConfig {
     energyFloor?: number;
     /** Smoothing factor for noise floor estimation (0.0–1.0). */
     noiseFloorAlpha?: number;
-    /** Frames of PCM (typically 20 ms @ 8 kHz) to prepend before detected speech start. */
+    /** Frames of PCM (typically 20 ms @ 16 kHz / 640 bytes) to prepend before detected speech start. */
     preSpeechFrames?: number;
-    /** Silence frames after speech before confirming end-of-speech. */
+    /** Frames of post-speech PCM to still forward to ASR after VAD speech end. */
     postSpeechFrames?: number;
 }
 /**
  * Smart turn-taking — controls when the runtime finalizes an utterance (end-of-turn) while
  * streaming audio to ASR. Reduces cutting off the user mid-sentence when enabled.
+ *
+ * On WS sessions these values are passed to the telephony VAD/SmartTurn service.
+ * On SIP sessions, `enabled: true` also ensures the ASR connector has an
+ * `utterance_end_ms` value (defaulting to `1000`) when the resolved connector config
+ * did not already provide one.
  */
 export interface AsrSmartTurnConfig {
     /** When `true`, turn-taking heuristics are applied (defaults vary by host). */
@@ -52,8 +61,8 @@ export interface AsrSmartTurnConfig {
  * - If neither is set, credentials fall back to the usual **`authentication_data.asr.<engine>`**
  *   blob for the resolved vendor (main/reserved keys on the agent).
  *
- * You may also set the same selector as **`data.name`**; it must not be sent to the ASR vendor
- * as a connector field — the runtime strips it when merging config.
+ * You may also set the same selector as **`data.name`**. The runtime treats it as
+ * the storage-row selector and strips it before sending connector params to the ASR vendor.
  *
  * ### Vendor
  *
@@ -76,10 +85,12 @@ export interface AsrConfig {
     /** Recognition language (BCP-47), e.g. `"ru-RU"`. Passed through to the connector as `language`. */
     language?: string;
     /**
-     * Vendor-specific connection parameters (URLs, timeouts, model ids, …). Merged last over
-     * catalog credentials so the script can override per call. Primitive values are stringified.
-     * Do not rely on **`name`** here for third-party “model name” fields — use a key not consumed
-     * as the storage row selector, or set **`name`** only at the top level.
+     * Vendor-specific connection parameters (URLs, timeouts, model ids, nested JSON, …).
+     * Merged last over channel defaults and catalog credentials so the script can override
+     * per call. Primitives are stringified; objects and arrays are JSON-serialized.
+     *
+     * Do not rely on **`name`** here for third-party “model name” fields — the runtime consumes
+     * it as the storage row selector and removes it before vendor config is built.
      */
     data?: Record<string, unknown>;
     /** Optional VAD tuning for this session (see host implementation). */
@@ -91,8 +102,11 @@ export interface AsrConfig {
  * Live speech recognition session returned by {@link import('./media-channel').MediaChannel.createAsr}.
  *
  * Subscribe to **`partial$`** / **`result$`** for transcripts; wire **`speechStart$`** /
- * **`speechEnd$`** / **`interrupt$`** for barge-in and UI. Always call **`destroy()`** when done
+ * **`speechEnd$`** / **`interrupt$`** for barge-in and UI. Call **`destroy()`** when done
  * (e.g. on `channel.events.terminated$`) to release connector and subscriptions.
+ *
+ * If connector creation fails, SIP/WS return a degraded handle: VAD observables still
+ * mirror the channel where possible, but `partial$` and `result$` do not emit real STT.
  */
 export interface AsrHandle {
     /** Opaque id (passed to `channel.textInput` helpers in automated tests). */
@@ -118,7 +132,7 @@ export interface AsrHandle {
     readonly interrupt$: Observable<void>;
     /** Normalized voice-activity probability 0–1 when the host exposes it; else may be inert. */
     readonly vadProbability$: Observable<number>;
-    /** Pause audio consumption by the recognizer (implementation may buffer). */
+    /** Pause forwarding new audio frames to the recognizer; skipped audio is not replayed. */
     pause(): void;
     /** Resume after {@link pause}. */
     resume(): void;

package/dist/types/asr-handle.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"asr-handle.d.ts","sourceRoot":"","sources":["../../src/types/asr-handle.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAElC;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,4DAA4D;IAC5D,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,0DAA0D;IAC1D,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,iEAAiE;IACjE,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,gCAAgC;IAChC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,6DAA6D;IAC7D,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,uFAAuF;IACvF,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,mEAAmE;IACnE,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,+EAA+E;IAC/E,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,oEAAoE;IACpE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,8EAA8E;IAC9E,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mEAAmE;IACnE,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,2EAA2E;IAC3E,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,4FAA4F;IAC5F,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,SAAS;IACxB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oGAAoG;IACpG,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,sEAAsE;IACtE,GAAG,CAAC,EAAE,YAAY,CAAC;IACnB,mDAAmD;IACnD,SAAS,CAAC,EAAE,kBAAkB,CAAC;CAChC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,SAAS;IACxB,4EAA4E;IAC5E,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;IACrC;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAClE,kEAAkE;IAClE,QAAQ,CAAC,YAAY,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;IACxC,wDAAwD;IACxD,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;IACtC,gFAAgF;IAChF,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;IACtC,6FAA6F;IAC7F,QAAQ,CAAC,eAAe,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;IAE7C,6EAA6E;IAC7E,KAAK,IAAI,IAAI,CAAC;IACd,kCAAkC;IAClC,MAAM,IAAI,IAAI,CAAC;IACf,kFAAkF;IAClF,QAAQ,IAAI,IAAI,CAAC;IACjB,8FAA8F;IAC9F,OAAO,IAAI,IAAI,CAAC;CACjB"}
+{"version":3,"file":"asr-handle.d.ts","sourceRoot":"","sources":["../../src/types/asr-handle.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAElC;;;;;;;GAOG;AACH,MAAM,WAAW,YAAY;IAC3B,4DAA4D;IAC5D,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,0DAA0D;IAC1D,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,iEAAiE;IACjE,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,gCAAgC;IAChC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,6DAA6D;IAC7D,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,oGAAoG;IACpG,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,8EAA8E;IAC9E,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,kBAAkB;IACjC,+EAA+E;IAC/E,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,oEAAoE;IACpE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,8EAA8E;IAC9E,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mEAAmE;IACnE,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,2EAA2E;IAC3E,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,4FAA4F;IAC5F,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,SAAS;IACxB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oGAAoG;IACpG,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,sEAAsE;IACtE,GAAG,CAAC,EAAE,YAAY,CAAC;IACnB,mDAAmD;IACnD,SAAS,CAAC,EAAE,kBAAkB,CAAC;CAChC;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,SAAS;IACxB,4EAA4E;IAC5E,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;IACrC;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAClE,kEAAkE;IAClE,QAAQ,CAAC,YAAY,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;IACxC,wDAAwD;IACxD,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;IACtC,gFAAgF;IAChF,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;IACtC,6FAA6F;IAC7F,QAAQ,CAAC,eAAe,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;IAE7C,0FAA0F;IAC1F,KAAK,IAAI,IAAI,CAAC;IACd,kCAAkC;IAClC,MAAM,IAAI,IAAI,CAAC;IACf,kFAAkF;IAClF,QAAQ,IAAI,IAAI,CAAC;IACjB,8FAA8F;IAC9F,OAAO,IAAI,IAAI,CAAC;CACjB"}

package/dist/types/events.d.ts

@@ -1,20 +1,20 @@
 /** DTMF digit event from the remote party. */
 export interface DtmfEvent {
-    /** The pressed digit (`"0"`–`"9"`, `"*"`, `"#"`). */
+    /** The pressed digit. SIP emits `0`–`9`, `*`, `#`; WS input also accepts `A`–`D`. */
     digit: string;
-    /** Duration of the tone in milliseconds. */
+    /** Duration of the tone in milliseconds, normalized by the channel when available. */
     duration: number;
 }
 /** Incoming SIP INFO message. */
 export interface SipInfo {
-    /** MIME content type (e.g. `"application/dtmf-relay"`). */
+    /** MIME content type (e.g. `"application/dtmf-relay"`). May be empty for low-level Sofia events. */
     contentType: string;
-    /** Message body. */
+    /** Message body. May be empty for low-level Sofia events. */
     body: string;
 }
 /** SIP call state change signal. */
 export interface SipSignal {
-    /** Call state (e.g. `"ringing"`, `"confirmed"`, `"terminated"`). */
+    /** Raw telephony/Sofia call state, not normalized to SDK `SipState`. */
     state: string;
     /** SIP response status code (e.g. `200`, `486`). */
     statusCode?: number;
@@ -23,11 +23,11 @@ export interface SipSignal {
     /** SDP body (for media negotiation events). */
     sdp?: string;
 }
-/** Arbitrary data message (used for WS data channel communication). */
+/** Arbitrary data message used for WS data-channel communication between script and client. */
 export interface DataMessage {
     /** Event name / type identifier. */
     event: string;
-    /** Event payload (any JSON-serializable data). */
+    /** Event payload. Keep it JSON-serializable for WS clients and worker proxying. */
     payload: unknown;
 }
 //# sourceMappingURL=events.d.ts.map

package/dist/types/events.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/types/events.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,MAAM,WAAW,SAAS;IACxB,qDAAqD;IACrD,KAAK,EAAE,MAAM,CAAC;IACd,4CAA4C;IAC5C,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,iCAAiC;AACjC,MAAM,WAAW,OAAO;IACtB,2DAA2D;IAC3D,WAAW,EAAE,MAAM,CAAC;IACpB,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,oCAAoC;AACpC,MAAM,WAAW,SAAS;IACxB,oEAAoE;IACpE,KAAK,EAAE,MAAM,CAAC;IACd,oDAAoD;IACpD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kCAAkC;IAClC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,+CAA+C;IAC/C,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,uEAAuE;AACvE,MAAM,WAAW,WAAW;IAC1B,oCAAoC;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,kDAAkD;IAClD,OAAO,EAAE,OAAO,CAAC;CAClB"}
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/types/events.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,MAAM,WAAW,SAAS;IACxB,qFAAqF;IACrF,KAAK,EAAE,MAAM,CAAC;IACd,sFAAsF;IACtF,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,iCAAiC;AACjC,MAAM,WAAW,OAAO;IACtB,oGAAoG;IACpG,WAAW,EAAE,MAAM,CAAC;IACpB,6DAA6D;IAC7D,IAAI,EAAE,MAAM,CAAC;CACd;AAED,oCAAoC;AACpC,MAAM,WAAW,SAAS;IACxB,wEAAwE;IACxE,KAAK,EAAE,MAAM,CAAC;IACd,oDAAoD;IACpD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kCAAkC;IAClC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,+CAA+C;IAC/C,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,+FAA+F;AAC/F,MAAM,WAAW,WAAW;IAC1B,oCAAoC;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,mFAAmF;IACnF,OAAO,EAAE,OAAO,CAAC;CAClB"}

package/dist/types/legacy-phrase.d.ts

@@ -2,7 +2,8 @@
  * Marker for pre-recorded phrase rows loaded from the Voctiv platform LE PostgreSQL DB
  * ({@link PlatformApi.getRecords}). Pass to {@link ChannelAudio.play} instead of a URL/path string.
  *
- * Only used when Voctiv platform compatibility mode is enabled.
+ * Only used when Voctiv platform compatibility mode is enabled and the server has resolved
+ * a trusted LE agent id/UUID plus `LEGACY_V3_RECORD_PHRASE_ROOT`.
  */
 export declare const LEGACY_PHRASE_RECORD_BRAND: "__legacyPhraseRecord";
 export interface LegacyPhraseRecord {
@@ -17,18 +18,24 @@ export interface LegacyPhraseRecord {
 export declare function isLegacyPhraseRecord(source: unknown): source is LegacyPhraseRecord;
 /** Parameters for {@link PlatformApi.getRecords} (Voctiv platform LE `RecordPhrase` / `record_phrase_file`). */
 export interface LegacyGetRecordsParams {
+    /** Phrase group/name (`record_phrase.name`). */
     phraseName: string;
+    /** Business flag used by the phrase catalog, normally `context.flag`. */
     flag: string;
+    /** Language key used by the phrase catalog, normally `context.language`. */
     language: string;
 }
 /**
- * When set on {@link PlayOptions}, after TTS the audio is copied under the Voctiv platform record-phrase root
- * and a `record_phrase` / `record_phrase_file` row is inserted so {@link PlatformApi.getRecords}
- * can retrieve it. Also registers the PCM in the TTS file cache for subsequent `say`/`presay`.
+ * When set on {@link PlayOptions}, after TTS the audio is copied under the Voctiv platform
+ * record-phrase root and a `record_phrase` / `record_phrase_file` row is inserted so
+ * {@link PlatformApi.getRecords} can retrieve it. Also registers the PCM in the TTS file
+ * cache for subsequent `say`/`presay`.
  *
- * Only honored when Voctiv platform compatibility mode is active and `LEGACY_V3_RECORD_PHRASE_ROOT` is set.
+ * Only honored when Voctiv platform compatibility mode is active, `LEGACY_V3_RECORD_PHRASE_ROOT`
+ * is set, TTS cache is available, and the server resolved a trusted LE agent id/UUID.
  */
 export interface LegacySavePhraseOptions {
+    /** Phrase group/name to create or update. */
     phraseName: string;
     /** Defaults to dialog `flag` from channel params when omitted. */
     flag?: string;

package/dist/types/legacy-phrase.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"legacy-phrase.d.ts","sourceRoot":"","sources":["../../src/types/legacy-phrase.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B,wBAAkC,CAAC;AAE1E,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,CAAC,0BAA0B,CAAC,EAAE,IAAI,CAAC;IAC5C,yGAAyG;IACzG,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,yCAAyC;IACzC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,0CAA0C;IAC1C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;AAED,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,kBAAkB,CAOlF;AAED,gHAAgH;AAChH,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,uBAAuB;IACtC,UAAU,EAAE,MAAM,CAAC;IACnB,kEAAkE;IAClE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oEAAoE;IACpE,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB"}
+{"version":3,"file":"legacy-phrase.d.ts","sourceRoot":"","sources":["../../src/types/legacy-phrase.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,eAAO,MAAM,0BAA0B,wBAAkC,CAAC;AAE1E,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,CAAC,0BAA0B,CAAC,EAAE,IAAI,CAAC;IAC5C,yGAAyG;IACzG,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,yCAAyC;IACzC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,0CAA0C;IAC1C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;AAED,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,kBAAkB,CAOlF;AAED,gHAAgH;AAChH,MAAM,WAAW,sBAAsB;IACrC,gDAAgD;IAChD,UAAU,EAAE,MAAM,CAAC;IACnB,yEAAyE;IACzE,IAAI,EAAE,MAAM,CAAC;IACb,4EAA4E;IAC5E,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,uBAAuB;IACtC,6CAA6C;IAC7C,UAAU,EAAE,MAAM,CAAC;IACnB,kEAAkE;IAClE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oEAAoE;IACpE,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB"}

package/dist/types/legacy-phrase.js

@@ -6,7 +6,8 @@ exports.isLegacyPhraseRecord = isLegacyPhraseRecord;
  * Marker for pre-recorded phrase rows loaded from the Voctiv platform LE PostgreSQL DB
  * ({@link PlatformApi.getRecords}). Pass to {@link ChannelAudio.play} instead of a URL/path string.
  *
- * Only used when Voctiv platform compatibility mode is enabled.
+ * Only used when Voctiv platform compatibility mode is enabled and the server has resolved
+ * a trusted LE agent id/UUID plus `LEGACY_V3_RECORD_PHRASE_ROOT`.
  */
 exports.LEGACY_PHRASE_RECORD_BRAND = '__legacyPhraseRecord';
 function isLegacyPhraseRecord(source) {

package/dist/types/legacy-phrase.js.map

@@ -1 +1 @@
-{"version":3,"file":"legacy-phrase.js","sourceRoot":"","sources":["../../src/types/legacy-phrase.ts"],"names":[],"mappings":";;;AAkBA,oDAOC;AAzBD;;;;;GAKG;AACU,QAAA,0BAA0B,GAAG,sBAA+B,CAAC;AAY1E,SAAgB,oBAAoB,CAAC,MAAe;IAClD,OAAO,CACL,OAAO,MAAM,KAAK,QAAQ;QAC1B,MAAM,KAAK,IAAI;QACd,MAA6B,CAAC,kCAA0B,CAAC,KAAK,IAAI;QACnE,OAAQ,MAA6B,CAAC,IAAI,KAAK,QAAQ,CACxD,CAAC;AACJ,CAAC"}
+{"version":3,"file":"legacy-phrase.js","sourceRoot":"","sources":["../../src/types/legacy-phrase.ts"],"names":[],"mappings":";;;AAmBA,oDAOC;AA1BD;;;;;;GAMG;AACU,QAAA,0BAA0B,GAAG,sBAA+B,CAAC;AAY1E,SAAgB,oBAAoB,CAAC,MAAe;IAClD,OAAO,CACL,OAAO,MAAM,KAAK,QAAQ;QAC1B,MAAM,KAAK,IAAI;QACd,MAA6B,CAAC,kCAA0B,CAAC,KAAK,IAAI;QACnE,OAAQ,MAA6B,CAAC,IAAI,KAAK,QAAQ,CACxD,CAAC;AACJ,CAAC"}

package/dist/types/logger.d.ts

@@ -3,6 +3,8 @@
  *
  * In Voctiv platform compatibility mode, log entries are also batch-written
  * to the `dialog_stats` DB table (equivalent of old LE `nn.log`).
+ * In all modes they go to the API process logger. Debug streaming, when enabled,
+ * forwards only logs from the current script session to the configured debug endpoint.
  */
 export interface ScriptLogger {
     /** Info-level log entry. */
@@ -11,7 +13,7 @@ export interface ScriptLogger {
     warn(message: string, data?: Record<string, unknown>): void;
     /** Error-level log entry. */
     error(message: string, data?: Record<string, unknown>): void;
-    /** Debug-level log entry (not written to DB, only to stdout). */
+    /** Debug-level log entry; intended for process/debug stream output rather than legacy DB stats. */
     debug(message: string, data?: Record<string, unknown>): void;
     /**
      * Enable real-time log streaming to a remote debug endpoint.

package/dist/types/logger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/types/logger.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,4BAA4B;IAC5B,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAC3D,+BAA+B;IAC/B,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAC5D,6BAA6B;IAC7B,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAC7D,iEAAiE;IACjE,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAE7D;;;;;;OAMG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC,kEAAkE;IAClE,YAAY,IAAI,IAAI,CAAC;IAErB;;;;;;;;;OASG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9E"}
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/types/logger.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,WAAW,YAAY;IAC3B,4BAA4B;IAC5B,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAC3D,+BAA+B;IAC/B,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAC5D,6BAA6B;IAC7B,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAC7D,mGAAmG;IACnG,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAE7D;;;;;;OAMG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC,kEAAkE;IAClE,YAAY,IAAI,IAAI,CAAC;IAErB;;;;;;;;;OASG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9E"}