@ukhomeoffice/cop-react-form-renderer 1.0.0 → 2.2.0

package/dist/components/SummaryList/SummaryList.test.js

@@ -54,6 +54,23 @@ describe('components', function () {
       return [key, value, actions];
     };
 
+    var checkRowNoChangeActions = function checkRowNoChangeActions(summaryList, index) {
+      var row = summaryList.childNodes[index];
+      expect(row.tagName).toEqual('DIV');
+      expect(row.classList).toContain("".concat(_SummaryList.DEFAULT_CLASS, "__row"));
+
+      var _row$childNodes2 = _slicedToArray(row.childNodes, 2),
+          key = _row$childNodes2[0],
+          value = _row$childNodes2[1];
+
+      expect(key.tagName).toEqual('DT');
+      expect(key.classList).toContain("".concat(_SummaryList.DEFAULT_CLASS, "__key"));
+      expect(value.tagName).toEqual('DD');
+      expect(value.classList).toContain("".concat(_SummaryList.DEFAULT_CLASS, "__value"));
+      expect(row.childNodes.length).toEqual(2);
+      return [key, value];
+    };
+
     it('should handle an empty rows array', function () {
       var ID = 'test-id';
       var ROWS = [];
@@ -193,5 +210,42 @@ describe('components', function () {
         expect(ON_ACTION_CALLS[index]).toEqual(row);
       });
     });
+    it('should handle rows with component values and actions set to hidden', function () {
+      var ID = 'test-id';
+      var VALUES = ['Alpha component value', 'Bravo component value'];
+      var ROWS = [{
+        pageId: 'p1',
+        fieldId: 'a',
+        key: 'Alpha',
+        value: /*#__PURE__*/_react2.default.createElement("div", null, VALUES[0])
+      }, {
+        pageId: 'p2',
+        fieldId: 'b',
+        key: 'Bravo',
+        value: /*#__PURE__*/_react2.default.createElement("div", null, VALUES[1])
+      }];
+
+      var _render5 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_SummaryList.default, {
+        "data-testid": ID,
+        rows: ROWS,
+        noChangeAction: true
+      })),
+          container = _render5.container;
+
+      var summaryList = checkSummaryList(container, ID);
+      expect(summaryList.childNodes.length).toEqual(ROWS.length);
+      ROWS.forEach(function (row, index) {
+        var _checkRowNoChangeActi = checkRowNoChangeActions(summaryList, index),
+            _checkRowNoChangeActi2 = _slicedToArray(_checkRowNoChangeActi, 2),
+            key = _checkRowNoChangeActi2[0],
+            value = _checkRowNoChangeActi2[1];
+
+        expect(key.textContent).toEqual(row.key);
+        expect(value.childNodes.length).toEqual(1);
+        var valueDiv = value.childNodes[0];
+        expect(valueDiv.tagName).toEqual('DIV');
+        expect(valueDiv.textContent).toEqual(VALUES[index]);
+      });
+    });
   });
 });

package/dist/components/SummaryList/helpers/getRowActionAttributes.js

@@ -13,9 +13,9 @@ var getRowActionAttributes = function getRowActionAttributes(row) {
           return row.action.onAction(row);
         }
       };
-    } else {
+    } else if (row.action.page) {
       return {
-        href: row.action.href
+        href: "/".concat(row.action.page)
       };
     }
   }

package/dist/components/SummaryList/helpers/getRowActionAttributes.test.js

@@ -20,15 +20,15 @@ describe('components', function () {
           };
           expect((0, _getRowActionAttributes.default)(ROW)).toEqual({});
         });
-        it('should handle a row with an href', function () {
-          var HREF = 'http://alpha.homeoffice.gov.uk';
+        it('should handle a row with a page', function () {
+          var PAGE = 'alpha';
           var ROW = {
             action: {
-              href: HREF
+              page: PAGE
             }
           };
           expect((0, _getRowActionAttributes.default)(ROW)).toEqual({
-            href: HREF
+            href: "/".concat(PAGE)
           });
         });
         it('should handle a row with an onAction function', function () {

package/dist/hooks/useHooks.js

@@ -4,11 +4,14 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.resetHooks = exports.removeHook = exports.default = exports.addHook = exports.ALLOWED_HOOKS = void 0;
-var ALLOWED_HOOKS = ['onRequest', 'onFormComplete', 'onFormLoad', 'onPageChange', 'onSubmit'];
+var ALLOWED_HOOKS = ['onFormComplete', 'onFormLoad', 'onGetComponent', 'onPageChange', 'onRequest', 'onSubmit'];
 exports.ALLOWED_HOOKS = ALLOWED_HOOKS;
 var DEFAULT_HOOKS = {
   onFormComplete: function onFormComplete() {},
   onFormLoad: function onFormLoad() {},
+  onGetComponent: function onGetComponent(config, wrap) {
+    return null;
+  },
   onPageChange: function onPageChange(pageId) {
     return pageId;
   },
@@ -22,6 +25,7 @@ var DEFAULT_HOOKS = {
 var hooks = {
   onFormComplete: DEFAULT_HOOKS.onFormComplete,
   onFormLoad: DEFAULT_HOOKS.onFormLoad,
+  onGetComponent: DEFAULT_HOOKS.onGetComponent,
   onPageChange: DEFAULT_HOOKS.onPageChange,
   onRequest: DEFAULT_HOOKS.onRequest,
   onSubmit: DEFAULT_HOOKS.onSubmit

package/dist/index.js

@@ -21,6 +21,12 @@ Object.defineProperty(exports, "HubFormats", {
     return _models.HubFormats;
   }
 });
+Object.defineProperty(exports, "SummaryList", {
+  enumerable: true,
+  get: function get() {
+    return _SummaryList.default;
+  }
+});
 Object.defineProperty(exports, "Utils", {
   enumerable: true,
   get: function get() {
@@ -31,6 +37,8 @@ exports.intercepts = exports.default = void 0;
 
 var _FormRenderer = _interopRequireDefault(require("./components/FormRenderer"));
 
+var _SummaryList = _interopRequireDefault(require("./components/SummaryList"));
+
 var _useHooks = require("./hooks/useHooks");
 
 var _models = require("./models");

package/dist/json/areYouACivilServant.json

@@ -0,0 +1,7 @@
+{
+  "data": [
+    { "id": "yes", "name": "Yes" },
+    { "id": "no-contractor", "name": "No, I'm a contractor" },
+    { "id": "no-agency", "name": "No, I'm agency staff" }
+  ]
+}

package/dist/json/firstForm.json

@@ -0,0 +1,94 @@
+{
+  "id": "firstForm",
+  "version": "1",
+  "name": "firstForm",
+  "title": "First form",
+  "type": "cya",
+  "components": [
+    {
+      "id": "firstName",
+      "fieldId": "firstName",
+      "label": "First name",
+      "type": "text",
+      "required": true
+    },
+    {
+      "id": "surname",
+      "fieldId": "surname",
+      "label": "Last name",
+      "type": "text",
+      "required": true
+    },
+    {
+      "id": "age",
+      "fieldId": "age",
+      "label": "Your age",
+      "type": "text",
+      "required": true
+    }
+  ],
+  "pages": [
+    {
+      "id": "before",
+      "name": "before",
+      "title": "Before you start",
+      "components": [
+        "This is a sample form to prove out the mechanism for save and continue.",
+        "When you click on the Start button, a new business key should be generated for this form.",
+        {
+          "type": "inset-text",
+          "content": "Generating a business key is non-reversible and cancelling the form creation will leave a gap."
+        },
+        "If you are happy to proceed, click start now."
+      ],
+      "actions": [
+        { "type": "navigate", "page": "firstName", "start": true, "label": "Start now" }
+      ],
+      "show_on_cya": false
+    },
+    {
+      "id": "firstName",
+      "name": "firstName",
+      "title": "Enter first name",
+      "components": [
+        { "use": "firstName", "label": "" }
+      ],
+      "actions": [ "saveAndContinue", "saveAndReturn" ],
+      "cya_link": {
+        "page": "firstName",
+        "aria_suffix": "your first name"
+      }
+    },
+    {
+      "id": "surname",
+      "name": "surname",
+      "title": "Enter surname",
+      "components": [
+        { "use": "surname", "label": "" }
+      ],
+      "actions": [ "saveAndContinue", "saveAndReturn" ],
+      "cya_link": {
+        "page": "surname",
+        "aria_suffix": "your surname"
+      }
+    },
+    {
+      "id": "age",
+      "name": "age",
+      "title": "Enter age",
+      "components": [
+        { "use": "age", "label": "" }
+      ],
+      "actions": [ "saveAndContinue", "saveAndReturn" ],
+      "cya_link": {
+        "page": "age",
+        "aria_suffix": "your first name"
+      }
+    }
+  ],
+  "cya": {
+    "actions": [
+      { "type": "submit", "label": "Submit", "validate": true }
+    ]
+  }
+}

package/dist/json/grade.json

@@ -0,0 +1,108 @@
+{
+  "data": [
+    {
+      "id": "373979c1-2360-46be-b712-0409ac068059",
+      "name": "SCS4",
+      "parentgradetypeid": null,
+      "validfrom": "2019-01-01T00:01:00.000Z",
+      "validto": null,
+      "updatedby": null
+    },
+    {
+      "id": "36c80dfe-0aae-455b-9445-2e1c09dcafdc",
+      "name": "SCS3",
+      "parentgradetypeid": "373979c1-2360-46be-b712-0409ac068059",
+      "validfrom": "2019-01-01T00:01:00.000Z",
+      "validto": null,
+      "updatedby": null
+    },
+    {
+      "id": "1b041cda-b151-4769-b76a-d42d67b0b960",
+      "name": "Senior Director / SCS2",
+      "parentgradetypeid": "36c80dfe-0aae-455b-9445-2e1c09dcafdc",
+      "validfrom": "2019-01-01T00:01:00.000Z",
+      "validto": null,
+      "updatedby": null
+    },
+    {
+      "id": "172de41d-f7b0-4be9-b7e8-0cf4f1a1342f",
+      "name": "Director / SCS1",
+      "parentgradetypeid": "1b041cda-b151-4769-b76a-d42d67b0b960",
+      "validfrom": "2019-01-01T00:01:00.000Z",
+      "validto": null,
+      "updatedby": null
+    },
+    {
+      "id": "39e18b45-0358-4a45-83ec-5a70b74641e8",
+      "name": "Deputy Director / Grade 6",
+      "parentgradetypeid": "172de41d-f7b0-4be9-b7e8-0cf4f1a1342f",
+      "validfrom": "2019-01-01T00:01:00.000Z",
+      "validto": null,
+      "updatedby": null
+    },
+    {
+      "id": "44855085-a36b-42e5-b805-f4ebe209ecf2",
+      "name": "Assistant Director / Grade 7",
+      "parentgradetypeid": "39e18b45-0358-4a45-83ec-5a70b74641e8",
+      "validfrom": "2019-01-01T00:01:00.000Z",
+      "validto": null,
+      "updatedby": null
+    },
+    {
+      "id": "4fad1115-7d12-4b6f-8d8a-97dbe469a346",
+      "name": "Senior Officer / Senior Executive Officer",
+      "parentgradetypeid": "44855085-a36b-42e5-b805-f4ebe209ecf2",
+      "validfrom": "2019-01-01T00:01:00.000Z",
+      "validto": null,
+      "updatedby": null
+    },
+    {
+      "id": "b512288d-95e3-4f60-ad4c-4cdfab68d841",
+      "name": "Higher Officer / Higher Executive Officer",
+      "parentgradetypeid": "4fad1115-7d12-4b6f-8d8a-97dbe469a346",
+      "validfrom": "2019-01-01T00:01:00.000Z",
+      "validto": null,
+      "updatedby": null
+    },
+    {
+      "id": "1c140011-46ad-4a5d-af25-e80a6fcdcdba",
+      "name": "Officer / Executive Officer",
+      "parentgradetypeid": "b512288d-95e3-4f60-ad4c-4cdfab68d841",
+      "validfrom": "2019-01-01T00:01:00.000Z",
+      "validto": null,
+      "updatedby": null
+    },
+    {
+      "id": "02de92d8-aad1-4663-a37f-a87012f60f1b",
+      "name": "Assistant Officer / Administrative Officer",
+      "parentgradetypeid": "1c140011-46ad-4a5d-af25-e80a6fcdcdba",
+      "validfrom": "2019-01-01T00:01:00.000Z",
+      "validto": null,
+      "updatedby": null
+    },
+    {
+      "id": "9910a29d-7fbb-451d-8729-f39f4373bbcc",
+      "name": "Assistant Office / Messenger",
+      "parentgradetypeid": "02de92d8-aad1-4663-a37f-a87012f60f1b",
+      "validfrom": "2019-01-01T00:01:00.000Z",
+      "validto": null,
+      "updatedby": null
+    },
+    {
+      "id": "073b92f8-7208-4026-a090-906c276079f1",
+      "name": "Contractor",
+      "parentgradetypeid": null,
+      "validfrom": "2019-01-01T00:01:00.000Z",
+      "validto": null,
+      "updatedby": null
+    },
+    {
+      "id": "c27cf914-0b97-4c4e-bb2d-2ae4b886baa5",
+      "name": "Agency Staff",
+      "parentgradetypeid": null,
+      "validfrom": "2019-01-01T00:01:00.000Z",
+      "validto": null,
+      "updatedby": null
+    }
+  ]
+}

package/dist/json/saveAndContinue.json

@@ -0,0 +1,98 @@
+{
+  "id": "saveAndContinue",
+  "version": "1",
+  "name": "saveAndContinue",
+  "title": "Save and continue example",
+  "type": "hub-and-spoke",
+  "components": [
+    {
+      "id": "firstName",
+      "fieldId": "firstName",
+      "label": "First name",
+      "type": "text",
+      "required": true
+    },
+    {
+      "id": "surname",
+      "fieldId": "surname",
+      "label": "Last name",
+      "type": "text",
+      "required": true
+    },
+    {
+      "id": "email",
+      "fieldId": "email",
+      "label": "Your email address",
+      "type": "email",
+      "required": true
+    },
+    {
+      "id": "location",
+      "fieldId": "location",
+      "label": "Incident location",
+      "type": "text",
+      "required": true
+    },
+    {
+      "id": "when",
+      "fieldId": "when",
+      "label": "Incident date and start time",
+      "type": "text",
+      "required": true
+    },
+    {
+      "id": "seizedItems",
+      "fieldId": "seizedItems",
+      "type": "collection",
+      "required": true,
+      "components": [
+        { "use": "type" },
+        { "use": "description" },
+        {
+          "id": "status",
+          "fieldId": "status",
+          "label": "What is the seized status of this item?",
+          "type": "radios",
+          "required": true
+        }
+      ],
+      "_description": "Required means at least 1 item"
+    }
+  ],
+  "pages": [
+    {
+      "id": "details",
+      "name": "details",
+      "title": "Your details",
+      "components": [
+        { "use": "firstName" },
+        { "use": "surname" },
+        { "use": "email" }
+      ],
+      "actions": [
+        { "type": "saveDraft", "validate": true, "label": "Save and continue" },
+        { "type": "saveAndReturn", "validate": true, "label": "Save and return later", "classModifiers": "secondary" }
+      ],
+      "cya_link": {
+        "page": "details",
+        "aria_suffix": "your details"
+      }
+    },
+    {
+      "id": "where-and-when",
+      "name": "where-and-when",
+      "title": "Where and when",
+      "components": [
+        { "use": "location" },
+        { "use": "when" }
+      ],
+      "actions": ["submit"],
+      "cya_link": {
+        "page": "where-and-when",
+        "aria_suffix": "where and when"
+      }
+    }
+  ],
+  "hub": { "format": "CYA" },
+  "cya": {}
+}