@helpai/elements 1.6.0 → 1.7.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.
@@ -3284,6 +3285,17 @@ export interface ChatWidgetInstance {
    * if no form with that id + a `manual` trigger exists.
    */
   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.
+   *
+   * @example
+   * ```ts
+   * chat.ask('How do I book a session?');
+   * ```
+   */
+  ask: (text: string) => void;
   /**
    * Subscribe to a lifecycle event. Returns an `off` function. See
    * {@link EventMap} for the full set + payload shapes — currently