@askdialog/dialog-sdk 2.11.0 → 2.12.0

package/dist/__tests__/searchControllerAttribution.spec.js

@@ -14,7 +14,7 @@ vi.mock("../utils/searchImpressions", () => ({
 const response = (overrides = {}) => ({
     results: [
         {
-            index: "products_fr",
+            index: "products_fr_eur",
             hits: [
                 { objectID: "p1", url: "https://shop.example/p1" },
                 { objectID: "p2" },
@@ -36,13 +36,14 @@ const trackSelectSearchResult = vi.fn();
 const navigate = vi.fn();
 const createController = () => createSearchController({
     search,
+    language: "fr",
+    currency: "EUR",
     analytics: {
         surface: "search_page",
         trackViewSearchResults,
         trackSelectSearchResult,
     },
     navigate,
-    locale: "fr",
 });
 beforeEach(() => {
     vi.useFakeTimers();
@@ -75,7 +76,7 @@ describe("search controller attribution", () => {
         await settle();
         expect(tracker.setContext).toHaveBeenCalledWith({
             query_id: "qid-1",
-            index: "products_fr",
+            index: "products_fr_eur",
             surface: "search_page",
             search_type: "lexical",
             page: 2,
@@ -105,7 +106,7 @@ describe("search controller attribution", () => {
         await settle();
         expect(trackViewSearchResults).toHaveBeenCalledWith({
             query_id: "qid-1",
-            index: "products_fr",
+            index: "products_fr_eur",
             surface: "search_page",
             search_type: "lexical",
             page: 1,
@@ -151,7 +152,7 @@ describe("search controller attribution", () => {
         });
         expect(trackSelectSearchResult).toHaveBeenCalledWith({
             query_id: "qid-1",
-            index: "products_fr",
+            index: "products_fr_eur",
             surface: "search_page",
             search_type: "lexical",
             page: 1,
@@ -201,12 +202,13 @@ describe("search controller attribution", () => {
     it("returns false when no navigate adapter is configured", async () => {
         const controller = createSearchController({
             search,
+            language: "fr",
+            currency: "EUR",
             analytics: {
                 surface: "search_page",
                 trackViewSearchResults,
                 trackSelectSearchResult,
             },
-            locale: "fr",
         });
         search.mockResolvedValue(response());
         controller.submit("shoes");

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",
+    index: "products_fr_eur",
     surface: "search_page",
     search_type: "lexical",
     page: 1,
@@ -184,8 +184,7 @@ describe("createSearchImpressionTracker", () => {
         vi.advanceTimersByTime(300);
         windowListeners.get("pageshow")?.({ persisted: true });
         intersect(card, 0.6);
-        // A stale pre-restore timer (200ms left) would record at 200ms and flush
-        // at 1700ms; a fresh dwell records at 500ms and flushes at 2000ms.
+        // Fresh dwell: record at 500ms and flush at 2000ms, not at 200ms and 1700ms.
         vi.advanceTimersByTime(1700);
         expect(emit).not.toHaveBeenCalled();
         vi.advanceTimersByTime(300);

package/dist/__tests__/searchService.spec.js

@@ -5,7 +5,7 @@ const API_KEY = "pk_test_abcdef";
 const request = {
     requests: [
         {
-            indexName: "products_fr",
+            indexName: "products_fr_eur",
             query: "running shoes",
             page: 2,
             hitsPerPage: 50,
@@ -15,7 +15,7 @@ const request = {
 const emptyResponse = {
     results: [
         {
-            index: "products_fr",
+            index: "products_fr_eur",
             hits: [],
             nbHits: 0,
             page: 0,
@@ -41,15 +41,17 @@ afterEach(() => {
 });
 describe("searchIndexName", () => {
     it.each([
-        ["fr-FR", "products_fr"],
-        ["pt-BR", "products_pt"],
-        ["fr", "products_fr"],
-        ["not a locale", "products_not a locale"],
-    ])("reduces the locale %s to a bare-language index name", (locale, name) => {
-        expect(searchIndexName("products", locale)).toBe(name);
+        ["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);
     });
     it("names every logical index", () => {
-        expect(searchIndexName("collections", "en-US")).toBe("collections_en");
+        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/);
     });
 });
 describe("searchLexical", () => {
@@ -69,11 +71,11 @@ describe("searchLexical", () => {
     it("keeps optional per-entry fields the caller did not provide off the wire", async () => {
         fetchMock.mockResolvedValue(jsonResponse(emptyResponse));
         await searchLexical(API_KEY, {
-            requests: [{ indexName: "products_fr", query: "running shoes" }],
+            requests: [{ indexName: "products_fr_eur", query: "running shoes" }],
         });
         const [, init] = fetchMock.mock.calls[0];
         expect(JSON.parse(init.body)).toEqual({
-            requests: [{ indexName: "products_fr", query: "running shoes" }],
+            requests: [{ indexName: "products_fr_eur", query: "running shoes" }],
         });
     });
     it("resolves the typed response, including empty results", async () => {

package/dist/searchController.d.ts

@@ -1,3 +1,3 @@
 import { SearchController, SearchControllerOptions } from "./types/searchController";
-export declare function createSearchController({ search, analytics, navigate, debounceMs, hitsPerPage, locale, sections, }: SearchControllerOptions): SearchController;
+export declare function createSearchController({ search, language, currency, analytics, navigate, 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":"AAOA,OAAO,EACL,gBAAgB,EAChB,uBAAuB,EAIxB,MAAM,0BAA0B,CAAC;AAqBlC,wBAAgB,sBAAsB,CAAC,EACrC,MAAM,EACN,SAAS,EACT,QAAQ,EACR,UAAgC,EAChC,WAAmC,EACnC,MAAM,EACN,QAAa,GACd,EAAE,uBAAuB,GAAG,gBAAgB,CA6L5C"}
+{"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"}

package/dist/searchController.js

@@ -1,16 +1,7 @@
-// This controller is one cohesive unit: `selectResult` reports whether the
-// navigate adapter handled the transition and the response is split into the
-// products entry plus its sections, pushing the file past the default 200-line
-// cap — raised modestly rather than split artificially.
-/* eslint max-lines: ["error", 240] */
 import { searchIndexName } from "./services/search";
 import { SearchStatus, } from "./types/searchController";
 import { createControllerAnalytics } from "./utils/searchControllerAnalytics";
-import { buildSectionQueries, pickSectionResults, } from "./utils/searchSections";
-const DEFAULT_DEBOUNCE_MS = 250;
-const DEFAULT_HITS_PER_PAGE = 12;
-// `SearchRequest` rejects queries under two visible characters (code points).
-const MIN_QUERY_CODE_POINTS = 2;
+import { buildSearchRequest, normalizeQuery, readSearchResults, } from "./utils/searchRequests";
 const INITIAL_STATE = {
     status: SearchStatus.IDLE,
     query: "",
@@ -19,18 +10,19 @@ const INITIAL_STATE = {
     sections: undefined,
     error: undefined,
 };
-export function createSearchController({ search, analytics, navigate, debounceMs = DEFAULT_DEBOUNCE_MS, hitsPerPage = DEFAULT_HITS_PER_PAGE, locale, sections = [], }) {
-    const indexName = searchIndexName("products", locale);
-    const resolveSections = () => typeof sections === "function" ? sections() : sections;
+export function createSearchController({ search, language, currency, analytics, navigate, debounceMs = 250, hitsPerPage = 12, sections = [], }) {
+    const requestConfig = {
+        indexName: searchIndexName("products", language, currency),
+        language,
+        currency,
+        hitsPerPage,
+    };
     let state = INITIAL_STATE;
     const listeners = new Set();
     const controllerAnalytics = createControllerAnalytics(analytics);
     let debounceTimer;
-    // Query typed but not yet run: `state.query` only holds committed queries, so
-    // without this, `setPage()` would cancel the debounce and paginate stale results.
     let pendingQuery;
     let abortController;
-    // Monotonic token: a response only lands if it belongs to the latest request.
     let requestId = 0;
     let disposed = false;
     const setState = (patch) => {
@@ -39,45 +31,40 @@ export function createSearchController({ search, analytics, navigate, debounceMs
             listener(state);
         }
     };
-    const cancelInFlight = () => {
+    const cancelPendingSearch = () => {
         clearTimeout(debounceTimer);
+        pendingQuery = undefined;
+        requestId += 1;
         abortController?.abort();
         abortController = undefined;
     };
-    const buildRequest = (query, page, requested) => ({
-        requests: [
-            { indexName, query, page, hitsPerPage },
-            ...buildSectionQueries(requested, query, locale, hitsPerPage),
-        ],
-    });
     const run = async (query, page) => {
-        cancelInFlight();
+        cancelPendingSearch();
         abortController = new AbortController();
-        const id = ++requestId;
+        const id = requestId;
         setState({ status: SearchStatus.LOADING, query, page });
         try {
-            const requested = resolveSections();
-            const response = await search(buildRequest(query, page, requested), {
+            const requested = typeof sections === "function" ? sections() : sections;
+            const request = buildSearchRequest(query, page, requested, requestConfig);
+            const response = await search(request, {
                 signal: abortController.signal,
             });
             if (id !== requestId) {
-                return; // A newer request landed first: this response is stale.
-            }
-            const result = response.results.find((entry) => entry.index === indexName);
-            if (result === undefined) {
-                throw new Error(`Dialog search returned no ${indexName} entry`);
+                return; // Ignore a superseded request.
             }
-            controllerAnalytics.onResponse(result);
+            const results = readSearchResults(response, requested, requestConfig);
+            controllerAnalytics.onResponse(results.response);
             setState({
-                status: result.nbHits === 0 ? SearchStatus.EMPTY : SearchStatus.SUCCESS,
-                response: result,
-                sections: pickSectionResults(response, requested, locale),
+                ...results,
+                status: results.response.nbHits === 0
+                    ? SearchStatus.EMPTY
+                    : SearchStatus.SUCCESS,
                 error: undefined,
             });
         }
         catch (error) {
             if (error instanceof DOMException && error.name === "AbortError") {
-                return; // Superseded by a newer request — never surfaced.
+                return; // Cancellation is not a search error.
             }
             if (id !== requestId) {
                 return;
@@ -90,33 +77,28 @@ export function createSearchController({ search, analytics, navigate, debounceMs
             });
         }
     };
-    // Shared by `setQuery`/`submit`: undefined = reset to idle (query too short).
-    const prepare = (rawQuery) => {
-        const query = rawQuery.trim();
-        cancelInFlight();
-        pendingQuery = undefined;
-        if ([...query].length < MIN_QUERY_CODE_POINTS) {
-            requestId += 1; // Invalidate anything in flight.
-            setState(INITIAL_STATE);
-            return undefined;
-        }
-        return query;
-    };
     return {
         setQuery(rawQuery) {
-            const query = disposed ? undefined : prepare(rawQuery);
+            if (disposed) {
+                return;
+            }
+            cancelPendingSearch();
+            const query = normalizeQuery(rawQuery);
             if (query === undefined) {
+                setState(INITIAL_STATE);
                 return;
             }
             pendingQuery = query;
-            debounceTimer = setTimeout(() => {
-                pendingQuery = undefined;
-                void run(query, 0);
-            }, debounceMs);
+            debounceTimer = setTimeout(() => void run(query, 0), debounceMs);
         },
         submit(rawQuery) {
-            const query = disposed ? undefined : prepare(rawQuery);
+            if (disposed) {
+                return;
+            }
+            cancelPendingSearch();
+            const query = normalizeQuery(rawQuery);
             if (query === undefined) {
+                setState(INITIAL_STATE);
                 return;
             }
             void run(query, 0);
@@ -126,15 +108,12 @@ export function createSearchController({ search, analytics, navigate, debounceMs
                 return;
             }
             if (pendingQuery !== undefined) {
-                // A query change is pending: the click targeted stale results, so the
-                // new query supersedes pagination — flush it now instead of debouncing.
-                const query = pendingQuery;
-                pendingQuery = undefined;
-                void run(query, 0);
+                // Submit pending input on page zero before allowing pagination.
+                void run(pendingQuery, 0);
                 return;
             }
             if (state.query === "") {
-                return; // Pagination requires a committed non-empty query.
+                return; // No query to paginate.
             }
             void run(state.query, page);
         },
@@ -173,9 +152,7 @@ export function createSearchController({ search, analytics, navigate, debounceMs
         getState: () => state,
         dispose() {
             disposed = true;
-            cancelInFlight();
-            requestId += 1;
-            pendingQuery = undefined;
+            cancelPendingSearch();
             listeners.clear();
             controllerAnalytics.dispose();
         },

package/dist/services/search.d.ts

@@ -1,8 +1,6 @@
 import { SearchIndex, SearchOptions, SearchRequest, SearchResponse } from "../types/search";
-export declare const searchIndexName: (index: SearchIndex, locale: string) => string;
-/**
- * One POST per invocation — no debounce, cache, retry or request state; the
- * caller owns cancellation through `options.signal`.
- */
+/** 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;
+/** 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;AAMzB,eAAO,MAAM,eAAe,GAAI,OAAO,WAAW,EAAE,QAAQ,MAAM,KAAG,MACzB,CAAC;AAoB7C;;;GAGG;AACH,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,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"}

package/dist/services/search.js

@@ -1,9 +1,17 @@
 import { config } from "../config";
 import { DialogSearchError } from "../DialogSearchError";
-import { toIso639LanguageCode } from "../utils/localization";
 const SEARCH_PATH = "/public/search/lexical";
 const API_KEY_HEADER = "x-dialog-api-key";
-export const searchIndexName = (index, locale) => `${index}_${toIso639LanguageCode(locale)}`;
+/** Build an index name from an ISO 639-1 language and ISO 4217 currency. */
+export const searchIndexName = (index, language, currency) => {
+    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.");
+    }
+    return `${index}_${language}_${currency.toLowerCase()}`;
+};
 const toSearchError = async (response) => {
     let body;
     try {
@@ -18,10 +26,7 @@ const toSearchError = async (response) => {
         : response.statusText;
     return new DialogSearchError({ status: response.status, code, message });
 };
-/**
- * One POST per invocation — no debounce, cache, retry or request state; the
- * caller owns cancellation through `options.signal`.
- */
+/** Send one request. The caller controls cancellation through `options.signal`. */
 export const searchLexical = async (apiKey, request, options) => {
     const response = await fetch(`${config.monolithApiUrl}${SEARCH_PATH}`, {
         method: "POST",

package/dist/types/constructor.d.ts

@@ -12,7 +12,10 @@ export interface CurrentProduct {
 }
 export interface DialogConstructor {
     apiKey: string;
+    /** BCP-47 locale, e.g. `fr-FR`. */
     locale: string;
+    /** Currency (ISO 4217), independent of language. */
+    currency: string;
     /**
      * Optional ISO 3166 country code used to format prices (e.g. 'FR', 'US').
      * When provided it takes precedence over the country derived from `locale`.

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,MAAM,UAAU,CAAC;AAC1C,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;CACjC;AAED,MAAM,WAAW,cAAc;IAC7B,6EAA6E;IAC7E,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;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;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B"}
+{"version":3,"file":"constructor.d.ts","sourceRoot":"","sources":["../../src/types/constructor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAC1C,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;CACjC;AAED,MAAM,WAAW,cAAc;IAC7B,6EAA6E;IAC7E,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,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;;;;OAIG;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;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B"}

package/dist/types/search.d.ts

@@ -1,38 +1,38 @@
-/** Logical indices the public search serves; the wire name adds the locale. */
+/** Supported indices before adding language and currency. */
 export declare const SEARCH_INDICES: readonly ["products", "collections", "articles", "pages"];
 export type SearchIndex = (typeof SEARCH_INDICES)[number];
 export interface SearchQuery {
-    /** `<index>_<locale>` (e.g. `products_fr`), one shared locale per request; unknown or unserved → 404. */
+    /**
+     * `<index>_<lang>_<currency>`, e.g. `products_fr_eur`.
+     * Use the same language and lowercase ISO 4217 currency for every entry.
+     * Unsupported index names return 404.
+     */
     indexName: string;
-    /** Trimmed server-side; must keep at least two visible characters (code points). */
+    /** At least two code points after server-side trimming. */
     query: string;
-    /** Zero-indexed results page. Defaults to 0 server-side. */
+    /** Zero-based page; server default: 0. */
     page?: number;
-    /** Between 1 and 100. Defaults to 20 server-side. */
+    /** Page size from 1 to 100; server default: 20. */
     hitsPerPage?: number;
 }
 export interface SearchRequest {
     requests: SearchQuery[];
 }
 export interface SearchOptions {
-    /** Forwarded to fetch untouched: aborting rejects with the native AbortError. */
+    /** Passed to fetch; cancellation rejects with `AbortError`. */
     signal?: AbortSignal;
 }
 export interface SearchPrice {
-    /** Decimal amount as a string, exactly as indexed (e.g. "24.90"). */
+    /** Decimal string, e.g. "24.90". */
     amount: string;
-    /** Absent when the price was indexed without a currency. */
+    /** Currency code, if provided by the index. */
     currencyCode?: string;
 }
 export interface SearchPriceRange {
     min: SearchPrice;
     max: SearchPrice;
 }
-/**
- * A flat, storefront-ready record: `objectID` plus the record's attributes.
- * Every display field is best-effort — a hit may carry only its id;
- * `priceRange` only comes from the products index.
- */
+/** Indexed record. Display fields are optional; only products have `priceRange`. */
 export interface SearchHit {
     objectID: string;
     title?: string;
@@ -52,7 +52,7 @@ export interface SearchResult {
     query: string;
     queryID: string;
 }
-/** One entry per request entry, in request order. */
+/** 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,+EAA+E;AAC/E,eAAO,MAAM,cAAc,2DAKjB,CAAC;AAEX,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC;AAE1D,MAAM,WAAW,WAAW;IAC1B,yGAAyG;IACzG,SAAS,EAAE,MAAM,CAAC;IAClB,oFAAoF;IACpF,KAAK,EAAE,MAAM,CAAC;IACd,4DAA4D;IAC5D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qDAAqD;IACrD,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,WAAW,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,aAAa;IAC5B,iFAAiF;IACjF,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,MAAM,WAAW,WAAW;IAC1B,qEAAqE;IACrE,MAAM,EAAE,MAAM,CAAC;IACf,4DAA4D;IAC5D,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,gBAAgB;IAC/B,GAAG,EAAE,WAAW,CAAC;IACjB,GAAG,EAAE,WAAW,CAAC;CAClB;AAED;;;;GAIG;AACH,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,qDAAqD;AACrD,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,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"}

package/dist/types/search.js

@@ -1,4 +1,4 @@
-/** Logical indices the public search serves; the wire name adds the locale. */
+/** Supported indices before adding language and currency. */
 export const SEARCH_INDICES = [
     "products",
     "collections",

package/dist/types/searchAnalytics.d.ts

@@ -4,26 +4,32 @@ export declare const SEARCH_TYPES: readonly ["lexical"];
 export type SearchType = (typeof SEARCH_TYPES)[number];
 export interface SearchAnalyticsEnvelope {
     query_id: string;
-    /** Public index name the result came from (e.g. `products_fr`) — the Algolia Insights tuple's index. */
+    /** Index returned by the API, e.g. `products_fr_eur`. */
     index: string;
-    /** Where results are displayed — not the integration technology. */
+    /** UI surface displaying the results. */
     surface: SearchSurface;
-    /** Retrieval mode that produced the results. */
+    /** Search mode that produced the results. */
     search_type: SearchType;
-    /** 1-based results page. */
+    /** One-based results page. */
     page: number;
-    /** Total results for the query, not for the page. */
+    /** Total hits across all pages. */
     total_hits: number;
-    /** Code points of the trimmed query. */
+    /** Number of code points in the trimmed query. */
     query_length: number;
 }
+/** Position is one-based across pages: page 2 at 20 hits/page starts at 21. */
 export interface SearchResultItem {
     product_id: string;
     position: number;
 }
+/**
+ * Impressions batched and deduplicated by (query_id, product_id).
+ * Empty results use `items: []` and `total_hits: 0`.
+ */
 export interface ViewSearchResultsParams extends SearchAnalyticsEnvelope {
     items: SearchResultItem[];
 }
+/** One selected result per event. */
 export interface SelectSearchResultParams extends SearchAnalyticsEnvelope {
     items: [SearchResultItem];
 }

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

@@ -1 +1 @@
-{"version":3,"file":"searchAnalytics.d.ts","sourceRoot":"","sources":["../../src/types/searchAnalytics.ts"],"names":[],"mappings":"AAKA,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,wGAAwG;IACxG,KAAK,EAAE,MAAM,CAAC;IACd,oEAAoE;IACpE,OAAO,EAAE,aAAa,CAAC;IACvB,gDAAgD;IAChD,WAAW,EAAE,UAAU,CAAC;IACxB,4BAA4B;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,qDAAqD;IACrD,UAAU,EAAE,MAAM,CAAC;IACnB,wCAAwC;IACxC,YAAY,EAAE,MAAM,CAAC;CACtB;AAID,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAMD,MAAM,WAAW,uBAAwB,SAAQ,uBAAuB;IACtE,KAAK,EAAE,gBAAgB,EAAE,CAAC;CAC3B;AAGD,MAAM,WAAW,wBAAyB,SAAQ,uBAAuB;IACvE,KAAK,EAAE,CAAC,gBAAgB,CAAC,CAAC;CAC3B;AAKD,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,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"}

package/dist/types/searchAnalytics.js

@@ -1,7 +1,4 @@
-// Storefront-search analytics contract (DEC-2448), snake_case end to end:
-// these property names ARE the canonical PostHog properties — the host
-// bridge forwards them verbatim (no camelCase mapping), so any rename here
-// is a breaking change of the cross-repo contract.
+// Property names are forwarded unchanged to analytics; renaming them breaks consumers.
 export const SEARCH_SURFACES = [
     "autocomplete",
     "search_page",