@formio/js 5.1.0-rc.27 → 5.1.0-rc.28

package/dist/formio.min.js.LICENSE.txt

@@ -20,7 +20,7 @@
 
 /*! @license DOMPurify 3.2.4 | (c) Cure53 and other contributors | Released under the Apache license 2.0 and Mozilla Public License 2.0 | github.com/cure53/DOMPurify/blob/3.2.4/LICENSE */
 
-/*! formiojs v5.1.0-rc.27 | https://unpkg.com/formiojs@5.1.0-rc.27/LICENSE.txt */
+/*! formiojs v5.1.0-rc.28 | https://unpkg.com/formiojs@5.1.0-rc.28/LICENSE.txt */
 
 /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */
 

package/dist/formio.utils.min.js.LICENSE.txt

@@ -20,7 +20,7 @@
 
 /*! @license DOMPurify 3.2.4 | (c) Cure53 and other contributors | Released under the Apache license 2.0 and Mozilla Public License 2.0 | github.com/cure53/DOMPurify/blob/3.2.4/LICENSE */
 
-/*! formiojs v5.1.0-rc.27 | https://unpkg.com/formiojs@5.1.0-rc.27/LICENSE.txt */
+/*! formiojs v5.1.0-rc.28 | https://unpkg.com/formiojs@5.1.0-rc.28/LICENSE.txt */
 
 /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */
 

package/lib/cjs/Embed.js

@@ -418,7 +418,7 @@ Formio.formioReady = new Promise((ready, reject) => {
     _a._formioReady = ready;
     _a._formioReadyReject = reject;
 });
-Formio.version = '5.1.0-rc.27';
+Formio.version = '5.1.0-rc.28';
 // Create a report.
 Formio.Report = {
     create: (element, submission, options = {}) => __awaiter(void 0, void 0, void 0, function* () {

package/lib/cjs/Formio.js

@@ -11,7 +11,7 @@ const CDN_1 = __importDefault(require("./CDN"));
 const providers_1 = __importDefault(require("./providers"));
 sdk_1.Formio.cdn = new CDN_1.default();
 sdk_1.Formio.Providers = providers_1.default;
-sdk_1.Formio.version = '5.1.0-rc.27';
+sdk_1.Formio.version = '5.1.0-rc.28';
 CDN_1.default.defaultCDN = sdk_1.Formio.version.includes('rc') ? 'https://cdn.test-form.io' : 'https://cdn.form.io';
 const isNil = (val) => val === null || val === undefined;
 sdk_1.Formio.prototype.uploadFile = function (storage, file, fileName, dir, progressCallback, url, options, fileKey, groupPermissions, groupId, uploadStartCallback, abortCallback, multipartOptions) {

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

@@ -163,6 +163,7 @@ declare class Component extends Element {
      */
     info: any;
     get componentsMap(): object;
+    parentShouldConditionallyClear(): boolean;
     parentConditionallyHidden(): boolean;
     set data(value: any);
     get data(): any;
@@ -227,7 +228,8 @@ declare class Component extends Element {
     get visible(): boolean;
     get logicallyHidden(): any;
     _logicallyHidden: any;
-    conditionallyHidden(skipParent?: boolean): any;
+    shouldConditionallyClear(skipParent?: boolean): boolean;
+    conditionallyHidden(skipParent?: boolean): boolean;
     set currentForm(instance: any);
     get currentForm(): any;
     _currentForm: any;
@@ -890,7 +892,15 @@ declare class Component extends Element {
      * @returns {boolean} - TRUE if a default value is set.
      */
     get hasDefaultValue(): boolean;
+    /**
+     * Determine if we should add a default value for this component.
+     * @returns {boolean} - TRUE if a default value should be set
+     */
     get shouldAddDefaultValue(): boolean;
+    /**
+     * Get the default value of this component.
+     * @returns {*} - The default value for this component.
+     */
     get defaultValue(): any;
     /**
      * Get the input value of this component.

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

@@ -414,7 +414,7 @@ class Component extends Element_1.default {
             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.conditionallyHidden() && this.component.clearOnHide)) {
+                if (!this.shouldConditionallyClear()) {
                     if (!this.hasValue()) {
                         if (this.shouldAddDefaultValue) {
                             this.dataValue = this.defaultValue;
@@ -445,6 +445,16 @@ class Component extends Element_1.default {
         var _a;
         return ((_a = this.root) === null || _a === void 0 ? void 0 : _a.childComponentsMap) || {};
     }
+    parentShouldConditionallyClear() {
+        let currentParent = this.parent;
+        while (currentParent) {
+            if (currentParent.shouldConditionallyClear(true)) {
+                return true;
+            }
+            currentParent = currentParent.parent;
+        }
+        return false;
+    }
     parentConditionallyHidden() {
         let currentParent = this.parent;
         while (currentParent) {
@@ -663,11 +673,48 @@ class Component extends Element_1.default {
         }
         return this._logicallyHidden;
     }
+    shouldConditionallyClear(skipParent = false) {
+        // Skip if this component has clearOnHide set to false.
+        if (this.component.clearOnHide === false) {
+            return false;
+        }
+        // If the component is logically hidden, then it is conditionally hidden and should clear.
+        if (this.logicallyHidden) {
+            return true;
+        }
+        // If we have a condition and it is not conditionally visible, the it should conditionally clear.
+        if (this.hasCondition() && !this.conditionallyVisible()) {
+            return true;
+        }
+        if (skipParent) {
+            // Stop recurrsion for the parent checks.
+            return false;
+        }
+        // If this component has a set value, then it should ONLY clear if a parent is hidden
+        // and has the clearOnHide set to true.
+        if (this.hasSetValue) {
+            return this.parentShouldConditionallyClear();
+        }
+        // Clear the value if the parent is conditionally hidden.
+        return this.parentConditionallyHidden();
+    }
     conditionallyHidden(skipParent = false) {
-        if (!this.hasCondition()) {
-            return this.logicallyHidden || (skipParent ? false : this.parentConditionallyHidden());
+        if (this.logicallyHidden) {
+            return true;
+        }
+        if (!this.hasCondition() && !skipParent) {
+            return this.parentConditionallyHidden();
+        }
+        // Return if we are not conditionally visible (conditionallyHidden)
+        if (!this.conditionallyVisible()) {
+            return true;
+        }
+        if (skipParent) {
+            // Stop recurrsion for the parent checks.
+            return false;
         }
-        return !this.conditionallyVisible() || this.logicallyHidden || (skipParent ? false : this.parentConditionallyHidden());
+        // Check the parent.
+        return this.parentConditionallyHidden();
     }
     get currentForm() {
         return this._currentForm;
@@ -2066,7 +2113,7 @@ class Component extends Element_1.default {
                         component: newComponent,
                         result,
                     });
-                    if (!lodash_1.default.isEqual(oldValue, newValue) && !(this.component.clearOnHide && this.conditionallyHidden())) {
+                    if (!lodash_1.default.isEqual(oldValue, newValue) && !this.shouldConditionallyClear()) {
                         this.setValue(newValue);
                         if (this.viewOnly) {
                             this.dataValue = newValue;
@@ -2099,7 +2146,7 @@ class Component extends Element_1.default {
                         component: newComponent,
                         result,
                     }, 'value');
-                    if (!lodash_1.default.isEqual(oldValue, newValue) && !(this.component.clearOnHide && this.conditionallyHidden())) {
+                    if (!lodash_1.default.isEqual(oldValue, newValue) && !this.shouldConditionallyClear()) {
                         this.setValue(newValue);
                         if (this.viewOnly) {
                             this.dataValue = newValue;
@@ -2205,7 +2252,7 @@ class Component extends Element_1.default {
     clearComponentOnHide() {
         // clearOnHide defaults to true for old forms (without the value set) so only trigger if the value is false.
         if (this.component.clearOnHide !== false && !this.options.readOnly && !this.options.showHiddenFields) {
-            if (this.conditionallyHidden()) {
+            if (this.shouldConditionallyClear()) {
                 this.deleteValue();
             }
             else if (!this.hasValue() && this.shouldAddDefaultValue) {
@@ -2526,15 +2573,17 @@ class Component extends Element_1.default {
             (this.component.defaultValue !== null) &&
             (this.component.defaultValue !== undefined));
     }
+    /**
+     * Determine if we should add a default value for this component.
+     * @returns {boolean} - TRUE if a default value should be set
+     */
     get shouldAddDefaultValue() {
-        // It should add a default value if...
-        //  1.) Ensure they have not set "noDefaults". If that is true, then will always return false.  AND
-        //  2.) The component is pristine (user has not manually modified it).  AND
-        //  3.) There is a default value setting present and it is not NULL or UNDEFINED.
-        return !this.options.noDefaults && this.pristine && (this.hasDefaultValue ||
-            // Empty strings and booleans are allowed primitives whose defaults are automatically added.
-            (this.emptyValue === '' || (typeof this.emptyValue === 'boolean')));
+        return this.pristine && this.allowData && (this.hasDefaultValue || !this.options.noDefaults);
     }
+    /**
+     * Get the default value of this component.
+     * @returns {*} - The default value for this component.
+     */
     get defaultValue() {
         let defaultValue = this.emptyValue;
         if (this.component.defaultValue) {
@@ -2805,10 +2854,8 @@ class Component extends Element_1.default {
         }
         // 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.conditionallyHidden() && clearOnHide;
         const allowOverride = lodash_1.default.get(this.component, 'allowCalculateOverride', false);
-        if (shouldBeCleared) {
+        if (this.shouldConditionallyClear()) {
             // remove calculated value so that the value is recalculated once component becomes visible
             if (this.hasOwnProperty('calculatedValue') && allowOverride) {
                 lodash_1.default.unset(this, 'calculatedValue');

package/lib/cjs/components/address/editForm/Address.edit.display.d.ts

@@ -8,6 +8,7 @@ declare const _default: ({
     customConditional: ({ data }: {
         data: any;
     }) => boolean;
+    defaultValue?: undefined;
     placeholder?: undefined;
     validate?: undefined;
 } | {
@@ -15,6 +16,7 @@ declare const _default: ({
     type: string;
     input: boolean;
     key: string;
+    defaultValue: string;
     label: string;
     placeholder: string;
     tooltip: string;
@@ -32,6 +34,7 @@ declare const _default: ({
     label: string;
     tooltip: string;
     customConditional?: undefined;
+    defaultValue?: undefined;
     placeholder?: undefined;
     validate?: undefined;
 } | {
@@ -45,6 +48,7 @@ declare const _default: ({
     customConditional: ({ data }: {
         data: any;
     }) => any;
+    defaultValue?: undefined;
     validate?: undefined;
 })[];
 export default _default;

package/lib/cjs/components/address/editForm/Address.edit.display.js

@@ -15,6 +15,7 @@ exports.default = [
         type: 'textfield',
         input: true,
         key: 'switchToManualModeLabel',
+        defaultValue: 'Can\'t find address? Switch to manual mode.',
         label: 'Switch To Manual Mode Label',
         placeholder: 'Switch To Manual Mode Label',
         tooltip: 'The label for the checkbox used to switch to manual mode.',

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

@@ -523,7 +523,7 @@ class FormComponent extends Component_1.default {
      * @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.conditionallyHidden() || !this.component.clearOnHide);
+        return this.subFormReady && (!this.component.hasOwnProperty('reference') || this.component.reference) && !this.shouldConditionallyClear();
     }
     /**
      * Returns the data for the subform.

package/lib/mjs/Embed.js

@@ -14,7 +14,7 @@ export class Formio {
         Formio._formioReady = ready;
         Formio._formioReadyReject = reject;
     });
-    static version = '5.1.0-rc.27';
+    static version = '5.1.0-rc.28';
     static setLicense(license, norecurse = false) {
         Formio.license = license;
         if (!norecurse && Formio.FormioClass) {

package/lib/mjs/Formio.js

@@ -4,7 +4,7 @@ import CDN from './CDN';
 import Providers from './providers';
 FormioCore.cdn = new CDN();
 FormioCore.Providers = Providers;
-FormioCore.version = '5.1.0-rc.27';
+FormioCore.version = '5.1.0-rc.28';
 CDN.defaultCDN = FormioCore.version.includes('rc') ? 'https://cdn.test-form.io' : 'https://cdn.form.io';
 const isNil = (val) => val === null || val === undefined;
 FormioCore.prototype.uploadFile = function (storage, file, fileName, dir, progressCallback, url, options, fileKey, groupPermissions, groupId, uploadStartCallback, abortCallback, multipartOptions) {

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

@@ -163,6 +163,7 @@ declare class Component extends Element {
      */
     info: any;
     get componentsMap(): object;
+    parentShouldConditionallyClear(): boolean;
     parentConditionallyHidden(): boolean;
     set data(value: any);
     get data(): any;
@@ -227,7 +228,8 @@ declare class Component extends Element {
     get visible(): boolean;
     get logicallyHidden(): any;
     _logicallyHidden: any;
-    conditionallyHidden(skipParent?: boolean): any;
+    shouldConditionallyClear(skipParent?: boolean): boolean;
+    conditionallyHidden(skipParent?: boolean): boolean;
     set currentForm(instance: any);
     get currentForm(): any;
     _currentForm: any;
@@ -890,7 +892,15 @@ declare class Component extends Element {
      * @returns {boolean} - TRUE if a default value is set.
      */
     get hasDefaultValue(): boolean;
+    /**
+     * Determine if we should add a default value for this component.
+     * @returns {boolean} - TRUE if a default value should be set
+     */
     get shouldAddDefaultValue(): boolean;
+    /**
+     * Get the default value of this component.
+     * @returns {*} - The default value for this component.
+     */
     get defaultValue(): any;
     /**
      * Get the input value of this component.

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

@@ -388,7 +388,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.conditionallyHidden() && this.component.clearOnHide)) {
+                if (!this.shouldConditionallyClear()) {
                     if (!this.hasValue()) {
                         if (this.shouldAddDefaultValue) {
                             this.dataValue = this.defaultValue;
@@ -418,6 +418,16 @@ export default class Component extends Element {
     get componentsMap() {
         return this.root?.childComponentsMap || {};
     }
+    parentShouldConditionallyClear() {
+        let currentParent = this.parent;
+        while (currentParent) {
+            if (currentParent.shouldConditionallyClear(true)) {
+                return true;
+            }
+            currentParent = currentParent.parent;
+        }
+        return false;
+    }
     parentConditionallyHidden() {
         let currentParent = this.parent;
         while (currentParent) {
@@ -636,11 +646,48 @@ export default class Component extends Element {
         }
         return this._logicallyHidden;
     }
+    shouldConditionallyClear(skipParent = false) {
+        // Skip if this component has clearOnHide set to false.
+        if (this.component.clearOnHide === false) {
+            return false;
+        }
+        // If the component is logically hidden, then it is conditionally hidden and should clear.
+        if (this.logicallyHidden) {
+            return true;
+        }
+        // If we have a condition and it is not conditionally visible, the it should conditionally clear.
+        if (this.hasCondition() && !this.conditionallyVisible()) {
+            return true;
+        }
+        if (skipParent) {
+            // Stop recurrsion for the parent checks.
+            return false;
+        }
+        // If this component has a set value, then it should ONLY clear if a parent is hidden
+        // and has the clearOnHide set to true.
+        if (this.hasSetValue) {
+            return this.parentShouldConditionallyClear();
+        }
+        // Clear the value if the parent is conditionally hidden.
+        return this.parentConditionallyHidden();
+    }
     conditionallyHidden(skipParent = false) {
-        if (!this.hasCondition()) {
-            return this.logicallyHidden || (skipParent ? false : this.parentConditionallyHidden());
+        if (this.logicallyHidden) {
+            return true;
+        }
+        if (!this.hasCondition() && !skipParent) {
+            return this.parentConditionallyHidden();
+        }
+        // Return if we are not conditionally visible (conditionallyHidden)
+        if (!this.conditionallyVisible()) {
+            return true;
+        }
+        if (skipParent) {
+            // Stop recurrsion for the parent checks.
+            return false;
         }
-        return !this.conditionallyVisible() || this.logicallyHidden || (skipParent ? false : this.parentConditionallyHidden());
+        // Check the parent.
+        return this.parentConditionallyHidden();
     }
     get currentForm() {
         return this._currentForm;
@@ -2041,7 +2088,7 @@ export default class Component extends Element {
                         component: newComponent,
                         result,
                     });
-                    if (!_.isEqual(oldValue, newValue) && !(this.component.clearOnHide && this.conditionallyHidden())) {
+                    if (!_.isEqual(oldValue, newValue) && !this.shouldConditionallyClear()) {
                         this.setValue(newValue);
                         if (this.viewOnly) {
                             this.dataValue = newValue;
@@ -2074,7 +2121,7 @@ export default class Component extends Element {
                         component: newComponent,
                         result,
                     }, 'value');
-                    if (!_.isEqual(oldValue, newValue) && !(this.component.clearOnHide && this.conditionallyHidden())) {
+                    if (!_.isEqual(oldValue, newValue) && !this.shouldConditionallyClear()) {
                         this.setValue(newValue);
                         if (this.viewOnly) {
                             this.dataValue = newValue;
@@ -2180,7 +2227,7 @@ export default class Component extends Element {
     clearComponentOnHide() {
         // clearOnHide defaults to true for old forms (without the value set) so only trigger if the value is false.
         if (this.component.clearOnHide !== false && !this.options.readOnly && !this.options.showHiddenFields) {
-            if (this.conditionallyHidden()) {
+            if (this.shouldConditionallyClear()) {
                 this.deleteValue();
             }
             else if (!this.hasValue() && this.shouldAddDefaultValue) {
@@ -2506,15 +2553,17 @@ export default class Component extends Element {
             (this.component.defaultValue !== null) &&
             (this.component.defaultValue !== undefined));
     }
+    /**
+     * Determine if we should add a default value for this component.
+     * @returns {boolean} - TRUE if a default value should be set
+     */
     get shouldAddDefaultValue() {
-        // It should add a default value if...
-        //  1.) Ensure they have not set "noDefaults". If that is true, then will always return false.  AND
-        //  2.) The component is pristine (user has not manually modified it).  AND
-        //  3.) There is a default value setting present and it is not NULL or UNDEFINED.
-        return !this.options.noDefaults && this.pristine && (this.hasDefaultValue ||
-            // Empty strings and booleans are allowed primitives whose defaults are automatically added.
-            (this.emptyValue === '' || (typeof this.emptyValue === 'boolean')));
+        return this.pristine && this.allowData && (this.hasDefaultValue || !this.options.noDefaults);
     }
+    /**
+     * Get the default value of this component.
+     * @returns {*} - The default value for this component.
+     */
     get defaultValue() {
         let defaultValue = this.emptyValue;
         if (this.component.defaultValue) {
@@ -2784,10 +2833,8 @@ 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.conditionallyHidden() && clearOnHide;
         const allowOverride = _.get(this.component, 'allowCalculateOverride', false);
-        if (shouldBeCleared) {
+        if (this.shouldConditionallyClear()) {
             // remove calculated value so that the value is recalculated once component becomes visible
             if (this.hasOwnProperty('calculatedValue') && allowOverride) {
                 _.unset(this, 'calculatedValue');

package/lib/mjs/components/address/editForm/Address.edit.display.d.ts

@@ -8,6 +8,7 @@ declare const _default: ({
     customConditional: ({ data }: {
         data: any;
     }) => boolean;
+    defaultValue?: undefined;
     placeholder?: undefined;
     validate?: undefined;
 } | {
@@ -15,6 +16,7 @@ declare const _default: ({
     type: string;
     input: boolean;
     key: string;
+    defaultValue: string;
     label: string;
     placeholder: string;
     tooltip: string;
@@ -32,6 +34,7 @@ declare const _default: ({
     label: string;
     tooltip: string;
     customConditional?: undefined;
+    defaultValue?: undefined;
     placeholder?: undefined;
     validate?: undefined;
 } | {
@@ -45,6 +48,7 @@ declare const _default: ({
     customConditional: ({ data }: {
         data: any;
     }) => any;
+    defaultValue?: undefined;
     validate?: undefined;
 })[];
 export default _default;

package/lib/mjs/components/address/editForm/Address.edit.display.js

@@ -13,6 +13,7 @@ export default [
         type: 'textfield',
         input: true,
         key: 'switchToManualModeLabel',
+        defaultValue: 'Can\'t find address? Switch to manual mode.',
         label: 'Switch To Manual Mode Label',
         placeholder: 'Switch To Manual Mode Label',
         tooltip: 'The label for the checkbox used to switch to manual mode.',

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

@@ -517,7 +517,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.conditionallyHidden() || !this.component.clearOnHide);
+        return this.subFormReady && (!this.component.hasOwnProperty('reference') || this.component.reference) && !this.shouldConditionallyClear();
     }
     /**
      * Returns the data for the subform.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@formio/js",
-  "version": "5.1.0-rc.27",
+  "version": "5.1.0-rc.28",
   "description": "JavaScript powered Forms with JSON Form Builder",
   "main": "lib/cjs/index.js",
   "exports": {