@bridgeline-digital/hawksearch-handlebars-ui 2.0.0-beta.5 → 2.0.0-beta.7

package/dist/components/content/content-types/custom-content/custom-content.component.d.ts

@@ -2,7 +2,7 @@ import { CustomContentComponentConfig, HawkSearchComponents } from '@configurati
 import { CustomContent, CustomContentComponentModel } from '@models';
 import { BaseContentComponent } from '../base-content.component';
 /**
- * The Custom Content component renders HTML defined in Hawksearch.
+ * The Custom Content component renders HTML defined in HawkSearch.
  *
  * ## Tag
  * The tag for this component is `<hawksearch-custom-content>`.

package/dist/components/content/content-types/featured-items-content/featured-items-content.component.d.ts

@@ -2,7 +2,7 @@ import { FeaturedItemsContentComponentConfig, HawkSearchComponents } from '@conf
 import { FeaturedItemsContent, FeaturedItemsContentComponentModel } from '@models';
 import { BaseContentComponent } from '../base-content.component';
 /**
- * The Featured Items Content component renders a custom list of search results (typically products) defined as Spotlights in Hawksearch. This is commonly used to display a default set of products when a query returns no results.
+ * The Featured Items Content component renders a custom list of search results (typically products) defined as Spotlights in HawkSearch. This is commonly used to display a default set of products when a query returns no results.
  *
  * ## Tag
  * The tag for this component is `<hawksearch-featured-items-content>`.

package/dist/components/content/content-types/featured-items-content-item/featured-items-content-item.component.d.ts

@@ -34,5 +34,5 @@ export declare class FeaturedItemsContentItemComponent extends BaseComponent<Fea
     protected bindFromEvent: boolean;
     protected renderContent(): boolean;
     protected getContentModel(): FeaturedItemsContentItemComponentModel;
-    protected bindChildElements(): void;
+    protected onRender(): void;
 }

package/dist/components/content/content-types/image-content/image-content.component.d.ts

@@ -2,7 +2,7 @@ import { HawkSearchComponents, ImageContentComponentConfig } from '@configuratio
 import { ImageContent, ImageContentComponentModel } from '@models';
 import { BaseContentComponent } from '../base-content.component';
 /**
- * The Image Content component displays an image defined in Hawksearch.
+ * The Image Content component displays an image defined in HawkSearch.
  *
  * ## Tag
  * The tag for this component is `<hawksearch-image-content>`.
@@ -19,5 +19,4 @@ export declare class ImageContentComponent extends BaseContentComponent<ImageCon
     protected renderContent(): boolean;
     protected getContentModel(): ImageContentComponentModel;
     protected onRender(): void;
-    protected bindChildElements(): void;
 }

package/dist/components/content/content-types/popular-queries-content/popular-queries-content.component.d.ts

@@ -18,5 +18,5 @@ export declare class PopularQueriesContentComponent extends BaseContentComponent
     protected defaultHtml: any;
     protected renderContent(): boolean;
     protected getContentModel(): PopularQueriesContentComponentModel;
-    protected bindChildElements(): void;
+    protected onRender(): void;
 }

package/dist/components/content/content-zone/content-zone.component.d.ts

@@ -2,7 +2,7 @@ import { ContentZoneComponentConfig, HawkSearchComponents } from '@configuration
 import { ContentZoneComponentModel, SearchResponse } from '@models';
 import { BaseComponent } from '../../base.component';
 /**
- * The Content Zone component renders a list of content items or Spotlight products as defined in the Merchandising section of Hawksearch.
+ * The Content Zone component renders a list of content items or Spotlight products as defined in the Merchandising section of HawkSearch.
  *
  * ## Tag
  * The tag for this component is `<hawksearch-content-zone>`.
@@ -12,7 +12,7 @@ import { BaseComponent } from '../../base.component';
  * | :- | :- | :- |
  * | name | `string` | Yes |
  *
- * The `name` attribute corresponds to the `Zone` property defined in Hawksearch. This is used to differentiate different content areas, allowing you to place content items exactly where you want within your search results page.
+ * The `name` attribute corresponds to the `Zone` property defined in HawkSearch. This is used to differentiate different content areas, allowing you to place content items exactly where you want within your search results page.
  *
  * ## Event-Binding Attributes
  * | Name | Value |

package/dist/components/general/date-picker/date-picker.component.d.ts

@@ -109,7 +109,7 @@ export declare class DatePickerComponent extends BaseComponent<DatePickerCompone
     attributeChangedCallback(name: string, oldValue: string | null, newValue: string | null): void;
     protected registerHelpers(): void;
     protected getContentModel(): DatePickerComponentModel;
-    protected bindChildElements(): void;
+    protected onRender(): void;
     private positionModal;
     private getYears;
     private getWeeks;

package/dist/components/general/range-slider/range-slider.component.d.ts

@@ -48,7 +48,7 @@ export declare class RangeSliderComponent extends BaseComponent<RangeSliderCompo
     private setStart;
     private setEnd;
     protected getContentModel(): RangeSliderComponentModel;
-    protected bindChildElements(): void;
+    protected onRender(): void;
     private onMouseUp;
     private onMouseMove;
 }

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

@@ -28,5 +28,5 @@ export declare class TooltipComponent extends BaseComponent<TooltipComponentConf
     private get text();
     protected renderContent(): boolean;
     protected getContentModel(): TooltipComponentModel;
-    protected bindChildElements(): void;
+    protected onRender(): void;
 }

package/dist/components/index.d.ts

@@ -20,12 +20,12 @@
  * <html>
  *   <head>
  *     <meta charset="utf-8" />
- *     <title>Hawksearch Handlebars UI</title>
+ *     <title>HawkSearch Handlebars UI</title>
  *     <meta name="viewport" content="width=device-width, initial-scale=1" />
  *     <script type="text/javascript">
- *       var Hawksearch = Hawksearch || {};
+ *       var HawkSearch = HawkSearch || {};
  *
- *       Hawksearch.config = {
+ *       HawkSearch.config = {
  *         clientId: "YOUR_CLIENTID_HERE",
  *         components: {
  *           pageSize: {
@@ -44,7 +44,7 @@
  *     <script src="node_modules/@bridgeline-digital/hawksearch-handlebars-ui/dist/handlebars-ui.js" defer ></script>
  *   </head>
  *   <body>
- *     <h1>Hawksearch Handlebars UI</h1>
+ *     <h1>HawkSearch Handlebars UI</h1>
  *     <hawksearch-search></hawksearch-search>
  *     <hawksearch-results></hawksearch-results>
  *   </body>
@@ -60,12 +60,12 @@
  * <html>
  *   <head>
  *     <meta charset="utf-8" />
- *     <title>Hawksearch Handlebars UI</title>
+ *     <title>HawkSearch Handlebars UI</title>
  *     <meta name="viewport" content="width=device-width, initial-scale=1" />
  *     <script type="text/javascript">
- *       var Hawksearch = Hawksearch || {};
+ *       var HawkSearch = HawkSearch || {};
  *
- *       Hawksearch.config = {
+ *       HawkSearch.config = {
  *         clientId: "f51060e1c38446f0bacdf283390c37e8",
  *         components: {
  *           pageSize: {
@@ -77,7 +77,7 @@
  *     <script src="node_modules/@bridgeline-digital/hawksearch-handlebars-ui/dist/handlebars-ui.js" defer ></script>
  *   </head>
  *   <body>
- *     <h1>Hawksearch Handlebars UI</h1>
+ *     <h1>HawkSearch Handlebars UI</h1>
  *     <hawksearch-search></hawksearch-search>
  *     <hawksearch-results></hawksearch-results>
  *     <template id="page-size-template">

package/dist/components/recommendations/recommendations-item/recommendations-item.component.d.ts

@@ -36,5 +36,5 @@ export declare class RecommendationsItemComponent extends BaseComponent<Recommen
     private get requestId();
     protected renderContent(): boolean;
     protected getContentModel(): RecommendationsItemComponentModel;
-    protected bindChildElements(): void;
+    protected onRender(): void;
 }

package/dist/components/search/autocomplete/autocomplete.component.d.ts

@@ -54,6 +54,6 @@ export declare class AutocompleteComponent extends BaseComponent<AutocompleteCom
     protected defaultHtml: any;
     protected renderContent(): boolean;
     protected getContentModel(): AutocompleteComponentModel;
-    protected bindChildElements(): void;
+    protected onRender(): void;
     private close;
 }

package/dist/components/search/facet-types/base-facet.component.d.ts

@@ -40,5 +40,5 @@ import { BaseComponent } from '../../base.component';
 export declare abstract class BaseFacetComponent<TConfig extends BaseComponentConfig, TModel extends BaseComponentModel> extends BaseComponent<TConfig, Facet, TModel> {
     protected bindFromEvent: boolean;
     state: FacetState;
-    protected bindChildElements(): void;
+    protected onRender(): void;
 }

package/dist/components/search/facet-types/checkbox-list-facet/checkbox-list-facet.component.d.ts

@@ -2,7 +2,7 @@ import { CheckboxListFacetComponentConfig, HawkSearchComponents } from '@configu
 import { CheckboxListFacetComponentModel } from '@models';
 import { BaseFacetComponent } from '../base-facet.component';
 /**
- * The Checkbox List Facet component renders a checkbox for each facet and may be nested depending on the configuration in the Hawksearch admin.
+ * The Checkbox List Facet component renders a checkbox for each facet and may be nested depending on the configuration in the HawkSearch admin.
  *
  * ## Tag
  * The tag for this component is `<hawksearch-checkbox-list-facet>`.

package/dist/components/search/facet-types/date-range-facet/date-range-facet.component.d.ts

@@ -27,7 +27,7 @@ export declare class DateRangeFacetComponent extends BaseFacetComponent<DateRang
     private get range();
     protected renderContent(): boolean;
     protected getContentModel(): DateRangeFacetComponentModel;
-    protected bindChildElements(): void;
+    protected onRender(): void;
     private updateInputElements;
     private setFacetValue;
 }

package/dist/components/search/facet-types/numeric-range-facet/numeric-range-facet.component.d.ts

@@ -27,6 +27,6 @@ export declare class NumericRangeFacetComponent extends BaseFacetComponent<Numer
     private get range();
     protected renderContent(): boolean;
     protected getContentModel(): NumericRangeFacetComponentModel;
-    protected bindChildElements(): void;
+    protected onRender(): void;
     private setFacetValue;
 }

package/dist/components/search/facet-types/range-slider-facet/range-slider-facet.component.d.ts

@@ -27,7 +27,7 @@ export declare class RangeSliderFacetComponent extends BaseFacetComponent<RangeS
     private get range();
     protected renderContent(): boolean;
     protected getContentModel(): RangeSliderFacetComponentModel;
-    protected bindChildElements(): void;
+    protected onRender(): void;
     private getRange;
     private updateInputElements;
     private setFacetValue;

package/dist/components/search/facet-types/recent-searches-facet/recent-searches-facet.component.d.ts

@@ -25,5 +25,5 @@ export declare class RecentSearchesFacetComponent extends BaseFacetComponent<Rec
     protected defaultHtml: any;
     protected renderContent(): boolean;
     protected getContentModel(): RecentSearchesFacetComponentModel;
-    protected bindChildElements(): void;
+    protected onRender(): void;
 }

package/dist/components/search/facet-types/related-searches-facet/related-searches-facet.component.d.ts

@@ -25,5 +25,5 @@ export declare class RelatedSearchesFacetComponent extends BaseFacetComponent<Re
     protected defaultHtml: any;
     protected renderContent(): boolean;
     protected getContentModel(): RelatedSearchesFacetComponentModel;
-    protected bindChildElements(): void;
+    protected onRender(): void;
 }

package/dist/components/search/facet-types/search-within-facet/search-within-facet.component.d.ts

@@ -25,5 +25,5 @@ export declare class SearchWithinFacetComponent extends BaseFacetComponent<Searc
     protected defaultHtml: any;
     protected renderContent(): boolean;
     protected getContentModel(): SearchWithinFacetComponentModel;
-    protected bindChildElements(): void;
+    protected onRender(): void;
 }

package/dist/components/search/facet-wrapper/facet-wrapper.component.d.ts

@@ -42,5 +42,6 @@ export declare class FacetWrapperComponent extends BaseComponent<FacetWrapperCom
     protected renderContent(): boolean;
     protected getContentModel(): FacetWrapperComponentModel;
     protected bindChildElements(): void;
+    protected onRender(): void;
     private rebindChildElements;
 }

package/dist/components/search/facets-list/facets-list.component.d.ts

@@ -28,4 +28,5 @@ export declare class FacetsListComponent extends BaseComponent<FacetsListCompone
     protected renderContent(): boolean;
     protected getContentModel(): FacetsListComponentModel;
     protected bindChildElements(): void;
+    protected onRender(): void;
 }

package/dist/components/search/modified-query/modified-query.component.d.ts

@@ -28,5 +28,5 @@ export declare class ModifiedQueryComponent extends BaseComponent<ModifiedQueryC
     protected bindFromEvent: boolean;
     protected renderContent(): boolean;
     protected getContentModel(): ModifiedQueryComponentModel;
-    protected bindChildElements(): void;
+    protected onRender(): void;
 }

package/dist/components/search/page-size/page-size.component.d.ts

@@ -28,5 +28,5 @@ export declare class PageSizeComponent extends BaseComponent<PageSizeComponentCo
     protected bindFromEvent: boolean;
     protected renderContent(): boolean;
     protected getContentModel(): PageSizeComponentModel;
-    protected bindChildElements(): void;
+    protected onRender(): void;
 }

package/dist/components/search/pagination/pagination.component.d.ts

@@ -4,7 +4,7 @@ import { BaseComponent } from '../../base.component';
 /**
  * The Pagination component is used to navigate between different pages of a search results set.
  *
- * *Note: If no maximum number of page links to display is configured in the Hawksearch admin, a default value of `9` will be used.*
+ * *Note: If no maximum number of page links to display is configured in the HawkSearch admin, a default value of `9` will be used.*
  *
  * ## Tag
  * The tag for this component is `<hawksearch-pagination>`.
@@ -37,7 +37,7 @@ export declare class PaginationComponent extends BaseComponent<PaginationCompone
     protected registerHelpers(): void;
     protected renderContent(): boolean;
     protected getContentModel(): PaginationComponentModel;
-    protected bindChildElements(): void;
+    protected onRender(): void;
     protected setPage(page: number): Promise<void>;
     private getPages;
 }

package/dist/components/search/query-suggestions/query-suggestions.component.d.ts

@@ -34,5 +34,5 @@ export declare class QuerySuggestionsComponent extends BaseComponent<QuerySugges
     protected registerHelpers(): void;
     protected renderContent(): boolean;
     protected getContentModel(): QuerySuggestionsComponentModel;
-    protected bindChildElements(): void;
+    protected onRender(): void;
 }

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

@@ -28,6 +28,6 @@ export declare class SearchFieldComponent extends BaseComponent<SearchFieldCompo
     connectedCallback(): void;
     disconnectedCallback(): void;
     protected getContentModel(): SearchFieldComponentModel;
-    protected bindChildElements(): void;
+    protected onRender(): void;
     private toggleAutocomplete;
 }

package/dist/components/search/search-results-item/search-results-item.component.d.ts

@@ -34,5 +34,5 @@ export declare class SearchResultsItemComponent extends BaseComponent<SearchResu
     protected bindFromEvent: boolean;
     protected renderContent(): boolean;
     protected getContentModel(): SearchResultsItemComponentModel;
-    protected bindChildElements(): void;
+    protected onRender(): void;
 }

package/dist/components/search/selected-facets/selected-facets.component.d.ts

@@ -27,5 +27,5 @@ export declare class SelectedFacetsComponent extends BaseComponent<SelectedFacet
     protected bindFromEvent: boolean;
     protected renderContent(): boolean;
     protected getContentModel(): SelectedFacetsComponentModel;
-    protected bindChildElements(): void;
+    protected onRender(): void;
 }

package/dist/components/search/sorting/sorting.component.d.ts

@@ -26,5 +26,5 @@ export declare class SortingComponent extends BaseComponent<SortingComponentConf
     protected bindFromEvent: boolean;
     protected renderContent(): boolean;
     protected getContentModel(): SortingComponentModel;
-    protected bindChildElements(): void;
+    protected onRender(): void;
 }

package/dist/components/search/tabs/tabs.component.d.ts

@@ -26,5 +26,5 @@ export declare class TabsComponent extends BaseComponent<TabsComponentConfig, Fa
     protected bindFromEvent: boolean;
     protected renderContent(): boolean;
     protected getContentModel(): TabsComponentModel;
-    protected bindChildElements(): void;
+    protected onRender(): void;
 }

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

@@ -19,6 +19,7 @@ export interface BaseComponentConfig {
 export interface AutocompleteComponentConfig extends BaseComponentConfig {
 }
 export interface CheckboxListFacetComponentConfig extends BaseComponentConfig {
+    excludeEnabled?: boolean;
     strings?: {
         collapse?: string;
         exclude?: string;
@@ -29,6 +30,7 @@ export interface CheckboxListFacetComponentConfig extends BaseComponentConfig {
     };
 }
 export interface ColorFacetComponentConfig extends BaseComponentConfig {
+    excludeEnabled?: boolean;
     strings?: {
         exclude?: string;
         include?: string;
@@ -176,6 +178,7 @@ export interface SelectedFacetsComponentConfig extends BaseComponentConfig {
     };
 }
 export interface SizeFacetComponentConfig extends BaseComponentConfig {
+    excludeEnabled?: boolean;
     strings?: {
         exclude?: string;
         include?: string;
@@ -258,7 +261,7 @@ export interface HawkSearchConfig {
      */
     css?: {
         /**
-         * URL to one or more stylesheets to be loaded
+         * 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>;
         /**
@@ -295,7 +298,42 @@ export interface HawkSearchConfig {
     /**
      * Map item attributes to common object properties
      */
-    fieldMappings?: {
+    recommendationsFieldMappings?: {
+        /**
+         * #### Default Value
+         * `'longdescription'`
+         */
+        description?: string;
+        /**
+         * #### Default Value
+         * `'image'`
+         */
+        imageUrl?: string;
+        /**
+         * #### Default Value
+         * `'price'`
+         */
+        price?: string;
+        /**
+         * #### Default Value
+         * `'saleprice'`
+         */
+        salePrice?: string;
+        /**
+         * #### Default Value
+         * `'itemname'`
+         */
+        title?: string;
+        /**
+         * #### Default Value
+         * `'url'`
+         */
+        url?: string;
+    };
+    /**
+     * Map item attributes to common object properties
+     */
+    searchResultsFieldMappings?: {
         /**
          * #### Default Value
          * `'longdescription'`
@@ -352,7 +390,7 @@ export interface HawkSearchConfig {
      */
     itemTypes?: {
         /**
-         * 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.
+         * If the value a search result item is missing a value for the field mapped to {@link HawkSearchConfig.searchResultsFieldMappings | type}, this value will be assumed.
          *
          * #### Default Value
          * `'content'`