import { IZFilterMetadata, IZFilterSubject } from './filter-subject.mjs';
/**
 * The operators for the {@link IZFilterCollection} filter.
 */
export declare enum ZOperatorCollection {
    /**
     * In
     */
    In = "in",
    /**
     * Not in.
     */
    NotIn = "not-in"
}
/**
 * A filter that operates on a collection of values.
 */
export interface IZFilterCollection extends IZFilterSubject<ZOperatorCollection> {
    /**
     * The values to compare the field against.
     */
    values: any[];
}
/**
 * Represents a builder for a collection filter.
 */
export declare class ZFilterCollectionBuilder {
    /**
     * The __type__ identifier for an {@link IZFilterCollection} object.
     */
    static readonly Type = "collection";
    private _filter;
    /**
     * Initializes a new instance of this object.
     */
    constructor();
    /**
     * Sets the field.
     *
     * @param val -
     *        The value to set.
     *
     * @returns
     *        This object.
     */
    subject(val: string): this;
    /**
     * Sets all of the values.
     *
     * @param values -
     *        The collection of values.
     *
     * @returns
     *        This object.
     */
    values(values: any[]): this;
    /**
     * Adds a value to the existing collection of values.
     *
     * @param value -
     *        The value to add.
     *
     * @returns
     *        This object.
     */
    value(value: any): this;
    /**
     * Sets the operator.
     *
     * @param val -
     *        The value to set.
     *
     * @returns
     *        This object.
     */
    operator(val: ZOperatorCollection): this;
    /**
     * Constructs an in filter.
     *
     * @returns
     *        This object.
     */
    in: () => this;
    /**
     * Constructs a not in filter.
     *
     * @returns
     *        This object.
     */
    notIn: () => this;
    /**
     * Returns a copy of the constructed filter.
     *
     * @returns
     *        A copy of the currently built filter.
     */
    build(): IZFilterCollection;
}
/**
 * Type guard for determining if a target filter is a collection filter.
 *
 * @param filter -
 *        The filter to test.
 *
 * @returns
 *        True if filters type is a collection filter.  False otherwise.
 */
export declare function isCollectionFilter(filter: IZFilterMetadata | null | undefined): filter is IZFilterCollection;
/**
 * A mapping of comparators that determine if data exists or does not exist within a data set.
 */
export declare const ZCollectionComparators: Record<ZOperatorCollection, (data: any, values: any[]) => boolean>;
/**
 * A list of all collection operators.
 */
export declare const ZOperatorsCollection: ZOperatorCollection[];
/**
 * Gets whether a candidate string represents a collection operator.
 *
 * @returns
 *        Type guard true if candidate is a collection operator, false
 *        otherwise.
 */
export declare function isCollectionOperator(candidate: string | null | undefined): candidate is ZOperatorCollection;