@azrico/webobject 1.3.12 → 1.3.14

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,8 +46,42 @@ 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;
+    /**
+     * set the value to its original
+     * @param key
+     */
+    resetValue(key: WriteablePropOf<this>): Promise<boolean>;
+    /**
+     * set the value to its original
+     * @param key
+     */
+    reset: (key: WriteablePropOf<this>) => Promise<boolean>;
+    /**
+     * clear any changes related to the key
+     * only works in when useDelta is true
+     * @param key
+     */
+    clearDeltaValue(key: WriteablePropOf<this>): boolean;
+    /**
+     * clear any changes related to the key
+     * only works in when useDelta is true
+     * @param key
+     */
+    clear: (key: WriteablePropOf<this>) => boolean;
     /**
      * set key of subObject
      * @param key
@@ -56,14 +90,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,6 +41,7 @@ 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();
@@ -63,19 +64,25 @@ 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);
@@ -84,7 +91,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);
@@ -93,13 +100,28 @@ 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);
+    /**
+     * set the value to its original
+     * @param key
+     */
+    _defineProperty(_assertThisInitialized(_this), "reset", _this.resetValue);
+    /**
+     * clear any changes related to the key
+     * only works in when useDelta is true
+     * @param key
+     */
+    _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;
   }
@@ -147,7 +169,7 @@ var SimpleObject = /*#__PURE__*/function (_MapableObject) {
                 _context.next = 7;
                 break;
               }
-              if (!this.__throw_errors) {
+              if (!(this.__throw_errors !== false)) {
                 _context.next = 6;
                 break;
               }
@@ -190,9 +212,37 @@ 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: "resetValue",
+    value:
+    /**
+     * set the value to its original
+     * @param key
+     */
+    function resetValue(key) {
+      return this.setValue(key, _classPrivateMethodGet(this, _getProperty, _getProperty2).call(this, key, true));
+    }
+  }, {
+    key: "clearDeltaValue",
+    value:
+    /**
+     * clear any changes related to the key
+     * only works in when useDelta is true
+     * @param key
+     */
+    function clearDeltaValue(key) {
+      return _classPrivateMethodGet(this, _clearDeltaProperty, _clearDeltaProperty2).call(this, key);
+    }
   }, {
     key: "setSubValue",
     value:
@@ -217,7 +267,7 @@ var SimpleObject = /*#__PURE__*/function (_MapableObject) {
                 _context2.next = 7;
                 break;
               }
-              if (!this.__throw_errors) {
+              if (!(this.__throw_errors !== false)) {
                 _context2.next = 6;
                 break;
               }
@@ -257,7 +307,14 @@ var SimpleObject = /*#__PURE__*/function (_MapableObject) {
         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 () {
@@ -279,7 +336,7 @@ var SimpleObject = /*#__PURE__*/function (_MapableObject) {
                 _context3.next = 9;
                 break;
               }
-              if (!this.__throw_errors) {
+              if (!(this.__throw_errors !== false)) {
                 _context3.next = 8;
                 break;
               }
@@ -295,7 +352,7 @@ var SimpleObject = /*#__PURE__*/function (_MapableObject) {
                 _context3.next = 17;
                 break;
               }
-              if (!this.__throw_errors) {
+              if (!(this.__throw_errors !== false)) {
                 _context3.next = 16;
                 break;
               }
@@ -323,6 +380,13 @@ var SimpleObject = /*#__PURE__*/function (_MapableObject) {
       }
       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 () {
@@ -360,6 +424,13 @@ var SimpleObject = /*#__PURE__*/function (_MapableObject) {
       }
       return notifyChanged;
     }()
+    /**
+     * check if a key can be changed on an object
+     * @param object
+     * @param key
+     * @param useExtraProps
+     * @returns
+     */
   }, {
     key: "apply_changes",
     value: /* -------------------------------------------------------------------------- */
@@ -388,6 +459,10 @@ var SimpleObject = /*#__PURE__*/function (_MapableObject) {
         this.clear_changes();
       }
     }
+    /**
+     * clear and discard all changes
+     * @returns
+     */
   }, {
     key: "clear_changes",
     value: function clear_changes() {
@@ -395,10 +470,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;
     }
     /**
@@ -503,7 +582,7 @@ var SimpleObject = /*#__PURE__*/function (_MapableObject) {
   }, {
     key: "lastChanged",
     get: function get() {
-      return this.__lastChanged;
+      return this.__lastChanged || "";
     }
   }, {
     key: "manager",
@@ -843,9 +922,24 @@ 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;
+  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;
+  }
+}
+function _clearDeltaProperty2(key) {
+  if (this.__use_delta) {
+    delete this.__delta[key];
+    return true;
+  }
+  return false;
 }
 function _setDefaultProperty2(key, value) {
   //@ts-ignore

package/package.json

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