@rulebricks/sdk 1.1.0 → 1.2.0

package/forge/operators.d.ts

@@ -0,0 +1,136 @@
+import { Field, RuleType, OperatorDef, DynamicValueType } from "./types.js";
+import { DynamicValue } from "./values.js";
+export declare type OperatorResult = [string, any[]];
+export declare class Argument<T> {
+    private value;
+    private expectedType;
+    constructor(value: T | DynamicValue, expectedType: DynamicValueType);
+    private validateType;
+    private getExpectedJsType;
+    toDict(): any;
+    static process(arg: any, expectedType: DynamicValueType): any;
+    toString(): string;
+}
+export declare class BooleanField implements Field {
+    readonly type = RuleType.BOOLEAN;
+    readonly operators: Record<string, OperatorDef>;
+    readonly defaultValue: boolean;
+    readonly name: string;
+    readonly description: string;
+    constructor(name: string, description?: string, defaultValue?: boolean);
+    equals(value: boolean | DynamicValue): OperatorResult;
+}
+export declare class NumberField implements Field {
+    readonly type = RuleType.NUMBER;
+    readonly operators: Record<string, OperatorDef>;
+    readonly defaultValue: number;
+    readonly name: string;
+    readonly description: string;
+    constructor(name: string, description?: string, defaultValue?: number);
+    equals(value: number | DynamicValue): OperatorResult;
+    not_equals(value: number | DynamicValue): OperatorResult;
+    greater_than(value: number | DynamicValue): OperatorResult;
+    less_than(value: number | DynamicValue): OperatorResult;
+    greater_than_or_equal(value: number | DynamicValue): OperatorResult;
+    less_than_or_equal(value: number | DynamicValue): OperatorResult;
+    between(start: number | DynamicValue, end: number | DynamicValue): OperatorResult;
+    not_between(start: number | DynamicValue, end: number | DynamicValue): OperatorResult;
+    is_even(): OperatorResult;
+    is_odd(): OperatorResult;
+    is_positive(): OperatorResult;
+    is_negative(): OperatorResult;
+    is_zero(): OperatorResult;
+    is_not_zero(): OperatorResult;
+    is_multiple_of(value: number | DynamicValue): OperatorResult;
+    is_not_multiple_of(value: number | DynamicValue): OperatorResult;
+    is_power_of(base: number | DynamicValue): OperatorResult;
+}
+export declare class DateField implements Field {
+    readonly type = RuleType.DATE;
+    readonly operators: Record<string, OperatorDef>;
+    readonly defaultValue: Date;
+    readonly name: string;
+    readonly description: string;
+    constructor(name: string, description?: string, defaultValue?: Date | null);
+    is_past(): OperatorResult;
+    is_future(): OperatorResult;
+    days_ago(days: number | DynamicValue): OperatorResult;
+    less_than_days_ago(days: number | DynamicValue): OperatorResult;
+    more_than_days_ago(days: number | DynamicValue): OperatorResult;
+    days_from_now(days: number | DynamicValue): OperatorResult;
+    less_than_days_from_now(days: number | DynamicValue): OperatorResult;
+    more_than_days_from_now(days: number | DynamicValue): OperatorResult;
+    is_today(): OperatorResult;
+    is_this_week(): OperatorResult;
+    is_this_month(): OperatorResult;
+    is_this_year(): OperatorResult;
+    is_next_week(): OperatorResult;
+    is_next_month(): OperatorResult;
+    is_next_year(): OperatorResult;
+    is_last_week(): OperatorResult;
+    is_last_month(): OperatorResult;
+    is_last_year(): OperatorResult;
+    after(date: Date | string | DynamicValue): OperatorResult;
+    on_or_after(date: Date | string | DynamicValue): OperatorResult;
+    before(date: Date | string | DynamicValue): OperatorResult;
+    on_or_before(date: Date | string | DynamicValue): OperatorResult;
+    between(start: Date | string | DynamicValue, end: Date | string | DynamicValue): OperatorResult;
+}
+export declare class StringField implements Field {
+    readonly type = RuleType.STRING;
+    readonly operators: Record<string, OperatorDef>;
+    readonly defaultValue: string;
+    readonly name: string;
+    readonly description: string;
+    constructor(name: string, description?: string, defaultValue?: string);
+    contains(value: string | DynamicValue): OperatorResult;
+    not_contains(value: string | DynamicValue): OperatorResult;
+    equals(value: string | DynamicValue): OperatorResult;
+    not_equals(value: string | DynamicValue): OperatorResult;
+    is_empty(): OperatorResult;
+    is_not_empty(): OperatorResult;
+    starts_with(value: string | DynamicValue): OperatorResult;
+    ends_with(value: string | DynamicValue): OperatorResult;
+    is_included_in(values: string[] | DynamicValue): OperatorResult;
+    matches_regex(pattern: string | DynamicValue): OperatorResult;
+    not_matches_regex(pattern: string | DynamicValue): OperatorResult;
+    is_email(): OperatorResult;
+    is_not_email(): OperatorResult;
+    is_url(): OperatorResult;
+    is_not_url(): OperatorResult;
+    is_ip(): OperatorResult;
+    is_not_ip(): OperatorResult;
+    is_uppercase(): OperatorResult;
+    is_lowercase(): OperatorResult;
+    is_numeric(): OperatorResult;
+    contains_only_digits(): OperatorResult;
+    contains_only_letters(): OperatorResult;
+    contains_only_digits_and_letters(): OperatorResult;
+}
+export declare class ListField implements Field {
+    readonly type = RuleType.LIST;
+    readonly operators: Record<string, OperatorDef>;
+    readonly defaultValue: any[];
+    readonly name: string;
+    readonly description: string;
+    constructor(name: string, description?: string, defaultValue?: any[]);
+    contains(value: any | DynamicValue): OperatorResult;
+    is_empty(): OperatorResult;
+    is_not_empty(): OperatorResult;
+    length_equals(length: number | DynamicValue): OperatorResult;
+    length_not_equals(length: number | DynamicValue): OperatorResult;
+    longer_than(length: number | DynamicValue): OperatorResult;
+    shorter_than(length: number | DynamicValue): OperatorResult;
+    contains_all(values: any[] | DynamicValue): OperatorResult;
+    contains_any(values: any[] | DynamicValue): OperatorResult;
+    contains_none(values: any[] | DynamicValue): OperatorResult;
+    not_contains(value: any | DynamicValue): OperatorResult;
+    equals(other: any[] | DynamicValue): OperatorResult;
+    not_equals(other: any[] | DynamicValue): OperatorResult;
+    has_duplicates(): OperatorResult;
+    no_duplicates(): OperatorResult;
+    contains_object_with_key_value(key: string | DynamicValue, value: any | DynamicValue): OperatorResult;
+    has_unique_elements(): OperatorResult;
+    is_sublist_of(superlist: any[] | DynamicValue): OperatorResult;
+    is_superlist_of(sublist: any[] | DynamicValue): OperatorResult;
+}