@ukhomeoffice/cop-react-form-renderer 6.14.3-test → 6.14.4

package/dist/components/CollectionSummary/BannerStrip.scss

@@ -39,6 +39,10 @@
   }
 }
 
+.hods-form-banner-strip__tag--fit-content{
+  max-width: fit-content;
+}
+
 @mixin banner-tag-colours($colour) {
   .hods-form-banner-strip__tag--#{$colour} {
     @extend .govuk-tag--#{$colour};

package/dist/components/FormPage/FormPage.js

@@ -12,6 +12,7 @@ var _utils = _interopRequireDefault(require("../../utils"));
 var _FormComponent = _interopRequireDefault(require("../FormComponent"));
 var _PageActions = _interopRequireDefault(require("../PageActions"));
 require("./FormPage.scss");
+var _validateOnPageLoad = require("../../utils/Validate/validateOnPageLoad");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
@@ -24,7 +25,7 @@ function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e =
 // Styles
 const DEFAULT_CLASS = exports.DEFAULT_CLASS = 'hods-form__page';
 const FormPage = _ref => {
-  var _page$customValidatio, _formPage$actions, _page$actions;
+  var _formPage$actions, _page$actions;
   let {
     page,
     pages,
@@ -37,8 +38,7 @@ const FormPage = _ref => {
     classModifiers,
     className,
     submitting,
-    pageId,
-    fromTarget
+    pageId
   } = _ref;
   const [patch, setPatch] = (0, _react.useState)({});
   const {
@@ -47,12 +47,12 @@ const FormPage = _ref => {
   } = (0, _hooks.useValidation)();
   const [patchLabel, setPatchLabel] = (0, _react.useState)({});
   const [isPageRendered, setIsPageRendered] = (0, _react.useState)(false);
-  const runOnLoad = Array.isArray(page === null || page === void 0 ? void 0 : page.customValidation) && page.customValidation.length > 0 ? ((_page$customValidatio = page.customValidation[0]) === null || _page$customValidatio === void 0 || (_page$customValidatio = _page$customValidatio.runWhen) === null || _page$customValidatio === void 0 ? void 0 : _page$customValidatio.onLoad) === true : false;
+  const runOnLoad = (0, _react.useMemo)(() => (0, _validateOnPageLoad.doValidateOnPageLoad)(page), [page]);
   (0, _react.useEffect)(() => {
     setIsPageRendered(true);
   }, []);
   (0, _react.useEffect)(() => {
-    if (isPageRendered && fromTarget && runOnLoad) {
+    if (isPageRendered && runOnLoad) {
       validate.page(page);
     }
   }, [pageId, isPageRendered]);
@@ -120,9 +120,9 @@ const FormPage = _ref => {
   }));
   let errorMessages = null;
   if (runOnLoad && (errors === null || errors === void 0 ? void 0 : errors.length) > 0) {
-    var _page$customValidatio2;
+    var _page$customValidatio;
     errorMessages = [{
-      error: page === null || page === void 0 || (_page$customValidatio2 = page.customValidation) === null || _page$customValidatio2 === void 0 || (_page$customValidatio2 = _page$customValidatio2[0]) === null || _page$customValidatio2 === void 0 ? void 0 : _page$customValidatio2.message
+      error: page === null || page === void 0 || (_page$customValidatio = page.customValidation) === null || _page$customValidatio === void 0 || (_page$customValidatio = _page$customValidatio[0]) === null || _page$customValidatio === void 0 ? void 0 : _page$customValidatio.message
     }];
   } else if ((errors === null || errors === void 0 ? void 0 : errors.length) > 0 && !runOnLoad) {
     errorMessages = errors;
@@ -174,7 +174,6 @@ FormPage.propTypes = {
   }).isRequired,
   pages: _propTypes.default.arrayOf(_propTypes.default.shape({})),
   submitting: _propTypes.default.bool,
-  fromTarget: _propTypes.default.bool,
   pageId: _propTypes.default.string.isRequired
 };
 FormPage.defaultProps = {
@@ -186,7 +185,6 @@ FormPage.defaultProps = {
   onTopLevelChange: undefined,
   onWrapperChange: undefined,
   pages: [],
-  submitting: false,
-  fromTarget: false
+  submitting: false
 };
 var _default = exports.default = FormPage;

package/dist/components/FormRenderer/FormRenderer.js

@@ -54,8 +54,7 @@ const FormRenderer = _ref => {
     noChangeAction,
     newPageId,
     viewOnly,
-    hideBlankRows,
-    fromTarget
+    hideBlankRows
   } = _ref;
   return /*#__PURE__*/_react.default.createElement(_context.HooksContextProvider, {
     overrides: hooks
@@ -76,8 +75,7 @@ const FormRenderer = _ref => {
     noChangeAction: noChangeAction,
     newPageId: newPageId,
     viewOnly: viewOnly,
-    hideBlankRows: hideBlankRows,
-    fromTarget: fromTarget
+    hideBlankRows: hideBlankRows
   })));
 };
 const DEFAULT_CLASS = exports.DEFAULT_CLASS = 'hods-form';
@@ -100,8 +98,7 @@ const InternalFormRenderer = _ref2 => {
     noChangeAction,
     newPageId,
     viewOnly,
-    hideBlankRows,
-    fromTarget
+    hideBlankRows
   } = _ref2;
   // Set up the initial states.
   const [data, setData] = (0, _react.useState)({});
@@ -326,8 +323,7 @@ const InternalFormRenderer = _ref2 => {
     classModifiers: formState.page.classModifiers,
     className: formState.page.className,
     submitting: submitting,
-    pageId: pageId,
-    fromTarget: fromTarget
+    pageId: pageId
   }), formState.page && !formState.cya && formState.page.collection && /*#__PURE__*/_react.default.createElement(_CollectionPage.default, {
     page: formState.page,
     pages: pages,
@@ -370,8 +366,7 @@ const propTypes = {
   /** See <a href="/?path=/docs/f-json--page#formtypes">FormTypes</a>. */
   type: _propTypes.default.oneOf([_models.FormTypes.CYA, _models.FormTypes.FORM, _models.FormTypes.HUB, _models.FormTypes.TASK, _models.FormTypes.WIZARD, _models.FormTypes.TASK_CYA, _models.FormTypes.FORM_WITH_TASK]).isRequired,
   viewOnly: _propTypes.default.bool,
-  hideBlankRows: _propTypes.default.bool,
-  fromTarget: _propTypes.default.bool.isRequired
+  hideBlankRows: _propTypes.default.bool
 };
 const defaultProps = {
   classBlock: DEFAULT_CLASS,

package/dist/utils/Condition/meetsCondition.js

@@ -69,7 +69,7 @@ const meetsCondition = (condition, value, data) => {
           if (!value || !compare) {
             return false;
           }
-          const valFloat = parseFloat(value.replace(',', ''));
+          const valFloat = Array.isArray(value) ? value.length : parseFloat(value.replace(',', ''));
           const compareFloat = parseFloat(compare.replace(',', ''));
           return valFloat < compareFloat;
         }
@@ -78,7 +78,7 @@ const meetsCondition = (condition, value, data) => {
           if (!value || !compare) {
             return false;
           }
-          const valFloat = parseFloat(value.replace(/,/g, ''));
+          const valFloat = Array.isArray(value) ? value.length : parseFloat(value.replace(/,/g, ''));
           const compareFloat = parseFloat(compare.replace(/,/g, ''));
           return valFloat > compareFloat;
         }

package/dist/utils/Data/getAutocompleteSource.js

@@ -7,63 +7,80 @@ exports.default = void 0;
 var _copReactComponents = require("@ukhomeoffice/cop-react-components");
 var _getOptions = _interopRequireDefault(require("./getOptions"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-// Global Imports
-
-// Local imports
+const MAX_NUMBER_RESULTS = 6000; // lower is better for performance, this still includes all ports
 
+const assignFullMatchScore = (subStringMatchIndex, label) => {
+  const matchAtBeginning = subStringMatchIndex === 0;
+  let score = 0;
+  if (matchAtBeginning) {
+    score = 1;
+  }
+  if (!matchAtBeginning) {
+    const isCompleteWord = label.substring(subStringMatchIndex - 1).startsWith(" ");
+    score = isCompleteWord ? 2 : 3;
+  }
+  return score;
+};
+const noMatch = score => score === 0;
+const lowerCaseMatch = (searchTerm, query) => typeof searchTerm !== 'string' ? false : searchTerm.toLowerCase().includes(query);
+const assignSynonymsScore = (option, searchQuery) => {
+  let score = 0;
+  const isMatch = option.synonyms.some(synonym => lowerCaseMatch(synonym, searchQuery));
+  if (isMatch) {
+    score = 4;
+  }
+  return score;
+};
+const assignExtraFieldsScore = (config, option, searchQuery) => {
+  let score = 0;
+  const isMatch = config.item.extraFieldsToSearch.some(field => {
+    const fieldToSearch = option[field];
+    return lowerCaseMatch(fieldToSearch, searchQuery);
+  });
+  if (isMatch) {
+    score = 5;
+  }
+  return score;
+};
+const mapToScoreAndLabel = (option, searchQuery, labelMapper, config) => {
+  var _config$item;
+  const label = labelMapper ? labelMapper(option).toLowerCase() : option.label.toLowerCase() || '';
+  let score = 0;
+  const subStringMatchIndex = label.indexOf(searchQuery);
+  const isFullMatch = subStringMatchIndex !== -1;
+  if (isFullMatch) {
+    score = assignFullMatchScore(subStringMatchIndex, label);
+  }
+  if (noMatch(score) && option.synonyms) {
+    score = assignSynonymsScore(option, searchQuery);
+  }
+  if (noMatch(score) && (_config$item = config.item) !== null && _config$item !== void 0 && _config$item.extraFieldsToSearch) {
+    score = assignExtraFieldsScore(config, option, searchQuery);
+  }
+  return {
+    score,
+    label,
+    option
+  };
+};
+const scoreOptions = (searchQuery, labelMapper, config) => (scoredOptions, option) => {
+  const scoredOption = mapToScoreAndLabel(option, searchQuery, labelMapper, config);
+  if (scoredOption.score > 0) {
+    scoredOptions.push(scoredOption);
+  }
+  return scoredOptions;
+};
+const compareByScoreAndLabel = (r1, r2) => (r1.score - r2.score) * 16 + r1.label.localeCompare(r2.label);
 const getAutocompleteSource = config => {
   let options = [];
   (0, _getOptions.default)(config, val => {
     options = val;
   });
-  const labelMaker = config !== null && config !== void 0 && config.item ? _copReactComponents.Utils.itemLabel(config.item) : null;
-  return (query, populateResults) => {
-    const lcQuery = query ? query.toLowerCase() : '';
-
-    // go through all options and give them a grade
-
-    const results = options.map(opt => {
-      const label = labelMaker ? labelMaker(opt) : opt.label || '';
-      const lcLabel = label.toLowerCase();
-
-      // result 'score'
-      let grade = 0;
-
-      // highest result - match at start of string
-      const index = lcLabel.indexOf(lcQuery);
-      if (index === 0) {
-        grade = 1;
-      } else if (index > 0) {
-        grade = lcLabel.substring(index - 1).startsWith(" ") ? 2 : 3;
-      } else {
-        var _config$item;
-        if (opt.synonyms) {
-          const match = opt.synonyms.some(synonym => synonym.toLowerCase().includes(lcQuery));
-          if (match) {
-            grade = 4;
-          }
-        }
-        if (!grade && (_config$item = config.item) !== null && _config$item !== void 0 && _config$item.extraFieldsToSearch) {
-          const found = config.item.extraFieldsToSearch.some(field => {
-            if (typeof opt[field] !== 'string') {
-              return false;
-            }
-            return opt[field].toLowerCase().includes(lcQuery);
-          });
-          if (found) grade = 5;
-        }
-      }
-      return {
-        grade,
-        label,
-        opt
-      };
-    }).filter(result => result.grade > 0);
-
-    // sort results and then map to just opts
-    populateResults(results
-    // the sort prioritises grade but also sorts by string value
-    .sort((r1, r2) => (r1.grade - r2.grade) * 16 + r1.label.localeCompare(r2.label)).map(r => r.opt));
+  const labelMapper = config !== null && config !== void 0 && config.item ? _copReactComponents.Utils.itemLabel(config.item) : null;
+  return (query, renderResult) => {
+    const searchQuery = typeof query === 'string' ? query.toLowerCase() : '';
+    const result = options.reduce(scoreOptions(searchQuery, labelMapper, config), []).sort(compareByScoreAndLabel).slice(0, MAX_NUMBER_RESULTS).map(scoredOptions => scoredOptions.option);
+    renderResult(result);
   };
 };
 var _default = exports.default = getAutocompleteSource;

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

@@ -6,10 +6,9 @@ function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbol
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
-function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } // Local imports
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
 describe('utils', () => {
   describe('Data', () => {
-    // test data
     const gbCurrency = {
       currencyName: 'Great British Pounds',
       currencyCode: 'GBP',
@@ -25,7 +24,7 @@ describe('utils', () => {
       value: 'USD',
       label: 'USD',
       slangTerm: 'bucks',
-      synonyms: ['greenbacks']
+      synonyms: ['greenbacks', 11]
     };
     const options = {
       alpha: {
@@ -81,6 +80,15 @@ describe('utils', () => {
             }]);
           });
         });
+        it('should only return first 6000 results that have some type of match', () => {
+          const moreThanMaxNumberOfOptions = Array(6001).fill(options.alpha);
+          const config = {
+            data: {
+              options: moreThanMaxNumberOfOptions
+            }
+          };
+          (0, _getAutocompleteSource.default)(config)(options.alpha.label, results => expect(results.length).toEqual(6000));
+        });
         it('should handle an empty query', () => {
           const CONFIG = {
             data: {
@@ -117,6 +125,18 @@ describe('utils', () => {
             expect(results).toEqual([options.alpha, options.bravo]);
           });
         });
+        it('should handle a non string query', () => {
+          const CONFIG = {
+            data: {
+              options: [options.alpha, options.bravo]
+            }
+          };
+          const SOURCE = (0, _getAutocompleteSource.default)(CONFIG);
+          SOURCE(1, results => {
+            expect(results.length).toEqual(2);
+            expect(results).toEqual([options.alpha, options.bravo]);
+          });
+        });
         it('should handle a missing label on an option', () => {
           const CONFIG = {
             data: {
@@ -171,8 +191,7 @@ describe('utils', () => {
             item: {
               value: 'currencyCode',
               label: 'currencyCode',
-              // eslint-disable-next-line no-template-curly-in-string
-              format: '${currencyName} (${currencyCode})'
+              format: "${currencyName} (${currencyCode})"
             },
             data: {
               options: testCurrencies
@@ -194,8 +213,7 @@ describe('utils', () => {
             item: {
               value: 'currencyCode',
               label: 'currencyCode',
-              // eslint-disable-next-line no-template-curly-in-string
-              format: '${currencyName} (${currencyCode})'
+              format: "${currencyName} (${currencyCode})"
             },
             data: {
               options: testCurrencies
@@ -212,8 +230,7 @@ describe('utils', () => {
             item: {
               value: 'currencyCode',
               label: 'currencyCode',
-              // eslint-disable-next-line no-template-curly-in-string
-              format: '${currencyName} (${currencyCode})'
+              format: "${currencyName} (${currencyCode})"
             },
             data: {
               options: testCurrencies
@@ -230,8 +247,7 @@ describe('utils', () => {
             item: {
               value: 'currencyCode',
               label: 'currencyCode',
-              // eslint-disable-next-line no-template-curly-in-string
-              format: '${currencyName} (${currencyCode})'
+              format: "${currencyName} (${currencyCode})"
             },
             data: {
               options: testCurrencies
@@ -248,8 +264,7 @@ describe('utils', () => {
             item: {
               value: 'currencyCode',
               label: 'currencyCode',
-              // eslint-disable-next-line no-template-curly-in-string
-              format: '${currencyName} (${currencyCode})'
+              format: "${currencyName} (${currencyCode})"
             },
             data: {
               options: [gbCurrency, {
@@ -281,8 +296,7 @@ describe('utils', () => {
             item: {
               value: 'currencyCode',
               label: 'currencyCode',
-              // eslint-disable-next-line no-template-curly-in-string
-              format: '${currencyName} (${currencyCode})'
+              format: "${currencyName} (${currencyCode})"
             },
             data: {
               options: testCurrencies
@@ -300,9 +314,8 @@ describe('utils', () => {
             item: {
               value: 'currencyCode',
               label: 'currencyCode',
-              // eslint-disable-next-line no-template-curly-in-string
-              format: '${currencyName} (${currencyCode})',
-              extraFieldsToSearch: ['slangTerm']
+              format: "${currencyName} (${currencyCode})",
+              extraFieldsToSearch: ['slangTerm', null]
             },
             data: {
               options: testCurrencies

package/dist/utils/Validate/validateOnPageLoad.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.doValidateOnPageLoad = void 0;
+var _Condition = _interopRequireDefault(require("../Condition"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+const doValidateOnPageLoad = page => {
+  var _validation$runWhen, _validation$runWhen2;
+  if (!(page !== null && page !== void 0 && page.customValidation)) return false;
+
+  // Find the validation with `onLoad` set to true
+  const validation = page === null || page === void 0 ? void 0 : page.customValidation.find(item => {
+    var _item$runWhen;
+    return ((_item$runWhen = item.runWhen) === null || _item$runWhen === void 0 ? void 0 : _item$runWhen.onLoad) === true;
+  });
+  if (!validation) return false;
+
+  // Check if the constraint is met using the condition
+  return (_validation$runWhen = validation.runWhen) !== null && _validation$runWhen !== void 0 && _validation$runWhen.constraint ? _Condition.default.meetsOne((_validation$runWhen2 = validation.runWhen) === null || _validation$runWhen2 === void 0 ? void 0 : _validation$runWhen2.constraint, page.formData) : false;
+};
+exports.doValidateOnPageLoad = doValidateOnPageLoad;

package/dist/utils/Validate/validateOnPageLoad.test.js

@@ -0,0 +1,88 @@
+"use strict";
+
+var _Condition = _interopRequireDefault(require("../Condition"));
+var _validateOnPageLoad = require("./validateOnPageLoad");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+describe('doValidateOnPageLoad', () => {
+  const formData = {
+    people: [{
+      name: 'John Doe'
+    }, {
+      name: 'Jane Doe'
+    }]
+  };
+  it('should return false if page.customValidation is not defined', () => {
+    const page = {
+      formData
+    };
+    const result = (0, _validateOnPageLoad.doValidateOnPageLoad)(page);
+    expect(result).toBe(false);
+  });
+  it('should return false if no validation item has onLoad set to true', () => {
+    const page = {
+      customValidation: [{
+        message: "Validation without onLoad",
+        runWhen: {
+          onLoad: false
+        }
+      }],
+      formData
+    };
+    const result = (0, _validateOnPageLoad.doValidateOnPageLoad)(page);
+    expect(result).toBe(false);
+  });
+  it('should return false if validation constraint is not met', () => {
+    const page = {
+      customValidation: [{
+        message: "Update all people details before continuing",
+        runWhen: {
+          onLoad: true,
+          constraint: [{
+            field: 'people',
+            op: _Condition.default.GREATER_THAN,
+            value: 3 // Condition that will fail
+          }]
+        }
+      }],
+      formData
+    };
+    jest.spyOn(_Condition.default, 'meetsOne').mockImplementation(() => false);
+    const result = (0, _validateOnPageLoad.doValidateOnPageLoad)(page);
+    expect(result).toBe(false);
+    expect(_Condition.default.meetsOne).toHaveBeenCalledWith(page.customValidation[0].runWhen.constraint, formData);
+  });
+  it('should return true if validation constraint is met', () => {
+    const page = {
+      customValidation: [{
+        message: "Update all people details before continuing",
+        runWhen: {
+          onLoad: true,
+          constraint: [{
+            field: 'people',
+            op: _Condition.default.GREATER_THAN,
+            value: 0 // Condition that will pass
+          }]
+        }
+      }],
+      formData
+    };
+    jest.spyOn(_Condition.default, 'meetsOne').mockImplementation(() => true);
+    const result = (0, _validateOnPageLoad.doValidateOnPageLoad)(page);
+    expect(result).toBe(true);
+    expect(_Condition.default.meetsOne).toHaveBeenCalledWith(page.customValidation[0].runWhen.constraint, formData);
+  });
+  it('should return false if no matching validation is found', () => {
+    const page = {
+      customValidation: [{
+        message: "Validation without constraint",
+        runWhen: {
+          onLoad: true,
+          constraint: null
+        }
+      }],
+      formData
+    };
+    const result = (0, _validateOnPageLoad.doValidateOnPageLoad)(page);
+    expect(result).toBe(false);
+  });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ukhomeoffice/cop-react-form-renderer",
-  "version": "6.14.3-test",
+  "version": "6.14.4",
   "private": false,
   "scripts": {
     "clean": "rimraf dist",