bkper-js 2.13.0 → 2.14.1

package/CHANGELOG.md

@@ -8,6 +8,7 @@ See what's new and what has changed in bkper-js
 
 - Files attached to transactions are now created internally when transaction is persisted
 - Added `Transaction.removeFile`
+- Added `Book.countTransactions`
 
 **September 2025**
 

package/lib/index.d.ts

@@ -95,11 +95,11 @@ export declare class Account extends Resource<bkper.Account> {
      * Sets a custom property in the Account.
      *
      * @param key - The property key
-     * @param value - The property value
+     * @param value - The property value, or null/undefined to clean it
      *
      * @returns This Account, for chaining
      */
-    setProperty(key: string, value: string | null): Account;
+    setProperty(key: string, value: string | null | undefined): Account;
     /**
      * Deletes a custom property.
      *
@@ -1578,11 +1578,11 @@ export declare class Book extends Resource<bkper.Book> {
      * Sets a custom property in the Book.
      *
      * @param key - The property key
-     * @param value - The property value
+     * @param value - The property value, or null/undefined to clean it
      *
      * @returns This Book, for chaining
      */
-    setProperty(key: string, value: string | null): Book;
+    setProperty(key: string, value: string | null | undefined): Book;
     /**
      * Formats a date according to date pattern of the Book.
      *
@@ -1850,6 +1850,14 @@ export declare class Book extends Resource<bkper.Book> {
      * @returns A [[TransactionList]] object containing the list of transactions
      */
     listTransactions(query?: string, limit?: number, cursor?: string): Promise<TransactionList>;
+    /**
+     * Retrieve the number of transactions based on a query.
+     *
+     * @param query - The query string
+     *
+     * @returns The number of matching transactions
+     */
+    countTransactions(query?: string): Promise<number | undefined>;
     /**
      * Lists events in the Book based on the provided parameters.
      *
@@ -2336,11 +2344,11 @@ export declare class Connection extends Resource<bkper.Connection> {
      * Sets a custom property in the Connection.
      *
      * @param key - The property key
-     * @param value - The property value
+     * @param value - The property value, or null/undefined to clean it
      *
      * @returns The Connection, for chaining
      */
-    setProperty(key: string, value: string | null): Connection;
+    setProperty(key: string, value: string | null | undefined): Connection;
     /**
      * Deletes a custom property stored in the Connection.
      *
@@ -2643,11 +2651,11 @@ export declare class File extends Resource<bkper.File> {
      * Sets a custom property in the File.
      *
      * @param key - The property key
-     * @param value - The property value
+     * @param value - The property value, or null/undefined to clean it
      *
      * @returns This File, for chaining
      */
-    setProperty(key: string, value: string | null): File;
+    setProperty(key: string, value: string | null | undefined): File;
     /**
      * Deletes a custom property.
      *
@@ -2770,11 +2778,11 @@ export declare class Group extends Resource<bkper.Group> {
      * Sets a custom property in the Group.
      *
      * @param key - The property key
-     * @param value - The property value
+     * @param value - The property value, or null/undefined to clean it
      *
      * @returns This Group, for chaining
      */
-    setProperty(key: string, value: string | null): Group;
+    setProperty(key: string, value: string | null | undefined): Group;
     /**
      * Delete a custom property
      *
@@ -3021,11 +3029,11 @@ export declare class Integration extends Resource<bkper.Integration> {
      * Sets a custom property in the Integration.
      *
      * @param key - The property key
-     * @param value - The property value
+     * @param value - The property value, or null/undefined to clean it
      *
      * @returns The Integration, for chaining
      */
-    setProperty(key: string, value: string | null): Integration;
+    setProperty(key: string, value: string | null | undefined): Integration;
     /**
      * Deletes a custom property stored in the Integration.
      *
@@ -3479,11 +3487,11 @@ export declare class Transaction extends Resource<bkper.Transaction> {
      * Sets a custom property in the Transaction.
      *
      * @param key - The property key
-     * @param value - The property value
+     * @param value - The property value, or null/undefined to clean it
      *
      * @returns This Transaction, for chaining
      */
-    setProperty(key: string, value: string | null): Transaction;
+    setProperty(key: string, value: string | null | undefined): Transaction;
     /**
      * Delete a custom property
      *

package/lib/model/Account.js

@@ -137,7 +137,7 @@ export class Account extends Resource {
      * Sets a custom property in the Account.
      *
      * @param key - The property key
-     * @param value - The property value
+     * @param value - The property value, or null/undefined to clean it
      *
      * @returns This Account, for chaining
      */

package/lib/model/Book.js

@@ -420,7 +420,7 @@ export class Book extends Resource {
      * Sets a custom property in the Book.
      *
      * @param key - The property key
-     * @param value - The property value
+     * @param value - The property value, or null/undefined to clean it
      *
      * @returns This Book, for chaining
      */
@@ -1070,6 +1070,19 @@ export class Book extends Resource {
             return new TransactionList(this, transactionsList);
         });
     }
+    /**
+     * Retrieve the number of transactions based on a query.
+     *
+     * @param query - The query string
+     *
+     * @returns The number of matching transactions
+     */
+    countTransactions(query) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const count = yield TransactionService.countTransactions(this.getId(), query, this.getConfig());
+            return count.total;
+        });
+    }
     /**
      * Lists events in the Book based on the provided parameters.
      *

package/lib/model/Connection.js

@@ -174,7 +174,7 @@ export class Connection extends Resource {
      * Sets a custom property in the Connection.
      *
      * @param key - The property key
-     * @param value - The property value
+     * @param value - The property value, or null/undefined to clean it
      *
      * @returns The Connection, for chaining
      */

package/lib/model/File.js

@@ -165,7 +165,7 @@ export class File extends Resource {
      * Sets a custom property in the File.
      *
      * @param key - The property key
-     * @param value - The property value
+     * @param value - The property value, or null/undefined to clean it
      *
      * @returns This File, for chaining
      */

package/lib/model/Group.js

@@ -180,7 +180,7 @@ export class Group extends Resource {
      * Sets a custom property in the Group.
      *
      * @param key - The property key
-     * @param value - The property value
+     * @param value - The property value, or null/undefined to clean it
      *
      * @returns This Group, for chaining
      */

package/lib/model/Integration.js

@@ -147,7 +147,7 @@ export class Integration extends Resource {
      * Sets a custom property in the Integration.
      *
      * @param key - The property key
-     * @param value - The property value
+     * @param value - The property value, or null/undefined to clean it
      *
      * @returns The Integration, for chaining
      */

package/lib/model/Transaction.js

@@ -371,7 +371,7 @@ export class Transaction extends Resource {
      * Sets a custom property in the Transaction.
      *
      * @param key - The property key
-     * @param value - The property value
+     * @param value - The property value, or null/undefined to clean it
      *
      * @returns This Transaction, for chaining
      */
@@ -713,7 +713,7 @@ export class Transaction extends Resource {
                 let dateObject = Utils.parseDate(date, this.book.getDatePattern(), this.book.getTimeZone());
                 this.payload.date = Utils.formatDateISO(dateObject, this.book.getTimeZone());
             }
-            else if (date.indexOf("-")) {
+            else if (date.indexOf("-") >= 0) {
                 this.payload.date = date;
             }
         }

package/lib/service/transaction-service.js

@@ -126,4 +126,11 @@ export function listTransactions(bookId, query, limit, cursor, config) {
         return response.data;
     });
 }
+export function countTransactions(bookId, query, config) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const request = new HttpBooksApiV5Request(`${bookId}/transactions/count`, config).setMethod('GET').addParam('query', query);
+        const response = yield request.fetch();
+        return response.data;
+    });
+}
 //# sourceMappingURL=transaction-service.js.map

package/lib/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.52.12"
+      "packageVersion": "7.53.1"
     }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bkper-js",
-  "version": "2.13.0",
+  "version": "2.14.1",
   "description": "Javascript client for Bkper REST API",
   "main": "./lib/index.js",
   "module": "./lib/index.js",