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

package/lib/mjs/providers/address/NominatimAddressProvider.js

@@ -8,6 +8,10 @@ import { AddressProvider } from './AddressProvider';
  * {extends AddressProvider}
  */
 export class NominatimAddressProvider extends AddressProvider {
+    /**
+     * Gets the name of the address provider.
+     * @type {string}
+     */
     static get name() {
         return 'nominatim';
     }
@@ -46,7 +50,7 @@ export class NominatimAddressProvider extends AddressProvider {
     }
     /**
      * Generates the request URL for the address provider with options.
-     * @param {NominatimAddressProviderOptionsParams} options
+     * @param {NominatimAddressProviderOptionsParams} options - The request options.
      * @returns {string} The formatted Url.
      */
     getRequestUrl(options = {}) {

package/lib/mjs/providers/processor/fileProcessor.d.ts

@@ -1,2 +1,8 @@
 export default fileProcessor;
-declare function fileProcessor(formio: any, config: any): (file: any, options: any) => Promise<any>;
+/**
+ * Creates a file processor function.
+ * @param {Formio} formio - The Formio instance.
+ * @param {object} config - The configuration object.
+ * @returns {function(File, object): Promise<FormData>} A function that takes a file and options, and returns a Promise that resolves with the processed file.
+ */
+declare function fileProcessor(formio: Formio, config: object): (arg0: File, arg1: object) => Promise<FormData>;

package/lib/mjs/providers/processor/fileProcessor.js

@@ -1,3 +1,9 @@
+/**
+ * Creates a file processor function.
+ * @param {Formio} formio - The Formio instance.
+ * @param {object} config - The configuration object.
+ * @returns {function(File, object): Promise<FormData>} A function that takes a file and options, and returns a Promise that resolves with the processed file.
+ */
 const fileProcessor = (formio, config) => (file, options) => new Promise((resolve, reject) => {
     const xhr = new XMLHttpRequest();
     // Fire on network error.

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

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

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

@@ -1,7 +1,8 @@
 import XHR from './xhr';
 /**
- *
- * @param formio
+ * Azure File Services provider for file storage.
+ * @param {object} formio formio instance
+ * @returns {import('./typedefs').FileProvider} The FileProvider interface defined in index.js.
  */
 function azure(formio) {
     return {

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

@@ -1,13 +1,9 @@
 export default base64;
 /**
- *
+ * base64 File Services provider for file storage.
+ * @returns {import('./typedefs').FileProvider} The FileProvider interface defined in index.js.
  */
-declare function base64(): {
-    title: string;
-    name: string;
-    uploadFile(file: any, fileName: any): Promise<any>;
-    downloadFile(file: any): Promise<any>;
-};
+declare function base64(): any;
 declare namespace base64 {
     let title: string;
 }

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

@@ -1,5 +1,6 @@
 /**
- *
+ * base64 File Services provider for file storage.
+ * @returns {import('./typedefs').FileProvider} The FileProvider interface defined in index.js.
  */
 function base64() {
     return {

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

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

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

@@ -1,7 +1,8 @@
 import { setXhrHeaders } from './xhr';
 /**
- *
- * @param formio
+ * Dropbox provider for file storage.
+ * @param {object} formio formio instance
+ * @returns {import('./typedefs').FileProvider} The FileProvider interface defined in index.js.
  */
 function dropbox(formio) {
     return {

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

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

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

@@ -1,7 +1,9 @@
 import { setXhrHeaders } from './xhr';
 /**
  *
- * @param formio
+ * Google Drive provider for file storage.
+ * @param {object} formio - formio instance
+ * @returns {import('./typedefs').FileProvider} The FileProvider interface defined in index.js.
  */
 function googledrive(formio) {
     return {

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

@@ -1,14 +1,9 @@
 export default indexeddb;
 /**
- *
+ * indexedDb provider for file storage.
+ * @returns {import('./typedefs').FileProvider} The FileProvider interface defined in index.js.
  */
-declare function indexeddb(): {
-    title: string;
-    name: string;
-    uploadFile(file: any, fileName: any, dir: any, progressCallback: any, url: any, options: any): Promise<any> | undefined;
-    downloadFile(file: any, options: any): Promise<any>;
-    deleteFile(file: any, options: any): Promise<any>;
-};
+declare function indexeddb(): any;
 declare namespace indexeddb {
     let title: string;
 }

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

@@ -1,6 +1,7 @@
 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 {

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

@@ -1,28 +1,10 @@
 export default s3;
 /**
- *
- * @param formio
+ * 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: 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;
-};
+declare function s3(formio: object): any;
 declare namespace s3 {
     let title: string;
 }

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

@@ -6,8 +6,9 @@ const loadAbortControllerPolyfill = async () => {
     }
 };
 /**
- *
- * @param formio
+ * 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 {

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

@@ -1,15 +1,10 @@
 export default url;
 /**
  *
- * @param formio
+ * @param {object} formio - formio instance
+ * @returns {import('./typedefs').FileProvider} The FileProvider interface defined in index.js.
  */
-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>;
-};
+declare function url(formio: object): any;
 declare namespace url {
     let title: string;
 }

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

@@ -1,12 +1,13 @@
 /**
  *
- * @param formio
+ * @param {object} formio - formio instance
+ * @returns {import('./typedefs').FileProvider} The FileProvider interface defined in index.js.
  */
 function url(formio) {
     /**
      *
-     * @param options
-     * @param xhr
+     * @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;

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

@@ -1,8 +1,24 @@
 /**
- *
- * @param fn
- * @param args
- * @param retries
- * @param err
+ * @typedef {any[]} Args
  */
-export function withRetries(fn: any, args: any, retries?: number, err?: null): Promise<any>;
+/**
+ * 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,9 +1,20 @@
 /**
- *
- * @param fn
- * @param args
- * @param retries
- * @param err
+ * @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) {

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 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/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 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;
@@ -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

@@ -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/mjs/utils/calendarUtils.js

@@ -16,7 +16,7 @@ export const 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 {
@@ -34,7 +34,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.
  */
 export function lessOrGreater(value, format, maxDate, minDate) {
     let message = '';
@@ -60,15 +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.
- * @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, format, minDate, maxDate) {
     const date = moment(value, format, true);

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

@@ -2,9 +2,9 @@ import { Utils } from '@formio/core';
 const { flattenComponents, guid, uniqueName, MODEL_TYPES, getModelType, getComponentAbsolutePath, getComponentPath, isComponentModelType, isComponentNestedDataType, componentPath, componentChildPath, eachComponentDataAsync, eachComponentData, getComponentKey, getContextualRowPath, getContextualRowData, componentInfo, eachComponent, eachComponentAsync, getComponentData, getComponentActualValue, isLayoutComponent, matchComponent, getComponent, searchComponents, removeComponent, hasCondition, parseFloatExt, formatAsCurrency, escapeRegExCharacters, getValue, getStrings, generateFormChange, applyFormChanges, findComponent, getEmptyValue, isComponentDataEmpty } = Utils;
 /**
  * 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, query) {
     console.warn('formio.js/utils findComponents is deprecated. Use searchComponents instead.');