dataflux 1.5.2 → 1.5.3

package/README.md

@@ -87,7 +87,7 @@ Nothing else to do! After your edit, the store will do a single PUT request to t
 
 ### Example 2
 
-DataFlux automatically sends the edited objects back to the API to be saved. However, you can disable this behavior and manually instruct the store when to save. 
+DataFlux automatically sends the edited objects back to the API to be saved. However, you can disable this behavior and manually instruct the store when to save.
 
 ```js
 // To disable autoSave you must declare the store (in store.js) as follows
@@ -100,7 +100,7 @@ The same example above now becomes:
 // Find the author Dante Alighieri
 store.find("author", ({name, surname}) => name == "Dante" && surname == "Alighieri")
         .then(([author]) => {
-            
+
           // When autoSave is false, author.set("country", "Italy") and 
           // author.country = "Italy" are equivalent
           author.country = "Italy"
@@ -174,12 +174,12 @@ You can also do multiple subscriptions at once:
 
 ```js
 const subscriptions = [
-    ["book", ({title}) => title === "The little prince"], // Model name and filter function
-    ["author"], // No filter function, all objects returned
+  ["book", ({title}) => title === "The little prince"], // Model name and filter function
+  ["author"], // No filter function, all objects returned
 ];
 
 const callback = ({book, author}) => {
-    // Objects are ready
+  // Objects are ready
 };
 
 const subKey = store.multipleSubscribe(requests, callback); // Subscribe
@@ -221,7 +221,7 @@ class MyComponent extends React.Component {
                     onTitleChange={(title) => book.set("title", title)}
                     // onTitleChange will alter the book and so the current 
                     // state of "books" (a setState will be performed).
-                    
+
                     // Alternatively:
                     // onTitleChange={store.handleChange(book, "title")} 
                     // is a syntactic sugar of the function above
@@ -493,11 +493,47 @@ Each object created is enriched with the following methods.
 | getRelation(model, filterFunction) | To get all the objects respecting a specific relation with this object (see [model relations](#model-relations)).                                                                                                                                                                                                                                                   |
 | save()                             | Method to save the object. You can do `store.save()` instead.                                                                                                                                                                                                                                                                                                       |
 | destroy()                          | Method to delete the object. You can do `store.delete()` instead.                                                                                                                                                                                                                                                                                                   |
-
 | toJSON()                           | It returns a pure JSON representation of the object.                                                                                                                                                                                                                                                                                                                |
 | toString()                         | It returns a string representation of the object.                                                                                                                                                                                                                                                                                                                   |
 | getFingerprint()                   | It returns a hash of the object. The hash changes at every change of the object or of any nested object. Useful to detect object changes.                                                                                                                                                                                                                           |
 | getModel()                         | It returns the model of this object. Mostly useful to do `object.getModel().getType()` and obtain a string defining the type of the object.                                                                                                                                                                                                                         |
+### Deeper Objects
+When a model is declared with the option `deep: true` (default, see [model creation](#models-creation)), all the sub objects will also offer many of the methods above.
+
+Imagine the API returns:
+
+```json
+[
+  {
+    "title": "The little prince",
+    "reviews": [
+      {
+        "stars": 4,
+        "comment": "comment 1"
+      },
+      {
+        "stars": 3,
+        "comment": "comment 2"
+      }
+    ]
+  },
+  ...
+]
+```
+
+You can operate on the reviews similarly to how you operate on the main model's objects (book).
+
+```js
+store.find("book")
+      .then(([book]) => {
+        const firstReview = book.reviews[0];
+
+        // Examples of what you can do:
+        firstReview.detroy(); // The first review is removed from the array book.reviews
+        firstReview.set("stars", 5); // Set the stars of the first review to 5
+      });
+```
+
 
 ## Editing objects
 The option `autoSave` can be `true`, `false`, or a number (milliseconds).

package/dist/Obj.js

@@ -117,10 +117,10 @@ var Obj = /*#__PURE__*/function (_BasicObj) {
         var mmnt = (0, _moment["default"])(value);
         _this[key] = mmnt.isValid() ? mmnt : value;
       } else if (_model.options.deep && _typeof(value) === "object" && !Array.isArray(value)) {
-        _this[key] = new _SubObj["default"](_assertThisInitialized(_this), value, _model);
+        _this[key] = new _SubObj["default"](_assertThisInitialized(_this), key, value, _model);
       } else if (_model.options.deep && Array.isArray(value)) {
         _this[key] = value.map(function (i) {
-          return new _SubObj["default"](_assertThisInitialized(_this), i, _model);
+          return new _SubObj["default"](_assertThisInitialized(_this), key, i, _model);
         });
       } else {
         _this[key] = value;

package/dist/SubObj.js

@@ -5,8 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 
-var _uuid = require("uuid");
-
 var _BasicObj2 = require("./BasicObj");
 
 var _moment = _interopRequireDefault(require("moment/moment"));
@@ -55,12 +53,14 @@ var _model = /*#__PURE__*/new WeakMap();
 
 var _parent = /*#__PURE__*/new WeakMap();
 
+var _parentField = /*#__PURE__*/new WeakMap();
+
 var SubObj = /*#__PURE__*/function (_BasicObj) {
   _inherits(SubObj, _BasicObj);
 
   var _super = _createSuper(SubObj);
 
-  function SubObj(parent, values, model) {
+  function SubObj(parent, field, values, model) {
     var _this;
 
     _classCallCheck(this, SubObj);
@@ -77,12 +77,27 @@ var SubObj = /*#__PURE__*/function (_BasicObj) {
       value: void 0
     });
 
+    _classPrivateFieldInitSpec(_assertThisInitialized(_this), _parentField, {
+      writable: true,
+      value: void 0
+    });
+
     _defineProperty(_assertThisInitialized(_this), "save", function () {
       return _classPrivateFieldGet(_assertThisInitialized(_this), _model).getStore().save([_classPrivateFieldGet(_assertThisInitialized(_this), _parent)]);
     });
 
     _defineProperty(_assertThisInitialized(_this), "destroy", function () {
-      return _classPrivateFieldGet(_assertThisInitialized(_this), _model).getStore()["delete"]([_classPrivateFieldGet(_assertThisInitialized(_this), _parent)]);
+      var _classPrivateFieldGet2;
+
+      if (Array.isArray(_classPrivateFieldGet(_assertThisInitialized(_this), _parent)[_classPrivateFieldGet(_assertThisInitialized(_this), _parentField)])) {
+        _classPrivateFieldGet(_assertThisInitialized(_this), _parent)[_classPrivateFieldGet(_assertThisInitialized(_this), _parentField)] = _classPrivateFieldGet(_assertThisInitialized(_this), _parent)[_classPrivateFieldGet(_assertThisInitialized(_this), _parentField)].filter(function (i) {
+          return i.getId() !== _this.getId();
+        });
+      } else if ((_classPrivateFieldGet2 = _classPrivateFieldGet(_assertThisInitialized(_this), _parent)[_classPrivateFieldGet(_assertThisInitialized(_this), _parentField)]) !== null && _classPrivateFieldGet2 !== void 0 && _classPrivateFieldGet2.getId) {
+        _classPrivateFieldGet(_assertThisInitialized(_this), _parent)[_classPrivateFieldGet(_assertThisInitialized(_this), _parentField)] = null;
+      }
+
+      return _classPrivateFieldGet(_assertThisInitialized(_this), _model).getStore().update([_classPrivateFieldGet(_assertThisInitialized(_this), _parent)]);
     });
 
     _defineProperty(_assertThisInitialized(_this), "update", function () {
@@ -93,6 +108,8 @@ var SubObj = /*#__PURE__*/function (_BasicObj) {
 
     _classPrivateFieldSet(_assertThisInitialized(_this), _parent, parent);
 
+    _classPrivateFieldSet(_assertThisInitialized(_this), _parentField, field);
+
     Object.keys(values).forEach(function (key) {
       var value = values[key];
 
@@ -100,10 +117,10 @@ var SubObj = /*#__PURE__*/function (_BasicObj) {
         var mmnt = (0, _moment["default"])(value);
         _this[key] = mmnt.isValid() ? mmnt : value;
       } else if (model.options.deep && _typeof(value) === "object" && !Array.isArray(value)) {
-        _this[key] = new SubObj(_classPrivateFieldGet(_assertThisInitialized(_this), _parent), value, model);
+        _this[key] = new SubObj(_classPrivateFieldGet(_assertThisInitialized(_this), _parent), key, value, model);
       } else if (model.options.deep && Array.isArray(value)) {
         _this[key] = value.map(function (i) {
-          return new SubObj(_classPrivateFieldGet(_assertThisInitialized(_this), _parent), i, model);
+          return new SubObj(_classPrivateFieldGet(_assertThisInitialized(_this), _parent), key, i, model);
         });
       } else {
         _this[key] = value;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dataflux",
-  "version": "1.5.2",
+  "version": "1.5.3",
   "description": "DataFlux, automatically interfaces with your REST APIs to create a 2-way-synced local data store. Transparently manages data propagation in the React state.",
   "main": "dist/index.js",
   "bin": "dist/index.js",