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

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

@@ -13,11 +13,11 @@ 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;
@@ -29,30 +29,31 @@ export default class FormComponent extends Component {
      * Prints out the value of form components as a datagrid value.
      */
     getValueAsString(value: any, options: any): any;
-    attach(element: any): Promise<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.
-     * @param fromAttach
-     * @returns {*}
+     * @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 fromAttach
+     * @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;
@@ -61,28 +62,30 @@ export default class FormComponent extends Component {
     setPristine(pristine: any): void;
     /**
      * Determine if the subform should be submitted.
-     * @returns {*|boolean}
+     * @returns {*|boolean} - TRUE if the subform should be submitted, FALSE if it should not.
      */
     get shouldSubmit(): any;
     /**
      * Returns the data for the subform.
-     * @returns {*}
+     * @returns {*} - the data for the subform.
      */
     getSubFormData(): any;
     /**
      * Submit the subform if configured to do so.
-     * @returns {*}
+     * @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 next
+     * @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: any): any;
+    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.
      */
-    beforeSubmit(): any;
+    beforeSubmit(): Promise<any>;
     isSubFormLazyLoad(): any;
     isHidden(): boolean;
     setValue(submission: any, flags?: {}): boolean;
@@ -92,7 +95,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(): boolean;
     isInternalEvent(event: any): boolean;

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

@@ -3,8 +3,9 @@ import FormEditDisplay from './editForm/Form.edit.display';
 import FormEditForm from './editForm/Form.edit.form';
 import FormEditData from './editForm/Form.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 nestedComponentForm([

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

@@ -200,6 +200,9 @@ export default class FormComponent extends Component {
         if (this.options.saveDraftThrottle) {
             options.saveDraftThrottle = this.options.saveDraftThrottle;
         }
+        if (this.options.skipDraftRestore) {
+            options.skipDraftRestore = this.options.skipDraftRestore;
+        }
         return options;
     }
     /* eslint-enable max-statements */
@@ -343,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) {
@@ -368,8 +371,8 @@ export default class FormComponent extends Component {
     }
     /**
      * Create a subform instance.
-     * @param fromAttach
-     * @returns {*}
+     * @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) => {
@@ -422,7 +425,8 @@ export default class FormComponent extends Component {
     }
     /**
      * Load the subform.
-     * @param fromAttach
+     * @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)) {
@@ -505,14 +509,14 @@ export default class FormComponent extends Component {
     }
     /**
      * Determine if the subform should be submitted.
-     * @returns {*|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.
-     * @returns {*}
+     * @returns {*} - the data for the subform.
      */
     getSubFormData() {
         if (_.get(this.subForm, 'form.display') === 'pdf') {
@@ -524,7 +528,7 @@ export default class FormComponent extends Component {
     }
     /**
      * Submit the subform if configured to do so.
-     * @returns {*}
+     * @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.
@@ -551,7 +555,8 @@ export default class FormComponent extends Component {
     }
     /**
      * Submit the form before the next page is triggered.
-     * @param next
+     * @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
@@ -562,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;
@@ -570,8 +576,9 @@ export default class FormComponent extends Component {
             this.subForm.triggerSaveDraft.cancel();
         }
         const isAlreadySubmitted = submission && submission._id && submission.form;
+        const isDraftSubmission = this.options.saveDraft && submission.state === 'draft';
         // This submission has already been submitted, so just return the reference data.
-        if (isAlreadySubmitted && !this.subForm?.wizard) {
+        if (isAlreadySubmitted && !this.subForm?.wizard && !isDraftSubmission) {
             this.dataValue = submission;
             return Promise.resolve(this.dataValue);
         }
@@ -671,7 +678,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/form/editForm/Form.edit.data.d.ts

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

package/lib/mjs/components/form/fixtures/comp7.d.ts

@@ -0,0 +1,36 @@
+declare namespace _default {
+    let _id: string;
+    let title: string;
+    let name: string;
+    let path: string;
+    let type: string;
+    let display: string;
+    let components: ({
+        label: string;
+        tableView: boolean;
+        key: string;
+        type: string;
+        input: boolean;
+        src?: undefined;
+        disableOnInvalid?: undefined;
+    } | {
+        label: string;
+        tableView: boolean;
+        src: string;
+        key: string;
+        type: string;
+        input: boolean;
+        disableOnInvalid?: undefined;
+    } | {
+        type: string;
+        label: string;
+        key: string;
+        disableOnInvalid: boolean;
+        input: boolean;
+        tableView: boolean;
+        src?: undefined;
+    })[];
+    let project: string;
+    let machineName: string;
+}
+export default _default;

package/lib/mjs/components/form/fixtures/comp7.js

@@ -0,0 +1,35 @@
+export default {
+    _id: '66051dae494c977c47028fac',
+    title: 'test draft parent',
+    name: 'testDraftParent',
+    path: 'testdraftparent',
+    type: 'form',
+    display: 'form',
+    components: [
+        {
+            label: 'Parent Form Field',
+            tableView: true,
+            key: 'parent',
+            type: 'textfield',
+            input: true,
+        },
+        {
+            label: 'Form',
+            tableView: true,
+            src: 'http://localhost:3000/idwqwhclwioyqbw/testdraftnested',
+            key: 'form',
+            type: 'form',
+            input: true,
+        },
+        {
+            type: 'button',
+            label: 'Submit',
+            key: 'submit',
+            disableOnInvalid: true,
+            input: true,
+            tableView: false,
+        },
+    ],
+    project: '63cead09be0090345b109e22',
+    machineName: 'idwqwhclwioyqbw:testdraftparent'
+};

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

@@ -0,0 +1,26 @@
+declare namespace _default {
+    let _id: string;
+    let title: string;
+    let name: string;
+    let path: string;
+    let type: string;
+    let display: string;
+    let components: ({
+        label: string;
+        tableView: boolean;
+        key: string;
+        type: string;
+        input: boolean;
+        disableOnInvalid?: undefined;
+    } | {
+        type: string;
+        label: string;
+        key: string;
+        disableOnInvalid: boolean;
+        input: boolean;
+        tableView: boolean;
+    })[];
+    let project: string;
+    let machineName: string;
+}
+export default _default;

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

@@ -0,0 +1,27 @@
+export default {
+    _id: '63e4deda12b88c4f05c125cf',
+    title: 'test draft nested',
+    name: 'testDraftNested',
+    path: 'testdraftnested',
+    type: 'form',
+    display: 'form',
+    components: [
+        {
+            label: 'Nested Form Field',
+            tableView: true,
+            key: 'nested',
+            type: 'textfield',
+            input: true,
+        },
+        {
+            type: 'button',
+            label: 'Submit',
+            key: 'submit',
+            disableOnInvalid: true,
+            input: true,
+            tableView: false,
+        },
+    ],
+    project: '63cead09be0090345b109e22',
+    machineName: 'idwqwhclwioyqbw:testdraftparent'
+};

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

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

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

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

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

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

@@ -33,7 +33,7 @@ export default class HiddenComponent extends Input {
     }
     /**
      * Check if a component is eligible for multiple validation
-     * @returns {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.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/html/HTML.form.js

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

@@ -23,7 +23,7 @@ export default class NumberComponent extends Input {
     numberMask: any;
     /**
      * Creates the number mask for normal numbers.
-     * @returns {*}
+     * @returns {*} - The number mask.
      */
     createNumberMask(): any;
     isDecimalAllowed(): any;

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

@@ -3,8 +3,9 @@ import NumberEditDisplay from './editForm/Number.edit.display';
 import NumberEditData from './editForm/Number.edit.data';
 import NumberEditValidation from './editForm/Number.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/number/Number.js

@@ -70,7 +70,7 @@ export default class NumberComponent extends Input {
     }
     /**
      * Creates the number mask for normal numbers.
-     * @returns {*}
+     * @returns {*} - The number mask.
      */
     createNumberMask() {
         return createNumberMask({

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

@@ -2,8 +2,9 @@ import nestedComponentForm from '../_classes/nested/NestedComponent.form';
 import PanelEditDisplay from './editForm/Panel.edit.display';
 import PanelEditConditional from './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.
  */
 export default function (...extend) {
     return nestedComponentForm([

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

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

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;