Merge branch 'master' into 5.x

# Conflicts:
#	src/Document.js
#	test/Collection/methods.test.js
#	test/security/kuzzleSecurity/userMethods.test.js

Author: ballinette

CHANGELOG.md

@@ -1,3 +1,17 @@
+# [4.0.1](https://github.com/kuzzleio/sdk-javascript/releases/tag/4.0.1) (2017-05-9)
+
+[Full Changelog](https://github.com/kuzzleio/sdk-javascript/compare/4.0.1...4.0.1)
+
+### Compatibility
+
+| Kuzzle | Proxy |
+|--------|-------|
+| 1.0.0-RC10 | 1.0.0-RC10 |
+
+#### Enhancements
+
+- [ [#200](https://github.com/kuzzleio/sdk-javascript/pull/200) ] Add kuzzle info in Document object   ([AnthonySendra](https://github.com/AnthonySendra))
+
 # [4.0.0](https://github.com/kuzzleio/sdk-javascript/releases/tag/4.0.0) (2017-04-10)
 
 [Full Changelog](https://github.com/kuzzleio/sdk-javascript/compare/4.0.0...4.0.0)
@@ -36,6 +50,7 @@
 - [ [#177](https://github.com/kuzzleio/sdk-javascript/pull/177) ] Remove previous and next cache in SearchResult   ([dbengsch](https://github.com/dbengsch))
 - [ [#177](https://github.com/kuzzleio/sdk-javascript/pull/177) ] Remove previous and next cache in SearchResult   ([dbengsch](https://github.com/dbengsch))
 - [ [#184](https://github.com/kuzzleio/sdk-javascript/pull/184) ] Browsers compatibility fix   ([scottinet](https://github.com/scottinet))
+
 ---
 
 # 3.4.0

README.md

@@ -26,7 +26,13 @@ You can access the Kuzzle repository on [Github](https://github.com/kuzzleio/kuz
 
 ## SDK Documentation
 
-The complete SDK documentation is available [here](http://kuzzleio.github.io/sdk-documentation)
+The complete SDK documentation is available [here](http://docs.kuzzle.io/sdk-reference/?javascript#kuzzle)
+
+## Report an issue
+
+Use following meta repository to report issues on SDK:
+
+https://github.com/kuzzleio/kuzzle-sdk/issues
 
 ## Protocols used
 

dist/kuzzle.js.map

@@ -1,6 +1,6 @@
 {
   "name": "kuzzle-sdk",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "description": "Official Javascript SDK for Kuzzle",
   "author": "The Kuzzle Team <support@kuzzle.io>",
   "repository": {

package.json

@@ -193,7 +193,7 @@ Collection.prototype.createDocument = function (id, document, options, cb) {
       return cb(err);
     }
 
-    doc = new Document(self, res.result._id, res.result._source);
+    doc = new Document(self, res.result._id, res.result._source, res.result._meta);
     doc.version = res.result._version;
     cb(null, doc);
   });
@@ -276,7 +276,7 @@ Collection.prototype.fetchDocument = function (documentId, options, cb) {
       return cb(err);
     }
 
-    document = new Document(self, res.result._id, res.result._source);
+    document = new Document(self, res.result._id, res.result._source, res.result._meta);
     document.version = res.result._version;
     cb(null, document);
   });
@@ -419,7 +419,7 @@ Collection.prototype.replaceDocument = function (documentId, content, options, c
       return cb(err);
     }
 
-    document = new Document(self, res.result._id, res.result._source);
+    document = new Document(self, res.result._id, res.result._source, res.result._meta);
     document.version = res.result._version;
     cb(null, document);
   });
@@ -462,7 +462,7 @@ Collection.prototype.search = function (filters, options, cb) {
     }
 
     result.result.hits.forEach(function (doc) {
-      var newDocument = new Document(self, doc._id, doc._source);
+      var newDocument = new Document(self, doc._id, doc._source, doc._meta);
 
       newDocument.version = doc._version;
 
@@ -531,7 +531,7 @@ Collection.prototype.scroll = function (scrollId, options, filters, cb) {
     }
 
     result.result.hits.forEach(function (doc) {
-      var newDocument = new Document(self, doc._id, doc._source);
+      var newDocument = new Document(self, doc._id, doc._source, doc._meta);
 
       newDocument.version = doc._version;
 

src/Collection.js

@@ -18,9 +18,10 @@
  * @param {Collection} collection - an instanciated Collection object
  * @param {string} [documentId] - ID of an existing document
  * @param {object} [content] - Initializes this document with the provided content
+ * @param {object} [meta] - Initializes this document with the provided meta
  * @constructor
  */
-function Document(collection, documentId, content) {
+function Document(collection, documentId, content, meta) {
   Object.defineProperties(this, {
     // read-only properties
     collection: {
@@ -55,6 +56,11 @@ function Document(collection, documentId, content) {
       value: undefined,
       enumerable: true,
       writable: true
+    },
+    meta: {
+      value: meta || {},
+      enumerable: true,
+      writable: false
     }
   });
 
@@ -112,6 +118,7 @@ Document.prototype.serialize = function () {
   }
 
   data.body = this.content;
+  data.meta = this.meta;
   data = this.kuzzle.addHeaders(data, this.headers);
 
   return data;
@@ -182,7 +189,7 @@ Document.prototype.refresh = function (options, cb) {
       return cb(error);
     }
 
-    newDocument = new Document(self.dataCollection, self.id, res.result._source);
+    newDocument = new Document(self.dataCollection, self.id, res.result._source, res.result._meta);
     newDocument.version = res.result._version;
 
     cb(null, newDocument);

src/Document.js

@@ -322,7 +322,7 @@ function notificationCallback (data) {
 
   if (data.controller === 'document' || (data.controller === 'realtime' && data.action === 'publish')) {
     data.type = 'document';
-    data.document = new Document(this.collection, data.result._id, data.result._source);
+    data.document = new Document(this.collection, data.result._id, data.result._source, data.result._meta);
     delete data.result;
   }
   else if (data.controller === 'realtime') {

src/Room.js

@@ -26,7 +26,16 @@ describe('Collection methods', function () {
 
   describe('#search', function () {
     beforeEach(function () {
-      result = { result: { _scroll_id: 'banana', total: 123, hits: [ {_id: 'foobar', _source: { foo: 'bar'}} ], aggregations: {someAggregate: {}}}};
+      result = {
+        result: {
+          _scroll_id: 'banana',
+          total: 123,
+          hits: [
+            {_id: 'foobar', _source: { foo: 'bar'}, _meta: {author: 'toto'}}
+          ],
+          aggregations: {someAggregate: {}}
+        }
+      };
       expectedQuery = {
         index: 'bar',
         collection: 'foo',
@@ -355,7 +364,7 @@ describe('Collection methods', function () {
       })).be.exactly(collection);
 
       should(kuzzle.query).be.calledOnce();
-      should(kuzzle.query).calledWith(expectedQuery, {body: content}, null, sinon.match.func);
+      should(kuzzle.query).calledWith(expectedQuery, {body: content, meta: {}}, null, sinon.match.func);
 
       kuzzle.query.yield(null, result);
     });
@@ -672,7 +681,7 @@ describe('Collection methods', function () {
 
       collection.publishMessage(new Document(collection, content), options);
       should(kuzzle.query).be.calledOnce();
-      should(kuzzle.query).calledWith(expectedQuery, {body: content}, options);
+      should(kuzzle.query).calledWith(expectedQuery, {body: content, meta: {}}, options);
     });
   });
 

test/Collection/methods.test.js

@@ -22,26 +22,37 @@ describe('Document constructor', function () {
     should(document).be.instanceof(Document);
     should(document.id).be.undefined();
     should(document.content).be.empty();
+    should(document.meta).be.empty();
     should(document.version).be.undefined();
     should(document.collection).be.exactly('foo');
 
     document = new Document(collection, { some: 'content' });
     should(document.id).be.undefined();
     should(document.content).match({some: 'content'});
+    should(document.meta).be.empty();
     should(document.version).be.undefined();
     should(document.collection).be.exactly('foo');
 
     document = new Document(collection, 'id', { some: 'content', _version: 123 });
     should(document.id).be.exactly('id');
     should(document.content).match({some: 'content'});
+    should(document.meta).be.empty();
     should(document.version).be.exactly(123);
     should(document.collection).be.exactly('foo');
 
     document = new Document(collection, 'id');
     should(document.id).be.exactly('id');
     should(document.content).be.empty();
+    should(document.meta).be.empty();
     should(document.version).be.undefined();
     should(document.collection).be.exactly('foo');
+
+    document = new Document(collection, 'id', { some: 'content', _version: 123 }, {author: 'toto'});
+    should(document.id).be.exactly('id');
+    should(document.content).match({some: 'content'});
+    should(document.meta).match({author: 'toto'});
+    should(document.version).be.exactly(123);
+    should(document.collection).be.exactly('foo');
   });
 
   it('should expose documented properties with the right permissions', function () {
@@ -52,6 +63,7 @@ describe('Document constructor', function () {
     should(document).have.propertyWithDescriptor('headers', { enumerable: true, writable: true, configurable: false });
     should(document).have.propertyWithDescriptor('id', { enumerable: true, writable: true, configurable: false });
     should(document).have.propertyWithDescriptor('version', { enumerable: true, writable: true, configurable: false });
+    should(document).have.propertyWithDescriptor('meta', { enumerable: true, writable: false, configurable: false });
   });
 
   it('should promisify the right functions', function () {

test/Document/constructor.test.js

@@ -74,7 +74,7 @@ describe('Document methods', function () {
       document.id = 'foo';
       document.delete(options);
       should(kuzzle.query).be.calledOnce();
-      should(kuzzle.query).calledWith(expectedQuery, {_id: 'foo', body: {}}, options);
+      should(kuzzle.query).calledWith(expectedQuery, {_id: 'foo', body: {}, meta: {}}, options);
     });
 
     it('should handle arguments correctly', function () {
@@ -241,7 +241,7 @@ describe('Document methods', function () {
       document.id = 'foo';
       should(document.save(options)).be.exactly(document);
       should(kuzzle.query).be.calledOnce();
-      should(kuzzle.query).calledWith(expectedQuery, {_id: 'foo', body: {}}, options);
+      should(kuzzle.query).calledWith(expectedQuery, {_id: 'foo', body: {}, meta: {}}, options);
     });
 
     it('should handle arguments correctly', function () {
@@ -311,7 +311,7 @@ describe('Document methods', function () {
 
       should(document.publish(options)).be.exactly(document);
       should(kuzzle.query).be.calledOnce();
-      should(kuzzle.query).calledWith(expectedQuery, {body: {}}, options);
+      should(kuzzle.query).calledWith(expectedQuery, {body: {}, meta: {}}, options);
     });
 
     it('should handle arguments correctly', function () {