import { type FilterKeyword } from "../v1/filter-keyword.js";
import { type FilterStatus } from "../v1/filter-status.js";
export interface FilterContextRegistry {
    home: never;
    notifications: never;
    public: never;
    thread: never;
    account: never;
}
export type FilterContext = keyof FilterContextRegistry;
export interface FilterActionRegistry {
    warn: never;
    hide: never;
    blur: never;
}
export type FilterAction = keyof FilterActionRegistry;
/**
 * Represents a user-defined filter for determining which statuses should not be shown to the user.
 * @see https://docs.joinmastodon.org/entities/filter/
 */
export interface Filter {
    /** The ID of the filter in the database. */
    id: string;
    /** A title given by the user to name the filter. */
    title: string;
    /** The contexts in which the filter should be applied. */
    context: FilterContext[];
    /** When the filter should no longer be applied */
    expiresAt?: string | null;
    /**
     * The action to be taken when a status matches this filter.
     *
     * `warn` = show a warning that identifies the matching filter by title, and allow the user to expand the filtered status. This is the default (and unknown values should be treated as equivalent to warn).
     *
     * `hide` = do not show this status if it is received
     *
     * `blur` = hide/blur media attachments with a warning identifying the matching filter by `title`
     */
    filterAction: FilterAction;
    /** The keywords grouped under this filter. */
    keywords: FilterKeyword[];
    /** The statuses grouped under this filter. */
    statuses: FilterStatus[];
}