@rulebricks/sdk 1.0.0

package/forge/rule.d.ts

@@ -0,0 +1,129 @@
+import { RulebricksApiClient } from "../Client.js";
+import { Field, RuleSettings, OperatorResult } from "./types.js";
+import { BooleanField, NumberField, StringField, DateField, ListField } from "./operators.js";
+export declare class RuleTest {
+    id: string;
+    name: string;
+    request: Record<string, any>;
+    response: Record<string, any>;
+    critical: boolean;
+    lastExecuted: string | null;
+    testState: string | null;
+    error: string | null;
+    success: boolean | null;
+    constructor();
+    private generateId;
+    setName(name: string): RuleTest;
+    expect(request: Record<string, any>, response: Record<string, any>): RuleTest;
+    isCritical(critical?: boolean): RuleTest;
+    toDict(): Record<string, any>;
+    static fromJSON(data: string | Record<string, any>): RuleTest;
+}
+export declare class Condition {
+    private rule;
+    private index;
+    private conditions;
+    request: Record<string, {
+        op: string;
+        args: any[];
+    }>;
+    response: Record<string, {
+        value: any;
+    }>;
+    settings: {
+        enabled: boolean;
+        groupId?: string | null;
+        priority: number;
+        schedule: any[];
+        or?: boolean;
+    };
+    constructor(rule: Rule, conditions?: Record<string, [string, any[]]>, index?: number | null, settings?: Partial<Condition["settings"]>);
+    private processDynamicValues;
+    when(conditions: Record<string, [string, any[]]>): Condition;
+    then(responses: Record<string, any>): Rule | Condition;
+    setPriority(priority: number): Condition;
+    enable(): Condition;
+    disable(): Condition;
+    delete(): void;
+    toString(): string;
+    [Symbol.toStringTag](): string;
+    toJSON(): Record<string, any>;
+}
+export declare class Rule {
+    id: string;
+    name: string;
+    description: string;
+    folderId: string | null;
+    slug: string;
+    createdAt: string;
+    updatedAt: string;
+    updatedBy: string;
+    published: boolean;
+    private workspace?;
+    private sampleRequest;
+    private sampleResponse;
+    testRequest: Record<string, any>;
+    private testSuite;
+    fields: Record<string, Field>;
+    responseFields: Record<string, Field>;
+    conditions: Condition[];
+    private groups;
+    private publishedRequestSchema;
+    private publishedResponseSchema;
+    private publishedConditions;
+    private publishedGroups;
+    private history;
+    private form;
+    accessGroups: string[];
+    settings: RuleSettings;
+    constructor();
+    private generateUUID;
+    private generateSlug;
+    private getFieldType;
+    setWorkspace(client: RulebricksApiClient): Rule;
+    setName(name: string): Rule;
+    setDescription(description: string): Rule;
+    setFolder(folderName: string, createIfMissing?: boolean): Promise<Rule>;
+    setFolderById(folderId: string): Rule;
+    setAlias(alias: string): Promise<Rule>;
+    addBooleanField(name: string, description?: string, defaultValue?: boolean): BooleanField;
+    addNumberField(name: string, description?: string, defaultValue?: number): NumberField;
+    addStringField(name: string, description?: string, defaultValue?: string): StringField;
+    addDateField(name: string, description?: string, defaultValue?: Date): DateField;
+    addListField(name: string, description?: string, defaultValue?: any[]): ListField;
+    enableContinuousTesting(enabled?: boolean): Rule;
+    enableSchemaValidation(enabled?: boolean): Rule;
+    requireAllProperties(enabled?: boolean): Rule;
+    lockSchema(enabled?: boolean): Rule;
+    addAccessGroup(groupName: string, createIfMissing?: boolean): Promise<Rule>;
+    removeAccessGroup(groupName: string): Rule;
+    addBooleanResponse(name: string, description?: string, defaultValue?: boolean): BooleanField;
+    addNumberResponse(name: string, description?: string, defaultValue?: number): NumberField;
+    addStringResponse(name: string, description?: string, defaultValue?: string): StringField;
+    addDateResponse(name: string, description?: string, defaultValue?: Date): DateField;
+    addListResponse(name: string, description?: string, defaultValue?: any[]): ListField;
+    findConditions(conditions: Record<string, [string, any[]]>): Condition[];
+    private getField;
+    getBooleanField(name: string): BooleanField;
+    getNumberField(name: string): NumberField;
+    getStringField(name: string): StringField;
+    getDateField(name: string): DateField;
+    getListField(name: string): ListField;
+    when(conditions?: Record<string, OperatorResult>): Condition;
+    any(conditions: Record<string, OperatorResult>): Condition;
+    getConditions(): Condition[];
+    getConditionCount(): number;
+    addTest(test: RuleTest): Rule;
+    removeTest(testId: string): Rule;
+    findTestById(testId: string): RuleTest | undefined;
+    findTestByName(name: string): RuleTest | undefined;
+    update(): Promise<Rule>;
+    publish(): Promise<Rule>;
+    fromWorkspace(ruleId: string): Promise<Rule>;
+    toDict(): Record<string, any>;
+    toJSON(): string;
+    static fromJSON(data: string | Record<string, any>): Rule;
+    getEditorUrl(): string;
+    toTable(): string;
+    toString(): string;
+}