bkper-js 2.5.1 → 2.7.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

@@ -1271,6 +1271,7 @@ export declare class Book {
 
 
 
+
     constructor(payload?: bkper.Book);
     /**
      * Gets an immutable copy of the JSON payload for this Book.
@@ -1498,6 +1499,14 @@ export declare class Book {
      * @returns The visibility of the book
      */
     getVisibility(): Visibility;
+    /**
+     * Sets the visibility of the book.
+     *
+     * @param visibility - The visibility to set
+     *
+     * @returns This Book, for chaining
+     */
+    setVisibility(visibility: Visibility): Book;
     /**
      * Gets the custom properties stored in this Book.
      *
@@ -1722,6 +1731,7 @@ export declare class Book {
 
 
 
+
     /**
      * Lists transactions in the Book based on the provided query, limit, and cursor, for pagination.
      *
@@ -1809,6 +1819,12 @@ export declare class Book {
      * @returns The saved queries from this book
      */
     getSavedQueries(): Promise<Query[]>;
+    /**
+     * Gets all collaborators of this Book.
+     *
+     * @returns Array of Collaborator objects
+     */
+    getCollaborators(): Promise<Collaborator[]>;
 }
 
 /**
@@ -1886,6 +1902,77 @@ export declare enum BotResponseType {
     ERROR = "ERROR"
 }
 
+/**
+ * This class defines a Collaborator of a [[Book]].
+ *
+ * A Collaborator represents a user that has been granted access to a Book with specific permissions.
+ *
+ * @public
+ */
+export declare class Collaborator {
+    payload: bkper.Collaborator;
+
+    constructor(book: Book, payload?: bkper.Collaborator);
+    /**
+     * Gets an immutable copy of the JSON payload.
+     *
+     * @returns An immutable copy of the json payload
+     */
+    json(): bkper.Collaborator;
+    /**
+     * Gets the Collaborator internal id.
+     *
+     * @returns The Collaborator internal id
+     */
+    getId(): string | undefined;
+    /**
+     * Gets the Collaborator email address.
+     *
+     * @returns The Collaborator email address
+     */
+    getEmail(): string | undefined;
+    /**
+     * Sets the email address of the Collaborator.
+     *
+     * @param email - The email address to set
+     *
+     * @returns This Collaborator, for chaining
+     */
+    setEmail(email: string): Collaborator;
+    /**
+     * Gets the permission level of the Collaborator.
+     *
+     * @returns The permission level
+     */
+    getPermission(): Permission | undefined;
+    /**
+     * Sets the permission level of the Collaborator.
+     *
+     * @param permission - The permission level to set
+     *
+     * @returns This Collaborator, for chaining
+     */
+    setPermission(permission: Permission): Collaborator;
+    /**
+     * Performs create new Collaborator.
+     *
+     * @returns Promise with the created Collaborator
+     */
+    create(message?: string): Promise<Collaborator>;
+    /**
+     * Performs update Collaborator.
+     *
+     * @returns Promise with the updated Collaborator
+     */
+    update(): Promise<Collaborator>;
+    /**
+     * Performs remove Collaborator.
+     *
+     * @returns Promise with the removed Collaborator
+     */
+    remove(): Promise<Collaborator>;
+}
+
 /**
  * This class defines a Collection of [[Books]].
  *
@@ -2491,6 +2578,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/index.js

@@ -14,6 +14,7 @@ export { BalancesDataTableBuilder } from './model/BalancesDataTableBuilder.js';
 export { BalancesReport } from './model/BalancesReport.js';
 export { Bkper } from './model/Bkper.js';
 export { Book } from './model/Book.js';
+export { Collaborator } from './model/Collaborator.js';
 export { Collection } from './model/Collection.js';
 export { Connection } from './model/Connection.js';
 export { Conversation } from './model/Conversation.js';

package/lib/model/Book.js

@@ -16,8 +16,10 @@ import * as GroupService from '../service/group-service.js';
 import * as IntegrationService from '../service/integration-service.js';
 import * as TransactionService from '../service/transaction-service.js';
 import * as EventService from '../service/event-service.js';
+import * as CollaboratorService from '../service/collaborator-service.js';
 import * as Utils from '../utils.js';
 import { Account } from './Account.js';
+import { Collaborator } from './Collaborator.js';
 import { Collection } from './Collection.js';
 import { Permission } from './Enums.js';
 import { EventList } from './EventList.js';
@@ -360,6 +362,17 @@ export class Book {
     getVisibility() {
         return this.payload.visibility;
     }
+    /**
+     * Sets the visibility of the book.
+     *
+     * @param visibility - The visibility to set
+     *
+     * @returns This Book, for chaining
+     */
+    setVisibility(visibility) {
+        this.payload.visibility = visibility;
+        return this;
+    }
     /**
      * Gets the custom properties stored in this Book.
      *
@@ -929,6 +942,10 @@ export class Book {
         this.nameAccountMap = undefined;
     }
     /** @internal */
+    clearCollaboratorCache() {
+        this.collaborators = undefined;
+    }
+    /** @internal */
     setAccount(account, remove) {
         const accountPayloads = this.payload.accounts || [];
         if (remove) {
@@ -1103,5 +1120,19 @@ export class Book {
             return this.queries;
         });
     }
+    /**
+     * Gets all collaborators of this Book.
+     *
+     * @returns Array of Collaborator objects
+     */
+    getCollaborators() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.collaborators) {
+                const collaboratorPayloads = yield CollaboratorService.listCollaborators(this.getId());
+                this.collaborators = collaboratorPayloads.map(payload => new Collaborator(this, payload));
+            }
+            return this.collaborators;
+        });
+    }
 }
 //# sourceMappingURL=Book.js.map

package/lib/model/Collaborator.js

@@ -0,0 +1,118 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as CollaboratorService from '../service/collaborator-service.js';
+/**
+ * This class defines a Collaborator of a [[Book]].
+ *
+ * A Collaborator represents a user that has been granted access to a Book with specific permissions.
+ *
+ * @public
+ */
+export class Collaborator {
+    constructor(book, payload) {
+        this.book = book;
+        this.payload = payload || {};
+    }
+    /**
+     * Gets an immutable copy of the JSON payload.
+     *
+     * @returns An immutable copy of the json payload
+     */
+    json() {
+        return Object.assign({}, this.payload);
+    }
+    /**
+     * Gets the Collaborator internal id.
+     *
+     * @returns The Collaborator internal id
+     */
+    getId() {
+        return this.payload.id;
+    }
+    /**
+     * Gets the Collaborator email address.
+     *
+     * @returns The Collaborator email address
+     */
+    getEmail() {
+        return this.payload.email;
+    }
+    /**
+     * Sets the email address of the Collaborator.
+     *
+     * @param email - The email address to set
+     *
+     * @returns This Collaborator, for chaining
+     */
+    setEmail(email) {
+        this.payload.email = email;
+        return this;
+    }
+    /**
+     * Gets the permission level of the Collaborator.
+     *
+     * @returns The permission level
+     */
+    getPermission() {
+        return this.payload.permission;
+    }
+    /**
+     * Sets the permission level of the Collaborator.
+     *
+     * @param permission - The permission level to set
+     *
+     * @returns This Collaborator, for chaining
+     */
+    setPermission(permission) {
+        this.payload.permission = permission;
+        return this;
+    }
+    /**
+     * Performs create new Collaborator.
+     *
+     * @returns Promise with the created Collaborator
+     */
+    create(message) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.payload = yield CollaboratorService.addOrUpdateCollaborator(this.book.getId(), this.payload, message);
+            this.book.clearCollaboratorCache();
+            return this;
+        });
+    }
+    /**
+     * Performs update Collaborator.
+     *
+     * @returns Promise with the updated Collaborator
+     */
+    update() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.payload = yield CollaboratorService.addOrUpdateCollaborator(this.book.getId(), this.payload);
+            this.book.clearCollaboratorCache();
+            return this;
+        });
+    }
+    /**
+     * Performs remove Collaborator.
+     *
+     * @returns Promise with the removed Collaborator
+     */
+    remove() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const email = this.getEmail();
+            if (!email) {
+                throw new Error('Collaborator email is required');
+            }
+            this.payload = yield CollaboratorService.removeCollaborator(this.book.getId(), email);
+            this.book.clearCollaboratorCache();
+            return this;
+        });
+    }
+}
+//# sourceMappingURL=Collaborator.js.map

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/lib/service/collaborator-service.js

@@ -0,0 +1,34 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { HttpBooksApiV5Request } from './http-api-request.js';
+export function listCollaborators(bookId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        const response = yield new HttpBooksApiV5Request(`${bookId}/collaborators`).setMethod('GET').fetch();
+        return ((_a = response === null || response === void 0 ? void 0 : response.data) === null || _a === void 0 ? void 0 : _a.items) || [];
+    });
+}
+export function addOrUpdateCollaborator(bookId, collaborator, message) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let request = new HttpBooksApiV5Request(`${bookId}/collaborators`).setMethod('POST').setPayload(collaborator);
+        if (message) {
+            request = request.addParam('message', message);
+        }
+        const response = yield request.fetch();
+        return response.data;
+    });
+}
+export function removeCollaborator(bookId, email) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield new HttpBooksApiV5Request(`${bookId}/collaborators/${email}`).setMethod('DELETE').fetch();
+        return response.data;
+    });
+}
+//# sourceMappingURL=collaborator-service.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bkper-js",
-  "version": "2.5.1",
+  "version": "2.7.0",
   "description": "Javascript client for Bkper REST API",
   "main": "./lib/index.js",
   "module": "./lib/index.js",
@@ -34,10 +34,9 @@
     "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.25.0"
   },
   "dependencies": {
-    "@google-cloud/local-auth": "^3.0.1",
     "axios": "^1.7.7",
     "big.js": "^6.0.3",
     "dayjs": "^1.10.3",