@ukhomeoffice/cop-react-form-renderer 5.7.0 → 5.8.0

package/dist/utils/Data/getAutocompleteSource.js

@@ -21,7 +21,12 @@ var getAutocompleteSource = function getAutocompleteSource(config) {
     var lcQuery = query ? query.toLowerCase() : '';
     populateResults(options.filter(function (opt) {
       var label = labelMaker ? labelMaker(opt) : opt.label || '';
-      return label.toLowerCase().includes(lcQuery);
+      if (label.toLowerCase().includes(lcQuery)) {
+        return true;
+      }
+      return opt.synonyms ? opt.synonyms.some(function (synonym) {
+        return synonym.toLowerCase().includes(lcQuery);
+      }) : false;
     }));
   };
 };

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

@@ -141,6 +141,29 @@ describe('utils', function () {
             }]);
           });
         });
+        it('should match options using a defined synonym', function () {
+          var CONFIG = {
+            data: {
+              options: [{
+                value: 'a',
+                label: 'Alpha',
+                synonyms: ['first']
+              }, {
+                value: 'b'
+              }]
+            }
+          };
+          var SOURCE = (0, _getAutocompleteSource.default)(CONFIG);
+          expect(typeof SOURCE === 'function').toBeTruthy();
+          SOURCE('first', function (results) {
+            expect(results.length).toEqual(1);
+            expect(results).toEqual([{
+              value: 'a',
+              label: 'Alpha',
+              synonyms: ['first']
+            }]);
+          });
+        });
       });
       describe('with custom item labels', function () {
         it('should get any specified options from the config', function () {
@@ -346,6 +369,42 @@ describe('utils', function () {
             }]);
           });
         });
+        it('should match options using a defined synonym', function () {
+          var CONFIG = {
+            item: {
+              value: 'currencyCode',
+              label: 'currencyCode',
+              // eslint-disable-next-line no-template-curly-in-string
+              format: '${currencyName} (${currencyCode})'
+            },
+            data: {
+              options: [{
+                currencyName: 'Great British Pounds',
+                currencyCode: 'GBP',
+                value: 'GBP',
+                label: 'GBP'
+              }, {
+                currencyName: 'United States Dollars',
+                currencyCode: 'USD',
+                value: 'USD',
+                label: 'USD',
+                synonyms: ['bucks']
+              }]
+            }
+          };
+          var SOURCE = (0, _getAutocompleteSource.default)(CONFIG);
+          expect(typeof SOURCE === 'function').toBeTruthy();
+          SOURCE('bucks', function (results) {
+            expect(results.length).toEqual(1);
+            expect(results).toEqual([{
+              currencyName: 'United States Dollars',
+              currencyCode: 'USD',
+              value: 'USD',
+              label: 'USD',
+              synonyms: ['bucks']
+            }]);
+          });
+        });
       });
     });
   });

package/package.json

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