import { type EmptyValues, type ILowerBoundedFilter, type IUpperBoundedFilter } from "../execution/filter/index.js";
import { type Identifier, type ObjRef } from "../objRef/index.js";
/**
 * Date string - ISO-8601 calendar date string, eg.: '2018-12-30'
 * @beta
 */
export type DateString = string;
/**
 * Type that identifies the the all time date filter
 * @alpha
 */
export type DateFilterOptionAllTimeType = "allTime";
/**
 * Type that identifies the absolute date filter form
 * @alpha
 */
export type DateFilterOptionAbsoluteFormType = "absoluteForm";
/**
 * Type that identifies the relative date filter form
 * @alpha
 */
export type DateFilterOptionRelativeFormType = "relativeForm";
/**
 * Type that identifies the absolute date filter preset
 * @alpha
 */
export type DateFilterOptionAbsolutePresetType = "absolutePreset";
/**
 * Type that identifies the relative date filter preset
 * @alpha
 */
export type DateFilterOptionRelativePresetType = "relativePreset";
/**
 * Type that identifies the empty date values date filter option
 * @alpha
 */
export type DateFilterOptionEmptyValuesType = "emptyValues";
/**
 * Type that identifies the date filter option
 * @alpha
 */
export type DateFilterOptionType = DateFilterOptionAllTimeType | DateFilterOptionAbsoluteFormType | DateFilterOptionRelativeFormType | DateFilterOptionAbsolutePresetType | DateFilterOptionRelativePresetType | DateFilterOptionEmptyValuesType;
/**
 * Relative granularity offset
 * (e.g. "GDC.time.year" granularity with offset -2 means "the previous 2 years")
 * @alpha
 */
export type RelativeDateFilterGranularityOffset = number;
/**
 * Supported date filter granularity for the relative date filter
 * @beta
 */
export type DateFilterGranularity = "GDC.time.minute" | "GDC.time.hour" | "GDC.time.date" | "GDC.time.week_us" | "GDC.time.month" | "GDC.time.fiscal_month" | "GDC.time.quarter" | "GDC.time.fiscal_quarter" | "GDC.time.year" | "GDC.time.fiscal_year";
/**
 * Type-guard testing whether the provided object is an instance of {@link DateFilterGranularity}.
 * @alpha
 */
export declare const isDateFilterGranularity: (obj: unknown) => obj is DateFilterGranularity;
/**
 * Common props for date filter options
 * @alpha
 */
export interface IDateFilterOption {
    /**
     * Local identifier of the option
     */
    localIdentifier: Identifier;
    /**
     * Customized name of the option to display in the dropdown
     */
    name?: string;
    /**
     * Option type
     */
    type: DateFilterOptionType;
    /**
     * Sets whether this option will be visible in the dropdown
     */
    visible: boolean;
}
/**
 * Custom absolute date filter preset
 * @alpha
 */
export interface IAbsoluteDateFilterPreset extends IDateFilterOption {
    /**
     * Type to identify an absolute date filter preset
     */
    type: DateFilterOptionAbsolutePresetType;
    /**
     * Absolute date filter start date
     */
    from: DateString;
    /**
     * Absolute date filter end date
     */
    to: DateString;
    /**
     * Optional configuration for how this preset should treat empty date values.
     */
    emptyValueHandling?: EmptyValues;
}
/**
 * Custom relative date filter preset
 * @alpha
 */
export interface IRelativeDateFilterPreset extends IDateFilterOption {
    /**
     * Type to identify a relative date filter preset
     */
    type: DateFilterOptionRelativePresetType;
    /**
     * Relative date filter granularity (day/week/year,etc.)
     */
    granularity: DateFilterGranularity;
    /**
     * Relative date filter granularity start offset
     */
    from: RelativeDateFilterGranularityOffset;
    /**
     * Relative date filter granularity end offset
     */
    to: RelativeDateFilterGranularityOffset;
    /**
     * Additional bound for the relative date filter
     */
    boundedFilter?: IUpperBoundedFilter | ILowerBoundedFilter;
    /**
     * Optional configuration for how this preset should treat empty date values.
     */
    emptyValueHandling?: EmptyValues;
}
/**
 * Generic type to express relative date filter preset of a particular granularity
 * @alpha
 */
export interface IRelativeDateFilterPresetOfGranularity<Key extends DateFilterGranularity> extends IRelativeDateFilterPreset {
    /**
     * Particular relative date filter preset granularity
     */
    granularity: Key;
}
/**
 * Customized options for the global absolute date filter
 * @alpha
 */
export interface IAbsoluteDateFilterForm extends IDateFilterOption {
    /**
     * Type to identify the global absolute date filter
     */
    type: DateFilterOptionAbsoluteFormType;
    /**
     * Optional configuration for how this option should treat empty date values.
     */
    emptyValueHandling?: EmptyValues;
}
/**
 * Customized options for the global relative date filter
 * @alpha
 */
export interface IRelativeDateFilterForm extends IDateFilterOption {
    /**
     * Type to identify the global relative date filter
     */
    type: DateFilterOptionRelativeFormType;
    /**
     * Available granularities for the global relative date filter
     */
    availableGranularities: DateFilterGranularity[];
    /**
     * Optional configuration for how this option should treat empty date values.
     */
    emptyValueHandling?: EmptyValues;
}
/**
 * Customized options for the global all time date filter
 * @alpha
 */
export interface IAllTimeDateFilterOption extends IDateFilterOption {
    /**
     * Type to identify the global all time date filter
     */
    type: DateFilterOptionAllTimeType;
    /**
     * Optional configuration for how this option should treat empty date values.
     */
    emptyValueHandling?: EmptyValues;
}
/**
 * Type-guard testing whether the provided object is an instance of {@link IAllTimeDateFilterOption}.
 * @alpha
 */
export declare const isAllTimeDateFilterOption: (obj: unknown) => obj is IAllTimeDateFilterOption;
/**
 * Preset option for empty date values (records with no date)
 * @alpha
 */
export interface IEmptyValuesDateFilterOption extends IDateFilterOption {
    /**
     * Type to identify the empty values date filter option
     */
    type: DateFilterOptionEmptyValuesType;
    /**
     * Optional configuration for how this option should treat empty date values.
     */
    emptyValueHandling?: EmptyValues;
}
/**
 * Type-guard testing whether the provided object is an instance of {@link IEmptyValuesDateFilterOption}.
 * @alpha
 */
export declare const isEmptyValuesDateFilterOption: (obj: unknown) => obj is IEmptyValuesDateFilterOption;
/**
 * Type-guard testing whether the provided object is an instance of {@link IAbsoluteDateFilterForm}.
 * @alpha
 */
export declare const isAbsoluteDateFilterForm: (obj: unknown) => obj is IAbsoluteDateFilterForm;
/**
 * Type-guard testing whether the provided object is an instance of {@link IAbsoluteDateFilterPreset}.
 * @alpha
 */
export declare const isAbsoluteDateFilterPreset: (obj: unknown) => obj is IAbsoluteDateFilterPreset;
/**
 * Type-guard testing whether the provided object is an instance of {@link IRelativeDateFilterForm}.
 * @alpha
 */
export declare const isRelativeDateFilterForm: (obj: unknown) => obj is IRelativeDateFilterForm;
/**
 * Type-guard testing whether the provided object is an instance of {@link IRelativeDateFilterPreset}.
 * @alpha
 */
export declare const isRelativeDateFilterPreset: (obj: unknown) => obj is IRelativeDateFilterPreset;
/**
 * Date filter configs allow to define your own date filter options, that appear in the date filter.
 *
 * @alpha
 */
export interface IDateFilterConfig {
    /**
     * Extended date filter config reference
     */
    ref: ObjRef;
    /**
     * Local identifier of the default selected date filter preset
     */
    selectedOption: Identifier;
    /**
     * Options to customize displaying of the global all time date filter
     */
    allTime?: IAllTimeDateFilterOption;
    /**
     * Options to customize displaying of the empty values date filter preset
     */
    emptyValues?: IEmptyValuesDateFilterOption;
    /**
     * Options to customize displaying of the global absolute date filter
     */
    absoluteForm?: IAbsoluteDateFilterForm;
    /**
     * Options to customize displaying of the global relative date filter
     */
    relativeForm?: IRelativeDateFilterForm;
    /**
     * Custom absolute date filter presets (options to display in the extended date filter dropdown)
     */
    absolutePresets?: IAbsoluteDateFilterPreset[];
    /**
     * Custom relative date filter presets (options to display in the extended date filter dropdown)
     */
    relativePresets?: IRelativeDateFilterPreset[];
}
//# sourceMappingURL=index.d.ts.map