@ukhomeoffice/cop-react-form-renderer 0.1.0-beta → 1.0.0-delta

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

@@ -0,0 +1,77 @@
+"use strict";
+
+var _getRowActionAttributes = _interopRequireDefault(require("./getRowActionAttributes"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+describe('components', function () {
+  describe('SummaryList', function () {
+    describe('helpers', function () {
+      describe('getRowActionAttributes', function () {
+        it('should handle a null row', function () {
+          expect((0, _getRowActionAttributes.default)(null)).toEqual({});
+        });
+        it('should handle a row without an action', function () {
+          expect((0, _getRowActionAttributes.default)({})).toEqual({});
+        });
+        it('should handle a row with an empty action', function () {
+          var ROW = {
+            action: {}
+          };
+          expect((0, _getRowActionAttributes.default)(ROW)).toEqual({});
+        });
+        it('should handle a row with an href', function () {
+          var HREF = 'http://alpha.homeoffice.gov.uk';
+          var ROW = {
+            action: {
+              href: HREF
+            }
+          };
+          expect((0, _getRowActionAttributes.default)(ROW)).toEqual({
+            href: HREF
+          });
+        });
+        it('should handle a row with an onAction function', function () {
+          var ON_ACTION_CALLS = [];
+
+          var ON_ACTION = function ON_ACTION(row) {
+            ON_ACTION_CALLS.push(row);
+          };
+
+          var ROW = {
+            action: {
+              onAction: ON_ACTION
+            }
+          };
+          var ATTRS = (0, _getRowActionAttributes.default)(ROW);
+          expect(ATTRS.onClick).toBeDefined();
+          expect(ATTRS.href).not.toBeDefined();
+          ATTRS.onClick();
+          expect(ON_ACTION_CALLS.length).toEqual(1);
+          expect(ON_ACTION_CALLS[0]).toEqual(ROW);
+        });
+        it('should favour onAction over href', function () {
+          var ON_ACTION_CALLS = [];
+
+          var ON_ACTION = function ON_ACTION(row) {
+            ON_ACTION_CALLS.push(row);
+          };
+
+          var HREF = 'http://alpha.homeoffice.gov.uk';
+          var ROW = {
+            action: {
+              href: HREF,
+              onAction: ON_ACTION
+            }
+          };
+          var ATTRS = (0, _getRowActionAttributes.default)(ROW);
+          expect(ATTRS.onClick).toBeDefined();
+          expect(ATTRS.href).not.toBeDefined();
+          ATTRS.onClick();
+          expect(ON_ACTION_CALLS.length).toEqual(1);
+          expect(ON_ACTION_CALLS[0]).toEqual(ROW);
+        });
+      });
+    });
+  });
+});

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

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "getRowActionAttributes", {
+  enumerable: true,
+  get: function get() {
+    return _getRowActionAttributes.default;
+  }
+});
+
+var _getRowActionAttributes = _interopRequireDefault(require("./getRowActionAttributes"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

package/dist/components/index.js

@@ -9,6 +9,12 @@ Object.defineProperty(exports, "CheckYourAnswers", {
     return _CheckYourAnswers.default;
   }
 });
+Object.defineProperty(exports, "FormComponent", {
+  enumerable: true,
+  get: function get() {
+    return _FormComponent.default;
+  }
+});
 Object.defineProperty(exports, "FormPage", {
   enumerable: true,
   get: function get() {
@@ -24,6 +30,8 @@ Object.defineProperty(exports, "FormRenderer", {
 
 var _CheckYourAnswers = _interopRequireDefault(require("./CheckYourAnswers"));
 
+var _FormComponent = _interopRequireDefault(require("./FormComponent"));
+
 var _FormPage = _interopRequireDefault(require("./FormPage"));
 
 var _FormRenderer = _interopRequireDefault(require("./FormRenderer"));

package/dist/hooks/useGetRequest.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = exports.STATUS_IDLE = exports.STATUS_FETCHING = exports.STATUS_FETCHED = exports.STATUS_ERROR = void 0;
+exports.default = exports.clear = exports.STATUS_IDLE = exports.STATUS_FETCHING = exports.STATUS_FETCHED = exports.STATUS_ERROR = void 0;
 
 var _axios = _interopRequireDefault(require("axios"));
 
@@ -29,8 +29,23 @@ function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Sy
 
 function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
 
+// Caches for responses and errors.
 var cache = {};
 var errorCache = {};
+
+var clearCache = function clearCache(cacheObject) {
+  var keys = Object.keys(cacheObject);
+  keys.forEach(function (key) {
+    delete cacheObject[key];
+  });
+};
+
+var clear = function clear() {
+  clearCache(cache);
+  clearCache(errorCache);
+};
+
+exports.clear = clear;
 var STATUS_IDLE = 'idle';
 exports.STATUS_IDLE = STATUS_IDLE;
 var STATUS_FETCHING = 'fetching';

package/dist/hooks/useHooks.js

@@ -3,17 +3,28 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.resetHooks = exports.removeHook = exports.default = exports.addHook = void 0;
-var ALLOWED_HOOKS = ['onRequest'];
+exports.resetHooks = exports.removeHook = exports.default = exports.addHook = exports.ALLOWED_HOOKS = void 0;
+var ALLOWED_HOOKS = ['onRequest', 'onFormComplete', 'onFormLoad', 'onPageChange', 'onSubmit'];
+exports.ALLOWED_HOOKS = ALLOWED_HOOKS;
 var DEFAULT_HOOKS = {
+  onFormComplete: function onFormComplete() {},
+  onFormLoad: function onFormLoad() {},
+  onPageChange: function onPageChange(pageId) {
+    return pageId;
+  },
   onRequest: function onRequest(req) {
     return req;
+  },
+  onSubmit: function onSubmit(type, payload, onSuccess, onError) {
+    if (typeof onSuccess === 'function') onSuccess();
   }
 };
 var hooks = {
-  onRequest: function onRequest(req) {
-    return req;
-  }
+  onFormComplete: DEFAULT_HOOKS.onFormComplete,
+  onFormLoad: DEFAULT_HOOKS.onFormLoad,
+  onPageChange: DEFAULT_HOOKS.onPageChange,
+  onRequest: DEFAULT_HOOKS.onRequest,
+  onSubmit: DEFAULT_HOOKS.onSubmit
 };
 
 var addHook = function addHook(name, hook) {

package/dist/index.js

@@ -41,7 +41,9 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 
 // Local imports
 var intercepts = {
-  add: _useHooks.addHook
+  add: _useHooks.addHook,
+  remove: _useHooks.removeHook,
+  reset: _useHooks.resetHooks
 };
 exports.intercepts = intercepts;
 var _default = _FormRenderer.default;

package/dist/models/EventTypes.js

@@ -0,0 +1,14 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var TYPE_BLUR = 'blur';
+var TYPE_SUBMIT = 'submit';
+var EventTypes = {
+  BLUR: TYPE_BLUR,
+  SUBMIT: TYPE_SUBMIT
+};
+var _default = EventTypes;
+exports.default = _default;

package/dist/models/FormPages.js

@@ -0,0 +1,14 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var PAGE_CYA = 'cya';
+var PAGE_HUB = 'hub';
+var FormPages = {
+  CYA: PAGE_CYA,
+  HUB: PAGE_HUB
+};
+var _default = FormPages;
+exports.default = _default;

package/dist/models/PageAction.js

@@ -0,0 +1,40 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.PageActionTypes = exports.DefaultPageActions = void 0;
+
+var _DefaultPageActions;
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+var TYPE_SUBMIT = 'submit';
+var TYPE_SAVE_AND_CONTINUE = 'saveAndContinue';
+var TYPE_SAVE_AND_RETURN = 'saveAndReturn';
+var PageActionTypes = {
+  SUBMIT: TYPE_SUBMIT,
+  SAVE_AND_CONTINUE: TYPE_SAVE_AND_CONTINUE,
+  SAVE_AND_RETURN: TYPE_SAVE_AND_RETURN
+};
+exports.PageActionTypes = PageActionTypes;
+var DefaultPageActions = (_DefaultPageActions = {}, _defineProperty(_DefaultPageActions, TYPE_SUBMIT, {
+  type: TYPE_SUBMIT,
+  validate: true
+}), _defineProperty(_DefaultPageActions, TYPE_SAVE_AND_CONTINUE, {
+  type: TYPE_SAVE_AND_CONTINUE,
+  validate: true,
+  label: 'Save and continue'
+}), _defineProperty(_DefaultPageActions, TYPE_SAVE_AND_RETURN, {
+  type: TYPE_SAVE_AND_RETURN,
+  validate: false,
+  label: 'Save and return later',
+  classModifiers: 'secondary'
+}), _DefaultPageActions);
+exports.DefaultPageActions = DefaultPageActions;
+var PageAction = {
+  TYPES: PageActionTypes,
+  DEFAULTS: DefaultPageActions
+};
+var _default = PageAction;
+exports.default = _default;

package/dist/models/index.js

@@ -9,6 +9,18 @@ Object.defineProperty(exports, "ComponentTypes", {
     return _ComponentTypes.default;
   }
 });
+Object.defineProperty(exports, "EventTypes", {
+  enumerable: true,
+  get: function get() {
+    return _EventTypes.default;
+  }
+});
+Object.defineProperty(exports, "FormPages", {
+  enumerable: true,
+  get: function get() {
+    return _FormPages.default;
+  }
+});
 Object.defineProperty(exports, "FormTypes", {
   enumerable: true,
   get: function get() {
@@ -21,11 +33,23 @@ Object.defineProperty(exports, "HubFormats", {
     return _HubFormats.default;
   }
 });
+Object.defineProperty(exports, "PageAction", {
+  enumerable: true,
+  get: function get() {
+    return _PageAction.default;
+  }
+});
 
 var _ComponentTypes = _interopRequireDefault(require("./ComponentTypes"));
 
+var _EventTypes = _interopRequireDefault(require("./EventTypes"));
+
+var _FormPages = _interopRequireDefault(require("./FormPages"));
+
 var _FormTypes = _interopRequireDefault(require("./FormTypes"));
 
 var _HubFormats = _interopRequireDefault(require("./HubFormats"));
 
+var _PageAction = _interopRequireDefault(require("./PageAction"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

package/dist/utils/CheckYourAnswers/getCYAAction.js

@@ -5,6 +5,15 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
+/**
+ * Gets an action object, configured appropriately for a Check your answers component.
+ * 
+ * @param {boolean} readonly Whether or not the component is readonly.
+ * @param {object} cya_link A configuration object for any link to show.
+ * @param {Function} onAction A function to invoke if the link is clicked.
+ * 
+ * @returns An action object for a Check your answers row.
+ */
 var getCYAAction = function getCYAAction(readonly, cya_link, onAction) {
   if (readonly !== true && cya_link) {
     return {

package/dist/utils/CheckYourAnswers/getCYARow.js

@@ -12,6 +12,16 @@ var _getCYAAction = _interopRequireDefault(require("./getCYAAction"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 // Local imports
+
+/**
+ * Gets a row object, configured appropriately for a Check your answers component.
+ * 
+ * @param {object} page The page to which this component row belongs.
+ * @param {object} component The component to render on this row.
+ * @param {Function} onAction A function to invoke if the change link is clicked.
+ * 
+ * @returns A configuration object for a Check your answers row.
+ */
 var getCYARow = function getCYARow(page, component, onAction) {
   return {
     pageId: page.id,

package/dist/utils/CheckYourAnswers/getCYARowsForPage.js

@@ -12,6 +12,15 @@ var _showComponentCYA = _interopRequireDefault(require("./showComponentCYA"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 // Local imports
+
+/**
+ * Gets an array of row objects, each configured appropriately for a Check your answers component.
+ * 
+ * @param {object} page The page to show components for.
+ * @param {Function} onAction A function to invoke if the change link on any row is clicked.
+ * 
+ * @returns An array of configuration objects for Check your answers rows.
+ */
 var getCYARowsForPage = function getCYARowsForPage(page, onAction) {
   return page.components.filter(function (c) {
     return (0, _showComponentCYA.default)(c, page.formData);

package/dist/utils/CheckYourAnswers/showComponentCYA.js

@@ -5,20 +5,21 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
-var _Component = _interopRequireDefault(require("../Component"));
-
 var _models = require("../../models");
 
+var _Component = _interopRequireDefault(require("../Component"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 // Local imports
 var EXCLUDE_FROM_CYA = [_models.ComponentTypes.HEADING, _models.ComponentTypes.HTML, _models.ComponentTypes.INSET_TEXT];
 /**
- * Determines whether a given component should display on the
- * Check your answers page.
+ * Determines whether a given component should display on the Check your answers screen.
+ * 
  * @param {object} options The component options.
  * @param {object} data The data contained on the form.
- * @returns A boolean true, if the component should show; otherwise false.
+ * 
+ * @returns A boolean true if the component should show; otherwise false.
  */
 
 var showComponentCYA = function showComponentCYA(options, data) {

package/dist/utils/Component/getComponent.js

@@ -102,10 +102,10 @@ var getComponentByType = function getComponentByType(config) {
 };
 
 var getComponent = function getComponent(config) {
-  var noWrap = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
+  var wrap = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
   var component = getComponentByType(config);
 
-  if (component && !noWrap && (0, _isEditable.default)(config)) {
+  if (component && wrap && (0, _isEditable.default)(config)) {
     var attrs = (0, _cleanAttributes.default)(config, ['fieldId', 'displayMenu']);
     return (0, _wrapInFormGroup.default)(attrs, component);
   }

package/dist/utils/Component/getComponent.test.js

@@ -75,7 +75,7 @@ describe('utils', function () {
 
         var heading = (0, _react.getByTestId)(container, ID);
         expect(heading.innerHTML).toContain(CONTENT);
-        expect(heading.tagName).toEqual('H3');
+        expect(heading.tagName).toEqual('H2');
         expect(heading.classList).toContain("govuk-heading-".concat(SIZE));
       });
       it('should return an appropriately rendered inset-text component', function () {

package/dist/utils/Data/setupFormData.js

@@ -44,9 +44,9 @@ var setupPageSourceData = function setupPageSourceData(pages, data) {
  *    2: fieldC: 'value'
  * In the above example, fieldA will not get a value as fieldB isn't
  * set until after fieldA is processed.
- * @param {*} pages 
- * @param {*} components 
- * @param {*} baseData 
+ * @param {Array} pages 
+ * @param {Array} components 
+ * @param {object} baseData 
  * @returns 
  */
 

package/dist/utils/Data/setupFormData.test.js

@@ -203,12 +203,12 @@ describe('utils', function () {
         // and data calculated for the fields, based on that source data.
 
         expect(RESULT).toEqual(_objectSpread(_objectSpread({}, _userProfileData.default), {}, {
-          firstName: _userProfileData.default.keycloakContext.givenName,
-          surname: _userProfileData.default.keycloakContext.familyName,
-          team: _userProfileData.default.staffDetailsDataContext.defaultteam,
-          staffGradeId: _userProfileData.default.staffDetailsDataContext.gradeid,
-          linemanagerEmail: _userProfileData.default.extendedStaffDetailsContext.linemanagerEmail,
-          delegateEmails: _userProfileData.default.extendedStaffDetailsContext.delegateEmails
+          firstName: _userProfileData.default.currentUser.givenName,
+          surname: _userProfileData.default.currentUser.familyName,
+          team: _userProfileData.default.userDetails.defaultteam,
+          staffGradeId: _userProfileData.default.userDetails.gradeid,
+          linemanagerEmail: _userProfileData.default.userDetails.linemanagerEmail,
+          delegateEmails: _userProfileData.default.userDetails.delegateEmails
         }));
       });
     });

package/dist/utils/Data/setupRefDataUrlForComponent.test.js

@@ -9,7 +9,7 @@ describe('utils', function () {
   describe('Data', function () {
     describe('setupRefDataUrlForComponent', function () {
       var DATA = {
-        environmentContext: {
+        urls: {
           refData: '/ref-data'
         }
       };
@@ -39,13 +39,13 @@ describe('utils', function () {
           id: 'component',
           // eslint-disable-next-line no-template-curly-in-string
           data: {
-            url: '${environmentContext.refData}/v1/teams'
+            url: '${urls.refData}/v1/teams'
           }
         };
         expect((0, _setupRefDataUrlForComponent.default)(COMPONENT, DATA)).toEqual({
           id: COMPONENT.id,
           data: {
-            url: "".concat(DATA.environmentContext.refData, "/v1/teams")
+            url: "".concat(DATA.urls.refData, "/v1/teams")
           }
         });
       });
@@ -68,7 +68,7 @@ describe('utils', function () {
           id: 'component',
           // eslint-disable-next-line no-template-curly-in-string
           data: {
-            url: '${environmentContext.referenceData}/v1/teams'
+            url: '${urls.referenceData}/v1/teams'
           }
         };
         expect((0, _setupRefDataUrlForComponent.default)(COMPONENT, DATA)).toEqual({

package/dist/utils/FormPage/getFormPage.js

@@ -19,7 +19,18 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
+/**
+ * Converts a page object defined in the JSON to a page object for rendering.
+ * @param {object} pageOptions The JSON page.
+ * @param {Array} formComponents The components defined at the top-level of the form.
+ * @param {object} formData The top-level form data, used for setting up components.
+ * @returns A page object for rendering.
+ */
 var getFormPage = function getFormPage(pageOptions, formComponents, formData) {
+  if (!pageOptions) {
+    return null;
+  }
+
   var components = pageOptions.components.map(function (componentOptions) {
     if (typeof componentOptions === 'string') {
       return (0, _getParagraphFromText.default)(componentOptions);
@@ -33,7 +44,7 @@ var getFormPage = function getFormPage(pageOptions, formComponents, formData) {
       ret = _objectSpread({}, componentOptions);
     }
 
-    return formData && formData.environmentContext ? _Data.default.refData.setupUrl(ret, formData) : ret;
+    return formData && formData.urls ? _Data.default.refData.setupUrl(ret, formData) : ret;
   });
   return _objectSpread(_objectSpread({}, pageOptions), {}, {
     formData: formData,