Search uid field can now be an array (for nested/deep keys).

Author: Brian Vaughn

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 1.4.0
+Search uid field can now be an array (for nested/deep keys).
+
 ## 1.3.7
 Fixed `package.json` to include correct files.
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "js-search",
-  "version": "1.3.7",
+  "version": "1.4.0",
   "description": "### What is it?",
   "main": "dist/commonjs/index.js",
   "directories": {

source/Search.js

@@ -1,4 +1,5 @@
 // @flow
+import getNestedFieldValue from './getNestedFieldValue';
 
 import { PrefixIndexStrategy } from './IndexStrategy/index';
 import { LowerCaseSanitizer } from './Sanitizer/index';
@@ -29,14 +30,14 @@ export class Search {
 
   _searchIndex : ISearchIndex;
   _tokenizer : ITokenizer;
-  _uidFieldName : string;
+  _uidFieldName : string | Array<string>;
 
   /**
    * Constructor.
    * @param uidFieldName Field containing values that uniquely identify search documents; this field's values are used
    *                     to ensure that a search result set does not contain duplicate objects.
    */
-  constructor(uidFieldName : string) {
+  constructor(uidFieldName : string | Array<string>) {
     this._uidFieldName = uidFieldName;
 
     // Set default/recommended strategies
@@ -168,7 +169,13 @@ export class Search {
 
     for (var di = 0, numDocuments = documents.length; di < numDocuments; di++) {
       var doc = documents[di];
-      var uid = doc[uidFieldName];
+      var uid;
+
+      if (uidFieldName instanceof Array) {
+        uid = getNestedFieldValue(doc, uidFieldName);
+      } else {
+        uid = doc[uidFieldName];
+      }
 
       for (var sfi = 0, numSearchableFields = _searchableFields.length; sfi < numSearchableFields; sfi++) {
         var fieldValue;
@@ -206,28 +213,3 @@ export class Search {
     }
   }
 }
-
-/**
- * Find and return a nested object value.
- *
- * @param object to crawl
- * @param path Property path
- * @returns {any}
- */
-function getNestedFieldValue(object : Object, path : Array<string>) {
-  path = path || [];
-  object = object || {};
-
-  var value = object;
-
-  // walk down the property path
-  for (var i = 0; i < path.length; i++) {
-    value = value[path[i]];
-
-    if (value == null) {
-      return null;
-    }
-  }
-
-  return value;
-}

source/Search.test.js

@@ -115,4 +115,35 @@ describe('Search', function() {
 
     validateSearchResults(search.search('nested foo'), []);
   });
+
+  it('should support nested uid paths', function() {
+    const melissaSmith = {
+      name: 'Melissa Smith',
+      email: '[email protected]',
+      login: {
+        userId: 2562,
+        username: 'heavycat937'
+      }
+    };
+    const johnSmith = {
+      name: 'John Smith',
+      email: '[email protected]',
+      login: {
+        userId: 54213,
+        username: 'jhon123'
+      }
+    };
+
+    var search = new Search(['login', 'userId']);
+    search.addIndex('title');
+    search.addIndex(['login', 'username']);
+    search.addIndex('name');
+    search.addIndex('email');
+    search.addDocuments([melissaSmith, johnSmith]);
+
+    validateSearchResults(search.search('Smith'), [melissaSmith, johnSmith]);
+    validateSearchResults(search.search('allen'), [melissaSmith, johnSmith]);
+    validateSearchResults(search.search('heavycat937'), [melissaSmith]);
+    validateSearchResults(search.search('jhon123'), [johnSmith]);
+  });
 });

source/SearchIndex/TfIdfSearchIndex.js

@@ -1,4 +1,5 @@
 // @flow
+import getNestedFieldValue from '../getNestedFieldValue';
 
 import type { ISearchIndex } from './SearchIndex';
 
@@ -25,11 +26,11 @@ type ITfIdfUidMetadata = {
  * Search index capable of returning results matching a set of tokens and ranked according to TF-IDF.
  */
 export class TfIdfSearchIndex implements ISearchIndex {
-  _uidFieldName : string;
+  _uidFieldName : string | Array<string>;
   _tokenToIdfCache : {[token : string] : number};
   _tokenMap : ITfIdfTokenMap;
 
-  constructor(uidFieldName : string) {
+  constructor(uidFieldName : string | Array<string>) {
     this._uidFieldName = uidFieldName;
     this._tokenToIdfCache = {};
     this._tokenMap = {};
@@ -108,10 +109,6 @@ export class TfIdfSearchIndex implements ISearchIndex {
       documents.push(uidToDocumentMap[uid]);
     }
 
-    var tokenMap = this._tokenMap;
-    var tokenToIdfCache = this._tokenToIdfCache;
-    var uidFieldName = this._uidFieldName;
-
     var calculateTfIdf = this._createCalculateTfIdf();
 
     // Return documents sorted by TF-IDF
@@ -155,7 +152,13 @@ export class TfIdfSearchIndex implements ISearchIndex {
           inverseDocumentFrequency = 0;
         }
 
-        var uid:any = document && document[uidFieldName];
+        var uid:any;
+        if (uidFieldName instanceof Array) {
+          uid = document && getNestedFieldValue(document, uidFieldName);
+        } else {
+          uid = document && document[uidFieldName];
+        }
+
         var termFrequency:number =
           typeof tokenMap[token] !== 'undefined' &&
           typeof tokenMap[token].$uidMap[uid] !== 'undefined'

source/SearchIndex/TfIdfSearchIndex.test.js

@@ -138,4 +138,29 @@ describe('Search', function() {
       expect(results[2]).toEqual(documentB);
     });
   });
+
+  it('should support nested uid paths', function() {
+    const melissaSmith = {
+      name: 'Melissa Smith',
+      login: {
+        userId: 2562
+      }
+    };
+    const johnSmith = {
+      name: 'John Smith',
+      login: {
+        userId: 54213
+      }
+    };
+
+    var searchIndex = new TfIdfSearchIndex(['login', 'userId']);
+    searchIndex.indexDocument(['Melissa'], 2562, melissaSmith);
+    searchIndex.indexDocument(['Smith'], 2562, melissaSmith);
+    searchIndex.indexDocument(['John'], 54213, johnSmith);
+    searchIndex.indexDocument(['Smith'], 54213, johnSmith);
+
+    expect(searchIndex.search(['Melissa'], [melissaSmith, johnSmith])).toEqual([melissaSmith]);
+    expect(searchIndex.search(['John'], [melissaSmith, johnSmith])).toEqual([johnSmith]);
+    expect(searchIndex.search(['Smith'], [melissaSmith, johnSmith])).toEqual([melissaSmith, johnSmith]);
+  });
 });

source/getNestedFieldValue.js

@@ -0,0 +1,24 @@
+/**
+ * Find and return a nested object value.
+ *
+ * @param object to crawl
+ * @param path Property path
+ * @returns {any}
+ */
+export default function getNestedFieldValue(object : Object, path : Array<string>) {
+  path = path || [];
+  object = object || {};
+
+  var value = object;
+
+  // walk down the property path
+  for (var i = 0; i < path.length; i++) {
+    value = value[path[i]];
+
+    if (value == null) {
+      return null;
+    }
+  }
+
+  return value;
+}