@bridgeline-digital/hawksearch-handlebars-ui 5.2.6 → 5.2.7

package/dist/index.d.ts

@@ -1,1438 +1 @@
-import * as Handlebars_2 from 'handlebars';
-
-/**
- * @category Autocomplete
- */
-declare interface AutocompleteCategories {
-    title: string;
-    results: Array<AutocompleteCategory>;
-}
-
-/**
- * @category Autocomplete
- */
-declare interface AutocompleteCategory {
-    title: string;
-    field: string;
-    value: string;
-    url: string;
-}
-
-declare interface AutocompleteComponentConfig extends BaseComponentConfig {
-}
-
-/**
- * @category Autocomplete
- */
-declare interface AutocompleteContent {
-    title: string;
-    results: Array<AutocompleteContentResult>;
-    totalRecords: number;
-}
-
-/**
- * @category Autocomplete
- */
-declare interface AutocompleteContentResult {
-    id: string;
-    title: string;
-    url: string;
-    pinned: boolean;
-    score: number;
-    attributes?: Record<string, Array<string>>;
-}
-
-/**
- * @category Tracking
- */
-declare enum AutocompleteItemType {
-    Search = 1,
-    Category = 2,
-    Product = 3,
-    Content = 4
-}
-
-/**
- * @category Autocomplete
- */
-declare interface AutocompleteProductResult extends Item {
-    pinned: boolean;
-    score: number;
-}
-
-/**
- * @category Autocomplete
- */
-declare interface AutocompleteProducts {
-    title: string;
-    results: Array<AutocompleteProductResult>;
-    totalRecords: number;
-}
-
-/**
- * @category Autocomplete
- */
-declare interface AutocompleteQueries {
-    title: string;
-    results: Array<AutocompleteQuery>;
-}
-
-/**
- * @category Autocomplete
- */
-declare interface AutocompleteQuery {
-    query: string;
-    url: string;
-}
-
-/**
- * @category Autocomplete
- */
-declare interface AutocompleteResponse {
-    query?: string;
-    categories: AutocompleteCategories;
-    content: AutocompleteContent;
-    products: AutocompleteProducts;
-    queries: AutocompleteQueries;
-    contentSuggestedQueries: AutocompleteQueries;
-    productSuggestedQueries: AutocompleteQueries;
-    totalRecords: number;
-    viewAllText: string;
-}
-
-declare class AutocompleteService extends BaseService {
-    protected baseUrl: string;
-    private decodeQuery;
-    query(query?: string): Promise<AutocompleteResponse>;
-    private executeAutocomplete;
-    private convertResponse;
-    bindComponent(autocompleteResponse: AutocompleteResponse): void;
-}
-
-declare interface BaseComponentConfig {
-    /**
-     * Specifies whether the component should be rendered in the [Shadow DOM](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_shadow_DOM). This is highly recommended to avoid CSS conflicts.
-     *
-     * #### Default Value
-     * `true`
-     */
-    shadowDom?: boolean;
-    /**
-     * Specifies a custom template to be used instead of the default template.
-     *
-     * *For more information, see {@link Components}.*
-     */
-    template?: string;
-}
-
-declare abstract class BaseService {
-    protected abstract baseUrl: string;
-    protected fieldMappings: ServiceFieldMappings;
-    protected variantFieldMappings: ServiceVariantFieldMappings;
-    queryStringParams: {
-        disableSpellcheck: string;
-        page: string;
-        pageSize: string;
-        query: string;
-        searchWithin: string;
-        sort: string;
-        requestType: string;
-    };
-    searchUrl: string;
-    protected get onSearchPage(): boolean;
-    constructor();
-    protected httpPost<T>(relativeUrl: string, body?: any, customHeaders?: any, isAbsoluteUrl?: boolean): Promise<T>;
-    private getHeaders;
-    private getFieldMappings;
-    protected getVisitorId(): string;
-    protected getVisitId(): string;
-    protected generateGuid(): string;
-    protected stripHtml(input: string): string;
-    protected getValue(data: object, fieldMappings: Array<string>): Array<string> | undefined;
-    protected getString(data: object, fieldMappings: Array<string>, defaultValue?: string): string | undefined;
-    protected getNumber(data: object, fieldMappings: Array<string>, defaultValue?: number): number | undefined;
-    protected getUrl(data: object, fieldMappings: Array<string>, prefix?: string | undefined): string | undefined;
-    protected getFullUrl(url: string | undefined, prefix: string | undefined): string | undefined;
-    protected getVariants(document: RawVariantDocument): {
-        items: Array<ItemVariant> | undefined;
-        selectedItem?: ItemVariant;
-    };
-    protected triggerBindEvent<T>(component: keyof HawkSearchComponents, data: T, filter?: string): void;
-    protected triggerEvent<T>(name: string, data: T): void;
-}
-
-declare interface Breakpoints<TValue> extends Record<DisplayType, TValue> {
-}
-
-declare interface CheckboxListFacetComponentConfig extends BaseComponentConfig {
-    excludeEnabled?: boolean;
-    strings?: {
-        collapse?: string;
-        exclude?: string;
-        expand?: string;
-        include?: string;
-        showFewer?: string;
-        showMore?: string;
-    };
-}
-
-declare interface ColorFacetComponentConfig extends BaseComponentConfig {
-    excludeEnabled?: boolean;
-    strings?: {
-        exclude?: string;
-        include?: string;
-        showFewer?: string;
-        showMore?: string;
-    };
-}
-
-/**
- * @category Search
- */
-declare interface ContentConfiguration {
-    breadcrumbs?: string;
-    customHtml?: string;
-    heading?: string;
-}
-
-/**
- * @category Content
- */
-declare interface ContentType {
-    id: number;
-    campaignId: number;
-    type: string;
-    title: string;
-    trackingEnabled: boolean;
-    zone: string;
-}
-
-/**
- * @category Content
- */
-declare interface ContentZone {
-    name: string;
-    items: Array<ContentZoneItem>;
-}
-
-declare interface ContentZoneComponentConfig extends BaseComponentConfig {
-}
-
-/**
- * @category Content
- */
-declare interface ContentZoneItem {
-    mobile: ContentType;
-    tablet: ContentType;
-    desktop: ContentType;
-}
-
-/**
- * @category Content
- */
-declare interface ContentZones {
-    [zone: string]: ContentZone;
-}
-
-declare interface ConversationalSearchComponentConfig extends BaseComponentConfig {
-    query?: string;
-    strings?: {
-        placeholder?: string;
-        resetLabel?: string;
-        sendLabel?: string;
-    };
-    prompt?: {
-        instructions?: string;
-        schema?: object;
-        onRequest?: any;
-        onResponse?: any;
-    };
-}
-
-declare class ConversationalService extends BaseService {
-    protected baseUrl: string;
-    protected API_KEY: string;
-    query(query?: MessageItemList, options?: object): Promise<any | void>;
-    private executeSearch;
-    private convertResponse;
-    bindComponents(conversationResponse: any): void;
-}
-
-declare interface CustomContentComponentConfig extends BaseComponentConfig {
-}
-
-/**
- * @category Search
- */
-declare interface DateFacetRange extends FacetRange<Date> {
-    type: 'date';
-}
-
-declare interface DatePickerComponentConfig extends BaseComponentConfig {
-    strings?: {
-        defaultLabel?: string;
-        next?: string;
-        previous?: string;
-        selectMonth?: string;
-        viewCalendar?: string;
-    };
-}
-
-declare interface DateRangeFacetComponentConfig extends BaseComponentConfig {
-    strings?: {
-        endDate?: string;
-        startDate?: string;
-    };
-}
-
-declare type DisplayType = 'mobile' | 'tablet' | 'desktop';
-
-/**
- * @category Tracking
- */
-declare enum EventType {
-    PageLoad = 1,
-    Search = 2,
-    Click = 3,
-    AddToCart = 4,
-    Rate = 5,
-    Sale = 6,
-    BannerClick = 7,
-    BannerImpression = 8,
-    RecommendationClick = 10,
-    AutocompleteClick = 11,
-    AddToCartMultiple = 14
-}
-
-/**
- * @category Search
- */
-declare interface Facet {
-    id: number;
-    type: FacetType;
-    title: string;
-    values?: Array<FacetValue>;
-    field: string;
-    collapsible: boolean;
-    collapsed?: boolean;
-    displayCount?: boolean;
-    range?: DateFacetRange | NumericFacetRange;
-    scrolling?: FacetScrolling;
-    search?: FacetSearch;
-    searchWithin?: string;
-    tooltip?: string;
-    truncation?: FacetTruncation;
-    visible: boolean;
-}
-
-/**
- * @category Search
- */
-declare interface FacetRange<T> {
-    type: string;
-    min: T;
-    max: T;
-    start: T;
-    end: T;
-}
-
-/**
- * @category Search
- */
-declare interface FacetScrolling {
-    height?: number;
-    threshold: number;
-}
-
-/**
- * @category Search
- */
-declare interface FacetSearch {
-    threshold: number;
-}
-
-declare interface FacetsListComponentConfig extends BaseComponentConfig {
-    strings?: {
-        heading?: string;
-    };
-}
-
-/**
- * @category Search
- */
-declare interface FacetTruncation {
-    threshold: number;
-}
-
-/**
- * @category Search
- */
-declare type FacetType = 'checkbox' | 'color' | 'date-range' | 'link' | 'numeric-range' | 'range-slider' | 'recent-searches' | 'related-searches' | 'search' | 'size' | 'tabs' | 'unsupported';
-
-/**
- * @category Search
- */
-declare interface FacetValue {
-    title: string;
-    imageUrl?: string;
-    value?: string;
-    color?: FacetValueColor;
-    count?: number;
-    level?: number;
-    selected?: boolean;
-    excluded?: boolean;
-    children?: Array<FacetValue>;
-}
-
-/**
- * @category Search
- */
-declare interface FacetValueColor {
-    name: string;
-    hex?: string;
-    imageUrl?: string;
-}
-
-declare interface FacetWrapperComponentConfig extends BaseComponentConfig {
-}
-
-declare interface FeaturedItemsContentComponentConfig extends BaseComponentConfig {
-}
-
-declare interface FeaturedItemsContentItemComponentConfig extends BaseComponentConfig {
-    strings?: {
-        sale?: string;
-    };
-}
-
-declare interface FieldMappings {
-    /**
-     * #### Default Value
-     * `['description', 'longdescription']`
-     */
-    description?: string | Array<string>;
-    /**
-     * #### Default Value
-     * `['imageurl', 'image']`
-     */
-    imageUrl?: string | Array<string>;
-    /**
-     * #### Default Value
-     * `'price'`
-     */
-    price?: string | Array<string>;
-    /**
-     * #### Default Value
-     * `'rating'`
-     */
-    rating?: string | Array<string>;
-    /**
-     * #### Default Value
-     * `['saleprice']`
-     */
-    salePrice?: string | Array<string>;
-    /**
-     * #### Default Value
-     * `['sku']`
-     */
-    sku?: string | Array<string>;
-    /**
-     * #### Default Value
-     * `['title', 'name', 'itemname']`
-     */
-    title?: string | Array<string>;
-    /**
-     * #### Default Value
-     * `'type'`
-     */
-    type?: string | Array<string>;
-    /**
-     * #### Default Value
-     * `'url'`
-     */
-    url?: string;
-}
-
-declare const HawkSearch: HawkSearchGlobal;
-export default HawkSearch;
-
-declare interface HawkSearchComponents {
-    'autocomplete'?: AutocompleteComponentConfig;
-    'checkbox-list-facet'?: CheckboxListFacetComponentConfig;
-    'color-facet'?: ColorFacetComponentConfig;
-    'conversationalsearch'?: ConversationalSearchComponentConfig;
-    'conceptsearch-field'?: SmartSearchFieldComponentConfig;
-    'content-zone'?: ContentZoneComponentConfig;
-    'custom-content'?: CustomContentComponentConfig;
-    'date-picker'?: DatePickerComponentConfig;
-    'date-range-facet'?: DateRangeFacetComponentConfig;
-    'facet-wrapper'?: FacetWrapperComponentConfig;
-    'facets-list'?: FacetsListComponentConfig;
-    'featured-items-content'?: FeaturedItemsContentComponentConfig;
-    'featured-items-content-item'?: FeaturedItemsContentItemComponentConfig;
-    'icon'?: IconComponentConfig;
-    'image-content'?: ImageContentComponentConfig;
-    'imagesearch-field'?: SmartSearchFieldComponentConfig;
-    'landing-page'?: LandingPageComponentConfig;
-    'link-list-facet'?: LinkListFacetComponentConfig;
-    'modified-query'?: ModifiedQueryComponentConfig;
-    'numeric-range-facet'?: NumericRangeFacetComponentConfig;
-    'page-size'?: PageSizeComponentConfig;
-    'pagination'?: PaginationComponentConfig;
-    'popular-queries-content'?: PopularQueriesContentComponentConfig;
-    'query-suggestions'?: QuerySuggestionsComponentConfig;
-    'range-slider'?: RangeSliderComponentConfig;
-    'range-slider-facet'?: RangeSliderFacetComponentConfig;
-    'rating'?: RatingComponentConfig;
-    'recommendations'?: RecommendationsComponentConfig;
-    'recommendations-item'?: RecommendationsItemComponentConfig;
-    'recent-searches-facet'?: RecentSearchesFacetComponentConfig;
-    'related-searches-facet'?: RelatedSearchesFacetComponentConfig;
-    'search-field'?: SearchFieldComponentConfig;
-    'search-results'?: SearchResultsComponentConfig;
-    'search-results-item'?: SearchResultsItemComponentConfig;
-    'search-results-list'?: SearchResultsListComponentConfig;
-    'search-within-facet'?: SearchWithinFacetComponentConfig;
-    'selected-facets'?: SelectedFacetsComponentConfig;
-    'size-facet'?: SizeFacetComponentConfig;
-    'smartresponse'?: SmartResponseComponentConfig;
-    'sorting'?: SortingComponentConfig;
-    'tabs'?: TabsComponentConfig;
-    'tooltip'?: TooltipComponentConfig;
-    'variant-selector'?: VariantSelectorComponentConfig;
-    'visualsearch-field'?: VisualSearchFieldComponentConfig;
-}
-
-declare interface HawkSearchConfig {
-    /**
-     * The unique ID for your installation found in the HawkSearch admin
-     */
-    clientId: string;
-    /**
-     * Specify an index to query rather than the default
-     */
-    index?: string;
-    /**
-     * Map item attributes to common object properties
-     */
-    fieldMappings?: FieldMappings;
-    autocomplete?: {
-        /**
-         * The API used to retrieve search results
-         *
-         * #### Default Value
-         * `'https://searchapi-dev.hawksearch.net'`
-         */
-        endpointUrl?: string;
-        /**
-         * Specifies whether autocomplete recommendations (autocomplete without entering a query - "instant engage") is enabled
-         *
-         * #### Default Value
-         * `false`
-         */
-        recommendationsEnabled?: boolean;
-        /**
-         * Whether to automatically URI decode the search query value. Runs recursively until value is fully decoded. For example, `Test%2520Value` would become `Test Value`.
-         *
-         * #### Default Value
-         * `true`
-         */
-        decodeQuery?: boolean;
-        /**
-         * Specifies the minimum length for a query to trigger an autocomplete recommendations request.
-         *
-         * #### Default Value
-         * `1`
-         */
-        minCharacterCount?: number;
-    };
-    search?: {
-        /**
-         * The API used to retrieve search results
-         *
-         * #### Default Value
-         * `'https://searchapi-dev.hawksearch.net'`
-         */
-        endpointUrl?: string;
-        /**
-         * The URL of your search results page. This is used to redirect users after performing a search.
-         *
-         * #### Default Value
-         * `'/search'`
-         */
-        url?: string;
-        /**
-         * The prefix for values sent to the API when excluding a facet. This is only modified in rare circumstances where the project has facet values starting with a hyphen.
-         *
-         * #### Default Value
-         * `'-'`
-         */
-        facetExclusionPrefix?: string;
-        /**
-         * Specifies how search results should be classified
-         */
-        itemTypes?: {
-            /**
-             * If the value a search result item is missing a value for the field mapped to {@link HawkSearchConfig.search | fieldMappings.type}, this value will be assumed.
-             *
-             * #### Default Value
-             * `'content'`
-             */
-            default: ItemType;
-            /**
-             * List of values that will be considered a `product` result.
-             *
-             * #### Default Value
-             * `['item', 'product']`
-             */
-            productValues?: Array<string>;
-        };
-        /**
-         * Specifies which query string parameters are used
-         */
-        queryStringMappings?: {
-            /**
-             * #### Default Value
-             * `'disableSpellcheck'`
-             */
-            disableSpellcheck?: string;
-            /**
-             * #### Default Value
-             * `'page'`
-             */
-            page?: string;
-            /**
-             * #### Default Value
-             * `'pageSize'`
-             */
-            pageSize?: string;
-            /**
-             * #### Default Value
-             * `'query'`
-             */
-            query?: string;
-            /**
-             * #### Default Value
-             * `'searchWithin'`
-             */
-            searchWithin?: string;
-            /**
-             * #### Default Value
-             * `'sort'`
-             */
-            sort?: string;
-            /**
-             * Sets RequestType field to toggle between Keyword search, Image search or Concept search
-             *
-             * #### Default Value
-             * `'DefaultSearch'`
-             */
-            requestType?: RequestType;
-        };
-        /**
-         * Whether to automatically URI decode the search query value. Runs recursively until value is fully decoded. For example, `Test%2520Value` would become `Test Value`.
-         *
-         * #### Default Value
-         * `true`
-         */
-        decodeQuery?: boolean;
-        /**
-         * Whether to automatically URI decode facet selection values. Runs recursively until value is fully decoded. For example, `Test%2520Value` would become `Test Value`.
-         *
-         * #### Default Value
-         * `true`
-         */
-        decodeFacetValues?: boolean;
-        /**
-         * Specifies a kValue for Concept and Image search
-         */
-        kValue?: number;
-    };
-    recommendations?: {
-        /**
-         * The API used to retrieve product recommendations
-         *
-         * #### Default Value
-         * `'https://recs-dev.hawksearch.net'`
-         */
-        endpointUrl?: string;
-    };
-    tracking?: {
-        /**
-         * Specifies whether user actions should be tracked to provide valuable insights on your search engine performance
-         *
-         * #### Default Value
-         *
-         * `true`
-         */
-        enabled?: boolean;
-        /**
-         * The API used to track user interactions
-         *
-         * #### Default Value
-         * `'https://tracking-dev.hawksearch.net'`
-         */
-        endpointUrl?: string;
-    };
-    variants?: {
-        /**
-         * When `true`, specifies that facet counts should be calculated based on the number of child items rather than the number of parent items
-         *
-         * #### Default Value
-         *
-         * `false`
-         */
-        baseFacetCountOnVariants?: boolean;
-        /**
-         * Specifies whether variant logic should be used if data is available
-         *
-         * #### Default Value
-         *
-         * `true`
-         */
-        enabled?: boolean;
-        /**
-         * When specified, this prefix is removed from the `attributes` collection on variant items. For example, if a value of `'child_'` is used and HawkSearch returns a field named `'child_color'`, it will be transformed to `'color'`.
-         */
-        fieldPrefix?: string;
-        /**
-         * Map item attributes to common object properties
-         */
-        fieldMappings?: VariantFieldMappings;
-        /**
-         * When `true`, specifies that tracking should use the ID of the selected variant rather than the ID of the parent
-         *
-         * #### Default Value
-         *
-         * `false`
-         */
-        trackUsingVariant?: boolean;
-    };
-    /**
-     * Specifies the minimum window widths that correspond to each breakpoint. This is used determine when certain content items are displayed.
-     *
-     * #### Default Value
-     * ```js
-     * {
-     *     mobile: undefined,
-     *     tablet: 740,
-     *     desktop: 990
-     * }
-     * ```
-     */
-    breakpoints?: Breakpoints<number>;
-    /**
-     * Specifies component-specific configuration options
-     */
-    components?: HawkSearchComponents;
-    /**
-     * Specifies which styles should be loaded for each component
-     */
-    css?: {
-        /**
-         * One or more style sets to be loaded. This can be either a URL to an external stylesheet, the ID of a `template` element wrapping around a `style` element, or a string containing CSS rules.
-         */
-        customStyles?: string | Array<string>;
-        /**
-         * Specifies whether the default stylesheet should be loaded. This should generally be true except for with completely custom interfaces.
-         */
-        defaultStyles?: boolean;
-    };
-    /**
-     * Specifies how values should be formatted for different cultures
-     */
-    formatting?: {
-        /**
-         * #### Default Value
-         * `'en-US'`
-         */
-        cultureIsoCode?: string;
-        /**
-         * #### Default Value
-         * `'USD'`
-         */
-        currencyIsoCode?: string;
-    };
-    /**
-     * The URL of an image to be loaded whenever an image fails to load for a search result item
-     */
-    placeholderImageUrl?: string;
-    seo?: {
-        title?: {
-            /**
-             * Value prepended to title returned from API
-             */
-            prefix?: string;
-            /**
-             * Value appended to title returned from API
-             */
-            suffix?: string;
-        };
-    };
-    /**
-     * Specifies whether components should be rendered in the [Shadow DOM](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_shadow_DOM). This is highly recommended to avoid CSS conflicts.
-     *
-     * #### Default Value
-     * `true`
-     */
-    shadowDom?: boolean;
-    /**
-     * If your data contains relative URLs, these values can be prepended to the values to convert them to absolute URLs
-     */
-    urlPrefixes?: {
-        assets?: string;
-        content?: string;
-    };
-    /**
-     * Specifies whether search queries should be displayed on console
-     *
-     * #### Default Value
-     * `false`
-     */
-    debug?: boolean;
-}
-
-declare interface HawkSearchGlobal {
-    config: HawkSearchConfig;
-    handlebars: typeof Handlebars_2;
-    recommendationsResponses?: {
-        [widgetId: string]: RecommendationsResponse;
-    };
-    searchRequest?: SearchRequest;
-    searchResponse?: SearchResponse;
-    services: {
-        autocomplete: AutocompleteService;
-        conversational: ConversationalService;
-        recommendations: RecommendationsService;
-        search: SearchService;
-        tracking: TrackingService;
-    };
-    init: (config: HawkSearchConfig) => void;
-}
-
-declare interface IconComponentConfig extends BaseComponentConfig {
-}
-
-declare interface ImageContentComponentConfig extends BaseComponentConfig {
-}
-
-/**
- * @category Base
- */
-declare interface Item {
-    attributes?: Record<string, Array<string>>;
-    description?: string;
-    id: string;
-    imageUrl?: string;
-    price?: number;
-    rating?: number;
-    salePrice?: number;
-    selectedVariant?: ItemVariant;
-    sku?: string;
-    title: string;
-    url: string;
-    variants?: Array<ItemVariant>;
-    visible?: boolean;
-}
-
-/**
- * @category Base
- */
-declare type ItemType = 'content' | 'product';
-
-/**
- * @category Base
- */
-declare interface ItemVariant {
-    attributes: Record<string, Array<string>>;
-    color?: {
-        name?: string;
-        hex?: string;
-        imageUrl?: string;
-    };
-    description?: string;
-    id: string;
-    imageUrl?: string;
-    price?: number;
-    queryMatch: boolean;
-    rating?: number;
-    salePrice?: number;
-    sku?: string;
-    title?: string;
-    url?: string;
-}
-
-declare interface LandingPageComponentConfig extends BaseComponentConfig {
-}
-
-declare interface LinkListFacetComponentConfig extends BaseComponentConfig {
-    strings?: {
-        showFewer?: string;
-        showMore?: string;
-    };
-}
-
-/**
- * @category Base
- */
-declare interface MessageItem {
-    role: MessageRole;
-    content: string;
-}
-
-/**
- * @category Base
- */
-declare interface MessageItemList extends Array<MessageItem> {
-}
-
-/**
- * @category Base
- */
-declare type MessageRole = 'system' | 'user' | 'assistant';
-
-declare interface ModifiedQueryComponentConfig extends BaseComponentConfig {
-    strings?: {
-        showingResultsFor?: string;
-        searchInsteadFor?: string;
-    };
-}
-
-/**
- * @category Search
- */
-declare interface NumericFacetRange extends FacetRange<number> {
-    type: 'numeric';
-}
-
-declare interface NumericRangeFacetComponentConfig extends BaseComponentConfig {
-    strings?: {
-        maximum?: string;
-        minimum?: string;
-    };
-}
-
-declare interface PageSizeComponentConfig extends BaseComponentConfig {
-}
-
-/**
- * @category Tracking
- */
-declare enum PageType {
-    Item = 1,
-    Landing = 2,
-    Cart = 3,
-    Order = 4,
-    Custom = 5
-}
-
-/**
- * @category Search
- */
-declare interface Pagination {
-    page: number;
-    pageSize: number;
-    totalPages: number;
-    totalResults: number;
-    maxPageLinks?: number;
-    displayFirstLink: boolean;
-    displayLastLink: boolean;
-    options: Array<PaginationOption>;
-}
-
-declare interface PaginationComponentConfig extends BaseComponentConfig {
-    strings?: {
-        first?: string;
-        last?: string;
-        next?: string;
-        previous?: string;
-        summary?: string;
-    };
-}
-
-/**
- * @category Search
- */
-declare interface PaginationOption {
-    title: string;
-    pageSize: number;
-    selected: boolean;
-    default: boolean;
-}
-
-declare interface PopularQueriesContentComponentConfig extends BaseComponentConfig {
-}
-
-declare interface QuerySuggestionsComponentConfig extends BaseComponentConfig {
-    strings?: {
-        orDelimeter?: string;
-        prompt?: string;
-    };
-}
-
-declare interface RangeSliderComponentConfig extends BaseComponentConfig {
-    strings?: {
-        end?: string;
-        start?: string;
-    };
-}
-
-declare interface RangeSliderFacetComponentConfig extends BaseComponentConfig {
-    strings?: {
-        maximum?: string;
-        minimum?: string;
-    };
-}
-
-declare interface RatingComponentConfig extends BaseComponentConfig {
-}
-
-declare interface RawVariantDocument {
-    hawk_child_attributes?: Array<Record<string, Array<string>>>;
-    hawk_child_attributes_hits?: Array<{
-        Items: Array<Record<string, Array<string>>>;
-        NofPages: number;
-        NofResults: number;
-    }>;
-}
-
-declare interface RecentSearchesFacetComponentConfig extends BaseComponentConfig {
-}
-
-declare interface RecommendationsComponentConfig extends BaseComponentConfig {
-    carousel?: {
-        autorotation?: {
-            enabled?: boolean;
-            interval?: number;
-        };
-        buttonsEnabled?: boolean;
-        enabled?: boolean;
-        paginationEnabled?: boolean;
-        paginationSelectedCssClass?: string;
-    };
-    headingEnabled?: boolean;
-    itemsToDisplay?: Breakpoints<number>;
-    strings?: {
-        next?: string;
-        previous?: string;
-    };
-}
-
-/**
- * @category Recommendations
- */
-declare interface RecommendationsItem extends Item {
-}
-
-declare interface RecommendationsItemComponentConfig extends BaseComponentConfig {
-    strings?: {
-        sale?: string;
-    };
-}
-
-/**
- * @category Recommendations
- */
-declare interface RecommendationsRequest {
-    widgetId: string;
-    itemId?: string;
-    url?: string;
-}
-
-/**
- * @category Recommendations
- */
-declare interface RecommendationsResponse {
-    requestId: string;
-    widgets?: Array<RecommendationsWidget>;
-}
-
-declare class RecommendationsService extends BaseService {
-    protected baseUrl: string;
-    getItems(recommendationsRequest: RecommendationsRequest): Promise<RecommendationsResponse>;
-    private executeRecommendations;
-    private convertResponse;
-    bindComponents(recommendationsResponse: RecommendationsResponse): void;
-}
-
-/**
- * @category Recommendations
- */
-declare interface RecommendationsWidget {
-    id: string;
-    requestId: string;
-    title: string;
-    carousel: boolean;
-    items?: Array<RecommendationsItem>;
-}
-
-/**
- * @category Search
- */
-declare interface Redirect {
-    url: string;
-    target?: string;
-}
-
-declare interface RelatedSearchesFacetComponentConfig extends BaseComponentConfig {
-}
-
-/**
- * @category Search
- */
-declare type RequestType = 'ConceptSearch' | 'ImageSearch' | 'DefaultSearch';
-
-declare interface SearchFieldComponentConfig extends BaseComponentConfig {
-    strings?: {
-        placeholder?: string;
-    };
-    /**
-     * Specifies whether the input element should be pre-populared if "query" parameter exists on the URL.
-     *
-     * #### Default Value
-     * `false`
-     */
-    disableAutofill?: boolean;
-}
-
-/**
- * @category Search
- */
-declare interface SearchRequest {
-    disableSpellcheck?: boolean;
-    facets?: SelectedFacets;
-    newRequest: boolean;
-    pageSize?: number;
-    page?: number;
-    query?: string;
-    requestType?: string;
-    searchWithin?: string;
-    sort?: string;
-    url?: string;
-}
-
-/**
- * @category Search
- */
-declare interface SearchResponse {
-    content?: ContentConfiguration;
-    contentZones?: ContentZones;
-    customLayout?: string;
-    facets?: Array<Facet>;
-    modifiedQuery?: string;
-    pagination?: Pagination;
-    query?: string;
-    querySuggestions?: Array<string>;
-    redirect?: Redirect;
-    results?: Array<SearchResultsItem>;
-    selectedFacets?: Array<SelectedFacet>;
-    seo?: SeoConfiguration;
-    sorting?: Sorting;
-    success: boolean;
-    trackingId: string;
-}
-
-declare interface SearchResultsComponentConfig extends BaseComponentConfig {
-}
-
-/**
- * @category Search
- */
-declare interface SearchResultsItem extends Item {
-    pinned: boolean;
-    score: number;
-    type: ItemType;
-}
-
-declare interface SearchResultsItemComponentConfig extends BaseComponentConfig {
-    strings?: {
-        sale?: string;
-    };
-}
-
-declare interface SearchResultsListComponentConfig extends BaseComponentConfig {
-}
-
-declare class SearchService extends BaseService {
-    protected baseUrl: string;
-    private facetExclusionPrefix;
-    private decodeQuery;
-    private decodeFacetValues;
-    private shouldRenderUI;
-    search(searchRequest: SearchRequest): Promise<SearchResponse>;
-    query(query?: SearchTypes, selectedFacets?: SelectedFacets | undefined, disableSpellcheck?: boolean): Promise<SearchResponse | void>;
-    addFacetValue(field: string, value: string): Promise<SearchResponse>;
-    removeFacetValue(field: string, value: string): Promise<SearchResponse>;
-    includeFacetValue(field: string, value: string): Promise<SearchResponse>;
-    excludeFacetValue(field: string, value: string): Promise<SearchResponse>;
-    private clearExistingFacetValue;
-    setFacetValue(field: string, value: string): Promise<SearchResponse>;
-    searchWithin(value: string): Promise<SearchResponse>;
-    selectTab(value?: string): Promise<SearchResponse>;
-    paginate(page: number): Promise<SearchResponse>;
-    setPageSize(pageSize: number): Promise<SearchResponse>;
-    sort(value?: string): Promise<SearchResponse>;
-    private executeSearch;
-    private ensureSearchRequest;
-    private convertResponse;
-    bindComponents(searchResponse: SearchResponse): void;
-    bindFacetsListComponent(searchResponse: SearchResponse | undefined): void;
-    bindLandingPageComponent(searchResponse: SearchResponse | undefined): void;
-    bindModifiedQueryComponent(searchResponse: SearchResponse | undefined): void;
-    bindPageSizeComponent(searchResponse: SearchResponse | undefined): void;
-    bindPaginationComponent(searchResponse: SearchResponse | undefined): void;
-    bindSearchFieldComponent(searchResponse: SearchResponse | undefined): void;
-    bindConceptSearchFieldComponent(searchResponse: SearchResponse | undefined): void;
-    bindImageSearchFieldComponent(searchResponse: SearchResponse | undefined): void;
-    bindSearchResultsComponent(searchResponse: SearchResponse | undefined): void;
-    bindSearchResultsListComponent(searchResponse: SearchResponse | undefined): void;
-    bindQuerySuggestionsComponent(searchResponse: SearchResponse | undefined): void;
-    bindSmartResponseComponent(searchResponse: SearchResponse | undefined): void;
-    bindSortingComponent(searchResponse: SearchResponse | undefined): void;
-    bindSelectedFacetsComponent(searchResponse: SearchResponse | undefined): void;
-    bindTabsComponent(searchResponse: SearchResponse | undefined): void;
-    bindZoneComponent(searchResponse: SearchResponse | undefined): void;
-    getRequestFromUrl(): SearchRequest;
-    private setQueryString;
-    private getSearchUrl;
-    private getBooleanParameter;
-    private getPositiveIntegerParameter;
-    private getStringParameter;
-    private getRecentQueries;
-    private saveRecentQueries;
-    protected setSeoElements(searchResponse: SearchResponse): void;
-    private removeElement;
-    private setLinkTag;
-    private setMetaTag;
-    private setTitle;
-}
-
-/**
- * @category Search
- */
-declare type SearchTypes = string | {
-    queryString: string;
-    requestType: string;
-} | undefined;
-
-declare interface SearchWithinFacetComponentConfig extends BaseComponentConfig {
-    strings?: {
-        label?: string;
-    };
-}
-
-/**
- * @category Search
- */
-declare interface SelectedFacet {
-    field: string;
-    currency: boolean;
-    title: string;
-    values: Array<SelectedFacetValue>;
-}
-
-/**
- * @category Search
- */
-declare type SelectedFacets = Record<string, Array<string> | undefined>;
-
-declare interface SelectedFacetsComponentConfig extends BaseComponentConfig {
-    strings?: {
-        remove?: string;
-    };
-}
-
-/**
- * @category Search
- */
-declare interface SelectedFacetValue {
-    title: string;
-    value: string;
-    excluded: boolean;
-}
-
-/**
- * @category Search
- */
-declare interface SeoConfiguration {
-    canonicalUrl?: string;
-    description?: string;
-    keywords?: string;
-    robots?: string;
-    title?: string;
-}
-
-declare interface ServiceFieldMappings {
-    description: Array<string>;
-    imageUrl: Array<string>;
-    price: Array<string>;
-    rating: Array<string>;
-    salePrice: Array<string>;
-    sku: Array<string>;
-    title: Array<string>;
-    type: Array<string>;
-    url: Array<string>;
-}
-
-declare interface ServiceVariantFieldMappings {
-    color: {
-        name: Array<string>;
-        hex: Array<string>;
-        imageUrl: Array<string>;
-    };
-    description: Array<string>;
-    id: Array<string>;
-    imageUrl: Array<string>;
-    price: Array<string>;
-    rating: Array<string>;
-    salePrice: Array<string>;
-    sku: Array<string>;
-    title: Array<string>;
-    url: Array<string>;
-}
-
-declare interface SizeFacetComponentConfig extends BaseComponentConfig {
-    excludeEnabled?: boolean;
-    strings?: {
-        exclude?: string;
-        include?: string;
-        showFewer?: string;
-        showMore?: string;
-    };
-}
-
-declare interface SmartResponseComponentConfig extends BaseComponentConfig {
-    strings?: {
-        header?: string;
-        noresults?: string;
-    };
-    prompt?: {
-        instructions?: string;
-        schema?: object;
-        onRequest?: any;
-        onResponse?: any;
-    };
-}
-
-declare interface SmartSearchFieldComponentConfig extends BaseComponentConfig {
-    strings?: {
-        placeholder?: string;
-    };
-    /**
-     * Specifies if a request is triggered on keypress.
-     *
-     * #### Default Value
-     * `false`
-     * *For more information, see {@link Components}.*
-     */
-    searchOnKeyPress?: boolean;
-    /**
-     * Specifies the minimum length for a query to trigger a request.
-     *
-     * #### Default Value
-     * `10`
-     * *For more information, see {@link Components}.*
-     */
-    searchMinCharacterCount?: number;
-    /**
-     * Specifies the debounce value between fetching data and keypress (ms)
-     *
-     * #### Default Value
-     * `350`
-     * *For more information, see {@link Components}.*
-     */
-    searchDebounceValue?: number;
-}
-
-/**
- * @category Search
- */
-declare interface Sorting {
-    value?: string;
-    options: Array<SortingOption>;
-}
-
-declare interface SortingComponentConfig extends BaseComponentConfig {
-}
-
-/**
- * @category Search
- */
-declare interface SortingOption {
-    title: string;
-    value: string;
-    default: boolean;
-    selected: boolean;
-}
-
-declare interface TabsComponentConfig extends BaseComponentConfig {
-}
-
-declare interface TooltipComponentConfig extends BaseComponentConfig {
-}
-
-declare class TrackingService extends BaseService {
-    protected baseUrl: string;
-    trackAddToCart(productId: string, quantity: number, price: number, currencyIsoCode: string): Promise<void>;
-    trackAddToCartMultiple(items: Array<{
-        productId: string;
-        quantity: number;
-        price: number;
-        currencyIsoCode: string;
-    }>): Promise<void>;
-    trackAutocompleteClick(query: string | undefined, itemType: AutocompleteItemType, title: string, url: string): Promise<void>;
-    trackBannerClick(bannerId: number, campaignId: number): Promise<void>;
-    trackBannerImpression(bannerId: number, campaignId: number): Promise<void>;
-    trackOrder(orderId: string, items: Array<{
-        productId: string;
-        quantity: number;
-        price: number;
-    }>, subTotal: number, tax: number, total: number, currencyIsoCode: string): Promise<void>;
-    trackPageLoad(pageType: PageType, productId?: string): Promise<void>;
-    trackRating(productId: string, rating: number): Promise<void>;
-    trackRecommendationClick(widgetId: string, requestId: string, productId: string): Promise<void>;
-    trackSearchResultClick(id: string, url: string, event?: PointerEvent): Promise<void>;
-    trackSearch(query: string | undefined, newSearch: boolean): Promise<void>;
-    trackEvent(type: EventType, data: any): Promise<void>;
-    private getQueryId;
-    private setNewQueryId;
-}
-
-declare interface VariantFieldMappings extends FieldMappings {
-    /**
-     * #### Default Value
-     * `['id']`
-     */
-    id?: string | Array<string>;
-    color?: {
-        /**
-         * #### Default Value
-         * `['colorname', 'color']`
-         */
-        name?: string | Array<string>;
-        /**
-         * #### Default Value
-         * `['colorhex', 'colorvalue']`
-         */
-        hex?: string | Array<string>;
-        /**
-         * #### Default Value
-         * `['colorimageurl', 'colorimage']`
-         */
-        imageUrl?: string | Array<string>;
-    };
-}
-
-declare interface VariantSelectorComponentConfig extends BaseComponentConfig {
-}
-
-declare interface VisualSearchFieldComponentConfig extends BaseComponentConfig {
-    strings?: {
-        dragImageMessage?: string;
-        uploadImageMessage?: string;
-        dropImageMessage?: string;
-        errorMessage?: string;
-    };
-}
-
-export { }
+export {};