dataflux 1.21.2 → 1.22.0

package/README.md

@@ -696,6 +696,7 @@ Each object created is enriched with the following methods.
 |------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | getId()                            | It returns a unique ID used by the store to identify the object. The ID is unique inside a single model. Be aware, `object.id` and `objet.getId()` may return different values, since store's IDs can be different from the one of the REST API.                                                                                                                    |
 | set(attribute, value, hidden)      | A method to set an attribute to the object. It provides some advantages compared to doing `object.attribute = value`, these are discussed in [below](#editing-objects). The third parameter is optional, and when set to true will set the attribute as hidden (see [hiddenFields](#models-creation)).                                                              |
+| delete(attribute)                  | A method to delete an attribute of the object.                                                                                                                                                                                                                                                                                                                      |
 | setConstant(attribute, value)      | A method to set an unmodifiable hidden attribute on the object. Setting the attribute as a constant will not propagate an update.                                                                                                                                                                                                                                   |
 | get(attribute, defaultValue)       | Method to retrieve the value of an attribute. It does not provide any advantage compared to accessing directly the attribute (e.g., `author.name`); except for hidden fields and constants, which can be retrieved only with the `.get` method. Additionally, you can provide a default value as a second parameter in case the object doesn't have that attribute. |
 | getRelation(model, filterFunction) | To get all the objects respecting a specific relation with this object (see [model relations](#model-relations)).                                                                                                                                                                                                                                                   |
@@ -709,6 +710,8 @@ Each object created is enriched with the following methods.
 | getError(attributeName)            | This method allows you to check if the specificed attribute generated any error according to the validation property specified in the model. See [objects validation](#objects-validation).                                                                                                                                                                         | 
 | setError(error)                    | Additionally to DataFlux's errors, you can trigger your own errors with this method. Other components observing this objet's error will be notified.                                                                                                                                                                                                                |
 | isDataflux()                       | This method returns true for all dataflux objects.                                                                                                                                                                                                                                                                                                                  |
+| isMock()                           | This method returns true if the object is a mock and was never inserted in the store.                                                                                                                                                                                                                                                                               |
+| isPersisted()                      | This method returns true if the object has been persisted to the server at least once. This does not mean that the server’s copy is up to date with the client’s copy.                                                                                                                                                                                              |
 
 ### Deep 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.

package/dist/BasicObj.js

@@ -96,6 +96,9 @@ var BasicObj = exports.BasicObj = /*#__PURE__*/function () {
     _defineProperty(this, "isDataflux", function () {
       return true;
     });
+    _defineProperty(this, "isPersisted", function () {
+      return true;
+    });
     _defineProperty(this, "isMock", function () {
       return false;
     });
@@ -173,6 +176,13 @@ var BasicObj = exports.BasicObj = /*#__PURE__*/function () {
     _classPrivateFieldSet(_model, this, model);
   }
   return _createClass(BasicObj, [{
+    key: "delete",
+    value: function _delete(attribute) {
+      delete _classPrivateFieldGet(_setHidden, this)[attribute];
+      delete this[attribute];
+      return this.update();
+    }
+  }, {
     key: "set",
     value: function set(attribute, value, hidden) {
       if (hidden) {

package/dist/Obj.js

@@ -59,6 +59,9 @@ var Obj = exports["default"] = /*#__PURE__*/function (_BasicObj) {
     _classCallCheck(this, Obj);
     _this = _callSuper(this, Obj, [values, _model]);
     _classPrivateFieldInitSpec(_this, _loaded, false);
+    _defineProperty(_this, "delete", function (attribute) {
+      return _superPropGet((_this, Obj), "delete", _this, 3)([attribute]);
+    });
     _defineProperty(_this, "set", function (attribute, value, hidden) {
       if (Array.isArray(value) && _this.getModel().options.deep) {
         value = value.map(function (i) {

package/dist/Store.js

@@ -214,6 +214,11 @@ var Store = exports["default"] = /*#__PURE__*/function () {
       var model = _this.models[type].model;
       var wrapper = new _Obj["default"](item, model);
       var id = wrapper.getId();
+      if (status === "new" || status === "mock") {
+        wrapper.isPersisted = function () {
+          return false;
+        };
+      }
       if (_this.models[type].storedObjects[id]) {
         throw new Error("The IDs provided for the model ".concat(type, " are not unique"));
       }
@@ -384,6 +389,9 @@ var Store = exports["default"] = /*#__PURE__*/function () {
               }
               item.fingerprint = object.object.getFingerprint();
               item.status = "old";
+              item.object.isPersisted = function () {
+                return true;
+              };
             }
           } catch (err) {
             _iterator3.e(err);

package/dist/SubObj.js

@@ -66,6 +66,9 @@ var SubObj = exports["default"] = /*#__PURE__*/function (_BasicObj) {
     _defineProperty(_this, "set", function (attribute, value, hidden) {
       return _superPropGet((_this, SubObj), "set", _this, 3)([attribute, value, hidden]);
     });
+    _defineProperty(_this, "delete", function (attribute) {
+      return _superPropGet((_this, SubObj), "delete", _this, 3)([attribute]);
+    });
     _defineProperty(_this, "save", function () {
       return _classPrivateFieldGet(_model, _this).getStore().save([_classPrivateFieldGet(_parent, _this)]);
     });