@formio/js 5.0.0 → 5.1.0-rc.2

package/lib/mjs/components/_classes/nested/NestedComponent.js

@@ -2,7 +2,8 @@
 import _ from 'lodash';
 import Field from '../field/Field';
 import Components from '../../Components';
-import { getArrayFromComponentPath, getStringFromComponentPath, getRandomComponentId } from '../../../utils/utils';
+'';
+import { getComponentPaths, getRandomComponentId, componentMatches, getBestMatch, getStringFromComponentPath } from '../../../utils/utils';
 import { process as processAsync, processSync } from '@formio/core/process';
 /**
  * NestedComponent class.
@@ -80,17 +81,26 @@ export default class NestedComponent extends Field {
         const visibilityChanged = this._visible !== value;
         this._visible = value;
         const isVisible = this.visible;
+        const isConditionallyHidden = this.checkConditionallyHidden();
         const forceShow = this.shouldForceShow();
         const forceHide = this.shouldForceHide();
-        this.components.forEach(component => {
+        this.components.forEach((component) => {
             // Set the parent visibility first since we may have nested components within nested components
             // and they need to be able to determine their visibility based on the parent visibility.
             component.parentVisible = isVisible;
-            const conditionallyVisible = component.conditionallyVisible();
-            if (forceShow || conditionallyVisible) {
+            component._parentConditionallyHidden = isConditionallyHidden;
+            let visible;
+            if (component.hasCondition()) {
+                component._conditionallyHidden = component.checkConditionallyHidden() || component._parentConditionallyHidden;
+                visible = !component.conditionallyHidden;
+            }
+            else {
+                visible = !component.component.hidden;
+            }
+            if (forceShow || visible) {
                 component.visible = true;
             }
-            else if (forceHide || !isVisible || !conditionallyVisible) {
+            else if (forceHide || !isVisible || !visible) {
                 component.visible = false;
             }
             // If hiding a nested component, clear all errors below.
@@ -99,7 +109,6 @@ export default class NestedComponent extends Field {
             }
         });
         if (visibilityChanged) {
-            this.clearOnHide();
             this.redraw();
         }
     }
@@ -198,6 +207,10 @@ export default class NestedComponent extends Field {
      */
     set rowIndex(value) {
         this._rowIndex = value;
+        this.paths = getComponentPaths(this.component, this.parent?.component, {
+            ...(this.parent?.paths || {}),
+            ...{ dataIndex: value }
+        });
         this.eachComponent((component) => {
             component.rowIndex = value;
         });
@@ -293,56 +306,36 @@ export default class NestedComponent extends Field {
         });
     }
     /**
-     * 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, fn, originalPath) {
-        originalPath = originalPath || getStringFromComponentPath(path);
-        if (this.componentsMap.hasOwnProperty(originalPath)) {
-            if (fn) {
-                return fn(this.componentsMap[originalPath]);
-            }
-            else {
-                return this.componentsMap[originalPath];
-            }
-        }
-        path = getArrayFromComponentPath(path);
-        const pathStr = originalPath;
-        const newPath = _.clone(path);
-        let key = newPath.shift();
-        const remainingPath = newPath;
-        let comp = null;
-        let possibleComp = null;
-        if (_.isNumber(key)) {
-            key = remainingPath.shift();
-        }
-        if (!_.isString(key)) {
-            return comp;
-        }
-        this.everyComponent((component, components) => {
-            const matchPath = component.hasInput && component.path ? pathStr.includes(component.path) : true;
-            if (component.component.key === key) {
-                possibleComp = component;
-                if (matchPath) {
-                    comp = component;
-                    if (remainingPath.length > 0 && 'getComponent' in component) {
-                        comp = component.getComponent(remainingPath, fn, originalPath);
-                    }
-                    else if (fn) {
-                        fn(component, components);
-                    }
-                    return false;
-                }
-            }
+    getComponent(path) {
+        path = getStringFromComponentPath(path);
+        const matches = {
+            path: undefined,
+            fullPath: undefined,
+            localPath: undefined,
+            fullLocalPath: undefined,
+            dataPath: undefined,
+            localDataPath: undefined,
+            key: undefined,
+        };
+        this.everyComponent((component) => {
+            // All searches are relative to this component so replace this path from the child paths.
+            componentMatches(component.component, {
+                path: component.paths?.path?.replace(new RegExp(`^${this.paths?.path}\\.?`), ''),
+                fullPath: component.paths?.fullPath?.replace(new RegExp(`^${this.paths?.fullPath}\\.?`), ''),
+                localPath: component.paths?.localPath?.replace(new RegExp(`^${this.paths?.localPath}\\.?`), ''),
+                fullLocalPath: component.paths?.fullLocalPath?.replace(new RegExp(`^${this.paths?.fullLocalPath}\\.?`), ''),
+                dataPath: component.paths?.dataPath?.replace(new RegExp(`^${this.paths?.dataPath}\\.?`), ''),
+                localDataPath: component.paths?.localDataPath?.replace(new RegExp(`^${this.paths?.localDataPath}\\.?`), ''),
+            }, path, this.rowIndex, matches, (type, match) => {
+                match.instance = component;
+                return match;
+            });
         });
-        if (!comp) {
-            comp = possibleComp;
-        }
-        return comp;
+        return getBestMatch(matches)?.instance;
     }
     /**
      * Return a component provided the Id of the component.
@@ -380,6 +373,7 @@ export default class NestedComponent extends Field {
         data = data || this.data;
         options.parent = this;
         options.parentVisible = this.visible;
+        options.parentConditionallyHidden = this.conditionallyHidden;
         options.root = options?.root || this.root || this;
         options.localRoot = this.localRoot;
         options.skipInit = true;
@@ -638,7 +632,7 @@ export default class NestedComponent extends Field {
     clearOnHide(show) {
         super.clearOnHide(show);
         if (this.component.clearOnHide) {
-            if (this.allowData && !this.hasValue() && !(this.options.server && !this.visible)) {
+            if (this.allowData && !this.hasValue() && !this.conditionallyHidden) {
                 this.dataValue = this.defaultValue;
             }
             if (this.hasValue()) {
@@ -667,7 +661,7 @@ export default class NestedComponent extends Field {
     }
     calculateValue(data, flags, row) {
         // Do not iterate into children and calculateValues if this nested component is conditionally hidden.
-        if (!this.conditionallyVisible()) {
+        if (this.conditionallyHidden) {
             return false;
         }
         return this.getComponents().reduce((changed, comp) => comp.calculateValue(data, flags, row) || changed, super.calculateValue(data, flags, row));
@@ -678,19 +672,16 @@ export default class NestedComponent extends Field {
     isValid(data, dirty) {
         return this.getComponents().reduce((valid, comp) => comp.isValid(data, dirty) && valid, super.isValid(data, dirty));
     }
-    validationProcessor({ scope, data, row, instance, component }, flags) {
+    validationProcessor({ scope, data, row, instance, paths }, flags) {
         const { dirty } = flags;
         if (this.root.hasExtraPages && this.page !== this.root.page) {
-            instance = this.childComponentsMap?.hasOwnProperty(component.path)
-                ? this.childComponentsMap[component.path]
-                : this.getComponent(component.path);
+            instance = this.componentsMap?.hasOwnProperty(paths.dataPath)
+                ? this.componentsMap[paths.dataPath]
+                : this.getComponent(paths.dataPath);
         }
         if (!instance) {
             return;
         }
-        if (!instance.component.path) {
-            instance.component.path = component.path;
-        }
         instance.checkComponentValidity(data, dirty, row, flags, scope.errors);
         if (instance.processOwnValidation) {
             scope.noRecurse = true;
@@ -722,7 +713,10 @@ export default class NestedComponent extends Field {
             components,
             instances: this.componentsMap,
             data: data,
+            local: !!flags.local,
             scope: { errors: [] },
+            parent: this.component,
+            parentPaths: this.paths,
             processors: [
                 {
                     process: validationProcessorProcess,

package/lib/mjs/components/_classes/nestedarray/NestedArrayComponent.d.ts

@@ -2,6 +2,8 @@ export default class NestedArrayComponent extends NestedDataComponent {
     static savedValueTypes(): string[];
     componentContext(component: any): any;
     get iteratableRows(): void;
+    set rowIndex(value: number | undefined);
+    get rowIndex(): number | undefined;
     prevHasAddButton: any;
     checkAddButtonChanged(): void;
     checkData(data: any, flags: any, row: any): any;
@@ -10,7 +12,6 @@ export default class NestedArrayComponent extends NestedDataComponent {
     checkRow(...args: any[]): any;
     processRow(method: any, data: any, opts: any, row: any, components: any, silentCheck: any): any;
     hasAddButton(): any;
-    getComponent(path: any, fn: any, originalPath: any): any;
     everyComponent(fn: any, rowIndex: any, options?: {}): void;
     getComponents(rowIndex: any): any;
     removeSubmissionMetadataRow(index: any): void;

package/lib/mjs/components/_classes/nestedarray/NestedArrayComponent.js

@@ -1,6 +1,8 @@
 'use strict';
 import _ from 'lodash';
-import { componentValueTypes, getStringFromComponentPath } from '../../../utils/utils';
+import { Utils } from '@formio/core/utils';
+const { getComponentPaths } = Utils;
+import { componentValueTypes, isLayoutComponent } from '../../../utils/utils';
 import Component from '../component/Component';
 import NestedDataComponent from '../nesteddata/NestedDataComponent';
 export default class NestedArrayComponent extends NestedDataComponent {
@@ -19,9 +21,13 @@ export default class NestedArrayComponent extends NestedDataComponent {
         throw new Error('Getter #iteratableRows() is not implemented');
     }
     get rowIndex() {
-        return super.rowIndex;
+        return this._rowIndex;
     }
     set rowIndex(value) {
+        this.paths = getComponentPaths(this.component, this.parent?.component, {
+            ...(this.parent?.paths || {}),
+            ...{ dataIndex: value }
+        });
         this._rowIndex = value;
     }
     init() {
@@ -84,47 +90,6 @@ export default class NestedArrayComponent extends NestedDataComponent {
                 value: this.dataValue,
             }, 'show'));
     }
-    getComponent(path, fn, originalPath) {
-        originalPath = originalPath || getStringFromComponentPath(path);
-        if (this.componentsMap.hasOwnProperty(originalPath)) {
-            if (fn) {
-                return fn(this.componentsMap[originalPath]);
-            }
-            else {
-                return this.componentsMap[originalPath];
-            }
-        }
-        path = Array.isArray(path) ? path : [path];
-        let key = path.shift();
-        const remainingPath = path;
-        let result = [];
-        let possibleComp = null;
-        let comp = null;
-        let rowIndex = null;
-        if (_.isNumber(key)) {
-            rowIndex = key;
-            key = remainingPath.shift();
-        }
-        if (!_.isString(key)) {
-            return result;
-        }
-        this.everyComponent((component, components) => {
-            if (component.component.key === key) {
-                possibleComp = component;
-                if (remainingPath.length > 0 && 'getComponent' in component) {
-                    comp = component.getComponent(remainingPath, fn, originalPath);
-                }
-                else if (fn) {
-                    fn(component, components);
-                }
-                result = rowIndex !== null ? comp : result.concat(comp || possibleComp);
-            }
-        }, rowIndex);
-        if ((!result || result.length === 0) && possibleComp) {
-            result = rowIndex !== null ? possibleComp : [possibleComp];
-        }
-        return result;
-    }
     everyComponent(fn, rowIndex, options = {}) {
         if (_.isObject(rowIndex)) {
             options = rowIndex;

package/lib/mjs/components/datagrid/DataGrid.d.ts

@@ -85,7 +85,6 @@ export default class DataGridComponent extends NestedArrayComponent {
         show: boolean;
     };
     checkComponentConditions(data: any, flags: any, row: any): boolean;
-    getComponent(path: any, fn: any): any;
     toggleGroup(element: any, index: any): void;
 }
 import NestedArrayComponent from '../_classes/nestedarray/NestedArrayComponent';

package/lib/mjs/components/datagrid/DataGrid.js

@@ -1,7 +1,6 @@
 import _ from 'lodash';
 import NestedArrayComponent from '../_classes/nestedarray/NestedArrayComponent';
 import { fastCloneDeep, getFocusableElements } from '../../utils/utils';
-import Components from '../Components';
 import dragula from 'dragula';
 export default class DataGridComponent extends NestedArrayComponent {
     static schema(...extend) {
@@ -407,7 +406,6 @@ export default class DataGridComponent extends NestedArrayComponent {
             }
             component.rowIndex = rowIndex;
             component.row = `${rowIndex}-${colIndex}`;
-            component.path = Components.getComponentPath(component);
         });
     }
     updateRowsComponents(rowIndex) {
@@ -473,6 +471,7 @@ export default class DataGridComponent extends NestedArrayComponent {
             const options = _.clone(this.options);
             options.name += `[${rowIndex}]`;
             options.row = `${rowIndex}-${colIndex}`;
+            options.rowIndex = rowIndex;
             let columnComponent;
             if (this.builderMode) {
                 col.id = col.id + rowIndex;
@@ -595,49 +594,6 @@ export default class DataGridComponent extends NestedArrayComponent {
     restoreComponentsContext() {
         this.rows.forEach((row, index) => _.forIn(row, (component) => component.data = this.dataValue[index]));
     }
-    getComponent(path, fn) {
-        path = Array.isArray(path) ? path : [path];
-        const [key, ...remainingPath] = path;
-        let result = [];
-        if (_.isNumber(key) && remainingPath.length) {
-            const compKey = remainingPath.pop();
-            result = this.rows[key][compKey];
-            // If the component is inside a Layout Component, try to find it among all the row's components
-            if (!result) {
-                Object.entries(this.rows[key]).forEach(([, comp]) => {
-                    if ('getComponent' in comp) {
-                        const possibleResult = comp.getComponent([compKey], fn);
-                        if (possibleResult) {
-                            result = possibleResult;
-                        }
-                    }
-                });
-            }
-            if (result && _.isFunction(fn)) {
-                fn(result, this.getComponents());
-            }
-            if (remainingPath.length && 'getComponent' in result) {
-                return result.getComponent(remainingPath, fn);
-            }
-            return result;
-        }
-        if (!_.isString(key)) {
-            return result;
-        }
-        this.everyComponent((component, components) => {
-            if (component.component.key === key) {
-                let comp = component;
-                if (remainingPath.length > 0 && 'getComponent' in component) {
-                    comp = component.getComponent(remainingPath, fn);
-                }
-                else if (fn) {
-                    fn(component, components);
-                }
-                result = result.concat(comp);
-            }
-        });
-        return result.length > 0 ? result : null;
-    }
     toggleGroup(element, index) {
         element.classList.toggle('collapsed');
         _.each(this.refs.chunks[index], row => {

package/lib/mjs/components/datamap/DataMap.js

@@ -3,7 +3,6 @@ import DataGridComponent from '../datagrid/DataGrid';
 import _ from 'lodash';
 import EventEmitter from 'eventemitter3';
 import { componentValueTypes, getComponentSavedTypes, uniqueKey } from '../../utils/utils';
-import Components from '../Components';
 export default class DataMapComponent extends DataGridComponent {
     static schema(...extend) {
         return Component.schema({
@@ -70,7 +69,7 @@ export default class DataMapComponent extends DataGridComponent {
     }
     get dataValue() {
         if (!this.key ||
-            (!this.visible && this.component.clearOnHide)) {
+            (this.conditionallyHidden && this.component.clearOnHide)) {
             return this.emptyValue;
         }
         if (!this.hasValue() && this.shouldAddDefaultValue) {
@@ -227,6 +226,7 @@ export default class DataMapComponent extends DataGridComponent {
         options.events = new EventEmitter();
         options.name += `[${rowIndex}]`;
         options.row = `${rowIndex}`;
+        options.rowIndex = rowIndex;
         const components = {};
         components['__key'] = this.createComponent(this.keySchema, options, { __key: this.builderMode ? this.defaultRowKey : key });
         components['__key'].on('componentChange', (event) => {
@@ -236,7 +236,6 @@ export default class DataMapComponent extends DataGridComponent {
             delete dataValue[key];
             const comp = components[this.valueKey];
             comp.component.key = newKey;
-            comp.path = Components.getComponentPath(comp);
             key = newKey;
         });
         const valueComponent = _.clone(this.component.valueComponent);

package/lib/mjs/components/editgrid/EditGrid.js

@@ -913,6 +913,7 @@ export default class EditGridComponent extends NestedArrayComponent {
             const options = _.clone(this.options);
             options.name += `[${rowIndex}]`;
             options.row = `${rowIndex}-${colIndex}`;
+            options.rowIndex = rowIndex;
             options.onChange = (flags = {}, changed, modified) => {
                 if (changed.instance.root?.id && (this.root?.id !== changed.instance.root.id)) {
                     changed.instance.root.triggerChange(flags, changed, modified);
@@ -929,7 +930,7 @@ export default class EditGridComponent extends NestedArrayComponent {
                         ...flags,
                         changed,
                     }, editRow.data, editRow.components);
-                    this.validateRow(editRow, false);
+                    this.validateRow(editRow, false, false);
                 }
                 if (this.variableTypeComponentsIndexes.length) {
                     this.checkRowVariableTypeComponents(editRow, rowIndex);
@@ -969,22 +970,24 @@ export default class EditGridComponent extends NestedArrayComponent {
     validateRow(editRow, dirty, forceSilentCheck, fromSubmission) {
         editRow.errors = [];
         if (this.shouldValidateRow(editRow, dirty, fromSubmission)) {
-            const silentCheck = (this.component.rowDrafts && !this.shouldValidateDraft(editRow)) || forceSilentCheck;
+            const silentCheck = forceSilentCheck === false ? false : ((this.component.rowDrafts && !this.shouldValidateDraft(editRow)) || forceSilentCheck);
             const rootValue = fastCloneDeep(this.rootValue);
             const editGridValue = _.get(rootValue, this.path, []);
             editGridValue[editRow.rowIndex] = editRow.data;
             _.set(rootValue, this.path, editGridValue);
             const validationProcessorProcess = (context) => this.validationProcessor(context, { dirty, silentCheck });
             const errors = processSync({
-                components: fastCloneDeep(this.component.components).map((component) => {
-                    component.parentPath = `${this.path}[${editRow.rowIndex}]`;
-                    return component;
-                }),
+                components: this.component.components,
                 data: rootValue,
                 row: editRow.data,
                 process: 'validateRow',
                 instances: this.componentsMap,
                 scope: { errors: [] },
+                parent: this.component,
+                parentPaths: {
+                    ...this.paths,
+                    dataIndex: editRow.rowIndex
+                },
                 processors: [
                     {
                         process: validationProcessorProcess,
@@ -1129,7 +1132,7 @@ export default class EditGridComponent extends NestedArrayComponent {
             }
         }
         const changed = this.hasChanged(value, this.dataValue);
-        if (this.parent && !this.options.server) {
+        if (this.parent) {
             this.parent.checkComponentConditions();
         }
         this.dataValue = value;
@@ -1162,10 +1165,7 @@ export default class EditGridComponent extends NestedArrayComponent {
         this.editRows = this.editRows.slice(0, dataLength);
         this.openWhenEmpty();
         this.updateOnChange(flags, changed);
-        // do not call checkData with server option, it is called when change is triggered in updateOnChange
-        if (!this.options.server) {
-            this.checkData();
-        }
+        this.checkData();
         this.changeState(changed, flags);
         return changed;
     }

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

@@ -21,7 +21,7 @@ export default class FormComponent extends Component {
     get useOriginalRevision(): any;
     setFormRevision(rev: any): void;
     subFormRevision: any;
-    getComponent(path: any, fn: any): any;
+    getComponent(path: any): any;
     getSubOptions(options?: {}): {};
     render(): string;
     asString(value: any): any;
@@ -55,8 +55,6 @@ export default class FormComponent extends Component {
      */
     loadSubForm(fromAttach: boolean): Promise<any>;
     subFormLoading: boolean | undefined;
-    get subFormData(): any;
-    checkComponentValidity(data: any, dirty: any, row: any, options: any, errors?: any[]): any;
     checkComponentConditions(data: any, flags: any, row: any): any;
     calculateValue(data: any, flags: any, row: any): any;
     setPristine(pristine: any): void;
@@ -90,6 +88,13 @@ export default class FormComponent extends Component {
     isHidden(): boolean;
     setValue(submission: any, flags?: {}): boolean;
     setSubFormValue(submission: any, flags: any): void;
+    /**
+     * 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.
+     * @return {void}
+     */
+    onSetSubFormValue(submission: object | null | undefined, flags: object | null | undefined): void;
     areAllComponentsEmpty(data: any): boolean;
     updateSubFormVisibility(): void;
     /**