@inkeep/agents-ui 0.14.23 → 0.14.25

package/dist/primitives/providers/base-events-provider.cjs

@@ -1 +1 @@
-"use client";"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const E=require("react/jsx-runtime"),t=require("react"),l=require("./config-provider.cjs"),a=t.createContext(void 0),p=({children:e})=>{const{baseSettings:s,componentType:n}=l.useInkeepConfig(),{tags:o,analyticsProperties:r}=s,i=t.useMemo(()=>({widgetLibraryVersion:"0.14.20",componentType:n,tags:o}),[n,o]),u={logEvent:t.useCallback(async c=>{const v={...i,...c.properties,...r},d={eventName:c.eventName,properties:v};return s.onEvent?.(d)},[s,i,r])};return E.jsx(a.Provider,{value:u,children:e})},g=()=>{const e=t.useContext(a);if(!e)throw new Error("useBaseEvents must be used within a BaseEventsProvider");return e};exports.BaseEventsProvider=p;exports.useBaseEvents=g;
+"use client";"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const E=require("react/jsx-runtime"),t=require("react"),l=require("./config-provider.cjs"),a=t.createContext(void 0),p=({children:e})=>{const{baseSettings:s,componentType:n}=l.useInkeepConfig(),{tags:o,analyticsProperties:r}=s,i=t.useMemo(()=>({widgetLibraryVersion:"0.14.24",componentType:n,tags:o}),[n,o]),u={logEvent:t.useCallback(async c=>{const v={...i,...c.properties,...r},d={eventName:c.eventName,properties:v};return s.onEvent?.(d)},[s,i,r])};return E.jsx(a.Provider,{value:u,children:e})},g=()=>{const e=t.useContext(a);if(!e)throw new Error("useBaseEvents must be used within a BaseEventsProvider");return e};exports.BaseEventsProvider=p;exports.useBaseEvents=g;

package/dist/primitives/providers/base-events-provider.js

@@ -5,7 +5,7 @@ import { useInkeepConfig as g } from "./config-provider.js";
 const a = d(void 0), P = ({ children: e }) => {
   const { baseSettings: t, componentType: o } = g(), { tags: s, analyticsProperties: n } = t, r = u(
     () => ({
-      widgetLibraryVersion: "0.14.20",
+      widgetLibraryVersion: "0.14.24",
       componentType: o,
       tags: s
     }),

package/dist/react/widget-toggle.d.ts

@@ -1,13 +1,13 @@
-import { ModalViewTypes, OnToggleView } from '../types/index.ts';
+import { ModalViewTypes, WidgetView } from '../types/index.ts';
 export declare function WidgetToggle(props: {
-    onToggleView: OnToggleView;
+    onToggleView: WidgetView['onToggleView'];
     query?: string;
     askAILabel?: string;
     searchLabel?: string;
     view: ModalViewTypes;
 }): import("react/jsx-runtime").JSX.Element;
 export declare function useToggleView(props: {
-    onToggleView?: OnToggleView;
+    onToggleView?: WidgetView['onToggleView'];
     query?: string;
 }): {
     handleToggle: (view: ModalViewTypes, autoSubmit?: boolean) => void;

package/dist/types/config/ai.d.ts

@@ -130,7 +130,9 @@ export interface InkeepAIChatSettings {
     disclaimerSettings?: AIChatDisclaimerSettings;
     /**
      * Callback function triggered whenever the user modifies their input message.
-     * @param message The current content of the input field
+     *
+  
+     * `param:` message The current content of the input field
      */
     onInputMessageChange?: (message: string) => void;
     /**
@@ -189,12 +191,14 @@ export interface AIChatDisclaimerSettings {
 export interface AIChatFunctions {
     /**
      * Programmatically sends a message in the chat.
-     * @param message Optional message text. If omitted, sends the current input value.
+  
+     * `param:` message Optional message text. If omitted, sends the current input value.
      */
     submitMessage: (message?: string) => void;
     /**
      * Programmatically updates the text in the chat input field.
-     * @param message The new message text to set
+  
+     * `param:` message The new message text to set
      */
     updateInputMessage: (message: string) => void;
     /**
@@ -204,8 +208,10 @@ export interface AIChatFunctions {
     clearChat: () => void;
     /**
      * Displays a form overlay in the chat interface.
-     * @param formSettings Configuration object defining the form's fields and behavior
-     * @param getHelpOption Optional getHelpOption that triggered the form (for analytics)
+  
+     * `param:` formSettings Configuration object defining the form's fields and behavior
+  
+     * `param:` getHelpOption Optional getHelpOption that triggered the form (for analytics)
      */
     openForm: (formSettings: AIChatFormSettings, getHelpOption?: GetHelpOption) => void;
     /**

package/dist/types/config/base.d.ts

@@ -51,12 +51,14 @@ export interface InkeepBaseSettings {
     analyticsProperties?: Record<string, unknown>;
     /**
      * Handler for analytics events from the widget.
-     * @param event The analytics event object
+  
+     * `param:` event The analytics event object
      */
     onEvent?: (event: InkeepCallbackEvent) => Promise<void>;
     /**
      * Handler for feedback events from the widget.
-     * @param feedback The feedback object
+  
+     * `param:` feedback The feedback object
      */
     onFeedback?: (feedback: InkeepFeedback & {
         properties?: Record<string, unknown>;
@@ -69,8 +71,10 @@ export interface InkeepBaseSettings {
     /**
      * Function to transform source data before display.
      * Allows customizing how source information is presented in the widget.
-     * @param source The original source data
-     * @returns The transformed source data
+  
+     * `param:` source The original source data
+     *
+     * `returns:`  The transformed source data
      */
     transformSource?: TransformSource;
     /**
@@ -224,7 +228,7 @@ export interface Style {
      * For type='link', this should be a valid URL to an external resource.
      * For type='style', this should be valid CSS code.
      *
-     * @example
+     * ```ts
      * // For type='link':
      * value: 'https://fonts.googleapis.com/css2?family=Inter:wght@400;700&display=swap'
      *
@@ -233,6 +237,7 @@ export interface Style {
      *   background: blue;
      *   color: white;
      * }`
+     * ```
      */
     value: string;
 }
@@ -309,8 +314,10 @@ export interface SyncColorMode {
      * The function receives an object containing the current values of all monitored attributes,
      * where the keys are attribute names and values are the attribute values.
      *
-     * @param attributes - Object containing the current values of monitored attributes
-     * @returns boolean - True if dark mode is detected, false otherwise
+  
+     * `param:` attributes - Object containing the current values of monitored attributes
+     *
+     * `returns:`  boolean - True if dark mode is detected, false otherwise
      *
      * @example
      * ```ts
@@ -330,7 +337,8 @@ export interface SyncColorMode {
      *
      * This can be used to perform side effects or sync the color mode with other parts of your application.
      *
-     * @param colorMode - The new color mode value ('light' | 'dark')
+  
+     * `param:` colorMode - The new color mode value ('light' | 'dark')
      *
      * @example
      * ```ts

package/dist/types/config/search.d.ts

@@ -21,9 +21,12 @@ export interface InkeepSearchSettings {
      * This callback handles the complete search implementation.
      * If not provided, the widget will warn and show no results.
      *
-     * @param query - The search query string
-     * @param abortSignal - Signal to abort the search request
-     * @returns Promise that resolves with search results
+  
+     * `param:` query - The search query string
+  
+     * `param:` abortSignal - Signal to abort the search request
+     *
+     * `returns:`  Promise that resolves with search results
      */
     onSearch?: (query: string, abortSignal: AbortSignal) => Promise<SourceItem[]>;
     /**

package/dist/types/js/index.d.ts

@@ -28,7 +28,8 @@ export type InkeepJS = Partial<Record<InkeepJSComponent, InkeepComponentInitiali
 export interface InkeepComponentInstance {
     /**
      * Updates the component with new props
-     * @param newProps The new props to apply to the component
+  
+     * `param:` newProps The new props to apply to the component
      */
     update: <T extends object>(newProps: T) => void;
     /**

package/dist/types/widget.d.ts

@@ -1,10 +1,5 @@
 export type UrlQueryParam = Record<string, string>;
 export type ModalViewTypes = 'chat' | 'search';
-export type OnToggleView = (opts: {
-    view: ModalViewTypes;
-    query?: string;
-    autoSubmit?: boolean;
-}) => void;
 export interface WidgetView {
     /**
      * Callback fired when the user toggles between chat and search views.
@@ -12,7 +7,11 @@ export interface WidgetView {
      * The parent component can use this
      * to coordinate showing/hiding the appropriate view.
      */
-    onToggleView?: OnToggleView;
+    onToggleView?: (opts: {
+        view: ModalViewTypes;
+        query?: string;
+        autoSubmit?: boolean;
+    }) => void;
     /**
      * The label for the Ask AI button.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inkeep/agents-ui",
-  "version": "0.14.23",
+  "version": "0.14.25",
   "description": "",
   "homepage": "",
   "repository": {