@coveo/headless 3.28.0 → 3.28.1-pre.060ac226ea

package/dist/definitions/controllers/core/sort/headless-core-sort.d.ts

@@ -32,6 +32,18 @@ export interface Sort extends Controller {
      * Verifies whether the specified sort criterion is the currently active one.
      *
      * @param criterion - The sort criterion to evaluate.
+     * Can be a single criterion or an array of criteria.
+     * The criteria in an array will be applied sequentially. For example, if there's a tie on the 1st criterion, the API uses the 2nd criterion to break the tie. However, this only works when combining:
+     * `SortByRelevancy` followed by one or more `SortByField` or `SortByDate` criteria.
+     * `SortByQRE` followed by one or more `SortByField` or `SortByDate` criteria.
+     * Two or more `SortByField` criteria.
+     * A single `SortByDate` criterion and one or more `SortByField` criteria in any order.
+     *
+     * Examples:
+     * * `SortByRelevancy`, `SortByField`
+     * * `SortByQRE`, `SortByField`
+     * * `SortByDate`, `SortByField`, `SortByField`
+     *
      * @returns `true` if the specified sort criterion is the currently active one; `false` otherwise.
      */
     isSortedBy(criterion: SortCriterion | SortCriterion[]): boolean;

package/dist/definitions/features/commerce/facets/core-facet/core-facet-actions.d.ts

@@ -4,6 +4,11 @@ export type UpdateCoreFacetNumberOfValuesPayload = UpdateFacetNumberOfValuesActi
 export declare const updateCoreFacetNumberOfValues: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: UpdateFacetNumberOfValuesActionCreatorPayload], UpdateFacetNumberOfValuesActionCreatorPayload, "commerce/facets/core/updateNumberOfValues", never, never>;
 export type UpdateCoreFacetIsFieldExpandedPayload = UpdateFacetIsFieldExpandedActionCreatorPayload;
 export declare const updateCoreFacetIsFieldExpanded: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: UpdateFacetIsFieldExpandedActionCreatorPayload], UpdateFacetIsFieldExpandedActionCreatorPayload, "commerce/facets/core/updateIsFieldExpanded", never, never>;
+/**
+ * Action to clear all core facet values.
+ *
+ * This is primarily used by the breadcrumb manager to reset all selected facets.
+ */
 export declare const clearAllCoreFacets: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"commerce/facets/core/clearAll">;
 export declare const deleteAllCoreFacets: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"commerce/facets/core/deleteAll">;
 export type DeselectAllValuesInCoreFacetPayload = {
@@ -12,6 +17,13 @@ export type DeselectAllValuesInCoreFacetPayload = {
      */
     facetId: string;
 };
+/**
+ * Action to deselect all values for a given facet.
+ *
+ * This is primarily used in facets to clear all selected values at the same time.
+ *
+ * @param payload - The payload of type {@link DeselectAllValuesInCoreFacetPayload} containing the facet ID to clear.
+ */
 export declare const deselectAllValuesInCoreFacet: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: DeselectAllValuesInCoreFacetPayload], DeselectAllValuesInCoreFacetPayload, "commerce/facets/core/deselectAllValues", never, never>;
 export type UpdateCoreFacetFreezeCurrentValuesPayload = UpdateFreezeCurrentValuesActionCreatorPayload;
 export declare const updateCoreFacetFreezeCurrentValues: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: UpdateFreezeCurrentValuesActionCreatorPayload], UpdateFreezeCurrentValuesActionCreatorPayload, "commerce/facets/core/updateFreezeCurrentValues", never, never>;

package/dist/definitions/features/commerce/facets/numeric-facet/numeric-facet-actions.d.ts

@@ -9,6 +9,13 @@ export interface ToggleSelectNumericFacetValuePayload {
      */
     selection: NumericRangeRequest;
 }
+/**
+ * Action to toggle a facet value of a NumericFacet.
+ *
+ * This is primarily used in facets and in breadcrumbs to select or deselect a facet value.
+ *
+ * @param payload - The payload of type {@link ToggleSelectNumericFacetValuePayload} containing the facet ID and the selection to toggle.
+ */
 export declare const toggleSelectNumericFacetValue: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: ToggleSelectNumericFacetValuePayload], ToggleSelectNumericFacetValuePayload, "commerce/facets/numericFacet/toggleSelectValue", never, never>;
 export type ToggleExcludeNumericFacetValuePayload = ToggleSelectNumericFacetValuePayload;
 export declare const toggleExcludeNumericFacetValue: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: ToggleSelectNumericFacetValuePayload], ToggleSelectNumericFacetValuePayload, "commerce/facets/numericFacet/toggleExcludeValue", never, never>;

package/dist/esm/features/commerce/facets/core-facet/core-facet-actions.js

@@ -9,8 +9,20 @@ export const updateCoreFacetIsFieldExpanded = createAction('commerce/facets/core
     facetId: requiredNonEmptyString,
     isFieldExpanded: new BooleanValue({ required: true }),
 }));
+/**
+ * Action to clear all core facet values.
+ *
+ * This is primarily used by the breadcrumb manager to reset all selected facets.
+ */
 export const clearAllCoreFacets = createAction('commerce/facets/core/clearAll');
 export const deleteAllCoreFacets = createAction('commerce/facets/core/deleteAll');
+/**
+ * Action to deselect all values for a given facet.
+ *
+ * This is primarily used in facets to clear all selected values at the same time.
+ *
+ * @param payload - The payload of type {@link DeselectAllValuesInCoreFacetPayload} containing the facet ID to clear.
+ */
 export const deselectAllValuesInCoreFacet = createAction('commerce/facets/core/deselectAllValues', (payload) => validatePayload(payload, {
     facetId: requiredNonEmptyString,
 }));

package/dist/esm/features/commerce/facets/facet-set/facet-set-slice.js

@@ -74,6 +74,7 @@ export const commerceFacetSetReducer = createReducer(getCommerceFacetSetInitialS
             return;
         }
         updateExistingFacetValueState(existingValue, 'select');
+        facetRequest.numberOfValues = facetRequest.initialNumberOfValues;
         if (facetRequest.interval === 'continuous' &&
             existingValue.state === 'idle') {
             facetRequest.values = [];
@@ -143,6 +144,7 @@ export const commerceFacetSetReducer = createReducer(getCommerceFacetSetInitialS
             return;
         }
         updateExistingFacetValueState(existingValue, 'exclude');
+        facetRequest.numberOfValues = facetRequest.initialNumberOfValues;
         if (facetRequest.interval === 'continuous' &&
             existingValue.state === 'idle') {
             facetRequest.values = [];
@@ -162,6 +164,7 @@ export const commerceFacetSetReducer = createReducer(getCommerceFacetSetInitialS
             return;
         }
         updateExistingFacetValueState(existingValue, 'exclude');
+        facetRequest.numberOfValues = facetRequest.initialNumberOfValues;
     })
         .addCase(updateCategoryFacetNumberOfValues, (state, action) => {
         const { facetId, numberOfValues } = action.payload;
@@ -315,16 +318,25 @@ function handleFieldSuggestionsFulfilled(state, facetId) {
     }
 }
 function handleDeselectAllFacetValues(request) {
-    if (request.type === 'hierarchical') {
-        request.initialNumberOfValues = undefined;
-        request.numberOfValues = undefined;
-        request.values = [];
-        request.preventAutoSelect = true;
-    }
-    else {
+    const resetValues = () => {
         request.values.forEach((value) => {
             value.state = 'idle';
         });
+    };
+    switch (request.type) {
+        case 'hierarchical':
+            request.initialNumberOfValues = undefined;
+            request.numberOfValues = undefined;
+            request.values = [];
+            request.preventAutoSelect = true;
+            break;
+        case 'numericalRange':
+            request.numberOfValues = request.initialNumberOfValues;
+            resetValues();
+            break;
+        default:
+            resetValues();
+            break;
     }
 }
 /**

package/dist/esm/features/commerce/facets/numeric-facet/numeric-facet-actions.js

@@ -2,6 +2,13 @@ import { ArrayValue, BooleanValue, NumberValue, RecordValue, StringValue, } from
 import { createAction } from '@reduxjs/toolkit';
 import { requiredNonEmptyString, serializeSchemaValidationError, validatePayload, validatePayloadAndThrow, } from '../../../../utils/validate-payload.js';
 import { validateManualNumericRanges } from '../../../facets/range-facets/numeric-facet-set/numeric-facet-actions.js';
+/**
+ * Action to toggle a facet value of a NumericFacet.
+ *
+ * This is primarily used in facets and in breadcrumbs to select or deselect a facet value.
+ *
+ * @param payload - The payload of type {@link ToggleSelectNumericFacetValuePayload} containing the facet ID and the selection to toggle.
+ */
 export const toggleSelectNumericFacetValue = createAction('commerce/facets/numericFacet/toggleSelectValue', (payload) => validatePayload(payload, {
     facetId: requiredNonEmptyString,
     selection: new RecordValue({

package/dist/esm/utils/version.js

@@ -1,2 +1,2 @@
-export const VERSION = "3.28.0" || 'Test version';
+export const VERSION = "3.28.1-pre.060ac226ea" || 'Test version';
 export const COVEO_FRAMEWORK = ['@coveo/atomic', '@coveo/quantic'];