@runtypelabs/voice 0.2.4 → 0.4.0

package/dist/types-Dkh4LxEA.d.ts

@@ -0,0 +1,100 @@
+type VoiceStatus = 'idle' | 'connecting' | 'listening' | 'thinking' | 'speaking' | 'error';
+type InterruptionMode = 'none' | 'cancel' | 'barge-in';
+interface TranscriptEntry {
+    readonly role: 'user' | 'assistant';
+    readonly content: string;
+    readonly timestamp: number;
+    readonly isFinal?: boolean;
+    readonly turnId?: string;
+    /**
+     * The reply is still being spoken, so `content` holds the clauses committed so
+     * far. A later snapshot replaces this entry with the authoritative transcript,
+     * or clears the flag in place when the caller stops the reply.
+     */
+    readonly partial?: boolean;
+}
+interface VoiceMetrics {
+    readonly llmMs?: number;
+    readonly ttsMs?: number;
+    readonly firstAudioMs?: number;
+    readonly totalMs?: number;
+    /**
+     * Turn start to the first synthesis request. Below `llmMs` when the engine spoke
+     * clauses while the reply was still generating, and equal to it otherwise.
+     */
+    readonly firstSynthesisMs?: number;
+    /** True when the reply was synthesized clause by clause, so `ttsMs` covers overlapped work. */
+    readonly incremental?: boolean;
+}
+/** File metadata for a previewable artifact, mirroring the unified `artifact_start.file` field. */
+interface VoiceArtifactFile {
+    readonly path: string;
+    readonly mimeType: string;
+    readonly language?: string;
+}
+/**
+ * An artifact the agent produced during a call, assembled from the additive
+ * `artifact` wire message. Artifacts arrive beside speech and are never spoken.
+ */
+interface VoiceArtifact {
+    readonly id: string;
+    readonly turnId: string | null;
+    readonly executionId?: string;
+    readonly artifactType: 'markdown' | 'component';
+    readonly title?: string;
+    readonly file?: VoiceArtifactFile;
+    readonly content: string;
+    readonly component?: string;
+    readonly props?: Record<string, unknown>;
+    readonly status: 'streaming' | 'complete';
+}
+/** The conversation this call is attached to, reported by the server once the call opens. */
+interface VoiceSession {
+    readonly sessionId: string;
+    readonly conversationId: string;
+}
+interface VoiceSnapshot {
+    readonly status: VoiceStatus;
+    readonly transcript: readonly TranscriptEntry[];
+    readonly interimTranscript: string | null;
+    readonly metrics: VoiceMetrics | null;
+    readonly audioLevel: number;
+    readonly isMuted: boolean;
+    readonly error: string | null;
+    readonly errorDetails?: {
+        code: string;
+        serverId?: string;
+        serverName: string;
+        diagnosticId: string;
+    };
+    readonly interruptionMode: InterruptionMode;
+    readonly canCancel: boolean;
+    readonly artifacts: readonly VoiceArtifact[];
+    /** Survives `endCall` so a host can reopen the same conversation; null until the server reports it. */
+    readonly session: VoiceSession | null;
+}
+interface VoiceClientOptions {
+    agentId: string;
+    /** Disable when the transcript consumer only supports sequential pipeline turns. */
+    fullDuplex?: boolean;
+    /** Optional custom audio source; the client owns and stops the returned tracks. */
+    audioSource?: () => Promise<MediaStream>;
+    /** Browser client token, or a getter called once per call to obtain a fresh token. */
+    clientToken: string | (() => string | Promise<string>);
+    /** Absolute API base URL, including any proxy path prefix. Defaults to https://api.runtype.com. */
+    apiUrl?: string;
+    /**
+     * Declares the `artifacts` capability, so the server sends `artifact` messages
+     * and the client assembles `snapshot.artifacts`. Off by default, which keeps an
+     * existing embed's wire byte-identical.
+     */
+    artifacts?: boolean;
+    /** Reuses an existing client session's conversation. Overrides the id remembered from a previous call. */
+    sessionId?: string;
+    /** Proof minted by client/init; resolve from the host's token-scoped visitor store on every call. */
+    visitorToken?: string | (() => string | undefined | Promise<string | undefined>);
+    /** Observe the server's conversation so a host can reuse it for text. Never contains visitor credentials. */
+    onSession?: (session: VoiceSession) => void;
+}
+
+export type { InterruptionMode as I, TranscriptEntry as T, VoiceClientOptions as V, VoiceSnapshot as a, VoiceArtifact as b, VoiceArtifactFile as c, VoiceMetrics as d, VoiceSession as e, VoiceStatus as f };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@runtypelabs/voice",
-  "version": "0.2.4",
+  "version": "0.4.0",
   "description": "Runtype browser voice client with React and Persona adapters",
   "type": "module",
   "license": "MIT",

package/dist/types-9SfA7oHc.d.cts

@@ -1,40 +0,0 @@
-type VoiceStatus = 'idle' | 'connecting' | 'listening' | 'thinking' | 'speaking' | 'error';
-type InterruptionMode = 'none' | 'cancel' | 'barge-in';
-interface TranscriptEntry {
-    readonly role: 'user' | 'assistant';
-    readonly content: string;
-    readonly timestamp: number;
-    readonly turnId?: string;
-}
-interface VoiceMetrics {
-    readonly llmMs?: number;
-    readonly ttsMs?: number;
-    readonly firstAudioMs?: number;
-    readonly totalMs?: number;
-}
-interface VoiceSnapshot {
-    readonly status: VoiceStatus;
-    readonly transcript: readonly TranscriptEntry[];
-    readonly interimTranscript: string | null;
-    readonly metrics: VoiceMetrics | null;
-    readonly audioLevel: number;
-    readonly isMuted: boolean;
-    readonly error: string | null;
-    readonly errorDetails?: {
-        code: string;
-        serverId?: string;
-        serverName: string;
-        diagnosticId: string;
-    };
-    readonly interruptionMode: InterruptionMode;
-    readonly canCancel: boolean;
-}
-interface VoiceClientOptions {
-    agentId: string;
-    /** Browser client token, or a getter called once per call to obtain a fresh token. */
-    clientToken: string | (() => string | Promise<string>);
-    /** Absolute API base URL, including any proxy path prefix. Defaults to https://api.runtype.com. */
-    apiUrl?: string;
-}
-
-export type { InterruptionMode as I, TranscriptEntry as T, VoiceClientOptions as V, VoiceSnapshot as a, VoiceMetrics as b, VoiceStatus as c };

package/dist/types-9SfA7oHc.d.ts

@@ -1,40 +0,0 @@
-type VoiceStatus = 'idle' | 'connecting' | 'listening' | 'thinking' | 'speaking' | 'error';
-type InterruptionMode = 'none' | 'cancel' | 'barge-in';
-interface TranscriptEntry {
-    readonly role: 'user' | 'assistant';
-    readonly content: string;
-    readonly timestamp: number;
-    readonly turnId?: string;
-}
-interface VoiceMetrics {
-    readonly llmMs?: number;
-    readonly ttsMs?: number;
-    readonly firstAudioMs?: number;
-    readonly totalMs?: number;
-}
-interface VoiceSnapshot {
-    readonly status: VoiceStatus;
-    readonly transcript: readonly TranscriptEntry[];
-    readonly interimTranscript: string | null;
-    readonly metrics: VoiceMetrics | null;
-    readonly audioLevel: number;
-    readonly isMuted: boolean;
-    readonly error: string | null;
-    readonly errorDetails?: {
-        code: string;
-        serverId?: string;
-        serverName: string;
-        diagnosticId: string;
-    };
-    readonly interruptionMode: InterruptionMode;
-    readonly canCancel: boolean;
-}
-interface VoiceClientOptions {
-    agentId: string;
-    /** Browser client token, or a getter called once per call to obtain a fresh token. */
-    clientToken: string | (() => string | Promise<string>);
-    /** Absolute API base URL, including any proxy path prefix. Defaults to https://api.runtype.com. */
-    apiUrl?: string;
-}
-
-export type { InterruptionMode as I, TranscriptEntry as T, VoiceClientOptions as V, VoiceSnapshot as a, VoiceMetrics as b, VoiceStatus as c };