import { type ObjRef } from "../objRef/index.js";
/**
 * Kpi
 * @public
 */
export type IKpi = IKpiWithComparison | IKpiWithoutComparison;
/**
 * Type-guard testing whether the provided object is an instance of {@link IKpi}.
 * @alpha
 */
export declare function isKpi(obj: unknown): obj is IKpi;
/**
 * Common kpi properties
 * @public
 */
export interface IKpiBase {
    comparisonType: IKpiComparisonTypeComparison;
    comparisonDirection?: IKpiComparisonDirection;
    metric: ObjRef;
}
/**
 * Kpi with comparison
 * @public
 */
export type IKpiWithComparison = IKpiWithPreviousPeriodComparison | IKpiWithPopComparison;
/**
 * Kpi with previous period comparison
 * @public
 */
export interface IKpiWithPreviousPeriodComparison extends IKpiBase {
    comparisonType: "previousPeriod";
    comparisonDirection: IKpiComparisonDirection;
}
/**
 * Kpi with period over period comparison
 * @public
 */
export interface IKpiWithPopComparison extends IKpiBase {
    comparisonType: "lastYear";
    comparisonDirection: IKpiComparisonDirection;
}
/**
 * Type-guard testing whether the provided object is an instance of {@link IKpiWithComparison}.
 * @alpha
 */
export declare function isKpiWithComparison(obj: unknown): obj is IKpiWithComparison;
/**
 * Kpi without comparison
 * @public
 */
export interface IKpiWithoutComparison extends IKpiBase {
    comparisonType: "none";
}
/**
 * Type-guard testing whether the provided object is an instance of {@link IKpiWithoutComparison}.
 * @alpha
 */
export declare function isKpiWithoutComparison(obj: unknown): obj is IKpiWithoutComparison;
/**
 * Kpi comparison type
 * @public
 */
export type IKpiComparisonTypeComparison = IKpiWithPreviousPeriodComparison["comparisonType"] | IKpiWithPopComparison["comparisonType"] | IKpiWithoutComparison["comparisonType"];
/**
 * Kpi comparison direction
 * @public
 */
export type IKpiComparisonDirection = "growIsGood" | "growIsBad";
//# sourceMappingURL=kpi.d.ts.map