@formio/js 5.0.0-dev.5643.9c5173a → 5.0.0-dev.5646.35daa65

package/lib/mjs/components/file/File.form.js

@@ -3,6 +3,11 @@ import FileEditData from './editForm/File.edit.data';
 import FileEditDisplay from './editForm/File.edit.display';
 import FileEditFile from './editForm/File.edit.file';
 import FileEditValidation from './editForm/File.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/file/File.js

@@ -649,8 +649,7 @@ export default class FileComponent extends Field {
         // Check if file with the same name is being uploaded
         const fileWithSameNameUploading = this.filesToSync.filesToUpload
             .some(fileToSync => fileToSync.file?.name === file.name);
-        const fileWithSameNameUploaded = this.dataValue
-            .some(fileStatus => fileStatus.originalName === file.name);
+        const fileWithSameNameUploaded = _.some(this.dataValue, fileStatus => fileStatus.originalName === file.name);
         return fileWithSameNameUploaded || fileWithSameNameUploading
             ? {
                 status: 'error',

package/lib/mjs/components/form/Form.d.ts

@@ -13,41 +13,47 @@ export default class FormComponent extends Component {
     valueChanged: boolean | undefined;
     subForm: any;
     formSrc: any;
-    get dataReady(): any;
+    get dataReady(): Promise<any>;
     get emptyValue(): {
         data: {};
     };
-    get ready(): any;
+    get ready(): Promise<any>;
     get useOriginalRevision(): any;
     setFormRevision(rev: any): void;
     subFormRevision: any;
     getComponent(path: any, fn: any): any;
     getSubOptions(options?: {}): {};
-    render(): any;
+    render(): string;
     asString(value: any): any;
-    attach(element: any): Promise<any>;
+    /**
+     * Prints out the value of form components as a datagrid value.
+     */
+    getValueAsString(value: any, options: any): any;
+    attach(element: any): Promise<void>;
     get hasLoadedForm(): any;
     get isRevisionChanged(): any;
-    subFormReady: any;
+    subFormReady: Promise<any> | null | undefined;
     /**
      * Pass everyComponent to subform.
-     * @param args
-     * @returns {*|void}
+     * @param {any[]} args - Arguments to pass through to the subform's everyComponent method.
+     * @returns {*} - The result of the subform's everyComponent method.
      */
-    everyComponent(...args: any[]): any | void;
+    everyComponent(...args: any[]): any;
     setSubFormDisabled(subForm: any): void;
     updateSubWizards(subForm: any): void;
     /**
      * Create a subform instance.
-     *
-     * @return {*}
+     * @param {boolean} [fromAttach] - This function is being called from an `attach` method.
+     * @returns {*} - The subform instance.
      */
-    createSubForm(fromAttach: any): any;
+    createSubForm(fromAttach?: boolean | undefined): any;
     hideSubmitButton(component: any): void;
     /**
      * Load the subform.
+     * @param {boolean} fromAttach - This function is being called from an `attach` method.
+     * @returns {Promise} - The promise that resolves when the subform is loaded.
      */
-    loadSubForm(fromAttach: any): any;
+    loadSubForm(fromAttach: boolean): Promise<any>;
     subFormLoading: boolean | undefined;
     get subFormData(): any;
     checkComponentValidity(data: any, dirty: any, row: any, options: any, errors?: any[]): any;
@@ -56,35 +62,47 @@ export default class FormComponent extends Component {
     setPristine(pristine: any): void;
     /**
      * Determine if the subform should be submitted.
-     * @return {*|boolean}
+     * @returns {*|boolean} - TRUE if the subform should be submitted, FALSE if it should not.
      */
     get shouldSubmit(): any;
     /**
      * Returns the data for the subform.
-     *
-     * @return {*}
+     * @returns {*} - the data for the subform.
      */
     getSubFormData(): any;
     /**
      * Submit the subform if configured to do so.
-     *
-     * @return {*}
+     * @returns {Promise} - The promise that resolves when the subform is submitted.
      */
-    submitSubForm(): any;
+    submitSubForm(): Promise<any>;
     /**
      * Submit the form before the next page is triggered.
+     * @param {Function} next - The function to trigger the next page.
+     * @returns {Promise} - The promise that resolves when the subform submission is complete (if necessary) and the next page is triggered.
+     */
+    beforePage(next: Function): Promise<any>;
+    /**
+     * Submit the form before the whole form is triggered.
+     * @returns {Promise} - The promise that resolves when the subform submission is complete (if necessary) and the form is submitted.
      */
-    beforePage(next: any): any;
+    beforeSubmit(): Promise<any>;
     isSubFormLazyLoad(): any;
     isHidden(): boolean;
     setValue(submission: any, flags?: {}): boolean;
     setSubFormValue(submission: any, flags: any): void;
+    /**
+     * Sets the subform value
+     * @param {object|null|undefined} submission - The submission to set.
+     * @param {object|null|undefined} flags - Any flags to apply when setting the submission.
+     * @returns {void}
+     */
+    onSetSubFormValue(submission: object | null | undefined, flags: object | null | undefined): void;
     areAllComponentsEmpty(data: any): boolean;
     updateSubFormVisibility(): void;
     /**
      * Determines if this form is a Nested Wizard
      * which means it should be a Wizard itself and should be a direct child of a Wizard's page
-     * @returns {boolean}
+     * @returns {boolean} - TRUE if this form is a Nested Wizard, FALSE otherwise
      */
     get isNestedWizard(): boolean;
     isInternalEvent(event: any): boolean;

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

@@ -2,6 +2,11 @@ import nestedComponentForm from '../_classes/nested/NestedComponent.form';
 import FormEditDisplay from './editForm/Form.edit.display';
 import FormEditForm from './editForm/Form.edit.form';
 import FormEditData from './editForm/Form.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 nestedComponentForm([
         {

package/lib/mjs/components/form/Form.js

@@ -346,8 +346,8 @@ export default class FormComponent extends Component {
     }
     /**
      * Pass everyComponent to subform.
-     * @param args
-     * @returns {*|void}
+     * @param {any[]} args - Arguments to pass through to the subform's everyComponent method.
+     * @returns {*} - The result of the subform's everyComponent method.
      */
     everyComponent(...args) {
         if (this.subForm) {
@@ -371,8 +371,8 @@ export default class FormComponent extends Component {
     }
     /**
      * Create a subform instance.
-     *
-     * @return {*}
+     * @param {boolean} [fromAttach] - This function is being called from an `attach` method.
+     * @returns {*} - The subform instance.
      */
     createSubForm(fromAttach) {
         this.subFormReady = this.loadSubForm(fromAttach).then((form) => {
@@ -425,6 +425,8 @@ export default class FormComponent extends Component {
     }
     /**
      * Load the subform.
+     * @param {boolean} fromAttach - This function is being called from an `attach` method.
+     * @returns {Promise} - The promise that resolves when the subform is loaded.
      */
     loadSubForm(fromAttach) {
         if (this.builderMode || this.isHidden() || (this.isSubFormLazyLoad() && !fromAttach)) {
@@ -440,7 +442,7 @@ export default class FormComponent extends Component {
         }
         else if (this.formSrc) {
             this.subFormLoading = true;
-            const options = this.root.formio?.base && this.root.formio?.projectUrl
+            const options = this.root?.formio?.base && this.root?.formio?.projectUrl
                 ? {
                     base: this.root.formio.base,
                     project: this.root.formio.projectUrl,
@@ -507,15 +509,14 @@ export default class FormComponent extends Component {
     }
     /**
      * Determine if the subform should be submitted.
-     * @return {*|boolean}
+     * @returns {*|boolean} - TRUE if the subform should be submitted, FALSE if it should not.
      */
     get shouldSubmit() {
         return this.subFormReady && (!this.component.hasOwnProperty('reference') || this.component.reference) && !this.isHidden();
     }
     /**
      * Returns the data for the subform.
-     *
-     * @return {*}
+     * @returns {*} - the data for the subform.
      */
     getSubFormData() {
         if (_.get(this.subForm, 'form.display') === 'pdf') {
@@ -527,8 +528,7 @@ export default class FormComponent extends Component {
     }
     /**
      * Submit the subform if configured to do so.
-     *
-     * @return {*}
+     * @returns {Promise} - The promise that resolves when the subform is submitted.
      */
     submitSubForm() {
         // If we wish to submit the form on next page, then do that here.
@@ -555,6 +555,8 @@ export default class FormComponent extends Component {
     }
     /**
      * Submit the form before the next page is triggered.
+     * @param {Function} next - The function to trigger the next page.
+     * @returns {Promise} - The promise that resolves when the subform submission is complete (if necessary) and the next page is triggered.
      */
     beforePage(next) {
         // Should not submit child forms if we are going to the previous page
@@ -565,6 +567,7 @@ export default class FormComponent extends Component {
     }
     /**
      * Submit the form before the whole form is triggered.
+     * @returns {Promise} - The promise that resolves when the subform submission is complete (if necessary) and the form is submitted.
      */
     beforeSubmit() {
         const submission = this.dataValue;
@@ -624,7 +627,7 @@ export default class FormComponent extends Component {
         if (shouldLoadSubmissionById || shouldLoadDraftById) {
             const formId = submission.form || this.formObj.form || this.component.form;
             const submissionUrl = `${this.subForm.formio.formsUrl}/${formId}/submission/${submission._id || this.subForm.submission._id}`;
-            const options = this.root.formio?.base && this.root.formio?.projectUrl
+            const options = this.root?.formio?.base && this.root?.formio?.projectUrl
                 ? {
                     base: this.root.formio.base,
                     project: this.root.formio.projectUrl,
@@ -636,9 +639,18 @@ export default class FormComponent extends Component {
             });
         }
         else {
-            this.subForm.setValue(submission, flags);
+            this.onSetSubFormValue(submission, flags);
         }
     }
+    /**
+     * Sets the subform value
+     * @param {object|null|undefined} submission - The submission to set.
+     * @param {object|null|undefined} flags - Any flags to apply when setting the submission.
+     * @returns {void}
+     */
+    onSetSubFormValue(submission, flags) {
+        this.subForm.setValue(submission, flags);
+    }
     isEmpty(value = this.dataValue) {
         return value === null || _.isEqual(value, this.emptyValue) || (this.areAllComponentsEmpty(value?.data) && !value?._id);
     }
@@ -676,7 +688,7 @@ export default class FormComponent extends Component {
     /**
      * Determines if this form is a Nested Wizard
      * which means it should be a Wizard itself and should be a direct child of a Wizard's page
-     * @returns {boolean}
+     * @returns {boolean} - TRUE if this form is a Nested Wizard, FALSE otherwise
      */
     get isNestedWizard() {
         return this.subForm?._form?.display === 'wizard' && this.parent?.parent?._form?.display === 'wizard';

package/lib/mjs/components/hidden/Hidden.d.ts

@@ -8,17 +8,7 @@ export default class HiddenComponent extends Input {
         showPreview: boolean;
         schema: any;
     };
-    get inputInfo(): {
-        type: string;
-        component: any;
-        changeEvent: string;
-        attr: {
-            name: any;
-            type: any;
-            class: string;
-            lang: any;
-        };
-    };
+    get inputInfo(): any;
     labelIsHidden(): boolean;
     get emptyValue(): string;
     setValue(value: any, flags?: {}): boolean;

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

@@ -1,6 +1,11 @@
 import Components from '../Components';
 import HiddenEditDisplay from './editForm/Hidden.edit.display';
 import HiddenEditData from './editForm/Hidden.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/hidden/Hidden.js

@@ -33,8 +33,7 @@ export default class HiddenComponent extends Input {
     }
     /**
      * Check if a component is eligible for multiple validation
-     *
-     * @return {boolean}
+     * @returns {boolean} - If the component is eligible for multiple validation.
      */
     validateMultiple() {
         // Since "arrays" are able to be stored in hidden components, we need to turn off multiple validation.

package/lib/mjs/components/html/HTML.d.ts

@@ -13,7 +13,8 @@ export default class HTMLComponent extends Component {
     get singleTags(): string[];
     checkRefreshOn(changed: any): void;
     renderContent(): any;
-    render(): any;
+    render(): string;
     get dataReady(): any;
+    attach(element: any): Promise<void>;
 }
 import Component from '../_classes/component/Component';

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

@@ -1,6 +1,11 @@
 import Components from '../Components';
 import HTMLEditDisplay from './editForm/HTML.edit.display';
 import HTMLEditLogic from './editForm/HTML.edit.logic';
+/**
+ * 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/number/Number.d.ts

@@ -10,35 +10,20 @@ export default class NumberComponent extends Input {
     static get serverConditionSettings(): {
         operators: any[];
         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(): {
         operators: any[];
         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): string[];
     constructor(...args: any[]);
     decimalSeparator: any;
     delimiter: any;
-    decimalLimit: any;
+    decimalLimit: number;
     numberMask: any;
     /**
      * Creates the number mask for normal numbers.
-     *
-     * @return {*}
+     * @returns {*} - The number mask.
      */
     createNumberMask(): any;
     isDecimalAllowed(): any;
@@ -49,5 +34,6 @@ export default class NumberComponent extends Input {
     parseValue(input: any): number;
     focus(): void;
     getMaskedValue(value: any): any;
+    getValueAsString(value: any, options: any): any;
 }
 import Input from '../_classes/input/Input';

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

@@ -2,6 +2,11 @@ import textEditForm from '../textfield/TextField.form';
 import NumberEditDisplay from './editForm/Number.edit.display';
 import NumberEditData from './editForm/Number.edit.data';
 import NumberEditValidation from './editForm/Number.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/number/Number.js

@@ -46,7 +46,7 @@ export default class NumberComponent extends Input {
     constructor(...args) {
         super(...args);
         const separators = getNumberSeparators(this.options.language || navigator.language);
-        this.decimalSeparator = this.options.decimalSeparator = this.options.decimalSeparator
+        this.decimalSeparator = this.options.decimalSeparator = this.component.decimalSymbol || this.options.decimalSeparator
             || this.options.properties?.decimalSeparator
             || separators.decimalSeparator;
         if (this.component.delimiter) {
@@ -70,8 +70,7 @@ export default class NumberComponent extends Input {
     }
     /**
      * Creates the number mask for normal numbers.
-     *
-     * @return {*}
+     * @returns {*} - The number mask.
      */
     createNumberMask() {
         return createNumberMask({

package/lib/mjs/components/number/fixtures/comp8.d.ts

@@ -0,0 +1,32 @@
+declare namespace _default {
+    let components: ({
+        label: string;
+        applyMaskOn: string;
+        mask: boolean;
+        tableView: boolean;
+        delimiter: boolean;
+        requireDecimal: boolean;
+        inputFormat: string;
+        truncateMultipleSpaces: boolean;
+        key: string;
+        type: string;
+        input: boolean;
+        decimalSymbol: string;
+        disableOnInvalid?: undefined;
+    } | {
+        type: string;
+        label: string;
+        key: string;
+        disableOnInvalid: boolean;
+        input: boolean;
+        tableView: boolean;
+        applyMaskOn?: undefined;
+        mask?: undefined;
+        delimiter?: undefined;
+        requireDecimal?: undefined;
+        inputFormat?: undefined;
+        truncateMultipleSpaces?: undefined;
+        decimalSymbol?: undefined;
+    })[];
+}
+export default _default;

package/lib/mjs/components/number/fixtures/comp8.js

@@ -0,0 +1,26 @@
+export default {
+    components: [
+        {
+            "label": "Number",
+            "applyMaskOn": "change",
+            "mask": false,
+            "tableView": false,
+            "delimiter": false,
+            "requireDecimal": false,
+            "inputFormat": "plain",
+            "truncateMultipleSpaces": false,
+            "key": "number",
+            "type": "number",
+            "input": true,
+            "decimalSymbol": "-"
+        },
+        {
+            "type": "button",
+            "label": "Submit",
+            "key": "submit",
+            "disableOnInvalid": true,
+            "input": true,
+            "tableView": false
+        }
+    ]
+};

package/lib/mjs/components/number/fixtures/index.d.ts

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

package/lib/mjs/components/number/fixtures/index.js

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

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/phonenumber/fixtures/comp2.d.ts

@@ -0,0 +1,16 @@
+declare namespace _default {
+    let components: {
+        label: string;
+        applyMaskOn: string;
+        allowMultipleMasks: boolean;
+        tableView: boolean;
+        key: string;
+        type: string;
+        inputMasks: {
+            label: string;
+            mask: string;
+        }[];
+        input: boolean;
+    }[];
+}
+export default _default;