@ukhomeoffice/cop-react-form-renderer 3.26.3 → 3.32.0

package/dist/utils/CollectionPage/getCollectionPageActiveIndex.test.js

@@ -0,0 +1,54 @@
+"use strict";
+
+var _getCollectionPageActiveIndex = _interopRequireDefault(require("./getCollectionPageActiveIndex"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+describe('utils.CollectionPage.getCollectionPageActiveIndex', function () {
+  it('should return the index of the active item in the collection, if one exists', function () {
+    var COLLECTION_NAME = 'test';
+    var ACTIVE_ID = '002';
+    var FORM_DATA = {
+      testActiveId: ACTIVE_ID,
+      test: [{
+        id: '001'
+      }, {
+        id: '002'
+      }]
+    };
+    var PAGE = {
+      collection: {
+        name: COLLECTION_NAME
+      },
+      formData: FORM_DATA
+    };
+    expect((0, _getCollectionPageActiveIndex.default)(PAGE.collection.name, PAGE.formData)).toEqual(1);
+  });
+  it('should return null if no active item can be found in the collection', function () {
+    var COLLECTION_NAME = 'test';
+    var ACTIVE_ID = '002';
+    var FORM_DATA = {
+      testActiveId: ACTIVE_ID,
+      test: [{
+        id: '001'
+      }]
+    };
+    var PAGE = {
+      collection: {
+        name: COLLECTION_NAME
+      },
+      formData: FORM_DATA
+    };
+    expect((0, _getCollectionPageActiveIndex.default)(PAGE.collection.name, PAGE.formData)).toEqual(null);
+  });
+  it('should return null if formData is null', function () {
+    var COLLECTION_NAME = 'test';
+    var PAGE = {
+      collection: {
+        name: COLLECTION_NAME
+      }
+    };
+    expect((0, _getCollectionPageActiveIndex.default)(PAGE.collection.name, null)).toEqual(null);
+  });
+});

package/dist/utils/CollectionPage/index.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _duplicateCollectionPageActiveEntry = _interopRequireDefault(require("./duplicateCollectionPageActiveEntry"));
+
+var _getCollectionPageActiveIndex = _interopRequireDefault(require("./getCollectionPageActiveIndex"));
+
+var _mergeCollectionPages = _interopRequireDefault(require("./mergeCollectionPages"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+var CollectionPage = {
+  duplicateActiveEntry: _duplicateCollectionPageActiveEntry.default,
+  getActiveIndex: _getCollectionPageActiveIndex.default,
+  mergePages: _mergeCollectionPages.default
+};
+var _default = CollectionPage;
+exports.default = _default;

package/dist/utils/CollectionPage/mergeCollectionPages.js

@@ -0,0 +1,69 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _showFormPageCYA = _interopRequireDefault(require("../FormPage/showFormPageCYA"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: 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 createMasterPage = function createMasterPage(page) {
+  return _objectSpread(_objectSpread({}, page), {}, {
+    title: page.collection.name.charAt(0).toUpperCase() + page.collection.name.slice(1)
+  });
+};
+
+var mergeIntoMasterPage = function mergeIntoMasterPage(page, masterPage) {
+  masterPage.collection = _objectSpread(_objectSpread({}, masterPage.collection), page.collection);
+  masterPage.components = [].concat(masterPage.components, page.components);
+  masterPage.formData = _objectSpread({}, page.formData);
+};
+/**
+ * Loop over an array of pages, merging any CollectionPages into a
+ * single master page for that collection. A master page is created
+ * for each unique collection.name that exists.
+ * These master pages contain all the fields needed to represent an
+ * entry in the collection. 
+ * The master page for each collection is positioned at the index
+ * of the first CollectionPage in that collection.
+ * @param { array } pages Array of pages in the form.
+ * @returns An array of the same pages, with a master page for each collection.
+ */
+
+
+var mergeCollectionPages = function mergeCollectionPages(pages) {
+  var masterPages = {};
+  return pages.map(function (page) {
+    var _page$collection;
+
+    if ((_page$collection = page.collection) !== null && _page$collection !== void 0 && _page$collection.name && (0, _showFormPageCYA.default)(page, page.formData)) {
+      if (!masterPages[page.collection.name]) {
+        // If no master page exists for this collection.name, then
+        // we kick one off using this page as a template.
+        masterPages[page.collection.name] = createMasterPage(page);
+        return masterPages[page.collection.name];
+      } else {
+        // If a master page already exists for this collection.name
+        // then we just merge this page into it and remove this page
+        // from the array.
+        mergeIntoMasterPage(page, masterPages[page.collection.name]);
+        return null;
+      }
+    }
+
+    return page;
+  }).filter(function (page) {
+    return !!page;
+  });
+};
+
+var _default = mergeCollectionPages;
+exports.default = _default;

package/dist/utils/CollectionPage/mergeCollectionPages.test.js

@@ -0,0 +1,131 @@
+"use strict";
+
+var _mergeCollectionPages = _interopRequireDefault(require("./mergeCollectionPages"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+describe('utils.CollectionPage.mergeCollectionPages', function () {
+  var TEXT_COMP = {
+    id: 'testText',
+    fieldId: 'testText',
+    type: 'text'
+  };
+  var DATE_COMP = {
+    id: 'testDate',
+    fieldId: 'testDate',
+    type: 'date'
+  };
+  it('should return the same array if no pages belong to collections', function () {
+    var PAGES = [{
+      id: 'page1'
+    }, {
+      id: 'page2'
+    }];
+    expect((0, _mergeCollectionPages.default)(PAGES)).toEqual(PAGES);
+  });
+  it('should merge pages from the same collection into a single page', function () {
+    var PAGES = [{
+      id: 'page1',
+      collection: {
+        name: 'collection'
+      },
+      components: [TEXT_COMP]
+    }, {
+      id: 'page2',
+      collection: {
+        name: 'collection'
+      },
+      components: [DATE_COMP]
+    }];
+    var RESULT = (0, _mergeCollectionPages.default)(PAGES);
+    expect(RESULT.length).toEqual(1);
+    expect(RESULT[0]).toEqual({
+      id: 'page1',
+      title: 'Collection',
+      collection: {
+        name: 'collection'
+      },
+      components: [TEXT_COMP, DATE_COMP],
+      formData: {}
+    });
+  });
+  it('should leave non-collection pages unaffected', function () {
+    var PAGES = [{
+      id: 'page1',
+      collection: {
+        name: 'collection'
+      },
+      components: [TEXT_COMP]
+    }, {
+      id: 'page2',
+      collection: {
+        name: 'collection'
+      },
+      components: [DATE_COMP]
+    }, {
+      id: 'page3'
+    }];
+    var RESULT = (0, _mergeCollectionPages.default)(PAGES);
+    expect(RESULT.length).toEqual(2);
+    expect(RESULT[0]).toEqual({
+      id: 'page1',
+      title: 'Collection',
+      collection: {
+        name: 'collection'
+      },
+      components: [TEXT_COMP, DATE_COMP],
+      formData: {}
+    });
+    expect(RESULT[1]).toEqual({
+      id: 'page3'
+    });
+  });
+  it('should handle multiple collections', function () {
+    var PAGES = [{
+      id: 'page1',
+      collection: {
+        name: 'collection1'
+      },
+      components: []
+    }, {
+      id: 'page2',
+      collection: {
+        name: 'collection1'
+      },
+      components: []
+    }, {
+      id: 'page3',
+      collection: {
+        name: 'collection2'
+      },
+      components: []
+    }, {
+      id: 'page4',
+      collection: {
+        name: 'collection2'
+      },
+      components: []
+    }];
+    var RESULT = (0, _mergeCollectionPages.default)(PAGES);
+    expect(RESULT.length).toEqual(2);
+    expect(RESULT[0]).toEqual({
+      id: 'page1',
+      collection: {
+        name: 'collection1'
+      },
+      title: 'Collection1',
+      components: [],
+      formData: {}
+    });
+    expect(RESULT[1]).toEqual({
+      id: 'page3',
+      collection: {
+        name: 'collection2'
+      },
+      title: 'Collection2',
+      components: [],
+      formData: {}
+    });
+  });
+});

package/dist/utils/Validate/validatePage.js

@@ -9,6 +9,8 @@ var _copReactComponents = require("@ukhomeoffice/cop-react-components");
 
 var _validateComponent = _interopRequireDefault(require("./validateComponent"));
 
+var _CollectionPage = _interopRequireDefault(require("../CollectionPage"));
+
 var _showFormPage = _interopRequireDefault(require("../FormPage/showFormPage"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -25,12 +27,24 @@ function _defineProperty(obj, key, value) { if (key in obj) { Object.definePrope
  * @returns An array containing all of the errors.
  */
 var validatePage = function validatePage(page) {
+  var data = page.formData;
+
+  if (page.collection) {
+    var activeIndex = _CollectionPage.default.getActiveIndex(page.collection.name, page.formData);
+
+    if (activeIndex !== null) {
+      var _page$formData$page$c;
+
+      data = (_page$formData$page$c = page.formData[page.collection.name]) === null || _page$formData$page$c === void 0 ? void 0 : _page$formData$page$c[activeIndex];
+    }
+  }
+
   if ((0, _showFormPage.default)(page, page.formData) && Array.isArray(page.components)) {
     var errs = page.components.reduce(function (errors, component) {
-      var componentErrors = (0, _validateComponent.default)(component, page.formData, page.formData);
+      var componentErrors = (0, _validateComponent.default)(component, data, data);
       return errors.concat(componentErrors).flat().map(function (err) {
         return !!err ? _objectSpread(_objectSpread({}, err), {}, {
-          error: _copReactComponents.Utils.interpolateString(err.error, page.formData)
+          error: _copReactComponents.Utils.interpolateString(err.error, data)
         }) : err;
       });
     }, []).filter(function (e) {