feat(refinementList): add escapeFacetHits parameter (#2507)

* chore(sffv): confirm #2474
* feat(sffv): implement XSS escape on search for facet values
* feat(refinementList): add escapeFacetHits
* chore(deps): update AlgoliaSearch Helper
* chore(doc): add new options
* chore(dev-novel): add a story for just escaping the values
* chore: fix code style
* chore(test): rm sinon of connectRefinementList test
* chore(test): clean up setImmmediate from connectRefinementList test
* refactor(refinement-list): use Boolean to convert escapeFacetValues
* chore(test): cleanup all setImmediate
* chore(test): use consise API when possible

dev/app/init-builtin-widgets.js

@@ -548,6 +548,58 @@ export default () => {
           })
         );
       })
+    )
+    .add(
+      'escape the facet values',
+      wrapWithHits(container => {
+        window.search.addWidget(
+          instantsearch.widgets.refinementList({
+            container,
+            attributeName: 'brand',
+            operator: 'or',
+            limit: 10,
+            templates: {
+              header: 'Searchable brands',
+            },
+            searchForFacetValues: {
+              placeholder: 'Find other brands...',
+              escapeFacetValues: true,
+            },
+          })
+        );
+      })
+    )
+    .add(
+      'with a hits widget with escapeHits set to true',
+      wrapWithHits(container => {
+        const list = document.createElement('div');
+        const hits = document.createElement('div');
+        container.appendChild(hits);
+        container.appendChild(list);
+        window.search.addWidget(
+          instantsearch.widgets.hits({
+            container: hits,
+            templates: {
+              item: '',
+            },
+            escapeHits: true,
+          })
+        );
+        window.search.addWidget(
+          instantsearch.widgets.refinementList({
+            container: list,
+            attributeName: 'brand',
+            operator: 'or',
+            limit: 10,
+            templates: {
+              header: 'Searchable brands',
+            },
+            searchForFacetValues: {
+              placeholder: 'Find other brands...',
+            },
+          })
+        );
+      })
     );
 
   storiesOf('StarRating').add(

package.json

@@ -113,7 +113,7 @@
   },
   "dependencies": {
     "algoliasearch": "^3.24.0",
-    "algoliasearch-helper": "^2.22.0",
+    "algoliasearch-helper": "^2.23.0",
     "classnames": "^2.2.5",
     "events": "^1.1.0",
     "hogan.js": "^3.0.2",