dataflux 1.7.2 → 1.8.0

package/README.md

@@ -20,7 +20,7 @@ npm install dataflux
 
 Using jsDelivr CDN:
 ```html
-<script src="https://cdn.jsdelivr.net/npm/dataflux/dist/index.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/dataflux/dist/dataflux.min.js"></script>
 ```
 
 ## Examples
@@ -31,7 +31,7 @@ Consider the following hypothetical store/model declaration common to all the ex
 
 ```js
 // Content of your store.js
-import {Store, Model} from "dataflux";
+const {Store, Model} = require("dataflux");
 
 // We create a new Store
 const store = new Store();
@@ -182,7 +182,7 @@ const callback = ({book, author}) => {
   // Objects are ready
 };
 
-const subKey = store.multipleSubscribe(requests, callback); // Subscribe
+const subKey = store.multipleSubscribe(subscriptions, callback); // Subscribe
 
 store.unsubscribe(subKey); // Unsubscribe
 ```
@@ -205,8 +205,8 @@ class MyComponent extends React.Component {
     // Get all books with a price < 20
     store.findAll("book", "books", this, ({price}) => price < 20);
     // An attribute "books" will be added/updated in the 
-    // state (the rest of the state remains unchanged) every time
-    // a book in our selection is inserted/deleted/edited.
+    // state every time a book in our selection is inserted/deleted/edited,
+    // the rest of the state remains unchanged.
 
     // findAll is a syntactic sugar for:
     // const callback = (books) => {this.setState({...this.state, books})};
@@ -234,6 +234,25 @@ The method `findAll` returns always an array. The method `findOne` returns a sin
 
 When the component will unmount, the `findAll` subscription will be automatically terminated without the need to unsubscribe. Be aware, `store.findAll()` injects the unsubscribe call inside `componentWillUnmount()`. If your component already implements `componentWillUnmount()`, then you will have to use `store.subscribe()` and `store.unsubscribe()` instead of `store.findAll()`, to avoid side effects when the component is unmounted.
 
+In case you prefer React hooks:
+
+```js
+function MyComponent() {
+  const [books, setBooks] = useState([]);
+
+  useEffect(() => {
+    const subKey = store.subscribe("books", setBooks, ({price}) => price < 20);
+
+    return () => {
+      store.unsubscribe(subKey); // Remember to unsubscribe
+    };
+  }, []);
+
+  return books.map(book => <Book onTitleChange={(title) => book.set("title", title)}/>);
+}
+```
+
+
 ## Configuration
 
 The store can be configured with the following options:
@@ -289,10 +308,23 @@ An operation object is an object like follows:
 {
   "method": "get",
   "url": "https://api.example.com",
-  "headers": {"Authorization": "bearer XXXX"}
+  "headers": {
+    "Authorization": "bearer XXXX"
+  },
+  "batch": false
 }
 ```
 
+Possible parameters are:
+
+| Parameter | Description                                                                                                                          | Default                                                                          |
+|-----------|--------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------|
+| method    | HTTP method, accepted are get,post,put, and delete                                                                                   | "get" for retrieve, "post" for insert, "put" for update, and "delete" for delete |
+| url       | The url of the api                                                                                                                   |                                                                                  |
+| headers   | Headers for the HTTP request ([list](https://en.wikipedia.org/wiki/List_of_HTTP_header_fields)).                                     |
+| batch     | A boolean declaring if the API is able to receive an array of objects or an object at a time. This is not applicable for `retrieve`. | false                                                                            |
+
+
 Usage example:
 
 ```js

package/dist/Model.js

@@ -7,8 +7,6 @@ exports["default"] = void 0;
 
 var _modelHooksUtils = require("./modelHooksUtils");
 
-var _batchPromises = _interopRequireDefault(require("batch-promises"));
-
 var _axios2 = _interopRequireDefault(require("axios"));
 
 var _BasicObj = require("./BasicObj");
@@ -99,6 +97,8 @@ var _bulkOperation = /*#__PURE__*/new WeakMap();
 
 var _toArray = /*#__PURE__*/new WeakMap();
 
+var _unWrap = /*#__PURE__*/new WeakMap();
+
 var _insertObjects = /*#__PURE__*/new WeakMap();
 
 var _updateObjects = /*#__PURE__*/new WeakMap();
@@ -193,7 +193,8 @@ var Model = /*#__PURE__*/_createClass(function Model(name) {
       return _this.getStore().whenSaved(_this.getType())["catch"](function (e) {
         throw new Error("You cannot perform load() on an unsaved object.");
       }).then(function () {
-        var res = _classPrivateFieldGet(_this, _loadFunction).call(_this, obj.toJSON());
+        var res = _classPrivateFieldGet(_this, _loadFunction).call(_this, obj.toJSON()); // toJSON to avoid side effects;
+
 
         if (typeof res === "string") {
           return _classPrivateFieldGet(_this, _axios).call(_this, {
@@ -284,7 +285,13 @@ var Model = /*#__PURE__*/_createClass(function Model(name) {
     if (!_this.options.lazyLoad) {
       return Promise.reject("Factory can be used only on a model declared with lazyLoad: true");
     } else {
-      return (0, _modelHooksUtils.executeHook)("retrieve", _classPrivateFieldGet(_this, _retrieveHook), params, _classPrivateFieldGet(_this, _axios));
+      return (0, _modelHooksUtils.executeHook)("retrieve", _classPrivateFieldGet(_this, _retrieveHook), params, _classPrivateFieldGet(_this, _axios)).then(function (data) {
+        if (!Array.isArray(data)) {
+          _classPrivateFieldSet(_this, _singleItemQuery, true);
+        }
+
+        return _classPrivateFieldGet(_this, _toArray).call(_this, data);
+      });
     }
   });
 
@@ -333,15 +340,9 @@ var Model = /*#__PURE__*/_createClass(function Model(name) {
   _classPrivateFieldInitSpec(this, _bulkOperation, {
     writable: true,
     value: function value(objects, action) {
-      if (_classPrivateFieldGet(_this, _singleItemQuery)) {
-        return (0, _batchPromises["default"])(_classPrivateFieldGet(_this, _batchSize), objects.map(function (i) {
-          return _classPrivateFieldGet(_this, _removeHiddenFields).call(_this, i.toJSON());
-        }), action);
-      } else {
-        return action(objects.map(function (i) {
-          return _classPrivateFieldGet(_this, _removeHiddenFields).call(_this, i.toJSON());
-        }));
-      }
+      return action(objects.map(function (i) {
+        return _classPrivateFieldGet(_this, _removeHiddenFields).call(_this, i.toJSON());
+      }));
     }
   });
 
@@ -349,7 +350,7 @@ var Model = /*#__PURE__*/_createClass(function Model(name) {
     writable: true,
     value: function value(data) {
       if (Array.isArray(data)) {
-        if (data.every(function (str) {
+        if (data.length && data.every(function (str) {
           return ["string", "number"].includes(_typeof(str));
         })) {
           return [{
@@ -370,24 +371,37 @@ var Model = /*#__PURE__*/_createClass(function Model(name) {
     }
   });
 
+  _classPrivateFieldInitSpec(this, _unWrap, {
+    writable: true,
+    value: function value(data) {
+      if (data.value != null && Object.keys(data).length === 1) {
+        return data.value;
+      } else if (Array.isArray(data) && data.length === 1 && data[0].value != null && Object.keys(data[0]).length === 1) {
+        return data[0].value;
+      } else {
+        return data;
+      }
+    }
+  });
+
   _classPrivateFieldInitSpec(this, _insertObjects, {
     writable: true,
     value: function value(data) {
-      return (0, _modelHooksUtils.executeHook)("insert", _classPrivateFieldGet(_this, _insertHook), data, _classPrivateFieldGet(_this, _axios)).then(_classPrivateFieldGet(_this, _toArray));
+      return (0, _modelHooksUtils.executeHook)("insert", _classPrivateFieldGet(_this, _insertHook), _classPrivateFieldGet(_this, _unWrap).call(_this, data), _classPrivateFieldGet(_this, _axios)).then(_classPrivateFieldGet(_this, _toArray));
     }
   });
 
   _classPrivateFieldInitSpec(this, _updateObjects, {
     writable: true,
     value: function value(data) {
-      return (0, _modelHooksUtils.executeHook)("update", _classPrivateFieldGet(_this, _updateHook), data, _classPrivateFieldGet(_this, _axios)).then(_classPrivateFieldGet(_this, _toArray));
+      return (0, _modelHooksUtils.executeHook)("update", _classPrivateFieldGet(_this, _updateHook), _classPrivateFieldGet(_this, _unWrap).call(_this, data), _classPrivateFieldGet(_this, _axios)).then(_classPrivateFieldGet(_this, _toArray));
     }
   });
 
   _classPrivateFieldInitSpec(this, _deleteObjects, {
     writable: true,
     value: function value(data) {
-      return (0, _modelHooksUtils.executeHook)("delete", _classPrivateFieldGet(_this, _deleteHook), data, _classPrivateFieldGet(_this, _axios)).then(_classPrivateFieldGet(_this, _toArray));
+      return (0, _modelHooksUtils.executeHook)("delete", _classPrivateFieldGet(_this, _deleteHook), _classPrivateFieldGet(_this, _unWrap).call(_this, data), _classPrivateFieldGet(_this, _axios)).then(_classPrivateFieldGet(_this, _toArray));
     }
   });
 

package/dist/ObserverStore.js

@@ -55,20 +55,28 @@ function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.g
 
 function _classPrivateMethodInitSpec(obj, privateSet) { _checkPrivateRedeclaration(obj, privateSet); privateSet.add(obj); }
 
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
 function _classPrivateFieldInitSpec(obj, privateMap, value) { _checkPrivateRedeclaration(obj, privateMap); privateMap.set(obj, value); }
 
 function _checkPrivateRedeclaration(obj, privateCollection) { if (privateCollection.has(obj)) { throw new TypeError("Cannot initialize the same private elements twice on an object"); } }
 
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
 function _classPrivateMethodGet(receiver, privateSet, fn) { if (!privateSet.has(receiver)) { throw new TypeError("attempted to get private field on non-instance"); } return fn; }
 
+function _classPrivateFieldSet(receiver, privateMap, value) { var descriptor = _classExtractFieldDescriptor(receiver, privateMap, "set"); _classApplyDescriptorSet(receiver, descriptor, value); return value; }
+
+function _classApplyDescriptorSet(receiver, descriptor, value) { if (descriptor.set) { descriptor.set.call(receiver, value); } else { if (!descriptor.writable) { throw new TypeError("attempted to set read only private field"); } descriptor.value = value; } }
+
 function _classPrivateFieldGet(receiver, privateMap) { var descriptor = _classExtractFieldDescriptor(receiver, privateMap, "get"); return _classApplyDescriptorGet(receiver, descriptor); }
 
 function _classExtractFieldDescriptor(receiver, privateMap, action) { if (!privateMap.has(receiver)) { throw new TypeError("attempted to " + action + " private field on non-instance"); } return privateMap.get(receiver); }
 
 function _classApplyDescriptorGet(receiver, descriptor) { if (descriptor.get) { return descriptor.get.call(receiver); } return descriptor.value; }
 
+var _queryPromises = /*#__PURE__*/new WeakMap();
+
+var _unsubPromises = /*#__PURE__*/new WeakMap();
+
 var _getUniqueSubs = /*#__PURE__*/new WeakMap();
 
 var _propagateChange = /*#__PURE__*/new WeakMap();
@@ -91,8 +99,19 @@ var ObserverStore = /*#__PURE__*/function (_PersistentStore) {
 
     _classPrivateMethodInitSpec(_assertThisInitialized(_this), _propagateInsertChange);
 
+    _classPrivateFieldInitSpec(_assertThisInitialized(_this), _queryPromises, {
+      writable: true,
+      value: []
+    });
+
+    _classPrivateFieldInitSpec(_assertThisInitialized(_this), _unsubPromises, {
+      writable: true,
+      value: []
+    });
+
     _defineProperty(_assertThisInitialized(_this), "multipleSubscribe", function (subscriptions, callback) {
       var dataPayload = {};
+      var subKey = (0, _uuid.v4)();
 
       var areAllDone = function areAllDone() {
         return subscriptions.map(function (_ref) {
@@ -105,7 +124,7 @@ var ObserverStore = /*#__PURE__*/function (_PersistentStore) {
         });
       };
 
-      return Promise.all(subscriptions.map(function (sub) {
+      Promise.all(subscriptions.map(function (sub) {
         var _sub = _slicedToArray(sub, 2),
             name = _sub[0],
             _sub$ = _sub[1],
@@ -118,62 +137,67 @@ var ObserverStore = /*#__PURE__*/function (_PersistentStore) {
 
         return _this.subscribe(name, wrappedCallback, filterFunction);
       })).then(function (subKeys) {
-        var subKey = (0, _uuid.v4)();
         _this._multipleSubscribed[subKey] = subKeys;
         return subKey;
       });
+      return subKey;
     });
 
     _defineProperty(_assertThisInitialized(_this), "subscribe", function (type, callback, filterFunction) {
-      var subKey = (0, _uuid.v4)();
+      var _this$_subscribed, _this$_subscribed$typ;
 
-      if (!_this._subscribed[type]) {
-        _this._subscribed[type] = {};
-      }
+      var subKey = (0, _uuid.v4)();
+      (_this$_subscribed$typ = (_this$_subscribed = _this._subscribed)[type]) !== null && _this$_subscribed$typ !== void 0 ? _this$_subscribed$typ : _this$_subscribed[type] = {};
 
-      _this.find(type, filterFunction).then(function (data) {
+      var prom = _this.find(type, filterFunction).then(function (data) {
         _classPrivateFieldGet(_assertThisInitialized(_this), _subscribeToObjects).call(_assertThisInitialized(_this), type, data, {
           callback: callback,
           filterFunction: filterFunction,
           subKey: subKey
         });
 
-        return callback(data);
+        callback(data);
       });
 
+      _classPrivateFieldGet(_assertThisInitialized(_this), _queryPromises).push(prom);
+
       return subKey;
     });
 
     _defineProperty(_assertThisInitialized(_this), "unsubscribe", function (key) {
-      if (_this._multipleSubscribed[key]) {
-        var _iterator = _createForOfIteratorHelper(_this._multipleSubscribed[key]),
-            _step;
+      if (_classPrivateFieldGet(_assertThisInitialized(_this), _queryPromises).length) {
+        _classPrivateFieldSet(_assertThisInitialized(_this), _unsubPromises, Promise.all(_classPrivateFieldGet(_assertThisInitialized(_this), _queryPromises)).then(function () {
+          if (_this._multipleSubscribed[key]) {
+            var _iterator = _createForOfIteratorHelper(_this._multipleSubscribed[key]),
+                _step;
 
-        try {
-          for (_iterator.s(); !(_step = _iterator.n()).done;) {
-            var sub = _step.value;
-
-            _this.unsubscribe(sub);
-          }
-        } catch (err) {
-          _iterator.e(err);
-        } finally {
-          _iterator.f();
-        }
+            try {
+              for (_iterator.s(); !(_step = _iterator.n()).done;) {
+                var sub = _step.value;
 
-        delete _this._multipleSubscribed[key];
-      } else {
-        for (var type in _this._subscribed) {
-          for (var id in _this._subscribed[type]) {
-            _this._subscribed[type][id] = _this._subscribed[type][id].filter(function (i) {
-              return i.subKey !== key;
-            });
+                _this.unsubscribe(sub);
+              }
+            } catch (err) {
+              _iterator.e(err);
+            } finally {
+              _iterator.f();
+            }
 
-            if (_this._subscribed[type][id].length === 0) {
-              delete _this._subscribed[type][id];
+            delete _this._multipleSubscribed[key];
+          } else {
+            for (var type in _this._subscribed) {
+              for (var id in _this._subscribed[type]) {
+                _this._subscribed[type][id] = _this._subscribed[type][id].filter(function (i) {
+                  return i.subKey !== key;
+                });
+
+                if (_this._subscribed[type][id].length === 0) {
+                  delete _this._subscribed[type][id];
+                }
+              }
             }
           }
-        }
+        }));
       }
     });
 
@@ -197,8 +221,10 @@ var ObserverStore = /*#__PURE__*/function (_PersistentStore) {
 
             try {
               for (_iterator3.s(); !(_step3 = _iterator3.n()).done;) {
+                var _sub$subKey, _out$_sub$subKey;
+
                 var sub = _step3.value;
-                out[sub.subKey] = out[sub.subKey] || sub;
+                (_out$_sub$subKey = out[_sub$subKey = sub.subKey]) !== null && _out$_sub$subKey !== void 0 ? _out$_sub$subKey : out[_sub$subKey] = sub;
               }
             } catch (err) {
               _iterator3.e(err);
@@ -220,20 +246,21 @@ var ObserverStore = /*#__PURE__*/function (_PersistentStore) {
       writable: true,
       value: function value() {
         var objects = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
+        return (_classPrivateFieldGet(_assertThisInitialized(_this), _unsubPromises).length ? Promise.all(_classPrivateFieldGet(_assertThisInitialized(_this), _unsubPromises)) : Promise.resolve()).then(function () {
+          if (objects.length) {
+            var type = objects[0].getModel().getType();
 
-        if (objects.length) {
-          var type = objects[0].getModel().getType();
+            var uniqueSubs = _classPrivateFieldGet(_assertThisInitialized(_this), _getUniqueSubs).call(_assertThisInitialized(_this), objects, type);
 
-          var uniqueSubs = _classPrivateFieldGet(_assertThisInitialized(_this), _getUniqueSubs).call(_assertThisInitialized(_this), objects, type);
-
-          (0, _batchPromises["default"])(10, uniqueSubs, function (_ref3) {
-            var callback = _ref3.callback,
-                filterFunction = _ref3.filterFunction;
-            return _this.find(type, filterFunction).then(callback);
-          });
-        }
+            (0, _batchPromises["default"])(10, uniqueSubs, function (_ref3) {
+              var callback = _ref3.callback,
+                  filterFunction = _ref3.filterFunction;
+              return _this.find(type, filterFunction).then(callback);
+            });
+          }
 
-        return objects;
+          return objects;
+        });
       }
     });
 
@@ -245,12 +272,11 @@ var ObserverStore = /*#__PURE__*/function (_PersistentStore) {
 
         try {
           for (_iterator4.s(); !(_step4 = _iterator4.n()).done;) {
+            var _this$_subscribed$typ2, _this$_subscribed$typ3;
+
             var object = _step4.value;
             var id = object.getId();
-
-            if (!_this._subscribed[type][id]) {
-              _this._subscribed[type][id] = [];
-            }
+            (_this$_subscribed$typ3 = (_this$_subscribed$typ2 = _this._subscribed[type])[id]) !== null && _this$_subscribed$typ3 !== void 0 ? _this$_subscribed$typ3 : _this$_subscribed$typ2[id] = [];
 
             _this._subscribed[type][id].push(item);
           }
@@ -297,71 +323,73 @@ var ObserverStore = /*#__PURE__*/function (_PersistentStore) {
 function _propagateInsertChange2(type, newObjects) {
   var _this3 = this;
 
-  if (this._subscribed[type]) {
-    var uniqueSubs = {};
-    var objects = Object.values(this._subscribed[type]);
+  return (_classPrivateFieldGet(this, _unsubPromises).length ? Promise.all(_classPrivateFieldGet(this, _unsubPromises)) : Promise.resolve()).then(function () {
+    if (_this3._subscribed[type]) {
+      var uniqueSubs = {};
+      var objects = Object.values(_this3._subscribed[type]);
 
-    for (var _i2 = 0, _objects = objects; _i2 < _objects.length; _i2++) {
-      var object = _objects[_i2];
+      for (var _i2 = 0, _objects = objects; _i2 < _objects.length; _i2++) {
+        var object = _objects[_i2];
 
-      var _iterator5 = _createForOfIteratorHelper(object),
-          _step5;
+        var _iterator5 = _createForOfIteratorHelper(object),
+            _step5;
 
-      try {
-        for (_iterator5.s(); !(_step5 = _iterator5.n()).done;) {
-          var sub = _step5.value;
+        try {
+          for (_iterator5.s(); !(_step5 = _iterator5.n()).done;) {
+            var sub = _step5.value;
 
-          if (!uniqueSubs[sub.subKey]) {
-            uniqueSubs[sub.subKey] = sub;
+            if (!uniqueSubs[sub.subKey]) {
+              uniqueSubs[sub.subKey] = sub;
+            }
           }
+        } catch (err) {
+          _iterator5.e(err);
+        } finally {
+          _iterator5.f();
         }
-      } catch (err) {
-        _iterator5.e(err);
-      } finally {
-        _iterator5.f();
       }
-    }
 
-    var possibleSubs = Object.values(uniqueSubs);
-    (0, _batchPromises["default"])(10, possibleSubs, function (_ref4) {
-      var callback = _ref4.callback,
-          filterFunction = _ref4.filterFunction;
-      var objectsToSubscribe = filterFunction ? newObjects.filter(filterFunction) : newObjects;
+      var possibleSubs = Object.values(uniqueSubs);
+      (0, _batchPromises["default"])(10, possibleSubs, function (_ref4) {
+        var callback = _ref4.callback,
+            filterFunction = _ref4.filterFunction;
+        var objectsToSubscribe = filterFunction ? newObjects.filter(filterFunction) : newObjects;
 
-      if (objectsToSubscribe.length) {
-        // Check if the new objects matter
-        return _this3.find(type, filterFunction).then(function (data) {
-          var subKey;
+        if (objectsToSubscribe.length) {
+          // Check if the new objects matter
+          return _this3.find(type, filterFunction).then(function (data) {
+            var subKey;
 
-          var _iterator6 = _createForOfIteratorHelper(data),
-              _step6;
+            var _iterator6 = _createForOfIteratorHelper(data),
+                _step6;
 
-          try {
-            for (_iterator6.s(); !(_step6 = _iterator6.n()).done;) {
-              var d = _step6.value;
+            try {
+              for (_iterator6.s(); !(_step6 = _iterator6.n()).done;) {
+                var d = _step6.value;
 
-              var item = _this3._subscribed[d.getModel().getType()][d.getId()];
+                var item = _this3._subscribed[d.getModel().getType()][d.getId()];
 
-              subKey = item ? item.subKey : null;
-              if (subKey) break;
+                subKey = item ? item.subKey : null;
+                if (subKey) break;
+              }
+            } catch (err) {
+              _iterator6.e(err);
+            } finally {
+              _iterator6.f();
             }
-          } catch (err) {
-            _iterator6.e(err);
-          } finally {
-            _iterator6.f();
-          }
 
-          _classPrivateFieldGet(_this3, _subscribeToObjects).call(_this3, type, objectsToSubscribe, {
-            callback: callback,
-            filterFunction: filterFunction,
-            subKey: subKey
-          });
+            _classPrivateFieldGet(_this3, _subscribeToObjects).call(_this3, type, objectsToSubscribe, {
+              callback: callback,
+              filterFunction: filterFunction,
+              subKey: subKey
+            });
 
-          return data;
-        }).then(callback);
-      }
-    });
-  }
+            return data;
+          }).then(callback);
+        }
+      });
+    }
+  });
 }
 
 var _default = ObserverStore;