@bridgeline-digital/hawksearch-handlebars-ui 5.1.2-beta.3 → 5.2.0

package/dist/configuration/configuration.models.d.ts

@@ -1,624 +0,0 @@
-import * as Handlebars from 'handlebars';
-import { ItemType, RecommendationsResponse, RequestType, SearchRequest, SearchResponse } from '@models';
-import { AutocompleteService, RecommendationsService, SearchService, TrackingService } from '../services';
-export 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;
-}
-export interface AutocompleteComponentConfig extends BaseComponentConfig {
-}
-export interface CheckboxListFacetComponentConfig extends BaseComponentConfig {
-    excludeEnabled?: boolean;
-    strings?: {
-        collapse?: string;
-        exclude?: string;
-        expand?: string;
-        include?: string;
-        showFewer?: string;
-        showMore?: string;
-    };
-}
-export interface ColorFacetComponentConfig extends BaseComponentConfig {
-    excludeEnabled?: boolean;
-    strings?: {
-        exclude?: string;
-        include?: string;
-        showFewer?: string;
-        showMore?: string;
-    };
-}
-export interface ContentZoneComponentConfig extends BaseComponentConfig {
-}
-export interface CustomContentComponentConfig extends BaseComponentConfig {
-}
-export interface DatePickerComponentConfig extends BaseComponentConfig {
-    strings?: {
-        defaultLabel?: string;
-        next?: string;
-        previous?: string;
-        selectMonth?: string;
-        viewCalendar?: string;
-    };
-}
-export interface DateRangeFacetComponentConfig extends BaseComponentConfig {
-    strings?: {
-        endDate?: string;
-        startDate?: string;
-    };
-}
-export interface FacetsListComponentConfig extends BaseComponentConfig {
-    strings?: {
-        heading?: string;
-    };
-}
-export interface FacetWrapperComponentConfig extends BaseComponentConfig {
-}
-export interface FeaturedItemsContentComponentConfig extends BaseComponentConfig {
-}
-export interface FeaturedItemsContentItemComponentConfig extends BaseComponentConfig {
-    strings?: {
-        sale?: string;
-    };
-}
-export interface IconComponentConfig extends BaseComponentConfig {
-}
-export interface ImageContentComponentConfig extends BaseComponentConfig {
-}
-export interface LandingPageComponentConfig extends BaseComponentConfig {
-}
-export interface LinkListFacetComponentConfig extends BaseComponentConfig {
-    strings?: {
-        showFewer?: string;
-        showMore?: string;
-    };
-}
-export interface ModifiedQueryComponentConfig extends BaseComponentConfig {
-    strings?: {
-        showingResultsFor?: string;
-        searchInsteadFor?: string;
-    };
-}
-export interface NumericRangeFacetComponentConfig extends BaseComponentConfig {
-    strings?: {
-        maximum?: string;
-        minimum?: string;
-    };
-}
-export interface PageSizeComponentConfig extends BaseComponentConfig {
-}
-export interface PaginationComponentConfig extends BaseComponentConfig {
-    strings?: {
-        first?: string;
-        last?: string;
-        next?: string;
-        previous?: string;
-        summary?: string;
-    };
-}
-export interface PopularQueriesContentComponentConfig extends BaseComponentConfig {
-}
-export interface QuerySuggestionsComponentConfig extends BaseComponentConfig {
-    strings?: {
-        orDelimeter?: string;
-        prompt?: string;
-    };
-}
-export interface RangeSliderComponentConfig extends BaseComponentConfig {
-    strings?: {
-        end?: string;
-        start?: string;
-    };
-}
-export interface RangeSliderFacetComponentConfig extends BaseComponentConfig {
-    strings?: {
-        maximum?: string;
-        minimum?: string;
-    };
-}
-export interface RatingComponentConfig extends BaseComponentConfig {
-}
-export interface RecentSearchesFacetComponentConfig extends BaseComponentConfig {
-}
-export interface RecommendationsItemComponentConfig extends BaseComponentConfig {
-    strings?: {
-        sale?: string;
-    };
-}
-export 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;
-    };
-}
-export interface RelatedSearchesFacetComponentConfig extends BaseComponentConfig {
-}
-export interface SearchFieldComponentConfig extends BaseComponentConfig {
-    strings?: {
-        placeholder?: string;
-    };
-}
-export interface ImageSearchFieldComponentConfig extends BaseComponentConfig {
-    strings?: {
-        dragImageMessage?: string;
-        uploadImageMessage?: string;
-        dropImageMessage?: string;
-        errorMessage?: string;
-    };
-}
-export interface SearchResultsComponentConfig extends BaseComponentConfig {
-}
-export interface SearchResultsItemComponentConfig extends BaseComponentConfig {
-    strings?: {
-        sale?: string;
-    };
-}
-export interface SearchResultsListComponentConfig extends BaseComponentConfig {
-}
-export interface SearchWithinFacetComponentConfig extends BaseComponentConfig {
-    strings?: {
-        label?: string;
-    };
-}
-export interface SelectedFacetsComponentConfig extends BaseComponentConfig {
-    strings?: {
-        remove?: string;
-    };
-}
-export interface SizeFacetComponentConfig extends BaseComponentConfig {
-    excludeEnabled?: boolean;
-    strings?: {
-        exclude?: string;
-        include?: string;
-        showFewer?: string;
-        showMore?: string;
-    };
-}
-export interface SortingComponentConfig extends BaseComponentConfig {
-}
-export interface TabsComponentConfig extends BaseComponentConfig {
-}
-export interface TooltipComponentConfig extends BaseComponentConfig {
-}
-export interface VariantSelectorComponentConfig extends BaseComponentConfig {
-}
-export interface HawkSearchComponents {
-    'autocomplete'?: AutocompleteComponentConfig;
-    'checkbox-list-facet'?: CheckboxListFacetComponentConfig;
-    'color-facet'?: ColorFacetComponentConfig;
-    '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;
-    '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;
-    'conceptsearch-field'?: SearchFieldComponentConfig;
-    'imagesearch-field'?: SearchFieldComponentConfig;
-    'imagefinder-field'?: SearchFieldComponentConfig;
-    'search-results'?: SearchResultsComponentConfig;
-    'search-results-item'?: SearchResultsItemComponentConfig;
-    'search-results-list'?: SearchResultsListComponentConfig;
-    'search-within-facet'?: SearchWithinFacetComponentConfig;
-    'selected-facets'?: SelectedFacetsComponentConfig;
-    'size-facet'?: SizeFacetComponentConfig;
-    'sorting'?: SortingComponentConfig;
-    'tabs'?: TabsComponentConfig;
-    'tooltip'?: TooltipComponentConfig;
-    'variant-selector'?: VariantSelectorComponentConfig;
-}
-export type DisplayType = 'mobile' | 'tablet' | 'desktop';
-export interface Breakpoints<TValue> extends Record<DisplayType, TValue> {
-}
-export 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;
-}
-export 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>;
-    };
-}
-export 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) 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
-         * `false`
-         */
-        decodeQuery?: boolean;
-    };
-    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
-         * `false`
-         */
-        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
-         * `false`
-         */
-        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;
-}
-export interface HawkSearchGlobal {
-    config: HawkSearchConfig;
-    handlebars: typeof Handlebars;
-    recommendationsResponses?: {
-        [widgetId: string]: RecommendationsResponse;
-    };
-    searchRequest?: SearchRequest;
-    searchResponse?: SearchResponse;
-    services?: {
-        autocomplete: AutocompleteService;
-        recommendations: RecommendationsService;
-        search: SearchService;
-        tracking: TrackingService;
-    };
-}
-export interface HawkSearchState {
-    searchRequest?: SearchRequest;
-    searchResponse: SearchResponse;
-}

package/dist/configuration/index.d.ts

@@ -1,4 +0,0 @@
-/**
- * @module Configuration
- */
-export * from './configuration.models';