@yak-io/nuxt 0.1.2 → 0.3.0

package/README.md

@@ -0,0 +1,155 @@
+# @yak-io/nuxt
+
+Nuxt 3 integration for the Yak embeddable chat widget. Provides a plugin-compatible factory that auto-mounts on `app:mounted` and provides the widget API via Nuxt's plugin system.
+
+## Installation
+
+```bash
+pnpm add @yak-io/nuxt
+```
+
+## Quickstart
+
+### 1. Create a Nuxt plugin
+
+```ts
+// plugins/yak.client.ts
+import { defineNuxtPlugin } from "#app";
+import { createYakProvider, enableYakLogging, disableYakLogging, isYakLoggingEnabled } from "@yak-io/nuxt";
+
+export default defineNuxtPlugin((nuxtApp) => {
+  const runtimeConfig = useRuntimeConfig();
+
+  const yak = createYakProvider({
+    appId: runtimeConfig.public.yakAppId,
+    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) => {
+      navigateTo(path);
+    },
+  });
+
+  // Mount on client, clean up on HMR
+  nuxtApp.hook("app:mounted", () => yak.mount());
+  if (import.meta.hot) {
+    import.meta.hot.dispose(() => yak.destroy());
+  }
+
+  return {
+    provide: {
+      yak,
+      yakLogging: { enableYakLogging, disableYakLogging, isYakLoggingEnabled },
+    },
+  };
+});
+```
+
+### 2. Access in components
+
+```ts
+// Any component <script setup>
+const { $yak } = useNuxtApp();
+const { open, openWithPrompt, isOpen, isReady } = $yak;
+```
+
+`isOpen` and `isReady` are Vue `readonly` refs:
+
+```html
+<template>
+  <button @click="open">Open Chat</button>
+  <span v-if="isOpen">Chat is open</span>
+</template>
+```
+
+### 3. Subscribe to tool events
+
+```ts
+const { $yak } = useNuxtApp();
+
+$yak.subscribeToToolEvents((event) => {
+  if (event.ok && event.name.startsWith("tasks.")) {
+    refreshTasks();
+  }
+});
+```
+
+## API Reference
+
+### `createYakProvider(options)`
+
+Creates a Yak widget instance. Returns a `YakApi` with Vue-reactive refs for reactive state.
+
+You must call `yak.mount()` on the client side (e.g., in the `app:mounted` hook) and `yak.destroy()` when cleaning up.
+
+**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 |
+
+### `YakApi`
+
+```ts
+type YakApi = {
+  isOpen: DeepReadonly<Ref<boolean>>;  // Vue readonly ref
+  isReady: DeepReadonly<Ref<boolean>>; // Vue readonly ref
+  open: () => void;
+  close: () => void;
+  openWithPrompt: (prompt: string) => void;
+  subscribeToToolEvents: (handler: ToolCallEventHandler) => () => void;
+  mount: () => void;    // Call in app:mounted hook
+  destroy: () => void;  // Call on HMR dispose / cleanup
+};
+```
+
+## Logging
+
+```ts
+import { enableYakLogging, disableYakLogging, isYakLoggingEnabled } from "@yak-io/nuxt";
+
+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/nuxt";
+```
+
+## License
+
+Proprietary — see LICENSE file.

package/dist/index.d.ts

@@ -1,5 +1,5 @@
+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 "./plugin.js";
 export { createYakProvider } from "./plugin.js";
-export type { YakProviderOptions, YakApi, ToolCallEventHandler } from "./plugin.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";
 //# 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,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChD,YAAY,EAAE,kBAAkB,EAAE,MAAM,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAGpF,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,aAAa,CAAC;AACpF,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC"}

package/dist/index.js

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

package/dist/plugin.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;
@@ -13,47 +14,22 @@ export type YakProviderOptions = {
     trigger?: boolean | TriggerButtonConfig;
 };
 export type YakApi = {
-    /** Readonly ref — whether the chat widget is open */
     isOpen: DeepReadonly<Ref<boolean>>;
-    /** Readonly ref — whether the iframe is ready */
     isReady: DeepReadonly<Ref<boolean>>;
-    /** Open the chat widget */
     open: () => void;
-    /** Close the chat widget */
     close: () => void;
-    /** Open the chat widget and send a prompt */
     openWithPrompt: (prompt: string) => void;
-    /** Subscribe to tool call completion events. Returns an unsubscribe function. */
     subscribeToToolEvents: (handler: ToolCallEventHandler) => () => void;
-    /** Mount the widget DOM — call only on client side */
+    voiceMachine: DeepReadonly<Ref<VoiceMachine>>;
+    voiceStart: () => Promise<void>;
+    voiceStop: () => Promise<void>;
+    voiceToggle: () => Promise<void>;
     mount: () => void;
-    /** Destroy the widget DOM */
     destroy: () => void;
 };
 /**
- * Creates a yak chat widget instance for Nuxt.
- * SSR-safe: call `mount()` only on the client side (e.g. in a plugin with `nuxtApp.hook("app:mounted")`
- * or inside `onMounted`).
- *
- * @example
- * ```ts
- * // plugins/yak.client.ts
- * import { createYakProvider } from "@yak-io/nuxt";
- *
- * export default defineNuxtPlugin((nuxtApp) => {
- *   const yak = createYakProvider({ appId: "my-app" });
- *
- *   nuxtApp.hook("app:mounted", () => yak.mount());
- *   nuxtApp.hook("app:beforeMount", () => {});
- *
- *   nuxtApp.provide("yak", yak);
- *
- *   // Cleanup on HMR
- *   if (import.meta.hot) {
- *     import.meta.hot.dispose(() => yak.destroy());
- *   }
- * });
- * ```
+ * Creates a yak widget (chat + voice) for Nuxt.
+ * SSR-safe: call `mount()` only on the client side.
  */
 export declare function createYakProvider(options: YakProviderOptions): YakApi;
 //# sourceMappingURL=plugin.d.ts.map

package/dist/plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,KAAK,GAAG,EAAE,KAAK,YAAY,EAAE,MAAM,KAAK,CAAC;AACjE,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,qDAAqD;IACrD,MAAM,EAAE,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;IACnC,iDAAiD;IACjD,OAAO,EAAE,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;IACpC,2BAA2B;IAC3B,IAAI,EAAE,MAAM,IAAI,CAAC;IACjB,4BAA4B;IAC5B,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,6CAA6C;IAC7C,cAAc,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IACzC,iFAAiF;IACjF,qBAAqB,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,MAAM,IAAI,CAAC;IACrE,sDAAsD;IACtD,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,6BAA6B;IAC7B,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB,CAAC;AAIF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,kBAAkB,GAAG,MAAM,CAkFrE"}
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.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,YAAY,EAAE,KAAK,GAAG,EAAiB,MAAM,KAAK,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;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;IACrE,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;IACjC,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB,CAAC;AAIF;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,kBAAkB,GAAG,MAAM,CAmGrE"}

package/dist/plugin.js

@@ -1,35 +1,14 @@
-import { ref, readonly } 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 { readonly, ref } from "vue";
 // ── Provider factory ────────────────────────────────────────────────────────
 /**
- * Creates a yak chat widget instance for Nuxt.
- * SSR-safe: call `mount()` only on the client side (e.g. in a plugin with `nuxtApp.hook("app:mounted")`
- * or inside `onMounted`).
- *
- * @example
- * ```ts
- * // plugins/yak.client.ts
- * import { createYakProvider } from "@yak-io/nuxt";
- *
- * export default defineNuxtPlugin((nuxtApp) => {
- *   const yak = createYakProvider({ appId: "my-app" });
- *
- *   nuxtApp.hook("app:mounted", () => yak.mount());
- *   nuxtApp.hook("app:beforeMount", () => {});
- *
- *   nuxtApp.provide("yak", yak);
- *
- *   // Cleanup on HMR
- *   if (import.meta.hot) {
- *     import.meta.hot.dispose(() => yak.destroy());
- *   }
- * });
- * ```
+ * Creates a yak widget (chat + voice) for Nuxt.
+ * SSR-safe: call `mount()` only on the client side.
  */
 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:", {
@@ -50,8 +29,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,
@@ -59,11 +40,13 @@ export function createYakProvider(options) {
         options: { disableRestartButton: options.disableRestartButton },
         onToolCallComplete: handleToolCallComplete,
     });
-    // Sync embed state → refs
     embed.onStateChange((state) => {
         isOpen.value = state.isOpen;
         isReady.value = state.isReady;
     });
+    embed.onVoiceStateChange((m) => {
+        voiceMachine.value = m;
+    });
     // Fetch chat config on first open
     if (options.getConfig) {
         const getConfig = options.getConfig;
@@ -84,6 +67,14 @@ export function createYakProvider(options) {
             }
         });
     }
+    const voiceStart = async () => {
+        try {
+            await embed.voiceStart();
+        }
+        catch (err) {
+            logger.warn("Voice start failed", err);
+        }
+    };
     return {
         isOpen: readonly(isOpen),
         isReady: readonly(isReady),
@@ -96,6 +87,10 @@ export function createYakProvider(options) {
                 toolEventSubscribers.delete(handler);
             };
         },
+        voiceMachine: readonly(voiceMachine),
+        voiceStart,
+        voiceStop: () => embed.voiceStop(),
+        voiceToggle: () => embed.voiceToggle(),
         mount: () => embed.mount(),
         destroy: () => embed.destroy(),
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yak-io/nuxt",
-  "version": "0.1.2",
+  "version": "0.3.0",
   "description": "Nuxt 3 module for embedding yak chatbot",
   "type": "module",
   "license": "SEE LICENSE IN LICENSE",
@@ -41,16 +41,16 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@yak-io/javascript": "0.6.0"
+    "@yak-io/javascript": "0.8.0"
   },
   "peerDependencies": {
     "nuxt": "^3.0.0",
     "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": {