@ukhomeoffice/cop-react-form-renderer 5.0.0-alpha → 5.0.1

package/dist/utils/CheckYourAnswers/getCYARowsForCollectionPage.test.js

@@ -0,0 +1,414 @@
+"use strict";
+
+var _getCYARowsForCollectionPage = _interopRequireDefault(require("./getCYARowsForCollectionPage"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+describe('utils.CheckYourAnswers.getCYARowsForCollectionPage', function () {
+  var TEXT_COMP = {
+    id: 'testText',
+    fieldId: 'testText',
+    label: 'Test text',
+    type: 'text'
+  };
+  var DATE_COMP = {
+    id: 'testDate',
+    fieldId: 'testDate',
+    label: 'Test date',
+    type: 'date'
+  };
+  var PAGES = [{
+    id: 'page1',
+    collection: {
+      name: 'collection'
+    },
+    components: [TEXT_COMP]
+  }, {
+    id: 'page2',
+    collection: {
+      name: 'collection'
+    },
+    components: [DATE_COMP]
+  }];
+  var MASTER_PAGE = {
+    id: 'page1',
+    collection: {
+      name: 'collection',
+      labels: {
+        // eslint-disable-next-line no-template-curly-in-string
+        item: 'Collection entry ${index}'
+      },
+      actions: [{
+        type: 'change'
+      }, {
+        type: 'remove',
+        label: 'custom remove label'
+      }, {
+        type: 'change',
+        label: 'custom change label',
+        page: 'confirmDelete'
+      }]
+    },
+    collectionPages: PAGES
+  };
+  it('should return no rows for a collection if it does not exist in formData', function () {
+    var FORM_DATA = {};
+    var PAGE = _objectSpread(_objectSpread({}, MASTER_PAGE), {}, {
+      formData: FORM_DATA
+    });
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null);
+    expect(ROWS.length).toEqual(0);
+  });
+  it('should return no rows for a collection if it has no entries', function () {
+    var FORM_DATA = {
+      collection: []
+    };
+    var PAGE = _objectSpread(_objectSpread({}, MASTER_PAGE), {}, {
+      formData: FORM_DATA
+    });
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null);
+    expect(ROWS.length).toEqual(0);
+  });
+  it('should accept the hideNameFromCYA collection flag', function () {
+    var FORM_DATA = {
+      collection: [{
+        testText: 'hello'
+      }]
+    };
+    var PAGE = _objectSpread(_objectSpread({}, MASTER_PAGE), {}, {
+      formData: FORM_DATA,
+      collection: _objectSpread(_objectSpread({}, MASTER_PAGE.collection), {}, {
+        hideNameFromCYA: true
+      })
+    });
+    var TITLE_FIELD_ID = "".concat(PAGE.collection.name, "Title");
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null);
+    expect(ROWS[0].fieldId).not.toEqual(TITLE_FIELD_ID);
+  });
+  it('should format titles correctly when collection.labels.item is specified', function () {
+    var FORM_DATA = {
+      collection: [{
+        id: '01',
+        testText: 'value'
+      }]
+    };
+    var PAGE = _objectSpread(_objectSpread({}, MASTER_PAGE), {}, {
+      formData: FORM_DATA
+    });
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null);
+    expect(ROWS.length).toEqual(7); // Collection title, item title, action rows & component rows
+    expect(ROWS[1].key).toEqual('Collection entry 1');
+  });
+  it('should provide default titles if collection.labels.item is not specified', function () {
+    var FORM_DATA = {
+      collection: [{
+        id: '01',
+        testText: 'value'
+      }]
+    };
+    var PAGE = _objectSpread(_objectSpread({}, MASTER_PAGE), {}, {
+      collection: _objectSpread(_objectSpread({}, MASTER_PAGE.collection), {}, {
+        labels: {}
+      }),
+      formData: FORM_DATA
+    });
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null);
+    expect(ROWS.length).toEqual(7); // Collection title, item title, action rows & component rows
+    expect(ROWS[1].key).toEqual('Item 1');
+  });
+  it('should return correctly formatted rows for mutliple entries', function () {
+    var FORM_DATA = {
+      collection: [{
+        id: '01',
+        testText: 'value'
+      }, {
+        id: '02',
+        testText: 'value'
+      }]
+    };
+    var PAGE = _objectSpread(_objectSpread({}, MASTER_PAGE), {}, {
+      formData: FORM_DATA
+    });
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null);
+    expect(ROWS.length).toEqual(13); // Title row + component row for each item
+    expect(ROWS[0]).toMatchObject({
+      type: 'heading',
+      key: 'Collection'
+    });
+    expect(ROWS[1]).toMatchObject({
+      type: 'heading',
+      key: 'Collection entry 1'
+    });
+    expect(ROWS[2].action.label).toEqual('Change');
+    expect(ROWS[3].action.label).toEqual('custom remove label');
+    expect(ROWS[4].action.label).toEqual('custom change label');
+    expect(ROWS[5]).toMatchObject({
+      value: 'value',
+      key: 'Test text'
+    });
+    expect(ROWS[6]).toMatchObject({
+      value: '',
+      key: 'Test date'
+    });
+    expect(ROWS[7]).toMatchObject({
+      type: 'heading',
+      key: 'Collection entry 2'
+    });
+    expect(ROWS[8].action.label).toEqual('Change');
+    expect(ROWS[9].action.label).toEqual('custom remove label');
+    expect(ROWS[10].action.label).toEqual('custom change label');
+    expect(ROWS[11]).toMatchObject({
+      value: 'value',
+      key: 'Test text'
+    });
+    expect(ROWS[12]).toMatchObject({
+      value: '',
+      key: 'Test date'
+    });
+  });
+  it('should exclude components that should not be shown', function () {
+    var FD = {
+      collection: [{
+        id: '01',
+        otherField: 'yes',
+        testText: 'testing'
+      }, {
+        id: '02',
+        otherField: 'no',
+        testText: 'testing'
+      }]
+    };
+    var PAGE = _objectSpread(_objectSpread({}, MASTER_PAGE), {}, {
+      collection: {
+        name: 'collection'
+      },
+      formData: FD,
+      collectionPages: [_objectSpread(_objectSpread({}, PAGES[0]), {}, {
+        components: [{
+          id: 'testText',
+          fieldId: 'testText',
+          label: 'Test text',
+          type: 'text',
+          show_when: {
+            field: "otherField",
+            op: "!=",
+            value: "yes"
+          }
+        }]
+      })]
+    });
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null);
+    expect(ROWS.length).toEqual(4);
+    expect(ROWS[0]).toMatchObject({
+      type: 'heading',
+      key: 'Collection'
+    });
+    expect(ROWS[1]).toMatchObject({
+      type: 'heading',
+      key: 'Item 1'
+    });
+    expect(ROWS[2]).toMatchObject({
+      type: 'heading',
+      key: 'Item 2'
+    });
+    expect(ROWS[3]).toMatchObject({
+      value: 'testing',
+      key: 'Test text'
+    });
+  });
+  it('should exclude pages that should not be shown', function () {
+    var FD = {
+      collection: [{
+        id: '01',
+        otherField: 'yes',
+        testText: 'testing'
+      }]
+    };
+    var PAGE = _objectSpread(_objectSpread({}, MASTER_PAGE), {}, {
+      collection: {
+        name: 'collection'
+      },
+      formData: FD,
+      collectionPages: [_objectSpread(_objectSpread({}, PAGES[0]), {}, {
+        show_when: {
+          field: "otherField",
+          op: "!=",
+          value: "yes"
+        }
+      }), PAGES[1]]
+    });
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null);
+    expect(ROWS.length).toEqual(3); // Missing the page with the text component on.
+    expect(ROWS[0]).toMatchObject({
+      type: 'heading',
+      key: 'Collection'
+    });
+    expect(ROWS[1]).toMatchObject({
+      type: 'heading',
+      key: 'Item 1'
+    });
+    expect(ROWS[2]).toMatchObject({
+      value: '',
+      key: 'Test date'
+    });
+  });
+  it('should include rows for custom headings', function () {
+    var FORM_DATA = {
+      collection: [{
+        id: '01',
+        testText: 'value'
+      }]
+    };
+    var PAGE = _objectSpread(_objectSpread({}, MASTER_PAGE), {}, {
+      formData: FORM_DATA,
+      collectionPages: [_objectSpread(_objectSpread({}, PAGES[0]), {}, {
+        collection: _objectSpread(_objectSpread({}, PAGES[0].collection), {}, {
+          heading: {
+            size: 'm',
+            text: 'Custom page heading'
+          }
+        })
+      })]
+    });
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null);
+    expect(ROWS.length).toEqual(7);
+    expect(ROWS[0]).toMatchObject({
+      type: 'heading',
+      key: 'Collection'
+    });
+    expect(ROWS[1]).toMatchObject({
+      type: 'heading',
+      key: 'Collection entry 1'
+    });
+    expect(ROWS[2].action.label).toEqual('Change');
+    expect(ROWS[3].action.label).toEqual('custom remove label');
+    expect(ROWS[4].action.label).toEqual('custom change label');
+    expect(ROWS[5]).toMatchObject({
+      type: 'heading',
+      key: 'Custom page heading',
+      size: 'm'
+    });
+    expect(ROWS[6]).toMatchObject({
+      value: 'value',
+      key: 'Test text'
+    });
+  });
+  it('should default to a title size of small if one is not specified', function () {
+    var FORM_DATA = {
+      collection: [{
+        id: '01',
+        testText: 'value'
+      }]
+    };
+    var PAGE = _objectSpread(_objectSpread({}, MASTER_PAGE), {}, {
+      formData: FORM_DATA,
+      collectionPages: [_objectSpread(_objectSpread({}, PAGES[0]), {}, {
+        collection: _objectSpread(_objectSpread({}, PAGES[0].collection), {}, {
+          heading: {
+            text: 'Custom page heading'
+          }
+        })
+      })]
+    });
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null);
+    expect(ROWS[5]).toMatchObject({
+      type: 'heading',
+      key: 'Custom page heading',
+      size: 's'
+    });
+  });
+  it('should position actions under the title if actionPosition flag is not specified', function () {
+    var FORM_DATA = {
+      collection: [{
+        id: '01',
+        testText: 'value'
+      }]
+    };
+    var PAGE = _objectSpread(_objectSpread({}, MASTER_PAGE), {}, {
+      formData: FORM_DATA
+    });
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null);
+    expect(ROWS[2].action.label).toEqual('Change');
+    expect(ROWS[3].action.label).toEqual('custom remove label');
+    expect(ROWS[4].action.label).toEqual('custom change label');
+  });
+  it('should position actions under the title if actionPosition flag is top', function () {
+    var FORM_DATA = {
+      collection: [{
+        id: '01',
+        testText: 'value'
+      }]
+    };
+    var PAGE = _objectSpread(_objectSpread({}, MASTER_PAGE), {}, {
+      collection: _objectSpread(_objectSpread({}, MASTER_PAGE.collection), {}, {
+        actionPosition: 'top'
+      }),
+      formData: FORM_DATA
+    });
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null);
+    expect(ROWS[2].action.label).toEqual('Change');
+    expect(ROWS[3].action.label).toEqual('custom remove label');
+    expect(ROWS[4].action.label).toEqual('custom change label');
+  });
+  it('should position actions under all other rows if actionPosition flag is bottom', function () {
+    var FORM_DATA = {
+      collection: [{
+        id: '01',
+        testText: 'value'
+      }]
+    };
+    var PAGE = _objectSpread(_objectSpread({}, MASTER_PAGE), {}, {
+      collection: _objectSpread(_objectSpread({}, MASTER_PAGE.collection), {}, {
+        actionPosition: 'bottom'
+      }),
+      formData: FORM_DATA
+    });
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null);
+    expect(ROWS[ROWS.length - 3].action.label).toEqual('Change');
+    expect(ROWS[ROWS.length - 2].action.label).toEqual('custom remove label');
+    expect(ROWS[ROWS.length - 1].action.label).toEqual('custom change label');
+  });
+  it('should ignore the result of the override function if it returns nullish', function () {
+    var FORM_DATA = {
+      collection: [{
+        id: '01',
+        testText: 'value'
+      }]
+    };
+    var PAGE = _objectSpread(_objectSpread({}, MASTER_PAGE), {}, {
+      formData: FORM_DATA
+    });
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null, function () {
+      return null;
+    });
+    expect(ROWS.length).toEqual(7); // Collection title, item title, action rows & component rows
+    expect(ROWS[5].key).toEqual("Test text");
+  });
+  it('should use the rows produced by the override function if provided', function () {
+    var FORM_DATA = {
+      collection: [{
+        id: '01',
+        testText: 'value'
+      }]
+    };
+
+    // eslint-disable-next-line arrow-body-style
+    var OVERRIDE = function OVERRIDE(page, comp) {
+      // This will be called for each component on the page,
+      // returning a custom row object.
+      return {
+        key: "CustomRowFor".concat(comp.label)
+      };
+    };
+    var PAGE = _objectSpread(_objectSpread({}, MASTER_PAGE), {}, {
+      formData: FORM_DATA
+    });
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null, OVERRIDE);
+    expect(ROWS.length).toEqual(7); // Collection title, item title, action rows & component rows
+    expect(ROWS[5].key).toEqual("CustomRowFor".concat(TEXT_COMP.label));
+  });
+});

package/dist/utils/CheckYourAnswers/getCYARowsForContainer.js

@@ -5,30 +5,44 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _models = require("../../models");
+var _elevateNestedComponents = _interopRequireDefault(require("../Component/elevateNestedComponents"));
 var _getCYARow = _interopRequireDefault(require("./getCYARow"));
 var _getCYARowsForCollection = _interopRequireDefault(require("./getCYARowsForCollection"));
 var _showComponentCYA = _interopRequireDefault(require("./showComponentCYA"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
-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 getCYARowsForContainer = function getCYARowsForContainer(page, container, formData, onAction) {
-  if ((0, _showComponentCYA.default)(container, page.formData)) {
-    return container.components.filter(function (c) {
-      return (0, _showComponentCYA.default)(c, page.formData);
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+var getCYARowsForContainer = function getCYARowsForContainer(page, container, formData, onAction, fnOverride) {
+  if ((0, _showComponentCYA.default)(container, _objectSpread(_objectSpread({}, page.formData), formData))) {
+    var allComponents = (0, _elevateNestedComponents.default)(container.components, formData);
+    return allComponents.filter(function (c) {
+      return (0, _showComponentCYA.default)(c, _objectSpread(_objectSpread({}, page.formData), formData));
     }).flatMap(function (component) {
       var fd = formData ? formData[component.fieldId] : undefined;
+      if (typeof fnOverride === 'function') {
+        var overrideRows = fnOverride(_objectSpread(_objectSpread({}, page), {}, {
+          formData: formData
+        }), component, onAction);
+        if (overrideRows) {
+          return overrideRows;
+        }
+      }
       if (component.type === _models.ComponentTypes.CONTAINER) {
-        return getCYARowsForContainer(page, component, fd, onAction);
+        return getCYARowsForContainer(page, component, _objectSpread(_objectSpread({}, fd), formData), onAction, fnOverride);
       }
       if (component.type === _models.ComponentTypes.COLLECTION) {
-        return (0, _getCYARowsForCollection.default)(page, component, fd, onAction);
+        return (0, _getCYARowsForCollection.default)(page, component, fd, onAction, fnOverride);
       }
       return (0, _getCYARow.default)(_objectSpread(_objectSpread({}, page), {}, {
         formData: formData
       }), component, onAction);
     });
   }
+  return null;
 };
 var _default = getCYARowsForContainer;
 exports.default = _default;