import type { PayloadAction } from '@reduxjs/toolkit'; import type { SearchEngine } from '../../../app/search-engine/search-engine.js'; import { type UpdateFacetAutoSelectionActionCreatorPayload } from '../generic/facet-actions.js'; import { type RegisterCategoryFacetActionCreatorPayload, type ToggleSelectCategoryFacetValueActionCreatorPayload, type UpdateCategoryFacetBasePathActionCreatorPayload, type UpdateCategoryFacetNumberOfValuesActionCreatorPayload, type UpdateCategoryFacetSortCriterionActionCreatorPayload } from './category-facet-set-actions.js'; export type { RegisterCategoryFacetActionCreatorPayload, ToggleSelectCategoryFacetValueActionCreatorPayload, UpdateCategoryFacetBasePathActionCreatorPayload, UpdateCategoryFacetNumberOfValuesActionCreatorPayload, UpdateCategoryFacetSortCriterionActionCreatorPayload, UpdateFacetAutoSelectionActionCreatorPayload, }; /** * The category facet set action creators. * * @group Actions * @category CategoryFacetSet */ export interface CategoryFacetSetActionCreators { /** * Deselects all values of a category facet. * * @param facetId - The unique identifier of the facet (for example, "1"). * @returns A dispatchable action. */ deselectAllCategoryFacetValues(facetId: string): PayloadAction; /** * Registers a category facet in the category facet set. * * @param payload - The action creator payload. * @returns A dispatchable action. */ registerCategoryFacet(payload: RegisterCategoryFacetActionCreatorPayload): PayloadAction; /** * Toggles a category facet value. * * @param payload - The action creator payload. * @returns A dispatchable action. */ toggleSelectCategoryFacetValue(payload: ToggleSelectCategoryFacetValueActionCreatorPayload): PayloadAction; /** * Updates the number of values of a category facet. * * @param payload - The action creator payload. * @returns A dispatchable action. */ updateCategoryFacetNumberOfValues(payload: UpdateCategoryFacetNumberOfValuesActionCreatorPayload): PayloadAction; /** * Updates the sort criterion for the category facet. * * @param payload - The action creator payload. * @returns A dispatchable action. */ updateCategoryFacetSortCriterion(payload: UpdateCategoryFacetSortCriterionActionCreatorPayload): PayloadAction; /** * Updates the preventAutoSelect flag of all facets. * @param payload - The action creator payload. * @returns A dispatchable action. */ updateFacetAutoSelection(payload: UpdateFacetAutoSelectionActionCreatorPayload): PayloadAction; /** * Updates the base path for the category facet. * * @param payload - The action creator payload. * @returns A dispatchable action. */ updateCategoryFacetBasePath(payload: UpdateCategoryFacetBasePathActionCreatorPayload): PayloadAction; } /** * Loads the `categoryFacetSet` reducer and returns possible action creators. * * @param engine - The headless engine. * @returns An object holding the action creators. * * @group Actions * @category CategoryFacetSet */ export declare function loadCategoryFacetSetActions(engine: SearchEngine): CategoryFacetSetActionCreators;