@formio/js 5.0.0-dev.5633.8d2b30d → 5.0.0-dev.5633.fde3bc9

package/lib/mjs/components/_classes/component/editForm/Component.edit.display.js

@@ -187,13 +187,5 @@ export default [
         key: 'tableView',
         input: true
     },
-    {
-        weight: 1600,
-        type: 'checkbox',
-        label: 'Modal Edit',
-        tooltip: 'Opens up a modal to edit the value of this component.',
-        key: 'modalEdit',
-        input: true
-    },
 ];
 /* eslint-enable max-len */

package/lib/mjs/components/_classes/component/editForm/Component.edit.validation.js

@@ -1,5 +1,5 @@
 import EditFormUtils from './utils';
-import Evaluator from '../../../../utils/Evaluator';
+import { Evaluator } from '../../../../utils/Evaluator';
 /* eslint-disable quotes, max-len */
 export default [
     {

package/lib/mjs/components/_classes/component/editForm/utils.js

@@ -1,5 +1,5 @@
 import _ from 'lodash';
-import Evaluator from '../../../../utils/Evaluator';
+import { Evaluator } from '../../../../utils/Evaluator';
 const EditFormUtils = {
     sortAndFilterComponents(components) {
         return _.filter(_.sortBy(components, 'weight'), (item) => !item.ignore);

package/lib/mjs/components/_classes/component/fixtures/comp6.d.ts

@@ -0,0 +1,77 @@
+declare namespace _default {
+    let components: ({
+        label: string;
+        applyMaskOn: string;
+        tableView: boolean;
+        key: string;
+        type: string;
+        input: boolean;
+        defaultValue: string;
+        mask?: undefined;
+        delimiter?: undefined;
+        requireDecimal?: undefined;
+        inputFormat?: undefined;
+        truncateMultipleSpaces?: undefined;
+        widget?: undefined;
+        data?: undefined;
+        action?: undefined;
+        showValidations?: undefined;
+    } | {
+        label: string;
+        applyMaskOn: string;
+        mask: boolean;
+        tableView: boolean;
+        delimiter: boolean;
+        requireDecimal: boolean;
+        inputFormat: string;
+        truncateMultipleSpaces: boolean;
+        key: string;
+        type: string;
+        input: boolean;
+        defaultValue: number;
+        widget?: undefined;
+        data?: undefined;
+        action?: undefined;
+        showValidations?: undefined;
+    } | {
+        label: string;
+        widget: string;
+        tableView: boolean;
+        data: {
+            values: {
+                label: string;
+                value: string;
+            }[];
+        };
+        key: string;
+        type: string;
+        input: boolean;
+        defaultValue: string;
+        applyMaskOn?: undefined;
+        mask?: undefined;
+        delimiter?: undefined;
+        requireDecimal?: undefined;
+        inputFormat?: undefined;
+        truncateMultipleSpaces?: undefined;
+        action?: undefined;
+        showValidations?: undefined;
+    } | {
+        label: string;
+        action: string;
+        showValidations: boolean;
+        tableView: boolean;
+        key: string;
+        type: string;
+        input: boolean;
+        applyMaskOn?: undefined;
+        defaultValue?: undefined;
+        mask?: undefined;
+        delimiter?: undefined;
+        requireDecimal?: undefined;
+        inputFormat?: undefined;
+        truncateMultipleSpaces?: undefined;
+        widget?: undefined;
+        data?: undefined;
+    })[];
+}
+export default _default;

package/lib/mjs/components/_classes/component/fixtures/comp6.js

@@ -0,0 +1,57 @@
+export default {
+    "components": [
+        {
+            "label": "Text Field",
+            "applyMaskOn": "change",
+            "tableView": true,
+            "key": "textField",
+            "type": "textfield",
+            "input": true,
+            "defaultValue": "test"
+        },
+        {
+            "label": "Number",
+            "applyMaskOn": "change",
+            "mask": false,
+            "tableView": false,
+            "delimiter": false,
+            "requireDecimal": false,
+            "inputFormat": "plain",
+            "truncateMultipleSpaces": false,
+            "key": "number",
+            "type": "number",
+            "input": true,
+            "defaultValue": 123
+        },
+        {
+            "label": "Select",
+            "widget": "choicesjs",
+            "tableView": true,
+            "data": {
+                "values": [
+                    {
+                        "label": "a",
+                        "value": "a"
+                    },
+                    {
+                        "label": "b",
+                        "value": "b"
+                    }
+                ]
+            },
+            "key": "select",
+            "type": "select",
+            "input": true,
+            "defaultValue": "a"
+        },
+        {
+            "label": "Reset",
+            "action": "reset",
+            "showValidations": false,
+            "tableView": false,
+            "key": "reset",
+            "type": "button",
+            "input": true
+        },
+    ]
+};

package/lib/mjs/components/_classes/component/fixtures/index.d.ts

@@ -3,4 +3,5 @@ import comp2 from './comp2';
 import comp3 from './comp3';
 import comp4 from './comp4';
 import comp5 from './comp5';
-export { comp1, comp2, comp3, comp4, comp5 };
+import comp6 from './comp6';
+export { comp1, comp2, comp3, comp4, comp5, comp6 };

package/lib/mjs/components/_classes/component/fixtures/index.js

@@ -3,4 +3,5 @@ import comp2 from './comp2';
 import comp3 from './comp3';
 import comp4 from './comp4';
 import comp5 from './comp5';
-export { comp1, comp2, comp3, comp4, comp5 };
+import comp6 from './comp6';
+export { comp1, comp2, comp3, comp4, comp5, comp6 };

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

@@ -1,5 +1,14 @@
 export default class Field extends Component {
-    render(element: any): any;
-    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.
-     *
-     * @return {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

@@ -146,13 +146,15 @@ export default class Input extends Multivalue {
             else {
                 this.addClass(element, 'text-danger');
             }
-            this.setContent(element, this.t(`{{ remaining }} ${type} remaining.`, {
-                remaining: remaining
+            this.setContent(element, this.t(`typeRemaining`, {
+                remaining: remaining,
+                type: type
             }));
         }
         else {
-            this.setContent(element, this.t(`{{ count }} ${type}`, {
-                count: count
+            this.setContent(element, this.t(`typeCount`, {
+                count: count,
+                type: type
             }));
         }
     }
@@ -239,8 +241,8 @@ export default class Input extends Multivalue {
     }
     /**
      * Creates an instance of a widget for this component.
-     *
-     * @return {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.d.ts

@@ -1,9 +1,9 @@
 export default class ListComponent extends Field {
     get isSelectURL(): boolean;
     get selectData(): any;
-    get shouldLoad(): any;
+    get shouldLoad(): boolean;
     getTemplateKeys(): void;
-    templateKeys: any[] | undefined;
+    templateKeys: string[] | undefined;
     get requestHeaders(): any;
     setItems(): void;
     updateCustomItems(): void;

package/lib/mjs/components/_classes/list/ListComponent.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/list/ListComponent.form.js

@@ -1,5 +1,10 @@
 import Components from '../../Components';
 import ListEditData from './editForm/ListComponent.edit.data';
+/**
+ * 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([
         {

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

@@ -1,24 +1,55 @@
 export default class Multivalue extends Field {
-    get addAnother(): any;
+    get addAnother(): string;
     useWrapper(): any;
-    render(): any;
+    /**
+     * @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 {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,9 +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, () => {
@@ -177,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 = {};
@@ -191,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;
@@ -201,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;
@@ -210,6 +243,7 @@ export default class Multivalue extends Field {
     }
     /**
      * Adds a new empty value to the data array.
+     * @param {any} value -A value to be added to the data array.
      */
     addNewValue(value) {
         if (value === undefined) {