@formio/js 5.5.1 → 5.6.0

package/lib/mjs/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/mjs/components/file/editForm/File.edit.file.js

@@ -290,8 +290,9 @@ export 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/mjs/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/mjs/components/form/Form.js

@@ -554,16 +554,38 @@ export default class FormComponent extends Component {
             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/mjs/components/signature/Signature.js

@@ -199,7 +199,7 @@ export default class SignatureComponent extends Input {
                 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.
@@ -228,7 +228,7 @@ export default class SignatureComponent extends Input {
             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/mjs/package.json

@@ -1,5 +1,5 @@
 {
     "type": "module",
-    "version": "5.5.1"
+    "version": "5.6.0"
     
 }

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

package/lib/mjs/providers/address/GoogleAddressProvider.js

@@ -5,6 +5,7 @@ import { AddressProvider } from './AddressProvider';
 const GOOGLE_MAPS_BASE_URL = 'https://maps.googleapis.com';
 const GOOGLE_MAPS_JS_URL = `${GOOGLE_MAPS_BASE_URL}/maps/api/js`;
 const GOOGLE_MAPS_JS_WITH_PARAMS_URL = `${GOOGLE_MAPS_JS_URL}?v=quarterly&libraries=places&loading=async&callback=googleMapsCallback`;
+const NEW_PLACES_API_VERSION = 'newPlacesApi';
 /**
  * @typedef {object} AutocompleteOptions
  * @property {string[]} fields - The fields to include in the autocomplete response.
@@ -71,6 +72,18 @@ export class GoogleAddressProvider extends AddressProvider {
     get alternativeDisplayValueProperty() {
         return 'formatted_address';
     }
+    /**
+     * @returns {string} The property to use for display value on places returned by the new Places API.
+     */
+    get newApiDisplayValueProperty() {
+        return 'formattedAddress';
+    }
+    /**
+     * @returns {boolean} Whether the provider is configured to use the new Places API.
+     */
+    get usesNewPlacesApi() {
+        return this.options?.version === NEW_PLACES_API_VERSION;
+    }
     /**
      * @param {AutocompleteOptions} options - The autocomplete options.
      */
@@ -88,10 +101,11 @@ export class GoogleAddressProvider extends AddressProvider {
   
      */
     setAutocompleteOptions() {
-        let options = _.get(this.options, 'autocompleteOptions', {});
-        if (!_.isObject(options)) {
-            options = {};
-        }
+        // Clone so the stored provider options are never mutated: the required fields
+        // differ per Places API version, and stale fields from a previous computation
+        // must not leak into the next one (FIO-10428).
+        const storedOptions = _.get(this.options, 'autocompleteOptions', {});
+        const options = _.isObject(storedOptions) ? _.cloneDeep(storedOptions) : {};
         this.addRequiredProviderOptions(options);
         this.autocompleteOptions = options;
     }
@@ -131,14 +145,9 @@ export class GoogleAddressProvider extends AddressProvider {
      * @returns {string[]} The required address properties.
      */
     getRequiredAddressProperties() {
-        return [
-            'address_components',
-            'formatted_address',
-            'geometry',
-            'place_id',
-            'plus_code',
-            'types',
-        ];
+        return this.usesNewPlacesApi
+            ? ['addressComponents', 'formattedAddress', 'location', 'viewport', 'id', 'plusCode', 'types']
+            : ['address_components', 'formatted_address', 'geometry', 'place_id', 'plus_code', 'types'];
     }
     /**
      * Adds the required provider options to the options.
@@ -167,24 +176,75 @@ export class GoogleAddressProvider extends AddressProvider {
         }
         return filteredPlace;
     }
-    attachAutocomplete(elem, index, onSelectAddress) {
+    attachAutocomplete(elem, index, onSelectAddress, disable = false) {
+        if (disable) {
+            return Promise.resolve();
+        }
         return Formio.libraryReady(this.getLibraryName()).then(() => {
-            const autocomplete = new google.maps.places.Autocomplete(elem, this.autocompleteOptions);
-            const listener = autocomplete.addListener('place_changed', () => {
-                const place = this.filterPlace(autocomplete.getPlace());
-                place.formattedPlace = _.get(autocomplete, 'gm_accessors_.place.se.formattedPrediction', place[this.alternativeDisplayValueProperty]);
-                onSelectAddress(place, elem, index);
-            });
-            return () => {
-                if (google?.maps?.event) {
-                    google.maps.event.clearInstanceListeners(autocomplete);
-                    google.maps.event.removeListener(listener);
-                }
-                document.querySelectorAll('.pac-container').forEach((node) => {
-                    if (node.parentNode) {
-                        node.parentNode.removeChild(node);
-                    }
+            this.setAutocompleteOptions();
+            if (!this.usesNewPlacesApi) {
+                const autocomplete = new google.maps.places.Autocomplete(elem, this.autocompleteOptions);
+                const listener = autocomplete.addListener('place_changed', () => {
+                    const place = this.filterPlace(autocomplete.getPlace());
+                    place.formattedPlace = _.get(autocomplete, 'gm_accessors_.place.se.formattedPrediction', place[this.alternativeDisplayValueProperty]);
+                    onSelectAddress(place, elem, index);
                 });
+                return () => {
+                    if (google?.maps?.event) {
+                        google.maps.event.clearInstanceListeners(autocomplete);
+                        google.maps.event.removeListener(listener);
+                    }
+                    document.querySelectorAll('.pac-container').forEach((node) => {
+                        if (node.parentNode) {
+                            node.parentNode.removeChild(node);
+                        }
+                    });
+                };
+            }
+            const { fields, componentRestrictions, ...elementOptions } = this.autocompleteOptions;
+            const country = componentRestrictions?.country;
+            if (country) {
+                // The new element spells legacy componentRestrictions.country as includedRegionCodes.
+                elementOptions.includedRegionCodes = _.castArray(country);
+            }
+            elementOptions.noInputIcon = true;
+            const autocomplete = new google.maps.places.PlaceAutocompleteElement(elementOptions);
+            if (elem?.value) {
+                autocomplete.value = elem.value;
+            }
+            autocomplete.classList.add('form-control');
+            // Replace the existing element with the autocomplete element
+            elem.parentNode.replaceChildren(autocomplete);
+            const handlePlaceSelect = async (event) => {
+                let selectedPlace;
+                try {
+                    const place = event.placePrediction.toPlace();
+                    await place.fetchFields({
+                        fields: fields || this.getRequiredAddressProperties(),
+                    });
+                    const convertedPlace = {
+                        addressComponents: place.addressComponents || [],
+                        formattedAddress: place.formattedAddress || '',
+                        location: place.location || {},
+                        viewport: place.viewport || {},
+                        id: place.id || '',
+                        plusCode: place.plusCode || {},
+                        types: place.types || [],
+                    };
+                    selectedPlace = this.filterPlace(convertedPlace);
+                    selectedPlace.formattedPlace = convertedPlace.formattedAddress;
+                }
+                catch (err) {
+                    // fetchFields rejections are otherwise swallowed by the Maps event
+                    // dispatcher; never let a failed details request drop the selection.
+                    console.warn(`Unable to fetch the selected place's details: ${err}`);
+                    selectedPlace = { formattedPlace: String(event.placePrediction?.text ?? '') };
+                }
+                onSelectAddress(selectedPlace, elem, index);
+            };
+            autocomplete.addEventListener('gmp-select', handlePlaceSelect);
+            return () => {
+                autocomplete.removeEventListener('gmp-select', handlePlaceSelect);
             };
         });
     }
@@ -195,10 +255,12 @@ export class GoogleAddressProvider extends AddressProvider {
         return Promise.resolve();
     }
     getDisplayValue(address) {
-        const displayedProperty = _.has(address, this.displayValueProperty)
-            ? this.displayValueProperty
-            : this.alternativeDisplayValueProperty;
-        return _.get(address, displayedProperty, '');
+        const displayedProperty = [
+            this.displayValueProperty,
+            this.alternativeDisplayValueProperty,
+            this.newApiDisplayValueProperty,
+        ].find((property) => _.has(address, property));
+        return displayedProperty ? _.get(address, displayedProperty, '') : '';
     }
     /**
      * Tries to remove the library if api key for loaded script is different.

package/lib/mjs/providers/storage/indexeddb.js

@@ -1,4 +1,4 @@
-import { v4 as uuidv4 } from 'uuid';
+import { guid } from '../../utils/utils';
 /**
  * indexedDb provider for file storage.
  * @returns {import('./typedefs').FileProvider} The FileProvider interface defined in index.js.
@@ -27,7 +27,7 @@ function indexeddb() {
                 return new Promise((resolve, reject) => {
                     reader.onload = () => {
                         const blobObject = new Blob([file], { type: file.type });
-                        const id = uuidv4(blobObject);
+                        const id = guid();
                         const data = {
                             id,
                             data: blobObject,

package/lib/mjs/utils/utils.d.ts

@@ -163,11 +163,6 @@ export function convertStringToHTMLElement(str: string, selector: string): HTMLE
  * @returns {string} - A unique filename.
  */
 export function uniqueName(name: string, template: string, evalContext: object): string;
-/**
- * Returns a GUID
- * @returns {string} - A GUID.
- */
-export function guid(): string;
 /**
  * Return a translated date setting.
  * @param {string|Date} date - The date to translate.
@@ -520,6 +515,7 @@ export function announceScreenReaderMessage(component: any, value: any, index?:
  * @param {string} text The text to output to screen readers
  */
 export function screenReaderSpeech(text: string): void;
+export { guid };
 /**
  * Map values through unfold and return first non-nil value.
  * @param {Array<T>} collection - The collection to map through unfold.;
@@ -536,3 +532,4 @@ export namespace componentValueTypes {
     let any: string;
 }
 export function interpolateErrors(component: Component, errors: FieldError[], interpolateFn: Function): [];
+import { guid } from './formUtils';

package/lib/mjs/utils/utils.js

@@ -2,7 +2,7 @@ import _ from 'lodash';
 import moment from 'moment-timezone/moment-timezone';
 import jtz from 'jstimezonedetect';
 import dompurify from 'dompurify';
-import { getValue } from './formUtils';
+import { getValue, guid } from './formUtils';
 import { Evaluator } from './Evaluator';
 import ConditionOperators from './conditionOperators';
 import { jsonLogic, convertShowToBoolean } from '@formio/core';
@@ -529,17 +529,8 @@ export function uniqueName(name, template, evalContext) {
     const uniqueName = `${Evaluator.interpolate(template, evalContext)}${extension}`.replace(/[^0-9a-zA-Z.\-_ ]/g, '-');
     return uniqueName;
 }
-/**
- * Returns a GUID
- * @returns {string} - A GUID.
- */
-export function guid() {
-    return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, (c) => {
-        const r = (Math.random() * 16) | 0;
-        const v = c === 'x' ? r : (r & 0x3) | 0x8;
-        return v.toString(16);
-    });
-}
+// Re-export GUID generator from @formio/core to avoid duplication
+export { guid };
 /**
  * Return a translated date setting.
  * @param {string|Date} date - The date to translate.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@formio/js",
-  "version": "5.5.1",
+  "version": "5.6.0",
   "description": "JavaScript powered Forms with JSON Form Builder",
   "main": "lib/cjs/index.js",
   "exports": {
@@ -56,6 +56,8 @@
   },
   "homepage": "https://github.com/formio/formio.js#readme",
   "dependencies": {
+    "@formio/bootstrap": "^4.0.5",
+    "@formio/core": "^2.8.3",
     "@formio/text-mask-addons": "^3.8.0-formio.4",
     "@formio/vanilla-text-mask": "^5.1.1-formio.1",
     "abortcontroller-polyfill": "^1.7.5",
@@ -69,7 +71,7 @@
     "core-js": "^3.37.1",
     "dialog-polyfill": "^0.5.6",
     "dom-autoscroller": "^2.3.4",
-    "dompurify": "^3.4.12",
+    "dompurify": "^3.4.13",
     "downloadjs": "^1.4.7",
     "dragula": "^3.7.3",
     "eventemitter3": "^5.0.1",
@@ -88,12 +90,10 @@
     "signature_pad": "^4.2.0",
     "string-hash": "^1.1.3",
     "tippy.js": "^6.3.7",
-    "uuid": "^9.0.0",
-    "vanilla-picker": "^2.12.3",
-    "@formio/bootstrap": "^4.0.4",
-    "@formio/core": "^2.8.1"
+    "vanilla-picker": "^2.12.3"
   },
   "devDependencies": {
+    "@formio/eslint-config": "0.0.0",
     "@types/node": "^22.15.19",
     "ace-builds": "1.34.2",
     "async-limiter": "^2.0.0",
@@ -146,8 +146,7 @@
     "webpack-bundle-analyzer": "^4.10.2",
     "webpack-cli": "^5.1.1",
     "webpack-node-externals": "^3.0.0",
-    "webpack-stream": "^7.0.0",
-    "@formio/eslint-config": "0.0.0"
+    "webpack-stream": "^7.0.0"
   },
   "ossRepo": {
     "repo": "https://github.com/formio/formio.js.git",