bkper-js 2.5.0 → 2.6.0

package/CHANGELOG.md

@@ -8,6 +8,11 @@ See what's new and what has changed in bkper-js
 **August 2025**
 
 * Added `Transaction.setFiles`
+* Added `File.getProperties`
+* Added `File.setProperties`
+* Added `File.getProperty`
+* Added `File.setProperty`
+* Added `File.deleteProperty`
 
 **July 2025**
 

package/lib/index.d.ts

@@ -1760,7 +1760,7 @@ export declare class Book {
      *
      * @returns The [[File]] object
      */
-    getFile(id: string): Promise<File>;
+    getFile(id: string): Promise<File | undefined>;
     /**
      * Performs create new Book.
      *
@@ -2491,6 +2491,49 @@ export declare class File {
      * @returns The file size in bytes
      */
     getSize(): number | undefined;
+    /**
+     * Gets the custom properties stored in this File.
+     *
+     * @returns The custom properties object
+     */
+    getProperties(): {
+        [key: string]: string;
+    };
+    /**
+     * Sets the custom properties of the File.
+     *
+     * @param properties - Object with key/value pair properties
+     *
+     * @returns This File, for chaining
+     */
+    setProperties(properties: {
+        [key: string]: string;
+    }): File;
+    /**
+     * 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: string[]): string | undefined;
+    /**
+     * Sets a custom property in the File.
+     *
+     * @param key - The property key
+     * @param value - The property value
+     *
+     * @returns This File, for chaining
+     */
+    setProperty(key: string, value: string | null): File;
+    /**
+     * Deletes a custom property.
+     *
+     * @param key - The property key
+     *
+     * @returns This File, for chaining
+     */
+    deleteProperty(key: string): File;
     /**
      * Perform create new File.
      *

package/lib/model/Book.js

@@ -1020,6 +1020,9 @@ export class Book {
     getFile(id) {
         return __awaiter(this, void 0, void 0, function* () {
             let wrapped = yield FileService.getFile(this.getId(), id);
+            if (!wrapped) {
+                return undefined;
+            }
             let file = new File(this, wrapped);
             return file;
         });

package/lib/model/File.js

@@ -119,6 +119,74 @@ export class File {
     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
+     *
+     * @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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bkper-js",
-  "version": "2.5.0",
+  "version": "2.6.0",
   "description": "Javascript client for Bkper REST API",
   "main": "./lib/index.js",
   "module": "./lib/index.js",
@@ -34,7 +34,7 @@
     "postversion": "git push --tags && yarn publish --new-version $npm_package_version && git push && echo \"Successfully released version $npm_package_version!\""
   },
   "peerDependencies": {
-    "@bkper/bkper-api-types": "^5.23.1"
+    "@bkper/bkper-api-types": "^5.24.0"
   },
   "dependencies": {
     "@google-cloud/local-auth": "^3.0.1",