Add category and custom fields filters

Author: anttiai

README.md

@@ -2,7 +2,7 @@
 
 [AddSearch](https://www.addsearch.com) is a hosted search platform for all your web content. This API 
 Client lets you easily use the [AddSearch Search API](https://www.addsearch.com/support/api-reference/) 
-from your JavaScript code. This client works on web browsers and with Node.js.
+from your JavaScript code on web browsers or with Node.js.
 
 ## Quick Start
 ```js
@@ -17,9 +17,6 @@ var cb = function(res) {
 
 // Execute search. Callback function cb will be called with search results
 client.search('keyword', cb);
-
-// Get search suggestions for a keyword
-client.suggest('api', cb);
 ```
 
 ## Publicly accessible functions
@@ -53,6 +50,32 @@ client.setLanguage('en');
 client.setDateFilter('2019-01-01', '2019-01-31');
 ```
 
+#### Define category filters 
+Filter by URL patterns, document types or *addsearch-category* meta tag values.
+See [full documentation.](https://www.addsearch.com/support/documentation/ranking-relevance-filters/filters/#category-filters)
+
+```js
+// Only PDF files or products
+client.setCategoryFilters('doctype_pdf,products');
+```
+
+#### Custom field filters
+Filter by custom fields. Custon fields can be defined in meta tags or AddSearch crawler can pick them up from your HTML or JSON data.
+See [full documentation.](https://www.addsearch.com/support/documentation/ranking-relevance-filters/custom-field/)
+
+```js
+// Search by specific city (Berlin, Paris or Boston)
+client.addCustomFieldFilter('city','berlin');
+client.addCustomFieldFilter('city','paris');
+client.addCustomFieldFilter('city','boston');
+
+// Remove paris (Berlin and Boston remaining)
+client.removeCustomFieldFilter('city','paris');
+
+// Remove all cities
+client.removeCustomFieldFilter('city');
+```
+
 #### Manage paging
 ```js
 // Defaults: page "1", pageSize "10", sortBy "relevance", sortOrder "desc"
@@ -65,31 +88,35 @@ client.nextPage();
 client.previousPage();
 ```
 
-## Browser support
-The client is tested on following browsers
+## Supported web browsers and node.js versions
+The client is tested on
 - Chrome
 - Firefox
 - Edge
 - Safari 6.1+
 - Internet Explorer 10+
+- Node.js 4+
+
 
 ## Development
 To modify this client library, clone this repository to your computer and execute following commands.
-### Install dependencies
+#### Install dependencies
 ```sh
 npm install
 ```
 
-### Run tests
+#### Run tests
 ```sh
 npm test
 ```
 
-### Build
-To build the client, run:
-
+#### Build
 ```sh
 npm run build
 ```
 
-Built bundle is saved under the *dist/* folder
+Built bundle is saved under the *dist/* folder
+
+## Support
+
+Feel free to semd any questions, ideas and suggestions at [support@addsearch.com](support@addsearch.com).

src/apifetch.js

@@ -39,12 +39,20 @@ var executeApiFetch = function(sitekey, type, settings, cb) {
   if (type === 'search') {
     qs = settingToQueryParam(settings.lang, 'lang') +
          settingToQueryParam(settings.fuzzy, 'fuzzy') +
+         settingToQueryParam(settings.categories, 'categories') +
          settingToQueryParam(settings.dateFrom, 'dateFrom') +
          settingToQueryParam(settings.dateTo, 'dateTo') +
          settingToQueryParam(settings.paging.page, 'page') +
          settingToQueryParam(settings.paging.pageSize, 'limit') +
          settingToQueryParam(settings.paging.sortBy, 'sort') +
          settingToQueryParam(settings.paging.sortOrder, 'order');
+
+    // Add custom field filters
+    if (settings.customFieldFilters) {
+      for (var i=0; i<settings.customFieldFilters.length; i++) {
+        qs = qs + '&customField=' + settings.customFieldFilters[i];
+      }
+    }
   }
 
 

src/index.js

@@ -29,7 +29,7 @@ var client = function(sitekey) {
 
     this.settings.setKeyword(keyword);
     executeApiFetch(this.sitekey, 'search', this.settings.getSettings(), callback);
-  };
+  }
 
 
   /**
@@ -39,19 +39,22 @@ var client = function(sitekey) {
    */
   this.suggest = function(keyword, callback) {
     executeApiFetch(this.sitekey, 'suggest', this.settings.getSettings(), callback);
-  };
+  }
 
 
   /**
    * Public functions
    */
   this.getSettings = function() { return this.settings.getSettings(); }
-  this.setLanguage = function(lang) { this.settings.setLanguage(lang); };
-  this.useFuzzyMatch = function(use) { this.settings.useFuzzyMatch(use); };
-  this.setDateFilter = function(dateFrom, dateTo) { this.settings.setDateFilter(dateFrom, dateTo); };
-  this.setPaging = function(page, pageSize, sortBy, sortOder) { this.settings.setPaging(page, pageSize, sortBy, sortOder); };
-  this.nextPage = function() { this.settings.nextPage(); };
-  this.previousPage = function() { this.settings.previousPage(); };
+  this.setLanguage = function(lang) { this.settings.setLanguage(lang); }
+  this.useFuzzyMatch = function(use) { this.settings.useFuzzyMatch(use); }
+  this.setCategoryFilters = function(categories) { this.settings.setCategoryFilters(categories); }
+  this.addCustomFieldFilter = function(fieldName, value) { this.settings.addCustomFieldFilter(fieldName, value); }
+  this.removeCustomFieldFilter = function(fieldName, value) { this.settings.removeCustomFieldFilter(fieldName, value); }
+  this.setDateFilter = function(dateFrom, dateTo) { this.settings.setDateFilter(dateFrom, dateTo); }
+  this.setPaging = function(page, pageSize, sortBy, sortOder) { this.settings.setPaging(page, pageSize, sortBy, sortOder); }
+  this.nextPage = function() { this.settings.nextPage(); }
+  this.previousPage = function() { this.settings.previousPage(); }
 
 }
 

src/settings.js

@@ -9,7 +9,8 @@ var settings = function() {
       pageSize: 10,
       sortBy: 'relevance',
       sortOrder: 'desc'
-    }
+    },
+    customFieldFilters: []
   };
 
   this.getSettings = function() {
@@ -31,6 +32,37 @@ var settings = function() {
     this.settings.fuzzy = fuzzy;
   }
 
+  this.setCategoryFilters = function(categories) {
+    this.settings.categories = categories;
+  }
+
+  this.addCustomFieldFilter = function(fieldName, value) {
+    var filter = encodeURIComponent(fieldName + '=' + value);
+    this.settings.customFieldFilters.push(filter);
+  }
+
+  this.removeCustomFieldFilter = function(fieldName, value) {
+    var removeAll = false;
+    var filter = encodeURIComponent(fieldName + '=' + value);
+
+    // Remove all by fieldName
+    if (!value) {
+      removeAll = true;
+      filter = encodeURIComponent(fieldName + '=');
+    }
+
+    for (var i=this.settings.customFieldFilters.length; i>0; i--) {
+      var v = this.settings.customFieldFilters[i-1];
+
+      if (removeAll && v.indexOf(filter) === 0) {
+        this.settings.customFieldFilters.splice(i-1, 1);
+      }
+      else if (v === filter) {
+        this.settings.customFieldFilters.splice(i-1, 1);
+      }
+    }
+  }
+
   this.setDateFilter = function(dateFrom, dateTo) {
     this.settings.dateFrom = dateFrom;
     this.settings.dateTo = dateTo;