feat(relevantSort): implement canRefine (#4693)

* feat(relevantSort): implement canRefine

* fix canRefine and the test cases

Author: Eunjae Lee

src/connectors/relevant-sort/__tests__/connectRelevantSort-test.ts

@@ -172,6 +172,7 @@ describe('connectRelevantSort', () => {
       expect(renderState1.relevantSort).toEqual({
         isRelevantSorted: false,
         isVirtualReplica: false,
+        canRefine: false,
         refine: expect.any(Function),
         widgetParams: {},
       });
@@ -192,6 +193,7 @@ describe('connectRelevantSort', () => {
       expect(renderState2.relevantSort).toEqual({
         isRelevantSorted: true,
         isVirtualReplica: true,
+        canRefine: true,
         refine: expect.any(Function),
         widgetParams: {},
       });
@@ -210,6 +212,7 @@ describe('connectRelevantSort', () => {
       expect(widgetRenderState1).toEqual({
         isRelevantSorted: false,
         isVirtualReplica: false,
+        canRefine: false,
         refine: expect.any(Function),
         widgetParams: {},
       });
@@ -229,6 +232,7 @@ describe('connectRelevantSort', () => {
       expect(widgetRenderState2).toEqual({
         isRelevantSorted: true,
         isVirtualReplica: true,
+        canRefine: true,
         refine: expect.any(Function),
         widgetParams: {},
       });

src/connectors/relevant-sort/connectRelevantSort.ts

@@ -6,8 +6,24 @@ export type RelevantSortConnectorParams = Record<string, unknown>;
 type Refine = (relevancyStrictness: number) => void;
 
 export type RelevantSortRendererOptions = {
+  /**
+   * Indicates if it has appliedRelevancyStrictness greater than zero
+   */
   isRelevantSorted: boolean;
+
+  /**
+   * Indicates if the results come from a virtual replica
+   */
   isVirtualReplica: boolean;
+
+  /**
+   * Indicates if search state can be refined
+   */
+  canRefine: boolean;
+
+  /**
+   * Sets the value as relevancyStrictness and trigger a new search
+   */
   refine: Refine;
 };
 
@@ -77,11 +93,14 @@ const connectRelevantSort: RelevantSortConnector = function connectRelevantSort(
 
         const { appliedRelevancyStrictness } = results || {};
 
+        const isVirtualReplica = appliedRelevancyStrictness !== undefined;
+
         return {
           isRelevantSorted:
             typeof appliedRelevancyStrictness !== 'undefined' &&
             appliedRelevancyStrictness > 0,
-          isVirtualReplica: appliedRelevancyStrictness !== undefined,
+          isVirtualReplica,
+          canRefine: isVirtualReplica,
           refine: connectorState.refine,
           widgetParams,
         };