@azrico/webobject 1.5.10 → 1.5.11

package/dist/src/WebObjects/WebObject.d.ts

@@ -1,14 +1,5 @@
-import { SimpleObject, sendChangesType } from "../index";
+import { SimpleObject, deltaParams, sendChangesType } from "../index";
 import { WebObjectManager } from "../index";
-export type deltaParams = {
-    type?: string;
-    isChild?: boolean;
-    useDelta?: boolean;
-    allProperties?: boolean;
-    extraProperties?: boolean;
-    needId?: boolean;
-    applyFilter?: boolean;
-};
 export declare class WebObject extends SimpleObject {
     static readonly __web_path: string;
     static readonly __protectedProperties: string[];
@@ -80,9 +71,10 @@ export declare class WebObject extends SimpleObject {
      */
     get_basicObject(): Promise<Partial<this>>;
     /**
-     * calls the `get_deltaObject` with  `allProperties=true`  `extraProperties=true`
+     * calls the `get_deltaObject` with
+     * `allProperties` `extraProperties` `tempProperties`
+     * set to true
      *
-     * useful in server applications
      * @returns
      */
     get_fullObject(p?: deltaParams): Promise<any>;

package/dist/src/WebObjects/WebObject.js

@@ -512,9 +512,10 @@ var WebObject = exports.WebObject = /*#__PURE__*/function (_SimpleObject) {
       return get_basicObject;
     }()
     /**
-     * calls the `get_deltaObject` with  `allProperties=true`  `extraProperties=true`
+     * calls the `get_deltaObject` with
+     * `allProperties` `extraProperties` `tempProperties`
+     * set to true
      *
-     * useful in server applications
      * @returns
      */
     )
@@ -526,10 +527,11 @@ var WebObject = exports.WebObject = /*#__PURE__*/function (_SimpleObject) {
           while (1) switch (_context9.prev = _context9.next) {
             case 0:
               _context9.next = 2;
-              return this.get_deltaObject({
+              return this.get_deltaObject(_objectSpread({
                 allProperties: true,
-                extraProperties: true
-              });
+                extraProperties: true,
+                tempProperties: true
+              }, p));
             case 2:
               return _context9.abrupt("return", _context9.sent);
             case 3:
@@ -553,7 +555,7 @@ var WebObject = exports.WebObject = /*#__PURE__*/function (_SimpleObject) {
     key: "get_deltaObject",
     value: (function () {
       var _get_deltaObject = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee12(p) {
-        var final_object, isChild, useDelta, allProperties, needId, chkChangables, useExtraProps, dlt, key, changableKeys, functionProps, index, fp, parseObj, _parseObj, _iterator, _step, _key, gotIndex, gotId, tempusers;
+        var final_object, useDelta, chkChangables, changedFields, key, changableKeys, functionProps, index, fp, parseObj, _parseObj, _iterator, _step, _key, gotIndex, gotId, tempusers;
         return _regeneratorRuntime().wrap(function _callee12$(_context12) {
           while (1) switch (_context12.prev = _context12.next) {
             case 0:
@@ -628,107 +630,95 @@ var WebObject = exports.WebObject = /*#__PURE__*/function (_SimpleObject) {
               };
               if (!p) p = {};
               final_object = {}; //@ts-ignore
-              isChild = Boolean(p.isChild || p.ischild); //@ts-ignore
-              useDelta = this.__use_delta || Boolean(p.useDelta || p.usedelta);
-              allProperties = Boolean(
-              //@ts-ignore
-              p.allProperties || p.allproperties || isChild); //@ts-ignore
-              needId = Boolean(p.needId || p.needid);
+              useDelta = this.__use_delta || p.useDelta;
               chkChangables = this.__changeables != null || this.__unchangeables != null;
-              useExtraProps = Boolean(p.extraProperties); //child objects usually dont update their __delta, so we read info from all of its properties
-              dlt = allProperties || !useDelta && isChild && chkChangables ? _objectSpread({}, this.allproperties) : _objectSpread({}, this.__delta);
+              /**
+               * child objects usually dont update their __delta
+               * so we read info from all of its properties
+               */
+              changedFields = p.allProperties || !useDelta && p.isChild && chkChangables ? _objectSpread({}, this.allproperties) : _objectSpread({}, this.__delta);
               /* ------------- parse children that have WebObject as delta ------------- */
               _context12.t0 = _regeneratorRuntime().keys(this);
-            case 12:
+            case 8:
               if ((_context12.t1 = _context12.t0()).done) {
-                _context12.next = 19;
+                _context12.next = 15;
                 break;
               }
               key = _context12.t1.value;
-              if (!(key.startsWith("__") || key in dlt)) {
-                _context12.next = 16;
+              if (!(key.startsWith("__") || key in changedFields)) {
+                _context12.next = 12;
                 break;
               }
-              return _context12.abrupt("continue", 12);
-            case 16:
+              return _context12.abrupt("continue", 8);
+            case 12:
               if (_WebObjectHelper["default"].isChangedWebObjectField(this[key])) {
                 /**
-                 * if an array child has any change we must change the whole array to database
+                 * if a child has any change we must add it into our delta
+                 * notice that the changes may not be saved to database depending on __changeables
+                 * but they are changes nevertheless
                  */
-                dlt[key] = this[key];
+                changedFields[key] = this[key];
               }
-              _context12.next = 12;
+              _context12.next = 8;
               break;
-            case 19:
+            case 15:
               /* ------------------------- get all changeable keys ------------------------ */
-              changableKeys = (0, _object.array_intersection)(Object.keys(dlt), WebObject.getChangeableKeys(this, {
-                useExtraProps: useExtraProps,
-                ignoreProtected: allProperties
-              })); // chkChangables
-              //     ? allkeys.filter((s) =>
-              //           SimpleObject.canChangeKey(this, s, {
-              //               useExtraProps: useExtraProps,
-              //               ignoreProtected: allProperties,
-              //           }),
-              //       )
-              //     : allkeys;
-              _context12.next = 22;
+              changableKeys = (0, _object.array_intersection)(Object.keys(changedFields), WebObject.getChangeableKeys(this, p));
+              _context12.next = 18;
               return _convert["default"].applyFormats({
-                inputobject: dlt,
+                inputobject: changedFields,
                 formats: (0, _object.object_getStatic)(this, "__formatList"),
                 changableKeys: changableKeys,
                 applyDefaults: true
               });
-            case 22:
+            case 18:
               /* -------------------------------------------------------------------------- */
               /*                            __functionProperties                            */
               /* -------------------------------------------------------------------------- */
               functionProps = (0, _object.object_getStatic)(this, "__functionProperties");
-              if (Array.isArray(functionProps)) {
-                for (index = 0; index < functionProps.length; index++) {
-                  fp = functionProps[index];
-                  if (dlt[fp]) dlt[fp] = (0, _object.fn_eval_this)(this, dlt[fp]);
-                }
+              for (index = 0; index < functionProps.length; index++) {
+                fp = functionProps[index];
+                if (changedFields[fp]) changedFields[fp] = (0, _object.fn_eval_this)(this, changedFields[fp]);
               }
               /* -------------------------------------------------------------------------- */
               /*                           parse all changableKeys                          */
               /* -------------------------------------------------------------------------- */
               _iterator = _createForOfIteratorHelper(changableKeys);
-              _context12.prev = 25;
+              _context12.prev = 21;
               _iterator.s();
-            case 27:
+            case 23:
               if ((_step = _iterator.n()).done) {
-                _context12.next = 34;
+                _context12.next = 30;
                 break;
               }
               _key = _step.value;
-              _context12.next = 31;
-              return parseObj(dlt[_key]);
-            case 31:
-              final_object[_key] = _context12.sent;
-            case 32:
               _context12.next = 27;
+              return parseObj(changedFields[_key]);
+            case 27:
+              final_object[_key] = _context12.sent;
+            case 28:
+              _context12.next = 23;
               break;
-            case 34:
-              _context12.next = 39;
+            case 30:
+              _context12.next = 35;
               break;
-            case 36:
-              _context12.prev = 36;
-              _context12.t2 = _context12["catch"](25);
+            case 32:
+              _context12.prev = 32;
+              _context12.t2 = _context12["catch"](21);
               _iterator.e(_context12.t2);
-            case 39:
-              _context12.prev = 39;
+            case 35:
+              _context12.prev = 35;
               _iterator.f();
-              return _context12.finish(39);
-            case 42:
+              return _context12.finish(35);
+            case 38:
               /* -------------------- add acrhived and date properties -------------------- */
-              if (allProperties) {
+              if (p.allProperties) {
                 final_object["_created_date"] = this["_created_date"];
                 final_object["_archived"] = this.isArchived;
                 final_object["_deleted"] = this.isDeleted;
               }
               /* ---------------------------- add id properties --------------------------- */
-              if (allProperties || needId) {
+              if (p.allProperties || p.needId) {
                 if (this["_index_key"]) final_object["_index_key"] = this["_index_key"];
                 gotIndex = this.getIndex();
                 gotId = this.getID();
@@ -746,11 +736,11 @@ var WebObject = exports.WebObject = /*#__PURE__*/function (_SimpleObject) {
                 final_object["_users"] = (0, _object.wrap_array)(tempusers);
               }
               return _context12.abrupt("return", final_object);
-            case 46:
+            case 42:
             case "end":
               return _context12.stop();
           }
-        }, _callee12, this, [[25, 36, 39, 42]]);
+        }, _callee12, this, [[21, 32, 35, 38]]);
       }));
       function get_deltaObject(_x4) {
         return _get_deltaObject.apply(this, arguments);

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

@@ -7,23 +7,31 @@ export type saveType = "normal" | "quick";
 export type sendChangesType = boolean | "auto";
 export type WithManager<T extends SimpleObject> = Ensure<T, "manager">;
 export type WithManagerOrNot<T extends SimpleObject> = T | WithManager<T>;
-type getKeysProps = {
-    useExtraProps?: boolean;
-    ignoreProtected?: boolean;
+export type deltaParams = {
+    type?: string;
+    useDelta?: boolean;
+    isChild?: boolean;
+    allProperties?: boolean;
+    extraProperties?: boolean;
+    tempProperties?: boolean;
+    bypassProtected?: boolean;
+    needId?: boolean;
+    applyFilter?: boolean;
 };
 export declare class SimpleObject extends MapableObject {
     #private;
     static readonly __db_name: string;
     static readonly __object_name: string;
-    static readonly __unchangeables?: string[];
-    static readonly __changeables?: string[];
-    static readonly __protectedProperties?: string[];
-    static readonly __functionProperties?: string[];
+    static readonly __unchangeables: string[];
+    static readonly __changeables: string[];
+    static readonly __extraProperties: string[];
+    static readonly __tempProperties: string[];
+    static readonly __protectedProperties: string[];
+    static readonly __functionProperties: string[];
     static readonly __formatList?: formatObject;
-    static readonly __extraProperties?: string[];
     static readonly __childTypes?: any[];
     static readonly __importColumns?: string[];
-    static readonly __checkProperties?: string[];
+    static readonly __checkProperties: string[];
     static readonly __use_delta: boolean;
     _static(): Function;
     protected __originalobject?: this;
@@ -158,7 +166,13 @@ export declare class SimpleObject extends MapableObject {
      * @returns true if manager was notified. false otherwise
      */
     notifyChanged<MKey extends PropOf<this>>(type: string, key: MKey | string, value: any, subvalue?: any): Promise<false | any[] | undefined>;
-    static getChangeableKeys(object: SimpleObject, options: getKeysProps): any[];
+    /**
+     * get a list of all keys that can be changed in given objcet
+     * @param object
+     * @param options
+     * @returns
+     */
+    static getChangeableKeys(object: SimpleObject, options: deltaParams): any[];
     /**
      * check if a key can be changed on an object
      * @param object the object we are checking
@@ -166,7 +180,7 @@ export declare class SimpleObject extends MapableObject {
      * @param useExtraProps should we check extra props?
      * @returns
      */
-    static canChangeKey(object: SimpleObject, key: string, options: getKeysProps): boolean;
+    static canChangeKey(object: SimpleObject, key: string, options: deltaParams): boolean;
     static hasIllegalChanges(referenceObject: any, changesObject: any, updaterUser: any): boolean;
     /**
      * Apply all the changes and empty the delta object

package/dist/src/structs/SimpleObject.js

@@ -707,7 +707,14 @@ var SimpleObject = exports.SimpleObject = /*#__PURE__*/function (_MapableObject)
         return _notifyChanged.apply(this, arguments);
       }
       return notifyChanged;
-    }())
+    }()
+    /**
+     * get a list of all keys that can be changed in given objcet
+     * @param object
+     * @param options
+     * @returns
+     */
+    )
   }, {
     key: "apply_changes",
     value: /* -------------------------------------------------------------------------- */
@@ -1270,26 +1277,26 @@ var SimpleObject = exports.SimpleObject = /*#__PURE__*/function (_MapableObject)
   }, {
     key: "getChangeableKeys",
     value: function getChangeableKeys(object, options) {
-      var _key_list2;
+      var _key_list;
       if (!object) return [];
-      var useExtraProps = options.useExtraProps,
-        ignoreProtected = options.ignoreProtected;
       var key_list = [];
-      if (useExtraProps) {
-        var _key_list;
-        var __extraProperties = object.constructor["__extraProperties"];
-        if (!(0, _object.array_isEmpty)(__extraProperties)) (_key_list = key_list).push.apply(_key_list, _toConsumableArray(__extraProperties));
-      }
-      /* -------------------------------------------------------------------------- */
-      var __changeables = object.constructor["__changeables"];
-      if (!(0, _object.array_isEmpty)(__changeables)) (_key_list2 = key_list).push.apply(_key_list2, _toConsumableArray(__changeables));
+      (_key_list = key_list).push.apply(_key_list, _toConsumableArray(object.constructor["__changeables"]));
       var __unchangeables = object.constructor["__unchangeables"];
       if (!(0, _object.array_isEmpty)(__unchangeables)) {
         key_list = key_list.filter(function (s) {
           return !__unchangeables.includes(s);
         });
       }
-      if (ignoreProtected !== true) {
+      /* -------------------------------------------------------------------------- */
+      if (options.extraProperties) {
+        var _key_list2;
+        (_key_list2 = key_list).push.apply(_key_list2, _toConsumableArray(object.constructor["__extraProperties"]));
+      }
+      if (options.tempProperties) {
+        var _key_list3;
+        (_key_list3 = key_list).push.apply(_key_list3, _toConsumableArray(object.constructor["__tempProperties"]));
+      }
+      if (options.bypassProtected !== true && !options.allProperties) {
         var __protectedProperties = object.constructor["__protectedProperties"];
         //protected keys can only be changed by the creator of this object
         //make sure you set the is_current_user function correctly
@@ -1314,36 +1321,6 @@ var SimpleObject = exports.SimpleObject = /*#__PURE__*/function (_MapableObject)
       if (!object || !key) return false;
       var keys = this.getChangeableKeys(object, options);
       return keys.includes(key);
-      // const {useExtraProps, ignoreProtected} = options;
-      // if (useExtraProps) {
-      //     const __extraProperties = object.constructor["__extraProperties"];
-      //     if (__extraProperties != null && __extraProperties.includes(key))
-      //         return true;
-      // }
-      // /* -------------------------------------------------------------------------- */
-      // const __changeables = object.constructor["__changeables"];
-      // const __unchangeables = object.constructor["__unchangeables"];
-      // /* -------------------------------------------------------------------------- */
-      // if (__changeables != null && !__changeables.includes(key)) return false;
-      // if (__unchangeables != null && __unchangeables.includes(key))
-      //     return false;
-      // if (ignoreProtected !== true) {
-      //     const __protectedProperties =
-      //         object.constructor["__protectedProperties"];
-      //     if (
-      //         __protectedProperties != null &&
-      //         __protectedProperties.includes(key)
-      //     ) {
-      //         //protected keys can only be changed by the creator of this object
-      //         //make sure you set the is_current_user function correctly
-      //         if (object.isNew) return true;
-      //         const creatorOfObject = (object as any).get("_creator");
-      //         return Boolean(
-      //             gfunc.run_action_sync("is_current_user", creatorOfObject),
-      //         );
-      //     }
-      // }
-      // return true;
     }
   }, {
     key: "hasIllegalChanges",
@@ -1690,22 +1667,24 @@ function _setSaveResultObject(toObj) {
 _defineProperty(SimpleObject, "__db_name", "");
 _defineProperty(SimpleObject, "__object_name", "");
 //these properties should not be changed and are usually set by server
-_defineProperty(SimpleObject, "__unchangeables", void 0);
+_defineProperty(SimpleObject, "__unchangeables", []);
 //these properties can be directly changed and are included in deltaObject
-_defineProperty(SimpleObject, "__changeables", void 0);
+_defineProperty(SimpleObject, "__changeables", []);
+//these properties usually are not directly changed and sometimes are included in deltaObject
+_defineProperty(SimpleObject, "__extraProperties", []);
+//these properties are never sent to database but may be sent to client
+_defineProperty(SimpleObject, "__tempProperties", []);
 //these properties can only be changed by the _creator
-_defineProperty(SimpleObject, "__protectedProperties", void 0);
+_defineProperty(SimpleObject, "__protectedProperties", []);
 //these properties will be evaluated when needed
-_defineProperty(SimpleObject, "__functionProperties", void 0);
+_defineProperty(SimpleObject, "__functionProperties", []);
 //apply these string formats
 _defineProperty(SimpleObject, "__formatList", void 0);
-//these properties usually are not directly changed and sometimes are included in deltaObject
-_defineProperty(SimpleObject, "__extraProperties", void 0);
 //types for children can be used when importing children
 _defineProperty(SimpleObject, "__childTypes", void 0);
 //these fields are used when importing
 _defineProperty(SimpleObject, "__importColumns", void 0);
 //these fields can be used when importing and checking if an item exists
-_defineProperty(SimpleObject, "__checkProperties", void 0);
+_defineProperty(SimpleObject, "__checkProperties", []);
 _defineProperty(SimpleObject, "__use_delta", true);
 var _default = exports["default"] = SimpleObject;

package/package.json

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