@askdialog/dialog-sdk 2.18.1 → 2.20.0

package/README.md

@@ -88,7 +88,7 @@ The optional `countryCode` (ISO 3166 alpha-2, e.g. `'FR'`, `'US'`) sets the regi
 The addToCart function is triggered when a user clicks the AddToCart button.
 The getProduct function is used to display product information in the assistant.
 
-`callbacks` is **optional**: a search-only integration can construct the client with just `apiKey` and `locale`. Only `getProduct()` and `addToCart()` require their callback — they throw an explicit configuration error when it is absent; every other feature works without callbacks.
+`callbacks` is **optional**: a search-only integration can construct the client with just `apiKey` and `locale`. Only `getProduct()`, `addToCart()`, `changeCartQuantity()` and `getCart()` require their callback — they throw an explicit configuration error when it is absent; every other feature works without callbacks.
 
 When the client is instantiated, it will automatically insert into the DOM the Dialog Assistant script, so you can interact with the assistant using `sendProductMessage` or `sendGenericMessage`. This assistant runtime always loads — it owns the shopper identity, consent handling and analytics bridge — while the heavy assistant UI stays lazy-loaded and is not fetched eagerly.
 
@@ -166,6 +166,33 @@ When set:
 
 Omit the flag (or set it to `false`) to keep the default behavior — the add-to-cart CTA and analytics are unchanged.
 
+### Reading the cart
+
+The assistant reads the shopper's cart (lines, total, currency) to suggest products that go with it. On storefronts where it cannot read the cart itself — for example a headless storefront — pass the optional `callbacks.getCart`:
+
+```ts
+new Dialog({
+  apiKey: 'YOUR_API_KEY',
+  locale: 'fr-FR', currency: 'EUR',
+  callbacks: {
+    addToCart, getProduct,
+    getCart: async (): Promise<CartSnapshot | null> => ({
+      lines: [
+        { productId: 'gid://shopify/Product/42', variantId: 'gid://shopify/ProductVariant/4242', quantity: 2, unitPrice: 12.5 },
+      ],
+      totalAmount: 25, // line items after cart discounts, excluding shipping
+      currency: 'EUR', // ISO 4217
+    }),
+  },
+});
+```
+
+- Amounts are in currency units (`12.5`, not cents); ids may be Shopify GIDs or raw ids, matching your product feed. Resolve `null` when the shopper has no cart.
+- `client.canReadCart()` tells whether the callback was provided; `client.getCart()` resolves your snapshot, and rejects with a configuration error when the callback is absent.
+- `getCart` is a read: `disableAddToCart` does not affect it.
+
+Omit it to keep the default behavior.
+
 ### Getters
 
 - apiKey
@@ -329,6 +356,7 @@ const controller = createSearchController({
     surface: 'search_page', // where results are displayed
     trackViewSearchResults: (params) => client.trackViewSearchResults(params),
     trackSelectSearchResult: (params) => client.trackSelectSearchResult(params),
+    trackOpenedSearch: (params) => client.trackOpenedSearch(params),
   },
   navigate: (url) => router.push(url), // optional platform routing adapter
   buildProductUrl: (hit) => `/products/${hit.handle}`, // optional, for hits without `url`
@@ -347,6 +375,8 @@ const unsubscribe = controller.subscribe((state) => {
   }
 });
 
+input.onfocus = () => controller.open(); // search opened
+closeButton.onclick = () => controller.close(); // reset without a request
 input.oninput = () => controller.setQuery(input.value); // debounced
 form.onsubmit = () => controller.submit(input.value); // immediate
 nextButton.onclick = () => controller.setPage(controller.getState().page + 1);
@@ -364,6 +394,8 @@ Analytics send each product hit's `id` (the product id) as `product_id`; `naviga
 Framework integrations:
 
 - Subscribe to state changes and render results.
+- Call `open()` when the search input gets focus. It emits `TRACK_OPENED_SEARCH` (`userId`, `surface`, `search_type`) on every focus; deduplication happens downstream.
+- Call `close()` when the shopper dismisses search, instead of `setQuery('')`, which runs the empty-query search. It cancels pending requests, emits impressions already qualified and resets the state to idle; the next `open()` runs the empty-query search again.
 - Call `observeResult(element, index)` for each result and `selectResult(index)` on selection. Use `{ navigate: false }` for middle-clicks and modified clicks. Call `preventDefault()` only when `selectResult` returns true.
 - Pass `navigate` for router navigation. The integration owns URL synchronization.
 - Create one controller per search surface and call `dispose()` on unmount.

package/dist/Dialog.d.ts

@@ -2,9 +2,10 @@ import { DialogConstructor } from "./types/constructor";
 import { Theme } from "./types/theme";
 import { DetailedLocaleInfo } from "./utils/localization";
 import { Suggestion } from "./types/suggestion";
-import { AddToCartInput, ChangeCartQuantityInput, GenericQuestionPayload, LegacyCheckoutParams, OpenAssistantPayload, OpenWithSuggestionsParams, ProductQuestionPayload, SubmitCheckoutParams } from "./types/events";
+import { DialogConfig } from "./types/dialogConfig";
+import { AddToCartInput, CartSnapshot, ChangeCartQuantityInput, GenericQuestionPayload, LegacyCheckoutParams, OpenAssistantPayload, OpenWithSuggestionsParams, ProductQuestionPayload, SubmitCheckoutParams } from "./types/events";
 import { SimplifiedProduct } from "./types/product";
-import { SelectSearchResultParams, ViewSearchResultsParams } from "./types/searchAnalytics";
+import { OpenedSearchParams, SelectSearchResultParams, ViewSearchResultsParams } from "./types/searchAnalytics";
 import { EventsHandler } from "./EventsHandler";
 import { SearchOptions, SearchRequest, SearchResponse } from "./types/search";
 import { AssistantEvent } from "./types/assistantEvent";
@@ -35,6 +36,8 @@ export declare class Dialog {
     getSuggestions(productId: string, options?: {
         limit?: number;
     }): Promise<Suggestion>;
+    /** The widget dialog config for this client's locale. */
+    getDialogConfig(): Promise<DialogConfig>;
     /**
      * Send one search request with names built by `searchIndexName`.
      * Cancel through `options.signal`. HTTP errors reject with `DialogSearchError`;
@@ -61,10 +64,14 @@ export declare class Dialog {
     addToCart(input: AddToCartInput): Promise<void>;
     canChangeCartQuantity(): boolean;
     changeCartQuantity(input: ChangeCartQuantityInput): Promise<void>;
+    canReadCart(): boolean;
+    getCart(): Promise<CartSnapshot | null>;
     private _isCartWriteDisabled;
     private _getCallbacksOrThrow;
     registerAddToCartEvent(input: AddToCartInput): void;
     registerSubmitCheckoutEvent(params: SubmitCheckoutParams | LegacyCheckoutParams): void;
+    /** Emit when the shopper opens search, e.g. focuses the search input. */
+    trackOpenedSearch(params: OpenedSearchParams): void;
     /**
      * Emit impressions batched by `createSearchImpressionTracker`.
      * Use `items: []` for an empty result set.

package/dist/Dialog.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Dialog.d.ts","sourceRoot":"","sources":["../src/Dialog.ts"],"names":[],"mappings":"AAIA,OAAO,EAIL,iBAAiB,EAClB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtC,OAAO,EACL,kBAAkB,EAEnB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EACL,cAAc,EACd,uBAAuB,EAEvB,sBAAsB,EACtB,oBAAoB,EACpB,oBAAoB,EACpB,yBAAyB,EACzB,sBAAsB,EACtB,oBAAoB,EACrB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EACL,wBAAwB,EACxB,uBAAuB,EACxB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAGhD,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAE9E,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD,qBAAa,MAAM;IACjB,gBAAuB,OAAO,SAAuB;IAErD,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,YAAY,CAAC,CAAS;IAE9B,OAAO,CAAC,UAAU,CAAC,CAAkB;IACrC,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,cAAc,CAAgB;IACtC,OAAO,CAAC,wBAAwB,CAAU;IAC1C,OAAO,CAAC,iBAAiB,CAAU;IACnC,OAAO,CAAC,iBAAiB,CAAC,CAAmB;IAC7C,OAAO,CAAC,eAAe,CAAC,CAAiB;gBAE7B,EACV,MAAM,EACN,MAAM,EACN,QAAQ,EACR,WAAW,EACX,SAAS,EACT,KAAK,EACL,MAAM,EACN,uBAAuB,EACvB,gBAAgB,EAChB,gBAAgB,EAChB,OAAO,GACR,EAAE,iBAAiB;IAyBpB,IAAW,MAAM,IAAI,MAAM,CAE1B;IACD,IAAW,KAAK,IAAI,KAAK,CAExB;IACD,IAAW,MAAM,IAAI,MAAM,CAE1B;IACD,IAAW,MAAM,IAAI,MAAM,CAE1B;IACD,IAAW,QAAQ,IAAI,MAAM,CAE5B;IACD,IAAW,aAAa,IAAI,aAAa,CAExC;IAEM,2BAA2B,IAAI,kBAAkB,GAAG,IAAI;IAI/D,OAAO,CAAC,uBAAuB;IAkB/B,kDAAkD;IACrC,cAAc,CACzB,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAC3B,OAAO,CAAC,UAAU,CAAC;IAStB;;;;OAIG;IACI,MAAM,CACX,OAAO,EAAE,aAAa,EACtB,OAAO,CAAC,EAAE,aAAa,GACtB,OAAO,CAAC,cAAc,CAAC;IAKnB,aAAa,CAAC,MAAM,EAAE,oBAAoB,GAAG,IAAI;IAIjD,4BAA4B,CAAC,EAClC,SAAS,EACT,OAAO,GACR,EAAE,yBAAyB,GAAG,IAAI;IAa5B,cAAc,IAAI,IAAI;IAI7B;;;OAGG;IACI,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI;IAYrE,OAAO,CAAC,MAAM,CAAC,iBAAiB;IAIhC,sDAAsD;IAC/C,mBAAmB,IAAI,IAAI;IAMlC,OAAO,CAAC,2BAA2B;IA2B5B,kBAAkB,CAAC,MAAM,EAAE,sBAAsB,GAAG,IAAI;IAIxD,kBAAkB,CAAC,MAAM,EAAE,sBAAsB,GAAG,IAAI;IAOxD,gBAAgB,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,GAAG,IAAI;IAIjE,sBAAsB,CAAC,KAAK,EAAE,cAAc,GAAG,IAAI;IAInD,UAAU,CACf,SAAS,EAAE,MAAM,EACjB,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,iBAAiB,CAAC;IAQhB,SAAS,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAUrD,qBAAqB,IAAI,OAAO;IAO1B,kBAAkB,CAC7B,KAAK,EAAE,uBAAuB,GAC7B,OAAO,CAAC,IAAI,CAAC;IAQhB,OAAO,CAAC,oBAAoB;IAY5B,OAAO,CAAC,oBAAoB;IAarB,sBAAsB,CAAC,KAAK,EAAE,cAAc,GAAG,IAAI;IASnD,2BAA2B,CAChC,MAAM,EAAE,oBAAoB,GAAG,oBAAoB,GAClD,IAAI;IA0BP;;;OAGG;IACI,sBAAsB,CAAC,MAAM,EAAE,uBAAuB,GAAG,IAAI;IAUpE,0FAA0F;IACnF,uBAAuB,CAAC,MAAM,EAAE,wBAAwB,GAAG,IAAI;IAUtE,OAAO,CAAC,cAAc;CAyCvB"}
+{"version":3,"file":"Dialog.d.ts","sourceRoot":"","sources":["../src/Dialog.ts"],"names":[],"mappings":"AAIA,OAAO,EAIL,iBAAiB,EAClB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtC,OAAO,EACL,kBAAkB,EAEnB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,EACL,cAAc,EACd,YAAY,EACZ,uBAAuB,EAEvB,sBAAsB,EACtB,oBAAoB,EACpB,oBAAoB,EACpB,yBAAyB,EACzB,sBAAsB,EACtB,oBAAoB,EACrB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EACL,kBAAkB,EAClB,wBAAwB,EACxB,uBAAuB,EACxB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAIhD,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAE9E,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD,qBAAa,MAAM;IACjB,gBAAuB,OAAO,SAAuB;IAErD,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,YAAY,CAAC,CAAS;IAE9B,OAAO,CAAC,UAAU,CAAC,CAAkB;IACrC,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,cAAc,CAAgB;IACtC,OAAO,CAAC,wBAAwB,CAAU;IAC1C,OAAO,CAAC,iBAAiB,CAAU;IACnC,OAAO,CAAC,iBAAiB,CAAC,CAAmB;IAC7C,OAAO,CAAC,eAAe,CAAC,CAAiB;gBAE7B,EACV,MAAM,EACN,MAAM,EACN,QAAQ,EACR,WAAW,EACX,SAAS,EACT,KAAK,EACL,MAAM,EACN,uBAAuB,EACvB,gBAAgB,EAChB,gBAAgB,EAChB,OAAO,GACR,EAAE,iBAAiB;IAyBpB,IAAW,MAAM,IAAI,MAAM,CAE1B;IACD,IAAW,KAAK,IAAI,KAAK,CAExB;IACD,IAAW,MAAM,IAAI,MAAM,CAE1B;IACD,IAAW,MAAM,IAAI,MAAM,CAE1B;IACD,IAAW,QAAQ,IAAI,MAAM,CAE5B;IACD,IAAW,aAAa,IAAI,aAAa,CAExC;IAEM,2BAA2B,IAAI,kBAAkB,GAAG,IAAI;IAI/D,OAAO,CAAC,uBAAuB;IAkB/B,kDAAkD;IACrC,cAAc,CACzB,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAC3B,OAAO,CAAC,UAAU,CAAC;IAStB,yDAAyD;IAClD,eAAe,IAAI,OAAO,CAAC,YAAY,CAAC;IAI/C;;;;OAIG;IACI,MAAM,CACX,OAAO,EAAE,aAAa,EACtB,OAAO,CAAC,EAAE,aAAa,GACtB,OAAO,CAAC,cAAc,CAAC;IAKnB,aAAa,CAAC,MAAM,EAAE,oBAAoB,GAAG,IAAI;IAIjD,4BAA4B,CAAC,EAClC,SAAS,EACT,OAAO,GACR,EAAE,yBAAyB,GAAG,IAAI;IAa5B,cAAc,IAAI,IAAI;IAI7B;;;OAGG;IACI,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI;IAYrE,OAAO,CAAC,MAAM,CAAC,iBAAiB;IAIhC,sDAAsD;IAC/C,mBAAmB,IAAI,IAAI;IAMlC,OAAO,CAAC,2BAA2B;IA2B5B,kBAAkB,CAAC,MAAM,EAAE,sBAAsB,GAAG,IAAI;IAIxD,kBAAkB,CAAC,MAAM,EAAE,sBAAsB,GAAG,IAAI;IAOxD,gBAAgB,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,GAAG,IAAI;IAIjE,sBAAsB,CAAC,KAAK,EAAE,cAAc,GAAG,IAAI;IAInD,UAAU,CACf,SAAS,EAAE,MAAM,EACjB,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,iBAAiB,CAAC;IAQhB,SAAS,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAUrD,qBAAqB,IAAI,OAAO;IAO1B,kBAAkB,CAC7B,KAAK,EAAE,uBAAuB,GAC7B,OAAO,CAAC,IAAI,CAAC;IAST,WAAW,IAAI,OAAO;IAIhB,OAAO,IAAI,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC;IAIpD,OAAO,CAAC,oBAAoB;IAY5B,OAAO,CAAC,oBAAoB;IAarB,sBAAsB,CAAC,KAAK,EAAE,cAAc,GAAG,IAAI;IASnD,2BAA2B,CAChC,MAAM,EAAE,oBAAoB,GAAG,oBAAoB,GAClD,IAAI;IA0BP,yEAAyE;IAClE,iBAAiB,CAAC,MAAM,EAAE,kBAAkB,GAAG,IAAI;IAO1D;;;OAGG;IACI,sBAAsB,CAAC,MAAM,EAAE,uBAAuB,GAAG,IAAI;IAUpE,0FAA0F;IACnF,uBAAuB,CAAC,MAAM,EAAE,wBAAwB,GAAG,IAAI;IAUtE,OAAO,CAAC,cAAc;CAyCvB"}

package/dist/Dialog.js

@@ -6,6 +6,7 @@ import { getDetailedLocaleInfo, } from "./utils/localization";
 import { ANONYMOUS_CUSTOMER_ID, CUSTOMER_ID } from "./constants/user";
 import { DialogEvents, } from "./types/events";
 import { EventsHandler } from "./EventsHandler";
+import { loadDialogConfig } from "./services/dialogConfig";
 import { loadSuggestions } from "./services/suggestions";
 import { searchLexical } from "./services/search";
 import { config } from "./config";
@@ -84,6 +85,10 @@ export class Dialog {
     async getSuggestions(productId, options) {
         return loadSuggestions(this._apiKey, this._locale, productId, options?.limit);
     }
+    /** The widget dialog config for this client's locale. */
+    getDialogConfig() {
+        return loadDialogConfig(this._apiKey, this._locale);
+    }
     /**
      * Send one search request with names built by `searchIndexName`.
      * Cancel through `options.signal`. HTTP errors reject with `DialogSearchError`;
@@ -186,6 +191,13 @@ export class Dialog {
             return;
         await this._getCallbacksOrThrow("changeCartQuantity").changeCartQuantity(input);
     }
+    // A read, not a write: `disableAddToCart` does not gate it.
+    canReadCart() {
+        return this._callbacks?.getCart !== undefined;
+    }
+    async getCart() {
+        return this._getCallbacksOrThrow("getCart").getCart();
+    }
     _isCartWriteDisabled(operation) {
         if (!this._disableAddToCart)
             return false;
@@ -228,6 +240,13 @@ export class Dialog {
             currency: params.currency,
         });
     }
+    /** Emit when the shopper opens search, e.g. focuses the search input. */
+    trackOpenedSearch(params) {
+        this._eventsHandler.emitExternalEvent(DialogEvents.TRACK_OPENED_SEARCH, {
+            userId: this._userId,
+            ...params,
+        });
+    }
     /**
      * Emit impressions batched by `createSearchImpressionTracker`.
      * Use `items: []` for an empty result set.

package/dist/EventsHandler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EventsHandler.d.ts","sourceRoot":"","sources":["../src/EventsHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,qBAAqB,EACrB,aAAa,EAEb,4BAA4B,EAC7B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAuB,WAAW,EAAgB,MAAM,gBAAgB,CAAC;AAiBhF,qBAAa,aAAa;IACxB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,eAAe,CAAuB;gBAElC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM;IAKpC,iBAAiB,CACtB,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC,EACzB,OAAO,CAAC,EAAE,WAAW,CAAC,SAAS,CAAC,GAC/B,IAAI;IAYA,mBAAmB,IAAI,IAAI;IAU3B,kBAAkB,IAAI,IAAI;IAIjC,OAAO,CAAC,sBAAsB;IAWvB,kBAAkB,CACvB,IAAI,EAAE,cAAc,CAAC,MAAM,CAAC,EAC5B,OAAO,CAAC,EAAE,4BAA4B,GACrC,IAAI;IAQA,gBAAgB,CACrB,QAAQ,EAAE,CACR,KAAK,EAAE,cAAc,CAAC,aAAa,GAAG,qBAAqB,CAAC,KACzD,IAAI,GACR,MAAM,IAAI;CA0Bd"}
+{"version":3,"file":"EventsHandler.d.ts","sourceRoot":"","sources":["../src/EventsHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,qBAAqB,EACrB,aAAa,EAEb,4BAA4B,EAC7B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAuB,WAAW,EAAgB,MAAM,gBAAgB,CAAC;AAkBhF,qBAAa,aAAa;IACxB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,eAAe,CAAuB;gBAElC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM;IAKpC,iBAAiB,CACtB,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC,EACzB,OAAO,CAAC,EAAE,WAAW,CAAC,SAAS,CAAC,GAC/B,IAAI;IAYA,mBAAmB,IAAI,IAAI;IAU3B,kBAAkB,IAAI,IAAI;IAIjC,OAAO,CAAC,sBAAsB;IAWvB,kBAAkB,CACvB,IAAI,EAAE,cAAc,CAAC,MAAM,CAAC,EAC5B,OAAO,CAAC,EAAE,4BAA4B,GACrC,IAAI;IAQA,gBAAgB,CACrB,QAAQ,EAAE,CACR,KAAK,EAAE,cAAc,CAAC,aAAa,GAAG,qBAAqB,CAAC,KACzD,IAAI,GACR,MAAM,IAAI;CA0Bd"}

package/dist/EventsHandler.js

@@ -6,6 +6,7 @@ import { DIALOG_CUSTOM_EVENT, DialogEvents } from "./types/events";
 const BUFFERED_EVENT_TYPES = new Set([
     DialogEvents.TRACK_ADD_TO_CART,
     DialogEvents.TRACK_SUBMIT_CHECKOUT,
+    DialogEvents.TRACK_OPENED_SEARCH,
     DialogEvents.TRACK_VIEW_SEARCH_RESULTS,
     DialogEvents.TRACK_SELECT_SEARCH_RESULT,
 ]);

package/dist/__tests__/dialogGetCart.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=dialogGetCart.spec.d.ts.map

package/dist/__tests__/dialogGetCart.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dialogGetCart.spec.d.ts","sourceRoot":"","sources":["../../src/__tests__/dialogGetCart.spec.ts"],"names":[],"mappings":""}

package/dist/__tests__/dialogGetCart.spec.js

@@ -0,0 +1,50 @@
+import { describe, expect, it, vi } from "vitest";
+import { Dialog } from "../Dialog";
+const buildDialog = (getCart, disableAddToCart = false) => {
+    const dialog = Object.create(Dialog.prototype);
+    Object.assign(dialog, {
+        _callbacks: {
+            addToCart: vi.fn(),
+            getProduct: vi.fn(),
+            ...(getCart === undefined ? {} : { getCart }),
+        },
+        _disableAddToCart: disableAddToCart,
+    });
+    return dialog;
+};
+const snapshot = {
+    lines: [
+        {
+            productId: "gid://shopify/Product/42",
+            variantId: "gid://shopify/ProductVariant/4242",
+            quantity: 2,
+            unitPrice: 12.5,
+        },
+    ],
+    totalAmount: 25,
+    currency: "EUR",
+};
+describe("Dialog.getCart", () => {
+    it("resolves the merchant's snapshot", async () => {
+        const getCart = vi.fn().mockResolvedValue(snapshot);
+        const dialog = buildDialog(getCart);
+        await expect(dialog.getCart()).resolves.toEqual(snapshot);
+        expect(getCart).toHaveBeenCalledOnce();
+        expect(dialog.canReadCart()).toBe(true);
+    });
+    it("resolves null when the merchant has no cart", async () => {
+        const dialog = buildDialog(vi.fn().mockResolvedValue(null));
+        await expect(dialog.getCart()).resolves.toBeNull();
+    });
+    it("rejects with an explicit configuration error without the callback", async () => {
+        const dialog = buildDialog(undefined);
+        await expect(dialog.getCart()).rejects.toThrowError(/callbacks\.getCart/);
+        expect(dialog.canReadCart()).toBe(false);
+    });
+    it("is not affected by disableAddToCart", async () => {
+        const getCart = vi.fn().mockResolvedValue(snapshot);
+        const dialog = buildDialog(getCart, true);
+        await expect(dialog.getCart()).resolves.toEqual(snapshot);
+        expect(dialog.canReadCart()).toBe(true);
+    });
+});

package/dist/__tests__/publicTypes.spec.js

@@ -10,6 +10,8 @@ describe("public API types", () => {
         expectTypeOf().not.toMatchTypeOf();
         expectTypeOf().toMatchTypeOf();
         expectTypeOf().parameters.toMatchTypeOf();
+        expectTypeOf().returns.toEqualTypeOf();
+        expectTypeOf().toEqualTypeOf();
         expectTypeOf().toEqualTypeOf();
         expectTypeOf().parameters.toMatchTypeOf();
         expectTypeOf().toMatchTypeOf();

package/dist/__tests__/searchController.spec.js

@@ -1,4 +1,4 @@
-/* eslint max-lines: ["error", 490] */
+/* eslint max-lines: ["error", 530] */
 import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
 import { createSearchController } from "../searchController";
 import { SearchStatus } from "../types/searchController";
@@ -224,16 +224,40 @@ describe("createSearchController", () => {
         await settle();
         expect(controller.getState().status).toBe(SearchStatus.EMPTY);
     });
-    it("resets to idle and invalidates in-flight work when the query gets too short", async () => {
+    it("runs the empty-query products search on open and tracks it with query_length 0", async () => {
+        const controller = createSearchController({
+            search,
+            language: "fr",
+            country: "FR",
+            sections: [{ index: "collections" }],
+            analytics: {
+                surface: "autocomplete",
+                trackViewSearchResults,
+                trackSelectSearchResult,
+            },
+        });
+        search.mockResolvedValue(response({ query: "" }));
+        controller.open();
+        await settle();
+        controller.open();
+        controller.selectResult(0, { navigate: false });
+        expect(search).toHaveBeenCalledTimes(1);
+        expect(search.mock.calls[0][0].requests).toEqual([
+            { indexName: "products_fr_fr", query: "", page: 0, hitsPerPage: 12 },
+        ]);
+        expect(controller.getState()).toMatchObject({
+            status: SearchStatus.SUCCESS,
+            query: "",
+        });
+        expect(trackSelectSearchResult).toHaveBeenCalledWith(expect.objectContaining({ query_length: 0 }));
+    });
+    it("searches from the first character after the debounce", async () => {
         const controller = createController();
-        const inFlight = deferred();
-        search.mockReturnValueOnce(inFlight.promise);
-        controller.submit("shoes");
+        search.mockResolvedValue(response({ query: "s" }));
         controller.setQuery("s");
-        inFlight.resolve(response());
+        vi.advanceTimersByTime(DEBOUNCE_MS);
         await settle();
-        expect(search).toHaveBeenCalledTimes(1);
-        expect(controller.getState().status).toBe(SearchStatus.IDLE);
+        expect(search.mock.calls[0][0].requests[0]).toMatchObject({ query: "s" });
     });
     it("resets pagination when a new query is submitted", async () => {
         const controller = createController();

package/dist/searchController.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchController.d.ts","sourceRoot":"","sources":["../src/searchController.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,gBAAgB,EAChB,uBAAuB,EAGxB,MAAM,0BAA0B,CAAC;AASlC,wBAAgB,sBAAsB,CAAC,EACrC,MAAM,EACN,QAAQ,EACR,OAAO,EACP,SAAS,EACT,QAAQ,EACR,eAAe,EACf,UAAgB,EAChB,WAAgB,EAChB,QAAa,GACd,EAAE,uBAAuB,GAAG,gBAAgB,CA4K5C"}
+{"version":3,"file":"searchController.d.ts","sourceRoot":"","sources":["../src/searchController.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,gBAAgB,EAChB,uBAAuB,EAGxB,MAAM,0BAA0B,CAAC;AASlC,wBAAgB,sBAAsB,CAAC,EACrC,MAAM,EACN,QAAQ,EACR,OAAO,EACP,SAAS,EACT,QAAQ,EACR,eAAe,EACf,UAAgB,EAChB,WAAgB,EAChB,QAAa,GACd,EAAE,uBAAuB,GAAG,gBAAgB,CA6K5C"}

package/dist/searchController.js

@@ -1,7 +1,7 @@
 import { searchIndexName } from "./services/search";
 import { SearchStatus, } from "./types/searchController";
 import { createControllerAnalytics } from "./utils/searchControllerAnalytics";
-import { buildSearchRequest, INITIAL_SEARCH_STATE, normalizeQuery, readSearchResults, } from "./utils/searchRequests";
+import { buildSearchRequest, INITIAL_SEARCH_STATE, readSearchResults, requestedSections, } from "./utils/searchRequests";
 export function createSearchController({ search, language, country, analytics, navigate, buildProductUrl, debounceMs = 100, hitsPerPage = 12, sections = [], }) {
     const requestConfig = {
         indexName: searchIndexName("products", language, country),
@@ -32,12 +32,15 @@ export function createSearchController({ search, language, country, analytics, n
         abortController = undefined;
     };
     const run = async (query, page) => {
+        if (disposed) {
+            return;
+        }
         cancelPendingSearch();
         abortController = new AbortController();
         const id = requestId;
         setState({ status: SearchStatus.LOADING, query, page });
         try {
-            const requested = typeof sections === "function" ? sections() : sections;
+            const requested = requestedSections(query, sections);
             const request = buildSearchRequest(query, page, requested, requestConfig);
             const response = await search(request, {
                 signal: abortController.signal,
@@ -56,11 +59,9 @@ export function createSearchController({ search, language, country, analytics, n
             });
         }
         catch (error) {
-            if (error instanceof DOMException && error.name === "AbortError") {
-                return; // Cancellation is not a search error.
-            }
-            if (id !== requestId) {
-                return;
+            const aborted = error instanceof DOMException && error.name === "AbortError";
+            if (aborted || id !== requestId) {
+                return; // Cancellation and superseded requests are not search errors.
             }
             setState({
                 status: SearchStatus.ERROR,
@@ -76,37 +77,21 @@ export function createSearchController({ search, language, country, analytics, n
                 return;
             }
             cancelPendingSearch();
-            const query = normalizeQuery(rawQuery);
-            if (query === undefined) {
-                setState(INITIAL_SEARCH_STATE);
-                return;
-            }
+            const query = rawQuery.trim();
             pendingQuery = query;
             debounceTimer = setTimeout(() => void run(query, 0), debounceMs);
         },
         submit(rawQuery) {
-            if (disposed) {
-                return;
-            }
-            cancelPendingSearch();
-            const query = normalizeQuery(rawQuery);
-            if (query === undefined) {
-                setState(INITIAL_SEARCH_STATE);
-                return;
-            }
-            void run(query, 0);
+            void run(rawQuery.trim(), 0);
         },
         setPage(page) {
-            if (disposed) {
-                return;
-            }
             if (pendingQuery !== undefined) {
                 // Submit pending input on page zero before allowing pagination.
                 void run(pendingQuery, 0);
                 return;
             }
-            if (state.query === "") {
-                return; // No query to paginate.
+            if (state.status === SearchStatus.IDLE) {
+                return; // No search to paginate.
             }
             void run(state.query, page);
         },
@@ -144,6 +129,20 @@ export function createSearchController({ search, language, country, analytics, n
             };
         },
         getState: () => state,
+        open() {
+            controllerAnalytics.open();
+            if ((state.status === SearchStatus.IDLE ||
+                state.status === SearchStatus.ERROR) &&
+                state.query === "" &&
+                pendingQuery === undefined) {
+                void run("", 0);
+            }
+        },
+        close() {
+            cancelPendingSearch();
+            controllerAnalytics.close();
+            setState(INITIAL_SEARCH_STATE);
+        },
         dispose() {
             disposed = true;
             cancelPendingSearch();

package/dist/services/dialogConfig.d.ts

@@ -0,0 +1,3 @@
+import { DialogConfig } from "../types/dialogConfig";
+export declare const loadDialogConfig: (apiKey: string, locale: string) => Promise<DialogConfig>;
+//# sourceMappingURL=dialogConfig.d.ts.map

package/dist/services/dialogConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dialogConfig.d.ts","sourceRoot":"","sources":["../../src/services/dialogConfig.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAKrD,eAAO,MAAM,gBAAgB,GAC3B,QAAQ,MAAM,EACd,QAAQ,MAAM,KACb,OAAO,CAAC,YAAY,CAWtB,CAAC"}

package/dist/services/dialogConfig.js

@@ -0,0 +1,11 @@
+import { config } from "../config";
+const DIALOG_CONFIG_PATH = "/widget/dialog-config";
+const API_KEY_HEADER = "x-dialog-api-key";
+export const loadDialogConfig = async (apiKey, locale) => {
+    const query = new URLSearchParams({ locale });
+    const response = await fetch(`${config.monolithApiUrl}${DIALOG_CONFIG_PATH}?${query.toString()}`, { headers: { [API_KEY_HEADER]: apiKey } });
+    if (!response.ok) {
+        throw new Error(`Dialog config request failed (${response.status}).`);
+    }
+    return (await response.json());
+};

package/dist/types/constructor.d.ts

@@ -1,10 +1,12 @@
-import { AddToCartInput, ChangeCartQuantityInput } from "./events";
+import { AddToCartInput, CartSnapshot, ChangeCartQuantityInput } from "./events";
 import { SimplifiedProduct } from "./product";
 import { Theme } from "./theme";
 export interface DialogCallbacks {
     addToCart: (input: AddToCartInput) => Promise<void>;
     getProduct: (productId: string, variantId?: string) => Promise<SimplifiedProduct>;
     changeCartQuantity?: (input: ChangeCartQuantityInput) => Promise<void>;
+    /** Resolves the shopper's current cart, or `null` when there is none. */
+    getCart?: () => Promise<CartSnapshot | null>;
 }
 export interface CurrentProduct {
     /** The catalog product id — must match the id in the Dialog product feed. */
@@ -26,10 +28,11 @@ export interface DialogConstructor {
     countryCode?: string;
     /**
      * Commerce callbacks. Optional: a search-only integration can omit them —
-     * the assistant runtime still loads, and `getProduct()`, `addToCart()` and
-     * `changeCartQuantity()` throw a configuration error when their callback is
-     * absent. `changeCartQuantity` is optional within the set: check
-     * `canChangeCartQuantity()` before calling it.
+     * the assistant runtime still loads, and `getProduct()`, `addToCart()`,
+     * `changeCartQuantity()` and `getCart()` throw a configuration error when
+     * their callback is absent. `changeCartQuantity` and `getCart` are optional
+     * within the set: check `canChangeCartQuantity()` / `canReadCart()` before
+     * calling them.
      */
     callbacks?: DialogCallbacks;
     theme?: Partial<Theme>;

package/dist/types/constructor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constructor.d.ts","sourceRoot":"","sources":["../../src/types/constructor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,uBAAuB,EAAE,MAAM,UAAU,CAAC;AACnE,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACpD,UAAU,EAAE,CACV,SAAS,EAAE,MAAM,EACjB,SAAS,CAAC,EAAE,MAAM,KACf,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAChC,kBAAkB,CAAC,EAAE,CAAC,KAAK,EAAE,uBAAuB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACxE;AAED,MAAM,WAAW,cAAc;IAC7B,6EAA6E;IAC7E,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,gBAAgB,GAAG,SAAS,CAAC;AAEzC,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,mCAAmC;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,oDAAoD;IACpD,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B,KAAK,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;;OAMG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;;;;;OAQG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B"}
+{"version":3,"file":"constructor.d.ts","sourceRoot":"","sources":["../../src/types/constructor.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,YAAY,EACZ,uBAAuB,EACxB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACpD,UAAU,EAAE,CACV,SAAS,EAAE,MAAM,EACjB,SAAS,CAAC,EAAE,MAAM,KACf,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAChC,kBAAkB,CAAC,EAAE,CAAC,KAAK,EAAE,uBAAuB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACvE,yEAAyE;IACzE,OAAO,CAAC,EAAE,MAAM,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;CAC9C;AAED,MAAM,WAAW,cAAc;IAC7B,6EAA6E;IAC7E,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,gBAAgB,GAAG,SAAS,CAAC;AAEzC,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,mCAAmC;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,oDAAoD;IACpD,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B,KAAK,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;;OAMG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;;;;;OAQG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B"}

package/dist/types/dialogConfig.d.ts

@@ -0,0 +1,7 @@
+export type SearchBusinessRanking = "best_sellers" | "newest" | "price_asc" | "price_desc";
+/** The part of the widget dialog config the SDK reads. */
+export interface DialogConfig {
+    /** Absent when the merchant chose no business ranking. */
+    searchBusinessRanking?: SearchBusinessRanking;
+}
+//# sourceMappingURL=dialogConfig.d.ts.map

package/dist/types/dialogConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dialogConfig.d.ts","sourceRoot":"","sources":["../../src/types/dialogConfig.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,qBAAqB,GAC7B,cAAc,GACd,QAAQ,GACR,WAAW,GACX,YAAY,CAAC;AAEjB,0DAA0D;AAC1D,MAAM,WAAW,YAAY;IAC3B,0DAA0D;IAC1D,qBAAqB,CAAC,EAAE,qBAAqB,CAAC;CAC/C"}

package/dist/types/dialogConfig.js

@@ -0,0 +1 @@
+export {};

package/dist/types/events.d.ts

@@ -1,4 +1,4 @@
-import { SelectSearchResultEventPayload, ViewSearchResultsEventPayload } from "./searchAnalytics";
+import { OpenedSearchEventPayload, SelectSearchResultEventPayload, ViewSearchResultsEventPayload } from "./searchAnalytics";
 export declare const DIALOG_CUSTOM_EVENT = "enableDialogAssistantEvent";
 export declare enum DialogEvents {
     OPEN_ASSISTANT = "open_assistant",
@@ -8,6 +8,7 @@ export declare enum DialogEvents {
     SEND_GENERIC_QUESTION = "GENERIC_QUESTION",
     TRACK_ADD_TO_CART = "TRACK_ADD_TO_CART",
     TRACK_SUBMIT_CHECKOUT = "TRACK_SUBMIT_CHECKOUT",
+    TRACK_OPENED_SEARCH = "TRACK_OPENED_SEARCH",
     TRACK_VIEW_SEARCH_RESULTS = "TRACK_VIEW_SEARCH_RESULTS",
     TRACK_SELECT_SEARCH_RESULT = "TRACK_SELECT_SEARCH_RESULT"
 }
@@ -78,6 +79,19 @@ export interface ChangeCartQuantityInput {
     variantId?: string;
     quantity: number;
 }
+export interface CartSnapshotLine {
+    productId: string;
+    variantId: string;
+    quantity: number;
+    unitPrice: number;
+}
+export interface CartSnapshot {
+    lines: CartSnapshotLine[];
+    /** Line items after cart discounts, excluding shipping. */
+    totalAmount: number;
+    /** ISO 4217. */
+    currency: string;
+}
 export interface TrackEventPayload extends AddToCartProductDetails {
     userId?: string;
     productId: string;
@@ -117,7 +131,7 @@ export interface LegacyCheckoutParams {
     currency?: string;
     variantId?: string;
 }
-export type DialogEventPayload = ProductQuestionPayload | GenericQuestionPayload | DiagnosticPayload | OpenAssistantPayload | OpenWithSuggestionsPayload | TrackEventPayload | SubmitCheckoutEventPayload | ViewSearchResultsEventPayload | SelectSearchResultEventPayload;
+export type DialogEventPayload = ProductQuestionPayload | GenericQuestionPayload | DiagnosticPayload | OpenAssistantPayload | OpenWithSuggestionsPayload | TrackEventPayload | SubmitCheckoutEventPayload | OpenedSearchEventPayload | ViewSearchResultsEventPayload | SelectSearchResultEventPayload;
 export interface DialogEvent<T = DialogEventPayload> {
     type: DialogEvents;
     payload: T;

package/dist/types/events.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/types/events.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,8BAA8B,EAC9B,6BAA6B,EAC9B,MAAM,mBAAmB,CAAC;AAE3B,eAAO,MAAM,mBAAmB,+BAA+B,CAAC;AAEhE,oBAAY,YAAY;IACtB,cAAc,mBAAmB;IACjC,qBAAqB,0BAA0B;IAC/C,eAAe,oBAAoB;IACnC,YAAY,qBAAqB;IACjC,qBAAqB,qBAAqB;IAC1C,iBAAiB,sBAAsB;IACvC,qBAAqB,0BAA0B;IAC/C,yBAAyB,8BAA8B;IACvD,0BAA0B,+BAA+B;CAC1D;AACD,MAAM,WAAW,sBAAsB;IACrC,QAAQ,EAAE,MAAM,CAAC;CAClB;AACD,MAAM,WAAW,sBAAuB,SAAQ,sBAAsB;IACpE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,yBAAyB;IACxC,SAAS,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAClC,OAAO,CAAC,EAAE,kBAAkB,CAAC;CAC9B;AAED,MAAM,WAAW,0BAA0B;IACzC,WAAW,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACpC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,MAAM,oBAAoB,GAAG,mBAAmB,GAAG,cAAc,CAAC;AAExE,MAAM,WAAW,iBAAiB;IAChC,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,UAAU,EAAE,oBAAoB,CAAC;IACjC,GAAG,EAAE,MAAM,CAAC;CACb;AAQD,MAAM,WAAW,uBAAuB;IACtC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAKD,MAAM,WAAW,cAAe,SAAQ,uBAAuB;IAC7D,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,uBAAuB;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAQD,MAAM,WAAW,iBAAkB,SAAQ,uBAAuB;IAChE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAKD,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAOD,MAAM,WAAW,0BAA0B;IACzC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,gBAAgB,EAAE,CAAC;CAC5B;AAGD,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,gBAAgB,EAAE,CAAC;CAC5B;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,kBAAkB,GAC1B,sBAAsB,GACtB,sBAAsB,GACtB,iBAAiB,GACjB,oBAAoB,GACpB,0BAA0B,GAC1B,iBAAiB,GACjB,0BAA0B,GAC1B,6BAA6B,GAC7B,8BAA8B,CAAC;AAEnC,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,kBAAkB;IACjD,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,EAAE,CAAC,CAAC;CACZ"}
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/types/events.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,wBAAwB,EACxB,8BAA8B,EAC9B,6BAA6B,EAC9B,MAAM,mBAAmB,CAAC;AAE3B,eAAO,MAAM,mBAAmB,+BAA+B,CAAC;AAEhE,oBAAY,YAAY;IACtB,cAAc,mBAAmB;IACjC,qBAAqB,0BAA0B;IAC/C,eAAe,oBAAoB;IACnC,YAAY,qBAAqB;IACjC,qBAAqB,qBAAqB;IAC1C,iBAAiB,sBAAsB;IACvC,qBAAqB,0BAA0B;IAC/C,mBAAmB,wBAAwB;IAC3C,yBAAyB,8BAA8B;IACvD,0BAA0B,+BAA+B;CAC1D;AACD,MAAM,WAAW,sBAAsB;IACrC,QAAQ,EAAE,MAAM,CAAC;CAClB;AACD,MAAM,WAAW,sBAAuB,SAAQ,sBAAsB;IACpE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,yBAAyB;IACxC,SAAS,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAClC,OAAO,CAAC,EAAE,kBAAkB,CAAC;CAC9B;AAED,MAAM,WAAW,0BAA0B;IACzC,WAAW,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACpC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,MAAM,oBAAoB,GAAG,mBAAmB,GAAG,cAAc,CAAC;AAExE,MAAM,WAAW,iBAAiB;IAChC,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,UAAU,EAAE,oBAAoB,CAAC;IACjC,GAAG,EAAE,MAAM,CAAC;CACb;AAQD,MAAM,WAAW,uBAAuB;IACtC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAKD,MAAM,WAAW,cAAe,SAAQ,uBAAuB;IAC7D,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,uBAAuB;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAID,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,gBAAgB,EAAE,CAAC;IAC1B,2DAA2D;IAC3D,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAQD,MAAM,WAAW,iBAAkB,SAAQ,uBAAuB;IAChE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAKD,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAOD,MAAM,WAAW,0BAA0B;IACzC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,gBAAgB,EAAE,CAAC;CAC5B;AAGD,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,gBAAgB,EAAE,CAAC;CAC5B;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,kBAAkB,GAC1B,sBAAsB,GACtB,sBAAsB,GACtB,iBAAiB,GACjB,oBAAoB,GACpB,0BAA0B,GAC1B,iBAAiB,GACjB,0BAA0B,GAC1B,wBAAwB,GACxB,6BAA6B,GAC7B,8BAA8B,CAAC;AAEnC,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,kBAAkB;IACjD,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,EAAE,CAAC,CAAC;CACZ"}

package/dist/types/events.js

@@ -8,6 +8,7 @@ export var DialogEvents;
     DialogEvents["SEND_GENERIC_QUESTION"] = "GENERIC_QUESTION";
     DialogEvents["TRACK_ADD_TO_CART"] = "TRACK_ADD_TO_CART";
     DialogEvents["TRACK_SUBMIT_CHECKOUT"] = "TRACK_SUBMIT_CHECKOUT";
+    DialogEvents["TRACK_OPENED_SEARCH"] = "TRACK_OPENED_SEARCH";
     DialogEvents["TRACK_VIEW_SEARCH_RESULTS"] = "TRACK_VIEW_SEARCH_RESULTS";
     DialogEvents["TRACK_SELECT_SEARCH_RESULT"] = "TRACK_SELECT_SEARCH_RESULT";
 })(DialogEvents || (DialogEvents = {}));

package/dist/types/index.d.ts

@@ -7,4 +7,5 @@ export * from "./search";
 export * from "./searchAnalytics";
 export * from "./searchController";
 export * from "./assistantEvent";
+export * from "./dialogConfig";
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC;AACzB,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC;AACzB,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC"}

package/dist/types/index.js

@@ -7,3 +7,4 @@ export * from "./search";
 export * from "./searchAnalytics";
 export * from "./searchController";
 export * from "./assistantEvent";
+export * from "./dialogConfig";

package/dist/types/searchAnalytics.d.ts

@@ -17,6 +17,11 @@ export interface SearchAnalyticsEnvelope {
     /** Number of code points in the trimmed query. */
     query_length: number;
 }
+/** The shopper opened search (focused the search input). */
+export interface OpenedSearchParams {
+    surface: SearchSurface;
+    search_type: SearchType;
+}
 /** Position is one-based across pages: page 2 at 20 hits/page starts at 21. */
 export interface SearchResultItem {
     product_id: string;
@@ -39,4 +44,7 @@ export interface ViewSearchResultsEventPayload extends ViewSearchResultsParams {
 export interface SelectSearchResultEventPayload extends SelectSearchResultParams {
     userId?: string;
 }
+export interface OpenedSearchEventPayload extends OpenedSearchParams {
+    userId?: string;
+}
 //# sourceMappingURL=searchAnalytics.d.ts.map

package/dist/types/searchAnalytics.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchAnalytics.d.ts","sourceRoot":"","sources":["../../src/types/searchAnalytics.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,eAAe,uEAKlB,CAAC;AAEX,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;AAE7D,eAAO,MAAM,YAAY,sBAAuB,CAAC;AAEjD,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC;AAEvD,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,wDAAwD;IACxD,KAAK,EAAE,MAAM,CAAC;IACd,yCAAyC;IACzC,OAAO,EAAE,aAAa,CAAC;IACvB,6CAA6C;IAC7C,WAAW,EAAE,UAAU,CAAC;IACxB,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,mCAAmC;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,kDAAkD;IAClD,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,+EAA+E;AAC/E,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAwB,SAAQ,uBAAuB;IACtE,KAAK,EAAE,gBAAgB,EAAE,CAAC;CAC3B;AAED,qCAAqC;AACrC,MAAM,WAAW,wBAAyB,SAAQ,uBAAuB;IACvE,KAAK,EAAE,CAAC,gBAAgB,CAAC,CAAC;CAC3B;AAGD,MAAM,WAAW,6BAA8B,SAAQ,uBAAuB;IAC5E,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,8BACf,SAAQ,wBAAwB;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}
+{"version":3,"file":"searchAnalytics.d.ts","sourceRoot":"","sources":["../../src/types/searchAnalytics.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,eAAe,uEAKlB,CAAC;AAEX,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;AAE7D,eAAO,MAAM,YAAY,sBAAuB,CAAC;AAEjD,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC;AAEvD,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,wDAAwD;IACxD,KAAK,EAAE,MAAM,CAAC;IACd,yCAAyC;IACzC,OAAO,EAAE,aAAa,CAAC;IACvB,6CAA6C;IAC7C,WAAW,EAAE,UAAU,CAAC;IACxB,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,mCAAmC;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,kDAAkD;IAClD,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,4DAA4D;AAC5D,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,aAAa,CAAC;IACvB,WAAW,EAAE,UAAU,CAAC;CACzB;AAED,+EAA+E;AAC/E,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAwB,SAAQ,uBAAuB;IACtE,KAAK,EAAE,gBAAgB,EAAE,CAAC;CAC3B;AAED,qCAAqC;AACrC,MAAM,WAAW,wBAAyB,SAAQ,uBAAuB;IACvE,KAAK,EAAE,CAAC,gBAAgB,CAAC,CAAC;CAC3B;AAGD,MAAM,WAAW,6BAA8B,SAAQ,uBAAuB;IAC5E,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,8BACf,SAAQ,wBAAwB;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,wBAAyB,SAAQ,kBAAkB;IAClE,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}

package/dist/types/searchController.d.ts

@@ -1,5 +1,5 @@
 import { SearchIndex, SearchOptions, SearchProductHit, SearchRequest, SearchResponse, SearchResult, SearchSections } from "./search";
-import { SearchSurface, SelectSearchResultParams, ViewSearchResultsParams } from "./searchAnalytics";
+import { OpenedSearchParams, SearchSurface, SelectSearchResultParams, ViewSearchResultsParams } from "./searchAnalytics";
 export declare const SearchStatus: {
     readonly IDLE: "idle";
     readonly LOADING: "loading";
@@ -15,7 +15,7 @@ export interface SearchSection {
 }
 export interface SearchControllerState {
     status: SearchStatus;
-    /** Last submitted query, excluding pending input. */
+    /** Last submitted query, excluding pending input; `""` once the empty-query results run. */
     query: string;
     /** Zero-based page of the last request. */
     page: number;
@@ -30,6 +30,8 @@ export interface SearchControllerAnalytics {
     surface: SearchSurface;
     trackViewSearchResults: (params: ViewSearchResultsParams) => void;
     trackSelectSearchResult: (params: SelectSearchResultParams) => void;
+    /** Called by `open()`; optional so existing custom adapters keep compiling. */
+    trackOpenedSearch?: (params: OpenedSearchParams) => void;
 }
 export interface SearchControllerOptions {
     /** Search function bound to its client, or a custom transport. */
@@ -49,7 +51,17 @@ export interface SearchControllerOptions {
 }
 /** Manage search requests, pagination and analytics independently of rendering. */
 export interface SearchController {
-    /** Submit after the debounce delay. */
+    /**
+     * Record that the shopper opened search; call it when the search input gets focus.
+     * With no query yet, it runs the empty-query products search.
+     */
+    open(): void;
+    /**
+     * Close search without a request: cancel pending and in-flight searches,
+     * flush qualified impressions and reset the state to idle with an empty query.
+     */
+    close(): void;
+    /** Submit after the debounce delay; an empty query runs the empty-query search. */
     setQuery(rawQuery: string): void;
     /** Submit immediately. */
     submit(rawQuery: string): void;

package/dist/types/searchController.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchController.d.ts","sourceRoot":"","sources":["../../src/types/searchController.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,aAAa,EACb,gBAAgB,EAChB,aAAa,EACb,cAAc,EACd,YAAY,EACZ,cAAc,EACf,MAAM,UAAU,CAAC;AAClB,OAAO,EACL,aAAa,EACb,wBAAwB,EACxB,uBAAuB,EACxB,MAAM,mBAAmB,CAAC;AAE3B,eAAO,MAAM,YAAY;;;;IAIvB,yCAAyC;;;CAGjC,CAAC;AAEX,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAE5E,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,OAAO,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;IACxC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,YAAY,CAAC;IACrB,qDAAqD;IACrD,KAAK,EAAE,MAAM,CAAC;IACd,2CAA2C;IAC3C,IAAI,EAAE,MAAM,CAAC;IACb,kFAAkF;IAClF,QAAQ,CAAC,EAAE,YAAY,CAAC,gBAAgB,CAAC,CAAC;IAC1C,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,MAAM,cAAc,GAAG,CAC3B,OAAO,EAAE,aAAa,EACtB,OAAO,CAAC,EAAE,aAAa,KACpB,OAAO,CAAC,cAAc,CAAC,CAAC;AAE7B,qFAAqF;AACrF,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,aAAa,CAAC;IACvB,sBAAsB,EAAE,CAAC,MAAM,EAAE,uBAAuB,KAAK,IAAI,CAAC;IAClE,uBAAuB,EAAE,CAAC,MAAM,EAAE,wBAAwB,KAAK,IAAI,CAAC;CACrE;AAED,MAAM,WAAW,uBAAuB;IACtC,kEAAkE;IAClE,MAAM,EAAE,cAAc,CAAC;IACvB,oDAAoD;IACpD,QAAQ,EAAE,MAAM,CAAC;IACjB,iFAAiF;IACjF,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,yBAAyB,CAAC;IACrC,8EAA8E;IAC9E,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,gBAAgB,KAAK,IAAI,CAAC;IACxD,wFAAwF;IACxF,eAAe,CAAC,EAAE,CAAC,GAAG,EAAE,gBAAgB,KAAK,MAAM,GAAG,SAAS,CAAC;IAChE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,SAAS,aAAa,EAAE,GAAG,CAAC,MAAM,SAAS,aAAa,EAAE,CAAC,CAAC;CACxE;AAED,mFAAmF;AACnF,MAAM,WAAW,gBAAgB;IAC/B,uCAAuC;IACvC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,0BAA0B;IAC1B,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,gFAAgF;IAChF,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,wDAAwD;IACxD,KAAK,IAAI,IAAI,CAAC;IACd,6EAA6E;IAC7E,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrD;;;;OAIG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC;IACvE,0FAA0F;IAC1F,UAAU,CAAC,GAAG,EAAE,gBAAgB,GAAG,MAAM,GAAG,SAAS,CAAC;IACtD,mEAAmE;IACnE,SAAS,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,qBAAqB,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;IACxE,QAAQ,IAAI,qBAAqB,CAAC;IAClC,kEAAkE;IAClE,OAAO,IAAI,IAAI,CAAC;CACjB"}
+{"version":3,"file":"searchController.d.ts","sourceRoot":"","sources":["../../src/types/searchController.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,aAAa,EACb,gBAAgB,EAChB,aAAa,EACb,cAAc,EACd,YAAY,EACZ,cAAc,EACf,MAAM,UAAU,CAAC;AAClB,OAAO,EACL,kBAAkB,EAClB,aAAa,EACb,wBAAwB,EACxB,uBAAuB,EACxB,MAAM,mBAAmB,CAAC;AAE3B,eAAO,MAAM,YAAY;;;;IAIvB,yCAAyC;;;CAGjC,CAAC;AAEX,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAE5E,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,OAAO,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;IACxC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,YAAY,CAAC;IACrB,4FAA4F;IAC5F,KAAK,EAAE,MAAM,CAAC;IACd,2CAA2C;IAC3C,IAAI,EAAE,MAAM,CAAC;IACb,kFAAkF;IAClF,QAAQ,CAAC,EAAE,YAAY,CAAC,gBAAgB,CAAC,CAAC;IAC1C,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,MAAM,cAAc,GAAG,CAC3B,OAAO,EAAE,aAAa,EACtB,OAAO,CAAC,EAAE,aAAa,KACpB,OAAO,CAAC,cAAc,CAAC,CAAC;AAE7B,qFAAqF;AACrF,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,aAAa,CAAC;IACvB,sBAAsB,EAAE,CAAC,MAAM,EAAE,uBAAuB,KAAK,IAAI,CAAC;IAClE,uBAAuB,EAAE,CAAC,MAAM,EAAE,wBAAwB,KAAK,IAAI,CAAC;IACpE,+EAA+E;IAC/E,iBAAiB,CAAC,EAAE,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,CAAC;CAC1D;AAED,MAAM,WAAW,uBAAuB;IACtC,kEAAkE;IAClE,MAAM,EAAE,cAAc,CAAC;IACvB,oDAAoD;IACpD,QAAQ,EAAE,MAAM,CAAC;IACjB,iFAAiF;IACjF,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,yBAAyB,CAAC;IACrC,8EAA8E;IAC9E,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,gBAAgB,KAAK,IAAI,CAAC;IACxD,wFAAwF;IACxF,eAAe,CAAC,EAAE,CAAC,GAAG,EAAE,gBAAgB,KAAK,MAAM,GAAG,SAAS,CAAC;IAChE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,SAAS,aAAa,EAAE,GAAG,CAAC,MAAM,SAAS,aAAa,EAAE,CAAC,CAAC;CACxE;AAED,mFAAmF;AACnF,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,IAAI,IAAI,IAAI,CAAC;IACb;;;OAGG;IACH,KAAK,IAAI,IAAI,CAAC;IACd,mFAAmF;IACnF,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,0BAA0B;IAC1B,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,gFAAgF;IAChF,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,wDAAwD;IACxD,KAAK,IAAI,IAAI,CAAC;IACd,6EAA6E;IAC7E,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrD;;;;OAIG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC;IACvE,0FAA0F;IAC1F,UAAU,CAAC,GAAG,EAAE,gBAAgB,GAAG,MAAM,GAAG,SAAS,CAAC;IACtD,mEAAmE;IACnE,SAAS,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,qBAAqB,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;IACxE,QAAQ,IAAI,qBAAqB,CAAC;IAClC,kEAAkE;IAClE,OAAO,IAAI,IAAI,CAAC;CACjB"}

package/dist/utils/searchControllerAnalytics.d.ts

@@ -2,9 +2,11 @@ import { SearchProductHit, SearchResult } from "../types/search";
 import { SearchControllerAnalytics } from "../types/searchController";
 /** Internal binding for search impressions and selections. */
 export interface ControllerAnalyticsBinding {
+    open(): void;
     onResponse(result: SearchResult<SearchProductHit>): void;
     observeResult(element: Element, result: SearchResult<SearchProductHit>, index: number): void;
     select(result: SearchResult<SearchProductHit>, index: number): void;
+    close(): void;
     dispose(): void;
 }
 export declare function createControllerAnalytics(analytics: SearchControllerAnalytics): ControllerAnalyticsBinding;

package/dist/utils/searchControllerAnalytics.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchControllerAnalytics.d.ts","sourceRoot":"","sources":["../../src/utils/searchControllerAnalytics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAKjE,OAAO,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAC;AAMtE,8DAA8D;AAC9D,MAAM,WAAW,0BAA0B;IACzC,UAAU,CAAC,MAAM,EAAE,YAAY,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC;IACzD,aAAa,CACX,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,YAAY,CAAC,gBAAgB,CAAC,EACtC,KAAK,EAAE,MAAM,GACZ,IAAI,CAAC;IACR,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,gBAAgB,CAAC,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACpE,OAAO,IAAI,IAAI,CAAC;CACjB;AAYD,wBAAgB,yBAAyB,CACvC,SAAS,EAAE,yBAAyB,GACnC,0BAA0B,CAgD5B"}
+{"version":3,"file":"searchControllerAnalytics.d.ts","sourceRoot":"","sources":["../../src/utils/searchControllerAnalytics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAKjE,OAAO,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAC;AAMtE,8DAA8D;AAC9D,MAAM,WAAW,0BAA0B;IACzC,IAAI,IAAI,IAAI,CAAC;IACb,UAAU,CAAC,MAAM,EAAE,YAAY,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC;IACzD,aAAa,CACX,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,YAAY,CAAC,gBAAgB,CAAC,EACtC,KAAK,EAAE,MAAM,GACZ,IAAI,CAAC;IACR,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,gBAAgB,CAAC,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACpE,KAAK,IAAI,IAAI,CAAC;IACd,OAAO,IAAI,IAAI,CAAC;CACjB;AAYD,wBAAgB,yBAAyB,CACvC,SAAS,EAAE,yBAAyB,GACnC,0BAA0B,CA4D5B"}

package/dist/utils/searchControllerAnalytics.js

@@ -16,6 +16,12 @@ export function createControllerAnalytics(analytics) {
         return impressions;
     };
     return {
+        open() {
+            analytics.trackOpenedSearch?.({
+                surface: analytics.surface,
+                search_type: "lexical",
+            });
+        },
         onResponse(result) {
             envelope = {
                 query_id: result.queryID,
@@ -45,6 +51,12 @@ export function createControllerAnalytics(analytics) {
             tracker().forceImpression(item);
             analytics.trackSelectSearchResult({ ...envelope, items: [item] });
         },
+        close() {
+            // Emit qualified impressions, drop the rest; the next response starts a new tracker.
+            impressions?.disconnect();
+            impressions = undefined;
+            envelope = undefined;
+        },
         dispose() {
             impressions?.disconnect();
         },

package/dist/utils/searchRequests.d.ts

@@ -1,7 +1,7 @@
 import { SearchProductHit, SearchRequest, SearchResponse, SearchResult, SearchSections } from "../types/search";
-import { SearchControllerState, SearchSection } from "../types/searchController";
+import { SearchControllerOptions, SearchControllerState, SearchSection } from "../types/searchController";
 export declare const INITIAL_SEARCH_STATE: SearchControllerState;
-export declare const normalizeQuery: (rawQuery: string) => string | undefined;
+export declare const requestedSections: (query: string, sections?: SearchControllerOptions["sections"]) => readonly SearchSection[];
 interface SearchRequestConfig {
     indexName: string;
     language: string;

package/dist/utils/searchRequests.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchRequests.d.ts","sourceRoot":"","sources":["../../src/utils/searchRequests.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,gBAAgB,EAChB,aAAa,EACb,cAAc,EACd,YAAY,EACZ,cAAc,EACf,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,qBAAqB,EACrB,aAAa,EAEd,MAAM,2BAA2B,CAAC;AAEnC,eAAO,MAAM,oBAAoB,EAAE,qBAOlC,CAAC;AAKF,eAAO,MAAM,cAAc,GAAI,UAAU,MAAM,KAAG,MAAM,GAAG,SAI1D,CAAC;AAEF,UAAU,mBAAmB;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,UAAU,aAAa;IACrB,QAAQ,EAAE,YAAY,CAAC,gBAAgB,CAAC,CAAC;IACzC,QAAQ,EAAE,cAAc,GAAG,SAAS,CAAC;CACtC;AAED,eAAO,MAAM,kBAAkB,GAC7B,OAAO,MAAM,EACb,MAAM,MAAM,EACZ,UAAU,SAAS,aAAa,EAAE,EAClC,+CAA+C,mBAAmB,KACjE,aAUD,CAAC;AAEH,eAAO,MAAM,iBAAiB,GAC5B,QAAQ,cAAc,EACtB,WAAW,SAAS,aAAa,EAAE,EACnC,kCAAkC,mBAAmB,KACpD,aAyBF,CAAC"}
+{"version":3,"file":"searchRequests.d.ts","sourceRoot":"","sources":["../../src/utils/searchRequests.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,gBAAgB,EAChB,aAAa,EACb,cAAc,EACd,YAAY,EACZ,cAAc,EACf,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,uBAAuB,EACvB,qBAAqB,EACrB,aAAa,EAEd,MAAM,2BAA2B,CAAC;AAEnC,eAAO,MAAM,oBAAoB,EAAE,qBAOlC,CAAC;AAEF,eAAO,MAAM,iBAAiB,GAC5B,OAAO,MAAM,EACb,WAAU,uBAAuB,CAAC,UAAU,CAAM,KACjD,SAAS,aAAa,EAMxB,CAAC;AAEF,UAAU,mBAAmB;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,UAAU,aAAa;IACrB,QAAQ,EAAE,YAAY,CAAC,gBAAgB,CAAC,CAAC;IACzC,QAAQ,EAAE,cAAc,GAAG,SAAS,CAAC;CACtC;AAED,eAAO,MAAM,kBAAkB,GAC7B,OAAO,MAAM,EACb,MAAM,MAAM,EACZ,UAAU,SAAS,aAAa,EAAE,EAClC,+CAA+C,mBAAmB,KACjE,aAUD,CAAC;AAEH,eAAO,MAAM,iBAAiB,GAC5B,QAAQ,cAAc,EACtB,WAAW,SAAS,aAAa,EAAE,EACnC,kCAAkC,mBAAmB,KACpD,aAyBF,CAAC"}

package/dist/utils/searchRequests.js

@@ -8,11 +8,11 @@ export const INITIAL_SEARCH_STATE = {
     sections: undefined,
     error: undefined,
 };
-// Match the API minimum query length.
-const MIN_QUERY_CODE_POINTS = 2;
-export const normalizeQuery = (rawQuery) => {
-    const query = rawQuery.trim();
-    return [...query].length >= MIN_QUERY_CODE_POINTS ? query : undefined;
+export const requestedSections = (query, sections = []) => {
+    if (query === "") {
+        return []; // The empty query only lists products.
+    }
+    return typeof sections === "function" ? sections() : sections;
 };
 export const buildSearchRequest = (query, page, sections, { indexName, language, country, hitsPerPage }) => ({
     requests: [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@askdialog/dialog-sdk",
-  "version": "2.18.1",
+  "version": "2.20.0",
   "private": false,
   "description": "Dialog SDK",
   "main": "dist/index.js",