@bridgeline-digital/hawksearch-handlebars-ui 2.0.0-beta.8 → 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/components/index.d.ts

@@ -1,17 +1,17 @@
 /**
- * ## Customizing Markup
+ * ## Overriding Component Templates
  *
  * This library was designed to be flexible and allow total customization of the markup used by all components.
  *
- * ### Overriding Templates
- *
  * There are three ways to replace the Handlebars template used by a component:
  *
  * - Pass a template HTML string containing a Handlebars template.
  * - Pass the ID of a template element containing a Handlebars template.
  * - Define the new Handlebars template as the child content of a control
  *
- * #### Passing an HTML string
+ * *Note: To avoid conflicts with BigCommerce and other systems that Handlebars for server-side rendering, this library also supports an alternate `[[value]]` syntax to work the same as the default Handlerbars `{{value}}` syntax.*
+ *
+ * ### Passing an HTML string
  *
  * In your HTML file, define the template content directly in the configuration options:
  *
@@ -51,7 +51,7 @@
  * </html>
  * ```
  *
- * #### Creating a template element
+ * ### Creating a template element
  *
  * In your HTML file, add the custom markup to a `template` element and pass the ID in the configuration options:
  *
@@ -95,7 +95,7 @@
  *
  * *Note: This approach tends to be easier to manage than the previous option as it is more compatible with popular HTML editors and templates can potentially be loaded from separate files using Server-side Includes (SSI).*
  *
- * #### Setting control content
+ * ### Setting control content
  *
  * In your HTML file, add the custom markup as the content of a component element:
  *

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

@@ -296,79 +296,89 @@ export interface HawkSearchConfig {
         tracking: string;
     };
     /**
-     * Map item attributes to common object properties
+     * Specify an index to query rather than the default
      */
-    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;
-    };
+    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
      */
-    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
@@ -390,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'`
@@ -417,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'`
@@ -456,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.
      *