bkper-js 2.3.0 → 2.5.0

package/CHANGELOG.md

@@ -5,6 +5,10 @@ See what's new and what has changed in bkper-js
 2025
 ----
 
+**August 2025**
+
+* Added `Transaction.setFiles`
+
 **July 2025**
 
 * **BREAKING CHANGE:** Refactored `Bkper` class from static methods to constructor-based pattern
@@ -14,6 +18,7 @@ See what's new and what has changed in bkper-js
 * Added `Balance` class back for improved balance reporting
 * Added `BalancesDataTableBuilder` for building balance data tables
 * Added `BalanceType` enum with TOTAL, PERIOD, and CUMULATIVE options
+* Added `includeGroups` parameter to `Bkper.getBook()` method for selective group loading
 
 
 **June 2025**   

package/lib/index.d.ts

@@ -960,8 +960,15 @@ export declare class BalancesDataTableBuilder implements BalancesDataTableBuilde
      */
     formatValues(format: boolean): BalancesDataTableBuilder;
     /**
-     * Defines whether Groups should expand its child accounts. true to expand itself, -1 to expand all subgroups. -2 to expand all accounts.
+     * Defines whether Groups should expand its child accounts.
      *
+     * true to expand itself
+     * -1 to expand all subgroups
+     * -2 to expand all accounts
+     * 0 to expand nothing
+     * 1 to expand itself and its first level of children
+     * 2 to expand itself and its first two levels of children
+     * etc.
      *
      * @returns This builder with respective expanded option, for chaining.
      */
@@ -1190,10 +1197,17 @@ export declare class Bkper {
      *
      * @param id - The universal book id - The same bookId param of URL you access at app.bkper.com
      * @param includeAccounts - Optional parameter to include accounts in the retrieved Book
+     * @param includeGroups - Optional parameter to include groups in the retrieved Book
+     *
+     * If both includeAccounts and includeGroups are false, the Book will be returned with only the basic information.
+     *
+     * If includeAccounts is true, the Book will be returned with the accounts and groups.
+     *
+     * If includeGroups is true, the Book will be returned with the groups.
      *
      * @returns The retrieved Book
      */
-    getBook(id: string, includeAccounts?: boolean): Promise<Book>;
+    getBook(id: string, includeAccounts?: boolean, includeGroups?: boolean): Promise<Book>;
     /**
      * Gets all [[Books]] the user has access to.
      *
@@ -3339,6 +3353,14 @@ export declare class Transaction {
      * @returns The files attached to the transaction
      */
     getFiles(): File[];
+    /**
+     * Sets the files attached to the Transaction.
+     *
+     * @param files - The files to set
+     *
+     * @returns This Transaction, for chaining
+     */
+    setFiles(files: File[]): Transaction;
     /**
      * Adds a file attachment to the Transaction.
      *

package/lib/model/BalancesDataTableBuilder.js

@@ -60,8 +60,15 @@ export class BalancesDataTableBuilder {
         return this;
     }
     /**
-     * Defines whether Groups should expand its child accounts. true to expand itself, -1 to expand all subgroups. -2 to expand all accounts.
+     * Defines whether Groups should expand its child accounts.
      *
+     * true to expand itself
+     * -1 to expand all subgroups
+     * -2 to expand all accounts
+     * 0 to expand nothing
+     * 1 to expand itself and its first level of children
+     * 2 to expand itself and its first two levels of children
+     * etc.
      *
      * @returns This builder with respective expanded option, for chaining.
      */

package/lib/model/Bkper.js

@@ -63,12 +63,19 @@ export class Bkper {
      *
      * @param id - The universal book id - The same bookId param of URL you access at app.bkper.com
      * @param includeAccounts - Optional parameter to include accounts in the retrieved Book
+     * @param includeGroups - Optional parameter to include groups in the retrieved Book
+     *
+     * If both includeAccounts and includeGroups are false, the Book will be returned with only the basic information.
+     *
+     * If includeAccounts is true, the Book will be returned with the accounts and groups.
+     *
+     * If includeGroups is true, the Book will be returned with the groups.
      *
      * @returns The retrieved Book
      */
-    getBook(id, includeAccounts) {
+    getBook(id, includeAccounts, includeGroups) {
         return __awaiter(this, void 0, void 0, function* () {
-            let book = yield BookService.loadBook(id, includeAccounts);
+            let book = yield BookService.loadBook(id, includeAccounts, includeGroups);
             return new Book(book);
         });
     }

package/lib/model/Transaction.js

@@ -214,6 +214,18 @@ export class Transaction {
             return [];
         }
     }
+    /**
+     * Sets the files attached to the Transaction.
+     *
+     * @param files - The files to set
+     *
+     * @returns This Transaction, for chaining
+     */
+    setFiles(files) {
+        const filePayloads = files.map(file => file.payload);
+        this.payload.files = [...filePayloads];
+        return this;
+    }
     /**
      * Adds a file attachment to the Transaction.
      *

package/lib/service/balances-service.js

@@ -8,9 +8,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { HttpBooksApiV5Request } from "./http-api-request.js";
+import axios from 'axios';
 export function getBalances(bookId, query) {
     return __awaiter(this, void 0, void 0, function* () {
         var response = yield new HttpBooksApiV5Request(`${bookId}/balances`).addParam('query', query).addParam('time', Date.now()).fetch();
+        if (response.data.balancesUrl) {
+            response = yield axios.get(response.data.balancesUrl);
+        }
         return response.data;
     });
 }

package/lib/service/book-service.js

@@ -26,13 +26,14 @@ export function loadBooks(query) {
         return booksJson;
     });
 }
-export function loadBook(bookId, loadAccounts) {
+export function loadBook(bookId, loadAccounts, loadGroups) {
     return __awaiter(this, void 0, void 0, function* () {
         if (bookId == null) {
             throw new Error("Book id null!");
         }
         loadAccounts = loadAccounts || false;
-        let response = yield new HttpBooksApiV5Request(bookId).addParam('loadAccounts', loadAccounts).fetch();
+        loadGroups = loadGroups || false;
+        let response = yield new HttpBooksApiV5Request(bookId).addParam('loadAccounts', loadAccounts).addParam('loadGroups', loadGroups).fetch();
         return response.data;
     });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bkper-js",
-  "version": "2.3.0",
+  "version": "2.5.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.0"
+    "@bkper/bkper-api-types": "^5.23.1"
   },
   "dependencies": {
     "@google-cloud/local-auth": "^3.0.1",