@ukhomeoffice/cop-react-form-renderer 4.0.2 → 4.4.0

package/dist/components/CollectionPage/CollectionPage.js

@@ -115,7 +115,7 @@ var CollectionPage = function CollectionPage(_ref) {
 
   return /*#__PURE__*/_react.default.createElement(_FormPage.default, {
     page: _objectSpread(_objectSpread({}, page), {}, {
-      formData: _objectSpread(_objectSpread({}, page.formData), data[activeIndex])
+      formData: _objectSpread(_objectSpread(_objectSpread({}, page.formData), data[activeIndex]), {}, _defineProperty({}, "".concat(page.collection.name, "ActiveIndex"), activeIndex))
     }),
     onAction: onInnerPageAction,
     onWrapperChange: onInnerPageChange,

package/dist/components/FormComponent/FormComponent.js

@@ -148,6 +148,7 @@ var FormComponent = function FormComponent(_ref) {
   return _utils.default.Component.get(_objectSpread(_objectSpread(_objectSpread(_objectSpread({}, attrs), component), {}, {
     id: component.full_path || component.id
   }, (0, _helpers.getComponentError)(component, validation === null || validation === void 0 ? void 0 : validation.errors)), {}, {
+    disabled: (0, _helpers.getComponentDisabled)(component.disabled, formData),
     label: _utils.default.interpolateString(component.label, formData),
     content: _utils.default.interpolateString(component.content, formData),
     hint: _utils.default.interpolateString(component.hint, formData),

package/dist/components/FormComponent/helpers/getComponentDisabled.js

@@ -0,0 +1,21 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _Utils = _interopRequireDefault(require("@ukhomeoffice/cop-react-components/dist/utils/Utils"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+var getComponentDisabled = function getComponentDisabled(disabled, formData) {
+  if (typeof disabled === 'string') {
+    return !!_Utils.default.interpolateString(disabled, formData);
+  }
+
+  return !!disabled;
+};
+
+var _default = getComponentDisabled;
+exports.default = _default;

package/dist/components/FormComponent/helpers/getComponentDisabled.test.js

@@ -0,0 +1,26 @@
+"use strict";
+
+var _getComponentDisabled = _interopRequireDefault(require("./getComponentDisabled"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+describe('components.FormComponent.helpers.getComponentDisabled', function () {
+  var DATA = {
+    shouldDisable: true
+  };
+  it('should return false if disabled is undefined', function () {
+    expect((0, _getComponentDisabled.default)(undefined, DATA)).toEqual(false);
+  });
+  it('should return false if disabled is boolean false', function () {
+    expect((0, _getComponentDisabled.default)(false, DATA)).toEqual(false);
+  });
+  it('should return true if disabled is boolean true', function () {
+    expect((0, _getComponentDisabled.default)(true, DATA)).toEqual(true);
+  });
+  it('should interpolate correctly if disabled is a field path', function () {
+    expect((0, _getComponentDisabled.default)('${shouldDisable}', DATA)).toEqual(true);
+  });
+  it('should return false if interpolating a field that does not exist', function () {
+    expect((0, _getComponentDisabled.default)('${notARealField}', DATA)).toEqual(false);
+  });
+});

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

@@ -3,6 +3,12 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+Object.defineProperty(exports, "getComponentDisabled", {
+  enumerable: true,
+  get: function get() {
+    return _getComponentDisabled.default;
+  }
+});
 Object.defineProperty(exports, "getComponentError", {
   enumerable: true,
   get: function get() {
@@ -10,6 +16,8 @@ Object.defineProperty(exports, "getComponentError", {
   }
 });
 
+var _getComponentDisabled = _interopRequireDefault(require("./getComponentDisabled"));
+
 var _getComponentError = _interopRequireDefault(require("./getComponentError"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

package/dist/components/FormPage/FormPage.js

@@ -89,7 +89,10 @@ var FormPage = function FormPage(_ref) {
       label: _utils.default.interpolateString(action.label, page.formData)
     }) : action;
   });
-  page.formData = _objectSpread(_objectSpread({}, page.formData), patch);
+
+  var operationResults = _utils.default.Operate.runPageOperations(page, _objectSpread(_objectSpread({}, page.formData), patch));
+
+  page.formData = _objectSpread(_objectSpread(_objectSpread({}, page.formData), patch), operationResults);
   return /*#__PURE__*/_react.default.createElement("div", {
     className: classes('page'),
     key: page.id

package/dist/utils/Operate/checkValueIsTruthy.js

@@ -0,0 +1,35 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _copReactComponents = require("@ukhomeoffice/cop-react-components");
+
+var _getSourceData = _interopRequireDefault(require("../Data/getSourceData"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Global imports.
+// Local imports.
+
+/**
+ * Simple operation to check if a given value in data is truthy or not.
+ * Supports getting a value from an interpolated field string.
+ * @param {object} config The operation config.
+ * @param {object} data The page's formData.
+ * @returns true if the value is truthy, false if it isn't or doesn't exist.
+ */
+var checkValueIsTruthy = function checkValueIsTruthy(config, data) {
+  if (config !== null && config !== void 0 && config.field) {
+    var fieldPath = _copReactComponents.Utils.interpolateString(config.field, data);
+
+    return !!(0, _getSourceData.default)(data, fieldPath);
+  }
+
+  return false;
+};
+
+var _default = checkValueIsTruthy;
+exports.default = _default;

package/dist/utils/Operate/checkValueIsTruthy.test.js

@@ -0,0 +1,44 @@
+"use strict";
+
+var _checkValueIsTruthy = _interopRequireDefault(require("./checkValueIsTruthy"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+describe('Utils.Operate.checkValueIsTruthy', function () {
+  var DATA = {
+    alpha: 'abc',
+    bravo: ''
+  };
+  it('Should return true is the value of the field is truthy', function () {
+    var CONFIG = {
+      field: 'alpha'
+    };
+    var result = (0, _checkValueIsTruthy.default)(CONFIG, DATA);
+    expect(result).toEqual(true);
+  });
+  it('Should return false if the value of the field is falsy', function () {
+    var CONFIG = {
+      field: 'bravo'
+    };
+    var result = (0, _checkValueIsTruthy.default)(CONFIG, DATA);
+    expect(result).toEqual(false);
+  });
+  it('Should return false if the field does not exist', function () {
+    var CONFIG = {
+      field: 'charlie'
+    };
+    var result = (0, _checkValueIsTruthy.default)(CONFIG, DATA);
+    expect(result).toEqual(false);
+  });
+  it('Should return false when an invalid config is used', function () {
+    var result = (0, _checkValueIsTruthy.default)(null, DATA);
+    expect(result).toEqual(false);
+  });
+  it('Should return false when invalid data is used', function () {
+    var CONFIG = {
+      field: 'alpha'
+    };
+    var result = (0, _checkValueIsTruthy.default)(CONFIG, null);
+    expect(result).toEqual(false);
+  });
+});

package/dist/utils/Operate/getIndexOfMatchingValueIn.js

@@ -0,0 +1,72 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _copReactComponents = require("@ukhomeoffice/cop-react-components");
+
+var _getSourceData = _interopRequireDefault(require("../Data/getSourceData"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Global imports.
+// Local imports.
+var getValueOrField = function getValueOrField(config, data) {
+  if (config !== null && config !== void 0 && config.value) {
+    return config.value;
+  }
+
+  var path = _copReactComponents.Utils.interpolateString(config === null || config === void 0 ? void 0 : config.field, data);
+
+  return (0, _getSourceData.default)(data, path);
+};
+/**
+ * Searches for a value in an array in data that matches a value given 
+ * in config. A cutoff index can be provided in config if the search 
+ * should stop after a certain number of entries. An index to ignore
+ * can also be provided.
+ * @param {object} config The config of the operation.
+ * @param {object} data A page's formData.
+ * @returns The index of the matching value if one exists, or null.
+ */
+
+
+var getIndexOfMatchingValueIn = function getIndexOfMatchingValueIn(config, data) {
+  if (!config || !data) {
+    return null;
+  }
+
+  var targetPath = _copReactComponents.Utils.interpolateString(config.target, data);
+
+  var target = (0, _getSourceData.default)(data, targetPath);
+  var value = getValueOrField(config, data);
+  var cutoff = getValueOrField(config.cutoff, data);
+  var ignore = getValueOrField(config.ignore, data);
+  var result = null;
+
+  if (target && value && Array.isArray(target)) {
+    target.every(function (entry, index) {
+      if (index === cutoff) {
+        return false;
+      }
+
+      if (index === ignore) {
+        return true;
+      }
+
+      if (entry === value || config.key && entry[config.key] === value) {
+        result = index;
+        return false;
+      }
+
+      return true;
+    });
+  }
+
+  return typeof result === 'number' ? result.toString() : result;
+};
+
+var _default = getIndexOfMatchingValueIn;
+exports.default = _default;

package/dist/utils/Operate/getIndexOfMatchingValueIn.test.js

@@ -0,0 +1,141 @@
+"use strict";
+
+var _getIndexOfMatchingValueIn = _interopRequireDefault(require("./getIndexOfMatchingValueIn"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+describe('Utils.Operate.getIndexOfPriorMatchingValueIn', function () {
+  var DATA = {
+    arrayOfValues: ['abc', 'bcd', 'cde', 'def'],
+    cutoffIndex: 1,
+    ignoreIndex: 2,
+    valueToSearchFor: 'cde',
+    targetName: 'arrayOfValues',
+    fieldName: 'valueToSearchFor',
+    cutoffName: 'cutoffIndex',
+    ignoreName: 'ignoreIndex'
+  };
+  it('Should return the index of a matching value if one exists', function () {
+    var CONFIG = {
+      target: 'arrayOfValues',
+      value: 'cde'
+    };
+    var result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
+    expect(result).toEqual('2');
+  });
+  it('Should handle getting value from given field', function () {
+    var CONFIG = {
+      target: 'arrayOfValues',
+      field: 'valueToSearchFor'
+    };
+    var result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
+    expect(result).toEqual('2');
+  });
+  it('Should handle interpolated string for field', function () {
+    var CONFIG = {
+      target: 'arrayOfValues',
+      field: '${fieldName}'
+    };
+    var result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
+    expect(result).toEqual('2');
+  });
+  it('Should handle a cutoff value being specified', function () {
+    var CONFIG = {
+      target: 'arrayOfValues',
+      value: 'cde',
+      cutoff: {
+        value: 1
+      }
+    };
+    var result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
+    expect(result).toEqual(null); // Cutoff occurs before matching value is reached.
+  });
+  it('Should handle a cutoff field being specified', function () {
+    var CONFIG = {
+      target: 'arrayOfValues',
+      value: 'cde',
+      cutoff: {
+        field: 'cutoffIndex'
+      }
+    };
+    var result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
+    expect(result).toEqual(null); // Cutoff occurs before matching value is reached.
+  });
+  it('Should handle interpolated string for cutoff.field', function () {
+    var CONFIG = {
+      target: 'arrayOfValues',
+      value: 'cde',
+      cutoff: {
+        field: '${cutoffName}'
+      }
+    };
+    var result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
+    expect(result).toEqual(null); // Cutoff occurs before matching value is reached.
+  });
+  it('Should handle an ignore value being specified', function () {
+    var CONFIG = {
+      target: 'arrayOfValues',
+      value: 'cde',
+      ignore: {
+        value: 2
+      }
+    };
+    var result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
+    expect(result).toEqual(null); // Should ignore the matching value.
+  });
+  it('Should handle an ignore field being specified', function () {
+    var CONFIG = {
+      target: 'arrayOfValues',
+      value: 'cde',
+      ignore: {
+        field: 'ignoreIndex'
+      }
+    };
+    var result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
+    expect(result).toEqual(null); // Should ignore the matching value.
+  });
+  it('Should handle interpolated string for ignore.field', function () {
+    var CONFIG = {
+      target: 'arrayOfValues',
+      value: 'cde',
+      ignore: {
+        field: '${ignoreName}'
+      }
+    };
+    var result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
+    expect(result).toEqual(null); // Should ignore the matching value.
+  });
+  it('Should handle interpolated string for target', function () {
+    var CONFIG = {
+      target: '${targetName}',
+      value: 'cde'
+    };
+    var result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
+    expect(result).toEqual('2');
+  });
+  it('Should return null when the target does not exist', function () {
+    var CONFIG = {
+      target: 'notARealTarget',
+      value: 'cde'
+    };
+    var result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
+    expect(result).toEqual(null);
+  });
+  it('Should return null when config is missing fields', function () {
+    var CONFIG = {};
+    var result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
+    expect(result).toEqual(null);
+  });
+  it('Should return null when config is invalid', function () {
+    var result = (0, _getIndexOfMatchingValueIn.default)(null, DATA);
+    expect(result).toEqual(null);
+  });
+  it('Should return null when data is invalid', function () {
+    var CONFIG = {
+      target: 'arrayOfValues',
+      value: 'cde'
+    };
+    var result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, null);
+    expect(result).toEqual(null);
+  });
+});

package/dist/utils/Operate/getValueFromFormData.js

@@ -0,0 +1,27 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _copReactComponents = require("@ukhomeoffice/cop-react-components");
+
+var _getSourceData = _interopRequireDefault(require("../Data/getSourceData"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Global imports.
+// Local imports.
+var getValueFromFormData = function getValueFromFormData(config, data) {
+  if (config !== null && config !== void 0 && config.field) {
+    var fieldPath = _copReactComponents.Utils.interpolateString(config.field, data);
+
+    return (0, _getSourceData.default)(data, fieldPath) || null;
+  }
+
+  return (config === null || config === void 0 ? void 0 : config.value) || null;
+};
+
+var _default = getValueFromFormData;
+exports.default = _default;

package/dist/utils/Operate/getValueFromFormData.test.js

@@ -0,0 +1,45 @@
+"use strict";
+
+var _getValueFromFormData = _interopRequireDefault(require("./getValueFromFormData"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+describe('Utils.Operate.addToFormData', function () {
+  var DATA = {
+    a: '1',
+    b: ['2', '3'],
+    indexOfThree: 1
+  };
+  it('Should return the value provided in config if no field is specified', function () {
+    var CONFIG = {
+      value: '2'
+    };
+    var result = (0, _getValueFromFormData.default)(CONFIG, DATA);
+    expect(result).toEqual(CONFIG.value);
+  });
+  it('Should return the value of the field given in config, if it exists', function () {
+    var CONFIG = {
+      field: 'a'
+    };
+    var result = (0, _getValueFromFormData.default)(CONFIG, DATA);
+    expect(result).toEqual(DATA.a);
+  });
+  it('Should handle interpolated field strings', function () {
+    var CONFIG = {
+      field: 'b[${indexOfThree}]'
+    };
+    var result = (0, _getValueFromFormData.default)(CONFIG, DATA);
+    expect(result).toEqual(DATA.b[1]);
+  });
+  it('Should return null when an invalid config is used', function () {
+    var result = (0, _getValueFromFormData.default)(null, DATA);
+    expect(result).toEqual(null);
+  });
+  it('Should return null when invalid data is used', function () {
+    var CONFIG = {
+      field: 'a'
+    };
+    var result = (0, _getValueFromFormData.default)(CONFIG, null);
+    expect(result).toEqual(null);
+  });
+});

package/dist/utils/Operate/index.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _runPageOperations = _interopRequireDefault(require("./runPageOperations"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+var Operate = {
+  runPageOperations: _runPageOperations.default
+};
+var _default = Operate;
+exports.default = _default;

package/dist/utils/Operate/runPageOperations.js

@@ -0,0 +1,70 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _checkValueIsTruthy = _interopRequireDefault(require("./checkValueIsTruthy"));
+
+var _getIndexOfMatchingValueIn = _interopRequireDefault(require("./getIndexOfMatchingValueIn"));
+
+var _getValueFromFormData = _interopRequireDefault(require("./getValueFromFormData"));
+
+var _shouldRun = _interopRequireDefault(require("./shouldRun"));
+
+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 functions = {
+  checkValueIsTruthy: _checkValueIsTruthy.default,
+  getIndexOfMatchingValueIn: _getIndexOfMatchingValueIn.default,
+  getValueFromFormData: _getValueFromFormData.default
+};
+
+var doOperation = function doOperation(config, data) {
+  var fn = functions[config.function];
+
+  if (typeof fn === 'function') {
+    return fn(config, data);
+  }
+
+  return undefined;
+};
+/**
+ * Run operations specified in a page's config on formData.
+ * The results of any operations are stored in an object with 
+ * the format of { operation_name: result, ... }.
+ * 
+ * If the page has no 'operations' field, or no valid operations
+ * are given, then an empty object is returned.
+ * 
+ * @param {object} config The config for the page.
+ * @param {object} data The page's formData.
+ * @returns An object containing the results of the operations.
+ */
+
+
+var runPageOperations = function runPageOperations(config, data) {
+  var result = {};
+
+  if (config !== null && config !== void 0 && config.operations && data) {
+    config.operations.forEach(function (op) {
+      if (op.output) {
+        if ((0, _shouldRun.default)(op.run_when, data)) {
+          result[op.output] = doOperation(op, _objectSpread(_objectSpread({}, data), result));
+        }
+      }
+    });
+  }
+
+  return result;
+};
+
+var _default = runPageOperations;
+exports.default = _default;

package/dist/utils/Operate/runPageOperations.test.js

@@ -0,0 +1,67 @@
+"use strict";
+
+var _runPageOperations = _interopRequireDefault(require("./runPageOperations"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+describe('Utils.Operate.runPageOperations', function () {
+  var DATA = {
+    alpha: 'abc',
+    bravo: ['bcd', 'cde', 'charlie'],
+    charlie: 'def'
+  };
+  it('Should return an empty object when no operations are specified', function () {
+    var PAGE = {};
+    var result = (0, _runPageOperations.default)(PAGE, DATA);
+    expect(result).toEqual({});
+  });
+  it('Should handle a single operation correctly', function () {
+    var PAGE = {
+      operations: [{
+        output: 'firstOpResult',
+        function: 'getValueFromFormData',
+        field: 'alpha'
+      }]
+    };
+    var result = (0, _runPageOperations.default)(PAGE, DATA);
+    expect(result).toEqual({
+      firstOpResult: 'abc'
+    });
+  });
+  it('Should handle a multiple operations correctly', function () {
+    var PAGE = {
+      operations: [{
+        output: 'firstOpResult',
+        function: 'getValueFromFormData',
+        field: 'alpha'
+      }, {
+        output: 'secondOpResult',
+        function: 'getValueFromFormData',
+        field: 'bravo[1]'
+      }]
+    };
+    var result = (0, _runPageOperations.default)(PAGE, DATA);
+    expect(result).toEqual({
+      firstOpResult: 'abc',
+      secondOpResult: 'cde'
+    });
+  });
+  it('Should handle chained operations correctly', function () {
+    var PAGE = {
+      operations: [{
+        output: 'firstOpResult',
+        function: 'getValueFromFormData',
+        field: 'bravo[2]'
+      }, {
+        output: 'secondOpResult',
+        function: 'getValueFromFormData',
+        field: '${firstOpResult}'
+      }]
+    };
+    var result = (0, _runPageOperations.default)(PAGE, DATA);
+    expect(result).toEqual({
+      firstOpResult: 'charlie',
+      secondOpResult: 'def'
+    });
+  });
+});

package/dist/utils/Operate/shouldRun.js

@@ -0,0 +1,67 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _copReactComponents = require("@ukhomeoffice/cop-react-components");
+
+var _getSourceData = _interopRequireDefault(require("../Data/getSourceData"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Global imports.
+// Local imports.
+
+/**
+ * Checks whether or not a page operation should run
+ * based on the provided run_when config.
+ * @param {object} config The run_when config.
+ * @param {object} data The page's formData.
+ * @returns 
+ */
+var shouldRun = function shouldRun(config, data) {
+  if (config !== null && config !== void 0 && config.condition) {
+    var fieldPath = _copReactComponents.Utils.interpolateString(config.field, data);
+
+    var fieldValue = (0, _getSourceData.default)(data, fieldPath);
+
+    switch (config.condition) {
+      // Only run the operation if a given field's value has changed.
+      case 'changes':
+        var lastPath = "".concat(fieldPath, "LastValue");
+        var lastValue = config[lastPath] || null;
+
+        if (lastValue === null) {
+          // If there isn't a last value then we assume
+          // that this is the first render.
+          config[lastPath] = fieldValue;
+          return false;
+        }
+
+        if (fieldValue !== lastValue) {
+          config[lastPath] = fieldValue;
+          return true;
+        }
+
+        return false;
+      // Only run the operation if a given field's value is truthy.
+
+      case 'isTruthy':
+        return !!fieldValue;
+      // Only run the operation if a given field's value is falsy.
+
+      case 'isFalsy':
+        return !fieldValue;
+
+      default:
+        return false;
+    }
+  }
+
+  return true;
+};
+
+var _default = shouldRun;
+exports.default = _default;

package/dist/utils/Operate/shouldRun.test.js

@@ -0,0 +1,69 @@
+"use strict";
+
+var _shouldRun = _interopRequireDefault(require("./shouldRun"));
+
+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; }
+
+describe('Utils.Operate.shouldRun', function () {
+  var DATA = {
+    alpha: 'abc',
+    bravo: ''
+  };
+  it('Should return true if the run_when config is invalid', function () {
+    expect((0, _shouldRun.default)(null, DATA)).toEqual(true);
+  });
+  it('Should return true when the condition is \'changes\' and target value has changed', function () {
+    var CONFIG = {
+      condition: 'changes',
+      field: 'alpha'
+    };
+    var result = (0, _shouldRun.default)(CONFIG, DATA);
+    expect(result).toEqual(false); // Expect false as this is the first render.
+
+    result = (0, _shouldRun.default)(CONFIG, DATA);
+    expect(result).toEqual(false); // Expect false as the field hasn't changed.
+
+    result = (0, _shouldRun.default)(CONFIG, _objectSpread(_objectSpread({}, DATA), {}, {
+      alpha: 'bcd'
+    }));
+    expect(result).toEqual(true); // Expect true as the field's value has been updated.
+  });
+  it('Should return true when the condition is \'isTruthy\' and target value is truthy', function () {
+    var CONFIG = {
+      condition: 'isTruthy',
+      field: 'alpha'
+    };
+    var result = (0, _shouldRun.default)(CONFIG, DATA);
+    expect(result).toEqual(true);
+  });
+  it('Should return false when the condition is \'isTruthy\' and target value is falsy', function () {
+    var CONFIG = {
+      condition: 'isTruthy',
+      field: 'bravo'
+    };
+    var result = (0, _shouldRun.default)(CONFIG, DATA);
+    expect(result).toEqual(false);
+  });
+  it('Should return true when the condition is \'isFalsy\' and target value is falsy', function () {
+    var CONFIG = {
+      condition: 'isFalsy',
+      field: 'bravo'
+    };
+    var result = (0, _shouldRun.default)(CONFIG, DATA);
+    expect(result).toEqual(true);
+  });
+  it('Should return false when the condition is \'isFalsy\' and target value is truthy', function () {
+    var CONFIG = {
+      condition: 'isFalsy',
+      field: 'alpha'
+    };
+    var result = (0, _shouldRun.default)(CONFIG, DATA);
+    expect(result).toEqual(false);
+  });
+});

package/dist/utils/index.js

@@ -27,6 +27,8 @@ var _Hub = _interopRequireDefault(require("./Hub"));
 
 var _Meta = _interopRequireDefault(require("./Meta"));
 
+var _Operate = _interopRequireDefault(require("./Operate"));
+
 var _Validate = _interopRequireDefault(require("./Validate"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -48,6 +50,7 @@ var Utils = _objectSpread({
   FormPage: _FormPage.default,
   Hub: _Hub.default,
   Meta: _Meta.default,
+  Operate: _Operate.default,
   Validate: _Validate.default
 }, _copReactComponents.Utils);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ukhomeoffice/cop-react-form-renderer",
-  "version": "4.0.2",
+  "version": "4.4.0",
   "private": false,
   "scripts": {
     "clean": "rimraf dist",
@@ -16,7 +16,7 @@
     "post-compile": "rimraf dist/*.test.* dist/**/*.test.* dist/**/*.stories.* dist/docs dist/assets"
   },
   "dependencies": {
-    "@ukhomeoffice/cop-react-components": "2.0.3",
+    "@ukhomeoffice/cop-react-components": "2.1.0",
     "axios": "^0.23.0",
     "dayjs": "^1.11.0",
     "govuk-frontend": "^4.3.1",