import type { CoreEngine } from '../../app/engine.js';
import type { DictionaryFieldContextPayload } from '../../features/dictionary-field-context/dictionary-field-context-state.js';
import { type Controller } from '../controller/headless-controller.js';
export type { DictionaryFieldContextPayload };
/**
 * The `DictionaryFieldContext` controller allows specifying which [dictionary field](https://docs.coveo.com/en/2036/) keys to retrieve.
 *
 * Example: [dictionary-field-context.fn.ts](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/dictionary-field-context/dictionary-field-context.fn.ts)
 *
 * @group Controllers
 * @category DictionaryFieldContext
 */
export interface DictionaryFieldContext extends Controller {
    /**
     * Sets the dictionary field context for the query. This replaces any existing context with the new one.
     *
     *  @param context - The dictionary field context to set for the query.
     */
    set(context: DictionaryFieldContextPayload): void;
    /**
     * Adds (or, if one is already present, replaces) a new dictionary field context key-value pair.
     *
     * @param field - The dictionary field name.
     * @param key - The dictionary field key for which to retrieve a value.
     */
    add(field: string, key: string): void;
    /**
     * Removes a dictionary field from the query.
     * @param field - The field to remove.
     */
    remove(field: string): void;
    /**
     * The state of the `DictionaryFieldContext` controller.
     */
    state: DictionaryFieldContextState;
}
/**
 * A scoped and simplified part of the headless state that is relevant to the `DictionaryFieldContext` controller.
 *
 * @group Controllers
 * @category DictionaryFieldContext
 */
export interface DictionaryFieldContextState {
    /**
     * An object holding the dictionary field context fields and keys to retrieve values for.
     */
    values: Record<string, string>;
}
/**
 * Creates a `DictionaryFieldContext` controller instance.
 *
 * @param engine - The headless engine.
 * @returns A `DictionaryFieldContext` controller instance.
 *
 * @group Controllers
 * @category DictionaryFieldContext
 */
export declare function buildDictionaryFieldContext(engine: CoreEngine): DictionaryFieldContext;