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

package/lib/mjs/Form.js

@@ -4,27 +4,119 @@ import Displays from './displays';
 import templates from './templates';
 import * as FormioUtils from './utils/utils';
 export default class Form extends Element {
+    /**
+     * Represents a JSON value.
+     * @typedef {(string | number | boolean | null | JSONArray | JSONObject)} JSON
+     */
+    /**
+     * Represents a JSON array.
+     * @typedef {Array<JSON>} JSONArray
+     */
+    /**
+     * Represents a JSON object.
+     * @typedef {{[key: string]: JSON}} JSONObject
+     */
+    /**
+     * @typedef {object} FormioHooks
+     * @property {Function} [beforeSubmit]
+     * @property {Function} [beforeCancel]
+     * @property {Function} [beforeNext]
+     * @property {Function} [beforePrev]
+     * @property {Function} [attachComponent]
+     * @property {Function} [setDataValue]
+     * @property {Function} [addComponents]
+     * @property {Function} [addComponent]
+     * @property {Function} [customValidation]
+     * @property {Function} [attachWebform]
+     */
+    /**
+     * @typedef {object} SanitizeConfig
+     * @property {string[]} [addAttr]
+     * @property {string[]} [addTags]
+     * @property {string[]} [allowedAttrs]
+     * @property {string[]} [allowedTags]
+     * @property {string[]} [allowedUriRegex]
+     * @property {string[]} [addUriSafeAttr]
+     */
+    /**
+     * @typedef {object} ButtonSettings
+     * @property {boolean} [showPrevious]
+     * @property {boolean} [showNext]
+     * @property {boolean} [showCancel]
+     * @property {boolean} [showSubmit]
+     */
+    /**
+     * @typedef {object} FormOptions
+     * @property {boolean} [saveDraft] - Enable the save draft feature.
+     * @property {number} [saveDraftThrottle] - The throttle for the save draft feature.
+     * @property {boolean} [readOnly] - Set this form to readOnly.
+     * @property {boolean} [noAlerts] - Disable the alerts dialog.
+     * @property {{[key: string]: string}} [i18n] - The translation file for this rendering.
+     * @property {string} [template] - Custom logic for creation of elements.
+     * @property {boolean} [noDefaults] - Exclude default values from the settings.
+     * @property {any} [fileService] - The file service for this form.
+     * @property {EventEmitter} [events] - The EventEmitter for this form.
+     * @property {string} [language] - The language to render this form in.
+     * @property {{[key: string]: string}} [i18next] - The i18next configuration for this form.
+     * @property {boolean} [viewAsHtml] - View the form as raw HTML.
+     * @property {'form' | 'html' | 'flat' | 'builder' | 'pdf'} [renderMode] - The render mode for this form.
+     * @property {boolean} [highlightErrors] - Highlight any errors on the form.
+     * @property {string} [componentErrorClass] - The error class for components.
+     * @property {any} [templates] - The templates for this form.
+     * @property {string} [iconset] - The iconset for this form.
+     * @property {import('@formio/core').Component[]} [components] - The components for this form.
+     * @property {{[key: string]: boolean}} [disabled] - Disabled components for this form.
+     * @property {boolean} [showHiddenFields] - Show hidden fields.
+     * @property {{[key: string]: boolean}} [hide] - Hidden components for this form.
+     * @property {{[key: string]: boolean}} [show] - Components to show for this form.
+     * @property {Formio} [formio] - The Formio instance for this form.
+     * @property {string} [decimalSeparator] - The decimal separator for this form.
+     * @property {string} [thousandsSeparator] - The thousands separator for this form.
+     * @property {FormioHooks} [hooks] - The hooks for this form.
+     * @property {boolean} [alwaysDirty] - Always be dirty.
+     * @property {boolean} [skipDraftRestore] - Skip restoring a draft.
+     * @property {'form' | 'wizard' | 'pdf'} [display] - The display for this form.
+     * @property {string} [cdnUrl] - The CDN url for this form.
+     * @property {boolean} [flatten] - Flatten the form.
+     * @property {boolean} [sanitize] - Sanitize the form.
+     * @property {SanitizeConfig} [sanitizeConfig] - The sanitize configuration for this form.
+     * @property {ButtonSettings} [buttonSettings] - The button settings for this form.
+     * @property {object} [breadcrumbSettings] - The breadcrumb settings for this form.
+     * @property {boolean} [allowPrevious] - Allow the previous button (for Wizard forms).
+     * @property {string[]} [wizardButtonOrder] - The order of the buttons (for Wizard forms).
+     * @property {boolean} [showCheckboxBackground] - Show the checkbox background.
+     * @property {number} [zoom] - The zoom for PDF forms.
+     */
     /**
      * Creates an easy to use interface for embedding webforms, pdfs, and wizards into your application.
-     * @param {object} element - The DOM element you wish to render this form within.
-     * @param {object | string} form - Either a Form JSON schema or the URL of a hosted form via. form.io.
-     * @param {object} options - The options to create a new form instance.
-     * @param {boolean} options.readOnly - Set this form to readOnly
-     * @param {boolean} options.noAlerts - Set to true to disable the alerts dialog.
-     * @param {boolean} options.i18n - The translation file for this rendering. @see https://github.com/formio/formio.js/blob/master/i18n.js
-     * @param {boolean} options.template - Provides a way to inject custom logic into the creation of every element rendered within the form.
-     * @param {...any} args
+     * @param {object} elementOrForm - The DOM element you wish to render this form within, or the form definition.
+     * @param {object | string | FormOptions} formOrOptions - A Form JSON schema, the URL of a hosted form, or the form options.
+     * @param {FormOptions} [options] - The options to create a new form instance.
      * @example
      * import Form from '@formio/js/Form';
      * const form = new Form(document.getElementById('formio'), 'https://examples.form.io/example');
      * form.build();
      */
-    constructor(...args) {
-        let options = args[0] instanceof HTMLElement ? args[2] : args[1];
+    /**
+     * @type {FormOptions} - the options for this Form.
+     */
+    options;
+    constructor(elementOrForm, formOrOptions, options = {}) {
+        let element, form, formOptions;
+        if (elementOrForm instanceof HTMLElement) {
+            element = elementOrForm;
+            form = formOrOptions;
+            formOptions = options;
+        }
+        else {
+            element = null;
+            form = elementOrForm;
+            formOptions = formOrOptions || {};
+        }
         if (Formio.options && Formio.options.form) {
-            options = Object.assign(options, Formio.options.form);
+            formOptions = Object.assign(formOptions, Formio.options.form);
         }
-        super(options);
+        super(formOptions);
         if (this.options.useSessionToken) {
             Formio.useSessionToken(this.options);
         }
@@ -33,30 +125,22 @@ export default class Form extends Element {
             this.readyReject = reject;
         });
         this.instance = null;
-        if (args[0] instanceof HTMLElement) {
+        if (element) {
             if (this.element) {
                 delete this.element.component;
             }
-            this.element = args[0];
-            this.options = args[2] || {};
-            this.options.events = this.events;
-            this.setForm(args[1])
-                .then(() => this.readyResolve(this.instance))
-                .catch(this.readyReject);
+            this.element = element;
         }
-        else if (args[0]) {
+        else {
             this.element = null;
-            this.options = args[1] || {};
-            this.options.events = this.events;
-            this.setForm(args[0])
+        }
+        if (form) {
+            this.setForm(form)
                 .then(() => this.readyResolve(this.instance))
                 .catch(this.readyReject);
         }
-        else {
-            this.element = null;
-            this.options = {};
-            this.options.events = this.events;
-        }
+        this.options = formOptions;
+        this.options.events = this.events;
         this.display = '';
     }
     createElement(tag, attrs, children) {

package/lib/mjs/FormBuilder.d.ts

@@ -1,6 +1,191 @@
 export default class FormBuilder extends Form {
-    static options: {};
-    constructor(element: any, form: any, options: any);
+    /**
+     * @typedef FormBuilderOptions
+     * @property {string[]} [disabled] - An array of "keys" of components that should be disabled within the form builder. Example: ['firstName', 'lastName']
+     * @property {boolean} [noNewEdit] - When set to TRUE no modal is shown when a component is dragged onto the form.
+     * @property {boolean} [noDefaultSubmitButton] - Set to TRUE to not include the default submit button in Webforms.
+     * @property {boolean} [alwaysConfirmComponentRemoval] - Set to TRUE to always require confirmation before removing a component.
+     * @property {object} [formConfig] - Form configurations to apply to forms being created. These configurations are added to the "config" property of the form object.
+     * @property {string} [resourceTag] - The tag to use to query for the "Existing Resource Fields" section of the builder.
+     * @property {import('./Form').FormOptions} [editForm] - The options to apply to the Edit Form (the form that shows inside the modal when you edit a component).
+     * @property {string} [language] - The language to load into the form builder.
+     * @property {object} [builder] - The builder options to pass to the builder.
+     * @property {'form'|'wizard'|'pdf'} [display] - The display mode of the builder.
+     * @property {string} [resourceFilter] - Filter applied to the resources that appear in the builder's Existing Resource Fields.
+     * @property {boolean} [noSource] - When set to TRUE, the resource ID in the builder's Existing Resource Fields will not be linked.
+     * @property {boolean} [showFullJsonSchema] - When set to TRUE, the full JSON schema will be displayed in the JSON edit menu.
+     */
+    /** @type {FormBuilderOptions} */
+    static options: {
+        /**
+         * - An array of "keys" of components that should be disabled within the form builder. Example: ['firstName', 'lastName']
+         */
+        disabled?: string[] | undefined;
+        /**
+         * - When set to TRUE no modal is shown when a component is dragged onto the form.
+         */
+        noNewEdit?: boolean | undefined;
+        /**
+         * - Set to TRUE to not include the default submit button in Webforms.
+         */
+        noDefaultSubmitButton?: boolean | undefined;
+        /**
+         * - Set to TRUE to always require confirmation before removing a component.
+         */
+        alwaysConfirmComponentRemoval?: boolean | undefined;
+        /**
+         * - Form configurations to apply to forms being created. These configurations are added to the "config" property of the form object.
+         */
+        formConfig?: object | undefined;
+        /**
+         * - The tag to use to query for the "Existing Resource Fields" section of the builder.
+         */
+        resourceTag?: string | undefined;
+        /**
+         * - The options to apply to the Edit Form (the form that shows inside the modal when you edit a component).
+         */
+        editForm?: any;
+        /**
+         * - The language to load into the form builder.
+         */
+        language?: string | undefined;
+        /**
+         * - The builder options to pass to the builder.
+         */
+        builder?: object | undefined;
+        /**
+         * - The display mode of the builder.
+         */
+        display?: "form" | "pdf" | "wizard" | undefined;
+        /**
+         * - Filter applied to the resources that appear in the builder's Existing Resource Fields.
+         */
+        resourceFilter?: string | undefined;
+        /**
+         * - When set to TRUE, the resource ID in the builder's Existing Resource Fields will not be linked.
+         */
+        noSource?: boolean | undefined;
+        /**
+         * - When set to TRUE, the full JSON schema will be displayed in the JSON edit menu.
+         */
+        showFullJsonSchema?: boolean | undefined;
+    };
+    /**
+     * Creates a new form builder.
+     * @param {HTMLElement} element - The HTML element to place the form builder.
+     * @param {string | object} form - The form to pass to the builder
+     * @param {FormBuilderOptions} options - The options to create this builder.
+     * @returns {FormBuilder} - The form builder instance.
+     */
+    constructor(element: HTMLElement, form: string | object, options: {
+        /**
+         * - An array of "keys" of components that should be disabled within the form builder. Example: ['firstName', 'lastName']
+         */
+        disabled?: string[] | undefined;
+        /**
+         * - When set to TRUE no modal is shown when a component is dragged onto the form.
+         */
+        noNewEdit?: boolean | undefined;
+        /**
+         * - Set to TRUE to not include the default submit button in Webforms.
+         */
+        noDefaultSubmitButton?: boolean | undefined;
+        /**
+         * - Set to TRUE to always require confirmation before removing a component.
+         */
+        alwaysConfirmComponentRemoval?: boolean | undefined;
+        /**
+         * - Form configurations to apply to forms being created. These configurations are added to the "config" property of the form object.
+         */
+        formConfig?: object | undefined;
+        /**
+         * - The tag to use to query for the "Existing Resource Fields" section of the builder.
+         */
+        resourceTag?: string | undefined;
+        /**
+         * - The options to apply to the Edit Form (the form that shows inside the modal when you edit a component).
+         */
+        editForm?: any;
+        /**
+         * - The language to load into the form builder.
+         */
+        language?: string | undefined;
+        /**
+         * - The builder options to pass to the builder.
+         */
+        builder?: object | undefined;
+        /**
+         * - The display mode of the builder.
+         */
+        display?: "form" | "pdf" | "wizard" | undefined;
+        /**
+         * - Filter applied to the resources that appear in the builder's Existing Resource Fields.
+         */
+        resourceFilter?: string | undefined;
+        /**
+         * - When set to TRUE, the resource ID in the builder's Existing Resource Fields will not be linked.
+         */
+        noSource?: boolean | undefined;
+        /**
+         * - When set to TRUE, the full JSON schema will be displayed in the JSON edit menu.
+         */
+        showFullJsonSchema?: boolean | undefined;
+    });
+    /** @type {FormBuilderOptions} */
+    options: {
+        /**
+         * - An array of "keys" of components that should be disabled within the form builder. Example: ['firstName', 'lastName']
+         */
+        disabled?: string[] | undefined;
+        /**
+         * - When set to TRUE no modal is shown when a component is dragged onto the form.
+         */
+        noNewEdit?: boolean | undefined;
+        /**
+         * - Set to TRUE to not include the default submit button in Webforms.
+         */
+        noDefaultSubmitButton?: boolean | undefined;
+        /**
+         * - Set to TRUE to always require confirmation before removing a component.
+         */
+        alwaysConfirmComponentRemoval?: boolean | undefined;
+        /**
+         * - Form configurations to apply to forms being created. These configurations are added to the "config" property of the form object.
+         */
+        formConfig?: object | undefined;
+        /**
+         * - The tag to use to query for the "Existing Resource Fields" section of the builder.
+         */
+        resourceTag?: string | undefined;
+        /**
+         * - The options to apply to the Edit Form (the form that shows inside the modal when you edit a component).
+         */
+        editForm?: any;
+        /**
+         * - The language to load into the form builder.
+         */
+        language?: string | undefined;
+        /**
+         * - The builder options to pass to the builder.
+         */
+        builder?: object | undefined;
+        /**
+         * - The display mode of the builder.
+         */
+        display?: "form" | "pdf" | "wizard" | undefined;
+        /**
+         * - Filter applied to the resources that appear in the builder's Existing Resource Fields.
+         */
+        resourceFilter?: string | undefined;
+        /**
+         * - When set to TRUE, the resource ID in the builder's Existing Resource Fields will not be linked.
+         */
+        noSource?: boolean | undefined;
+        /**
+         * - When set to TRUE, the full JSON schema will be displayed in the JSON edit menu.
+         */
+        showFullJsonSchema?: boolean | undefined;
+    };
     create(display: any): any;
 }
 import Form from './Form';

package/lib/mjs/FormBuilder.js

@@ -2,7 +2,33 @@ import { Formio } from './Formio';
 import Builders from './builders';
 import Form from './Form';
 export default class FormBuilder extends Form {
+    /**
+     * @typedef FormBuilderOptions
+     * @property {string[]} [disabled] - An array of "keys" of components that should be disabled within the form builder. Example: ['firstName', 'lastName']
+     * @property {boolean} [noNewEdit] - When set to TRUE no modal is shown when a component is dragged onto the form.
+     * @property {boolean} [noDefaultSubmitButton] - Set to TRUE to not include the default submit button in Webforms.
+     * @property {boolean} [alwaysConfirmComponentRemoval] - Set to TRUE to always require confirmation before removing a component.
+     * @property {object} [formConfig] - Form configurations to apply to forms being created. These configurations are added to the "config" property of the form object.
+     * @property {string} [resourceTag] - The tag to use to query for the "Existing Resource Fields" section of the builder.
+     * @property {import('./Form').FormOptions} [editForm] - The options to apply to the Edit Form (the form that shows inside the modal when you edit a component).
+     * @property {string} [language] - The language to load into the form builder.
+     * @property {object} [builder] - The builder options to pass to the builder.
+     * @property {'form'|'wizard'|'pdf'} [display] - The display mode of the builder.
+     * @property {string} [resourceFilter] - Filter applied to the resources that appear in the builder's Existing Resource Fields.
+     * @property {boolean} [noSource] - When set to TRUE, the resource ID in the builder's Existing Resource Fields will not be linked.
+     * @property {boolean} [showFullJsonSchema] - When set to TRUE, the full JSON schema will be displayed in the JSON edit menu.
+     */
+    /** @type {FormBuilderOptions} */
     static options = {};
+    /** @type {FormBuilderOptions} */
+    options;
+    /**
+     * Creates a new form builder.
+     * @param {HTMLElement} element - The HTML element to place the form builder.
+     * @param {string | object} form - The form to pass to the builder
+     * @param {FormBuilderOptions} options - The options to create this builder.
+     * @returns {FormBuilder} - The form builder instance.
+     */
     constructor(element, form, options) {
         form = form || {};
         options = options || {};
@@ -20,13 +46,12 @@ export default class FormBuilder extends Form {
 }
 /**
  * Factory that creates a new form builder based on the form parameter.
- * @param element {HMTLElement} - The HTML Element to add this form to.
- * @param form {string|Object} - The src of the form, or a form object.
- * @param options {Object} - The options to create this form.
- * @param {...any} args
+ * @param {HTMLElement} element - The HTML Element to add this form to.
+ * @param {string|object} form - The src of the form, or a form object.
+ * @param {object} options - The options to create this form.
  * @returns {Promise} - When the form is instance is ready.
  */
-Formio.builder = (...args) => {
-    return (new FormBuilder(...args)).ready;
+Formio.builder = (element, form, options) => {
+    return (new FormBuilder(element, form, options)).ready;
 };
 Formio.FormBuilder = FormBuilder;

package/lib/mjs/PDF.d.ts

@@ -1,5 +1,4 @@
 export default class PDF extends Webform {
-    constructor(element: any, options: any);
     components: any[];
     init(): void;
     render(): any;

package/lib/mjs/Webform.d.ts

@@ -89,14 +89,14 @@
 declare class Webform extends NestedDataComponent {
     /**
      * Creates a new Form instance.
-     * @param {HTMLElement | object | FormOptions} [elementOrOptions] - The DOM element to render this form within or the options to create this form instance.
-     * @param {FormOptions} [options] - The options to create a new form instance.
+     * @param {HTMLElement | object | import('Form').FormOptions} [elementOrOptions] - The DOM element to render this form within or the options to create this form instance.
+     * @param {import('Form').FormOptions} [options] - The options to create a new form instance.
      */
-    constructor(elementOrOptions?: HTMLElement | object | FormOptions, options?: FormOptions | undefined);
+    constructor(elementOrOptions?: HTMLElement | object | import('Form').FormOptions, options?: any);
     /**
-     * @type {FormOptions} - the options for this Webform.
+     * @type {import('Form').FormOptions} - the options for this Webform.
      */
-    options: FormOptions;
+    options: any;
     _src: string;
     _loading: boolean;
     _form: {};
@@ -359,7 +359,7 @@ declare class Webform extends NestedDataComponent {
     executeFormController(): false | undefined;
     build(element: any): Promise<any>;
     getClassName(): string;
-    render(): string;
+    render(): import("./components/_classes/field/Field").default;
     redraw(): Promise<void> | Promise<boolean>;
     attach(element: any): Promise<boolean>;
     hasRequiredFields(): boolean;

package/lib/mjs/Webform.js

@@ -134,13 +134,13 @@ function getOptions(options) {
  */
 export default class Webform extends NestedDataComponent {
     /**
-     * @type {FormOptions} - the options for this Webform.
+     * @type {import('Form').FormOptions} - the options for this Webform.
      */
     options;
     /**
      * Creates a new Form instance.
-     * @param {HTMLElement | object | FormOptions} [elementOrOptions] - The DOM element to render this form within or the options to create this form instance.
-     * @param {FormOptions} [options] - The options to create a new form instance.
+     * @param {HTMLElement | object | import('Form').FormOptions} [elementOrOptions] - The DOM element to render this form within or the options to create this form instance.
+     * @param {import('Form').FormOptions} [options] - The options to create a new form instance.
      */
     constructor(elementOrOptions, options) {
         let element, formOptions;

package/lib/mjs/Wizard.d.ts

@@ -88,7 +88,7 @@ declare class Wizard extends Webform {
     }): any[];
     findRootPanel(component: any): any;
     setRootPanelId(component: any): void;
-    establishPages(data?: any): any[];
+    establishPages(data?: object): any[];
     updatePages(): void;
     addComponents(): void;
     setPage(num: any): Promise<void>;

package/lib/mjs/addons/PasswordStrength/PasswordStrengthAddon.d.ts

@@ -680,25 +680,26 @@ 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(): boolean;
     /**
      * 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: boolean | number, validation: any, message: string, errors: any): any;
+    handleRuleCheckResult(valid: boolean | number, validation: any, message: string, errors: any[]): number;
     performChecks(value: any): {
         charactersPoolSize: number;
         errors: any[];
     };
     /**
      * 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: string): boolean;
     handleBlackListCheckResult(result: any, errors: any): void;
@@ -709,8 +710,9 @@ 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?: number): any;
+    getLevel(entropy?: number): object;
     /**
      * Update the current view of the password's security indicator
      */

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;