@formio/js 5.0.0-dev.5613.77144cc → 5.0.0-dev.5614.b5c93f3

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

@@ -88,7 +88,7 @@ class EditGridComponent extends NestedArrayComponent_1.default {
       {% if (!instance.options.readOnly && !instance.disabled) { %}
         <div class="col-sm-2">
           <div class="btn-group pull-right">
-            <button class="btn btn-default btn-light btn-sm editRow"><i class="{{ iconClass('pen-fill') }}"></i></button>
+            <button class="btn btn-default btn-light btn-sm editRow"><i class="{{ iconClass('edit') }}"></i></button>
             {% if (!instance.hasRemoveButtons || instance.hasRemoveButtons()) { %}
               <button class="btn btn-danger btn-sm removeRow"><i class="{{ iconClass('trash') }}"></i></button>
             {% } %}
@@ -109,7 +109,7 @@ class EditGridComponent extends NestedArrayComponent_1.default {
         {% if (!instance.options.readOnly && !instance.disabled) { %}
           <td class="editgrid-table-column">
             <div class="btn-group">
-              <button class="btn btn-default btn-light btn-sm editRow" aria-label="{{ t('Edit row') }}"><i class="{{ iconClass('pen-fill') }}"></i></button>
+              <button class="btn btn-default btn-light btn-sm editRow" aria-label="{{ t('Edit row') }}"><i class="{{ iconClass('edit') }}"></i></button>
               {% if (!instance.hasRemoveButtons || instance.hasRemoveButtons()) { %}
               <button class="btn btn-danger btn-sm removeRow" aria-label="{{ t('Remove row') }}"><i class="{{ iconClass('trash') }}"></i></button>
               {% } %}
@@ -166,8 +166,8 @@ class EditGridComponent extends NestedArrayComponent_1.default {
         return headerTemplate;
     }
     /**
-     * Returns true if the component has nested components which don't trigger changes on the root level
-     */ //
+     * @returns {boolean} - Returns true if the component has nested components which don't trigger changes on the root level
+     */
     get hasScopedChildren() {
         return !this.inlineEditMode;
     }
@@ -570,25 +570,20 @@ class EditGridComponent extends NestedArrayComponent_1.default {
         return result;
     }
     getComponents(rowIndex) {
-        var _a;
         // Ensure editrows is set.
         this.editRows = this.editRows || [];
         return this.builderMode
             ? super.getComponents()
             : lodash_1.default.isNumber(rowIndex)
-                ? (((_a = this.editRows[rowIndex]) === null || _a === void 0 ? void 0 : _a.components) || [])
+                ? (this.editRows[rowIndex].components || [])
                 : this.editRows.reduce((result, row) => result.concat(row.components || []), []);
     }
-    destroy(all = false) {
-        this.calculatedValue = undefined;
-        super.destroy(all);
-    }
-    destroyComponents(all = false, rowIndex = 0) {
+    destroyComponents(rowIndex) {
         if (this.builderMode) {
-            return super.destroyComponents(all);
+            return super.destroyComponents();
         }
         const components = this.getComponents(rowIndex).slice();
-        components.forEach((comp) => this.removeComponent(comp, this.components, all));
+        components.forEach((comp) => this.removeComponent(comp, this.components));
     }
     createRow(dataObj, rowIndex) {
         const editRow = {
@@ -761,7 +756,7 @@ class EditGridComponent extends NestedArrayComponent_1.default {
             case EditRowState.New: {
                 editRow.state = EditRowState.Removed;
                 this.clearErrors(rowIndex);
-                this.destroyComponents(false, rowIndex);
+                this.destroyComponents(rowIndex);
                 if (this.inlineEditMode) {
                     this.splice(rowIndex);
                 }
@@ -880,7 +875,7 @@ class EditGridComponent extends NestedArrayComponent_1.default {
     baseRemoveRow(rowIndex) {
         const editRow = this.editRows[rowIndex];
         editRow.state = EditRowState.Removed;
-        this.destroyComponents(false, rowIndex);
+        this.destroyComponents(rowIndex);
         return editRow;
     }
     removeRow(rowIndex, modified) {
@@ -903,15 +898,6 @@ class EditGridComponent extends NestedArrayComponent_1.default {
         this.redraw();
     }
     createRowComponents(row, rowIndex, recreatePartially) {
-        // Iterate through existing components and destroy the ones with the same rowIndex.
-        if (this.components) {
-            for (let i = 0; i < this.components.length; i++) {
-                if (this.components[i].rowIndex === rowIndex) {
-                    this.components[i].destroy();
-                    this.components.splice(i, 1);
-                }
-            }
-        }
         const currentRowComponents = lodash_1.default.get(this.editRows, `[${rowIndex}].components`, null);
         return this.component.components.map((col, colIndex) => {
             var _a;
@@ -1046,7 +1032,7 @@ class EditGridComponent extends NestedArrayComponent_1.default {
         }
     }
     /**
-     * Return that this component processes its own validation.
+     * @returns {boolean} - Return that this component processes its own validation.
      */
     get processOwnValidation() {
         return true;
@@ -1193,7 +1179,7 @@ class EditGridComponent extends NestedArrayComponent_1.default {
         });
     }
     emptyRows() {
-        this.editRows.forEach((editRow, index) => this.destroyComponents(false, index));
+        this.editRows.forEach((editRow, index) => this.destroyComponents(index));
         this.editRows = [];
     }
     resetValue() {

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

@@ -1,9 +1,6 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-const Evaluator_1 = __importDefault(require("../../../utils/Evaluator"));
+const Evaluator_1 = require("../../../utils/Evaluator");
 exports.default = [
     {
         key: 'placeholder',
@@ -38,7 +35,7 @@ exports.default = [
         weight: 1002,
         input: false,
         customConditional() {
-            return !Evaluator_1.default.noeval;
+            return !Evaluator_1.Evaluator.noeval;
         },
     },
     {

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

@@ -1,9 +1,6 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-const Evaluator_1 = __importDefault(require("../../../utils/Evaluator"));
+const Evaluator_1 = require("../../../utils/Evaluator");
 exports.default = [
     {
         type: 'textarea',
@@ -18,7 +15,7 @@ exports.default = [
         description: 'Two available variables. "value" is the array of row data and "components" is the array of components in the grid.',
         tooltip: 'This is the <a href=\'https://lodash.com/docs/4.17.5#template\'>Lodash Template</a> used to render the header of the Edit grid.',
         customConditional({ data }) {
-            return (!Evaluator_1.default.noeval || Evaluator_1.default.protectedEval) && !data.displayAsTable;
+            return (!Evaluator_1.Evaluator.noeval || Evaluator_1.Evaluator.protectedEval) && !data.displayAsTable;
         }
     },
     {
@@ -34,7 +31,7 @@ exports.default = [
         description: 'Two available variables. "value" is the array of row data and "components" is the array of components in the grid.',
         tooltip: 'This is the <a href=\'https://lodash.com/docs/4.17.5#template\'>Lodash Template</a> used to render the header of the Edit grid.',
         customConditional({ data }) {
-            return (!Evaluator_1.default.noeval || Evaluator_1.default.protectedEval) && data.displayAsTable;
+            return (!Evaluator_1.Evaluator.noeval || Evaluator_1.Evaluator.protectedEval) && data.displayAsTable;
         }
     },
     {
@@ -52,7 +49,7 @@ exports.default = [
             ' To add click events, add the classes "editRow" and "removeRow" to elements.',
         tooltip: 'This is the <a href=\'https://lodash.com/docs/4.17.5#template\'>Lodash Template</a> used to render each row of the Edit grid.',
         customConditional({ data }) {
-            return (!Evaluator_1.default.noeval || Evaluator_1.default.protectedEval) && !data.displayAsTable;
+            return (!Evaluator_1.Evaluator.noeval || Evaluator_1.Evaluator.protectedEval) && !data.displayAsTable;
         }
     },
     {
@@ -70,7 +67,7 @@ exports.default = [
             ' To add click events, add the classes "editRow" and "removeRow" to elements.',
         tooltip: 'This is the <a href=\'https://lodash.com/docs/4.17.5#template\'>Lodash Template</a> used to render each row of the Edit grid.',
         customConditional({ data }) {
-            return (!Evaluator_1.default.noeval || Evaluator_1.default.protectedEval) && data.displayAsTable;
+            return (!Evaluator_1.Evaluator.noeval || Evaluator_1.Evaluator.protectedEval) && data.displayAsTable;
         }
     },
     {
@@ -85,7 +82,7 @@ exports.default = [
         description: 'Two available variables. "value" is the array of row data and "components" is the array of components in the grid.',
         tooltip: 'This is the <a href=\'https://lodash.com/docs/4.17.5#template\'>Lodash Template</a> used to render the footer of the Edit grid.',
         customConditional() {
-            return !Evaluator_1.default.noeval || Evaluator_1.default.protectedEval;
+            return !Evaluator_1.Evaluator.noeval || Evaluator_1.Evaluator.protectedEval;
         }
     },
     {

package/lib/cjs/components/email/Email.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/cjs/components/email/Email.form.js

@@ -6,6 +6,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const TextField_form_1 = __importDefault(require("../textfield/TextField.form"));
 const Email_edit_display_1 = __importDefault(require("./editForm/Email.edit.display"));
 const Email_edit_validation_1 = __importDefault(require("./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.
+ */
 function default_1(...extend) {
     return (0, TextField_form_1.default)([
         {

package/lib/cjs/components/fieldset/Fieldset.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/cjs/components/fieldset/Fieldset.form.js

@@ -5,6 +5,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const NestedComponent_form_1 = __importDefault(require("../_classes/nested/NestedComponent.form"));
 const Fieldset_edit_display_1 = __importDefault(require("./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.
+ */
 function default_1(...extend) {
     return (0, NestedComponent_form_1.default)([
         {

package/lib/cjs/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: {
@@ -59,7 +45,7 @@ export default class FileComponent extends Field {
         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;
     }>;
@@ -167,6 +154,5 @@ export default class FileComponent extends Field {
     getFile(fileInfo: any): any;
     focus(): void;
     beforeSubmit(): Promise<void>;
-    destroy(all: any): void;
 }
 import Field from '../_classes/field/Field';

package/lib/cjs/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/cjs/components/file/File.form.js

@@ -8,6 +8,11 @@ const File_edit_data_1 = __importDefault(require("./editForm/File.edit.data"));
 const File_edit_display_1 = __importDefault(require("./editForm/File.edit.display"));
 const File_edit_file_1 = __importDefault(require("./editForm/File.edit.file"));
 const File_edit_validation_1 = __importDefault(require("./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.
+ */
 function default_1(...extend) {
     return Components_1.default.baseEditForm([
         {

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

@@ -652,8 +652,7 @@ class FileComponent extends Field_1.default {
         // Check if file with the same name is being uploaded
         const fileWithSameNameUploading = this.filesToSync.filesToUpload
             .some(fileToSync => { var _a; return ((_a = fileToSync.file) === null || _a === void 0 ? void 0 : _a.name) === file.name; });
-        const fileWithSameNameUploaded = this.dataValue
-            .some(fileStatus => fileStatus.originalName === file.name);
+        const fileWithSameNameUploaded = lodash_1.default.some(this.dataValue, fileStatus => fileStatus.originalName === file.name);
         return fileWithSameNameUploaded || fileWithSameNameUploading
             ? {
                 status: 'error',
@@ -1031,9 +1030,9 @@ class FileComponent extends Field_1.default {
             }
         });
     }
-    destroy(all) {
+    destroy() {
         this.stopVideo();
-        super.destroy(all);
+        super.destroy();
     }
 }
 exports.default = FileComponent;

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

@@ -7,6 +7,11 @@ const NestedComponent_form_1 = __importDefault(require("../_classes/nested/Neste
 const Form_edit_display_1 = __importDefault(require("./editForm/Form.edit.display"));
 const Form_edit_form_1 = __importDefault(require("./editForm/Form.edit.form"));
 const Form_edit_data_1 = __importDefault(require("./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.
+ */
 function default_1(...extend) {
     return (0, NestedComponent_form_1.default)([
         {