retell-utils 0.4.5 → 0.5.1

package/dist/flow.js

@@ -1,6 +1,6 @@
 import { z } from "zod";
 import { KbConfigSchema, McpConfigSchema } from "./agent.js";
-import { EquationCombinatorSchema, EquationOperatorSchema, FlowInstructionTypeSchema, FlowNodeTypeSchema, FlowTransitionConditionTypeSchema, LlmModelSchema, StartSpeakerSchema, } from "./enums.js";
+import { EquationCombinatorSchema, EquationOperatorSchema, FlowInstructionTypeSchema, FlowTransitionConditionTypeSchema, LlmModelSchema, StartSpeakerSchema, } from "./enums.js";
 import { LlmToolSchema, TransferDestinationSchema, TransferOptionSchema, } from "./llm.js";
 // ---------------------------------------------------------------------------
 // Shared sub-schemas
@@ -51,26 +51,26 @@ const GlobalNodeSettingSchema = z.object({
     negative_finetune_examples: z.array(FinetuneExampleSchema).optional(),
     cool_down: z.number().optional(),
 });
-/** Schema for a conversation flow node with all known fields explicit. */
-export const FlowNodeSchema = z.object({
-    // Common
-    id: z.string().optional(),
-    name: z.string().optional(),
-    type: FlowNodeTypeSchema.optional(),
-    instruction: z
-        .object({
-        type: FlowInstructionTypeSchema.optional(),
-        text: z.string().optional(),
-    })
-        .optional(),
-    display_position: DisplayPositionSchema.nullable().optional(),
-    // Edges
-    edges: z.array(FlowEdgeSchema).optional(),
-    edge: FlowEdgeSchema.optional(),
-    else_edge: FlowEdgeSchema.optional(),
-    skip_response_edge: FlowEdgeSchema.optional(),
+// ---------------------------------------------------------------------------
+// Per-type node schemas (discriminated union on `type`)
+// ---------------------------------------------------------------------------
+const InstructionSchema = z.object({
+    type: FlowInstructionTypeSchema,
+    text: z.string(),
+});
+/** Fields shared by every node type. */
+const baseNodeFields = {
+    id: z.string(),
+    name: z.string(),
+    display_position: DisplayPositionSchema.default({ x: 0, y: 0 }),
+};
+const ConversationNodeSchema = z.object({
+    ...baseNodeFields,
+    type: z.literal("conversation"),
+    instruction: InstructionSchema,
+    edges: z.array(FlowEdgeSchema),
     always_edge: FlowEdgeSchema.optional(),
-    // Conversation node fields
+    skip_response_edge: FlowEdgeSchema.optional(),
     start_speaker: StartSpeakerSchema.optional(),
     interruption_sensitivity: z.number().optional(),
     global_node_setting: GlobalNodeSettingSchema.optional(),
@@ -82,15 +82,82 @@ export const FlowNodeSchema = z.object({
         .array(FinetuneExampleSchema)
         .nullable()
         .optional(),
-    // Function node fields
-    tool_id: z.string().optional(),
-    tool_type: z.string().optional(),
-    speak_during_execution: z.boolean().optional(),
-    wait_for_result: z.boolean().optional(),
-    // Transfer node fields
-    transfer_destination: TransferDestinationSchema.optional(),
-    transfer_option: TransferOptionSchema.optional(),
 });
+const EndNodeSchema = z.object({
+    ...baseNodeFields,
+    type: z.literal("end"),
+    instruction: InstructionSchema.optional(),
+    speak_during_execution: z.boolean().default(false),
+});
+const FunctionNodeSchema = z.object({
+    ...baseNodeFields,
+    type: z.literal("function"),
+    instruction: InstructionSchema.optional(),
+    tool_id: z.string(),
+    tool_type: z.string(),
+    speak_during_execution: z.boolean().default(false),
+    wait_for_result: z.boolean(),
+    edges: z.array(FlowEdgeSchema),
+    else_edge: FlowEdgeSchema.optional(),
+    global_node_setting: GlobalNodeSettingSchema.optional(),
+});
+const TransferCallNodeSchema = z.object({
+    ...baseNodeFields,
+    type: z.literal("transfer_call"),
+    instruction: InstructionSchema,
+    transfer_destination: TransferDestinationSchema,
+    transfer_option: TransferOptionSchema,
+    speak_during_execution: z.boolean().default(false),
+    edge: FlowEdgeSchema,
+});
+const BranchNodeSchema = z.object({
+    ...baseNodeFields,
+    type: z.literal("branch"),
+    edges: z.array(FlowEdgeSchema),
+    else_edge: FlowEdgeSchema,
+});
+const ComponentNodeSchema = z.object({
+    ...baseNodeFields,
+    type: z.literal("component"),
+    component_id: z.string(),
+    component_type: z.string(),
+    edges: z.array(FlowEdgeSchema),
+    else_edge: FlowEdgeSchema.optional(),
+});
+const PressDigitNodeSchema = z.looseObject({
+    ...baseNodeFields,
+    type: z.literal("press_digit"),
+});
+const SmsNodeSchema = z.looseObject({
+    ...baseNodeFields,
+    type: z.literal("sms"),
+});
+const ExtractDynamicVariablesNodeSchema = z.looseObject({
+    ...baseNodeFields,
+    type: z.literal("extract_dynamic_variables"),
+});
+const AgentSwapNodeSchema = z.looseObject({
+    ...baseNodeFields,
+    type: z.literal("agent_swap"),
+});
+const McpNodeSchema = z.looseObject({
+    ...baseNodeFields,
+    type: z.literal("mcp"),
+});
+/** Discriminated union of all conversation flow node types. */
+export const FlowNodeSchema = z.discriminatedUnion("type", [
+    ConversationNodeSchema,
+    EndNodeSchema,
+    FunctionNodeSchema,
+    TransferCallNodeSchema,
+    BranchNodeSchema,
+    ComponentNodeSchema,
+    PressDigitNodeSchema,
+    SmsNodeSchema,
+    ExtractDynamicVariablesNodeSchema,
+    AgentSwapNodeSchema,
+    McpNodeSchema,
+]);
 // ---------------------------------------------------------------------------
 // Flow components
 // ---------------------------------------------------------------------------
@@ -105,6 +172,21 @@ export const FlowComponentSchema = z.object({
     begin_tag_display_position: DisplayPositionSchema.nullable().optional(),
 });
 // ---------------------------------------------------------------------------
+// Shared (account-level) flow component response
+// ---------------------------------------------------------------------------
+/** Zod schema for a shared conversation flow component response from the API. */
+export const ConversationFlowComponentResponseSchema = z.object({
+    conversation_flow_component_id: z.string(),
+    user_modified_timestamp: z.number(),
+    linked_conversation_flow_ids: z.array(z.string()).optional(),
+    name: z.string().optional(),
+    nodes: z.array(FlowNodeSchema).optional(),
+    tools: z.array(LlmToolSchema).nullable().optional(),
+    mcps: z.array(McpConfigSchema).nullable().optional(),
+    start_node_id: z.string().nullable().optional(),
+    begin_tag_display_position: DisplayPositionSchema.nullable().optional(),
+});
+// ---------------------------------------------------------------------------
 // Model choice
 // ---------------------------------------------------------------------------
 /** Model selection configuration for conversation flows. */

package/dist/index.d.ts

@@ -11,7 +11,7 @@ export { type ChatSchemaConfig, ChatSchemas, chatSchemaDefaults, createChatSchem
 export { WebhookSchemas, createWebhookSchemas } from "./webhook.js";
 export { ChatAgentResponseSchema, GuardrailConfigSchema, KbConfigSchema, McpConfigSchema, PiiConfigSchema, PostAnalysisFieldSchema, PronunciationEntrySchema, ResponseEngineConversationFlowSchema, ResponseEngineCustomLlmSchema, ResponseEngineRetellLlmSchema, ResponseEngineSchema, VoiceAgentResponseSchema, } from "./agent.js";
 export { LlmResponseSchema, LlmStateEdgeSchema, LlmStateSchema, LlmToolSchema, TransferDestinationSchema, TransferOptionSchema, } from "./llm.js";
-export { ConversationFlowResponseSchema, FlowComponentSchema, FlowEdgeSchema, FlowEquationSchema, FlowNodeSchema, FlowTransitionConditionSchema, } from "./flow.js";
+export { ConversationFlowComponentResponseSchema, ConversationFlowResponseSchema, FlowComponentSchema, FlowEdgeSchema, FlowEquationSchema, FlowNodeSchema, FlowTransitionConditionSchema, } from "./flow.js";
 export { InputMatchRuleSchema, TestCaseDefinitionSchema, TestCaseResponseEngineSchema, ToolMockSchema, } from "./test-case.js";
 export { retellPagination } from "./pagination.js";
 export { pluralize, resolveFilePlaceholders, toSnakeCase } from "./utils.js";

package/dist/index.js

@@ -25,7 +25,7 @@ export { ChatAgentResponseSchema, GuardrailConfigSchema, KbConfigSchema, McpConf
 // LLM config schemas
 export { LlmResponseSchema, LlmStateEdgeSchema, LlmStateSchema, LlmToolSchema, TransferDestinationSchema, TransferOptionSchema, } from "./llm.js";
 // Conversation flow config schemas
-export { ConversationFlowResponseSchema, FlowComponentSchema, FlowEdgeSchema, FlowEquationSchema, FlowNodeSchema, FlowTransitionConditionSchema, } from "./flow.js";
+export { ConversationFlowComponentResponseSchema, ConversationFlowResponseSchema, FlowComponentSchema, FlowEdgeSchema, FlowEquationSchema, FlowNodeSchema, FlowTransitionConditionSchema, } from "./flow.js";
 // Test case schemas
 export { InputMatchRuleSchema, TestCaseDefinitionSchema, TestCaseResponseEngineSchema, ToolMockSchema, } from "./test-case.js";
 // Pagination utility

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "retell-utils",
-  "version": "0.4.5",
+  "version": "0.5.1",
   "description": "Type-safe Zod schemas for Retell AI API resources with lifecycle-aware discriminated unions and generic customization",
   "type": "module",
   "zshy": {