@ukhomeoffice/cop-react-form-renderer 6.0.0 → 6.0.1-peter

package/dist/utils/FormPage/getConditionalText.test.js

@@ -0,0 +1,162 @@
+"use strict";
+
+var _getConditionalText = _interopRequireDefault(require("./getConditionalText"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+describe('utils.FormPage.getConditionalText', function () {
+  var FORM_DATA = {
+    testField: 'Alpha',
+    testField2: 'yes'
+  };
+  it('should return null if no options are provided', function () {
+    var result = (0, _getConditionalText.default)(null, FORM_DATA);
+    expect(result).toEqual(null);
+  });
+  it('should return the option if it\'s just a string', function () {
+    var result = (0, _getConditionalText.default)('abc123', FORM_DATA);
+    expect(result).toEqual('abc123');
+  });
+  it('should return a correctly interpolated string', function () {
+    // eslint-disable-next-line no-template-curly-in-string
+    var result = (0, _getConditionalText.default)('${testField} string', FORM_DATA);
+    expect(result).toEqual("".concat(FORM_DATA.testField, " string"));
+  });
+  it('should return the option that has it\'s conditions met', function () {
+    var OPTIONS = [{
+      text: 'Text A',
+      show_when: [{
+        field: 'testField2',
+        op: '=',
+        value: 'no'
+      }]
+    }, {
+      text: 'Text B',
+      show_when: [{
+        field: 'testField2',
+        op: '=',
+        value: 'yes'
+      }]
+    }];
+    var result = (0, _getConditionalText.default)(OPTIONS, FORM_DATA);
+    expect(result).toEqual('Text B');
+  });
+  it('should return a plain string option if one is encountered in the array', function () {
+    var OPTIONS = [{
+      text: 'Text A',
+      show_when: [{
+        field: 'testField2',
+        op: '=',
+        value: 'notTheValue'
+      }]
+    }, {
+      text: 'Text B',
+      show_when: [{
+        field: 'testField2',
+        op: '=',
+        value: 'notTheValue'
+      }]
+    }, "Default text"];
+    var result = (0, _getConditionalText.default)(OPTIONS, FORM_DATA);
+    expect(result).toEqual('Default text');
+  });
+  it('should correctly interpolate a plain string option in the array', function () {
+    var OPTIONS = [{
+      text: 'Text A',
+      show_when: [{
+        field: 'testField2',
+        op: '=',
+        value: 'notTheValue'
+      }]
+    }, {
+      text: 'Text B',
+      show_when: [{
+        field: 'testField2',
+        op: '=',
+        value: 'notTheValue'
+      }]
+    },
+    // eslint-disable-next-line no-template-curly-in-string
+    "${testField} text"];
+    var result = (0, _getConditionalText.default)(OPTIONS, FORM_DATA);
+    expect(result).toEqual("".concat(FORM_DATA.testField, " text"));
+  });
+  it('should correctly interpolate a conditional option', function () {
+    var OPTIONS = [{
+      text: 'Text A',
+      show_when: [{
+        field: 'testField2',
+        op: '=',
+        value: 'no'
+      }]
+    }, {
+      // eslint-disable-next-line no-template-curly-in-string
+      text: '${testField} text',
+      show_when: [{
+        field: 'testField2',
+        op: '=',
+        value: 'yes'
+      }]
+    }];
+    var result = (0, _getConditionalText.default)(OPTIONS, FORM_DATA);
+    expect(result).toEqual("".concat(FORM_DATA.testField, " text"));
+  });
+  it('should correctly use a conditional option', function () {
+    var OPTIONS = [{
+      text: 'Text A',
+      show_when: [{
+        field: 'testField2',
+        op: '=',
+        value: 'no'
+      }]
+    }, {
+      // eslint-disable-next-line no-template-curly-in-string
+      text: '${testField} text',
+      show_when: [{
+        field: 'testField2',
+        op: '=',
+        value: 'yes'
+      }]
+    }];
+    var result = (0, _getConditionalText.default)(OPTIONS, FORM_DATA);
+    expect(result).toEqual("".concat(FORM_DATA.testField, " text"));
+  });
+  it('should correctly use a different key to find the text if one is provided', function () {
+    var OPTIONS = [{
+      customKey: 'Text A',
+      show_when: [{
+        field: 'testField2',
+        op: '=',
+        value: 'no'
+      }]
+    }, {
+      // eslint-disable-next-line no-template-curly-in-string
+      customKey: '${testField} text',
+      show_when: [{
+        field: 'testField2',
+        op: '=',
+        value: 'yes'
+      }]
+    }];
+    var result = (0, _getConditionalText.default)(OPTIONS, FORM_DATA, 'customKey');
+    expect(result).toEqual("".concat(FORM_DATA.testField, " text"));
+  });
+  it('should return null for a conditional option if formData is empty', function () {
+    var OPTIONS = [{
+      text: 'Text A',
+      show_when: [{
+        field: 'testField2',
+        op: '=',
+        value: 'no'
+      }]
+    }, {
+      // eslint-disable-next-line no-template-curly-in-string
+      text: '${testField} text',
+      show_when: [{
+        field: 'testField2',
+        op: '=',
+        value: 'yes'
+      }]
+    }];
+    var result = (0, _getConditionalText.default)(OPTIONS, {});
+    expect(result).toEqual(null);
+  });
+});

package/dist/utils/FormPage/index.js

@@ -5,17 +5,20 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _applyConditionalProperties = _interopRequireDefault(require("./applyConditionalProperties"));
+var _getConditionalText = _interopRequireDefault(require("./getConditionalText"));
 var _getFormPage = _interopRequireDefault(require("./getFormPage"));
 var _getFormPages = _interopRequireDefault(require("./getFormPages"));
-var _getPageTitle = _interopRequireDefault(require("./getPageTitle"));
 var _showFormPage = _interopRequireDefault(require("./showFormPage"));
 var _showFormPageCYA = _interopRequireDefault(require("./showFormPageCYA"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 var FormPage = {
   applyConditionalProperties: _applyConditionalProperties.default,
+  getConditionalText: _getConditionalText.default,
   get: _getFormPage.default,
   getAll: _getFormPages.default,
-  getTitle: _getPageTitle.default,
+  getTitle: function getTitle(options, formData) {
+    return (0, _getConditionalText.default)(options, formData, 'title');
+  },
   show: _showFormPage.default,
   showCYA: _showFormPageCYA.default
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ukhomeoffice/cop-react-form-renderer",
-  "version": "6.0.0",
+  "version": "6.0.1-peter",
   "private": false,
   "scripts": {
     "clean": "rimraf dist",
@@ -16,11 +16,10 @@
     "post-compile": "rimraf dist/*.test.* dist/**/*.test.* dist/**/*.stories.* dist/docs dist/assets"
   },
   "dependencies": {
-    "@ukhomeoffice/cop-react-components": "^4.0.0",
+    "@ukhomeoffice/cop-react-components": "^3.19.1",
     "axios": "^0.23.0",
     "dayjs": "^1.11.0",
-    "govuk-frontend": "^5.0.0",
-    "sass": "^1.69.5",
+    "govuk-frontend": "^4.3.1",
     "web-vitals": "^1.0.1"
   },
   "devDependencies": {
@@ -49,6 +48,7 @@
     "eslint-config-airbnb": "^19.0.4",
     "eslint-config-prettier": "^8.6.0",
     "html-react-parser": "^0.10.5",
+    "node-sass": "^6.0.1",
     "prop-types": "^15.8.1",
     "react": "^16.13.1",
     "react-dom": "^16.13.1",

package/dist/utils/FormPage/getPageTitle.js

@@ -1,32 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _copReactComponents = require("@ukhomeoffice/cop-react-components");
-var _meetsAllConditions = _interopRequireDefault(require("../Condition/meetsAllConditions"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-// Global imports.
-
-// Local imports.
-
-var getPageTitle = function getPageTitle(title, formData) {
-  if (typeof title === 'string') {
-    return _copReactComponents.Utils.interpolateString(title, formData);
-  }
-  if (!Array.isArray(title) || Object.keys(formData).length === 0) {
-    return null;
-  }
-  var shownOption = title.find(function (option) {
-    if (typeof option === 'string') {
-      // This is intended to allow a plain string 'fallback' option in the array.
-      // As such, it should be the last option in the array as any options after
-      // it will not be considered.
-      return true;
-    }
-    return (0, _meetsAllConditions.default)(option.show_when, formData);
-  });
-  return typeof shownOption === 'string' ? _copReactComponents.Utils.interpolateString(shownOption, formData) : _copReactComponents.Utils.interpolateString(shownOption.title, formData);
-};
-var _default = exports.default = getPageTitle;

package/dist/utils/FormPage/getPageTitle.test.js

@@ -1,138 +0,0 @@
-"use strict";
-
-var _getPageTitle = _interopRequireDefault(require("./getPageTitle"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-describe('utils.FormPage.getPageTitle', function () {
-  var FORM_DATA = {
-    testField: 'Alpha',
-    testField2: 'yes'
-  };
-  it('should return null if title is not defined', function () {
-    var result = (0, _getPageTitle.default)(null, FORM_DATA);
-    expect(result).toEqual(null);
-  });
-  it('should return the defined page title if it\'s just a string', function () {
-    var PAGE = {
-      title: 'Page title'
-    };
-    var result = (0, _getPageTitle.default)(PAGE.title, FORM_DATA);
-    expect(result).toEqual('Page title');
-  });
-  it('should return a correctly interpolated title', function () {
-    // eslint-disable-next-line no-template-curly-in-string
-    var PAGE = {
-      title: '${testField} title'
-    };
-    var result = (0, _getPageTitle.default)(PAGE.title, FORM_DATA);
-    expect(result).toEqual("".concat(FORM_DATA.testField, " title"));
-  });
-  it('should return the title that has it\'s conditions met', function () {
-    var PAGE = {
-      title: [{
-        title: 'First title',
-        show_when: [{
-          field: 'testField2',
-          op: '=',
-          value: 'no'
-        }]
-      }, {
-        title: 'Second title',
-        show_when: [{
-          field: 'testField2',
-          op: '=',
-          value: 'yes'
-        }]
-      }]
-    };
-    var result = (0, _getPageTitle.default)(PAGE.title, FORM_DATA);
-    expect(result).toEqual('Second title');
-  });
-  it('should return a plain string title if one is encountered in the array', function () {
-    var PAGE = {
-      title: [{
-        title: 'First title',
-        show_when: [{
-          field: 'testField2',
-          op: '=',
-          value: 'notTheValue'
-        }]
-      }, {
-        title: 'Second title',
-        show_when: [{
-          field: 'testField2',
-          op: '=',
-          value: 'notTheValue'
-        }]
-      }, "Default title"]
-    };
-    var result = (0, _getPageTitle.default)(PAGE.title, FORM_DATA);
-    expect(result).toEqual('Default title');
-  });
-  it('should correctly interpolate a plain string option in the title array', function () {
-    var PAGE = {
-      title: [{
-        title: 'First title',
-        show_when: [{
-          field: 'testField2',
-          op: '=',
-          value: 'notTheValue'
-        }]
-      }, {
-        title: 'Second title',
-        show_when: [{
-          field: 'testField2',
-          op: '=',
-          value: 'notTheValue'
-        }]
-      },
-      // eslint-disable-next-line no-template-curly-in-string
-      "${testField} title"]
-    };
-    var result = (0, _getPageTitle.default)(PAGE.title, FORM_DATA);
-    expect(result).toEqual("".concat(FORM_DATA.testField, " title"));
-  });
-  it('should correctly interpolate a conditional title', function () {
-    var PAGE = {
-      title: [{
-        title: 'First title',
-        show_when: [{
-          field: 'testField2',
-          op: '=',
-          value: 'no'
-        }]
-      }, {
-        // eslint-disable-next-line no-template-curly-in-string
-        title: '${testField} title',
-        show_when: [{
-          field: 'testField2',
-          op: '=',
-          value: 'yes'
-        }]
-      }]
-    };
-    var result = (0, _getPageTitle.default)(PAGE.title, FORM_DATA);
-    expect(result).toEqual("".concat(FORM_DATA.testField, " title"));
-  });
-  it('should return null for a conditional title if formData is empty', function () {
-    var PAGE = {
-      title: [{
-        title: 'First title',
-        show_when: [{
-          field: 'testField2',
-          op: '=',
-          value: 'no'
-        }]
-      }, {
-        // eslint-disable-next-line no-template-curly-in-string
-        title: '${testField} title',
-        show_when: [{
-          field: 'testField2',
-          op: '=',
-          value: 'yes'
-        }]
-      }]
-    };
-    var result = (0, _getPageTitle.default)(PAGE.title, {});
-    expect(result).toEqual(null);
-  });
-});