@bridgeline-digital/hawksearch-handlebars-ui 5.0.0-beta.6 → 5.0.0
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.
- package/changelog.md +102 -102
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/readme.md +1 -1
package/changelog.md
CHANGED
|
@@ -1,102 +1,102 @@
|
|
|
1
|
-
# 5.0.0
|
|
2
|
-
|
|
3
|
-
## New Features
|
|
4
|
-
|
|
5
|
-
1. Added VariantSelectorComponent
|
|
6
|
-
2. Implemented VariantSelectorComponent in default templates for search results, featured items, recommendations, and autocomplete
|
|
7
|
-
|
|
8
|
-
## Bug Fixes
|
|
9
|
-
|
|
10
|
-
1. Updated the `attributes` collection on recommendation items to split single string values by `|^|` into string arrays
|
|
11
|
-
2. Added logic to catch HTTP errors in service layer
|
|
12
|
-
|
|
13
|
-
## Breaking Changes
|
|
14
|
-
|
|
15
|
-
1. Modified JSON structure for field mapping configuration
|
|
16
|
-
2. The `attributes` collection on recommendation items now consists of the data in `customDict` from the API response rather than preserving `customDict` as a nested property
|
|
17
|
-
|
|
18
|
-
# 4.0.4
|
|
19
|
-
|
|
20
|
-
1. Modified RecommendationsService to transform response properties into arrays to be consistent with search results and autocomplete
|
|
21
|
-
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.
|
|
22
|
-
3. Fixed bug with autocomplete top categories links not working when not on search results page
|
|
23
|
-
4. Fixed parameter name in order tracking event data
|
|
24
|
-
|
|
25
|
-
# 4.0.3
|
|
26
|
-
|
|
27
|
-
1. Fixed URL parsing logic to avoid prepending domain when API returns a value starting with `//`
|
|
28
|
-
|
|
29
|
-
# 4.0.2
|
|
30
|
-
|
|
31
|
-
1. Updated `number` and `currency` Handlebars helpers to handle string values from API and made decimals parameter optional
|
|
32
|
-
|
|
33
|
-
# 4.0.1
|
|
34
|
-
|
|
35
|
-
1. Modified SearchService so that `hawksearch:after-search-completed` event fires before SEO elements are set
|
|
36
|
-
|
|
37
|
-
# 4.0.0
|
|
38
|
-
|
|
39
|
-
## New Features
|
|
40
|
-
|
|
41
|
-
1. Added `HawkSearch.config.autocomplete.recommendationsEnabled` property with a default value of `false` to toggle autocomplete recommendations (instant engage)
|
|
42
|
-
2. Added new RatingComponent to be displayed on SearchResultsItemComponent, RecommendationsItemComponent, and FeaturedItemsContentItemComponent.
|
|
43
|
-
3. Added product ratings and prices to autocomplete
|
|
44
|
-
4. Added suggested queries (did you mean?) to autocomplete
|
|
45
|
-
|
|
46
|
-
## Bug Fixes
|
|
47
|
-
|
|
48
|
-
1. Converting `price` and `salePrice` values of 0 to `undefined`
|
|
49
|
-
2. Fixed price rendering logic in default templates of SearchResultsItemComponent, RecommendationsItemComponent, and FeaturedItemsContentItemComponent
|
|
50
|
-
|
|
51
|
-
## Breaking Changes
|
|
52
|
-
|
|
53
|
-
1. Refactored HawkSearchConfig structure to group properties by search, autocomplete, and recommendations. Some property names have changed slightly.
|
|
54
|
-
2. Modified endpoints configuration to expect only domain rather than full API URL
|
|
55
|
-
|
|
56
|
-
# 3.0.0
|
|
57
|
-
|
|
58
|
-
## New Features
|
|
59
|
-
|
|
60
|
-
1. Added support for A/B testing in Recommendations component
|
|
61
|
-
2. Added support for default autocomplete without entering a query
|
|
62
|
-
3. Modified autocomplete to display when refocusing on search field
|
|
63
|
-
4. Added optional `item-id` attribute to Recommendations component
|
|
64
|
-
5. Added instance-level configuration overrides through `config` attribute or `configOverride` property
|
|
65
|
-
|
|
66
|
-
## Bug Fixes
|
|
67
|
-
|
|
68
|
-
1. Fixed script file name and configuration link in documentation
|
|
69
|
-
2. Fixed bug requiring double-click to expand facet that is collapsed by default
|
|
70
|
-
|
|
71
|
-
## Breaking Changes
|
|
72
|
-
|
|
73
|
-
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
|
|
74
|
-
|
|
75
|
-
# 2.0.0
|
|
76
|
-
|
|
77
|
-
## New Features
|
|
78
|
-
|
|
79
|
-
1. Added Landing Pages components
|
|
80
|
-
2. Added Recommendations components
|
|
81
|
-
3. Added component-level configuration to support functionality toggles and easy string replacements
|
|
82
|
-
4. Added `hawksearch:before-${componentName}-rendered` event hooks to support passing custom data to Handlebars templates
|
|
83
|
-
5. Added configuration setting to toggle facet exclude value functionality. This is now disabled by default.
|
|
84
|
-
6. Added ability to load CSS styles without requiring an external stylesheet
|
|
85
|
-
7. Added customizable index to search results, autocomplete, and recommendations requests
|
|
86
|
-
8. Added ability to set product as default search results item type
|
|
87
|
-
9. Added alternate `[[value]]` syntax to work the same as the default Handlerbars `{{value}}` syntax to avoid conflicts when customizing templates within BigCommerce
|
|
88
|
-
10. Added support for nested object properties in field mappings
|
|
89
|
-
11. Added rendering of canonical URL including search refinements
|
|
90
|
-
12. Added configurable facet exclusion prefix
|
|
91
|
-
13. Implemented TypeDoc code-generated documentation to ensure it remains up-to-date and available for each version
|
|
92
|
-
|
|
93
|
-
## Bug Fixes
|
|
94
|
-
|
|
95
|
-
1. Fixed Autocomplete template name
|
|
96
|
-
2. Added logic to handle scrolling facets by setting a max-height in default template
|
|
97
|
-
|
|
98
|
-
## Breaking Changes
|
|
99
|
-
|
|
100
|
-
1. Changed entry file from `hawksearch-handlebars-ui.js` to `index.js`
|
|
101
|
-
2. Renamed `Hawksearch` global object to `HawkSearch`
|
|
102
|
-
3. Changes to `HawkSearch.config` model to support new features
|
|
1
|
+
# 5.0.0
|
|
2
|
+
|
|
3
|
+
## New Features
|
|
4
|
+
|
|
5
|
+
1. Added VariantSelectorComponent
|
|
6
|
+
2. Implemented VariantSelectorComponent in default templates for search results, featured items, recommendations, and autocomplete
|
|
7
|
+
|
|
8
|
+
## Bug Fixes
|
|
9
|
+
|
|
10
|
+
1. Updated the `attributes` collection on recommendation items to split single string values by `|^|` into string arrays
|
|
11
|
+
2. Added logic to catch HTTP errors in service layer
|
|
12
|
+
|
|
13
|
+
## Breaking Changes
|
|
14
|
+
|
|
15
|
+
1. Modified JSON structure for field mapping configuration
|
|
16
|
+
2. The `attributes` collection on recommendation items now consists of the data in `customDict` from the API response rather than preserving `customDict` as a nested property
|
|
17
|
+
|
|
18
|
+
# 4.0.4
|
|
19
|
+
|
|
20
|
+
1. Modified RecommendationsService to transform response properties into arrays to be consistent with search results and autocomplete
|
|
21
|
+
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.
|
|
22
|
+
3. Fixed bug with autocomplete top categories links not working when not on search results page
|
|
23
|
+
4. Fixed parameter name in order tracking event data
|
|
24
|
+
|
|
25
|
+
# 4.0.3
|
|
26
|
+
|
|
27
|
+
1. Fixed URL parsing logic to avoid prepending domain when API returns a value starting with `//`
|
|
28
|
+
|
|
29
|
+
# 4.0.2
|
|
30
|
+
|
|
31
|
+
1. Updated `number` and `currency` Handlebars helpers to handle string values from API and made decimals parameter optional
|
|
32
|
+
|
|
33
|
+
# 4.0.1
|
|
34
|
+
|
|
35
|
+
1. Modified SearchService so that `hawksearch:after-search-completed` event fires before SEO elements are set
|
|
36
|
+
|
|
37
|
+
# 4.0.0
|
|
38
|
+
|
|
39
|
+
## New Features
|
|
40
|
+
|
|
41
|
+
1. Added `HawkSearch.config.autocomplete.recommendationsEnabled` property with a default value of `false` to toggle autocomplete recommendations (instant engage)
|
|
42
|
+
2. Added new RatingComponent to be displayed on SearchResultsItemComponent, RecommendationsItemComponent, and FeaturedItemsContentItemComponent.
|
|
43
|
+
3. Added product ratings and prices to autocomplete
|
|
44
|
+
4. Added suggested queries (did you mean?) to autocomplete
|
|
45
|
+
|
|
46
|
+
## Bug Fixes
|
|
47
|
+
|
|
48
|
+
1. Converting `price` and `salePrice` values of 0 to `undefined`
|
|
49
|
+
2. Fixed price rendering logic in default templates of SearchResultsItemComponent, RecommendationsItemComponent, and FeaturedItemsContentItemComponent
|
|
50
|
+
|
|
51
|
+
## Breaking Changes
|
|
52
|
+
|
|
53
|
+
1. Refactored HawkSearchConfig structure to group properties by search, autocomplete, and recommendations. Some property names have changed slightly.
|
|
54
|
+
2. Modified endpoints configuration to expect only domain rather than full API URL
|
|
55
|
+
|
|
56
|
+
# 3.0.0
|
|
57
|
+
|
|
58
|
+
## New Features
|
|
59
|
+
|
|
60
|
+
1. Added support for A/B testing in Recommendations component
|
|
61
|
+
2. Added support for default autocomplete without entering a query
|
|
62
|
+
3. Modified autocomplete to display when refocusing on search field
|
|
63
|
+
4. Added optional `item-id` attribute to Recommendations component
|
|
64
|
+
5. Added instance-level configuration overrides through `config` attribute or `configOverride` property
|
|
65
|
+
|
|
66
|
+
## Bug Fixes
|
|
67
|
+
|
|
68
|
+
1. Fixed script file name and configuration link in documentation
|
|
69
|
+
2. Fixed bug requiring double-click to expand facet that is collapsed by default
|
|
70
|
+
|
|
71
|
+
## Breaking Changes
|
|
72
|
+
|
|
73
|
+
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
|
|
74
|
+
|
|
75
|
+
# 2.0.0
|
|
76
|
+
|
|
77
|
+
## New Features
|
|
78
|
+
|
|
79
|
+
1. Added Landing Pages components
|
|
80
|
+
2. Added Recommendations components
|
|
81
|
+
3. Added component-level configuration to support functionality toggles and easy string replacements
|
|
82
|
+
4. Added `hawksearch:before-${componentName}-rendered` event hooks to support passing custom data to Handlebars templates
|
|
83
|
+
5. Added configuration setting to toggle facet exclude value functionality. This is now disabled by default.
|
|
84
|
+
6. Added ability to load CSS styles without requiring an external stylesheet
|
|
85
|
+
7. Added customizable index to search results, autocomplete, and recommendations requests
|
|
86
|
+
8. Added ability to set product as default search results item type
|
|
87
|
+
9. Added alternate `[[value]]` syntax to work the same as the default Handlerbars `{{value}}` syntax to avoid conflicts when customizing templates within BigCommerce
|
|
88
|
+
10. Added support for nested object properties in field mappings
|
|
89
|
+
11. Added rendering of canonical URL including search refinements
|
|
90
|
+
12. Added configurable facet exclusion prefix
|
|
91
|
+
13. Implemented TypeDoc code-generated documentation to ensure it remains up-to-date and available for each version
|
|
92
|
+
|
|
93
|
+
## Bug Fixes
|
|
94
|
+
|
|
95
|
+
1. Fixed Autocomplete template name
|
|
96
|
+
2. Added logic to handle scrolling facets by setting a max-height in default template
|
|
97
|
+
|
|
98
|
+
## Breaking Changes
|
|
99
|
+
|
|
100
|
+
1. Changed entry file from `hawksearch-handlebars-ui.js` to `index.js`
|
|
101
|
+
2. Renamed `Hawksearch` global object to `HawkSearch`
|
|
102
|
+
3. Changes to `HawkSearch.config` model to support new features
|