@bridgeline-digital/hawksearch-handlebars-ui 3.0.0 → 4.0.0-beta.1

package/dist/components/general/index.d.ts

@@ -1,4 +1,5 @@
 export * from './date-picker/date-picker.component';
 export * from './icon/icon.component';
 export * from './range-slider/range-slider.component';
+export * from './rating/rating.component';
 export * from './tooltip/tooltip.component';

package/dist/components/general/rating/rating.component.d.ts

@@ -0,0 +1,39 @@
+import { HawkSearchComponents, RatingComponentConfig } from '@configuration';
+import { RatingComponentModel } from '@models';
+import { BaseComponent } from '../../base.component';
+/**
+ * The Rating component is used to display a visual representation of ratings for a particular product.
+ *
+ * ## Tag
+ * The tag for this component is `<hawksearch-rating>`.
+ *
+ * ## Attributes
+ * | Name | Type | Default Value | Required |
+ * | :- | :- | :- | :- |
+ * | rating | `number` | | Yes
+ *
+ * These attributes are used to position the tooltip based on the size and scroll position of the active window. The `hawksearch-tooltip` attribute should be present on an element containing both the element the tooltip is attached to (to display on hover) and the element containing the tooltip content, which should have a `hawksearch-tooltip-content` attribute.
+ *
+ * ## Handlebars Helpers
+ * | Name | Rating | Star Number
+ * | :- | :- | :- |
+ * | ratingIcon | `number` | `number` |
+ *
+ * This helper function returns the icon name to display for a given rating and star number (1-5)
+ *
+ * ## Default Template
+ * The following is the default Handlebars template for this component. To create a custom template, it is recommended to use this as a starting point.
+ * {@embed ./rating.component.hbs}
+ *
+ * @category General
+ */
+export declare class RatingComponent extends BaseComponent<RatingComponentConfig, number, RatingComponentModel> {
+    protected componentName: keyof HawkSearchComponents;
+    protected defaultHtml: any;
+    protected bindFromEvent: boolean;
+    protected registerHelpers(): void;
+    private get rating();
+    protected renderContent(): boolean;
+    protected getContentModel(): RatingComponentModel;
+    protected onRender(): void;
+}

package/dist/components/search/search-field/search-field.component.d.ts

@@ -28,6 +28,7 @@ export declare class SearchFieldComponent extends BaseComponent<SearchFieldCompo
     private defaultAutocompleteResponse?;
     private previousAutocompleteResponse?;
     private previousValue;
+    private get recommendationsEnabled();
     connectedCallback(): void;
     disconnectedCallback(): void;
     protected getContentModel(): SearchFieldComponentModel;

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

@@ -126,6 +126,8 @@ export interface RangeSliderFacetComponentConfig extends BaseComponentConfig {
         minimum?: string;
     };
 }
+export interface RatingComponentConfig extends BaseComponentConfig {
+}
 export interface RecentSearchesFacetComponentConfig extends BaseComponentConfig {
 }
 export interface RecommendationsItemComponentConfig extends BaseComponentConfig {
@@ -216,6 +218,7 @@ export interface HawkSearchComponents {
     'query-suggestions'?: QuerySuggestionsComponentConfig;
     'range-slider'?: RangeSliderComponentConfig;
     'range-slider-facet'?: RangeSliderFacetComponentConfig;
+    'rating'?: RatingComponentConfig;
     'recommendations'?: RecommendationsComponentConfig;
     'recommendations-item'?: RecommendationsItemComponentConfig;
     'recent-searches-facet'?: RecentSearchesFacetComponentConfig;
@@ -240,77 +243,45 @@ export interface HawkSearchConfig {
      */
     clientId: string;
     /**
-     * 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
+     * Specify an index to query rather than the default
      */
-    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>;
+    index?: string;
+    autocomplete?: {
         /**
-         * Specifies whether the default stylesheet should be loaded. This should generally be true except for with completely custom interfaces.
+         * The API used to retrieve search results
+         *
+         * #### Default Value
+         * `'https://searchapi-dev.hawksearch.net'`
          */
-        defaultStyles?: boolean;
+        endpointUrl?: string;
+        recommendationsEnabled?: boolean;
     };
-    /**
-     * Specifies which endpoints are called by each {@link Services | service}
-     */
-    endpoints?: {
+    search?: {
         /**
-         * The API used to retrieve product recommendations
+         * The API used to retrieve search results
          *
          * #### Default Value
-         * `'https://recs-dev.hawksearch.net/api/recommendation/v2'`
+         * `'https://searchapi-dev.hawksearch.net'`
          */
-        recommendations: string;
+        endpointUrl?: string;
         /**
-         * The API used to retrieve search results
+         * The URL of your search results page. This is used to redirect users after performing a search.
          *
          * #### Default Value
-         * `'https://searchapi-dev.hawksearch.net/api/v2'`
+         * `'/search'`
          */
-        search: string;
+        url?: string;
         /**
-         * The API used to track user interactions
+         * 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
-         * `'https://tracking-dev.hawksearch.net/api'`
+         * `'-'`
          */
-        tracking: string;
-    };
-    /**
-     * Specify an index to query rather than the default
-     */
-    index?: 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;
-    /**
-     * Map item attributes to common object properties
-     */
-    fieldMappings?: {
-        recommendations?: {
+        facetExclusionPrefix?: string;
+        /**
+         * Map item attributes to common object properties
+         */
+        fieldMappings?: {
             /**
              * #### Default Value
              * `'longdescription'`
@@ -326,6 +297,11 @@ export interface HawkSearchConfig {
              * `'price'`
              */
             price?: string;
+            /**
+             * #### Default Value
+             * `'rating'`
+             */
+            rating?: string;
             /**
              * #### Default Value
              * `'saleprice'`
@@ -336,13 +312,84 @@ export interface HawkSearchConfig {
              * `'itemname'`
              */
             title?: string;
+            /**
+             * #### Default Value
+             * `'type'`
+             */
+            type?: string;
             /**
              * #### Default Value
              * `'url'`
              */
             url?: string;
         };
-        searchResults?: {
+        /**
+         * 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: SearchResultsItemType;
+            /**
+             * 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;
+        };
+    };
+    recommendations?: {
+        /**
+         * The API used to retrieve product recommendations
+         *
+         * #### Default Value
+         * `'https://recs-dev.hawksearch.net'`
+         */
+        endpointUrl?: string;
+        /**
+         * Map item attributes to common object properties
+         */
+        fieldMappings?: {
             /**
              * #### Default Value
              * `'longdescription'`
@@ -358,6 +405,11 @@ export interface HawkSearchConfig {
              * `'price'`
              */
             price?: string;
+            /**
+             * #### Default Value
+             * `'rating'`
+             */
+            rating?: string;
             /**
              * #### Default Value
              * `'saleprice'`
@@ -368,11 +420,6 @@ export interface HawkSearchConfig {
              * `'itemname'`
              */
             title?: string;
-            /**
-             * #### Default Value
-             * `'type'`
-             */
-            type?: string;
             /**
              * #### Default Value
              * `'url'`
@@ -380,86 +427,72 @@ export interface HawkSearchConfig {
             url?: string;
         };
     };
-    /**
-     * Specifies how values should be formatted for different cultures
-     */
-    formatting?: {
-        /**
-         * #### Default Value
-         * `'en-US'`
-         */
-        cultureIsoCode?: string;
-        /**
-         * #### Default Value
-         * `'USD'`
-         */
-        currencyIsoCode?: string;
-    };
-    /**
-     * Specifies how search results should be classified
-     */
-    itemTypes?: {
+    tracking?: {
         /**
-         * If the value a search result item is missing a value for the field mapped to {@link HawkSearchConfig.fieldMappings | type}, this value will be assumed.
+         * Specifies whether user actions should be tracked to provide valuable insights on your search engine performance
          *
          * #### Default Value
-         * `'content'`
+         *
+         * `true`
          */
-        default: SearchResultsItemType;
+        enabled?: boolean;
         /**
-         * List of values that will be considered a `product` result.
+         * The API used to track user interactions
          *
          * #### Default Value
-         * `['item', 'product']`
+         * `'https://tracking-dev.hawksearch.net'`
          */
-        productValues?: Array<string>;
+        endpointUrl?: string;
     };
     /**
-     * The URL of an image to be loaded whenever an image fails to load for a search result item
+     * 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
+     * }
+     * ```
      */
-    placeholderImageUrl?: string;
+    breakpoints?: Breakpoints<number>;
     /**
-     * Specifies which query string parameters are used
+     * Specifies component-specific configuration options
      */
-    queryStringMappings?: {
-        /**
-         * #### Default Value
-         * `'disableSpellcheck'`
-         */
-        disableSpellcheck?: string;
-        /**
-         * #### Default Value
-         * `'page'`
-         */
-        page?: string;
+    components?: HawkSearchComponents;
+    /**
+     * Specifies which styles should be loaded for each component
+     */
+    css?: {
         /**
-         * #### Default Value
-         * `'pageSize'`
+         * 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.
          */
-        pageSize?: string;
+        customStyles?: string | Array<string>;
         /**
-         * #### Default Value
-         * `'query'`
+         * Specifies whether the default stylesheet should be loaded. This should generally be true except for with completely custom interfaces.
          */
-        query?: string;
+        defaultStyles?: boolean;
+    };
+    /**
+     * Specifies how values should be formatted for different cultures
+     */
+    formatting?: {
         /**
          * #### Default Value
-         * `'searchWithin'`
+         * `'en-US'`
          */
-        searchWithin?: string;
+        cultureIsoCode?: string;
         /**
          * #### Default Value
-         * `'sort'`
+         * `'USD'`
          */
-        sort?: string;
+        currencyIsoCode?: string;
     };
     /**
-     * The URL of your search results page. This is used to redirect users after performing a search.
-     *
-     * #### Default Value
-     * `'/search'`
+     * The URL of an image to be loaded whenever an image fails to load for a search result item
      */
-    searchUrl?: string;
+    placeholderImageUrl?: string;
     seo?: {
         title?: {
             /**
@@ -479,14 +512,6 @@ export interface HawkSearchConfig {
      * `true`
      */
     shadowDom?: boolean;
-    /**
-     * Specifies whether user actions should be tracked to provide valuable insights on your search engine performance
-     *
-     * #### Default Value
-     *
-     * `true`
-     */
-    trackingEnabled?: boolean;
     /**
      * If your data contains relative URLs, these values can be prepended to the values to convert them to absolute URLs
      */