@formio/js 5.0.2 → 5.1.0-dev.5522.066969f

package/lib/mjs/utils/utils.js

@@ -1,42 +1,19 @@
 /* global jQuery */
 import _ from 'lodash';
-import jsonLogic from 'json-logic-js';
 import moment from 'moment-timezone/moment-timezone';
 import jtz from 'jstimezonedetect';
-import { lodashOperators } from './jsonlogic/operators';
 import dompurify from 'dompurify';
+import dayjs from "dayjs";
+import utc from 'dayjs/plugin/utc';
+import timezone from 'dayjs/plugin/timezone';
+import advancedFormat from 'dayjs/plugin/advancedFormat';
+import { jsonLogic, convertShowToBoolean } from '@formio/core';
 import { getValue } from './formUtils';
 import { Evaluator } from './Evaluator';
 import ConditionOperators from './conditionOperators';
-import { convertShowToBoolean } from '@formio/core';
-const interpolate = Evaluator.interpolate;
-export * from './formUtils';
-// Configure JsonLogic
-lodashOperators.forEach((name) => jsonLogic.add_operation(`_${name}`, _[name]));
-// Retrieve Any Date
-jsonLogic.add_operation('getDate', (date) => {
-    return moment(date).toISOString();
-});
-// Set Relative Minimum Date
-jsonLogic.add_operation('relativeMinDate', (relativeMinDate) => {
-    return moment().subtract(relativeMinDate, 'days').toISOString();
-});
-// Set Relative Maximum Date
-jsonLogic.add_operation('relativeMaxDate', (relativeMaxDate) => {
-    return moment().add(relativeMaxDate, 'days').toISOString();
-});
-export { jsonLogic, ConditionOperators, moment };
-/**
- * Sets the path to the component and parent schema.
- * @param {import('@formio/core').Component} component - The component to set the path for.
- */
-function setPathToComponentAndPerentSchema(component) {
-    component.path = getComponentPath(component);
-    const dataParent = getDataParentComponent(component);
-    if (dataParent && typeof dataParent === 'object') {
-        dataParent.path = getComponentPath(dataParent);
-    }
-}
+dayjs.extend(timezone);
+dayjs.extend(advancedFormat);
+dayjs.extend(utc);
 /**
  * Evaluate a method.
  * @param {Function|string|object} func - The function to evaluate.
@@ -222,13 +199,21 @@ export function checkSimpleConditional(component, condition, row, data, instance
                 return true;
             }
             const splittedConditionPath = conditionComponentPath.split('.');
-            const conditionalPaths = instance?.parent?.type === 'datagrid' || instance?.parent?.type === 'editgrid' ? [] : getConditionalPathsRecursive(splittedConditionPath, data);
+            const checkParentTypeInTree = (instance, componentType) => {
+                if (!instance?.parent) {
+                    return false;
+                }
+                return instance?.parent.type === componentType || checkParentTypeInTree(instance.parent, componentType);
+            };
+            const conditionalPaths = checkParentTypeInTree(instance, 'datagrid') || checkParentTypeInTree(instance, 'editgrid')
+                ? []
+                : getConditionalPathsRecursive(splittedConditionPath, data);
             if (conditionalPaths.length > 0) {
                 return conditionalPaths.map((path) => {
                     const value = getComponentActualValue(path, data, row);
                     const ConditionOperator = ConditionOperators[operator];
                     return ConditionOperator
-                        ? new ConditionOperator().getResult({ value, comparedValue, instance, component, conditionComponentPath })
+                        ? new ConditionOperator().getResult({ value, comparedValue, instance, component, path })
                         : true;
                 });
             }
@@ -236,7 +221,7 @@ export function checkSimpleConditional(component, condition, row, data, instance
                 const value = getComponentActualValue(conditionComponentPath, data, row);
                 const СonditionOperator = ConditionOperators[operator];
                 return СonditionOperator
-                    ? new СonditionOperator().getResult({ value, comparedValue, instance, component, conditionComponentPath })
+                    ? new СonditionOperator().getResult({ value, comparedValue, instance, component, path: conditionComponentPath })
                     : true;
             }
         });
@@ -333,17 +318,18 @@ function getRow(component, row, instance, conditional) {
     // If no component's instance passed (happens only in 6.x server), calculate its path based on the schema
     if (!instance) {
         instance = _.cloneDeep(component);
-        setPathToComponentAndPerentSchema(instance);
     }
     const dataParent = getDataParentComponent(instance);
-    const parentPath = dataParent ? getComponentPath(dataParent) : null;
-    const isTriggerCondtionComponentPath = condition.when || !condition.conditions
-        ? condition.when?.startsWith(parentPath)
-        : _.some(condition.conditions, cond => cond.component.startsWith(parentPath));
-    if (dataParent && isTriggerCondtionComponentPath) {
-        const newRow = {};
-        _.set(newRow, parentPath, row);
-        row = newRow;
+    if (dataParent) {
+        const parentPath = dataParent.paths?.localPath;
+        const isTriggerCondtionComponentPath = condition.when || !condition.conditions
+            ? condition.when?.startsWith(dataParent.paths?.localPath)
+            : _.some(condition.conditions, cond => cond.component.startsWith(dataParent.paths?.localPath));
+        if (isTriggerCondtionComponentPath) {
+            const newRow = {};
+            _.set(newRow, parentPath, row);
+            row = newRow;
+        }
     }
     return row;
 }
@@ -515,7 +501,7 @@ export function guid() {
 /**
  * Return a translated date setting.
  * @param {string|Date} date - The date to translate.
- * @returns {(null|Date)} - The translated date.
+ * @returns {(null|dayjs.Dayjs)} - The translated date.
  */
 export function getDateSetting(date) {
     if (_.isNil(date) || _.isNaN(date) || date === '') {
@@ -535,13 +521,13 @@ export function getDateSetting(date) {
     try {
         const value = Evaluator.evaluator(`return ${date};`, 'moment')(moment);
         if (typeof value === 'string') {
-            dateSetting = moment(value);
+            dateSetting = dayjs(value);
         }
         else if (typeof value.toDate === 'function') {
-            dateSetting = moment(value.toDate().toUTCString());
+            dateSetting = dayjs(value.toDate().toUTCString());
         }
         else if (value instanceof Date) {
-            dateSetting = moment(value);
+            dateSetting = dayjs(value);
         }
     }
     catch (e) {
@@ -569,17 +555,17 @@ export function isValidDate(date) {
  * @returns {string} - The current timezone.
  */
 export function currentTimezone() {
-    if (moment.currentTimezone) {
-        return moment.currentTimezone;
+    if (dayjs.currentTimezone) {
+        return dayjs.currentTimezone;
     }
-    moment.currentTimezone = jtz.determine().name();
-    return moment.currentTimezone;
+    dayjs.currentTimezone = jtz.determine().name();
+    return dayjs.currentTimezone;
 }
 /**
  * Get an offset date provided a date object and timezone object.
  * @param {Date} date - The date to offset.
  * @param {string} timezone - The timezone to offset the date to.
- * @returns {Date} - The offset date.
+ * @returns {{date: Date, abbr: string}} - The offset date.
  */
 export function offsetDate(date, timezone) {
     if (timezone === 'UTC') {
@@ -588,133 +574,89 @@ export function offsetDate(date, timezone) {
             abbr: 'UTC'
         };
     }
-    const dateMoment = moment(date).tz(timezone);
+    const dateMoment = dayjs(date).tz(timezone);
     return {
         date: new Date(date.getTime() + ((dateMoment.utcOffset() + date.getTimezoneOffset()) * 60000)),
         abbr: dateMoment.format('z')
     };
 }
 /**
- * Returns if the zones are loaded.
- * @returns {boolean} - TRUE if the zones are loaded; FALSE otherwise.
- */
-export function zonesLoaded() {
-    return moment.zonesLoaded;
-}
-/**
- * Returns if we should load the zones.
+ * Returns if we should handle a timezone difference.
  * @param {string} timezone - The timezone to check if we should load the zones.
- * @returns {boolean} - TRUE if we should load the zones; FALSE otherwise.
+ * @returns {boolean} - TRUE if we should handle timezones; FALSE otherwise.
  */
-export function shouldLoadZones(timezone) {
-    if (timezone === currentTimezone() || timezone === 'UTC') {
-        return false;
-    }
-    return true;
-}
-/**
- * Externally load the timezone data.
- * @param {string} url - The URL to load the timezone data from.
- * @param {string} timezone - The timezone to load.
- * @returns {Promise<any> | *} - Resolves when the zones for this timezone are loaded.
- */
-export function loadZones(url, timezone) {
-    if (timezone && !shouldLoadZones(timezone)) {
-        // Return non-resolving promise.
-        return new Promise(_.noop);
-    }
-    if (moment.zonesPromise) {
-        return moment.zonesPromise;
-    }
-    return moment.zonesPromise = fetch(url)
-        .then(resp => resp.json().then(zones => {
-        moment.tz.load(zones);
-        moment.zonesLoaded = true;
-        // Trigger a global event that the timezones have finished loading.
-        if (document && document.createEvent && document.body && document.body.dispatchEvent) {
-            var event = document.createEvent('Event');
-            event.initEvent('zonesLoaded', true, true);
-            document.body.dispatchEvent(event);
-        }
-    }));
+export function shouldHandleTimezone(timezone) {
+    return !(timezone === currentTimezone() || timezone === 'UTC');
 }
 /**
- * Get the moment date object for translating dates with timezones.
- * @param {string|Date} value - The value to convert into a moment date.
+ * Get the Dayjs date object for translating dates with timezones.
+ * @param {string|Date} value - The value to convert into a dayjs date.
  * @param {string} format - The format to convert the date to.
  * @param {string} timezone - The timezone to convert the date to.
- * @returns {Date} - The moment date object.
+ * @param {object} options - The options object
+ * @returns {dayjs.Dayjs} - The dayjs date object.
  */
-export function momentDate(value, format, timezone) {
-    const momentDate = moment(value);
+export function dayjsDate(value, format, timezone, options) {
+    const dayjsDate = dayjs(value);
     if (!timezone) {
-        return momentDate;
+        return dayjsDate;
     }
     if (timezone === 'UTC') {
         timezone = 'Etc/UTC';
     }
-    if ((timezone !== currentTimezone() || (format && format.match(/\s(z$|z\s)/))) && moment.zonesLoaded) {
-        return momentDate.tz(timezone);
+    if ((timezone !== currentTimezone() || (format && format.match(/\s(z$|z\s)/))) && (shouldHandleTimezone(timezone) || options?.email)) {
+        return dayjsDate.tz(timezone);
     }
-    return momentDate;
+    return dayjsDate;
 }
 /**
  * Format a date provided a value, format, and timezone object.
- * @param {string} timezonesUrl - The URL to load the timezone data from.
  * @param {string|Date} value - The value to format.
  * @param {string} format - The format to format the date to.
  * @param {string} timezone - The timezone to format the date to.
  * @param {string} flatPickrInputFormat - The format to use for flatpickr input.
  * @returns {string} - The formatted date.
  */
-export function formatDate(timezonesUrl, value, format, timezone, flatPickrInputFormat) {
-    const momentDate = moment(value, flatPickrInputFormat || undefined);
+export function formatDate(value, format, timezone, flatPickrInputFormat) {
+    const dayjsDate = dayjs(value, flatPickrInputFormat || undefined);
     if (timezone === currentTimezone()) {
         // See if our format contains a "z" timezone character.
         if (format.match(/\s(z$|z\s)/)) {
-            loadZones(timezonesUrl);
-            if (moment.zonesLoaded) {
-                return momentDate.tz(timezone).format(convertFormatToMoment(format));
+            if (shouldHandleTimezone(timezone)) {
+                return dayjsDate.tz(timezone).format(convertFormatToDayjs(format));
             }
             else {
-                return momentDate.format(convertFormatToMoment(format.replace(/\s(z$|z\s)/, '')));
+                return dayjsDate.format(convertFormatToDayjs(format.replace(/\s(z$|z\s)/, '')));
             }
         }
         // Return the standard format.
-        return momentDate.format(convertFormatToMoment(format));
+        return dayjsDate.format(convertFormatToDayjs(format));
     }
     if (timezone === 'UTC') {
-        const offset = offsetDate(momentDate.toDate(), 'UTC');
-        return `${moment(offset.date).format(convertFormatToMoment(format))} UTC`;
-    }
-    // Load the zones since we need timezone information.
-    loadZones(timezonesUrl);
-    if (moment.zonesLoaded && timezone) {
-        return momentDate.tz(timezone).format(`${convertFormatToMoment(format)} z`);
+        const offset = offsetDate(dayjsDate.toDate(), 'UTC');
+        return `${dayjs(offset.date).format(convertFormatToDayjs(format))} UTC`;
     }
-    else {
-        return momentDate.format(convertFormatToMoment(format));
+    if (shouldHandleTimezone(timezone)) {
+        return dayjsDate.tz(timezone).format(`${convertFormatToDayjs(format)} z`);
     }
+    return dayjsDate.format(convertFormatToDayjs(format));
 }
 /**
  * Pass a format function to format within a timezone.
- * @param {string} timezonesUrl - The URL to load the timezone data from.
  * @param {Function} formatFn - The format function to use.
  * @param {Date|string} date - The date to format.
  * @param {string} format - The format to format the date to.
  * @param {string} timezone - The timezone to format the date to.
  * @returns {string} - The formatted date.
  */
-export function formatOffset(timezonesUrl, formatFn, date, format, timezone) {
+export function formatOffset(formatFn, date, format, timezone) {
     if (timezone === currentTimezone()) {
         return formatFn(date, format);
     }
     if (timezone === 'UTC') {
         return `${formatFn(offsetDate(date, 'UTC').date, format)} UTC`;
     }
-    // Load the zones since we need timezone information.
-    loadZones(timezonesUrl);
-    if (moment.zonesLoaded) {
+    if (shouldHandleTimezone(timezone)) {
         const offset = offsetDate(date, timezone);
         return `${formatFn(offset.date, format)} ${offset.abbr}`;
     }
@@ -771,7 +713,7 @@ export function convertFormatToFlatpickr(format) {
  * @param {string} format - The format to convert.
  * @returns {string} - The converted format.
  */
-export function convertFormatToMoment(format) {
+export function convertFormatToDayjs(format) {
     return format
         // Year conversion.
         .replace(/y/g, 'Y')
@@ -1320,11 +1262,10 @@ export function sanitize(string, options) {
 export function fastCloneDeep(obj) {
     return obj ? JSON.parse(JSON.stringify(obj)) : obj;
 }
-export { Evaluator, interpolate };
 /**
  * Returns if the component is an input component.
  * @param {import('@formio/core').Component} componentJson - The JSON of a component.
- * @returns {bool} - TRUE if the component is an input component; FALSE otherwise.
+ * @returns {boolean} - TRUE if the component is an input component; FALSE otherwise.
  */
 export function isInputComponent(componentJson) {
     if (componentJson.input === false || componentJson.input === true) {
@@ -1348,7 +1289,7 @@ export function isInputComponent(componentJson) {
 /**
  * Takes a component path, and returns a component path array.
  * @param {string} pathStr - The path string to convert to an array.
- * @returns {Arryay<number>} - The array of paths.
+ * @returns {Array<string>} - The array of paths.
  */
 export function getArrayFromComponentPath(pathStr) {
     if (!pathStr || !_.isString(pathStr)) {
@@ -1479,15 +1420,10 @@ export function getComponentPathWithoutIndicies(path = '') {
 /**
  * Returns a path to the component which based on its schema
  * @param {import('@formio/core').Component} component - Component containing link to its parent's schema in the 'parent' property
- * @param {string} path - Path to the component
  * @returns {string} - Path to the component
  */
-export function getComponentPath(component, path = '') {
-    if (!component || !component.key || component?._form?.display === 'wizard') { // unlike the Webform, the Wizard has the key and it is a duplicate of the panel key
-        return path;
-    }
-    path = component.isInputComponent || component.input === true ? `${component.key}${path ? '.' : ''}${path}` : path;
-    return getComponentPath(component.parent, path);
+export function getComponentPath(component) {
+    return component.paths.localDataPath;
 }
 /**
  * Returns a parent component of the passed component instance skipping all the Layout components
@@ -1517,26 +1453,6 @@ export function isPromise(value) {
         && typeof value.then === 'function'
         && Object.prototype.toString.call(value) === '[object Promise]';
 }
-/**
- * Determines if the component has a scoping parent in tree (a component which scopes its children and manages its
- * changes by itself, e.g. EditGrid)
- * @param {Component} componentInstance - The component to check for the scoping parent.
- * @param {boolean} firstPass - Whether it is the first pass of the function
- * @returns {boolean|*} - TRUE if the component has a scoping parent; FALSE otherwise
- */
-export function isInsideScopingComponent(componentInstance, firstPass = true) {
-    if (!firstPass && componentInstance?.hasScopedChildren) {
-        return true;
-    }
-    const dataParent = getDataParentComponent(componentInstance);
-    if (dataParent?.hasScopedChildren) {
-        return true;
-    }
-    else if (dataParent?.parent) {
-        return isInsideScopingComponent(dataParent.parent, false);
-    }
-    return false;
-}
 /**
  * Returns all the focusable elements within the provided dom element.
  * @param {HTMLElement} element - The element to get the focusable elements from.
@@ -1547,8 +1463,6 @@ export function getFocusableElements(element) {
     textarea:not([disabled]), button:not([disabled]), [href]`;
     return element.querySelectorAll(focusableSelector);
 }
-// Export lodash to save space with other libraries.
-export { _ };
 export const componentValueTypes = {
     number: 'number',
     string: 'string',
@@ -1588,3 +1502,17 @@ export const interpolateErrors = (component, errors, interpolateFn) => {
         return { ...error, message: unescapeHTML(interpolateFn(toInterpolate, context)), context: { ...context } };
     });
 };
+/**
+ * Checks if a string has timezone information encoded in it
+ * Example: 2024-01-01T00:00:00Z -> true
+ * Example: 2024-01-01T00:00:00+03:00 -> true
+ * Example: 2011-05-03T00:00:00 -> false
+ * @param {string} value the string value to check
+ * @returns {boolean} if value has encoded timezone
+ */
+export function hasEncodedTimezone(value) {
+    if (typeof value !== 'string') {
+        return false;
+    }
+    return (value.substring(value.length - 1) === 'z' || value.substring(value.length - 1) === 'Z' || value.match(/[+|-][0-9]{2}:[0-9]{2}$/));
+}

package/lib/mjs/widgets/CalendarWidget.d.ts

@@ -22,13 +22,6 @@ export default class CalendarWidget extends InputWidget {
         minDate: string;
         maxDate: string;
     };
-    zoneLoading: boolean;
-    timezonesUrl: string;
-    /**
-     * Load the timezones.
-     * @returns {boolean} TRUE if the zones are loading, FALSE otherwise.
-     */
-    loadZones(): boolean;
     attach(input: any): Promise<any>;
     defaultFormat: {
         date: string;
@@ -84,7 +77,7 @@ export default class CalendarWidget extends InputWidget {
      * @returns {void}
      */
     setValue(value: any): void;
-    getValueAsString(value: any, format: any): string;
+    getValueAsString(value: any, format?: string): string;
     setErrorClasses(hasErrors: any): void;
     isCalendarElement(element: any): any;
     initFlatpickr(Flatpickr: any): void;