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

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

@@ -59,7 +59,7 @@ export declare abstract class BaseComponent<TConfig extends BaseComponentConfig,
     /**
      * 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`.
      */
-    protected get rootElement(): ParentNode;
+    get rootElement(): ParentNode;
     /**
      * @internal
      *

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

@@ -295,81 +295,90 @@ export interface HawkSearchConfig {
          */
         tracking: string;
     };
+    /**
+     * Specify an index to query rather than the default
+     */
     index?: string;
     /**
-     * Map item attributes to common object properties
+     * 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
+     * `'-'`
      */
-    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;
-    };
+    facetExclusionPrefix?: string;
     /**
      * Map item attributes to common object properties
      */
-    searchResultsFieldMappings?: {
-        /**
-         * #### 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
-         * `'type'`
-         */
-        type?: string;
-        /**
-         * #### Default Value
-         * `'url'`
-         */
-        url?: string;
+    fieldMappings?: {
+        recommendations?: {
+            /**
+             * #### 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;
+        };
+        searchResults?: {
+            /**
+             * #### 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
+             * `'type'`
+             */
+            type?: string;
+            /**
+             * #### Default Value
+             * `'url'`
+             */
+            url?: string;
+        };
     };
     /**
      * Specifies how values should be formatted for different cultures
@@ -391,7 +400,7 @@ export interface HawkSearchConfig {
      */
     itemTypes?: {
         /**
-         * 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.
+         * 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.
          *
          * #### Default Value
          * `'content'`
@@ -418,12 +427,6 @@ export interface HawkSearchConfig {
          * `'disableSpellcheck'`
          */
         disableSpellcheck?: string;
-        /**
-         * This value is used as a prefix before the field name of the facet. For example, with the default value, if the field name is `color`, the query string parameter would become `facet-color`.
-         * #### Default Value
-         * `'facet'`
-         */
-        facet?: string;
         /**
          * #### Default Value
          * `'page'`
@@ -457,6 +460,18 @@ export interface HawkSearchConfig {
      * `'/search'`
      */
     searchUrl?: 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.
      *