@askdialog/dialog-sdk 2.15.1 → 2.17.0

package/README.md

@@ -260,9 +260,9 @@ Example of expected result:
 
 - Search products
 
-`client.search()` sends a multi-index request to the public search API. Build names with `searchIndexName(index, language, currency)`: `<index>_<lang>_<currency>`, e.g. `products_fr_eur`. Supported indices: `products`, `collections`, `articles`, `pages`. Language must be a lowercase ISO 639-1 code (`fr`, `en`). Regional locales such as `fr-FR` are rejected. The ISO 4217 currency is lowercased in the index name.
+`client.search()` sends a multi-index request to the public search API. Build names with `searchIndexName(index, language, country)`: `<index>_<lang>_<country>`, e.g. `products_fr_be`. Supported indices: `products`, `collections`, `articles`, `pages`. Language must be a lowercase ISO 639-1 code (`fr`, `en`). Regional locales such as `fr-FR` are rejected. The country is the shopper's ISO 3166-1 alpha-2 code, lowercased in the index name.
 
-Currency is required and independent of language: `fr` with `USD` produces `products_fr_usd`. Names without a currency suffix return 404.
+The country is required and independent of language: `fr` with `CA` produces `products_fr_ca`. Product prices are in the base currency of the market that sells to that country. Names without a country suffix return 404.
 
 ```typescript
 import { Dialog, DialogSearchError, searchIndexName } from '@askdialog/dialog-sdk';
@@ -273,7 +273,7 @@ const client = new Dialog({ apiKey: 'YOUR_API_KEY', locale: 'fr-FR', currency: '
 const response: SearchResponse = await client.search({
   requests: [
     {
-      indexName: searchIndexName('products', 'fr', client.currency), // "products_fr_eur"
+      indexName: searchIndexName('products', 'fr', 'BE'), // "products_fr_be"
       query: 'shampoo',
       page: 0, // optional, zero-indexed (default 0)
       hitsPerPage: 20, // optional, 1-100 (default 20)
@@ -282,8 +282,12 @@ const response: SearchResponse = await client.search({
 });
 // response.results[n]: { index, hits, nbHits, page, nbPages, hitsPerPage,
 //                        processingTimeMS, query, queryID }
-// response.results[n].hits[m]: { objectID, title?, url?, handle?, imageUrl?,
-//                                priceRange? }
+// A products hit is Algolia's Shopify record (`SearchProductHit`), plus `url`
+// and `currency`: { objectID (variant id), id (product id), title?, handle?,
+// url?, image?, variants_min_price?, price?, compare_at_price?, ... }
+// Collection hits are `SearchCollectionHit`, Algolia's collection record:
+// { objectID, title?, handle?, url?, body_html_safe?, image?, products_count?, ... }
+// Article and page hits are `SearchHit`: { objectID, title?, url?, handle?, imageUrl? }
 ```
 
 With the IIFE bundle the results are plain runtime JSON (same shape, no types):
@@ -293,7 +297,7 @@ With the IIFE bundle the results are plain runtime JSON (same shape, no types):
 <script>
   const client = new window.DialogSDK.Dialog({ apiKey: 'YOUR_API_KEY', locale: 'fr-FR', currency: 'EUR' });
   client
-    .search({ requests: [{ indexName: 'products_fr_eur', query: 'shampoo' }] })
+    .search({ requests: [{ indexName: 'products_fr_be', query: 'shampoo' }] })
     .then((response) => console.log(response.results[0].hits));
 </script>
 ```
@@ -316,13 +320,14 @@ const client = new Dialog({ apiKey: 'YOUR_API_KEY', locale: 'fr-FR', currency: '
 const controller = createSearchController({
   search: (request, options) => client.search(request, options),
   language: 'fr',
-  currency: client.currency,
+  country: 'BE', // shopper's country
   analytics: {
     surface: 'search_page', // where results are displayed
     trackViewSearchResults: (params) => client.trackViewSearchResults(params),
     trackSelectSearchResult: (params) => client.trackSelectSearchResult(params),
   },
   navigate: (url) => router.push(url), // optional platform routing adapter
+  buildProductUrl: (hit) => `/products/${hit.handle}`, // optional, for hits without `url`
   debounceMs: 250, // optional (default 250)
   hitsPerPage: 12, // optional (default 12)
   sections: [{ index: 'collections', hitsPerPage: 5 }], // optional, first page only; a function is resolved per request
@@ -346,9 +351,11 @@ retryButton.onclick = () => controller.retry();
 controller.dispose();
 ```
 
-The client uses a BCP-47 `locale` such as `fr-FR` for assistant localization. Search controllers and React/Vue hooks require explicit `language` (ISO 639-1) and `currency` (ISO 4217), independently of the client locale. Pass `client.currency` to reuse its configured currency.
+The client uses a BCP-47 `locale` such as `fr-FR` for assistant localization. Search controllers and React/Vue hooks require explicit `language` (ISO 639-1) and `country` (the shopper's ISO 3166-1 alpha-2 country), independently of the client locale.
 
-For Shopify, use `window.Shopify.currency.active` as the currency. Controller options are fixed at creation; recreate the controller to change language or currency.
+For Shopify, use `window.Shopify.country` as the country. Controller options are fixed at creation; recreate the controller to change language or country.
+
+Analytics send each product hit's `id` (the product id) as `product_id`; `navigate` receives `controller.productUrl(hit)`: the hit's `url`, else `buildProductUrl`'s result.
 
 Framework integrations:
 

package/dist/__tests__/dialogSearchAnalytics.spec.js

@@ -17,7 +17,7 @@ const buildDialog = () => {
 };
 const envelope = {
     query_id: "query-1",
-    index: "products_fr_eur",
+    index: "products_fr_fr",
     surface: "search_page",
     search_type: "lexical",
     page: 2,

package/dist/__tests__/publicTypes.spec.js

@@ -19,7 +19,13 @@ describe("public API types", () => {
         expectTypeOf().toEqualTypeOf();
         expectTypeOf().toEqualTypeOf();
         expectTypeOf().toEqualTypeOf();
-        expectTypeOf().toMatchTypeOf();
+        expectTypeOf().toEqualTypeOf();
+        expectTypeOf().toEqualTypeOf();
+        expectTypeOf().toEqualTypeOf();
+        expectTypeOf().toEqualTypeOf();
+        expectTypeOf().toEqualTypeOf();
+        expectTypeOf().toEqualTypeOf();
+        expectTypeOf().toEqualTypeOf();
         const error = new DialogSearchError({ status: 404, message: "not found" });
         expectTypeOf(error.status).toEqualTypeOf();
         expectTypeOf(error.code).toEqualTypeOf();

package/dist/__tests__/searchController.spec.js

@@ -15,7 +15,7 @@ const DEBOUNCE_MS = 250;
 const response = (overrides = {}) => ({
     results: [
         {
-            index: "products_fr_eur",
+            index: "products_fr_fr",
             hits: [{ objectID: "p1" }, { objectID: "p2" }],
             nbHits: 2,
             page: 0,
@@ -50,7 +50,7 @@ const createController = () => {
     const controller = createSearchController({
         search,
         language: "fr",
-        currency: "EUR",
+        country: "FR",
         analytics: {
             surface: "search_page",
             trackViewSearchResults,
@@ -94,24 +94,24 @@ describe("createSearchController", () => {
         });
         expect(controller.getState().status).toBe(SearchStatus.SUCCESS);
     });
-    it("sends one products entry with independent language and currency", async () => {
+    it("sends one products entry with the language and the shopper's country", async () => {
         const controller = createSearchController({
             search,
             language: "fr",
-            currency: "USD",
+            country: "US",
             analytics: {
                 surface: "search_page",
                 trackViewSearchResults,
                 trackSelectSearchResult,
             },
         });
-        search.mockResolvedValue(response({ query: "shoes", index: "products_fr_usd" }));
+        search.mockResolvedValue(response({ query: "shoes", index: "products_fr_us" }));
         controller.submit("shoes");
         await settle();
         expect(search.mock.calls[0][0]).toEqual({
             requests: [
                 {
-                    indexName: "products_fr_usd",
+                    indexName: "products_fr_us",
                     query: "shoes",
                     page: 0,
                     hitsPerPage: 12,
@@ -305,7 +305,7 @@ describe("createSearchController", () => {
         const controller = createSearchController({
             search,
             language: "fr",
-            currency: "USD",
+            country: "US",
             analytics: {
                 surface: "search_page",
                 trackViewSearchResults,
@@ -315,30 +315,30 @@ describe("createSearchController", () => {
         });
         const collections = {
             ...response().results[0],
-            index: "collections_fr_usd",
+            index: "collections_fr_us",
             hits: [{ objectID: "c1" }],
             nbHits: 1,
         };
         search.mockResolvedValueOnce({
-            results: [...response({ index: "products_fr_usd" }).results, collections],
+            results: [...response({ index: "products_fr_us" }).results, collections],
         });
         controller.submit("shoes");
         await settle();
         expect(search.mock.calls[0][0].requests).toEqual([
             {
-                indexName: "products_fr_usd",
+                indexName: "products_fr_us",
                 query: "shoes",
                 page: 0,
                 hitsPerPage: 12,
             },
             {
-                indexName: "collections_fr_usd",
+                indexName: "collections_fr_us",
                 query: "shoes",
                 page: 0,
                 hitsPerPage: 5,
             },
         ]);
-        expect(controller.getState().response?.index).toBe("products_fr_usd");
+        expect(controller.getState().response?.index).toBe("products_fr_us");
         expect(controller.getState().sections).toEqual({ collections });
     });
     it("resolves a sections function per request and leaves a missing entry out", async () => {
@@ -346,7 +346,7 @@ describe("createSearchController", () => {
         const controller = createSearchController({
             search,
             language: "fr",
-            currency: "EUR",
+            country: "FR",
             analytics: {
                 surface: "search_page",
                 trackViewSearchResults,
@@ -363,7 +363,7 @@ describe("createSearchController", () => {
         expect(search.mock.calls[0][0].requests).toHaveLength(1);
         expect(search.mock.calls[1][0].requests).toHaveLength(2);
         expect(search.mock.calls[1][0].requests[1]).toMatchObject({
-            indexName: "collections_fr_eur",
+            indexName: "collections_fr_fr",
             hitsPerPage: 12,
         });
         expect(controller.getState().sections).toEqual({});
@@ -373,7 +373,7 @@ describe("createSearchController", () => {
         const controller = createSearchController({
             search,
             language: "fr",
-            currency: "EUR",
+            country: "FR",
             analytics: {
                 surface: "search_page",
                 trackViewSearchResults,

package/dist/__tests__/searchControllerAttribution.spec.js

@@ -1,4 +1,4 @@
-/* eslint max-lines: ["error", 300] */
+/* eslint max-lines: ["error", 310] */
 import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
 import { createSearchController } from "../searchController";
 const tracker = vi.hoisted(() => ({
@@ -11,13 +11,23 @@ const tracker = vi.hoisted(() => ({
 vi.mock("../utils/searchImpressions", () => ({
     createSearchImpressionTracker: () => tracker,
 }));
+// `objectID` is the variant id, `id` the product id the events carry.
+const productHit = (objectID, id, url) => ({
+    objectID,
+    id,
+    url,
+    tags: [],
+    options: {},
+    option_names: [],
+    inventory_available: true,
+});
 const response = (overrides = {}) => ({
     results: [
         {
-            index: "products_fr_eur",
+            index: "products_fr_fr",
             hits: [
-                { objectID: "p1", url: "https://shop.example/p1" },
-                { objectID: "p2" },
+                productHit("v11", 101, "https://shop.example/p1"),
+                productHit("v22", 102),
             ],
             nbHits: 30,
             page: 0,
@@ -37,7 +47,7 @@ const navigate = vi.fn();
 const createController = () => createSearchController({
     search,
     language: "fr",
-    currency: "EUR",
+    country: "FR",
     analytics: {
         surface: "search_page",
         trackViewSearchResults,
@@ -76,7 +86,7 @@ describe("search controller attribution", () => {
         await settle();
         expect(tracker.setContext).toHaveBeenCalledWith({
             query_id: "qid-1",
-            index: "products_fr_eur",
+            index: "products_fr_fr",
             surface: "search_page",
             search_type: "lexical",
             page: 2,
@@ -106,7 +116,7 @@ describe("search controller attribution", () => {
         await settle();
         expect(trackViewSearchResults).toHaveBeenCalledWith({
             query_id: "qid-1",
-            index: "products_fr_eur",
+            index: "products_fr_fr",
             surface: "search_page",
             search_type: "lexical",
             page: 1,
@@ -123,7 +133,7 @@ describe("search controller attribution", () => {
         await settle();
         controller.observeResult(element, 1);
         expect(tracker.observe).toHaveBeenCalledWith(element, {
-            product_id: "p2",
+            product_id: "102",
             position: 2 * 12 + 2,
         });
     });
@@ -147,18 +157,18 @@ describe("search controller attribution", () => {
         await settle();
         controller.selectResult(0);
         expect(tracker.forceImpression).toHaveBeenCalledWith({
-            product_id: "p1",
+            product_id: "101",
             position: 1,
         });
         expect(trackSelectSearchResult).toHaveBeenCalledWith({
             query_id: "qid-1",
-            index: "products_fr_eur",
+            index: "products_fr_fr",
             surface: "search_page",
             search_type: "lexical",
             page: 1,
             total_hits: 30,
             query_length: 5,
-            items: [{ product_id: "p1", position: 1 }],
+            items: [{ product_id: "101", position: 1 }],
         });
         expect(navigate).toHaveBeenCalledWith("https://shop.example/p1", landed.results[0].hits[0]);
         expect(order).toEqual(["impression", "select", "navigate"]);
@@ -169,7 +179,7 @@ describe("search controller attribution", () => {
         controller.submit("shoes");
         await settle();
         controller.selectResult(1);
-        expect(trackSelectSearchResult).toHaveBeenCalledWith(expect.objectContaining({ items: [{ product_id: "p2", position: 2 }] }));
+        expect(trackSelectSearchResult).toHaveBeenCalledWith(expect.objectContaining({ items: [{ product_id: "102", position: 2 }] }));
         expect(navigate).not.toHaveBeenCalled();
     });
     it("returns true when the navigate adapter handles the transition", async () => {
@@ -203,7 +213,7 @@ describe("search controller attribution", () => {
         const controller = createSearchController({
             search,
             language: "fr",
-            currency: "EUR",
+            country: "FR",
             analytics: {
                 surface: "search_page",
                 trackViewSearchResults,

package/dist/__tests__/searchImpressions.spec.js

@@ -3,7 +3,7 @@ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
 import { createSearchImpressionTracker } from "../utils/searchImpressions";
 const envelope = {
     query_id: "query-1",
-    index: "products_fr_eur",
+    index: "products_fr_fr",
     surface: "search_page",
     search_type: "lexical",
     page: 1,

package/dist/__tests__/searchService.spec.js

@@ -41,17 +41,16 @@ afterEach(() => {
 });
 describe("searchIndexName", () => {
     it.each([
-        ["fr", "EUR", "products_fr_eur"],
-        ["pt", "BRL", "products_pt_brl"],
-        ["fr", "CAD", "products_fr_cad"],
-        ["en", "EUR", "products_en_eur"],
-    ])("builds an index name from language %s and currency", (locale, currency, name) => {
-        expect(searchIndexName("products", locale, currency)).toBe(name);
+        ["fr", "BE", "products_fr_be"],
+        ["pt", "br", "products_pt_br"],
+        ["fr", "CA", "products_fr_ca"],
+    ])("builds an index name from language %s and the shopper's country", (language, country, name) => {
+        expect(searchIndexName("products", language, country)).toBe(name);
     });
-    it("names every logical index", () => {
-        expect(searchIndexName("collections", "en", "USD")).toBe("collections_en_usd");
-        expect(() => searchIndexName("products", "fr-FR", "EUR")).toThrow(/ISO 639-1/);
-        expect(() => searchIndexName("products", "fr", "")).toThrow(/ISO 4217/);
+    it("names every logical index and rejects invalid codes", () => {
+        expect(searchIndexName("collections", "en", "US")).toBe("collections_en_us");
+        expect(() => searchIndexName("products", "fr-FR", "FR")).toThrow(/ISO 639-1/);
+        expect(() => searchIndexName("products", "fr", "EUR")).toThrow(/ISO 3166-1/);
     });
 });
 describe("searchLexical", () => {

package/dist/index.d.ts

@@ -6,5 +6,6 @@ export * from "./services/search";
 export * from "./types";
 export { isRtlLanguageCode, resolveTextDirection, type TextDirection, } from "./utils/localization";
 export * from "./utils/searchImpressions";
+export * from "./utils/searchPrice";
 export * from "./windowAudit";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,SAAS,CAAC;AACxB,OAAO,EACL,iBAAiB,EACjB,oBAAoB,EACpB,KAAK,aAAa,GACnB,MAAM,sBAAsB,CAAC;AAC9B,cAAc,2BAA2B,CAAC;AAC1C,cAAc,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,SAAS,CAAC;AACxB,OAAO,EACL,iBAAiB,EACjB,oBAAoB,EACpB,KAAK,aAAa,GACnB,MAAM,sBAAsB,CAAC;AAC9B,cAAc,2BAA2B,CAAC;AAC1C,cAAc,qBAAqB,CAAC;AACpC,cAAc,eAAe,CAAC"}

package/dist/index.js

@@ -6,4 +6,5 @@ export * from "./services/search";
 export * from "./types";
 export { isRtlLanguageCode, resolveTextDirection, } from "./utils/localization";
 export * from "./utils/searchImpressions";
+export * from "./utils/searchPrice";
 export * from "./windowAudit";

package/dist/searchController.d.ts

@@ -1,3 +1,3 @@
 import { SearchController, SearchControllerOptions } from "./types/searchController";
-export declare function createSearchController({ search, language, currency, analytics, navigate, debounceMs, hitsPerPage, sections, }: SearchControllerOptions): SearchController;
+export declare function createSearchController({ search, language, country, analytics, navigate, buildProductUrl, debounceMs, hitsPerPage, sections, }: SearchControllerOptions): SearchController;
 //# sourceMappingURL=searchController.d.ts.map

package/dist/searchController.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchController.d.ts","sourceRoot":"","sources":["../src/searchController.ts"],"names":[],"mappings":"AACA,OAAO,EACL,gBAAgB,EAChB,uBAAuB,EAGxB,MAAM,0BAA0B,CAAC;AAiBlC,wBAAgB,sBAAsB,CAAC,EACrC,MAAM,EACN,QAAQ,EACR,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,UAAgB,EAChB,WAAgB,EAChB,QAAa,GACd,EAAE,uBAAuB,GAAG,gBAAgB,CAuK5C"}
+{"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"}

package/dist/searchController.js

@@ -1,23 +1,15 @@
 import { searchIndexName } from "./services/search";
 import { SearchStatus, } from "./types/searchController";
 import { createControllerAnalytics } from "./utils/searchControllerAnalytics";
-import { buildSearchRequest, normalizeQuery, readSearchResults, } from "./utils/searchRequests";
-const INITIAL_STATE = {
-    status: SearchStatus.IDLE,
-    query: "",
-    page: 0,
-    response: undefined,
-    sections: undefined,
-    error: undefined,
-};
-export function createSearchController({ search, language, currency, analytics, navigate, debounceMs = 250, hitsPerPage = 12, sections = [], }) {
+import { buildSearchRequest, INITIAL_SEARCH_STATE, normalizeQuery, readSearchResults, } from "./utils/searchRequests";
+export function createSearchController({ search, language, country, analytics, navigate, buildProductUrl, debounceMs = 250, hitsPerPage = 12, sections = [], }) {
     const requestConfig = {
-        indexName: searchIndexName("products", language, currency),
+        indexName: searchIndexName("products", language, country),
         language,
-        currency,
+        country,
         hitsPerPage,
     };
-    let state = INITIAL_STATE;
+    let state = INITIAL_SEARCH_STATE;
     const listeners = new Set();
     const controllerAnalytics = createControllerAnalytics(analytics);
     let debounceTimer;
@@ -31,6 +23,7 @@ export function createSearchController({ search, language, currency, analytics,
             listener(state);
         }
     };
+    const productUrl = (hit) => hit.url !== undefined && hit.url !== "" ? hit.url : buildProductUrl?.(hit);
     const cancelPendingSearch = () => {
         clearTimeout(debounceTimer);
         pendingQuery = undefined;
@@ -85,7 +78,7 @@ export function createSearchController({ search, language, currency, analytics,
             cancelPendingSearch();
             const query = normalizeQuery(rawQuery);
             if (query === undefined) {
-                setState(INITIAL_STATE);
+                setState(INITIAL_SEARCH_STATE);
                 return;
             }
             pendingQuery = query;
@@ -98,7 +91,7 @@ export function createSearchController({ search, language, currency, analytics,
             cancelPendingSearch();
             const query = normalizeQuery(rawQuery);
             if (query === undefined) {
-                setState(INITIAL_STATE);
+                setState(INITIAL_SEARCH_STATE);
                 return;
             }
             void run(query, 0);
@@ -135,7 +128,7 @@ export function createSearchController({ search, language, currency, analytics,
                 return false;
             }
             controllerAnalytics.select(response, index);
-            const url = response.hits[index].url;
+            const url = productUrl(response.hits[index]);
             const runAdapter = options?.navigate ?? true;
             if (runAdapter && navigate !== undefined && url !== undefined) {
                 navigate(url, response.hits[index]);
@@ -143,6 +136,7 @@ export function createSearchController({ search, language, currency, analytics,
             }
             return false;
         },
+        productUrl,
         subscribe(listener) {
             listeners.add(listener);
             return () => {

package/dist/services/search.d.ts

@@ -1,6 +1,6 @@
 import { SearchIndex, SearchOptions, SearchRequest, SearchResponse } from "../types/search";
-/** Build an index name from an ISO 639-1 language and ISO 4217 currency. */
-export declare const searchIndexName: (index: SearchIndex, language: string, currency: string) => string;
+/** Build an index name from an ISO 639-1 language and the shopper's ISO 3166-1 alpha-2 country. */
+export declare const searchIndexName: (index: SearchIndex, language: string, country: string) => string;
 /** Send one request. The caller controls cancellation through `options.signal`. */
 export declare const searchLexical: (apiKey: string, request: SearchRequest, options?: SearchOptions) => Promise<SearchResponse>;
 //# sourceMappingURL=search.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../../src/services/search.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,WAAW,EACX,aAAa,EACb,aAAa,EACb,cAAc,EACf,MAAM,iBAAiB,CAAC;AAKzB,4EAA4E;AAC5E,eAAO,MAAM,eAAe,GAC1B,OAAO,WAAW,EAClB,UAAU,MAAM,EAChB,UAAU,MAAM,KACf,MASF,CAAC;AAoBF,mFAAmF;AACnF,eAAO,MAAM,aAAa,GACxB,QAAQ,MAAM,EACd,SAAS,aAAa,EACtB,UAAU,aAAa,KACtB,OAAO,CAAC,cAAc,CAgBxB,CAAC"}
+{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../../src/services/search.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,WAAW,EACX,aAAa,EACb,aAAa,EACb,cAAc,EACf,MAAM,iBAAiB,CAAC;AAKzB,mGAAmG;AACnG,eAAO,MAAM,eAAe,GAC1B,OAAO,WAAW,EAClB,UAAU,MAAM,EAChB,SAAS,MAAM,KACd,MASF,CAAC;AAoBF,mFAAmF;AACnF,eAAO,MAAM,aAAa,GACxB,QAAQ,MAAM,EACd,SAAS,aAAa,EACtB,UAAU,aAAa,KACtB,OAAO,CAAC,cAAc,CAgBxB,CAAC"}

package/dist/services/search.js

@@ -2,15 +2,15 @@ import { config } from "../config";
 import { DialogSearchError } from "../DialogSearchError";
 const SEARCH_PATH = "/public/search/lexical";
 const API_KEY_HEADER = "x-dialog-api-key";
-/** Build an index name from an ISO 639-1 language and ISO 4217 currency. */
-export const searchIndexName = (index, language, currency) => {
+/** Build an index name from an ISO 639-1 language and the shopper's ISO 3166-1 alpha-2 country. */
+export const searchIndexName = (index, language, country) => {
     if (!/^[a-z]{2}$/.test(language)) {
         throw new Error("Search language must be a lowercase ISO 639-1 code.");
     }
-    if (!/^[A-Za-z]{3}$/.test(currency)) {
-        throw new Error("Search currency must be an ISO 4217 code.");
+    if (!/^[A-Za-z]{2}$/.test(country)) {
+        throw new Error("Search country must be an ISO 3166-1 alpha-2 code.");
     }
-    return `${index}_${language}_${currency.toLowerCase()}`;
+    return `${index}_${language}_${country.toLowerCase()}`;
 };
 const toSearchError = async (response) => {
     let body;

package/dist/types/search.d.ts

@@ -1,10 +1,10 @@
-/** Supported indices before adding language and currency. */
+/** Supported indices before adding language and country. */
 export declare const SEARCH_INDICES: readonly ["products", "collections", "articles", "pages"];
 export type SearchIndex = (typeof SEARCH_INDICES)[number];
 export interface SearchQuery {
     /**
-     * `<index>_<lang>_<currency>`, e.g. `products_fr_eur`.
-     * Use the same language and lowercase ISO 4217 currency for every entry.
+     * `<index>_<lang>_<country>`, e.g. `products_fr_be`.
+     * Use the same language and lowercase ISO 3166-1 alpha-2 country for every entry.
      * Unsupported index names return 404.
      */
     indexName: string;
@@ -22,28 +22,82 @@ export interface SearchOptions {
     /** Passed to fetch; cancellation rejects with `AbortError`. */
     signal?: AbortSignal;
 }
-export interface SearchPrice {
-    /** Decimal string, e.g. "24.90". */
-    amount: string;
-    /** Currency code, if provided by the index. */
-    currencyCode?: string;
-}
-export interface SearchPriceRange {
-    min: SearchPrice;
-    max: SearchPrice;
+/** Algolia's collection record, plus `url`. */
+export interface SearchCollectionHit {
+    /** Collection id, the last segment of the Shopify GID. */
+    objectID: string;
+    title?: string;
+    handle?: string;
+    url?: string;
+    body_html?: string;
+    body_html_safe?: string;
+    image?: string;
+    products_count?: number;
+    template_suffix?: string;
+    updated_at?: string;
 }
-/** Indexed record. Display fields are optional; only products have `priceRange`. */
+/** An article or page hit. */
 export interface SearchHit {
     objectID: string;
     title?: string;
     url?: string;
     handle?: string;
     imageUrl?: string;
-    priceRange?: SearchPriceRange;
 }
-export interface SearchResult {
+/**
+ * A product hit: Algolia's Shopify record, plus `url` and `currency`.
+ * Prices are numbers in the base currency of the shopper's market (`currency`);
+ * a price the market lacks is absent.
+ */
+export interface SearchProductHit {
+    /** Variant id, the last segment of the Shopify GID. */
+    objectID: string;
+    /** Product id, a number when numeric. */
+    id: number | string;
+    title?: string;
+    handle?: string;
+    url?: string;
+    variant_title?: string;
+    position?: number;
+    image?: string;
+    product_image?: string;
+    body_html_safe?: string;
+    vendor?: string;
+    product_type?: string;
+    tags: string[];
+    sku?: string;
+    barcode?: string;
+    option1?: string;
+    option2?: string;
+    option3?: string;
+    /** Lowercase option name to selected value. */
+    options: Record<string, string>;
+    option_names: string[];
+    price?: number;
+    compare_at_price?: number;
+    variants_min_price?: number;
+    variants_max_price?: number;
+    variants_compare_at_price_min?: number;
+    variants_compare_at_price_max?: number;
+    /** ISO 4217 base currency of the shopper's market. */
+    currency?: string;
+    variants_count?: number;
+    inventory_quantity?: number;
+    inventory_available: boolean;
+    created_at?: string;
+    updated_at?: string;
+    published_at?: string;
+}
+/** The hit each index answers. */
+export interface SearchHitByIndex {
+    products: SearchProductHit;
+    collections: SearchCollectionHit;
+    articles: SearchHit;
+    pages: SearchHit;
+}
+export interface SearchResult<THit = SearchHitByIndex[SearchIndex]> {
     index: string;
-    hits: SearchHit[];
+    hits: THit[];
     nbHits: number;
     page: number;
     nbPages: number;
@@ -52,6 +106,10 @@ export interface SearchResult {
     query: string;
     queryID: string;
 }
+/** Results of the sections searched next to products, keyed by index. */
+export type SearchSections = {
+    [Index in Exclude<SearchIndex, "products">]?: SearchResult<SearchHitByIndex[Index]>;
+};
 /** Results in request order. */
 export interface SearchResponse {
     results: SearchResult[];

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

@@ -1 +1 @@
-{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../../src/types/search.ts"],"names":[],"mappings":"AAAA,6DAA6D;AAC7D,eAAO,MAAM,cAAc,2DAKjB,CAAC;AAEX,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC;AAE1D,MAAM,WAAW,WAAW;IAC1B;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,2DAA2D;IAC3D,KAAK,EAAE,MAAM,CAAC;IACd,0CAA0C;IAC1C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mDAAmD;IACnD,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,WAAW,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,aAAa;IAC5B,+DAA+D;IAC/D,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,MAAM,WAAW,WAAW;IAC1B,oCAAoC;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,+CAA+C;IAC/C,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,gBAAgB;IAC/B,GAAG,EAAE,WAAW,CAAC;IACjB,GAAG,EAAE,WAAW,CAAC;CAClB;AAED,oFAAoF;AACpF,MAAM,WAAW,SAAS;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,gBAAgB,CAAC;CAC/B;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,SAAS,EAAE,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,EAAE,MAAM,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,gCAAgC;AAChC,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,YAAY,EAAE,CAAC;CACzB"}
+{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../../src/types/search.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,eAAO,MAAM,cAAc,2DAKjB,CAAC;AAEX,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC;AAE1D,MAAM,WAAW,WAAW;IAC1B;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,2DAA2D;IAC3D,KAAK,EAAE,MAAM,CAAC;IACd,0CAA0C;IAC1C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mDAAmD;IACnD,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,WAAW,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,aAAa;IAC5B,+DAA+D;IAC/D,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,+CAA+C;AAC/C,MAAM,WAAW,mBAAmB;IAClC,0DAA0D;IAC1D,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,8BAA8B;AAC9B,MAAM,WAAW,SAAS;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,uDAAuD;IACvD,QAAQ,EAAE,MAAM,CAAC;IACjB,yCAAyC;IACzC,EAAE,EAAE,MAAM,GAAG,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,+CAA+C;IAC/C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,6BAA6B,CAAC,EAAE,MAAM,CAAC;IACvC,6BAA6B,CAAC,EAAE,MAAM,CAAC;IACvC,sDAAsD;IACtD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,mBAAmB,EAAE,OAAO,CAAC;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,kCAAkC;AAClC,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,WAAW,EAAE,mBAAmB,CAAC;IACjC,QAAQ,EAAE,SAAS,CAAC;IACpB,KAAK,EAAE,SAAS,CAAC;CAClB;AAED,MAAM,WAAW,YAAY,CAAC,IAAI,GAAG,gBAAgB,CAAC,WAAW,CAAC;IAChE,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,IAAI,EAAE,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,EAAE,MAAM,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,yEAAyE;AACzE,MAAM,MAAM,cAAc,GAAG;KAC1B,KAAK,IAAI,OAAO,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,YAAY,CACxD,gBAAgB,CAAC,KAAK,CAAC,CACxB;CACF,CAAC;AAEF,gCAAgC;AAChC,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,YAAY,EAAE,CAAC;CACzB"}

package/dist/types/search.js

@@ -1,4 +1,4 @@
-/** Supported indices before adding language and currency. */
+/** Supported indices before adding language and country. */
 export const SEARCH_INDICES = [
     "products",
     "collections",

package/dist/types/searchAnalytics.d.ts

@@ -4,7 +4,7 @@ export declare const SEARCH_TYPES: readonly ["lexical"];
 export type SearchType = (typeof SEARCH_TYPES)[number];
 export interface SearchAnalyticsEnvelope {
     query_id: string;
-    /** Index returned by the API, e.g. `products_fr_eur`. */
+    /** Index returned by the API, e.g. `products_fr_be`. */
     index: string;
     /** UI surface displaying the results. */
     surface: SearchSurface;

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,yDAAyD;IACzD,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,+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"}

package/dist/types/searchController.d.ts

@@ -1,4 +1,4 @@
-import { SearchHit, SearchIndex, SearchOptions, SearchRequest, SearchResponse, SearchResult } from "./search";
+import { SearchIndex, SearchOptions, SearchProductHit, SearchRequest, SearchResponse, SearchResult, SearchSections } from "./search";
 import { SearchSurface, SelectSearchResultParams, ViewSearchResultsParams } from "./searchAnalytics";
 export declare const SearchStatus: {
     readonly IDLE: "idle";
@@ -20,8 +20,8 @@ export interface SearchControllerState {
     /** Zero-based page of the last request. */
     page: number;
     /** Last products result; retained while loading and cleared on error or reset. */
-    response?: SearchResult;
-    sections?: Partial<Record<SearchIndex, SearchResult>>;
+    response?: SearchResult<SearchProductHit>;
+    sections?: SearchSections;
     error?: unknown;
 }
 export type SearchFunction = (request: SearchRequest, options?: SearchOptions) => Promise<SearchResponse>;
@@ -36,11 +36,13 @@ export interface SearchControllerOptions {
     search: SearchFunction;
     /** Lowercase ISO 639-1 language code, e.g. `fr`. */
     language: string;
-    /** ISO 4217 currency, independent of language. */
-    currency: string;
+    /** Shopper's ISO 3166-1 alpha-2 country, e.g. `BE`; prices follow its market. */
+    country: string;
     analytics: SearchControllerAnalytics;
     /** Navigate after recording selection. Omit to use native link navigation. */
-    navigate?: (url: string, hit: SearchHit) => void;
+    navigate?: (url: string, hit: SearchProductHit) => void;
+    /** Build a product's link when its hit has no `url`, e.g. `/products/${hit.handle}`. */
+    buildProductUrl?: (hit: SearchProductHit) => string | undefined;
     debounceMs?: number;
     hitsPerPage?: number;
     sections?: readonly SearchSection[] | (() => readonly SearchSection[]);
@@ -65,6 +67,8 @@ export interface SearchController {
     selectResult(index: number, options?: {
         navigate?: boolean;
     }): boolean;
+    /** The hit's `url`, else `buildProductUrl`'s result; undefined when neither gives one. */
+    productUrl(hit: SearchProductHit): string | undefined;
     /** Subscribe to state changes; returns an unsubscribe function. */
     subscribe(listener: (state: SearchControllerState) => void): () => void;
     getState(): SearchControllerState;

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,SAAS,EACT,WAAW,EACX,aAAa,EACb,aAAa,EACb,cAAc,EACd,YAAY,EACb,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;IACxB,QAAQ,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC,CAAC;IACtD,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,kDAAkD;IAClD,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,yBAAyB,CAAC;IACrC,8EAA8E;IAC9E,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,KAAK,IAAI,CAAC;IACjD,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,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,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"}

package/dist/utils/searchControllerAnalytics.d.ts

@@ -1,10 +1,10 @@
-import { SearchResult } from "../types/search";
+import { SearchProductHit, SearchResult } from "../types/search";
 import { SearchControllerAnalytics } from "../types/searchController";
 /** Internal binding for search impressions and selections. */
 export interface ControllerAnalyticsBinding {
-    onResponse(result: SearchResult): void;
-    observeResult(element: Element, result: SearchResult, index: number): void;
-    select(result: SearchResult, index: number): void;
+    onResponse(result: SearchResult<SearchProductHit>): void;
+    observeResult(element: Element, result: SearchResult<SearchProductHit>, index: number): void;
+    select(result: SearchResult<SearchProductHit>, index: number): 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,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAK/C,OAAO,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAC;AAMtE,8DAA8D;AAC9D,MAAM,WAAW,0BAA0B;IACzC,UAAU,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAAC;IACvC,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3E,MAAM,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAClD,OAAO,IAAI,IAAI,CAAC;CACjB;AAQD,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,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"}

package/dist/utils/searchControllerAnalytics.js

@@ -1,6 +1,7 @@
 import { createSearchImpressionTracker, } from "./searchImpressions";
 const resultItem = (result, index) => ({
-    product_id: result.hits[index].objectID,
+    // `objectID` is the variant id; analytics count products.
+    product_id: String(result.hits[index].id),
     // One-based position across all pages.
     position: result.page * result.hitsPerPage + index + 1,
 });

package/dist/utils/searchPrice.d.ts

@@ -0,0 +1,9 @@
+import type { SearchProductHit } from "../types/search";
+/** The lowest variant price only, as on the Shopify storefront search. */
+export declare const formatSearchPrice: ({ variants_min_price: amount, currency }: SearchProductHit, locale?: string) => string;
+/**
+ * The lowest compare-at price, struck next to the price, only when it is
+ * higher than a shown price; it may belong to another variant.
+ */
+export declare const formatSearchCompareAtPrice: (hit: SearchProductHit, locale?: string) => string;
+//# sourceMappingURL=searchPrice.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"searchPrice.d.ts","sourceRoot":"","sources":["../../src/utils/searchPrice.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAsBxD,0EAA0E;AAC1E,eAAO,MAAM,iBAAiB,GAC5B,0CAA0C,gBAAgB,EAC1D,SAAS,MAAM,KACd,MAAgD,CAAC;AAEpD;;;GAGG;AACH,eAAO,MAAM,0BAA0B,GACrC,KAAK,gBAAgB,EACrB,SAAS,MAAM,KACd,MAeF,CAAC"}

package/dist/utils/searchPrice.js

@@ -0,0 +1,30 @@
+// Hide a missing or invalid amount; show a bare amount when currency is absent.
+const formatAmount = (amount, currency, locale) => {
+    if (amount === undefined || !Number.isFinite(amount)) {
+        return "";
+    }
+    try {
+        return currency === undefined
+            ? new Intl.NumberFormat(locale).format(amount)
+            : new Intl.NumberFormat(locale, { style: "currency", currency }).format(amount);
+    }
+    catch {
+        return "";
+    }
+};
+/** The lowest variant price only, as on the Shopify storefront search. */
+export const formatSearchPrice = ({ variants_min_price: amount, currency }, locale) => formatAmount(amount, currency, locale);
+/**
+ * The lowest compare-at price, struck next to the price, only when it is
+ * higher than a shown price; it may belong to another variant.
+ */
+export const formatSearchCompareAtPrice = (hit, locale) => {
+    const { variants_min_price: price, variants_compare_at_price_min: compareAt, } = hit;
+    if (price === undefined ||
+        compareAt === undefined ||
+        !(compareAt > price) ||
+        formatSearchPrice(hit, locale) === "") {
+        return "";
+    }
+    return formatAmount(compareAt, hit.currency, locale);
+};

package/dist/utils/searchRequests.d.ts

@@ -1,17 +1,18 @@
-import { SearchIndex, SearchRequest, SearchResponse, SearchResult } from "../types/search";
-import { SearchSection } from "../types/searchController";
+import { SearchProductHit, SearchRequest, SearchResponse, SearchResult, SearchSections } from "../types/search";
+import { SearchControllerState, SearchSection } from "../types/searchController";
+export declare const INITIAL_SEARCH_STATE: SearchControllerState;
 export declare const normalizeQuery: (rawQuery: string) => string | undefined;
 interface SearchRequestConfig {
     indexName: string;
     language: string;
-    currency: string;
+    country: string;
     hitsPerPage: number;
 }
 interface SearchResults {
-    response: SearchResult;
-    sections: Partial<Record<SearchIndex, SearchResult>> | undefined;
+    response: SearchResult<SearchProductHit>;
+    sections: SearchSections | undefined;
 }
-export declare const buildSearchRequest: (query: string, page: number, sections: readonly SearchSection[], { indexName, language, currency, hitsPerPage }: SearchRequestConfig) => SearchRequest;
-export declare const readSearchResults: (result: SearchResponse, requested: readonly SearchSection[], { indexName, language, currency }: SearchRequestConfig) => SearchResults;
+export declare const buildSearchRequest: (query: string, page: number, sections: readonly SearchSection[], { indexName, language, country, hitsPerPage }: SearchRequestConfig) => SearchRequest;
+export declare const readSearchResults: (result: SearchResponse, requested: readonly SearchSection[], { indexName, language, country }: SearchRequestConfig) => SearchResults;
 export {};
 //# sourceMappingURL=searchRequests.d.ts.map

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,EACL,WAAW,EACX,aAAa,EACb,cAAc,EACd,YAAY,EACb,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAK1D,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,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,UAAU,aAAa;IACrB,QAAQ,EAAE,YAAY,CAAC;IACvB,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC,GAAG,SAAS,CAAC;CAClE;AAED,eAAO,MAAM,kBAAkB,GAC7B,OAAO,MAAM,EACb,MAAM,MAAM,EACZ,UAAU,SAAS,aAAa,EAAE,EAClC,gDAAgD,mBAAmB,KAClE,aAUD,CAAC;AAEH,eAAO,MAAM,iBAAiB,GAC5B,QAAQ,cAAc,EACtB,WAAW,SAAS,aAAa,EAAE,EACnC,mCAAmC,mBAAmB,KACrD,aAwBF,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,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"}

package/dist/utils/searchRequests.js

@@ -1,36 +1,46 @@
 import { searchIndexName } from "../services/search";
+import { SearchStatus, } from "../types/searchController";
+export const INITIAL_SEARCH_STATE = {
+    status: SearchStatus.IDLE,
+    query: "",
+    page: 0,
+    response: undefined,
+    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 buildSearchRequest = (query, page, sections, { indexName, language, currency, hitsPerPage }) => ({
+export const buildSearchRequest = (query, page, sections, { indexName, language, country, hitsPerPage }) => ({
     requests: [
         { indexName, query, page, hitsPerPage },
         ...sections.map((section) => ({
-            indexName: searchIndexName(section.index, language, currency),
+            indexName: searchIndexName(section.index, language, country),
             query,
             page: 0,
             hitsPerPage: section.hitsPerPage ?? hitsPerPage,
         })),
     ],
 });
-export const readSearchResults = (result, requested, { indexName, language, currency }) => {
+export const readSearchResults = (result, requested, { indexName, language, country }) => {
     const response = result.results.find((entry) => entry.index === indexName);
     if (response === undefined) {
         throw new Error(`Dialog search returned no ${indexName} entry`);
     }
     const sections = {};
     for (const section of requested) {
-        const requestedIndexName = searchIndexName(section.index, language, currency);
+        const requestedIndexName = searchIndexName(section.index, language, country);
         const entry = result.results.find((candidate) => candidate.index === requestedIndexName);
         if (entry !== undefined) {
             sections[section.index] = entry;
         }
     }
     return {
-        response,
+        // Each index answers its own record type.
+        response: response,
         sections: requested.length === 0 ? undefined : sections,
     };
 };

package/package.json

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