@bridgeline-digital/hawksearch-handlebars-ui 4.0.0 → 4.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/changelog.md +74 -66
  2. package/dist/helpers/helpers.d.ts +2 -2
  3. package/dist/index.js +1 -1
  4. package/dist/index.js.map +1 -1
  5. package/package.json +1 -1
  6. package/readme.md +1 -1
package/changelog.md CHANGED
@@ -1,66 +1,74 @@
1
- # 4.0.0
2
-
3
- ## New Features
4
-
5
- 1. Added `HawkSearch.config.autocomplete.recommendationsEnabled` property with a default value of `false` to toggle autocomplete recommendations (instant engage)
6
- 2. Added new RatingComponent to be displayed on SearchResultsItemComponent, RecommendationsItemComponent, and FeaturedItemsContentItemComponent.
7
- 3. Added product ratings and prices to autocomplete
8
- 4. Added suggested queries (did you mean?) to autocomplete
9
-
10
- ## Bug Fixes
11
-
12
- 1. Converting `price` and `salePrice` values of 0 to `undefined`
13
- 2. Fixed price rendering logic in default templates of SearchResultsItemComponent, RecommendationsItemComponent, and FeaturedItemsContentItemComponent
14
-
15
- ## Breaking Changes
16
-
17
- 1. Refactored HawkSearchConfig structure to group properties by search, autocomplete, and recommendations. Some property names have changed slightly.
18
- 2. Modified endpoints configuration to expect only domain rather than full API URL
19
-
20
- # 3.0.0
21
-
22
- ## New Features
23
-
24
- 1. Added support for A/B testing in Recommendations component
25
- 2. Added support for default autocomplete without entering a query
26
- 3. Modified autocomplete to display when refocusing on search field
27
- 4. Added optional `item-id` attribute to Recommendations component
28
- 5. Added instance-level configuration overrides through `config` attribute or `configOverride` property
29
-
30
- ## Bug Fixes
31
-
32
- 1. Fixed script file name and configuration link in documentation
33
- 2. Fixed bug requiring double-click to expand facet that is collapsed by default
34
-
35
- ## Breaking Changes
36
-
37
- 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
38
-
39
- # 2.0.0
40
-
41
- ## New Features
42
-
43
- 1. Added Landing Pages components
44
- 2. Added Recommendations components
45
- 3. Added component-level configuration to support functionality toggles and easy string replacements
46
- 4. Added `hawksearch:before-${componentName}-rendered` event hooks to support passing custom data to Handlebars templates
47
- 5. Added configuration setting to toggle facet exclude value functionality. This is now disabled by default.
48
- 6. Added ability to load CSS styles without requiring an external stylesheet
49
- 7. Added customizable index to search results, autocomplete, and recommendations requests
50
- 8. Added ability to set product as default search results item type
51
- 9. Added alternate `[[value]]` syntax to work the same as the default Handlerbars `{{value}}` syntax to avoid conflicts when customizing templates within BigCommerce
52
- 10. Added support for nested object properties in field mappings
53
- 11. Added rendering of canonical URL including search refinements
54
- 12. Added configurable facet exclusion prefix
55
- 13. Implemented TypeDoc code-generated documentation to ensure it remains up-to-date and available for each version
56
-
57
- ## Bug Fixes
58
-
59
- 1. Fixed Autocomplete template name
60
- 2. Added logic to handle scrolling facets by setting a max-height in default template
61
-
62
- ## Breaking Changes
63
-
64
- 1. Changed entry file from `hawksearch-handlebars-ui.js` to `index.js`
65
- 2. Renamed `Hawksearch` global object to `HawkSearch`
66
- 3. Changes to `HawkSearch.config` model to support new features
1
+ # 4.0.2
2
+
3
+ 1. Updated `number` and `currency` Handlebars helpers to handle string values from API and made decimals parameter optional
4
+
5
+ # 4.0.1
6
+
7
+ 1. Modified SearchService so that `hawksearch:after-search-completed` event fires before SEO elements are set
8
+
9
+ # 4.0.0
10
+
11
+ ## New Features
12
+
13
+ 1. Added `HawkSearch.config.autocomplete.recommendationsEnabled` property with a default value of `false` to toggle autocomplete recommendations (instant engage)
14
+ 2. Added new RatingComponent to be displayed on SearchResultsItemComponent, RecommendationsItemComponent, and FeaturedItemsContentItemComponent.
15
+ 3. Added product ratings and prices to autocomplete
16
+ 4. Added suggested queries (did you mean?) to autocomplete
17
+
18
+ ## Bug Fixes
19
+
20
+ 1. Converting `price` and `salePrice` values of 0 to `undefined`
21
+ 2. Fixed price rendering logic in default templates of SearchResultsItemComponent, RecommendationsItemComponent, and FeaturedItemsContentItemComponent
22
+
23
+ ## Breaking Changes
24
+
25
+ 1. Refactored HawkSearchConfig structure to group properties by search, autocomplete, and recommendations. Some property names have changed slightly.
26
+ 2. Modified endpoints configuration to expect only domain rather than full API URL
27
+
28
+ # 3.0.0
29
+
30
+ ## New Features
31
+
32
+ 1. Added support for A/B testing in Recommendations component
33
+ 2. Added support for default autocomplete without entering a query
34
+ 3. Modified autocomplete to display when refocusing on search field
35
+ 4. Added optional `item-id` attribute to Recommendations component
36
+ 5. Added instance-level configuration overrides through `config` attribute or `configOverride` property
37
+
38
+ ## Bug Fixes
39
+
40
+ 1. Fixed script file name and configuration link in documentation
41
+ 2. Fixed bug requiring double-click to expand facet that is collapsed by default
42
+
43
+ ## Breaking Changes
44
+
45
+ 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
46
+
47
+ # 2.0.0
48
+
49
+ ## New Features
50
+
51
+ 1. Added Landing Pages components
52
+ 2. Added Recommendations components
53
+ 3. Added component-level configuration to support functionality toggles and easy string replacements
54
+ 4. Added `hawksearch:before-${componentName}-rendered` event hooks to support passing custom data to Handlebars templates
55
+ 5. Added configuration setting to toggle facet exclude value functionality. This is now disabled by default.
56
+ 6. Added ability to load CSS styles without requiring an external stylesheet
57
+ 7. Added customizable index to search results, autocomplete, and recommendations requests
58
+ 8. Added ability to set product as default search results item type
59
+ 9. Added alternate `[[value]]` syntax to work the same as the default Handlerbars `{{value}}` syntax to avoid conflicts when customizing templates within BigCommerce
60
+ 10. Added support for nested object properties in field mappings
61
+ 11. Added rendering of canonical URL including search refinements
62
+ 12. Added configurable facet exclusion prefix
63
+ 13. Implemented TypeDoc code-generated documentation to ensure it remains up-to-date and available for each version
64
+
65
+ ## Bug Fixes
66
+
67
+ 1. Fixed Autocomplete template name
68
+ 2. Added logic to handle scrolling facets by setting a max-height in default template
69
+
70
+ ## Breaking Changes
71
+
72
+ 1. Changed entry file from `hawksearch-handlebars-ui.js` to `index.js`
73
+ 2. Renamed `Hawksearch` global object to `HawkSearch`
74
+ 3. Changes to `HawkSearch.config` model to support new features
package/dist/helpers/helpers.d.ts CHANGED
@@ -101,7 +101,7 @@ export declare function html(html: string): Handlebars.SafeString;
101
101
  * @param defaultValue Default value
102
102
  * @returns Formatted currency string
103
103
  */
104
- export declare function currency(value: number | Array<number> | undefined, decimals: number | undefined, defaultValue?: number): string | undefined;
104
+ export declare function currency(value: number | string | Array<number> | Array<string> | undefined, decimals: number | undefined, defaultValue?: number): string | undefined;
105
105
  /**
106
106
  * This function returns whether the first provided value is greater than the second provided value.
107
107
  *
@@ -156,7 +156,7 @@ export declare function lte(value1: any, value2: any): boolean;
156
156
  * @param defaultValue Default value
157
157
  * @returns Formatted number string
158
158
  */
159
- export declare function number(value: number | Array<number> | undefined, decimals: number, defaultValue?: number): string | undefined;
159
+ export declare function number(value: number | string | Array<number> | Array<string> | undefined, decimals: number | undefined, defaultValue?: number): string | undefined;
160
160
  /**
161
161
  * This function returns whether any provided value resolves to `true`.
162
162
  *