bkper-js 2.15.0 → 2.15.2

package/lib/model/Connection.js

@@ -7,7 +7,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { Resource } from "./Resource.js";
+import { ResourceProperty } from "./ResourceProperty.js";
 import { Bkper } from "./Bkper.js";
 import * as ConnectionService from "../service/connection-service.js";
 import { Integration } from "./Integration.js";
@@ -16,7 +16,7 @@ import { Integration } from "./Integration.js";
  *
  * @public
  */
-export class Connection extends Resource {
+export class Connection extends ResourceProperty {
     constructor(payload, config) {
         super(payload);
         this.config = config;
@@ -133,75 +133,6 @@ export class Connection extends Resource {
         this.payload.type = type;
         return this;
     }
-    /**
-     * Gets the custom properties stored in the Connection
-     *
-     * @returns Object with key/value pair properties
-     */
-    getProperties() {
-        return this.payload.properties != null
-            ? Object.assign({}, this.payload.properties) : {};
-    }
-    /**
-     * Sets the custom properties of the Connection.
-     *
-     * @param properties - Object with key/value pair properties
-     *
-     * @returns The Connection, for chaining
-     */
-    setProperties(properties) {
-        this.payload.properties = Object.assign({}, properties);
-        return this;
-    }
-    /**
-     * Gets the property value for given keys. First property found will be retrieved.
-     *
-     * @param keys - The property key
-     *
-     * @returns The retrieved property value
-     */
-    getProperty(...keys) {
-        for (let index = 0; index < keys.length; index++) {
-            const key = keys[index];
-            let value = this.payload.properties != null ? this.payload.properties[key] : null;
-            if (value != null && value.trim() != "") {
-                return value;
-            }
-        }
-        return undefined;
-    }
-    /**
-     * Sets a custom property in the Connection.
-     *
-     * @param key - The property key
-     * @param value - The property value, or null/undefined to clean it
-     *
-     * @returns The Connection, for chaining
-     */
-    setProperty(key, value) {
-        if (key == null || key.trim() == "") {
-            return this;
-        }
-        if (this.payload.properties == null) {
-            this.payload.properties = {};
-        }
-        if (!value) {
-            value = "";
-        }
-        this.payload.properties[key] = value;
-        return this;
-    }
-    /**
-     * Deletes a custom property stored in the Connection.
-     *
-     * @param key - The property key
-     *
-     * @returns The Connection, for chaining
-     */
-    deleteProperty(key) {
-        this.setProperty(key, null);
-        return this;
-    }
     /**
      * Cleans any token property stored in the Connection.
      */
@@ -210,24 +141,6 @@ export class Connection extends Resource {
             .filter((key) => key.includes("token"))
             .forEach((key) => this.deleteProperty(key));
     }
-    /**
-     * Gets the custom properties keys stored in the Connection.
-     *
-     * @returns The retrieved property keys
-     */
-    getPropertyKeys() {
-        let properties = this.getProperties();
-        let propertyKeys = [];
-        if (properties) {
-            for (var key in properties) {
-                if (Object.prototype.hasOwnProperty.call(properties, key)) {
-                    propertyKeys.push(key);
-                }
-            }
-        }
-        propertyKeys = propertyKeys.sort();
-        return propertyKeys;
-    }
     /**
      * Gets the existing [[Integrations]] on the Connection.
      *

package/lib/model/File.js

@@ -8,7 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as FileService from "../service/file-service.js";
-import { Resource } from "./Resource.js";
+import { ResourceProperty } from "./ResourceProperty.js";
 /**
  *
  * This class defines a File uploaded to a [[Book]].
@@ -17,7 +17,7 @@ import { Resource } from "./Resource.js";
  *
  * @public
  */
-export class File extends Resource {
+export class File extends ResourceProperty {
     constructor(book, payload) {
         super(payload || { createdAt: `${Date.now()}` });
         this.book = book;
@@ -124,75 +124,6 @@ export class File extends Resource {
     getSize() {
         return this.payload.size;
     }
-    /**
-     * Gets the custom properties stored in this File.
-     *
-     * @returns The custom properties object
-     */
-    getProperties() {
-        return this.payload.properties != null
-            ? Object.assign({}, this.payload.properties) : {};
-    }
-    /**
-     * Sets the custom properties of the File.
-     *
-     * @param properties - Object with key/value pair properties
-     *
-     * @returns This File, for chaining
-     */
-    setProperties(properties) {
-        this.payload.properties = Object.assign({}, properties);
-        return this;
-    }
-    /**
-     * Gets the property value for given keys. First property found will be retrieved.
-     *
-     * @param keys - The property key
-     *
-     * @returns The property value or undefined if not found
-     */
-    getProperty(...keys) {
-        for (let index = 0; index < keys.length; index++) {
-            const key = keys[index];
-            let value = this.payload.properties != null ? this.payload.properties[key] : null;
-            if (value != null && value.trim() != "") {
-                return value;
-            }
-        }
-        return undefined;
-    }
-    /**
-     * Sets a custom property in the File.
-     *
-     * @param key - The property key
-     * @param value - The property value, or null/undefined to clean it
-     *
-     * @returns This File, for chaining
-     */
-    setProperty(key, value) {
-        if (key == null || key.trim() == "") {
-            return this;
-        }
-        if (this.payload.properties == null) {
-            this.payload.properties = {};
-        }
-        if (!value) {
-            value = "";
-        }
-        this.payload.properties[key] = value;
-        return this;
-    }
-    /**
-     * Deletes a custom property.
-     *
-     * @param key - The property key
-     *
-     * @returns This File, for chaining
-     */
-    deleteProperty(key) {
-        this.setProperty(key, null);
-        return this;
-    }
     /**
      * Perform create new File.
      *

package/lib/model/Group.js

@@ -10,7 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import * as GroupService from "../service/group-service.js";
 import { normalizeText } from "../utils.js";
 import { Account } from "./Account.js";
-import { Resource } from "./Resource.js";
+import { ResourceProperty } from "./ResourceProperty.js";
 /**
  * This class defines a Group of [[Accounts]].
  *
@@ -20,7 +20,7 @@ import { Resource } from "./Resource.js";
  *
  * @public
  */
-export class Group extends Resource {
+export class Group extends ResourceProperty {
     constructor(book, payload) {
         super(payload || { createdAt: `${Date.now()}` });
         /** @internal */
@@ -139,75 +139,6 @@ export class Group extends Resource {
     getType() {
         return this.payload.type;
     }
-    /**
-     * Gets the custom properties stored in this Group.
-     *
-     * @returns The custom properties as a key/value object
-     */
-    getProperties() {
-        return this.payload.properties != null
-            ? Object.assign({}, this.payload.properties) : {};
-    }
-    /**
-     * Sets the custom properties of the Group
-     *
-     * @param properties - Object with key/value pair properties
-     *
-     * @returns This Group, for chaining
-     */
-    setProperties(properties) {
-        this.payload.properties = Object.assign({}, properties);
-        return this;
-    }
-    /**
-     * Gets the property value for given keys. First property found will be retrieved.
-     *
-     * @param keys - The property key
-     *
-     * @returns The property value, or undefined if not found
-     */
-    getProperty(...keys) {
-        for (let index = 0; index < keys.length; index++) {
-            const key = keys[index];
-            let value = this.payload.properties != null ? this.payload.properties[key] : null;
-            if (value != null && value.trim() != "") {
-                return value;
-            }
-        }
-        return undefined;
-    }
-    /**
-     * Sets a custom property in the Group.
-     *
-     * @param key - The property key
-     * @param value - The property value, or null/undefined to clean it
-     *
-     * @returns This Group, for chaining
-     */
-    setProperty(key, value) {
-        if (key == null || key.trim() == "") {
-            return this;
-        }
-        if (this.payload.properties == null) {
-            this.payload.properties = {};
-        }
-        if (!value) {
-            value = "";
-        }
-        this.payload.properties[key] = value;
-        return this;
-    }
-    /**
-     * Delete a custom property
-     *
-     * @param key - The property key
-     *
-     * @returns This Group, for chaining
-     */
-    deleteProperty(key) {
-        this.setProperty(key, null);
-        return this;
-    }
     /**
      * Tells if the Group is hidden on main transactions menu.
      *

package/lib/model/Integration.js

@@ -8,14 +8,14 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as IntegrationService from "../service/integration-service.js";
-import { Resource } from "./Resource.js";
+import { ResourceProperty } from "./ResourceProperty.js";
 import { Bkper } from "./Bkper.js";
 /**
  * This class defines a Integration from an [[User]] to an external service.
  *
  * @public
  */
-export class Integration extends Resource {
+export class Integration extends ResourceProperty {
     constructor(payload, config) {
         super(payload || {});
         this.config = config;
@@ -106,75 +106,6 @@ export class Integration extends Resource {
     getLastUpdateMs() {
         return this.payload.lastUpdateMs;
     }
-    /**
-     * Gets the custom properties stored in the Integration.
-     *
-     * @returns Object with key/value pair properties
-     */
-    getProperties() {
-        return this.payload.properties != null
-            ? Object.assign({}, this.payload.properties) : {};
-    }
-    /**
-     * Sets the custom properties of the Integration.
-     *
-     * @param properties - Object with key/value pair properties
-     *
-     * @returns The Integration, for chaining
-     */
-    setProperties(properties) {
-        this.payload.properties = Object.assign({}, properties);
-        return this;
-    }
-    /**
-     * Gets the property value for given keys. First property found will be retrieved.
-     *
-     * @param keys - The property key
-     *
-     * @returns The retrieved property value
-     */
-    getProperty(...keys) {
-        for (let index = 0; index < keys.length; index++) {
-            const key = keys[index];
-            let value = this.payload.properties != null ? this.payload.properties[key] : null;
-            if (value != null && value.trim() != "") {
-                return value;
-            }
-        }
-        return undefined;
-    }
-    /**
-     * Sets a custom property in the Integration.
-     *
-     * @param key - The property key
-     * @param value - The property value, or null/undefined to clean it
-     *
-     * @returns The Integration, for chaining
-     */
-    setProperty(key, value) {
-        if (key == null || key.trim() == "") {
-            return this;
-        }
-        if (this.payload.properties == null) {
-            this.payload.properties = {};
-        }
-        if (!value) {
-            value = "";
-        }
-        this.payload.properties[key] = value;
-        return this;
-    }
-    /**
-     * Deletes a custom property stored in the Integration.
-     *
-     * @param key - The property key
-     *
-     * @returns The Integration, for chaining
-     */
-    deleteProperty(key) {
-        this.setProperty(key, null);
-        return this;
-    }
     /**
      * Performs remove Integration.
      *

package/lib/model/ResourceProperty.js

@@ -0,0 +1,130 @@
+import { Resource } from "./Resource.js";
+/**
+ * Abstract base class for Bkper resources that support custom properties.
+ *
+ * Extends Resource<T> and adds property management methods for entities
+ * that have a properties field in their payload.
+ *
+ * @public
+ */
+export class ResourceProperty extends Resource {
+    /**
+     * Checks if a property key represents a hidden property.
+     * Hidden properties are those whose keys end with an underscore "_".
+     *
+     * @param key - The property key to check
+     * @returns True if the property is hidden, false otherwise
+     *
+     * @internal
+     */
+    isHiddenProperty(key) {
+        return key.endsWith('_');
+    }
+    /**
+     * Gets the custom properties stored in this resource.
+     *
+     * @returns Object with key/value pair properties
+     */
+    getProperties() {
+        return this.payload.properties != null
+            ? Object.assign({}, this.payload.properties) : {};
+    }
+    /**
+     * Sets the custom properties of this resource.
+     *
+     * @param properties - Object with key/value pair properties
+     * @param filterHidden - If true, hidden properties (ending with "_") will not be set. Defaults to false.
+     *
+     * @returns This resource, for chaining
+     */
+    setProperties(properties, filterHidden = false) {
+        if (!filterHidden) {
+            this.payload.properties = Object.assign({}, properties);
+            return this;
+        }
+        const filteredProperties = {};
+        for (const key in properties) {
+            if (Object.prototype.hasOwnProperty.call(properties, key)) {
+                if (!this.isHiddenProperty(key)) {
+                    filteredProperties[key] = properties[key];
+                }
+            }
+        }
+        this.payload.properties = Object.assign({}, filteredProperties);
+        return this;
+    }
+    /**
+     * Gets the property value for given keys. First property found will be retrieved.
+     *
+     * @param keys - The property keys to search for
+     *
+     * @returns The property value or undefined if not found
+     */
+    getProperty(...keys) {
+        for (let index = 0; index < keys.length; index++) {
+            const key = keys[index];
+            let value = this.payload.properties != null
+                ? this.payload.properties[key]
+                : null;
+            if (value != null && value.trim() != "") {
+                return value;
+            }
+        }
+        return undefined;
+    }
+    /**
+     * Sets a custom property in this resource.
+     *
+     * @param key - The property key
+     * @param value - The property value, or null/undefined to clean it
+     * @param filterHidden - If true, hidden properties (ending with "_") will not be set. Defaults to false.
+     *
+     * @returns This resource, for chaining
+     */
+    setProperty(key, value, filterHidden = false) {
+        if (key == null || key.trim() == "") {
+            return this;
+        }
+        if (filterHidden && this.isHiddenProperty(key)) {
+            return this;
+        }
+        if (this.payload.properties == null) {
+            this.payload.properties = {};
+        }
+        if (!value) {
+            value = "";
+        }
+        this.payload.properties[key] = value;
+        return this;
+    }
+    /**
+     * Deletes a custom property.
+     *
+     * @param key - The property key
+     *
+     * @returns This resource, for chaining
+     */
+    deleteProperty(key) {
+        this.setProperty(key, null);
+        return this;
+    }
+    /**
+     * Gets the custom properties keys stored in this resource.
+     *
+     * @returns Array of property keys sorted alphabetically
+     */
+    getPropertyKeys() {
+        let properties = this.getProperties();
+        let propertyKeys = [];
+        if (properties) {
+            for (var key in properties) {
+                if (Object.prototype.hasOwnProperty.call(properties, key)) {
+                    propertyKeys.push(key);
+                }
+            }
+        }
+        propertyKeys = propertyKeys.sort();
+        return propertyKeys;
+    }
+}
+//# sourceMappingURL=ResourceProperty.js.map