@lumavox/client 0.1.1 → 0.4.0

package/dist/events.d.ts

@@ -1,7 +1,7 @@
 /**
  * Every frame the edge sends, as it sends it: the wire's own field names,
  * snake_case included, so the docs' WebSocket page and these types read
- * the same.
+ * the same — and every field always there, `null` where it does not apply.
  *
  * **Hand-written, and held twice.** `ServerFrames` is keyed by the event
  * names `protocol.gen.ts` takes from the edge's vocabulary, so an event the
@@ -9,7 +9,7 @@
  * test (`apps/edge/test/sdk.test.ts`) holds every field of every frame the
  * real conversation object sends to these, both ways.
  */
-import type { RelationInfo } from "./gen/index.js";
+import type { ErrorCode, RelationInfo } from "./gen/index.js";
 import type { ServerEventName } from "./protocol.gen.js";
 interface Frame<T extends ServerEventName> {
     type: T;
@@ -51,7 +51,8 @@ export interface TurnStartFrame extends Frame<"turn.start">, InTurn {
 /** A spoken turn's transcript, before the reply. */
 export interface HeardFrame extends Frame<"heard">, InTurn {
     text: string;
-    seconds: number;
+    /** How long the recording was. */
+    audio_seconds: number;
 }
 /** The open recording as heard so far: a caption, replaced by the next. */
 export interface HeardPartialFrame extends Frame<"heard.partial"> {
@@ -60,10 +61,11 @@ export interface HeardPartialFrame extends Frame<"heard.partial"> {
 /** A `transcribeOnly` recording's words: part of no turn. */
 export interface TranscriptFrame extends Frame<"transcript"> {
     text: string;
-    seconds: number;
+    /** How long the recording was. */
+    audio_seconds: number;
     request_id: string;
     /** The recording's id, which the SDK names every recording with. */
-    id?: string;
+    recording_id: string | null;
 }
 export interface MoodFrame extends Frame<"mood">, InTurn {
     mood: string;
@@ -109,7 +111,7 @@ export interface AudioStartFrame extends Frame<"audio.start">, InTurn, AudioForm
 export interface AudioEndFrame extends Frame<"audio.end">, InTurn {
     chunk: number;
     bytes: number;
-    audio_s: number;
+    audio_seconds: number;
 }
 /** After `mute`, once the last audio window has closed. */
 export interface MutedFrame extends Frame<"muted">, InTurn {
@@ -150,10 +152,8 @@ export interface TurnDoneFrame extends Frame<"turn.done">, InTurn {
     output_tokens: number | null;
     mood: string | null;
     mood_intensity: number | null;
-    /** Always `null`: a relationship that moved arrives as its own frame. */
-    relation: null;
-    /** `true` when the reply was cut short. */
-    truncated: true | null;
+    /** Whether the reply was cut short. */
+    truncated: boolean;
     chunks_spoken: number;
     heard: string | null;
     heard_seconds: number | null;
@@ -164,25 +164,31 @@ export interface InterruptedFrame extends Frame<"interrupted">, InTurn {
     message: string;
     mood: string | null;
     mood_intensity: number | null;
-    detail: string | null;
+    /** Why it stopped: `cancel`, or the failure its `error` named. */
+    reason: string | null;
 }
 /**
  * Something went wrong. It does not end the connection, and inside a turn
- * it does not end the turn. `detail` alone: a frame refused; `stage:
- * "speech"`: the reply could not be spoken; `status`: the turn or a
- * `transcribeOnly` recording failed.
+ * it does not end the turn. `code` is the REST API's (`conflict` for a
+ * turn already running, `insufficient_credits`, `provider_failed`, …);
+ * `stage: "speech"` when only the speaking failed.
  */
 export interface ErrorFrame extends Frame<"error"> {
-    detail: string;
-    turn?: string;
-    status?: number;
-    stage?: string;
-    request_id?: string;
+    code: ErrorCode;
+    message: string;
+    /** The turn it ended or interrupted. */
+    turn: string | null;
+    stage: "speech" | null;
+    /** The reply's chunk that could not be spoken. */
+    chunk: number | null;
+    /** A `transcribeOnly` recording's request. */
+    request_id: string | null;
     /** The recording it refused or failed. */
-    id?: string;
+    recording_id: string | null;
 }
-/** The answer to `ping`, and sent unprompted after 30 s of client silence. */
-export interface PongFrame extends Frame<"pong"> {
+/** The answer to `ping`, from the edge's runtime: the one frame with no `seq`. */
+export interface PongFrame {
+    type: "pong";
 }
 /**
  * Every event, by name. **Exhaustive**: a name in the vocabulary with no

package/dist/gen/index.d.ts

@@ -1 +1 @@
-export type { ClientOptions, CompactData, CompactError, CompactErrors, CompactionInfo, CompactRequest, CompactResponse, CompactResponses, CreateSessionData, CreateSessionError, CreateSessionErrors, CreateSessionResponse, CreateSessionResponses, DeleteSessionData, DeleteSessionError, DeleteSessionErrors, DeleteSessionResponse, DeleteSessionResponses, ErrorInfo, ErrorResponse, ExtractData, ExtractError, ExtractErrors, ExtractResponse, ExtractResponses, FactInfo, FactList, ForgetFactData, ForgetFactError, ForgetFactErrors, ForgetFactResponse, ForgetFactResponses, ForgetUserFactsData, ForgetUserFactsError, ForgetUserFactsErrors, ForgetUserFactsResponse, ForgetUserFactsResponses, ForgottenFacts, GetSessionDetailData, GetSessionDetailError, GetSessionDetailErrors, GetSessionDetailResponse, GetSessionDetailResponses, KnowledgeCitation, KnowledgeLookupInfo, ListFactsData, ListFactsError, ListFactsErrors, ListFactsResponse, ListFactsResponses, ListRelationsData, ListRelationsError, ListRelationsErrors, ListRelationsResponse, ListRelationsResponses, ListSessionsData, ListSessionsError, ListSessionsErrors, ListSessionsResponse, ListSessionsResponses, MessageInfo, MessageKnowledge, RelationInfo, RelationList, SessionCreateRequest, SessionDetail, SessionInfo } from './types.gen.js';
+export type { ClientOptions, CompactionInfo, CompactRequest, CompactSessionData, CompactSessionError, CompactSessionErrors, CompactSessionResponse, CompactSessionResponses, CreateSessionData, CreateSessionError, CreateSessionErrors, CreateSessionResponse, CreateSessionResponses, DeleteAllFactsData, DeleteAllFactsError, DeleteAllFactsErrors, DeleteAllFactsResponse, DeleteAllFactsResponses, DeleteFactData, DeleteFactError, DeleteFactErrors, DeleteFactResponse, DeleteFactResponses, DeleteSessionData, DeleteSessionError, DeleteSessionErrors, DeleteSessionResponse, DeleteSessionResponses, ErrorCode, ErrorInfo, ErrorResponse, ExtractSessionFactsData, ExtractSessionFactsError, ExtractSessionFactsErrors, ExtractSessionFactsResponse, ExtractSessionFactsResponses, FactInfo, FactPage, FactsDeleted, GetSessionData, GetSessionError, GetSessionErrors, GetSessionResponse, GetSessionResponses, KnowledgeCitation, KnowledgeLookupInfo, ListFactsData, ListFactsError, ListFactsErrors, ListFactsResponse, ListFactsResponses, ListRelationsData, ListRelationsError, ListRelationsErrors, ListRelationsResponse, ListRelationsResponses, ListSessionsData, ListSessionsError, ListSessionsErrors, ListSessionsResponse, ListSessionsResponses, MessageInfo, MessageKnowledge, MessagePage, RelationInfo, RelationPage, SessionCreateRequest, SessionDetail, SessionInfo, SessionPage, ValidationIssue } from './types.gen.js';