@formio/js 5.0.0-rc.67 → 5.0.0-rc.68

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

@@ -1,7 +1,8 @@
 import _ from 'lodash';
 import NestedArrayComponent from '../_classes/nestedarray/NestedArrayComponent';
 import { fastCloneDeep, getFocusableElements } from '../../utils/utils';
-import { Components } from '../Components';
+import Components from '../Components';
+import dragula from 'dragula';
 export default class DataGridComponent extends NestedArrayComponent {
     static schema(...extend) {
         return NestedArrayComponent.schema({
@@ -278,34 +279,32 @@ export default class DataGridComponent extends NestedArrayComponent {
             this.refs[`${this.datagridKey}-row`].forEach((row, index) => {
                 row.dragInfo = { index };
             });
-            if (this.root.dragulaLib) {
-                this.dragula = this.root.dragulaLib([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');
-                        }
-                    }
-                }).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;
-                            }
-                            else {
-                                const cssText = Object.values(styles).reduce((css, propertyName) => {
-                                    return `${css}${propertyName}:${styles.getPropertyValue(propertyName)};`;
-                                }, '');
-                                el.children[index].style.cssText = 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');
                     }
-                });
-            }
+                }
+            }).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;
+                        }
+                        else {
+                            const cssText = Object.values(styles).reduce((css, propertyName) => {
+                                return `${css}${propertyName}:${styles.getPropertyValue(propertyName)};`;
+                            }, '');
+                            el.children[index].style.cssText = cssText;
+                        }
+                    });
+                }
+            });
         }
         this.refs[`${this.datagridKey}-addRow`].forEach((addButton) => {
             this.addEventListener(addButton, 'click', this.addRow.bind(this));
@@ -333,6 +332,24 @@ export default class DataGridComponent extends NestedArrayComponent {
     getComponentsContainer() {
         return this.component.components;
     }
+    /**
+     * Reorder values in array based on the old and new position
+     * @param {any} valuesArr - An array of values.
+     * @param {number} oldPosition - The index of the value in array before reordering.
+     * @param {number} newPosition - The index of the value in array after reordering.
+     * @param {boolean|any} movedBelow - Whether or not the value is moved below.
+     * @returns {void}
+     */
+    reorderValues(valuesArr, oldPosition, newPosition, movedBelow) {
+        if (!_.isArray(valuesArr) || _.isEmpty(valuesArr)) {
+            return;
+        }
+        const draggedRowData = valuesArr[oldPosition];
+        //insert element at new position
+        valuesArr.splice(newPosition, 0, draggedRowData);
+        //remove element from old position (if was moved above, after insertion it's at +1 index)
+        valuesArr.splice(movedBelow ? oldPosition : oldPosition + 1, 1);
+    }
     onReorder(element, _target, _source, sibling) {
         if (!element.dragInfo || (sibling && !sibling.dragInfo)) {
             console.warn('There is no Drag Info available for either dragged or sibling element');
@@ -343,11 +360,9 @@ export default class DataGridComponent extends NestedArrayComponent {
         const newPosition = sibling ? sibling.dragInfo.index : this.dataValue.length;
         const movedBelow = newPosition > oldPosition;
         const dataValue = fastCloneDeep(this.dataValue);
-        const draggedRowData = dataValue[oldPosition];
-        //insert element at new position
-        dataValue.splice(newPosition, 0, draggedRowData);
-        //remove element from old position (if was moved above, after insertion it's at +1 index)
-        dataValue.splice(movedBelow ? oldPosition : oldPosition + 1, 1);
+        this.reorderValues(dataValue, oldPosition, newPosition, movedBelow);
+        //reorder select data
+        this.reorderValues(_.get(this.root, `submission.metadata.selectData.${this.path}`, []), oldPosition, newPosition, movedBelow);
         //need to re-build rows to re-calculate indexes and other indexed fields for component instance (like rows for ex.)
         this.setValue(dataValue, { isReordered: true });
         this.rebuild();

package/lib/mjs/components/datagrid/fixtures/comp-with-reorder.d.ts

@@ -0,0 +1,100 @@
+declare namespace _default {
+    export { form };
+    export { submission };
+}
+export default _default;
+declare namespace form {
+    let _id: string;
+    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: {
+            select: string;
+        }[];
+        key: string;
+        type: string;
+        input: boolean;
+        components: {
+            label: string;
+            widget: string;
+            tableView: boolean;
+            dataSrc: string;
+            data: {
+                resource: string;
+            };
+            dataType: string;
+            valueProperty: string;
+            template: string;
+            validate: {
+                select: boolean;
+            };
+            key: string;
+            type: string;
+            searchField: string;
+            limit: number;
+            noRefreshOnScroll: boolean;
+            addResource: boolean;
+            reference: boolean;
+            input: 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;
+        components?: undefined;
+    })[];
+    let created: string;
+    let modified: string;
+    let machineName: string;
+}
+declare namespace submission {
+    let form_1: string;
+    export { form_1 as form };
+    export namespace metadata {
+        namespace selectData {
+            let dataGrid: {
+                select: {
+                    data: {
+                        number: number;
+                    };
+                };
+            }[];
+        }
+    }
+    export namespace data {
+        let dataGrid_1: {
+            select: string;
+        }[];
+        export { dataGrid_1 as dataGrid };
+        export let dataTable: never[];
+        export let submit: boolean;
+    }
+    let _id_1: string;
+    export { _id_1 as _id };
+    export let project: string;
+    export let state: string;
+    let created_1: string;
+    export { created_1 as created };
+    let modified_1: string;
+    export { modified_1 as modified };
+}

package/lib/mjs/components/datagrid/fixtures/comp-with-reorder.js

@@ -0,0 +1,137 @@
+const form = {
+    _id: '66742f4146717b98a9fa280f',
+    title: 'test reorder',
+    name: 'testReorder',
+    path: 'testreorder',
+    type: 'form',
+    display: 'form',
+    components: [
+        {
+            label: 'Data Grid',
+            reorder: true,
+            addAnotherPosition: 'bottom',
+            layoutFixed: false,
+            enableRowGroups: false,
+            initEmpty: false,
+            tableView: false,
+            defaultValue: [
+                {
+                    select: '',
+                },
+            ],
+            key: 'dataGrid',
+            type: 'datagrid',
+            input: true,
+            components: [
+                {
+                    label: 'Select',
+                    widget: 'choicesjs',
+                    tableView: true,
+                    dataSrc: 'resource',
+                    data: {
+                        resource: '66742ee946717b98a9fa1b0b',
+                    },
+                    dataType: 'string',
+                    valueProperty: 'data.textField',
+                    template: '<span>{{ item.data.number }}</span>',
+                    validate: {
+                        select: false,
+                    },
+                    key: 'select',
+                    type: 'select',
+                    searchField: 'data.textField__regex',
+                    limit: 10,
+                    noRefreshOnScroll: false,
+                    addResource: false,
+                    reference: false,
+                    input: true,
+                },
+            ],
+        },
+        {
+            type: 'button',
+            label: 'Submit',
+            key: 'submit',
+            disableOnInvalid: true,
+            input: true,
+            tableView: false,
+        },
+    ],
+    created: '2024-06-20T13:31:45.177Z',
+    modified: '2024-06-25T10:32:46.577Z',
+    machineName: 'tifwklexhyrgxbr:testReorder',
+};
+const submission = {
+    form: '66742f4146717b98a9fa280f',
+    metadata: {
+        selectData: {
+            dataGrid: [
+                {
+                    select: {
+                        data: {
+                            number: 1,
+                        },
+                    },
+                },
+                {
+                    select: {
+                        data: {
+                            number: 2,
+                        },
+                    },
+                },
+                {
+                    select: {
+                        data: {
+                            number: 3,
+                        },
+                    },
+                },
+                {
+                    select: {
+                        data: {
+                            number: 4,
+                        },
+                    },
+                },
+                {
+                    select: {
+                        data: {
+                            number: 5,
+                        },
+                    },
+                },
+            ],
+        },
+    },
+    data: {
+        dataGrid: [
+            {
+                select: '11',
+            },
+            {
+                select: '22',
+            },
+            {
+                select: '33',
+            },
+            {
+                select: '44',
+            },
+            {
+                select: '55',
+            },
+        ],
+        dataTable: [],
+        submit: true,
+    },
+    _id: '667ab5ee6a69739703d30def',
+    project: '65df46bc93bcfaa231f3db1c',
+    state: 'submitted',
+    created: '2024-06-25T12:19:58.626Z',
+    modified: '2024-06-25T12:19:58.627Z',
+};
+export default {
+    form,
+    submission,
+};

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

@@ -16,4 +16,5 @@ import modalWithRequiredFields from './comp-modal-with-required-fields';
 import withAllowCalculateOverride from './comp-with-allow-calculate-override';
 import twoWithAllowCalculatedOverride from './two-comp-with-allow-calculate-override';
 import withCheckboxes from './comp-with-checkboxes';
-export { comp1, comp2, comp3, comp4, comp5, comp6, comp7, comp8, comp9, withCollapsibleRowGroups, withConditionalFieldsAndValidations, withDefValue, withLogic, withRowGroupsAndDefValue, modalWithRequiredFields, withAllowCalculateOverride, twoWithAllowCalculatedOverride, withCheckboxes };
+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 };

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

@@ -16,4 +16,5 @@ import withCollapsibleRowGroups from './comp-with-collapsible-groups';
 import withAllowCalculateOverride from './comp-with-allow-calculate-override';
 import twoWithAllowCalculatedOverride from './two-comp-with-allow-calculate-override';
 import withCheckboxes from './comp-with-checkboxes';
-export { comp1, comp2, comp3, comp4, comp5, comp6, comp7, comp8, comp9, withCollapsibleRowGroups, withConditionalFieldsAndValidations, withDefValue, withLogic, withRowGroupsAndDefValue, modalWithRequiredFields, withAllowCalculateOverride, twoWithAllowCalculatedOverride, withCheckboxes };
+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 };

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/editgrid/EditGrid.js

@@ -1079,7 +1079,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/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

@@ -7,6 +7,7 @@ import comp12 from './comp12';
 import comp13 from './comp13';
 import comp14 from './comp14';
 import comp15 from './comp15';
+import comp16 from './comp16';
 import comp4 from './comp4';
 import comp5 from './comp5';
 import comp6 from './comp6';
@@ -16,4 +17,4 @@ import comp9 from './comp9';
 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 };
+export { comp1, comp2, comp3, comp10, comp11, comp12, comp13, comp14, comp15, comp16, comp4, comp5, comp6, comp7, comp8, comp9, compOpenWhenEmpty, withOpenWhenEmptyAndConditions, compWithCustomDefaultValue };

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

@@ -13,7 +13,8 @@ import comp12 from './comp12';
 import comp13 from './comp13';
 import comp14 from './comp14';
 import comp15 from './comp15';
+import comp16 from './comp16';
 import withOpenWhenEmptyAndConditions from './comp-with-conditions-and-openWhenEmpty';
 import compOpenWhenEmpty from './comp-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 };
+export { comp1, comp2, comp3, comp10, comp11, comp12, comp13, comp14, comp15, comp16, comp4, comp5, comp6, comp7, comp8, comp9, compOpenWhenEmpty, withOpenWhenEmptyAndConditions, compWithCustomDefaultValue };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@formio/js",
-  "version": "5.0.0-rc.67",
+  "version": "5.0.0-rc.68",
   "description": "JavaScript powered Forms with JSON Form Builder",
   "main": "lib/cjs/index.js",
   "exports": {
@@ -81,7 +81,7 @@
   "dependencies": {
     "@formio/bootstrap": "3.0.0-rc.36",
     "@formio/choices.js": "^10.2.1",
-    "@formio/core": "2.2.0-rc.5",
+    "@formio/core": "2.2.0-rc.6",
     "@formio/text-mask-addons": "^3.8.0-formio.2",
     "@formio/vanilla-text-mask": "^5.1.1-formio.1",
     "abortcontroller-polyfill": "^1.7.5",