@formio/js 5.5.2 → 5.6.1

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

@@ -20,7 +20,7 @@
 
 /*! @license DOMPurify 3.4.13 | (c) Cure53 and other contributors | Released under the Apache license 2.0 and Mozilla Public License 2.0 | github.com/cure53/DOMPurify/blob/3.4.13/LICENSE */
 
-/*! formiojs v5.5.2 | https://unpkg.com/formiojs@5.5.2/LICENSE.txt */
+/*! formiojs v5.6.1 | https://unpkg.com/formiojs@5.6.1/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

@@ -500,7 +500,7 @@ Formio.formioReady = new Promise((ready, reject) => {
     _a._formioReady = ready;
     _a._formioReadyReject = reject;
 });
-Formio.version = '5.5.2';
+Formio.version = '5.6.1';
 // 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.5.2';
+sdk_1.Formio.version = '5.6.1';
 CDN_1.default.defaultCDN = sdk_1.Formio.version.includes('rc')
     ? 'https://cdn.test-form.io'
     : 'https://cdn.form.io';

package/lib/cjs/components/Components.js

@@ -68,11 +68,7 @@ class Components {
         else {
             comp = new Component_1.default(component, options, data);
         }
-        if (comp.path) {
-            comp.eachRootChildComponentsMap((map) => {
-                map[comp.path] = comp;
-            });
-        }
+        comp.registerComponentInstance();
         // Reset the componentMatches on the root element if any new component is created.
         let parent = comp.parent;
         while (parent) {

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

@@ -171,6 +171,20 @@ declare class Component extends Element {
      * @param {(map: object) => void} fn - Called once per root that exposes a `childComponentsMap`.
      */
     eachRootChildComponentsMap(fn: (map: object) => void): void;
+    /**
+     * Registers this instance in every root's `childComponentsMap`. Several components can resolve
+     * to one data path — see `getSharedPathKey` in `@formio/core` for the rule this follows.
+     * @returns {void}
+     */
+    registerComponentInstance(): void;
+    sharedPathKey: string | undefined;
+    /**
+     * Removes this instance from every root's `childComponentsMap`.
+     * @param {string} [path] - The path this instance was registered under, when it has since
+     * been re-keyed (a DataGrid row index change regenerates paths before unregistering).
+     * @returns {void}
+     */
+    unregisterComponentInstance(path?: string | undefined): void;
     /**
      * Returns if the parent should conditionally clear.
      *

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

@@ -441,6 +441,39 @@ class Component extends Element_1.default {
             currentRoot = currentRoot.root;
         }
     }
+    /**
+     * Registers this instance in every root's `childComponentsMap`. Several components can resolve
+     * to one data path — see `getSharedPathKey` in `@formio/core` for the rule this follows.
+     * @returns {void}
+     */
+    registerComponentInstance() {
+        const path = this.path;
+        if (!path) {
+            return;
+        }
+        // Recorded on every instance, not just the ones that lose the race for the path: it names
+        // this registration for `unregisterComponentInstance()`, which can run after `path` changed.
+        this.sharedPathKey = utils_1.default.getSharedPathKey(path, this.component.key);
+        this.eachRootChildComponentsMap((map) => {
+            utils_1.default.registerInstanceAtPath(map, path, this.component.key, this);
+        });
+    }
+    /**
+     * Removes this instance from every root's `childComponentsMap`.
+     * @param {string} [path] - The path this instance was registered under, when it has since
+     * been re-keyed (a DataGrid row index change regenerates paths before unregistering).
+     * @returns {void}
+     */
+    unregisterComponentInstance(path = this.path) {
+        this.eachRootChildComponentsMap((map) => {
+            if (map[path] === this) {
+                delete map[path];
+            }
+            if (this.sharedPathKey && map[this.sharedPathKey] === this) {
+                delete map[this.sharedPathKey];
+            }
+        });
+    }
     /**
      * Returns if the parent should conditionally clear.
      *
@@ -925,11 +958,12 @@ class Component extends Element_1.default {
      * @returns {string} - The translated text.
      */
     t(text, params = {}, ...args) {
+        var _a;
         if (!text) {
             return '';
         }
         // Use _userInput: true to ignore translations from defaults
-        if (text in en_1.default && params._userInput) {
+        if (((_a = this.i18next) === null || _a === void 0 ? void 0 : _a.language) === 'en' && text in en_1.default && params._userInput) {
             return text;
         }
         params.data = params.data || this.rootValue;

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

@@ -557,11 +557,7 @@ class NestedComponent extends Field_1.default {
         components = components || this.components;
         component.destroy(all);
         lodash_1.default.remove(components, { id: component.id });
-        component.eachRootChildComponentsMap((map) => {
-            if (map[component.path]) {
-                delete map[component.path];
-            }
-        });
+        component.unregisterComponentInstance();
     }
     /**
      * Removes a component provided the API key of that component.
@@ -671,9 +667,11 @@ class NestedComponent extends Field_1.default {
         var _a;
         const { dirty } = flags;
         if (this.root && this.root.hasSubWizards && this.page !== this.root.page) {
-            instance = ((_a = this.componentsMap) === null || _a === void 0 ? void 0 : _a.hasOwnProperty(paths.dataPath))
-                ? this.componentsMap[paths.dataPath]
-                : this.getComponent(paths.dataPath);
+            // `instance` was resolved by @formio/core against this very map, shared-path rule and
+            // all, so only fill in what that lookup cannot reach: components keyed by their data
+            // path where core looked under a full path, and components absent from the map.
+            instance =
+                instance || ((_a = this.componentsMap) === null || _a === void 0 ? void 0 : _a[paths.dataPath]) || this.getComponent(paths.dataPath);
         }
         if (!instance) {
             return;

package/lib/cjs/components/address/Address.js

@@ -417,8 +417,12 @@ class AddressComponent extends Container_1.default {
         this.searchInput.forEach((element, index) => {
             if (!this.builderMode && element && this.provider) {
                 if (this.component.provider === 'google') {
+                    if (this.component.enableNewPlacesApi) {
+                        this.provider.options.version = 'newPlacesApi';
+                    }
                     this.googlePlacesCleanups = [];
-                    this.provider.attachAutocomplete(element, index, this.onSelectAddress.bind(this))
+                    this.provider
+                        .attachAutocomplete(element, index, this.onSelectAddress.bind(this), this.disabled)
                         .then((cleanup) => {
                         if (typeof cleanup === 'function') {
                             this.googlePlacesCleanups.push(cleanup);
@@ -514,7 +518,6 @@ class AddressComponent extends Container_1.default {
         if (this.autocompleterWidget && typeof this.autocompleterWidget.destroy === 'function') {
             this.autocompleterWidget.destroy();
         }
-        ;
         (this.googlePlacesCleanups || []).forEach((cleanup) => {
             cleanup();
         });

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

@@ -118,6 +118,30 @@ declare const _default: ({
     validate?: undefined;
     defaultValue?: undefined;
     description?: undefined;
+} | {
+    weight: number;
+    type: string;
+    input: boolean;
+    key: string;
+    label: string;
+    tooltip: string;
+    conditional: {
+        json: {
+            '===': (string | {
+                var: string;
+            })[];
+        };
+    };
+    placeholder?: undefined;
+    valueProperty?: undefined;
+    dataSrc?: undefined;
+    data?: undefined;
+    validate?: undefined;
+    defaultValue?: undefined;
+    rows?: undefined;
+    editor?: undefined;
+    as?: undefined;
+    description?: undefined;
 } | {
     type: string;
     input: boolean;

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

@@ -141,6 +141,19 @@ exports.default = [
             },
         },
     },
+    {
+        weight: 10,
+        type: 'checkbox',
+        input: true,
+        key: 'enableNewPlacesApi',
+        label: 'Places API (New)',
+        tooltip: 'Enable the new Google Places API instead of the legacy version.',
+        conditional: {
+            json: {
+                '===': [{ var: 'data.provider' }, 'google'],
+            },
+        },
+    },
     {
         type: 'textarea',
         input: true,

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

@@ -436,12 +436,8 @@ class DataGridComponent extends NestedArrayComponent_1.default {
             component.rowIndex = rowIndex;
             component.row = `${rowIndex}-${colIndex}`;
             entries.forEach(({ instance, oldPath }) => {
-                instance.eachRootChildComponentsMap((map) => {
-                    if (map[oldPath] === instance) {
-                        delete map[oldPath];
-                    }
-                    map[instance.paths.dataPath] = instance;
-                });
+                instance.unregisterComponentInstance(oldPath);
+                instance.registerComponentInstance();
             });
         });
     }
@@ -547,7 +543,8 @@ class DataGridComponent extends NestedArrayComponent_1.default {
                     }, modified);
                     this.triggerRootChange(flags, changed, modified);
                 }
-                this.processRow('checkData', null, Object.assign(Object.assign({}, flags), { changed }), row, lodash_1.default.toArray(this.rows[rowIndex]));
+                const rowData = this.dataValue[rowIndex];
+                this.processRow('checkData', null, Object.assign(Object.assign({}, flags), { changed }), rowData, lodash_1.default.toArray(this.rows[rowIndex]));
             };
             let columnComponent;
             if (this.builderMode) {

package/lib/cjs/components/file/File.js

@@ -103,6 +103,11 @@ class FileComponent extends Field_1.default {
         this.abortUploads = [];
         this.pendingfiles = [];
         this.resolvedFiles = [];
+        const imageSize = Number(this.component.imageSize);
+        const isValidImageSize = imageSize > 0;
+        if (!isValidImageSize) {
+            this.component.imageSize = '200';
+        }
     }
     get dataReady() {
         return this.filesReady || Promise.resolve();
@@ -637,7 +642,7 @@ class FileComponent extends Field_1.default {
             fileKey: this.component.fileKey || 'file',
             storage: this.component.storage,
             options: this.component.storage === 'url'
-                ? (this.component.urlRequestOptions || this.component.options)
+                ? this.component.urlRequestOptions || this.component.options
                 : this.component.options,
             file,
             size: file.size,
@@ -673,7 +678,9 @@ class FileComponent extends Field_1.default {
         return fileWithSameNameUploaded || fileWithSameNameUploading
             ? {
                 status: 'error',
-                message: this.t(fileWithSameNameUploading ? 'fileWithDuplicatedNameInProgress' : 'fileWithDuplicatedNameLoaded'),
+                message: this.t(fileWithSameNameUploading
+                    ? 'fileWithDuplicatedNameInProgress'
+                    : 'fileWithDuplicatedNameLoaded'),
             }
             : {};
     }
@@ -872,8 +879,8 @@ class FileComponent extends Field_1.default {
     deleteFile(fileInfo) {
         return __awaiter(this, void 0, void 0, function* () {
             const options = this.component.storage === 'url'
-                ? (this.component.urlRequestOptions || this.component.options || {})
-                : (this.component.options || {});
+                ? this.component.urlRequestOptions || this.component.options || {}
+                : this.component.options || {};
             if (fileInfo &&
                 ['url', 'indexeddb', 's3', 'azure', 'googledrive'].includes(this.component.storage)) {
                 const { fileService } = this;
@@ -1013,7 +1020,7 @@ class FileComponent extends Field_1.default {
                     delete fileToSync.progress;
                     this.redraw();
                     if (fileInfo) {
-                        const fileExists = this.resolvedFiles.find(x => x.fileInfo.originalName === fileToSync.originalName);
+                        const fileExists = this.resolvedFiles.find((x) => x.fileInfo.originalName === fileToSync.originalName);
                         if (!fileExists && fileToSync.status !== 'error') {
                             this.resolvedFiles.push({ fileToSync, fileInfo });
                         }
@@ -1071,8 +1078,8 @@ class FileComponent extends Field_1.default {
     }
     getFile(fileInfo) {
         const options = this.component.storage === 'url'
-            ? (this.component.urlRequestOptions || this.component.options || {})
-            : (this.component.options || {});
+            ? this.component.urlRequestOptions || this.component.options || {}
+            : this.component.options || {};
         const { fileService } = this;
         if (!fileService) {
             return alert(this.t('noFileService'));
@@ -1113,7 +1120,9 @@ class FileComponent extends Field_1.default {
                     return Promise.resolve();
                 }
                 yield this.syncFiles();
-                return this.shouldSyncFiles ? Promise.reject(this.t('synchronizationFailed')) : Promise.resolve();
+                return this.shouldSyncFiles
+                    ? Promise.reject(this.t('synchronizationFailed'))
+                    : Promise.resolve();
             }
             catch (error) {
                 return Promise.reject(error.message);

package/lib/cjs/components/file/editForm/File.edit.file.d.ts

@@ -18,6 +18,7 @@ declare const _default: ({
     editor?: undefined;
     as?: undefined;
     logic?: undefined;
+    clearOnHide?: undefined;
     optionsLabelPosition?: undefined;
     inline?: undefined;
     defaultValue?: undefined;
@@ -48,6 +49,7 @@ declare const _default: ({
     editor?: undefined;
     as?: undefined;
     logic?: undefined;
+    clearOnHide?: undefined;
     optionsLabelPosition?: undefined;
     inline?: undefined;
     defaultValue?: undefined;
@@ -95,6 +97,7 @@ declare const _default: ({
     editor?: undefined;
     as?: undefined;
     logic?: undefined;
+    clearOnHide?: undefined;
     optionsLabelPosition?: undefined;
     inline?: undefined;
     defaultValue?: undefined;
@@ -125,6 +128,7 @@ declare const _default: ({
     editor?: undefined;
     as?: undefined;
     logic?: undefined;
+    clearOnHide?: undefined;
     optionsLabelPosition?: undefined;
     inline?: undefined;
     defaultValue?: undefined;
@@ -161,6 +165,7 @@ declare const _default: ({
     editor?: undefined;
     as?: undefined;
     logic?: undefined;
+    clearOnHide?: undefined;
     optionsLabelPosition?: undefined;
     inline?: undefined;
     defaultValue?: undefined;
@@ -191,6 +196,7 @@ declare const _default: ({
     tableView?: undefined;
     components?: undefined;
     logic?: undefined;
+    clearOnHide?: undefined;
     optionsLabelPosition?: undefined;
     inline?: undefined;
     defaultValue?: undefined;
@@ -237,6 +243,7 @@ declare const _default: ({
     rows?: undefined;
     editor?: undefined;
     as?: undefined;
+    clearOnHide?: undefined;
     optionsLabelPosition?: undefined;
     inline?: undefined;
     defaultValue?: undefined;
@@ -259,6 +266,7 @@ declare const _default: ({
     editor?: undefined;
     as?: undefined;
     logic?: undefined;
+    clearOnHide?: undefined;
     optionsLabelPosition?: undefined;
     inline?: undefined;
     defaultValue?: undefined;
@@ -281,6 +289,7 @@ declare const _default: ({
     editor?: undefined;
     as?: undefined;
     logic?: undefined;
+    clearOnHide?: undefined;
     optionsLabelPosition?: undefined;
     inline?: undefined;
     defaultValue?: undefined;
@@ -311,6 +320,7 @@ declare const _default: ({
     editor?: undefined;
     as?: undefined;
     logic?: undefined;
+    clearOnHide?: undefined;
     optionsLabelPosition?: undefined;
     inline?: undefined;
     defaultValue?: undefined;
@@ -323,6 +333,7 @@ declare const _default: ({
     placeholder: string;
     tooltip: string;
     weight: number;
+    clearOnHide: boolean;
     conditional: {
         json: {
             '==': (boolean | {
@@ -345,6 +356,37 @@ declare const _default: ({
     inline?: undefined;
     defaultValue?: undefined;
     values?: undefined;
+} | {
+    type: string;
+    input: boolean;
+    key: string;
+    label: string;
+    placeholder: string;
+    tooltip: string;
+    weight: number;
+    conditional: {
+        json: {
+            '==': (boolean | {
+                var: string;
+            })[];
+            '==='?: undefined;
+            in?: undefined;
+        };
+    };
+    valueProperty?: undefined;
+    dataSrc?: undefined;
+    data?: undefined;
+    tableView?: undefined;
+    components?: undefined;
+    rows?: undefined;
+    editor?: undefined;
+    as?: undefined;
+    logic?: undefined;
+    clearOnHide?: undefined;
+    optionsLabelPosition?: undefined;
+    inline?: undefined;
+    defaultValue?: undefined;
+    values?: undefined;
 } | {
     type: string;
     input: boolean;
@@ -370,6 +412,7 @@ declare const _default: ({
     editor?: undefined;
     as?: undefined;
     logic?: undefined;
+    clearOnHide?: undefined;
 } | {
     type: string;
     input: boolean;
@@ -393,6 +436,7 @@ declare const _default: ({
     editor?: undefined;
     as?: undefined;
     logic?: undefined;
+    clearOnHide?: undefined;
     optionsLabelPosition?: undefined;
     inline?: undefined;
     defaultValue?: undefined;

package/lib/cjs/components/file/editForm/File.edit.file.js

@@ -295,8 +295,9 @@ exports.default = [
         key: 'imageSize',
         label: 'Image Size',
         placeholder: '100',
-        tooltip: 'The image size for previewing images.',
+        tooltip: 'The image size, in square pixels, for previewing images.',
         weight: 40,
+        clearOnHide: false,
         conditional: {
             json: {
                 '==': [{ var: 'data.image' }, true],

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

@@ -63,6 +63,13 @@ export default class FormComponent extends Component {
     checkComponentConditions(data: any, flags: any, row: any): any;
     calculateValue(data: any, flags: any, row: any): any;
     setPristine(pristine: any): void;
+    /**
+     * Determine if an ancestor is hidden by the `hidden` JSON flag alone. An ancestor that has its
+     * own condition is governed by that condition instead and is left to `parentConditionallyHidden`
+     * — the `hidden` flag and conditionally-hidden are distinct states (FIO-11691).
+     * @returns {boolean} - TRUE if an ancestor is hidden in the JSON and has no condition.
+     */
+    hasAncestorHiddenInJsonOnly(): boolean;
     /**
      * Determine if the subform should be submitted.
      * @returns {*|boolean} - TRUE if the subform should be submitted, FALSE if it should not.

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

@@ -564,16 +564,38 @@ class FormComponent extends Component_1.default {
             this.subForm.setPristine(pristine);
         }
     }
+    /**
+     * Determine if an ancestor is hidden by the `hidden` JSON flag alone. An ancestor that has its
+     * own condition is governed by that condition instead and is left to `parentConditionallyHidden`
+     * — the `hidden` flag and conditionally-hidden are distinct states (FIO-11691).
+     * @returns {boolean} - TRUE if an ancestor is hidden in the JSON and has no condition.
+     */
+    hasAncestorHiddenInJsonOnly() {
+        let currentParent = this.parent;
+        while (currentParent) {
+            if (currentParent.component.hidden && !currentParent.hasCondition()) {
+                return true;
+            }
+            currentParent = currentParent.parent;
+        }
+        return false;
+    }
     /**
      * Determine if the subform should be submitted.
      * @returns {*|boolean} - TRUE if the subform should be submitted, FALSE if it should not.
      */
     get shouldSubmit() {
+        const savesAsReference = !this.component.hasOwnProperty('reference') || this.component.reference;
         const hiddenByJsonOnly = !this.hasCondition() && this.component.hidden;
+        // Layout ancestors (fieldset, panel, tabs...) hide us without appearing in our data path, so
+        // their hidden state is only reachable by walking the instance chain (FIO-9879).
+        const hiddenByAncestor = this.hasAncestorHiddenInJsonOnly() || this.parentConditionallyHidden();
+        // Gate on our own clearOnHide, never an ancestor's.
+        const clearedWhileHidden = (hiddenByJsonOnly || hiddenByAncestor) && this.component.clearOnHide;
         return (this.subFormReady &&
-            (!this.component.hasOwnProperty('reference') || this.component.reference) &&
+            savesAsReference &&
             !this.shouldConditionallyClear() &&
-            !(hiddenByJsonOnly && this.component.clearOnHide));
+            !clearedWhileHidden);
     }
     /**
      * Returns the data for the subform.

package/lib/cjs/components/signature/Signature.js

@@ -203,7 +203,7 @@ class SignatureComponent extends Input_1.default {
                 penColor: this.component.penColor,
                 backgroundColor: this.component.backgroundColor,
             });
-            this.signaturePad.addEventListener('endStroke', () => this.setValue(this.signaturePad.toDataURL()));
+            this.signaturePad.addEventListener('endStroke', () => this.setValue(this.signaturePad.toDataURL(), { modified: true }));
             this.refs.signatureImage.setAttribute('src', this.signaturePad.toDataURL());
             this.onDisabled();
             // Ensure the signature is always the size of its container.
@@ -232,7 +232,7 @@ class SignatureComponent extends Input_1.default {
             event.preventDefault();
             this.showCanvas(true);
             this.signaturePad.clear();
-            this.setValue(this.defaultValue);
+            this.setValue(this.defaultValue, { modified: true });
         });
         this.setValue(this.dataValue);
         return superAttach;

package/lib/cjs/package.json

@@ -1,4 +1,4 @@
 {
     "type": "commonjs",
-    "version": "5.5.2"
+    "version": "5.6.1"
 }

package/lib/cjs/providers/address/GoogleAddressProvider.d.ts

@@ -39,6 +39,14 @@ export class GoogleAddressProvider extends AddressProvider {
      * @returns {string} The alternative property to use for display value.
      */
     get alternativeDisplayValueProperty(): string;
+    /**
+     * @returns {string} The property to use for display value on places returned by the new Places API.
+     */
+    get newApiDisplayValueProperty(): string;
+    /**
+     * @returns {boolean} Whether the provider is configured to use the new Places API.
+     */
+    get usesNewPlacesApi(): boolean;
     /**
      * @param {AutocompleteOptions} options - The autocomplete options.
      */
@@ -78,7 +86,7 @@ export class GoogleAddressProvider extends AddressProvider {
      */
     addRequiredProviderOptions(options: AutocompleteOptions): void;
     filterPlace(place: any): {};
-    attachAutocomplete(elem: any, index: any, onSelectAddress: any): any;
+    attachAutocomplete(elem: any, index: any, onSelectAddress: any, disable?: boolean): any;
     search(): Promise<void>;
     makeRequest(): Promise<void>;
     getDisplayValue(address: any): any;