@helpai/elements 1.6.0 → 1.8.0

package/index.d.ts

@@ -3207,11 +3207,12 @@ type HookListener = (instance: ChatWidgetInstance, event: EventName, data: unkno
 /**
  * Host-element command bus.
  *
- * The programmatic API (`chat.open()`, `.close()`, `.expand()`)
- * dispatches `CustomEvent`s on the shadow host element. The App listens
- * for those same events and routes them to its state handlers. That
- * keeps the two modules decoupled — `index.ts` doesn't hold a ref to App
- * state, App doesn't know about the public instance handle.
+ * The programmatic API (`chat.open()`, `.close()`, `.ask()`, …) and the
+ * `<web-ai-chat>` element's methods dispatch `CustomEvent`s on the shadow
+ * host element. The App listens for those same events and routes them to
+ * its state handlers. That keeps the two modules decoupled — `index.ts`
+ * doesn't hold a ref to App state, App doesn't know about the public
+ * instance handle.
  *
  * This module is the single source of truth for the event names + the
  * tiny helpers on both sides of the bridge.
@@ -3221,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.
  *
@@ -3284,6 +3290,18 @@ export interface ChatWidgetInstance {
    * if no form with that id + a `manual` trigger exists.
    */
   openForm: (id: string) => void;
+  /**
+   * 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?'); // 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, options?: AskOptions) => void;
   /**
    * Subscribe to a lifecycle event. Returns an `off` function. See
    * {@link EventMap} for the full set + payload shapes — currently
@@ -3427,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 };