@yak-io/javascript 0.1.0

package/LICENSE

@@ -0,0 +1,36 @@
+Yak Proprietary License
+
+Copyright (c) 2025 Yak. All rights reserved.
+
+This software and associated documentation files (the "Software") are the
+proprietary property of Yak and are protected by copyright law.
+
+GRANT OF LICENSE:
+Subject to the terms of this license and your valid subscription or agreement
+with Yak, you are granted a limited, non-exclusive, non-transferable license
+to use the Software solely for integrating the Yak chatbot widget into your
+applications as intended and documented.
+
+RESTRICTIONS:
+You may NOT:
+- Modify, adapt, alter, translate, or create derivative works of the Software
+- Reverse engineer, disassemble, decompile, or otherwise attempt to derive
+  the source code of the Software
+- Redistribute, sublicense, lease, rent, or lend the Software to third parties
+- Remove or alter any proprietary notices, labels, or marks on the Software
+- Use the Software for any purpose other than as expressly permitted herein
+
+NO WARRANTY:
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL YAK
+BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
+CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+TERMINATION:
+This license is effective until terminated. Your rights under this license
+will terminate automatically without notice if you fail to comply with any
+of its terms.
+
+For licensing inquiries, contact: support@yak.io

package/dist/client.d.ts

@@ -0,0 +1,175 @@
+import type { ChatConfig } from "./types/config.js";
+import type { Theme } from "./types/messaging.js";
+import type { ToolCallHandler, GraphQLSchemaHandler, RESTSchemaHandler } from "./types/tools.js";
+declare global {
+    interface Window {
+        __YAK_INTERNAL_DEV__?: boolean;
+    }
+}
+export interface YakClientConfig {
+    appId: string;
+    /**
+     * Handler for tool calls from the chat widget.
+     * The consuming platform decides how to execute (browser, server fetch, etc.)
+     *
+     * @example Browser-only execution
+     * ```ts
+     * onToolCall: async (name, args) => {
+     *   if (name === "ui.scrollTo") {
+     *     document.getElementById(args.id)?.scrollIntoView();
+     *     return { success: true };
+     *   }
+     *   throw new Error(`Unknown tool: ${name}`);
+     * }
+     * ```
+     *
+     * @example Server delegation
+     * ```ts
+     * onToolCall: async (name, args) => {
+     *   const res = await fetch("/api/yak/tools", {
+     *     method: "POST",
+     *     body: JSON.stringify({ name, args }),
+     *   });
+     *   const data = await res.json();
+     *   if (!data.ok) throw new Error(data.error);
+     *   return data.result;
+     * }
+     * ```
+     */
+    onToolCall?: ToolCallHandler;
+    /**
+     * Handler for GraphQL schema-based tool calls.
+     * Called when the LLM generates a GraphQL request based on a provided schema.
+     *
+     * @example
+     * ```ts
+     * onGraphQLSchemaCall: async (schemaName, request) => {
+     *   const res = await fetch("/graphql", {
+     *     method: "POST",
+     *     headers: { "Content-Type": "application/json" },
+     *     body: JSON.stringify({
+     *       query: request.query,
+     *       variables: request.variables,
+     *     }),
+     *   });
+     *   return res.json();
+     * }
+     * ```
+     */
+    onGraphQLSchemaCall?: GraphQLSchemaHandler;
+    /**
+     * Handler for REST/OpenAPI schema-based tool calls.
+     * Called when the LLM generates a REST request based on a provided schema.
+     *
+     * @example
+     * ```ts
+     * onRESTSchemaCall: async (schemaName, request) => {
+     *   const url = new URL(`https://api.example.com${request.path}`);
+     *   if (request.query) {
+     *     for (const [key, value] of Object.entries(request.query)) {
+     *       url.searchParams.set(key, value);
+     *     }
+     *   }
+     *   const res = await fetch(url.toString(), {
+     *     method: request.method,
+     *     body: request.body ? JSON.stringify(request.body) : undefined,
+     *   });
+     *   return res.json();
+     * }
+     * ```
+     */
+    onRESTSchemaCall?: RESTSchemaHandler;
+    theme?: Theme;
+    chatConfig?: ChatConfig;
+    onRedirect?: (path: string) => void;
+    onClose?: () => void;
+    onReady?: () => void;
+    /** Chat configuration options */
+    options?: {
+        /** Disable the restart session button in the header */
+        disableRestartButton?: boolean;
+    };
+}
+export declare class YakClient {
+    private config;
+    private iframeWindow;
+    private isWidgetOpen;
+    private readyTarget;
+    private unexpectedOriginLogged;
+    private lastUrl;
+    private debouncedSendContext;
+    private observer;
+    constructor(config: YakClientConfig);
+    updateConfig(newConfig: Partial<YakClientConfig>): void;
+    /**
+     * Get the iframe origin URL (base URL for the chat widget)
+     * This is computed each time to support setting __YAK_INTERNAL_DEV__ after page load.
+     */
+    getIframeOrigin(): string;
+    /**
+     * Get the full iframe embed URL for the chatbot
+     *
+     * @example
+     * ```ts
+     * const client = new YakClient({ appId: "my-app" });
+     * const iframeSrc = client.getEmbedUrl();
+     * // Returns: "https://chat.yak.io/embed/v1/my-app"
+     * ```
+     */
+    getEmbedUrl(): string;
+    /**
+     * Get the app ID
+     */
+    getAppId(): string;
+    /**
+     * Get the current theme configuration
+     */
+    getTheme(): Theme | undefined;
+    /**
+     * Send a prompt message to the chatbot iframe
+     * Note: The iframe must be ready to receive messages (onReady callback must have fired)
+     *
+     * @example
+     * ```ts
+     * const client = new YakClient({ appId: "my-app", onReady: () => {
+     *   client.sendPrompt("Help me with my order");
+     * }});
+     * ```
+     */
+    sendPrompt(prompt: string): void;
+    /**
+     * Send a focus request to the chatbot iframe
+     * This will focus the chat input field
+     */
+    sendFocus(): void;
+    /**
+     * Check if the iframe is ready to receive messages
+     */
+    isReady(): boolean;
+    setIframeWindow(window: Window | null): void;
+    setWidgetOpen(isOpen: boolean): void;
+    mount(): void;
+    unmount(): void;
+    private startObserving;
+    private stopObserving;
+    private handlePopState;
+    private handleMessage;
+    private sendConfigToIframe;
+    private sendPageContext;
+    private handleToolCall;
+    private handleGraphQLSchemaCall;
+    private handleRESTSchemaCall;
+    private sendToolResultToIframe;
+    /**
+     * Convert a value to a serializable form by stripping functions and other non-cloneable values.
+     * Uses JSON.parse(JSON.stringify()) which handles most cases.
+     */
+    private toSerializable;
+    private extractErrorMessage;
+    /**
+     * Validates that a redirect path is safe (relative path or same-origin).
+     * Blocks absolute URLs to external domains to prevent open redirect attacks.
+     */
+    private isAllowedRedirect;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,KAAK,EAA8C,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAC9F,OAAO,KAAK,EACV,eAAe,EACf,oBAAoB,EACpB,iBAAiB,EAGlB,MAAM,kBAAkB,CAAC;AAM1B,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,oBAAoB,CAAC,EAAE,OAAO,CAAC;KAChC;CACF;AA+BD,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,UAAU,CAAC,EAAE,eAAe,CAAC;IAC7B;;;;;;;;;;;;;;;;;;OAkBG;IACH,mBAAmB,CAAC,EAAE,oBAAoB,CAAC;IAC3C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,gBAAgB,CAAC,EAAE,iBAAiB,CAAC;IACrC,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACpC,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IACrB,iCAAiC;IACjC,OAAO,CAAC,EAAE;QACR,uDAAuD;QACvD,oBAAoB,CAAC,EAAE,OAAO,CAAC;KAChC,CAAC;CACH;AAED,qBAAa,SAAS;IACpB,OAAO,CAAC,MAAM,CAAkB;IAChC,OAAO,CAAC,YAAY,CAAuB;IAC3C,OAAO,CAAC,YAAY,CAAkB;IACtC,OAAO,CAAC,WAAW,CAAmD;IACtE,OAAO,CAAC,sBAAsB,CAAS;IACvC,OAAO,CAAC,OAAO,CAAO;IACtB,OAAO,CAAC,oBAAoB,CAAa;IACzC,OAAO,CAAC,QAAQ,CAAiC;gBAErC,MAAM,EAAE,eAAe;IAQ5B,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,eAAe,CAAC;IAOvD;;;OAGG;IACI,eAAe,IAAI,MAAM;IAIhC;;;;;;;;;OASG;IACI,WAAW,IAAI,MAAM;IA8D5B;;OAEG;IACI,QAAQ,IAAI,MAAM;IAIzB;;OAEG;IACI,QAAQ,IAAI,KAAK,GAAG,SAAS;IAIpC;;;;;;;;;;OAUG;IACI,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAavC;;;OAGG;IACI,SAAS,IAAI,IAAI;IAYxB;;OAEG;IACI,OAAO,IAAI,OAAO;IAIlB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAOrC,aAAa,CAAC,MAAM,EAAE,OAAO;IAa7B,KAAK;IAOL,OAAO;IAQd,OAAO,CAAC,cAAc;IA+BtB,OAAO,CAAC,aAAa;IAOrB,OAAO,CAAC,cAAc,CAGrB;IAED,OAAO,CAAC,aAAa,CA+GpB;IAED,OAAO,CAAC,kBAAkB;IA2B1B,OAAO,CAAC,eAAe;YAoBT,cAAc;YAuBd,uBAAuB;YAuBvB,oBAAoB;IAuBlC,OAAO,CAAC,sBAAsB;IAuB9B;;;OAGG;IACH,OAAO,CAAC,cAAc;IAatB,OAAO,CAAC,mBAAmB;IAU3B;;;OAGG;IACH,OAAO,CAAC,iBAAiB;CAsB1B"}