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

package/lib/mjs/components/_classes/nested/NestedComponent.js

@@ -4,6 +4,10 @@ import Field from '../field/Field';
 import Components from '../../Components';
 import { getArrayFromComponentPath, getStringFromComponentPath, getRandomComponentId } from '../../../utils/utils';
 import { process as processAsync, processSync } from '@formio/core/process';
+/**
+ * NestedComponent class.
+ * @augments Field
+ */
 export default class NestedComponent extends Field {
     static schema(...extend) {
         return Field.schema({
@@ -14,20 +18,40 @@ export default class NestedComponent extends Field {
     constructor(component, options, data) {
         super(component, options, data);
         this.type = 'components';
+        /**
+         * The collapsed state of this NestedComponent.
+         * @type {boolean}
+         * @default false
+         * @private
+         */
         this._collapsed = !!this.component.collapsed;
     }
     get defaultSchema() {
         return NestedComponent.schema();
     }
+    /**
+     * Get the schema for the NestedComponent.
+     * @returns {object} The schema for the NestedComponent.
+     * @override
+     */
     get schema() {
         const schema = super.schema;
         const components = _.uniqBy(this.getComponents(), 'component.key');
         schema.components = _.map(components, 'schema');
         return schema;
     }
+    /**
+     * Get collapsed state.
+     * @returns {boolean} The collapsed state.
+     */
     get collapsed() {
         return this._collapsed;
     }
+    /**
+     * Set collapsed state.
+     * @param {boolean} value - The collapsed state.
+     * @returns {void}
+     */
     collapse(value) {
         const promise = this.redraw();
         if (!value) {
@@ -35,10 +59,20 @@ export default class NestedComponent extends Field {
         }
         return promise;
     }
+    /**
+     * Set collapsed state.
+     * @param {boolean} value - The collapsed state.
+     * @returns {void}
+     */
     set collapsed(value) {
         this._collapsed = value;
         this.collapse(value);
     }
+    /**
+     * Set visible state of parent and each child component.
+     * @param {boolean} value - The visible state.
+     * @returns {void}
+     */
     set visible(value) {
         // DO NOT CALL super here.  There is an issue where clearOnHide was getting triggered with
         // subcomponents because the "parentVisible" flag was set to false when it should really be
@@ -69,65 +103,136 @@ export default class NestedComponent extends Field {
             this.redraw();
         }
     }
+    /**
+     * Get visible state.
+     * @returns {boolean} The visible state.
+     */
     get visible() {
         return super.visible;
     }
+    /**
+     * Set parent visibility.
+     * @param {boolean} value - The parent visibility.
+     * @returns {void}
+     */
     set parentVisible(value) {
         super.parentVisible = value;
         this.components.forEach(component => component.parentVisible = this.visible);
     }
+    /**
+     * Get parent visibility.
+     * @returns {boolean} The parent visibility.
+     */
     get parentVisible() {
         return super.parentVisible;
     }
+    /**
+     * Get the disabled state.
+     * @returns {boolean} - The disabled state.
+     */
     get disabled() {
         return super.disabled;
     }
+    /**
+     * Set the disabled state.
+     * @param {boolean} disabled - The disabled state.
+     */
     set disabled(disabled) {
         super.disabled = disabled;
         this.components.forEach((component) => component.parentDisabled = disabled);
     }
+    /**
+     * Set parent disabled state.
+     * @param {boolean} value - The parent disabled state.
+     * @returns {void}
+     */
     set parentDisabled(value) {
         super.parentDisabled = value;
         this.components.forEach(component => {
             component.parentDisabled = this.disabled;
         });
     }
+    /**
+     * Get parent disabled state.
+     * @returns {boolean} The parent disabled state.
+     */
     get parentDisabled() {
         return super.parentDisabled;
     }
+    /**
+     * Get ready state from all components.
+     * @returns {Promise<Array>} - The promise that resolves when all components are ready.
+     */
     get ready() {
         return Promise.all(this.getComponents().map(component => component.ready));
     }
+    /**
+     * Get currentForm object.
+     * @returns {object} - The current form object.
+     */
     get currentForm() {
         return super.currentForm;
     }
+    /**
+     * Set currentForm object.
+     * @param {object} instance - The current form object.
+     * @returns {void}
+     */
     set currentForm(instance) {
         super.currentForm = instance;
         this.getComponents().forEach(component => {
             component.currentForm = instance;
         });
     }
+    /**
+     * Get Row Index.
+     * @returns {number} - The row index.
+     */
     get rowIndex() {
         return this._rowIndex;
     }
+    /**
+     * Set Row Index to row and update each component.
+     * @param {number} value - The row index.
+     * @returns {void}
+     */
     set rowIndex(value) {
         this._rowIndex = value;
         this.eachComponent((component) => {
             component.rowIndex = value;
         });
     }
+    /**
+     * Get Contextual data of the component.
+     * @returns {object} - The contextual data of the component.
+     * @override
+     */
     componentContext() {
         return this._data;
     }
+    /**
+     * Get the data of the component.
+     * @returns {object} - The data of the component.
+     * @override
+     */
     get data() {
         return this._data;
     }
+    /**
+     * Set the data of the component.
+     * @param {object} value - The data of the component.
+     * @returns {void}
+     */
     set data(value) {
         this._data = value;
         this.eachComponent((component) => {
             component.data = this.componentContext(component);
         });
     }
+    /**
+     * Get components array.
+     * @returns {Array} - The components array.
+     */
     getComponents() {
         return this.components || [];
     }
@@ -150,6 +255,11 @@ export default class NestedComponent extends Field {
             }
         });
     }
+    /**
+     * 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) {
         let result = false;
         this.everyComponent((comp) => {
@@ -160,6 +270,10 @@ export default class NestedComponent extends Field {
         });
         return result;
     }
+    /**
+     * Get the flattened components of this NestedComponent.
+     * @returns {object} - The flattened components of this NestedComponent.
+     */
     flattenComponents() {
         const result = {};
         this.everyComponent((component) => {
@@ -252,10 +366,10 @@ 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, options, data, before, replacedComp) {
@@ -319,8 +433,8 @@ export default class NestedComponent extends Field {
     }
     /**
      * 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, options) {
         data = data || this.data;
@@ -336,7 +450,7 @@ export default class NestedComponent extends Field {
     }
     /**
      * 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.
@@ -403,6 +517,10 @@ export default class NestedComponent extends Field {
             childPromise,
         ]);
     }
+    /**
+     * Attach the logic to the components.
+     * @param {import('@formio/core').Component[]} components - The components to attach logic to.
+     */
     attachComponentsLogic(components) {
         components = components || this.components;
         _.each(components, (comp) => {
@@ -432,8 +550,8 @@ export default class NestedComponent extends Field {
     }
     /**
      * 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, components, all = false) {
@@ -571,9 +689,9 @@ export default class NestedComponent extends Field {
     }
     /**
      * 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 = null, data = null, flags = {}) {
@@ -611,9 +729,9 @@ export default class NestedComponent extends Field {
     }
     /**
      * 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 = null, flags = {}) {
         data = data || this.rootValue;

package/lib/mjs/components/_classes/nesteddata/NestedDataComponent.d.ts

@@ -3,9 +3,15 @@ export default class NestedDataComponent extends NestedComponent {
     hasChanged(newValue: any, oldValue: any): boolean;
     get allowData(): boolean;
     get emptyValue(): {};
+    componentContext(): any;
     getValueAsString(value: any, options: any): string;
     getDataValueAsTable(value: any, options: any): string;
     everyComponent(fn: any, options?: {}): void;
+    /**
+     * Get the value of this component.
+     * @returns {*}
+     */
+    getValue(): any;
     updateValue(value: any, flags?: {}): boolean;
     setValue(value: any, flags?: {}): boolean;
 }

package/lib/mjs/components/address/Address.d.ts

@@ -54,7 +54,7 @@ export default class AddressComponent extends ContainerComponent {
     renderElement(value: any): any;
     renderRow(value: any, index: any): any;
     renderGrid(): any;
-    render(): string;
+    render(): Field;
     onSelectAddress(address: any, element: any, index: any): void;
     addRow(): void;
     attach(element: any): Promise<void>;
@@ -65,3 +65,4 @@ export default class AddressComponent extends ContainerComponent {
     getValueAsString(value: any, options: any): any;
 }
 import ContainerComponent from '../container/Container';
+import Field from '../_classes/field/Field';

package/lib/mjs/components/button/Button.d.ts

@@ -21,7 +21,7 @@ export default class ButtonComponent extends Field {
     get clicked(): any;
     get defaultValue(): boolean;
     get oauthConfig(): any;
-    render(): string;
+    render(): Field;
     attachButton(): void;
     hasError: boolean | undefined;
     isDisabledOnInvalid: any;

package/lib/mjs/components/checkbox/Checkbox.d.ts

@@ -39,7 +39,7 @@ export default class CheckBoxComponent extends Field {
     get labelInfo(): {
         hidden: boolean;
     };
-    render(): string;
+    render(): Field;
     attach(element: any): Promise<void>;
     input: any;
     detach(element: any): void;

package/lib/mjs/components/columns/Columns.d.ts

@@ -14,7 +14,7 @@ export default class ColumnsComponent extends NestedComponent {
     get columnKey(): string;
     columns: any[] | undefined;
     labelIsHidden(): boolean;
-    render(): string;
+    render(): import("../_classes/field/Field").default;
     justifyColumn(items: any, index: any): boolean;
     justify(): any;
     get gridSize(): number;

package/lib/mjs/components/container/Container.d.ts

@@ -9,6 +9,7 @@ export default class ContainerComponent extends NestedDataComponent {
         schema: any;
     };
     constructor(...args: any[]);
+    addComponents(data: any, options: any): void;
     checkData(data: any, flags: any, row: any, components: any): void;
     focus(): void;
 }

package/lib/mjs/components/datagrid/DataGrid.d.ts

@@ -54,7 +54,7 @@ export default class DataGridComponent extends NestedArrayComponent {
     hasTopSubmit(): any;
     hasBottomSubmit(): any;
     get canAddColumn(): boolean;
-    render(): string;
+    render(): import("../_classes/field/Field").default;
     getRows(): {}[];
     getColumns(): any[];
     hasHeader(): any;

package/lib/mjs/components/day/Day.d.ts

@@ -84,7 +84,7 @@ export default class DayComponent extends Field {
     }[] | undefined;
     setErrorClasses(elements: any, dirty: any, hasError: any): void;
     dayFirst: any;
-    render(): string;
+    render(): Field;
     renderField(name: any): any;
     attach(element: any): Promise<void>;
     set disabled(disabled: any);

package/lib/mjs/components/editgrid/EditGrid.d.ts

@@ -35,6 +35,8 @@ export default class EditGridComponent extends NestedArrayComponent {
     get inlineEditMode(): any;
     get saveEditMode(): boolean;
     get minLength(): any;
+    set data(value: any);
+    get data(): any;
     get displayAsTable(): any;
     get iteratableRows(): any;
     get defaultValue(): any[];

package/lib/mjs/components/file/File.d.ts

@@ -45,7 +45,7 @@ export default class FileComponent extends Field {
         type: number;
         actions: number;
     };
-    render(): string;
+    render(): Field;
     getVideoStream(constraints: any): any;
     stopVideoStream(videoStream: any): void;
     getFrame(videoPlayer: any): Promise<any>;
@@ -130,7 +130,7 @@ export default class FileComponent extends Field {
         message: string;
         file?: undefined;
     } | {
-        file: any;
+        file: FormData | null;
         status?: undefined;
         message?: undefined;
     }>;

package/lib/mjs/components/number/Number.d.ts

@@ -19,7 +19,7 @@ export default class NumberComponent extends Input {
     constructor(...args: any[]);
     decimalSeparator: any;
     delimiter: any;
-    decimalLimit: any;
+    decimalLimit: number;
     numberMask: any;
     /**
      * Creates the number mask for normal numbers.

package/lib/mjs/components/radio/Radio.d.ts

@@ -43,7 +43,7 @@ export default class RadioComponent extends ListComponent {
     itemsLoadedResolve: ((value: any) => void) | undefined;
     optionsLoaded: boolean | undefined;
     loadedOptions: any[] | undefined;
-    render(): string;
+    render(): import("../_classes/field/Field").default;
     attach(element: any): Promise<void>;
     detach(element: any): void;
     validateValueProperty(): boolean;

package/lib/mjs/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/mjs/components/radio/Radio.js

@@ -357,9 +357,9 @@ export default class RadioComponent extends ListComponent {
         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/mjs/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/mjs/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/mjs/components/select/Select.js

@@ -284,10 +284,10 @@ export default class SelectComponent extends ListComponent {
     }
     /**
      * 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 = getRandomComponentId()) {
         if (_.isNil(label))
@@ -593,6 +593,7 @@ export default class SelectComponent extends ListComponent {
     }
     /**
      * Get the request headers for this select dropdown.
+     * @returns {*} - Returns the request headers for this select dropdown.
      */
     get requestHeaders() {
         // Create the headers object.
@@ -1069,12 +1070,6 @@ export default class SelectComponent extends ListComponent {
     get visible() {
         return super.visible;
     }
-    /**
-     * @param {*} value
-     * @param values
-     * @param {Array} items
-     * @param keyValue
-     */
     addCurrentChoices(values, items, keyValue) {
         if (!values) {
             return false;
@@ -1223,9 +1218,9 @@ export default class SelectComponent extends ListComponent {
         }
     }
     /**
-     * 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)) {
@@ -1421,6 +1416,7 @@ 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) {
         return _.isObject(value) && this.isEntireObjectDisplay()
@@ -1435,7 +1431,7 @@ export default class SelectComponent extends ListComponent {
     }
     /**
      * 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 = [];
@@ -1475,7 +1471,7 @@ export default class SelectComponent extends ListComponent {
     }
     /**
      * 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/mjs/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/mjs/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/mjs/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/mjs/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/mjs/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/mjs/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;