@dhis2/expression-parser 1.1.0-beta.6 → 1.1.0-beta.8

package/expression-parser.d.ts

@@ -1,111 +1,480 @@
 type Nullable<T> = T | null | undefined
-export declare class DataItemJs {
-    constructor(type: string, uid0: IDJs, uid1: Array<IDJs>, uid2: Array<IDJs>, modifiers: QueryModifiersJs);
-    get type(): string;
-    get uid0(): IDJs;
-    get uid1(): Array<IDJs>;
-    get uid2(): Array<IDJs>;
-    get modifiers(): QueryModifiersJs;
-    copy(type?: string, uid0?: IDJs, uid1?: Array<IDJs>, uid2?: Array<IDJs>, modifiers?: QueryModifiersJs): DataItemJs;
+export declare abstract class ExpressionMode {
+    private constructor();
+    static get VALIDATION_RULE_EXPRESSION(): ExpressionMode & {
+        get name(): "VALIDATION_RULE_EXPRESSION";
+        get ordinal(): 0;
+    };
+    static get VALIDATION_RULE_RESULT_TEST(): ExpressionMode & {
+        get name(): "VALIDATION_RULE_RESULT_TEST";
+        get ordinal(): 1;
+    };
+    static get PREDICTOR_GENERATOR_EXPRESSION(): ExpressionMode & {
+        get name(): "PREDICTOR_GENERATOR_EXPRESSION";
+        get ordinal(): 2;
+    };
+    static get PREDICTOR_SKIP_TEST(): ExpressionMode & {
+        get name(): "PREDICTOR_SKIP_TEST";
+        get ordinal(): 3;
+    };
+    static get INDICATOR_EXPRESSION(): ExpressionMode & {
+        get name(): "INDICATOR_EXPRESSION";
+        get ordinal(): 4;
+    };
+    static get PROGRAM_INDICATOR_EXPRESSION(): ExpressionMode & {
+        get name(): "PROGRAM_INDICATOR_EXPRESSION";
+        get ordinal(): 5;
+    };
+    static get RULE_ENGINE_CONDITION(): ExpressionMode & {
+        get name(): "RULE_ENGINE_CONDITION";
+        get ordinal(): 6;
+    };
+    static get RULE_ENGINE_ACTION(): ExpressionMode & {
+        get name(): "RULE_ENGINE_ACTION";
+        get ordinal(): 7;
+    };
+    static values(): Array<ExpressionMode>;
+    static valueOf(value: string): ExpressionMode;
+    get name(): "VALIDATION_RULE_EXPRESSION" | "VALIDATION_RULE_RESULT_TEST" | "PREDICTOR_GENERATOR_EXPRESSION" | "PREDICTOR_SKIP_TEST" | "INDICATOR_EXPRESSION" | "PROGRAM_INDICATOR_EXPRESSION" | "RULE_ENGINE_CONDITION" | "RULE_ENGINE_ACTION";
+    get ordinal(): 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
+}
+export declare abstract class AggregationType {
+    private constructor();
+    static get sum(): AggregationType & {
+        get name(): "sum";
+        get ordinal(): 0;
+    };
+    static get avg(): AggregationType & {
+        get name(): "avg";
+        get ordinal(): 1;
+    };
+    static get avg_sum_org_unit(): AggregationType & {
+        get name(): "avg_sum_org_unit";
+        get ordinal(): 2;
+    };
+    static get last(): AggregationType & {
+        get name(): "last";
+        get ordinal(): 3;
+    };
+    static get last_avg_org_unit(): AggregationType & {
+        get name(): "last_avg_org_unit";
+        get ordinal(): 4;
+    };
+    static get last_analytics_period(): AggregationType & {
+        get name(): "last_analytics_period";
+        get ordinal(): 5;
+    };
+    static get last_analytics_period_avg_org_unit(): AggregationType & {
+        get name(): "last_analytics_period_avg_org_unit";
+        get ordinal(): 6;
+    };
+    static get first(): AggregationType & {
+        get name(): "first";
+        get ordinal(): 7;
+    };
+    static get first_avg_org_unit(): AggregationType & {
+        get name(): "first_avg_org_unit";
+        get ordinal(): 8;
+    };
+    static get count(): AggregationType & {
+        get name(): "count";
+        get ordinal(): 9;
+    };
+    static get stddev(): AggregationType & {
+        get name(): "stddev";
+        get ordinal(): 10;
+    };
+    static get variance(): AggregationType & {
+        get name(): "variance";
+        get ordinal(): 11;
+    };
+    static get min(): AggregationType & {
+        get name(): "min";
+        get ordinal(): 12;
+    };
+    static get max(): AggregationType & {
+        get name(): "max";
+        get ordinal(): 13;
+    };
+    static get none(): AggregationType & {
+        get name(): "none";
+        get ordinal(): 14;
+    };
+    static get custom(): AggregationType & {
+        get name(): "custom";
+        get ordinal(): 15;
+    };
+    static values(): Array<AggregationType>;
+    static valueOf(value: string): AggregationType;
+    get name(): "sum" | "avg" | "avg_sum_org_unit" | "last" | "last_avg_org_unit" | "last_analytics_period" | "last_analytics_period_avg_org_unit" | "first" | "first_avg_org_unit" | "count" | "stddev" | "variance" | "min" | "max" | "none" | "custom";
+    get ordinal(): 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15;
+}
+export declare abstract class DataItemType {
+    private constructor();
+    static get DATA_ELEMENT(): DataItemType & {
+        get name(): "DATA_ELEMENT";
+        get ordinal(): 0;
+    };
+    static get ATTRIBUTE(): DataItemType & {
+        get name(): "ATTRIBUTE";
+        get ordinal(): 1;
+    };
+    static get CONSTANT(): DataItemType & {
+        get name(): "CONSTANT";
+        get ordinal(): 2;
+    };
+    static get PROGRAM_DATA_ELEMENT(): DataItemType & {
+        get name(): "PROGRAM_DATA_ELEMENT";
+        get ordinal(): 3;
+    };
+    static get PROGRAM_INDICATOR(): DataItemType & {
+        get name(): "PROGRAM_INDICATOR";
+        get ordinal(): 4;
+    };
+    static get INDICATOR(): DataItemType & {
+        get name(): "INDICATOR";
+        get ordinal(): 5;
+    };
+    static get ORG_UNIT_GROUP(): DataItemType & {
+        get name(): "ORG_UNIT_GROUP";
+        get ordinal(): 6;
+    };
+    static get REPORTING_RATE(): DataItemType & {
+        get name(): "REPORTING_RATE";
+        get ordinal(): 7;
+    };
+    static get PROGRAM_VARIABLE(): DataItemType & {
+        get name(): "PROGRAM_VARIABLE";
+        get ordinal(): 8;
+    };
+    getType(numberOfIds: number, index: number): IDType;
+    static values(): Array<DataItemType>;
+    static valueOf(value: string): DataItemType;
+    get name(): "DATA_ELEMENT" | "ATTRIBUTE" | "CONSTANT" | "PROGRAM_DATA_ELEMENT" | "PROGRAM_INDICATOR" | "INDICATOR" | "ORG_UNIT_GROUP" | "REPORTING_RATE" | "PROGRAM_VARIABLE";
+    get ordinal(): 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8;
+    static get Companion(): {
+        fromSymbol(symbol: string): DataItemType;
+    };
+}
+export declare class ID {
+    constructor(type: IDType, value: string);
+    get type(): IDType;
+    get value(): string;
     toString(): string;
+    copy(type?: IDType, value?: string): ID;
     hashCode(): number;
     equals(other: Nullable<any>): boolean;
+}
+export declare abstract class IDType {
+    private constructor();
+    static get AttributeUID(): IDType & {
+        get name(): "AttributeUID";
+        get ordinal(): 0;
+    };
+    static get AttributeOptionComboUID(): IDType & {
+        get name(): "AttributeOptionComboUID";
+        get ordinal(): 1;
+    };
+    static get CategoryOptionUID(): IDType & {
+        get name(): "CategoryOptionUID";
+        get ordinal(): 2;
+    };
+    static get CategoryOptionComboUID(): IDType & {
+        get name(): "CategoryOptionComboUID";
+        get ordinal(): 3;
+    };
+    static get CategoryOptionGroupUID(): IDType & {
+        get name(): "CategoryOptionGroupUID";
+        get ordinal(): 4;
+    };
+    static get DataElementUID(): IDType & {
+        get name(): "DataElementUID";
+        get ordinal(): 5;
+    };
+    static get DateElementGroupUID(): IDType & {
+        get name(): "DateElementGroupUID";
+        get ordinal(): 6;
+    };
+    static get DataSetUID(): IDType & {
+        get name(): "DataSetUID";
+        get ordinal(): 7;
+    };
+    static get ConstantUID(): IDType & {
+        get name(): "ConstantUID";
+        get ordinal(): 8;
+    };
+    static get IndicatorUID(): IDType & {
+        get name(): "IndicatorUID";
+        get ordinal(): 9;
+    };
+    static get OrganisationUnitGroupUID(): IDType & {
+        get name(): "OrganisationUnitGroupUID";
+        get ordinal(): 10;
+    };
+    static get ProgramUID(): IDType & {
+        get name(): "ProgramUID";
+        get ordinal(): 11;
+    };
+    static get ProgramIndicatorUID(): IDType & {
+        get name(): "ProgramIndicatorUID";
+        get ordinal(): 12;
+    };
+    static get ProgramVariableName(): IDType & {
+        get name(): "ProgramVariableName";
+        get ordinal(): 13;
+    };
+    static get ProgramStageUID(): IDType & {
+        get name(): "ProgramStageUID";
+        get ordinal(): 14;
+    };
+    static get ReportingRateType(): IDType & {
+        get name(): "ReportingRateType";
+        get ordinal(): 15;
+    };
+    isUID(): boolean;
+    static values(): Array<IDType>;
+    static valueOf(value: string): IDType;
+    get name(): "AttributeUID" | "AttributeOptionComboUID" | "CategoryOptionUID" | "CategoryOptionComboUID" | "CategoryOptionGroupUID" | "DataElementUID" | "DateElementGroupUID" | "DataSetUID" | "ConstantUID" | "IndicatorUID" | "OrganisationUnitGroupUID" | "ProgramUID" | "ProgramIndicatorUID" | "ProgramVariableName" | "ProgramStageUID" | "ReportingRateType";
+    get ordinal(): 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15;
+}
+export declare abstract class ProgramVariable {
+    private constructor();
+    static get analytics_period_end(): ProgramVariable & {
+        get name(): "analytics_period_end";
+        get ordinal(): 0;
+    };
+    static get analytics_period_start(): ProgramVariable & {
+        get name(): "analytics_period_start";
+        get ordinal(): 1;
+    };
+    static get completed_date(): ProgramVariable & {
+        get name(): "completed_date";
+        get ordinal(): 2;
+    };
+    static get creation_date(): ProgramVariable & {
+        get name(): "creation_date";
+        get ordinal(): 3;
+    };
+    static get current_date(): ProgramVariable & {
+        get name(): "current_date";
+        get ordinal(): 4;
+    };
+    static get due_date(): ProgramVariable & {
+        get name(): "due_date";
+        get ordinal(): 5;
+    };
+    static get enrollment_count(): ProgramVariable & {
+        get name(): "enrollment_count";
+        get ordinal(): 6;
+    };
+    static get enrollment_date(): ProgramVariable & {
+        get name(): "enrollment_date";
+        get ordinal(): 7;
+    };
+    static get enrollment_id(): ProgramVariable & {
+        get name(): "enrollment_id";
+        get ordinal(): 8;
+    };
+    static get enrollment_status(): ProgramVariable & {
+        get name(): "enrollment_status";
+        get ordinal(): 9;
+    };
+    static get environment(): ProgramVariable & {
+        get name(): "environment";
+        get ordinal(): 10;
+    };
+    static get event_count(): ProgramVariable & {
+        get name(): "event_count";
+        get ordinal(): 11;
+    };
+    static get scheduled_event_count(): ProgramVariable & {
+        get name(): "scheduled_event_count";
+        get ordinal(): 12;
+    };
+    static get event_date(): ProgramVariable & {
+        get name(): "event_date";
+        get ordinal(): 13;
+    };
+    static get scheduled_date(): ProgramVariable & {
+        get name(): "scheduled_date";
+        get ordinal(): 14;
+    };
+    static get event_id(): ProgramVariable & {
+        get name(): "event_id";
+        get ordinal(): 15;
+    };
+    static get event_status(): ProgramVariable & {
+        get name(): "event_status";
+        get ordinal(): 16;
+    };
+    static get execution_date(): ProgramVariable & {
+        get name(): "execution_date";
+        get ordinal(): 17;
+    };
+    static get incident_date(): ProgramVariable & {
+        get name(): "incident_date";
+        get ordinal(): 18;
+    };
+    static get org_unit_count(): ProgramVariable & {
+        get name(): "org_unit_count";
+        get ordinal(): 19;
+    };
+    static get org_unit(): ProgramVariable & {
+        get name(): "org_unit";
+        get ordinal(): 20;
+    };
+    static get orgunit_code(): ProgramVariable & {
+        get name(): "orgunit_code";
+        get ordinal(): 21;
+    };
+    static get program_name(): ProgramVariable & {
+        get name(): "program_name";
+        get ordinal(): 22;
+    };
+    static get program_stage_id(): ProgramVariable & {
+        get name(): "program_stage_id";
+        get ordinal(): 23;
+    };
+    static get program_stage_name(): ProgramVariable & {
+        get name(): "program_stage_name";
+        get ordinal(): 24;
+    };
+    static get sync_date(): ProgramVariable & {
+        get name(): "sync_date";
+        get ordinal(): 25;
+    };
+    static get tei_count(): ProgramVariable & {
+        get name(): "tei_count";
+        get ordinal(): 26;
+    };
+    static get value_count(): ProgramVariable & {
+        get name(): "value_count";
+        get ordinal(): 27;
+    };
+    static get zero_pos_value_count(): ProgramVariable & {
+        get name(): "zero_pos_value_count";
+        get ordinal(): 28;
+    };
+    static values(): Array<ProgramVariable>;
+    static valueOf(value: string): ProgramVariable;
+    get name(): "analytics_period_end" | "analytics_period_start" | "completed_date" | "creation_date" | "current_date" | "due_date" | "enrollment_count" | "enrollment_date" | "enrollment_id" | "enrollment_status" | "environment" | "event_count" | "scheduled_event_count" | "event_date" | "scheduled_date" | "event_id" | "event_status" | "execution_date" | "incident_date" | "org_unit_count" | "org_unit" | "orgunit_code" | "program_name" | "program_stage_id" | "program_stage_name" | "sync_date" | "tei_count" | "value_count" | "zero_pos_value_count";
+    get ordinal(): 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28;
+}
+export declare abstract class ValueType {
+    private constructor();
+    static get MIXED(): ValueType & {
+        get name(): "MIXED";
+        get ordinal(): 0;
+    };
+    static get NUMBER(): ValueType & {
+        get name(): "NUMBER";
+        get ordinal(): 1;
+    };
+    static get BOOLEAN(): ValueType & {
+        get name(): "BOOLEAN";
+        get ordinal(): 2;
+    };
+    static get DATE(): ValueType & {
+        get name(): "DATE";
+        get ordinal(): 3;
+    };
+    static get STRING(): ValueType & {
+        get name(): "STRING";
+        get ordinal(): 4;
+    };
+    static get SAME(): ValueType & {
+        get name(): "SAME";
+        get ordinal(): 5;
+    };
+    isSame(): boolean;
+    isMixed(): boolean;
+    isAssignableTo(other: ValueType): boolean;
+    isMaybeAssignableTo(other: ValueType): boolean;
+    isValidValue(value: Nullable<any>): boolean;
+    static values(): Array<ValueType>;
+    static valueOf(value: string): ValueType;
+    get name(): "MIXED" | "NUMBER" | "BOOLEAN" | "DATE" | "STRING" | "SAME";
+    get ordinal(): 0 | 1 | 2 | 3 | 4 | 5;
     static get Companion(): {
-        get TYPES(): Array<string>;
+        allSame(types: any/* List<ValueType> */): boolean;
     };
 }
-export declare class Entry<K, V> {
-    constructor(key: K, value: V);
-    get key(): K;
-    get value(): V;
-    copy(key?: K, value?: V): Entry<K, V>;
+export declare class DataItemJs {
+    constructor(type: DataItemType, uid0: ID, uid1: Array<ID>, uid2: Array<ID>, modifiers: QueryModifiersJs);
+    get type(): DataItemType;
+    get uid0(): ID;
+    get uid1(): Array<ID>;
+    get uid2(): Array<ID>;
+    get modifiers(): QueryModifiersJs;
+    copy(type?: DataItemType, uid0?: ID, uid1?: Array<ID>, uid2?: Array<ID>, modifiers?: QueryModifiersJs): DataItemJs;
     toString(): string;
     hashCode(): number;
     equals(other: Nullable<any>): boolean;
 }
 export declare class ExpressionDataJs {
-    constructor(programRuleVariableValues?: Array<Entry<string, VariableValueJs>>, programVariableValues?: Array<Entry<string, any>>, supplementaryValues?: Array<Entry<string, Array<string>>>, dataItemValues?: Array<Entry<DataItemJs, any>>, namedValues?: Array<Entry<string, any>>);
-    get programRuleVariableValues(): Array<Entry<string, VariableValueJs>>;
-    get programVariableValues(): Array<Entry<string, any>>;
-    get supplementaryValues(): Array<Entry<string, Array<string>>>;
-    get dataItemValues(): Array<Entry<DataItemJs, any>>;
-    get namedValues(): Array<Entry<string, any>>;
-    copy(programRuleVariableValues?: Array<Entry<string, VariableValueJs>>, programVariableValues?: Array<Entry<string, any>>, supplementaryValues?: Array<Entry<string, Array<string>>>, dataItemValues?: Array<Entry<DataItemJs, any>>, namedValues?: Array<Entry<string, any>>): ExpressionDataJs;
+    constructor(programRuleVariableValues?: Map<string, VariableValueJs>, programVariableValues?: Map<string, any>, supplementaryValues?: Map<string, Array<string>>, dataItemValues?: Map<DataItemJs, any>, namedValues?: Map<string, any>);
+    get programRuleVariableValues(): Map<string, VariableValueJs>;
+    get programVariableValues(): Map<string, any>;
+    get supplementaryValues(): Map<string, Array<string>>;
+    get dataItemValues(): Map<DataItemJs, any>;
+    get namedValues(): Map<string, any>;
+    copy(programRuleVariableValues?: Map<string, VariableValueJs>, programVariableValues?: Map<string, any>, supplementaryValues?: Map<string, Array<string>>, dataItemValues?: Map<DataItemJs, any>, namedValues?: Map<string, any>): ExpressionDataJs;
     toString(): string;
     hashCode(): number;
     equals(other: Nullable<any>): boolean;
 }
 export declare class ExpressionJs {
-    constructor(expression: string, mode: string);
+    constructor(expression: string, mode: ExpressionMode);
     collectDataItems(): Array<DataItemJs>;
     collectProgramRuleVariableNames(): Array<string>;
     collectProgramVariablesNames(): Array<string>;
     evaluate(unsupported: (p0: string) => Nullable<any>, data: ExpressionDataJs): Nullable<any>;
     collectProgramVariables(): Array<VariableJs>;
-    collectUIDs(): Array<IDJs>;
-    describe(displayNames: Array<Entry<string, string>>): string;
-    validate(displayNamesKeys: Array<Entry<string, string>>): void;
+    collectUIDs(): Array<ID>;
+    describe(displayNames: Map<string, string>): string;
+    validate(displayNamesKeys: Map<string, string>): void;
     collectDataItemForRegenerate(): Array<DataItemJs>;
-    regenerate(dataItemValues: Array<Entry<DataItemJs, number>>): string;
+    regenerate(dataItemValues: Map<DataItemJs, number>): string;
     normalise(): string;
     toString(): string;
     static get Companion(): {
         get MODES(): Array<string>;
     };
 }
-export declare class IDJs {
-    constructor(type: string, value: string);
-    get type(): string;
-    get value(): string;
-    copy(type?: string, value?: string): IDJs;
-    toString(): string;
-    hashCode(): number;
-    equals(other: Nullable<any>): boolean;
-    static get Companion(): {
-        get TYPES(): Array<string>;
-    };
-}
 export declare class QueryModifiersJs {
-    constructor(periodAggregation: boolean, aggregationType: Nullable<string>, maxDate: Nullable<string>, minDate: Nullable<string>, periodOffset: Nullable<number>, stageOffset: Nullable<number>, yearToDate: boolean, subExpression: Nullable<string>);
+    constructor(periodAggregation: boolean, aggregationType: Nullable<AggregationType>, maxDate: Nullable<string>, minDate: Nullable<string>, periodOffset: Nullable<number>, stageOffset: Nullable<number>, yearToDate: boolean, subExpression: Nullable<string>);
     get periodAggregation(): boolean;
-    get aggregationType(): Nullable<string>;
+    get aggregationType(): Nullable<AggregationType>;
     get maxDate(): Nullable<string>;
     get minDate(): Nullable<string>;
     get periodOffset(): Nullable<number>;
     get stageOffset(): Nullable<number>;
     get yearToDate(): boolean;
     get subExpression(): Nullable<string>;
-    copy(periodAggregation?: boolean, aggregationType?: Nullable<string>, maxDate?: Nullable<string>, minDate?: Nullable<string>, periodOffset?: Nullable<number>, stageOffset?: Nullable<number>, yearToDate?: boolean, subExpression?: Nullable<string>): QueryModifiersJs;
+    copy(periodAggregation?: boolean, aggregationType?: Nullable<AggregationType>, maxDate?: Nullable<string>, minDate?: Nullable<string>, periodOffset?: Nullable<number>, stageOffset?: Nullable<number>, yearToDate?: boolean, subExpression?: Nullable<string>): QueryModifiersJs;
     toString(): string;
     hashCode(): number;
     equals(other: Nullable<any>): boolean;
     static get Companion(): {
-        get AGGREGATION_TYPES(): Array<string>;
     };
 }
 export declare class VariableJs {
-    constructor(name: string, modifiers: QueryModifiersJs);
-    get name(): string;
+    constructor(name: ProgramVariable, modifiers: QueryModifiersJs);
+    get name(): ProgramVariable;
     get modifiers(): QueryModifiersJs;
-    copy(name?: string, modifiers?: QueryModifiersJs): VariableJs;
+    copy(name?: ProgramVariable, modifiers?: QueryModifiersJs): VariableJs;
     toString(): string;
     hashCode(): number;
     equals(other: Nullable<any>): boolean;
-    static get Companion(): {
-        get NAMES(): Array<string>;
-    };
 }
 export declare class VariableValueJs {
-    constructor(valueType: string, value: Nullable<string>, candidates: Array<string>, eventDate: Nullable<string>);
-    get valueType(): string;
+    constructor(valueType: ValueType, value: Nullable<string>, candidates: Array<string>, eventDate: Nullable<string>);
+    get valueType(): ValueType;
     get value(): Nullable<string>;
     get candidates(): Array<string>;
     get eventDate(): Nullable<string>;
-    copy(valueType?: string, value?: Nullable<string>, candidates?: Array<string>, eventDate?: Nullable<string>): VariableValueJs;
+    copy(valueType?: ValueType, value?: Nullable<string>, candidates?: Array<string>, eventDate?: Nullable<string>): VariableValueJs;
     toString(): string;
     hashCode(): number;
     equals(other: Nullable<any>): boolean;
-    static get Companion(): {
-        get VALUE_TYPES(): Array<string>;
-    };
 }