@magicx-eng/ai-autocomplete-vanilla 0.52.0 → 0.53.1

package/README.md

@@ -166,6 +166,7 @@ ac.destroy();                  // Remove DOM, listeners, timers
 ac.setMode("dark");            // Switch color mode
 ac.update({ animations: false, optionsPosition: "above" });
 ac.selectProduct(product);     // Emit onProductSelect (Tier 3 / custom strips)
+ac.prepareSubmit();            // Prepare the typed word before your own button builds a result
 ac.getResult();                // The AutocompleteResult as it stands right now
 ac.getRequestId();             // The latest applied /suggest request ID, or null
 ```
@@ -689,6 +690,7 @@ unsub();
 | `removeLastParam()` | Remove the last completed param from state. The text stays in the input as plain text. |
 | `clearNewParamId()` | Clear shimmer animation state. |
 | `reset()` | Clear all state, re-fetch initial suggestions, and start a new session (rotates `session_id`). Call this after handling submit. |
+| `prepareSubmit()` | Call before building a submit result from your own button. A typed word that equals exactly one completion candidate becomes a completed param, the same as Enter. Read the updated state with `getState()` to build the result. |
 | `recordSubmit(result)` | Record a submit from a button you render. Enter and the built-in button are recorded for you; call this once per submit from your own button. |
 | `setValue(text)` | Set text (controlled mode). Text set this way is not reported as the user starting a search. |
 | `prefillText(text)` | Fill the field with text the user did not type — e.g. a query carried over from the previous page — and handle it like typing: suggestions are fetched and the text is recognized. Not reported as the user starting a search. |

package/dist/index.d.mts

@@ -94,6 +94,14 @@ interface Suggestion {
      * nothing about how the options are answered.
      */
     smart_suggestion?: boolean;
+    /**
+     * The joining word or two typed before a date or date range picker's answer
+     * ("from" before "Nov 17"). Typed as plain text, so the completed param still
+     * holds only the answer. A suggestion answered from its options carries its
+     * joining words in their text instead. Absent on servers that send none,
+     * which then answer exactly as before.
+     */
+    lead_in?: string;
 }
 interface InputItem {
     parameter: string;
@@ -1367,6 +1375,12 @@ declare class AIAutocomplete {
      * highlight the keyboard has since moved elsewhere is left alone.
      */
     clearHighlight(index: number): void;
+    /**
+     * Call before you build a submit result from your own button.
+     * A typed word that equals exactly one completion candidate becomes a completed param, the same as Enter.
+     * Read the updated state with `getState()` to build the result.
+     */
+    prepareSubmit(): void;
     /**
      * Records a submit in telemetry. The SDK does this itself when it runs the
      * submit (Enter, or Tier 1's button); call it only from a submit path you

package/dist/index.d.ts

@@ -94,6 +94,14 @@ interface Suggestion {
      * nothing about how the options are answered.
      */
     smart_suggestion?: boolean;
+    /**
+     * The joining word or two typed before a date or date range picker's answer
+     * ("from" before "Nov 17"). Typed as plain text, so the completed param still
+     * holds only the answer. A suggestion answered from its options carries its
+     * joining words in their text instead. Absent on servers that send none,
+     * which then answer exactly as before.
+     */
+    lead_in?: string;
 }
 interface InputItem {
     parameter: string;
@@ -1367,6 +1375,12 @@ declare class AIAutocomplete {
      * highlight the keyboard has since moved elsewhere is left alone.
      */
     clearHighlight(index: number): void;
+    /**
+     * Call before you build a submit result from your own button.
+     * A typed word that equals exactly one completion candidate becomes a completed param, the same as Enter.
+     * Read the updated state with `getState()` to build the result.
+     */
+    prepareSubmit(): void;
     /**
      * Records a submit in telemetry. The SDK does this itself when it runs the
      * submit (Enter, or Tier 1's button); call it only from a submit path you