Release 4.0.0

.eslintrc.json

@@ -51,8 +51,7 @@
     "yoda": [2, "never"]
   },
   "env": {
-    "node": true,
-    "mocha": true
+    "browser": true
   },
   "parserOptions": {
     "ecmaVersion": 5

CHANGELOG.md

@@ -1,3 +1,43 @@
+# [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)
+
+### Compatibility
+
+| Kuzzle | Proxy |
+|--------|-------|
+| 1.0.0-RC9.6 | 1.0.0-RC9 |
+
+#### Breaking changes
+
+- [ [#201](https://github.com/kuzzleio/sdk-javascript/pull/201) ] Rename metadata into volatile   ([AnthonySendra](https://github.com/AnthonySendra))
+
+#### Bug fixes
+
+- [ [#194](https://github.com/kuzzleio/sdk-javascript/pull/194) ] Stop calling onClientError when disconnect is called   ([jenow](https://github.com/jenow))
+- [ [#193](https://github.com/kuzzleio/sdk-javascript/pull/193) ] Wrap filter in query for deleteDocument   ([jenow](https://github.com/jenow))
+
+#### Enhancements
+
+- [ [#199](https://github.com/kuzzleio/sdk-javascript/pull/199) ] Add support for the new retryOnConflict option   ([scottinet](https://github.com/scottinet))
+- [ [#191](https://github.com/kuzzleio/sdk-javascript/pull/191) ] Standardize memory storage object   ([scottinet](https://github.com/scottinet))
+
+#### Exclude
+
+- [ [#196](https://github.com/kuzzleio/sdk-javascript/pull/196) ] Fix ms.hgetall return value interpretation   ([scottinet](https://github.com/scottinet))
+- [ [#198](https://github.com/kuzzleio/sdk-javascript/pull/198) ] Fix ms.zscore return value type   ([scottinet](https://github.com/scottinet))
+
+#### Others
+
+- [ [#195](https://github.com/kuzzleio/sdk-javascript/pull/195) ] Moved bufferutil and utf-8-validate to peerDependencies   ([jenow](https://github.com/jenow))
+- [ [#190](https://github.com/kuzzleio/sdk-javascript/pull/190) ] Align SearchResult and scroll with other SDKs   ([dbengsch](https://github.com/dbengsch))
+- [ [#182](https://github.com/kuzzleio/sdk-javascript/pull/182) ] Collection.createDocument: rename the updateIfExist option   ([scottinet](https://github.com/scottinet))
+- [ [#188](https://github.com/kuzzleio/sdk-javascript/pull/188) ] Make all options given to kuzzle constructor writable   ([benoitvidis](https://github.com/benoitvidis))
+- [ [#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
 
 Fill changes list: https://github.com/kuzzleio/sdk-javascript/releases/tag/3.4.0

README.md

@@ -21,6 +21,7 @@ You can access the Kuzzle repository on [Github](https://github.com/kuzzleio/kuz
     * [Basic usage](#basic-usage-js)
 * [Building manually](#building-manually)
 * [Migrating from SDK v1.x](#migrating-from-sdk-v1.x)
+* [Note](#note)
 * [License](#license)
 
 ## SDK Documentation
@@ -139,6 +140,10 @@ kuzzle
 
 * Kuzzle constructor has been changed. Instead of an URL, you have to provide a resolvable server name, or an IP address. If you need to specify a port different than the provided default value, you can do so using the `port` option.
 
+## Note
+
+* bufferutil and utf-8-validate have been moved to peerDependencies
+
 ## License
 
 [Apache 2](LICENSE.md)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "kuzzle-sdk",
-  "version": "3.4.2",
+  "version": "4.0.0",
   "description": "Official Javascript SDK for Kuzzle",
   "author": "The Kuzzle Team <[email protected]>",
   "repository": {
@@ -28,12 +28,14 @@
   "license": "Apache-2.0",
   "dependencies": {
     "bluebird": "3.4.7",
-    "bufferutil": "^2.0.1",
     "eslint-loader": "^1.6.1",
-    "utf-8-validate": "^3.0.1",
     "uuid": "3.0.1",
     "ws": "^2.0.3"
   },
+  "peerDependencies": {
+    "bufferutil": "^2.0.1",
+    "utf-8-validate": "^3.0.1"
+  },
   "devDependencies": {
     "codecov": "^1.0.1",
     "eslint": "^3.15.0",
@@ -52,4 +54,4 @@
   "engines": {
     "node": ">= 6.9.1"
   }
-}
+}

src/Collection.js

@@ -3,7 +3,7 @@ var
   Document = require('./Document'),
   CollectionMapping = require('./CollectionMapping'),
   Room = require('./Room'),
-  KuzzleSubscribeResult = require('./SubscribeResult');
+  SubscribeResult = require('./SubscribeResult');
 
 /**
  * This is a global callback pattern, called by all asynchronous functions of the Kuzzle object.
@@ -134,11 +134,12 @@ Collection.prototype.create = function (options, cb) {
  * Create a new document in Kuzzle.
  *
  * Takes an optional argument object with the following properties:
- *    - metadata (object, default: null):
+ *    - volatile (object, default: null):
  *        Additional information passed to notifications to other users
- *    - updateIfExist (boolean, default: false):
- *        If the same document already exists: throw an error if sets to false.
- *        Update the existing document otherwise
+ *    - ifExist (string, allowed values: "error" (default), "replace"):
+ *        If the same document already exists:
+ *          - resolves with an error if set to "error".
+ *          - replaces the existing document if set to "replace"
  *
  * @param {string} [id] - (optional) document identifier
  * @param {object} document - either an instance of a Document object, or a document
@@ -170,8 +171,13 @@ Collection.prototype.createDocument = function (id, document, options, cb) {
     data.body = document;
   }
 
-  if (options) {
-    action = options.updateIfExist ? 'createOrReplace' : 'create';
+  if (options && options.ifExist) {
+    if (options.ifExist === 'replace') {
+      action = 'createOrReplace';
+    }
+    else if (options.ifExist !== 'error') {
+      throw new Error('Invalid value for the "ifExist" option: ' + options.ifExist);
+    }
   }
 
   if (id) {
@@ -203,7 +209,7 @@ Collection.prototype.createDocument = function (id, document, options, cb) {
  * That means that a document that was just been created won’t be returned by this function
  *
  * Takes an optional argument object with the following properties:
- *    - metadata (object, default: null):
+ *    - volatile (object, default: null):
  *        Additional information passed to notifications to other users
  *
  * @param {string|object} arg - Either a document ID (will delete only this particular document), or a set of filters
@@ -220,7 +226,7 @@ Collection.prototype.deleteDocument = function (arg, options, cb) {
     data._id = arg;
     action = 'delete';
   } else {
-    data.body = arg;
+    data.body = {query: arg};
     action = 'deleteByQuery';
   }
 
@@ -308,7 +314,7 @@ Collection.prototype.fetchAllDocuments = function (options, cb) {
 
   this.kuzzle.callbackRequired('Collection.fetchAllDocuments', cb);
 
-  this.search(filters, options, function getNextDocuments (error, searchResult) {
+  this.search(filters, options, function fetchNextDocuments (error, searchResult) {
     if (error) {
       return cb(error);
     }
@@ -322,7 +328,7 @@ Collection.prototype.fetchAllDocuments = function (options, cb) {
       searchResult.documents.forEach(function(document) {
         documents.push(document);
       });
-      searchResult.next(getNextDocuments);
+      searchResult.fetchNext(fetchNextDocuments);
     }
     else {
       cb(null, documents);
@@ -355,7 +361,7 @@ Collection.prototype.getMapping = function (options, cb) {
  * Publish a realtime message
  *
  * Takes an optional argument object with the following properties:
- *    - metadata (object, default: null):
+ *    - volatile (object, default: null):
  *        Additional information passed to notifications to other users
  *
  * @param {object} document - either a Document instance or a JSON object
@@ -382,7 +388,7 @@ Collection.prototype.publishMessage = function (document, options, cb) {
  * Replace an existing document with a new one.
  *
  * Takes an optional argument object with the following properties:
- *    - metadata (object, default: null):
+ *    - volatile (object, default: null):
  *        Additional information passed to notifications to other users
  *
  * @param {string} documentId - Unique document identifier of the document to replace
@@ -471,8 +477,10 @@ Collection.prototype.search = function (filters, options, cb) {
       self,
       result.result.total,
       documents,
-      result.result.aggregations ? result.result.aggregations : [],
-      {options: options, filters: filters}
+      result.result.aggregations ? result.result.aggregations : {},
+      options,
+      filters,
+      options.previous || null
     ));
   });
 };
@@ -538,8 +546,10 @@ Collection.prototype.scroll = function (scrollId, options, filters, cb) {
       self,
       result.result.total,
       documents,
-      result.result.aggregations ? result.result.aggregations : [],
-      {options: options, filters: filters}
+      {},
+      options,
+      filters,
+      options.previous || null
     ));
   });
 
@@ -567,7 +577,7 @@ Collection.prototype.subscribe = function (filters, options, cb) {
 
   this.kuzzle.callbackRequired('Collection.subscribe', cb);
 
-  subscribeResult = new KuzzleSubscribeResult();
+  subscribeResult = new SubscribeResult();
   room = new Room(this, options);
 
   room.renew(filters, cb, subscribeResult.done.bind(subscribeResult));
@@ -602,7 +612,7 @@ Collection.prototype.truncate = function (options, cb) {
  * Update parts of a document
  *
  * Takes an optional argument object with the following properties:
- *    - metadata (object, default: null):
+ *    - volatile (object, default: null):
  *        Additional information passed to notifications to other users
  *
  * @param {string} documentId - Unique document identifier of the document to update
@@ -624,6 +634,10 @@ Collection.prototype.updateDocument = function (documentId, content, options, cb
     options = null;
   }
 
+  if (options && options.retryOnConflict) {
+    data.retryOnConflict = options.retryOnConflict;
+  }
+
   data = self.kuzzle.addHeaders(data, this.headers);
 
   self.kuzzle.query(this.buildQueryArgs('document', 'update'), data, options, cb && function (err, res) {

src/Document.js

@@ -15,24 +15,24 @@
  *   - providing a documentID to the constructor will automatically call refresh, unless a content is also provided
  *
  *
- * @param {object} kuzzleDataCollection - an instanciated Collection object
+ * @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
  * @constructor
  */
-function Document(kuzzleDataCollection, documentId, content) {
+function Document(collection, documentId, content) {
   Object.defineProperties(this, {
     // read-only properties
     collection: {
-      value: kuzzleDataCollection.collection,
+      value: collection.collection,
       enumerable: true
     },
     dataCollection: {
-      value: kuzzleDataCollection,
+      value: collection,
       enumerable: false
     },
     kuzzle: {
-      value: kuzzleDataCollection.kuzzle,
+      value: collection.kuzzle,
       enumerable: false
     },
     // writable properties
@@ -47,7 +47,7 @@ function Document(kuzzleDataCollection, documentId, content) {
       enumerable: true
     },
     headers: {
-      value: JSON.parse(JSON.stringify(kuzzleDataCollection.headers)),
+      value: JSON.parse(JSON.stringify(collection.headers)),
       enumerable: true,
       writable: true
     },
@@ -127,7 +127,7 @@ Document.prototype.toString = function () {
  * Deletes this document in Kuzzle.
  *
  * Takes an optional argument object with the following properties:
- *    - metadata (object, default: null):
+ *    - volatile (object, default: null):
  *        Additional information passed to notifications to other users
  *
  * @param {object} [options] - Optional parameters
@@ -194,7 +194,7 @@ Document.prototype.refresh = function (options, cb) {
  * of this object.
  *
  * Takes an optional argument object with the following properties:
- *    - metadata (object, default: null):
+ *    - volatile (object, default: null):
  *        Additional information passed to notifications to other users
  *
  * @param {object} [options] - Optional parameters
@@ -231,7 +231,7 @@ Document.prototype.save = function (options, cb) {
  * Sends the content of this document as a realtime message.
  *
  * Takes an optional argument object with the following properties:
- *    - metadata (object, default: null):
+ *    - volatile (object, default: null):
  *        Additional information passed to notifications to other users
  *
  * @param {object} [options] - Optional parameters

src/Kuzzle.js

@@ -146,7 +146,7 @@ function Kuzzle (host, options, cb) {
       enumerable: true,
       writable: true
     },
-    metadata: {
+    volatile: {
       value: {},
       enumerable: true,
       writable: true
@@ -268,9 +268,9 @@ function Kuzzle (host, options, cb) {
       }
 
       eventProperties.listeners.forEach(function (listener) {
-        process.nextTick(function () {
+        setTimeout(function () {
           listener.fn.apply(undefined, args);
-        });
+        }, 0);
       });
 
       // Events without the 'lastEmitted' property can be emitted without minimum time between emissions
@@ -1252,7 +1252,7 @@ Kuzzle.prototype.now = function (options, cb) {
  * Base method used to send read queries to Kuzzle
  *
  * Takes an optional argument object with the following properties:
- *    - metadata (object, default: null):
+ *    - volatile (object, default: null):
  *        Additional information passed to notifications to other users
  *
  * @param {object} queryArgs - Query configuration
@@ -1266,7 +1266,7 @@ Kuzzle.prototype.query = function (queryArgs, query, options, cb) {
     object = {
       action: queryArgs.action,
       controller: queryArgs.controller,
-      metadata: this.metadata
+      volatile: this.volatile
     },
     self = this;
 
@@ -1302,9 +1302,9 @@ Kuzzle.prototype.query = function (queryArgs, query, options, cb) {
       object.scrollId = options.scrollId;
     }
 
-    if (options.metadata) {
-      Object.keys(options.metadata).forEach(function (meta) {
-        object.metadata[meta] = options.metadata[meta];
+    if (options.volatile) {
+      Object.keys(options.volatile).forEach(function (meta) {
+        object.volatile[meta] = options.volatile[meta];
       });
     }
   }
@@ -1313,14 +1313,14 @@ Kuzzle.prototype.query = function (queryArgs, query, options, cb) {
     throw new Error('Invalid query parameter: ' + query);
   }
 
-  if (query.metadata) {
-    Object.keys(query.metadata).forEach(function (meta) {
-      object.metadata[meta] = query.metadata[meta];
+  if (query.volatile) {
+    Object.keys(query.volatile).forEach(function (meta) {
+      object.volatile[meta] = query.volatile[meta];
     });
   }
 
   for (attr in query) {
-    if (attr !== 'metadata' && query.hasOwnProperty(attr)) {
+    if (attr !== 'volatile' && query.hasOwnProperty(attr)) {
       object[attr] = query[attr];
     }
   }