@formio/js 5.0.0-dev.5896.56bf2bd → 5.0.0-dev.5902.1eb1690

package/lib/mjs/components/Components.js

@@ -1,7 +1,6 @@
 import Component from './_classes/component/Component';
 import EditFormUtils from './_classes/component/editForm/utils';
 import BaseEditForm from './_classes/component/Component.form';
-import { getComponentKey, getModelType } from '../utils/utils';
 import _ from 'lodash';
 export default class Components {
     static _editFormUtils = EditFormUtils;
@@ -46,34 +45,6 @@ export default class Components {
     static setComponent(name, comp) {
         Components.components[name] = comp;
     }
-    /**
-     * Return a path of component's value.
-     * @param {Component} component - The component instance.
-     * @returns {string} - The component's value path.
-     */
-    static getComponentPath(component) {
-        let path = '';
-        const componentKey = getComponentKey(component.component);
-        if (componentKey) {
-            let thisPath = component.options?.parent || component;
-            while (thisPath && !thisPath.allowData && thisPath.parent) {
-                thisPath = thisPath.parent;
-            }
-            // TODO: any component that is nested in e.g. a Data Grid or an Edit Grid is going to receive a row prop; the problem
-            // is that options.row is passed to each further nested component, which results in erroneous paths like
-            // `editGrid[0].container[0].textField` rather than `editGrid[0].container.textField`. This should be adapted for other
-            // components with a tree-like data model
-            const rowIndex = component.row;
-            const rowIndexPath = rowIndex && !['container'].includes(thisPath.component.type) ? `[${Number.parseInt(rowIndex)}]` : '';
-            path = `${thisPath.path}${rowIndexPath}.`;
-            if (rowIndexPath && getModelType(thisPath) === 'nestedDataArray') {
-                path = `${path}data.`;
-            }
-            path += componentKey;
-            return _.trim(path, '.');
-        }
-        return path;
-    }
     static create(component, options, data) {
         let comp = null;
         if (component.type && Components.components.hasOwnProperty(component.type)) {
@@ -98,9 +69,7 @@ export default class Components {
         else {
             comp = new Component(component, options, data);
         }
-        const path = Components.getComponentPath(comp);
-        if (path) {
-            comp.path = path;
+        if (comp.path) {
             comp.componentsMap[comp.path] = comp;
         }
         return comp;

package/lib/mjs/components/_classes/component/Component.d.ts

@@ -42,14 +42,13 @@ declare class Component extends Element {
      */
     private _hasCondition;
     /**
-     * References to dom elements
+     * The row index for this component.
      */
-    refs: {};
+    _rowIndex: number | undefined;
     /**
-     * The data path to this specific component instance.
-     * @type {string}
+     * References to dom elements
      */
-    path: string;
+    refs: {};
     /**
      * An array of all the children components errors.
      */
@@ -114,7 +113,19 @@ declare class Component extends Element {
      * @type {Component}
      */
     parent: Component;
+    /**
+     * The component paths for this component.
+     * @type {import('@formio/core').ComponentPaths} - The component paths.
+     */
+    paths: import('@formio/core').ComponentPaths;
     _path: string;
+    /**
+     * Determines if this component is conditionally hidden. Should generally not be set outside of conditional logic pipeline.
+     * This is necessary because of clearOnHide behavior that only clears when conditionally hidden - we need to track
+     * conditionallyHidden separately from "regular" visibility.
+     */
+    _parentConditionallyHidden: any;
+    _conditionallyHidden: any;
     /**
      * Determines if this component is visible, or not.
      */
@@ -158,7 +169,7 @@ declare class Component extends Element {
      * @type {*}
      */
     info: any;
-    get componentsMap(): any;
+    get componentsMap(): object;
     set data(value: any);
     get data(): any;
     mergeSchema(component?: {}): any;
@@ -182,6 +193,17 @@ declare class Component extends Element {
      * @returns {boolean} - TRUE if the component is disabled.
      */
     get disabled(): boolean;
+    /**
+     * Set Row Index to row and update each component.
+     * @param {number} value - The row index.
+     * @returns {void}
+     */
+    set rowIndex(value: number);
+    /**
+     * Get Row Index.
+     * @returns {number} - The row index.
+     */
+    get rowIndex(): number;
     afterComponentAssign(): void;
     createAddon(addonConfiguration: any): any;
     get shouldDisabled(): any;
@@ -190,6 +212,8 @@ declare class Component extends Element {
     get hasInput(): any;
     get defaultSchema(): any;
     get key(): any;
+    set path(path: string | undefined);
+    get path(): string | undefined;
     set parentVisible(value: any);
     get parentVisible(): any;
     set parentDisabled(value: boolean);
@@ -207,12 +231,20 @@ declare class Component extends Element {
      * @returns {boolean} - Whether the component is visible or not.
      */
     get visible(): boolean;
+    get conditionallyHidden(): any;
+    /**
+     * Evaluates whether the component is conditionally hidden (as opposed to intentionally hidden, e.g. via the `hidden` component schema property).
+     * @param {object} data - The data object to evaluate the condition against.
+     * @param {object} row - The row object to evaluate the condition against.
+     * @returns {boolean} - Whether the component is conditionally hidden.
+     */
+    checkConditionallyHidden(data?: object, row?: object): boolean;
     set currentForm(instance: any);
     get currentForm(): any;
     _currentForm: any;
     get fullMode(): boolean;
     get builderMode(): boolean;
-    get calculatedPath(): string;
+    get calculatedPath(): string | undefined;
     get labelPosition(): any;
     get labelWidth(): any;
     get labelMargin(): any;

package/lib/mjs/components/_classes/component/Component.js

@@ -6,7 +6,7 @@ import isMobile from 'ismobilejs';
 import { processOne, processOneSync, validateProcessInfo } from '@formio/core/process';
 import { Formio } from '../../../Formio';
 import * as FormioUtils from '../../../utils/utils';
-import { fastCloneDeep, boolValue, getComponentPath, isInsideScopingComponent, currentTimezone, getScriptPlugin } from '../../../utils/utils';
+import { fastCloneDeep, boolValue, isInsideScopingComponent, currentTimezone, getScriptPlugin, getContextualRowData } from '../../../utils/utils';
 import Element from '../../../Element';
 import ComponentModal from '../componentModal/ComponentModal';
 import Widgets from '../../../widgets';
@@ -221,6 +221,10 @@ export default class Component extends Element {
          * @private
          */
         this._hasCondition = null;
+        /**
+         * The row index for this component.
+         */
+        this._rowIndex = undefined;
         /**
          * References to dom elements
          */
@@ -231,11 +235,6 @@ export default class Component extends Element {
             this.options.components[component.type]) {
             _.merge(component, this.options.components[component.type]);
         }
-        /**
-         * The data path to this specific component instance.
-         * @type {string}
-         */
-        this.path = component?.key || '';
         /**
          * An array of all the children components errors.
          */
@@ -304,15 +303,30 @@ export default class Component extends Element {
          * @type {Component}
          */
         this.parent = this.options.parent;
+        /**
+         * The component paths for this component.
+         * @type {import('@formio/core').ComponentPaths} - The component paths.
+         */
+        this.paths = FormioUtils.getComponentPaths(this.component, this.parent?.component, {
+            ...this.parent?.paths,
+            dataIndex: this.options.rowIndex === undefined ? this.parent?.paths?.dataIndex : this.options.rowIndex
+        });
         this.options.name = this.options.name || 'data';
         this._path = '';
         // Needs for Nextgen Rules Engine
         this.resetCaches();
+        /**
+         * Determines if this component is conditionally hidden. Should generally not be set outside of conditional logic pipeline.
+         * This is necessary because of clearOnHide behavior that only clears when conditionally hidden - we need to track
+         * conditionallyHidden separately from "regular" visibility.
+         */
+        this._parentConditionallyHidden = this.options.hasOwnProperty('parentConditionallyHidden') ? this.options.parentConditionallyHidden : false;
+        this._conditionallyHidden = this.checkConditionallyHidden(null, data) || this._parentConditionallyHidden;
         /**
          * Determines if this component is visible, or not.
          */
         this._parentVisible = this.options.hasOwnProperty('parentVisible') ? this.options.parentVisible : true;
-        this._visible = this._parentVisible && this.conditionallyVisible(null, data);
+        this._visible = this._parentVisible && (this.hasCondition() ? !this._conditionallyHidden : !this.component.hidden);
         this._parentDisabled = false;
         /**
          * The reference attribute name for this component
@@ -381,7 +395,7 @@ export default class Component extends Element {
             if (this.allowData && this.key) {
                 this.options.name += `[${this.key}]`;
                 // If component is visible or not set to clear on hide, set the default value.
-                if (this.visible || !this.component.clearOnHide) {
+                if (!(this.conditionallyHidden && this.component.clearOnHide)) {
                     if (!this.hasValue()) {
                         if (this.shouldAddDefaultValue) {
                             this.dataValue = this.defaultValue;
@@ -409,12 +423,7 @@ export default class Component extends Element {
     }
     /* eslint-enable max-statements */
     get componentsMap() {
-        if (this.localRoot?.childComponentsMap) {
-            return this.localRoot.childComponentsMap;
-        }
-        const localMap = {};
-        localMap[this.path] = this;
-        return localMap;
+        return this.root?.childComponentsMap || {};
     }
     get data() {
         return this._data;
@@ -455,11 +464,31 @@ export default class Component extends Element {
     }
     init() {
         this.disabled = this.shouldDisabled;
-        this._visible = this.conditionallyVisible(null, null);
+        this._conditionallyHidden = this.checkConditionallyHidden();
+        this._visible = (this.hasCondition() ? !this.conditionallyHidden : !this.component.hidden);
         if (this.component.addons?.length) {
             this.component.addons.forEach((addon) => this.createAddon(addon));
         }
     }
+    /**
+     * Get Row Index.
+     * @returns {number} - The row index.
+     */
+    get rowIndex() {
+        return this._rowIndex;
+    }
+    /**
+     * Set Row Index to row and update each component.
+     * @param {number} value - The row index.
+     * @returns {void}
+     */
+    set rowIndex(value) {
+        this.paths = FormioUtils.getComponentPaths(this.component, this.parent?.component, {
+            ...(this.parent?.paths || {}),
+            ...{ dataIndex: value }
+        });
+        this._rowIndex = value;
+    }
     afterComponentAssign() {
         //implement in extended classes
     }
@@ -528,6 +557,12 @@ export default class Component extends Element {
     get key() {
         return _.get(this.component, 'key', '');
     }
+    get path() {
+        return this.paths.dataPath;
+    }
+    set path(path) {
+        throw new Error('Should not be setting the path of a component.');
+    }
     set parentVisible(value) {
         this._parentVisible = value;
     }
@@ -573,7 +608,6 @@ export default class Component extends Element {
                 return;
             }
             this._visible = value;
-            this.clearOnHide();
             this.redraw();
         }
     }
@@ -594,6 +628,21 @@ export default class Component extends Element {
         }
         return this._visible && this._parentVisible;
     }
+    get conditionallyHidden() {
+        return this._conditionallyHidden || this._parentConditionallyHidden;
+    }
+    /**
+     * Evaluates whether the component is conditionally hidden (as opposed to intentionally hidden, e.g. via the `hidden` component schema property).
+     * @param {object} data - The data object to evaluate the condition against.
+     * @param {object} row - The row object to evaluate the condition against.
+     * @returns {boolean} - Whether the component is conditionally hidden.
+     */
+    checkConditionallyHidden(data = null, row = null) {
+        if (!this.hasCondition()) {
+            return false;
+        }
+        return !this.conditionallyVisible(data, row);
+    }
     get currentForm() {
         return this._currentForm;
     }
@@ -1246,7 +1295,7 @@ export default class Component extends Element {
         if (refreshData === 'data') {
             this.refresh(this.data, changed, flags);
         }
-        else if ((changePath && getComponentPath(changed.instance) === refreshData) && changed && changed.instance &&
+        else if ((changePath && (changed.instance?.paths?.localPath === refreshData)) && changed && changed.instance &&
             // Make sure the changed component is not in a different "context". Solves issues where refreshOn being set
             // in fields inside EditGrids could alter their state from other rows (which is bad).
             this.inContext(changed.instance)) {
@@ -1764,7 +1813,7 @@ export default class Component extends Element {
     rebuild() {
         this.destroy();
         this.init();
-        this.visible = this.conditionallyVisible(null, null);
+        this.visible = this.hasCondition() ? !this.conditionallyHidden : !this.component.hidden;
         return this.redraw();
     }
     /**
@@ -1831,8 +1880,8 @@ export default class Component extends Element {
     conditionallyVisible(data, row) {
         data = data || this.rootValue;
         row = row || this.data;
-        if (this.builderMode || this.previewMode || !this.hasCondition()) {
-            return !this.component.hidden;
+        if (this.builderMode || this.previewMode) {
+            return true;
         }
         data = data || (this.root ? this.root.data : {});
         return this.checkCondition(row, data);
@@ -1862,8 +1911,14 @@ export default class Component extends Element {
         if (!this.builderMode & !this.previewMode && this.fieldLogic(data, row)) {
             this.redraw();
         }
-        // Check advanced conditions
-        const visible = this.conditionallyVisible(data, row);
+        // Check advanced conditions (and cache the result)
+        const isConditionallyHidden = this.checkConditionallyHidden(data, row) || this._parentConditionallyHidden;
+        if (isConditionallyHidden !== this._conditionallyHidden) {
+            this._conditionallyHidden = isConditionallyHidden;
+            this.clearOnHide();
+        }
+        // Check visibility
+        const visible = (this.hasCondition() ? !this.conditionallyHidden : !this.component.hidden);
         if (this.visible !== visible) {
             this.visible = visible;
         }
@@ -1973,6 +2028,12 @@ export default class Component extends Element {
                     FormioUtils.setActionProperty(newComponent, action, result, row, data, this);
                     const property = action.property.value;
                     if (!_.isEqual(_.get(this.component, property), _.get(newComponent, property))) {
+                        // Advanced Logic can modify the component's hidden property; because we track conditionally hidden state
+                        // separately from the component's hidden property, and technically this Advanced Logic conditionally hides
+                        // a component, we need to set _conditionallyHidden to the new value
+                        if (property === 'hidden') {
+                            this._conditionallyHidden = newComponent.hidden;
+                        }
                         changed = true;
                     }
                     break;
@@ -1986,7 +2047,7 @@ export default class Component extends Element {
                         component: newComponent,
                         result,
                     });
-                    if (!_.isEqual(oldValue, newValue) && !(this.component.clearOnHide && !this.visible)) {
+                    if (!_.isEqual(oldValue, newValue) && !(this.component.clearOnHide && this.conditionallyHidden)) {
                         this.setValue(newValue);
                         if (this.viewOnly) {
                             this.dataValue = newValue;
@@ -2019,7 +2080,7 @@ export default class Component extends Element {
                         component: newComponent,
                         result,
                     }, 'value');
-                    if (!_.isEqual(oldValue, newValue) && !(this.component.clearOnHide && !this.visible)) {
+                    if (!_.isEqual(oldValue, newValue) && !(this.component.clearOnHide && this.conditionallyHidden)) {
                         this.setValue(newValue);
                         if (this.viewOnly) {
                             this.dataValue = newValue;
@@ -2130,7 +2191,7 @@ export default class Component extends Element {
             this.component.clearOnHide !== false &&
             !this.options.readOnly &&
             !this.options.showHiddenFields) {
-            if (!this.visible) {
+            if (this.conditionallyHidden) {
                 this.deleteValue();
             }
             else if (!this.hasValue() && this.shouldAddDefaultValue) {
@@ -2392,7 +2453,7 @@ export default class Component extends Element {
      */
     get dataValue() {
         if (!this.key ||
-            (!this.visible && this.component.clearOnHide && !this.rootPristine)) {
+            (this.conditionallyHidden && this.component.clearOnHide && !this.rootPristine)) {
             return this.emptyValue;
         }
         if (!this.hasValue() && this.shouldAddDefaultValue) {
@@ -2411,7 +2472,7 @@ export default class Component extends Element {
     set dataValue(value) {
         if (!this.allowData ||
             !this.key ||
-            (!this.visible && this.component.clearOnHide && !this.rootPristine)) {
+            (this.conditionallyHidden && this.component.clearOnHide && !this.rootPristine)) {
             return;
         }
         if ((value !== null) && (value !== undefined)) {
@@ -2482,7 +2543,7 @@ export default class Component extends Element {
             }
             return value;
         };
-        if (this.defaultMask) {
+        if (Array.isArray(this.defaultMask) ? this.defaultMask.length > 0 : this.defaultMask) {
             if (Array.isArray(defaultValue)) {
                 defaultValue = defaultValue.map(checkMask);
             }
@@ -2731,7 +2792,7 @@ export default class Component extends Element {
         // If no calculated value or
         // hidden and set to clearOnHide (Don't calculate a value for a hidden field set to clear when hidden)
         const { clearOnHide } = this.component;
-        const shouldBeCleared = !this.visible && clearOnHide;
+        const shouldBeCleared = this.conditionallyHidden && clearOnHide;
         const allowOverride = _.get(this.component, 'allowCalculateOverride', false);
         if (shouldBeCleared) {
             // remove calculated value so that the value is recalculated once component becomes visible
@@ -2857,6 +2918,9 @@ export default class Component extends Element {
      * @returns {string} - The message to show when the component is invalid.
      */
     invalidMessage(data, dirty, ignoreCondition, row) {
+        if (!row) {
+            row = getContextualRowData(this.component, data, this.paths);
+        }
         if (!ignoreCondition && !this.checkCondition(row, data)) {
             return '';
         }
@@ -2874,6 +2938,8 @@ export default class Component extends Element {
             data,
             row,
             path: this.path || this.component.key,
+            parent: this.parent?.component,
+            paths: this.paths,
             scope: validationScope,
             instance: this,
             processors: [
@@ -2926,7 +2992,7 @@ export default class Component extends Element {
         if (flags.silentCheck) {
             return [];
         }
-        let isDirty = this.dirty || flags.dirty;
+        let isDirty = (flags.dirty === false) ? false : (this.dirty || flags.dirty);
         if (this.options.alwaysDirty) {
             isDirty = true;
         }
@@ -2951,7 +3017,10 @@ export default class Component extends Element {
             component: this.component,
             data,
             row,
+            local: !!flags.local,
             value: this.validationValue,
+            parent: this.parent?.component,
+            paths: this.paths,
             path: this.path || this.component.key,
             instance: this,
             form: this.root ? this.root._form : {},
@@ -3214,12 +3283,6 @@ export default class Component extends Element {
         return (this.component.protected || !this.component.persistent || (this.component.persistent === 'client-only'));
     }
     shouldSkipValidation(data, row, flags = {}) {
-        const { validateWhenHidden = false } = this.component || {};
-        const forceValidOnHidden = (!this.visible || !this.checkCondition(row, data)) && !validateWhenHidden;
-        if (forceValidOnHidden) {
-            // If this component is forced valid when it is hidden, then we also need to reset the errors for this component.
-            this._errors = [];
-        }
         const rules = [
             // Do not validate if the flags say not too.
             () => flags.noValidate,
@@ -3230,7 +3293,14 @@ export default class Component extends Element {
             // Check to see if we are editing and if so, check component persistence.
             () => this.isValueHidden(),
             // Force valid if component is hidden.
-            () => forceValidOnHidden
+            () => {
+                if (!this.component.validateWhenHidden && (!this.visible || !this.checkCondition(row, data))) {
+                    // If this component is forced valid when it is hidden, then we also need to reset the errors for this component.
+                    this._errors = [];
+                    return true;
+                }
+                return false;
+            }
         ];
         return rules.some(pred => pred());
     }
@@ -3367,7 +3437,7 @@ export default class Component extends Element {
                         // If component definition changed, replace it.
                         if (!_.isEqual(this.component, newComponent)) {
                             this.component = newComponent;
-                            const visible = this.conditionallyVisible(null, null);
+                            const visible = this.hasCondition() ? !this.conditionallyHidden : !this.component.hidden;
                             const disabled = this.shouldDisabled;
                             // Change states which won't be recalculated during redrawing
                             if (this.visible !== visible) {

package/lib/mjs/components/_classes/component/editForm/Component.edit.data.js

@@ -128,10 +128,10 @@ export default [
     {
         weight: 700,
         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.',
+        tooltip: 'When a field is conditionally hidden, omit the value from the submission data.',
         input: true
     },
     EditFormUtils.javaScriptValue('Custom Default Value', 'customDefaultValue', 'customDefaultValue', 1000, '<p><h4>Example:</h4><pre>value = data.firstName + " " + data.lastName;</pre></p>', '<p><h4>Example:</h4><pre>{"cat": [{"var": "data.firstName"}, " ", {"var": "data.lastName"}]}</pre>'),

package/lib/mjs/components/_classes/component/editForm/Component.edit.validation.js

@@ -22,7 +22,7 @@ export default [
         weight: 100,
         type: 'checkbox',
         label: 'Validate When Hidden',
-        tooltip: 'Validates the component when it is hidden/conditionally hidden. Vaildation errors are displayed in the error alert on the form submission.',
+        tooltip: 'Validates the component when it is hidden/conditionally hidden. Vaildation errors are displayed in the error alert on the form submission. Use caution when enabling this setting, as it can cause a hidden component to be invalid with no way for the form user to correct it.',
         key: 'validateWhenHidden',
         input: true
     },

package/lib/mjs/components/_classes/componentModal/ComponentModal.d.ts

@@ -22,6 +22,7 @@ export default class ComponentModal {
         modalOverlay: string;
         modalContents: string;
         modalClose: string;
+        componentContent: string;
         openModalWrapper: string;
         openModal: string;
         modalSave: string;

package/lib/mjs/components/_classes/componentModal/ComponentModal.js

@@ -61,6 +61,7 @@ export default class ComponentModal {
             modalOverlay: 'single',
             modalContents: 'single',
             modalClose: 'single',
+            componentContent: 'single',
             openModalWrapper: 'single',
             openModal: 'single',
             modalSave: 'single',

package/lib/mjs/components/_classes/nested/NestedComponent.d.ts

@@ -56,18 +56,6 @@ export default class NestedComponent extends Field {
      * @returns {object} - The current form object.
      */
     get currentForm(): object;
-    /**
-     * Set Row Index to row and update each component.
-     * @param {number} value - The row index.
-     * @returns {void}
-     */
-    set rowIndex(value: number);
-    /**
-     * Get Row Index.
-     * @returns {number} - The row index.
-     */
-    get rowIndex(): number;
-    _rowIndex: number | undefined;
     /**
      * Get Contextual data of the component.
      * @returns {object} - The contextual data of the component.
@@ -115,14 +103,11 @@ export default class NestedComponent extends Field {
      */
     eachComponent(fn: Function): void;
     /**
-     * Returns a component provided a key. This performs a deep search within the
-     * component tree.
+     * Returns a component provided a key. This performs a deep search within the component tree.
      * @param {string} path - The path to the component.
-     * @param {Function} [fn] - Called with the component once found.
-     * @param {string} [originalPath] - The original path to the component.
      * @returns {any} - The component that is located.
      */
-    getComponent(path: string, fn?: Function | undefined, originalPath?: string | undefined): any;
+    getComponent(path: string): any;
     /**
      * Return a component provided the Id of the component.
      * @param {string} id - The Id of the component.
@@ -211,12 +196,12 @@ export default class NestedComponent extends Field {
     calculateValue(data: any, flags: any, row: any): any;
     isLastPage(): boolean;
     isValid(data: any, dirty: any): any;
-    validationProcessor({ scope, data, row, instance, component }: {
+    validationProcessor({ scope, data, row, instance, paths }: {
         scope: any;
         data: any;
         row: any;
         instance: any;
-        component: any;
+        paths: any;
     }, flags: any): void;
     /**
      * Perform a validation on all child components of this nested component.