@voicelayer/sdk 0.6.1 → 0.6.3

package/dist/brain/index.d.ts

@@ -81,14 +81,14 @@ declare const ConnectorUpFrame: z.ZodDiscriminatedUnion<"kind", [z.ZodObject<{
     code: z.ZodEnum<["upstream_timeout", "upstream_error", "bad_response", "normalize_failed", "unreachable"]>;
     message: z.ZodString;
 }, "strip", z.ZodTypeAny, {
+    kind: "brain.error";
     code: "upstream_timeout" | "upstream_error" | "bad_response" | "normalize_failed" | "unreachable";
     message: string;
-    kind: "brain.error";
     streamId: string;
 }, {
+    kind: "brain.error";
     code: "upstream_timeout" | "upstream_error" | "bad_response" | "normalize_failed" | "unreachable";
     message: string;
-    kind: "brain.error";
     streamId: string;
 }>]>;
 type ConnectorUpFrame = z.infer<typeof ConnectorUpFrame>;

package/dist/brain/index.js

@@ -883,7 +883,9 @@ var CallEventKind = z.enum([
   "dtmf.sent",
   // A host's runtime intervention (burn-down G-6): call_say / call_send_guidance / call_inject_context / call_instruct,
   // with masked args and the API key — written by the API only, never through the worker's /events endpoint.
-  "mcp.interaction"
+  "mcp.interaction",
+  // One per caller turn the agent answered (burn-down G-44): where that turn's wait went — see TurnLatencyPayload.
+  "turn.latency"
 ]);
 var OP_CALL_EVENT_KIND = /^(tool|handoff|lookup|record|notify|engine)\.[a-z0-9_]{1,48}(\.[a-z0-9_]{1,48})?$/;
 var OpCallEventKind = z.string().regex(OP_CALL_EVENT_KIND);
@@ -910,6 +912,17 @@ z.object({
   code: z.number().int().min(0).max(15),
   participantId: z.string().optional()
 });
+var LatencyMs = z.number().int().min(0).max(6e5).nullable();
+z.object({
+  turn: z.number().int().min(1),
+  atMs: z.number().int().min(0),
+  endpointingMs: LatencyMs,
+  sttMs: LatencyMs,
+  llmMs: LatencyMs,
+  ttsMs: LatencyMs,
+  endToEndMs: LatencyMs,
+  realtime: z.boolean().optional()
+});
 z.object({
   totalUsd: z.string(),
   breakdown: z.object({
@@ -1019,6 +1032,58 @@ z.union([
     error: z.object({ code: TextTurnErrorCode, detail: z.string().max(500).optional() })
   })
 ]);
+var PLATFORM_MAX_CALL_MINUTES = 240;
+var Message = z.string().trim().min(1).max(300);
+var CallerRateLimit = z.object({
+  enabled: z.boolean().optional(),
+  perTenMinutes: z.number().int().min(1).max(100).optional(),
+  perDay: z.number().int().min(1).max(1e3).optional(),
+  withheldPerTenMinutes: z.number().int().min(1).max(100).optional(),
+  withheldPerDay: z.number().int().min(1).max(1e3).optional()
+});
+var CallLimits = z.object({
+  /** The agent's own ceiling in minutes; clamped to the workspace's plan ceiling. Absent ⇒ DEFAULT_MAX_CALL_MINUTES. */
+  maxDurationMinutes: z.number().int().min(1).max(PLATFORM_MAX_CALL_MINUTES).optional(),
+  /** Seconds before the limit the wrap-up line is spoken; 0 ⇒ no warning. */
+  wrapUpWarningSeconds: z.number().int().min(0).max(300).optional(),
+  wrapUpMessage: Message.optional(),
+  goodbyeMessage: Message.optional(),
+  callerRateLimit: CallerRateLimit.optional(),
+  rateLimitedMessage: Message.optional()
+});
+var CallerChannel = z.enum(["phone", "web"]);
+z.object({
+  roomName: z.string().min(1).max(256),
+  /** From the dispatch metadata: lets the API admit (gate) a room whose call row doesn't exist yet. */
+  agentId: z.string().max(128).optional(),
+  phoneNumberId: z.string().max(128).optional(),
+  caller: z.object({
+    channel: CallerChannel,
+    /** The caller's number as the carrier presented it; null / absent / not E.164 ⇒ the withheld bucket. */
+    number: z.string().max(64).nullable().optional()
+  })
+});
+var CallDurationLimits = z.object({
+  /** The agent's own ceiling (already clamped to the plan), or null when it set none. */
+  agentMaxSeconds: z.number().int().min(1).nullable(),
+  /** The plan ceiling — the platform bound no call outlives. */
+  ceilingSeconds: z.number().int().min(1),
+  wrapUpWarningSeconds: z.number().int().min(0),
+  wrapUpMessage: z.string(),
+  goodbyeMessage: z.string()
+});
+z.discriminatedUnion("admitted", [
+  z.object({ admitted: z.literal(true), limits: CallDurationLimits }),
+  z.object({
+    admitted: z.literal(false),
+    /** 'rate_limited:caller' | 'inbound_refused:<code>' — already recorded as the call's end reason. */
+    endReason: z.string(),
+    /** The fixed line to speak before hanging up. */
+    message: z.string()
+  })
+]);
+
+// ../contracts/src/agent-config.ts
 var VoiceConfig = z.object({
   // Finite, vetted list — platform-level enum.
   provider: z.enum(["deepgram", "elevenlabs", "openai", "cartesia"]),
@@ -1181,6 +1246,9 @@ var AgentConfig = z.object({
   // LLM slot through the connector instead of a first-party model. Null/absent →
   // first-party pipeline (unchanged default). See docs/specs/voice-brain-connector.
   brainConnectorId: z.string().uuid().nullable().optional(),
+  // Per-agent call bounds: caller rate limit, max duration and their spoken lines (burn-down G-41, G-43). Absent ⇒
+  // every default (call-limits.ts) — the rate limit is ON by default.
+  callLimits: CallLimits.optional(),
   // Provenance: 'sdk' (hand-coded defineAgent worker), 'flow' (canvas deploy),
   // 'playbook' (agent-mode deploy), or 'connector' (brain-connector agent).
   // DERIVED from the linked agents row's deploy tags (flowId / playbookId /
@@ -1474,6 +1542,8 @@ z.object({
   consultation: ConsultationPolicy,
   tags: z.array(z.string().max(64)).max(32).nullable(),
   brainConnectorId: z.string().uuid().nullable(),
+  // Versions published before call limits existed carry none: read as null (every default).
+  callLimits: CallLimits.nullable().default(null),
   flowVersion: z.number().int().nullable(),
   processSchema: ProcessSchemaDTO.nullable()
 });
@@ -1509,6 +1579,7 @@ var AgentConfigDiffField = z.enum([
   "language",
   "tools",
   "brainConnectorId",
+  "callLimits",
   "consultation",
   "tags",
   "flowVersion",
@@ -1634,6 +1705,9 @@ var CostEstimatePerMinute = z.object({
 var CostEstimateBilledPerMinute = z.object({
   platformFee: z.number().nonnegative(),
   providerPassthrough: z.number().nonnegative(),
+  // The flat own-key fee per minute (burn-down B-26); 0 when every provider runs on the platform's keys. Optional
+  // only for responses from an API older than the fee.
+  ownKeyFee: z.number().nonnegative().optional(),
   telephony: z.number().nonnegative(),
   allIn: z.number().nonnegative()
 });
@@ -1834,6 +1908,38 @@ z.object({
   note: z.string().max(2e3).nullable().optional(),
   reviewed: z.boolean().optional()
 });
+var CAPTURED_FIELDS_MAX = 200;
+var CAPTURED_STRING_MAX_CHARS = 8e3;
+var CAPTURED_ARRAY_MAX_ITEMS = 100;
+var CapturedFieldValue = z.union([
+  z.string().max(CAPTURED_STRING_MAX_CHARS),
+  z.number().finite(),
+  z.boolean(),
+  z.array(z.string().max(CAPTURED_STRING_MAX_CHARS)).max(CAPTURED_ARRAY_MAX_ITEMS),
+  z.null()
+]);
+var CapturedField = z.object({
+  name: z.string().min(1).max(64),
+  type: ProcessFieldType,
+  required: z.boolean(),
+  // false ⇒ the call never captured it; `value` is then null
+  filled: z.boolean(),
+  value: CapturedFieldValue
+});
+var StructuredOutputs = z.record(CapturedFieldValue);
+z.object({
+  // Every declared field, in declaration order; empty when the agent declares none.
+  fields: z.array(CapturedField).max(CAPTURED_FIELDS_MAX)
+}).superRefine((body, ctx) => {
+  const seen = /* @__PURE__ */ new Set();
+  for (const f of body.fields) {
+    if (seen.has(f.name)) ctx.addIssue({ code: z.ZodIssueCode.custom, message: `duplicate field ${f.name}` });
+    seen.add(f.name);
+    if (!f.filled && f.value !== null) ctx.addIssue({ code: z.ZodIssueCode.custom, message: `${f.name}: an unfilled field has no value` });
+  }
+});
+
+// ../contracts/src/call-result.ts
 var TranscriptTurn = z.object({
   speaker: z.enum(["caller", "agent"]),
   text: z.string(),
@@ -1882,9 +1988,13 @@ z.object({
   startedAt: z.string().datetime(),
   endedAt: z.string().datetime(),
   durationMs: z.number().int().min(0),
+  // Final segments only, in call order.
   transcript: z.array(TranscriptTurn),
-  // Whatever the agent's process-schema captured. No prescribed shape.
-  structuredOutputs: z.record(z.unknown()).optional(),
+  // The filled fields of the agent's process / flow, keyed by name (burn-down G-20). Absent when the agent declares no
+  // fields, or its worker never reported them.
+  structuredOutputs: StructuredOutputs.optional(),
+  // Every declared field with what the call captured and whether it was filled — the same list `call.ended` carries.
+  fields: z.array(CapturedField).optional(),
   recordingUrl: z.string().url().optional(),
   cost: z.object({
     totalUsd: z.string(),
@@ -1911,7 +2021,18 @@ z.object({
   // set, it is the same value `call.ended` carries; `call.ended` always has one.
   direction: CallWebhookDirection.nullable()
 });
+var CALL_ENDED_PAYLOAD_VERSION = 2;
+var CallEndedTranscript = z.object({
+  // Final segments only (what was said, never an interim STT guess), in call order. Empty when `truncated`.
+  turns: z.array(TranscriptTurn),
+  // How many final turns the call has — the length of `turns` unless truncated.
+  turnCount: z.number().int().min(0),
+  truncated: z.boolean(),
+  // Where the whole transcript is: GET /v1/calls/:callId/result (its `transcript`). Always set.
+  fetchPath: z.string().regex(/^\/v1\/calls\/[0-9a-f-]{36}\/result$/)
+});
 z.object({
+  version: z.literal(CALL_ENDED_PAYLOAD_VERSION),
   callId: z.string().uuid(),
   durationMs: z.number().int().min(0),
   endedAt: z.string().datetime(),
@@ -1922,7 +2043,20 @@ z.object({
   toE164: Party,
   direction: CallWebhookDirection,
   outcome: CallWebhookOutcome,
-  attributes: CallWebhookAttributes
+  attributes: CallWebhookAttributes,
+  // Every field the agent declared (its process, or a flow's slots), in declaration order, with what the call captured
+  // and whether it was filled. Empty when the agent declares none.
+  fields: z.array(CapturedField),
+  // The filled fields as one object keyed by name (as GET /v1/calls/:id/result returns them). Absent when the agent
+  // declares no fields.
+  structuredOutputs: StructuredOutputs.optional(),
+  transcript: CallEndedTranscript,
+  // true: the agent's worker confirmed its last transcript segment and captured field had landed before this payload
+  // was built. false: built without that word (a worker that crashed or runs an SDK before 0.6.2, or one that didn't
+  // answer within the hold) — the transcript and fields are what had arrived; GET /v1/calls/:id/result has any later.
+  finalized: z.boolean(),
+  // true: the payload would have passed CALL_ENDED_PAYLOAD_MAX_BYTES, so values were left out (see the cap) — fetch them.
+  valuesOmitted: z.boolean()
 });
 z.object({
   callId: z.string().uuid(),
@@ -2267,161 +2401,6 @@ z.object({
   settings: TelephonySettings,
   profile: EffectiveCallProfile
 });
-var SHORTENER_HOSTS = [
-  "bit.ly",
-  "tinyurl.com",
-  "t.co",
-  "goo.gl",
-  "ow.ly",
-  "is.gd",
-  "buff.ly",
-  "rebrand.ly",
-  "cutt.ly",
-  "shorturl.at",
-  "tiny.cc"
-];
-var PLACEHOLDER_HOSTS = ["acme.com", "example.com", "example.org", "test.com", "localhost"];
-var PublicUrl = z.string().url().refine((v) => v.startsWith("https://"), "must be https").refine((v) => {
-  try {
-    const host = new URL(v).hostname.toLowerCase().replace(/^www\./, "");
-    return !SHORTENER_HOSTS.includes(host);
-  } catch {
-    return false;
-  }
-}, "public URL shorteners are rejected by carriers \u2014 use your own domain").refine((v) => {
-  try {
-    const host = new URL(v).hostname.toLowerCase().replace(/^www\./, "");
-    return !PLACEHOLDER_HOSTS.some((p) => host === p || host.endsWith(`.${p}`));
-  } catch {
-    return false;
-  }
-}, "placeholder domain \u2014 reviewers will follow this link and reject the campaign");
-var A2pBusinessType = z.enum([
-  "Sole Proprietorship",
-  "Partnership",
-  "Corporation",
-  "Co-operative",
-  "Limited Liability Corporation",
-  "Non-profit Corporation"
-]);
-var A2pBusinessInfo = z.object({
-  legalName: z.string().trim().min(2).max(200),
-  /** EIN (US) or equivalent registration number. */
-  registrationNumber: z.string().trim().min(4).max(50),
-  businessType: A2pBusinessType,
-  /** Publicly reachable production site — not staging, not a 404. */
-  website: PublicUrl,
-  industry: z.string().trim().min(2).max(60),
-  address: z.object({
-    street: z.string().trim().min(2).max(200),
-    city: z.string().trim().min(1).max(100),
-    region: z.string().trim().min(1).max(100),
-    postalCode: z.string().trim().min(2).max(20),
-    isoCountry: z.string().trim().length(2)
-  }),
-  authorizedRep: z.object({
-    firstName: z.string().trim().min(1).max(100),
-    lastName: z.string().trim().min(1).max(100),
-    email: z.string().trim().email(),
-    phone: z.string().trim().regex(/^\+[1-9]\d{6,14}$/, "must be E.164"),
-    jobTitle: z.string().trim().min(2).max(100)
-  })
-});
-var A2pOptInType = z.enum(["WEB_FORM", "PAPER_FORM", "VERBAL", "VIA_TEXT", "MOBILE_QR_CODE"]);
-var A2pUseCase = z.enum([
-  "MIXED",
-  "CUSTOMER_CARE",
-  "MARKETING",
-  "ACCOUNT_NOTIFICATION",
-  "2FA",
-  "DELIVERY_NOTIFICATION",
-  "HIGHER_EDUCATION",
-  "POLLING_VOTING",
-  "PUBLIC_SERVICE_ANNOUNCEMENT",
-  "LOW_VOLUME"
-]);
-var A2pMessagingProfile = z.object({
-  useCase: A2pUseCase,
-  /** Specific, not generic. "We send texts" gets rejected; describe the actual
-   *  messages and when they are sent. */
-  description: z.string().trim().min(40).max(4096),
-  /**
-   * The single most-rejected field. Must describe HOW people opt in, state the
-   * message frequency, include the "message and data rates may apply"
-   * disclosure, and link to publicly reachable evidence. Twilio's API bounds it
-   * to 40–2049 characters.
-   */
-  messageFlow: z.string().trim().min(40).max(2049),
-  optInType: A2pOptInType,
-  /** Publicly accessible screenshots/pages showing the opt-in. Reviewers open
-   *  these; anything behind a login fails. */
-  optInEvidenceUrls: z.array(PublicUrl).min(1).max(5),
-  /** Real messages the customer will send. Must reflect the declared use case
-   *  and carry opt-out language. */
-  messageSamples: z.array(z.string().trim().min(10).max(1024)).min(2).max(5),
-  privacyPolicyUrl: PublicUrl,
-  termsAndConditionsUrl: PublicUrl,
-  hasEmbeddedLinks: z.boolean().default(false),
-  hasEmbeddedPhone: z.boolean().default(false)
-});
-z.object({
-  business: A2pBusinessInfo,
-  messaging: A2pMessagingProfile,
-  /** Register against Twilio's mock endpoints — exercises the full pipeline
-   *  with no fees and no real carrier submission. Used in CI and staging. */
-  mock: z.boolean().default(false)
-}).superRefine((v, ctx) => {
-  const flow = v.messaging.messageFlow.toLowerCase();
-  if (!/(msg|message)\s*(&|and)\s*data rates/.test(flow)) {
-    ctx.addIssue({
-      code: z.ZodIssueCode.custom,
-      path: ["messaging", "messageFlow"],
-      message: 'must include a "Message and data rates may apply" disclosure \u2014 carriers reject without it'
-    });
-  }
-  if (!/\d/.test(flow) || !/(msg|message|text)/.test(flow)) {
-    ctx.addIssue({
-      code: z.ZodIssueCode.custom,
-      path: ["messaging", "messageFlow"],
-      message: 'must state message frequency, e.g. "Up to 4 msgs/month"'
-    });
-  }
-  const hasOptOut = v.messaging.messageSamples.some((s) => /stop/i.test(s));
-  if (!hasOptOut) {
-    ctx.addIssue({
-      code: z.ZodIssueCode.custom,
-      path: ["messaging", "messageSamples"],
-      message: 'at least one sample must include opt-out language (e.g. "Reply STOP to opt out")'
-    });
-  }
-});
-var A2pState = z.enum([
-  "none",
-  "profile_pending",
-  "profile_approved",
-  "profile_failed",
-  "brand_pending",
-  "brand_approved",
-  "brand_failed",
-  "campaign_pending",
-  "messaging_ready",
-  "campaign_failed"
-]);
-z.object({
-  state: A2pState,
-  customerProfileSid: z.string().nullable(),
-  trustProductSid: z.string().nullable(),
-  brandSid: z.string().nullable(),
-  messagingServiceSid: z.string().nullable(),
-  campaignSid: z.string().nullable(),
-  mock: z.boolean(),
-  /** Carrier/Twilio rejection details, surfaced verbatim so the customer can
-   *  fix the specific field rather than guess. */
-  failures: z.array(z.object({ code: z.number().nullable(), field: z.string().nullable(), message: z.string() })).default([]),
-  /** Plain-language next step for the dashboard. */
-  nextAction: z.string().nullable(),
-  updatedAt: z.string().nullable()
-});
 var ConnectorMode = z.enum(["tunnel", "direct"]);
 var ConnectorStatus = z.enum(["online", "degraded", "offline"]);
 var ConnectorNormalize = z.enum(["auto", "on", "off"]);
@@ -2536,9 +2515,11 @@ var FLOW_BOOT_FAILURES = [
   "worker_identity_refused",
   "provider_unavailable"
 ];
-z.enum(
-  FLOW_BOOT_FAILURES.map((cause) => `flow_boot:${cause}`)
-);
+var AGENT_END_REASONS = [
+  "max_duration",
+  ...FLOW_BOOT_FAILURES.map((cause) => `flow_boot:${cause}`)
+];
+z.enum(AGENT_END_REASONS);
 var EnvironmentSpec = z.enum(["draft", "live"]);
 z.object({
   agentName: z.string().min(1),
@@ -3603,6 +3584,18 @@ z.object({
   thresholdUsd: z.number().min(1).max(TOPUP_MAX_USD),
   amountUsd: z.number().int().min(TOPUP_MIN_USD).max(TOPUP_MAX_USD)
 });
+var PipelineSlotKey = z.object({
+  /** The provider as the slot reports it (LiveKit's label: `openai`, `api.openai.com`, `Deepgram`, …). */
+  provider: z.string().min(1).max(200),
+  /** true = the workspace's own key built it; false = the platform's. */
+  byok: z.boolean()
+});
+z.object({
+  llm: PipelineSlotKey.optional(),
+  stt: PipelineSlotKey.optional(),
+  tts: PipelineSlotKey.optional(),
+  realtime: PipelineSlotKey.optional()
+});
 
 // src/brain/transport-tunnel.ts
 var AsyncQueue = class {