@helpai/elements 1.7.0 → 1.8.0

package/index.d.ts

@@ -3222,6 +3222,11 @@ interface OpenTarget {
   to: 'home' | 'chats' | 'help' | 'news';
   id?: string;
 }
+/** How `ask(text, options)` lands: in the composer for the visitor to send (default), or sent right away. */
+interface AskOptions {
+  /** Send the text as the visitor's message instead of filling the composer with it. Default `false`. */
+  send?: boolean;
+}
 /**
  * Comprehensive logger for the widget runtime.
  *
@@ -3286,16 +3291,17 @@ export interface ChatWidgetInstance {
    */
   openForm: (id: string) => void;
   /**
-   * Open the chat and send `text` as the visitor's message in the current conversation — for a site's own "Ask
-   * about pricing" button. The message waits until the chat can take it (still connecting, a pre-chat form to
-   * answer, a reply still arriving), then goes out.
+   * Open the chat with `text` in the composer, ready for the visitor to edit and send — for a site's own "Ask about
+   * pricing" button. With `{ send: true }` it goes out as the visitor's message instead. Either way it waits until
+   * the chat can take it (still connecting, a pre-chat form to answer; a send also waits for a reply still arriving).
    *
    * @example
    * ```ts
-   * chat.ask('How do I book a session?');
+   * chat.ask('How do I book a session?'); // open the chat with the question in the composer
+   * chat.ask('How do I book a session?', { send: true }); // open the chat and send it
    * ```
    */
-  ask: (text: string) => void;
+  ask: (text: string, options?: AskOptions) => void;
   /**
    * Subscribe to a lifecycle event. Returns an `off` function. See
    * {@link EventMap} for the full set + payload shapes — currently
@@ -3439,4 +3445,4 @@ export declare const brand: {
   readonly domain: string;
   readonly siteUrl: string;
 };
-export type { Asset, BlocksConfig, ChatWidgetOptions, ConnectionConfig, ConnectionConfigPartial, EventMap, EventName, HandshakeResponse, HookListener, Link, LogEntry, LogLevel, OpenTarget, ResolvedOptions, ServerConfig, SiteConfig, WidgetConfig, WidgetConfigPartial, WidgetSettings, WidgetSettingsPartial };
+export type { AskOptions, Asset, BlocksConfig, ChatWidgetOptions, ConnectionConfig, ConnectionConfigPartial, EventMap, EventName, HandshakeResponse, HookListener, Link, LogEntry, LogLevel, OpenTarget, ResolvedOptions, ServerConfig, SiteConfig, WidgetConfig, WidgetConfigPartial, WidgetSettings, WidgetSettingsPartial };