@azrico/webobject 1.5.10 → 1.5.12

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.12",
     "description": "Stateful object",
     "author": "Azrideus",
     "license": "MIT",