@formio/js 5.0.2 → 5.1.0-dev.5936.fa0f253

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

@@ -115,10 +115,10 @@ export default class EditGridComponent extends NestedArrayComponent {
     }
     get defaultDialogTemplate() {
         return `
-    <h3 ${this._referenceAttributeName}="dialogHeader">${this.t('Do you want to clear data?')}</h3>
+    <h3 ${this._referenceAttributeName}="dialogHeader">${this.t('wantToClearData')}</h3>
     <div style="display:flex; justify-content: flex-end;">
-      <button ${this._referenceAttributeName}="dialogCancelButton" class="btn btn-secondary" aria-label="${this.t('Cancel')}">${this.t('Cancel')}</button>
-      <button ${this._referenceAttributeName}="dialogYesButton" class="btn btn-danger" aria-label="${this.t('Yes, delete it')}">${this.t('Yes, delete it')}</button>
+      <button ${this._referenceAttributeName}="dialogCancelButton" class="btn btn-secondary" aria-label="${this.t('cancel')}">${this.t('cancel')}</button>
+      <button ${this._referenceAttributeName}="dialogYesButton" class="btn btn-danger" aria-label="${this.t('yesDelete')}">${this.t('yesDelete')}</button>
     </div>
   `;
     }
@@ -289,12 +289,15 @@ export default class EditGridComponent extends NestedArrayComponent {
     }
     checkRowVariableTypeComponents(editRow, rowIndex) {
         const rowComponents = editRow.components;
+        let typeChanged = false;
         if (_.some(this.variableTypeComponentsIndexes, (compIndex) => {
             const variableTypeComp = rowComponents[compIndex];
             return variableTypeComp.type !== variableTypeComp.component.type;
         })) {
             editRow.components = this.createRowComponents(editRow.data, rowIndex, true);
+            typeChanged = true;
         }
+        return typeChanged;
     }
     setVariableTypeComponents() {
         //set components which type is changing within a row (e.g.,by mergeComponentSchema action)
@@ -543,13 +546,6 @@ export default class EditGridComponent extends NestedArrayComponent {
             }
         });
     }
-    restoreComponentsContext() {
-        this.getComponents().forEach((component) => {
-            const rowData = this.dataValue[component.rowIndex];
-            const editRowData = this.editRows[component.rowIndex]?.data;
-            component.data = rowData || editRowData;
-        });
-    }
     flattenComponents(rowIndex) {
         const result = {};
         this.everyComponent((component) => {
@@ -668,6 +664,11 @@ export default class EditGridComponent extends NestedArrayComponent {
                 }
             },
         }, this.component.saveRow || 'Save'));
+        this.emit('editGridOpenModal', {
+            component: this.component,
+            row: editRow,
+            instance: this,
+        });
         return this.attachComponents(modalContent, components);
     }
     showDialog(rowIndex) {
@@ -725,6 +726,11 @@ export default class EditGridComponent extends NestedArrayComponent {
             editRow.data = dataSnapshot;
             this.restoreRowContext(editRow);
         }
+        this.emit('editGridEditRow', {
+            component: this.component,
+            row: editRow,
+            instance: this,
+        });
         if (this.component.modal) {
             return this.addRowModal(rowIndex);
         }
@@ -913,6 +919,7 @@ export default class EditGridComponent extends NestedArrayComponent {
             const options = _.clone(this.options);
             options.name += `[${rowIndex}]`;
             options.row = `${rowIndex}-${colIndex}`;
+            options.rowIndex = rowIndex;
             options.onChange = (flags = {}, changed, modified) => {
                 if (changed.instance.root?.id && (this.root?.id !== changed.instance.root.id)) {
                     changed.instance.root.triggerChange(flags, changed, modified);
@@ -929,11 +936,13 @@ export default class EditGridComponent extends NestedArrayComponent {
                         ...flags,
                         changed,
                     }, editRow.data, editRow.components);
-                    this.validateRow(editRow, false);
+                    this.validateRow(editRow, false, false);
                 }
                 if (this.variableTypeComponentsIndexes.length) {
-                    this.checkRowVariableTypeComponents(editRow, rowIndex);
-                    this.redraw();
+                    const typeChanged = this.checkRowVariableTypeComponents(editRow, rowIndex);
+                    if (typeChanged) {
+                        this.redraw();
+                    }
                 }
             };
             const comp = this.createComponent(_.assign({}, column, { row: options.row }), options, row, null, recreatePartially && currentRowComponents ? currentRowComponents[colIndex] : null);
@@ -969,22 +978,24 @@ export default class EditGridComponent extends NestedArrayComponent {
     validateRow(editRow, dirty, forceSilentCheck, fromSubmission) {
         editRow.errors = [];
         if (this.shouldValidateRow(editRow, dirty, fromSubmission)) {
-            const silentCheck = (this.component.rowDrafts && !this.shouldValidateDraft(editRow)) || forceSilentCheck;
+            const silentCheck = forceSilentCheck === false ? false : ((this.component.rowDrafts && !this.shouldValidateDraft(editRow)) || forceSilentCheck);
             const rootValue = fastCloneDeep(this.rootValue);
             const editGridValue = _.get(rootValue, this.path, []);
             editGridValue[editRow.rowIndex] = editRow.data;
             _.set(rootValue, this.path, editGridValue);
             const validationProcessorProcess = (context) => this.validationProcessor(context, { dirty, silentCheck });
             const errors = processSync({
-                components: fastCloneDeep(this.component.components).map((component) => {
-                    component.parentPath = `${this.path}[${editRow.rowIndex}]`;
-                    return component;
-                }),
+                components: this.component.components,
                 data: rootValue,
                 row: editRow.data,
                 process: 'validateRow',
                 instances: this.componentsMap,
                 scope: { errors: [] },
+                parent: this.component,
+                parentPaths: {
+                    ...this.paths,
+                    dataIndex: editRow.rowIndex
+                },
                 processors: [
                     {
                         process: validationProcessorProcess,
@@ -1012,13 +1023,16 @@ export default class EditGridComponent extends NestedArrayComponent {
             if (valid === null) {
                 editRow.errors.push({
                     type: 'error',
-                    message: `Invalid row validation for ${this.key}`
+                    message: this.t('componentInvalidRowValidation', { componentKey: this.key })
                 });
             }
         }
-        if (!this.component.rowDrafts || this.root?.submitted) {
+        if (editRow.alerts && (!this.component.rowDrafts || this.root?.submitted)) {
             this.showRowErrorAlerts(editRow, editRow.errors);
         }
+        else if (editRow.errors?.length) {
+            this.setCustomValidity(editRow.errors, dirty);
+        }
         return editRow.errors;
     }
     showRowErrorAlerts(editRow, errors) {
@@ -1085,7 +1099,9 @@ export default class EditGridComponent extends NestedArrayComponent {
             errors.push(...this._errors);
             return false;
         }
-        const message = this.invalid || this.invalidMessage(data, dirty, false, row);
+        // TODO: this is the only place invalidMessage gets called, and it's not clear why it's needed - we already validate the editGrid
+        // component above with super.checkComponentValidity
+        const message = this.invalid || this.invalidMessage(data, dirty, false, row, options);
         if (allRowErrors.length && this.root?.submitted && !message) {
             this._errors = this.setCustomValidity(message, dirty);
             errors.push(...this._errors);
@@ -1129,9 +1145,6 @@ export default class EditGridComponent extends NestedArrayComponent {
             }
         }
         const changed = this.hasChanged(value, this.dataValue);
-        if (this.parent && !this.options.server) {
-            this.parent.checkComponentConditions();
-        }
         this.dataValue = value;
         // Refresh editRow data when data changes.
         this.dataValue.forEach((row, rowIndex) => {
@@ -1162,10 +1175,6 @@ export default class EditGridComponent extends NestedArrayComponent {
         this.editRows = this.editRows.slice(0, dataLength);
         this.openWhenEmpty();
         this.updateOnChange(flags, changed);
-        // do not call checkData with server option, it is called when change is triggered in updateOnChange
-        if (!this.options.server) {
-            this.checkData();
-        }
         this.changeState(changed, flags);
         return changed;
     }

package/lib/mjs/components/email/editForm/Email.edit.display.js

@@ -7,6 +7,18 @@ export default [
         key: 'allowMultipleMasks',
         ignore: true,
     },
+    {
+        key: 'inputMasks',
+        ignore: true
+    },
+    {
+        key: 'widget.type',
+        ignore: true
+    },
+    {
+        key: 'widget',
+        ignore: true
+    },
     {
         key: 'showWordCount',
         ignore: true

package/lib/mjs/components/fieldset/editForm/Fieldset.edit.display.js

@@ -3,6 +3,14 @@ export default [
         key: 'labelPosition',
         ignore: true
     },
+    {
+        key: 'labelWidth',
+        ignore: true
+    },
+    {
+        key: 'labelMargin',
+        ignore: true
+    },
     {
         key: 'placeholder',
         ignore: true

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

@@ -33,7 +33,7 @@ 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;
@@ -45,7 +45,7 @@ export default class FileComponent extends Field {
         type: number;
         actions: number;
     };
-    render(): Field;
+    render(): string;
     getVideoStream(constraints: any): any;
     stopVideoStream(videoStream: any): void;
     getFrame(videoPlayer: any): Promise<any>;

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

@@ -98,12 +98,18 @@ export default class FileComponent extends Field {
         if (this.component.privateDownload) {
             fileInfo.private = true;
         }
-        return this.fileService.downloadFile(fileInfo).then((result) => result.url);
+        // pass the component to the downloadFile method
+        return this.fileService.downloadFile(fileInfo, this.component).then((result) => result.url);
     }
     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(', ');
         }
@@ -196,7 +202,7 @@ export default class FileComponent extends Field {
             this.videoStream = stream;
             const { videoPlayer } = this.refs;
             if (!videoPlayer) {
-                console.warn('Video player not found in template.');
+                console.warn(this.t('videoPlayerNotFound'));
                 this.cameraMode = false;
                 this.redraw();
                 return;
@@ -221,7 +227,7 @@ export default class FileComponent extends Field {
     takePicture() {
         const { videoPlayer } = this.refs;
         if (!videoPlayer) {
-            console.warn('Video player not found in template.');
+            console.warn(this.t('videoPlayerNotFound'));
             this.cameraMode = false;
             this.redraw();
             return;
@@ -626,7 +632,7 @@ export default class FileComponent extends Field {
             file,
             size: file.size,
             status: 'info',
-            message: this.t('Processing file. Please wait...'),
+            message: this.t('waitFileProcessing'),
             hash: '',
         };
     }
@@ -655,7 +661,7 @@ export default class FileComponent extends Field {
         return fileWithSameNameUploaded || fileWithSameNameUploading
             ? {
                 status: 'error',
-                message: this.t(`File with the same name is already ${fileWithSameNameUploading ? 'being ' : ''}uploaded`),
+                message: this.t(fileWithSameNameUploading ? 'fileWithDuplicatedNameInProgress' : 'fileWithDuplicatedNameLoaded'),
             }
             : {};
     }
@@ -664,7 +670,7 @@ export default class FileComponent extends Field {
         if (this.component.filePattern && !this.validatePattern(file, this.component.filePattern)) {
             return {
                 status: 'error',
-                message: this.t('File is the wrong type; it must be {{ pattern }}', {
+                message: this.t('wrongFileType', {
                     pattern: this.component.filePattern,
                 }),
             };
@@ -673,7 +679,7 @@ export default class FileComponent extends Field {
         if (this.component.fileMinSize && !this.validateMinSize(file, this.component.fileMinSize)) {
             return {
                 status: 'error',
-                message: this.t('File is too small; it must be at least {{ size }}', {
+                message: this.t('fileTooSmall', {
                     size: this.component.fileMinSize,
                 }),
             };
@@ -682,7 +688,7 @@ export default class FileComponent extends Field {
         if (this.component.fileMaxSize && !this.validateMaxSize(file, this.component.fileMaxSize)) {
             return {
                 status: 'error',
-                message: this.t('File is too big; it must be at most {{ size }}', {
+                message: this.t('fileTooBig', {
                     size: this.component.fileMaxSize,
                 }),
             };
@@ -694,7 +700,7 @@ export default class FileComponent extends Field {
         return !fileService
             ? {
                 status: 'error',
-                message: this.t('File Service not provided.'),
+                message: this.t('noFileService'),
             }
             : {};
     }
@@ -742,7 +748,7 @@ export default class FileComponent extends Field {
                 this.fileDropHidden = false;
                 return {
                     status: 'error',
-                    message: this.t('File processing has been failed.'),
+                    message: this.t('fileProcessingFailed'),
                 };
             }
             finally {
@@ -776,7 +782,7 @@ export default class FileComponent extends Field {
             return this.filesToSync.filesToUpload.push(fileToSync);
         }
         if (this.autoSync) {
-            fileToSync.message = this.t('Ready to be uploaded into storage');
+            fileToSync.message = this.t('readyForUpload');
         }
         this.filesToSync.filesToUpload.push({
             ...fileToSync,
@@ -814,8 +820,8 @@ export default class FileComponent extends Field {
             ...fileInfo,
             status: 'info',
             message: this.autoSync
-                ? this.t('Ready to be removed from storage')
-                : this.t('Preparing file to remove'),
+                ? this.t('readyForRemovingFromStorage')
+                : this.t('preparingFileToRemove'),
         });
         const index = this.dataValue.findIndex(file => file.name === fileInfo.name);
         this.splice(index);
@@ -853,7 +859,7 @@ export default class FileComponent extends Field {
                 }
                 await this.deleteFile(fileToSync);
                 fileToSync.status = 'success';
-                fileToSync.message = this.t('Succefully removed');
+                fileToSync.message = this.t('succefullyRemoved');
             }
             catch (response) {
                 fileToSync.status = 'error';
@@ -899,7 +905,9 @@ export default class FileComponent extends Field {
     async uploadFile(fileToSync) {
         return await this.fileService.uploadFile(fileToSync.storage, fileToSync.file, fileToSync.name, fileToSync.dir, 
         // Progress callback
-        this.updateProgress.bind(this, fileToSync), fileToSync.url, fileToSync.options, fileToSync.fileKey, fileToSync.groupPermissions, fileToSync.groupResourceId, () => { }, 
+        this.updateProgress.bind(this, fileToSync), fileToSync.url, fileToSync.options, fileToSync.fileKey, fileToSync.groupPermissions, fileToSync.groupResourceId, () => {
+            this.emit('fileUploadingStart');
+        }, 
         // Abort upload callback
         (abort) => this.abortUploads.push({
             id: fileToSync.id,
@@ -921,9 +929,10 @@ export default class FileComponent extends Field {
                 }
                 fileInfo = await this.uploadFile(fileToSync);
                 fileToSync.status = 'success';
-                fileToSync.message = this.t('Succefully uploaded');
+                fileToSync.message = this.t('succefullyUploaded');
                 fileInfo.originalName = fileToSync.originalName;
                 fileInfo.hash = fileToSync.hash;
+                this.emit('fileUploadingEnd');
             }
             catch (response) {
                 fileToSync.status = 'error';
@@ -933,6 +942,7 @@ export default class FileComponent extends Field {
                     : response.type === 'abort'
                         ? this.t('Request was aborted')
                         : response.toString();
+                this.emit('fileUploadingEnd');
                 this.emit('fileUploadError', {
                     fileToSync,
                     response,
@@ -1020,7 +1030,7 @@ export default class FileComponent extends Field {
             }
             await this.syncFiles();
             return this.shouldSyncFiles
-                ? Promise.reject('Synchronization is failed')
+                ? Promise.reject(this.t('synchronizationFailed'))
                 : Promise.resolve();
         }
         catch (error) {

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

@@ -16,6 +16,7 @@ declare const _default: ({
     components?: undefined;
     rows?: undefined;
     editor?: undefined;
+    as?: undefined;
     optionsLabelPosition?: undefined;
     inline?: undefined;
     defaultValue?: undefined;
@@ -45,6 +46,7 @@ declare const _default: ({
     components?: undefined;
     rows?: undefined;
     editor?: undefined;
+    as?: undefined;
     optionsLabelPosition?: undefined;
     inline?: undefined;
     defaultValue?: undefined;
@@ -91,6 +93,7 @@ declare const _default: ({
     data?: undefined;
     rows?: undefined;
     editor?: undefined;
+    as?: undefined;
     optionsLabelPosition?: undefined;
     inline?: undefined;
     defaultValue?: undefined;
@@ -120,6 +123,7 @@ declare const _default: ({
     components?: undefined;
     rows?: undefined;
     editor?: undefined;
+    as?: undefined;
     optionsLabelPosition?: undefined;
     inline?: undefined;
     defaultValue?: undefined;
@@ -149,6 +153,7 @@ declare const _default: ({
     components?: undefined;
     rows?: undefined;
     editor?: undefined;
+    as?: undefined;
     optionsLabelPosition?: undefined;
     inline?: undefined;
     defaultValue?: undefined;
@@ -160,6 +165,7 @@ declare const _default: ({
     tooltip: string;
     rows: number;
     editor: string;
+    as: string;
     input: boolean;
     weight: number;
     placeholder: string;
@@ -207,6 +213,7 @@ declare const _default: ({
     components?: undefined;
     rows?: undefined;
     editor?: undefined;
+    as?: undefined;
     optionsLabelPosition?: undefined;
     inline?: undefined;
     defaultValue?: undefined;
@@ -227,6 +234,7 @@ declare const _default: ({
     components?: undefined;
     rows?: undefined;
     editor?: undefined;
+    as?: undefined;
     optionsLabelPosition?: undefined;
     inline?: undefined;
     defaultValue?: undefined;
@@ -247,6 +255,7 @@ declare const _default: ({
     components?: undefined;
     rows?: undefined;
     editor?: undefined;
+    as?: undefined;
     optionsLabelPosition?: undefined;
     inline?: undefined;
     defaultValue?: undefined;
@@ -276,6 +285,7 @@ declare const _default: ({
     components?: undefined;
     rows?: undefined;
     editor?: undefined;
+    as?: undefined;
     optionsLabelPosition?: undefined;
     inline?: undefined;
     defaultValue?: undefined;
@@ -305,6 +315,7 @@ declare const _default: ({
     components?: undefined;
     rows?: undefined;
     editor?: undefined;
+    as?: undefined;
     optionsLabelPosition?: undefined;
     inline?: undefined;
     defaultValue?: undefined;
@@ -332,6 +343,7 @@ declare const _default: ({
     components?: undefined;
     rows?: undefined;
     editor?: undefined;
+    as?: undefined;
 } | {
     type: string;
     input: boolean;
@@ -353,6 +365,7 @@ declare const _default: ({
     tableView?: undefined;
     rows?: undefined;
     editor?: undefined;
+    as?: undefined;
     optionsLabelPosition?: undefined;
     inline?: undefined;
     defaultValue?: undefined;

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

@@ -115,6 +115,7 @@ export default [
         tooltip: 'Pass your custom xhr options(optional)',
         rows: 5,
         editor: 'ace',
+        as: 'json',
         input: true,
         weight: 15,
         placeholder: `{

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

@@ -13,7 +13,7 @@ export default class FormComponent extends Component {
     valueChanged: boolean | undefined;
     subForm: any;
     formSrc: any;
-    get dataReady(): Promise<any>;
+    get dataReady(): any;
     get emptyValue(): {
         data: {};
     };
@@ -21,7 +21,7 @@ export default class FormComponent extends Component {
     get useOriginalRevision(): any;
     setFormRevision(rev: any): void;
     subFormRevision: any;
-    getComponent(path: any, fn: any): any;
+    getComponent(path: any): any;
     getSubOptions(options?: {}): {};
     render(): string;
     asString(value: any): any;
@@ -32,6 +32,7 @@ export default class FormComponent extends Component {
     attach(element: any): Promise<void>;
     get hasLoadedForm(): any;
     get isRevisionChanged(): any;
+    get subFormData(): any;
     subFormReady: Promise<any> | null | undefined;
     /**
      * Pass everyComponent to subform.
@@ -44,19 +45,19 @@ export default class FormComponent extends Component {
     /**
      * Create a subform instance.
      * @param {boolean} [fromAttach] - This function is being called from an `attach` method.
+     * @param {boolean} [beforeSubmit] - This function is being called from a `beforeSubmit` method.
      * @returns {*} - The subform instance.
      */
-    createSubForm(fromAttach?: boolean | undefined): any;
+    createSubForm(fromAttach?: boolean | undefined, beforeSubmit?: boolean | undefined): any;
     hideSubmitButton(component: any): void;
     /**
      * Load the subform.
      * @param {boolean} fromAttach - This function is being called from an `attach` method.
+     * @param {boolean} beforeSubmit - This function is being called from a `beforeSubmit` method.
      * @returns {Promise} - The promise that resolves when the subform is loaded.
      */
-    loadSubForm(fromAttach: boolean): Promise<any>;
+    loadSubForm(fromAttach: boolean, beforeSubmit: boolean): Promise<any>;
     subFormLoading: boolean | undefined;
-    get subFormData(): any;
-    checkComponentValidity(data: any, dirty: any, row: any, options: any, errors?: any[]): any;
     checkComponentConditions(data: any, flags: any, row: any): any;
     calculateValue(data: any, flags: any, row: any): any;
     setPristine(pristine: any): void;
@@ -90,7 +91,13 @@ export default class FormComponent extends Component {
     isHidden(): boolean;
     setValue(submission: any, flags?: {}): boolean;
     setSubFormValue(submission: any, flags: any): void;
-    areAllComponentsEmpty(data: any): boolean;
+    /**
+     * 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;
     updateSubFormVisibility(): void;
     /**
      * Determines if this form is a Nested Wizard