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

package/lib/cjs/providers/storage/util.js

@@ -1,4 +1,7 @@
 "use strict";
+/**
+ * @typedef {any[]} Args
+ */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -11,11 +14,19 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.withRetries = void 0;
 /**
- *
- * @param fn
- * @param args
- * @param retries
- * @param err
+ * Function to be retried
+ * @callback RetryFunction
+ * @param {...Args} args
+ * @returns {Promise<any>}
+ */
+/**
+ * Executes a function with retries in case of failure.
+ * @param {RetryFunction} fn - The function to be executed.
+ * @param {Args} args - The arguments to be passed to the function.
+ * @param {number} [retries] - The number of retries in case of failure.
+ * @param {string} [err] - The error message to be thrown after all retries have failed.
+ * @returns {Promise<any>} The result of the function execution.
+ * @throws {Error} When all retries have failed.
  */
 function withRetries(fn, args, retries = 3, err = null) {
     return __awaiter(this, void 0, void 0, function* () {

package/lib/cjs/utils/builder.d.ts

@@ -1,17 +1,19 @@
 declare namespace _default {
     /**
      * Appends a number to a component.key to keep it unique
-     * @param {object} form
-     *   The components parent form.
-     * @param container
-     * @param {object} component
-     *   The component to uniquify
+     * @param {import('@formio/core').Component[]} container - The container of components to uniquify against
+     * @param {import('@formio/core').Component} component - The Component to uniqify.
+     * @returns {boolean} - If the component was changed.
      */
-    function uniquify(container: any, component: object): boolean;
+    function uniquify(container: import("@formio/core").Component[], component: import("@formio/core").Component): boolean;
     namespace additionalShortcuts {
         let button: string[];
     }
-    function getAlphaShortcuts(): any;
+    /**
+     * Returns the alpha character shortcuts.
+     * @returns {string[]} - An array of shortcuts of alpha characters.
+     */
+    function getAlphaShortcuts(): string[];
     function getAdditionalShortcuts(type: any): any;
     function getBindedShortcuts(components: any, input: any): any[];
     function getAvailableShortcuts(form: any, component: any): {

package/lib/cjs/utils/builder.js

@@ -8,11 +8,9 @@ const utils_1 = require("./utils");
 exports.default = {
     /**
      * Appends a number to a component.key to keep it unique
-     * @param {object} form
-     *   The components parent form.
-     * @param container
-     * @param {object} component
-     *   The component to uniquify
+     * @param {import('@formio/core').Component[]} container - The container of components to uniquify against
+     * @param {import('@formio/core').Component} component - The Component to uniqify.
+     * @returns {boolean} - If the component was changed.
      */
     uniquify(container, component) {
         let changed = false;
@@ -41,12 +39,19 @@ exports.default = {
         }, true);
         return changed;
     },
+    /**
+     * Additional shortcuts for the builder.
+     */
     additionalShortcuts: {
         button: [
             'Enter',
             'Esc'
         ]
     },
+    /**
+     * Returns the alpha character shortcuts.
+     * @returns {string[]} - An array of shortcuts of alpha characters.
+     */
     getAlphaShortcuts() {
         return lodash_1.default.range('A'.charCodeAt(), 'Z'.charCodeAt() + 1).map((charCode) => String.fromCharCode(charCode));
     },

package/lib/cjs/utils/calendarUtils.d.ts

@@ -8,7 +8,7 @@
  *   The max date.
  * @param {Date} minDate
  *   The min date.
- * @returns {{message: string, result: boolean}}
+ * @returns {{message: string, result: boolean}} - The response object.
  */
 export function lessOrGreater(value: typeof moment, format: [string], maxDate: Date, minDate: Date): {
     message: string;
@@ -16,15 +16,11 @@ export function lessOrGreater(value: typeof moment, format: [string], maxDate: D
 };
 /**
  * Checks the entered date for validity.
- * @param {string} value
- *   The value to check.
- * @param {[string]} format
- *   A moment formats.
- * @param {Date} maxDate
- *   The max date.
- * @param {Date} minDate
- *   The min date.
- * @returns {{message: string, result: boolean}}
+ * @param {string} value - The value to check.
+ * @param {[string]} format - A moment formats.
+ * @param {Date} minDate - The minimum date.
+ * @param {Date} maxDate - The maximum date.
+ * @returns {{message: string, result: boolean}} - The response object.
  */
 export function checkInvalidDate(value: string, format: [string], minDate: Date, maxDate: Date): {
     message: string;

package/lib/cjs/utils/calendarUtils.js

@@ -22,7 +22,7 @@ exports.CALENDAR_ERROR_MESSAGES = {
  *   The message for response.
  * @param {boolean} result
  *   The boolean flag for response.
- * @returns {{message: string, result: boolean}}
+ * @returns {{message: string, result: boolean}} - The response object.
  */
 function buildResponse(message, result) {
     return {
@@ -40,7 +40,7 @@ function buildResponse(message, result) {
  *   The max date.
  * @param {Date} minDate
  *   The min date.
- * @returns {{message: string, result: boolean}}
+ * @returns {{message: string, result: boolean}} - The response object.
  */
 function lessOrGreater(value, format, maxDate, minDate) {
     let message = '';
@@ -67,15 +67,11 @@ function lessOrGreater(value, format, maxDate, minDate) {
 exports.lessOrGreater = lessOrGreater;
 /**
  * Checks the entered date for validity.
- * @param {string} value
- *   The value to check.
- * @param {[string]} format
- *   A moment formats.
- * @param {Date} maxDate
- *   The max date.
- * @param {Date} minDate
- *   The min date.
- * @returns {{message: string, result: boolean}}
+ * @param {string} value - The value to check.
+ * @param {[string]} format - A moment formats.
+ * @param {Date} minDate - The minimum date.
+ * @param {Date} maxDate - The maximum date.
+ * @returns {{message: string, result: boolean}} - The response object.
  */
 function checkInvalidDate(value, format, minDate, maxDate) {
     const date = (0, moment_1.default)(value, format, true);

package/lib/cjs/utils/formUtils.d.ts

@@ -1,10 +1,10 @@
 /**
  * Deprecated version of findComponents. Renamed to searchComponents.
- * @param components
- * @param query
- * @returns {*}
+ * @param {import('@formio/core').Component[]} components - The components to find components within.
+ * @param {object} query - The query to use when searching for the components.
+ * @returns {import('@formio/core').Component[]} - The result of the component that is found.
  */
-export function findComponents(components: any, query: any): any;
+export function findComponents(components: import('@formio/core').Component[], query: object): import('@formio/core').Component[];
 export const flattenComponents: typeof Utils.flattenComponents;
 export const guid: typeof Utils.guid;
 export const uniqueName: typeof Utils.uniqueName;

package/lib/cjs/utils/formUtils.js

@@ -42,9 +42,9 @@ exports.getEmptyValue = getEmptyValue;
 exports.isComponentDataEmpty = isComponentDataEmpty;
 /**
  * Deprecated version of findComponents. Renamed to searchComponents.
- * @param components
- * @param query
- * @returns {*}
+ * @param {import('@formio/core').Component[]} components - The components to find components within.
+ * @param {object} query - The query to use when searching for the components.
+ * @returns {import('@formio/core').Component[]} - The result of the component that is found.
  */
 function findComponents(components, query) {
     console.warn('formio.js/utils findComponents is deprecated. Use searchComponents instead.');

package/lib/cjs/utils/utils.d.ts

@@ -103,149 +103,146 @@ export function checkJsonConditional(component: import('@formio/core').Component
 export function checkCondition(component: import('@formio/core').Component, row: any, data: any, form: import('@formio/core').Form, instance: any): boolean;
 /**
  * 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: any, trigger: any, row: any, data: any, form: any, instance: any): mixed;
+export function checkTrigger(component: import('@formio/core').Component, trigger: any, row: import('@formio/core').DataObject, data: import('@formio/core').DataObject, form: import('@formio/core').Form, instance: any): boolean;
 /**
- *
- * @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: any, action: any, result: any, row: any, data: any, instance: any): any;
+export function setActionProperty(component: import('@formio/core').Component, action: any, result: string, row: import('@formio/core').DataObject, data: import('@formio/core').DataObject, instance: any): import('@formio/core').Component;
 /**
  * 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: any): string;
+export function unescapeHTML(str: string): string;
 /**
  * Make HTML element from string
- * @param str
- * @param selector
- * @returns {HTMLElement}
+ * @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.
  */
-/**
- *
- * @param str
- * @param selector
- */
-export function convertStringToHTMLElement(str: any, selector: any): any;
+export function convertStringToHTMLElement(str: string, selector: string): HTMLElement;
 /**
  * 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: any, template: any, evalContext: any): string;
+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 date
- * @returns {(null|Date)}
+ * @param {string|Date} date - The date to translate.
+ * @returns {(null|Date)} - The translated date.
  */
-export function getDateSetting(date: any): (null | Date);
+export function getDateSetting(date: string | Date): (null | Date);
 /**
- *
- * @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: any): any;
+export function isValidDate(date: Date | string): boolean;
 /**
  * Get the current timezone string.
- * @returns {string}
+ * @returns {string} - The current timezone.
  */
 export function currentTimezone(): string;
 /**
  * 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: any, timezone: any): Date;
+export function offsetDate(date: Date, timezone: string): Date;
 /**
  * Returns if the zones are loaded.
- * @returns {boolean}
+ * @returns {boolean} - TRUE if the zones are loaded; FALSE otherwise.
  */
 export function zonesLoaded(): boolean;
 /**
  * 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: any): boolean;
+export function shouldLoadZones(timezone: string): boolean;
 /**
  * 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: any, timezone: any): Promise<any> | any;
+export function loadZones(url: string, timezone: string): Promise<any> | any;
 /**
  * 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: any, format: any, timezone: any): any;
+export function momentDate(value: string | Date, format: string, timezone: string): Date;
 /**
  * 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: any, value: any, format: any, timezone: any, flatPickrInputFormat: any): string;
+export function formatDate(timezonesUrl: string, value: string | Date, format: string, timezone: string, flatPickrInputFormat: string): string;
 /**
  * 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: any, formatFn: any, date: any, format: any, timezone: any): string;
+export function formatOffset(timezonesUrl: string, formatFn: Function, date: Date | string, format: string, timezone: string): string;
 /**
- *
- * @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: any): {
-    dayFirst: boolean;
-};
+export function getLocaleDateFormatInfo(locale: Intl.LocalesArgument): object;
 /**
  * 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: any): string;
+export function convertFormatToFlatpickr(format: string): string;
 /**
  * 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: any): string;
+export function convertFormatToMoment(format: string): string;
 /**
- *
- * @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: any): any;
+export function convertFormatToMask(format: string): string;
 /**
  * Returns an input mask that is compatible with the input mask library.
  * @param {string} mask - The Form.io input mask.
@@ -254,64 +251,69 @@ export function convertFormatToMask(format: any): any;
  */
 export function getInputMask(mask: string, placeholderChar: string): any[];
 /**
- *
- * @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: any, mask: any, placeholderChar: any): any;
+export function unmaskValue(value: string, mask: string, placeholderChar: string): string;
 /**
- *
- * @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: any, inputMask: any): boolean;
+export function matchInputMask(value: string, inputMask: string): boolean;
 /**
- *
- * @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?: string): {
     delimiter: string;
     decimalSeparator: string;
 };
 /**
- *
- * @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: any, defaultLimit: any): any;
+export function getNumberDecimalLimit(component: import('@formio/core').Component, defaultLimit: number): number;
 /**
- *
- * @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, }: {
-    currency: any;
-    decimalLimit: any;
-    decimalSeparator: any;
-    lang: any;
+    currency: string;
+    decimalLimit: number;
+    decimalSeparator: string;
+    lang: string;
 }): {
     prefix: string;
     suffix: string;
 };
 /**
  * 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: any, component: any): any;
+export function fieldData(data: import('@formio/core').DataObject, component: import('@formio/core').Component): any;
 /**
  * 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: any, delay?: number, ...args: any[]): any;
+export function delay(fn: Function, delay?: number, ...args: any[]): any;
 /**
  * Iterate the given key to make it unique.
  * @param {string} key