@formio/js 5.0.0-rc.27 → 5.0.0-rc.29

package/lib/cjs/components/Components.d.ts

@@ -253,6 +253,13 @@ export default class Components {
     static setComponents(comps: any): void;
     static addComponent(name: any, comp: any): void;
     static setComponent(name: any, comp: any): void;
+    /**
+     * Return a path of component's value.
+     *
+     * @param {Object} component - The component instance.
+     * @return {string} - The component's value path.
+     */
+    static getComponentPath(component: Object): string;
     static create(component: any, options: any, data: any): any;
 }
 import BaseEditForm from './_classes/component/Component.form';

package/lib/cjs/components/Components.js

@@ -48,6 +48,31 @@ class Components {
     static setComponent(name, comp) {
         Components.components[name] = comp;
     }
+    /**
+     * Return a path of component's value.
+     *
+     * @param {Object} component - The component instance.
+     * @return {string} - The component's value path.
+     */
+    static getComponentPath(component) {
+        var _a;
+        let path = '';
+        if (component.component.key) {
+            let thisPath = ((_a = component.options) === null || _a === void 0 ? void 0 : _a.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}.`;
+            path += component.component.key;
+            return lodash_1.default.trim(path, '.');
+        }
+    }
     static create(component, options, data) {
         let comp = null;
         if (component.type && Components.components.hasOwnProperty(component.type)) {
@@ -72,6 +97,11 @@ class Components {
         else {
             comp = new Component_1.default(component, options, data);
         }
+        const path = Components.getComponentPath(comp);
+        if (path) {
+            comp.path = path;
+            comp.componentsMap[comp.path] = comp;
+        }
         return comp;
     }
 }

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

@@ -47,16 +47,21 @@ declare class Component extends Element {
      * References to dom elements
      */
     refs: {};
-    /**
-     * Set the validator instance.
-     */
-    validator: import("../../../validator/Validator").ValidationChecker;
     /**
      * The data path to this specific component instance.
      *
      * @type {string}
      */
     path: string;
+    /**
+     * An array of all the children components errors.
+     */
+    childErrors: any[];
+    /**
+     * Last validation errors that have occured.
+     */
+    _errors: any[];
+    _visibleErrors: any[];
     /**
      * The Form.io component JSON schema.
      * @type {*}
@@ -76,11 +81,6 @@ declare class Component extends Element {
      * @type {*}
      */
     _data: any;
-    /**
-     * The existing error that this component has.
-     * @type {string}
-     */
-    error: string;
     /**
      * Tool tip text after processing
      * @type {string}
@@ -91,6 +91,12 @@ declare class Component extends Element {
      * @type {number}
      */
     row: number;
+    /**
+     * Points to a flat map of child components (if applicable).
+     *
+     * @type {Object}
+     */
+    childComponentsMap: Object;
     /**
      * Determines if this component is disabled, or not.
      *
@@ -116,13 +122,7 @@ declare class Component extends Element {
      * @type {Component}
      */
     parent: Component;
-    /**
-     * The validators that are assigned to this component.
-     * @type {[string]}
-     */
-    validators: [string];
     _path: string;
-    _parentPath: any;
     /**
      * Determines if this component is visible, or not.
      */
@@ -164,6 +164,7 @@ declare class Component extends Element {
      * @type {*}
      */
     info: any;
+    get componentsMap(): any;
     set data(arg: any);
     get data(): any;
     mergeSchema(component?: {}): any;
@@ -405,6 +406,8 @@ declare class Component extends Element {
      * @returns {string} - The name of the component.
      */
     get name(): string;
+    get visibleErrors(): any[];
+    get errors(): any[];
     /**
      * Returns the error label for this component.
      * @return {*}
@@ -699,7 +702,30 @@ declare class Component extends Element {
      * @return {boolean}
      */
     isValid(data: any, dirty: any): boolean;
-    setComponentValidity(messages: any, dirty: any, silentCheck: any): boolean;
+    setComponentValidity(errors: any, dirty: any, silentCheck: any): any;
+    /**
+     * Interpolate errors from the validation methods.
+     * @param {*} errors
+     * @returns
+     */
+    interpolateErrors(errors: any): any[];
+    /**
+     * Show component validation errors.
+     * @param {*} errors - An array of errors that have occured.
+     * @param {*} data - The root submission data.
+     * @param {*} row - The contextual row data.
+     * @param {*} flags - The flags to perform validation.
+     * @returns
+     */
+    showValidationErrors(errors: any, data: any, row: any, flags: any): any;
+    /**
+     * Perform a component validation.
+     * @param {*} data - The root data you wish to use for this component.
+     * @param {*} row - The contextual row data you wish to use for this component.
+     * @param {*} flags - The flags to control the behavior of the validation.
+     * @returns
+     */
+    validateComponent(data: any, row: any, flags?: any): any;
     /**
      * Checks the validity of this component and sets the error message if it is invalid.
      *
@@ -708,9 +734,17 @@ declare class Component extends Element {
      * @param row
      * @return {boolean}
      */
-    checkComponentValidity(data: any, dirty: any, row: any, options?: {}): boolean;
-    checkValidity(data: any, dirty: any, row: any, silentCheck: any): boolean;
-    checkAsyncValidity(data: any, dirty: any, row: any, silentCheck: any): Promise<boolean>;
+    checkComponentValidity(data: any, dirty: any, row: any, flags?: {}, allErrors?: any[]): boolean;
+    /**
+     * Checks the validity of the component.
+     * @param {*} data
+     * @param {*} dirty
+     * @param {*} row
+     * @param {*} silentCheck
+     * @returns
+     */
+    checkValidity(data: any, dirty: any, row: any, silentCheck: any, errors?: any[]): boolean;
+    checkAsyncValidity(data: any, dirty: any, row: any, silentCheck: any, errors?: any[]): boolean;
     /**
      * Check the conditions, calculations, and validity of a single component and triggers an update if
      * something changed.
@@ -720,8 +754,8 @@ declare class Component extends Element {
      *
      * @return boolean - If component is valid or not.
      */
-    checkData(data: any, flags: any, row: any): boolean;
-    checkModal(isValid?: boolean, dirty?: boolean): void;
+    checkData(data: any, flags: any, row: any): true | undefined;
+    checkModal(errors?: any[], dirty?: boolean): void;
     get validationValue(): any;
     isEmpty(value?: any): any;
     isEqual(valueA: any, valueB?: any): any;
@@ -731,11 +765,10 @@ declare class Component extends Element {
      * @return {boolean}
      */
     validateMultiple(): boolean;
-    get errors(): string[];
     clearErrorClasses(element?: any): void;
     setInputWidgetErrorClasses(inputRefs: any, hasErrors: any): void;
     addFocusBlurEvents(element: any): void;
-    setCustomValidity(messages: any, dirty: any, external: any): void;
+    setCustomValidity(messages: any, dirty: any, external: any): any;
     /**
      * Determines if the value of this component is hidden from the user as if it is coming from the server, but is
      * protected.
@@ -743,7 +776,7 @@ declare class Component extends Element {
      * @return {boolean|*}
      */
     isValueHidden(): boolean | any;
-    shouldSkipValidation(data: any, dirty: any, row: any): boolean;
+    shouldSkipValidation(data: any, row: any, flags?: {}): boolean;
     whenReady(): Promise<void>;
     get dataReady(): Promise<void>;
     /**
@@ -786,9 +819,6 @@ declare class Component extends Element {
     get previewMode(): boolean;
 }
 declare namespace Component {
-    class Validator {
-        private constructor();
-    }
     const externalLibraries: {};
     function requireLibrary(name: any, property: any, src: any, polling: any): any;
     function libraryReady(name: any): any;