lua-cli 3.53.0 → 3.55.0

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

@@ -64,6 +64,22 @@ declare interface LuaTool<TInput extends ZodType = ZodType> {
     name: string;
     /** Description of what the tool does */
     description: string;
+    /**
+     * Optional text the chat shows to the user while this tool runs and after it
+     * finishes, instead of the tool's name. Either one text for both moments, or
+     * one for each:
+     *
+     * ```ts
+     * label = { running: 'Creating a ticket for {subject}', done: 'Created a ticket for {subject}' };
+     * label = 'Checked stock';
+     * ```
+     *
+     * `{argName}` is replaced with that argument's value from the call (string
+     * and number arguments only). Don't end the text with "…": the chat adds it
+     * while the tool runs. Each text is a string literal (or a const holding one)
+     * of at most 80 characters; `lua compile` ignores a computed label.
+     */
+    label?: ToolLabel;
     /** Zod schema for input validation */
     inputSchema: TInput;
     /**
@@ -234,15 +250,15 @@ declare const LuaVoiceConfigSchema: z.ZodEffects<z.ZodObject<{
          */
         options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     }, "strip", z.ZodTypeAny, {
-        model: string;
         kind: "inference";
-        voice?: string | undefined;
+        model: string;
         options?: Record<string, unknown> | undefined;
+        voice?: string | undefined;
     }, {
-        model: string;
         kind: "inference";
-        voice?: string | undefined;
+        model: string;
         options?: Record<string, unknown> | undefined;
+        voice?: string | undefined;
     }>, z.ZodObject<{
         kind: z.ZodLiteral<"plugin">;
         provider: z.ZodEnum<["deepgram", "elevenlabs"]>;
@@ -257,13 +273,13 @@ declare const LuaVoiceConfigSchema: z.ZodEffects<z.ZodObject<{
     }, "strip", z.ZodTypeAny, {
         class: "LLM" | "STT" | "STTv2" | "TTS";
         options: Record<string, unknown>;
-        provider: "deepgram" | "elevenlabs";
         kind: "plugin";
+        provider: "deepgram" | "elevenlabs";
     }, {
         class: "LLM" | "STT" | "STTv2" | "TTS";
         options: Record<string, unknown>;
-        provider: "deepgram" | "elevenlabs";
         kind: "plugin";
+        provider: "deepgram" | "elevenlabs";
     }>, z.ZodObject<{
         kind: z.ZodLiteral<"realtime">;
         provider: z.ZodEnum<["openai", "google", "xai"]>;
@@ -276,12 +292,12 @@ declare const LuaVoiceConfigSchema: z.ZodEffects<z.ZodObject<{
         options: z.ZodRecord<z.ZodString, z.ZodUnknown>;
     }, "strip", z.ZodTypeAny, {
         options: Record<string, unknown>;
-        provider: "openai" | "google" | "xai";
         kind: "realtime";
+        provider: "openai" | "google" | "xai";
     }, {
         options: Record<string, unknown>;
-        provider: "openai" | "google" | "xai";
         kind: "realtime";
+        provider: "openai" | "google" | "xai";
     }>]>;
     stt: z.ZodOptional<z.ZodDiscriminatedUnion<"kind", [z.ZodObject<{
         kind: z.ZodLiteral<"inference">;
@@ -300,15 +316,15 @@ declare const LuaVoiceConfigSchema: z.ZodEffects<z.ZodObject<{
          */
         options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     }, "strip", z.ZodTypeAny, {
-        model: string;
         kind: "inference";
-        voice?: string | undefined;
+        model: string;
         options?: Record<string, unknown> | undefined;
+        voice?: string | undefined;
     }, {
-        model: string;
         kind: "inference";
-        voice?: string | undefined;
+        model: string;
         options?: Record<string, unknown> | undefined;
+        voice?: string | undefined;
     }>, z.ZodObject<{
         kind: z.ZodLiteral<"plugin">;
         provider: z.ZodEnum<["deepgram", "elevenlabs"]>;
@@ -323,13 +339,13 @@ declare const LuaVoiceConfigSchema: z.ZodEffects<z.ZodObject<{
     }, "strip", z.ZodTypeAny, {
         class: "LLM" | "STT" | "STTv2" | "TTS";
         options: Record<string, unknown>;
-        provider: "deepgram" | "elevenlabs";
         kind: "plugin";
+        provider: "deepgram" | "elevenlabs";
     }, {
         class: "LLM" | "STT" | "STTv2" | "TTS";
         options: Record<string, unknown>;
-        provider: "deepgram" | "elevenlabs";
         kind: "plugin";
+        provider: "deepgram" | "elevenlabs";
     }>, z.ZodObject<{
         kind: z.ZodLiteral<"realtime">;
         provider: z.ZodEnum<["openai", "google", "xai"]>;
@@ -342,12 +358,12 @@ declare const LuaVoiceConfigSchema: z.ZodEffects<z.ZodObject<{
         options: z.ZodRecord<z.ZodString, z.ZodUnknown>;
     }, "strip", z.ZodTypeAny, {
         options: Record<string, unknown>;
-        provider: "openai" | "google" | "xai";
         kind: "realtime";
+        provider: "openai" | "google" | "xai";
     }, {
         options: Record<string, unknown>;
-        provider: "openai" | "google" | "xai";
         kind: "realtime";
+        provider: "openai" | "google" | "xai";
     }>]>>;
     tts: z.ZodOptional<z.ZodDiscriminatedUnion<"kind", [z.ZodObject<{
         kind: z.ZodLiteral<"inference">;
@@ -366,15 +382,15 @@ declare const LuaVoiceConfigSchema: z.ZodEffects<z.ZodObject<{
          */
         options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     }, "strip", z.ZodTypeAny, {
-        model: string;
         kind: "inference";
-        voice?: string | undefined;
+        model: string;
         options?: Record<string, unknown> | undefined;
+        voice?: string | undefined;
     }, {
-        model: string;
         kind: "inference";
-        voice?: string | undefined;
+        model: string;
         options?: Record<string, unknown> | undefined;
+        voice?: string | undefined;
     }>, z.ZodObject<{
         kind: z.ZodLiteral<"plugin">;
         provider: z.ZodEnum<["deepgram", "elevenlabs"]>;
@@ -389,13 +405,13 @@ declare const LuaVoiceConfigSchema: z.ZodEffects<z.ZodObject<{
     }, "strip", z.ZodTypeAny, {
         class: "LLM" | "STT" | "STTv2" | "TTS";
         options: Record<string, unknown>;
-        provider: "deepgram" | "elevenlabs";
         kind: "plugin";
+        provider: "deepgram" | "elevenlabs";
     }, {
         class: "LLM" | "STT" | "STTv2" | "TTS";
         options: Record<string, unknown>;
-        provider: "deepgram" | "elevenlabs";
         kind: "plugin";
+        provider: "deepgram" | "elevenlabs";
     }>, z.ZodObject<{
         kind: z.ZodLiteral<"realtime">;
         provider: z.ZodEnum<["openai", "google", "xai"]>;
@@ -408,12 +424,12 @@ declare const LuaVoiceConfigSchema: z.ZodEffects<z.ZodObject<{
         options: z.ZodRecord<z.ZodString, z.ZodUnknown>;
     }, "strip", z.ZodTypeAny, {
         options: Record<string, unknown>;
-        provider: "openai" | "google" | "xai";
         kind: "realtime";
+        provider: "openai" | "google" | "xai";
     }, {
         options: Record<string, unknown>;
-        provider: "openai" | "google" | "xai";
         kind: "realtime";
+        provider: "openai" | "google" | "xai";
     }>]>>;
     vad: z.ZodOptional<z.ZodString>;
     vadOptions: z.ZodOptional<z.ZodObject<{
@@ -572,52 +588,52 @@ declare const LuaVoiceConfigSchema: z.ZodEffects<z.ZodObject<{
     excludeTools: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
 }, "strip", z.ZodTypeAny, {
     llm: {
-        model: string;
         kind: "inference";
-        voice?: string | undefined;
+        model: string;
         options?: Record<string, unknown> | undefined;
+        voice?: string | undefined;
     } | {
         class: "LLM" | "STT" | "STTv2" | "TTS";
         options: Record<string, unknown>;
-        provider: "deepgram" | "elevenlabs";
         kind: "plugin";
+        provider: "deepgram" | "elevenlabs";
     } | {
         options: Record<string, unknown>;
-        provider: "openai" | "google" | "xai";
         kind: "realtime";
+        provider: "openai" | "google" | "xai";
     };
     name?: string | undefined;
     vad?: string | undefined;
     stt?: {
-        model: string;
         kind: "inference";
-        voice?: string | undefined;
+        model: string;
         options?: Record<string, unknown> | undefined;
+        voice?: string | undefined;
     } | {
         class: "LLM" | "STT" | "STTv2" | "TTS";
         options: Record<string, unknown>;
-        provider: "deepgram" | "elevenlabs";
         kind: "plugin";
+        provider: "deepgram" | "elevenlabs";
     } | {
         options: Record<string, unknown>;
-        provider: "openai" | "google" | "xai";
         kind: "realtime";
+        provider: "openai" | "google" | "xai";
     } | undefined;
     volume?: number | undefined;
     tts?: {
-        model: string;
         kind: "inference";
-        voice?: string | undefined;
+        model: string;
         options?: Record<string, unknown> | undefined;
+        voice?: string | undefined;
     } | {
         class: "LLM" | "STT" | "STTv2" | "TTS";
         options: Record<string, unknown>;
-        provider: "deepgram" | "elevenlabs";
         kind: "plugin";
+        provider: "deepgram" | "elevenlabs";
     } | {
         options: Record<string, unknown>;
-        provider: "openai" | "google" | "xai";
         kind: "realtime";
+        provider: "openai" | "google" | "xai";
     } | undefined;
     vadOptions?: {
         minSpeechDuration?: number | undefined;
@@ -666,52 +682,52 @@ declare const LuaVoiceConfigSchema: z.ZodEffects<z.ZodObject<{
     excludeTools?: string[] | undefined;
 }, {
     llm: {
-        model: string;
         kind: "inference";
-        voice?: string | undefined;
+        model: string;
         options?: Record<string, unknown> | undefined;
+        voice?: string | undefined;
     } | {
         class: "LLM" | "STT" | "STTv2" | "TTS";
         options: Record<string, unknown>;
-        provider: "deepgram" | "elevenlabs";
         kind: "plugin";
+        provider: "deepgram" | "elevenlabs";
     } | {
         options: Record<string, unknown>;
-        provider: "openai" | "google" | "xai";
         kind: "realtime";
+        provider: "openai" | "google" | "xai";
     };
     name?: string | undefined;
     vad?: string | undefined;
     stt?: {
-        model: string;
         kind: "inference";
-        voice?: string | undefined;
+        model: string;
         options?: Record<string, unknown> | undefined;
+        voice?: string | undefined;
     } | {
         class: "LLM" | "STT" | "STTv2" | "TTS";
         options: Record<string, unknown>;
-        provider: "deepgram" | "elevenlabs";
         kind: "plugin";
+        provider: "deepgram" | "elevenlabs";
     } | {
         options: Record<string, unknown>;
-        provider: "openai" | "google" | "xai";
         kind: "realtime";
+        provider: "openai" | "google" | "xai";
     } | undefined;
     volume?: number | undefined;
     tts?: {
-        model: string;
         kind: "inference";
-        voice?: string | undefined;
+        model: string;
         options?: Record<string, unknown> | undefined;
+        voice?: string | undefined;
     } | {
         class: "LLM" | "STT" | "STTv2" | "TTS";
         options: Record<string, unknown>;
-        provider: "deepgram" | "elevenlabs";
         kind: "plugin";
+        provider: "deepgram" | "elevenlabs";
     } | {
         options: Record<string, unknown>;
-        provider: "openai" | "google" | "xai";
         kind: "realtime";
+        provider: "openai" | "google" | "xai";
     } | undefined;
     vadOptions?: {
         minSpeechDuration?: number | undefined;
@@ -760,52 +776,52 @@ declare const LuaVoiceConfigSchema: z.ZodEffects<z.ZodObject<{
     excludeTools?: string[] | undefined;
 }>, {
     llm: {
-        model: string;
         kind: "inference";
-        voice?: string | undefined;
+        model: string;
         options?: Record<string, unknown> | undefined;
+        voice?: string | undefined;
     } | {
         class: "LLM" | "STT" | "STTv2" | "TTS";
         options: Record<string, unknown>;
-        provider: "deepgram" | "elevenlabs";
         kind: "plugin";
+        provider: "deepgram" | "elevenlabs";
     } | {
         options: Record<string, unknown>;
-        provider: "openai" | "google" | "xai";
         kind: "realtime";
+        provider: "openai" | "google" | "xai";
     };
     name?: string | undefined;
     vad?: string | undefined;
     stt?: {
-        model: string;
         kind: "inference";
-        voice?: string | undefined;
+        model: string;
         options?: Record<string, unknown> | undefined;
+        voice?: string | undefined;
     } | {
         class: "LLM" | "STT" | "STTv2" | "TTS";
         options: Record<string, unknown>;
-        provider: "deepgram" | "elevenlabs";
         kind: "plugin";
+        provider: "deepgram" | "elevenlabs";
     } | {
         options: Record<string, unknown>;
-        provider: "openai" | "google" | "xai";
         kind: "realtime";
+        provider: "openai" | "google" | "xai";
     } | undefined;
     volume?: number | undefined;
     tts?: {
-        model: string;
         kind: "inference";
-        voice?: string | undefined;
+        model: string;
         options?: Record<string, unknown> | undefined;
+        voice?: string | undefined;
     } | {
         class: "LLM" | "STT" | "STTv2" | "TTS";
         options: Record<string, unknown>;
-        provider: "deepgram" | "elevenlabs";
         kind: "plugin";
+        provider: "deepgram" | "elevenlabs";
     } | {
         options: Record<string, unknown>;
-        provider: "openai" | "google" | "xai";
         kind: "realtime";
+        provider: "openai" | "google" | "xai";
     } | undefined;
     vadOptions?: {
         minSpeechDuration?: number | undefined;
@@ -854,52 +870,52 @@ declare const LuaVoiceConfigSchema: z.ZodEffects<z.ZodObject<{
     excludeTools?: string[] | undefined;
 }, {
     llm: {
-        model: string;
         kind: "inference";
-        voice?: string | undefined;
+        model: string;
         options?: Record<string, unknown> | undefined;
+        voice?: string | undefined;
     } | {
         class: "LLM" | "STT" | "STTv2" | "TTS";
         options: Record<string, unknown>;
-        provider: "deepgram" | "elevenlabs";
         kind: "plugin";
+        provider: "deepgram" | "elevenlabs";
     } | {
         options: Record<string, unknown>;
-        provider: "openai" | "google" | "xai";
         kind: "realtime";
+        provider: "openai" | "google" | "xai";
     };
     name?: string | undefined;
     vad?: string | undefined;
     stt?: {
-        model: string;
         kind: "inference";
-        voice?: string | undefined;
+        model: string;
         options?: Record<string, unknown> | undefined;
+        voice?: string | undefined;
     } | {
         class: "LLM" | "STT" | "STTv2" | "TTS";
         options: Record<string, unknown>;
-        provider: "deepgram" | "elevenlabs";
         kind: "plugin";
+        provider: "deepgram" | "elevenlabs";
     } | {
         options: Record<string, unknown>;
-        provider: "openai" | "google" | "xai";
         kind: "realtime";
+        provider: "openai" | "google" | "xai";
     } | undefined;
     volume?: number | undefined;
     tts?: {
-        model: string;
         kind: "inference";
-        voice?: string | undefined;
+        model: string;
         options?: Record<string, unknown> | undefined;
+        voice?: string | undefined;
     } | {
         class: "LLM" | "STT" | "STTv2" | "TTS";
         options: Record<string, unknown>;
-        provider: "deepgram" | "elevenlabs";
         kind: "plugin";
+        provider: "deepgram" | "elevenlabs";
     } | {
         options: Record<string, unknown>;
-        provider: "openai" | "google" | "xai";
         kind: "realtime";
+        provider: "openai" | "google" | "xai";
     } | undefined;
     vadOptions?: {
         minSpeechDuration?: number | undefined;
@@ -993,6 +1009,7 @@ declare class LuaVoiceTool<TInput extends ZodType = ZodType> implements LuaTool<
     readonly inputSchema: TInput;
     readonly execute: (input: any, ctx?: LuaVoiceToolCtx) => Promise<any>;
     readonly condition?: () => Promise<boolean>;
+    readonly label?: ToolLabel;
     readonly voice?: {
         flags?: ToolFlag[];
     };
@@ -1011,6 +1028,8 @@ declare interface LuaVoiceToolConfig<TInput extends ZodType = ZodType> {
     execute: (input: any, ctx?: LuaVoiceToolCtx) => Promise<any>;
     condition?: () => Promise<boolean>;
     flags?: ToolFlag[];
+    /** What a step shows while the tool runs and when it is done, as on `LuaTool`. */
+    label?: ToolLabel;
 }
 
 /**
@@ -1247,6 +1266,12 @@ declare enum ToolFlag {
     DISALLOW_INTERRUPTION = "disallow_interruption"
 }
 
+/** A tool's `label`: one text for both moments, or one while it runs and one when it is done. `{arg}` fills from the call. */
+declare type ToolLabel = string | {
+    running: string;
+    done: string;
+};
+
 /**
  * Wrap each LuaTool / LuaVoiceTool in a LiveKit `llm.tool({})` so the
  * AgentSession can dispatch tool calls. The mockTools map overrides the

package/dist/workflow-builder.d.ts

@@ -276,6 +276,22 @@ declare interface LuaTool<TInput extends ZodType = ZodType> {
     name: string;
     /** Description of what the tool does */
     description: string;
+    /**
+     * Optional text the chat shows to the user while this tool runs and after it
+     * finishes, instead of the tool's name. Either one text for both moments, or
+     * one for each:
+     *
+     * ```ts
+     * label = { running: 'Creating a ticket for {subject}', done: 'Created a ticket for {subject}' };
+     * label = 'Checked stock';
+     * ```
+     *
+     * `{argName}` is replaced with that argument's value from the call (string
+     * and number arguments only). Don't end the text with "…": the chat adds it
+     * while the tool runs. Each text is a string literal (or a const holding one)
+     * of at most 80 characters; `lua compile` ignores a computed label.
+     */
+    label?: ToolLabel;
     /** Zod schema for input validation */
     inputSchema: TInput;
     /**
@@ -700,6 +716,12 @@ declare enum ToolFlag {
     DISALLOW_INTERRUPTION = "disallow_interruption"
 }
 
+/** A tool's `label`: one text for both moments, or one while it runs and one when it is done. `{arg}` fills from the call. */
+declare type ToolLabel = string | {
+    running: string;
+    done: string;
+};
+
 export declare interface ToolStepOptions {
     input?: LuaMapConfig;
     timeoutSeconds?: number;