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

package/lib/mjs/addons/PasswordStrength/PasswordStrengthAddon.js

@@ -198,7 +198,7 @@ export default class PasswordStrengthAddon extends FormioAddon {
     }
     /**
      * Determines is a password is secure enough to submit
-     * @returns {boolean}
+     * @returns {boolean} - returns TRUE if password is valid, FALSE if it is not.
      */
     isValid() {
         const isValidCheck = this.settings.isValid;
@@ -215,9 +215,9 @@ export default class PasswordStrengthAddon extends FormioAddon {
      * Handles the result of check and constructs a new error object or returns an amount of points to add to the current entropy
      * @param {boolean|number} valid - Determines if the validation was failed or an amount of points if it was passed
      * @param {*} validation - Validation configuration
-     * @param {string} value - Value which was validated
      * @param {string} message - Message which should be shown if validation was not passed
-     * @param errors
+     * @param {any[]} errors - The errors array (will be mutated)
+     * @returns {number} - Returns an amount of points to add to the current entropy
      */
     handleRuleCheckResult(valid, validation, message, errors) {
         if (valid !== true) {
@@ -257,7 +257,8 @@ export default class PasswordStrengthAddon extends FormioAddon {
     }
     /**
      * Performs checks to validate password security
-     * @param {string} value - Suggested password
+     * @param {string} value - The password value to be checked.
+     * @returns {boolean} - Returns TRUE if password is strong enough, FALSE if it is not.
      */
     checkValidity(value) {
         const passwordLength = value.length;
@@ -355,6 +356,7 @@ export default class PasswordStrengthAddon extends FormioAddon {
     /**
      * Finds the level which one the passed entropy suits
      * @param {number} entropy - Points of password's security
+     * @returns {object} - Returns the level object
      */
     getLevel(entropy = this.entropy) {
         const lowestLevel = this.levels[0];

package/lib/mjs/components/_classes/field/Field.d.ts

@@ -1,5 +1,14 @@
 export default class Field extends Component {
-    render(element: any): string;
-    saveCaretPosition(element: any, index: any): void;
+    /**
+     * @param {object} element - The component to create.
+     * @returns {Field} - The created field.
+     */
+    render(element: object): Field;
+    /**
+    /* Saves current caret position to restore it after the component is redrawn
+     * @param {HTMLElement} element - The element to save the caret position for.
+     * @param {number} index - The index of the element.
+     */
+    saveCaretPosition(element: HTMLElement, index: number): void;
 }
 import Component from '../component/Component';

package/lib/mjs/components/_classes/field/Field.js

@@ -1,5 +1,13 @@
 import Component from '../component/Component';
+/*
+ * Field class is a base class for all fields.
+ * @extends Component
+ */
 export default class Field extends Component {
+    /**
+     * @param {object} element - The component to create.
+     * @returns {Field} - The created field.
+     */
     render(element) {
         if (this.noField) {
             return super.render(element);
@@ -18,7 +26,11 @@ export default class Field extends Component {
             }));
         }
     }
-    // Saves current caret position to restore it after the component is redrawn
+    /**
+    /* Saves current caret position to restore it after the component is redrawn
+     * @param {HTMLElement} element - The element to save the caret position for.
+     * @param {number} index - The index of the element.
+     */
     saveCaretPosition(element, index) {
         if (this.root?.focusedComponent?.path === this.path) {
             try {

package/lib/mjs/components/_classes/input/Input.d.ts

@@ -30,13 +30,14 @@ export default class Input extends Multivalue {
     updateValue(value: any, flags: any, index: any): boolean;
     parseValue(value: any): any;
     formatValue(value: any): any;
+    attach(element: any): Promise<any>;
     getWidget(index: any): any;
     attachElement(element: any, index: any): Promise<void>;
     /**
      * Creates an instance of a widget for this component.
-     * @param index
-     * @returns {null}
+     * @param {number} index - The index of the widget.
+     * @returns {*} - The widget instance.
      */
-    createWidget(index: any): null;
+    createWidget(index: number): any;
 }
 import Multivalue from '../multivalue/Multivalue';

package/lib/mjs/components/_classes/input/Input.js

@@ -239,8 +239,8 @@ export default class Input extends Multivalue {
     }
     /**
      * Creates an instance of a widget for this component.
-     * @param index
-     * @returns {null}
+     * @param {number} index - The index of the widget.
+     * @returns {*} - The widget instance.
      */
     createWidget(index) {
         // Return null if no widget is found.

package/lib/mjs/components/_classes/list/ListComponent.form.d.ts

@@ -1,7 +1,6 @@
 /**
- *
- * @param {...any} extend
+ * List Component edit form.
+ * @param {...any} extend - The extended schema.
+ * @returns {object} - The List Component edit form.
  */
-export default function _default(...extend: any[]): {
-    components: any;
-};
+export default function _default(...extend: any[]): object;

package/lib/mjs/components/_classes/list/ListComponent.form.js

@@ -1,8 +1,9 @@
 import Components from '../../Components';
 import ListEditData from './editForm/ListComponent.edit.data';
 /**
- *
- * @param {...any} extend
+ * List Component edit form.
+ * @param {...any} extend - The extended schema.
+ * @returns {object} - The List Component edit form.
  */
 export default function (...extend) {
     return Components.baseEditForm([

package/lib/mjs/components/_classes/multivalue/Multivalue.d.ts

@@ -1,24 +1,55 @@
 export default class Multivalue extends Field {
     get addAnother(): string;
     useWrapper(): any;
-    render(): string;
+    /**
+     * @returns {Field} - The created field.
+     */
+    render(): Field;
     renderElement(): string;
-    renderRow(value: any, index: any): any;
-    attach(dom: any): Promise<any[]>;
+    /**
+     * Renders a single row for multi-value components.
+     * @param {any} value - The value associated with the row to render.
+     * @param {number} index - The index of the row in the multi-value list.
+     * @returns {any} Returns the HTML string representation of the row.
+     */
+    renderRow(value: any, index: number): any;
+    /**
+     * @param {HTMLElement} dom - The DOM element to which the component will attach.
+     * @returns {Promise} - Promise that resolves when all asynchronous tasks that have finished.
+     */
+    attach(dom: HTMLElement): Promise<any>;
     /**
      * Attach inputs to the element.
-     * @param element
-     * @param index
+     * @param {HTMLElement} element - The element to attach.
+     * @param {number} index - The index of the element to attach.
+     */
+    attachElement(element: HTMLElement, index: number): void;
+    /**
+     * Event handler for selecting a mask from a dropdown.
+     * @param {Event} event - Event triggered by changing the selected option in mask.
+     */
+    onSelectMaskHandler(event: Event): void;
+    /**
+     * Retrieves the mask pattern for a given mask name
+     * @param {string} maskName - The name of the mask to retrieve.
+     * @returns {any} The mask pattern associated with the given mask name.
      */
-    attachElement(element: any, index: any): void;
-    onSelectMaskHandler(event: any): void;
-    getMaskPattern(maskName: any): any;
+    getMaskPattern(maskName: string): any;
     multiMasks: {} | undefined;
-    attachMultiMask(index: any): boolean;
-    updateMask(input: any, mask: any): void;
+    /**
+     * Attaches a selectable mask to an input field based on its configuration.
+     * @param {number} index - The index of the select or input in component array.
+     * @returns {boolean} - Returns true if the mask was successfully attached
+     */
+    attachMultiMask(index: number): boolean;
+    /**
+     * @param {any} input - The input element on which the mask is to be applied.
+     * @param {string} mask - The mask pattern to apply to the input element. Exit early if no mask.
+     */
+    updateMask(input: any, mask: string): void;
     /**
      * Adds a new empty value to the data array.
-     * @param value
+     * @param {any} value -A value to be added to the data array.
      */
     addNewValue(value: any): void;
     /**

package/lib/mjs/components/_classes/multivalue/Multivalue.js

@@ -29,6 +29,9 @@ export default class Multivalue extends Field {
     useWrapper() {
         return this.component.hasOwnProperty('multiple') && this.component.multiple;
     }
+    /**
+     * @returns {Field} - The created field.
+     */
     render() {
         // If single value field.
         if (!this.useWrapper()) {
@@ -51,6 +54,12 @@ export default class Multivalue extends Field {
     renderElement() {
         return '';
     }
+    /**
+     * Renders a single row for multi-value components.
+     * @param {any} value - The value associated with the row to render.
+     * @param {number} index - The index of the row in the multi-value list.
+     * @returns {any} Returns the HTML string representation of the row.
+     */
     renderRow(value, index) {
         return this.renderTemplate('multiValueRow', {
             index,
@@ -58,6 +67,10 @@ export default class Multivalue extends Field {
             element: `${this.renderElement(value, index)}`,
         });
     }
+    /**
+     * @param {HTMLElement} dom - The DOM element to which the component will attach.
+     * @returns {Promise} - Promise that resolves when all asynchronous tasks that have finished.
+     */
     attach(dom) {
         const superAttach = super.attach(dom);
         this.loadRefs(dom, {
@@ -91,6 +104,9 @@ export default class Multivalue extends Field {
             return Promise.all(promises);
         });
     }
+    /**
+     * Remove all event handlers.
+     */
     detach() {
         if (this.refs.input && this.refs.input.length) {
             this.refs.input.forEach((input) => {
@@ -113,8 +129,8 @@ export default class Multivalue extends Field {
     }
     /**
      * Attach inputs to the element.
-     * @param element
-     * @param index
+     * @param {HTMLElement} element - The element to attach.
+     * @param {number} index - The index of the element to attach.
      */
     attachElement(element, index) {
         this.addEventListener(element, this.inputInfo.changeEvent, () => {
@@ -176,9 +192,18 @@ export default class Multivalue extends Field {
             }
         }
     }
+    /**
+     * Event handler for selecting a mask from a dropdown.
+     * @param {Event} event - Event triggered by changing the selected option in mask.
+     */
     onSelectMaskHandler(event) {
         this.updateMask(event.target.maskInput, this.getMaskPattern(event.target.value));
     }
+    /**
+     * Retrieves the mask pattern for a given mask name
+     * @param {string} maskName - The name of the mask to retrieve.
+     * @returns {any} The mask pattern associated with the given mask name.
+     */
     getMaskPattern(maskName) {
         if (!this.multiMasks) {
             this.multiMasks = {};
@@ -190,6 +215,11 @@ export default class Multivalue extends Field {
         this.multiMasks[maskName] = mask ? mask.mask : this.component.inputMasks[0].mask;
         return this.multiMasks[maskName];
     }
+    /**
+     * Attaches a selectable mask to an input field based on its configuration.
+     * @param {number} index - The index of the select or input in component array.
+     * @returns {boolean} - Returns true if the mask was successfully attached
+     */
     attachMultiMask(index) {
         if (!(this.isMultipleMasksField && this.component.inputMasks.length && this.refs.input.length)) {
             return false;
@@ -200,6 +230,10 @@ export default class Multivalue extends Field {
         this.setInputMask(maskSelect.maskInput, this.component.inputMasks[0].mask);
         return true;
     }
+    /**
+     * @param {any} input - The input element on which the mask is to be applied.
+     * @param {string} mask - The mask pattern to apply to the input element. Exit early if no mask.
+     */
     updateMask(input, mask) {
         if (!mask) {
             return;
@@ -209,7 +243,7 @@ export default class Multivalue extends Field {
     }
     /**
      * Adds a new empty value to the data array.
-     * @param value
+     * @param {any} value -A value to be added to the data array.
      */
     addNewValue(value) {
         if (value === undefined) {

package/lib/mjs/components/_classes/nested/NestedComponent.d.ts

@@ -1,16 +1,96 @@
+/**
+ * NestedComponent class.
+ * @augments Field
+ */
 export default class NestedComponent extends Field {
     constructor(component: any, options: any, data: any);
     type: string;
-    _collapsed: boolean;
+    /**
+     * The collapsed state of this NestedComponent.
+     * @type {boolean}
+     * @default false
+     * @private
+     */
+    private _collapsed;
+    /**
+     * Set collapsed state.
+     * @param {boolean} value - The collapsed state.
+     * @returns {void}
+     */
     set collapsed(value: boolean);
+    /**
+     * Get collapsed state.
+     * @returns {boolean} The collapsed state.
+     */
     get collapsed(): boolean;
-    collapse(value: any): Promise<void>;
+    /**
+     * Set collapsed state.
+     * @param {boolean} value - The collapsed state.
+     * @returns {void}
+     */
+    collapse(value: boolean): void;
+    /**
+     * Set parent visibility.
+     * @param {boolean} value - The parent visibility.
+     * @returns {void}
+     */
+    set parentVisible(value: boolean);
+    /**
+     * Get parent visibility.
+     * @returns {boolean} The parent visibility.
+     */
+    get parentVisible(): boolean;
+    /**
+     * Get ready state from all components.
+     * @returns {Promise<Array>} - The promise that resolves when all components are ready.
+     */
     get ready(): Promise<any[]>;
-    set rowIndex(value: any);
-    get rowIndex(): any;
-    _rowIndex: any;
-    componentContext(): any;
-    getComponents(): any;
+    /**
+     * Set currentForm object.
+     * @param {object} instance - The current form object.
+     * @returns {void}
+     */
+    set currentForm(instance: object);
+    /**
+     * Get currentForm object.
+     * @returns {object} - The current form object.
+     */
+    get currentForm(): object;
+    /**
+     * Set Row Index to row and update each component.
+     * @param {number} value - The row index.
+     * @returns {void}
+     */
+    set rowIndex(value: number);
+    /**
+     * Get Row Index.
+     * @returns {number} - The row index.
+     */
+    get rowIndex(): number;
+    _rowIndex: number | undefined;
+    /**
+     * Get Contextual data of the component.
+     * @returns {object} - The contextual data of the component.
+     * @override
+     */
+    override componentContext(): object;
+    /**
+     * Set the data of the component.
+     * @param {object} value - The data of the component.
+     * @returns {void}
+     */
+    override set data(value: object);
+    /**
+     * Get the data of the component.
+     * @returns {object} - The data of the component.
+     * @override
+     */
+    override get data(): object;
+    /**
+     * Get components array.
+     * @returns {Array} - The components array.
+     */
+    getComponents(): any[];
     /**
      * Perform a deep iteration over every component, including those
      * within other container based components.
@@ -18,8 +98,17 @@ export default class NestedComponent extends Field {
      * @param {any} options - The options to include with this everyComponent call.
      */
     everyComponent(fn: Function, options?: any): void;
-    hasComponent(component: any): boolean;
-    flattenComponents(): {};
+    /**
+     * Check if the component has a component.
+     * @param {import('@formio/core').Component} component - The component to check.
+     * @returns {boolean} - TRUE if the component has a component, FALSE otherwise.
+     */
+    hasComponent(component: import('@formio/core').Component): boolean;
+    /**
+     * Get the flattened components of this NestedComponent.
+     * @returns {object} - The flattened components of this NestedComponent.
+     */
+    flattenComponents(): object;
     /**
      * Perform an iteration over each component within this container component.
      * @param {Function} fn - Called for each component
@@ -44,13 +133,13 @@ export default class NestedComponent extends Field {
     /**
      * Create a new component and add it to the components array.
      * @param {import('@formio/core').Component} component - The component JSON schema to create.
-     * @param {any} options - The options to create the component with.
-     * @param {any} data - The submission data object to house the data for this component.
-     * @param {*} [before] - The component before which to add this component.
-     * @param {*} [replacedComp] - The component to replace with this component.
+     * @param {object} options - The options to create the component with.
+     * @param {import('@formio/core').DataObject} data - The submission data object to house the data for this component.
+     * @param {import('@formio/core').Component} [before] - The component before which to add this component.
+     * @param {import('@formio/core').Component} [replacedComp] - The component to replace with this component.
      * @returns {any} - The created component instance.
      */
-    createComponent(component: import('@formio/core').Component, options: any, data: any, before?: any, replacedComp?: any): any;
+    createComponent(component: import('@formio/core').Component, options: object, data: import('@formio/core').DataObject, before?: import("@formio/core").Component | undefined, replacedComp?: import("@formio/core").Component | undefined): any;
     getContainer(): any;
     get componentComponents(): any;
     get nestedKey(): string;
@@ -58,31 +147,36 @@ export default class NestedComponent extends Field {
     components: any;
     /**
      * Add a new component instance to the components array.
-     * @param {any} [data] - The Submission data for this component.
-     * @param {any} [options] - The options for this component.
+     * @param {import('@formio/core').DataObject} [data] - The Submission data for this component.
+     * @param {object} [options] - The options for this component.
      */
-    addComponents(data?: any, options?: any): void;
+    addComponents(data?: import("@formio/core").DataObject | undefined, options?: object | undefined): void;
     /**
      * Add a new component to the components array.
-     * @param {object} component - The component JSON schema to add.
+     * @param {import('@formio/core').Component} component - The component JSON schema to add.
      * @param {object} data - The submission data object to house the data for this component.
      * @param {HTMLElement} before - A DOM element to insert this element before.
      * @param {boolean} [noAdd] - A possibly extraneous boolean flag.
      * @returns {any} - The created component instance.
      */
-    addComponent(component: object, data?: object, before?: HTMLElement, noAdd?: boolean | undefined): any;
+    addComponent(component: import('@formio/core').Component, data?: object, before?: HTMLElement, noAdd?: boolean | undefined): any;
     beforeFocus(): void;
+    render(children: any): Field;
     renderComponents(components: any): any;
     attach(element: any): Promise<[void, void]>;
-    attachComponentsLogic(components: any): void;
+    /**
+     * Attach the logic to the components.
+     * @param {import('@formio/core').Component[]} components - The components to attach logic to.
+     */
+    attachComponentsLogic(components: import('@formio/core').Component[]): void;
     attachComponents(element: any, components: any, container: any): Promise<any>;
     /**
      * Remove a component from the components array and from the children object
-     * @param {any} component - The component to remove from the components.
-     * @param {Array<any>} components - An array of components to remove this component from.
+     * @param {import('@formio/core').Component} component - The component to remove from the components.
+     * @param {import('@formio/core').Component[]} components - An array of components to remove this component from.
      * @param {boolean} [all] - If set to TRUE will cascade remove all components.
      */
-    removeComponent(component: any, components: Array<any>, all?: boolean | undefined): void;
+    removeComponent(component: import('@formio/core').Component, components: import('@formio/core').Component[], all?: boolean | undefined): void;
     /**
      * Removes a component provided the API key of that component.
      * @param {string} key - The API key of the component to remove.
@@ -125,27 +219,27 @@ export default class NestedComponent extends Field {
     }, flags: any): void;
     /**
      * Perform a validation on all child components of this nested component.
-     * @param {*} components - The components to validate.
-     * @param {*} data - The data to validate.
-     * @param {*} flags - The flags to use when validating.
+     * @param {import('@formio/core').Component[]} components - The components to validate.
+     * @param {import('@formio/core').DataObject} data - The data to validate.
+     * @param {object} flags - The flags to use when validating.
      * @returns {Promise<Array>|Array} - The errors if any exist.
      */
-    validateComponents(components?: any, data?: any, flags?: any): Promise<any[]> | any[];
+    validateComponents(components?: import('@formio/core').Component[], data?: import('@formio/core').DataObject, flags?: object): Promise<any[]> | any[];
     /**
      * Validate a nested component with data, or its own internal data.
-     * @param {*} data - The data to validate.
-     * @param {*} flags - The flags to use when validating.
-     * @returns {*} - The errors if any exist.
+     * @param {import('@formio/core').DataObject} data - The data to validate.
+     * @param {object} flags - The flags to use when validating.
+     * @returns {Array} - The errors if any exist.
      */
-    validate(data?: any, flags?: any): any;
+    validate(data?: import('@formio/core').DataObject, flags?: object): any[];
     checkComponentValidity(data?: null, dirty?: boolean, row?: null, flags?: {}, allErrors?: any[]): boolean;
     checkAsyncValidity(data?: null, dirty?: boolean, row?: null, silentCheck?: boolean): Promise<any>;
     setPristine(pristine: any): void;
-    get isPristine(): any;
-    get isDirty(): any;
+    get isDirty(): boolean | undefined;
     destroyComponents(all?: boolean): void;
     get visibleErrors(): any;
     get errors(): any;
+    getValue(): object;
     get dataReady(): Promise<any[]>;
     setNestedValue(component: any, value: any, flags?: {}): any;
     setValue(value: any, flags?: {}): any;