Merge pull request #36 from AddSearch/support-multiple-sort-options

support sortOptions in array

Author: haoAddsearch

README.md

@@ -143,6 +143,20 @@ Set page number, page size and sorting parameters. It's possible to order result
 - relevance (descending)
 - date (ascending or descending)
 - custom field value (ascending or descending. E.g. *custom_fields.price*)
+
+Type of sortBy and sortOrder: `string` or `array`. They must have the same type, in case type is array, sortBy and sortOrder must have the same size.
+For example:
+```js
+sortBy = 'date';
+sortOrder = 'desc';
+
+or
+
+sortBy = ['date', 'custom_fields.price'];
+sortOrder = ['desc', 'asc'];
+```
+
+
 ```js
 // Defaults: page "1", pageSize "10", sortBy "relevance", sortOrder "desc"
 client.setPaging(page, pageSize, sortBy, sortOrder);

src/apifetch.js

@@ -75,8 +75,6 @@ var executeApiFetch = function(apiHostname, sitekey, type, settings, cb, fuzzyRe
         settingToQueryParam(settings.dateTo, 'dateTo') +
         settingToQueryParam(settings.paging.page, 'page') +
         settingToQueryParam(settings.paging.pageSize, 'limit') +
-        settingToQueryParam(settings.paging.sortBy, 'sort') +
-        settingToQueryParam(settings.paging.sortOrder, 'order') +
         settingToQueryParam(settings.shuffleAndLimitTo, 'shuffleAndLimitTo') +
         settingToQueryParam(settings.jwt, 'jwt') +
         settingToQueryParam(settings.resultType, 'resultType') +
@@ -87,6 +85,17 @@ var executeApiFetch = function(apiHostname, sitekey, type, settings, cb, fuzzyRe
         settingToQueryParam(settings.analyticsTag, 'analyticsTag') +
         settingToQueryParam(settings.hierarchicalFacetSetting, 'hierarchicalFacets');
 
+      // Add sortBy and sortOrder
+      if (Array.isArray(settings.paging.sortBy)) {
+        settings.paging.sortBy.forEach(function(value, index) {
+          qs = qs + settingToQueryParam(value, 'sort') +
+            settingToQueryParam(settings.paging.sortOrder[index], 'order');
+        });
+      } else {
+        qs = qs + settingToQueryParam(settings.paging.sortBy, 'sort') +
+          settingToQueryParam(settings.paging.sortOrder, 'order');
+      }
+
       // Add custom field filters
       if (settings.customFieldFilters) {
         for (let i = 0; i < settings.customFieldFilters.length; i++) {

src/settings.js

@@ -1,5 +1,6 @@
 'use strict';
 
+var util = require('./util');
 var settings = function() {
   this.settings = {
     keyword: '*',
@@ -203,15 +204,7 @@ var settings = function() {
 
   this.setPaging = function(page, pageSize, sortBy, sortOrder) {
     // Validate
-    if (page < 1) {
-      throw "page must be 1 or bigger";
-    }
-    if (pageSize < 1 || pageSize > 300) {
-      throw "pageSize must be 1-300";
-    }
-    if (sortOrder !== 'asc' && sortOrder !== 'desc') {
-      throw "sortOrder must be asc or desc";
-    }
+    util.validateSetPagingParams(page, pageSize, sortBy, sortOrder);
 
     this.settings.paging.page = page;
     this.settings.paging.pageSize = pageSize;

src/util.js

@@ -14,7 +14,33 @@ const base64 = function(s) {
   }
 }
 
+const validateSetPagingParams = function(page, pageSize, sortBy, sortOrder) {
+  if (page < 1) {
+    throw "page must be 1 or bigger";
+  }
+  if (pageSize < 1 || pageSize > 300) {
+    throw "pageSize must be 1-300";
+  }
+  if (!sortBy || !sortOrder) {
+    throw "invalid values for sortBy or sortOrder: " + sortBy + ", " + sortOrder;
+  }
+  if (!((typeof sortBy == 'string' && typeof sortOrder == 'string') || (Array.isArray(sortBy) && Array.isArray(sortOrder)))) {
+    throw "sortBy and sortOrder must have the same type: string or Array";
+  }
+  if (Array.isArray(sortBy) && sortBy.length !== sortOrder.length) {
+    throw "sortBy and sortOrder must have the same size";
+  }
+  if (typeof sortOrder == 'string' && sortOrder !== 'asc' && sortOrder !== 'desc') {
+    throw "sortOrder must be asc or desc";
+  }
+  if (Array.isArray(sortOrder) &&
+    sortOrder.filter(function(e) {return e !== 'desc' && e!=='asc'}).length > 0) {
+    throw "all values of sortOrder array must be asc or desc";
+  }
+}
+
 module.exports = {
   isFunction,
-  base64
+  base64,
+  validateSetPagingParams: validateSetPagingParams
 }