@formio/js 5.0.2 → 5.1.0-dev.5522.066969f

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

@@ -3,7 +3,7 @@ import _ from 'lodash';
 import Component from '../_classes/component/Component';
 import ComponentModal from '../_classes/componentModal/ComponentModal';
 import EventEmitter from 'eventemitter3';
-import { isMongoId, eachComponent, getStringFromComponentPath, getArrayFromComponentPath, componentValueTypes } from '../../utils/utils';
+import { isMongoId, eachComponent, componentValueTypes } from '../../utils';
 import { Formio } from '../../Formio';
 import Form from '../../Form';
 export default class FormComponent extends Component {
@@ -96,8 +96,11 @@ export default class FormComponent extends Component {
         }
         return this.createSubForm();
     }
+    shouldConditionallyClearOnPristine() {
+        return !this.hasSetValue && super.shouldConditionallyClearOnPristine();
+    }
     get dataReady() {
-        return this.subFormReady || Promise.resolve();
+        return this.subForm?.dataReady || this.subFormReady || Promise.resolve();
     }
     get defaultValue() {
         // Not not provide a default value unless the subform is ready so that it will initialize correctly.
@@ -109,6 +112,10 @@ export default class FormComponent extends Component {
     get emptyValue() {
         return { data: {} };
     }
+    // In order for the subform values to set properly, we must always say that nested forms have a default value.
+    get hasDefaultValue() {
+        return true;
+    }
     get ready() {
         return this.subFormReady || Promise.resolve();
     }
@@ -127,24 +134,19 @@ export default class FormComponent extends Component {
             this.subFormRevision = undefined;
         }
     }
-    getComponent(path, fn) {
-        path = getArrayFromComponentPath(path);
-        if (path[0] === 'data') {
-            path.shift();
-        }
-        const originalPathStr = `${this.path}.data.${getStringFromComponentPath(path)}`;
-        if (this.subForm) {
-            return this.subForm.getComponent(path, fn, originalPathStr);
+    getComponent(path) {
+        if (!this.subForm) {
+            return null;
         }
+        return this.subForm.getComponent(path);
     }
     /* eslint-disable max-statements */
     getSubOptions(options = {}) {
         options.events = this.createEmitter();
         // Make sure to not show the submit button in wizards in the nested forms.
         _.set(options, 'buttonSettings.showSubmit', false);
-        // Set the parent options to the subform so those references are stable when the subform is created
+        // Set the parent option to the subform so those references are stable when the subform is created
         options.parent = this;
-        options.parentVisible = this.visible;
         if (!this.options) {
             return options;
         }
@@ -206,12 +208,13 @@ export default class FormComponent extends Component {
         if (this.options.skipDraftRestore) {
             options.skipDraftRestore = this.options.skipDraftRestore;
         }
+        options.parent = this;
         return options;
     }
     /* eslint-enable max-statements */
     render() {
         if (this.builderMode) {
-            return super.render(this.component.label || 'Nested form');
+            return super.render(this.t(this.component.label || 'nestedForm'));
         }
         const subform = this.subForm ? this.subForm.render() : this.renderTemplate('loading');
         return super.render(subform);
@@ -224,13 +227,13 @@ export default class FormComponent extends Component {
      */
     getValueAsString(value, options) {
         if (!value) {
-            return 'No data provided';
+            return this.t('noDataProvided');
         }
         if (!value.data && value._id) {
             return value._id;
         }
         if (!value.data || !Object.keys(value.data).length) {
-            return 'No data provided';
+            return this.t('noDataProvided');
         }
         if (options?.email) {
             let result = (`
@@ -271,6 +274,9 @@ export default class FormComponent extends Component {
             if (this.isSubFormLazyLoad() && !this.hasLoadedForm && !this.subFormLoading) {
                 this.createSubForm(true);
             }
+            if (!this.subFormReady) {
+                return Promise.resolve();
+            }
             return this.subFormReady.then(() => {
                 this.empty(element);
                 if (this.options.builder) {
@@ -286,17 +292,20 @@ export default class FormComponent extends Component {
                     }
                     this.subForm.attach(element);
                     this.valueChanged = this.hasSetValue;
-                    if (!this.valueChanged && this.dataValue.state !== 'submitted') {
-                        this.setDefaultValue();
-                    }
-                    else {
-                        this.restoreValue();
+                    if (!this.shouldConditionallyClear()) {
+                        if (!this.valueChanged && this.dataValue.state !== 'submitted') {
+                            this.setDefaultValue();
+                        }
+                        else {
+                            this.restoreValue();
+                        }
                     }
                 }
                 if (!this.builderMode && this.component.modalEdit) {
                     const modalShouldBeOpened = this.componentModal ? this.componentModal.isOpened : false;
                     const currentValue = modalShouldBeOpened ? this.componentModal.currentValue : this.dataValue;
                     this.componentModal = new ComponentModal(this, element, modalShouldBeOpened, currentValue, this._referenceAttributeName);
+                    this.subForm.element = this.componentModal.refs.componentContent || this.subForm.element;
                     this.setOpenModalElement();
                 }
                 this.calculateValue();
@@ -332,6 +341,9 @@ export default class FormComponent extends Component {
             && _.isNumber(this.formObj._vid)
             && this.formObj._vid !== this.subFormRevision;
     }
+    get subFormData() {
+        return this.dataValue?.data || {};
+    }
     destroy(all = false) {
         if (this.subForm) {
             this.subForm.destroy(all);
@@ -375,10 +387,11 @@ export default class FormComponent extends Component {
     /**
      * Create a subform instance.
      * @param {boolean} [fromAttach] - This function is being called from an `attach` method.
+     * @param {boolean} [beforeSubmit] - This function is being called from a `beforeSubmit` method.
      * @returns {*} - The subform instance.
      */
-    createSubForm(fromAttach) {
-        this.subFormReady = this.loadSubForm(fromAttach).then((form) => {
+    createSubForm(fromAttach, beforeSubmit) {
+        this.subFormReady = this.loadSubForm(fromAttach, beforeSubmit).then((form) => {
             if (!form) {
                 return;
             }
@@ -394,8 +407,14 @@ export default class FormComponent extends Component {
             return (new Form(form, this.getSubOptions())).ready.then((instance) => {
                 this.subForm = instance;
                 this.subForm.currentForm = this;
+                this.subForm.parentVisible = this.visible;
+                const componentsMap = this.componentsMap;
+                const formComponentsMap = this.subForm.componentsMap;
+                _.assign(componentsMap, formComponentsMap);
+                this.component.components = this.subForm._form?.components;
+                this.component.display = this.subForm._form?.display;
                 this.subForm.on('change', () => {
-                    if (this.subForm) {
+                    if (this.subForm && !this.shouldConditionallyClear()) {
                         this.dataValue = this.subForm.getValue();
                         this.triggerChange({
                             noEmit: true
@@ -410,6 +429,8 @@ export default class FormComponent extends Component {
                 this.valueChanged = this.hasSetValue;
                 this.onChange();
                 return this.subForm;
+            }).catch((err) => {
+                console.log(err);
             });
         }).then((subForm) => {
             this.updateSubWizards(subForm);
@@ -418,19 +439,22 @@ export default class FormComponent extends Component {
         return this.subFormReady;
     }
     hideSubmitButton(component) {
-        const isSubmitButton = (component.type === 'button') &&
-            ((component.action === 'submit') || !component.action);
+        const isSubmitButton = component.type === 'button' && (component.action === 'submit' || !component.action);
         if (isSubmitButton) {
             component.hidden = true;
+            // clearOnHide no longer clears from the JSON `hidden` flag, so we make the button conditionally hidden to clear its data
+            component.customConditional = 'show = false';
         }
     }
     /**
      * Load the subform.
      * @param {boolean} fromAttach - This function is being called from an `attach` method.
+     * @param {boolean} beforeSubmit - This function is being called from a `beforeSubmit` method.
      * @returns {Promise} - The promise that resolves when the subform is loaded.
      */
-    loadSubForm(fromAttach) {
-        if (this.builderMode || this.isHidden() || (this.isSubFormLazyLoad() && !fromAttach)) {
+    loadSubForm(fromAttach, beforeSubmit) {
+        const loadHiddenForm = beforeSubmit && !this.component.clearOnHide;
+        if (this.builderMode || (this.conditionallyHidden() && !loadHiddenForm) || (this.isSubFormLazyLoad() && !fromAttach)) {
             return Promise.resolve();
         }
         if (this.hasLoadedForm && !this.isRevisionChanged &&
@@ -465,17 +489,6 @@ export default class FormComponent extends Component {
         }
         return Promise.resolve();
     }
-    get subFormData() {
-        return this.dataValue?.data || {};
-    }
-    checkComponentValidity(data, dirty, row, options, errors = []) {
-        options = options || {};
-        const silentCheck = options.silentCheck || false;
-        if (this.subForm) {
-            return this.subForm.checkValidity(this.subFormData, dirty, null, silentCheck, errors);
-        }
-        return super.checkComponentValidity(data, dirty, row, options, errors);
-    }
     checkComponentConditions(data, flags, row) {
         const visible = super.checkComponentConditions(data, flags, row);
         // Return if already hidden
@@ -483,14 +496,14 @@ export default class FormComponent extends Component {
             return visible;
         }
         if (this.subForm) {
-            return this.subForm.checkConditions(this.subFormData);
+            return this.subForm.checkConditions(this.subFormData, flags);
         }
         // There are few cases when subForm is not loaded when a change is triggered,
         // so we need to perform checkConditions after it is ready, or some conditional fields might be hidden in View mode
         else if (this.subFormReady) {
             this.subFormReady.then(() => {
                 if (this.subForm) {
-                    return this.subForm.checkConditions(this.subFormData);
+                    return this.subForm.checkConditions(this.subFormData, flags);
                 }
             });
         }
@@ -513,7 +526,7 @@ export default class FormComponent extends Component {
      * @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();
+        return this.subFormReady && (!this.component.hasOwnProperty('reference') || this.component.reference) && !this.shouldConditionallyClear();
     }
     /**
      * Returns the data for the subform.
@@ -540,7 +553,7 @@ export default class FormComponent extends Component {
                 }
                 this.subForm.nosubmit = false;
                 this.subForm.submitted = true;
-                return this.subForm.submitForm().then(result => {
+                return this.subForm.submitForm({}, true).then(result => {
                     this.subForm.loading = false;
                     this.subForm.showAllErrors = false;
                     this.dataValue = result.submission;
@@ -583,11 +596,19 @@ export default class FormComponent extends Component {
             this.dataValue = submission;
             return Promise.resolve(this.dataValue);
         }
-        return this.submitSubForm(false)
-            .then(() => {
-            return this.dataValue;
-        })
-            .then(() => super.beforeSubmit());
+        // we need to load a hidden form (when clearOnHide is disabled) in order to get and submit (if needed) its data
+        const loadHiddenForm = !this.component.clearOnHide;
+        if ((this.isSubFormLazyLoad() || loadHiddenForm) && !this.subFormLoading && !this.subForm) {
+            return this.createSubForm(true, true)
+                .then(() => this.submitSubForm(false))
+                .then(() => this.dataValue)
+                .then(() => super.beforeSubmit());
+        }
+        else {
+            return this.submitSubForm(false)
+                .then(() => this.dataValue)
+                .then(() => super.beforeSubmit());
+        }
     }
     isSubFormLazyLoad() {
         return this.root?._form?.display === 'wizard' && this.component.lazyLoad;
@@ -636,28 +657,27 @@ export default class FormComponent extends Component {
                 : {};
             this.subForm.setUrl(submissionUrl, { ...this.options, ...options });
             this.subForm.loadSubmission().catch((err) => {
-                console.error(`Unable to load subform submission ${submission._id}:`, err);
+                console.error(this.t('subformSubmissionLoadingError', { submissionId: submission._id }), err);
             });
         }
         else {
-            this.subForm.setValue(submission, flags);
+            this.onSetSubFormValue(submission, flags);
         }
     }
-    isEmpty(value = this.dataValue) {
-        return value === null || _.isEqual(value, this.emptyValue) || (this.areAllComponentsEmpty(value?.data) && !value?._id);
-    }
-    areAllComponentsEmpty(data) {
-        let res = true;
-        if (this.subForm) {
-            this.subForm.everyComponent((comp) => {
-                const componentValue = _.get(data, comp.key);
-                res &= comp.isEmpty(componentValue);
-            });
-        }
-        else {
-            res = false;
+    /**
+     * Sets the subform value
+     * @param {object|null|undefined} submission - The submission to set.
+     * @param {object|null|undefined} flags - Any flags to apply when setting the submission.
+     * @returns {void}
+     */
+    onSetSubFormValue(submission, flags) {
+        this.subForm.setValue(submission, flags);
+        if (flags?.fromSubmission) {
+            this.subForm.submissionReadyResolve(submission);
         }
-        return res;
+    }
+    isEmpty(value = this.dataValue) {
+        return value === null || _.isEqual(value, this.emptyValue);
     }
     getValue() {
         if (this.subForm) {
@@ -672,6 +692,13 @@ export default class FormComponent extends Component {
         }
         return errors;
     }
+    conditionallyHidden() {
+        const conditionallyHidden = super.conditionallyHidden();
+        if (this.subForm) {
+            this.subForm._conditionallyHidden = conditionallyHidden;
+        }
+        return conditionallyHidden;
+    }
     updateSubFormVisibility() {
         if (this.subForm) {
             this.subForm.parentVisible = this.visible;

package/lib/mjs/components/form/editForm/Form.edit.data.js

@@ -6,7 +6,7 @@ export default [
     {
         weight: 140,
         type: 'checkbox',
-        label: 'Clear Value When Hidden',
+        label: 'Omit Value From Submission Data When Conditionally Hidden',
         key: 'clearOnHide',
         defaultValue: true,
         tooltip: 'When a field is hidden, clear the value.',

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

@@ -30,9 +30,10 @@ export default [
         tooltip: 'if it is checked, the subform is loaded after navigation to the page with this component within the wizard.',
         input: true,
         customConditional({ instance, data }) {
-            const formInfo = instance.root?.getComponent('form')?.defaultDownloadedResources.find(res => res._id === data.form);
+            const formComp = instance.root?.getComponent('form');
+            const formInfo = formComp?.defaultDownloadedResources.find(res => res._id === data.form);
             const displayMode = 'wizard';
-            return instance.options?.editForm?.display === displayMode && formInfo && formInfo.display !== displayMode;
+            return instance.options?.editForm?.display === displayMode && ((data.form && !formInfo) || (formInfo && formInfo.display !== displayMode));
         },
     },
     {
@@ -44,7 +45,7 @@ export default [
         },
         searchField: 'title__regex',
         template: '<span>{{ item._vid }}</span>',
-        valueProperty: '_id',
+        valueProperty: 'revisionId',
         authenticate: true,
         label: 'Form Revision',
         key: 'revision',
@@ -66,7 +67,7 @@ export default [
         input: true,
         weight: 20,
         key: 'reference',
-        label: 'Save as reference',
-        tooltip: 'Using this option will save this field as a reference and link its value to the value of the origin record.'
+        label: 'Submit as reference',
+        tooltip: 'When "Submit as reference" is enabled, the form submission will be recorded against the Parent Form as well as the Child Form. When a submission recorded with "Submit as reference" is edited, the update is applied to each submission made against the Parent Form and Child Form.'
     }
 ];

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

@@ -10,7 +10,6 @@ export default class HiddenComponent extends Input {
     };
     get inputInfo(): any;
     labelIsHidden(): boolean;
-    get emptyValue(): string;
     setValue(value: any, flags?: {}): boolean;
 }
 import Input from '../_classes/input/Input';

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

@@ -43,7 +43,7 @@ export default class HiddenComponent extends Input {
         return true;
     }
     get emptyValue() {
-        return '';
+        return null;
     }
     setValue(value, flags = {}) {
         return this.updateValue(value, flags);

package/lib/mjs/components/hidden/editForm/Hidden.edit.display.js

@@ -3,6 +3,14 @@ export default [
         key: 'labelPosition',
         ignore: true
     },
+    {
+        key: 'labelWidth',
+        ignore: true
+    },
+    {
+        key: 'labelMargin',
+        ignore: true
+    },
     {
         key: 'placeholder',
         ignore: true

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

@@ -51,9 +51,20 @@ export default class HTMLComponent extends Component {
     }
     checkRefreshOn(changed) {
         super.checkRefreshOn(changed);
-        if (!this.builderMode && this.component.refreshOnChange && this.element &&
-            !_.isUndefined(changed) && ((_.isBoolean(changed) && changed) || !_.isEmpty(changed)) &&
-            this.conditionallyVisible(this.data, this.row)) {
+        let visible;
+        if (this.hasCondition()) {
+            visible = !this.conditionallyHidden();
+        }
+        else {
+            visible = !this.component.hidden;
+        }
+        const shouldSetContent = !this.builderMode
+            && this.component.refreshOnChange
+            && this.element
+            && !_.isUndefined(changed)
+            && ((_.isBoolean(changed) && changed) || !_.isEmpty(changed))
+            && visible;
+        if (shouldSetContent) {
             this.setContent(this.element, this.renderContent());
         }
     }

package/lib/mjs/components/html/editForm/HTML.edit.display.js

@@ -3,6 +3,14 @@ export default [
         key: 'labelPosition',
         ignore: true
     },
+    {
+        key: 'labelWidth',
+        ignore: true
+    },
+    {
+        key: 'labelMargin',
+        ignore: true
+    },
     {
         key: 'placeholder',
         ignore: true

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

@@ -2,7 +2,7 @@ import { createNumberMask } from '@formio/text-mask-addons';
 import { conformToMask, maskInput } from '@formio/vanilla-text-mask';
 import _ from 'lodash';
 import Input from '../_classes/input/Input';
-import { getNumberSeparators, getNumberDecimalLimit, componentValueTypes, getComponentSavedTypes } from '../../utils/utils';
+import { getNumberSeparators, getNumberDecimalLimit, componentValueTypes, getComponentSavedTypes } from '../../utils/';
 export default class NumberComponent extends Input {
     static schema(...extend) {
         return Input.schema({
@@ -54,7 +54,7 @@ export default class NumberComponent extends Input {
         }
         else {
             if (this.component.thousandsSeparator || this.options.properties?.thousandsSeparator || this.options.thousandsSeparator) {
-                console.warn('In order for thousands separator to work properly, you must set the delimiter to true in the component json');
+                console.warn(this.t('noDelimiterSet'));
             }
             this.delimiter = '';
         }
@@ -168,14 +168,21 @@ export default class NumberComponent extends Input {
         if (typeof input === 'string') {
             input = input.split(this.delimiter).join('').replace(this.decimalSeparator, '.');
         }
-        let value = parseFloat(input);
-        if (!_.isNaN(value)) {
+        let value;
+        if (!_.isNaN(input)) {
             // Format scientific notation
-            if (/e/i.test(String(value))) {
+            if (/[0-9]+[eE]/.test(String(input))) {
+                // Convert to exponential notation will depend on the decimal limit set in the component
+                // Example: 1.23e-5 will be converted to 1.23e-5 if decimal limit is set to 2
+                // Example: 1.23e5 will be converted to 1.23e+5 if decimal limit is set to 2
+                // if decimal limit is 3, 1.23e5 will be converted to 1.230e+5
+                // if decimal limit is not set, 1.23e5 will be converted to 1.23000000000000000000e+5
+                value = parseFloat(input);
                 value = value.toExponential(this.decimalLimit);
             }
             else {
-                value = String(value).replace('.', this.decimalSeparator);
+                value = parseFloat(input);
+                value = !_.isNaN(value) ? String(value).replace('.', this.decimalSeparator) : null;
             }
         }
         else {

package/lib/mjs/components/number/editForm/Number.edit.display.js

@@ -11,6 +11,18 @@ export default [
         key: 'allowMultipleMasks',
         ignore: true
     },
+    {
+        key: 'inputMasks',
+        ignore: true
+    },
+    {
+        key: 'widget.type',
+        ignore: true
+    },
+    {
+        key: 'widget',
+        ignore: true
+    },
     {
         key: 'showWordCount',
         ignore: true,

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

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

package/lib/mjs/components/password/editForm/Password.edit.display.js

@@ -10,5 +10,17 @@ export default [
     {
         key: 'allowMultipleMasks',
         ignore: true
-    }
+    },
+    {
+        key: 'inputMasks',
+        ignore: true
+    },
+    {
+        key: 'widget.type',
+        ignore: true
+    },
+    {
+        key: 'widget',
+        ignore: true
+    },
 ];

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

@@ -17,7 +17,15 @@ export default function (...extend) {
                 {
                     key: 'showCharCount',
                     ignore: true
-                }
+                },
+                {
+                    key: 'widget.type',
+                    ignore: true
+                },
+                {
+                    key: 'widget',
+                    ignore: true
+                },
             ]
         },
         {

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

@@ -28,7 +28,8 @@ export default class RadioComponent extends ListComponent {
     optionsLoaded: boolean | undefined;
     loadedOptions: any[] | undefined;
     beforeSubmit(): Promise<any>;
-    render(): import("../_classes/field/Field").default;
+    convertValues(values: any): any;
+    render(): string;
     attach(element: any): Promise<void>;
     detach(element: any): void;
     validateValueProperty(): boolean;
@@ -41,5 +42,12 @@ export default class RadioComponent extends ListComponent {
     setSelectedClasses(): void;
     updateValue(value: any, flags: any): boolean;
     currentValue: any;
+    /**
+     * 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
+     */
+    convertByDataType(value: any): any;
+    normalizeValue(value: any): any;
 }
 import ListComponent from '../_classes/list/ListComponent';