@reltio/components 1.4.2189 → 1.4.2190

package/cjs/features/workflow/AddWorkflowDialog/AddWorkflowDialog.spec.js

@@ -46,6 +46,15 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -265,4 +274,62 @@ describe('AddWorkflowDialog tests', function () {
             }
         });
     }); });
+    describe('Required comments', function () {
+        it('should not allow to start workflow if comment is required with empty comment', function () { return __awaiter(void 0, void 0, void 0, function () {
+            var definitionsWithRequiredComment, mockAnchorEl, props, user, commentField, startButton, comment;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        mdm_sdk_1.startProcessInstance.mockResolvedValue(null);
+                        definitionsWithRequiredComment = __spreadArray(__spreadArray([], definitions, true), [
+                            {
+                                type: 'workflowWithRequiredComment',
+                                displayName: 'Workflow With Required Comment',
+                                manualStart: true,
+                                requiresCommentOnStart: true,
+                                objectTypes: ['configuration/entityTypes/HCO']
+                            }
+                        ], false);
+                        mdm_sdk_1.processDefinitions.mockReturnValue(Promise.resolve({
+                            data: definitionsWithRequiredComment
+                        }));
+                        mockAnchorEl = document.createElement('div');
+                        props = {
+                            onClose: jest.fn(),
+                            anchorEl: mockAnchorEl
+                        };
+                        user = setUp(props).user;
+                        expect(react_2.screen.getByText('Add new workflow')).toBeInTheDocument();
+                        return [4 /*yield*/, user.click(react_2.screen.getByRole('combobox'))];
+                    case 1:
+                        _a.sent();
+                        return [4 /*yield*/, user.click(react_2.screen.getByText('Workflow With Required Comment'))];
+                    case 2:
+                        _a.sent();
+                        commentField = react_2.screen.getByRole('textbox', { name: /type a comment/i });
+                        expect(commentField).toBeRequired();
+                        startButton = react_2.screen.getByText('Start');
+                        expect(startButton).toBeDisabled();
+                        comment = 'Some comment';
+                        return [4 /*yield*/, user.type(commentField, comment)];
+                    case 3:
+                        _a.sent();
+                        expect(startButton).not.toBeDisabled();
+                        return [4 /*yield*/, user.click(startButton)];
+                    case 4:
+                        _a.sent();
+                        expect(mdm_sdk_1.startProcessInstance).toHaveBeenCalledWith({
+                            workflowPath: workflowPath,
+                            environment: workflowEnvironmentUrl,
+                            tenant: tenant.id,
+                            processType: 'workflowWithRequiredComment',
+                            comment: comment,
+                            objectURIs: ['entities/uri1']
+                        });
+                        expect(react_2.screen.getByText('A new workflow has started')).toBeInTheDocument();
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+    });
 });

package/cjs/features/workflow/TaskActionButtons/TaskActionButtons.spec.js

@@ -139,7 +139,7 @@ describe('TaskActionButtons tests', function () {
             }
         });
     }); });
-    describe('required comments', function () {
+    describe('Required comments', function () {
         it('should show comment dialog if commentRequired is true', function () { return __awaiter(void 0, void 0, void 0, function () {
             var task, user, dialog, textfield;
             return __generator(this, function (_a) {

package/cjs/features/workflow/WorkflowTaskCard/components/DataChangeRequestTaskCard/DataChangeRequestTaskCard.spec.js

@@ -69,8 +69,11 @@ var mdm_sdk_1 = require("@reltio/mdm-sdk");
 var MdmModuleContext_1 = require("../../../../../contexts/MdmModuleContext");
 var CommentDialogContext_1 = require("../../../../../contexts/CommentDialogContext");
 var DataChangeRequestTaskCard_1 = require("./DataChangeRequestTaskCard");
-jest.mock('@reltio/mdm-sdk', function () { return (__assign(__assign({}, jest.requireActual('@reltio/mdm-sdk')), { getDataChangeRequest: jest.fn(), getEntitiesByUris: jest.fn() })); });
+var WorkflowTasksContext_1 = require("../../../../../contexts/WorkflowTasksContext");
+jest.mock('@reltio/mdm-sdk', function () { return (__assign(__assign({}, jest.requireActual('@reltio/mdm-sdk')), { getDataChangeRequest: jest.fn(), getEntitiesByUris: jest.fn(), runTaskAction: jest.fn() })); });
 jest.mock('../../../../../contexts/MdmModuleContext', function () { return (__assign(__assign({}, jest.requireActual('../../../../../contexts/MdmModuleContext')), { useMdmMetadata: jest.fn() })); });
+var onActionSuccess = jest.fn();
+var workflowTaskContextValue = { onActionSuccess: onActionSuccess };
 describe('DataChangeRequestTaskCard tests', function () {
     var _a, _b;
     var metadata = {
@@ -180,7 +183,7 @@ describe('DataChangeRequestTaskCard tests', function () {
     var dcrUri = "changeRequests/".concat(dcrId);
     var dueDate = 1731825314640;
     var newStartDate = (0, moment_1.default)('11/15/2024', 'MM/DD/YYYY').valueOf();
-    var task = {
+    var defaultTask = {
         assignee: userName,
         processInstanceId: '60260030',
         processType: 'dataChangeRequestReview',
@@ -260,17 +263,32 @@ describe('DataChangeRequestTaskCard tests', function () {
             label: relationEntityLabel
         }
     ];
-    var setUp = function () {
+    var tenant = { id: 't1', name: 't1' };
+    var workflowPath = 'workflowPath';
+    var workflowEnvironmentUrl = 'workflowEnvironmentUrl';
+    var mdmValues = {
+        user: {
+            username: userName
+        },
+        tenant: tenant,
+        workflowPath: workflowPath,
+        workflowEnvironmentUrl: workflowEnvironmentUrl
+    };
+    var setUp = function (_a) {
+        var _b = _a === void 0 ? {} : _a, _c = _b.task, task = _c === void 0 ? defaultTask : _c;
         var user = user_event_1.default.setup();
         var Providers = function (_a) {
             var children = _a.children;
-            return (react_1.default.createElement(LocalizationProvider_1.LocalizationProvider, { dateAdapter: AdapterMoment_1.AdapterMoment },
-                react_1.default.createElement(CommentDialogContext_1.CommentDialogProvider, null, children)));
+            return (react_1.default.createElement(MdmModuleContext_1.MdmModuleProvider, { values: mdmValues },
+                react_1.default.createElement(LocalizationProvider_1.LocalizationProvider, { dateAdapter: AdapterMoment_1.AdapterMoment },
+                    react_1.default.createElement(WorkflowTasksContext_1.WorkflowTasksContext.Provider, { value: workflowTaskContextValue },
+                        react_1.default.createElement(CommentDialogContext_1.CommentDialogProvider, null, children)))));
         };
         return __assign(__assign({}, (0, react_2.render)(react_1.default.createElement(DataChangeRequestTaskCard_1.DataChangeRequestTaskCard, { task: task }), { wrapper: Providers })), { user: user });
     };
     beforeAll(function () {
         mdm_sdk_1.getEntitiesByUris.mockResolvedValue(entities);
+        mdm_sdk_1.runTaskAction.mockResolvedValue(null);
     });
     beforeEach(function () {
         MdmModuleContext_1.useMdmMetadata.mockReturnValue(metadata);
@@ -517,4 +535,61 @@ describe('DataChangeRequestTaskCard tests', function () {
             }
         });
     }); });
+    describe('Required comments', function () {
+        it('should show comment dialog when user runs action and comment is required', function () { return __awaiter(void 0, void 0, void 0, function () {
+            var task, user, dialog, comment, commentInput;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        task = __assign(__assign({}, defaultTask), { possibleActions: [
+                                {
+                                    action: 'Approve',
+                                    label: 'Approve',
+                                    commentRequired: true
+                                },
+                                {
+                                    action: 'Reject',
+                                    label: 'Reject',
+                                    commentRequired: false
+                                }
+                            ] });
+                        mdm_sdk_1.getDataChangeRequest.mockResolvedValue(dcr);
+                        user = setUp({ task: task }).user;
+                        return [4 /*yield*/, user.click(react_2.screen.getByTestId('task-actions'))];
+                    case 1:
+                        _a.sent();
+                        return [4 /*yield*/, user.click(react_2.screen.getByText(task.possibleActions[0].label))];
+                    case 2:
+                        _a.sent();
+                        expect(mdm_sdk_1.runTaskAction).not.toHaveBeenCalled();
+                        dialog = react_2.screen.getAllByRole('presentation')[1];
+                        expect((0, react_2.within)(dialog).getByText('Please provide a comment for your action')).toBeInTheDocument();
+                        expect((0, react_2.within)(dialog).getByText('Type a comment')).toBeInTheDocument();
+                        expect((0, react_2.within)(dialog).getByText('Cancel')).toBeInTheDocument();
+                        expect((0, react_2.within)(dialog).getByText('Done')).toBeInTheDocument();
+                        comment = 'Some comment';
+                        commentInput = react_2.screen.getAllByRole('textbox')[0];
+                        return [4 /*yield*/, user.click(commentInput)];
+                    case 3:
+                        _a.sent();
+                        return [4 /*yield*/, user.paste(comment)];
+                    case 4:
+                        _a.sent();
+                        return [4 /*yield*/, user.click((0, react_2.within)(dialog).getByText('Done'))];
+                    case 5:
+                        _a.sent();
+                        expect(react_2.screen.queryByText('Please provide a comment for your action')).not.toBeInTheDocument();
+                        expect(mdm_sdk_1.runTaskAction).toHaveBeenCalledWith({
+                            workflowPath: workflowPath,
+                            environment: workflowEnvironmentUrl,
+                            tenant: tenant.id,
+                            taskId: task.taskId,
+                            action: task.possibleActions[0].action,
+                            processInstanceComment: comment
+                        });
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+    });
 });

package/cjs/features/workflow/WorkflowTaskCard/components/GenericWorkflowTaskCard/GenericWorkflowTaskCard.spec.js

@@ -456,4 +456,108 @@ describe('GenericWorkflowTaskCard tests', function () {
             }
         });
     }); });
+    describe('Required comments', function () {
+        it('should show comment dialog when user runs action and comment is required', function () { return __awaiter(void 0, void 0, void 0, function () {
+            var task, user, dialog, comment, commentInput;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        task = __assign(__assign({}, defaultTask), { possibleActions: [
+                                {
+                                    action: 'Delete',
+                                    label: 'Delete',
+                                    commentRequired: true
+                                },
+                                {
+                                    action: 'Cancel',
+                                    label: 'Cancel',
+                                    commentRequired: false
+                                }
+                            ] });
+                        user = setUp({ task: task }).user;
+                        return [4 /*yield*/, user.click(react_2.screen.getByTestId('task-actions'))];
+                    case 1:
+                        _a.sent();
+                        return [4 /*yield*/, user.click(react_2.screen.getByText(task.possibleActions[0].label))];
+                    case 2:
+                        _a.sent();
+                        expect(mdm_sdk_1.runTaskAction).not.toHaveBeenCalled();
+                        dialog = react_2.screen.getAllByRole('presentation')[1];
+                        expect((0, react_2.within)(dialog).getByText('Please provide a comment for your action')).toBeInTheDocument();
+                        expect((0, react_2.within)(dialog).getByText('Type a comment')).toBeInTheDocument();
+                        expect((0, react_2.within)(dialog).getByText('Cancel')).toBeInTheDocument();
+                        expect((0, react_2.within)(dialog).getByText('Done')).toBeInTheDocument();
+                        comment = 'comment';
+                        commentInput = react_2.screen.getAllByRole('textbox')[0];
+                        return [4 /*yield*/, user.click(commentInput)];
+                    case 3:
+                        _a.sent();
+                        return [4 /*yield*/, user.paste(comment)];
+                    case 4:
+                        _a.sent();
+                        return [4 /*yield*/, user.click((0, react_2.within)(react_2.screen.getAllByRole('presentation')[1]).getByText('Done'))];
+                    case 5:
+                        _a.sent();
+                        expect(mdm_sdk_1.runTaskAction).toHaveBeenCalledWith({
+                            workflowPath: workflowPath,
+                            environment: workflowEnvironmentUrl,
+                            tenant: tenant.id,
+                            taskId: defaultTask.taskId,
+                            action: defaultTask.possibleActions[0].action,
+                            processInstanceComment: comment
+                        });
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        it('should not show comment dialog when user types comment and run action', function () { return __awaiter(void 0, void 0, void 0, function () {
+            var task, user, comment, commentInput;
+            var _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        task = __assign(__assign({}, defaultTask), { possibleActions: [
+                                {
+                                    action: 'Delete',
+                                    label: 'Delete',
+                                    commentRequired: true
+                                },
+                                {
+                                    action: 'Cancel',
+                                    label: 'Cancel',
+                                    commentRequired: false
+                                }
+                            ] });
+                        user = setUp({ task: task }).user;
+                        return [4 /*yield*/, user.click(react_2.screen.getByTestId('collapse-button'))];
+                    case 1:
+                        _b.sent();
+                        comment = 'comment';
+                        commentInput = react_2.screen.getByPlaceholderText('Write a comment');
+                        return [4 /*yield*/, user.click(commentInput)];
+                    case 2:
+                        _b.sent();
+                        return [4 /*yield*/, user.paste(comment)];
+                    case 3:
+                        _b.sent();
+                        return [4 /*yield*/, user.click(react_2.screen.getByRole('button', { name: (_a = task.preferredAction) === null || _a === void 0 ? void 0 : _a.label }))];
+                    case 4:
+                        _b.sent();
+                        return [4 /*yield*/, user.click(react_2.screen.getByTestId("reltio-profile-select-mode-".concat(task.possibleActions[0].label)))];
+                    case 5:
+                        _b.sent();
+                        expect(react_2.screen.queryByText('Please provide a comment for your action')).not.toBeInTheDocument();
+                        expect(mdm_sdk_1.runTaskAction).toHaveBeenCalledWith({
+                            workflowPath: workflowPath,
+                            environment: workflowEnvironmentUrl,
+                            tenant: tenant.id,
+                            taskId: defaultTask.taskId,
+                            action: defaultTask.possibleActions[0].action,
+                            processInstanceComment: comment
+                        });
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+    });
 });

package/cjs/features/workflow/WorkflowTaskCard/components/PotentialMatchTaskCard/PotentialMatchTaskCard.spec.js

@@ -59,17 +59,24 @@ var AdapterMoment_1 = require("@mui/x-date-pickers/AdapterMoment");
 var MdmModuleContext_1 = require("../../../../../contexts/MdmModuleContext");
 var CommentDialogContext_1 = require("../../../../../contexts/CommentDialogContext");
 var PotentialMatchTaskCard_1 = require("./PotentialMatchTaskCard");
+jest.mock('@reltio/mdm-sdk', function () { return (__assign(__assign({}, jest.requireActual('@reltio/mdm-sdk')), { runTaskAction: jest.fn() })); });
 describe('PotentialMatchTaskCard tests', function () {
+    var tenant = { id: 't1', name: 't1' };
+    var workflowPath = 'workflowPath';
+    var workflowEnvironmentUrl = 'workflowEnvironmentUrl';
     var mdmValues = {
         metadata: { entityTypes: [], relationTypes: [] },
         entity: { uri: 'entities/uri1', type: 'configuration/entityTypes/HCO' },
-        tenant: { id: 't1', name: 't1' },
+        tenant: tenant,
+        workflowPath: workflowPath,
+        workflowEnvironmentUrl: workflowEnvironmentUrl,
+        user: { username: 'egorshkov' },
         dtssPath: 'path',
         dataTenants: [],
         activityFilter: mdm_sdk_1.ActivityFilter.ACTIVE_ONLY
     };
     var relatedEntityUri = 'entities/6hj8baQ';
-    var task = {
+    var defaultTask = {
         assignee: 'egorshkov',
         objectURIs: [relatedEntityUri, 'entities/1RdgehCi'],
         createdBy: 'egorshkov',
@@ -103,7 +110,7 @@ describe('PotentialMatchTaskCard tests', function () {
             uri: 'entities/6hj8baQ'
         }
     };
-    var defaultProps = { task: task, match: match, entitiesMap: entitiesMap };
+    var defaultProps = { task: defaultTask, match: match, entitiesMap: entitiesMap };
     var setUp = function (props) {
         if (props === void 0) { props = {}; }
         var user = user_event_1.default.setup();
@@ -115,6 +122,9 @@ describe('PotentialMatchTaskCard tests', function () {
         };
         return __assign({ user: user }, (0, react_2.render)(react_1.default.createElement(PotentialMatchTaskCard_1.PotentialMatchTaskCard, __assign({}, defaultProps, props)), { wrapper: Providers }));
     };
+    beforeAll(function () {
+        mdm_sdk_1.runTaskAction.mockResolvedValue(null);
+    });
     afterEach(function () {
         jest.clearAllMocks();
     });
@@ -163,4 +173,60 @@ describe('PotentialMatchTaskCard tests', function () {
             }
         });
     }); });
+    describe('Required comments', function () {
+        it('should show comment dialog when user runs action and comment is required', function () { return __awaiter(void 0, void 0, void 0, function () {
+            var task, user, dialog, comment, commentInput;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        task = __assign(__assign({}, defaultTask), { isOpen: true, possibleActions: [
+                                {
+                                    action: 'Approve',
+                                    label: 'Approve',
+                                    commentRequired: true
+                                },
+                                {
+                                    action: 'Reject',
+                                    label: 'Reject',
+                                    commentRequired: false
+                                }
+                            ] });
+                        user = setUp({ task: task }).user;
+                        return [4 /*yield*/, user.click(react_2.screen.getByTestId('task-actions'))];
+                    case 1:
+                        _a.sent();
+                        return [4 /*yield*/, user.click(react_2.screen.getByText(task.possibleActions[0].label))];
+                    case 2:
+                        _a.sent();
+                        expect(mdm_sdk_1.runTaskAction).not.toHaveBeenCalled();
+                        dialog = react_2.screen.getAllByRole('presentation')[1];
+                        expect((0, react_2.within)(dialog).getByText('Please provide a comment for your action')).toBeInTheDocument();
+                        expect((0, react_2.within)(dialog).getByText('Type a comment')).toBeInTheDocument();
+                        expect((0, react_2.within)(dialog).getByText('Cancel')).toBeInTheDocument();
+                        expect((0, react_2.within)(dialog).getByText('Done')).toBeInTheDocument();
+                        comment = 'Some comment';
+                        commentInput = react_2.screen.getAllByRole('textbox')[0];
+                        return [4 /*yield*/, user.click(commentInput)];
+                    case 3:
+                        _a.sent();
+                        return [4 /*yield*/, user.paste(comment)];
+                    case 4:
+                        _a.sent();
+                        return [4 /*yield*/, user.click((0, react_2.within)(dialog).getByText('Done'))];
+                    case 5:
+                        _a.sent();
+                        expect(react_2.screen.queryByText('Please provide a comment for your action')).not.toBeInTheDocument();
+                        expect(mdm_sdk_1.runTaskAction).toHaveBeenCalledWith({
+                            workflowPath: workflowPath,
+                            environment: workflowEnvironmentUrl,
+                            tenant: tenant.id,
+                            taskId: task.taskId,
+                            action: task.possibleActions[0].action,
+                            processInstanceComment: comment
+                        });
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+    });
 });

package/features/workflow/AddWorkflowDialog/AddWorkflowDialog.spec.js

@@ -45,6 +45,15 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
 import React from 'react';
 import { act, render, screen } from '@testing-library/react';
 import userEvent from '@testing-library/user-event';
@@ -260,4 +269,62 @@ describe('AddWorkflowDialog tests', function () {
             }
         });
     }); });
+    describe('Required comments', function () {
+        it('should not allow to start workflow if comment is required with empty comment', function () { return __awaiter(void 0, void 0, void 0, function () {
+            var definitionsWithRequiredComment, mockAnchorEl, props, user, commentField, startButton, comment;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        startProcessInstance.mockResolvedValue(null);
+                        definitionsWithRequiredComment = __spreadArray(__spreadArray([], definitions, true), [
+                            {
+                                type: 'workflowWithRequiredComment',
+                                displayName: 'Workflow With Required Comment',
+                                manualStart: true,
+                                requiresCommentOnStart: true,
+                                objectTypes: ['configuration/entityTypes/HCO']
+                            }
+                        ], false);
+                        processDefinitions.mockReturnValue(Promise.resolve({
+                            data: definitionsWithRequiredComment
+                        }));
+                        mockAnchorEl = document.createElement('div');
+                        props = {
+                            onClose: jest.fn(),
+                            anchorEl: mockAnchorEl
+                        };
+                        user = setUp(props).user;
+                        expect(screen.getByText('Add new workflow')).toBeInTheDocument();
+                        return [4 /*yield*/, user.click(screen.getByRole('combobox'))];
+                    case 1:
+                        _a.sent();
+                        return [4 /*yield*/, user.click(screen.getByText('Workflow With Required Comment'))];
+                    case 2:
+                        _a.sent();
+                        commentField = screen.getByRole('textbox', { name: /type a comment/i });
+                        expect(commentField).toBeRequired();
+                        startButton = screen.getByText('Start');
+                        expect(startButton).toBeDisabled();
+                        comment = 'Some comment';
+                        return [4 /*yield*/, user.type(commentField, comment)];
+                    case 3:
+                        _a.sent();
+                        expect(startButton).not.toBeDisabled();
+                        return [4 /*yield*/, user.click(startButton)];
+                    case 4:
+                        _a.sent();
+                        expect(startProcessInstance).toHaveBeenCalledWith({
+                            workflowPath: workflowPath,
+                            environment: workflowEnvironmentUrl,
+                            tenant: tenant.id,
+                            processType: 'workflowWithRequiredComment',
+                            comment: comment,
+                            objectURIs: ['entities/uri1']
+                        });
+                        expect(screen.getByText('A new workflow has started')).toBeInTheDocument();
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+    });
 });

package/features/workflow/TaskActionButtons/TaskActionButtons.spec.js

@@ -134,7 +134,7 @@ describe('TaskActionButtons tests', function () {
             }
         });
     }); });
-    describe('required comments', function () {
+    describe('Required comments', function () {
         it('should show comment dialog if commentRequired is true', function () { return __awaiter(void 0, void 0, void 0, function () {
             var task, user, dialog, textfield;
             return __generator(this, function (_a) {

package/features/workflow/WorkflowTaskCard/components/DataChangeRequestTaskCard/DataChangeRequestTaskCard.spec.js

@@ -60,12 +60,15 @@ import userEvent from '@testing-library/user-event';
 import moment from 'moment';
 import { LocalizationProvider } from '@mui/x-date-pickers/LocalizationProvider';
 import { AdapterMoment } from '@mui/x-date-pickers/AdapterMoment';
-import { DCROperationTypes, DCRTypes, getDataChangeRequest, getEntitiesByUris } from '@reltio/mdm-sdk';
-import { useMdmMetadata } from '../../../../../contexts/MdmModuleContext';
+import { DCROperationTypes, DCRTypes, getDataChangeRequest, getEntitiesByUris, runTaskAction } from '@reltio/mdm-sdk';
+import { MdmModuleProvider, useMdmMetadata } from '../../../../../contexts/MdmModuleContext';
 import { CommentDialogProvider } from '../../../../../contexts/CommentDialogContext';
 import { DataChangeRequestTaskCard } from './DataChangeRequestTaskCard';
-jest.mock('@reltio/mdm-sdk', function () { return (__assign(__assign({}, jest.requireActual('@reltio/mdm-sdk')), { getDataChangeRequest: jest.fn(), getEntitiesByUris: jest.fn() })); });
+import { WorkflowTasksContext } from '../../../../../contexts/WorkflowTasksContext';
+jest.mock('@reltio/mdm-sdk', function () { return (__assign(__assign({}, jest.requireActual('@reltio/mdm-sdk')), { getDataChangeRequest: jest.fn(), getEntitiesByUris: jest.fn(), runTaskAction: jest.fn() })); });
 jest.mock('../../../../../contexts/MdmModuleContext', function () { return (__assign(__assign({}, jest.requireActual('../../../../../contexts/MdmModuleContext')), { useMdmMetadata: jest.fn() })); });
+var onActionSuccess = jest.fn();
+var workflowTaskContextValue = { onActionSuccess: onActionSuccess };
 describe('DataChangeRequestTaskCard tests', function () {
     var _a, _b;
     var metadata = {
@@ -175,7 +178,7 @@ describe('DataChangeRequestTaskCard tests', function () {
     var dcrUri = "changeRequests/".concat(dcrId);
     var dueDate = 1731825314640;
     var newStartDate = moment('11/15/2024', 'MM/DD/YYYY').valueOf();
-    var task = {
+    var defaultTask = {
         assignee: userName,
         processInstanceId: '60260030',
         processType: 'dataChangeRequestReview',
@@ -255,17 +258,32 @@ describe('DataChangeRequestTaskCard tests', function () {
             label: relationEntityLabel
         }
     ];
-    var setUp = function () {
+    var tenant = { id: 't1', name: 't1' };
+    var workflowPath = 'workflowPath';
+    var workflowEnvironmentUrl = 'workflowEnvironmentUrl';
+    var mdmValues = {
+        user: {
+            username: userName
+        },
+        tenant: tenant,
+        workflowPath: workflowPath,
+        workflowEnvironmentUrl: workflowEnvironmentUrl
+    };
+    var setUp = function (_a) {
+        var _b = _a === void 0 ? {} : _a, _c = _b.task, task = _c === void 0 ? defaultTask : _c;
         var user = userEvent.setup();
         var Providers = function (_a) {
             var children = _a.children;
-            return (React.createElement(LocalizationProvider, { dateAdapter: AdapterMoment },
-                React.createElement(CommentDialogProvider, null, children)));
+            return (React.createElement(MdmModuleProvider, { values: mdmValues },
+                React.createElement(LocalizationProvider, { dateAdapter: AdapterMoment },
+                    React.createElement(WorkflowTasksContext.Provider, { value: workflowTaskContextValue },
+                        React.createElement(CommentDialogProvider, null, children)))));
         };
         return __assign(__assign({}, render(React.createElement(DataChangeRequestTaskCard, { task: task }), { wrapper: Providers })), { user: user });
     };
     beforeAll(function () {
         getEntitiesByUris.mockResolvedValue(entities);
+        runTaskAction.mockResolvedValue(null);
     });
     beforeEach(function () {
         useMdmMetadata.mockReturnValue(metadata);
@@ -512,4 +530,61 @@ describe('DataChangeRequestTaskCard tests', function () {
             }
         });
     }); });
+    describe('Required comments', function () {
+        it('should show comment dialog when user runs action and comment is required', function () { return __awaiter(void 0, void 0, void 0, function () {
+            var task, user, dialog, comment, commentInput;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        task = __assign(__assign({}, defaultTask), { possibleActions: [
+                                {
+                                    action: 'Approve',
+                                    label: 'Approve',
+                                    commentRequired: true
+                                },
+                                {
+                                    action: 'Reject',
+                                    label: 'Reject',
+                                    commentRequired: false
+                                }
+                            ] });
+                        getDataChangeRequest.mockResolvedValue(dcr);
+                        user = setUp({ task: task }).user;
+                        return [4 /*yield*/, user.click(screen.getByTestId('task-actions'))];
+                    case 1:
+                        _a.sent();
+                        return [4 /*yield*/, user.click(screen.getByText(task.possibleActions[0].label))];
+                    case 2:
+                        _a.sent();
+                        expect(runTaskAction).not.toHaveBeenCalled();
+                        dialog = screen.getAllByRole('presentation')[1];
+                        expect(within(dialog).getByText('Please provide a comment for your action')).toBeInTheDocument();
+                        expect(within(dialog).getByText('Type a comment')).toBeInTheDocument();
+                        expect(within(dialog).getByText('Cancel')).toBeInTheDocument();
+                        expect(within(dialog).getByText('Done')).toBeInTheDocument();
+                        comment = 'Some comment';
+                        commentInput = screen.getAllByRole('textbox')[0];
+                        return [4 /*yield*/, user.click(commentInput)];
+                    case 3:
+                        _a.sent();
+                        return [4 /*yield*/, user.paste(comment)];
+                    case 4:
+                        _a.sent();
+                        return [4 /*yield*/, user.click(within(dialog).getByText('Done'))];
+                    case 5:
+                        _a.sent();
+                        expect(screen.queryByText('Please provide a comment for your action')).not.toBeInTheDocument();
+                        expect(runTaskAction).toHaveBeenCalledWith({
+                            workflowPath: workflowPath,
+                            environment: workflowEnvironmentUrl,
+                            tenant: tenant.id,
+                            taskId: task.taskId,
+                            action: task.possibleActions[0].action,
+                            processInstanceComment: comment
+                        });
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+    });
 });

package/features/workflow/WorkflowTaskCard/components/GenericWorkflowTaskCard/GenericWorkflowTaskCard.spec.js

@@ -57,7 +57,7 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
 import React from 'react';
 import i18n from 'ui-i18n';
 import { identity } from 'ramda';
-import { render, screen } from '@testing-library/react';
+import { render, screen, within } from '@testing-library/react';
 import userEvent from '@testing-library/user-event';
 import { createTheme } from '@mui/material/styles';
 import { ThemeProvider } from '@mui/styles';
@@ -451,4 +451,108 @@ describe('GenericWorkflowTaskCard tests', function () {
             }
         });
     }); });
+    describe('Required comments', function () {
+        it('should show comment dialog when user runs action and comment is required', function () { return __awaiter(void 0, void 0, void 0, function () {
+            var task, user, dialog, comment, commentInput;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        task = __assign(__assign({}, defaultTask), { possibleActions: [
+                                {
+                                    action: 'Delete',
+                                    label: 'Delete',
+                                    commentRequired: true
+                                },
+                                {
+                                    action: 'Cancel',
+                                    label: 'Cancel',
+                                    commentRequired: false
+                                }
+                            ] });
+                        user = setUp({ task: task }).user;
+                        return [4 /*yield*/, user.click(screen.getByTestId('task-actions'))];
+                    case 1:
+                        _a.sent();
+                        return [4 /*yield*/, user.click(screen.getByText(task.possibleActions[0].label))];
+                    case 2:
+                        _a.sent();
+                        expect(runTaskAction).not.toHaveBeenCalled();
+                        dialog = screen.getAllByRole('presentation')[1];
+                        expect(within(dialog).getByText('Please provide a comment for your action')).toBeInTheDocument();
+                        expect(within(dialog).getByText('Type a comment')).toBeInTheDocument();
+                        expect(within(dialog).getByText('Cancel')).toBeInTheDocument();
+                        expect(within(dialog).getByText('Done')).toBeInTheDocument();
+                        comment = 'comment';
+                        commentInput = screen.getAllByRole('textbox')[0];
+                        return [4 /*yield*/, user.click(commentInput)];
+                    case 3:
+                        _a.sent();
+                        return [4 /*yield*/, user.paste(comment)];
+                    case 4:
+                        _a.sent();
+                        return [4 /*yield*/, user.click(within(screen.getAllByRole('presentation')[1]).getByText('Done'))];
+                    case 5:
+                        _a.sent();
+                        expect(runTaskAction).toHaveBeenCalledWith({
+                            workflowPath: workflowPath,
+                            environment: workflowEnvironmentUrl,
+                            tenant: tenant.id,
+                            taskId: defaultTask.taskId,
+                            action: defaultTask.possibleActions[0].action,
+                            processInstanceComment: comment
+                        });
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        it('should not show comment dialog when user types comment and run action', function () { return __awaiter(void 0, void 0, void 0, function () {
+            var task, user, comment, commentInput;
+            var _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        task = __assign(__assign({}, defaultTask), { possibleActions: [
+                                {
+                                    action: 'Delete',
+                                    label: 'Delete',
+                                    commentRequired: true
+                                },
+                                {
+                                    action: 'Cancel',
+                                    label: 'Cancel',
+                                    commentRequired: false
+                                }
+                            ] });
+                        user = setUp({ task: task }).user;
+                        return [4 /*yield*/, user.click(screen.getByTestId('collapse-button'))];
+                    case 1:
+                        _b.sent();
+                        comment = 'comment';
+                        commentInput = screen.getByPlaceholderText('Write a comment');
+                        return [4 /*yield*/, user.click(commentInput)];
+                    case 2:
+                        _b.sent();
+                        return [4 /*yield*/, user.paste(comment)];
+                    case 3:
+                        _b.sent();
+                        return [4 /*yield*/, user.click(screen.getByRole('button', { name: (_a = task.preferredAction) === null || _a === void 0 ? void 0 : _a.label }))];
+                    case 4:
+                        _b.sent();
+                        return [4 /*yield*/, user.click(screen.getByTestId("reltio-profile-select-mode-".concat(task.possibleActions[0].label)))];
+                    case 5:
+                        _b.sent();
+                        expect(screen.queryByText('Please provide a comment for your action')).not.toBeInTheDocument();
+                        expect(runTaskAction).toHaveBeenCalledWith({
+                            workflowPath: workflowPath,
+                            environment: workflowEnvironmentUrl,
+                            tenant: tenant.id,
+                            taskId: defaultTask.taskId,
+                            action: defaultTask.possibleActions[0].action,
+                            processInstanceComment: comment
+                        });
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+    });
 });

package/features/workflow/WorkflowTaskCard/components/PotentialMatchTaskCard/PotentialMatchTaskCard.spec.js

@@ -46,25 +46,32 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 import React from 'react';
-import { render, screen } from '@testing-library/react';
+import { render, screen, within } from '@testing-library/react';
 import userEvent from '@testing-library/user-event';
-import { ActivityFilter } from '@reltio/mdm-sdk';
+import { ActivityFilter, runTaskAction } from '@reltio/mdm-sdk';
 import { LocalizationProvider } from '@mui/x-date-pickers/LocalizationProvider';
 import { AdapterMoment } from '@mui/x-date-pickers/AdapterMoment';
 import { MdmModuleProvider } from '../../../../../contexts/MdmModuleContext';
 import { CommentDialogProvider } from '../../../../../contexts/CommentDialogContext';
 import { PotentialMatchTaskCard } from './PotentialMatchTaskCard';
+jest.mock('@reltio/mdm-sdk', function () { return (__assign(__assign({}, jest.requireActual('@reltio/mdm-sdk')), { runTaskAction: jest.fn() })); });
 describe('PotentialMatchTaskCard tests', function () {
+    var tenant = { id: 't1', name: 't1' };
+    var workflowPath = 'workflowPath';
+    var workflowEnvironmentUrl = 'workflowEnvironmentUrl';
     var mdmValues = {
         metadata: { entityTypes: [], relationTypes: [] },
         entity: { uri: 'entities/uri1', type: 'configuration/entityTypes/HCO' },
-        tenant: { id: 't1', name: 't1' },
+        tenant: tenant,
+        workflowPath: workflowPath,
+        workflowEnvironmentUrl: workflowEnvironmentUrl,
+        user: { username: 'egorshkov' },
         dtssPath: 'path',
         dataTenants: [],
         activityFilter: ActivityFilter.ACTIVE_ONLY
     };
     var relatedEntityUri = 'entities/6hj8baQ';
-    var task = {
+    var defaultTask = {
         assignee: 'egorshkov',
         objectURIs: [relatedEntityUri, 'entities/1RdgehCi'],
         createdBy: 'egorshkov',
@@ -98,7 +105,7 @@ describe('PotentialMatchTaskCard tests', function () {
             uri: 'entities/6hj8baQ'
         }
     };
-    var defaultProps = { task: task, match: match, entitiesMap: entitiesMap };
+    var defaultProps = { task: defaultTask, match: match, entitiesMap: entitiesMap };
     var setUp = function (props) {
         if (props === void 0) { props = {}; }
         var user = userEvent.setup();
@@ -110,6 +117,9 @@ describe('PotentialMatchTaskCard tests', function () {
         };
         return __assign({ user: user }, render(React.createElement(PotentialMatchTaskCard, __assign({}, defaultProps, props)), { wrapper: Providers }));
     };
+    beforeAll(function () {
+        runTaskAction.mockResolvedValue(null);
+    });
     afterEach(function () {
         jest.clearAllMocks();
     });
@@ -158,4 +168,60 @@ describe('PotentialMatchTaskCard tests', function () {
             }
         });
     }); });
+    describe('Required comments', function () {
+        it('should show comment dialog when user runs action and comment is required', function () { return __awaiter(void 0, void 0, void 0, function () {
+            var task, user, dialog, comment, commentInput;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        task = __assign(__assign({}, defaultTask), { isOpen: true, possibleActions: [
+                                {
+                                    action: 'Approve',
+                                    label: 'Approve',
+                                    commentRequired: true
+                                },
+                                {
+                                    action: 'Reject',
+                                    label: 'Reject',
+                                    commentRequired: false
+                                }
+                            ] });
+                        user = setUp({ task: task }).user;
+                        return [4 /*yield*/, user.click(screen.getByTestId('task-actions'))];
+                    case 1:
+                        _a.sent();
+                        return [4 /*yield*/, user.click(screen.getByText(task.possibleActions[0].label))];
+                    case 2:
+                        _a.sent();
+                        expect(runTaskAction).not.toHaveBeenCalled();
+                        dialog = screen.getAllByRole('presentation')[1];
+                        expect(within(dialog).getByText('Please provide a comment for your action')).toBeInTheDocument();
+                        expect(within(dialog).getByText('Type a comment')).toBeInTheDocument();
+                        expect(within(dialog).getByText('Cancel')).toBeInTheDocument();
+                        expect(within(dialog).getByText('Done')).toBeInTheDocument();
+                        comment = 'Some comment';
+                        commentInput = screen.getAllByRole('textbox')[0];
+                        return [4 /*yield*/, user.click(commentInput)];
+                    case 3:
+                        _a.sent();
+                        return [4 /*yield*/, user.paste(comment)];
+                    case 4:
+                        _a.sent();
+                        return [4 /*yield*/, user.click(within(dialog).getByText('Done'))];
+                    case 5:
+                        _a.sent();
+                        expect(screen.queryByText('Please provide a comment for your action')).not.toBeInTheDocument();
+                        expect(runTaskAction).toHaveBeenCalledWith({
+                            workflowPath: workflowPath,
+                            environment: workflowEnvironmentUrl,
+                            tenant: tenant.id,
+                            taskId: task.taskId,
+                            action: task.possibleActions[0].action,
+                            processInstanceComment: comment
+                        });
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+    });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reltio/components",
-  "version": "1.4.2189",
+  "version": "1.4.2190",
   "license": "SEE LICENSE IN LICENSE FILE",
   "main": "./cjs/index.js",
   "module": "./index.js",