@ukhomeoffice/cop-react-form-renderer 6.14.9 → 6.15.2-alpha

package/dist/utils/Data/getAutocompleteSource.js

@@ -7,80 +7,63 @@ 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 }; }
-const MAX_NUMBER_RESULTS = 6000; // lower is better for performance, this still includes all ports
+// Global Imports
+
+// Local imports
 
-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 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);
+  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));
   };
 };
 var _default = exports.default = getAutocompleteSource;

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

@@ -6,9 +6,10 @@ 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); }
+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
 describe('utils', () => {
   describe('Data', () => {
+    // test data
     const gbCurrency = {
       currencyName: 'Great British Pounds',
       currencyCode: 'GBP',
@@ -24,7 +25,7 @@ describe('utils', () => {
       value: 'USD',
       label: 'USD',
       slangTerm: 'bucks',
-      synonyms: ['greenbacks', 11]
+      synonyms: ['greenbacks']
     };
     const options = {
       alpha: {
@@ -80,15 +81,6 @@ 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: {
@@ -125,18 +117,6 @@ 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: {
@@ -191,7 +171,8 @@ describe('utils', () => {
             item: {
               value: 'currencyCode',
               label: 'currencyCode',
-              format: "${currencyName} (${currencyCode})"
+              // eslint-disable-next-line no-template-curly-in-string
+              format: '${currencyName} (${currencyCode})'
             },
             data: {
               options: testCurrencies
@@ -213,7 +194,8 @@ describe('utils', () => {
             item: {
               value: 'currencyCode',
               label: 'currencyCode',
-              format: "${currencyName} (${currencyCode})"
+              // eslint-disable-next-line no-template-curly-in-string
+              format: '${currencyName} (${currencyCode})'
             },
             data: {
               options: testCurrencies
@@ -230,7 +212,8 @@ describe('utils', () => {
             item: {
               value: 'currencyCode',
               label: 'currencyCode',
-              format: "${currencyName} (${currencyCode})"
+              // eslint-disable-next-line no-template-curly-in-string
+              format: '${currencyName} (${currencyCode})'
             },
             data: {
               options: testCurrencies
@@ -247,7 +230,8 @@ describe('utils', () => {
             item: {
               value: 'currencyCode',
               label: 'currencyCode',
-              format: "${currencyName} (${currencyCode})"
+              // eslint-disable-next-line no-template-curly-in-string
+              format: '${currencyName} (${currencyCode})'
             },
             data: {
               options: testCurrencies
@@ -264,7 +248,8 @@ describe('utils', () => {
             item: {
               value: 'currencyCode',
               label: 'currencyCode',
-              format: "${currencyName} (${currencyCode})"
+              // eslint-disable-next-line no-template-curly-in-string
+              format: '${currencyName} (${currencyCode})'
             },
             data: {
               options: [gbCurrency, {
@@ -296,7 +281,8 @@ describe('utils', () => {
             item: {
               value: 'currencyCode',
               label: 'currencyCode',
-              format: "${currencyName} (${currencyCode})"
+              // eslint-disable-next-line no-template-curly-in-string
+              format: '${currencyName} (${currencyCode})'
             },
             data: {
               options: testCurrencies
@@ -314,8 +300,9 @@ describe('utils', () => {
             item: {
               value: 'currencyCode',
               label: 'currencyCode',
-              format: "${currencyName} (${currencyCode})",
-              extraFieldsToSearch: ['slangTerm', null]
+              // eslint-disable-next-line no-template-curly-in-string
+              format: '${currencyName} (${currencyCode})',
+              extraFieldsToSearch: ['slangTerm']
             },
             data: {
               options: testCurrencies

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ukhomeoffice/cop-react-form-renderer",
-  "version": "6.14.9",
+  "version": "6.15.2-alpha",
   "private": false,
   "scripts": {
     "clean": "rimraf dist",
@@ -16,7 +16,7 @@
     "yalc-publish": "yarn compile-with-maps && cp -r src dist/src && yalc publish --push"
   },
   "dependencies": {
-    "@ukhomeoffice/cop-react-components": "4.7.11",
+    "@ukhomeoffice/cop-react-components": "4.7.4",
     "axios": "^0.23.0",
     "dayjs": "^1.11.0",
     "govuk-frontend": "^5.0.0",

package/dist/utils/Validate/validateOnPageLoad.js

@@ -1,23 +0,0 @@
-"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

@@ -1,88 +0,0 @@
-"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);
-  });
-});