@formio/js 5.0.0-dev.5603.8554c0d → 5.0.0-dev.5610.11a9aca

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

@@ -1,6 +1,11 @@
 import nestedComponentForm from '../_classes/nested/NestedComponent.form';
 import PanelEditDisplay from './editForm/Panel.edit.display';
 import PanelEditConditional from './editForm/Panel.edit.conditional';
+/**
+ * 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/panel/Panel.js

@@ -1,6 +1,5 @@
 import NestedComponent from '../_classes/nested/NestedComponent';
 import { isChildOf } from '../../utils/utils';
-import FormComponent from '../form/Form';
 export default class PanelComponent extends NestedComponent {
     static schema(...extend) {
         return NestedComponent.schema({

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

@@ -2,6 +2,11 @@ import textEditForm from '../textfield/TextField.form';
 import PasswordEditDisplay from './editForm/Password.edit.display';
 import PasswordEditData from './editForm/Password.edit.data';
 import PasswordEditValidation from './editForm/Password.edit.validation';
+/**
+ * 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/phonenumber/PhoneNumber.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/phonenumber/PhoneNumber.form.js

@@ -1,5 +1,10 @@
 import textEditForm from '../textfield/TextField.form';
 import PhoneNumberEditValidation from './editForm/PhoneNumber.edit.validation';
+/**
+ * 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.d.ts

@@ -17,13 +17,6 @@ export default class RadioComponent extends ListComponent {
                 custom(): any;
             };
         };
-        constructor: Function;
-        toString(): string;
-        toLocaleString(): string;
-        valueOf(): Object;
-        hasOwnProperty(v: PropertyKey): boolean;
-        isPrototypeOf(v: Object): boolean;
-        propertyIsEnumerable(v: PropertyKey): boolean;
     };
     static get serverConditionSettings(): {
         valueComponent(classComp: any): {
@@ -35,28 +28,11 @@ export default class RadioComponent extends ListComponent {
                 custom: string;
             };
         };
-        constructor: Function;
-        toString(): string;
-        toLocaleString(): string;
-        valueOf(): Object;
-        hasOwnProperty(v: PropertyKey): boolean;
-        isPrototypeOf(v: Object): boolean;
-        propertyIsEnumerable(v: PropertyKey): boolean;
     };
     static savedValueTypes(schema: any): any[];
     constructor(component: any, options: any, data: any);
     previousValue: any;
-    get inputInfo(): {
-        type: string;
-        component: any;
-        changeEvent: string;
-        attr: {
-            name: any;
-            type: any;
-            class: string;
-            lang: any;
-        };
-    };
+    get inputInfo(): any;
     get emptyValue(): string;
     get isRadio(): boolean;
     get optionSelectedClass(): string;
@@ -67,7 +43,8 @@ export default class RadioComponent extends ListComponent {
     itemsLoadedResolve: ((value: any) => void) | undefined;
     optionsLoaded: boolean | undefined;
     loadedOptions: any[] | undefined;
-    render(): any;
+    render(): import("../_classes/field/Field").default;
+    attach(element: any): Promise<void>;
     detach(element: any): void;
     validateValueProperty(): boolean;
     validateValueAvailability(setting: any, value: any): boolean;

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

@@ -2,6 +2,11 @@ import listComponentForm from '../_classes/list/ListComponent.form';
 import RadioEditData from './editForm/Radio.edit.data';
 import RadioEditDisplay from './editForm/Radio.edit.display';
 import RadioEditValidation from './editForm/Radio.edit.validation';
+/**
+ * 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/radio/Radio.js

@@ -357,10 +357,9 @@ export default class RadioComponent extends ListComponent {
         return changed;
     }
     /**
-     * Normalize values coming into updateValue.
-     *
-     * @param value
-     * @return {*}
+     * Normalize values coming into updateValue. For example, depending on the configuration, string value `"true"` will be normalized to boolean `true`.
+     * @param {*} value - The value to normalize
+     * @returns {*} - Returns the normalized value
      */
     normalizeValue(value) {
         const dataType = this.component.dataType || 'auto';

package/lib/mjs/components/recaptcha/ReCaptcha.d.ts

@@ -8,7 +8,7 @@ export default class ReCaptchaComponent extends Component {
         schema: any;
     };
     static savedValueTypes(): never[];
-    render(): any;
+    render(): string;
     recaptchaResult: any;
     createInput(): void;
     recaptchaApiReady: any;

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

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

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

@@ -1,5 +1,9 @@
 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

@@ -9,23 +9,9 @@ export default class SelectComponent extends ListComponent {
     };
     static get serverConditionSettings(): {
         valueComponent(classComp: any): any;
-        constructor: Function;
-        toString(): string;
-        toLocaleString(): string;
-        valueOf(): Object;
-        hasOwnProperty(v: PropertyKey): boolean;
-        isPrototypeOf(v: Object): boolean;
-        propertyIsEnumerable(v: PropertyKey): boolean;
     };
     static get conditionOperatorsSettings(): {
         valueComponent(classComp: any): any;
-        constructor: Function;
-        toString(): string;
-        toLocaleString(): string;
-        valueOf(): Object;
-        hasOwnProperty(v: PropertyKey): boolean;
-        isPrototypeOf(v: Object): boolean;
-        propertyIsEnumerable(v: PropertyKey): boolean;
     };
     static savedValueTypes(schema: any): any[];
     templateData: {} | undefined;
@@ -44,21 +30,11 @@ export default class SelectComponent extends ListComponent {
     get dataReady(): any;
     get emptyValue(): {};
     get valueProperty(): any;
-    get inputInfo(): {
-        type: string;
-        component: any;
-        changeEvent: string;
-        attr: {
-            name: any;
-            type: any;
-            class: string;
-            lang: any;
-        };
-    };
+    get inputInfo(): any;
     get isSelectResource(): boolean;
     get itemsFromUrl(): boolean;
     get isInfiniteScrollProvided(): boolean;
-    get shouldInitialLoad(): any;
+    get shouldInitialLoad(): boolean;
     get selectMetadata(): any;
     isEntireObjectDisplay(): boolean;
     selectValueAndLabel(data: any): {
@@ -68,11 +44,12 @@ export default class SelectComponent extends ListComponent {
     itemTemplate(data: any, value: any): any;
     /**
      * Adds an option to the select dropdown.
-     *
-     * @param value
-     * @param label
+     * @param {*} value - The value of the new option.
+     * @param {string} label - The label of the new option.
+     * @param {object} [attrs] - Additional value attributes. Defaults to {}.
+     * @param {string} [id] - An id. Defaults to a random string.
      */
-    addOption(value: any, label: any, attrs?: {}, id?: string): void;
+    addOption(value: any, label: string, attrs?: object | undefined, id?: string | undefined): void;
     addValueOptions(items: any): boolean;
     disableInfiniteScroll(): void;
     set serverCount(value: any);
@@ -82,6 +59,7 @@ export default class SelectComponent extends ListComponent {
     set downloadedResources(value: any);
     get downloadedResources(): any;
     getSingleItemValueForHTMLMode(data: any): any;
+    itemValueForHTMLMode(value: any): any;
     get loadingError(): boolean | undefined;
     loadItems(url: any, search: any, headers: any, options: any, method: any, body: any): void;
     getCustomItems(): any;
@@ -99,7 +77,7 @@ export default class SelectComponent extends ListComponent {
     activate(): void;
     setLoadingItem(addToCurrentList?: boolean): void;
     get active(): boolean | undefined;
-    render(): any;
+    render(): import("../_classes/field/Field").default;
     wrapElement(element: any): any;
     choicesOptions(): any;
     attach(element: any): Promise<void> | undefined;
@@ -115,11 +93,8 @@ export default class SelectComponent extends ListComponent {
     attachRefreshOnBlur(): void;
     addPlaceholderItem(placeholderValue: any): void;
     update(): void;
-    /**
-     * @param {*} value
-     * @param {Array} items
-     */
-    addCurrentChoices(values: any, items: any[], keyValue: any): any;
+    addCurrentChoices(values: any, items: any, keyValue: any): any;
+    getValueAsString(data: any, options: any): any;
     normalizeSingleValue(value: any): any;
     setMetadata(value: any): any;
     updateValue(value: any, flags: any): boolean;
@@ -131,22 +106,24 @@ 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;
     /**
      * If component has static values (values, json) or custom values, returns an array of them
-     * @returns {Array<*>|undefined}
+     * @returns {Array<*>|undefined} - Returns an array of the static or custom values.
      */
     getOptionsValues(): Array<any> | undefined;
     /**
      * Output this select dropdown as a string value.
-     * @return {*}
+     * @returns {*}
      */
     isBooleanOrNumber(value: any): any;
     getNormalizedValues(): any;
     asString(value: any, options?: {}): any;
     focus(): void;
+    setErrorClasses(elements: any, dirty: any, hasError: any, hasMessages: any, element?: any): void;
 }
 import ListComponent from '../_classes/list/ListComponent';
 import Choices from '../../utils/ChoicesWrapper';

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

@@ -2,6 +2,11 @@ import listComponentForm from '../_classes/list/ListComponent.form';
 import SelectEditData from './editForm/Select.edit.data';
 import SelectEditDisplay from './editForm/Select.edit.display';
 import SelectEditValidation from './editForm/Select.edit.validation';
+/**
+ * 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

@@ -284,9 +284,10 @@ export default class SelectComponent extends ListComponent {
     }
     /**
      * Adds an option to the select dropdown.
-     *
-     * @param value
-     * @param label
+     * @param {*} value - The value of the new option.
+     * @param {string} label - The label of the new option.
+     * @param {object} [attrs] - Additional value attributes. Defaults to {}.
+     * @param {string} [id] - An id. Defaults to a random string.
      */
     addOption(value, label, attrs = {}, id = getRandomComponentId()) {
         if (_.isNil(label))
@@ -592,6 +593,7 @@ export default class SelectComponent extends ListComponent {
     }
     /**
      * Get the request headers for this select dropdown.
+     * @returns {*} - Returns the request headers for this select dropdown.
      */
     get requestHeaders() {
         // Create the headers object.
@@ -1068,10 +1070,6 @@ export default class SelectComponent extends ListComponent {
     get visible() {
         return super.visible;
     }
-    /**
-     * @param {*} value
-     * @param {Array} items
-     */
     addCurrentChoices(values, items, keyValue) {
         if (!values) {
             return false;
@@ -1220,10 +1218,9 @@ export default class SelectComponent extends ListComponent {
         }
     }
     /**
-     * Normalize values coming into updateValue.
-     *
-     * @param value
-     * @return {*}
+     * Normalize values coming into updateValue. For example, depending on the configuration, string value `"true"` will be normalized to boolean `true`.
+     * @param {*} value - The value to normalize
+     * @returns {*} - Returns the normalized value
      */
     normalizeValue(value) {
         if (this.component.multiple && Array.isArray(value)) {
@@ -1418,7 +1415,8 @@ 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) {
         return _.isObject(value) && this.isEntireObjectDisplay()
@@ -1433,7 +1431,7 @@ export default class SelectComponent extends ListComponent {
     }
     /**
      * If component has static values (values, json) or custom values, returns an array of them
-     * @returns {Array<*>|undefined}
+     * @returns {Array<*>|undefined} - Returns an array of the static or custom values.
      */
     getOptionsValues() {
         let rawItems = [];
@@ -1473,8 +1471,7 @@ export default class SelectComponent extends ListComponent {
     }
     /**
      * Check if a component is eligible for multiple validation
-     *
-     * @return {boolean}
+     * @returns {boolean} - Returns FALSE for select components.
      */
     validateMultiple() {
         // Select component will contain one input when flagged as multiple.
@@ -1482,7 +1479,7 @@ export default class SelectComponent extends ListComponent {
     }
     /**
      * Output this select dropdown as a string value.
-     * @return {*}
+     * @returns {*}
      */
     isBooleanOrNumber(value) {
         return typeof value === 'number' || typeof value === 'boolean';

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

@@ -9,13 +9,6 @@ export default class SelectBoxesComponent extends RadioComponent {
                 custom: string;
             };
         };
-        constructor: Function;
-        toString(): string;
-        toLocaleString(): string;
-        valueOf(): Object;
-        hasOwnProperty(v: PropertyKey): boolean;
-        isPrototypeOf(v: Object): boolean;
-        propertyIsEnumerable(v: PropertyKey): boolean;
     };
     static get conditionOperatorsSettings(): {
         valueComponent(classComp: any): {
@@ -27,22 +20,14 @@ export default class SelectBoxesComponent extends RadioComponent {
                 custom: string;
             };
         };
-        constructor: Function;
-        toString(): string;
-        toLocaleString(): string;
-        valueOf(): Object;
-        hasOwnProperty(v: PropertyKey): boolean;
-        isPrototypeOf(v: Object): boolean;
-        propertyIsEnumerable(v: PropertyKey): boolean;
     };
     static savedValueTypes(schema: any): string[];
     constructor(...args: any[]);
     get emptyValue(): any;
     /**
      * Only empty if the values are all false.
-     *
-     * @param value
-     * @return {boolean}
+     * @param {any} value - The value to check if empty.
+     * @returns {boolean} - If the value is empty.
      */
     isEmpty(value?: any): boolean;
     setInputsDisabled(value: any, onlyUnchecked: any): void;

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

@@ -1,5 +1,10 @@
 import radioEditForm from '../radio/Radio.form';
 import SelectBoxesEditValidation from './editForm/SelectBoxes.edit.validation';
+/**
+ * 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,9 +79,8 @@ export default class SelectBoxesComponent extends RadioComponent {
     }
     /**
      * Only empty if the values are all false.
-     *
-     * @param value
-     * @return {boolean}
+     * @param {any} value - The value to check if empty.
+     * @returns {boolean} - If the value is empty.
      */
     isEmpty(value = this.dataValue) {
         let empty = true;
@@ -105,9 +104,8 @@ export default class SelectBoxesComponent extends RadioComponent {
     }
     /**
      * Normalize values coming into updateValue.
-     *
-     * @param value
-     * @return {*}
+     * @param {any} value - The value to normalize.
+     * @returns {*} - The normalized value
      */
     normalizeValue(value) {
         value = value || {};
@@ -140,9 +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.d.ts

@@ -9,23 +9,9 @@ export default class SignatureComponent extends Input {
     };
     static get serverConditionSettings(): {
         operators: string[];
-        constructor: Function;
-        toString(): string;
-        toLocaleString(): string;
-        valueOf(): Object;
-        hasOwnProperty(v: PropertyKey): boolean;
-        isPrototypeOf(v: Object): boolean;
-        propertyIsEnumerable(v: PropertyKey): boolean;
     };
     static get conditionOperatorsSettings(): {
         operators: string[];
-        constructor: Function;
-        toString(): string;
-        toLocaleString(): string;
-        valueOf(): Object;
-        hasOwnProperty(v: PropertyKey): boolean;
-        isPrototypeOf(v: Object): boolean;
-        propertyIsEnumerable(v: PropertyKey): boolean;
     };
     static savedValueTypes(schema: any): string[];
     currentWidth: any;
@@ -36,6 +22,7 @@ export default class SignatureComponent extends Input {
     showCanvas(show: any): void;
     onDisabled(): void;
     checkSize(force: any, scale: any): void;
+    getModalPreviewTemplate(): any;
     signaturePad: SignaturePad | null | undefined;
     observer: any;
     getValueAsString(value: any): "" | "Yes" | "No";

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

@@ -2,6 +2,11 @@ import Components from '../Components';
 import SignatureEditData from './editForm/Signature.edit.data';
 import SignatureEditDisplay from './editForm/Signature.edit.display';
 import SignatureEditValidation from './editForm/Signature.edit.validation';
+/**
+ * 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.d.ts

@@ -9,29 +9,17 @@ export default class SurveyComponent extends Field {
     };
     static get serverConditionSettings(): {
         operators: string[];
-        constructor: Function;
-        toString(): string;
-        toLocaleString(): string;
-        valueOf(): Object;
-        hasOwnProperty(v: PropertyKey): boolean;
-        isPrototypeOf(v: Object): boolean;
-        propertyIsEnumerable(v: PropertyKey): boolean;
     };
     static get conditionOperatorsSettings(): {
         operators: string[];
-        constructor: Function;
-        toString(): string;
-        toLocaleString(): string;
-        valueOf(): Object;
-        hasOwnProperty(v: PropertyKey): boolean;
-        isPrototypeOf(v: Object): boolean;
-        propertyIsEnumerable(v: PropertyKey): boolean;
     };
     static savedValueTypes(schema: any): string[];
-    render(): any;
+    render(): Field;
+    attach(element: any): Promise<void>;
     setValue(value: any, flags?: {}): boolean;
     get emptyValue(): {};
     validateRequired(setting: any, value: any): any;
     getInputName(question: any): string;
+    getValueAsString(value: any, options: any): any;
 }
 import Field from '../_classes/field/Field';

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

@@ -2,6 +2,11 @@ import Components from '../Components';
 import SurveyEditData from './editForm/Survey.edit.data';
 import SurveyEditDisplay from './editForm/Survey.edit.display';
 import SurveyEditValidation from './editForm/Survey.edit.validation';
+/**
+ * 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([
         {