@yak-io/svelte 0.3.0 → 0.4.0

package/README.md

@@ -1,26 +1,37 @@
 # @yak-io/svelte
 
-Svelte integration for the Yak embeddable chat widget. Uses Svelte stores for reactive state.
+> 📚 **Full documentation:** https://docs.yak.io/docs/sdks/svelte
+>
+> 🤖 **For LLMs / AI agents:** https://docs.yak.io/llms.txt
 
-## Installation
+Svelte SDK for [Yak](https://docs.yak.io) — an embeddable AI assistant (text chat **and** push-to-talk voice) for web apps. `createYakProvider` returns a `YakApi` whose reactive state is exposed as Svelte `Readable` stores.
 
 ```bash
 pnpm add @yak-io/svelte
 ```
 
+## Exports
+
+| Export | Kind | Purpose |
+| --- | --- | --- |
+| `createYakProvider(options)` | fn | Create a widget instance. Returns a `YakApi` with stores + `mount`/`destroy`. |
+| `enableYakLogging` / `disableYakLogging` / `isYakLoggingEnabled` | fn | Toggle verbose SDK logging. |
+| Types | — | `YakProviderOptions`, `YakApi`, `ToolCallEventHandler`, plus core types from `@yak-io/javascript`. |
+
 ## Quickstart
 
-### 1. Initialize the provider (module scope)
+### 1. Create the provider (module scope)
 
 ```ts
 // src/yak.ts
-import { onMount, onDestroy } from "svelte";
+import { goto } from "$app/navigation";
 import { createYakProvider } from "@yak-io/svelte";
 
 export const yak = createYakProvider({
   appId: import.meta.env.VITE_YAK_APP_ID,
+  mode: "both",   // "chat" | "voice" | "both" — default "chat"
+  trigger: true,  // show the floating launcher pill
   theme: { position: "bottom-right", colorMode: "system" },
-  trigger: { label: "Ask with AI" },
   getConfig: async () => {
     const res = await fetch("/api/yak");
     return res.json();
@@ -35,19 +46,17 @@ export const yak = createYakProvider({
     if (!data.ok) throw new Error(data.error);
     return data.result;
   },
-  onRedirect: (path) => {
-    goto(path);
-  },
+  onRedirect: (path) => goto(path),
 });
 ```
 
-### 2. Mount and destroy in your root component
+### 2. Mount/destroy in your root component
 
 ```svelte
-<!-- App.svelte -->
+<!-- +layout.svelte -->
 <script lang="ts">
   import { onMount, onDestroy } from "svelte";
-  import { yak } from "./yak.ts";
+  import { yak } from "$lib/yak";
 
   onMount(() => yak.mount());
   onDestroy(() => yak.destroy());
@@ -56,69 +65,85 @@ export const yak = createYakProvider({
 <slot />
 ```
 
-### 3. Use stores in components
+### 3. Use the stores
+
+`isOpen`/`isReady` are `Readable` stores — read them with `$`:
+
+```svelte
+<script lang="ts">
+  import { yak } from "$lib/yak";
+  const { isOpen, open, openWithPrompt } = yak;
+</script>
+
+<button on:click={open}>Open chat</button>
+<button on:click={() => openWithPrompt("How do I get started?")}>Get help</button>
+{#if $isOpen}<span>Chat is open</span>{/if}
+```
+
+## Voice
 
-`isOpen` and `isReady` are Svelte `Readable` stores — subscribe with `$`:
+Set `mode: "voice"` or `mode: "both"`, then drive the session. `voiceStart()` must run from a user gesture (browser mic requirement).
 
 ```svelte
 <script lang="ts">
-  import { yak } from "../yak.ts";
-  const { isOpen, isReady, open, openWithPrompt } = yak;
+  import { yak } from "$lib/yak";
+  const { voiceToggle, voiceLoading, voiceMachine } = yak;
 </script>
 
-<button on:click={open}>Open Chat</button>
-{#if $isOpen}
-  <p>Chat is open</p>
-{/if}
-{#if $isOpen && !$isReady}
-  <p>Loading…</p>
-{/if}
+<button on:click={voiceToggle} disabled={$voiceLoading}>
+  {$voiceMachine.state === "idle" ? "Start voice" : `Stop (${$voiceMachine.state})`}
+</button>
 ```
 
-### 4. Subscribe to tool events
+## Tool events
 
 ```ts
 yak.subscribeToToolEvents((event) => {
-  if (event.ok && event.name.startsWith("tasks.")) {
-    refreshTasks();
-  }
+  // { name, args, ok, result?, error? }
+  if (event.ok && event.name.startsWith("tasks.")) refreshTasks();
 });
 ```
 
-## API Reference
+## API reference
 
 ### `createYakProvider(options)`
 
-Creates a Yak widget instance. Returns a `YakApi` with Svelte stores for reactive state.
-
-You must call `yak.mount()` in `onMount()` and `yak.destroy()` in `onDestroy()`.
-
-**Options:**
-
-| Option | Type | Description |
-|--------|------|-------------|
-| `appId` | `string` | Your Yak app ID |
-| `getConfig` | `ChatConfigProvider` | Async function returning routes + tools. Called on first open. |
-| `onToolCall` | `ToolCallHandler` | Handle tool invocations from the assistant |
-| `onGraphQLSchemaCall` | `GraphQLSchemaHandler` | Handle GraphQL schema tool calls |
-| `onRESTSchemaCall` | `RESTSchemaHandler` | Handle REST/OpenAPI schema tool calls |
-| `theme` | `Theme` | Position, color mode, and custom colors |
-| `onRedirect` | `(path: string) => void` | Navigation handler (defaults to `window.location.assign`) |
-| `disableRestartButton` | `boolean` | Hide the restart session button |
-| `trigger` | `boolean \| TriggerButtonConfig` | Built-in trigger button |
+Returns a `YakApi`. You must call `yak.mount()` in `onMount()` and `yak.destroy()` in `onDestroy()`.
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `appId` | `string` | — | Your Yak app ID (required). |
+| `mode` | `"chat" \| "voice" \| "both"` | `"chat"` | Which surfaces the widget exposes. |
+| `trigger` | `boolean \| TriggerButtonConfig` | `false` | Show the floating pill. **Set `true`** to display it; `TriggerButtonConfig` recolors it. |
+| `getConfig` | `ChatConfigProvider` | — | Async provider of routes + tools. Called on open / voice start. |
+| `onToolCall` | `ToolCallHandler` | — | Executes a tool the assistant calls. |
+| `onGraphQLSchemaCall` | `GraphQLSchemaHandler` | — | Handles GraphQL schema tool calls. |
+| `onRESTSchemaCall` | `RESTSchemaHandler` | — | Handles REST/OpenAPI schema tool calls. |
+| `theme` | `Theme` | — | Position, color mode, and colors. |
+| `onRedirect` | `(path: string) => void` | `window.location.assign` | Navigation handler. |
+| `disableRestartButton` | `boolean` | `false` | Hide the restart-session button. |
 
 ### `YakApi`
 
 ```ts
 type YakApi = {
-  isOpen: Readable<boolean>;   // Svelte store
-  isReady: Readable<boolean>;  // Svelte store
+  // chat
+  isOpen: Readable<boolean>;
+  isReady: Readable<boolean>;
+  chatLoading: Readable<boolean>; // isOpen && !isReady
   open: () => void;
   close: () => void;
   openWithPrompt: (prompt: string) => void;
   subscribeToToolEvents: (handler: ToolCallEventHandler) => () => void;
-  mount: () => void;    // Call in onMount()
-  destroy: () => void;  // Call in onDestroy()
+  // voice
+  voiceMachine: Readable<VoiceMachine>; // { state, errorMessage? }
+  voiceLoading: Readable<boolean>; // state === "connecting"
+  voiceStart: () => Promise<void>;
+  voiceStop: () => Promise<void>;
+  voiceToggle: () => Promise<void>;
+  // lifecycle
+  mount: () => void;    // call in onMount()
+  destroy: () => void;  // call in onDestroy()
 };
 ```
 
@@ -127,9 +152,7 @@ type YakApi = {
 ```ts
 import { enableYakLogging, disableYakLogging, isYakLoggingEnabled } from "@yak-io/svelte";
 
-enableYakLogging();    // Enable verbose SDK logs
-disableYakLogging();   // Disable SDK logs
-isYakLoggingEnabled(); // → boolean
+enableYakLogging(); // verbose SDK logs
 ```
 
 ## Types
@@ -143,11 +166,13 @@ import type {
   ToolCallHandler,
   ToolCallEvent,
   Theme,
-  TriggerButtonConfig,
+  WidgetMode,
   WidgetPosition,
+  VoiceState,
+  VoiceMachine,
 } from "@yak-io/svelte";
 ```
 
 ## License
 
-Proprietary — see LICENSE file.
+Proprietary — see [LICENSE](./LICENSE).

package/dist/provider.d.ts

@@ -13,18 +13,35 @@ export type YakProviderOptions = {
     disableRestartButton?: boolean;
     trigger?: boolean | TriggerButtonConfig;
 };
+/** Handle for controlling the Yak widget — chat + voice — from Svelte (stores). */
 export type YakApi = {
+    /** Whether the chat panel is currently open. */
     isOpen: Readable<boolean>;
+    /** Whether the chat iframe is ready to receive messages. */
     isReady: Readable<boolean>;
+    /** Whether the chat is opening but not yet interactive (`isOpen && !isReady`). */
+    chatLoading: Readable<boolean>;
+    /** Open the chat panel. */
     open: () => void;
+    /** Close the chat panel. */
     close: () => void;
+    /** Open the chat panel and send a specific prompt. */
     openWithPrompt: (prompt: string) => void;
+    /** Subscribe to tool-call completion events; returns an unsubscribe function. */
     subscribeToToolEvents: (handler: ToolCallEventHandler) => () => void;
+    /** Current voice state-machine snapshot. `idle` when mode is `chat`. */
     voiceMachine: Readable<VoiceMachine>;
+    /** Whether the voice session is establishing its connection (`state === "connecting"`). */
+    voiceLoading: Readable<boolean>;
+    /** Start a voice session. Must be invoked from a user gesture. */
     voiceStart: () => Promise<void>;
+    /** Stop the current voice session. */
     voiceStop: () => Promise<void>;
+    /** Toggle voice: start if idle/error, stop if active. */
     voiceToggle: () => Promise<void>;
+    /** Mount the widget into the DOM. Call once (e.g. in `onMount`). */
     mount: () => void;
+    /** Tear down the widget and remove its listeners. */
     destroy: () => void;
 };
 /**

package/dist/provider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EAGzB,KAAK,iBAAiB,EACtB,KAAK,KAAK,EACV,KAAK,aAAa,EAClB,KAAK,eAAe,EACpB,KAAK,mBAAmB,EACxB,KAAK,YAAY,EACjB,KAAK,UAAU,EAEhB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,KAAK,QAAQ,EAAsB,MAAM,cAAc,CAAC;AAIjE,MAAM,MAAM,oBAAoB,GAAG,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,CAAC;AAElE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,SAAS,CAAC,EAAE,kBAAkB,CAAC;IAC/B,UAAU,CAAC,EAAE,eAAe,CAAC;IAC7B,mBAAmB,CAAC,EAAE,oBAAoB,CAAC;IAC3C,gBAAgB,CAAC,EAAE,iBAAiB,CAAC;IACrC,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACpC,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,OAAO,CAAC,EAAE,OAAO,GAAG,mBAAmB,CAAC;CACzC,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG;IAEnB,MAAM,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC1B,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC3B,IAAI,EAAE,MAAM,IAAI,CAAC;IACjB,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,cAAc,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IACzC,qBAAqB,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,MAAM,IAAI,CAAC;IAErE,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC;IACrC,UAAU,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAChC,SAAS,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/B,WAAW,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjC,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB,CAAC;AAIF;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,kBAAkB,GAAG,MAAM,CAiGrE"}
+{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EAGzB,KAAK,iBAAiB,EACtB,KAAK,KAAK,EACV,KAAK,aAAa,EAClB,KAAK,eAAe,EACpB,KAAK,mBAAmB,EACxB,KAAK,YAAY,EACjB,KAAK,UAAU,EAEhB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAW,KAAK,QAAQ,EAAsB,MAAM,cAAc,CAAC;AAI1E,MAAM,MAAM,oBAAoB,GAAG,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,CAAC;AAElE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,SAAS,CAAC,EAAE,kBAAkB,CAAC;IAC/B,UAAU,CAAC,EAAE,eAAe,CAAC;IAC7B,mBAAmB,CAAC,EAAE,oBAAoB,CAAC;IAC3C,gBAAgB,CAAC,EAAE,iBAAiB,CAAC;IACrC,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACpC,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,OAAO,CAAC,EAAE,OAAO,GAAG,mBAAmB,CAAC;CACzC,CAAC;AAEF,mFAAmF;AACnF,MAAM,MAAM,MAAM,GAAG;IAEnB,gDAAgD;IAChD,MAAM,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC1B,4DAA4D;IAC5D,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC3B,kFAAkF;IAClF,WAAW,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC/B,2BAA2B;IAC3B,IAAI,EAAE,MAAM,IAAI,CAAC;IACjB,4BAA4B;IAC5B,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,sDAAsD;IACtD,cAAc,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IACzC,iFAAiF;IACjF,qBAAqB,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,MAAM,IAAI,CAAC;IAErE,wEAAwE;IACxE,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC;IACrC,2FAA2F;IAC3F,YAAY,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IAChC,kEAAkE;IAClE,UAAU,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAChC,sCAAsC;IACtC,SAAS,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/B,yDAAyD;IACzD,WAAW,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjC,oEAAoE;IACpE,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,qDAAqD;IACrD,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB,CAAC;AAIF;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,kBAAkB,GAAG,MAAM,CAyGrE"}

package/dist/provider.js

@@ -1,5 +1,5 @@
 import { INITIAL_VOICE_MACHINE, logger, YakEmbed, } from "@yak-io/javascript";
-import { readonly, writable } from "svelte/store";
+import { derived, readonly, writable } from "svelte/store";
 // ── Provider factory ────────────────────────────────────────────────────────
 /**
  * Creates a yak widget instance (chat + voice) with Svelte stores.
@@ -86,9 +86,12 @@ export function createYakProvider(options) {
             logger.warn("Voice start failed", err);
         }
     };
+    const chatLoading = derived([isOpen, isReady], ([$isOpen, $isReady]) => $isOpen && !$isReady);
+    const voiceLoading = derived(voiceMachine, ($voiceMachine) => $voiceMachine.state === "connecting");
     return {
         isOpen: readonly(isOpen),
         isReady: readonly(isReady),
+        chatLoading,
         open: () => embed.open(),
         close: () => embed.close(),
         openWithPrompt: (prompt) => embed.openWithPrompt(prompt),
@@ -99,6 +102,7 @@ export function createYakProvider(options) {
             };
         },
         voiceMachine: readonly(voiceMachine),
+        voiceLoading,
         voiceStart,
         voiceStop: () => embed.voiceStop(),
         voiceToggle: () => embed.voiceToggle(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yak-io/svelte",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Svelte SDK for embedding yak chatbot",
   "type": "module",
   "license": "SEE LICENSE IN LICENSE",
@@ -25,6 +25,7 @@
     "node": ">=18"
   },
   "files": [
+    "README.md",
     "dist",
     "LICENSE"
   ],
@@ -41,7 +42,7 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@yak-io/javascript": "0.8.0"
+    "@yak-io/javascript": "0.9.0"
   },
   "peerDependencies": {
     "svelte": "^5.0.0"
@@ -52,6 +53,7 @@
     "typescript": "^5.3.0",
     "@repo/typescript-config": "0.0.0"
   },
+  "homepage": "https://docs.yak.io/docs/sdks/svelte",
   "scripts": {
     "build": "tsc",
     "check-types": "tsc --noEmit",