feat(headless): add categoryFacet/updateBasePath action (#3077)

https://coveord.atlassian.net/browse/KIT-2644

packages/headless/src/features/facets/category-facet-set/category-facet-set-actions-loader.ts

@@ -8,20 +8,23 @@ import {
 import {
   deselectAllCategoryFacetValues,
   registerCategoryFacet,
-  RegisterCategoryFacetActionCreatorPayload,
   toggleSelectCategoryFacetValue,
-  ToggleSelectCategoryFacetValueActionCreatorPayload,
   updateCategoryFacetNumberOfValues,
-  UpdateCategoryFacetNumberOfValuesActionCreatorPayload,
   updateCategoryFacetSortCriterion,
+  updateCategoryFacetBasePath,
+  RegisterCategoryFacetActionCreatorPayload,
+  ToggleSelectCategoryFacetValueActionCreatorPayload,
+  UpdateCategoryFacetNumberOfValuesActionCreatorPayload,
   UpdateCategoryFacetSortCriterionActionCreatorPayload,
+  UpdateCategoryFacetBasePathActionCreatorPayload,
 } from './category-facet-set-actions';
 
 export type {
   RegisterCategoryFacetActionCreatorPayload,
   ToggleSelectCategoryFacetValueActionCreatorPayload,
   UpdateCategoryFacetNumberOfValuesActionCreatorPayload,
   UpdateCategoryFacetSortCriterionActionCreatorPayload,
+  UpdateCategoryFacetBasePathActionCreatorPayload,
   UpdateFacetAutoSelectionActionCreatorPayload,
 };
 
@@ -68,7 +71,7 @@ export interface CategoryFacetSetActionCreators {
   ): PayloadAction<UpdateCategoryFacetNumberOfValuesActionCreatorPayload>;
 
   /**
-   * Updates the the sort criterion for the category facet.
+   * Updates the sort criterion for the category facet.
    *
    * @param payload - The action creator payload.
    * @returns A dispatchable action.
@@ -85,6 +88,16 @@ export interface CategoryFacetSetActionCreators {
   updateFacetAutoSelection(
     payload: UpdateFacetAutoSelectionActionCreatorPayload
   ): PayloadAction<UpdateFacetAutoSelectionActionCreatorPayload>;
+
+  /**
+   * Updates the base path for the category facet.
+   *
+   * @param payload - The action creator payload.
+   * @returns A dispatchable action.
+   */
+  updateCategoryFacetBasePath(
+    payload: UpdateCategoryFacetBasePathActionCreatorPayload
+  ): PayloadAction<UpdateCategoryFacetBasePathActionCreatorPayload>;
 }
 
 /**
@@ -105,5 +118,6 @@ export function loadCategoryFacetSetActions(
     updateCategoryFacetNumberOfValues,
     updateCategoryFacetSortCriterion,
     updateFacetAutoSelection,
+    updateCategoryFacetBasePath,
   };
 }

packages/headless/src/features/facets/category-facet-set/category-facet-set-actions.ts

@@ -84,7 +84,7 @@ export interface RegisterCategoryFacetActionCreatorPayload {
   sortCriteria?: CategoryFacetSortCriterion;
 }
 
-const registerCategoryFacetPayloadDefinition = {
+const categoryFacetPayloadDefinition = {
   facetId: facetIdDefinition,
   field: requiredNonEmptyString,
   delimitingCharacter: new StringValue({required: false, emptyAllowed: true}),
@@ -99,7 +99,7 @@ const registerCategoryFacetPayloadDefinition = {
 export const registerCategoryFacet = createAction(
   'categoryFacet/register',
   (payload: RegisterCategoryFacetActionCreatorPayload) =>
-    validatePayload(payload, registerCategoryFacetPayloadDefinition)
+    validatePayload(payload, categoryFacetPayloadDefinition)
 );
 
 export interface ToggleSelectCategoryFacetValueActionCreatorPayload {
@@ -134,7 +134,8 @@ export const toggleSelectCategoryFacetValue = createAction(
 
 export const deselectAllCategoryFacetValues = createAction(
   'categoryFacet/deselectAll',
-  (payload: string) => validatePayload(payload, facetIdDefinition)
+  (payload: string) =>
+    validatePayload(payload, categoryFacetPayloadDefinition.facetId)
 );
 
 export interface UpdateCategoryFacetNumberOfValuesActionCreatorPayload {
@@ -153,8 +154,8 @@ export const updateCategoryFacetNumberOfValues = createAction(
   'categoryFacet/updateNumberOfValues',
   (payload: UpdateCategoryFacetNumberOfValuesActionCreatorPayload) =>
     validatePayload(payload, {
-      facetId: facetIdDefinition,
-      numberOfValues: new NumberValue({required: true, min: 1}),
+      facetId: categoryFacetPayloadDefinition.facetId,
+      numberOfValues: categoryFacetPayloadDefinition.numberOfValues,
     })
 );
 
@@ -174,7 +175,28 @@ export const updateCategoryFacetSortCriterion = createAction(
   'categoryFacet/updateSortCriterion',
   (payload: UpdateCategoryFacetSortCriterionActionCreatorPayload) =>
     validatePayload(payload, {
-      facetId: facetIdDefinition,
+      facetId: categoryFacetPayloadDefinition.facetId,
       criterion: new Value<CategoryFacetSortCriterion>(),
     })
 );
+
+export interface UpdateCategoryFacetBasePathActionCreatorPayload {
+  /**
+   * The unique identifier of the facet (e.g., `"1"`).
+   */
+  facetId: string;
+
+  /**
+   * The base path shared by all values for the facet.
+   */
+  basePath: string[];
+}
+
+export const updateCategoryFacetBasePath = createAction(
+  'categoryFacet/updateBasePath',
+  (payload: UpdateCategoryFacetBasePathActionCreatorPayload) =>
+    validatePayload(payload, {
+      facetId: categoryFacetPayloadDefinition.facetId,
+      basePath: new ArrayValue({each: requiredNonEmptyString}),
+    })
+);