Merge pull request #182 from kuzzleio/rename-updateifexist-option

Collection.createDocument: rename the updateIfExist option

Author: scottinet

package.json

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

src/Collection.js

@@ -136,9 +136,10 @@ Collection.prototype.create = function (options, cb) {
  * Takes an optional argument object with the following properties:
  *    - metadata (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) {

test/Collection/methods.test.js

@@ -424,13 +424,29 @@ describe('Collection methods', function () {
       should(emitted).be.true();
     });
 
-    it('should be able to handle the updateIfExist option', function () {
+    it('should be able to handle the ifExist=replace option', function () {
       var collection = kuzzle.collection(expectedQuery.collection);
       expectedQuery.action = 'createOrReplace';
 
-      collection.createDocument(result.result._source, {updateIfExist: true});
+      collection.createDocument(result.result._source, {ifExist: 'replace'});
       should(emitted).be.true();
     });
+
+    it('should be able to handle the ifExist=error option', function () {
+      var collection = kuzzle.collection(expectedQuery.collection);
+      expectedQuery.action = 'create';
+
+      collection.createDocument(result.result._source, {ifExist: 'error'});
+      should(emitted).be.true();
+    });
+
+    it('should throw an error if the ifExist option is invalid', function () {
+      var collection = kuzzle.collection(expectedQuery.collection);
+
+      should(function () {
+        collection.createDocument(result.result._source, {ifExist: 'foobar'});
+      }).throw();
+    });
   });
 
   describe('#deleteDocument', function () {