@livekit/agents 1.0.46 → 1.0.47

package/dist/voice/index.cjs

@@ -31,6 +31,7 @@ var voice_exports = {};
 __export(voice_exports, {
   Agent: () => import_agent.Agent,
   AgentSession: () => import_agent_session.AgentSession,
+  AgentTask: () => import_agent.AgentTask,
   RunContext: () => import_run_context.RunContext,
   StopResponse: () => import_agent.StopResponse,
   testing: () => testing
@@ -50,6 +51,7 @@ var testing = __toESM(require("./testing/index.cjs"), 1);
 0 && (module.exports = {
   Agent,
   AgentSession,
+  AgentTask,
   RunContext,
   StopResponse,
   testing,

package/dist/voice/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/voice/index.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2025 LiveKit, Inc.\n//\n// SPDX-License-Identifier: Apache-2.0\nexport { Agent, StopResponse, type AgentOptions, type ModelSettings } from './agent.js';\nexport { AgentSession, type AgentSessionOptions, type VoiceOptions } from './agent_session.js';\nexport * from './avatar/index.js';\nexport * from './background_audio.js';\nexport * from './events.js';\nexport { type TimedString } from './io.js';\nexport * from './report.js';\nexport * from './room_io/index.js';\nexport { RunContext } from './run_context.js';\nexport * as testing from './testing/index.js';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAGA,mBAA2E;AAC3E,2BAA0E;AAC1E,0BAAc,8BALd;AAMA,0BAAc,kCANd;AAOA,0BAAc,wBAPd;AAQA,gBAAiC;AACjC,0BAAc,wBATd;AAUA,0BAAc,+BAVd;AAWA,yBAA2B;AAC3B,cAAyB;","names":[]}
+{"version":3,"sources":["../../src/voice/index.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2025 LiveKit, Inc.\n//\n// SPDX-License-Identifier: Apache-2.0\nexport { Agent, AgentTask, StopResponse, type AgentOptions, type ModelSettings } from './agent.js';\nexport { AgentSession, type AgentSessionOptions, type VoiceOptions } from './agent_session.js';\nexport * from './avatar/index.js';\nexport * from './background_audio.js';\nexport * from './events.js';\nexport { type TimedString } from './io.js';\nexport * from './report.js';\nexport * from './room_io/index.js';\nexport { RunContext } from './run_context.js';\nexport * as testing from './testing/index.js';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAGA,mBAAsF;AACtF,2BAA0E;AAC1E,0BAAc,8BALd;AAMA,0BAAc,kCANd;AAOA,0BAAc,wBAPd;AAQA,gBAAiC;AACjC,0BAAc,wBATd;AAUA,0BAAc,+BAVd;AAWA,yBAA2B;AAC3B,cAAyB;","names":[]}

package/dist/voice/index.d.cts

@@ -1,4 +1,4 @@
-export { Agent, StopResponse, type AgentOptions, type ModelSettings } from './agent.js';
+export { Agent, AgentTask, StopResponse, type AgentOptions, type ModelSettings } from './agent.js';
 export { AgentSession, type AgentSessionOptions, type VoiceOptions } from './agent_session.js';
 export * from './avatar/index.js';
 export * from './background_audio.js';

package/dist/voice/index.d.ts

@@ -1,4 +1,4 @@
-export { Agent, StopResponse, type AgentOptions, type ModelSettings } from './agent.js';
+export { Agent, AgentTask, StopResponse, type AgentOptions, type ModelSettings } from './agent.js';
 export { AgentSession, type AgentSessionOptions, type VoiceOptions } from './agent_session.js';
 export * from './avatar/index.js';
 export * from './background_audio.js';

package/dist/voice/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/voice/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,YAAY,EAAE,KAAK,aAAa,EAAE,MAAM,YAAY,CAAC;AACxF,OAAO,EAAE,YAAY,EAAE,KAAK,mBAAmB,EAAE,KAAK,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAC/F,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,SAAS,CAAC;AAC3C,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AACnC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,KAAK,OAAO,MAAM,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/voice/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,KAAK,YAAY,EAAE,KAAK,aAAa,EAAE,MAAM,YAAY,CAAC;AACnG,OAAO,EAAE,YAAY,EAAE,KAAK,mBAAmB,EAAE,KAAK,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAC/F,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,SAAS,CAAC;AAC3C,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AACnC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,KAAK,OAAO,MAAM,oBAAoB,CAAC"}

package/dist/voice/index.js

@@ -1,4 +1,4 @@
-import { Agent, StopResponse } from "./agent.js";
+import { Agent, AgentTask, StopResponse } from "./agent.js";
 import { AgentSession } from "./agent_session.js";
 export * from "./avatar/index.js";
 export * from "./background_audio.js";
@@ -11,6 +11,7 @@ import * as testing from "./testing/index.js";
 export {
   Agent,
   AgentSession,
+  AgentTask,
   RunContext,
   StopResponse,
   testing

package/dist/voice/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/voice/index.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2025 LiveKit, Inc.\n//\n// SPDX-License-Identifier: Apache-2.0\nexport { Agent, StopResponse, type AgentOptions, type ModelSettings } from './agent.js';\nexport { AgentSession, type AgentSessionOptions, type VoiceOptions } from './agent_session.js';\nexport * from './avatar/index.js';\nexport * from './background_audio.js';\nexport * from './events.js';\nexport { type TimedString } from './io.js';\nexport * from './report.js';\nexport * from './room_io/index.js';\nexport { RunContext } from './run_context.js';\nexport * as testing from './testing/index.js';\n"],"mappings":"AAGA,SAAS,OAAO,oBAA2D;AAC3E,SAAS,oBAAiE;AAC1E,cAAc;AACd,cAAc;AACd,cAAc;AACd,eAAiC;AACjC,cAAc;AACd,cAAc;AACd,SAAS,kBAAkB;AAC3B,YAAY,aAAa;","names":[]}
+{"version":3,"sources":["../../src/voice/index.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2025 LiveKit, Inc.\n//\n// SPDX-License-Identifier: Apache-2.0\nexport { Agent, AgentTask, StopResponse, type AgentOptions, type ModelSettings } from './agent.js';\nexport { AgentSession, type AgentSessionOptions, type VoiceOptions } from './agent_session.js';\nexport * from './avatar/index.js';\nexport * from './background_audio.js';\nexport * from './events.js';\nexport { type TimedString } from './io.js';\nexport * from './report.js';\nexport * from './room_io/index.js';\nexport { RunContext } from './run_context.js';\nexport * as testing from './testing/index.js';\n"],"mappings":"AAGA,SAAS,OAAO,WAAW,oBAA2D;AACtF,SAAS,oBAAiE;AAC1E,cAAc;AACd,cAAc;AACd,cAAc;AACd,eAAiC;AACjC,cAAc;AACd,cAAc;AACd,SAAS,kBAAkB;AAC3B,YAAY,aAAa;","names":[]}

package/dist/voice/speech_handle.cjs

@@ -58,6 +58,8 @@ class SpeechHandle {
   _numSteps = 1;
   /** @internal - OpenTelemetry context for the agent turn span */
   _agentTurnContext;
+  /** @internal - used by AgentTask/RunResult final output plumbing */
+  _maybeRunFinalOutput;
   itemAddedCallbacks = /* @__PURE__ */ new Set();
   doneCallbacks = /* @__PURE__ */ new Set();
   /** @internal Symbol marker for type identification */
@@ -128,7 +130,7 @@ class SpeechHandle {
    * has entirely played out, including any tool calls and response follow-ups.
    */
   async waitForPlayout() {
-    const store = import_agent.asyncLocalStorage.getStore();
+    const store = import_agent.functionCallStorage.getStore();
     if (store && (store == null ? void 0 : store.functionCall)) {
       throw new Error(
         `Cannot call 'SpeechHandle.waitForPlayout()' from inside the function tool '${store.functionCall.name}'. This creates a circular wait: the speech handle is waiting for the function tool to complete, while the function tool is simultaneously waiting for the speech handle.
@@ -143,6 +145,10 @@ To wait for the assistant's spoken response prior to running this tool, use RunC
     await Promise.race(fs);
   }
   addDoneCallback(callback) {
+    if (this.done()) {
+      queueMicrotask(() => callback(this));
+      return;
+    }
     this.doneCallbacks.add(callback);
   }
   removeDoneCallback(callback) {

package/dist/voice/speech_handle.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/voice/speech_handle.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2024 LiveKit, Inc.\n//\n// SPDX-License-Identifier: Apache-2.0\nimport type { Context } from '@opentelemetry/api';\nimport type { ChatItem } from '../llm/index.js';\nimport type { Task } from '../utils.js';\nimport { Event, Future, shortuuid } from '../utils.js';\nimport { asyncLocalStorage } from './agent.js';\n\n/** Symbol used to identify SpeechHandle instances */\nconst SPEECH_HANDLE_SYMBOL = Symbol.for('livekit.agents.SpeechHandle');\n\n/**\n * Type guard to check if a value is a SpeechHandle.\n */\nexport function isSpeechHandle(value: unknown): value is SpeechHandle {\n  return (\n    typeof value === 'object' &&\n    value !== null &&\n    SPEECH_HANDLE_SYMBOL in value &&\n    (value as Record<symbol, boolean>)[SPEECH_HANDLE_SYMBOL] === true\n  );\n}\n\nexport class SpeechHandle {\n  /** Priority for messages that should be played after all other messages in the queue */\n  static SPEECH_PRIORITY_LOW = 0;\n  /** Every speech generates by the VoiceAgent defaults to this priority. */\n  static SPEECH_PRIORITY_NORMAL = 5;\n  /** Priority for important messages that should be played before others. */\n  static SPEECH_PRIORITY_HIGH = 10;\n\n  private interruptFut = new Future<void>();\n  private authorizedEvent = new Event();\n  private scheduledFut = new Future<void>();\n  private doneFut = new Future<void>();\n  private generations: Future<void>[] = [];\n  private _chatItems: ChatItem[] = [];\n\n  /** @internal */\n  _tasks: Task<void>[] = [];\n\n  /** @internal */\n  _numSteps = 1;\n\n  /** @internal - OpenTelemetry context for the agent turn span */\n  _agentTurnContext?: Context;\n\n  private itemAddedCallbacks: Set<(item: ChatItem) => void> = new Set();\n  private doneCallbacks: Set<(sh: SpeechHandle) => void> = new Set();\n\n  /** @internal Symbol marker for type identification */\n  readonly [SPEECH_HANDLE_SYMBOL] = true;\n\n  constructor(\n    private _id: string,\n    private _allowInterruptions: boolean,\n    /** @internal */\n    public _stepIndex: number,\n    readonly parent?: SpeechHandle,\n  ) {\n    this.doneFut.await.finally(() => {\n      for (const callback of this.doneCallbacks) {\n        callback(this);\n      }\n    });\n  }\n\n  static create(options?: {\n    allowInterruptions?: boolean;\n    stepIndex?: number;\n    parent?: SpeechHandle;\n  }) {\n    const { allowInterruptions = true, stepIndex = 0, parent } = options ?? {};\n\n    return new SpeechHandle(shortuuid('speech_'), allowInterruptions, stepIndex, parent);\n  }\n\n  get interrupted(): boolean {\n    return this.interruptFut.done;\n  }\n\n  get numSteps(): number {\n    return this._numSteps;\n  }\n\n  get id(): string {\n    return this._id;\n  }\n\n  get scheduled(): boolean {\n    return this.scheduledFut.done;\n  }\n\n  get allowInterruptions(): boolean {\n    return this._allowInterruptions;\n  }\n\n  /**\n   * Allow or disallow interruptions on this SpeechHandle.\n   *\n   * When set to false, the SpeechHandle will no longer accept any incoming\n   * interruption requests until re-enabled. If the handle is already\n   * interrupted, clearing interruptions is not allowed.\n   *\n   * @param value - true to allow interruptions, false to disallow\n   * @throws Error If attempting to disable interruptions when already interrupted\n   */\n  set allowInterruptions(value: boolean) {\n    if (this.interrupted && !value) {\n      throw new Error(\n        'Cannot set allow_interruptions to False, the SpeechHandle is already interrupted',\n      );\n    }\n    this._allowInterruptions = value;\n  }\n\n  done(): boolean {\n    return this.doneFut.done;\n  }\n\n  get chatItems(): ChatItem[] {\n    return this._chatItems;\n  }\n\n  /**\n   * Interrupt the current speech generation.\n   *\n   * @throws Error If this speech handle does not allow interruptions.\n   *\n   * @returns The same speech handle that was interrupted.\n   */\n  interrupt(force: boolean = false): SpeechHandle {\n    if (!force && !this.allowInterruptions) {\n      throw new Error('This generation handle does not allow interruptions');\n    }\n\n    this._cancel();\n    return this;\n  }\n\n  /**\n   * Waits for the entire assistant turn to complete playback.\n   *\n   * This method waits until the assistant has fully finished speaking,\n   * including any finalization steps beyond initial response generation.\n   * This is appropriate to call when you want to ensure the speech output\n   * has entirely played out, including any tool calls and response follow-ups.\n   */\n  async waitForPlayout(): Promise<void> {\n    const store = asyncLocalStorage.getStore();\n    if (store && store?.functionCall) {\n      throw new Error(\n        `Cannot call 'SpeechHandle.waitForPlayout()' from inside the function tool '${store.functionCall.name}'. ` +\n          'This creates a circular wait: the speech handle is waiting for the function tool to complete, ' +\n          'while the function tool is simultaneously waiting for the speech handle.\\n' +\n          \"To wait for the assistant's spoken response prior to running this tool, use RunContext.wait_for_playout() instead.\",\n      );\n    }\n    await this.doneFut.await;\n  }\n\n  async waitIfNotInterrupted(aw: Promise<unknown>[]): Promise<void> {\n    const allTasksPromise = Promise.all(aw);\n    const fs: Promise<unknown>[] = [allTasksPromise, this.interruptFut.await];\n    await Promise.race(fs);\n  }\n\n  addDoneCallback(callback: (sh: SpeechHandle) => void) {\n    this.doneCallbacks.add(callback);\n  }\n\n  removeDoneCallback(callback: (sh: SpeechHandle) => void) {\n    this.doneCallbacks.delete(callback);\n  }\n\n  /** @internal */\n  _cancel(): SpeechHandle {\n    if (this.done()) {\n      return this;\n    }\n\n    if (!this.interruptFut.done) {\n      this.interruptFut.resolve();\n    }\n\n    return this;\n  }\n\n  /** @internal */\n  _authorizeGeneration(): void {\n    const fut = new Future<void>();\n    this.generations.push(fut);\n    this.authorizedEvent.set();\n  }\n\n  /** @internal */\n  _clearAuthorization(): void {\n    this.authorizedEvent.clear();\n  }\n\n  /** @internal */\n  async _waitForAuthorization(): Promise<void> {\n    await this.authorizedEvent.wait();\n  }\n\n  /** @internal */\n  async _waitForGeneration(stepIdx: number = -1): Promise<void> {\n    if (this.generations.length === 0) {\n      throw new Error('cannot use wait_for_generation: no active generation is running.');\n    }\n\n    const index = stepIdx === -1 ? this.generations.length - 1 : stepIdx;\n    const generation = this.generations[index];\n    if (!generation) {\n      throw new Error(`Generation at index ${index} not found.`);\n    }\n    return generation.await;\n  }\n\n  /** @internal */\n  async _waitForScheduled(): Promise<void> {\n    return this.scheduledFut.await;\n  }\n\n  /** @internal */\n  _markGenerationDone(): void {\n    if (this.generations.length === 0) {\n      throw new Error('cannot use mark_generation_done: no active generation is running.');\n    }\n\n    const lastGeneration = this.generations[this.generations.length - 1];\n    if (lastGeneration && !lastGeneration.done) {\n      lastGeneration.resolve();\n    }\n  }\n\n  /** @internal */\n  _markDone(): void {\n    if (!this.doneFut.done) {\n      this.doneFut.resolve();\n      if (this.generations.length > 0) {\n        this._markGenerationDone(); // preemptive generation could be cancelled before being scheduled\n      }\n    }\n  }\n\n  /** @internal */\n  _markScheduled(): void {\n    if (!this.scheduledFut.done) {\n      this.scheduledFut.resolve();\n    }\n  }\n\n  /** @internal */\n  _addItemAddedCallback(callback: (item: ChatItem) => void): void {\n    this.itemAddedCallbacks.add(callback);\n  }\n\n  /** @internal */\n  _removeItemAddedCallback(callback: (item: ChatItem) => void): void {\n    this.itemAddedCallbacks.delete(callback);\n  }\n\n  /** @internal */\n  _itemAdded(items: ChatItem[]): void {\n    for (const item of items) {\n      for (const cb of this.itemAddedCallbacks) {\n        cb(item);\n      }\n      this._chatItems.push(item);\n    }\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAMA,mBAAyC;AACzC,mBAAkC;AAGlC,MAAM,uBAAuB,OAAO,IAAI,6BAA6B;AAK9D,SAAS,eAAe,OAAuC;AACpE,SACE,OAAO,UAAU,YACjB,UAAU,QACV,wBAAwB,SACvB,MAAkC,oBAAoB,MAAM;AAEjE;AAEO,MAAM,aAAa;AAAA,EA8BxB,YACU,KACA,qBAED,YACE,QACT;AALQ;AACA;AAED;AACE;AAET,SAAK,QAAQ,MAAM,QAAQ,MAAM;AAC/B,iBAAW,YAAY,KAAK,eAAe;AACzC,iBAAS,IAAI;AAAA,MACf;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA,EAxCA,OAAO,sBAAsB;AAAA;AAAA,EAE7B,OAAO,yBAAyB;AAAA;AAAA,EAEhC,OAAO,uBAAuB;AAAA,EAEtB,eAAe,IAAI,oBAAa;AAAA,EAChC,kBAAkB,IAAI,mBAAM;AAAA,EAC5B,eAAe,IAAI,oBAAa;AAAA,EAChC,UAAU,IAAI,oBAAa;AAAA,EAC3B,cAA8B,CAAC;AAAA,EAC/B,aAAyB,CAAC;AAAA;AAAA,EAGlC,SAAuB,CAAC;AAAA;AAAA,EAGxB,YAAY;AAAA;AAAA,EAGZ;AAAA,EAEQ,qBAAoD,oBAAI,IAAI;AAAA,EAC5D,gBAAiD,oBAAI,IAAI;AAAA;AAAA,EAGjE,CAAU,oBAAoB,IAAI;AAAA,EAgBlC,OAAO,OAAO,SAIX;AACD,UAAM,EAAE,qBAAqB,MAAM,YAAY,GAAG,OAAO,IAAI,WAAW,CAAC;AAEzE,WAAO,IAAI,iBAAa,wBAAU,SAAS,GAAG,oBAAoB,WAAW,MAAM;AAAA,EACrF;AAAA,EAEA,IAAI,cAAuB;AACzB,WAAO,KAAK,aAAa;AAAA,EAC3B;AAAA,EAEA,IAAI,WAAmB;AACrB,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,IAAI,KAAa;AACf,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,IAAI,YAAqB;AACvB,WAAO,KAAK,aAAa;AAAA,EAC3B;AAAA,EAEA,IAAI,qBAA8B;AAChC,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,IAAI,mBAAmB,OAAgB;AACrC,QAAI,KAAK,eAAe,CAAC,OAAO;AAC9B,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AACA,SAAK,sBAAsB;AAAA,EAC7B;AAAA,EAEA,OAAgB;AACd,WAAO,KAAK,QAAQ;AAAA,EACtB;AAAA,EAEA,IAAI,YAAwB;AAC1B,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,UAAU,QAAiB,OAAqB;AAC9C,QAAI,CAAC,SAAS,CAAC,KAAK,oBAAoB;AACtC,YAAM,IAAI,MAAM,qDAAqD;AAAA,IACvE;AAEA,SAAK,QAAQ;AACb,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,iBAAgC;AACpC,UAAM,QAAQ,+BAAkB,SAAS;AACzC,QAAI,UAAS,+BAAO,eAAc;AAChC,YAAM,IAAI;AAAA,QACR,8EAA8E,MAAM,aAAa,IAAI;AAAA;AAAA,MAIvG;AAAA,IACF;AACA,UAAM,KAAK,QAAQ;AAAA,EACrB;AAAA,EAEA,MAAM,qBAAqB,IAAuC;AAChE,UAAM,kBAAkB,QAAQ,IAAI,EAAE;AACtC,UAAM,KAAyB,CAAC,iBAAiB,KAAK,aAAa,KAAK;AACxE,UAAM,QAAQ,KAAK,EAAE;AAAA,EACvB;AAAA,EAEA,gBAAgB,UAAsC;AACpD,SAAK,cAAc,IAAI,QAAQ;AAAA,EACjC;AAAA,EAEA,mBAAmB,UAAsC;AACvD,SAAK,cAAc,OAAO,QAAQ;AAAA,EACpC;AAAA;AAAA,EAGA,UAAwB;AACtB,QAAI,KAAK,KAAK,GAAG;AACf,aAAO;AAAA,IACT;AAEA,QAAI,CAAC,KAAK,aAAa,MAAM;AAC3B,WAAK,aAAa,QAAQ;AAAA,IAC5B;AAEA,WAAO;AAAA,EACT;AAAA;AAAA,EAGA,uBAA6B;AAC3B,UAAM,MAAM,IAAI,oBAAa;AAC7B,SAAK,YAAY,KAAK,GAAG;AACzB,SAAK,gBAAgB,IAAI;AAAA,EAC3B;AAAA;AAAA,EAGA,sBAA4B;AAC1B,SAAK,gBAAgB,MAAM;AAAA,EAC7B;AAAA;AAAA,EAGA,MAAM,wBAAuC;AAC3C,UAAM,KAAK,gBAAgB,KAAK;AAAA,EAClC;AAAA;AAAA,EAGA,MAAM,mBAAmB,UAAkB,IAAmB;AAC5D,QAAI,KAAK,YAAY,WAAW,GAAG;AACjC,YAAM,IAAI,MAAM,kEAAkE;AAAA,IACpF;AAEA,UAAM,QAAQ,YAAY,KAAK,KAAK,YAAY,SAAS,IAAI;AAC7D,UAAM,aAAa,KAAK,YAAY,KAAK;AACzC,QAAI,CAAC,YAAY;AACf,YAAM,IAAI,MAAM,uBAAuB,KAAK,aAAa;AAAA,IAC3D;AACA,WAAO,WAAW;AAAA,EACpB;AAAA;AAAA,EAGA,MAAM,oBAAmC;AACvC,WAAO,KAAK,aAAa;AAAA,EAC3B;AAAA;AAAA,EAGA,sBAA4B;AAC1B,QAAI,KAAK,YAAY,WAAW,GAAG;AACjC,YAAM,IAAI,MAAM,mEAAmE;AAAA,IACrF;AAEA,UAAM,iBAAiB,KAAK,YAAY,KAAK,YAAY,SAAS,CAAC;AACnE,QAAI,kBAAkB,CAAC,eAAe,MAAM;AAC1C,qBAAe,QAAQ;AAAA,IACzB;AAAA,EACF;AAAA;AAAA,EAGA,YAAkB;AAChB,QAAI,CAAC,KAAK,QAAQ,MAAM;AACtB,WAAK,QAAQ,QAAQ;AACrB,UAAI,KAAK,YAAY,SAAS,GAAG;AAC/B,aAAK,oBAAoB;AAAA,MAC3B;AAAA,IACF;AAAA,EACF;AAAA;AAAA,EAGA,iBAAuB;AACrB,QAAI,CAAC,KAAK,aAAa,MAAM;AAC3B,WAAK,aAAa,QAAQ;AAAA,IAC5B;AAAA,EACF;AAAA;AAAA,EAGA,sBAAsB,UAA0C;AAC9D,SAAK,mBAAmB,IAAI,QAAQ;AAAA,EACtC;AAAA;AAAA,EAGA,yBAAyB,UAA0C;AACjE,SAAK,mBAAmB,OAAO,QAAQ;AAAA,EACzC;AAAA;AAAA,EAGA,WAAW,OAAyB;AAClC,eAAW,QAAQ,OAAO;AACxB,iBAAW,MAAM,KAAK,oBAAoB;AACxC,WAAG,IAAI;AAAA,MACT;AACA,WAAK,WAAW,KAAK,IAAI;AAAA,IAC3B;AAAA,EACF;AACF;","names":[]}
+{"version":3,"sources":["../../src/voice/speech_handle.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2024 LiveKit, Inc.\n//\n// SPDX-License-Identifier: Apache-2.0\nimport type { Context } from '@opentelemetry/api';\nimport type { ChatItem } from '../llm/index.js';\nimport type { Task } from '../utils.js';\nimport { Event, Future, shortuuid } from '../utils.js';\nimport { functionCallStorage } from './agent.js';\n\n/** Symbol used to identify SpeechHandle instances */\nconst SPEECH_HANDLE_SYMBOL = Symbol.for('livekit.agents.SpeechHandle');\n\n/**\n * Type guard to check if a value is a SpeechHandle.\n */\nexport function isSpeechHandle(value: unknown): value is SpeechHandle {\n  return (\n    typeof value === 'object' &&\n    value !== null &&\n    SPEECH_HANDLE_SYMBOL in value &&\n    (value as Record<symbol, boolean>)[SPEECH_HANDLE_SYMBOL] === true\n  );\n}\n\nexport class SpeechHandle {\n  /** Priority for messages that should be played after all other messages in the queue */\n  static SPEECH_PRIORITY_LOW = 0;\n  /** Every speech generates by the VoiceAgent defaults to this priority. */\n  static SPEECH_PRIORITY_NORMAL = 5;\n  /** Priority for important messages that should be played before others. */\n  static SPEECH_PRIORITY_HIGH = 10;\n\n  private interruptFut = new Future<void>();\n  private authorizedEvent = new Event();\n  private scheduledFut = new Future<void>();\n  private doneFut = new Future<void>();\n  private generations: Future<void>[] = [];\n  private _chatItems: ChatItem[] = [];\n\n  /** @internal */\n  _tasks: Task<void>[] = [];\n\n  /** @internal */\n  _numSteps = 1;\n\n  /** @internal - OpenTelemetry context for the agent turn span */\n  _agentTurnContext?: Context;\n\n  /** @internal - used by AgentTask/RunResult final output plumbing */\n  _maybeRunFinalOutput?: unknown;\n\n  private itemAddedCallbacks: Set<(item: ChatItem) => void> = new Set();\n  private doneCallbacks: Set<(sh: SpeechHandle) => void> = new Set();\n\n  /** @internal Symbol marker for type identification */\n  readonly [SPEECH_HANDLE_SYMBOL] = true;\n\n  constructor(\n    private _id: string,\n    private _allowInterruptions: boolean,\n    /** @internal */\n    public _stepIndex: number,\n    readonly parent?: SpeechHandle,\n  ) {\n    this.doneFut.await.finally(() => {\n      for (const callback of this.doneCallbacks) {\n        callback(this);\n      }\n    });\n  }\n\n  static create(options?: {\n    allowInterruptions?: boolean;\n    stepIndex?: number;\n    parent?: SpeechHandle;\n  }) {\n    const { allowInterruptions = true, stepIndex = 0, parent } = options ?? {};\n\n    return new SpeechHandle(shortuuid('speech_'), allowInterruptions, stepIndex, parent);\n  }\n\n  get interrupted(): boolean {\n    return this.interruptFut.done;\n  }\n\n  get numSteps(): number {\n    return this._numSteps;\n  }\n\n  get id(): string {\n    return this._id;\n  }\n\n  get scheduled(): boolean {\n    return this.scheduledFut.done;\n  }\n\n  get allowInterruptions(): boolean {\n    return this._allowInterruptions;\n  }\n\n  /**\n   * Allow or disallow interruptions on this SpeechHandle.\n   *\n   * When set to false, the SpeechHandle will no longer accept any incoming\n   * interruption requests until re-enabled. If the handle is already\n   * interrupted, clearing interruptions is not allowed.\n   *\n   * @param value - true to allow interruptions, false to disallow\n   * @throws Error If attempting to disable interruptions when already interrupted\n   */\n  set allowInterruptions(value: boolean) {\n    if (this.interrupted && !value) {\n      throw new Error(\n        'Cannot set allow_interruptions to False, the SpeechHandle is already interrupted',\n      );\n    }\n    this._allowInterruptions = value;\n  }\n\n  done(): boolean {\n    return this.doneFut.done;\n  }\n\n  get chatItems(): ChatItem[] {\n    return this._chatItems;\n  }\n\n  /**\n   * Interrupt the current speech generation.\n   *\n   * @throws Error If this speech handle does not allow interruptions.\n   *\n   * @returns The same speech handle that was interrupted.\n   */\n  interrupt(force: boolean = false): SpeechHandle {\n    if (!force && !this.allowInterruptions) {\n      throw new Error('This generation handle does not allow interruptions');\n    }\n\n    this._cancel();\n    return this;\n  }\n\n  /**\n   * Waits for the entire assistant turn to complete playback.\n   *\n   * This method waits until the assistant has fully finished speaking,\n   * including any finalization steps beyond initial response generation.\n   * This is appropriate to call when you want to ensure the speech output\n   * has entirely played out, including any tool calls and response follow-ups.\n   */\n  async waitForPlayout(): Promise<void> {\n    const store = functionCallStorage.getStore();\n    if (store && store?.functionCall) {\n      throw new Error(\n        `Cannot call 'SpeechHandle.waitForPlayout()' from inside the function tool '${store.functionCall.name}'. ` +\n          'This creates a circular wait: the speech handle is waiting for the function tool to complete, ' +\n          'while the function tool is simultaneously waiting for the speech handle.\\n' +\n          \"To wait for the assistant's spoken response prior to running this tool, use RunContext.wait_for_playout() instead.\",\n      );\n    }\n    await this.doneFut.await;\n  }\n\n  async waitIfNotInterrupted(aw: Promise<unknown>[]): Promise<void> {\n    const allTasksPromise = Promise.all(aw);\n    const fs: Promise<unknown>[] = [allTasksPromise, this.interruptFut.await];\n    await Promise.race(fs);\n  }\n\n  addDoneCallback(callback: (sh: SpeechHandle) => void) {\n    if (this.done()) {\n      queueMicrotask(() => callback(this));\n      return;\n    }\n    this.doneCallbacks.add(callback);\n  }\n\n  removeDoneCallback(callback: (sh: SpeechHandle) => void) {\n    this.doneCallbacks.delete(callback);\n  }\n\n  /** @internal */\n  _cancel(): SpeechHandle {\n    if (this.done()) {\n      return this;\n    }\n\n    if (!this.interruptFut.done) {\n      this.interruptFut.resolve();\n    }\n\n    return this;\n  }\n\n  /** @internal */\n  _authorizeGeneration(): void {\n    const fut = new Future<void>();\n    this.generations.push(fut);\n    this.authorizedEvent.set();\n  }\n\n  /** @internal */\n  _clearAuthorization(): void {\n    this.authorizedEvent.clear();\n  }\n\n  /** @internal */\n  async _waitForAuthorization(): Promise<void> {\n    await this.authorizedEvent.wait();\n  }\n\n  /** @internal */\n  async _waitForGeneration(stepIdx: number = -1): Promise<void> {\n    if (this.generations.length === 0) {\n      throw new Error('cannot use wait_for_generation: no active generation is running.');\n    }\n\n    const index = stepIdx === -1 ? this.generations.length - 1 : stepIdx;\n    const generation = this.generations[index];\n    if (!generation) {\n      throw new Error(`Generation at index ${index} not found.`);\n    }\n    return generation.await;\n  }\n\n  /** @internal */\n  async _waitForScheduled(): Promise<void> {\n    return this.scheduledFut.await;\n  }\n\n  /** @internal */\n  _markGenerationDone(): void {\n    if (this.generations.length === 0) {\n      throw new Error('cannot use mark_generation_done: no active generation is running.');\n    }\n\n    const lastGeneration = this.generations[this.generations.length - 1];\n    if (lastGeneration && !lastGeneration.done) {\n      lastGeneration.resolve();\n    }\n  }\n\n  /** @internal */\n  _markDone(): void {\n    if (!this.doneFut.done) {\n      this.doneFut.resolve();\n      if (this.generations.length > 0) {\n        this._markGenerationDone(); // preemptive generation could be cancelled before being scheduled\n      }\n    }\n  }\n\n  /** @internal */\n  _markScheduled(): void {\n    if (!this.scheduledFut.done) {\n      this.scheduledFut.resolve();\n    }\n  }\n\n  /** @internal */\n  _addItemAddedCallback(callback: (item: ChatItem) => void): void {\n    this.itemAddedCallbacks.add(callback);\n  }\n\n  /** @internal */\n  _removeItemAddedCallback(callback: (item: ChatItem) => void): void {\n    this.itemAddedCallbacks.delete(callback);\n  }\n\n  /** @internal */\n  _itemAdded(items: ChatItem[]): void {\n    for (const item of items) {\n      for (const cb of this.itemAddedCallbacks) {\n        cb(item);\n      }\n      this._chatItems.push(item);\n    }\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAMA,mBAAyC;AACzC,mBAAoC;AAGpC,MAAM,uBAAuB,OAAO,IAAI,6BAA6B;AAK9D,SAAS,eAAe,OAAuC;AACpE,SACE,OAAO,UAAU,YACjB,UAAU,QACV,wBAAwB,SACvB,MAAkC,oBAAoB,MAAM;AAEjE;AAEO,MAAM,aAAa;AAAA,EAiCxB,YACU,KACA,qBAED,YACE,QACT;AALQ;AACA;AAED;AACE;AAET,SAAK,QAAQ,MAAM,QAAQ,MAAM;AAC/B,iBAAW,YAAY,KAAK,eAAe;AACzC,iBAAS,IAAI;AAAA,MACf;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA,EA3CA,OAAO,sBAAsB;AAAA;AAAA,EAE7B,OAAO,yBAAyB;AAAA;AAAA,EAEhC,OAAO,uBAAuB;AAAA,EAEtB,eAAe,IAAI,oBAAa;AAAA,EAChC,kBAAkB,IAAI,mBAAM;AAAA,EAC5B,eAAe,IAAI,oBAAa;AAAA,EAChC,UAAU,IAAI,oBAAa;AAAA,EAC3B,cAA8B,CAAC;AAAA,EAC/B,aAAyB,CAAC;AAAA;AAAA,EAGlC,SAAuB,CAAC;AAAA;AAAA,EAGxB,YAAY;AAAA;AAAA,EAGZ;AAAA;AAAA,EAGA;AAAA,EAEQ,qBAAoD,oBAAI,IAAI;AAAA,EAC5D,gBAAiD,oBAAI,IAAI;AAAA;AAAA,EAGjE,CAAU,oBAAoB,IAAI;AAAA,EAgBlC,OAAO,OAAO,SAIX;AACD,UAAM,EAAE,qBAAqB,MAAM,YAAY,GAAG,OAAO,IAAI,WAAW,CAAC;AAEzE,WAAO,IAAI,iBAAa,wBAAU,SAAS,GAAG,oBAAoB,WAAW,MAAM;AAAA,EACrF;AAAA,EAEA,IAAI,cAAuB;AACzB,WAAO,KAAK,aAAa;AAAA,EAC3B;AAAA,EAEA,IAAI,WAAmB;AACrB,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,IAAI,KAAa;AACf,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,IAAI,YAAqB;AACvB,WAAO,KAAK,aAAa;AAAA,EAC3B;AAAA,EAEA,IAAI,qBAA8B;AAChC,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,IAAI,mBAAmB,OAAgB;AACrC,QAAI,KAAK,eAAe,CAAC,OAAO;AAC9B,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AACA,SAAK,sBAAsB;AAAA,EAC7B;AAAA,EAEA,OAAgB;AACd,WAAO,KAAK,QAAQ;AAAA,EACtB;AAAA,EAEA,IAAI,YAAwB;AAC1B,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,UAAU,QAAiB,OAAqB;AAC9C,QAAI,CAAC,SAAS,CAAC,KAAK,oBAAoB;AACtC,YAAM,IAAI,MAAM,qDAAqD;AAAA,IACvE;AAEA,SAAK,QAAQ;AACb,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,iBAAgC;AACpC,UAAM,QAAQ,iCAAoB,SAAS;AAC3C,QAAI,UAAS,+BAAO,eAAc;AAChC,YAAM,IAAI;AAAA,QACR,8EAA8E,MAAM,aAAa,IAAI;AAAA;AAAA,MAIvG;AAAA,IACF;AACA,UAAM,KAAK,QAAQ;AAAA,EACrB;AAAA,EAEA,MAAM,qBAAqB,IAAuC;AAChE,UAAM,kBAAkB,QAAQ,IAAI,EAAE;AACtC,UAAM,KAAyB,CAAC,iBAAiB,KAAK,aAAa,KAAK;AACxE,UAAM,QAAQ,KAAK,EAAE;AAAA,EACvB;AAAA,EAEA,gBAAgB,UAAsC;AACpD,QAAI,KAAK,KAAK,GAAG;AACf,qBAAe,MAAM,SAAS,IAAI,CAAC;AACnC;AAAA,IACF;AACA,SAAK,cAAc,IAAI,QAAQ;AAAA,EACjC;AAAA,EAEA,mBAAmB,UAAsC;AACvD,SAAK,cAAc,OAAO,QAAQ;AAAA,EACpC;AAAA;AAAA,EAGA,UAAwB;AACtB,QAAI,KAAK,KAAK,GAAG;AACf,aAAO;AAAA,IACT;AAEA,QAAI,CAAC,KAAK,aAAa,MAAM;AAC3B,WAAK,aAAa,QAAQ;AAAA,IAC5B;AAEA,WAAO;AAAA,EACT;AAAA;AAAA,EAGA,uBAA6B;AAC3B,UAAM,MAAM,IAAI,oBAAa;AAC7B,SAAK,YAAY,KAAK,GAAG;AACzB,SAAK,gBAAgB,IAAI;AAAA,EAC3B;AAAA;AAAA,EAGA,sBAA4B;AAC1B,SAAK,gBAAgB,MAAM;AAAA,EAC7B;AAAA;AAAA,EAGA,MAAM,wBAAuC;AAC3C,UAAM,KAAK,gBAAgB,KAAK;AAAA,EAClC;AAAA;AAAA,EAGA,MAAM,mBAAmB,UAAkB,IAAmB;AAC5D,QAAI,KAAK,YAAY,WAAW,GAAG;AACjC,YAAM,IAAI,MAAM,kEAAkE;AAAA,IACpF;AAEA,UAAM,QAAQ,YAAY,KAAK,KAAK,YAAY,SAAS,IAAI;AAC7D,UAAM,aAAa,KAAK,YAAY,KAAK;AACzC,QAAI,CAAC,YAAY;AACf,YAAM,IAAI,MAAM,uBAAuB,KAAK,aAAa;AAAA,IAC3D;AACA,WAAO,WAAW;AAAA,EACpB;AAAA;AAAA,EAGA,MAAM,oBAAmC;AACvC,WAAO,KAAK,aAAa;AAAA,EAC3B;AAAA;AAAA,EAGA,sBAA4B;AAC1B,QAAI,KAAK,YAAY,WAAW,GAAG;AACjC,YAAM,IAAI,MAAM,mEAAmE;AAAA,IACrF;AAEA,UAAM,iBAAiB,KAAK,YAAY,KAAK,YAAY,SAAS,CAAC;AACnE,QAAI,kBAAkB,CAAC,eAAe,MAAM;AAC1C,qBAAe,QAAQ;AAAA,IACzB;AAAA,EACF;AAAA;AAAA,EAGA,YAAkB;AAChB,QAAI,CAAC,KAAK,QAAQ,MAAM;AACtB,WAAK,QAAQ,QAAQ;AACrB,UAAI,KAAK,YAAY,SAAS,GAAG;AAC/B,aAAK,oBAAoB;AAAA,MAC3B;AAAA,IACF;AAAA,EACF;AAAA;AAAA,EAGA,iBAAuB;AACrB,QAAI,CAAC,KAAK,aAAa,MAAM;AAC3B,WAAK,aAAa,QAAQ;AAAA,IAC5B;AAAA,EACF;AAAA;AAAA,EAGA,sBAAsB,UAA0C;AAC9D,SAAK,mBAAmB,IAAI,QAAQ;AAAA,EACtC;AAAA;AAAA,EAGA,yBAAyB,UAA0C;AACjE,SAAK,mBAAmB,OAAO,QAAQ;AAAA,EACzC;AAAA;AAAA,EAGA,WAAW,OAAyB;AAClC,eAAW,QAAQ,OAAO;AACxB,iBAAW,MAAM,KAAK,oBAAoB;AACxC,WAAG,IAAI;AAAA,MACT;AACA,WAAK,WAAW,KAAK,IAAI;AAAA,IAC3B;AAAA,EACF;AACF;","names":[]}

package/dist/voice/speech_handle.d.cts

@@ -31,6 +31,8 @@ export declare class SpeechHandle {
     _numSteps: number;
     /** @internal - OpenTelemetry context for the agent turn span */
     _agentTurnContext?: Context;
+    /** @internal - used by AgentTask/RunResult final output plumbing */
+    _maybeRunFinalOutput?: unknown;
     private itemAddedCallbacks;
     private doneCallbacks;
     /** @internal Symbol marker for type identification */

package/dist/voice/speech_handle.d.ts

@@ -31,6 +31,8 @@ export declare class SpeechHandle {
     _numSteps: number;
     /** @internal - OpenTelemetry context for the agent turn span */
     _agentTurnContext?: Context;
+    /** @internal - used by AgentTask/RunResult final output plumbing */
+    _maybeRunFinalOutput?: unknown;
     private itemAddedCallbacks;
     private doneCallbacks;
     /** @internal Symbol marker for type identification */

package/dist/voice/speech_handle.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"speech_handle.d.ts","sourceRoot":"","sources":["../../src/voice/speech_handle.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAIxC,qDAAqD;AACrD,QAAA,MAAM,oBAAoB,eAA4C,CAAC;AAEvE;;GAEG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,YAAY,CAOpE;AAED,qBAAa,YAAY;IA+BrB,OAAO,CAAC,GAAG;IACX,OAAO,CAAC,mBAAmB;IAC3B,gBAAgB;IACT,UAAU,EAAE,MAAM;IACzB,QAAQ,CAAC,MAAM,CAAC;IAlClB,wFAAwF;IACxF,MAAM,CAAC,mBAAmB,SAAK;IAC/B,0EAA0E;IAC1E,MAAM,CAAC,sBAAsB,SAAK;IAClC,2EAA2E;IAC3E,MAAM,CAAC,oBAAoB,SAAM;IAEjC,OAAO,CAAC,YAAY,CAAsB;IAC1C,OAAO,CAAC,eAAe,CAAe;IACtC,OAAO,CAAC,YAAY,CAAsB;IAC1C,OAAO,CAAC,OAAO,CAAsB;IACrC,OAAO,CAAC,WAAW,CAAsB;IACzC,OAAO,CAAC,UAAU,CAAkB;IAEpC,gBAAgB;IAChB,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAM;IAE1B,gBAAgB;IAChB,SAAS,SAAK;IAEd,gEAAgE;IAChE,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B,OAAO,CAAC,kBAAkB,CAA4C;IACtE,OAAO,CAAC,aAAa,CAA8C;IAEnE,sDAAsD;IACtD,QAAQ,CAAC,CAAC,oBAAoB,CAAC,QAAQ;gBAG7B,GAAG,EAAE,MAAM,EACX,mBAAmB,EAAE,OAAO;IACpC,gBAAgB;IACT,UAAU,EAAE,MAAM,EAChB,MAAM,CAAC,0BAAc;IAShC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE;QACtB,kBAAkB,CAAC,EAAE,OAAO,CAAC;QAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,MAAM,CAAC,EAAE,YAAY,CAAC;KACvB;IAMD,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED,IAAI,EAAE,IAAI,MAAM,CAEf;IAED,IAAI,SAAS,IAAI,OAAO,CAEvB;IAED,IAAI,kBAAkB,IAAI,OAAO,CAEhC;IAED;;;;;;;;;OASG;IACH,IAAI,kBAAkB,CAAC,KAAK,EAAE,OAAO,EAOpC;IAED,IAAI,IAAI,OAAO;IAIf,IAAI,SAAS,IAAI,QAAQ,EAAE,CAE1B;IAED;;;;;;OAMG;IACH,SAAS,CAAC,KAAK,GAAE,OAAe,GAAG,YAAY;IAS/C;;;;;;;OAOG;IACG,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAa/B,oBAAoB,CAAC,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAMjE,eAAe,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,YAAY,KAAK,IAAI;IAIpD,kBAAkB,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,YAAY,KAAK,IAAI;IAIvD,gBAAgB;IAChB,OAAO,IAAI,YAAY;IAYvB,gBAAgB;IAChB,oBAAoB,IAAI,IAAI;IAM5B,gBAAgB;IAChB,mBAAmB,IAAI,IAAI;IAI3B,gBAAgB;IACV,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5C,gBAAgB;IACV,kBAAkB,CAAC,OAAO,GAAE,MAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAa7D,gBAAgB;IACV,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC;IAIxC,gBAAgB;IAChB,mBAAmB,IAAI,IAAI;IAW3B,gBAAgB;IAChB,SAAS,IAAI,IAAI;IASjB,gBAAgB;IAChB,cAAc,IAAI,IAAI;IAMtB,gBAAgB;IAChB,qBAAqB,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,IAAI,GAAG,IAAI;IAI/D,gBAAgB;IAChB,wBAAwB,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,IAAI,GAAG,IAAI;IAIlE,gBAAgB;IAChB,UAAU,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,IAAI;CAQpC"}
+{"version":3,"file":"speech_handle.d.ts","sourceRoot":"","sources":["../../src/voice/speech_handle.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAIxC,qDAAqD;AACrD,QAAA,MAAM,oBAAoB,eAA4C,CAAC;AAEvE;;GAEG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,YAAY,CAOpE;AAED,qBAAa,YAAY;IAkCrB,OAAO,CAAC,GAAG;IACX,OAAO,CAAC,mBAAmB;IAC3B,gBAAgB;IACT,UAAU,EAAE,MAAM;IACzB,QAAQ,CAAC,MAAM,CAAC;IArClB,wFAAwF;IACxF,MAAM,CAAC,mBAAmB,SAAK;IAC/B,0EAA0E;IAC1E,MAAM,CAAC,sBAAsB,SAAK;IAClC,2EAA2E;IAC3E,MAAM,CAAC,oBAAoB,SAAM;IAEjC,OAAO,CAAC,YAAY,CAAsB;IAC1C,OAAO,CAAC,eAAe,CAAe;IACtC,OAAO,CAAC,YAAY,CAAsB;IAC1C,OAAO,CAAC,OAAO,CAAsB;IACrC,OAAO,CAAC,WAAW,CAAsB;IACzC,OAAO,CAAC,UAAU,CAAkB;IAEpC,gBAAgB;IAChB,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAM;IAE1B,gBAAgB;IAChB,SAAS,SAAK;IAEd,gEAAgE;IAChE,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B,oEAAoE;IACpE,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B,OAAO,CAAC,kBAAkB,CAA4C;IACtE,OAAO,CAAC,aAAa,CAA8C;IAEnE,sDAAsD;IACtD,QAAQ,CAAC,CAAC,oBAAoB,CAAC,QAAQ;gBAG7B,GAAG,EAAE,MAAM,EACX,mBAAmB,EAAE,OAAO;IACpC,gBAAgB;IACT,UAAU,EAAE,MAAM,EAChB,MAAM,CAAC,0BAAc;IAShC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE;QACtB,kBAAkB,CAAC,EAAE,OAAO,CAAC;QAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,MAAM,CAAC,EAAE,YAAY,CAAC;KACvB;IAMD,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED,IAAI,EAAE,IAAI,MAAM,CAEf;IAED,IAAI,SAAS,IAAI,OAAO,CAEvB;IAED,IAAI,kBAAkB,IAAI,OAAO,CAEhC;IAED;;;;;;;;;OASG;IACH,IAAI,kBAAkB,CAAC,KAAK,EAAE,OAAO,EAOpC;IAED,IAAI,IAAI,OAAO;IAIf,IAAI,SAAS,IAAI,QAAQ,EAAE,CAE1B;IAED;;;;;;OAMG;IACH,SAAS,CAAC,KAAK,GAAE,OAAe,GAAG,YAAY;IAS/C;;;;;;;OAOG;IACG,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAa/B,oBAAoB,CAAC,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAMjE,eAAe,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,YAAY,KAAK,IAAI;IAQpD,kBAAkB,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,YAAY,KAAK,IAAI;IAIvD,gBAAgB;IAChB,OAAO,IAAI,YAAY;IAYvB,gBAAgB;IAChB,oBAAoB,IAAI,IAAI;IAM5B,gBAAgB;IAChB,mBAAmB,IAAI,IAAI;IAI3B,gBAAgB;IACV,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5C,gBAAgB;IACV,kBAAkB,CAAC,OAAO,GAAE,MAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAa7D,gBAAgB;IACV,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC;IAIxC,gBAAgB;IAChB,mBAAmB,IAAI,IAAI;IAW3B,gBAAgB;IAChB,SAAS,IAAI,IAAI;IASjB,gBAAgB;IAChB,cAAc,IAAI,IAAI;IAMtB,gBAAgB;IAChB,qBAAqB,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,IAAI,GAAG,IAAI;IAI/D,gBAAgB;IAChB,wBAAwB,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,IAAI,GAAG,IAAI;IAIlE,gBAAgB;IAChB,UAAU,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,IAAI;CAQpC"}

package/dist/voice/speech_handle.js

@@ -1,5 +1,5 @@
 import { Event, Future, shortuuid } from "../utils.js";
-import { asyncLocalStorage } from "./agent.js";
+import { functionCallStorage } from "./agent.js";
 const SPEECH_HANDLE_SYMBOL = Symbol.for("livekit.agents.SpeechHandle");
 function isSpeechHandle(value) {
   return typeof value === "object" && value !== null && SPEECH_HANDLE_SYMBOL in value && value[SPEECH_HANDLE_SYMBOL] === true;
@@ -34,6 +34,8 @@ class SpeechHandle {
   _numSteps = 1;
   /** @internal - OpenTelemetry context for the agent turn span */
   _agentTurnContext;
+  /** @internal - used by AgentTask/RunResult final output plumbing */
+  _maybeRunFinalOutput;
   itemAddedCallbacks = /* @__PURE__ */ new Set();
   doneCallbacks = /* @__PURE__ */ new Set();
   /** @internal Symbol marker for type identification */
@@ -104,7 +106,7 @@ class SpeechHandle {
    * has entirely played out, including any tool calls and response follow-ups.
    */
   async waitForPlayout() {
-    const store = asyncLocalStorage.getStore();
+    const store = functionCallStorage.getStore();
     if (store && (store == null ? void 0 : store.functionCall)) {
       throw new Error(
         `Cannot call 'SpeechHandle.waitForPlayout()' from inside the function tool '${store.functionCall.name}'. This creates a circular wait: the speech handle is waiting for the function tool to complete, while the function tool is simultaneously waiting for the speech handle.
@@ -119,6 +121,10 @@ To wait for the assistant's spoken response prior to running this tool, use RunC
     await Promise.race(fs);
   }
   addDoneCallback(callback) {
+    if (this.done()) {
+      queueMicrotask(() => callback(this));
+      return;
+    }
     this.doneCallbacks.add(callback);
   }
   removeDoneCallback(callback) {

package/dist/voice/speech_handle.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/voice/speech_handle.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2024 LiveKit, Inc.\n//\n// SPDX-License-Identifier: Apache-2.0\nimport type { Context } from '@opentelemetry/api';\nimport type { ChatItem } from '../llm/index.js';\nimport type { Task } from '../utils.js';\nimport { Event, Future, shortuuid } from '../utils.js';\nimport { asyncLocalStorage } from './agent.js';\n\n/** Symbol used to identify SpeechHandle instances */\nconst SPEECH_HANDLE_SYMBOL = Symbol.for('livekit.agents.SpeechHandle');\n\n/**\n * Type guard to check if a value is a SpeechHandle.\n */\nexport function isSpeechHandle(value: unknown): value is SpeechHandle {\n  return (\n    typeof value === 'object' &&\n    value !== null &&\n    SPEECH_HANDLE_SYMBOL in value &&\n    (value as Record<symbol, boolean>)[SPEECH_HANDLE_SYMBOL] === true\n  );\n}\n\nexport class SpeechHandle {\n  /** Priority for messages that should be played after all other messages in the queue */\n  static SPEECH_PRIORITY_LOW = 0;\n  /** Every speech generates by the VoiceAgent defaults to this priority. */\n  static SPEECH_PRIORITY_NORMAL = 5;\n  /** Priority for important messages that should be played before others. */\n  static SPEECH_PRIORITY_HIGH = 10;\n\n  private interruptFut = new Future<void>();\n  private authorizedEvent = new Event();\n  private scheduledFut = new Future<void>();\n  private doneFut = new Future<void>();\n  private generations: Future<void>[] = [];\n  private _chatItems: ChatItem[] = [];\n\n  /** @internal */\n  _tasks: Task<void>[] = [];\n\n  /** @internal */\n  _numSteps = 1;\n\n  /** @internal - OpenTelemetry context for the agent turn span */\n  _agentTurnContext?: Context;\n\n  private itemAddedCallbacks: Set<(item: ChatItem) => void> = new Set();\n  private doneCallbacks: Set<(sh: SpeechHandle) => void> = new Set();\n\n  /** @internal Symbol marker for type identification */\n  readonly [SPEECH_HANDLE_SYMBOL] = true;\n\n  constructor(\n    private _id: string,\n    private _allowInterruptions: boolean,\n    /** @internal */\n    public _stepIndex: number,\n    readonly parent?: SpeechHandle,\n  ) {\n    this.doneFut.await.finally(() => {\n      for (const callback of this.doneCallbacks) {\n        callback(this);\n      }\n    });\n  }\n\n  static create(options?: {\n    allowInterruptions?: boolean;\n    stepIndex?: number;\n    parent?: SpeechHandle;\n  }) {\n    const { allowInterruptions = true, stepIndex = 0, parent } = options ?? {};\n\n    return new SpeechHandle(shortuuid('speech_'), allowInterruptions, stepIndex, parent);\n  }\n\n  get interrupted(): boolean {\n    return this.interruptFut.done;\n  }\n\n  get numSteps(): number {\n    return this._numSteps;\n  }\n\n  get id(): string {\n    return this._id;\n  }\n\n  get scheduled(): boolean {\n    return this.scheduledFut.done;\n  }\n\n  get allowInterruptions(): boolean {\n    return this._allowInterruptions;\n  }\n\n  /**\n   * Allow or disallow interruptions on this SpeechHandle.\n   *\n   * When set to false, the SpeechHandle will no longer accept any incoming\n   * interruption requests until re-enabled. If the handle is already\n   * interrupted, clearing interruptions is not allowed.\n   *\n   * @param value - true to allow interruptions, false to disallow\n   * @throws Error If attempting to disable interruptions when already interrupted\n   */\n  set allowInterruptions(value: boolean) {\n    if (this.interrupted && !value) {\n      throw new Error(\n        'Cannot set allow_interruptions to False, the SpeechHandle is already interrupted',\n      );\n    }\n    this._allowInterruptions = value;\n  }\n\n  done(): boolean {\n    return this.doneFut.done;\n  }\n\n  get chatItems(): ChatItem[] {\n    return this._chatItems;\n  }\n\n  /**\n   * Interrupt the current speech generation.\n   *\n   * @throws Error If this speech handle does not allow interruptions.\n   *\n   * @returns The same speech handle that was interrupted.\n   */\n  interrupt(force: boolean = false): SpeechHandle {\n    if (!force && !this.allowInterruptions) {\n      throw new Error('This generation handle does not allow interruptions');\n    }\n\n    this._cancel();\n    return this;\n  }\n\n  /**\n   * Waits for the entire assistant turn to complete playback.\n   *\n   * This method waits until the assistant has fully finished speaking,\n   * including any finalization steps beyond initial response generation.\n   * This is appropriate to call when you want to ensure the speech output\n   * has entirely played out, including any tool calls and response follow-ups.\n   */\n  async waitForPlayout(): Promise<void> {\n    const store = asyncLocalStorage.getStore();\n    if (store && store?.functionCall) {\n      throw new Error(\n        `Cannot call 'SpeechHandle.waitForPlayout()' from inside the function tool '${store.functionCall.name}'. ` +\n          'This creates a circular wait: the speech handle is waiting for the function tool to complete, ' +\n          'while the function tool is simultaneously waiting for the speech handle.\\n' +\n          \"To wait for the assistant's spoken response prior to running this tool, use RunContext.wait_for_playout() instead.\",\n      );\n    }\n    await this.doneFut.await;\n  }\n\n  async waitIfNotInterrupted(aw: Promise<unknown>[]): Promise<void> {\n    const allTasksPromise = Promise.all(aw);\n    const fs: Promise<unknown>[] = [allTasksPromise, this.interruptFut.await];\n    await Promise.race(fs);\n  }\n\n  addDoneCallback(callback: (sh: SpeechHandle) => void) {\n    this.doneCallbacks.add(callback);\n  }\n\n  removeDoneCallback(callback: (sh: SpeechHandle) => void) {\n    this.doneCallbacks.delete(callback);\n  }\n\n  /** @internal */\n  _cancel(): SpeechHandle {\n    if (this.done()) {\n      return this;\n    }\n\n    if (!this.interruptFut.done) {\n      this.interruptFut.resolve();\n    }\n\n    return this;\n  }\n\n  /** @internal */\n  _authorizeGeneration(): void {\n    const fut = new Future<void>();\n    this.generations.push(fut);\n    this.authorizedEvent.set();\n  }\n\n  /** @internal */\n  _clearAuthorization(): void {\n    this.authorizedEvent.clear();\n  }\n\n  /** @internal */\n  async _waitForAuthorization(): Promise<void> {\n    await this.authorizedEvent.wait();\n  }\n\n  /** @internal */\n  async _waitForGeneration(stepIdx: number = -1): Promise<void> {\n    if (this.generations.length === 0) {\n      throw new Error('cannot use wait_for_generation: no active generation is running.');\n    }\n\n    const index = stepIdx === -1 ? this.generations.length - 1 : stepIdx;\n    const generation = this.generations[index];\n    if (!generation) {\n      throw new Error(`Generation at index ${index} not found.`);\n    }\n    return generation.await;\n  }\n\n  /** @internal */\n  async _waitForScheduled(): Promise<void> {\n    return this.scheduledFut.await;\n  }\n\n  /** @internal */\n  _markGenerationDone(): void {\n    if (this.generations.length === 0) {\n      throw new Error('cannot use mark_generation_done: no active generation is running.');\n    }\n\n    const lastGeneration = this.generations[this.generations.length - 1];\n    if (lastGeneration && !lastGeneration.done) {\n      lastGeneration.resolve();\n    }\n  }\n\n  /** @internal */\n  _markDone(): void {\n    if (!this.doneFut.done) {\n      this.doneFut.resolve();\n      if (this.generations.length > 0) {\n        this._markGenerationDone(); // preemptive generation could be cancelled before being scheduled\n      }\n    }\n  }\n\n  /** @internal */\n  _markScheduled(): void {\n    if (!this.scheduledFut.done) {\n      this.scheduledFut.resolve();\n    }\n  }\n\n  /** @internal */\n  _addItemAddedCallback(callback: (item: ChatItem) => void): void {\n    this.itemAddedCallbacks.add(callback);\n  }\n\n  /** @internal */\n  _removeItemAddedCallback(callback: (item: ChatItem) => void): void {\n    this.itemAddedCallbacks.delete(callback);\n  }\n\n  /** @internal */\n  _itemAdded(items: ChatItem[]): void {\n    for (const item of items) {\n      for (const cb of this.itemAddedCallbacks) {\n        cb(item);\n      }\n      this._chatItems.push(item);\n    }\n  }\n}\n"],"mappings":"AAMA,SAAS,OAAO,QAAQ,iBAAiB;AACzC,SAAS,yBAAyB;AAGlC,MAAM,uBAAuB,OAAO,IAAI,6BAA6B;AAK9D,SAAS,eAAe,OAAuC;AACpE,SACE,OAAO,UAAU,YACjB,UAAU,QACV,wBAAwB,SACvB,MAAkC,oBAAoB,MAAM;AAEjE;AAEO,MAAM,aAAa;AAAA,EA8BxB,YACU,KACA,qBAED,YACE,QACT;AALQ;AACA;AAED;AACE;AAET,SAAK,QAAQ,MAAM,QAAQ,MAAM;AAC/B,iBAAW,YAAY,KAAK,eAAe;AACzC,iBAAS,IAAI;AAAA,MACf;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA,EAxCA,OAAO,sBAAsB;AAAA;AAAA,EAE7B,OAAO,yBAAyB;AAAA;AAAA,EAEhC,OAAO,uBAAuB;AAAA,EAEtB,eAAe,IAAI,OAAa;AAAA,EAChC,kBAAkB,IAAI,MAAM;AAAA,EAC5B,eAAe,IAAI,OAAa;AAAA,EAChC,UAAU,IAAI,OAAa;AAAA,EAC3B,cAA8B,CAAC;AAAA,EAC/B,aAAyB,CAAC;AAAA;AAAA,EAGlC,SAAuB,CAAC;AAAA;AAAA,EAGxB,YAAY;AAAA;AAAA,EAGZ;AAAA,EAEQ,qBAAoD,oBAAI,IAAI;AAAA,EAC5D,gBAAiD,oBAAI,IAAI;AAAA;AAAA,EAGjE,CAAU,oBAAoB,IAAI;AAAA,EAgBlC,OAAO,OAAO,SAIX;AACD,UAAM,EAAE,qBAAqB,MAAM,YAAY,GAAG,OAAO,IAAI,WAAW,CAAC;AAEzE,WAAO,IAAI,aAAa,UAAU,SAAS,GAAG,oBAAoB,WAAW,MAAM;AAAA,EACrF;AAAA,EAEA,IAAI,cAAuB;AACzB,WAAO,KAAK,aAAa;AAAA,EAC3B;AAAA,EAEA,IAAI,WAAmB;AACrB,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,IAAI,KAAa;AACf,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,IAAI,YAAqB;AACvB,WAAO,KAAK,aAAa;AAAA,EAC3B;AAAA,EAEA,IAAI,qBAA8B;AAChC,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,IAAI,mBAAmB,OAAgB;AACrC,QAAI,KAAK,eAAe,CAAC,OAAO;AAC9B,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AACA,SAAK,sBAAsB;AAAA,EAC7B;AAAA,EAEA,OAAgB;AACd,WAAO,KAAK,QAAQ;AAAA,EACtB;AAAA,EAEA,IAAI,YAAwB;AAC1B,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,UAAU,QAAiB,OAAqB;AAC9C,QAAI,CAAC,SAAS,CAAC,KAAK,oBAAoB;AACtC,YAAM,IAAI,MAAM,qDAAqD;AAAA,IACvE;AAEA,SAAK,QAAQ;AACb,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,iBAAgC;AACpC,UAAM,QAAQ,kBAAkB,SAAS;AACzC,QAAI,UAAS,+BAAO,eAAc;AAChC,YAAM,IAAI;AAAA,QACR,8EAA8E,MAAM,aAAa,IAAI;AAAA;AAAA,MAIvG;AAAA,IACF;AACA,UAAM,KAAK,QAAQ;AAAA,EACrB;AAAA,EAEA,MAAM,qBAAqB,IAAuC;AAChE,UAAM,kBAAkB,QAAQ,IAAI,EAAE;AACtC,UAAM,KAAyB,CAAC,iBAAiB,KAAK,aAAa,KAAK;AACxE,UAAM,QAAQ,KAAK,EAAE;AAAA,EACvB;AAAA,EAEA,gBAAgB,UAAsC;AACpD,SAAK,cAAc,IAAI,QAAQ;AAAA,EACjC;AAAA,EAEA,mBAAmB,UAAsC;AACvD,SAAK,cAAc,OAAO,QAAQ;AAAA,EACpC;AAAA;AAAA,EAGA,UAAwB;AACtB,QAAI,KAAK,KAAK,GAAG;AACf,aAAO;AAAA,IACT;AAEA,QAAI,CAAC,KAAK,aAAa,MAAM;AAC3B,WAAK,aAAa,QAAQ;AAAA,IAC5B;AAEA,WAAO;AAAA,EACT;AAAA;AAAA,EAGA,uBAA6B;AAC3B,UAAM,MAAM,IAAI,OAAa;AAC7B,SAAK,YAAY,KAAK,GAAG;AACzB,SAAK,gBAAgB,IAAI;AAAA,EAC3B;AAAA;AAAA,EAGA,sBAA4B;AAC1B,SAAK,gBAAgB,MAAM;AAAA,EAC7B;AAAA;AAAA,EAGA,MAAM,wBAAuC;AAC3C,UAAM,KAAK,gBAAgB,KAAK;AAAA,EAClC;AAAA;AAAA,EAGA,MAAM,mBAAmB,UAAkB,IAAmB;AAC5D,QAAI,KAAK,YAAY,WAAW,GAAG;AACjC,YAAM,IAAI,MAAM,kEAAkE;AAAA,IACpF;AAEA,UAAM,QAAQ,YAAY,KAAK,KAAK,YAAY,SAAS,IAAI;AAC7D,UAAM,aAAa,KAAK,YAAY,KAAK;AACzC,QAAI,CAAC,YAAY;AACf,YAAM,IAAI,MAAM,uBAAuB,KAAK,aAAa;AAAA,IAC3D;AACA,WAAO,WAAW;AAAA,EACpB;AAAA;AAAA,EAGA,MAAM,oBAAmC;AACvC,WAAO,KAAK,aAAa;AAAA,EAC3B;AAAA;AAAA,EAGA,sBAA4B;AAC1B,QAAI,KAAK,YAAY,WAAW,GAAG;AACjC,YAAM,IAAI,MAAM,mEAAmE;AAAA,IACrF;AAEA,UAAM,iBAAiB,KAAK,YAAY,KAAK,YAAY,SAAS,CAAC;AACnE,QAAI,kBAAkB,CAAC,eAAe,MAAM;AAC1C,qBAAe,QAAQ;AAAA,IACzB;AAAA,EACF;AAAA;AAAA,EAGA,YAAkB;AAChB,QAAI,CAAC,KAAK,QAAQ,MAAM;AACtB,WAAK,QAAQ,QAAQ;AACrB,UAAI,KAAK,YAAY,SAAS,GAAG;AAC/B,aAAK,oBAAoB;AAAA,MAC3B;AAAA,IACF;AAAA,EACF;AAAA;AAAA,EAGA,iBAAuB;AACrB,QAAI,CAAC,KAAK,aAAa,MAAM;AAC3B,WAAK,aAAa,QAAQ;AAAA,IAC5B;AAAA,EACF;AAAA;AAAA,EAGA,sBAAsB,UAA0C;AAC9D,SAAK,mBAAmB,IAAI,QAAQ;AAAA,EACtC;AAAA;AAAA,EAGA,yBAAyB,UAA0C;AACjE,SAAK,mBAAmB,OAAO,QAAQ;AAAA,EACzC;AAAA;AAAA,EAGA,WAAW,OAAyB;AAClC,eAAW,QAAQ,OAAO;AACxB,iBAAW,MAAM,KAAK,oBAAoB;AACxC,WAAG,IAAI;AAAA,MACT;AACA,WAAK,WAAW,KAAK,IAAI;AAAA,IAC3B;AAAA,EACF;AACF;","names":[]}
+{"version":3,"sources":["../../src/voice/speech_handle.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2024 LiveKit, Inc.\n//\n// SPDX-License-Identifier: Apache-2.0\nimport type { Context } from '@opentelemetry/api';\nimport type { ChatItem } from '../llm/index.js';\nimport type { Task } from '../utils.js';\nimport { Event, Future, shortuuid } from '../utils.js';\nimport { functionCallStorage } from './agent.js';\n\n/** Symbol used to identify SpeechHandle instances */\nconst SPEECH_HANDLE_SYMBOL = Symbol.for('livekit.agents.SpeechHandle');\n\n/**\n * Type guard to check if a value is a SpeechHandle.\n */\nexport function isSpeechHandle(value: unknown): value is SpeechHandle {\n  return (\n    typeof value === 'object' &&\n    value !== null &&\n    SPEECH_HANDLE_SYMBOL in value &&\n    (value as Record<symbol, boolean>)[SPEECH_HANDLE_SYMBOL] === true\n  );\n}\n\nexport class SpeechHandle {\n  /** Priority for messages that should be played after all other messages in the queue */\n  static SPEECH_PRIORITY_LOW = 0;\n  /** Every speech generates by the VoiceAgent defaults to this priority. */\n  static SPEECH_PRIORITY_NORMAL = 5;\n  /** Priority for important messages that should be played before others. */\n  static SPEECH_PRIORITY_HIGH = 10;\n\n  private interruptFut = new Future<void>();\n  private authorizedEvent = new Event();\n  private scheduledFut = new Future<void>();\n  private doneFut = new Future<void>();\n  private generations: Future<void>[] = [];\n  private _chatItems: ChatItem[] = [];\n\n  /** @internal */\n  _tasks: Task<void>[] = [];\n\n  /** @internal */\n  _numSteps = 1;\n\n  /** @internal - OpenTelemetry context for the agent turn span */\n  _agentTurnContext?: Context;\n\n  /** @internal - used by AgentTask/RunResult final output plumbing */\n  _maybeRunFinalOutput?: unknown;\n\n  private itemAddedCallbacks: Set<(item: ChatItem) => void> = new Set();\n  private doneCallbacks: Set<(sh: SpeechHandle) => void> = new Set();\n\n  /** @internal Symbol marker for type identification */\n  readonly [SPEECH_HANDLE_SYMBOL] = true;\n\n  constructor(\n    private _id: string,\n    private _allowInterruptions: boolean,\n    /** @internal */\n    public _stepIndex: number,\n    readonly parent?: SpeechHandle,\n  ) {\n    this.doneFut.await.finally(() => {\n      for (const callback of this.doneCallbacks) {\n        callback(this);\n      }\n    });\n  }\n\n  static create(options?: {\n    allowInterruptions?: boolean;\n    stepIndex?: number;\n    parent?: SpeechHandle;\n  }) {\n    const { allowInterruptions = true, stepIndex = 0, parent } = options ?? {};\n\n    return new SpeechHandle(shortuuid('speech_'), allowInterruptions, stepIndex, parent);\n  }\n\n  get interrupted(): boolean {\n    return this.interruptFut.done;\n  }\n\n  get numSteps(): number {\n    return this._numSteps;\n  }\n\n  get id(): string {\n    return this._id;\n  }\n\n  get scheduled(): boolean {\n    return this.scheduledFut.done;\n  }\n\n  get allowInterruptions(): boolean {\n    return this._allowInterruptions;\n  }\n\n  /**\n   * Allow or disallow interruptions on this SpeechHandle.\n   *\n   * When set to false, the SpeechHandle will no longer accept any incoming\n   * interruption requests until re-enabled. If the handle is already\n   * interrupted, clearing interruptions is not allowed.\n   *\n   * @param value - true to allow interruptions, false to disallow\n   * @throws Error If attempting to disable interruptions when already interrupted\n   */\n  set allowInterruptions(value: boolean) {\n    if (this.interrupted && !value) {\n      throw new Error(\n        'Cannot set allow_interruptions to False, the SpeechHandle is already interrupted',\n      );\n    }\n    this._allowInterruptions = value;\n  }\n\n  done(): boolean {\n    return this.doneFut.done;\n  }\n\n  get chatItems(): ChatItem[] {\n    return this._chatItems;\n  }\n\n  /**\n   * Interrupt the current speech generation.\n   *\n   * @throws Error If this speech handle does not allow interruptions.\n   *\n   * @returns The same speech handle that was interrupted.\n   */\n  interrupt(force: boolean = false): SpeechHandle {\n    if (!force && !this.allowInterruptions) {\n      throw new Error('This generation handle does not allow interruptions');\n    }\n\n    this._cancel();\n    return this;\n  }\n\n  /**\n   * Waits for the entire assistant turn to complete playback.\n   *\n   * This method waits until the assistant has fully finished speaking,\n   * including any finalization steps beyond initial response generation.\n   * This is appropriate to call when you want to ensure the speech output\n   * has entirely played out, including any tool calls and response follow-ups.\n   */\n  async waitForPlayout(): Promise<void> {\n    const store = functionCallStorage.getStore();\n    if (store && store?.functionCall) {\n      throw new Error(\n        `Cannot call 'SpeechHandle.waitForPlayout()' from inside the function tool '${store.functionCall.name}'. ` +\n          'This creates a circular wait: the speech handle is waiting for the function tool to complete, ' +\n          'while the function tool is simultaneously waiting for the speech handle.\\n' +\n          \"To wait for the assistant's spoken response prior to running this tool, use RunContext.wait_for_playout() instead.\",\n      );\n    }\n    await this.doneFut.await;\n  }\n\n  async waitIfNotInterrupted(aw: Promise<unknown>[]): Promise<void> {\n    const allTasksPromise = Promise.all(aw);\n    const fs: Promise<unknown>[] = [allTasksPromise, this.interruptFut.await];\n    await Promise.race(fs);\n  }\n\n  addDoneCallback(callback: (sh: SpeechHandle) => void) {\n    if (this.done()) {\n      queueMicrotask(() => callback(this));\n      return;\n    }\n    this.doneCallbacks.add(callback);\n  }\n\n  removeDoneCallback(callback: (sh: SpeechHandle) => void) {\n    this.doneCallbacks.delete(callback);\n  }\n\n  /** @internal */\n  _cancel(): SpeechHandle {\n    if (this.done()) {\n      return this;\n    }\n\n    if (!this.interruptFut.done) {\n      this.interruptFut.resolve();\n    }\n\n    return this;\n  }\n\n  /** @internal */\n  _authorizeGeneration(): void {\n    const fut = new Future<void>();\n    this.generations.push(fut);\n    this.authorizedEvent.set();\n  }\n\n  /** @internal */\n  _clearAuthorization(): void {\n    this.authorizedEvent.clear();\n  }\n\n  /** @internal */\n  async _waitForAuthorization(): Promise<void> {\n    await this.authorizedEvent.wait();\n  }\n\n  /** @internal */\n  async _waitForGeneration(stepIdx: number = -1): Promise<void> {\n    if (this.generations.length === 0) {\n      throw new Error('cannot use wait_for_generation: no active generation is running.');\n    }\n\n    const index = stepIdx === -1 ? this.generations.length - 1 : stepIdx;\n    const generation = this.generations[index];\n    if (!generation) {\n      throw new Error(`Generation at index ${index} not found.`);\n    }\n    return generation.await;\n  }\n\n  /** @internal */\n  async _waitForScheduled(): Promise<void> {\n    return this.scheduledFut.await;\n  }\n\n  /** @internal */\n  _markGenerationDone(): void {\n    if (this.generations.length === 0) {\n      throw new Error('cannot use mark_generation_done: no active generation is running.');\n    }\n\n    const lastGeneration = this.generations[this.generations.length - 1];\n    if (lastGeneration && !lastGeneration.done) {\n      lastGeneration.resolve();\n    }\n  }\n\n  /** @internal */\n  _markDone(): void {\n    if (!this.doneFut.done) {\n      this.doneFut.resolve();\n      if (this.generations.length > 0) {\n        this._markGenerationDone(); // preemptive generation could be cancelled before being scheduled\n      }\n    }\n  }\n\n  /** @internal */\n  _markScheduled(): void {\n    if (!this.scheduledFut.done) {\n      this.scheduledFut.resolve();\n    }\n  }\n\n  /** @internal */\n  _addItemAddedCallback(callback: (item: ChatItem) => void): void {\n    this.itemAddedCallbacks.add(callback);\n  }\n\n  /** @internal */\n  _removeItemAddedCallback(callback: (item: ChatItem) => void): void {\n    this.itemAddedCallbacks.delete(callback);\n  }\n\n  /** @internal */\n  _itemAdded(items: ChatItem[]): void {\n    for (const item of items) {\n      for (const cb of this.itemAddedCallbacks) {\n        cb(item);\n      }\n      this._chatItems.push(item);\n    }\n  }\n}\n"],"mappings":"AAMA,SAAS,OAAO,QAAQ,iBAAiB;AACzC,SAAS,2BAA2B;AAGpC,MAAM,uBAAuB,OAAO,IAAI,6BAA6B;AAK9D,SAAS,eAAe,OAAuC;AACpE,SACE,OAAO,UAAU,YACjB,UAAU,QACV,wBAAwB,SACvB,MAAkC,oBAAoB,MAAM;AAEjE;AAEO,MAAM,aAAa;AAAA,EAiCxB,YACU,KACA,qBAED,YACE,QACT;AALQ;AACA;AAED;AACE;AAET,SAAK,QAAQ,MAAM,QAAQ,MAAM;AAC/B,iBAAW,YAAY,KAAK,eAAe;AACzC,iBAAS,IAAI;AAAA,MACf;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA,EA3CA,OAAO,sBAAsB;AAAA;AAAA,EAE7B,OAAO,yBAAyB;AAAA;AAAA,EAEhC,OAAO,uBAAuB;AAAA,EAEtB,eAAe,IAAI,OAAa;AAAA,EAChC,kBAAkB,IAAI,MAAM;AAAA,EAC5B,eAAe,IAAI,OAAa;AAAA,EAChC,UAAU,IAAI,OAAa;AAAA,EAC3B,cAA8B,CAAC;AAAA,EAC/B,aAAyB,CAAC;AAAA;AAAA,EAGlC,SAAuB,CAAC;AAAA;AAAA,EAGxB,YAAY;AAAA;AAAA,EAGZ;AAAA;AAAA,EAGA;AAAA,EAEQ,qBAAoD,oBAAI,IAAI;AAAA,EAC5D,gBAAiD,oBAAI,IAAI;AAAA;AAAA,EAGjE,CAAU,oBAAoB,IAAI;AAAA,EAgBlC,OAAO,OAAO,SAIX;AACD,UAAM,EAAE,qBAAqB,MAAM,YAAY,GAAG,OAAO,IAAI,WAAW,CAAC;AAEzE,WAAO,IAAI,aAAa,UAAU,SAAS,GAAG,oBAAoB,WAAW,MAAM;AAAA,EACrF;AAAA,EAEA,IAAI,cAAuB;AACzB,WAAO,KAAK,aAAa;AAAA,EAC3B;AAAA,EAEA,IAAI,WAAmB;AACrB,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,IAAI,KAAa;AACf,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,IAAI,YAAqB;AACvB,WAAO,KAAK,aAAa;AAAA,EAC3B;AAAA,EAEA,IAAI,qBAA8B;AAChC,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,IAAI,mBAAmB,OAAgB;AACrC,QAAI,KAAK,eAAe,CAAC,OAAO;AAC9B,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AACA,SAAK,sBAAsB;AAAA,EAC7B;AAAA,EAEA,OAAgB;AACd,WAAO,KAAK,QAAQ;AAAA,EACtB;AAAA,EAEA,IAAI,YAAwB;AAC1B,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,UAAU,QAAiB,OAAqB;AAC9C,QAAI,CAAC,SAAS,CAAC,KAAK,oBAAoB;AACtC,YAAM,IAAI,MAAM,qDAAqD;AAAA,IACvE;AAEA,SAAK,QAAQ;AACb,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,iBAAgC;AACpC,UAAM,QAAQ,oBAAoB,SAAS;AAC3C,QAAI,UAAS,+BAAO,eAAc;AAChC,YAAM,IAAI;AAAA,QACR,8EAA8E,MAAM,aAAa,IAAI;AAAA;AAAA,MAIvG;AAAA,IACF;AACA,UAAM,KAAK,QAAQ;AAAA,EACrB;AAAA,EAEA,MAAM,qBAAqB,IAAuC;AAChE,UAAM,kBAAkB,QAAQ,IAAI,EAAE;AACtC,UAAM,KAAyB,CAAC,iBAAiB,KAAK,aAAa,KAAK;AACxE,UAAM,QAAQ,KAAK,EAAE;AAAA,EACvB;AAAA,EAEA,gBAAgB,UAAsC;AACpD,QAAI,KAAK,KAAK,GAAG;AACf,qBAAe,MAAM,SAAS,IAAI,CAAC;AACnC;AAAA,IACF;AACA,SAAK,cAAc,IAAI,QAAQ;AAAA,EACjC;AAAA,EAEA,mBAAmB,UAAsC;AACvD,SAAK,cAAc,OAAO,QAAQ;AAAA,EACpC;AAAA;AAAA,EAGA,UAAwB;AACtB,QAAI,KAAK,KAAK,GAAG;AACf,aAAO;AAAA,IACT;AAEA,QAAI,CAAC,KAAK,aAAa,MAAM;AAC3B,WAAK,aAAa,QAAQ;AAAA,IAC5B;AAEA,WAAO;AAAA,EACT;AAAA;AAAA,EAGA,uBAA6B;AAC3B,UAAM,MAAM,IAAI,OAAa;AAC7B,SAAK,YAAY,KAAK,GAAG;AACzB,SAAK,gBAAgB,IAAI;AAAA,EAC3B;AAAA;AAAA,EAGA,sBAA4B;AAC1B,SAAK,gBAAgB,MAAM;AAAA,EAC7B;AAAA;AAAA,EAGA,MAAM,wBAAuC;AAC3C,UAAM,KAAK,gBAAgB,KAAK;AAAA,EAClC;AAAA;AAAA,EAGA,MAAM,mBAAmB,UAAkB,IAAmB;AAC5D,QAAI,KAAK,YAAY,WAAW,GAAG;AACjC,YAAM,IAAI,MAAM,kEAAkE;AAAA,IACpF;AAEA,UAAM,QAAQ,YAAY,KAAK,KAAK,YAAY,SAAS,IAAI;AAC7D,UAAM,aAAa,KAAK,YAAY,KAAK;AACzC,QAAI,CAAC,YAAY;AACf,YAAM,IAAI,MAAM,uBAAuB,KAAK,aAAa;AAAA,IAC3D;AACA,WAAO,WAAW;AAAA,EACpB;AAAA;AAAA,EAGA,MAAM,oBAAmC;AACvC,WAAO,KAAK,aAAa;AAAA,EAC3B;AAAA;AAAA,EAGA,sBAA4B;AAC1B,QAAI,KAAK,YAAY,WAAW,GAAG;AACjC,YAAM,IAAI,MAAM,mEAAmE;AAAA,IACrF;AAEA,UAAM,iBAAiB,KAAK,YAAY,KAAK,YAAY,SAAS,CAAC;AACnE,QAAI,kBAAkB,CAAC,eAAe,MAAM;AAC1C,qBAAe,QAAQ;AAAA,IACzB;AAAA,EACF;AAAA;AAAA,EAGA,YAAkB;AAChB,QAAI,CAAC,KAAK,QAAQ,MAAM;AACtB,WAAK,QAAQ,QAAQ;AACrB,UAAI,KAAK,YAAY,SAAS,GAAG;AAC/B,aAAK,oBAAoB;AAAA,MAC3B;AAAA,IACF;AAAA,EACF;AAAA;AAAA,EAGA,iBAAuB;AACrB,QAAI,CAAC,KAAK,aAAa,MAAM;AAC3B,WAAK,aAAa,QAAQ;AAAA,IAC5B;AAAA,EACF;AAAA;AAAA,EAGA,sBAAsB,UAA0C;AAC9D,SAAK,mBAAmB,IAAI,QAAQ;AAAA,EACtC;AAAA;AAAA,EAGA,yBAAyB,UAA0C;AACjE,SAAK,mBAAmB,OAAO,QAAQ;AAAA,EACzC;AAAA;AAAA,EAGA,WAAW,OAAyB;AAClC,eAAW,QAAQ,OAAO;AACxB,iBAAW,MAAM,KAAK,oBAAoB;AACxC,WAAG,IAAI;AAAA,MACT;AACA,WAAK,WAAW,KAAK,IAAI;AAAA,IAC3B;AAAA,EACF;AACF;","names":[]}

package/dist/voice/testing/run_result.cjs

@@ -40,16 +40,18 @@ class RunResult {
   _events = [];
   doneFut = new import_utils.Future();
   userInput;
+  outputType;
+  finalOutputValue;
+  hasFinalOutput = false;
   handles = /* @__PURE__ */ new Set();
   lastSpeechHandle;
   runAssert;
-  // TODO(brian): Add typed output support for parity with Python
-  // - Add outputType?: new (...args: unknown[]) => T
-  // - Add finalOutput?: T
-  // - Implement markDone() to extract final_output from SpeechHandle.maybeRunFinalOutput
-  // - See Python: run_result.py lines 182-201
+  // Store per-handle closures so _unwatchHandle can remove callbacks symmetrically.
+  doneCallbacks = /* @__PURE__ */ new Map();
+  itemAddedCallback = (item) => this._itemAdded(item);
   constructor(options) {
     this.userInput = options == null ? void 0 : options.userInput;
+    this.outputType = options == null ? void 0 : options.outputType;
   }
   /**
    * List of all recorded events generated during the run.
@@ -80,11 +82,15 @@ ${eventsStr}
   }
   /**
    * Returns the final output of the run after completion.
-   *
-   * @throws Error - Not implemented yet.
    */
   get finalOutput() {
-    throw new Error("finalOutput is not yet implemented in JS.");
+    if (!this.doneFut.done) {
+      throw new Error("cannot retrieve finalOutput, RunResult is not done");
+    }
+    if (!this.hasFinalOutput) {
+      throw new Error("no final output");
+    }
+    return this.finalOutputValue;
   }
   /**
    * Indicates whether the run has finished processing all events.
@@ -146,13 +152,14 @@ ${eventsStr}
    * Watch a speech handle or task for completion.
    */
   _watchHandle(handle) {
+    if (this.handles.has(handle)) return;
     this.handles.add(handle);
     if ((0, import_speech_handle.isSpeechHandle)(handle)) {
-      handle._addItemAddedCallback(this._itemAdded.bind(this));
+      handle._addItemAddedCallback(this.itemAddedCallback);
     }
-    handle.addDoneCallback(() => {
-      this._markDoneIfNeeded(handle);
-    });
+    const doneCallback = () => this._markDoneIfNeeded(handle);
+    this.doneCallbacks.set(handle, doneCallback);
+    handle.addDoneCallback(doneCallback);
   }
   /**
    * @internal
@@ -160,22 +167,66 @@ ${eventsStr}
    */
   _unwatchHandle(handle) {
     this.handles.delete(handle);
+    const doneCallback = this.doneCallbacks.get(handle);
+    if (doneCallback) {
+      handle.removeDoneCallback(doneCallback);
+      this.doneCallbacks.delete(handle);
+    }
     if ((0, import_speech_handle.isSpeechHandle)(handle)) {
-      handle._removeItemAddedCallback(this._itemAdded.bind(this));
+      handle._removeItemAddedCallback(this.itemAddedCallback);
     }
   }
+  /** @internal */
+  _watchedHandleCount() {
+    return this.handles.size;
+  }
+  /** @internal – Reject the run with an error (e.g. when deferred generateReply fails). */
+  _reject(error) {
+    if (!this.doneFut.done) {
+      this.doneFut.reject(error);
+    }
+  }
+  /** @internal */
   _markDoneIfNeeded(handle) {
     if ((0, import_speech_handle.isSpeechHandle)(handle)) {
       this.lastSpeechHandle = handle;
     }
-    if ([...this.handles].every((h) => (0, import_speech_handle.isSpeechHandle)(h) ? h.done() : h.done)) {
+    const allDone = [...this.handles].every((h) => (0, import_speech_handle.isSpeechHandle)(h) ? h.done() : h.done);
+    if (allDone) {
       this._markDone();
     }
   }
   _markDone() {
-    if (!this.doneFut.done) {
+    if (this.doneFut.done) {
+      return;
+    }
+    if (!this.lastSpeechHandle) {
+      this.doneFut.resolve();
+      return;
+    }
+    const finalOutput = this.lastSpeechHandle._maybeRunFinalOutput;
+    if (finalOutput instanceof Error) {
+      this.doneFut.reject(finalOutput);
+      return;
+    }
+    if (this.outputType) {
+      const result = this.outputType.safeParse(finalOutput);
+      if (!result.success) {
+        this.doneFut.reject(
+          new Error(`Expected output matching provided zod schema: ${result.error.message}`)
+        );
+        return;
+      }
+      this.finalOutputValue = result.data;
+      this.hasFinalOutput = true;
       this.doneFut.resolve();
+      return;
+    }
+    if (finalOutput !== void 0) {
+      this.finalOutputValue = finalOutput;
+      this.hasFinalOutput = true;
     }
+    this.doneFut.resolve();
   }
   /**
    * Find the correct insertion index to maintain chronological order.