@azrico/webobject 1.3.13 → 1.3.15

package/dist/src/WebObjects/WebObject.js

@@ -75,10 +75,10 @@ var WebObject = /*#__PURE__*/function (_SimpleObject) {
       var createIfNotExists = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : true;
       var sendChange = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : "auto";
       if (!this.canModify) {
-        if (this.__throw_errors) throw Error("Cant use setMetaValue on ".concat(key, " when on readonly mode"));else return false;
+        if (this.__throw_errors !== false) throw Error("Cant use setMetaValue on ".concat(key, " when on readonly mode"));else return false;
       }
       if (!key || typeof key != "string") {
-        if (this.__throw_errors) throw Error("Bad key at setMetaValue");else return false;
+        if (this.__throw_errors !== false) throw Error("Bad key at setMetaValue");else return false;
       }
       var old_value = WebObject.getMetaValue(this, key);
       if ((0, _object.object_equals)(old_value, value)) return false; //same value, no changes
@@ -127,7 +127,7 @@ var WebObject = /*#__PURE__*/function (_SimpleObject) {
         return _regeneratorRuntime().wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
-              if (!this.__throw_errors) {
+              if (!(this.__throw_errors !== false)) {
                 _context.next = 2;
                 break;
               }
@@ -154,7 +154,7 @@ var WebObject = /*#__PURE__*/function (_SimpleObject) {
         return _regeneratorRuntime().wrap(function _callee2$(_context2) {
           while (1) switch (_context2.prev = _context2.next) {
             case 0:
-              if (!this.__throw_errors) {
+              if (!(this.__throw_errors !== false)) {
                 _context2.next = 2;
                 break;
               }

package/dist/src/structs/SimpleObject.d.ts

@@ -18,10 +18,10 @@ export declare class SimpleObject extends MapableObject {
     __delta: Partial<this>;
     __temp: any;
     __changed: boolean;
-    __lastChanged: string;
-    __is_readonly: boolean;
-    __throw_errors: boolean;
-    _deleted: boolean;
+    __lastChanged?: string;
+    __is_readonly?: boolean;
+    __throw_errors?: boolean;
+    _deleted?: boolean;
     _deletedBy?: string;
     __errors?: any[];
     __showErrors?: boolean;
@@ -46,10 +46,30 @@ export declare class SimpleObject extends MapableObject {
     setValue(key: WriteablePropOf<this>, value: any, sendChanges?: sendChangesType): Promise<boolean>;
     set: (key: WriteablePropOf<this>, value: any, sendChanges?: sendChangesType) => Promise<boolean>;
     setTemp: (key: string, value: any) => any;
+    /**
+     * set value of a key only if the value is empty
+     * @param key
+     * @param value
+     * @returns
+     */
     setDefaultValue(key: WriteablePropOf<this>, value: any): boolean;
+    /**
+     * set value of a key only if the value is empty
+     * @param key
+     * @param value
+     * @returns
+     */
     setDefault: (key: WriteablePropOf<this>, value: any) => boolean;
-    clearDeltaValue(key: WriteablePropOf<this>): boolean;
-    clear: (key: WriteablePropOf<this>) => boolean;
+    /**
+     * set the value to its original
+     * @param key
+     */
+    reset(key: WriteablePropOf<this>, notifyChanged?: sendChangesType): Promise<boolean>;
+    /**
+     * reset all values back to their original
+     * @param key
+     */
+    resetAll(notifyChanged?: sendChangesType): Promise<boolean>;
     /**
      * set key of subObject
      * @param key
@@ -58,14 +78,43 @@ export declare class SimpleObject extends MapableObject {
      * @return true if changed , false otherwise
      */
     setSubValue(key: PropOf<this>, objKey: string, subvalue: any, sendChanges?: sendChangesType): Promise<boolean>;
+    /**
+     * Push value on array
+     * @param key
+     * @param value
+     * @param sendChanges
+     * @returns
+     */
     pushValue<MKey extends PropOf<this>>(key: MKey, value: any, sendChanges?: sendChangesType): Promise<this[MKey] | false>;
+    /**
+     * notify the manager class when a value is changed on this object
+     * @param type
+     * @param key
+     * @param value
+     * @param subvalue
+     */
     notifyChanged(type: string, key: string, value: any, subvalue?: any): Promise<void>;
+    /**
+     * check if a key can be changed on an object
+     * @param object
+     * @param key
+     * @param useExtraProps
+     * @returns
+     */
     static canChangeKey(object: SimpleObject, key: string, useExtraProps: boolean): boolean;
     /**
      * Apply the changes and empty the delta object
      */
     apply_changes(): boolean;
+    /**
+     * clear and discard all changes
+     * @returns
+     */
     clear_changes(): boolean;
+    /**
+     * clear and discard all temp values
+     * @returns
+     */
     clear_cache(): boolean;
     /**
      * Sets readonly property on given objects

package/dist/src/structs/SimpleObject.js

@@ -41,7 +41,6 @@ function _classPrivateMethodGet(receiver, privateSet, fn) { if (!privateSet.has(
 var _setSubProperty = /*#__PURE__*/new WeakSet();
 var _getSubProperty = /*#__PURE__*/new WeakSet();
 var _setProperty = /*#__PURE__*/new WeakSet();
-var _clearDeltaProperty = /*#__PURE__*/new WeakSet();
 var _setDefaultProperty = /*#__PURE__*/new WeakSet();
 var _getProperty = /*#__PURE__*/new WeakSet();
 var _getTempProperty = /*#__PURE__*/new WeakSet();
@@ -64,20 +63,24 @@ var SimpleObject = /*#__PURE__*/function (_MapableObject) {
     _classPrivateMethodInitSpec(_assertThisInitialized(_this), _getTempProperty);
     _classPrivateMethodInitSpec(_assertThisInitialized(_this), _getProperty);
     _classPrivateMethodInitSpec(_assertThisInitialized(_this), _setDefaultProperty);
-    _classPrivateMethodInitSpec(_assertThisInitialized(_this), _clearDeltaProperty);
     _classPrivateMethodInitSpec(_assertThisInitialized(_this), _setProperty);
     _classPrivateMethodInitSpec(_assertThisInitialized(_this), _getSubProperty);
     _classPrivateMethodInitSpec(_assertThisInitialized(_this), _setSubProperty);
+    //an exact copy of this object is stored here
     _defineProperty(_assertThisInitialized(_this), "__originalobject", void 0);
-    //changes
+    //changes are saved here
     _defineProperty(_assertThisInitialized(_this), "__delta", {});
     _defineProperty(_assertThisInitialized(_this), "__temp", undefined);
     _defineProperty(_assertThisInitialized(_this), "__changed", false);
-    _defineProperty(_assertThisInitialized(_this), "__lastChanged", "");
+    //the last thing that was changed on this object
+    _defineProperty(_assertThisInitialized(_this), "__lastChanged", void 0);
+    //is the object read only
     _defineProperty(_assertThisInitialized(_this), "__is_readonly", void 0);
+    //should we throw errors when encountering an error?
+    //is TRUE by default
     _defineProperty(_assertThisInitialized(_this), "__throw_errors", void 0);
     //is this object marked as deleted?
-    _defineProperty(_assertThisInitialized(_this), "_deleted", false);
+    _defineProperty(_assertThisInitialized(_this), "_deleted", void 0);
     _defineProperty(_assertThisInitialized(_this), "_deletedBy", void 0);
     //errors
     _defineProperty(_assertThisInitialized(_this), "__errors", void 0);
@@ -86,7 +89,7 @@ var SimpleObject = /*#__PURE__*/function (_MapableObject) {
     _defineProperty(_assertThisInitialized(_this), "__saveResultObject", void 0);
     _defineProperty(_assertThisInitialized(_this), "__saveResultIsSuccess", true);
     _defineProperty(_assertThisInitialized(_this), "__saveResultType", void 0);
-    //sequence key
+    //sequence key (usually managed by the database)
     _defineProperty(_assertThisInitialized(_this), "_index_key", "");
     //sequence value , used to index the object with increasing numbers
     _defineProperty(_assertThisInitialized(_this), "_index_value", -1);
@@ -95,14 +98,17 @@ var SimpleObject = /*#__PURE__*/function (_MapableObject) {
     _defineProperty(_assertThisInitialized(_this), "getTemp", _classPrivateMethodGet(_assertThisInitialized(_this), _getTempProperty, _getTempProperty2));
     _defineProperty(_assertThisInitialized(_this), "set", _this.setValue);
     _defineProperty(_assertThisInitialized(_this), "setTemp", _classPrivateMethodGet(_assertThisInitialized(_this), _setTempProperty, _setTempProperty2));
+    /**
+     * set value of a key only if the value is empty
+     * @param key
+     * @param value
+     * @returns
+     */
     _defineProperty(_assertThisInitialized(_this), "setDefault", _this.setDefaultValue);
-    _defineProperty(_assertThisInitialized(_this), "clear", _this.clearDeltaValue);
     _defineProperty(_assertThisInitialized(_this), "get_managerClass", function () {
       return null;
     });
-    if (_this._deleted == null) _this._deleted = false;
     _this.__is_readonly = is_readonly;
-    _this.__throw_errors = true;
     _this.clear_changes();
     return _this;
   }
@@ -150,7 +156,7 @@ var SimpleObject = /*#__PURE__*/function (_MapableObject) {
                 _context.next = 7;
                 break;
               }
-              if (!this.__throw_errors) {
+              if (!(this.__throw_errors !== false)) {
                 _context.next = 6;
                 break;
               }
@@ -193,17 +199,96 @@ var SimpleObject = /*#__PURE__*/function (_MapableObject) {
     }()
   }, {
     key: "setDefaultValue",
-    value: function setDefaultValue(key, value) {
+    value:
+    /**
+     * set value of a key only if the value is empty
+     * @param key
+     * @param value
+     * @returns
+     */
+    function setDefaultValue(key, value) {
       return _classPrivateMethodGet(this, _setDefaultProperty, _setDefaultProperty2).call(this, key, value);
     }
   }, {
-    key: "clearDeltaValue",
-    value: function clearDeltaValue(key) {
-      return _classPrivateMethodGet(this, _clearDeltaProperty, _clearDeltaProperty2).call(this, key);
-    }
-  }, {
-    key: "setSubValue",
+    key: "reset",
     value:
+    /**
+     * set the value to its original
+     * @param key
+     */
+    function () {
+      var _reset = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee2(key) {
+        var notifyChanged,
+          _args2 = arguments;
+        return _regeneratorRuntime().wrap(function _callee2$(_context2) {
+          while (1) switch (_context2.prev = _context2.next) {
+            case 0:
+              notifyChanged = _args2.length > 1 && _args2[1] !== undefined ? _args2[1] : "auto";
+              _context2.next = 3;
+              return this.setValue(key, this[key], notifyChanged);
+            case 3:
+              return _context2.abrupt("return", _context2.sent);
+            case 4:
+            case "end":
+              return _context2.stop();
+          }
+        }, _callee2, this);
+      }));
+      function reset(_x3) {
+        return _reset.apply(this, arguments);
+      }
+      return reset;
+    }()
+    /**
+     * reset all values back to their original
+     * @param key
+     */
+  }, {
+    key: "resetAll",
+    value: function () {
+      var _resetAll = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee3() {
+        var notifyChanged,
+          fr,
+          key,
+          _args3 = arguments;
+        return _regeneratorRuntime().wrap(function _callee3$(_context3) {
+          while (1) switch (_context3.prev = _context3.next) {
+            case 0:
+              notifyChanged = _args3.length > 0 && _args3[0] !== undefined ? _args3[0] : "auto";
+              fr = true;
+              _context3.t0 = _regeneratorRuntime().keys(this.__delta);
+            case 3:
+              if ((_context3.t1 = _context3.t0()).done) {
+                _context3.next = 13;
+                break;
+              }
+              key = _context3.t1.value;
+              _context3.t2 = fr;
+              if (!_context3.t2) {
+                _context3.next = 10;
+                break;
+              }
+              _context3.next = 9;
+              return this.reset(key, notifyChanged);
+            case 9:
+              _context3.t2 = _context3.sent;
+            case 10:
+              fr = _context3.t2;
+              _context3.next = 3;
+              break;
+            case 13:
+              return _context3.abrupt("return", fr);
+            case 14:
+            case "end":
+              return _context3.stop();
+          }
+        }, _callee3, this);
+      }));
+      function resetAll() {
+        return _resetAll.apply(this, arguments);
+      }
+      return resetAll;
+    }()
     /**
      * set key of subObject
      * @param key
@@ -211,30 +296,32 @@ var SimpleObject = /*#__PURE__*/function (_MapableObject) {
      * @param subvalue
      * @return true if changed , false otherwise
      */
-    function () {
-      var _setSubValue = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee2(key, objKey, subvalue) {
+  }, {
+    key: "setSubValue",
+    value: function () {
+      var _setSubValue = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee4(key, objKey, subvalue) {
         var sendChanges,
           isValueChanged,
           subval,
-          _args2 = arguments;
-        return _regeneratorRuntime().wrap(function _callee2$(_context2) {
-          while (1) switch (_context2.prev = _context2.next) {
+          _args4 = arguments;
+        return _regeneratorRuntime().wrap(function _callee4$(_context4) {
+          while (1) switch (_context4.prev = _context4.next) {
             case 0:
-              sendChanges = _args2.length > 3 && _args2[3] !== undefined ? _args2[3] : "auto";
+              sendChanges = _args4.length > 3 && _args4[3] !== undefined ? _args4[3] : "auto";
               if (this.canModify) {
-                _context2.next = 7;
+                _context4.next = 7;
                 break;
               }
-              if (!this.__throw_errors) {
-                _context2.next = 6;
+              if (!(this.__throw_errors !== false)) {
+                _context4.next = 6;
                 break;
               }
               throw Error("Cant use setValue when on readonly mode");
             case 6:
-              return _context2.abrupt("return", false);
+              return _context4.abrupt("return", false);
             case 7:
               isValueChanged = false;
-              _context2.prev = 8;
+              _context4.prev = 8;
               //if accessing subval of an object, make sure the object is not null
               subval = _classPrivateMethodGet(this, _getSubProperty, _getSubProperty2).call(this, key, objKey);
               if (!(0, _object.object_equals)(subval, subvalue, {
@@ -244,100 +331,114 @@ var SimpleObject = /*#__PURE__*/function (_MapableObject) {
                 isValueChanged = true;
               } else isValueChanged = false;
             case 11:
-              _context2.prev = 11;
+              _context4.prev = 11;
               if (!(sendChanges === true || sendChanges === "auto" && isValueChanged)) {
-                _context2.next = 15;
+                _context4.next = 15;
                 break;
               }
-              _context2.next = 15;
+              _context4.next = 15;
               return this.notifyChanged("", String(key), objKey, subvalue);
             case 15:
-              return _context2.finish(11);
+              return _context4.finish(11);
             case 16:
-              return _context2.abrupt("return", isValueChanged);
+              return _context4.abrupt("return", isValueChanged);
             case 17:
             case "end":
-              return _context2.stop();
+              return _context4.stop();
           }
-        }, _callee2, this, [[8,, 11, 16]]);
+        }, _callee4, this, [[8,, 11, 16]]);
       }));
-      function setSubValue(_x3, _x4, _x5) {
+      function setSubValue(_x4, _x5, _x6) {
         return _setSubValue.apply(this, arguments);
       }
       return setSubValue;
-    }() //Push value on array
+    }()
+    /**
+     * Push value on array
+     * @param key
+     * @param value
+     * @param sendChanges
+     * @returns
+     */
   }, {
     key: "pushValue",
     value: function () {
-      var _pushValue = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee3(key, value) {
+      var _pushValue = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee5(key, value) {
         var sendChanges,
           tempArray,
-          _args3 = arguments;
-        return _regeneratorRuntime().wrap(function _callee3$(_context3) {
-          while (1) switch (_context3.prev = _context3.next) {
+          _args5 = arguments;
+        return _regeneratorRuntime().wrap(function _callee5$(_context5) {
+          while (1) switch (_context5.prev = _context5.next) {
             case 0:
-              sendChanges = _args3.length > 2 && _args3[2] !== undefined ? _args3[2] : "auto";
+              sendChanges = _args5.length > 2 && _args5[2] !== undefined ? _args5[2] : "auto";
               if (!(value == null)) {
-                _context3.next = 3;
+                _context5.next = 3;
                 break;
               }
-              return _context3.abrupt("return", false);
+              return _context5.abrupt("return", false);
             case 3:
               if (this.canModify) {
-                _context3.next = 9;
+                _context5.next = 9;
                 break;
               }
-              if (!this.__throw_errors) {
-                _context3.next = 8;
+              if (!(this.__throw_errors !== false)) {
+                _context5.next = 8;
                 break;
               }
               throw Error("Cant use pushValue when on readonly mode");
             case 8:
-              return _context3.abrupt("return", false);
+              return _context5.abrupt("return", false);
             case 9:
               if (_classPrivateMethodGet(this, _getProperty, _getProperty2).call(this, key) == null) {
                 _classPrivateMethodGet(this, _setProperty, _setProperty2).call(this, key, []);
               }
               tempArray = _classPrivateMethodGet(this, _getProperty, _getProperty2).call(this, key);
               if (Array.isArray(tempArray)) {
-                _context3.next = 17;
+                _context5.next = 17;
                 break;
               }
-              if (!this.__throw_errors) {
-                _context3.next = 16;
+              if (!(this.__throw_errors !== false)) {
+                _context5.next = 16;
                 break;
               }
               throw Error("Cant use pushValue on non Array keys");
             case 16:
-              return _context3.abrupt("return", false);
+              return _context5.abrupt("return", false);
             case 17:
               _classPrivateMethodGet(this, _setProperty, _setProperty2).call(this, key, [].concat(_toConsumableArray(tempArray), [value]));
               if (!(sendChanges === true || sendChanges === "auto")) {
-                _context3.next = 21;
+                _context5.next = 21;
                 break;
               }
-              _context3.next = 21;
+              _context5.next = 21;
               return this.notifyChanged("", String(key), value);
             case 21:
-              return _context3.abrupt("return", tempArray);
+              return _context5.abrupt("return", tempArray);
             case 22:
             case "end":
-              return _context3.stop();
+              return _context5.stop();
           }
-        }, _callee3, this);
+        }, _callee5, this);
       }));
-      function pushValue(_x6, _x7) {
+      function pushValue(_x7, _x8) {
         return _pushValue.apply(this, arguments);
       }
       return pushValue;
     }()
+    /**
+     * notify the manager class when a value is changed on this object
+     * @param type
+     * @param key
+     * @param value
+     * @param subvalue
+     */
   }, {
     key: "notifyChanged",
     value: function () {
-      var _notifyChanged = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee4(type, key, value, subvalue) {
+      var _notifyChanged = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee6(type, key, value, subvalue) {
         var lc, manager_class;
-        return _regeneratorRuntime().wrap(function _callee4$(_context4) {
-          while (1) switch (_context4.prev = _context4.next) {
+        return _regeneratorRuntime().wrap(function _callee6$(_context6) {
+          while (1) switch (_context6.prev = _context6.next) {
             case 0:
               if (value === undefined && type != "meta") value = this.getValue(key);
               this.__changed = true;
@@ -352,22 +453,29 @@ var SimpleObject = /*#__PURE__*/function (_MapableObject) {
               /* --------------------------- notify the manager --------------------------- */
               manager_class = this.get_managerClass();
               if (!(manager_class instanceof _ObjectManager["default"])) {
-                _context4.next = 10;
+                _context6.next = 10;
                 break;
               }
-              _context4.next = 10;
+              _context6.next = 10;
               return manager_class.notifyChanged(type, key, value, subvalue);
             case 10:
             case "end":
-              return _context4.stop();
+              return _context6.stop();
           }
-        }, _callee4, this);
+        }, _callee6, this);
       }));
-      function notifyChanged(_x8, _x9, _x10, _x11) {
+      function notifyChanged(_x9, _x10, _x11, _x12) {
         return _notifyChanged.apply(this, arguments);
       }
       return notifyChanged;
     }()
+    /**
+     * check if a key can be changed on an object
+     * @param object
+     * @param key
+     * @param useExtraProps
+     * @returns
+     */
   }, {
     key: "apply_changes",
     value: /* -------------------------------------------------------------------------- */
@@ -396,6 +504,10 @@ var SimpleObject = /*#__PURE__*/function (_MapableObject) {
         this.clear_changes();
       }
     }
+    /**
+     * clear and discard all changes
+     * @returns
+     */
   }, {
     key: "clear_changes",
     value: function clear_changes() {
@@ -403,10 +515,14 @@ var SimpleObject = /*#__PURE__*/function (_MapableObject) {
       this.__changed = false;
       return true;
     }
+    /**
+     * clear and discard all temp values
+     * @returns
+     */
   }, {
     key: "clear_cache",
     value: function clear_cache() {
-      this.__temp = undefined;
+      delete this.__temp;
       return true;
     }
     /**
@@ -511,7 +627,7 @@ var SimpleObject = /*#__PURE__*/function (_MapableObject) {
   }, {
     key: "lastChanged",
     get: function get() {
-      return this.__lastChanged;
+      return this.__lastChanged || "";
     }
   }, {
     key: "manager",
@@ -851,16 +967,17 @@ function _getSubProperty2(key, subkey) {
   return subobj[subkey];
 }
 function _setProperty2(key, value) {
-  this.__delta[key] = value; //always update delta to keep track of changes
-  if (!this.__use_delta) this[key] = value; //on noDelta mode, also update the obj
-  return true;
-}
-function _clearDeltaProperty2(key) {
-  if (this.__use_delta) {
+  if (this[key] === value) {
+    /**
+     * We set something back to its original value so no need to save it as Delta
+     */
     delete this.__delta[key];
+    return false;
+  } else {
+    this.__delta[key] = value; //always update delta to keep track of changes
+    if (!this.__use_delta) this[key] = value; //on noDelta mode, also update the obj
     return true;
   }
-  return false;
 }
 function _setDefaultProperty2(key, value) {
   //@ts-ignore
@@ -873,11 +990,9 @@ function _setDefaultProperty2(key, value) {
 function _getProperty2(key) {
   var original = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
   //check if we should use delta version or normal version for this property
-  if (this.__use_delta && !original && key in this.__delta) {
-    //@ts-ignore
-    return this.__delta[key];
-  }
-  return this[key];
+  if (original || !this.__use_delta || !(key in this.__delta)) return this[key];
+  //@ts-ignore
+  return this.__delta[key];
 }
 function _getTempProperty2(key) {
   if (this.__temp == null) return undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@azrico/webobject",
-    "version": "1.3.13",
+    "version": "1.3.15",
     "description": "Stateful object",
     "author": "Azrideus",
     "license": "MIT",