@bridgeline-digital/hawksearch-handlebars-ui 4.0.3-beta.0 → 4.0.4-beta.0

package/changelog.md

@@ -1,79 +1,79 @@
-# 4.0.3
-
-1. Modified RecommendationsService to transform response properties into arrays to be consistent with search results and autocomplete.
-2. Modified `attributes` property on `RecommendationsItem` to include only the properties from `customDict` on the API response. The other properties from the response are standard so repeating them under `attributes` does not make sense.
-
-# 4.0.2
-
-1. Updated `number` and `currency` Handlebars helpers to handle string values from API and made decimals parameter optional
-
-# 4.0.1
-
-1. Modified SearchService so that `hawksearch:after-search-completed` event fires before SEO elements are set
-
-# 4.0.0
-
-## New Features
-
-1. Added `HawkSearch.config.autocomplete.recommendationsEnabled` property with a default value of `false` to toggle autocomplete recommendations (instant engage)
-2. Added new RatingComponent to be displayed on SearchResultsItemComponent, RecommendationsItemComponent, and FeaturedItemsContentItemComponent.
-3. Added product ratings and prices to autocomplete
-4. Added suggested queries (did you mean?) to autocomplete
-
-## Bug Fixes
-
-1. Converting `price` and `salePrice` values of 0 to `undefined`
-2. Fixed price rendering logic in default templates of SearchResultsItemComponent, RecommendationsItemComponent, and FeaturedItemsContentItemComponent
-
-## Breaking Changes
-
-1. Refactored HawkSearchConfig structure to group properties by search, autocomplete, and recommendations. Some property names have changed slightly.
-2. Modified endpoints configuration to expect only domain rather than full API URL
-
-# 3.0.0
-
-## New Features
-
-1. Added support for A/B testing in Recommendations component
-2. Added support for default autocomplete without entering a query
-3. Modified autocomplete to display when refocusing on search field
-4. Added optional `item-id` attribute to Recommendations component
-5. Added instance-level configuration overrides through `config` attribute or `configOverride` property
-
-## Bug Fixes
-
-1. Fixed script file name and configuration link in documentation
-2. Fixed bug requiring double-click to expand facet that is collapsed by default
-
-## Breaking Changes
-
-1. Removed unused option to define custom component template as child content of tag to provide future possibility of using slots or declarative Shadow DOM
-
-# 2.0.0
-
-## New Features
-
-1. Added Landing Pages components
-2. Added Recommendations components
-3. Added component-level configuration to support functionality toggles and easy string replacements
-4. Added `hawksearch:before-${componentName}-rendered` event hooks to support passing custom data to Handlebars templates
-5. Added configuration setting to toggle facet exclude value functionality. This is now disabled by default.
-6. Added ability to load CSS styles without requiring an external stylesheet
-7. Added customizable index to search results, autocomplete, and recommendations requests
-8. Added ability to set product as default search results item type
-9. Added alternate `[[value]]` syntax to work the same as the default Handlerbars `{{value}}` syntax to avoid conflicts when customizing templates within BigCommerce
-10. Added support for nested object properties in field mappings
-11. Added rendering of canonical URL including search refinements
-12. Added configurable facet exclusion prefix
-13. Implemented TypeDoc code-generated documentation to ensure it remains up-to-date and available for each version
-
-## Bug Fixes
-
-1. Fixed Autocomplete template name
-2. Added logic to handle scrolling facets by setting a max-height in default template
-
-## Breaking Changes
-
-1. Changed entry file from `hawksearch-handlebars-ui.js` to `index.js`
-2. Renamed `Hawksearch` global object to `HawkSearch`
-3. Changes to `HawkSearch.config` model to support new features
+# 4.0.3
+
+1. Modified RecommendationsService to transform response properties into arrays to be consistent with search results and autocomplete.
+2. Modified `attributes` property on `RecommendationsItem` to include only the properties from `customDict` on the API response. The other properties from the response are standard so repeating them under `attributes` does not make sense.
+
+# 4.0.2
+
+1. Updated `number` and `currency` Handlebars helpers to handle string values from API and made decimals parameter optional
+
+# 4.0.1
+
+1. Modified SearchService so that `hawksearch:after-search-completed` event fires before SEO elements are set
+
+# 4.0.0
+
+## New Features
+
+1. Added `HawkSearch.config.autocomplete.recommendationsEnabled` property with a default value of `false` to toggle autocomplete recommendations (instant engage)
+2. Added new RatingComponent to be displayed on SearchResultsItemComponent, RecommendationsItemComponent, and FeaturedItemsContentItemComponent.
+3. Added product ratings and prices to autocomplete
+4. Added suggested queries (did you mean?) to autocomplete
+
+## Bug Fixes
+
+1. Converting `price` and `salePrice` values of 0 to `undefined`
+2. Fixed price rendering logic in default templates of SearchResultsItemComponent, RecommendationsItemComponent, and FeaturedItemsContentItemComponent
+
+## Breaking Changes
+
+1. Refactored HawkSearchConfig structure to group properties by search, autocomplete, and recommendations. Some property names have changed slightly.
+2. Modified endpoints configuration to expect only domain rather than full API URL
+
+# 3.0.0
+
+## New Features
+
+1. Added support for A/B testing in Recommendations component
+2. Added support for default autocomplete without entering a query
+3. Modified autocomplete to display when refocusing on search field
+4. Added optional `item-id` attribute to Recommendations component
+5. Added instance-level configuration overrides through `config` attribute or `configOverride` property
+
+## Bug Fixes
+
+1. Fixed script file name and configuration link in documentation
+2. Fixed bug requiring double-click to expand facet that is collapsed by default
+
+## Breaking Changes
+
+1. Removed unused option to define custom component template as child content of tag to provide future possibility of using slots or declarative Shadow DOM
+
+# 2.0.0
+
+## New Features
+
+1. Added Landing Pages components
+2. Added Recommendations components
+3. Added component-level configuration to support functionality toggles and easy string replacements
+4. Added `hawksearch:before-${componentName}-rendered` event hooks to support passing custom data to Handlebars templates
+5. Added configuration setting to toggle facet exclude value functionality. This is now disabled by default.
+6. Added ability to load CSS styles without requiring an external stylesheet
+7. Added customizable index to search results, autocomplete, and recommendations requests
+8. Added ability to set product as default search results item type
+9. Added alternate `[[value]]` syntax to work the same as the default Handlerbars `{{value}}` syntax to avoid conflicts when customizing templates within BigCommerce
+10. Added support for nested object properties in field mappings
+11. Added rendering of canonical URL including search refinements
+12. Added configurable facet exclusion prefix
+13. Implemented TypeDoc code-generated documentation to ensure it remains up-to-date and available for each version
+
+## Bug Fixes
+
+1. Fixed Autocomplete template name
+2. Added logic to handle scrolling facets by setting a max-height in default template
+
+## Breaking Changes
+
+1. Changed entry file from `hawksearch-handlebars-ui.js` to `index.js`
+2. Renamed `Hawksearch` global object to `HawkSearch`
+3. Changes to `HawkSearch.config` model to support new features

package/dist/components/base.component.d.ts

@@ -1,139 +1,139 @@
-import { BaseComponentConfig, HawkSearchComponents } from '@configuration';
-import { BaseComponentModel } from '@models';
-/**
- * @typeParam TConfig Component configuration
- * @typeParam TData Component data
- * @typeParam TModel Data bound to Handlebars template
- *
- * @noInheritDoc
- * @category Base
- */
-export declare abstract class BaseComponent<TConfig extends BaseComponentConfig, TData, TModel extends BaseComponentModel> extends HTMLElement {
-    /**
-     * Optional instance-level configuration to override the global configuration
-     */
-    configOverride?: TConfig;
-    /**
-     * The data bound to the component.
-     */
-    data?: TData;
-    /**
-     * The Handlebars reference shared by all HawkSearch components.
-     */
-    protected handlebars: typeof Handlebars;
-    /**
-     * For components that may have multiple instances with different data sources, this property is used to identify the subset of data used for binding.
-     *
-     * @internal
-     */
-    protected eventFilter?: string;
-    /**
-     * The data bound to the Handlebars template.
-     */
-    protected contentModel?: TModel;
-    /**
-     * The name of the component. This value is appended to `hawksearch-` to determine the tag name. For example, a value of `search-results` would be rendered by `<hawksearch-search-results>`.
-     *
-     * @internal
-     */
-    protected abstract componentName: keyof HawkSearchComponents;
-    /**
-     * The default Handlebars template.
-     *
-     * @internal
-     */
-    protected abstract defaultHtml: string;
-    /**
-     * Determines whether the component is bound by an event. If `false`, binding is performed by the parent component.
-     *
-     * @internal
-     */
-    protected abstract bindFromEvent: boolean;
-    /**
-     * The optional configuration object for this component.
-     */
-    protected get configuration(): TConfig | undefined;
-    /**
-     * Whether or not the component is rendered within the Shadow DOM. In order of preference, this is specified by {@link configuration} or {@link Models.HawkSearchConfig.shadowDom}.
-     *
-     * @internal
-     * @defaultValue `true`
-     */
-    protected get shadowDom(): boolean;
-    /**
-     * The root element which should be used for querying any child elements. This resolves to `this.shadowRoot` if the Shadow DOM is enabled, otherwise `this`.
-     */
-    get rootElement(): ParentNode;
-    /**
-     * The name of the event that this component listens to for data binding. if {@link bindFromEvent} is `true`, this prepends `hawksearch:bind-` to {@link componentName} and appends :{@link eventFilter}, if specified.
-     *
-     * @internal
-     */
-    private get eventName();
-    /**
-     * @internal
-     */
-    private bindEventHandler?;
-    /**
-     * @internal
-     */
-    private template;
-    /**
-     * @ignore
-     */
-    connectedCallback(): void;
-    /**
-     * @ignore
-     */
-    disconnectedCallback(): void;
-    /**
-     * Optional method that can be overwritten to register Handlebars helper functions which can be accessed from the template. For more information, see [Custom Helpers](https://handlebarsjs.com/guide/#custom-helpers).
-     *
-     * @virtual
-     */
-    protected registerHelpers(): void;
-    /**
-     * Binds {@link contentModel} to the Handlebars template and renders the resulting HTML content.
-     */
-    render(): void;
-    /**
-     * Determines whether the {@link data} meets the necessary conditions to perform data binding and render content.
-     *
-     * @virtual
-     * @returns Whether the component should be rendered. If `false`, the component will have empty contents and be set to `display: none;`.
-     */
-    protected renderContent(): boolean;
-    /**
-     * Gets the data to be bound to the Handlebars template.
-     *
-     * @internal
-     * @returns The data bound to the Handlebars template.
-     */
-    protected abstract getContentModel(): TModel;
-    /**
-     * After the component is rendered, this method is called to bind any child components.
-     *
-     * @virtual
-     */
-    protected bindChildElements(): void;
-    /**
-     * After the component is rendered, this method is called for any additional processing (such as attaching event listeners) which needs to occur.
-     *
-     * @virtual
-     */
-    protected onRender(): void;
-    /**
-     * @returns The Handlebars template HTML. In order of preference, this is specified by the child contents of the HTML element, the template specified by {@link configuration}, or the default template for the component.
-     *
-     * @internal
-     */
-    private getCustomTemplateHtml;
-    /**
-     * Replaces placeholders in a given string with values from a data object.
-     *
-     * @param template The template string.
-     * @param values The object containing properties which will be bound to `template`.
-     * @returns The `template` string with all placeholders replaced by the values specified in `values`.
-     */
-    protected interpolate(template: string, values: Record<string, string>): string;
-}
+import { BaseComponentConfig, HawkSearchComponents } from '@configuration';
+import { BaseComponentModel } from '@models';
+/**
+ * @typeParam TConfig Component configuration
+ * @typeParam TData Component data
+ * @typeParam TModel Data bound to Handlebars template
+ *
+ * @noInheritDoc
+ * @category Base
+ */
+export declare abstract class BaseComponent<TConfig extends BaseComponentConfig, TData, TModel extends BaseComponentModel> extends HTMLElement {
+    /**
+     * Optional instance-level configuration to override the global configuration
+     */
+    configOverride?: TConfig;
+    /**
+     * The data bound to the component.
+     */
+    data?: TData;
+    /**
+     * The Handlebars reference shared by all HawkSearch components.
+     */
+    protected handlebars: typeof Handlebars;
+    /**
+     * For components that may have multiple instances with different data sources, this property is used to identify the subset of data used for binding.
+     *
+     * @internal
+     */
+    protected eventFilter?: string;
+    /**
+     * The data bound to the Handlebars template.
+     */
+    protected contentModel?: TModel;
+    /**
+     * The name of the component. This value is appended to `hawksearch-` to determine the tag name. For example, a value of `search-results` would be rendered by `<hawksearch-search-results>`.
+     *
+     * @internal
+     */
+    protected abstract componentName: keyof HawkSearchComponents;
+    /**
+     * The default Handlebars template.
+     *
+     * @internal
+     */
+    protected abstract defaultHtml: string;
+    /**
+     * Determines whether the component is bound by an event. If `false`, binding is performed by the parent component.
+     *
+     * @internal
+     */
+    protected abstract bindFromEvent: boolean;
+    /**
+     * The optional configuration object for this component.
+     */
+    protected get configuration(): TConfig | undefined;
+    /**
+     * Whether or not the component is rendered within the Shadow DOM. In order of preference, this is specified by {@link configuration} or {@link Models.HawkSearchConfig.shadowDom}.
+     *
+     * @internal
+     * @defaultValue `true`
+     */
+    protected get shadowDom(): boolean;
+    /**
+     * The root element which should be used for querying any child elements. This resolves to `this.shadowRoot` if the Shadow DOM is enabled, otherwise `this`.
+     */
+    get rootElement(): ParentNode;
+    /**
+     * The name of the event that this component listens to for data binding. if {@link bindFromEvent} is `true`, this prepends `hawksearch:bind-` to {@link componentName} and appends :{@link eventFilter}, if specified.
+     *
+     * @internal
+     */
+    private get eventName();
+    /**
+     * @internal
+     */
+    private bindEventHandler?;
+    /**
+     * @internal
+     */
+    private template;
+    /**
+     * @ignore
+     */
+    connectedCallback(): void;
+    /**
+     * @ignore
+     */
+    disconnectedCallback(): void;
+    /**
+     * Optional method that can be overwritten to register Handlebars helper functions which can be accessed from the template. For more information, see [Custom Helpers](https://handlebarsjs.com/guide/#custom-helpers).
+     *
+     * @virtual
+     */
+    protected registerHelpers(): void;
+    /**
+     * Binds {@link contentModel} to the Handlebars template and renders the resulting HTML content.
+     */
+    render(): void;
+    /**
+     * Determines whether the {@link data} meets the necessary conditions to perform data binding and render content.
+     *
+     * @virtual
+     * @returns Whether the component should be rendered. If `false`, the component will have empty contents and be set to `display: none;`.
+     */
+    protected renderContent(): boolean;
+    /**
+     * Gets the data to be bound to the Handlebars template.
+     *
+     * @internal
+     * @returns The data bound to the Handlebars template.
+     */
+    protected abstract getContentModel(): TModel;
+    /**
+     * After the component is rendered, this method is called to bind any child components.
+     *
+     * @virtual
+     */
+    protected bindChildElements(): void;
+    /**
+     * After the component is rendered, this method is called for any additional processing (such as attaching event listeners) which needs to occur.
+     *
+     * @virtual
+     */
+    protected onRender(): void;
+    /**
+     * @returns The Handlebars template HTML. In order of preference, this is specified by the child contents of the HTML element, the template specified by {@link configuration}, or the default template for the component.
+     *
+     * @internal
+     */
+    private getCustomTemplateHtml;
+    /**
+     * Replaces placeholders in a given string with values from a data object.
+     *
+     * @param template The template string.
+     * @param values The object containing properties which will be bound to `template`.
+     * @returns The `template` string with all placeholders replaced by the values specified in `values`.
+     */
+    protected interpolate(template: string, values: Record<string, string>): string;
+}

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

@@ -1,9 +1,9 @@
-import { BaseComponentConfig } from '@configuration';
-import { BaseComponentModel, ContentType } from '@models';
-import { BaseComponent } from '../../base.component';
-/**
- * @category Content
- */
-export declare abstract class BaseContentComponent<TConfig extends BaseComponentConfig, TData extends ContentType, TModel extends BaseComponentModel> extends BaseComponent<TConfig, TData, TModel> {
-    protected bindFromEvent: boolean;
-}
+import { BaseComponentConfig } from '@configuration';
+import { BaseComponentModel, ContentType } from '@models';
+import { BaseComponent } from '../../base.component';
+/**
+ * @category Content
+ */
+export declare abstract class BaseContentComponent<TConfig extends BaseComponentConfig, TData extends ContentType, TModel extends BaseComponentModel> extends BaseComponent<TConfig, TData, TModel> {
+    protected bindFromEvent: boolean;
+}

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

@@ -1,21 +1,21 @@
-import { CustomContentComponentConfig, HawkSearchComponents } from '@configuration';
-import { CustomContent, CustomContentComponentModel } from '@models';
-import { BaseContentComponent } from '../base-content.component';
-/**
- * The Custom Content component renders HTML defined in HawkSearch.
- *
- * ## Tag
- * The tag for this component is `<hawksearch-custom-content>`.
- *
- * ## 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 ./custom-content.component.hbs}
- *
- * @category Content
- */
-export declare class CustomContentComponent extends BaseContentComponent<CustomContentComponentConfig, CustomContent, CustomContentComponentModel> {
-    protected componentName: keyof HawkSearchComponents;
-    protected defaultHtml: any;
-    protected renderContent(): boolean;
-    protected getContentModel(): CustomContentComponentModel;
-}
+import { CustomContentComponentConfig, HawkSearchComponents } from '@configuration';
+import { CustomContent, CustomContentComponentModel } from '@models';
+import { BaseContentComponent } from '../base-content.component';
+/**
+ * The Custom Content component renders HTML defined in HawkSearch.
+ *
+ * ## Tag
+ * The tag for this component is `<hawksearch-custom-content>`.
+ *
+ * ## 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 ./custom-content.component.hbs}
+ *
+ * @category Content
+ */
+export declare class CustomContentComponent extends BaseContentComponent<CustomContentComponentConfig, CustomContent, CustomContentComponentModel> {
+    protected componentName: keyof HawkSearchComponents;
+    protected defaultHtml: any;
+    protected renderContent(): boolean;
+    protected getContentModel(): CustomContentComponentModel;
+}

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

@@ -1,22 +1,22 @@
-import { FeaturedItemsContentComponentConfig, HawkSearchComponents } from '@configuration';
-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.
- *
- * ## Tag
- * The tag for this component is `<hawksearch-featured-items-content>`.
- *
- * ## 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 ./featured-items-content.component.hbs}
- *
- * @category Content
- */
-export declare class FeaturedItemsContentComponent extends BaseContentComponent<FeaturedItemsContentComponentConfig, FeaturedItemsContent, FeaturedItemsContentComponentModel> {
-    protected componentName: keyof HawkSearchComponents;
-    protected defaultHtml: any;
-    protected renderContent(): boolean;
-    protected getContentModel(): FeaturedItemsContentComponentModel;
-    protected bindChildElements(): void;
-}
+import { FeaturedItemsContentComponentConfig, HawkSearchComponents } from '@configuration';
+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.
+ *
+ * ## Tag
+ * The tag for this component is `<hawksearch-featured-items-content>`.
+ *
+ * ## 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 ./featured-items-content.component.hbs}
+ *
+ * @category Content
+ */
+export declare class FeaturedItemsContentComponent extends BaseContentComponent<FeaturedItemsContentComponentConfig, FeaturedItemsContent, FeaturedItemsContentComponentModel> {
+    protected componentName: keyof HawkSearchComponents;
+    protected defaultHtml: any;
+    protected renderContent(): boolean;
+    protected getContentModel(): FeaturedItemsContentComponentModel;
+    protected bindChildElements(): void;
+}

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

@@ -1,38 +1,38 @@
-import { FeaturedItemsContentItemComponentConfig, HawkSearchComponents } from '@configuration';
-import { FeaturedItemsContentItemComponentModel, SearchResultsItem } from '@models';
-import { BaseComponent } from '../../../base.component';
-/**
- * The Featured Items Content Item component displays information for an individual product or page.
- *
- * ## Tag
- * The tag for this component is `<hawksearch-featured-items-content>`.
- *
- * ## Event-Binding Attributes
- * ### Images
- * | Name | Value |
- * | :- | :- |
- * | hawksearch-image | |
- *
- * Image elements with this attribute will have their src value replaced with a placeholder image URL if the image fails to load.
- *
- * ### Links
- * | Name | Value |
- * | :- | :- |
- * | hawksearch-link | |
- *
- * Anchor elements with this attribute will be tracked when clicked.
- *
- * ## 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 ./featured-items-content-item.component.hbs}
- *
- * @category Content
- */
-export declare class FeaturedItemsContentItemComponent extends BaseComponent<FeaturedItemsContentItemComponentConfig, SearchResultsItem, FeaturedItemsContentItemComponentModel> {
-    protected componentName: keyof HawkSearchComponents;
-    protected defaultHtml: any;
-    protected bindFromEvent: boolean;
-    protected renderContent(): boolean;
-    protected getContentModel(): FeaturedItemsContentItemComponentModel;
-    protected onRender(): void;
-}
+import { FeaturedItemsContentItemComponentConfig, HawkSearchComponents } from '@configuration';
+import { FeaturedItemsContentItemComponentModel, SearchResultsItem } from '@models';
+import { BaseComponent } from '../../../base.component';
+/**
+ * The Featured Items Content Item component displays information for an individual product or page.
+ *
+ * ## Tag
+ * The tag for this component is `<hawksearch-featured-items-content>`.
+ *
+ * ## Event-Binding Attributes
+ * ### Images
+ * | Name | Value |
+ * | :- | :- |
+ * | hawksearch-image | |
+ *
+ * Image elements with this attribute will have their src value replaced with a placeholder image URL if the image fails to load.
+ *
+ * ### Links
+ * | Name | Value |
+ * | :- | :- |
+ * | hawksearch-link | |
+ *
+ * Anchor elements with this attribute will be tracked when clicked.
+ *
+ * ## 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 ./featured-items-content-item.component.hbs}
+ *
+ * @category Content
+ */
+export declare class FeaturedItemsContentItemComponent extends BaseComponent<FeaturedItemsContentItemComponentConfig, SearchResultsItem, FeaturedItemsContentItemComponentModel> {
+    protected componentName: keyof HawkSearchComponents;
+    protected defaultHtml: any;
+    protected bindFromEvent: boolean;
+    protected renderContent(): boolean;
+    protected getContentModel(): FeaturedItemsContentItemComponentModel;
+    protected onRender(): void;
+}