@formio/js 5.0.0-dev.5641.d9ab3df → 5.0.0-dev.5643.17b8168

package/lib/mjs/components/day/Day.js

@@ -62,7 +62,8 @@ export default class DayComponent extends Field {
     }
     /**
      * The empty value for day component.
-     * @returns {'00/00/0000'} - The empty value of the day component.
+     *
+     * @return {'00/00/0000'}
      */
     get emptyValue() {
         return '00/00/0000';
@@ -353,10 +354,10 @@ export default class DayComponent extends Field {
         return dateParts.join('/');
     }
     /**
-     * Set the value at a specific index and updates the component's refs.
-     * @param {number} index - The index to set.
-     * @param {any} value - The value to set.
-     * @returns {null|void} - Returns null if the value is invalid, otherwise void.
+     * Set the value at a specific index.
+     *
+     * @param index
+     * @param value
      */
     setValueAt(index, value) {
         // temporary solution to avoid input reset
@@ -410,7 +411,7 @@ export default class DayComponent extends Field {
     }
     /**
      * Get the format for the value string.
-     * @returns {string} - the format for the value string.
+     * @returns {string}
      */
     get format() {
         let format = '';
@@ -434,8 +435,9 @@ export default class DayComponent extends Field {
     }
     /**
      * Return the date for this component.
-     * @param {any} value - The value to convert to a date.
-     * @returns {null|string} - The date string.
+     *
+     * @param value
+     * @return {*}
      */
     getDate(value) {
         let defaults = [], day, month, year;
@@ -481,15 +483,16 @@ export default class DayComponent extends Field {
         return result;
     }
     /**
-     * Return the date string for this component.
-     * @returns {string|null} - The date string for this component.
+     * Return the date object for this component.
+     * @returns {Date}
      */
     get date() {
         return this.getDate();
     }
     /**
      * Return the raw value.
-     * @returns {string} - The raw value of the component.
+     *
+     * @returns {Date}
      */
     get validationValue() {
         return this.dataValue;
@@ -500,8 +503,9 @@ export default class DayComponent extends Field {
     }
     /**
      * Get the value at a specific index.
-     * @param {number} index - The index to get the value from.
-     * @returns {*} - The value at index.
+     *
+     * @param index
+     * @returns {*}
      */
     getValueAt(index) {
         const date = this.date || this.emptyValue;
@@ -516,8 +520,9 @@ export default class DayComponent extends Field {
     }
     /**
      * Get the input value of the date.
-     * @param {any} value - The value to convert to a string.
-     * @returns {string|null} - The string value of the date.
+     *
+     * @param value
+     * @return {null}
      */
     getValueAsString(value) {
         return this.getDate(value) || '';

package/lib/mjs/components/editgrid/EditGrid.d.ts

@@ -19,9 +19,8 @@ export default class EditGridComponent extends NestedArrayComponent {
     get rowTemplate(): any;
     get headerTemplate(): any;
     /**
-     * @returns {boolean} - Returns true if the component has nested components which don't trigger changes on the root level
-     */
-    get hasScopedChildren(): boolean;
+     * Returns true if the component has nested components which don't trigger changes on the root level
+     */ get hasScopedChildren(): boolean;
     get emptyValue(): never[];
     get editgridKey(): string;
     get rowRef(): string;
@@ -36,8 +35,6 @@ export default class EditGridComponent extends NestedArrayComponent {
     get inlineEditMode(): any;
     get saveEditMode(): boolean;
     get minLength(): any;
-    set data(value: any);
-    get data(): any;
     get displayAsTable(): any;
     get iteratableRows(): any;
     get defaultValue(): any[];
@@ -93,10 +90,9 @@ export default class EditGridComponent extends NestedArrayComponent {
     validateRow(editRow: any, dirty: any, forceSilentCheck: any): any;
     showRowErrorAlerts(editRow: any, errors: any): void;
     /**
-     * @returns {boolean} - Return that this component processes its own validation.
+     * Return that this component processes its own validation.
      */
     get processOwnValidation(): boolean;
-    checkComponentValidity(data: any, dirty: any, row: any, options?: {}, errors?: any[]): boolean;
     setRowInvalid(ref: any, index: any): void;
     changeState(changed: any, flags: any): void;
     openWhenEmpty(): void;

package/lib/mjs/components/editgrid/EditGrid.form.d.ts

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

package/lib/mjs/components/editgrid/EditGrid.form.js

@@ -3,11 +3,6 @@ import EditGridEditData from './editForm/EditGrid.edit.data';
 import EditGridEditDisplay from './editForm/EditGrid.edit.display';
 import EditGridEditTemplates from './editForm/EditGrid.edit.templates';
 import EditGridEditValidation from './editForm/EditGrid.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/editgrid/EditGrid.js

@@ -161,8 +161,8 @@ export default class EditGridComponent extends NestedArrayComponent {
         return headerTemplate;
     }
     /**
-     * @returns {boolean} - Returns true if the component has nested components which don't trigger changes on the root level
-     */
+     * Returns true if the component has nested components which don't trigger changes on the root level
+     */ //
     get hasScopedChildren() {
         return !this.inlineEditMode;
     }
@@ -1035,7 +1035,7 @@ export default class EditGridComponent extends NestedArrayComponent {
         }
     }
     /**
-     * @returns {boolean} - Return that this component processes its own validation.
+     * Return that this component processes its own validation.
      */
     get processOwnValidation() {
         return true;

package/lib/mjs/components/editgrid/editForm/EditGrid.edit.display.js

@@ -1,4 +1,4 @@
-import { Evaluator } from '../../../utils/Evaluator';
+import Evaluator from '../../../utils/Evaluator';
 export default [
     {
         key: 'placeholder',

package/lib/mjs/components/editgrid/editForm/EditGrid.edit.templates.js

@@ -1,4 +1,4 @@
-import { Evaluator } from '../../../utils/Evaluator';
+import Evaluator from '../../../utils/Evaluator';
 export default [
     {
         type: 'textarea',

package/lib/mjs/components/email/Email.form.d.ts

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

package/lib/mjs/components/email/Email.form.js

@@ -1,11 +1,6 @@
 import baseEditForm from '../textfield/TextField.form';
 import EmailEditFormDisplay from './editForm/Email.edit.display';
 import EmailEditFormValidation from './editForm/Email.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 baseEditForm([
         {

package/lib/mjs/components/fieldset/Fieldset.form.d.ts

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

package/lib/mjs/components/fieldset/Fieldset.form.js

@@ -1,10 +1,5 @@
 import nestedComponentForm from '../_classes/nested/NestedComponent.form';
 import FieldSetEditDisplay from './editForm/Fieldset.edit.display';
-/**
- * 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/file/File.d.ts

@@ -9,9 +9,23 @@ export default class FileComponent 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[];
     support: {
@@ -45,7 +59,7 @@ export default class FileComponent extends Field {
         type: number;
         actions: number;
     };
-    render(): Field;
+    render(): any;
     getVideoStream(constraints: any): any;
     stopVideoStream(videoStream: any): void;
     getFrame(videoPlayer: any): Promise<any>;
@@ -65,7 +79,6 @@ export default class FileComponent extends Field {
     get actions(): {
         abort: (id: any) => void;
     };
-    attach(element: any): Promise<void>;
     filesReady: Promise<any> | undefined;
     filesReadyResolve: ((value: any) => void) | undefined;
     filesReadyReject: ((reason?: any) => void) | undefined;
@@ -89,34 +102,34 @@ export default class FileComponent extends Field {
         file: any;
         size: any;
         status: string;
-        message: string;
+        message: any;
         hash: string;
     };
     handleSubmissionRevisions(file: any): Promise<any>;
     validateFileName(file: any): {
         status: string;
-        message: string;
+        message: any;
     } | {
         status?: undefined;
         message?: undefined;
     };
     validateFileSettings(file: any): {
         status: string;
-        message: string;
+        message: any;
     } | {
         status?: undefined;
         message?: undefined;
     };
     validateFileService(): {
         status: string;
-        message: string;
+        message: any;
     } | {
         status?: undefined;
         message?: undefined;
     };
     validateFile(file: any): {
         status: string;
-        message: string;
+        message: any;
     } | {
         status?: undefined;
         message?: undefined;
@@ -127,10 +140,10 @@ export default class FileComponent extends Field {
     };
     triggerFileProcessor(file: any): Promise<{
         status: string;
-        message: string;
+        message: any;
         file?: undefined;
     } | {
-        file: FormData | null;
+        file: any;
         status?: undefined;
         message?: undefined;
     }>;

package/lib/mjs/components/file/File.form.d.ts

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

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

@@ -3,11 +3,6 @@ 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/form/Form.d.ts

@@ -13,47 +13,41 @@ export default class FormComponent extends Component {
     valueChanged: boolean | undefined;
     subForm: any;
     formSrc: any;
-    get dataReady(): Promise<any>;
+    get dataReady(): any;
     get emptyValue(): {
         data: {};
     };
-    get ready(): Promise<any>;
+    get ready(): any;
     get useOriginalRevision(): any;
     setFormRevision(rev: any): void;
     subFormRevision: any;
     getComponent(path: any, fn: any): any;
     getSubOptions(options?: {}): {};
-    render(): string;
+    render(): any;
     asString(value: any): any;
-    /**
-     * Prints out the value of form components as a datagrid value.
-     */
-    getValueAsString(value: any, options: any): any;
-    attach(element: any): Promise<void>;
+    attach(element: any): Promise<any>;
     get hasLoadedForm(): any;
     get isRevisionChanged(): any;
-    subFormReady: Promise<any> | null | undefined;
+    subFormReady: any;
     /**
      * Pass everyComponent to subform.
-     * @param {any[]} args - Arguments to pass through to the subform's everyComponent method.
-     * @returns {*} - The result of the subform's everyComponent method.
+     * @param args
+     * @returns {*|void}
      */
-    everyComponent(...args: any[]): any;
+    everyComponent(...args: any[]): any | void;
     setSubFormDisabled(subForm: any): void;
     updateSubWizards(subForm: any): void;
     /**
      * Create a subform instance.
-     * @param {boolean} [fromAttach] - This function is being called from an `attach` method.
-     * @returns {*} - The subform instance.
+     *
+     * @return {*}
      */
-    createSubForm(fromAttach?: boolean | undefined): any;
+    createSubForm(fromAttach: any): 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: boolean): Promise<any>;
+    loadSubForm(fromAttach: any): any;
     subFormLoading: boolean | undefined;
     get subFormData(): any;
     checkComponentValidity(data: any, dirty: any, row: any, options: any, errors?: any[]): any;
@@ -62,30 +56,25 @@ export default class FormComponent extends Component {
     setPristine(pristine: any): void;
     /**
      * Determine if the subform should be submitted.
-     * @returns {*|boolean} - TRUE if the subform should be submitted, FALSE if it should not.
+     * @return {*|boolean}
      */
     get shouldSubmit(): any;
     /**
      * Returns the data for the subform.
-     * @returns {*} - the data for the subform.
+     *
+     * @return {*}
      */
     getSubFormData(): any;
     /**
      * Submit the subform if configured to do so.
-     * @returns {Promise} - The promise that resolves when the subform is submitted.
+     *
+     * @return {*}
      */
-    submitSubForm(): Promise<any>;
+    submitSubForm(): 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.
      */
-    beforeSubmit(): Promise<any>;
+    beforePage(next: any): any;
     isSubFormLazyLoad(): any;
     isHidden(): boolean;
     setValue(submission: any, flags?: {}): boolean;
@@ -95,7 +84,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} - TRUE if this form is a Nested Wizard, FALSE otherwise
+     * @returns {boolean}
      */
     get isNestedWizard(): boolean;
     isInternalEvent(event: any): boolean;

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

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

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

@@ -2,11 +2,6 @@ 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 {any[]} args - Arguments to pass through to the subform's everyComponent method.
-     * @returns {*} - The result of the subform's everyComponent method.
+     * @param args
+     * @returns {*|void}
      */
     everyComponent(...args) {
         if (this.subForm) {
@@ -371,8 +371,8 @@ export default class FormComponent extends Component {
     }
     /**
      * Create a subform instance.
-     * @param {boolean} [fromAttach] - This function is being called from an `attach` method.
-     * @returns {*} - The subform instance.
+     *
+     * @return {*}
      */
     createSubForm(fromAttach) {
         this.subFormReady = this.loadSubForm(fromAttach).then((form) => {
@@ -425,8 +425,6 @@ 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)) {
@@ -442,7 +440,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,
@@ -509,14 +507,15 @@ export default class FormComponent extends Component {
     }
     /**
      * Determine if the subform should be submitted.
-     * @returns {*|boolean} - TRUE if the subform should be submitted, FALSE if it should not.
+     * @return {*|boolean}
      */
     get shouldSubmit() {
         return this.subFormReady && (!this.component.hasOwnProperty('reference') || this.component.reference) && !this.isHidden();
     }
     /**
      * Returns the data for the subform.
-     * @returns {*} - the data for the subform.
+     *
+     * @return {*}
      */
     getSubFormData() {
         if (_.get(this.subForm, 'form.display') === 'pdf') {
@@ -528,7 +527,8 @@ export default class FormComponent extends Component {
     }
     /**
      * Submit the subform if configured to do so.
-     * @returns {Promise} - The promise that resolves when the subform is submitted.
+     *
+     * @return {*}
      */
     submitSubForm() {
         // If we wish to submit the form on next page, then do that here.
@@ -555,8 +555,6 @@ 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
@@ -567,7 +565,6 @@ 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;
@@ -627,7 +624,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,
@@ -679,7 +676,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} - TRUE if this form is a Nested Wizard, FALSE otherwise
+     * @returns {boolean}
      */
     get isNestedWizard() {
         return this.subForm?._form?.display === 'wizard' && this.parent?.parent?._form?.display === 'wizard';

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

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

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

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

package/lib/mjs/components/hidden/Hidden.form.js

@@ -1,11 +1,6 @@
 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,7 +33,8 @@ export default class HiddenComponent extends Input {
     }
     /**
      * Check if a component is eligible for multiple validation
-     * @returns {boolean} - If the component is eligible for multiple validation.
+     *
+     * @return {boolean}
      */
     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,8 +13,7 @@ export default class HTMLComponent extends Component {
     get singleTags(): string[];
     checkRefreshOn(changed: any): void;
     renderContent(): any;
-    render(): string;
+    render(): any;
     get dataReady(): any;
-    attach(element: any): Promise<void>;
 }
 import Component from '../_classes/component/Component';

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

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