@formio/js 5.0.0-dev.5647.4cf82e8 → 5.0.0-dev.5650.cd53187

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

@@ -9,23 +9,9 @@ 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: {
@@ -47,19 +33,19 @@ export default class FileComponent extends Field {
     get dataReady(): Promise<any>;
     loadImage(fileInfo: any): any;
     get emptyValue(): never[];
-    getValueAsString(value: any): any;
+    getValueAsString(value: any, options: any): any;
     get defaultValue(): any[];
     get hasTypes(): any;
     _fileBrowseHidden: any;
     get shouldSyncFiles(): boolean;
-    get autoSync(): any;
+    get autoSync(): boolean;
     get columnsSize(): {
         name: number;
         size: number;
         type: number;
         actions: number;
     };
-    render(): any;
+    render(): Field;
     getVideoStream(constraints: any): any;
     stopVideoStream(videoStream: any): void;
     getFrame(videoPlayer: any): Promise<any>;
@@ -79,6 +65,7 @@ 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;
@@ -102,34 +89,34 @@ export default class FileComponent extends Field {
         file: any;
         size: any;
         status: string;
-        message: any;
+        message: string;
         hash: string;
     };
     handleSubmissionRevisions(file: any): Promise<any>;
     validateFileName(file: any): {
         status: string;
-        message: any;
+        message: string;
     } | {
         status?: undefined;
         message?: undefined;
     };
     validateFileSettings(file: any): {
         status: string;
-        message: any;
+        message: string;
     } | {
         status?: undefined;
         message?: undefined;
     };
     validateFileService(): {
         status: string;
-        message: any;
+        message: string;
     } | {
         status?: undefined;
         message?: undefined;
     };
     validateFile(file: any): {
         status: string;
-        message: any;
+        message: string;
     } | {
         status?: undefined;
         message?: undefined;
@@ -140,10 +127,10 @@ export default class FileComponent extends Field {
     };
     triggerFileProcessor(file: any): Promise<{
         status: string;
-        message: any;
+        message: string;
         file?: undefined;
     } | {
-        file: any;
+        file: FormData | null;
         status?: undefined;
         message?: undefined;
     }>;

package/lib/mjs/components/file/File.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/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

@@ -103,7 +103,12 @@ export default class FileComponent extends Field {
     get emptyValue() {
         return [];
     }
-    getValueAsString(value) {
+    getValueAsString(value, options) {
+        if (options?.review && !this.component.uploadOnly) {
+            return _.map(value, (val, index) => {
+                return `<a href="${val.url || '#'}" target="_blank" data-path='${this.path}' data-fileindex='${index}'>${val.originalName}</a>`;
+            }).join(', ');
+        }
         if (_.isArray(value)) {
             return _.map(value, 'originalName').join(', ');
         }
@@ -135,7 +140,9 @@ export default class FileComponent extends Field {
         return Boolean(this.filesToSync.filesToDelete.length || this.filesToSync.filesToUpload.length);
     }
     get autoSync() {
-        return _.get(this, 'component.autoSync', false);
+        // Disable autoSync for now
+        return false;
+        // return _.get(this, 'component.autoSync', false);
     }
     get columnsSize() {
         const actionsColumn = this.disabled ? 0 : this.autoSync ? 2 : 1;
@@ -649,8 +656,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',
@@ -932,6 +938,10 @@ export default class FileComponent extends Field {
                     : response.type === 'abort'
                         ? this.t('Request was aborted')
                         : response.toString();
+                this.emit('fileUploadError', {
+                    fileToSync,
+                    response,
+                });
             }
             finally {
                 delete fileToSync.progress;

package/lib/mjs/components/file/editForm/File.edit.display.js

@@ -4,7 +4,7 @@ export default [
         ignore: true
     },
     {
-        type: 'checkbox',
+        type: 'hidden',
         label: 'Files Synchronization feature',
         tooltip: 'Enable ability to control files synchronization. Files will be auto synced before submit.',
         key: 'autoSync',

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)) {
@@ -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;
@@ -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/form/editForm/Form.edit.form.js

@@ -44,7 +44,7 @@ export default [
         },
         searchField: 'title__regex',
         template: '<span>{{ item._vid }}</span>',
-        valueProperty: '_id',
+        valueProperty: 'revisionId',
         authenticate: true,
         label: 'Form Revision',
         key: 'revision',

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/html/HTML.js

@@ -5,7 +5,7 @@ export default class HTMLComponent extends Component {
         return Component.schema({
             label: 'HTML',
             type: 'htmlelement',
-            tag: 'p',
+            tag: 'div',
             attrs: [],
             content: '',
             input: false,

package/lib/mjs/components/number/Number.d.ts

@@ -10,44 +10,45 @@ 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;
-    parseNumber(value: any): number;
+    /**
+     * parses a numeric string by removing the delimiters and replacing the decimal separator back to '.' so that it can
+     * be processed by either parseInt or parseFloat
+     * @param {string} value the value to be parsed
+     * @returns {number} a parsed number
+     */
+    parseNumber(value: string): number;
     setInputMask(input: any): void;
     getValueAt(index: any): number | null;
     setValueAt(index: any, value: any, flags?: {}): void;
-    parseValue(input: any): number;
+    /**
+     * Converts a string to a floating point number, formats the number based on the parsed float function
+     * (https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/parseFloat) and then returns the
+     * formatted number back as a string
+     * Example Input: "123.456,22"
+     * Example Output: "123456,22"
+     * @param {string | number} input the numeric string to parse
+     * @returns {string | null} a parsed string
+     */
+    parseValue(input: string | number): string | null;
     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([
         {