feat(clearRefinements): implement canRefine (#4684)

* feat(clearRefinements): implement canRefine

DX-1310

* Update src/connectors/clear-refinements/connectClearRefinements.ts

Co-authored-by: Eunjae Lee <eunjae.lee@algolia.com>

Co-authored-by: Eunjae Lee <eunjae.lee@algolia.com>

Author: Haroenv

src/connectors/clear-refinements/__tests__/connectClearRefinements-test.ts

@@ -84,6 +84,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/clear-refin
       expect(isFirstRenderAtInit).toBe(true);
       expect(firstRenderingOptions.createURL).toBeInstanceOf(Function);
       expect(firstRenderingOptions.refine).toBeInstanceOf(Function);
+      expect(firstRenderingOptions.canRefine).toBe(false);
       expect(firstRenderingOptions.hasRefinements).toBe(false);
       expect(firstRenderingOptions.widgetParams).toEqual({
         foo: 'bar', // dummy param to test `widgetParams`
@@ -111,6 +112,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/clear-refin
       expect(secondRenderingOptions.createURL).toBeInstanceOf(Function);
       expect(secondRenderingOptions.refine).toBeInstanceOf(Function);
       expect(secondRenderingOptions.hasRefinements).toBe(false);
+      expect(secondRenderingOptions.canRefine).toBe(false);
     });
 
     it('does not throw without the unmount function', () => {
@@ -151,6 +153,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/clear-refin
 
         expect(renderState1.clearRefinements).toEqual({
           hasRefinements: false,
+          canRefine: false,
           createURL: expect.any(Function),
           refine: expect.any(Function),
           widgetParams: {},
@@ -197,6 +200,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/clear-refin
 
         expect(renderState2.clearRefinements).toEqual({
           hasRefinements: true,
+          canRefine: true,
           createURL: expect.any(Function),
           refine: expect.any(Function),
           widgetParams: {},
@@ -230,6 +234,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/clear-refin
 
         expect(renderState1).toEqual({
           hasRefinements: false,
+          canRefine: false,
           createURL: expect.any(Function),
           refine: expect.any(Function),
           widgetParams: {},
@@ -275,6 +280,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/clear-refin
 
         expect(renderState2).toEqual({
           hasRefinements: true,
+          canRefine: true,
           createURL: expect.any(Function),
           refine: expect.any(Function),
           widgetParams: {},
@@ -434,6 +440,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/clear-refin
       );
 
       expect(rendering.mock.calls[0][0].hasRefinements).toBe(false);
+      expect(rendering.mock.calls[0][0].canRefine).toBe(false);
 
       widget.render!(
         createRenderOptions({
@@ -446,6 +453,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/clear-refin
       );
 
       expect(rendering.mock.calls[1][0].hasRefinements).toBe(true);
+      expect(rendering.mock.calls[1][0].canRefine).toBe(true);
     });
 
     it('with query not excluded and not empty has refinements', () => {
@@ -471,6 +479,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/clear-refin
       );
 
       expect(rendering.mock.calls[0][0].hasRefinements).toBe(false);
+      expect(rendering.mock.calls[0][0].canRefine).toBe(false);
 
       widget.render!(
         createRenderOptions({
@@ -483,6 +492,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/clear-refin
       );
 
       expect(rendering.mock.calls[1][0].hasRefinements).toBe(true);
+      expect(rendering.mock.calls[1][0].canRefine).toBe(true);
     });
 
     it('with query not excluded and empty has no refinements', () => {
@@ -505,6 +515,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/clear-refin
       );
 
       expect(rendering.mock.calls[0][0].hasRefinements).toBe(false);
+      expect(rendering.mock.calls[0][0].canRefine).toBe(false);
 
       widget.render!(
         createRenderOptions({
@@ -517,6 +528,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/clear-refin
       );
 
       expect(rendering.mock.calls[1][0].hasRefinements).toBe(false);
+      expect(rendering.mock.calls[1][0].canRefine).toBe(false);
     });
 
     it('without includedAttributes or excludedAttributes and with a query has no refinements', () => {
@@ -536,6 +548,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/clear-refin
       );
 
       expect(rendering.mock.calls[0][0].hasRefinements).toBe(false);
+      expect(rendering.mock.calls[0][0].canRefine).toBe(false);
 
       widget.render!(
         createRenderOptions({
@@ -548,6 +561,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/clear-refin
       );
 
       expect(rendering.mock.calls[1][0].hasRefinements).toBe(false);
+      expect(rendering.mock.calls[1][0].canRefine).toBe(false);
     });
 
     it('includes only includedAttributes', () => {
@@ -601,6 +615,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/clear-refin
       expect(helper.hasRefinements('facet1')).toBe(false);
       expect(helper.hasRefinements('facet2')).toBe(true);
       expect(rendering.mock.calls[2][0].hasRefinements).toBe(false);
+      expect(rendering.mock.calls[2][0].canRefine).toBe(false);
     });
 
     it('includes only includedAttributes (with query)', () => {
@@ -651,6 +666,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/clear-refin
       expect(helper.hasRefinements('facet1')).toBe(false);
       expect(helper.state.query).toBe('');
       expect(rendering.mock.calls[2][0].hasRefinements).toBe(false);
+      expect(rendering.mock.calls[2][0].canRefine).toBe(false);
     });
 
     it('excludes excludedAttributes', () => {
@@ -699,6 +715,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/clear-refin
         expect(helper.hasRefinements('facet2')).toBe(true);
 
         expect(rendering.mock.calls[1][0].hasRefinements).toBe(true);
+        expect(rendering.mock.calls[1][0].canRefine).toBe(true);
       }
 
       {
@@ -798,6 +815,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/clear-refin
       expect(helper.hasRefinements('facet3')).toBe(false);
       expect(helper.state.query).toBe('');
       expect(rendering.mock.calls[2][0].hasRefinements).toBe(false);
+      expect(rendering.mock.calls[2][0].canRefine).toBe(false);
     });
 
     describe('createURL', () => {

src/connectors/clear-refinements/connectClearRefinements.ts

@@ -40,9 +40,15 @@ export type ClearRefinementsRendererOptions = {
 
   /**
    * Indicates if search state is refined.
+   * @deprecated prefer reading canRefine
    */
   hasRefinements: boolean;
 
+  /**
+   * Indicates if search state can be refined.
+   */
+  canRefine: boolean;
+
   /**
    * Creates a url for the next state when refinements are cleared.
    */
@@ -176,10 +182,13 @@ const connectClearRefinements: ClearRefinementsConnector = function connectClear
             )
           );
 
+        const canRefine = connectorState.attributesToClear.some(
+          attributeToClear => attributeToClear.items.length > 0
+        );
+
         return {
-          hasRefinements: connectorState.attributesToClear.some(
-            attributeToClear => attributeToClear.items.length > 0
-          ),
+          canRefine,
+          hasRefinements: canRefine,
           refine: cachedRefine,
           createURL: cachedCreateURL,
           widgetParams,