@formio/js 5.0.0-dev.5646.8734cf4 → 5.0.0-dev.5650.cd53187

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

@@ -1,104 +1,196 @@
+/**
+ * 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.
-     *
-     * @param {function} fn - Called for every component.
+     * @param {Function} fn - Called for every component.
+     * @param {any} options - The options to include with this everyComponent call.
      */
-    everyComponent(fn: Function, options: any): void;
-    hasComponent(component: any): boolean;
-    flattenComponents(): {};
+    everyComponent(fn: Function, options?: any): void;
+    /**
+     * 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
+     * @param {Function} fn - Called for each component
      */
     eachComponent(fn: Function): void;
     /**
      * Returns a component provided a key. This performs a deep search within the
      * component tree.
-     *
-     * @param {string} key - The key of the component to retrieve.
-     * @param {function} [fn] - Called with the component once found.
+     * @param {string} path - The path to the component.
+     * @param {Function} [fn] - Called with the component once found.
      * @param {string} [originalPath] - The original path to the component.
-     * @return {Component} - The component that is located.
+     * @returns {any} - The component that is located.
      */
-    getComponent(path: any, fn?: Function | undefined, originalPath?: string | undefined): Component;
+    getComponent(path: string, fn?: Function | undefined, originalPath?: string | undefined): any;
     /**
      * Return a component provided the Id of the component.
-     *
      * @param {string} id - The Id of the component.
-     * @param {function} fn - Called with the component once it is retrieved.
-     * @return {Object} - The component retrieved.
+     * @param {Function} fn - Called with the component once it is retrieved.
+     * @returns {object} - The component retrieved.
      */
-    getComponentById(id: string, fn: Function): Object;
+    getComponentById(id: string, fn?: Function): object;
     /**
      * Create a new component and add it to the components array.
-     *
-     * @param component
-     * @param data
+     * @param {import('@formio/core').Component} component - The component JSON schema to create.
+     * @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: any, 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;
     get templateName(): string;
     components: any;
     /**
-     *
-     * @param element
-     * @param data
+     * Add a new component instance to the components array.
+     * @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 {Object} data - The submission data object to house the data for this component.
+     * @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.
-     * @return {Component} - The created component instance.
+     * @param {boolean} [noAdd] - A possibly extraneous boolean flag.
+     * @returns {any} - The created component instance.
      */
-    addComponent(component: Object, data: Object, before: HTMLElement, noAdd: any): Component;
+    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 {Component} component - The component to remove from the components.
-     * @param {Array<Component>} 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: Component, components: Array<Component>, all?: boolean): 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.
-     * @param {function} fn - Called once the component is removed.
-     * @return {null}
+     * @param {Function} fn - Called once the component is removed.
+     * @returns {null|void} - Returns nothing if the component is not found.
      */
-    removeComponentByKey(key: string, fn: Function): null;
+    removeComponentByKey(key: string, fn?: Function): null | void;
     /**
      * Removes a component provided the Id of the component.
-     *
      * @param {string} id - The Id of the component to remove.
-     * @param {function} fn - Called when the component is removed.
-     * @return {null}
+     * @param {Function} fn - Called when the component is removed.
+     * @returns {null|void} - Returns nothing if the component is not found.
      */
-    removeComponentById(id: string, fn: Function): null;
+    removeComponentById(id: string, fn?: Function): null | void;
     updateValue(value: any, flags?: {}): any;
     shouldSkipValidation(data: any, row: any, flags: any): boolean;
     checkData(data: any, flags: any, row: any, components: any): true | undefined;
@@ -107,46 +199,51 @@ export default class NestedComponent extends Field {
     restoreComponentsContext(): void;
     /**
      * Allow components to hook into the next page trigger to perform their own logic.
-     *
-     * @return {*}
+     * @param {Function} next - The callback to continue to the next page.
+     * @returns {Promise} - A promise when the page has been processed.
+     */
+    beforePage(next: Function): Promise<any>;
+    /**
+     * Allow components to hook into the submission to provide their own async data.
+     * @returns {Promise} - Returns a promise when the constituent beforeSubmit functions are complete.
      */
-    beforePage(next: any): any;
+    beforeSubmit(): Promise<any>;
     calculateValue(data: any, flags: any, row: any): any;
     isLastPage(): boolean;
     isValid(data: any, dirty: any): any;
-    validationProcessor({ scope, data, row, instance }: {
+    validationProcessor({ scope, data, row, instance, component }: {
         scope: any;
         data: any;
         row: any;
         instance: any;
+        component: any;
     }, flags: any): void;
     /**
      * Perform a validation on all child components of this nested component.
-     * @param {*} components
-     * @param {*} data
-     * @param {*} flags
-     * @returns
+     * @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): 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
-     * @param {*} flags
-     * @returns
-     */
-    validate(data: any, flags?: any): any;
-    checkComponentValidity(data: any, dirty: any, row: any, flags?: {}, allErrors?: any[]): boolean;
-    checkValidity(data: any, dirty: any, row: any, silentCheck: any, childErrors?: any[]): boolean;
-    checkAsyncValidity(data: any, dirty: any, row: any, silentCheck: any): Promise<any>;
+     * @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?: 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(): 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;
     get lazyLoad(): any;
 }
 import Field from '../field/Field';
-import Component from '../component/Component';

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

@@ -1,3 +1,6 @@
-export default function _default(...extend: any[]): {
-    components: any;
-};
+/**
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
+ */
+export default function _default(...extend: any[]): import('@formio/core').Component[];

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

@@ -1,4 +1,9 @@
 import Components from '../../Components';
+/**
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
+ */
 export default function (...extend) {
     return Components.baseEditForm([
         {