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

package/lib/mjs/WebformBuilder.js

@@ -14,7 +14,7 @@ import './components/builder';
 if (typeof window !== 'undefined' && typeof window.global === 'undefined') {
     window.global = window;
 }
-import dragula from 'dragula/dist/dragula.min.js';
+import dragula from 'dragula';
 export default class WebformBuilder extends Component {
     // eslint-disable-next-line max-statements
     constructor() {
@@ -347,7 +347,7 @@ export default class WebformBuilder extends Component {
         }
         if (component.refs.removeComponent) {
             this.attachTooltip(component.refs.removeComponent, this.t('Remove'));
-            component.addEventListener(component.refs.removeComponent, 'click', () => this.removeComponent(component.schema, parent, component.component));
+            component.addEventListener(component.refs.removeComponent, 'click', () => this.removeComponent(component.schema, parent, component.component, component));
         }
         return element;
     }
@@ -721,6 +721,10 @@ export default class WebformBuilder extends Component {
             }
         }
         if (info) {
+            //if this is a custom component that was already assigned a key, don't stomp on it
+            if (!Components.components.hasOwnProperty(info.type) && info.key) {
+                return info;
+            }
             info.key = this.generateKey(info);
         }
         return info;
@@ -924,7 +928,7 @@ export default class WebformBuilder extends Component {
             }
         }
     }
-    removeComponent(component, parent, original) {
+    removeComponent(component, parent, original, componentInstance) {
         if (!parent) {
             return;
         }
@@ -950,6 +954,9 @@ export default class WebformBuilder extends Component {
             else if (parent.formioComponent && parent.formioComponent.removeChildComponent) {
                 parent.formioComponent.removeChildComponent(component);
             }
+            if (component.input && componentInstance && componentInstance.parent) {
+                _.unset(componentInstance._data, componentInstance.key);
+            }
             const rebuild = parent.formioComponent.rebuild() || Promise.resolve();
             rebuild.then(() => {
                 this.emit('removeComponent', component, parent.formioComponent.schema, path, index);
@@ -1079,11 +1086,12 @@ export default class WebformBuilder extends Component {
         let hasInvalidComponents = false;
         this.webform.everyComponent((comp) => {
             const path = comp.path;
+            const errors = comp.visibleErrors || [];
             if (repeatablePaths.includes(path)) {
                 comp.setCustomValidity(`API Key is not unique: ${comp.key}`);
                 hasInvalidComponents = true;
             }
-            else if (comp.error?.message?.startsWith('API Key is not unique')) {
+            else if (errors.length && errors[0].message?.startsWith('API Key is not unique')) {
                 comp.setCustomValidity('');
             }
         });
@@ -1118,8 +1126,8 @@ export default class WebformBuilder extends Component {
                     comp = component;
                 }
             });
-            const originalComp = comp.component;
-            const originalComponentSchema = comp.schema;
+            const originalComp = comp?.component;
+            const originalComponentSchema = comp?.schema;
             const isParentSaveChildMethod = this.isParentSaveChildMethod(parent.formioComponent);
             if (parentContainer && !isParentSaveChildMethod) {
                 parentContainer[index] = submissionData;
@@ -1176,9 +1184,12 @@ export default class WebformBuilder extends Component {
         saveButtons.forEach((saveButton) => {
             this.editForm.addEventListener(saveButton, 'click', (event) => {
                 event.preventDefault();
-                if (!this.editForm.checkValidity(this.editForm.data, true, this.editForm.data)) {
+                const errors = this.editForm.validate(this.editForm.data, {
+                    dirty: true
+                });
+                if (errors.length) {
                     this.editForm.setPristine(false);
-                    this.editForm.showErrors();
+                    this.editForm.showErrors(errors);
                     return false;
                 }
                 this.saved = true;
@@ -1233,7 +1244,11 @@ export default class WebformBuilder extends Component {
         this.editForm = new Webform({
             ..._.omit(this.options, ['hooks', 'builder', 'events', 'attachMode', 'skipInit']),
             language: this.options.language,
-            ...editFormOptions
+            ...editFormOptions,
+            evalContext: {
+                ...(editFormOptions?.evalContext || this.options?.evalContext || {}),
+                buildingForm: this.form,
+            },
         });
         this.hook('editFormProperties', parent);
         this.editForm.form = (isJsonEdit && !isCustom) ? {
@@ -1339,8 +1354,14 @@ export default class WebformBuilder extends Component {
                         }
                     }
                 }
+                // If the edit form has any nested form inside, we get a partial data (nested form's data) in the
+                // event.data property
+                let editFormData;
+                if (event.changed.instance && event.changed.instance.root && event.changed.instance.root.id !== this.editForm.id) {
+                    editFormData = this.editForm.data;
+                }
                 // Update the component.
-                this.updateComponent(event.data.componentJson || event.data, event.changed);
+                this.updateComponent(event.data.componentJson || editFormData || event.data, event.changed);
             }
         });
         this.attachEditComponentControls(component, parent, isNew, original, ComponentClass);

package/lib/mjs/Wizard.d.ts

@@ -70,6 +70,7 @@ declare class Wizard extends Webform {
     beforePage(next: any): Promise<any>;
     emitNextPage(): void;
     nextPage(): Promise<void>;
+    validateCurrentPage(flags?: {}): any;
     emitPrevPage(): void;
     prevPage(): Promise<void>;
     cancel(noconfirm: any): Promise<void> | Promise<number>;
@@ -84,13 +85,13 @@ declare class Wizard extends Webform {
     hasButton(name: any, nextPage?: number | null): any;
     pageId(page: any): any;
     onChange(flags: any, changed: any, modified: any, changes: any): void;
+    checkValidity(data: any, dirty: any, row: any, currentPageOnly: any, childErrors?: any[]): any;
     focusOnComponent(key: any): any;
 }
 declare namespace Wizard {
-    const setBaseUrl: typeof Formio.setBaseUrl;
-    const setApiUrl: typeof Formio.setApiUrl;
-    const setAppUrl: typeof Formio.setAppUrl;
+    const setBaseUrl: any;
+    const setApiUrl: any;
+    const setAppUrl: any;
 }
 export default Wizard;
 import Webform from './Webform';
-import { Formio } from './Formio';

package/lib/mjs/Wizard.js

@@ -1,7 +1,7 @@
 import _ from 'lodash';
 import Webform from './Webform';
 import { Formio } from './Formio';
-import { fastCloneDeep, checkCondition, firstNonNil, uniqueKey, eachComponent } from './utils/utils';
+import { fastCloneDeep, checkCondition, firstNonNil, uniqueKey, eachComponent, unescapeHTML } from './utils/utils';
 export default class Wizard extends Webform {
     /**
      * Constructor for wizard based forms
@@ -172,7 +172,9 @@ export default class Wizard extends Webform {
         return this.renderTemplate('wizardNav', ctx);
     }
     prepareHeaderSettings(ctx, headerType) {
-        if (this.currentPanel && this.currentPanel.breadcrumb === 'none' || ctx.isSubForm) {
+        const shouldHideBreadcrumbs = this.currentPanel?.breadcrumb === 'none' ||
+            _.get(this.form, 'settings.wizardBreadcrumbsType', '') === 'none';
+        if (shouldHideBreadcrumbs || ctx.isSubForm) {
             return null;
         }
         return this.renderTemplate(headerType, ctx);
@@ -570,6 +572,7 @@ export default class Wizard extends Webform {
             }
             this.redraw().then(() => {
                 this.checkData(this.submission.data);
+                this.validateCurrentPage();
             });
             return Promise.resolve();
         }
@@ -665,7 +668,8 @@ export default class Wizard extends Webform {
             });
         }
         // Validate the form, before go to the next page
-        if (this.checkValidity(this.localData, true, this.localData, true)) {
+        const errors = this.validateCurrentPage({ dirty: true });
+        if (errors.length === 0) {
             this.checkData(this.submission.data);
             return this.beforePage(true).then(() => {
                 return this.setPage(this.getNextPage()).then(() => {
@@ -680,9 +684,13 @@ export default class Wizard extends Webform {
         else {
             this.currentPage.components.forEach((comp) => comp.setPristine(false));
             this.scrollIntoView(this.element);
-            return Promise.reject(this.showErrors([], true));
+            return Promise.reject(this.showErrors(errors, true));
         }
     }
+    validateCurrentPage(flags = {}) {
+        // Accessing the parent ensures the right instance (whether it's the parent Wizard or a nested Wizard) performs its validation
+        return this.currentPage?.parent.validateComponents(this.currentPage.component.components, this.currentPage.parent.data, flags);
+    }
     emitPrevPage() {
         this.emit('prevPage', { page: this.page, submission: this.submission });
     }
@@ -759,7 +767,7 @@ export default class Wizard extends Webform {
         return super.setForm(form, flags);
     }
     onSetForm(clonedForm, initialForm) {
-        this.component.components = (this._parentPath ? initialForm.components : clonedForm.components) || [];
+        this.component.components = (this.parent ? initialForm.components : clonedForm.components) || [];
         this.setComponentSchema();
     }
     setEditMode(submission) {
@@ -772,7 +780,9 @@ export default class Wizard extends Webform {
         const changed = this.getPages({ all: true }).reduce((changed, page) => {
             return this.setNestedValue(page, submission.data, flags, changed) || changed;
         }, false);
-        if (!flags.sanitize) {
+        if (!flags.sanitize ||
+            (flags && flags.fromSubmission && (this.prefixComps.length || this.suffixComps.length) && submission._id) ||
+            (this.options.server && (this.prefixComps.length || this.suffixComps.length))) {
             this.mergeData(this.data, submission.data);
         }
         if (changed) {
@@ -823,9 +833,9 @@ export default class Wizard extends Webform {
     }
     onChange(flags, changed, modified, changes) {
         super.onChange(flags, changed, modified, changes);
-        if (this.alert && !this.submitted) {
-            this.checkValidity(this.localData, false, this.localData, true);
-            this.showErrors([], true, true);
+        const errors = this.validate(this.localData, { dirty: false });
+        if (this.alert) {
+            this.showErrors(errors, true, true);
         }
         // If the pages change, need to redraw the header.
         let currentPanels;
@@ -861,7 +871,7 @@ export default class Wizard extends Webform {
         }
         return super.redraw();
     }
-    checkValidity(data, dirty, row, currentPageOnly) {
+    checkValidity(data, dirty, row, currentPageOnly, childErrors = []) {
         if (!this.checkCondition(row, data)) {
             this.setCustomValidity('');
             return true;
@@ -869,7 +879,7 @@ export default class Wizard extends Webform {
         const components = !currentPageOnly || this.isLastPage()
             ? this.getComponents()
             : this.currentPage.components;
-        return components.reduce((check, comp) => comp.checkValidity(data, dirty, row) && check, true);
+        return components.reduce((check, comp) => comp.checkValidity(data, dirty, row, childErrors) && check, true);
     }
     get errors() {
         if (!this.isLastPage()) {
@@ -878,23 +888,22 @@ export default class Wizard extends Webform {
         return super.errors;
     }
     focusOnComponent(key) {
-        let pageIndex = 0;
-        const [page] = this.pages.filter((page, index) => {
-            let hasComponent = false;
-            page.getComponent(key, (comp) => {
-                if (comp.path === key) {
-                    pageIndex = index;
-                    hasComponent = true;
+        const component = this.getComponent(key);
+        if (component) {
+            let topPanel = component.parent;
+            while (!(topPanel.parent instanceof Wizard)) {
+                topPanel = topPanel.parent;
+            }
+            const pageIndex = this.pages.findIndex(page => page === topPanel);
+            if (pageIndex >= 0) {
+                const page = this.pages[pageIndex];
+                if (page && page !== this.currentPage) {
+                    return this.setPage(pageIndex).then(() => {
+                        this.showErrors(this.validate(this.localData, { dirty: true }));
+                        super.focusOnComponent(key);
+                    });
                 }
-            });
-            return hasComponent;
-        });
-        if (page && page !== this.currentPage) {
-            return this.setPage(pageIndex).then(() => {
-                this.checkValidity(this.submission.data, true, this.submission.data);
-                this.showErrors();
-                super.focusOnComponent(key);
-            });
+            }
         }
         return super.focusOnComponent(key);
     }

package/lib/mjs/WizardBuilder.d.ts

@@ -9,6 +9,7 @@ export default class WizardBuilder extends WebformBuilder {
         }[];
     };
     page: number;
+    removeComponent(component: any, parent: any, original: any): boolean | undefined;
     allowDrop(element: any): boolean;
     get pages(): any;
     get currentPage(): any;

package/lib/mjs/addons/PasswordStrength/PasswordStrengthAddon.d.ts

@@ -698,8 +698,7 @@ export default class PasswordStrengthAddon extends FormioAddon {
      * @param {string} value - Suggested password
      */
     checkValidity(value: string): boolean;
-    errors: any[] | undefined;
-    handleBlackListCheckResult(result: any): void;
+    handleBlackListCheckResult(result: any, errors: any): void;
     levels: any[];
     maxEntropy: any;
     attach(element: any): void;

package/lib/mjs/addons/PasswordStrength/PasswordStrengthAddon.js

@@ -261,30 +261,29 @@ export default class PasswordStrengthAddon extends FormioAddon {
     checkValidity(value) {
         const passwordLength = value.length;
         const { charactersPoolSize, errors } = this.performChecks(value);
-        this.errors = errors;
         const entropy = this.calculatePasswordEntropy(passwordLength, charactersPoolSize);
         const blackListCheck = this.settings.blackList?.length || this.settings.customBlacklistedWords ?
             this.checkBlackList(value)
             : null;
+        const isValid = this.isValid();
+        if (!isValid) {
+            errors.push({
+                message: 'Password is not strong enough',
+                level: this.settings.required ? 'error' : 'warning'
+            });
+        }
         // If there were found some words from the black list
         if (blackListCheck && blackListCheck !== true) {
-            this.handleBlackListCheckResult(blackListCheck);
+            this.handleBlackListCheckResult(blackListCheck, errors);
             // Select the mininal entropy based on the dictionary check or symbolic check
             this.entropy = Math.min(entropy, blackListCheck.entropy);
         }
         else {
             this.entropy = entropy;
         }
-        const isValid = this.isValid();
-        if (!isValid) {
-            this.errors.push({
-                message: 'Password is not strong enough',
-                level: this.settings.required ? 'error' : 'warning'
-            });
-        }
-        return !this.errors.length;
+        return !errors.length;
     }
-    handleBlackListCheckResult(result) {
+    handleBlackListCheckResult(result, errors) {
         const blacklistedWords = result.blacklistedWords;
         const isRequired = this.settings.disableBlacklistedWords;
         const message = `Password ${isRequired ? 'must' : 'should'} not include common words: ${blacklistedWords.join(', ')}`;
@@ -292,7 +291,7 @@ export default class PasswordStrengthAddon extends FormioAddon {
             name: 'blacklist',
             required: isRequired,
         };
-        this.handleRuleCheckResult(false, validation, message, this.errors);
+        this.handleRuleCheckResult(false, validation, message, errors);
     }
     constructor(settings, componentInstance) {
         super(settings, componentInstance);

package/lib/mjs/addons/index.d.ts

@@ -592,6 +592,7 @@ export const editForms: {
         multiple?: undefined;
         hideLabel?: undefined;
     })[];
+    tableView: boolean;
     defaultValue: {
         data: {
             rulesSettings: {

package/lib/mjs/addons/index.js

@@ -6,7 +6,11 @@ export const editForms = [
     key: 'settings',
     display: 'form',
     input: true,
-    components,
+    components: components.map((comp) => {
+        comp.tableView = false;
+        return comp;
+    }),
+    tableView: false,
     defaultValue: {
         data: defaultSettings
     },

package/lib/mjs/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/mjs/components/Components.js

@@ -45,6 +45,30 @@ 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) {
+        let path = '';
+        if (component.component.key) {
+            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}.`;
+            path += component.component.key;
+            return _.trim(path, '.');
+        }
+    }
     static create(component, options, data) {
         let comp = null;
         if (component.type && Components.components.hasOwnProperty(component.type)) {
@@ -69,6 +93,11 @@ class Components {
         else {
             comp = new Component(component, options, data);
         }
+        const path = Components.getComponentPath(comp);
+        if (path) {
+            comp.path = path;
+            comp.componentsMap[comp.path] = comp;
+        }
         return comp;
     }
 }

package/lib/mjs/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;