bkper-js 2.29.3 → 2.30.0

package/README.md

@@ -15,16 +15,20 @@ It provides a set of classes and functions to interact with the Bkper API, inclu
 
 ### Add the package:
 
-```
+```bash tab="npm"
 npm i -S bkper-js
 ```
-or
-```
-yarn add bkper-js
+
+```bash tab="bun"
+bun add bkper-js
 ```
-or
+
+```bash tab="pnpm"
+pnpm add bkper-js
 ```
-bun add bkper-js
+
+```bash tab="yarn"
+yarn add bkper-js
 ```
 
 ## Usage
@@ -39,7 +43,7 @@ import { getOAuthToken } from 'bkper';
 
 // Configure with CLI authentication
 Bkper.setConfig({
-  oauthTokenProvider: async () => getOAuthToken()
+    oauthTokenProvider: async () => getOAuthToken(),
 });
 
 // Create Bkper instance
@@ -54,7 +58,7 @@ const books = await bkper.getBooks();
 console.log(`You have ${books.length} books`);
 ```
 
-First, login via CLI: `bkper login`
+First, login via CLI: `bkper auth login`
 
 ### Web Applications
 
@@ -66,8 +70,8 @@ import { BkperAuth } from '@bkper/web-auth';
 
 // Initialize authentication
 const auth = new BkperAuth({
-  onLoginSuccess: () => initializeApp(),
-  onLoginRequired: () => showLoginButton()
+    onLoginSuccess: () => initializeApp(),
+    onLoginRequired: () => showLoginButton(),
 });
 
 // Restore session on app load
@@ -75,7 +79,7 @@ await auth.init();
 
 // Configure Bkper with web auth
 Bkper.setConfig({
-  oauthTokenProvider: async () => auth.getAccessToken()
+    oauthTokenProvider: async () => auth.getAccessToken(),
 });
 
 // Create Bkper instance and use it
@@ -91,8 +95,7 @@ API keys are optional and only needed for dedicated quota limits. If not provide
 
 ```typescript
 Bkper.setConfig({
-  oauthTokenProvider: async () => getOAuthToken(),
-  apiKeyProvider: async () => process.env.BKPER_API_KEY // Optional - for dedicated quota
+    oauthTokenProvider: async () => getOAuthToken(),
+    apiKeyProvider: async () => process.env.BKPER_API_KEY, // Optional - for dedicated quota
 });
 ```
-

package/lib/index.d.ts

@@ -13,6 +13,10 @@
  *
  * An Account can be grouped by [[Groups]].
  *
+ * @remarks
+ * `Account` has no `getBalance()` method. To retrieve account balances, use
+ * {@link Book.getBalancesReport} and read the resulting {@link BalancesContainer}.
+ *
  * @public
  */
 export declare class Account extends ResourceProperty<bkper.Account> {
@@ -1826,6 +1830,14 @@ export declare class Book extends ResourceProperty<bkper.Book> {
      * @returns The created Accounts
      */
     batchCreateAccounts(accounts: Account[]): Promise<Account[]>;
+    /**
+     * Delete [[Accounts]] on the Book, in batch.
+     *
+     * @param accounts - The accounts to be deleted
+     *
+     * @returns The deleted Accounts
+     */
+    batchDeleteAccounts(accounts: Account[]): Promise<Account[]>;
     /**
      * Create [[Groups]] on the Book, in batch.
      *
@@ -1835,7 +1847,7 @@ export declare class Book extends ResourceProperty<bkper.Book> {
      */
     batchCreateGroups(groups: Group[]): Promise<Group[]>;
     /**
-     * Trigger [Balances Audit](https://help.bkper.com/en/articles/4412038-balances-audit) async process.
+     * Trigger Balances Audit async process.
      */
     audit(): void;
     /**
@@ -3230,8 +3242,6 @@ export declare enum Periodicity {
 /**
  * Enum representing permissions of user in the Book
  *
- * Learn more at [share article](https://help.bkper.com/en/articles/2569153-share-your-book-with-your-peers).
- *
  * @public
  */
 export declare enum Permission {

package/lib/model/Account.js

@@ -18,6 +18,10 @@ import { ResourceProperty } from './ResourceProperty.js';
  *
  * An Account can be grouped by [[Groups]].
  *
+ * @remarks
+ * `Account` has no `getBalance()` method. To retrieve account balances, use
+ * {@link Book.getBalancesReport} and read the resulting {@link BalancesContainer}.
+ *
  * @public
  */
 export class Account extends ResourceProperty {

package/lib/model/Book.js

@@ -574,6 +574,32 @@ export class Book extends ResourceProperty {
             return [];
         });
     }
+    /**
+     * Delete [[Accounts]] on the Book, in batch.
+     *
+     * @param accounts - The accounts to be deleted
+     *
+     * @returns The deleted Accounts
+     */
+    batchDeleteAccounts(accounts) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (accounts.length > 0) {
+                const accountList = {
+                    items: accounts.map(a => a.json()),
+                };
+                const payloads = yield AccountService.deleteAccounts(this.getId(), accountList, this.getConfig());
+                const deletedAccounts = [];
+                for (const payload of payloads) {
+                    const account = new Account(this, payload);
+                    deletedAccounts.push(account);
+                    this.setAccount(payload, true);
+                }
+                this.clearCache();
+                return deletedAccounts;
+            }
+            return [];
+        });
+    }
     /**
      * Create [[Groups]] on the Book, in batch.
      *
@@ -599,7 +625,7 @@ export class Book extends ResourceProperty {
         });
     }
     /**
-     * Trigger [Balances Audit](https://help.bkper.com/en/articles/4412038-balances-audit) async process.
+     * Trigger Balances Audit async process.
      */
     audit() {
         BookService.audit(this.getId(), this.getConfig());

package/lib/model/Enums.js

@@ -37,8 +37,6 @@ export var DecimalSeparator;
 /**
  * Enum representing permissions of user in the Book
  *
- * Learn more at [share article](https://help.bkper.com/en/articles/2569153-share-your-book-with-your-peers).
- *
  * @public
  */
 export var Permission;

package/lib/service/account-service.js

@@ -34,6 +34,13 @@ export function deleteAccount(bookId, account, config) {
         return response.data;
     });
 }
+export function deleteAccounts(bookId, payload, config) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        const response = yield new HttpBooksApiV5Request(`${bookId}/accounts/delete/batch`, config).setMethod('POST').setPayload(payload).fetch();
+        return ((_a = response.data) === null || _a === void 0 ? void 0 : _a.items) || [];
+    });
+}
 export function getAccount(bookId, idOrName, config) {
     return __awaiter(this, void 0, void 0, function* () {
         let response = yield new HttpBooksApiV5Request(`${bookId}/accounts/${encodeURIComponent(idOrName)}`, config).setMethod('GET').fetch();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bkper-js",
-  "version": "2.29.3",
+  "version": "2.30.0",
   "description": "Javascript client for Bkper REST API",
   "main": "./lib/index.js",
   "module": "./lib/index.js",
@@ -35,7 +35,7 @@
     "postversion": "git push --tags && yarn publish --new-version $npm_package_version && git push && echo \"Successfully released version $npm_package_version!\""
   },
   "dependencies": {
-    "@bkper/bkper-api-types": "^5.36.0",
+    "@bkper/bkper-api-types": "^5.37.0",
     "big.js": "^6.0.3",
     "dayjs": "^1.10.3",
     "luxon": "^1.25.0",