@formio/js 5.1.0-rc.8 → 5.1.0

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

@@ -20,7 +20,6 @@ export default class AddressComponent extends ContainerComponent {
             key: 'address',
             switchToManualModeLabel: 'Can\'t find address? Switch to manual mode.',
             provider: '',
-            providerOptions: {},
             manualModeViewString: '',
             hideLabel: false,
             disableClearIcon: false,
@@ -113,20 +112,33 @@ export default class AddressComponent extends ContainerComponent {
             NestedComponent.prototype.addComponents.call(this, this.manualMode ? this.address : {});
         }
         Field.prototype.init.call(this);
+        // Added for backwards compatibility
+        if (this.component.providerOptions) {
+            const { params, url, queryProperty, responseProperty, displayValueProperty } = this.component.providerOptions;
+            const key = params?.key;
+            const autocompleteOptions = params?.autocompleteOptions;
+            delete this.component.providerOptions;
+            this.component.url = url;
+            this.component.queryProperty = queryProperty;
+            this.component.responseProperty = responseProperty;
+            this.component.displayValueProperty = displayValueProperty;
+            this.component.apiKey = key;
+            this.component.autocompleteOptions = autocompleteOptions;
+        }
+        let provider = this.component.provider;
+        const providerOptions = this.providerOptions;
+        const map = this.component.map;
         if (!this.builderMode) {
-            if (this.component.provider) {
-                const { provider, providerOptions, } = this.component;
+            if (provider) {
                 if (_.get(providerOptions, 'params.subscriptionKey')) {
                     _.set(providerOptions, "params['subscription-key']", _.get(providerOptions, 'params.subscriptionKey'));
                     _.unset(providerOptions, 'params.subscriptionKey');
                 }
                 this.provider = this.initializeProvider(provider, providerOptions);
             }
-            else if (this.component.map) {
+            else if (map) {
                 // Fallback to legacy version where Google Maps was the only provider.
-                this.component.provider = GoogleAddressProvider.name;
-                this.component.providerOptions = this.component.providerOptions || {};
-                const { map, provider, providerOptions, } = this.component;
+                provider = this.component.provider = GoogleAddressProvider.name;
                 const { key, region, } = map;
                 if (key) {
                     _.set(providerOptions, 'params.key', key);
@@ -258,6 +270,16 @@ export default class AddressComponent extends ContainerComponent {
             ? (this.refs[AddressComponent.modeSwitcherRef] || null)
             : null;
     }
+    get providerOptions() {
+        return {
+            params: { subscriptionKey: this.component.subscriptionKey, key: this.component.apiKey, ...this.component.params },
+            url: this.component.url,
+            queryProperty: this.component.queryProperty,
+            responseProperty: this.component.responseProperty,
+            displayValueProperty: this.component.displayValueProperty,
+            autocompleteOptions: this.component.autocompleteOptions
+        };
+    }
     get removeValueIcon() {
         return this.refs
             ? (this.refs[AddressComponent.removeValueIconRef] || null)
@@ -371,7 +393,8 @@ export default class AddressComponent extends ContainerComponent {
         const result = ((this.builderMode || this.manualMode) ? super.attach : Field.prototype.attach).call(this, element);
         if (!this.builderMode) {
             if (!this.provider && this.component.provider) {
-                const { provider, providerOptions, } = this.component;
+                const provider = this.component.provider;
+                const providerOptions = this.providerOptions;
                 this.provider = this.initializeProvider(provider, providerOptions);
             }
         }

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/address/editForm/Address.edit.provider.js

@@ -26,7 +26,7 @@ export default [
     {
         type: 'textfield',
         input: true,
-        key: "providerOptions.params.subscriptionKey",
+        key: "subscriptionKey",
         label: 'Subscription Key',
         placeholder: 'Enter Subscription Key',
         weight: 10,
@@ -41,7 +41,7 @@ export default [
     {
         type: 'textfield',
         input: true,
-        key: 'providerOptions.url',
+        key: 'url',
         label: 'Url',
         placeholder: 'Enter Url',
         weight: 10,
@@ -56,7 +56,7 @@ export default [
     {
         type: 'textfield',
         input: true,
-        key: 'providerOptions.queryProperty',
+        key: 'queryProperty',
         label: 'Query Property',
         defaultValue: 'query',
         placeholder: 'Enter Query Property',
@@ -69,7 +69,7 @@ export default [
     {
         type: 'textfield',
         input: true,
-        key: 'providerOptions.responseProperty',
+        key: 'responseProperty',
         label: 'Response Property',
         placeholder: 'Enter Response Property',
         weight: 30,
@@ -81,7 +81,7 @@ export default [
     {
         type: 'textfield',
         input: true,
-        key: 'providerOptions.displayValueProperty',
+        key: 'displayValueProperty',
         label: 'Display Value Property',
         placeholder: 'Display Value Property',
         weight: 40,
@@ -93,7 +93,7 @@ export default [
     {
         type: 'textarea',
         input: true,
-        key: 'providerOptions.params',
+        key: 'params',
         label: 'Params',
         placeholder: '{ ... }',
         weight: 50,
@@ -108,7 +108,7 @@ export default [
     {
         type: 'textfield',
         input: true,
-        key: 'providerOptions.params.key',
+        key: 'apiKey',
         label: 'API Key',
         placeholder: 'Enter API Key',
         weight: 10,
@@ -123,7 +123,7 @@ export default [
     {
         type: 'textarea',
         input: true,
-        key: 'providerOptions.params.autocompleteOptions',
+        key: 'autocompleteOptions',
         label: 'Provider options',
         placeholder: 'Enter provider options as JSON object',
         defaultValue: {},

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

@@ -393,7 +393,7 @@ export default class DataGridComponent extends NestedArrayComponent {
             row
         });
         this.checkConditions();
-        this.triggerChange();
+        this.triggerChange({ modified: true });
         this.redraw().then(() => {
             this.focusOnNewRowElement(this.rows[index]);
         });
@@ -472,6 +472,9 @@ export default class DataGridComponent extends NestedArrayComponent {
             options.name += `[${rowIndex}]`;
             options.row = `${rowIndex}-${colIndex}`;
             options.rowIndex = rowIndex;
+            options.onChange = (flags, changed, modified) => {
+                this.triggerChange({ modified });
+            };
             let columnComponent;
             if (this.builderMode) {
                 col.id = col.id + rowIndex;
@@ -591,9 +594,6 @@ export default class DataGridComponent extends NestedArrayComponent {
         this.updateOnChange(flags, changed);
         return changed;
     }
-    restoreComponentsContext() {
-        this.rows.forEach((row, index) => _.forIn(row, (component) => component.data = this.dataValue[index]));
-    }
     toggleGroup(element, index) {
         element.classList.toggle('collapsed');
         _.each(this.refs.chunks[index], row => {

package/lib/mjs/components/datamap/DataMap.js

@@ -68,14 +68,10 @@ export default class DataMapComponent extends DataGridComponent {
         return {};
     }
     get dataValue() {
-        if (!this.key ||
-            (this.conditionallyHidden && this.component.clearOnHide)) {
+        if (!this.key) {
             return this.emptyValue;
         }
-        if (!this.hasValue() && this.shouldAddDefaultValue) {
-            this.dataValue = this.emptyValue;
-        }
-        return _.get(this.data, this.key);
+        return _.get(this.data, this.key, this.emptyValue);
     }
     set dataValue(value) {
         super.dataValue = value;

package/lib/mjs/components/datetime/DateTime.d.ts

@@ -20,6 +20,6 @@ export default class DateTimeComponent extends Input {
     get momentFormat(): string;
     createWrapper(): boolean;
     checkValidity(data: any, dirty: any, rowData: any): boolean;
-    getValueAsString(value: any): any;
+    getValueAsString(value: any, options: any): any;
 }
 import Input from '../_classes/input/Input';

package/lib/mjs/components/datetime/DateTime.js

@@ -1,7 +1,7 @@
 import _ from 'lodash';
 import moment from 'moment';
 import FormioUtils from '../../utils';
-import { componentValueTypes, getComponentSavedTypes } from '../../utils/utils';
+import { componentValueTypes, fastCloneDeep, getComponentSavedTypes } from '../../utils/utils';
 import Input from '../_classes/input/Input';
 export default class DateTimeComponent extends Input {
     static schema(...extend) {
@@ -127,6 +127,10 @@ export default class DateTimeComponent extends Input {
             maxDate: _.get(this.component, 'datePicker.maxDate'),
             ...customOptions,
         };
+        // update originalComponent to include widget and other updated settings
+        // it is done here since these settings depend on properties present after the component is initialized
+        // originalComponent is used to restore the component (and widget) after evaluating field logic
+        this.originalComponent = fastCloneDeep(this.component);
         /* eslint-enable camelcase */
     }
     get defaultSchema() {
@@ -173,15 +177,15 @@ export default class DateTimeComponent extends Input {
         }
         return super.checkValidity(data, dirty, rowData);
     }
-    getValueAsString(value) {
+    getValueAsString(value, options) {
         let format = FormioUtils.convertFormatToMoment(this.component.format);
         format += format.match(/z$/) ? '' : ' z';
         const timezone = this.timezone;
         if (value && !this.attached && timezone) {
             if (Array.isArray(value) && this.component.multiple) {
-                return value.map(item => _.trim(FormioUtils.momentDate(item, format, timezone).format(format))).join(', ');
+                return value.map(item => _.trim(FormioUtils.momentDate(item, format, timezone, options).format(format))).join(', ');
             }
-            return _.trim(FormioUtils.momentDate(value, format, timezone).format(format));
+            return _.trim(FormioUtils.momentDate(value, format, timezone, options).format(format));
         }
         if (Array.isArray(value) && this.component.multiple) {
             return value.map(item => _.trim(moment(item).format(format))).join(', ');

package/lib/mjs/components/datetime/editForm/DateTime.edit.validation.d.ts

@@ -6,36 +6,87 @@ declare const _default: ({
     persistent: boolean;
     weight: number;
     tooltip: string;
+    applyMaskOn?: undefined;
+    logic?: undefined;
     skipMerge?: undefined;
-    customConditional?: undefined;
+    tableView?: undefined;
+    validateWhenHidden?: undefined;
     enableTime?: undefined;
 } | {
+    label: string;
+    tooltip: string;
+    applyMaskOn: string;
+    key: string;
+    logic: ({
+        name: string;
+        trigger: {
+            type: string;
+            javascript: string;
+            event?: undefined;
+        };
+        actions: {
+            name: string;
+            type: string;
+            schemaDefinition: string;
+        }[];
+    } | {
+        name: string;
+        trigger: {
+            type: string;
+            event: string;
+            javascript?: undefined;
+        };
+        actions: {
+            name: string;
+            type: string;
+            customAction: string;
+        }[];
+    })[];
     type: string;
     input: boolean;
-    key: string;
-    label: string;
     skipMerge: boolean;
     weight: number;
-    tooltip: string;
-    customConditional({ data, component }: {
-        data: any;
-        component: any;
-    }): boolean;
     persistent?: undefined;
+    tableView?: undefined;
+    validateWhenHidden?: undefined;
     enableTime?: undefined;
 } | {
+    label: string;
+    tooltip: string;
+    applyMaskOn: string;
+    tableView: boolean;
+    validateWhenHidden: boolean;
+    key: string;
+    logic: ({
+        name: string;
+        trigger: {
+            type: string;
+            javascript: string;
+            event?: undefined;
+        };
+        actions: {
+            name: string;
+            type: string;
+            schemaDefinition: string;
+        }[];
+    } | {
+        name: string;
+        trigger: {
+            type: string;
+            event: string;
+            javascript?: undefined;
+        };
+        actions: {
+            name: string;
+            type: string;
+            customAction: string;
+        }[];
+    })[];
     type: string;
     input: boolean;
     enableTime: boolean;
-    key: string;
     skipMerge: boolean;
-    label: string;
     weight: number;
-    tooltip: string;
-    customConditional({ data, component }: {
-        data: any;
-        component: any;
-    }): any;
     persistent?: undefined;
 })[];
 export default _default;

package/lib/mjs/components/datetime/editForm/DateTime.edit.validation.js

@@ -9,35 +9,44 @@ export default [
         tooltip: 'Enables to use input for moment functions instead of calendar.'
     },
     {
-        type: 'datetime',
-        input: true,
+        label: 'Minimum Date',
+        tooltip: "The minimum date that can be picked. You can also use Moment.js functions. For example: moment().subtract(10, 'days')",
+        applyMaskOn: 'change',
         key: 'datePicker.minDate',
-        label: 'Use calendar to set minDate',
-        skipMerge: true,
-        weight: 10,
-        tooltip: 'Enables to use calendar to set date.',
-        customConditional({ data, component }) {
-            if (component.datePicker && component.datePicker.minDate && component.datePicker.minDate.indexOf('moment') !== -1) {
-                return false;
-            }
-            return !data.enableMinDateInput;
-        },
-    },
-    {
+        logic: [
+            {
+                name: 'check input mode',
+                trigger: {
+                    type: 'javascript',
+                    javascript: "if (component.datePicker && component.datePicker.minDate && component.datePicker.minDate.indexOf('moment') !== -1) {\r\n  result = false;\r\n}\r\nelse {\r\n  result = !data.enableMinDateInput;\r\n}",
+                },
+                actions: [
+                    {
+                        name: 'change component',
+                        type: 'mergeComponentSchema',
+                        schemaDefinition: "schema = {\n  type: 'datetime',\n  label: 'Use calendar to set minDate',\n  enableDate: true,\n  enableTime: true,\n  tooltip: 'Enables to use calendar to set date.',\n  widget: {\n    type: 'calendar',\n    displayInTimezone: 'viewer',\n    locale: 'en',\n    useLocaleSettings: false,\n    allowInput: true,\n    mode: 'single',\n    enableTime: true,\n    noCalendar: false,\n    format: 'yyyy-MM-dd hh:mm a',\n    hourIncrement: 1,\n    minuteIncrement: 1,\n    time_24hr: false,\n    disableWeekends: false,\n    disableWeekdays: false,\n    maxDate: null,\n  },\n};",
+                    },
+                ],
+            },
+            {
+                name: 'clear value',
+                trigger: {
+                    type: 'event',
+                    event: 'componentChange',
+                },
+                actions: [
+                    {
+                        name: 'reset value',
+                        type: 'customAction',
+                        customAction: "var isDateInput = instance.component?.type === 'datetime';\nvar enableInput = data.enableMinDateInput;\nvar allowReset = result[0].component && result[0].component.key === 'enableMinDateInput' && !result[0].flags?.fromSubmission;\nif(((enableInput && isDateInput) || (!enableInput && !isDateInput)) && allowReset) {\n  instance.resetValue()\n}\n",
+                    },
+                ],
+            },
+        ],
         type: 'textfield',
         input: true,
-        enableTime: false,
-        key: 'datePicker.minDate',
         skipMerge: true,
-        label: 'Minimum Date',
         weight: 10,
-        tooltip: 'The minimum date that can be picked. You can also use Moment.js functions. For example: \n \n moment().subtract(10, \'days\')',
-        customConditional({ data, component }) {
-            if (component.datePicker && component.datePicker.minDate && component.datePicker.minDate.indexOf('moment') !== -1) {
-                return true;
-            }
-            return data.enableMinDateInput;
-        },
     },
     {
         type: 'checkbox',
@@ -49,34 +58,46 @@ export default [
         tooltip: 'Enables to use input for moment functions instead of calendar.'
     },
     {
-        type: 'datetime',
-        input: true,
+        label: 'Maximum Date',
+        tooltip: "The maximum date that can be picked. You can also use Moment.js functions. For example: moment().add(10, 'days')",
+        applyMaskOn: 'change',
+        tableView: true,
+        validateWhenHidden: false,
         key: 'datePicker.maxDate',
-        skipMerge: true,
-        label: 'Use calendar to set maxDate',
-        weight: 20,
-        tooltip: 'Enables to use calendar to set date.',
-        customConditional({ data, component }) {
-            if (component.datePicker && component.datePicker.maxDate && component.datePicker.maxDate.indexOf('moment') !== -1) {
-                return false;
-            }
-            return !data.enableMaxDateInput;
-        },
-    },
-    {
+        logic: [
+            {
+                name: 'check input mode',
+                trigger: {
+                    type: 'javascript',
+                    javascript: "if (component.datePicker && component.datePicker.maxDate && component.datePicker.maxDate.indexOf('moment') !== -1) {\r\n  result = false;\r\n}\r\nelse {\r\n  result = !data.enableMaxDateInput;\r\n}",
+                },
+                actions: [
+                    {
+                        name: 'change component',
+                        type: 'mergeComponentSchema',
+                        schemaDefinition: "schema = {\n  type: 'datetime',\n  label: 'Use calendar to set maxDate',\n  enableDate: true,\n  enableTime: true,\n  tooltip: 'Enables to use calendar to set date.',\n  widget: {\n    type: 'calendar',\n    displayInTimezone: 'viewer',\n    locale: 'en',\n    useLocaleSettings: false,\n    allowInput: true,\n    mode: 'single',\n    enableTime: true,\n    noCalendar: false,\n    format: 'yyyy-MM-dd hh:mm a',\n    hourIncrement: 1,\n    minuteIncrement: 1,\n    time_24hr: false,\n    disableWeekends: false,\n    disableWeekdays: false,\n    maxDate: null,\n  },\n};",
+                    },
+                ],
+            },
+            {
+                name: 'clear value',
+                trigger: {
+                    type: 'event',
+                    event: 'componentChange',
+                },
+                actions: [
+                    {
+                        name: 'reset value',
+                        type: 'customAction',
+                        customAction: "var isDateInput = instance.component?.type === 'datetime';\nvar enableInput = data.enableMaxDateInput;\nvar allowReset = result[0].component && result[0].component.key === 'enableMaxDateInput' && !result[0].flags?.fromSubmission;\nif(((enableInput && isDateInput) || (!enableInput && !isDateInput)) && allowReset) {\n  instance.resetValue()\n}\n",
+                    },
+                ],
+            },
+        ],
         type: 'textfield',
         input: true,
         enableTime: false,
-        key: 'datePicker.maxDate',
         skipMerge: true,
-        label: 'Maximum Date',
-        tooltip: 'The maximum date that can be picked. You can also use Moment.js functions. For example: \n \n moment().add(10, \'days\')',
         weight: 20,
-        customConditional({ data, component }) {
-            if (component.datePicker && component.datePicker.maxDate && component.datePicker.maxDate.indexOf('moment') !== -1) {
-                return true;
-            }
-            return data.enableMaxDateInput;
-        },
     }
 ];

package/lib/mjs/components/day/Day.js

@@ -2,6 +2,7 @@ import _ from 'lodash';
 import moment from 'moment';
 import Field from '../_classes/field/Field';
 import { boolValue, componentValueTypes, getComponentSavedTypes, getLocaleDateFormatInfo } from '../../utils/utils';
+import { getDayFormat } from '@formio/core';
 export default class DayComponent extends Field {
     static schema(...extend) {
         return Field.schema({
@@ -474,24 +475,7 @@ export default class DayComponent extends Field {
      * @returns {string} - the format for the value string.
      */
     get format() {
-        let format = '';
-        if (this.component.dayFirst && this.showDay) {
-            format += 'D/';
-        }
-        if (this.showMonth) {
-            format += 'M/';
-        }
-        if (!this.component.dayFirst && this.showDay) {
-            format += 'D/';
-        }
-        if (this.showYear) {
-            format += 'YYYY';
-            return format;
-        }
-        else {
-            // Trim off the "/" from the end of the format string.
-            return format.length ? format.substring(0, format.length - 1) : format;
-        }
+        return getDayFormat(this.component);
     }
     /**
      * Return the date for this component.

package/lib/mjs/components/editgrid/EditGrid.js

@@ -543,13 +543,6 @@ export default class EditGridComponent extends NestedArrayComponent {
             }
         });
     }
-    restoreComponentsContext() {
-        this.getComponents().forEach((component) => {
-            const rowData = this.dataValue[component.rowIndex];
-            const editRowData = this.editRows[component.rowIndex]?.data;
-            component.data = rowData || editRowData;
-        });
-    }
     flattenComponents(rowIndex) {
         const result = {};
         this.everyComponent((component) => {
@@ -1088,7 +1081,9 @@ export default class EditGridComponent extends NestedArrayComponent {
             errors.push(...this._errors);
             return false;
         }
-        const message = this.invalid || this.invalidMessage(data, dirty, false, row);
+        // TODO: this is the only place invalidMessage gets called, and it's not clear why it's needed - we already validate the editGrid
+        // component above with super.checkComponentValidity
+        const message = this.invalid || this.invalidMessage(data, dirty, false, row, options);
         if (allRowErrors.length && this.root?.submitted && !message) {
             this._errors = this.setCustomValidity(message, dirty);
             errors.push(...this._errors);
@@ -1132,9 +1127,6 @@ export default class EditGridComponent extends NestedArrayComponent {
             }
         }
         const changed = this.hasChanged(value, this.dataValue);
-        if (this.parent) {
-            this.parent.checkComponentConditions();
-        }
         this.dataValue = value;
         // Refresh editRow data when data changes.
         this.dataValue.forEach((row, rowIndex) => {
@@ -1165,7 +1157,6 @@ export default class EditGridComponent extends NestedArrayComponent {
         this.editRows = this.editRows.slice(0, dataLength);
         this.openWhenEmpty();
         this.updateOnChange(flags, changed);
-        this.checkData();
         this.changeState(changed, flags);
         return changed;
     }