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

package/lib/mjs/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/mjs/components/phonenumber/PhoneNumber.form.js

@@ -1,8 +1,9 @@
 import textEditForm from '../textfield/TextField.form';
 import PhoneNumberEditValidation from './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.
  */
 export default function (...extend) {
     return textEditForm([

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

@@ -3,8 +3,9 @@ import RadioEditData from './editForm/Radio.edit.data';
 import RadioEditDisplay from './editForm/Radio.edit.display';
 import RadioEditValidation from './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.
  */
 export default function (...extend) {
     return listComponentForm([

package/lib/mjs/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/mjs/components/recaptcha/ReCaptcha.form.js

@@ -1,7 +1,8 @@
 import Components from '../Components';
 import ReCaptchaEditDisplay from './editForm/ReCaptcha.edit.display';
 /**
- *
+ * The Edit Form function.
+ * @returns {import('@formio/core').Component[]} - The edit form components.
  */
 export default function () {
     return Components.baseEditForm([

package/lib/mjs/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/mjs/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/mjs/components/select/Select.form.js

@@ -3,8 +3,9 @@ import SelectEditData from './editForm/Select.edit.data';
 import SelectEditDisplay from './editForm/Select.edit.display';
 import SelectEditValidation from './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.
  */
 export default function (...extend) {
     return listComponentForm([

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

@@ -1415,7 +1415,7 @@ export default class SelectComponent extends ListComponent {
     }
     /**
      * 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/mjs/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/mjs/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/mjs/components/selectboxes/SelectBoxes.form.js

@@ -1,8 +1,9 @@
 import radioEditForm from '../radio/Radio.form';
 import SelectBoxesEditValidation from './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.
  */
 export default function (...extend) {
     return radioEditForm([

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

@@ -79,8 +79,8 @@ export default class SelectBoxesComponent extends RadioComponent {
     }
     /**
      * 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;
@@ -104,8 +104,8 @@ export default class SelectBoxesComponent extends RadioComponent {
     }
     /**
      * Normalize values coming into updateValue.
-     * @param value
-     * @returns {*}
+     * @param {any} value - The value to normalize.
+     * @returns {*} - The normalized value
      */
     normalizeValue(value) {
         value = value || {};
@@ -138,8 +138,9 @@ export default class SelectBoxesComponent extends RadioComponent {
     }
     /**
      * 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/mjs/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/mjs/components/signature/Signature.form.js

@@ -3,8 +3,9 @@ import SignatureEditData from './editForm/Signature.edit.data';
 import SignatureEditDisplay from './editForm/Signature.edit.display';
 import SignatureEditValidation from './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.
  */
 export default function (...extend) {
     return Components.baseEditForm([

package/lib/mjs/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/mjs/components/survey/Survey.form.js

@@ -3,8 +3,9 @@ import SurveyEditData from './editForm/Survey.edit.data';
 import SurveyEditDisplay from './editForm/Survey.edit.display';
 import SurveyEditValidation from './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.
  */
 export default function (...extend) {
     return Components.baseEditForm([

package/lib/mjs/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/mjs/components/table/Table.form.js

@@ -1,8 +1,9 @@
 import nestedComponentForm from '../_classes/nested/NestedComponent.form';
 import TableEditDisplay from './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.
  */
 export default function (...extend) {
     return nestedComponentForm([

package/lib/mjs/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/mjs/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/mjs/components/tabs/Tabs.form.js

@@ -1,8 +1,9 @@
 import nestedComponentForm from '../_classes/nested/NestedComponent.form';
 import TabsEditDisplay from './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.
  */
 export default function (...extend) {
     return nestedComponentForm([

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

@@ -107,7 +107,7 @@ export default class TabsComponent extends NestedComponent {
     }
     /**
      * 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/mjs/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/mjs/components/tags/Tags.form.js

@@ -1,8 +1,9 @@
 import Components from '../Components';
 import TagsEditData from './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.
  */
 export default function (...extend) {
     return Components.baseEditForm([

package/lib/mjs/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/mjs/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/mjs/components/textarea/TextArea.form.js

@@ -2,8 +2,9 @@ import textEditForm from '../textfield/TextField.form';
 import TextAreaEditDisplay from './editForm/TextArea.edit.display';
 import TextAreaEditValidation from './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.
  */
 export default function (...extend) {
     return textEditForm([

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

@@ -77,8 +77,8 @@ export default class TextAreaComponent extends TextFieldComponent {
     }
     /**
      * 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/mjs/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/mjs/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/mjs/components/textfield/TextField.form.js

@@ -3,8 +3,9 @@ import TextFieldEditData from './editForm/TextField.edit.data';
 import TextFieldEditDisplay from './editForm/TextField.edit.display';
 import TextFieldEditValidation from './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.
  */
 export default function (...extend) {
     return Components.baseEditForm([

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

@@ -95,10 +95,10 @@ export default class TextFieldComponent extends Input {
         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.
@@ -117,9 +117,9 @@ export default class TextFieldComponent extends Input {
     }
     /**
      * 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) {
@@ -132,9 +132,10 @@ export default class TextFieldComponent extends Input {
     }
     /**
      * 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) {
@@ -166,8 +167,8 @@ export default class TextFieldComponent extends Input {
     }
     /**
      * 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) {
         if (!this.isMultipleMasksField) {

package/lib/mjs/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/mjs/components/time/Time.form.js

@@ -2,8 +2,9 @@ import baseEditForm from '../_classes/component/Component.form';
 import TimeEditData from './editForm/Time.edit.data';
 import TimeEditDisplay from './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.
  */
 export default function (...extend) {
     return baseEditForm([

package/lib/mjs/components/unknown/Unknown.form.d.ts

@@ -1,37 +1,5 @@
 /**
- *
+ * Unknown Component schema.
+ * @returns {object} - The Unknown Component edit form.
  */
-export default function _default(): {
-    components: {
-        type: string;
-        key: string;
-        components: {
-            label: string;
-            key: string;
-            weight: number;
-            components: ({
-                key: string;
-                label: string;
-                input: boolean;
-                tag: string;
-                content: string;
-                type: string;
-                weight: number;
-                as?: undefined;
-                editor?: undefined;
-                tooltip?: undefined;
-            } | {
-                type: string;
-                as: string;
-                editor: string;
-                weight: number;
-                input: boolean;
-                key: string;
-                label: string;
-                tooltip: string;
-                tag?: undefined;
-                content?: undefined;
-            })[];
-        }[];
-    }[];
-};
+export default function _default(): object;

package/lib/mjs/components/unknown/Unknown.form.js

@@ -1,6 +1,7 @@
 import UnknownEditDisplay from './editForm/Unknown.edit.display';
 /**
- *
+ * Unknown Component schema.
+ * @returns {object} - The Unknown Component edit form.
  */
 export default function () {
     return {

package/lib/mjs/components/url/Url.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/mjs/components/url/Url.form.js

@@ -3,8 +3,9 @@ import UrlEditDisplay from './editForm/Url.edit.display';
 import UrlEditData from './editForm/Url.edit.data';
 import UrlEditValidation from './editForm/Url.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.
  */
 export default function (...extend) {
     return textEditForm([