kwikid-forms/lib/renderer/form-view/definitions/form-view.actions.definition.d.ts

KwikID's JSON Configuration based Forms Renderer and Builder

import { TAction, TSource } from "kwikid-toolkit";
import { TMessage } from "./form-view.commons.definition";
export declare enum EActionKey {
    REMOVE_KEY_FROM_OBJECT_PATH = "REMOVE_KEY_FROM_OBJECT_PATH",
    SET_VALUE = "SET_VALUE",
    SET_FIELD_DEFAULT_VALUE = "SET_FIELD_DEFAULT_VALUE",
    SET_API_STATUS = "SET_API_STATUS",
    SET_API_HEADER_VALUE = "SET_API_HEADER_VALUE",
    SET_API_HEADER_VALIDITY = "SET_API_HEADER_VALIDITY",
    SET_API_BODY_VALUE = "SET_API_BODY_VALUE",
    SET_API_BODY_VALIDITY = "SET_API_BODY_VALIDITY",
    FIELD_API_TIMER_MESSAGE_SHOW = "FIELD_API_TIMER_MESSAGE_SHOW",
    FIELD_API_TIMER_MESSAGE_HIDE = "FIELD_API_TIMER_MESSAGE_HIDE",
    SET_FIELD_VALIDITY = "SET_FIELD_VALIDITY",
    FIELD_MESSAGE_SHOW = "FIELD_MESSAGE_SHOW",
    FIELD_MESSAGES_HIDE = "FIELD_MESSAGES_HIDE",
    FIELD_ERROR_SHOW = "FIELD_ERROR_SHOW",
    FIELD_ERROR_HIDE = "FIELD_ERROR_HIDE",
    FIELD_SHOW = "FIELD_SHOW",
    FIELD_HIDE = "FIELD_HIDE",
    FIELD_ENABLE = "FIELD_ENABLE",
    FIELD_DISABLE = "FIELD_DISABLE",
    FIELD_RESET = "FIELD_RESET",
    FIELD_GROUP_SHOW_API_LOADER = "FIELD_GROUP_SHOW_API_LOADER",
    FIELD_GROUP_HIDE_API_LOADER = "FIELD_GROUP_HIDE_API_LOADER",
    FIELD_SHOW_API_LOADER = "FIELD_SHOW_API_LOADER",
    FIELD_HIDE_API_LOADER = "FIELD_HIDE_API_LOADER",
    HANDLE_CONNECTED_ELEMENTS = "HANDLE_CONNECTED_ELEMENTS",
    CUSTOM = "CUSTOM",
    SCROLL_TO_FIELD = "SCROLL_TO_FIELD",
    FIELD_GROUP_SHOW = "FIELD_GROUP_SHOW",
    FIELD_GROUP_HIDE = "FIELD_GROUP_HIDE",
    FIELD_GROUP_ENABLE = "FIELD_GROUP_ENABLE",
    FIELD_GROUP_DISABLE = "FIELD_GROUP_DISABLE",
    FIELD_GROUP_RESET = "FIELD_GROUP_RESET",
    SET_DROPDOWN_OPTIONS = "SET_DROPDOWN_OPTIONS",
    API_CALL = "API_CALL",
    API_CALL_MULTIPLE = "API_CALL_MULTIPLE",
    API_CALL_MULTIPLE_END = "API_CALL_MULTIPLE_END",
    TASK_API_CALL = "TASK_API_CALL",
    TASK_API_CALL_MULTIPLE = "TASK_API_CALL_MULTIPLE",
    TASK_API_CALL_MULTIPLE_END = "TASK_API_CALL_MULTIPLE_END",
    PREVIEW_DIALOG_SHOW = "PREVIEW_DIALOG_SHOW",
    PREVIEW_ERROR_SHOW = "PREVIEW_ERROR_SHOW",
    POPUP_FORM_SHOW = "POPUP_FORM_SHOW",
    STOP_WAITING = "STOP_WAITING",
    NOTIFICATION_ERROR_SHOW = "NOTIFICATION_ERROR_SHOW",
    NOTIFICATION_ERROR_HIDE = "NOTIFICATION_ERROR_HIDE",
    DIALOG_SHOW = "DIALOG_SHOW",
    DIALOG_HIDE = "DIALOG_HIDE",
    RESUME_TASK_EXECUTION = "RESUME_TASK_EXECUTION",
    STOP_TASK_EXECUTION = "STOP_TASK_EXECUTION",
    REDIRECT_TO_URL = "REDIRECT_TO_URL",
    SAVE_FORM = "SAVE_FORM",
    ALERT_SHOW = "ALERT_SHOW",
    SET_HTML = "SET_HTML"
}
export declare type TActionKey = EActionKey.SET_VALUE | EActionKey.SET_FIELD_DEFAULT_VALUE | EActionKey.SET_API_STATUS | EActionKey.SET_API_HEADER_VALUE | EActionKey.SET_API_HEADER_VALIDITY | EActionKey.SET_API_BODY_VALUE | EActionKey.SET_API_BODY_VALIDITY | EActionKey.SET_FIELD_VALIDITY | EActionKey.FIELD_API_TIMER_MESSAGE_SHOW | EActionKey.FIELD_API_TIMER_MESSAGE_HIDE | EActionKey.FIELD_MESSAGE_SHOW | EActionKey.FIELD_MESSAGES_HIDE | EActionKey.FIELD_ERROR_SHOW | EActionKey.FIELD_ERROR_HIDE | EActionKey.FIELD_SHOW | EActionKey.FIELD_HIDE | EActionKey.FIELD_ENABLE | EActionKey.FIELD_DISABLE | EActionKey.FIELD_RESET | EActionKey.FIELD_GROUP_SHOW_API_LOADER | EActionKey.FIELD_GROUP_HIDE_API_LOADER | EActionKey.FIELD_SHOW_API_LOADER | EActionKey.FIELD_HIDE_API_LOADER | EActionKey.HANDLE_CONNECTED_ELEMENTS | EActionKey.CUSTOM | EActionKey.FIELD_GROUP_SHOW | EActionKey.FIELD_GROUP_HIDE | EActionKey.FIELD_GROUP_ENABLE | EActionKey.FIELD_GROUP_DISABLE | EActionKey.API_CALL | EActionKey.API_CALL_MULTIPLE | EActionKey.API_CALL_MULTIPLE_END | EActionKey.TASK_API_CALL | EActionKey.TASK_API_CALL_MULTIPLE | EActionKey.TASK_API_CALL_MULTIPLE_END | EActionKey.SET_DROPDOWN_OPTIONS | EActionKey.PREVIEW_DIALOG_SHOW | EActionKey.POPUP_FORM_SHOW | EActionKey.STOP_WAITING | EActionKey.NOTIFICATION_ERROR_SHOW | EActionKey.NOTIFICATION_ERROR_HIDE | EActionKey.DIALOG_SHOW | EActionKey.DIALOG_HIDE | EActionKey.RESUME_TASK_EXECUTION | EActionKey.STOP_TASK_EXECUTION | EActionKey.REDIRECT_TO_URL | EActionKey.SAVE_FORM | EActionKey.ALERT_SHOW | EActionKey.SET_HTML;
export declare type TActionSetValue = TAction & {
    key: EActionKey.SET_VALUE;
    props: {
        value: {
            source: TSource;
            destination: TSource;
        };
    };
};
export declare type TActionSetFieldDefaultValue = TAction & {
    key: EActionKey.SET_FIELD_DEFAULT_VALUE;
    props: {
        fieldKey: string;
        source: TSource;
    };
};
export declare type TActionFieldMessageShow = TAction & {
    key: EActionKey.FIELD_MESSAGE_SHOW;
    props: {
        fieldKey: string;
        message: TMessage;
    };
};
export declare type TActionFieldMessageHide = TAction & {
    key: EActionKey.FIELD_MESSAGES_HIDE;
    props: {
        fieldKey: string;
        message: TMessage;
    };
};
export declare type TActionFieldErrorShow = TAction & {
    key: EActionKey.FIELD_ERROR_SHOW;
    props: {
        fieldKey: string;
        message: TMessage;
    };
};
export declare type IFieldErrorHide = TAction & {
    key: EActionKey.FIELD_ERROR_HIDE;
    props: {
        fieldKey: string;
        message: TMessage;
    };
};
export declare type TActionFieldShow = TAction & {
    key: EActionKey.FIELD_SHOW;
    props: {
        fieldKey: string;
    };
};
export declare type TActionFieldHide = TAction & {
    key: EActionKey.FIELD_HIDE;
    props: {
        fieldKey: string;
    };
};
export declare type TActionFieldEnable = TAction & {
    key: EActionKey.FIELD_ENABLE;
    props: {
        fieldKey: string;
    };
};
export declare type TActionFieldDisable = TAction & {
    key: EActionKey.FIELD_DISABLE;
    props: {
        fieldKey: string;
    };
};
export declare type TActionFieldReset = TAction & {
    key: EActionKey.FIELD_RESET;
    props: {
        fieldKey: string;
    };
};
export declare type TActionHandleConnectedElement = TAction & {
    key: EActionKey.HANDLE_CONNECTED_ELEMENTS;
    props: {
        fieldKey: string;
    };
};
export declare type TActionApiCall = TAction & {
    key: EActionKey.API_CALL;
    props: {
        fieldKey: string;
        apiKey: string;
    };
};
export declare type TActionApiCallsDone = TAction & {
    key: EActionKey.API_CALL;
    props: {
        fieldKey: string;
    };
};
export declare type TActionPreviewDialogShow = TAction & {
    key: EActionKey.PREVIEW_DIALOG_SHOW;
    props: {
        html?: {
            before?: string;
            after?: string;
        };
        iframe?: {
            src: string;
            title?: string;
        };
    };
};
export declare type TActionSetHtml = TAction & {
    key: EActionKey.SET_HTML;
    props: {
        fieldKey: string;
        message: TMessage;
    };
};