feat(pagination): implement canRefine (#4683)

* feat(pagination): implement canRefine

DX-1313

* add canRefine to mock

* chore(test): take impact in account

Author: Haroenv

src/connectors/pagination/__tests__/connectPagination-test.ts

@@ -445,6 +445,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/pagination/
         pages: [],
         createURL: expect.any(Function),
         refine: expect.any(Function),
+        canRefine: false,
         widgetParams: {},
       });
     });
@@ -461,6 +462,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/pagination/
         pages: [],
         createURL: expect.any(Function),
         refine: expect.any(Function),
+        canRefine: false,
         widgetParams: { padding: 5 },
       });
     });
@@ -487,6 +489,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/pagination/
         pages: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10],
         createURL: expect.any(Function),
         refine: expect.any(Function),
+        canRefine: true,
         widgetParams: { padding: 5 },
       });
     });
@@ -519,6 +522,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/pagination/
         pages: [15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25],
         createURL: expect.any(Function),
         refine: expect.any(Function),
+        canRefine: true,
         widgetParams: { padding: 5 },
       });
     });
@@ -551,6 +555,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/pagination/
         pages: [89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99],
         createURL: expect.any(Function),
         refine: expect.any(Function),
+        canRefine: true,
         widgetParams: { padding: 5 },
       });
     });
@@ -563,6 +568,34 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/pagination/
 
       expect(refine2).toBe(refine1);
     });
+
+    it('gives `canRefine` as false for a single page', () => {
+      const [widget] = getInitializedWidget();
+
+      const { canRefine } = widget.getWidgetRenderState(
+        createRenderOptions({
+          results: new SearchResults(new SearchParameters(), [
+            createSingleSearchResponse({ nbPages: 1 }),
+          ]),
+        })
+      );
+
+      expect(canRefine).toBe(false);
+    });
+
+    it('gives `canRefine` as true for a multiple pages', () => {
+      const [widget] = getInitializedWidget();
+
+      const { canRefine } = widget.getWidgetRenderState(
+        createRenderOptions({
+          results: new SearchResults(new SearchParameters(), [
+            createSingleSearchResponse({ nbPages: 2 }),
+          ]),
+        })
+      );
+
+      expect(canRefine).toBe(true);
+    });
   });
 
   describe('getRenderState', () => {
@@ -601,6 +634,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/pagination/
           pages: [15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25],
           createURL: expect.any(Function),
           refine: expect.any(Function),
+          canRefine: true,
           widgetParams: { padding: 5 },
         },
       });

src/connectors/pagination/connectPagination.ts

@@ -32,6 +32,9 @@ export type PaginationRendererOptions = {
   /** Sets the current page and triggers a search. */
   refine(page: number): void;
 
+  /** true if this search returned more than one page */
+  canRefine: boolean;
+
   /** The number of the page currently displayed. */
   currentRefinement: number;
 
@@ -163,6 +166,7 @@ const connectPagination: ConnectPagination = function connectPagination(
         return {
           createURL: connectorState.createURL(state),
           refine: connectorState.refine,
+          canRefine: nbPages > 1,
           currentRefinement: page,
           nbHits: results?.nbHits || 0,
           nbPages,

src/widgets/index/__tests__/index-test.ts

@@ -2173,6 +2173,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/index-widge
             ...renderState,
             pagination: {
               refine: paginationRefine,
+              canRefine: false,
               createURL: paginationCreateURL,
               isFirstPage: true,
               isLastPage: true,
@@ -2207,6 +2208,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/index-widge
               },
               pagination: {
                 refine: paginationRefine,
+                canRefine: false,
                 createURL: paginationCreateURL,
                 isFirstPage: true,
                 isLastPage: true,
@@ -2240,6 +2242,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/index-widge
               },
               pagination: {
                 refine: paginationRefine,
+                canRefine: false,
                 createURL: paginationCreateURL,
                 isFirstPage: true,
                 isLastPage: true,
@@ -2286,6 +2289,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/index-widge
             ...renderState,
             pagination: {
               refine: () => {},
+              canRefine: false,
               createURL: () => '',
               isFirstPage: true,
               isLastPage: true,