@voicelayer/sdk 0.5.0 → 0.6.0

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

@@ -434,6 +434,8 @@ var FlowNodeType = z.enum([
   "ask",
   "confirm",
   "tool",
+  // Send an email through the workspace's email (metered, wallet-gated; From on a verified domain) — burn-down G-22.
+  "email",
   "decision",
   "handoff",
   "end",
@@ -626,7 +628,15 @@ var ProcessToolDTO = z.object({
    * Self-hosted workers only: allow a private / loopback address (a localhost service of your own). A platform
    * worker (it holds the internal service token) never honours it.
    */
-  allowPrivateNetwork: z.boolean().optional()
+  allowPrivateNetwork: z.boolean().optional(),
+  /**
+   * Burn-down G-33: the model reads the caller's PII as tokens (`<PII_PHONE_1>`). `true` — this tool's arguments carry
+   * the caller's real values instead, when its URL fixes the host (publish refuses it on a host the call fills in).
+   * Absent — real values only when it signs in with a connection; otherwise the endpoint gets the tokens. `false` —
+   * always the tokens.
+   * (packages/sdk/test/tool-detokenise.test.ts)
+   */
+  sendRealValues: z.boolean().optional()
 });
 var ProcessSchemaDTO = z.object({
   id: z.string().min(1).max(64),
@@ -1186,8 +1196,14 @@ var AgentConfig = z.object({
   // collects nothing structured. DERIVED from the agents row; read-only.
   requiredInfo: z.array(RequiredInfoField).max(64).default([]),
   createdAt: z.string().datetime(),
-  // Optimistic-lock token. PATCH must echo this in If-Match.
-  updatedAt: z.string().datetime()
+  // On the draft view: when the draft row last changed. On the published view (GET /config's default): when what runs
+  // last changed — the published version's createdAt. Only the draft's is the PATCH lock token: send draftUpdatedAt.
+  updatedAt: z.string().datetime(),
+  // The optimistic-lock token PATCH /v1/agents/:id/config checks (If-Match; also sent, quoted, as the ETag): the DRAFT
+  // row's updatedAt. Always on the draft view; on the published view only while the draft equals what's published —
+  // otherwise absent, and an editor reads ?view=draft, so it never writes over unpublished changes it didn't see
+  // (burn-down G-37). A projection of the existing column, not a stored field (agents DECISIONS A-7 stands).
+  draftUpdatedAt: z.string().datetime().optional()
 });
 
 // ../contracts/src/call-plan.ts
@@ -1395,6 +1411,56 @@ z.object({
   ok: z.literal(true),
   scopesPurged: z.array(MemoryScope)
 });
+var EMAIL_RE = /^[^\s@<>"]+@[^\s@<>"]+\.[^\s@<>"]+$/;
+function isEmailAddress(value) {
+  return EMAIL_RE.test(value) && value.length <= 254;
+}
+var EMAIL_SUBJECT_MAX = 200;
+var EMAIL_TEXT_MAX = 5e4;
+var EMAIL_HTML_MAX = 2e5;
+var address = z.string().max(254).refine(isEmailAddress, { message: "must be an email address" });
+z.object({
+  to: address,
+  subject: z.string().min(1).max(EMAIL_SUBJECT_MAX),
+  text: z.string().min(1).max(EMAIL_TEXT_MAX),
+  html: z.string().min(1).max(EMAIL_HTML_MAX).optional(),
+  // An address on one of the workspace's verified sending domains; omitted → the platform sender.
+  from: address.optional(),
+  // The display name shown beside `from` (or beside the platform sender's address).
+  fromName: z.string().trim().min(1).max(64).refine((v) => !/[\r\n<>"]/.test(v), { message: 'must not contain line breaks, <, > or "' }).optional(),
+  // Where a reply goes — any address; it needs no verification.
+  replyTo: address.optional(),
+  // The conversation (a call, a text conversation) the email belongs to — a conversation sends at most 3 emails.
+  conversationId: z.string().min(1).max(128).optional()
+});
+var DOMAIN_RE = /^(?=.{4,253}$)(?!-)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z]{2,63}$/;
+function normalizeDomain(input) {
+  return input.trim().toLowerCase().replace(/^[a-z]+:\/\//, "").replace(/\/.*$/, "").replace(/\.$/, "");
+}
+function isDomainName(value) {
+  return DOMAIN_RE.test(value);
+}
+z.object({
+  domain: z.string().max(253).transform(normalizeDomain).refine(isDomainName, { message: "must be a domain like example.com" })
+});
+var EmailDomainStatus = z.enum(["pending", "verified", "failed"]);
+var EmailDnsRecord = z.object({
+  type: z.enum(["CNAME", "TXT"]),
+  name: z.string(),
+  value: z.string(),
+  // dkim: proves the domain (required); dmarc: recommended, only when the domain has no DMARC record yet.
+  purpose: z.enum(["dkim", "dmarc"]),
+  required: z.boolean()
+});
+z.object({
+  id: z.string(),
+  domain: z.string(),
+  status: EmailDomainStatus,
+  records: z.array(EmailDnsRecord),
+  createdAt: z.string().datetime(),
+  lastCheckedAt: z.string().datetime().nullable(),
+  verifiedAt: z.string().datetime().nullable()
+});
 z.object({
   systemPrompt: z.string().max(64e3),
   routingInstructions: z.string().max(32e3).nullable(),
@@ -1470,21 +1536,27 @@ z.object({
 
 // ../contracts/src/providers.ts
 var PROVIDERS = {
-  openai: { id: "openai", label: "OpenAI", capabilities: ["llm", "tts", "realtime"], byok: true, supportsBaseUrl: true, keyPlaceholder: "sk-..." },
-  anthropic: { id: "anthropic", label: "Anthropic", capabilities: ["llm"], byok: true, supportsBaseUrl: true, keyPlaceholder: "sk-ant-..." },
-  deepgram: { id: "deepgram", label: "Deepgram", capabilities: ["stt", "tts"], byok: true, supportsBaseUrl: false, keyPlaceholder: "Deepgram API key" },
-  elevenlabs: { id: "elevenlabs", label: "ElevenLabs", capabilities: ["tts"], byok: true, supportsBaseUrl: false, keyPlaceholder: "ElevenLabs API key" },
-  cartesia: { id: "cartesia", label: "Cartesia", capabilities: ["stt", "tts"], byok: true, supportsBaseUrl: false, keyPlaceholder: "Cartesia API key" },
-  assemblyai: { id: "assemblyai", label: "AssemblyAI", capabilities: ["stt"], byok: true, supportsBaseUrl: false, keyPlaceholder: "AssemblyAI API key" },
-  google: { id: "google", label: "Google (Gemini)", capabilities: ["llm", "realtime"], byok: true, supportsBaseUrl: false, keyPlaceholder: "AIza..." },
-  groq: { id: "groq", label: "Groq", capabilities: ["llm"], byok: true, supportsBaseUrl: true, keyPlaceholder: "gsk_..." },
+  openai: { id: "openai", label: "OpenAI", capabilities: ["llm", "tts", "realtime"], byok: true, supportsBaseUrl: true, keyPlaceholder: "sk-...", runsOn: { llm: ["voice", "text"], tts: ["voice"], realtime: ["voice"] }, platformKeyEnv: "OPENAI_API_KEY" },
+  // No platform runtime: LiveKit's anthropic plugin needs @livekit/agents >= 1.5 (the workers pin 1.4.0 — the 1.7 audio
+  // regression), and the API's text replies run OpenAI only (burn-down G-9).
+  anthropic: { id: "anthropic", label: "Anthropic", capabilities: ["llm"], byok: true, supportsBaseUrl: true, keyPlaceholder: "sk-ant-...", runsOn: { llm: [] }, platformKeyEnv: "ANTHROPIC_API_KEY" },
+  deepgram: { id: "deepgram", label: "Deepgram", capabilities: ["stt", "tts"], byok: true, supportsBaseUrl: false, keyPlaceholder: "Deepgram API key", runsOn: { stt: ["voice"], tts: ["voice"] }, platformKeyEnv: "DEEPGRAM_API_KEY" },
+  elevenlabs: { id: "elevenlabs", label: "ElevenLabs", capabilities: ["tts"], byok: true, supportsBaseUrl: false, keyPlaceholder: "ElevenLabs API key", runsOn: { tts: ["voice"] }, platformKeyEnv: "ELEVEN_API_KEY" },
+  // Cartesia's LiveKit plugin (1.4.0) ships TTS only: its speech-to-text has no runtime.
+  cartesia: { id: "cartesia", label: "Cartesia", capabilities: ["stt", "tts"], byok: true, supportsBaseUrl: false, keyPlaceholder: "Cartesia API key", runsOn: { stt: [], tts: ["voice"] }, platformKeyEnv: "CARTESIA_API_KEY" },
+  assemblyai: { id: "assemblyai", label: "AssemblyAI", capabilities: ["stt"], byok: true, supportsBaseUrl: false, keyPlaceholder: "AssemblyAI API key", runsOn: { stt: ["voice"] }, platformKeyEnv: "ASSEMBLYAI_API_KEY" },
+  // Gemini on text waits on burn-down G-9 (the API's text replies run OpenAI only).
+  google: { id: "google", label: "Google (Gemini)", capabilities: ["llm", "realtime"], byok: true, supportsBaseUrl: false, keyPlaceholder: "AIza...", runsOn: { llm: ["voice"], realtime: ["voice"] }, platformKeyEnv: "GOOGLE_API_KEY" },
+  groq: { id: "groq", label: "Groq", capabilities: ["llm"], byok: true, supportsBaseUrl: true, keyPlaceholder: "gsk_...", runsOn: { llm: [] }, platformKeyEnv: "GROQ_API_KEY" },
   // Runtime-only providers (no external key): local VAD.
-  silero: { id: "silero", label: "Silero", capabilities: ["vad"], byok: false, supportsBaseUrl: false }
+  silero: { id: "silero", label: "Silero", capabilities: ["vad"], byok: false, supportsBaseUrl: false, runsOn: { vad: ["voice"] } }
 };
 function byokProviders() {
   return Object.values(PROVIDERS).filter((p) => p.byok);
 }
 var ProviderKind = z.enum(["llm", "stt", "tts", "realtime"]);
+var ModelSurface = z.enum(["voice", "text"]);
+var ProviderKeySource = z.enum(["workspace", "platform", "none"]);
 var CatalogVoice = z.object({
   id: z.string().min(1).max(128),
   label: z.string().min(1).max(128),
@@ -1518,7 +1590,12 @@ var CatalogProvider = z.object({
   // Populated for tts / realtime providers.
   voices: z.array(CatalogVoice).optional(),
   // Pre-selected when the provider is chosen.
-  defaultModel: z.string().max(128).optional()
+  defaultModel: z.string().max(128).optional(),
+  // The surfaces the platform runs this provider's models on (contracts PROVIDERS `runsOn`). A picker offers the
+  // provider only for a surface listed here; absent means none, so an unrunnable provider is never offered by default.
+  surfaces: z.array(ModelSurface).default([]),
+  // Whose key this provider would run on for the requesting workspace; unknown means none.
+  key: ProviderKeySource.default("none")
 });
 z.object({
   llm: z.array(CatalogProvider).default([]),
@@ -1573,8 +1650,26 @@ z.object({
   // The assumptions actually used (after defaults) — drives the UI footnote.
   assumptions: CostEstimateAssumptions.required()
 });
+
+// ../contracts/src/openai-models.ts
+function categorizeOpenAiModel(id) {
+  const s = id.toLowerCase();
+  if (s.includes("realtime")) return "realtime";
+  if (s.includes("transcribe") || s.includes("whisper")) return "stt";
+  if (s.includes("tts") || s.includes("audio-speech")) return "tts";
+  if (/embedding|moderation|dall-e|image|^omni-|^text-|search|rerank|babbage|davinci|codex/.test(s)) {
+    return null;
+  }
+  if (/-pro\b|deep-research|computer-use/.test(s)) return null;
+  if (/^(gpt|o[0-9]|chatgpt)/.test(s)) return "llm";
+  return null;
+}
+function isOpenAiChatModel(id) {
+  return categorizeOpenAiModel(id) === "llm";
+}
 var EvaluationMetric = z.enum(["rating", "binary", "options", "text"]);
 var EvaluationStatus = z.enum(["pending", "scored", "failed"]);
+var EvaluationJudgeModel = z.string().min(1).max(128).refine(isOpenAiChatModel, { message: "The judge runs OpenAI chat models only (e.g. gpt-4o-mini)." });
 var EvaluationOption = z.object({
   value: z.string().min(1).max(64),
   label: z.string().min(1).max(120),
@@ -1586,6 +1681,7 @@ z.object({
   name: z.string().min(1).max(120),
   criteria: z.string().max(4e3),
   metric: EvaluationMetric,
+  // a stored row may predate the judge-model rule; it is judged on the default (EVALUATION_JUDGE_SUGGESTIONS)
   model: z.string().min(1).max(128),
   minValue: z.number().int().nullable(),
   minLabel: z.string().nullable(),
@@ -1601,7 +1697,7 @@ var EvaluationInput = z.object({
   name: z.string().min(1).max(120),
   criteria: z.string().max(4e3).default(""),
   metric: EvaluationMetric.default("rating"),
-  model: z.string().min(1).max(128).default("gpt-4o-mini"),
+  model: EvaluationJudgeModel.default("gpt-4o-mini"),
   minValue: z.number().int().nullable().optional(),
   minLabel: z.string().max(200).nullable().optional(),
   maxValue: z.number().int().nullable().optional(),
@@ -1763,7 +1859,10 @@ var ToolCallAudit = z.object({
   ok: z.boolean(),
   // refused by the Action Guard before it ran
   blocked: z.boolean(),
-  errorMessage: z.string().optional()
+  errorMessage: z.string().optional(),
+  // Burn-down G-33: the call's PII tokens swapped back for the caller's real values in this tool's arguments (it went to
+  // a trusted destination) — how many, and the host they went to (null: the agent's own code). Never a value.
+  detokenized: z.object({ count: z.number().int().min(1), destinationHost: z.string().nullable() }).optional()
 });
 var McpInteractionAudit = z.object({
   // One of the four runtime tools — closed set, no growth allowed.
@@ -2429,7 +2528,14 @@ z.discriminatedUnion("kind", [
   BrainRequestFrame,
   BrainCancelFrame
 ]);
-var FLOW_BOOT_FAILURES = ["schema_fetch_failed", "no_process_schema", "missing_agent_id", "no_api_key", "worker_identity_refused"];
+var FLOW_BOOT_FAILURES = [
+  "schema_fetch_failed",
+  "no_process_schema",
+  "missing_agent_id",
+  "no_api_key",
+  "worker_identity_refused",
+  "provider_unavailable"
+];
 z.enum(
   FLOW_BOOT_FAILURES.map((cause) => `flow_boot:${cause}`)
 );