@ukhomeoffice/cop-react-form-renderer 1.0.0-gamma → 2.1.0

package/dist/components/FormRenderer/FormRenderer.stories.mdx

@@ -1,14 +1,23 @@
 <!-- Global imports -->
+
 import { ArgsTable, Canvas, Meta, Story } from '@storybook/addon-docs';
-import { Button, Details, Heading, Link, Panel } from '@ukhomeoffice/cop-react-components';
+import {
+  Button,
+  Details,
+  Heading,
+  Link,
+  Panel,
+} from '@ukhomeoffice/cop-react-components';
 import { useState } from 'react';
 import withMock from 'storybook-addon-mock';
 
 <!-- Local imports -->
+
 import { addHook } from '../../hooks/useHooks';
 import FormRenderer from './FormRenderer';
 
 <!-- JSON documents -->
+
 import CIVIL_SERVANT from '../../json/areYouACivilServant.json';
 import FIRST_FORM from '../../json/firstForm.json';
 import GRADE from '../../json/grade.json';
@@ -16,52 +25,60 @@ import TEAMS from '../../json/team.json';
 import USER_PROFILE_DATA from '../../json/userProfile.data.json';
 import USER_PROFILE from '../../json/userProfile.json';
 
-<Meta title="Components/Form renderer" id="D-FormRenderer" component={ FormRenderer } decorators={[withMock]} />
+<Meta
+  title='Components/Form renderer'
+  id='D-FormRenderer'
+  component={FormRenderer}
+  decorators={[withMock]}
+/>
 
-<Heading size="xl" caption="Components">Form renderer</Heading>
+<Heading size='xl' caption='Components'>
+  Form renderer
+</Heading>
 
 Renders a form with <Link href="https://ukhomeoffice.github.io/cop-react-components/?path=/docs/d-alert--default-story">COP React components</Link>,
 on the basis of a <Link href="/?path=/docs/f-json-form">JSON</Link> that describes which elements are required.
 
 <Canvas withToolbar>
-  <Story name="Default" parameters={{
-    mockData: [
-      {
-        url: `${USER_PROFILE_DATA.urls.refData}/areYouACivilServant`,
-        method: 'GET',
-        status: 200,
-        response: CIVIL_SERVANT
-      },
-      {
-        url: `${USER_PROFILE_DATA.urls.refData}/grade`,
-        method: 'GET',
-        status: 200,
-        response: GRADE
-      },
-      {
-        url: `${USER_PROFILE_DATA.urls.refData}/team`,
-        method: 'GET',
-        status: 200,
-        response: TEAMS
-      }
-    ]
-  }}>
+  <Story
+    name='Default'
+    parameters={{
+      mockData: [
+        {
+          url: `${USER_PROFILE_DATA.urls.refData}/areYouACivilServant`,
+          method: 'GET',
+          status: 200,
+          response: CIVIL_SERVANT,
+        },
+        {
+          url: `${USER_PROFILE_DATA.urls.refData}/grade`,
+          method: 'GET',
+          status: 200,
+          response: GRADE,
+        },
+        {
+          url: `${USER_PROFILE_DATA.urls.refData}/team`,
+          method: 'GET',
+          status: 200,
+          response: TEAMS,
+        },
+      ],
+    }}
+  >
     {() => {
-      return (
-        <FormRenderer {...USER_PROFILE} data={USER_PROFILE_DATA} />
-      );
+      return <FormRenderer {...USER_PROFILE} data={USER_PROFILE_DATA} />;
     }}
   </Story>
 </Canvas>
 
-<Details summary="Properties" className="no-indent">
-  <ArgsTable of={ FormRenderer } />
+<Details summary='Properties' className='no-indent'>
+  <ArgsTable of={FormRenderer} />
 </Details>
 
 ## CYA type
 
 <Canvas>
-  <Story name="CYA">
+  <Story name='CYA'>
     {() => {
       const [complete, setComplete] = useState(false);
       const [returnLater, setReturnLater] = useState(false);
@@ -82,7 +99,12 @@ on the basis of a <Link href="/?path=/docs/f-json-form">JSON</Link> that describ
         setReturnLater(!!pageId === false);
       });
       addHook('onSubmit', (type, payload, onSuccess, onError) => {
-        console.log('onSubmit called of type', type, 'called, with the payload', payload);
+        console.log(
+          'onSubmit called of type',
+          type,
+          'called, with the payload',
+          payload
+        );
         onSuccess();
       });
       const reset = () => {
@@ -91,25 +113,69 @@ on the basis of a <Link href="/?path=/docs/f-json-form">JSON</Link> that describ
       };
       return (
         <>
-        {!complete && !returnLater && <FormRenderer {...FIRST_FORM} data={{}} />}
-        {complete &&
-          <div>
-            <Panel title="Submission successful">
-              Your submission was successful.
-            </Panel>
-            <Button onClick={() => reset()}>Start again</Button>
-          </div>
-        }
-        {!complete && returnLater &&
-          <div>
-            <Panel title="Saved to return later">
-              You clicked on "Save and return later".
-            </Panel>
-            <Button onClick={() => reset()}>Start again</Button>
-          </div>
-        }
+          {!complete && !returnLater && (
+            <FormRenderer {...FIRST_FORM} data={{}} />
+          )}
+          {complete && (
+            <div>
+              <Panel title='Submission successful'>
+                Your submission was successful.
+              </Panel>
+              <Button onClick={() => reset()}>Start again</Button>
+            </div>
+          )}
+          {!complete && returnLater && (
+            <div>
+              <Panel title='Saved to return later'>
+                You clicked on "Save and return later".
+              </Panel>
+              <Button onClick={() => reset()}>Start again</Button>
+            </div>
+          )}
         </>
       );
     }}
   </Story>
 </Canvas>
+
+## Read-only style
+
+<Canvas>
+  <Story
+    name='Read-only style'
+    parameters={{
+      mockData: [
+        {
+          url: `${USER_PROFILE_DATA.urls.refData}/areYouACivilServant`,
+          method: 'GET',
+          status: 200,
+          response: CIVIL_SERVANT,
+        },
+        {
+          url: `${USER_PROFILE_DATA.urls.refData}/grade`,
+          method: 'GET',
+          status: 200,
+          response: GRADE,
+        },
+        {
+          url: `${USER_PROFILE_DATA.urls.refData}/team`,
+          method: 'GET',
+          status: 200,
+          response: TEAMS,
+        },
+      ],
+    }}
+  >
+    {() => {
+      return (
+        <FormRenderer
+          {...USER_PROFILE}
+          data={USER_PROFILE_DATA}
+          summaryListClassModifiers='no-border'
+          hide_title={true}
+          noChangeAction={true}
+        />
+      );
+    }}
+  </Story>
+</Canvas>

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

@@ -467,5 +467,45 @@ describe('components', function () {
         }
       }, _callee12);
     })));
+    it('should show no title when hide_title is set to true', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee14() {
+      var form, hub;
+      return regeneratorRuntime.wrap(function _callee14$(_context14) {
+        while (1) {
+          switch (_context14.prev = _context14.next) {
+            case 0:
+              _context14.next = 2;
+              return (0, _testUtils.act)( /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee13() {
+                return regeneratorRuntime.wrap(function _callee13$(_context13) {
+                  while (1) {
+                    switch (_context13.prev = _context13.next) {
+                      case 0:
+                        (0, _reactDom.render)( /*#__PURE__*/_react2.default.createElement(_FormRenderer.default, _extends({}, _userProfile.default, {
+                          data: _userProfileData.default,
+                          hide_title: true
+                        })), container);
+
+                      case 1:
+                      case "end":
+                        return _context13.stop();
+                    }
+                  }
+                }, _callee13);
+              })));
+
+            case 2:
+              form = checkForm(container);
+              expect(form.childNodes.length).toEqual(1); //Hub page (= CYA)
+
+              hub = form.childNodes[0];
+              expect(hub.tagName).toEqual('DIV');
+              expect(hub.classList).toContain(_CheckYourAnswers.DEFAULT_CLASS);
+
+            case 7:
+            case "end":
+              return _context14.stop();
+          }
+        }
+      }, _callee14);
+    })));
   });
 });

package/dist/components/FormRenderer/handlers/getPageId.js

@@ -12,16 +12,7 @@ exports.default = void 0;
  * @returns A page id.
  */
 var getPageId = function getPageId(action, pageId) {
-  if (action) {
-    // TODO: Improve how this is handled.
-    if (action.href) {
-      return action.href.split('/').pop();
-    } else if (action.url) {
-      return action.url.split('/').pop();
-    }
-  }
-
-  return pageId;
+  return (action === null || action === void 0 ? void 0 : action.page) || pageId;
 };
 
 var _default = getPageId;

package/dist/components/FormRenderer/handlers/getPageId.test.js

@@ -14,46 +14,20 @@ describe('components', function () {
           var ACTION = null;
           expect((0, _getPageId.default)(ACTION, PAGE_ID)).toEqual(PAGE_ID);
         });
-        it('should return the pageId when the action contains no href or url', function () {
+        it('should return the pageId when the action contains no page', function () {
           var PAGE_ID = 'alpha';
           var ACTION = {
             id: 'bravo'
           };
           expect((0, _getPageId.default)(ACTION, PAGE_ID)).toEqual(PAGE_ID);
         });
-        it('should return the final part of the href when provided', function () {
-          var LAST_PART = 'delta';
-          var HREF = "/bravo/charlie/".concat(LAST_PART);
+        it('should return the page when provided', function () {
+          var NAVIGATE_TO = 'delta';
           var PAGE_ID = 'alpha';
           var ACTION = {
-            href: HREF
+            page: NAVIGATE_TO
           };
-          expect((0, _getPageId.default)(ACTION, PAGE_ID)).toEqual(LAST_PART);
-        });
-        it('should return the final part of the url when provided', function () {
-          var LAST_PART = 'delta';
-          var URL = "/bravo/charlie/".concat(LAST_PART);
-          var PAGE_ID = 'alpha';
-          var ACTION = {
-            url: URL
-          };
-          expect((0, _getPageId.default)(ACTION, PAGE_ID)).toEqual(LAST_PART);
-        });
-        it('should return the whole href when it contains no backslashes', function () {
-          var HREF = 'delta';
-          var PAGE_ID = 'alpha';
-          var ACTION = {
-            href: HREF
-          };
-          expect((0, _getPageId.default)(ACTION, PAGE_ID)).toEqual(HREF);
-        });
-        it('should return the whole url when it contains no backslashes', function () {
-          var URL = 'delta';
-          var PAGE_ID = 'alpha';
-          var ACTION = {
-            url: URL
-          };
-          expect((0, _getPageId.default)(ACTION, PAGE_ID)).toEqual(URL);
+          expect((0, _getPageId.default)(ACTION, PAGE_ID)).toEqual(NAVIGATE_TO);
         });
       });
     });

package/dist/components/FormRenderer/handlers/handlers.test.js

@@ -46,7 +46,7 @@ describe('components', function () {
         it('should not call the onNavigate method when the page is unchanged', function () {
           var CURRENT_PAGE_ID = 'alpha';
           var ACTION = {
-            href: "/".concat(CURRENT_PAGE_ID)
+            page: CURRENT_PAGE_ID
           };
           var ON_NAVIGATE_CALLS = [];
 
@@ -62,7 +62,7 @@ describe('components', function () {
           var CURRENT_PAGE_ID = 'alpha';
           var NEW_PAGE_ID = 'bravo';
           var ACTION = {
-            href: "/".concat(NEW_PAGE_ID)
+            page: NEW_PAGE_ID
           };
           var ON_NAVIGATE_CALLS = [];
 

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

@@ -7,57 +7,64 @@ exports.default = void 0;
 
 var _models = require("../../../models");
 
+var _FormPage = _interopRequireDefault(require("../../../utils/FormPage"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
 var getNextHubPageId = function getNextHubPageId(action) {
-  if ((action === null || action === void 0 ? void 0 : action.type) === _models.PageAction.TYPES.SAVE_AND_RETURN) {
-    return _models.FormPages.HUB;
-  }
+  return (action === null || action === void 0 ? void 0 : action.page) || _models.FormPages.HUB;
+};
 
-  return (action === null || action === void 0 ? void 0 : action.nextPageId) || _models.FormPages.HUB;
+var getNextCYAPageId = function getNextCYAPageId(pages, currentPageId, formData) {
+  return getNextWizardPageId(pages, currentPageId, formData) || _models.FormPages.CYA;
 };
 
-var getNextCYAPageId = function getNextCYAPageId(pages, currentPageId, action) {
-  if ((action === null || action === void 0 ? void 0 : action.type) === _models.PageAction.TYPES.SAVE_AND_RETURN) {
-    return undefined;
-  }
+var getNextWizardPageId = function getNextWizardPageId(pages, currentPageId, formData) {
+  var _page;
 
   var nextIndex = pages.findIndex(function (p) {
     return p.id === currentPageId;
   }) + 1;
-  return nextIndex < pages.length ? pages[nextIndex].id : _models.FormPages.CYA;
-};
+  var page = pages[nextIndex];
 
-var getNextWizardPageId = function getNextWizardPageId(pages, currentPageId, action) {
-  if ((action === null || action === void 0 ? void 0 : action.type) === _models.PageAction.TYPES.SAVE_AND_RETURN) {
-    return undefined;
+  while (page && !_FormPage.default.show(page, formData)) {
+    nextIndex++;
+    page = pages[nextIndex];
   }
 
-  var nextIndex = pages.findIndex(function (p) {
-    return p.id === currentPageId;
-  }) + 1;
-  return nextIndex < pages.length ? pages[nextIndex].id : undefined;
+  return ((_page = page) === null || _page === void 0 ? void 0 : _page.id) || undefined;
 };
 
-var getNextFormPageId = function getNextFormPageId(pages, action) {
-  if ((action === null || action === void 0 ? void 0 : action.type) === _models.PageAction.TYPES.SAVE_AND_RETURN) {
-    return undefined;
-  }
-
+var getNextFormPageId = function getNextFormPageId(pages) {
+  // A form has a single page... so always return that id.
   return pages.length > 0 ? pages[0].id : undefined;
 };
 
-var getNextPageId = function getNextPageId(formType, pages, currentPageId, action) {
+var getNextPageId = function getNextPageId(formType, pages, currentPageId, action, formData) {
+  if (action) {
+    if (action.type === _models.PageAction.TYPES.NAVIGATE) {
+      return pages.find(function (p) {
+        return p.id === action.page;
+      }) ? action.page : undefined;
+    }
+
+    if (action.type === _models.PageAction.TYPES.SAVE_AND_RETURN) {
+      return formType === _models.FormTypes.HUB ? _models.FormPages.HUB : undefined;
+    }
+  }
+
   switch (formType) {
     case _models.FormTypes.HUB:
       return getNextHubPageId(action);
 
     case _models.FormTypes.CYA:
-      return getNextCYAPageId(pages, currentPageId, action);
+      return getNextCYAPageId(pages, currentPageId, formData);
 
     case _models.FormTypes.WIZARD:
-      return getNextWizardPageId(pages, currentPageId, action);
+      return getNextWizardPageId(pages, currentPageId, formData);
 
     default:
-      return getNextFormPageId(pages, action);
+      return getNextFormPageId(pages);
   }
 };
 

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

@@ -11,11 +11,87 @@ describe('components', function () {
   describe('FormRenderer', function () {
     describe('helpers', function () {
       describe('getNextPageId', function () {
+        var OPTIONS = [{
+          value: 'romeo',
+          label: 'Romeo'
+        }, {
+          value: 'juliet',
+          label: 'Juliet'
+        }];
+        var RADIOS = {
+          id: 'radios',
+          fieldId: 'radios',
+          type: _models.ComponentTypes.RADIOS,
+          data: {
+            options: OPTIONS
+          }
+        };
+        var TEXT = {
+          id: 'text',
+          fieldId: 'text',
+          type: _models.ComponentTypes.TEXT
+        };
+        var HTML = {
+          type: _models.ComponentTypes.HTML,
+          content: 'HTML'
+        };
+        var SHOW_WHEN_JULIET = {
+          field: RADIOS.fieldId,
+          op: '=',
+          value: OPTIONS[1].value
+        };
+        var SHOW_WHEN_ROMEO = {
+          field: RADIOS.fieldId,
+          op: '=',
+          value: OPTIONS[0].value
+        };
+        var FORM_DATA = {
+          radios: OPTIONS[0].value
+        }; // 'romeo'
+
         var PAGES = [{
           id: 'alpha'
         }, {
           id: 'bravo'
+        }, {
+          id: 'charlie',
+          components: [RADIOS]
+        }, {
+          id: 'delta',
+          components: [TEXT],
+          show_when: SHOW_WHEN_JULIET
+        }, {
+          id: 'echo',
+          components: [HTML]
+        }, {
+          id: 'foxtrot',
+          components: [TEXT],
+          show_when: SHOW_WHEN_ROMEO
         }];
+        describe("when the action type is '".concat(_models.PageAction.TYPES.NAVIGATE, "'"), function () {
+          it('should return undefined if the action has no page property', function () {
+            var ACTION = {
+              type: _models.PageAction.TYPES.NAVIGATE
+            };
+            expect((0, _getNextPageId.default)(_models.FormTypes.HUB, PAGES, PAGES[0].id, ACTION, FORM_DATA)).toBeUndefined();
+          });
+          it('should return the page on the action if it exists among the pages', function () {
+            var PAGE = PAGES[1].id;
+            var ACTION = {
+              type: _models.PageAction.TYPES.NAVIGATE,
+              page: PAGE
+            };
+            expect((0, _getNextPageId.default)(_models.FormTypes.HUB, PAGES, PAGES[0].id, ACTION, FORM_DATA)).toEqual(PAGE);
+          });
+          it('should return undefined if the page on the action does not exist among the pages', function () {
+            var PAGE = 'golf';
+            var ACTION = {
+              type: _models.PageAction.TYPES.NAVIGATE,
+              page: PAGE
+            };
+            expect((0, _getNextPageId.default)(_models.FormTypes.HUB, PAGES, PAGES[0].id, ACTION, FORM_DATA)).toBeUndefined();
+          });
+        });
         describe("when the form type is '".concat(_models.FormTypes.HUB, "'"), function () {
           var FORM_TYPE = _models.FormTypes.HUB;
           it("should return '".concat(_models.FormPages.HUB, "' by default"), function () {
@@ -23,13 +99,13 @@ describe('components', function () {
           });
           it("should return '".concat(_models.FormPages.HUB, "' if the action is '").concat(_models.PageAction.TYPES.SAVE_AND_RETURN, "'"), function () {
             var ACTION = _models.PageAction.DEFAULTS.saveAndReturn;
-            expect((0, _getNextPageId.default)(FORM_TYPE, PAGES, PAGES[0].id, ACTION)).toEqual(_models.FormPages.HUB);
+            expect((0, _getNextPageId.default)(FORM_TYPE, PAGES, PAGES[0].id, ACTION, FORM_DATA)).toEqual(_models.FormPages.HUB);
           });
-          it('should return action.nextPageId if specified', function () {
+          it('should return action.page if specified', function () {
             var ACTION = {
-              nextPageId: 'bob'
+              page: 'bob'
             };
-            expect((0, _getNextPageId.default)(FORM_TYPE, PAGES, undefined, ACTION)).toEqual(ACTION.nextPageId);
+            expect((0, _getNextPageId.default)(FORM_TYPE, PAGES, undefined, ACTION, FORM_DATA)).toEqual(ACTION.page);
           });
         });
         describe("when the form type is '".concat(_models.FormTypes.CYA, "'"), function () {
@@ -40,12 +116,18 @@ describe('components', function () {
           it('should return the second page when on the first page', function () {
             expect((0, _getNextPageId.default)(FORM_TYPE, PAGES, PAGES[0].id)).toEqual(PAGES[1].id);
           });
-          it("should return '".concat(_models.FormPages.CYA, "' when on the last page"), function () {
-            expect((0, _getNextPageId.default)(FORM_TYPE, PAGES, PAGES[PAGES.length - 1].id)).toEqual(_models.FormPages.CYA);
+          it('should return the third page when on the second page', function () {
+            expect((0, _getNextPageId.default)(FORM_TYPE, PAGES, PAGES[1].id)).toEqual(PAGES[2].id);
+          });
+          it("should return the fifth page when on the third page because the fourth page show_when is not met", function () {
+            expect((0, _getNextPageId.default)(FORM_TYPE, PAGES, PAGES[2].id, _models.PageAction.DEFAULTS.saveAndContinue, FORM_DATA)).toEqual(PAGES[4].id);
+          });
+          it("should return the sixth page when on the fifth page because the sixth page show_when is met", function () {
+            expect((0, _getNextPageId.default)(FORM_TYPE, PAGES, PAGES[4].id, _models.PageAction.DEFAULTS.saveAndContinue, FORM_DATA)).toEqual(PAGES[5].id);
           });
           it("should return undefined if the action is '".concat(_models.PageAction.TYPES.SAVE_AND_RETURN, "'"), function () {
             var ACTION = _models.PageAction.DEFAULTS.saveAndReturn;
-            expect((0, _getNextPageId.default)(FORM_TYPE, PAGES, PAGES[0].id, ACTION)).toBeUndefined();
+            expect((0, _getNextPageId.default)(FORM_TYPE, PAGES, PAGES[0].id, ACTION, FORM_DATA)).toBeUndefined();
           });
         });
         describe("when the form type is '".concat(_models.FormTypes.WIZARD, "'"), function () {

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

@@ -0,0 +1,27 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _models = require("../../../models");
+
+var _getNextPageId = _interopRequireDefault(require("./getNextPageId"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+var getSubmissionStatus = function getSubmissionStatus(formType, pages, currentPageId, action, formData) {
+  if ((action === null || action === void 0 ? void 0 : action.type) === _models.PageAction.TYPES.SAVE_AND_RETURN) {
+    return {
+      page: currentPageId
+    };
+  }
+
+  return {
+    page: (0, _getNextPageId.default)(formType, pages, currentPageId, action, formData)
+  };
+};
+
+var _default = getSubmissionStatus;
+exports.default = _default;