@magicx-eng/ai-autocomplete-vanilla 0.39.0 → 0.41.0

package/README.md

@@ -80,7 +80,8 @@ const ac = new AIAutocomplete(container, {
   maskCompletedText: false, // when true, omits completed params' text from API requests (PII masking)
   commitOnWordEnd: false,   // true = a word still being typed never becomes a chip until a space, Enter, or Tab ends it (exact matches and server identified params). Picking an option is unchanged.
   additionalContext: { tier: "gold" }, // optional user context, to personalize suggestions and options
-  language: "es",           // BCP 47 tag sent with every suggestion request. Default: navigator.language, else "en-US"
+  language: "es",           // BCP 47 tag sent with every suggestion request and telemetry event. Default: navigator.language, else "en-US"
+  productId: "...",         // your product id: what the dropdown offers before anything is typed is read from a cacheable URL with no credential; falls back to a suggestion request
 
   // Appearance
   mode: "auto",               // "light" | "dark" | "auto"
@@ -730,13 +731,14 @@ A discriminated union: `APIKeyConfig | AccessTokenConfig`.
   getAccessToken: async () => {
     const res = await fetch("/api/ac-token");
     const { access_token, expires_at } = await res.json();
-    return { accessToken: access_token, expiresAt: expires_at };
+    // expires_at is Unix seconds; the SDK's expiresAt is Unix milliseconds.
+    return { accessToken: access_token, expiresAt: expires_at * 1000 };
   },
   endpoint: "https://api.ai-autocomplete.com/api/suggest", // optional, this is the default
 }
 ```
 
-The SDK handles token refresh transparently: if a request returns 401, it calls `getAccessToken` once, retries, and only surfaces an error if the retry also fails. Concurrent 401s share a single refresh call. Tokens are refreshed proactively 30 seconds before `expiresAt`.
+The SDK handles token refresh transparently: if a request returns 401, it calls `getAccessToken` once, retries, and only surfaces an error if the retry also fails. Concurrent 401s share a single refresh call. Tokens are refreshed proactively 30 seconds before `expiresAt` (Unix milliseconds).
 
 ### `AutocompleteResult`
 

package/dist/index.d.mts

@@ -138,6 +138,12 @@ interface AutocompleteResponse {
         request_at: string;
         /** The server's funnel-telemetry switch. Absent means off: send no funnel events. */
         funnel_telemetry?: boolean;
+        /**
+         * The server's phrase exact match switch. When true, a typed phrase that
+         * starts at the word the last request ended in can match an option
+         * exactly. Absent means off.
+         */
+        phrase_exact_match?: boolean;
         /** The request's `schema_version`, echoed back. */
         schema_version?: string;
     };
@@ -932,10 +938,18 @@ interface CoreOptions {
      */
     additionalContext?: Record<string, unknown>;
     /**
-     * BCP 47 language tag (e.g. `"es"`), sent with every suggestion request.
+     * BCP 47 language tag (e.g. `"es"`), sent with every suggestion request and telemetry event.
      * Default: the browser language (`navigator.language`), else `"en-US"`.
+     * Only an explicit value selects the SDK's own UI words (Spanish for `es`, English otherwise). The browser language does not.
      */
     language?: string;
+    /**
+     * Your product id. When set, what the dropdown offers before anything is
+     * typed is read from a cacheable URL for your product, with no credential,
+     * instead of a suggestion request; it falls back to a suggestion request
+     * when it cannot be read.
+     */
+    productId?: string;
     /**
      * Stable id for this visitor, kept by the host across page loads (e.g. a
      * first-party cookie). Rides on funnel telemetry so searches can be joined
@@ -1366,6 +1380,7 @@ declare class AIAutocomplete {
      */
     private fireImpression;
     private fireTelemetry;
+    private updateLanguageAttribute;
     private setupContainer;
     private buildAndRenderFull;
     private buildAndRenderDropdown;
@@ -2095,6 +2110,20 @@ interface RenderEditableArgs {
  */
 declare function renderEditableContent(args: RenderEditableArgs): void;
 
+declare const en: {
+    language: string;
+    proceed: string;
+    select: string;
+    skipHint: string;
+    skip: string;
+    skipLabel: string;
+    products: string;
+    soldOut: string;
+    submit: string;
+    scrollArrow: string;
+};
+type UIStrings = typeof en;
+
 /**
  * The "more below" arrow for the options grid.
  *
@@ -2285,7 +2314,7 @@ declare function buildQuery(text: string, completedParams: CompletedParamState[]
  * Pure computation — no DOM access. Shared by the vanilla renderer and the
  * React / Angular footer components so the wording can't drift between them.
  */
-declare function getFooterHint(optionHighlighted: boolean, isInputEmpty: boolean): {
+declare function getFooterHint(optionHighlighted: boolean, isInputEmpty: boolean, strings?: UIStrings): {
     key: string;
     hint: string;
 };

package/dist/index.d.ts

@@ -138,6 +138,12 @@ interface AutocompleteResponse {
         request_at: string;
         /** The server's funnel-telemetry switch. Absent means off: send no funnel events. */
         funnel_telemetry?: boolean;
+        /**
+         * The server's phrase exact match switch. When true, a typed phrase that
+         * starts at the word the last request ended in can match an option
+         * exactly. Absent means off.
+         */
+        phrase_exact_match?: boolean;
         /** The request's `schema_version`, echoed back. */
         schema_version?: string;
     };
@@ -932,10 +938,18 @@ interface CoreOptions {
      */
     additionalContext?: Record<string, unknown>;
     /**
-     * BCP 47 language tag (e.g. `"es"`), sent with every suggestion request.
+     * BCP 47 language tag (e.g. `"es"`), sent with every suggestion request and telemetry event.
      * Default: the browser language (`navigator.language`), else `"en-US"`.
+     * Only an explicit value selects the SDK's own UI words (Spanish for `es`, English otherwise). The browser language does not.
      */
     language?: string;
+    /**
+     * Your product id. When set, what the dropdown offers before anything is
+     * typed is read from a cacheable URL for your product, with no credential,
+     * instead of a suggestion request; it falls back to a suggestion request
+     * when it cannot be read.
+     */
+    productId?: string;
     /**
      * Stable id for this visitor, kept by the host across page loads (e.g. a
      * first-party cookie). Rides on funnel telemetry so searches can be joined
@@ -1366,6 +1380,7 @@ declare class AIAutocomplete {
      */
     private fireImpression;
     private fireTelemetry;
+    private updateLanguageAttribute;
     private setupContainer;
     private buildAndRenderFull;
     private buildAndRenderDropdown;
@@ -2095,6 +2110,20 @@ interface RenderEditableArgs {
  */
 declare function renderEditableContent(args: RenderEditableArgs): void;
 
+declare const en: {
+    language: string;
+    proceed: string;
+    select: string;
+    skipHint: string;
+    skip: string;
+    skipLabel: string;
+    products: string;
+    soldOut: string;
+    submit: string;
+    scrollArrow: string;
+};
+type UIStrings = typeof en;
+
 /**
  * The "more below" arrow for the options grid.
  *
@@ -2285,7 +2314,7 @@ declare function buildQuery(text: string, completedParams: CompletedParamState[]
  * Pure computation — no DOM access. Shared by the vanilla renderer and the
  * React / Angular footer components so the wording can't drift between them.
  */
-declare function getFooterHint(optionHighlighted: boolean, isInputEmpty: boolean): {
+declare function getFooterHint(optionHighlighted: boolean, isInputEmpty: boolean, strings?: UIStrings): {
     key: string;
     hint: string;
 };