@ukhomeoffice/cop-react-form-renderer 3.15.0 → 3.17.0

package/dist/components/FormPage/FormPage.js

@@ -104,7 +104,9 @@ var FormPage = function FormPage(_ref) {
       formData: _objectSpread(_objectSpread({}, page.formData), patch)
     });
   }), /*#__PURE__*/_react.default.createElement(_PageActions.default, {
-    actions: page.actions,
+    actions: page.actions.filter(function (action) {
+      return _utils.default.Component.show(action, page.formData);
+    }),
     onAction: function onAction(action) {
       return _onAction(action, patch);
     }

package/dist/components/FormPage/FormPage.test.js

@@ -92,6 +92,44 @@ describe('components.FormPage', function () {
         }
       }
     };
+    var PAGE_WITH_CONDITIONAL_BUTTONS = {
+      id: 'pageId',
+      // eslint-disable-next-line no-template-curly-in-string
+      title: '${title}',
+      components: [TEXT_WITH_EXPRESSION, AUTO_WITH_EXPRESSION],
+      actions: [{
+        type: 'submit',
+        validate: true,
+        label: 'Button 1',
+        show_when: [{
+          field: 'currentUser.givenName',
+          op: '!=',
+          value: 'Doe'
+        }]
+      }, {
+        type: 'submit',
+        validate: false,
+        label: 'Button 2',
+        show_when: [{
+          field: 'currentUser.givenName',
+          op: '=',
+          value: 'Doe'
+        }]
+      }],
+      formData: {
+        title: 'Order Form',
+        text1: "Text1 ".concat(VALUE),
+        text2: "Text2 ".concat(VALUE),
+        wrapper: {
+          email: 'test@example.email',
+          nextAction: 'Payment',
+          prevAction: 'User Details'
+        },
+        currentUser: {
+          givenName: 'Doe'
+        }
+      }
+    };
     var ON_ACTION_CALLS = [];
 
     var checkInputField = function checkInputField(formGroup, fieldId, lbl, hnt, val) {
@@ -305,5 +343,26 @@ describe('components.FormPage', function () {
         }
       }, _callee4);
     })));
+    it('should render only the conditionally shown button', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee5() {
+      var _renderWithValidation5, container, page;
+
+      return regeneratorRuntime.wrap(function _callee5$(_context5) {
+        while (1) {
+          switch (_context5.prev = _context5.next) {
+            case 0:
+              _renderWithValidation5 = (0, _setupTests.renderWithValidation)( /*#__PURE__*/_react2.default.createElement(_FormPage.default, {
+                page: PAGE_WITH_CONDITIONAL_BUTTONS,
+                onAction: ON_ACTION
+              })), container = _renderWithValidation5.container;
+              page = container.childNodes[0];
+              checkFormButtonGroup(page.childNodes[3], ['Button 2']); // Just the second button shown
+
+            case 3:
+            case "end":
+              return _context5.stop();
+          }
+        }
+      }, _callee5);
+    })));
   });
 });

package/dist/components/FormRenderer/FormRenderer.js

@@ -437,7 +437,7 @@ FormRenderer.propTypes = InternalFormRenderer.propTypes = {
   title: _propTypes.default.string,
 
   /** See <a href="/?path=/docs/f-json--page#formtypes">FormTypes</a>. */
-  type: _propTypes.default.oneOf([_models.FormTypes.CYA, _models.FormTypes.FORM, _models.FormTypes.HUB, _models.FormTypes.TASK, _models.FormTypes.WIZARD, _models.FormTypes.TASKCYA]).isRequired,
+  type: _propTypes.default.oneOf([_models.FormTypes.CYA, _models.FormTypes.FORM, _models.FormTypes.HUB, _models.FormTypes.TASK, _models.FormTypes.WIZARD, _models.FormTypes.TASK_CYA, _models.FormTypes.FORM_WITH_TASK]).isRequired,
   components: _propTypes.default.arrayOf(_propTypes.default.object).isRequired,
   pages: _propTypes.default.arrayOf(_propTypes.default.object).isRequired,
   hub: _propTypes.default.object,

package/dist/components/FormRenderer/helpers/getSubmissionStatus.js

@@ -12,7 +12,7 @@ var _getNextPageId = _interopRequireDefault(require("./getNextPageId"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 var getSubmissionStatus = function getSubmissionStatus(formType, pages, currentPageId, action, formData, currentTask, isCompleted) {
-  if (formType === _models.FormTypes.TASK) {
+  if (formType === _models.FormTypes.TASK || formType === _models.FormTypes.FORM_WITH_TASK) {
     var formStatus = formData.formStatus || {};
     formStatus.tasks = formStatus.tasks || {};
     formStatus.tasks[currentTask.name] = formStatus.tasks[currentTask.name] || {};

package/dist/components/FormRenderer/helpers/getSubmissionStatus.test.js

@@ -103,7 +103,7 @@ describe('components', function () {
         });
         describe("when the action type is '".concat(_models.PageAction.TYPES.SAVE_AND_RETURN, "'"), function () {
           Object.values(_models.FormTypes).forEach(function (formType) {
-            if (formType !== _models.FormTypes.TASK) {
+            if (formType !== _models.FormTypes.TASK && formType !== _models.FormTypes.FORM_WITH_TASK) {
               it("should return the current page if the form type is '".concat(formType, "'"), function () {
                 var ACTION = _models.PageAction.DEFAULTS.saveAndReturn;
                 expect((0, _getSubmissionStatus.default)(formType, PAGES, PAGES[0].id, ACTION, FORM_DATA)).toMatchObject({

package/dist/models/FormTypes.js

@@ -4,19 +4,21 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var TYPE_FORM = 'form';
 var TYPE_CHECK_YOUR_ANSWERS = 'cya';
+var TYPE_FORM = 'form';
+var TYPE_FORM_WITH_TASK_LIST = 'form-with-task-list';
 var TYPE_HUB_AND_SPOKE = 'hub-and-spoke';
 var TYPE_TASK_LIST = 'task-list';
-var TYPE_WIZARD = 'wizard';
 var TYPE_TASK_LIST_CYA = 'task-list-cya';
+var TYPE_WIZARD = 'wizard';
 var FormTypes = {
-  FORM: TYPE_FORM,
   CYA: TYPE_CHECK_YOUR_ANSWERS,
+  FORM: TYPE_FORM,
+  FORM_WITH_TASK: TYPE_FORM_WITH_TASK_LIST,
   HUB: TYPE_HUB_AND_SPOKE,
   TASK: TYPE_TASK_LIST,
-  WIZARD: TYPE_WIZARD,
-  TASKCYA: TYPE_TASK_LIST_CYA
+  TASK_CYA: TYPE_TASK_LIST_CYA,
+  WIZARD: TYPE_WIZARD
 };
 var _default = FormTypes;
 exports.default = _default;

package/dist/utils/Hub/getFormHub.js

@@ -37,7 +37,7 @@ var getFormHub = function getFormHub(type, hub, components, formData) {
     }
   }
 
-  if (type === _models.FormTypes.TASK) {
+  if (type === _models.FormTypes.TASK || type === _models.FormTypes.FORM_WITH_TASK) {
     return _models.HubFormats.TASK;
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ukhomeoffice/cop-react-form-renderer",
-  "version": "3.15.0",
+  "version": "3.17.0",
   "private": false,
   "scripts": {
     "clean": "rimraf dist",