@formio/js 5.0.0-dev.5613.3476921 → 5.0.0-dev.5614.b5c93f3

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

@@ -1,4 +1,8 @@
 import { v4 as uuidv4 } from 'uuid';
+/**
+ * indexedDb provider for file storage.
+ * @returns {import('./typedefs').FileProvider} The FileProvider interface defined in index.js.
+ */
 function indexeddb() {
     return {
         title: 'indexedDB',

package/lib/mjs/providers/storage/s3.d.ts

@@ -1,24 +1,10 @@
 export default s3;
-declare function s3(formio: any): {
-    uploadFile(file: any, fileName: any, dir: any, progressCallback: any, url: any, options: any, fileKey: any, groupPermissions: any, groupId: any, abortCallback: any, multipartOptions: any): Promise<{
-        storage: string;
-        name: any;
-        bucket: any;
-        key: any;
-        url: any;
-        acl: any;
-        size: any;
-        type: any;
-    }>;
-    completeMultipartUpload(serverResponse: any, parts: any, multipart: any): Promise<void>;
-    abortMultipartUpload(serverResponse: any): void;
-    uploadParts(file: any, urls: any, headers: any, partSize: any, multipart: any, abortSignal: any): Promise<{
-        ETag: string;
-        PartNumber: number;
-    }[]>;
-    downloadFile(file: any): any;
-    deleteFile(fileInfo: any): any;
-};
+/**
+ * S3 File Services provider for file storage.
+ * @param {object} formio formio instance
+ * @returns {import('./typedefs').FileProvider} The FileProvider interface defined in index.js.
+ */
+declare function s3(formio: object): any;
 declare namespace s3 {
     let title: string;
 }

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

@@ -5,6 +5,11 @@ const loadAbortControllerPolyfill = async () => {
         await import('abortcontroller-polyfill/dist/polyfill-patch-fetch');
     }
 };
+/**
+ * S3 File Services provider for file storage.
+ * @param {object} formio formio instance
+ * @returns {import('./typedefs').FileProvider} The FileProvider interface defined in index.js.
+ */
 function s3(formio) {
     return {
         async uploadFile(file, fileName, dir, progressCallback, url, options, fileKey, groupPermissions, groupId, abortCallback, multipartOptions) {

package/lib/mjs/providers/storage/url.d.ts

@@ -1,11 +1,10 @@
 export default url;
-declare function url(formio: any): {
-    title: string;
-    name: string;
-    uploadFile(file: any, name: any, dir: any, progressCallback: any, url: any, options: any, fileKey: any, groupPermissions: any, groupId: any, abortCallback: any): any;
-    deleteFile(fileInfo: any, options: any): Promise<any>;
-    downloadFile(file: any): Promise<any>;
-};
+/**
+ *
+ * @param {object} formio - formio instance
+ * @returns {import('./typedefs').FileProvider} The FileProvider interface defined in index.js.
+ */
+declare function url(formio: object): any;
 declare namespace url {
     let title: string;
 }

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

@@ -1,4 +1,14 @@
+/**
+ *
+ * @param {object} formio - formio instance
+ * @returns {import('./typedefs').FileProvider} The FileProvider interface defined in index.js.
+ */
 function url(formio) {
+    /**
+     *
+     * @param {object} options - options to set on the xhr
+     * @param {object} xhr - the xhr object
+     */
     function setOptions(options, xhr) {
         const parsedOptions = typeof options === 'string' ? JSON.parse(options) : options;
         for (const prop in parsedOptions) {

package/lib/mjs/providers/storage/util.d.ts

@@ -1 +1,24 @@
-export function withRetries(fn: any, args: any, retries?: number, err?: null): Promise<any>;
+/**
+ * @typedef {any[]} Args
+ */
+/**
+ * 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.
+ */
+export function withRetries(fn: RetryFunction, args: Args, retries?: number | undefined, err?: string | undefined): Promise<any>;
+export type Args = any[];
+/**
+ * Function to be retried
+ */
+export type RetryFunction = (...args: Args[]) => Promise<any>;

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

@@ -1,3 +1,21 @@
+/**
+ * @typedef {any[]} Args
+ */
+/**
+ * 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.
+ */
 export async function withRetries(fn, args, retries = 3, err = null) {
     if (!retries) {
         throw new Error(err);

package/lib/mjs/templates/Templates.d.ts

@@ -1 +1,2 @@
 export default Template;
+import { Template } from '@formio/core/experimental';

package/lib/mjs/translations/en.d.ts

@@ -72,5 +72,10 @@ declare namespace _default {
     let reCaptchaTokenValidationError: string;
     let reCaptchaTokenNotSpecifiedError: string;
     let apiKey: string;
+    let typeRemaining: string;
+    let typeCount: string;
+    let requiredDayField: string;
+    let requiredMonthField: string;
+    let requiredYearField: string;
 }
 export default _default;

package/lib/mjs/translations/en.js

@@ -71,5 +71,10 @@ export default {
     submitButtonAriaLabel: 'Submit Form button. Click to submit the form',
     reCaptchaTokenValidationError: 'ReCAPTCHA: Token validation error',
     reCaptchaTokenNotSpecifiedError: 'ReCAPTCHA: Token is not specified in submission',
-    apiKey: 'API Key is not unique: {{key}}'
+    apiKey: 'API Key is not unique: {{key}}',
+    typeRemaining: '{{ remaining }} {{ type }} remaining.',
+    typeCount: '{{ count }} {{ type }}',
+    requiredDayField: '{{ field }} is required',
+    requiredMonthField: '{{ field }} is required',
+    requiredYearField: '{{ field }} is required'
 };

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

@@ -24,7 +24,7 @@ declare class ChoicesWrapper extends Choices {
     _onEnterKey(args: any): void;
     _onDirectionKey(...args: any[]): void;
     timeout: NodeJS.Timeout | undefined;
-    _selectHighlightedChoice(activeItems: any): void;
+    _selectHighlightedChoice(): void;
     _onKeyDown(event: any): void;
     onSelectValue({ event, activeItems, hasActiveDropdown }: {
         event: any;

package/lib/mjs/utils/ChoicesWrapper.js

@@ -99,10 +99,21 @@ class ChoicesWrapper extends Choices {
             this._selectHighlightedChoice(activeItems);
         }
     }
-    _selectHighlightedChoice(activeItems) {
+    _selectHighlightedChoice() {
         const highlightedChoice = this.dropdown.getChild(`.${this.config.classNames.highlightedState}`);
         if (highlightedChoice) {
-            this._handleChoiceAction(activeItems, highlightedChoice);
+            const id = highlightedChoice.dataset.id;
+            const choice = id && this._store.getChoiceById(id);
+            this._addItem({
+                value: choice.value,
+                label: choice.label,
+                choiceId: choice.id,
+                groupId: choice.groupId,
+                customProperties: choice.customProperties,
+                placeholder: choice.placeholder,
+                keyCode: choice.keyCode
+            });
+            this._triggerChange(choice.value);
         }
         event.preventDefault();
     }

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

@@ -1,4 +1,7 @@
-export default Evaluator;
-declare namespace Evaluator {
-    function registerEvaluator(evaluator: any): void;
+export class Evaluator {
+    static cache: {};
+    static protectedEval: boolean;
+    static noeval: boolean;
+    static template(template: any, hash: any): any;
+    static interpolate(rawTemplate: any, data: any, _options: any): any;
 }

package/lib/mjs/utils/Evaluator.js

@@ -1,13 +1,11 @@
 import _ from 'lodash';
 import stringHash from 'string-hash';
-import { Evaluator as CoreEvaluator } from '@formio/core/utils';
-const Evaluator = {
-    noeval: false,
-    protectedEval: false, // This property can be customized only by plugins
-    cache: {},
-    templateSettings: CoreEvaluator.templateSettings,
-    evaluator: CoreEvaluator.evaluator,
-    template(template, hash) {
+import { JSONLogicEvaluator as CoreEvaluator } from '@formio/core/utils';
+export class Evaluator extends CoreEvaluator {
+    static cache = {};
+    static protectedEval = false;
+    static noeval = false;
+    static template(template, hash) {
         hash = hash || stringHash(template);
         if (Evaluator.cache[hash]) {
             return Evaluator.cache[hash];
@@ -20,8 +18,8 @@ const Evaluator = {
         catch (err) {
             console.warn('Error while processing template', err, template);
         }
-    },
-    interpolate(rawTemplate, data, _options) {
+    }
+    static interpolate(rawTemplate, data, _options) {
         // Ensure reverse compatability.
         const options = _.isObject(_options) ? _options : { noeval: _options };
         if (typeof rawTemplate === 'function') {
@@ -51,14 +49,5 @@ const Evaluator = {
             }
         }
         return template;
-    },
-    evaluate(func, args) {
-        return Array.isArray(args) ? func(...args) : func(args);
     }
-};
-Evaluator.registerEvaluator = (evaluator) => {
-    Object.keys(evaluator).forEach((key) => {
-        Evaluator[key] = evaluator[key];
-    });
-};
-export default Evaluator;
+}

package/lib/mjs/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 {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/mjs/utils/builder.js

@@ -3,11 +3,9 @@ import { eachComponent, uniqueKey } from './utils';
 export default {
     /**
      * Appends a number to a component.key to keep it unique
-     *
-     * @param {Object} form
-     *   The components parent form.
-     * @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;
@@ -36,12 +34,19 @@ export 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 _.range('A'.charCodeAt(), 'Z'.charCodeAt() + 1).map((charCode) => String.fromCharCode(charCode));
     },

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

@@ -1,15 +1,14 @@
 /**
  * Checks the value for a min date and max date.
- *
  * @param {moment} value
  *   The value to check.
- * @param {[String]} format
+ * @param {[string]} format
  *   A moment formats.
  * @param {Date} maxDate
  *   The max date.
  * @param {Date} minDate
  *   The min date.
- * * @return {{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;
@@ -17,16 +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.
- * * @return {{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/mjs/utils/calendarUtils.js

@@ -12,12 +12,11 @@ export const CALENDAR_ERROR_MESSAGES = {
 };
 /**
  * Builds the response for checkInvalidDate.
- *
- * @param {String} message
+ * @param {string} message
  *   The message for response.
- * @param {Boolean} result
+ * @param {boolean} result
  *   The boolean flag for response.
- * * @return {{message: string, result: boolean}}
+ * @returns {{message: string, result: boolean}} - The response object.
  */
 function buildResponse(message, result) {
     return {
@@ -27,16 +26,15 @@ function buildResponse(message, result) {
 }
 /**
  * Checks the value for a min date and max date.
- *
  * @param {moment} value
  *   The value to check.
- * @param {[String]} format
+ * @param {[string]} format
  *   A moment formats.
  * @param {Date} maxDate
  *   The max date.
  * @param {Date} minDate
  *   The min date.
- * * @return {{message: string, result: boolean}}
+ * @returns {{message: string, result: boolean}} - The response object.
  */
 export function lessOrGreater(value, format, maxDate, minDate) {
     let message = '';
@@ -62,16 +60,11 @@ export function lessOrGreater(value, format, maxDate, minDate) {
 }
 /**
  * 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.
- * * @return {{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, format, minDate, maxDate) {
     const date = moment(value, format, true);

package/lib/mjs/utils/conditionOperators/IsEmptyValue.js

@@ -11,10 +11,10 @@ export default class IsEmptyValue extends ConditionOperator {
         return false;
     }
     execute({ value, instance, conditionComponentPath }) {
-        const isEmptyValue = _.isEmpty(value);
+        const isEmptyValue = _.isEmpty(_.isNumber(value) ? String(value) : value);
         if (instance && instance.root) {
-            const conditionTriggerComponent = instance.root.getComponent(conditionComponentPath);
-            return conditionTriggerComponent ? conditionTriggerComponent.isEmpty() : isEmptyValue;
+            const conditionTriggerComponent = instance.root?.getComponent && instance.root.getComponent(conditionComponentPath);
+            return conditionTriggerComponent?.isEmpty ? conditionTriggerComponent.isEmpty() : isEmptyValue;
         }
         return isEmptyValue;
     }

package/lib/mjs/utils/conditionOperators/IsEqualTo.js

@@ -17,7 +17,7 @@ export default class IsEqualTo extends ConditionOperator {
             catch (e) { }
         }
         if (instance && instance.root) {
-            const conditionTriggerComponent = instance.root.getComponent(conditionComponentPath);
+            const conditionTriggerComponent = instance.root?.getComponent && instance.root.getComponent(conditionComponentPath);
             if (conditionTriggerComponent
                 && isSelectResourceWithObjectValue(conditionTriggerComponent.component)
                 && conditionTriggerComponent.component?.template) {