@yak-io/angular 0.1.1 → 0.2.0

package/README.md

@@ -0,0 +1,188 @@
+# @yak-io/angular
+
+Angular integration for the Yak embeddable chat widget. Uses a factory function compatible with Angular's component and service patterns.
+
+## Installation
+
+```bash
+pnpm add @yak-io/angular
+```
+
+## Quickstart
+
+### 1. Initialize in your root component
+
+```ts
+// app.component.ts
+import { Component, OnInit, OnDestroy, inject } from "@angular/core";
+import { Router } from "@angular/router";
+import { createYakProvider, type YakApi } from "@yak-io/angular";
+import { environment } from "../environments/environment";
+
+@Component({
+  selector: "app-root",
+  standalone: true,
+  template: "<router-outlet />",
+})
+export class AppComponent implements OnInit, OnDestroy {
+  private router = inject(Router);
+  private yak: YakApi;
+
+  constructor() {
+    this.yak = createYakProvider({
+      appId: environment.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) => {
+        this.router.navigateByUrl(path);
+      },
+    });
+  }
+
+  ngOnInit() {
+    this.yak.mount();
+  }
+
+  ngOnDestroy() {
+    this.yak.destroy();
+  }
+}
+```
+
+### 2. Share via an Angular service
+
+Create a service to share the widget API across components:
+
+```ts
+// yak.service.ts
+import { Injectable, signal } from "@angular/core";
+import type { YakApi } from "@yak-io/angular";
+
+@Injectable({ providedIn: "root" })
+export class YakService {
+  private yak: YakApi | null = null;
+  readonly isOpen = signal(false);
+  readonly isReady = signal(false);
+
+  setYak(yak: YakApi) {
+    this.yak = yak;
+    yak.subscribeToState(({ isOpen, isReady }) => {
+      this.isOpen.set(isOpen);
+      this.isReady.set(isReady);
+    });
+  }
+
+  open() { this.yak?.open(); }
+  close() { this.yak?.close(); }
+  openWithPrompt(prompt: string) { this.yak?.openWithPrompt(prompt); }
+}
+```
+
+### 3. Use in components
+
+```ts
+// any.component.ts
+import { Component, inject } from "@angular/core";
+import { YakService } from "./yak.service";
+
+@Component({
+  template: `
+    <button (click)="yakService.open()">Open Chat</button>
+    <p *ngIf="yakService.isOpen()">Chat is open</p>
+  `,
+})
+export class AnyComponent {
+  yakService = inject(YakService);
+}
+```
+
+## API Reference
+
+### `createYakProvider(options)`
+
+Creates a Yak widget instance. Returns a `YakApi` object.
+
+Call `yak.mount()` in `ngOnInit()` and `yak.destroy()` in `ngOnDestroy()`.
+
+**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 = {
+  readonly isOpen: boolean;  // Plain boolean (use subscribeToState for reactivity)
+  readonly isReady: boolean; // Plain boolean
+  open: () => void;
+  close: () => void;
+  openWithPrompt: (prompt: string) => void;
+  subscribeToToolEvents: (handler: ToolCallEventHandler) => () => void;
+  subscribeToState: (handler: (state: { isOpen: boolean; isReady: boolean }) => void) => () => void;
+  mount: () => void;    // Call in ngOnInit() or ngAfterViewInit()
+  destroy: () => void;  // Call in ngOnDestroy()
+};
+```
+
+Use `subscribeToState` to react to state changes — wire it to Angular signals, `BehaviorSubject`s, or change detection:
+
+```ts
+yak.subscribeToState(({ isOpen, isReady }) => {
+  this.isOpen.set(isOpen);
+  this.changeDetector.markForCheck();
+});
+```
+
+## Logging
+
+```ts
+import { enableYakLogging, disableYakLogging, isYakLoggingEnabled } from "@yak-io/angular";
+
+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/angular";
+```
+
+## License
+
+Proprietary — see LICENSE file.

package/dist/service.js

@@ -1,5 +1,5 @@
 import { YakEmbed, } from "@yak-io/javascript";
-import { logger } from "./internal/logger.js";
+import { logger } from "@yak-io/javascript";
 // ── Provider factory ────────────────────────────────────────────────────────
 /**
  * Creates a yak chat widget instance for Angular.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yak-io/angular",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Angular SDK for embedding yak chatbot",
   "type": "module",
   "license": "SEE LICENSE IN LICENSE",
@@ -41,13 +41,13 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@yak-io/javascript": "0.6.0"
+    "@yak-io/javascript": "0.7.0"
   },
   "peerDependencies": {
-    "@angular/core": "^17.0.0 || ^18.0.0 || ^19.0.0"
+    "@angular/core": "^17.0.0 || ^18.0.0 || ^19.0.0 || ^20.0.0 || ^21.0.0"
   },
   "devDependencies": {
-    "@types/node": "^24.10.4",
+    "@types/node": "^24.12.0",
     "typescript": "^5.3.0",
     "@repo/typescript-config": "0.0.0"
   },

package/dist/internal/logger.d.ts

@@ -1,2 +0,0 @@
-export { logger } from "@yak-io/javascript";
-//# sourceMappingURL=logger.d.ts.map

package/dist/internal/logger.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/internal/logger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC"}

package/dist/internal/logger.js

@@ -1 +0,0 @@
-export { logger } from "@yak-io/javascript";