@nuskin/react-search-sdk 1.0.0-trying-again.1 → 1.0.0-trying-again.2

package/dist/index.d.mts

@@ -1,652 +1,60 @@
-import React, { ReactNode, ReactElement } from 'react';
-import { SearchModalCopy } from '@nuskin/react-search-components';
-import { SalesAIChatWidgetProps } from '@nuskin/react-nui-chat-sdk';
+import { ReactNode, ReactElement } from 'react';
 
 /**
- * Shared TypeScript types for the search SDK.
- *
- * Kept intentionally permissive at the boundary (`unknown`, `[key: string]: unknown`)
- * to preserve the drop-in behavior of the ported JavaScript service. Downstream
- * consumers can narrow at their integration point.
- */
-
-/** Normalised locale parts as consumed by the SDK. */
-interface LocaleParts {
-    /** ISO 3166-1 alpha-2, upper-case. Example: `"US"`. */
-    country: string;
-    /** ISO 639-1, lower-case. Example: `"en"`. */
-    language: string;
-    /** Full Contentstack-style locale string. Example: `"US-en"`. */
-    locale: string;
-}
-/**
- * Shape returned by the market-config lookup. Only the fields the SDK reads
- * are typed; consumers may pass through additional properties.
- */
-interface MarketConfig {
-    api_gateway_path?: string;
-    store_id?: string | number;
-    [key: string]: unknown;
-}
-/** Callback the consumer wires in to resolve market config on demand. */
-type GetMarketConfig = (context: {
-    locationLike: LocationLike | null;
-    country: string;
-}) => Promise<MarketConfig | null | undefined>;
-/**
- * The subset of the DOM `Location` interface the SDK depends on. Every
- * property is optional so tests can pass minimal fakes.
- */
-interface LocationLike {
-    origin?: string;
-    hostname?: string;
-    pathname?: string;
-    search?: string;
-    href?: string;
-    assign?: (url: string) => void;
-}
-/**
- * A raw suggestion / option payload used for navigation. Fields mirror the
- * shapes the original service defensively read from — none are required.
- */
-interface SuggestionOption {
-    slug?: string | undefined;
-    productSlug?: string | undefined;
-    product_slug?: string | undefined;
-    href?: string | undefined;
-    url?: string | undefined;
-    value?: string | undefined;
-    label?: string | undefined;
-    identifier?: string | undefined;
-    [key: string]: unknown;
-}
-/** Response shape returned by `fetchSuggestions`. */
-interface SuggestionsResponse {
-    /** Suggestions array. May be empty when the API returns no matches. */
-    suggestions: unknown[];
-    /** "Did you mean?" alternate-query suggestions. */
-    didYouMean: unknown[];
-    /** Total match count reported by the API. */
-    totalResultsCount: number;
-    /** Original product array from the catalog API. */
-    product?: unknown;
-    /** Pageable metadata from the catalog API. */
-    pageableInfo?: {
-        totalCount?: number;
-    } & Record<string, unknown>;
-    /** Original snake_case field name from some API variants. */
-    did_you_mean?: unknown;
-    [key: string]: unknown;
-}
-/** Copy strings surfaced to the input chrome. */
-interface SearchChromeCopy {
-    placeholder: string;
-    inputAriaLabel: string;
-}
-/** Mapped product type after normalisation. */
-type ProductType = 'bundle' | 'single';
-/**
- * A catalog suggestion item produced by `mapCatalogProductToSuggestion`.
- * All navigation fields are preserved from the original service shape.
- */
-interface CatalogSuggestionItem {
-    id: string;
-    identifier: string;
-    sku: string;
-    label: string;
-    value: string;
-    imageURL: string;
-    thumbnail: string;
-    productType: ProductType;
-    product_type: ProductType;
-    outOfStock: boolean;
-    productStatus: string | undefined;
-    status: string | undefined;
-    cartActionDisabled: boolean;
-    customProductType: string;
-    slug: string | null;
-    productSlug: string | null;
-    url: string | null;
-    href: string | null;
-    keywords: string;
-    ingredientTerms: string[];
-}
-/**
- * A "Did You Mean?" item produced by `normalizeDidYouMean`. Additional
- * fields from the raw API response are preserved via index signature.
- */
-interface DidYouMeanItem {
-    id: string;
-    value: string;
-    suggestionType: 'did-you-mean';
-    [key: string]: unknown;
-}
-/** Options accepted by `useSearchSuggestions`. */
-interface UseSearchSuggestionsOptions {
-    /** The `SearchService` instance created by `createSearchService`. */
-    service: SearchService;
-    /**
-     * When `false` the hook clears state and skips all API calls.
-     * Useful for suppressing suggestions while the user is typing a question.
-     * Defaults to `true`.
-     */
-    enabled?: boolean;
-}
-/** State and actions returned by `useSearchSuggestions`. */
-interface UseSearchSuggestionsResult {
-    /**
-     * Resets the query to `""` and clears all suggestions state.
-     * Call when the user clicks the Clear button.
-     */
-    clearQuery: () => void;
-    /**
-     * `true` after a fetch completes with an empty result set.
-     * Use this to show a "No suggestions" message.
-     */
-    emptyFetched: boolean;
-    /** `true` when the server has more matches than `MAX_VISIBLE_SUGGESTIONS`. */
-    hasMoreResults: boolean;
-    /** `true` when the trimmed query is non-empty. */
-    hasQuery: boolean;
-    /** `true` when the latest suggestions request failed. */
-    suggestionFetchFailed: boolean;
-    /** Normalised "Did You Mean?" items from the API. */
-    didYouMean: DidYouMeanItem[];
-    /** `true` while a debounced fetch is in flight. */
-    loading: boolean;
-    /** The current query string (unmodified, as typed by the user). */
-    query: string;
-    /**
-     * The trimmed query the current results (or failure) belong to; `""` until a
-     * fetch has finished. Compare with `query.trim()` to know whether the
-     * results on screen are for the term the user has typed.
-     */
-    settledQuery: string;
-    /** Raw React state setter — prefer `updateQuery` for controlled inputs. */
-    setQuery: React.Dispatch<React.SetStateAction<string>>;
-    /** Normalised product suggestion items from the catalog API. */
-    suggestions: CatalogSuggestionItem[];
-    /** Total match count reported by the Equinox API. */
-    totalResultsCount: number;
-    /**
-     * Preferred setter — updates `query`, optimistically sets `loading`, and
-     * clears `emptyFetched` before the debounce fires.
-     */
-    updateQuery: (query: string) => void;
-}
-/** Options accepted by `createSearchService`. */
-interface SearchServiceOptions {
-    /** Custom `fetch` implementation. Defaults to the global `fetch` when available. */
-    fetchImpl?: typeof fetch | null | undefined;
-    /** DOM `Location`-like object. Defaults to `window.location` in the browser. */
-    location?: LocationLike | null | undefined;
-    /** Storage-like object. Defaults to `window.sessionStorage` in the browser. */
-    storage?: Storage | null | undefined;
-    /**
-     * Explicit suggestions URL or path. When provided, overrides the market-config
-     * lookup. Absolute URLs are used as-is; paths are resolved against
-     * `location.origin`.
-     */
-    suggestionsApi?: string | undefined;
-    /** Explicit Equinox store ID. When provided, overrides the market-config lookup. */
-    storeId?: string | number | undefined;
-    /** ISO 3166-1 alpha-2 country code. Normalised to upper-case. */
-    country?: string | undefined;
-    /** ISO 639-1 language code. Normalised to lower-case. */
-    language?: string | undefined;
-    /** Full Contentstack-style locale string. Falls back to `"UNKNOWN"`. */
-    locale?: string | undefined;
-    /** Placeholder text for the expanded input. */
-    searchPlaceholder?: string | undefined;
-    /** Aria-label for the expanded input. */
-    inputAriaLabel?: string | undefined;
-    /**
-     * Async callback resolving to a `MarketConfig`. Required for automatic
-     * suggestion-URL/storeId resolution when `suggestionsApi`/`storeId` are
-     * not passed explicitly.
-     */
-    getMarketConfig?: GetMarketConfig | undefined;
-    /**
-     * Optional callback invoked when a suggestion action (cart icon click) is activated.
-     * Allows consumers to implement custom behavior (e.g., add-to-cart) before navigation.
-     * If this returns `true`, navigation is skipped; if `false` or undefined, normal navigation proceeds.
-     */
-    onSuggestionAction?: (option: SuggestionOption) => Promise<boolean> | boolean | undefined;
-}
-/** Public API returned by `createSearchService`. */
-interface SearchService {
-    /** Returns fallback placeholder + aria-label copy. */
-    getSearchChromeCopy: () => Promise<SearchChromeCopy>;
-    /** Fetches typeahead suggestions from the Equinox catalog. */
-    fetchSuggestions: (searchTerm: string) => Promise<SuggestionsResponse>;
-    /**
-     * Records the query in recent searches, then returns the option URL or the
-     * fallback search-results path for the consuming router to navigate.
-     */
-    submitProductSearch: (query: string, option?: SuggestionOption) => string | undefined;
-    /**
-     * Returns the suggestion's URL if one is resolvable; otherwise submits the
-     * suggestion's textual value as a product search.
-     */
-    activateSuggestionAction: (option: SuggestionOption) => string | undefined;
-    /** Returns the navigable URL for a suggestion option (or `""`). */
-    getSuggestionHref: (option: SuggestionOption) => string;
-    /** Returns the search-results page path for `query`. */
-    viewMoreResults: (input: {
-        query: string;
-    }) => string | undefined;
-    /** Returns the persisted recent searches for the current locale bucket. */
-    getRecentSearches: () => string[];
-    /** Removes all persisted recent searches for the current locale bucket. */
-    clearRecentSearches: () => void;
-}
-
-/**
- * SearchApiService — Phase 0 lift-and-shift of
- * `header-mfe/src/services/HeaderSearchService.js`.
- *
- * Behaviour follows the header search contract for URL formats,
- * `sessionStorage` key format, fetch parameter shape, and fallback values.
- * Navigation side effects are left to the consuming router.
- *
- * Two responsibilities were intentionally moved OUT of the SDK to preserve
- * the SDK-narrow boundary:
- *   1. Market-config resolution (`equinoxMarketsConfig.js` — depends on
- *      `@nuskin/configuration-sdk`). Consumers inject a `getMarketConfig`
- *      callback if they want automatic URL/store-id resolution.
- *   2. Locale resolution from the browser URL (`getLocale`). Consumers must
- *      pass `country`/`language` explicitly.
- */
-
-/**
- * Replaces `{api_name}` in a market-config gateway path with the given API
- * name, then trims a single trailing slash. Ported from the equivalent helper
- * in `equinoxMarketsConfig.js` so the SDK has no runtime dependency on it.
- */
-declare function resolveApiGatewayPath(apiGatewayPath: string | undefined | null, apiName?: string): string;
-/**
- * Creates a search service instance. All options are optional; sensible
- * fallbacks are used when the browser environment is absent (SSR).
- */
-declare function createSearchService(options?: SearchServiceOptions): SearchService;
-
-/**
- * useSearchSuggestions — Phase 0 lift-and-shift of
- * `header-mfe/src/components/search/auto-complete/hooks/useAutoComplete.js`
- * (`useAutoCompleteSuggestions` export).
- *
- * Behaviour is preserved verbatim:
- *   - 220 ms debounce (DEBOUNCE_MS constant — do not change)
- *   - Request-ID stale-response guard (replaces AbortController in the original)
- *   - `MAX_VISIBLE_SUGGESTIONS` cap applied before setting state
- *   - `didYouMean` items take precedence: when present, `suggestions` is set
- *     to `[]` and the DYM items are used as the visible list
- *   - `emptyFetched` is only set to `true` when BOTH arrays are empty after
- *     a successful fetch
- *   - `enabled = false` clears state without firing an API call
- *
- * Keyboard navigation (`useAutoCompleteKeyboard`) and all display-data helpers
- * live in `react-search-components` — they depend on DOM refs and component props.
- */
-
-/**
- * Manages debounced typeahead suggestions from the Equinox catalog API.
- *
- * @example
- * ```tsx
- * const service = createSearchService({ country, language, locale, suggestionsApi, storeId });
- * const { suggestions, didYouMean, loading, updateQuery, clearQuery } =
- *   useSearchSuggestions({ service });
- * ```
- */
-declare function useSearchSuggestions({ service, enabled, }: UseSearchSuggestionsOptions): UseSearchSuggestionsResult;
-
-/**
- * Catalog-product normalisation helpers — Phase 0 lift-and-shift of the
- * relevant portions of
- * `header-mfe/src/components/search/auto-complete/autoComplete.helpers.js`.
- *
- * Only the data-processing helpers are included here. UI-specific helpers
- * (keyboard event handlers, ARIA attribute computation, display-data
- * extraction) live in `react-search-components` because they depend on DOM
- * refs and component-level props.
- *
- * Key difference from the original:
- *   `resolveSuggestionImageSrc` returns `""` when the source is absent
- *   instead of falling back to a bundled PNG asset. Components apply their
- *   own `<img onError>` / CSS placeholder; the SDK must not bundle assets.
- */
-
-/** Returns `true` when `productStatus` is `"sellable"`. */
-declare function isSellableProductStatus(productStatus: unknown): boolean;
-/**
- * Returns `true` when the suggestion option should not allow add-to-cart
- * (out of stock, discontinued, inactive, etc.).
- */
-declare function isCartActionDisabled(suggestionOption: Record<string, unknown> | null | undefined): boolean;
-/**
- * Returns `true` when the suggestion row should be displayed as
- * non-interactive (out-of-stock only — a subset of `isCartActionDisabled`).
- */
-declare function isSuggestionDisabled(suggestionOption: Record<string, unknown> | null | undefined): boolean;
-/**
- * Reads the first non-empty image URL from a Contentstack / catalog property
- * bag. Returns `""` when no image is found.
+ * Where `CommerceSearch` wants the host to take the shopper: a page inside the app (a path for
+ * the host's router, with the market prefix already removed), or somewhere that needs a full
+ * page load.
  */
-declare function getImageFromProperty(properties?: Record<string, unknown>): string;
-/**
- * Normalises an image source value. Returns `""` when the source is absent or
- * blank. Components are responsible for applying a fallback placeholder image.
- */
-declare function resolveSuggestionImageSrc(imageSrc: unknown): string;
-/**
- * Extracts a flat list of ingredient terms from a Contentstack ingredient
- * structure. Used to populate `CatalogSuggestionItem.ingredientTerms`.
- */
-declare function getIngredientTerms(rawIngredients: unknown): string[];
-/**
- * Maps a raw Equinox catalog product object to the normalised
- * `CatalogSuggestionItem` shape consumed by the UI components.
- * Returns `null` for invalid input so callers can `.filter(Boolean)`.
- */
-declare function mapCatalogProductToSuggestion(product: unknown, index?: number): CatalogSuggestionItem | null;
-/**
- * Normalises the raw `didYouMean` / `did_you_mean` array from the Equinox
- * API into a consistent shape consumed by `useSearchSuggestions`.
- */
-declare function normalizeDidYouMean(didYouMean: unknown): DidYouMeanItem[];
-/**
- * Returns the items that should actually be rendered in the suggestions list.
- * When "Did You Mean?" results are present they take precedence over product
- * suggestions (matching the original header-mfe behaviour).
- */
-declare function getVisibleSuggestions(opts: {
-    didYouMean: DidYouMeanItem[];
-    suggestions: CatalogSuggestionItem[];
-}): DidYouMeanItem[] | CatalogSuggestionItem[];
-/**
- * Builds the analytics payload emitted when the user clicks "See More Results".
- */
-declare function getSeeMoreResultsPayload(query: string, totalResultsCount: number, suggestions: CatalogSuggestionItem[]): {
-    query: string;
-    source: string;
-    totalResultsCount: number;
-    visibleResultsCount: number;
+type NavigationTarget = {
+    type: 'internal';
+    path: string;
+} | {
+    type: 'external';
+    url: string;
 };
 
 /**
- * Types + Window augmentation for the GTM (Google Tag Manager) tracking layer.
- */
-declare global {
-    interface Window {
-        dataLayer?: unknown[];
-    }
-}
-type SearchGtmUserStatus = 'guest' | 'logged_in';
-type SearchGtmSearchType = 'semantic search' | 'AI agent';
-/**
- * Context shared by every AI-chat GTM event. Values that are unknown at
- * emit time should be passed as an empty string so the schema stays stable
- * (matches the placeholder shape the data team provided in COMX-3277).
+ * The account types the suggestions API distinguishes, sent as `X-Customer-Type`.
+ *
+ * TODO: this set is a best guess from the values the storefront sends. Confirm what the
+ * suggestions API accepts, experimentally, once the search runs against it.
  */
-interface SearchGtmContext {
-    /** NUi conversation id (the widget's `onConversationChange`), coerced to string. */
-    chatId?: string | number;
-    /** Page type where the chat was initiated (e.g. `plp`, `pdp`, `home`). */
-    pageType?: string;
-    /** ISO 3166-1 alpha-2 country code (e.g. `US`, `DE`). */
-    countryCode?: string;
-    /** Language code (e.g. `en`, `de`). */
-    language?: string;
-    /**
-     * Whether the visitor is a guest or a logged-in user.
-     * Falls back to the `IsAuthenticated` localStorage flag written by the
-     * storefront `Session` model when not supplied by the host.
-     */
-    userStatus?: SearchGtmUserStatus;
-    /** Authenticated user id, or empty for guests. */
+type CustomerAccountType = 'guest' | 'Brand Affiliate' | 'Retail Customer' | 'Preferred Customer/Member';
+/** Who is searching. */
+interface CommerceSearchCustomer {
+    /** Whether the visitor is signed in. The NUi agent is for signed-in visitors only. */
+    isAuthenticated: boolean;
+    /** Defaults to `guest`. Ignored for a visitor who is not signed in. */
+    accountType?: CustomerAccountType;
+    /** The signed-in visitor's id, for analytics. */
     userId?: string;
-    /**
-     * Customer account type (e.g. `Retail Customer`, `Brand Affiliate`).
-     * Falls back to the `accountType` localStorage value written by the
-     * storefront `Customer` / `MyAccount` flows when not supplied.
-     */
-    accountType?: string;
-}
-/** Payload for the Search_Type event (query the user submitted). */
-interface SearchTypeEventInput extends SearchGtmContext {
-    /** Type of AI search: `semantic search` or `AI agent`. */
-    searchType?: SearchGtmSearchType;
-    /** User's raw search query / response text. */
-    searchResponse?: string;
-}
-/** Payload for the ProductSearch event (results returned to the user). */
-interface ProductSearchEventInput extends SearchGtmContext {
-    searchType?: SearchGtmSearchType;
-    /** Number of product results shown to the user. */
-    productResults?: number;
-    /** Raw products payload to send into Product_results as JSON string. */
-    productResultsData?: unknown;
-}
-/** Payload for the Error_popup event. */
-interface ErrorPopupEventInput extends SearchGtmContext {
-    searchType?: SearchGtmSearchType;
-}
-
-/** How the host's NUi app is reached and presented. */
-interface NuiAgentConfig {
-    /** The NUi app key for the search surface. */
-    appKey: string;
-    /** Origin of the NUi API. */
-    apiBaseUrl: string;
-    /** UI language, e.g. `en-US`. */
-    language?: string;
-    /** Widget theme. Defaults to `nui-light`. */
-    theme?: SalesAIChatWidgetProps['theme'];
-    /** Context sent with every turn of the conversation, under the handoff context. */
-    context?: Record<string, unknown>;
-    /** Lets the host draw the agent's product recommendations. */
-    renderProduct?: SalesAIChatWidgetProps['renderProduct'];
 }
-
-/** How long a submit waits for the typeahead of that exact term before it stays on search. */
-declare const SUBMIT_WAIT_TIMEOUT_MS = 2000;
-interface ProductSearchProps {
+interface CommerceSearchProps {
     isOpen: boolean;
     onClose: () => void;
-    /** From `createSearchService`. Keep its identity stable (memoize it). */
-    service: SearchService;
-    /** Takes the shopper to a path, using the host's router. The panel closes afterwards. */
-    navigate: (path: string) => void;
-    /** Whether the visitor is signed in (the storefront's `customerData.isAuthenticated`). */
-    isAuthenticated: boolean;
-    /** The NUi app the agent runs on. */
-    agent: NuiAgentConfig;
+    /**
+     * Takes the shopper to a destination, using the host's router for an internal path and a
+     * full page load for an external URL. The panel closes afterwards.
+     */
+    navigate: (target: NavigationTarget) => void;
+    /** Read on every request, so a change after sign-in is picked up. */
+    customer: CommerceSearchCustomer;
+    /** ISO 3166-1 alpha-2 market, for example `US`. */
+    country: string;
+    /** ISO 639-1 language, for example `en`. */
+    language: string;
+    /** Shown at the top of the panel, for example the brand logo. */
     logo?: ReactNode;
-    cancelLabel?: string;
-    fallbackImageUrl?: string;
-    copy?: SearchModalCopy;
-    /** Host-known values for the search analytics events. */
-    gtmContext?: Omit<SearchGtmContext, 'chatId'>;
-}
-/**
- * Product search with an agent fallback.
- *
- * Shows Solr typeahead and recent searches in the library's `SearchModal`. When a signed-in
- * shopper submits a term whose typeahead shows no products, the NUi agent takes over in the same
- * panel with that term as the first message. Everything else behaves as plain search.
- */
-declare function ProductSearch({ isOpen, onClose, service, navigate, isAuthenticated, agent, logo, cancelLabel, fallbackImageUrl, copy, gtmContext, }: Readonly<ProductSearchProps>): ReactElement;
-
-/**
- * The enable gate for NUi search.
- *
- * NUi search is on only for signed-in visitors who have switched it on with
- * the `enableNuiSearch` flag, set by a cookie or by a URL query parameter
- * (`?enableNuiSearch=true` or `=false`). The query parameter also writes the
- * cookie, so the choice sticks while the visitor navigates. Off by default.
- *
- * The flag is a client-side feature toggle, not a security control. Real
- * per-market and per-locale switching is a later step.
- */
-/** Name shared by the cookie and the URL query parameter. */
-declare const NUI_SEARCH_FLAG = "enableNuiSearch";
-/** Where the flag is read from and written to. Defaults to the browser. */
-interface NuiSearchFlagEnv {
-    /** Query string, with or without the leading `?`. */
-    search?: string;
-    /** Cookie string, as in `document.cookie`. */
-    cookie?: string;
-    /** Called with a cookie string to store when the query parameter is set. */
-    setCookie?: (cookie: string) => void;
-}
-/**
- * Resolves the flag. A valid query parameter wins over the cookie and is
- * written back to the cookie; otherwise the cookie decides. `undefined` means
- * it was never set. Safe to call during server rendering.
- */
-declare function resolveNuiSearchFlag(env?: NuiSearchFlagEnv): boolean | undefined;
-interface IsNuiSearchEnabledInput {
-    /** From the host (the storefront's `customerData.isAuthenticated`). */
-    isAuthenticated: boolean | undefined;
-    /** The resolved flag; see `resolveNuiSearchFlag`. */
-    flag: boolean | undefined;
-}
-/** On only when the visitor is signed in and the flag is explicitly on. */
-declare function isNuiSearchEnabled({ isAuthenticated, flag, }: IsNuiSearchEnabledInput): boolean;
-
-/**
- * Routing between Solr search and the NUi agent.
- *
- * Rule: when the shopper submits a search and the typeahead response for that
- * exact term shows no products, the NUi widget takes over in the same panel.
- * Anything else stays plain search. A pure function, so a smarter intent
- * heuristic can replace it later without touching any UI.
- */
-
-/**
- * - `search`  — stay on Solr search (submit behaves as it does today).
- * - `handoff` — hand the query to the NUi agent.
- * - `wait`    — the typeahead for this term has not settled yet; ask again when
- *               the snapshot changes. Callers should apply their own timeout and
- *               fall back to `search`, so a slow request never blocks a submit.
- */
-type SearchRoute = 'search' | 'handoff' | 'wait';
-/** The slice of `useSearchSuggestions` state the rule reads. */
-type RoutingSnapshot = Pick<UseSearchSuggestionsResult, 'query' | 'loading' | 'settledQuery' | 'suggestions' | 'suggestionFetchFailed'>;
-interface DecideSearchRouteInput {
-    /** Whether NUi search is on for this visitor (see `isNuiSearchEnabled`). */
-    enabled: boolean;
-    snapshot: RoutingSnapshot;
 }
 /**
- * Decides what a submitted search does.
- *
- * "No products" means the hook has nothing to show for the term. A response
- * that only offers "did you mean" terms counts as no products: the hook hides
- * the products in that case, so the shopper sees none either. A failed request
- * is not "no products": an outage must not send every shopper to the agent.
- */
-declare function decideSearchRoute({ enabled, snapshot, }: DecideSearchRouteInput): SearchRoute;
-
-/**
- * Extracts `{ countryCode, language }` from a storefront-shaped path
- * (`/{country}/{language}/...`, e.g. `/us/en/product/x`).
+ * The commerce website's single search entry point: typeahead and recent searches over the
+ * product catalog today, with the NUi agent taking over in the same panel when a signed-in
+ * shopper searches for something with no products. What it can answer is not limited to
+ * products — it is the commerce site's search, not a product-only search box.
  *
- * Reads `window.location.pathname` when called with no argument. Returns `{}`
- * if the first two path segments are not both 2-letter locale codes.
- */
-declare function getLocaleFromUrl(pathname?: string): {
-    countryCode?: string;
-    language?: string;
-};
-
-/**
- * GTM constants — event names, storage keys, and enum-like value maps.
- * Types are declared in `./gtmTypes` and imported here only for `satisfies`.
- */
-declare const SEARCH_GTM_EVENTS: {
-    readonly CHAT_ENTRY_POINT: "Begin_chat";
-    readonly SEARCH_TYPE: "Search_Type";
-    readonly PRODUCT_SEARCH: "ProductSearch";
-    readonly ERROR_POPUP: "Error_popup";
-};
-declare const SEARCH_GTM_SEARCH_TYPES: {
-    readonly SEMANTIC: "semantic search";
-    readonly AI_AGENT: "AI agent";
-};
-declare const SEARCH_GTM_USER_STATUS: {
-    readonly GUEST: "guest";
-    readonly LOGGED_IN: "logged_in";
-};
-
-/**
- * GTM (Google Tag Manager) dataLayer tracking for the AI Chat Bot.
- *
- * Implements the events specified in COMX-3277:
- *   1. Chatentry_Point  - user initiates the AI chat from an entry point
- *   2. Search_Type      - user submits a query in the AI chat
- *   3. ProductSearch    - AI chat returns product results (fires even on 0)
- *   4. Error_popup      - API errors / unhandled exceptions during a session
- *
- * All UI repos (react-search-components, and any host consuming the SDK)
- * should call these helpers instead of touching `window.dataLayer` directly,
- * so that payload shape and error handling stay consistent.
- *
- * Types live in `./gtmTypes`, constants in `./gtmConstants`, and generic
- * helpers in `./commonUtils` / `./storage`.
- */
-
-/**
- * Pushes a raw event object onto `window.dataLayer`.
- *
- * Silently no-ops when `window` is unavailable (SSR) or the dataLayer is
- * missing - GTM tag firing is a best-effort side effect, never a blocker for
- * the search flow.
- */
-declare function pushGtmEvent(event: Record<string, unknown>): void;
-/** Fires `Begin_chat` when the user initiates the AI chat. */
-declare function trackChatEntryPoint(ctx: SearchGtmContext): void;
-/** Fires `Search_Type` when the user submits a query in the AI chat. */
-declare function trackSearchType(input: SearchTypeEventInput): void;
-/**
- * Fires `ProductSearch` when the AI chat returns results.
- * Must be called even when 0 products are returned.
- */
-declare function trackProductSearch(input: ProductSearchEventInput): void;
-/** Fires `Error_popup` for API errors and unhandled exceptions during chat. */
-declare function trackErrorPopup(input: ErrorPopupEventInput): void;
-
-/**
- * Constants for the search SDK. Ported from
- * `header-mfe/src/utils/search/search.constants.js` — only the values the
- * SDK itself needs (Phase 0 lift-and-shift). CMS keys, GTM tracking config,
- * and mobile-only placeholder rotation constants stay in header-mfe.
+ * The package works out the rest itself: the market's catalog lookup, the minimum search length,
+ * which NUi app to use, the panel's text and the analytics fields.
  */
-/** API shopping-context segment used when resolving the Equinox gateway URL. */
-declare const STOREFRONT_SHOPPING_CONTEXT = "storefront";
-/** Catalog suggestions path appended when the market gateway is not already
- *  under the storefront shopping context. */
-declare const CATALOG_SUGGESTIONS_PATH = "/storefront/catalogs/search/suggestions";
-/** Prefix for the `sessionStorage` key that persists recent searches.
- *  Full key format: `${RECENT_SEARCHES_PREFIX}:{locale}:{COUNTRY}:{lang}`.
- *  Must not change — existing sessions rely on this key. */
-declare const RECENT_SEARCHES_PREFIX = "nuskin:header:recentSearches";
-/** Maximum number of recent searches persisted per locale bucket. */
-declare const RECENT_SEARCHES_DEFAULT_LIMIT = 10;
-/** Equinox suggestion pagination — page is 1-indexed. */
-declare const DEFAULT_SUGGESTION_PAGE = 1;
-/** Number of suggestion rows requested from the Equinox catalog per call. */
-declare const DEFAULT_SUGGESTION_SIZE = 6;
-/** Segment used when building the fallback search-results URL. */
-declare const DEFAULT_SEARCH_PATH = "/search";
-/** Debounce for typeahead input → API dispatch. Preserved from header-mfe. */
-declare const DEBOUNCE_MS = 220;
-/** Cap on suggestions rendered in the dropdown, regardless of API response size. */
-declare const MAX_VISIBLE_SUGGESTIONS = 6;
-/** Fallback placeholder shown inside the expanded search input. */
-declare const SEARCH_PLACEHOLDER = "Search by product name, ingredient, benefits, or SKU";
-/** Fallback placeholder shown on the collapsed search trigger. */
-declare const TRIGGER_PLACEHOLDER = "Product Search";
+declare function CommerceSearch({ isOpen, onClose, navigate, customer, country, language, logo, }: Readonly<CommerceSearchProps>): ReactElement;
 
-export { CATALOG_SUGGESTIONS_PATH, type CatalogSuggestionItem, DEBOUNCE_MS, DEFAULT_SEARCH_PATH, DEFAULT_SUGGESTION_PAGE, DEFAULT_SUGGESTION_SIZE, type DecideSearchRouteInput, type DidYouMeanItem, type ErrorPopupEventInput, type GetMarketConfig, type IsNuiSearchEnabledInput, type LocaleParts, type LocationLike, MAX_VISIBLE_SUGGESTIONS, type MarketConfig, NUI_SEARCH_FLAG, type NuiAgentConfig, type NuiSearchFlagEnv, ProductSearch, type ProductSearchEventInput, type ProductSearchProps, type ProductType, RECENT_SEARCHES_DEFAULT_LIMIT, RECENT_SEARCHES_PREFIX, type RoutingSnapshot, SEARCH_GTM_EVENTS, SEARCH_GTM_SEARCH_TYPES, SEARCH_GTM_USER_STATUS, SEARCH_PLACEHOLDER, STOREFRONT_SHOPPING_CONTEXT, SUBMIT_WAIT_TIMEOUT_MS, type SearchChromeCopy, type SearchGtmContext, type SearchGtmSearchType, type SearchGtmUserStatus, type SearchRoute, type SearchService, type SearchServiceOptions, type SearchTypeEventInput, type SuggestionOption, type SuggestionsResponse, TRIGGER_PLACEHOLDER, type UseSearchSuggestionsOptions, type UseSearchSuggestionsResult, createSearchService, decideSearchRoute, getImageFromProperty, getIngredientTerms, getLocaleFromUrl, getSeeMoreResultsPayload, getVisibleSuggestions, isCartActionDisabled, isNuiSearchEnabled, isSellableProductStatus, isSuggestionDisabled, mapCatalogProductToSuggestion, normalizeDidYouMean, pushGtmEvent, resolveApiGatewayPath, resolveNuiSearchFlag, resolveSuggestionImageSrc, trackChatEntryPoint, trackErrorPopup, trackProductSearch, trackSearchType, useSearchSuggestions };
+export { CommerceSearch, type CommerceSearchCustomer, type CommerceSearchProps, type CustomerAccountType, type NavigationTarget };