import { AdaptablePredicateDefPartialWithExtends } from '../AdaptableState/Common/AdaptablePredicate';
import { AdaptablePredicateDef, ColumnScope, BaseContext, PredicateModuleScope, SystemAlertPredicateId, SystemAlertPredicateIds, SystemBadgeStylePredicateId, SystemBadgeStylePredicateIds, SystemFilterPredicateId, SystemFilterPredicateIds, SystemFlashingCellPredicateId, SystemFlashingCellPredicateIds, SystemFormatColumnPredicateId, SystemFormatColumnPredicateIds, AdaptableColumnContext } from '../types';
/**
 * Options for managing Adaptable Predicates using AdaptableQL
 */
export interface PredicateOptions {
    /**
     * Definitions for Custom provided Predicates
     *
     * @defaultValue []
     */
    customPredicateDefs?: (AdaptablePredicateDef | AdaptablePredicateDefPartialWithExtends)[];
    /**
     * Which System Predicates are available when Filtering
     *
     * @defaultValue all `SystemFilterPredicateIds`
     */
    systemFilterPredicates?: SystemFilterPredicateIds | ((context: SystemPredicatesContext<SystemFilterPredicateId>) => SystemFilterPredicateIds);
    /**
     * Which System Predicates are available for Badge Styles
     *
     * @defaultValue all `SystemBadgeStylePredicateIds`
     */
    systemBadgeStylePredicates?: SystemBadgeStylePredicateIds | ((context: SystemPredicatesContext<SystemBadgeStylePredicateId>) => SystemBadgeStylePredicateIds);
    /**
     * Which System Predicates are available in Alert Module
     *
     * @defaultValue all `SystemAlertPredicateIds`
     */
    systemAlertPredicates?: SystemAlertPredicateIds | ((context: SystemPredicatesContext<SystemAlertPredicateId>) => SystemAlertPredicateIds);
    /**
     * Which System Predicates are available in Format Column Module
     *
     * @defaultValue all `SystemFormatColumnPredicateIds`
     */
    systemFormatColumnPredicates?: SystemFormatColumnPredicateIds | ((context: SystemPredicatesContext<SystemFormatColumnPredicateId>) => SystemFormatColumnPredicateIds);
    /**
     * Which System Predicates are available in Flashing Cell Module
     *
     * @defaultValue all `SystemFlashingCellPredicateIds`
     */
    systemFlashingCellPredicates?: SystemFlashingCellPredicateIds | ((context: SystemPredicatesContext<SystemFlashingCellPredicateId>) => SystemFlashingCellPredicateIds);
    /**
     * Perform case-sensitive text comparisons when evaluating Predicates
     *
     * @defaultValue false
     * @noCodeItem
     */
    caseSensitivePredicates?: boolean | ((context: AdaptableColumnContext) => boolean);
    /**
     *
     * Should In Predicate evaluate using datetime, rather than date (the default)
     * @defaultValue  false
     * @noCodeItem
     */
    evaluateInPredicateUsingTime?: boolean | ((context: AdaptableColumnContext) => boolean);
}
/**
 * Context used for setting which System Predicates are available
 */
export interface SystemPredicatesContext<PREDICATE_TYPE = string> extends BaseContext {
    /**
     * AdapTable-provided System Predicate Definitions
     */
    systemPredicateDefs: AdaptablePredicateDef<PREDICATE_TYPE>[];
    /**
     * Module for which Predicates are being retrieved
     */
    moduleScope: PredicateModuleScope;
    /**
     * Current Scope where Predicates are being used
     */
    columnScope: ColumnScope;
}
