@inkeep/agents-ui 0.14.25 → 0.14.26

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.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;
+"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.25",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.24",
+      widgetLibraryVersion: "0.14.25",
       componentType: o,
       tags: s
     }),

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

@@ -132,7 +132,7 @@ export interface InkeepAIChatSettings {
      * 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;
     /**
@@ -192,13 +192,13 @@ 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;
     /**
@@ -209,9 +209,8 @@ export interface AIChatFunctions {
     /**
      * 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

@@ -52,13 +52,15 @@ export interface InkeepBaseSettings {
     /**
      * Handler for analytics events from the widget.
   
-     * `param:` event The analytics event object
+     * @param event - The analytics event object
+     * @returns Promise that resolves when the event is logged
      */
     onEvent?: (event: InkeepCallbackEvent) => Promise<void>;
     /**
      * Handler for feedback events from the widget.
   
-     * `param:` feedback The feedback object
+     * @param feedback - The feedback object
+     * @returns The feedback object
      */
     onFeedback?: (feedback: InkeepFeedback & {
         properties?: Record<string, unknown>;
@@ -70,11 +72,14 @@ export interface InkeepBaseSettings {
     shouldBypassCaptcha?: boolean;
     /**
      * Function to transform source data before display.
+     *
+     * @remarks
      * 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
+     * @param type - The type of source data
+     * @param opts - The options for the transform source
+     * @returns The transformed source data
      */
     transformSource?: TransformSource;
     /**
@@ -311,13 +316,13 @@ export interface SyncColorMode {
     /**
      * A function that determines if dark mode is active based on the target element's attributes.
      *
+     * @remarks
      * 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 True if dark mode is detected, false otherwise
      *
      * @example
      * ```ts
@@ -338,7 +343,7 @@ 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

@@ -22,11 +22,10 @@ export interface InkeepSearchSettings {
      * 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
+     * @param query - The search query string
+     * @param abortSignal - Signal to abort the search request
      *
-     * `returns:`  Promise that resolves with search results
+     * @returns Promise that resolves with search results
      */
     onSearch?: (query: string, abortSignal: AbortSignal) => Promise<SourceItem[]>;
     /**

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

@@ -29,7 +29,7 @@ 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/package.json

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