@sonara/client 0.21.6

package/dist/esm/index.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @sonara/client: talk to the Sonara runtime (protocol v1) from Node 18+
+ * or an Electron main process. Zero dependencies.
+ *
+ *     const sonara = await connect({ clientName: "my-app", runtimePath });
+ *     sonara.onState((s) => render(s));
+ *     await sonara.speak("Hello.");
+ */
+export { connect } from "./connect.js";
+export type { ConnectOptions } from "./connect.js";
+export { SonaraClient } from "./client.js";
+export type { Unsubscribe } from "./client.js";
+export { SonaraError } from "./errors.js";
+export type { ErrorCode } from "./errors.js";
+export { AgentApi, ChannelsApi, SystemApi } from "./extensions.js";
+export { EnginesApi } from "./engines.js";
+export type { EngineAddOptions, EngineModelsDraft, EngineProfile, SendMode, EngineTestOptions, } from "./engines.js";
+export type { AskKind, AudioMode, ChannelOpenOptions, ChannelPolicy, StreamMessage } from "./extensions.js";
+export { readRuntime, resolveHome } from "./discovery.js";
+export { PROTOCOL, VERSION } from "./version.js";
+export type { ControlAction, EngineStatus, HelloInfo, ItemEvent, ItemPhase, LogEvent, NowPlaying, Reply, RuntimeInfo, SettingKey, SpeakMode, SpeakOptions, State, Voice, } from "./types.js";

package/dist/esm/index.js

@@ -0,0 +1,15 @@
+/**
+ * @sonara/client: talk to the Sonara runtime (protocol v1) from Node 18+
+ * or an Electron main process. Zero dependencies.
+ *
+ *     const sonara = await connect({ clientName: "my-app", runtimePath });
+ *     sonara.onState((s) => render(s));
+ *     await sonara.speak("Hello.");
+ */
+export { connect } from "./connect.js";
+export { SonaraClient } from "./client.js";
+export { SonaraError } from "./errors.js";
+export { AgentApi, ChannelsApi, SystemApi } from "./extensions.js";
+export { EnginesApi } from "./engines.js";
+export { readRuntime, resolveHome } from "./discovery.js";
+export { PROTOCOL, VERSION } from "./version.js";

package/dist/esm/package.json

@@ -0,0 +1 @@
+{"type":"module"}

package/dist/esm/types.d.ts

@@ -0,0 +1,111 @@
+/** Queue mode of `speak`: after everything queued, or drop the unread items first. */
+export type SpeakMode = "append" | "replace";
+/** Core playback controls (protocol v1, `control`). */
+export type ControlAction = "play" | "pause" | "toggle" | "stop" | "skip" | "previous" | "next" | "restart" | "mute" | "unmute";
+/** Core setting keys (protocol v1, `set` / `get`). */
+export type SettingKey = "volume" | "rate" | "voice" | "engine";
+export interface SpeakOptions {
+    /** `append` (default) or `replace` (drop unread items, never the current one). */
+    mode?: SpeakMode;
+    /** Also cut the current item and start this one now. */
+    interrupt?: boolean;
+    /** Shown in `state.now_playing.label`. */
+    label?: string;
+}
+export interface NowPlaying {
+    item_id: number;
+    label: string | null;
+    /** The chunk being read. */
+    text: string;
+    chunk: number;
+    chunks: number;
+    [extra: string]: unknown;
+}
+/** A `state` event: a full snapshot, sent on change only. */
+export interface State {
+    seq: number;
+    now_playing: NowPlaying | null;
+    queued: number;
+    paused: boolean;
+    muted: boolean;
+    volume: number;
+    rate: number;
+    voice: string | null;
+    engine_status: EngineStatus;
+    [extra: string]: unknown;
+}
+/**
+ * `state.engine_status`. Protocol 1.1 adds readiness: Kokoro is `loading`,
+ * `downloading` (with `progress`), `waiting` to retry or `unavailable`
+ * until it is `ready`, and names the engine speaking meanwhile in
+ * `fallback`. A 1.0 runtime sends only `engine`.
+ */
+export interface EngineStatus {
+    engine: string;
+    ready?: boolean;
+    status?: "ready" | "loading" | "downloading" | "waiting" | "unavailable";
+    progress?: {
+        done: number;
+        total: number;
+    };
+    fallback?: string;
+    message?: string;
+    /**
+     * Protocol 1.2: why an external engine is not speaking itself
+     * (`no_key`, `auth`, `quota`, `rate_limited`, `network`, `timeout`,
+     * `server`, `bad_voice`, `bad_config`, `format`).
+     */
+    reason?: string;
+    [extra: string]: unknown;
+}
+export type ItemPhase = "started" | "finished" | "skipped" | "failed";
+/** An `item` event. */
+export interface ItemEvent {
+    item_id: number;
+    phase: ItemPhase;
+    [extra: string]: unknown;
+}
+/** A `log` event. */
+export interface LogEvent {
+    message: string;
+    [extra: string]: unknown;
+}
+export interface Voice {
+    id: string;
+    name: string;
+    language: string;
+    engine: string;
+    license_class: "permissive" | "os" | "external";
+    installed: boolean;
+    [extra: string]: unknown;
+}
+/** The `hello` reply: what the runtime offers. */
+export interface HelloInfo {
+    version: string;
+    protocol: {
+        major: number;
+        minor: number;
+    };
+    capabilities: string[];
+    extensions: string[];
+    /** Requested extensions this runtime lacks. */
+    unavailable: string[];
+    [extra: string]: unknown;
+}
+/** Contents of `runtime.json` (protocol v1, Discovery). */
+export interface RuntimeInfo {
+    pid: number;
+    port: number;
+    http_port: number;
+    token: string;
+    version: string;
+    protocol: {
+        major: number;
+        minor: number;
+    };
+    capabilities: string[];
+    started_at: string;
+    [extra: string]: unknown;
+}
+/** Any reply with `ok: true`; the fields depend on the request. */
+export type Reply = Record<string, unknown>;

package/dist/esm/types.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/version.d.ts

@@ -0,0 +1,7 @@
+/** Version of this package, sent as `client.version` in `hello`. */
+export declare const VERSION = "0.21.6";
+/** Protocol this client speaks. */
+export declare const PROTOCOL: {
+    readonly major: 1;
+    readonly minor: 0;
+};

package/dist/esm/version.js

@@ -0,0 +1,4 @@
+/** Version of this package, sent as `client.version` in `hello`. */
+export const VERSION = "0.21.6";
+/** Protocol this client speaks. */
+export const PROTOCOL = { major: 1, minor: 0 };

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@sonara/client",
+  "version": "0.21.6",
+  "description": "Client for the Sonara text-to-speech runtime (protocol v1): connect, speak, control, live state. Zero dependencies.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Maxaubert/Sonara.git",
+    "directory": "clients/ts"
+  },
+  "keywords": [
+    "sonara",
+    "tts",
+    "text-to-speech",
+    "electron",
+    "speech"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/cjs/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist/",
+    "LICENSE",
+    "README.md"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "clean": "node scripts/clean.mjs",
+    "build": "node scripts/clean.mjs && tsc -p tsconfig.esm.json && tsc -p tsconfig.cjs.json && node scripts/mark-dist.mjs",
+    "typecheck": "tsc -p tsconfig.esm.json --noEmit",
+    "test": "node scripts/test.mjs",
+    "test:unit": "node scripts/test.mjs unit",
+    "prepack": "npm run build"
+  },
+  "devDependencies": {
+    "@types/node": "18.19.130",
+    "typescript": "5.9.3"
+  }
+}