@formio/js 5.0.0-dev.5695.024ad9c → 5.0.0-dev.5703.20a26ed

package/lib/mjs/components/datagrid/DataGrid.js

@@ -1,8 +1,7 @@
 import _ from 'lodash';
 import NestedArrayComponent from '../_classes/nestedarray/NestedArrayComponent';
 import { fastCloneDeep, getFocusableElements } from '../../utils/utils';
-import { Components } from '../Components';
-import dragula from 'dragula';
+import Components from '../Components';
 export default class DataGridComponent extends NestedArrayComponent {
     static schema(...extend) {
         return NestedArrayComponent.schema({
@@ -39,6 +38,9 @@ export default class DataGridComponent extends NestedArrayComponent {
         if (this.initRows || !_.isEqual(this.dataValue, this.emptyValue)) {
             this.createRows(true);
         }
+        if (this.allowReorder) {
+            this.dragulaReady = this.getDragula();
+        }
         this.visibleColumns = {};
         this.prevHasAddButton = this.hasAddButton();
         this.checkColumns();
@@ -279,31 +281,25 @@ export default class DataGridComponent extends NestedArrayComponent {
             this.refs[`${this.datagridKey}-row`].forEach((row, index) => {
                 row.dragInfo = { index };
             });
-            this.dragula = dragula([this.refs[`${this.datagridKey}-tbody`]], {
-                moves: (_draggedElement, _oldParent, clickedElement) => {
-                    const clickedElementKey = clickedElement.getAttribute('data-key');
-                    const oldParentKey = _oldParent.getAttribute('data-key');
-                    //Check if the clicked button belongs to that container, if false, it belongs to the nested container
-                    if (oldParentKey === clickedElementKey) {
-                        return clickedElement.classList.contains('formio-drag-button');
-                    }
+            this.dragulaReady.then((dragula) => {
+                // The drop event may call redraw twice which calls attach twice and because this block of code is asynchronous
+                // BOTH redraws may be called before this block of code runs (which causes this block of code to run twice sequentially).
+                // This causes two dragula() calls on the same container which breaks dragula. To fix this the return value must
+                // be saved in this.dragula and have its container contents reset if it exists
+                if (this.dragula && this.dragula.containers) {
+                    this.dragula.containers = [];
                 }
-            }).on('drop', this.onReorder.bind(this));
-            this.dragula.on('cloned', (el, original) => {
-                if (el && el.children && original && original.children) {
-                    _.each(original.children, (child, index) => {
-                        const styles = getComputedStyle(child, null);
-                        if (styles.cssText !== '') {
-                            el.children[index].style.cssText = styles.cssText;
+                this.dragula = dragula([this.refs[`${this.datagridKey}-tbody`]], {
+                    moves: (_draggedElement, _oldParent, clickedElement) => {
+                        const clickedElementKey = clickedElement.getAttribute('data-key');
+                        const oldParentKey = _oldParent.getAttribute('data-key');
+                        //Check if the clicked button belongs to that container, if false, it belongs to the nested container
+                        if (oldParentKey === clickedElementKey) {
+                            return clickedElement.classList.contains('formio-drag-button');
                         }
-                        else {
-                            const cssText = Object.values(styles).reduce((css, propertyName) => {
-                                return `${css}${propertyName}:${styles.getPropertyValue(propertyName)};`;
-                            }, '');
-                            el.children[index].style.cssText = cssText;
-                        }
-                    });
-                }
+                    }
+                }).on('drop', this.onReorder.bind(this))
+                    .on('cloned', this.onCloned.bind(this));
             });
         }
         this.refs[`${this.datagridKey}-addRow`].forEach((addButton) => {
@@ -370,6 +366,22 @@ export default class DataGridComponent extends NestedArrayComponent {
         this.setValue(dataValue, { isReordered: true });
         this.rebuild();
     }
+    onCloned(el, original) {
+        if (el && el.children && original && original.children) {
+            _.each(original.children, (child, index) => {
+                const styles = getComputedStyle(child, null);
+                if (styles.cssText !== '') {
+                    el.children[index].style.cssText = styles.cssText;
+                }
+                else {
+                    const cssText = Object.values(styles).reduce((css, propertyName) => {
+                        return `${css}${propertyName}:${styles.getPropertyValue(propertyName)};`;
+                    }, '');
+                    el.children[index].style.cssText = cssText;
+                }
+            });
+        }
+    }
     focusOnNewRowElement(row) {
         Object.keys(row).find((key) => {
             const element = row[key].element;

package/lib/mjs/components/datagrid/fixtures/comp10.d.ts

@@ -0,0 +1,81 @@
+declare namespace _default {
+    let title: string;
+    let name: string;
+    let path: string;
+    let type: string;
+    let display: string;
+    let components: ({
+        label: string;
+        reorder: boolean;
+        addAnotherPosition: string;
+        layoutFixed: boolean;
+        enableRowGroups: boolean;
+        initEmpty: boolean;
+        tableView: boolean;
+        defaultValue: {}[];
+        validate: {
+            required: boolean;
+        };
+        key: string;
+        type: string;
+        input: boolean;
+        components: {
+            label: string;
+            columns: ({
+                components: {
+                    label: string;
+                    applyMaskOn: string;
+                    tableView: boolean;
+                    key: string;
+                    type: string;
+                    input: boolean;
+                }[];
+                width: number;
+                offset: number;
+                push: number;
+                pull: number;
+                size: string;
+                currentWidth: number;
+            } | {
+                components: {
+                    label: string;
+                    tableView: boolean;
+                    key: string;
+                    type: string;
+                    input: boolean;
+                }[];
+                width: number;
+                offset: number;
+                push: number;
+                pull: number;
+                size: string;
+                currentWidth: number;
+            })[];
+            key: string;
+            type: string;
+            input: boolean;
+            tableView: boolean;
+        }[];
+        disableOnInvalid?: undefined;
+    } | {
+        type: string;
+        label: string;
+        key: string;
+        disableOnInvalid: boolean;
+        input: boolean;
+        tableView: boolean;
+        reorder?: undefined;
+        addAnotherPosition?: undefined;
+        layoutFixed?: undefined;
+        enableRowGroups?: undefined;
+        initEmpty?: undefined;
+        defaultValue?: undefined;
+        validate?: undefined;
+        components?: undefined;
+    })[];
+    let pdfComponents: never[];
+    namespace settings {
+        let logs: string;
+    }
+}
+export default _default;

package/lib/mjs/components/datagrid/fixtures/comp10.js

@@ -0,0 +1,85 @@
+export default {
+    title: 'randomName',
+    name: 'randomName',
+    path: 'randomName',
+    type: 'form',
+    display: 'form',
+    components: [
+        {
+            label: 'Data Grid',
+            reorder: false,
+            addAnotherPosition: 'bottom',
+            layoutFixed: false,
+            enableRowGroups: false,
+            initEmpty: false,
+            tableView: false,
+            defaultValue: [
+                {}
+            ],
+            validate: {
+                required: true
+            },
+            key: 'dataGrid',
+            type: 'datagrid',
+            input: true,
+            components: [
+                {
+                    label: 'Columns',
+                    columns: [
+                        {
+                            components: [
+                                {
+                                    label: 'Text Field',
+                                    applyMaskOn: 'change',
+                                    tableView: true,
+                                    key: 'textField',
+                                    type: 'textfield',
+                                    input: true
+                                }
+                            ],
+                            width: 6,
+                            offset: 0,
+                            push: 0,
+                            pull: 0,
+                            size: 'md',
+                            currentWidth: 6
+                        },
+                        {
+                            components: [
+                                {
+                                    label: 'Checkbox',
+                                    tableView: false,
+                                    key: 'checkbox',
+                                    type: 'checkbox',
+                                    input: true
+                                }
+                            ],
+                            width: 6,
+                            offset: 0,
+                            push: 0,
+                            pull: 0,
+                            size: 'md',
+                            currentWidth: 6
+                        }
+                    ],
+                    key: 'columns',
+                    type: 'columns',
+                    input: false,
+                    tableView: false
+                }
+            ]
+        },
+        {
+            type: 'button',
+            label: 'Submit',
+            key: 'submit',
+            disableOnInvalid: true,
+            input: true,
+            tableView: false
+        }
+    ],
+    pdfComponents: [],
+    settings: {
+        logs: 'true'
+    }
+};

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

@@ -7,6 +7,7 @@ import comp6 from './comp6';
 import comp7 from './comp7';
 import comp8 from './comp8';
 import comp9 from './comp9';
+import comp10 from './comp10';
 import withCollapsibleRowGroups from './comp-with-collapsible-groups';
 import withConditionalFieldsAndValidations from './comp-with-conditional-components-and-validations';
 import withDefValue from './comp-with-def-value';
@@ -17,4 +18,4 @@ import withAllowCalculateOverride from './comp-with-allow-calculate-override';
 import twoWithAllowCalculatedOverride from './two-comp-with-allow-calculate-override';
 import withCheckboxes from './comp-with-checkboxes';
 import withReorder from './comp-with-reorder';
-export { comp1, comp2, comp3, comp4, comp5, comp6, comp7, comp8, comp9, withCollapsibleRowGroups, withConditionalFieldsAndValidations, withDefValue, withLogic, withRowGroupsAndDefValue, modalWithRequiredFields, withAllowCalculateOverride, twoWithAllowCalculatedOverride, withCheckboxes, withReorder };
+export { comp1, comp2, comp3, comp4, comp5, comp6, comp7, comp8, comp9, comp10, withCollapsibleRowGroups, withConditionalFieldsAndValidations, withDefValue, withLogic, withRowGroupsAndDefValue, modalWithRequiredFields, withAllowCalculateOverride, twoWithAllowCalculatedOverride, withCheckboxes, withReorder };

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

@@ -7,6 +7,7 @@ import comp6 from './comp6';
 import comp7 from './comp7';
 import comp8 from './comp8';
 import comp9 from './comp9';
+import comp10 from './comp10';
 import withDefValue from './comp-with-def-value';
 import withRowGroupsAndDefValue from './comp-row-groups-with-def-value';
 import modalWithRequiredFields from './comp-modal-with-required-fields';
@@ -17,4 +18,4 @@ import withAllowCalculateOverride from './comp-with-allow-calculate-override';
 import twoWithAllowCalculatedOverride from './two-comp-with-allow-calculate-override';
 import withCheckboxes from './comp-with-checkboxes';
 import withReorder from './comp-with-reorder';
-export { comp1, comp2, comp3, comp4, comp5, comp6, comp7, comp8, comp9, withCollapsibleRowGroups, withConditionalFieldsAndValidations, withDefValue, withLogic, withRowGroupsAndDefValue, modalWithRequiredFields, withAllowCalculateOverride, twoWithAllowCalculatedOverride, withCheckboxes, withReorder };
+export { comp1, comp2, comp3, comp4, comp5, comp6, comp7, comp8, comp9, comp10, withCollapsibleRowGroups, withConditionalFieldsAndValidations, withDefValue, withLogic, withRowGroupsAndDefValue, modalWithRequiredFields, withAllowCalculateOverride, twoWithAllowCalculatedOverride, withCheckboxes, withReorder };

package/lib/mjs/components/datamap/DataMap.js

@@ -3,7 +3,7 @@ import DataGridComponent from '../datagrid/DataGrid';
 import _ from 'lodash';
 import EventEmitter from 'eventemitter3';
 import { componentValueTypes, getComponentSavedTypes, uniqueKey } from '../../utils/utils';
-import { Components } from '../Components';
+import Components from '../Components';
 export default class DataMapComponent extends DataGridComponent {
     static schema(...extend) {
         return Component.schema({

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

@@ -0,0 +1,41 @@
+declare namespace _default {
+    let components: ({
+        label: string;
+        hideInputLabels: boolean;
+        inputsLabelPosition: string;
+        useLocaleSettings: boolean;
+        alwaysEnabled: boolean;
+        tableView: boolean;
+        fields: {
+            day: {
+                hide: boolean;
+                required: boolean;
+            };
+            month: {
+                hide: boolean;
+                required: boolean;
+            };
+            year: {
+                hide: boolean;
+                required: boolean;
+            };
+        };
+        key: string;
+        type: string;
+        input: boolean;
+        showValidations?: undefined;
+    } | {
+        label: string;
+        showValidations: boolean;
+        alwaysEnabled: boolean;
+        tableView: boolean;
+        key: string;
+        type: string;
+        input: boolean;
+        hideInputLabels?: undefined;
+        inputsLabelPosition?: undefined;
+        useLocaleSettings?: undefined;
+        fields?: undefined;
+    })[];
+}
+export default _default;

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

@@ -0,0 +1,38 @@
+export default {
+    "components": [
+        {
+            "label": "Day - Table",
+            "hideInputLabels": false,
+            "inputsLabelPosition": "top",
+            "useLocaleSettings": false,
+            "alwaysEnabled": false,
+            "tableView": false,
+            "fields": {
+                "day": {
+                    "hide": false,
+                    "required": true
+                },
+                "month": {
+                    "hide": false,
+                    "required": true
+                },
+                "year": {
+                    "hide": false,
+                    "required": true
+                }
+            },
+            "key": "dayTable",
+            "type": "day",
+            "input": true
+        },
+        {
+            "label": "Submit",
+            "showValidations": false,
+            "alwaysEnabled": false,
+            "tableView": false,
+            "key": "submit",
+            "type": "button",
+            "input": true
+        }
+    ]
+};

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

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

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

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

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

@@ -672,6 +672,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) {
@@ -729,6 +734,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);
         }
@@ -1079,7 +1089,8 @@ export default class EditGridComponent extends NestedArrayComponent {
             return false;
         }
         else if (rowsEditing && this.saveEditMode && !this.component.openWhenEmpty) {
-            this.setCustomValidity(this.t(this.errorMessage('unsavedRowsError')), dirty);
+            this._errors = this.setCustomValidity(this.t(this.errorMessage('unsavedRowsError')), dirty);
+            errors.push(...this._errors);
             return false;
         }
         const message = this.invalid || this.invalidMessage(data, dirty, false, row);

package/lib/mjs/components/editgrid/fixtures/comp-test-events.d.ts

@@ -0,0 +1,54 @@
+declare namespace _default {
+    let _id: string;
+    let title: string;
+    let name: string;
+    let path: string;
+    let type: string;
+    let display: string;
+    let owner: string;
+    let components: ({
+        label: string;
+        tableView: boolean;
+        modal: boolean;
+        validateWhenHidden: boolean;
+        rowDrafts: boolean;
+        key: string;
+        type: string;
+        displayAsTable: boolean;
+        input: boolean;
+        components: {
+            label: string;
+            applyMaskOn: string;
+            tableView: boolean;
+            validateWhenHidden: boolean;
+            key: string;
+            type: string;
+            input: boolean;
+        }[];
+        disableOnInvalid?: undefined;
+    } | {
+        type: string;
+        label: string;
+        key: string;
+        disableOnInvalid: boolean;
+        input: boolean;
+        tableView: boolean;
+        modal?: undefined;
+        validateWhenHidden?: undefined;
+        rowDrafts?: undefined;
+        displayAsTable?: undefined;
+        components?: undefined;
+    })[];
+    let pdfComponents: never[];
+    let settings: {};
+    let properties: {};
+    let project: string;
+    let controller: string;
+    let revisions: string;
+    let submissionRevisions: string;
+    let _vid: number;
+    let created: string;
+    let modified: string;
+    let machineName: string;
+}
+export default _default;

package/lib/mjs/components/editgrid/fixtures/comp-test-events.js

@@ -0,0 +1,52 @@
+export default {
+    _id: '669e1c88a40e327e67e7d1c5',
+    title: 'editGrid test',
+    name: 'editGridTest',
+    path: 'editgridtest',
+    type: 'form',
+    display: 'form',
+    owner: '637b2e6b48c1227e60b1f910',
+    components: [
+        {
+            label: 'Edit Grid',
+            tableView: false,
+            modal: false,
+            validateWhenHidden: false,
+            rowDrafts: false,
+            key: 'editGrid',
+            type: 'editgrid',
+            displayAsTable: false,
+            input: true,
+            components: [
+                {
+                    label: 'Text Field',
+                    applyMaskOn: 'change',
+                    tableView: true,
+                    validateWhenHidden: false,
+                    key: 'textField',
+                    type: 'textfield',
+                    input: true,
+                },
+            ],
+        },
+        {
+            type: 'button',
+            label: 'Submit',
+            key: 'submit',
+            disableOnInvalid: true,
+            input: true,
+            tableView: false,
+        },
+    ],
+    pdfComponents: [],
+    settings: {},
+    properties: {},
+    project: '669e1c68a40e327e67e7cedd',
+    controller: '',
+    revisions: '',
+    submissionRevisions: '',
+    _vid: 0,
+    created: '2024-07-22T08:47:04.399Z',
+    modified: '2024-07-22T10:04:23.474Z',
+    machineName: 'authoring-qzdhayddccjauyr:editGridTest',
+};

package/lib/mjs/components/editgrid/fixtures/comp16.d.ts

@@ -0,0 +1,52 @@
+declare namespace _default {
+    let type: string;
+    let display: string;
+    let components: ({
+        title: string;
+        breadcrumbClickable: boolean;
+        buttonSettings: {
+            previous: boolean;
+            cancel: boolean;
+            next: boolean;
+        };
+        collapsible: boolean;
+        tableView: boolean;
+        key: string;
+        type: string;
+        label: string;
+        input: boolean;
+        components: {
+            label: string;
+            tableView: boolean;
+            rowDrafts: boolean;
+            key: string;
+            type: string;
+            input: boolean;
+            components: {
+                label: string;
+                tableView: boolean;
+                key: string;
+                type: string;
+                input: boolean;
+                alwaysEnabled: boolean;
+            }[];
+            alwaysEnabled: boolean;
+        }[];
+        alwaysEnabled: boolean;
+        showValidations?: undefined;
+    } | {
+        label: string;
+        showValidations: boolean;
+        alwaysEnabled: boolean;
+        tableView: boolean;
+        key: string;
+        type: string;
+        input: boolean;
+        title?: undefined;
+        breadcrumbClickable?: undefined;
+        buttonSettings?: undefined;
+        collapsible?: undefined;
+        components?: undefined;
+    })[];
+}
+export default _default;

package/lib/mjs/components/editgrid/fixtures/comp16.js

@@ -0,0 +1,69 @@
+export default {
+    type: 'form',
+    display: 'wizard',
+    components: [
+        {
+            title: 'Page 1',
+            breadcrumbClickable: true,
+            buttonSettings: {
+                previous: true,
+                cancel: true,
+                next: true
+            },
+            collapsible: false,
+            tableView: false,
+            key: 'page3',
+            type: 'panel',
+            label: 'Page 2',
+            input: false,
+            components: [
+                {
+                    label: 'Edit Grid',
+                    tableView: true,
+                    rowDrafts: false,
+                    key: 'editGrid',
+                    type: 'editgrid',
+                    input: true,
+                    components: [
+                        {
+                            label: 'Text Field',
+                            tableView: true,
+                            key: 'textField',
+                            type: 'textfield',
+                            input: true,
+                            alwaysEnabled: false
+                        }
+                    ],
+                    alwaysEnabled: false
+                }
+            ],
+            alwaysEnabled: false
+        },
+        {
+            title: 'Page 2',
+            breadcrumbClickable: true,
+            buttonSettings: {
+                previous: true,
+                cancel: true,
+                next: true
+            },
+            collapsible: false,
+            tableView: false,
+            key: 'page2',
+            type: 'panel',
+            label: 'Page 1',
+            input: false,
+            alwaysEnabled: false,
+            components: []
+        },
+        {
+            label: 'Submit',
+            showValidations: false,
+            alwaysEnabled: false,
+            tableView: false,
+            key: 'submit',
+            type: 'button',
+            input: true
+        }
+    ]
+};

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

@@ -13,7 +13,9 @@ import comp6 from './comp6';
 import comp7 from './comp7';
 import comp8 from './comp8';
 import comp9 from './comp9';
+import comp16 from './comp16';
 import compOpenWhenEmpty from './comp-openWhenEmpty';
 import withOpenWhenEmptyAndConditions from './comp-with-conditions-and-openWhenEmpty';
 import compWithCustomDefaultValue from './comp-with-custom-default-value';
-export { comp1, comp2, comp3, comp10, comp11, comp12, comp13, comp14, comp15, comp4, comp5, comp6, comp7, comp8, comp9, compOpenWhenEmpty, withOpenWhenEmptyAndConditions, compWithCustomDefaultValue };
+import compTestEvents from './comp-test-events';
+export { comp1, comp2, comp3, comp10, comp11, comp12, comp13, comp14, comp15, comp4, comp5, comp6, comp7, comp8, comp9, comp16, compOpenWhenEmpty, withOpenWhenEmptyAndConditions, compWithCustomDefaultValue, compTestEvents };