@formio/js 5.0.0-dev.5633.8d2b30d → 5.0.0-dev.5633.fde3bc9

package/lib/mjs/components/form/Form.d.ts

@@ -13,41 +13,47 @@ export default class FormComponent extends Component {
     valueChanged: boolean | undefined;
     subForm: any;
     formSrc: any;
-    get dataReady(): any;
+    get dataReady(): Promise<any>;
     get emptyValue(): {
         data: {};
     };
-    get ready(): any;
+    get ready(): Promise<any>;
     get useOriginalRevision(): any;
     setFormRevision(rev: any): void;
     subFormRevision: any;
     getComponent(path: any, fn: any): any;
     getSubOptions(options?: {}): {};
-    render(): any;
+    render(): string;
     asString(value: any): any;
-    attach(element: any): Promise<any>;
+    /**
+     * Prints out the value of form components as a datagrid value.
+     */
+    getValueAsString(value: any, options: any): any;
+    attach(element: any): Promise<void>;
     get hasLoadedForm(): any;
     get isRevisionChanged(): any;
-    subFormReady: any;
+    subFormReady: Promise<any> | null | undefined;
     /**
      * Pass everyComponent to subform.
-     * @param args
-     * @returns {*|void}
+     * @param {any[]} args - Arguments to pass through to the subform's everyComponent method.
+     * @returns {*} - The result of the subform's everyComponent method.
      */
-    everyComponent(...args: any[]): any | void;
+    everyComponent(...args: any[]): any;
     setSubFormDisabled(subForm: any): void;
     updateSubWizards(subForm: any): void;
     /**
      * Create a subform instance.
-     *
-     * @return {*}
+     * @param {boolean} [fromAttach] - This function is being called from an `attach` method.
+     * @returns {*} - The subform instance.
      */
-    createSubForm(fromAttach: any): any;
+    createSubForm(fromAttach?: boolean | undefined): any;
     hideSubmitButton(component: any): void;
     /**
      * Load the subform.
+     * @param {boolean} fromAttach - This function is being called from an `attach` method.
+     * @returns {Promise} - The promise that resolves when the subform is loaded.
      */
-    loadSubForm(fromAttach: any): any;
+    loadSubForm(fromAttach: boolean): Promise<any>;
     subFormLoading: boolean | undefined;
     get subFormData(): any;
     checkComponentValidity(data: any, dirty: any, row: any, options: any, errors?: any[]): any;
@@ -56,43 +62,47 @@ export default class FormComponent extends Component {
     setPristine(pristine: any): void;
     /**
      * Determine if the subform should be submitted.
-     * @return {*|boolean}
+     * @returns {*|boolean} - TRUE if the subform should be submitted, FALSE if it should not.
      */
     get shouldSubmit(): any;
     /**
      * Returns the data for the subform.
-     *
-     * @return {*}
+     * @returns {*} - the data for the subform.
      */
     getSubFormData(): any;
     /**
      * Submit the subform if configured to do so.
-     *
-     * @return {*}
+     * @returns {Promise} - The promise that resolves when the subform is submitted.
      */
-    submitSubForm(): any;
+    submitSubForm(): Promise<any>;
     /**
      * Submit the form before the next page is triggered.
+     * @param {Function} next - The function to trigger the next page.
+     * @returns {Promise} - The promise that resolves when the subform submission is complete (if necessary) and the next page is triggered.
+     */
+    beforePage(next: Function): Promise<any>;
+    /**
+     * Submit the form before the whole form is triggered.
+     * @returns {Promise} - The promise that resolves when the subform submission is complete (if necessary) and the form is submitted.
      */
-    beforePage(next: any): any;
+    beforeSubmit(): Promise<any>;
     isSubFormLazyLoad(): any;
     isHidden(): boolean;
     setValue(submission: any, flags?: {}): boolean;
     setSubFormValue(submission: any, flags: any): void;
     /**
      * Sets the subform value
-     *
-     * @param {Object | null | undefined} submission
-     * @param {Object | null | undefined} flags
+     * @param {object|null|undefined} submission - The submission to set.
+     * @param {object|null|undefined} flags - Any flags to apply when setting the submission.
      * @return {void}
      */
-    onSetSubFormValue(submission: Object | null | undefined, flags: Object | null | undefined): void;
+    onSetSubFormValue(submission: object | null | undefined, flags: object | null | undefined): void;
     areAllComponentsEmpty(data: any): boolean;
     updateSubFormVisibility(): void;
     /**
      * Determines if this form is a Nested Wizard
      * which means it should be a Wizard itself and should be a direct child of a Wizard's page
-     * @returns {boolean}
+     * @returns {boolean} - TRUE if this form is a Nested Wizard, FALSE otherwise
      */
     get isNestedWizard(): boolean;
     isInternalEvent(event: any): boolean;

package/lib/mjs/components/form/Form.form.d.ts

@@ -1,3 +1,6 @@
-export default function _default(...extend: any[]): {
-    components: any;
-};
+/**
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
+ */
+export default function _default(...extend: any[]): import('@formio/core').Component[];

package/lib/mjs/components/form/Form.form.js

@@ -2,6 +2,11 @@ import nestedComponentForm from '../_classes/nested/NestedComponent.form';
 import FormEditDisplay from './editForm/Form.edit.display';
 import FormEditForm from './editForm/Form.edit.form';
 import FormEditData from './editForm/Form.edit.data';
+/**
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
+ */
 export default function (...extend) {
     return nestedComponentForm([
         {

package/lib/mjs/components/form/Form.js

@@ -346,8 +346,8 @@ export default class FormComponent extends Component {
     }
     /**
      * Pass everyComponent to subform.
-     * @param args
-     * @returns {*|void}
+     * @param {any[]} args - Arguments to pass through to the subform's everyComponent method.
+     * @returns {*} - The result of the subform's everyComponent method.
      */
     everyComponent(...args) {
         if (this.subForm) {
@@ -371,8 +371,8 @@ export default class FormComponent extends Component {
     }
     /**
      * Create a subform instance.
-     *
-     * @return {*}
+     * @param {boolean} [fromAttach] - This function is being called from an `attach` method.
+     * @returns {*} - The subform instance.
      */
     createSubForm(fromAttach) {
         this.subFormReady = this.loadSubForm(fromAttach).then((form) => {
@@ -425,6 +425,8 @@ export default class FormComponent extends Component {
     }
     /**
      * Load the subform.
+     * @param {boolean} fromAttach - This function is being called from an `attach` method.
+     * @returns {Promise} - The promise that resolves when the subform is loaded.
      */
     loadSubForm(fromAttach) {
         if (this.builderMode || this.isHidden() || (this.isSubFormLazyLoad() && !fromAttach)) {
@@ -507,15 +509,14 @@ export default class FormComponent extends Component {
     }
     /**
      * Determine if the subform should be submitted.
-     * @return {*|boolean}
+     * @returns {*|boolean} - TRUE if the subform should be submitted, FALSE if it should not.
      */
     get shouldSubmit() {
         return this.subFormReady && (!this.component.hasOwnProperty('reference') || this.component.reference) && !this.isHidden();
     }
     /**
      * Returns the data for the subform.
-     *
-     * @return {*}
+     * @returns {*} - the data for the subform.
      */
     getSubFormData() {
         if (_.get(this.subForm, 'form.display') === 'pdf') {
@@ -527,8 +528,7 @@ export default class FormComponent extends Component {
     }
     /**
      * Submit the subform if configured to do so.
-     *
-     * @return {*}
+     * @returns {Promise} - The promise that resolves when the subform is submitted.
      */
     submitSubForm() {
         // If we wish to submit the form on next page, then do that here.
@@ -555,6 +555,8 @@ export default class FormComponent extends Component {
     }
     /**
      * Submit the form before the next page is triggered.
+     * @param {Function} next - The function to trigger the next page.
+     * @returns {Promise} - The promise that resolves when the subform submission is complete (if necessary) and the next page is triggered.
      */
     beforePage(next) {
         // Should not submit child forms if we are going to the previous page
@@ -565,6 +567,7 @@ export default class FormComponent extends Component {
     }
     /**
      * Submit the form before the whole form is triggered.
+     * @returns {Promise} - The promise that resolves when the subform submission is complete (if necessary) and the form is submitted.
      */
     beforeSubmit() {
         const submission = this.dataValue;
@@ -641,9 +644,8 @@ export default class FormComponent extends Component {
     }
     /**
      * Sets the subform value
-     *
-     * @param {Object | null | undefined} submission
-     * @param {Object | null | undefined} flags
+     * @param {object|null|undefined} submission - The submission to set.
+     * @param {object|null|undefined} flags - Any flags to apply when setting the submission.
      * @return {void}
      */
     onSetSubFormValue(submission, flags) {
@@ -686,7 +688,7 @@ export default class FormComponent extends Component {
     /**
      * Determines if this form is a Nested Wizard
      * which means it should be a Wizard itself and should be a direct child of a Wizard's page
-     * @returns {boolean}
+     * @returns {boolean} - TRUE if this form is a Nested Wizard, FALSE otherwise
      */
     get isNestedWizard() {
         return this.subForm?._form?.display === 'wizard' && this.parent?.parent?._form?.display === 'wizard';

package/lib/mjs/components/hidden/Hidden.d.ts

@@ -8,17 +8,7 @@ export default class HiddenComponent extends Input {
         showPreview: boolean;
         schema: any;
     };
-    get inputInfo(): {
-        type: string;
-        component: any;
-        changeEvent: string;
-        attr: {
-            name: any;
-            type: any;
-            class: string;
-            lang: any;
-        };
-    };
+    get inputInfo(): any;
     labelIsHidden(): boolean;
     get emptyValue(): string;
     setValue(value: any, flags?: {}): boolean;

package/lib/mjs/components/hidden/Hidden.form.d.ts

@@ -1,3 +1,6 @@
-export default function _default(...extend: any[]): {
-    components: any;
-};
+/**
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
+ */
+export default function _default(...extend: any[]): import('@formio/core').Component[];

package/lib/mjs/components/hidden/Hidden.form.js

@@ -1,6 +1,11 @@
 import Components from '../Components';
 import HiddenEditDisplay from './editForm/Hidden.edit.display';
 import HiddenEditData from './editForm/Hidden.edit.data';
+/**
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
+ */
 export default function (...extend) {
     return Components.baseEditForm([
         {

package/lib/mjs/components/hidden/Hidden.js

@@ -33,8 +33,7 @@ export default class HiddenComponent extends Input {
     }
     /**
      * Check if a component is eligible for multiple validation
-     *
-     * @return {boolean}
+     * @returns {boolean} - If the component is eligible for multiple validation.
      */
     validateMultiple() {
         // Since "arrays" are able to be stored in hidden components, we need to turn off multiple validation.

package/lib/mjs/components/html/HTML.d.ts

@@ -13,7 +13,8 @@ export default class HTMLComponent extends Component {
     get singleTags(): string[];
     checkRefreshOn(changed: any): void;
     renderContent(): any;
-    render(): any;
+    render(): string;
     get dataReady(): any;
+    attach(element: any): Promise<void>;
 }
 import Component from '../_classes/component/Component';

package/lib/mjs/components/html/HTML.form.d.ts

@@ -1,3 +1,6 @@
-export default function _default(...extend: any[]): {
-    components: any;
-};
+/**
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
+ */
+export default function _default(...extend: any[]): import('@formio/core').Component[];

package/lib/mjs/components/html/HTML.form.js

@@ -1,6 +1,11 @@
 import Components from '../Components';
 import HTMLEditDisplay from './editForm/HTML.edit.display';
 import HTMLEditLogic from './editForm/HTML.edit.logic';
+/**
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
+ */
 export default function (...extend) {
     return Components.baseEditForm([
         {

package/lib/mjs/components/number/Number.d.ts

@@ -10,35 +10,20 @@ export default class NumberComponent extends Input {
     static get serverConditionSettings(): {
         operators: any[];
         valueComponent(classComp: any): any;
-        constructor: Function;
-        toString(): string;
-        toLocaleString(): string;
-        valueOf(): Object;
-        hasOwnProperty(v: PropertyKey): boolean;
-        isPrototypeOf(v: Object): boolean;
-        propertyIsEnumerable(v: PropertyKey): boolean;
     };
     static get conditionOperatorsSettings(): {
         operators: any[];
         valueComponent(classComp: any): any;
-        constructor: Function;
-        toString(): string;
-        toLocaleString(): string;
-        valueOf(): Object;
-        hasOwnProperty(v: PropertyKey): boolean;
-        isPrototypeOf(v: Object): boolean;
-        propertyIsEnumerable(v: PropertyKey): boolean;
     };
     static savedValueTypes(schema: any): string[];
     constructor(...args: any[]);
     decimalSeparator: any;
     delimiter: any;
-    decimalLimit: any;
+    decimalLimit: number;
     numberMask: any;
     /**
      * Creates the number mask for normal numbers.
-     *
-     * @return {*}
+     * @returns {*} - The number mask.
      */
     createNumberMask(): any;
     isDecimalAllowed(): any;
@@ -49,5 +34,6 @@ export default class NumberComponent extends Input {
     parseValue(input: any): number;
     focus(): void;
     getMaskedValue(value: any): any;
+    getValueAsString(value: any, options: any): any;
 }
 import Input from '../_classes/input/Input';

package/lib/mjs/components/number/Number.form.d.ts

@@ -1,3 +1,6 @@
-export default function _default(...extend: any[]): {
-    components: any;
-};
+/**
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
+ */
+export default function _default(...extend: any[]): import('@formio/core').Component[];

package/lib/mjs/components/number/Number.form.js

@@ -2,6 +2,11 @@ import textEditForm from '../textfield/TextField.form';
 import NumberEditDisplay from './editForm/Number.edit.display';
 import NumberEditData from './editForm/Number.edit.data';
 import NumberEditValidation from './editForm/Number.edit.validation';
+/**
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
+ */
 export default function (...extend) {
     return textEditForm([
         {

package/lib/mjs/components/number/Number.js

@@ -70,8 +70,7 @@ export default class NumberComponent extends Input {
     }
     /**
      * Creates the number mask for normal numbers.
-     *
-     * @return {*}
+     * @returns {*} - The number mask.
      */
     createNumberMask() {
         return createNumberMask({

package/lib/mjs/components/panel/Panel.form.d.ts

@@ -1,3 +1,6 @@
-export default function _default(...extend: any[]): {
-    components: any;
-};
+/**
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
+ */
+export default function _default(...extend: any[]): import('@formio/core').Component[];

package/lib/mjs/components/panel/Panel.form.js

@@ -1,6 +1,11 @@
 import nestedComponentForm from '../_classes/nested/NestedComponent.form';
 import PanelEditDisplay from './editForm/Panel.edit.display';
 import PanelEditConditional from './editForm/Panel.edit.conditional';
+/**
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
+ */
 export default function (...extend) {
     return nestedComponentForm([
         {

package/lib/mjs/components/panel/Panel.js

@@ -1,6 +1,5 @@
 import NestedComponent from '../_classes/nested/NestedComponent';
 import { isChildOf } from '../../utils/utils';
-import FormComponent from '../form/Form';
 export default class PanelComponent extends NestedComponent {
     static schema(...extend) {
         return NestedComponent.schema({

package/lib/mjs/components/password/Password.form.d.ts

@@ -1,3 +1,6 @@
-export default function _default(...extend: any[]): {
-    components: any;
-};
+/**
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
+ */
+export default function _default(...extend: any[]): import('@formio/core').Component[];

package/lib/mjs/components/password/Password.form.js

@@ -2,6 +2,11 @@ import textEditForm from '../textfield/TextField.form';
 import PasswordEditDisplay from './editForm/Password.edit.display';
 import PasswordEditData from './editForm/Password.edit.data';
 import PasswordEditValidation from './editForm/Password.edit.validation';
+/**
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
+ */
 export default function (...extend) {
     return textEditForm([
         {

package/lib/mjs/components/phonenumber/PhoneNumber.form.d.ts

@@ -1,3 +1,6 @@
-export default function _default(...extend: any[]): {
-    components: any;
-};
+/**
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
+ */
+export default function _default(...extend: any[]): import('@formio/core').Component[];

package/lib/mjs/components/phonenumber/PhoneNumber.form.js

@@ -1,5 +1,10 @@
 import textEditForm from '../textfield/TextField.form';
 import PhoneNumberEditValidation from './editForm/PhoneNumber.edit.validation';
+/**
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
+ */
 export default function (...extend) {
     return textEditForm([
         {

package/lib/mjs/components/radio/Radio.d.ts

@@ -17,13 +17,6 @@ export default class RadioComponent extends ListComponent {
                 custom(): any;
             };
         };
-        constructor: Function;
-        toString(): string;
-        toLocaleString(): string;
-        valueOf(): Object;
-        hasOwnProperty(v: PropertyKey): boolean;
-        isPrototypeOf(v: Object): boolean;
-        propertyIsEnumerable(v: PropertyKey): boolean;
     };
     static get serverConditionSettings(): {
         valueComponent(classComp: any): {
@@ -35,28 +28,11 @@ export default class RadioComponent extends ListComponent {
                 custom: string;
             };
         };
-        constructor: Function;
-        toString(): string;
-        toLocaleString(): string;
-        valueOf(): Object;
-        hasOwnProperty(v: PropertyKey): boolean;
-        isPrototypeOf(v: Object): boolean;
-        propertyIsEnumerable(v: PropertyKey): boolean;
     };
     static savedValueTypes(schema: any): any[];
     constructor(component: any, options: any, data: any);
     previousValue: any;
-    get inputInfo(): {
-        type: string;
-        component: any;
-        changeEvent: string;
-        attr: {
-            name: any;
-            type: any;
-            class: string;
-            lang: any;
-        };
-    };
+    get inputInfo(): any;
     get emptyValue(): string;
     get isRadio(): boolean;
     get optionSelectedClass(): string;
@@ -67,7 +43,8 @@ export default class RadioComponent extends ListComponent {
     itemsLoadedResolve: ((value: any) => void) | undefined;
     optionsLoaded: boolean | undefined;
     loadedOptions: any[] | undefined;
-    render(): any;
+    render(): import("../_classes/field/Field").default;
+    attach(element: any): Promise<void>;
     detach(element: any): void;
     validateValueProperty(): boolean;
     validateValueAvailability(setting: any, value: any): boolean;

package/lib/mjs/components/radio/Radio.form.d.ts

@@ -1,3 +1,6 @@
-export default function _default(...extend: any[]): {
-    components: any;
-};
+/**
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
+ */
+export default function _default(...extend: any[]): import('@formio/core').Component[];

package/lib/mjs/components/radio/Radio.form.js

@@ -2,6 +2,11 @@ import listComponentForm from '../_classes/list/ListComponent.form';
 import RadioEditData from './editForm/Radio.edit.data';
 import RadioEditDisplay from './editForm/Radio.edit.display';
 import RadioEditValidation from './editForm/Radio.edit.validation';
+/**
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
+ */
 export default function (...extend) {
     return listComponentForm([
         {

package/lib/mjs/components/radio/Radio.js

@@ -200,7 +200,8 @@ export default class RadioComponent extends ListComponent {
         if (this.viewOnly || !this.refs.input || !this.refs.input.length) {
             return this.dataValue;
         }
-        let value = this.dataValue;
+        // If the input type of the component is checkbox the value should be determined by the checkboxes checked property
+        let value = this.component.inputType === 'checkbox' ? '' : this.dataValue;
         this.refs.input.forEach((input, index) => {
             if (input.checked) {
                 value = (this.isSelectURL && _.isObject(this.loadedOptions[index].value)) ?
@@ -322,7 +323,7 @@ export default class RadioComponent extends ListComponent {
             const value = this.dataValue;
             this.refs.wrapper.forEach((wrapper, index) => {
                 const input = this.refs.input[index];
-                const checked = (input.type === 'checkbox') ? value[input.value] : (input.value.toString() === value.toString());
+                const checked = (input.type === 'checkbox') ? value[input.value] || input.checked : (input.value.toString() === value.toString());
                 if (checked) {
                     //add class to container when selected
                     this.addClass(wrapper, this.optionSelectedClass);
@@ -359,10 +360,9 @@ export default class RadioComponent extends ListComponent {
         return changed;
     }
     /**
-     * Normalize values coming into updateValue.
-     *
-     * @param value
-     * @return {*}
+     * Normalize values coming into updateValue. For example, depending on the configuration, string value `"true"` will be normalized to boolean `true`.
+     * @param {*} value - The value to normalize
+     * @returns {*} - Returns the normalized value
      */
     normalizeValue(value) {
         const dataType = this.component.dataType || 'auto';

package/lib/mjs/components/recaptcha/ReCaptcha.d.ts

@@ -1,7 +1,7 @@
 export default class ReCaptchaComponent extends Component {
     static get builderInfo(): {};
     static savedValueTypes(): never[];
-    render(): any;
+    render(): string;
     recaptchaResult: any;
     createInput(): void;
     recaptchaApiReady: any;

package/lib/mjs/components/recaptcha/ReCaptcha.form.d.ts

@@ -1,3 +1,6 @@
-export default function _default(...extend: any[]): {
-    components: any;
-};
+/**
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
+ */
+export default function _default(...extend: any[]): import('@formio/core').Component[];

package/lib/mjs/components/recaptcha/ReCaptcha.form.js

@@ -1,5 +1,10 @@
 import Components from '../Components';
 import ReCaptchaEditDisplay from './editForm/ReCaptcha.edit.display';
+/**
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
+ */
 export default function (...extend) {
     return Components.baseEditForm([
         {