@formio/js 5.0.0-rc.52 → 5.0.0-rc.53

package/lib/mjs/utils/utils.js

@@ -353,14 +353,13 @@ export function checkCondition(component, row, data, form, instance) {
 }
 /**
  * Test a trigger on a component.
- * @param component
- * @param action
- * @param trigger
- * @param data
- * @param row
- * @param form
- * @param instance
- * @returns {mixed}
+ * @param {import('@formio/core').Component} component - The component to test the trigger against.
+ * @param {import('@formio/core').LogicTrigger} trigger - The trigger configuration.
+ * @param {import('@formio/core').DataObject} row - The contextual row data.
+ * @param {import('@formio/core').DataObject} data - The root data object.
+ * @param {import('@formio/core').Form} form - The form object.
+ * @param {any} instance - The component that is performing the trigger.
+ * @returns {boolean} - TRUE if the trigger should fire; FALSE otherwise.
  */
 export function checkTrigger(component, trigger, row, data, form, instance) {
     // If trigger is empty, don't fire it
@@ -380,13 +379,14 @@ export function checkTrigger(component, trigger, row, data, form, instance) {
     return false;
 }
 /**
- *
- * @param component
- * @param action
- * @param result
- * @param row
- * @param data
- * @param instance
+ * Sets a property on a component via an executed Logic action.
+ * @param {import('@formio/core').Component} component - The component to set the property on.
+ * @param {import('@formio/core').LogicAction} action - The action to perform on the component.
+ * @param {string} result - The name of the variable in the evaulation to use as the result.
+ * @param {import('@formio/core').DataObject} row - The contextual row data.
+ * @param {import('@formio/core').DataObject} data - The full submission data.
+ * @param {any} instance - The component instance.
+ * @returns {import('@formio/core').Component} - The modified component.
  */
 export function setActionProperty(component, action, result, row, data, instance) {
     const property = action.property.value;
@@ -421,8 +421,8 @@ export function setActionProperty(component, action, result, row, data, instance
 }
 /**
  * Unescape HTML characters like &lt, &gt, &amp and etc.
- * @param str
- * @returns {string}
+ * @param {string} str - The string to unescape.
+ * @returns {string} - The unescaped string.
  */
 export function unescapeHTML(str) {
     if (typeof window === 'undefined' || !('DOMParser' in window)) {
@@ -433,14 +433,9 @@ export function unescapeHTML(str) {
 }
 /**
  * Make HTML element from string
- * @param str
- * @param selector
- * @returns {HTMLElement}
- */
-/**
- *
- * @param str
- * @param selector
+ * @param {string} str - The string to convert to an HTML element.
+ * @param {string} selector - The selector to use to get the element once it is created.
+ * @returns {HTMLElement} - The HTML element that was created.
  */
 export function convertStringToHTMLElement(str, selector) {
     const doc = new window.DOMParser().parseFromString(str, 'text/html');
@@ -448,10 +443,10 @@ export function convertStringToHTMLElement(str, selector) {
 }
 /**
  * Make a filename guaranteed to be unique.
- * @param name
- * @param template
- * @param evalContext
- * @returns {string}
+ * @param {string} name - The original name of the file.
+ * @param {string} template - The template to use for the unique name.
+ * @param {object} evalContext - The context to use for the evaluation.
+ * @returns {string} - A unique filename.
  */
 export function uniqueName(name, template, evalContext) {
     template = template || '{{fileName}}-{{guid}}';
@@ -475,7 +470,8 @@ export function uniqueName(name, template, evalContext) {
     return uniqueName;
 }
 /**
- *
+ * Returns a GUID
+ * @returns {string} - A GUID.
  */
 export function guid() {
     return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, (c) => {
@@ -488,8 +484,8 @@ export function guid() {
 }
 /**
  * Return a translated date setting.
- * @param date
- * @returns {(null|Date)}
+ * @param {string|Date} date - The date to translate.
+ * @returns {(null|Date)} - The translated date.
  */
 export function getDateSetting(date) {
     if (_.isNil(date) || _.isNaN(date) || date === '') {
@@ -531,15 +527,16 @@ export function getDateSetting(date) {
     return dateSetting.toDate();
 }
 /**
- *
- * @param date
+ * Returns true if the date is a valid date. False otherwise.
+ * @param {Date|string} date - The date to check for validity.
+ * @returns {boolean} - TRUE if the date is valid; FALSE otherwise.
  */
 export function isValidDate(date) {
     return _.isDate(date) && !_.isNaN(date.getDate());
 }
 /**
  * Get the current timezone string.
- * @returns {string}
+ * @returns {string} - The current timezone.
  */
 export function currentTimezone() {
     if (moment.currentTimezone) {
@@ -550,9 +547,9 @@ export function currentTimezone() {
 }
 /**
  * Get an offset date provided a date object and timezone object.
- * @param date
- * @param timezone
- * @returns {Date}
+ * @param {Date} date - The date to offset.
+ * @param {string} timezone - The timezone to offset the date to.
+ * @returns {Date} - The offset date.
  */
 export function offsetDate(date, timezone) {
     if (timezone === 'UTC') {
@@ -569,15 +566,15 @@ export function offsetDate(date, timezone) {
 }
 /**
  * Returns if the zones are loaded.
- * @returns {boolean}
+ * @returns {boolean} - TRUE if the zones are loaded; FALSE otherwise.
  */
 export function zonesLoaded() {
     return moment.zonesLoaded;
 }
 /**
  * Returns if we should load the zones.
- * @param timezone
- * @returns {boolean}
+ * @param {string} timezone - The timezone to check if we should load the zones.
+ * @returns {boolean} - TRUE if we should load the zones; FALSE otherwise.
  */
 export function shouldLoadZones(timezone) {
     if (timezone === currentTimezone() || timezone === 'UTC') {
@@ -587,9 +584,9 @@ export function shouldLoadZones(timezone) {
 }
 /**
  * Externally load the timezone data.
- * @param url
- * @param timezone
- * @returns {Promise<any> | *}
+ * @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)) {
@@ -613,10 +610,10 @@ export function loadZones(url, timezone) {
 }
 /**
  * Get the moment date object for translating dates with timezones.
- * @param value
- * @param format
- * @param timezone
- * @returns {*}
+ * @param {string|Date} value - The value to convert into a moment 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.
  */
 export function momentDate(value, format, timezone) {
     const momentDate = moment(value);
@@ -633,12 +630,12 @@ export function momentDate(value, format, timezone) {
 }
 /**
  * Format a date provided a value, format, and timezone object.
- * @param timezonesUrl
- * @param value
- * @param format
- * @param timezone
- * @param flatPickrInputFormat
- * @returns {string}
+ * @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);
@@ -671,12 +668,12 @@ export function formatDate(timezonesUrl, value, format, timezone, flatPickrInput
 }
 /**
  * Pass a format function to format within a timezone.
- * @param timezonesUrl
- * @param formatFn
- * @param date
- * @param format
- * @param timezone
- * @returns {string}
+ * @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) {
     if (timezone === currentTimezone()) {
@@ -696,8 +693,9 @@ export function formatOffset(timezonesUrl, formatFn, date, format, timezone) {
     }
 }
 /**
- *
- * @param locale
+ * Returns the local date format information.
+ * @param {Intl.LocalesArgument} locale - The locale to get the date format for.
+ * @returns {object} - The local date format information.
  */
 export function getLocaleDateFormatInfo(locale) {
     const formatInfo = {};
@@ -709,8 +707,8 @@ export function getLocaleDateFormatInfo(locale) {
 }
 /**
  * Convert the format from the angular-datepicker module to flatpickr format.
- * @param format
- * @returns {string}
+ * @param {string} format - The format to convert.
+ * @returns {string} - The converted format.
  */
 export function convertFormatToFlatpickr(format) {
     return format
@@ -740,8 +738,8 @@ export function convertFormatToFlatpickr(format) {
 }
 /**
  * Convert the format from the angular-datepicker module to moment format.
- * @param format
- * @returns {string}
+ * @param {string} format - The format to convert.
+ * @returns {string} - The converted format.
  */
 export function convertFormatToMoment(format) {
     return format
@@ -757,8 +755,9 @@ export function convertFormatToMoment(format) {
         .replace(/U/g, 'X');
 }
 /**
- *
- * @param format
+ * Convert the format from the angular-datepicker module to mask format.
+ * @param {string} format - The format to convert.
+ * @returns {string} - The converted format.
  */
 export function convertFormatToMask(format) {
     return format
@@ -818,10 +817,11 @@ export function getInputMask(mask, placeholderChar) {
     return maskArray;
 }
 /**
- *
- * @param value
- * @param mask
- * @param placeholderChar
+ * Unmasks a value using the provided mask and placeholder characters.
+ * @param {string} value - The value to unmask.
+ * @param {string} mask - The mask to use for unmasking.
+ * @param {string} placeholderChar - The placeholder character to use for unmasking.
+ * @returns {string} - The unmasked value.
  */
 export function unmaskValue(value, mask, placeholderChar) {
     if (!mask || !value || value.length > mask.length) {
@@ -839,9 +839,10 @@ export function unmaskValue(value, mask, placeholderChar) {
     return unmaskedValue;
 }
 /**
- *
- * @param value
- * @param inputMask
+ * Returns true if the value matches the input mask format.
+ * @param {string} value - The value to check.
+ * @param {string} inputMask - The input mask to check against.
+ * @returns {boolean} - TRUE if the value matches the input mask; FALSE otherwise.
  */
 export function matchInputMask(value, inputMask) {
     if (!inputMask) {
@@ -861,8 +862,9 @@ export function matchInputMask(value, inputMask) {
     return true;
 }
 /**
- *
- * @param lang
+ * Returns the number separators (i.e. 1,000) for the provided language.
+ * @param {string} lang - The language code to get the number separators for.
+ * @returns {{delimiter: string, decimalSeparator: string}} - The number separators.
  */
 export function getNumberSeparators(lang = 'en') {
     const formattedNumberString = (12345.6789).toLocaleString(lang);
@@ -879,9 +881,10 @@ export function getNumberSeparators(lang = 'en') {
     };
 }
 /**
- *
- * @param component
- * @param defaultLimit
+ * Returns the number for the maximum amount of decimal places for a number.
+ * @param {import('@formio/core').Component} component - The component to check for decimal limits.
+ * @param {number} defaultLimit - The default limit to use if none is provided in the component.
+ * @returns {number} - The number of decimal places allowed.
  */
 export function getNumberDecimalLimit(component, defaultLimit) {
     if (_.has(component, 'decimalLimit')) {
@@ -899,12 +902,13 @@ export function getNumberDecimalLimit(component, defaultLimit) {
     return decimalLimit;
 }
 /**
- *
- * @param root0
- * @param root0.currency
- * @param root0.decimalLimit
- * @param root0.decimalSeparator
- * @param root0.lang
+ * Returns the currency affixes for a specific language.
+ * @param {object} arg0 - The arguments object.
+ * @param {string} arg0.currency - The currency code to get the affixes for.
+ * @param {number} arg0.decimalLimit - The number of decimal places to use.
+ * @param {string} arg0.decimalSeparator - The decimal separator to use.
+ * @param {string} arg0.lang - The language code to use.
+ * @returns {{prefix: string, suffix: string}} - The currency affixes.
  */
 export function getCurrencyAffixes({ currency, decimalLimit, decimalSeparator, lang, }) {
     // Get the prefix and suffix from the localized string.
@@ -927,9 +931,9 @@ export function getCurrencyAffixes({ currency, decimalLimit, decimalSeparator, l
 }
 /**
  * Fetch the field data provided a component.
- * @param data
- * @param component
- * @returns {*}
+ * @param {import('@formio/core').DataObject} data - The data object to fetch the field data from.
+ * @param {import('@formio/core').Component} component - The component to fetch the field data for.
+ * @returns {*} - The field data.
  */
 export function fieldData(data, component) {
     if (!data) {
@@ -975,10 +979,10 @@ export function fieldData(data, component) {
 }
 /**
  * Delays function execution with possibility to execute function synchronously or cancel it.
- * @param fn Function to delay
- * @param delay Delay time
- * @param {...any} args
- * @returns {*}
+ * @param {Function} fn - Function to delay
+ * @param {number} delay - Delay time
+ * @param {...any} args - Arguments to pass to the function
+ * @returns {*} - Function to cancel the delay
  */
 export function delay(fn, delay = 0, ...args) {
     const timer = setTimeout(fn, delay, ...args);
@@ -989,7 +993,8 @@ export function delay(fn, delay = 0, ...args) {
         clearTimeout(timer);
     }
     /**
-     *
+     * Execute the function early.
+     * @returns {*} - The result of the function.
      */
     function earlyCall() {
         cancel();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@formio/js",
-  "version": "5.0.0-rc.52",
+  "version": "5.0.0-rc.53",
   "description": "JavaScript powered Forms with JSON Form Builder",
   "main": "lib/cjs/index.js",
   "exports": {
@@ -86,10 +86,10 @@
     "browser-cookies": "^1.2.0",
     "browser-md5-file": "^1.1.1",
     "compare-versions": "^6.0.0-rc.2",
-    "core-js": "^3.37.0",
+    "core-js": "^3.37.1",
     "dialog-polyfill": "^0.5.6",
     "dom-autoscroller": "^2.3.4",
-    "dompurify": "^3.1.0",
+    "dompurify": "^3.1.3",
     "downloadjs": "^1.4.7",
     "dragula": "^3.7.3",
     "eventemitter3": "^5.0.1",
@@ -105,7 +105,7 @@
     "lodash": "^4.17.21",
     "moment": "^2.29.4",
     "moment-timezone": "^0.5.44",
-    "quill": "^2.0.0",
+    "quill": "^2.0.2",
     "signature_pad": "^4.2.0",
     "string-hash": "^1.1.3",
     "tippy.js": "^6.3.7",
@@ -113,9 +113,9 @@
     "vanilla-picker": "^2.12.3"
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^7.7.1",
-    "@typescript-eslint/parser": "^7.7.1",
-    "ace-builds": "1.33.1",
+    "@typescript-eslint/eslint-plugin": "^7.9.0",
+    "@typescript-eslint/parser": "^7.9.0",
+    "ace-builds": "1.33.2",
     "async-limiter": "^2.0.0",
     "bootstrap-icons": "^1.10.5",
     "bootswatch": "^5.3.3",
@@ -127,7 +127,7 @@
     "esdoc-ecmascript-proposal-plugin": "^1.0.0",
     "esdoc-standard-plugin": "^1.0.0",
     "eslint": "^8.57.0",
-    "eslint-plugin-jsdoc": "^48.2.3",
+    "eslint-plugin-jsdoc": "^48.2.5",
     "fetch-mock": "^9.11.0",
     "file-loader": "^6.2.0",
     "flatpickr": "^4.6.13",
@@ -143,7 +143,6 @@
     "gulp-sync": "^0.1.4",
     "gulp-watch": "^5.0.1",
     "hoek": "^6.1.3",
-    "jsdoc": "^4.0.2",
     "jsdom": "22.1.0",
     "jsdom-global": "^3.0.2",
     "karma": "^6.4.3",
@@ -160,13 +159,14 @@
     "pretty": "^2.0.0",
     "pygments-css": "^1.0.0",
     "raw-loader": "^4.0.2",
-    "sass": "^1.74.1",
+    "sass": "^1.77.1",
     "shortcut-buttons-flatpickr": "^0.4.0",
     "sinon": "^17.0.1",
     "string-replace-loader": "^3.1.0",
     "ts-loader": "^9.4.4",
     "ts-node": "^10.9.1",
     "tsc": "^2.0.4",
+    "typedoc": "^0.25.13",
     "typescript": "5.3.2",
     "webpack": "^5.90.3",
     "webpack-bundle-analyzer": "^4.10.2",