@aemforms/af-core 0.22.73 → 0.22.75

package/esm/types/src/BaseNode.d.ts

@@ -56,14 +56,16 @@ export declare abstract class BaseNode<T extends BaseJson> implements BaseModel
         columnClassNames?: undefined;
         columnCount?: undefined;
         gridClassNames?: undefined;
+        ':type': string;
+        repeatable?: boolean | undefined;
+        minOccur?: number | undefined;
+        maxOccur?: number | undefined;
         properties: {
             [key: string]: any;
         };
         index: number;
         parent: undefined;
         qualifiedName: any;
-        repeatable: boolean | undefined;
-        ':type': string;
         id: string;
     };
     subscribe(callback: callbackFn, eventName?: string): {

package/esm/types/src/Checkbox.d.ts

@@ -67,6 +67,7 @@ declare class Checkbox extends Field {
             value: any;
         };
     };
+    protected _applyDefaults(): void;
     protected _getDefaults(): {
         enforceEnum: boolean;
         readOnly: boolean;
@@ -80,5 +81,76 @@ declare class Checkbox extends Field {
         type: string | undefined;
     };
     get enum(): any[];
+    protected updateDataNodeAndTypedValue(val: any): undefined | any;
+    set checked(check: boolean);
+    get checked(): boolean;
+    getState(isRepeatableChild?: boolean, forRestore?: boolean): {
+        checked: boolean;
+        editFormat: string | undefined;
+        displayFormat: string | undefined;
+        editValue: any;
+        displayValue: any;
+        enabled: boolean | undefined;
+        readOnly: boolean | undefined;
+        description?: string | undefined;
+        rules?: import("./types").Items<string> | undefined;
+        events?: import("./types").Items<string | string[] | undefined> | undefined;
+        enumNames?: string[] | import("./types").EnumName[] | undefined;
+        enum?: any[] | undefined;
+        accept?: string[] | undefined;
+        enforceEnum?: boolean | undefined;
+        exclusiveMinimum?: number | undefined;
+        exclusiveMaximum?: number | undefined;
+        format?: string | undefined;
+        maxFileSize?: string | number | undefined;
+        maxLength?: number | undefined;
+        maximum?: number | undefined;
+        maxItems?: number | undefined;
+        minOccur?: number | undefined;
+        maxOccur?: number | undefined;
+        minLength?: number | undefined;
+        minimum?: number | undefined;
+        minItems?: number | undefined;
+        pattern?: string | undefined;
+        required?: boolean | undefined;
+        step?: number | undefined;
+        type?: string | undefined;
+        validationExpression?: string | undefined;
+        uniqueItems?: boolean | undefined;
+        dataRef?: string | null | undefined;
+        lang?: string | undefined;
+        ':type': string;
+        appliedCssClassNames?: string | undefined;
+        label?: import("./types").Label | undefined;
+        visible?: boolean | undefined;
+        name?: string | undefined;
+        constraintMessages?: import("./types").ConstraintsMessages | undefined;
+        fieldType?: string | undefined;
+        errorMessage?: string | undefined;
+        properties: {
+            [key: string]: any;
+        };
+        repeatable?: boolean | undefined;
+        screenReaderText?: string | undefined;
+        tooltip?: string | undefined;
+        altText?: string | undefined;
+        viewType?: string | undefined;
+        placeholder?: string | undefined;
+        valid?: boolean | undefined;
+        validity?: any;
+        validationMessage?: string | undefined;
+        default?: any;
+        value?: any;
+        emptyValue?: "" | "undefined" | "null" | undefined;
+        _dependents?: string[] | undefined;
+        allowedComponents?: undefined;
+        columnClassNames?: undefined;
+        columnCount?: undefined;
+        gridClassNames?: undefined;
+        index: number;
+        parent: undefined;
+        qualifiedName: any;
+        id: string;
+    };
 }
 export default Checkbox;

package/esm/types/src/Container.d.ts

@@ -37,14 +37,16 @@ declare abstract class Container<T extends ContainerJson & RulesJson> extends Sc
         columnClassNames?: undefined;
         columnCount?: undefined;
         gridClassNames?: undefined;
+        ':type': string;
+        repeatable?: boolean | undefined;
+        minOccur?: number | undefined;
+        maxOccur?: number | undefined;
         properties: {
             [key: string]: any;
         };
         index: number;
         parent: undefined;
         qualifiedName: any;
-        repeatable: boolean | undefined;
-        ':type': string;
         id: string;
     };
     private _createChild;

package/esm/types/src/Field.d.ts

@@ -51,7 +51,7 @@ declare class Field extends Scriptable<FieldJson> implements FieldModel {
     get editValue(): any;
     get displayValue(): any;
     protected getDataNodeValue(typedValue: any): any;
-    private updateDataNodeAndTypedValue;
+    protected updateDataNodeAndTypedValue(val: any): any;
     get value(): any;
     set value(v: any);
     reset(): void;
@@ -197,7 +197,7 @@ declare class Field extends Scriptable<FieldJson> implements FieldModel {
         properties: {
             [key: string]: any;
         };
-        repeatable: boolean | undefined;
+        repeatable?: boolean | undefined;
         screenReaderText?: string | undefined;
         tooltip?: string | undefined;
         altText?: string | undefined;
@@ -209,6 +209,7 @@ declare class Field extends Scriptable<FieldJson> implements FieldModel {
         default?: any;
         value?: any;
         emptyValue?: "" | "undefined" | "null" | undefined;
+        checked?: boolean | undefined;
         _dependents?: string[] | undefined;
         allowedComponents?: undefined;
         columnClassNames?: undefined;

package/esm/types/src/Form.d.ts

@@ -91,14 +91,16 @@ declare class Form extends Container<FormJson> implements FormModel {
         columnClassNames?: undefined;
         columnCount?: undefined;
         gridClassNames?: undefined;
+        ':type': string;
+        repeatable?: boolean | undefined;
+        minOccur?: number | undefined;
+        maxOccur?: number | undefined;
         properties: {
             [key: string]: any;
         };
         index: number;
         parent: undefined;
         qualifiedName: any;
-        repeatable: boolean | undefined;
-        ':type': string;
         id: string;
     };
     get type(): string;

package/esm/types/src/FormInstance.d.ts

@@ -2,7 +2,7 @@ import { FormModel } from './types/index';
 import { LogLevel } from './controller/Logger';
 import { CustomFunction, FunctionDefinition } from './rules/FunctionRuntime';
 export declare const createFormInstance: (formModel: any, callback?: ((f: FormModel) => any) | undefined, logLevel?: LogLevel, fModel?: any) => FormModel;
-export declare const restoreFormInstance: (formModel: any, { logLevel }?: {
+export declare const restoreFormInstance: (formModel: any, data?: any, { logLevel }?: {
     logLevel: LogLevel;
 }) => FormModel;
 export declare const validateFormInstance: (formModel: any, data: any) => boolean;

package/esm/types/src/controller/Events.d.ts

@@ -66,6 +66,9 @@ export declare class SubmitSuccess extends ActionImpl {
 export declare class SubmitFailure extends ActionImpl {
     constructor(payload?: any, dispatch?: boolean);
 }
+export declare class SubmitError extends ActionImpl {
+    constructor(payload?: any, dispatch?: boolean);
+}
 export declare class Reset extends ActionImpl {
     constructor(payload?: any, dispatch?: boolean);
 }

package/esm/types/src/types/Json.d.ts

@@ -100,6 +100,7 @@ export type FieldJson = BaseJson & TranslationFieldJson & {
     editValue?: string;
     displayValue?: string;
     emptyValue?: 'null' | 'undefined' | '';
+    checked?: boolean;
 };
 export type ContainerJson = BaseJson & {
     items: Array<FieldJson | ContainerJson>;

package/esm/types/src/utils/ValidationUtils.d.ts

@@ -12,7 +12,8 @@ type ValidConstraintsType = {
     email: ValidationConstraints[];
 };
 export declare const ValidConstraints: ValidConstraintsType;
-export type ValidationConstraints = 'type' | 'format' | 'minimum' | 'maximum' | 'exclusiveMinimum' | 'exclusiveMaximum' | 'minItems' | 'maxItems' | 'uniqueItems' | 'minLength' | 'maxLength' | 'pattern' | 'required' | 'enum' | 'accept' | 'maxFileSize';
+export declare const validationConstraintsList: readonly ["type", "format", "minimum", "maximum", "exclusiveMinimum", "exclusiveMaximum", "minItems", "maxItems", "uniqueItems", "minLength", "maxLength", "pattern", "required", "enum", "accept", "maxFileSize"];
+export type ValidationConstraints = typeof validationConstraintsList[number];
 type ConstraintsObject = {
     [key in ValidationConstraints]: (constraint: any, inputVal: any) => ValidationResult;
 };

package/lib/BaseNode.d.ts

@@ -56,14 +56,16 @@ export declare abstract class BaseNode<T extends BaseJson> implements BaseModel
         columnClassNames?: undefined;
         columnCount?: undefined;
         gridClassNames?: undefined;
+        ':type': string;
+        repeatable?: boolean | undefined;
+        minOccur?: number | undefined;
+        maxOccur?: number | undefined;
         properties: {
             [key: string]: any;
         };
         index: number;
         parent: undefined;
         qualifiedName: any;
-        repeatable: boolean | undefined;
-        ':type': string;
         id: string;
     };
     subscribe(callback: callbackFn, eventName?: string): {

package/lib/BaseNode.js

@@ -13,6 +13,7 @@ exports.BaseNode = exports.exclude = exports.include = exports.dependencyTracked
 const Events_1 = require("./controller/Events");
 const DataRefParser_1 = require("./utils/DataRefParser");
 const EmptyDataValue_1 = __importDefault(require("./data/EmptyDataValue"));
+const ValidationUtils_1 = require("./utils/ValidationUtils");
 exports.editableProperties = [
     'value',
     'label',
@@ -31,7 +32,8 @@ exports.editableProperties = [
     'maximum',
     'maxItems',
     'minimum',
-    'minItems'
+    'minItems',
+    'checked'
 ];
 exports.dynamicProps = [
     ...exports.editableProperties,
@@ -239,7 +241,11 @@ class BaseNode {
         return !this._jsonModel.name && !isNonTransparent;
     }
     getState(forRestore = false) {
-        return Object.assign(Object.assign(Object.assign({}, this._jsonModel), { properties: this.properties, index: this.index, parent: undefined, qualifiedName: this.qualifiedName, repeatable: this.repeatable === true ? true : undefined, ':type': this[':type'] }), (forRestore ? {
+        return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, this._jsonModel), { properties: this.properties, index: this.index, parent: undefined, qualifiedName: this.qualifiedName }), (this.repeatable === true ? {
+            repeatable: true,
+            minOccur: this.parent.minItems,
+            maxOccur: this.parent.maxItems
+        } : {})), { ':type': this[':type'] }), (forRestore ? {
             _dependents: this._dependents.length ? this._dependents.map(x => x.node.id) : undefined,
             allowedComponents: undefined,
             columnClassNames: undefined,
@@ -322,6 +328,9 @@ class BaseNode {
                 this.notifyDependents(changeAction);
             }
             notifyChildren.call(this, changeAction);
+            if (ValidationUtils_1.validationConstraintsList.includes(prop)) {
+                this.validate();
+            }
             return changeAction.payload.changes;
         }
         return [];

package/lib/Checkbox.d.ts

@@ -67,6 +67,7 @@ declare class Checkbox extends Field {
             value: any;
         };
     };
+    protected _applyDefaults(): void;
     protected _getDefaults(): {
         enforceEnum: boolean;
         readOnly: boolean;
@@ -80,5 +81,76 @@ declare class Checkbox extends Field {
         type: string | undefined;
     };
     get enum(): any[];
+    protected updateDataNodeAndTypedValue(val: any): undefined | any;
+    set checked(check: boolean);
+    get checked(): boolean;
+    getState(isRepeatableChild?: boolean, forRestore?: boolean): {
+        checked: boolean;
+        editFormat: string | undefined;
+        displayFormat: string | undefined;
+        editValue: any;
+        displayValue: any;
+        enabled: boolean | undefined;
+        readOnly: boolean | undefined;
+        description?: string | undefined;
+        rules?: import("./types").Items<string> | undefined;
+        events?: import("./types").Items<string | string[] | undefined> | undefined;
+        enumNames?: string[] | import("./types").EnumName[] | undefined;
+        enum?: any[] | undefined;
+        accept?: string[] | undefined;
+        enforceEnum?: boolean | undefined;
+        exclusiveMinimum?: number | undefined;
+        exclusiveMaximum?: number | undefined;
+        format?: string | undefined;
+        maxFileSize?: string | number | undefined;
+        maxLength?: number | undefined;
+        maximum?: number | undefined;
+        maxItems?: number | undefined;
+        minOccur?: number | undefined;
+        maxOccur?: number | undefined;
+        minLength?: number | undefined;
+        minimum?: number | undefined;
+        minItems?: number | undefined;
+        pattern?: string | undefined;
+        required?: boolean | undefined;
+        step?: number | undefined;
+        type?: string | undefined;
+        validationExpression?: string | undefined;
+        uniqueItems?: boolean | undefined;
+        dataRef?: string | null | undefined;
+        lang?: string | undefined;
+        ':type': string;
+        appliedCssClassNames?: string | undefined;
+        label?: import("./types").Label | undefined;
+        visible?: boolean | undefined;
+        name?: string | undefined;
+        constraintMessages?: import("./types").ConstraintsMessages | undefined;
+        fieldType?: string | undefined;
+        errorMessage?: string | undefined;
+        properties: {
+            [key: string]: any;
+        };
+        repeatable?: boolean | undefined;
+        screenReaderText?: string | undefined;
+        tooltip?: string | undefined;
+        altText?: string | undefined;
+        viewType?: string | undefined;
+        placeholder?: string | undefined;
+        valid?: boolean | undefined;
+        validity?: any;
+        validationMessage?: string | undefined;
+        default?: any;
+        value?: any;
+        emptyValue?: "" | "undefined" | "null" | undefined;
+        _dependents?: string[] | undefined;
+        allowedComponents?: undefined;
+        columnClassNames?: undefined;
+        columnCount?: undefined;
+        gridClassNames?: undefined;
+        index: number;
+        parent: undefined;
+        qualifiedName: any;
+        id: string;
+    };
 }
 export default Checkbox;

package/lib/Checkbox.js

@@ -1,10 +1,17 @@
 "use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const Field_1 = __importDefault(require("./Field"));
 const ValidationUtils_1 = require("./utils/ValidationUtils");
+const BaseNode_1 = require("./BaseNode");
 const requiredConstraint = (offValue) => (constraint, value) => {
     const valid = ValidationUtils_1.Constraints.required(constraint, value).valid && (!constraint || value != offValue);
     return { valid, value };
@@ -19,11 +26,59 @@ class Checkbox extends Field_1.default {
         baseConstraints.required = requiredConstraint(this.offValue());
         return baseConstraints;
     }
+    _applyDefaults() {
+        var _a, _b;
+        if (typeof this._jsonModel.checked === 'boolean') {
+            if (this._jsonModel.checked) {
+                this._jsonModel.default = (_a = this._jsonModel.enum) === null || _a === void 0 ? void 0 : _a[0];
+            }
+            else {
+                this._jsonModel.default = (_b = this._jsonModel.enum) === null || _b === void 0 ? void 0 : _b[1];
+            }
+        }
+        super._applyDefaults();
+    }
     _getDefaults() {
         return Object.assign(Object.assign({}, super._getDefaults()), { enforceEnum: true });
     }
     get enum() {
         return this._jsonModel.enum || [];
     }
+    updateDataNodeAndTypedValue(val) {
+        var _a, _b;
+        const changes = super.updateDataNodeAndTypedValue(val);
+        const valueChange = changes.find((c) => c.propertyName === 'value');
+        if (valueChange) {
+            const oldChecked = valueChange.prevValue === ((_a = this._jsonModel.enum) === null || _a === void 0 ? void 0 : _a[0]);
+            const newChecked = valueChange.currentValue === ((_b = this._jsonModel.enum) === null || _b === void 0 ? void 0 : _b[0]);
+            if (oldChecked !== newChecked) {
+                changes.push({
+                    propertyName: 'checked',
+                    prevValue: oldChecked,
+                    currentValue: newChecked
+                });
+            }
+        }
+        return changes;
+    }
+    set checked(check) {
+        var _a, _b;
+        if (check) {
+            this.value = (_a = this._jsonModel.enum) === null || _a === void 0 ? void 0 : _a[0];
+        }
+        else {
+            this.value = (_b = this._jsonModel.enum) === null || _b === void 0 ? void 0 : _b[1];
+        }
+    }
+    get checked() {
+        var _a;
+        return this.value === ((_a = this._jsonModel.enum) === null || _a === void 0 ? void 0 : _a[0]);
+    }
+    getState(isRepeatableChild = false, forRestore = false) {
+        return Object.assign(Object.assign({}, super.getState(isRepeatableChild, forRestore)), { checked: this.checked });
+    }
 }
+__decorate([
+    (0, BaseNode_1.dependencyTracked)()
+], Checkbox.prototype, "checked", null);
 exports.default = Checkbox;

package/lib/Container.d.ts

@@ -37,14 +37,16 @@ declare abstract class Container<T extends ContainerJson & RulesJson> extends Sc
         columnClassNames?: undefined;
         columnCount?: undefined;
         gridClassNames?: undefined;
+        ':type': string;
+        repeatable?: boolean | undefined;
+        minOccur?: number | undefined;
+        maxOccur?: number | undefined;
         properties: {
             [key: string]: any;
         };
         index: number;
         parent: undefined;
         qualifiedName: any;
-        repeatable: boolean | undefined;
-        ':type': string;
         id: string;
     };
     private _createChild;

package/lib/Field.d.ts

@@ -51,7 +51,7 @@ declare class Field extends Scriptable<FieldJson> implements FieldModel {
     get editValue(): any;
     get displayValue(): any;
     protected getDataNodeValue(typedValue: any): any;
-    private updateDataNodeAndTypedValue;
+    protected updateDataNodeAndTypedValue(val: any): any;
     get value(): any;
     set value(v: any);
     reset(): void;
@@ -197,7 +197,7 @@ declare class Field extends Scriptable<FieldJson> implements FieldModel {
         properties: {
             [key: string]: any;
         };
-        repeatable: boolean | undefined;
+        repeatable?: boolean | undefined;
         screenReaderText?: string | undefined;
         tooltip?: string | undefined;
         altText?: string | undefined;
@@ -209,6 +209,7 @@ declare class Field extends Scriptable<FieldJson> implements FieldModel {
         default?: any;
         value?: any;
         emptyValue?: "" | "undefined" | "null" | undefined;
+        checked?: boolean | undefined;
         _dependents?: string[] | undefined;
         allowedComponents?: undefined;
         columnClassNames?: undefined;

package/lib/Field.js

@@ -244,7 +244,6 @@ class Field extends Scriptable_1.default {
     }
     set required(r) {
         this._setProperty('required', r);
-        this.validate();
     }
     get maximum() {
         if (this.type === 'number' || this.format === 'date' || this.type === 'integer') {

package/lib/Form.d.ts

@@ -91,14 +91,16 @@ declare class Form extends Container<FormJson> implements FormModel {
         columnClassNames?: undefined;
         columnCount?: undefined;
         gridClassNames?: undefined;
+        ':type': string;
+        repeatable?: boolean | undefined;
+        minOccur?: number | undefined;
+        maxOccur?: number | undefined;
         properties: {
             [key: string]: any;
         };
         index: number;
         parent: undefined;
         qualifiedName: any;
-        repeatable: boolean | undefined;
-        ':type': string;
         id: string;
     };
     get type(): string;

package/lib/Form.js

@@ -217,7 +217,7 @@ class Form extends Container_1.default {
         if (!validate_form || this.validate().length === 0) {
             const payload = (action === null || action === void 0 ? void 0 : action.payload) || {};
             const successEventName = (payload === null || payload === void 0 ? void 0 : payload.success) ? payload === null || payload === void 0 ? void 0 : payload.success : 'submitSuccess';
-            const failureEventName = (payload === null || payload === void 0 ? void 0 : payload.error) ? payload === null || payload === void 0 ? void 0 : payload.error : 'submitFailure';
+            const failureEventName = (payload === null || payload === void 0 ? void 0 : payload.error) ? payload === null || payload === void 0 ? void 0 : payload.error : 'submitError';
             (0, FunctionRuntime_1.submit)(context, successEventName, failureEventName, payload === null || payload === void 0 ? void 0 : payload.submit_as, payload === null || payload === void 0 ? void 0 : payload.data);
         }
     }

package/lib/FormInstance.d.ts

@@ -2,7 +2,7 @@ import { FormModel } from './types/index';
 import { LogLevel } from './controller/Logger';
 import { CustomFunction, FunctionDefinition } from './rules/FunctionRuntime';
 export declare const createFormInstance: (formModel: any, callback?: ((f: FormModel) => any) | undefined, logLevel?: LogLevel, fModel?: any) => FormModel;
-export declare const restoreFormInstance: (formModel: any, { logLevel }?: {
+export declare const restoreFormInstance: (formModel: any, data?: any, { logLevel }?: {
     logLevel: LogLevel;
 }) => FormModel;
 export declare const validateFormInstance: (formModel: any, data: any) => boolean;

package/lib/FormInstance.js

@@ -13,6 +13,7 @@ const Logger_1 = require("./controller/Logger");
 const FormCreationUtils_1 = require("./utils/FormCreationUtils");
 const FunctionRuntime_1 = require("./rules/FunctionRuntime");
 const FormUtils_1 = require("./utils/FormUtils");
+const DataGroup_1 = __importDefault(require("./data/DataGroup"));
 const createFormInstance = (formModel, callback, logLevel = 'error', fModel = undefined) => {
     try {
         let f = fModel;
@@ -39,9 +40,13 @@ exports.createFormInstance = createFormInstance;
 const defaultOptions = {
     logLevel: 'error'
 };
-const restoreFormInstance = (formModel, { logLevel } = defaultOptions) => {
+const restoreFormInstance = (formModel, data = null, { logLevel } = defaultOptions) => {
     try {
         const form = new Form_1.default(Object.assign({}, formModel), FormCreationUtils_1.FormFieldFactory, new RuleEngine_1.default(), new EventQueue_1.default(new Logger_1.Logger(logLevel)), logLevel, 'restore');
+        if (data) {
+            form._bindToDataModel(new DataGroup_1.default('$form', data));
+            form.syncDataAndFormModel(form.getDataNode());
+        }
         form.getEventQueue().empty();
         return form;
     }

package/lib/controller/Events.d.ts

@@ -66,6 +66,9 @@ export declare class SubmitSuccess extends ActionImpl {
 export declare class SubmitFailure extends ActionImpl {
     constructor(payload?: any, dispatch?: boolean);
 }
+export declare class SubmitError extends ActionImpl {
+    constructor(payload?: any, dispatch?: boolean);
+}
 export declare class Reset extends ActionImpl {
     constructor(payload?: any, dispatch?: boolean);
 }

package/lib/controller/Events.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RemoveInstance = exports.AddInstance = exports.RemoveItem = exports.AddItem = exports.CustomEvent = exports.FieldChanged = exports.Reset = exports.SubmitFailure = exports.SubmitSuccess = exports.Submit = exports.Focus = exports.ValidationComplete = exports.Blur = exports.Click = exports.FormLoad = exports.Initialize = exports.propertyChange = exports.ExecuteRule = exports.Valid = exports.Invalid = exports.Change = void 0;
+exports.RemoveInstance = exports.AddInstance = exports.RemoveItem = exports.AddItem = exports.CustomEvent = exports.FieldChanged = exports.Reset = exports.SubmitError = exports.SubmitFailure = exports.SubmitSuccess = exports.Submit = exports.Focus = exports.ValidationComplete = exports.Blur = exports.Click = exports.FormLoad = exports.Initialize = exports.propertyChange = exports.ExecuteRule = exports.Valid = exports.Invalid = exports.Change = void 0;
 class ActionImpl {
     constructor(payload, type, _metadata) {
         this._metadata = _metadata;
@@ -129,6 +129,12 @@ class SubmitFailure extends ActionImpl {
     }
 }
 exports.SubmitFailure = SubmitFailure;
+class SubmitError extends ActionImpl {
+    constructor(payload, dispatch = false) {
+        super(payload, 'submitError', { dispatch });
+    }
+}
+exports.SubmitError = SubmitError;
 class Reset extends ActionImpl {
     constructor(payload, dispatch = false) {
         super(payload, 'reset', { dispatch });

package/lib/rules/FunctionRuntime.js

@@ -69,7 +69,8 @@ const request = (context, uri, httpVerb, payload, success, error, headers) => __
     else {
         context.form.logger.error('Error invoking a rest API');
         const eName = getCustomEventName(error);
-        if (error === 'submitFailure') {
+        if (error === 'submitError') {
+            context.form.dispatch(new Events_1.SubmitError(result, true));
             context.form.dispatch(new Events_1.SubmitFailure(result, true));
         }
         else {
@@ -201,6 +202,11 @@ class FunctionRuntimeImpl {
                                 },
                                 exportData: () => {
                                     return FunctionRuntimeImpl.getInstance().getFunctions().exportData._func.call(undefined, args, data, interpreter);
+                                },
+                                submitForm: (payload, validateForm, contentType) => {
+                                    const submitAs = contentType || 'multipart/form-data';
+                                    const args = ['custom:submitSuccess', 'custom:submitError', submitAs, payload, validateForm];
+                                    return FunctionRuntimeImpl.getInstance().getFunctions().submitForm._func.call(undefined, args, data, interpreter);
                                 }
                             }
                         };
@@ -302,11 +308,24 @@ class FunctionRuntimeImpl {
             },
             submitForm: {
                 _func: (args, data, interpreter) => {
-                    const success = toString(args[0]);
-                    const error = toString(args[1]);
-                    const submit_as = args.length > 2 ? toString(args[2]) : 'multipart/form-data';
-                    const submit_data = args.length > 3 ? valueOf(args[3]) : null;
-                    const validate_form = args.length > 4 ? valueOf(args[4]) : true;
+                    let success = 'custom:submitSuccess';
+                    let error = 'custom:submitError';
+                    let submit_data;
+                    let validate_form;
+                    let submit_as;
+                    if (args.length > 0 && typeof valueOf(args[0]) === 'object') {
+                        submit_data = args.length > 0 ? valueOf(args[0]) : null;
+                        validate_form = args.length > 1 ? valueOf(args[1]) : true;
+                        submit_as = args.length > 2 ? toString(args[2]) : 'multipart/form-data';
+                    }
+                    else {
+                        interpreter.globals.form.logger.warn('This usage of submitForm is deprecated. Please see the documentation and update');
+                        success = toString(args[0]);
+                        error = toString(args[1]);
+                        submit_as = args.length > 2 ? toString(args[2]) : 'multipart/form-data';
+                        submit_data = args.length > 3 ? valueOf(args[3]) : null;
+                        validate_form = args.length > 4 ? valueOf(args[4]) : true;
+                    }
                     interpreter.globals.form.dispatch(new Events_1.Submit({
                         success,
                         error,

package/lib/types/Json.d.ts

@@ -100,6 +100,7 @@ export declare type FieldJson = BaseJson & TranslationFieldJson & {
     editValue?: string;
     displayValue?: string;
     emptyValue?: 'null' | 'undefined' | '';
+    checked?: boolean;
 };
 export declare type ContainerJson = BaseJson & {
     items: Array<FieldJson | ContainerJson>;