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

package/lib/cjs/components/panel/Panel.form.d.ts

@@ -1,7 +1,6 @@
 /**
- *
- * @param {...any} extend
+ * 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[]): {
-    components: any;
-};
+export default function _default(...extend: any[]): import('@formio/core').Component[];

package/lib/cjs/components/panel/Panel.form.js

@@ -7,8 +7,9 @@ const NestedComponent_form_1 = __importDefault(require("../_classes/nested/Neste
 const Panel_edit_display_1 = __importDefault(require("./editForm/Panel.edit.display"));
 const Panel_edit_conditional_1 = __importDefault(require("./editForm/Panel.edit.conditional"));
 /**
- *
- * @param {...any} extend
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
  */
 function default_1(...extend) {
     return (0, NestedComponent_form_1.default)([

package/lib/cjs/components/panel/editForm/Panel.edit.conditional.d.ts

@@ -20,7 +20,7 @@ declare const _default: {
             'margin-bottom': string;
         };
         key: string;
-        customConditional(): any;
+        customConditional(): boolean;
         components: ({
             type: string;
             key: any;

package/lib/cjs/components/password/Password.form.d.ts

@@ -1,7 +1,6 @@
 /**
- *
- * @param {...any} extend
+ * 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[]): {
-    components: any;
-};
+export default function _default(...extend: any[]): import('@formio/core').Component[];

package/lib/cjs/components/password/Password.form.js

@@ -8,8 +8,9 @@ const Password_edit_display_1 = __importDefault(require("./editForm/Password.edi
 const Password_edit_data_1 = __importDefault(require("./editForm/Password.edit.data"));
 const Password_edit_validation_1 = __importDefault(require("./editForm/Password.edit.validation"));
 /**
- *
- * @param {...any} extend
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
  */
 function default_1(...extend) {
     return (0, TextField_form_1.default)([

package/lib/cjs/components/phonenumber/PhoneNumber.form.d.ts

@@ -1,7 +1,6 @@
 /**
- *
- * @param {...any} extend
+ * 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[]): {
-    components: any;
-};
+export default function _default(...extend: any[]): import('@formio/core').Component[];

package/lib/cjs/components/phonenumber/PhoneNumber.form.js

@@ -6,8 +6,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const TextField_form_1 = __importDefault(require("../textfield/TextField.form"));
 const PhoneNumber_edit_validation_1 = __importDefault(require("./editForm/PhoneNumber.edit.validation"));
 /**
- *
- * @param {...any} extend
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
  */
 function default_1(...extend) {
     return (0, TextField_form_1.default)([

package/lib/cjs/components/radio/Radio.form.d.ts

@@ -1,5 +1,6 @@
 /**
- *
- * @param {...any} extend
+ * 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[]): object;
+export default function _default(...extend: any[]): import('@formio/core').Component[];

package/lib/cjs/components/radio/Radio.form.js

@@ -8,8 +8,9 @@ const Radio_edit_data_1 = __importDefault(require("./editForm/Radio.edit.data"))
 const Radio_edit_display_1 = __importDefault(require("./editForm/Radio.edit.display"));
 const Radio_edit_validation_1 = __importDefault(require("./editForm/Radio.edit.validation"));
 /**
- *
- * @param {...any} extend
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
  */
 function default_1(...extend) {
     return (0, ListComponent_form_1.default)([

package/lib/cjs/components/recaptcha/ReCaptcha.form.d.ts

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

package/lib/cjs/components/recaptcha/ReCaptcha.form.js

@@ -6,7 +6,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const Components_1 = __importDefault(require("../Components"));
 const ReCaptcha_edit_display_1 = __importDefault(require("./editForm/ReCaptcha.edit.display"));
 /**
- *
+ * The Edit Form function.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
  */
 function default_1() {
     return Components_1.default.baseEditForm([

package/lib/cjs/components/select/Select.d.ts

@@ -34,7 +34,7 @@ export default class SelectComponent extends ListComponent {
     get isSelectResource(): boolean;
     get itemsFromUrl(): boolean;
     get isInfiniteScrollProvided(): boolean;
-    get shouldInitialLoad(): any;
+    get shouldInitialLoad(): boolean;
     get selectMetadata(): any;
     isEntireObjectDisplay(): boolean;
     selectValueAndLabel(data: any): {
@@ -106,7 +106,7 @@ export default class SelectComponent extends ListComponent {
     validateValueAvailability(setting: any, value: any): boolean;
     /**
      * Performs required transformations on the initial value to use in selectOptions
-     * @param {*} value
+     * @param {*} value - The value to transform.
      * @returns {*} - Returns the options value.
      */
     getOptionValue(value: any): any;

package/lib/cjs/components/select/Select.form.d.ts

@@ -1,5 +1,6 @@
 /**
- *
- * @param {...any} extend
+ * 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[]): object;
+export default function _default(...extend: any[]): import('@formio/core').Component[];

package/lib/cjs/components/select/Select.form.js

@@ -8,8 +8,9 @@ const Select_edit_data_1 = __importDefault(require("./editForm/Select.edit.data"
 const Select_edit_display_1 = __importDefault(require("./editForm/Select.edit.display"));
 const Select_edit_validation_1 = __importDefault(require("./editForm/Select.edit.validation"));
 /**
- *
- * @param {...any} extend
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
  */
 function default_1(...extend) {
     return (0, ListComponent_form_1.default)([

package/lib/cjs/components/select/Select.js

@@ -1389,7 +1389,7 @@ class SelectComponent extends ListComponent_1.default {
     }
     /**
      * Performs required transformations on the initial value to use in selectOptions
-     * @param {*} value
+     * @param {*} value - The value to transform.
      * @returns {*} - Returns the options value.
      */
     getOptionValue(value) {

package/lib/cjs/components/selectboxes/SelectBoxes.d.ts

@@ -26,16 +26,10 @@ export default class SelectBoxesComponent extends RadioComponent {
     get emptyValue(): any;
     /**
      * Only empty if the values are all false.
-     * @param value
-     * @returns {boolean}
+     * @param {any} value - The value to check if empty.
+     * @returns {boolean} - If the value is empty.
      */
     isEmpty(value?: any): boolean;
-    /**
-     * Set the value of this component.
-     * @param value
-     * @param flags
-     */
-    setValue(value: any, flags?: {}): boolean;
     setInputsDisabled(value: any, onlyUnchecked: any): void;
     checkComponentValidity(data: any, dirty: any, rowData: any, options: any, errors?: any[]): boolean;
 }

package/lib/cjs/components/selectboxes/SelectBoxes.form.d.ts

@@ -1,5 +1,6 @@
 /**
- *
- * @param {...any} extend
+ * 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[]): object;
+export default function _default(...extend: any[]): import('@formio/core').Component[];

package/lib/cjs/components/selectboxes/SelectBoxes.form.js

@@ -6,8 +6,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const Radio_form_1 = __importDefault(require("../radio/Radio.form"));
 const SelectBoxes_edit_validation_1 = __importDefault(require("./editForm/SelectBoxes.edit.validation"));
 /**
- *
- * @param {...any} extend
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
  */
 function default_1(...extend) {
     return (0, Radio_form_1.default)([

package/lib/cjs/components/selectboxes/SelectBoxes.js

@@ -81,8 +81,8 @@ class SelectBoxesComponent extends Radio_1.default {
     }
     /**
      * Only empty if the values are all false.
-     * @param value
-     * @returns {boolean}
+     * @param {any} value - The value to check if empty.
+     * @returns {boolean} - If the value is empty.
      */
     isEmpty(value = this.dataValue) {
         let empty = true;
@@ -106,8 +106,8 @@ class SelectBoxesComponent extends Radio_1.default {
     }
     /**
      * Normalize values coming into updateValue.
-     * @param value
-     * @returns {*}
+     * @param {any} value - The value to normalize.
+     * @returns {*} - The normalized value
      */
     normalizeValue(value) {
         value = value || {};
@@ -140,8 +140,9 @@ class SelectBoxesComponent extends Radio_1.default {
     }
     /**
      * Set the value of this component.
-     * @param value
-     * @param flags
+     * @param {any} value - The value to set.
+     * @param {any} flags - Flags to apply to this update.
+     * @returns {boolean} - If the value has changed.
      */
     setValue(value, flags = {}) {
         const changed = this.updateValue(value, flags);

package/lib/cjs/components/signature/Signature.form.d.ts

@@ -1,7 +1,6 @@
 /**
- *
- * @param {...any} extend
+ * 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[]): {
-    components: any;
-};
+export default function _default(...extend: any[]): import('@formio/core').Component[];

package/lib/cjs/components/signature/Signature.form.js

@@ -8,8 +8,9 @@ const Signature_edit_data_1 = __importDefault(require("./editForm/Signature.edit
 const Signature_edit_display_1 = __importDefault(require("./editForm/Signature.edit.display"));
 const Signature_edit_validation_1 = __importDefault(require("./editForm/Signature.edit.validation"));
 /**
- *
- * @param {...any} extend
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
  */
 function default_1(...extend) {
     return Components_1.default.baseEditForm([

package/lib/cjs/components/survey/Survey.form.d.ts

@@ -1,7 +1,6 @@
 /**
- *
- * @param {...any} extend
+ * 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[]): {
-    components: any;
-};
+export default function _default(...extend: any[]): import('@formio/core').Component[];

package/lib/cjs/components/survey/Survey.form.js

@@ -8,8 +8,9 @@ const Survey_edit_data_1 = __importDefault(require("./editForm/Survey.edit.data"
 const Survey_edit_display_1 = __importDefault(require("./editForm/Survey.edit.display"));
 const Survey_edit_validation_1 = __importDefault(require("./editForm/Survey.edit.validation"));
 /**
- *
- * @param {...any} extend
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
  */
 function default_1(...extend) {
     return Components_1.default.baseEditForm([

package/lib/cjs/components/table/Table.form.d.ts

@@ -1,7 +1,6 @@
 /**
- *
- * @param {...any} extend
+ * 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[]): {
-    components: any;
-};
+export default function _default(...extend: any[]): import('@formio/core').Component[];

package/lib/cjs/components/table/Table.form.js

@@ -6,8 +6,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const NestedComponent_form_1 = __importDefault(require("../_classes/nested/NestedComponent.form"));
 const Table_edit_display_1 = __importDefault(require("./editForm/Table.edit.display"));
 /**
- *
- * @param {...any} extend
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
  */
 function default_1(...extend) {
     return (0, NestedComponent_form_1.default)([

package/lib/cjs/components/tabs/Tabs.d.ts

@@ -20,9 +20,9 @@ export default class TabsComponent extends NestedComponent {
     detach(all: any): void;
     /**
      * Set the current tab.
-     * @param index
+     * @param {number} index - The index of the tab to set.
      */
-    setTab(index: any): void;
+    setTab(index: number): void;
     beforeFocus(component: any): void;
     setErrorClasses(elements: any, dirty: any, hasErrors: any, hasMessages: any, element?: any): void;
     handleTabsValidation(): void;

package/lib/cjs/components/tabs/Tabs.form.d.ts

@@ -1,7 +1,6 @@
 /**
- *
- * @param {...any} extend
+ * 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[]): {
-    components: any;
-};
+export default function _default(...extend: any[]): import('@formio/core').Component[];

package/lib/cjs/components/tabs/Tabs.form.js

@@ -6,8 +6,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const NestedComponent_form_1 = __importDefault(require("../_classes/nested/NestedComponent.form"));
 const Tabs_edit_display_1 = __importDefault(require("./editForm/Tabs.edit.display"));
 /**
- *
- * @param {...any} extend
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
  */
 function default_1(...extend) {
     return (0, NestedComponent_form_1.default)([

package/lib/cjs/components/tabs/Tabs.js

@@ -112,7 +112,7 @@ class TabsComponent extends NestedComponent_1.default {
     }
     /**
      * Set the current tab.
-     * @param index
+     * @param {number} index - The index of the tab to set.
      */
     setTab(index) {
         if (!this.tabs || !this.tabs[index] || !this.refs[this.tabKey] || !this.refs[this.tabKey][index]) {

package/lib/cjs/components/tags/Tags.form.d.ts

@@ -1,7 +1,6 @@
 /**
- *
- * @param {...any} extend
+ * 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[]): {
-    components: any;
-};
+export default function _default(...extend: any[]): import('@formio/core').Component[];

package/lib/cjs/components/tags/Tags.form.js

@@ -6,8 +6,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const Components_1 = __importDefault(require("../Components"));
 const Tags_edit_data_1 = __importDefault(require("./editForm/Tags.edit.data"));
 /**
- *
- * @param {...any} extend
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
  */
 function default_1(...extend) {
     return Components_1.default.baseEditForm([

package/lib/cjs/components/textarea/TextArea.d.ts

@@ -5,10 +5,10 @@ export default class TextAreaComponent extends TextFieldComponent {
     get autoExpand(): any;
     /**
      * Updates the editor value.
-     * @param index
-     * @param newValue
+     * @param {number} index - The index of the editor.
+     * @param {any} newValue - The new editor value.
      */
-    updateEditorValue(index: any, newValue: any): void;
+    updateEditorValue(index: number, newValue: any): void;
     autoModified: boolean | undefined;
     attachElement(element: any, index: any): any;
     imageHandler(moduleInstance: any, range: any, files: any): void;

package/lib/cjs/components/textarea/TextArea.form.d.ts

@@ -1,7 +1,6 @@
 /**
- *
- * @param {...any} extend
+ * 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[]): {
-    components: any;
-};
+export default function _default(...extend: any[]): import('@formio/core').Component[];

package/lib/cjs/components/textarea/TextArea.form.js

@@ -7,8 +7,9 @@ const TextField_form_1 = __importDefault(require("../textfield/TextField.form"))
 const TextArea_edit_display_1 = __importDefault(require("./editForm/TextArea.edit.display"));
 const TextArea_edit_validation_1 = __importDefault(require("./editForm/TextArea.edit.validation"));
 /**
- *
- * @param {...any} extend
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
  */
 function default_1(...extend) {
     return (0, TextField_form_1.default)([

package/lib/cjs/components/textarea/TextArea.js

@@ -82,8 +82,8 @@ class TextAreaComponent extends TextField_1.default {
     }
     /**
      * Updates the editor value.
-     * @param index
-     * @param newValue
+     * @param {number} index - The index of the editor.
+     * @param {any} newValue - The new editor value.
      */
     updateEditorValue(index, newValue) {
         newValue = this.getConvertedValue(this.trimBlanks(newValue));

package/lib/cjs/components/textfield/TextField.d.ts

@@ -18,33 +18,26 @@ export default class TextFieldComponent extends Input {
     static savedValueTypes(schema: any): string[];
     get emptyValue(): string;
     /**
-     * Returns the mask value object.
-     * @param value
-     * @param flags
-     * @returns {*}
+     * Returns the mask value object (mutates value!).
+     * @param {any} [value] - The value to convert to a mask value.
+     * @param {any} [flags] - The flags to use when converting to a mask value.
+     * @returns {*} - The value as a mask value.
      */
-    maskValue(value: any, flags?: {}): any;
+    maskValue(value?: any, flags?: any): any;
     /**
      * Normalize the value set in the data object.
-     * @param value
-     * @param flags
-     * @returns {*}
+     * @param {any} value - The value to normalize.
+     * @param {any} flags - The flags to use when normalizing the value.
+     * @returns {*} - Returns the normalized value.
      */
-    normalizeValue(value: any, flags?: {}): any;
-    /**
-     * Sets the value at this index.
-     * @param index
-     * @param value
-     * @param flags
-     */
-    setValueAt(index: any, value: any, flags?: {}): void;
+    normalizeValue(value: any, flags?: any): any;
     unmaskValue(value: any, format?: any): string;
     /**
      * Returns the value at this index.
-     * @param index
-     * @returns {*}
+     * @param {number} index - The index to get the value from.
+     * @returns {*} - The value at the index.
      */
-    getValueAt(index: any): any;
+    getValueAt(index: number): any;
     checkInputMaskValue(inputMask: any): boolean;
     setInputMask(input: any, inputMask: any, usePlaceholder: any): void;
     isHtmlRenderMode(): any;

package/lib/cjs/components/textfield/TextField.form.d.ts

@@ -1,7 +1,6 @@
 /**
- *
- * @param {...any} extend
+ * 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[]): {
-    components: any;
-};
+export default function _default(...extend: any[]): import('@formio/core').Component[];

package/lib/cjs/components/textfield/TextField.form.js

@@ -8,8 +8,9 @@ const TextField_edit_data_1 = __importDefault(require("./editForm/TextField.edit
 const TextField_edit_display_1 = __importDefault(require("./editForm/TextField.edit.display"));
 const TextField_edit_validation_1 = __importDefault(require("./editForm/TextField.edit.validation"));
 /**
- *
- * @param {...any} extend
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
  */
 function default_1(...extend) {
     return Components_1.default.baseEditForm([

package/lib/cjs/components/textfield/TextField.js

@@ -111,10 +111,10 @@ class TextFieldComponent extends Input_1.default {
         return super.attach(element);
     }
     /**
-     * Returns the mask value object.
-     * @param value
-     * @param flags
-     * @returns {*}
+     * Returns the mask value object (mutates value!).
+     * @param {any} [value] - The value to convert to a mask value.
+     * @param {any} [flags] - The flags to use when converting to a mask value.
+     * @returns {*} - The value as a mask value.
      */
     maskValue(value, flags = {}) {
         // Convert it into the correct format.
@@ -133,9 +133,9 @@ class TextFieldComponent extends Input_1.default {
     }
     /**
      * Normalize the value set in the data object.
-     * @param value
-     * @param flags
-     * @returns {*}
+     * @param {any} value - The value to normalize.
+     * @param {any} flags - The flags to use when normalizing the value.
+     * @returns {*} - Returns the normalized value.
      */
     normalizeValue(value, flags = {}) {
         if (!this.isMultipleMasksField) {
@@ -148,9 +148,10 @@ class TextFieldComponent extends Input_1.default {
     }
     /**
      * Sets the value at this index.
-     * @param index
-     * @param value
-     * @param flags
+     * @param {number} index - The index to set the value at.
+     * @param {any} value - The value to set.
+     * @param {any} [flags] - The flags to use when setting the value.
+     * @returns {void}
      */
     setValueAt(index, value, flags = {}) {
         if (!this.isMultipleMasksField) {
@@ -182,8 +183,8 @@ class TextFieldComponent extends Input_1.default {
     }
     /**
      * Returns the value at this index.
-     * @param index
-     * @returns {*}
+     * @param {number} index - The index to get the value from.
+     * @returns {*} - The value at the index.
      */
     getValueAt(index) {
         var _a, _b;

package/lib/cjs/components/time/Time.form.d.ts

@@ -1,7 +1,6 @@
 /**
- *
- * @param {...any} extend
+ * 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[]): {
-    components: any;
-};
+export default function _default(...extend: any[]): import('@formio/core').Component[];

package/lib/cjs/components/time/Time.form.js

@@ -7,8 +7,9 @@ const Component_form_1 = __importDefault(require("../_classes/component/Componen
 const Time_edit_data_1 = __importDefault(require("./editForm/Time.edit.data"));
 const Time_edit_display_1 = __importDefault(require("./editForm/Time.edit.display"));
 /**
- *
- * @param {...any} extend
+ * The Edit Form function.
+ * @param {...any} extend - The components that extend the edit form.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
  */
 function default_1(...extend) {
     return (0, Component_form_1.default)([