Using SearchResult instance as result of searchSpecifications & scrollSpecifications

Author: samniisan

src/Collection.js

@@ -699,7 +699,6 @@ Collection.prototype.search = function (filters, options, cb) {
 
   query = self.kuzzle.addHeaders({body: filters}, this.headers);
 
-
   self.kuzzle.query(this.buildQueryArgs('document', 'search'), query, options, function (error, result) {
     var documents = [];
 
@@ -811,7 +810,8 @@ Collection.prototype.scroll = function (scrollId, options, filters, cb) {
  */
 Collection.prototype.scrollSpecifications = function (scrollId, options, cb) {
   var
-    data = { scrollId: scrollId };
+    data = { scrollId: scrollId },
+    self = this;
 
   if (!scrollId) {
     throw new Error('Collection.scrollSpecifications: scrollId is required');
@@ -828,14 +828,36 @@ Collection.prototype.scrollSpecifications = function (scrollId, options, cb) {
     data.scroll = options.scroll;
   }
 
-  this.kuzzle.query(
-    { controller: 'collection', action: 'scrollSpecifications'},
-    this.kuzzle.addHeaders(data, this.headers),
-    options,
-    function (err, res) {
-      cb (err, err ? undefined : res.result);
+  this.kuzzle.query({ controller: 'collection', action: 'scrollSpecifications'}, this.kuzzle.addHeaders(data, this.headers), options, function (err, res) {
+    var
+      documents = [];
+
+    if (err) {
+      return cb(err);
+    }
+
+    res.result.hits.forEach(function (doc) {
+      var newDocument = new Document(self, doc._id, doc._source, doc._meta);
+
+      newDocument.version = doc._version;
+
+      documents.push(newDocument);
+    });
+
+    if (res.result.scrollId) {
+      options.scrollId = res.result.scrollId;
     }
-  );
+
+    cb(null, new KuzzleSearchResult(
+      self,
+      res.result.total,
+      documents,
+      res.result.aggregations ? res.result.aggregations : {},
+      options,
+      null,
+      options.previous || null
+    ));
+  });
 };
 
 /**
@@ -860,7 +882,34 @@ Collection.prototype.searchSpecifications = function (filters, options, cb) {
   data = self.kuzzle.addHeaders(data, this.headers);
 
   self.kuzzle.query({ controller: 'collection', action: 'searchSpecifications' }, data, options, function (err, res) {
-    cb(err, err ? undefined : res.result);
+    var
+      documents = [];
+
+    if (err) {
+      return cb(err);
+    }
+
+    res.result.hits.forEach(function (doc) {
+      var newDocument = new Document(self, doc._id, doc._source, doc._meta);
+
+      newDocument.version = doc._version;
+
+      documents.push(newDocument);
+    });
+
+    if (res.result.scrollId) {
+      options.scrollId = res.result.scrollId;
+    }
+
+    cb(null, new KuzzleSearchResult(
+      self,
+      res.result.total,
+      documents,
+      res.result.aggregations ? res.result.aggregations : {},
+      options,
+      filters,
+      options.previous || null
+    ));
   });
 };
 

test/Collection/methods.test.js

@@ -179,11 +179,11 @@ describe('Collection methods', function () {
 
       collection.scrollSpecifications(scrollId, options, function(err, res) {
         should(err).be.null();
-        should(res).be.an.instanceOf(Object).and.match(result.result);
-        should(res.total).be.a.Number().and.be.exactly(result.result.total);
-        should(res.hits).be.an.Array();
-        should(res.hits.length).be.exactly(result.result.hits.length);
-        should(res.scrollId).be.exactly('1337');
+        should(res).be.an.instanceOf(SearchResult);
+        should(res.getTotal()).be.a.Number().and.be.exactly(result.result.total);
+        should(res.getDocuments()).be.an.Array();
+        should(res.getDocuments().length).be.exactly(result.result.hits.length);
+        should(res.options.scrollId).be.exactly('1337');
 
         done();
       });
@@ -1252,11 +1252,11 @@ describe('Collection methods', function () {
 
       collection.searchSpecifications(filters, options, function (err, res) {
         should(err).be.null();
-        should(res).be.an.instanceOf(Object).and.match(result.result);
-        should(res.total).be.a.Number().and.be.exactly(result.result.total);
-        should(res.hits).be.an.Array();
-        should(res.hits.length).be.exactly(result.result.hits.length);
-        should(res.scrollId).be.exactly('1337');
+        should(res).be.an.instanceOf(SearchResult);
+        should(res.getTotal()).be.a.Number().and.be.exactly(result.result.total);
+        should(res.getDocuments()).be.an.Array();
+        should(res.getDocuments().length).be.exactly(result.result.hits.length);
+        should(res.options.scrollId).be.exactly('1337');
 
         done();
       });