@ukhomeoffice/cop-react-form-renderer 3.6.2 → 3.8.0

package/dist/utils/Data/setupFormData.js

@@ -5,6 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
+var _dayjs = _interopRequireDefault(require("dayjs"));
+
 var _getSourceData = _interopRequireDefault(require("./getSourceData"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -15,6 +17,56 @@ 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; }
 
+var setDefaultDateValue = function setDefaultDateValue(date, data) {
+  if (date.defaultValue === 'today') {
+    data[date.fieldId] = (0, _dayjs.default)().format('DD-MM-YYYY');
+  } else {
+    data[date.fieldId] = date.defaultValue;
+  }
+};
+/** 
+ * This currently will not work for collections or containers.
+ * If support is required it will need to be added.
+ */
+
+
+var setupDefaultValue = function setupDefaultValue(component, data) {
+  if (component.defaultValue && !data[component.fieldId]) {
+    switch (component.type) {
+      case 'date':
+        setDefaultDateValue(component, data);
+        break;
+
+      default:
+        data[component.fieldId] = component.defaultValue;
+    }
+  }
+
+  if (component.defaultValue) {
+    // Some components will throw warnings when having 
+    // both a 'value' and 'defaultValue' prop set. 
+    // defaultValue is safe to delete once we've tried
+    // to use it.
+    delete component.defaultValue;
+  }
+};
+
+var setupDefaultValuesForComponents = function setupDefaultValuesForComponents(components, data) {
+  components.forEach(function (component) {
+    return setupDefaultValue(component, data);
+  });
+};
+
+var setupPageDefaultValues = function setupPageDefaultValues(pages, data) {
+  pages.forEach(function (page) {
+    page.components.filter(function (c) {
+      return !c.use;
+    }).forEach(function (component) {
+      return setupDefaultValue(component, data);
+    });
+  });
+};
+
 var setupComponentSourceData = function setupComponentSourceData(component, data) {
   if (component.source) {
     data[component.fieldId] = (0, _getSourceData.default)(data, component.source.field);
@@ -37,8 +89,11 @@ var setupPageSourceData = function setupPageSourceData(pages, data) {
   });
 };
 /**
- * This populates an object with data from source fields.
- * Note that this doesn't currently support sequenced dependencies:
+ * This populates an object with data either from a specified default
+ * value or from a source field. If both are specified, data from a
+ * source field will take priority.
+ * Note that in the case of source fields, this doesn't currently 
+ * support sequenced dependencies:
  *    0: fieldA: source.field = fieldB
  *    1: fieldB: source.field = fieldC
  *    2: fieldC: 'value'
@@ -54,6 +109,8 @@ var setupPageSourceData = function setupPageSourceData(pages, data) {
 var setupFormData = function setupFormData(pages, components, baseData) {
   var data = _objectSpread({}, baseData);
 
+  setupDefaultValuesForComponents(components, data);
+  setupPageDefaultValues(pages, data);
   setupSourceDataForComponents(components, data);
   setupPageSourceData(pages, data);
   return data;

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

@@ -211,6 +211,66 @@ describe('utils', function () {
           delegateEmails: _userProfileData.default.userDetails.delegateEmails
         }));
       });
+      it('should handle a default value field', function () {
+        var PAGES = [];
+        var COMPONENTS = [{
+          fieldId: 'testField',
+          type: 'text',
+          defaultValue: 'VALUE'
+        }];
+        var DATA = {};
+        var RESULT = (0, _setupFormData.default)(PAGES, COMPONENTS, DATA);
+        expect(RESULT).toEqual({
+          testField: 'VALUE'
+        });
+      });
+      it('should ignore a default value when a value already exists in data', function () {
+        var PAGES = [];
+        var COMPONENTS = [{
+          fieldId: 'testField',
+          type: 'text',
+          defaultValue: 'VALUE'
+        }];
+        var DATA = {
+          testField: 'EXISTING_VALUE'
+        };
+        var RESULT = (0, _setupFormData.default)(PAGES, COMPONENTS, DATA);
+        expect(RESULT).toEqual({
+          testField: 'EXISTING_VALUE'
+        });
+      });
+      it('should handle default values within pages', function () {
+        var PAGES = [{
+          components: [{
+            fieldId: 'pageField',
+            type: 'text',
+            defaultValue: 'VALUE'
+          }]
+        }];
+        var COMPONENTS = [];
+        var DATA = {};
+        var RESULT = (0, _setupFormData.default)(PAGES, COMPONENTS, DATA);
+        expect(RESULT).toEqual({
+          pageField: 'VALUE'
+        });
+      });
+      it('should ignore default values within pages when a value already exists in data', function () {
+        var PAGES = [{
+          components: [{
+            fieldId: 'pageField',
+            type: 'text',
+            defaultValue: 'VALUE'
+          }]
+        }];
+        var COMPONENTS = [];
+        var DATA = {
+          pageField: 'EXISTING_VALUE'
+        };
+        var RESULT = (0, _setupFormData.default)(PAGES, COMPONENTS, DATA);
+        expect(RESULT).toEqual({
+          pageField: 'EXISTING_VALUE'
+        });
+      });
     });
   });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ukhomeoffice/cop-react-form-renderer",
-  "version": "3.6.2",
+  "version": "3.8.0",
   "private": false,
   "scripts": {
     "clean": "rimraf dist",
@@ -17,7 +17,7 @@
   },
   "dependencies": {
     "@ukhomeoffice/cop-react-components": "1.9.5",
-    "axios": "^0.21.1",
+    "axios": "^0.23.0",
     "dayjs": "^1.11.0",
     "govuk-frontend": "^3.13.0",
     "web-vitals": "^1.0.1"