@yak-io/vue 0.1.2 → 0.3.0

package/README.md

@@ -0,0 +1,151 @@
+# @yak-io/vue
+
+Vue 3 integration for the Yak embeddable chat widget. Uses Vue's Composition API with reactive refs.
+
+## Installation
+
+```bash
+pnpm add @yak-io/vue
+```
+
+## Quickstart
+
+### 1. Initialize in your root component
+
+```ts
+// App.vue <script setup>
+import { createYakProvider } from "@yak-io/vue";
+
+createYakProvider({
+  appId: import.meta.env.VITE_YAK_APP_ID,
+  theme: { position: "bottom-right", colorMode: "system" },
+  trigger: { label: "Ask with AI" },
+  getConfig: async () => {
+    const res = await fetch("/api/yak");
+    return res.json();
+  },
+  onToolCall: async (name, args) => {
+    const res = await fetch("/api/yak", {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify({ name, args }),
+    });
+    const data = await res.json();
+    if (!data.ok) throw new Error(data.error);
+    return data.result;
+  },
+  onRedirect: (path) => {
+    router.push(path);
+  },
+});
+```
+
+`createYakProvider` calls `onMounted` and `onUnmounted` internally — no manual lifecycle management needed.
+
+### 2. Use in descendant components
+
+```ts
+// MyComponent.vue <script setup>
+import { useYak } from "@yak-io/vue";
+
+const { open, openWithPrompt, isOpen, isReady } = useYak();
+```
+
+`isOpen` and `isReady` are `readonly` Vue refs — use them like any other ref:
+
+```html
+<template>
+  <div>
+    <button @click="open">Open Chat</button>
+    <p v-if="isOpen">Chat is open</p>
+    <p v-if="!isReady && isOpen">Loading…</p>
+  </div>
+</template>
+```
+
+### 3. Subscribe to tool events
+
+```ts
+import { useYakToolEvent } from "@yak-io/vue";
+
+useYakToolEvent((event) => {
+  if (event.ok && event.name.startsWith("tasks.")) {
+    refreshTasks();
+  }
+});
+```
+
+Automatically unsubscribes when the component unmounts.
+
+## API Reference
+
+### `createYakProvider(options)`
+
+Call once in your root/layout component. Sets up the widget, registers lifecycle hooks, and provides the API to all descendant components via Vue's `provide/inject`.
+
+Returns a `YakApi` object (same as `useYak()`).
+
+**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 |
+
+### `useYak()`
+
+Inject the widget API in any descendant component.
+
+```ts
+const {
+  isOpen,             // DeepReadonly<Ref<boolean>>
+  isReady,            // DeepReadonly<Ref<boolean>>
+  open,               // () => void
+  close,              // () => void
+  openWithPrompt,     // (prompt: string) => void
+  subscribeToToolEvents, // (handler) => () => void
+} = useYak();
+```
+
+Throws if called outside a component tree where `createYakProvider` was used.
+
+### `useYakToolEvent(handler)`
+
+Subscribe to tool call completion events. Unsubscribes automatically on component unmount.
+
+## Logging
+
+```ts
+import { enableYakLogging, disableYakLogging, isYakLoggingEnabled } from "@yak-io/vue";
+
+enableYakLogging();    // Enable verbose SDK logs
+disableYakLogging();   // Disable SDK logs
+isYakLoggingEnabled(); // → boolean
+```
+
+## Types
+
+```ts
+import type {
+  YakProviderOptions,
+  YakApi,
+  ToolCallEventHandler,
+  ChatConfigProvider,
+  ToolCallHandler,
+  ToolCallEvent,
+  Theme,
+  TriggerButtonConfig,
+  WidgetPosition,
+} from "@yak-io/vue";
+```
+
+## License
+
+Proprietary — see LICENSE file.

package/dist/composables.d.ts

@@ -1,8 +1,9 @@
-import { type Ref, type DeepReadonly } from "vue";
-import { type TriggerButtonConfig, type ChatConfigProvider, type ToolCallHandler, type ToolCallEvent, type GraphQLSchemaHandler, type RESTSchemaHandler, type Theme } from "@yak-io/javascript";
+import { type ChatConfigProvider, type GraphQLSchemaHandler, type RESTSchemaHandler, type Theme, type ToolCallEvent, type ToolCallHandler, type TriggerButtonConfig, type VoiceMachine, type WidgetMode } from "@yak-io/javascript";
+import { type DeepReadonly, type Ref } from "vue";
 export type ToolCallEventHandler = (event: ToolCallEvent) => void;
 export type YakProviderOptions = {
     appId: string;
+    mode?: WidgetMode;
     getConfig?: ChatConfigProvider;
     onToolCall?: ToolCallHandler;
     onGraphQLSchemaCall?: GraphQLSchemaHandler;
@@ -19,30 +20,27 @@ export type YakApi = {
     close: () => void;
     openWithPrompt: (prompt: string) => void;
     subscribeToToolEvents: (handler: ToolCallEventHandler) => () => void;
+    voiceMachine: DeepReadonly<Ref<VoiceMachine>>;
+    voiceStart: () => Promise<void>;
+    voiceStop: () => Promise<void>;
+    voiceToggle: () => Promise<void>;
 };
 /**
- * Sets up the yak chat widget and provides it to descendant components.
+ * Sets up the yak widget (chat + voice) and provides it to descendants.
  * Call this once in a root/layout component.
  *
  * @example
  * ```ts
- * // App.vue <script setup>
- * import { createYakProvider } from "@yak-io/vue";
- *
  * createYakProvider({
  *   appId: "my-app",
- *   trigger: { label: "Ask with AI" },
+ *   mode: "both",
+ *   getConfig: async () => ({ routes: { routes: [], generated_at: "" } }),
  * });
  * ```
  */
 export declare function createYakProvider(options: YakProviderOptions): YakApi;
 /**
- * Access the yak chat widget API.
- *
- * @example
- * ```ts
- * const { open, isOpen, openWithPrompt } = useYak();
- * ```
+ * Access the yak widget API (chat + voice).
  *
  * @throws {Error} if used outside a component tree with createYakProvider
  */
@@ -50,15 +48,6 @@ export declare function useYak(): YakApi;
 /**
  * Subscribe to tool call completion events.
  * Automatically cleans up on component unmount.
- *
- * @example
- * ```ts
- * useYakToolEvent((event) => {
- *   if (event.ok && event.name.startsWith("task.")) {
- *     refreshTasks();
- *   }
- * });
- * ```
  */
 export declare function useYakToolEvent(handler: ToolCallEventHandler): void;
 //# sourceMappingURL=composables.d.ts.map

package/dist/composables.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"composables.d.ts","sourceRoot":"","sources":["../src/composables.ts"],"names":[],"mappings":"AAAA,OAAO,EAQL,KAAK,GAAG,EACR,KAAK,YAAY,EAClB,MAAM,KAAK,CAAC;AACb,OAAO,EAEL,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,EACvB,KAAK,eAAe,EACpB,KAAK,aAAa,EAClB,KAAK,oBAAoB,EACzB,KAAK,iBAAiB,EACtB,KAAK,KAAK,EACX,MAAM,oBAAoB,CAAC;AAK5B,MAAM,MAAM,oBAAoB,GAAG,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,CAAC;AAElE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,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;IACnB,MAAM,EAAE,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;IACnC,OAAO,EAAE,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;IACpC,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;CACtE,CAAC;AAQF;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,kBAAkB,GAAG,MAAM,CA6FrE;AAID;;;;;;;;;GASG;AACH,wBAAgB,MAAM,IAAI,MAAM,CAM/B;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI,CAUnE"}
+{"version":3,"file":"composables.d.ts","sourceRoot":"","sources":["../src/composables.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,EACL,KAAK,YAAY,EAMjB,KAAK,GAAG,EAGT,MAAM,KAAK,CAAC;AAIb,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,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;IACnC,OAAO,EAAE,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;IACpC,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,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC;IAC9C,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;CAClC,CAAC;AAQF;;;;;;;;;;;;GAYG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,kBAAkB,GAAG,MAAM,CA6GrE;AAID;;;;GAIG;AACH,wBAAgB,MAAM,IAAI,MAAM,CAM/B;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI,CAUnE"}

package/dist/composables.js

@@ -1,27 +1,25 @@
-import { ref, readonly, onMounted, onUnmounted, inject, provide, } from "vue";
-import { YakEmbed, } from "@yak-io/javascript";
-import { logger } from "@yak-io/javascript";
+import { INITIAL_VOICE_MACHINE, logger, YakEmbed, } from "@yak-io/javascript";
+import { inject, onMounted, onUnmounted, provide, readonly, ref, } from "vue";
 // ── Injection key ───────────────────────────────────────────────────────────
 const YAK_KEY = Symbol("yak");
 // ── Provider composable ─────────────────────────────────────────────────────
 /**
- * Sets up the yak chat widget and provides it to descendant components.
+ * Sets up the yak widget (chat + voice) and provides it to descendants.
  * Call this once in a root/layout component.
  *
  * @example
  * ```ts
- * // App.vue <script setup>
- * import { createYakProvider } from "@yak-io/vue";
- *
  * createYakProvider({
  *   appId: "my-app",
- *   trigger: { label: "Ask with AI" },
+ *   mode: "both",
+ *   getConfig: async () => ({ routes: { routes: [], generated_at: "" } }),
  * });
  * ```
  */
 export function createYakProvider(options) {
     const isOpen = ref(false);
     const isReady = ref(false);
+    const voiceMachine = ref(INITIAL_VOICE_MACHINE);
     const toolEventSubscribers = new Set();
     const handleToolCallComplete = (event) => {
         logger.debug("Tool call completed, notifying subscribers:", {
@@ -42,8 +40,10 @@ export function createYakProvider(options) {
         (typeof window !== "undefined" ? (path) => window.location.assign(path) : undefined);
     const embed = new YakEmbed({
         appId: options.appId,
+        mode: options.mode,
         theme: options.theme,
         trigger: options.trigger ?? false,
+        getConfig: options.getConfig,
         onToolCall: options.onToolCall,
         onGraphQLSchemaCall: options.onGraphQLSchemaCall,
         onRESTSchemaCall: options.onRESTSchemaCall,
@@ -51,12 +51,13 @@ export function createYakProvider(options) {
         options: { disableRestartButton: options.disableRestartButton },
         onToolCallComplete: handleToolCallComplete,
     });
-    // Subscribe to state changes
     embed.onStateChange((state) => {
         isOpen.value = state.isOpen;
         isReady.value = state.isReady;
     });
-    // Mount/unmount with component lifecycle
+    embed.onVoiceStateChange((m) => {
+        voiceMachine.value = m;
+    });
     onMounted(() => {
         embed.mount();
     });
@@ -83,6 +84,14 @@ export function createYakProvider(options) {
             }
         });
     }
+    const voiceStart = async () => {
+        try {
+            await embed.voiceStart();
+        }
+        catch (err) {
+            logger.warn("Voice start failed", err);
+        }
+    };
     const api = {
         isOpen: readonly(isOpen),
         isReady: readonly(isReady),
@@ -95,18 +104,17 @@ export function createYakProvider(options) {
                 toolEventSubscribers.delete(handler);
             };
         },
+        voiceMachine: readonly(voiceMachine),
+        voiceStart,
+        voiceStop: () => embed.voiceStop(),
+        voiceToggle: () => embed.voiceToggle(),
     };
     provide(YAK_KEY, api);
     return api;
 }
 // ── Consumer composables ────────────────────────────────────────────────────
 /**
- * Access the yak chat widget API.
- *
- * @example
- * ```ts
- * const { open, isOpen, openWithPrompt } = useYak();
- * ```
+ * Access the yak widget API (chat + voice).
  *
  * @throws {Error} if used outside a component tree with createYakProvider
  */
@@ -120,15 +128,6 @@ export function useYak() {
 /**
  * Subscribe to tool call completion events.
  * Automatically cleans up on component unmount.
- *
- * @example
- * ```ts
- * useYakToolEvent((event) => {
- *   if (event.ok && event.name.startsWith("task.")) {
- *     refreshTasks();
- *   }
- * });
- * ```
  */
 export function useYakToolEvent(handler) {
     const api = inject(YAK_KEY);

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-export { useYak, useYakToolEvent, createYakProvider } from "./composables.js";
-export type { YakProviderOptions, YakApi, ToolCallEventHandler } from "./composables.js";
-export { enableYakLogging, disableYakLogging, isYakLoggingEnabled } from "@yak-io/javascript";
-export type { GraphQLSchemaHandler, RESTSchemaHandler, GraphQLRequest, RESTRequest, ToolCallHandler, ToolCallEvent, SchemaSource, GraphQLSchemaSource, OpenAPISchemaSource, Theme, ThemeColors, TriggerButtonConfig, WidgetPosition, ChatConfigProvider, } from "@yak-io/javascript";
+export type { ChatConfigProvider, GraphQLRequest, GraphQLSchemaHandler, GraphQLSchemaSource, OpenAPISchemaSource, RESTRequest, RESTSchemaHandler, SchemaSource, Theme, ThemeColors, ToolCallEvent, ToolCallHandler, TriggerButtonConfig, VoiceMachine, VoiceState, WidgetMode, WidgetPosition, } from "@yak-io/javascript";
+export { disableYakLogging, enableYakLogging, isYakLoggingEnabled } from "@yak-io/javascript";
+export type { ToolCallEventHandler, YakApi, YakProviderOptions } from "./composables.js";
+export { createYakProvider, useYak, useYakToolEvent } from "./composables.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAC9E,YAAY,EAAE,kBAAkB,EAAE,MAAM,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAGzF,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAG9F,YAAY,EACV,oBAAoB,EACpB,iBAAiB,EACjB,cAAc,EACd,WAAW,EACX,eAAe,EACf,aAAa,EACb,YAAY,EACZ,mBAAmB,EACnB,mBAAmB,EACnB,KAAK,EACL,WAAW,EACX,mBAAmB,EACnB,cAAc,EACd,kBAAkB,GACnB,MAAM,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,YAAY,EACV,kBAAkB,EAClB,cAAc,EACd,oBAAoB,EACpB,mBAAmB,EACnB,mBAAmB,EACnB,WAAW,EACX,iBAAiB,EACjB,YAAY,EACZ,KAAK,EACL,WAAW,EACX,aAAa,EACb,eAAe,EACf,mBAAmB,EACnB,YAAY,EACZ,UAAU,EACV,UAAU,EACV,cAAc,GACf,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC9F,YAAY,EAAE,oBAAoB,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACzF,OAAO,EAAE,iBAAiB,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC"}

package/dist/index.js

@@ -1,4 +1,4 @@
 // Public API
-export { useYak, useYakToolEvent, createYakProvider } from "./composables.js";
 // Re-export logging utilities
-export { enableYakLogging, disableYakLogging, isYakLoggingEnabled } from "@yak-io/javascript";
+export { disableYakLogging, enableYakLogging, isYakLoggingEnabled } from "@yak-io/javascript";
+export { createYakProvider, useYak, useYakToolEvent } from "./composables.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yak-io/vue",
-  "version": "0.1.2",
+  "version": "0.3.0",
   "description": "Vue SDK for embedding yak chatbot",
   "type": "module",
   "license": "SEE LICENSE IN LICENSE",
@@ -41,15 +41,15 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@yak-io/javascript": "0.6.0"
+    "@yak-io/javascript": "0.8.0"
   },
   "peerDependencies": {
     "vue": "^3.3.0"
   },
   "devDependencies": {
-    "@types/node": "^24.12.0",
+    "@types/node": "^24.12.4",
     "typescript": "^5.3.0",
-    "vue": "^3.5.16",
+    "vue": "^3.5.34",
     "@repo/typescript-config": "0.0.0"
   },
   "scripts": {