import type { PayloadAction } from '@reduxjs/toolkit'; import type { SearchEngine } from '../../app/search-engine/search-engine.js'; import { type DisableFacetActionCreatorPayload, type EnableFacetActionCreatorPayload, type UpdateFacetOptionsActionCreatorPayload } from './facet-options-actions.js'; export type { DisableFacetActionCreatorPayload, EnableFacetActionCreatorPayload, UpdateFacetOptionsActionCreatorPayload, }; /** * The facetOptions action creators. * * @group Actions * @category FacetOptions */ export interface FacetOptionsActionCreators { /** * Updates options that affect facet reordering. For more information, refer to [the documentation on query parameters](https://docs.coveo.com/en/13#operation/searchUsingPost-facets). * * @param payload - The action creator payload. * @returns A dispatchable action. */ updateFacetOptions(payload: UpdateFacetOptionsActionCreatorPayload): PayloadAction; /** * Enables a facet. I.e., undoes the effects of `disable`. * * @param facetId - The unique identifier of the facet (for example, "abcd"). * @returns A dispatchable action. */ enableFacet(facetId: string): PayloadAction; /** * Disables a facet. I.e., prevents it from filtering results. * * @param facetId - The unique identifier of the facet (for example, "1"). * @returns A dispatchable action. */ disableFacet(facetId: string): PayloadAction; } /** * Loads the `facetOptions` reducer and returns possible action creators. * * @param engine - The headless engine. * @returns An object holding the action creators. * * @group Actions * @category FacetOptions */ export declare function loadFacetOptionsActions(engine: SearchEngine): FacetOptionsActionCreators;