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

package/lib/cjs/components/radio/Radio.form.d.ts

@@ -2,6 +2,4 @@
  *
  * @param {...any} extend
  */
-export default function _default(...extend: any[]): {
-    components: any;
-};
+export default function _default(...extend: any[]): object;

package/lib/cjs/components/radio/Radio.js

@@ -357,9 +357,9 @@ class RadioComponent extends ListComponent_1.default {
         return changed;
     }
     /**
-     * Normalize values coming into updateValue.
-     * @param value
-     * @returns {*}
+     * Normalize values coming into updateValue. For example, depending on the configuration, string value `"true"` will be normalized to boolean `true`.
+     * @param {*} value - The value to normalize
+     * @returns {*} - Returns the normalized value
      */
     normalizeValue(value) {
         const dataType = this.component.dataType || 'auto';

package/lib/cjs/components/select/Select.d.ts

@@ -44,12 +44,12 @@ export default class SelectComponent extends ListComponent {
     itemTemplate(data: any, value: any): any;
     /**
      * Adds an option to the select dropdown.
-     * @param value
-     * @param label
-     * @param attrs
-     * @param id
+     * @param {*} value - The value of the new option.
+     * @param {string} label - The label of the new option.
+     * @param {object} [attrs] - Additional value attributes. Defaults to {}.
+     * @param {string} [id] - An id. Defaults to a random string.
      */
-    addOption(value: any, label: any, attrs?: {}, id?: string): void;
+    addOption(value: any, label: string, attrs?: object | undefined, id?: string | undefined): void;
     addValueOptions(items: any): boolean;
     disableInfiniteScroll(): void;
     set serverCount(value: any);
@@ -77,7 +77,7 @@ export default class SelectComponent extends ListComponent {
     activate(): void;
     setLoadingItem(addToCurrentList?: boolean): void;
     get active(): boolean | undefined;
-    render(): string;
+    render(): import("../_classes/field/Field").default;
     wrapElement(element: any): any;
     choicesOptions(): any;
     attach(element: any): Promise<void> | undefined;
@@ -93,13 +93,7 @@ export default class SelectComponent extends ListComponent {
     attachRefreshOnBlur(): void;
     addPlaceholderItem(placeholderValue: any): void;
     update(): void;
-    /**
-     * @param {*} value
-     * @param values
-     * @param {Array} items
-     * @param keyValue
-     */
-    addCurrentChoices(values: any, items: any[], keyValue: any): any;
+    addCurrentChoices(values: any, items: any, keyValue: any): any;
     getValueAsString(data: any, options: any): any;
     normalizeSingleValue(value: any): any;
     setMetadata(value: any): any;
@@ -113,11 +107,12 @@ export default class SelectComponent extends ListComponent {
     /**
      * Performs required transformations on the initial value to use in selectOptions
      * @param {*} value
+     * @returns {*} - Returns the options value.
      */
     getOptionValue(value: any): any;
     /**
      * If component has static values (values, json) or custom values, returns an array of them
-     * @returns {Array<*>|undefined}
+     * @returns {Array<*>|undefined} - Returns an array of the static or custom values.
      */
     getOptionsValues(): Array<any> | undefined;
     /**

package/lib/cjs/components/select/Select.form.d.ts

@@ -2,6 +2,4 @@
  *
  * @param {...any} extend
  */
-export default function _default(...extend: any[]): {
-    components: any;
-};
+export default function _default(...extend: any[]): object;

package/lib/cjs/components/select/Select.js

@@ -286,10 +286,10 @@ class SelectComponent extends ListComponent_1.default {
     }
     /**
      * Adds an option to the select dropdown.
-     * @param value
-     * @param label
-     * @param attrs
-     * @param id
+     * @param {*} value - The value of the new option.
+     * @param {string} label - The label of the new option.
+     * @param {object} [attrs] - Additional value attributes. Defaults to {}.
+     * @param {string} [id] - An id. Defaults to a random string.
      */
     addOption(value, label, attrs = {}, id = (0, utils_1.getRandomComponentId)()) {
         if (lodash_1.default.isNil(label))
@@ -593,6 +593,7 @@ class SelectComponent extends ListComponent_1.default {
     }
     /**
      * Get the request headers for this select dropdown.
+     * @returns {*} - Returns the request headers for this select dropdown.
      */
     get requestHeaders() {
         // Create the headers object.
@@ -1042,12 +1043,6 @@ class SelectComponent extends ListComponent_1.default {
     get visible() {
         return super.visible;
     }
-    /**
-     * @param {*} value
-     * @param values
-     * @param {Array} items
-     * @param keyValue
-     */
     addCurrentChoices(values, items, keyValue) {
         if (!values) {
             return false;
@@ -1196,9 +1191,9 @@ class SelectComponent extends ListComponent_1.default {
         }
     }
     /**
-     * Normalize values coming into updateValue.
-     * @param value
-     * @returns {*}
+     * Normalize values coming into updateValue. For example, depending on the configuration, string value `"true"` will be normalized to boolean `true`.
+     * @param {*} value - The value to normalize
+     * @returns {*} - Returns the normalized value
      */
     normalizeValue(value) {
         if (this.component.multiple && Array.isArray(value)) {
@@ -1395,6 +1390,7 @@ class SelectComponent extends ListComponent_1.default {
     /**
      * Performs required transformations on the initial value to use in selectOptions
      * @param {*} value
+     * @returns {*} - Returns the options value.
      */
     getOptionValue(value) {
         return lodash_1.default.isObject(value) && this.isEntireObjectDisplay()
@@ -1409,7 +1405,7 @@ class SelectComponent extends ListComponent_1.default {
     }
     /**
      * If component has static values (values, json) or custom values, returns an array of them
-     * @returns {Array<*>|undefined}
+     * @returns {Array<*>|undefined} - Returns an array of the static or custom values.
      */
     getOptionsValues() {
         let rawItems = [];
@@ -1449,7 +1445,7 @@ class SelectComponent extends ListComponent_1.default {
     }
     /**
      * Check if a component is eligible for multiple validation
-     * @returns {boolean}
+     * @returns {boolean} - Returns FALSE for select components.
      */
     validateMultiple() {
         // Select component will contain one input when flagged as multiple.

package/lib/cjs/components/selectboxes/SelectBoxes.form.d.ts

@@ -2,6 +2,4 @@
  *
  * @param {...any} extend
  */
-export default function _default(...extend: any[]): {
-    components: any;
-};
+export default function _default(...extend: any[]): object;

package/lib/cjs/components/survey/Survey.d.ts

@@ -14,7 +14,7 @@ export default class SurveyComponent extends Field {
         operators: string[];
     };
     static savedValueTypes(schema: any): string[];
-    render(): string;
+    render(): Field;
     attach(element: any): Promise<void>;
     setValue(value: any, flags?: {}): boolean;
     get emptyValue(): {};

package/lib/cjs/components/table/Table.d.ts

@@ -19,6 +19,6 @@ export default class TableComponent extends NestedComponent {
     get colWidth(): string;
     noField: boolean;
     table: any[] | undefined;
-    render(): string;
+    render(): import("../_classes/field/Field").default;
 }
 import NestedComponent from '../_classes/nested/NestedComponent';

package/lib/cjs/components/tabs/Tabs.d.ts

@@ -16,7 +16,7 @@ export default class TabsComponent extends NestedComponent {
     currentTab: number;
     noField: boolean;
     tabs: any[] | undefined;
-    render(): string;
+    render(): import("../_classes/field/Field").default;
     detach(all: any): void;
     /**
      * Set the current tab.

package/lib/cjs/components/textfield/TextField.d.ts

@@ -38,7 +38,7 @@ export default class TextFieldComponent extends Input {
      * @param flags
      */
     setValueAt(index: any, value: any, flags?: {}): void;
-    unmaskValue(value: any, format?: any): any;
+    unmaskValue(value: any, format?: any): string;
     /**
      * Returns the value at this index.
      * @param index

package/lib/cjs/providers/address/NominatimAddressProvider.d.ts

@@ -19,7 +19,7 @@ export class NominatimAddressProvider extends AddressProvider {
     get displayValueProperty(): string;
     /**
      * 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?: NominatimAddressProviderOptionsParams): string;

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

@@ -11,6 +11,10 @@ const AddressProvider_1 = require("./AddressProvider");
  * {extends AddressProvider}
  */
 class NominatimAddressProvider extends AddressProvider_1.AddressProvider {
+    /**
+     * Gets the name of the address provider.
+     * @type {string}
+     */
     static get name() {
         return 'nominatim';
     }
@@ -49,7 +53,7 @@ class NominatimAddressProvider extends AddressProvider_1.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/cjs/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/cjs/providers/processor/fileProcessor.js

@@ -1,5 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * 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/cjs/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/cjs/providers/storage/azure.js

@@ -5,8 +5,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const xhr_1 = __importDefault(require("./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/cjs/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/cjs/providers/storage/base64.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 /**
- *
+ * base64 File Services provider for file storage.
+ * @returns {import('./typedefs').FileProvider} The FileProvider interface defined in index.js.
  */
 function base64() {
     return {

package/lib/cjs/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/cjs/providers/storage/dropbox.js

@@ -2,8 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const xhr_1 = require("./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/cjs/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/cjs/providers/storage/googleDrive.js

@@ -3,7 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const xhr_1 = require("./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/cjs/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/cjs/providers/storage/indexeddb.js

@@ -2,7 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const uuid_1 = require("uuid");
 /**
- *
+ * indexedDb provider for file storage.
+ * @returns {import('./typedefs').FileProvider} The FileProvider interface defined in index.js.
  */
 function indexeddb() {
     return {

package/lib/cjs/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/cjs/providers/storage/s3.js

@@ -43,8 +43,9 @@ const loadAbortControllerPolyfill = () => __awaiter(void 0, void 0, void 0, func
     }
 });
 /**
- *
- * @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/cjs/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/cjs/providers/storage/url.js

@@ -2,13 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 /**
  *
- * @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/cjs/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/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));
     },