bkper-js 2.12.4 → 2.14.0

package/CHANGELOG.md

@@ -4,6 +4,11 @@ See what's new and what has changed in bkper-js
 
 ## 2025
 
+**October 2025**
+
+- Files attached to transactions are now created internally when transaction is persisted
+- Added `Transaction.removeFile`
+
 **September 2025**
 
 - **v2.8.0 - INTERNAL REFACTOR:**
@@ -42,7 +47,6 @@ 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`

package/lib/index.d.ts

@@ -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.
      *
@@ -3297,6 +3305,7 @@ export declare class Template extends Resource<bkper.Template> {
  */
 export declare class Transaction extends Resource<bkper.Transaction> {
 
+
     constructor(book: Book, payload?: bkper.Transaction);
 
     /**
@@ -3416,23 +3425,24 @@ export declare class Transaction extends Resource<bkper.Transaction> {
      */
     getFiles(): File[];
     /**
-     * Sets the files attached to the Transaction.
+     * Removes a file attachment from the Transaction.
      *
-     * @param files - The files to set
+     * @param file - The File to remove from this Transaction
      *
      * @returns This Transaction, for chaining
      */
-    setFiles(files: File[]): Transaction;
+    removeFile(file: File): Transaction;
     /**
      * Adds a file attachment to the Transaction.
      *
-     * Files MUST be previously created in the Book.
+     * Files not previously created in the Book will be automatically created when the transaction is persisted.
      *
-     * @param file - The file to add
+     * @param file - The File to add to this Transaction
      *
      * @returns This Transaction, for chaining
      */
     addFile(file: File): Transaction;
+
     /**
      * Check if the transaction has the specified tag.
      *

package/lib/model/Book.js

@@ -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/Transaction.js

@@ -13,6 +13,7 @@ import { Resource } from "./Resource.js";
 import * as TransactionService from "../service/transaction-service.js";
 import * as Utils from "../utils.js";
 import { Amount } from "./Amount.js";
+import { v4 as uuidv4 } from "uuid";
 /**
  *
  * This class defines a Transaction between [credit and debit](http://en.wikipedia.org/wiki/Debits_and_credits) [[Accounts]].
@@ -24,6 +25,8 @@ import { Amount } from "./Amount.js";
 export class Transaction extends Resource {
     constructor(book, payload) {
         super(payload || { createdAt: `${Date.now()}` });
+        /** @internal */
+        this.pendingFiles = new Map();
         this.book = book;
     }
     /** @internal */
@@ -219,38 +222,80 @@ export class Transaction extends Resource {
         }
     }
     /**
-     * Sets the files attached to the Transaction.
+     * Removes a file attachment from the Transaction.
      *
-     * @param files - The files to set
+     * @param file - The File to remove from this Transaction
      *
      * @returns This Transaction, for chaining
      */
-    setFiles(files) {
-        const filePayloads = files.map((file) => {
-            return {
-                id: file.getId(),
-                name: file.getName()
-            };
-        });
-        this.payload.files = filePayloads;
+    removeFile(file) {
+        const fileId = file.getId();
+        if (fileId) {
+            if (this.payload.files != null) {
+                this.payload.files = this.payload.files.filter(f => f.id !== fileId);
+            }
+            this.pendingFiles.delete(fileId);
+        }
         return this;
     }
     /**
      * Adds a file attachment to the Transaction.
      *
-     * Files MUST be previously created in the Book.
+     * Files not previously created in the Book will be automatically created when the transaction is persisted.
      *
-     * @param file - The file to add
+     * @param file - The File to add to this Transaction
      *
      * @returns This Transaction, for chaining
      */
     addFile(file) {
+        var _a;
         if (this.payload.files == null) {
             this.payload.files = [];
         }
+        // Store file reference for later creation if needed
+        const fileId = file.getId();
+        const fileBookId = (_a = file.getBook()) === null || _a === void 0 ? void 0 : _a.getId();
+        if (fileId == null || fileBookId != this.book.getId()) {
+            // Generate temporary ID if file doesn't have one
+            if (fileId == null) {
+                file.payload.id = `temporary_${uuidv4()}`;
+            }
+            this.pendingFiles.set(file.getId(), file);
+        }
         this.payload.files.push(file.json());
         return this;
     }
+    /** @internal */
+    createPendingFiles() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.pendingFiles.size === 0) {
+                return;
+            }
+            if (this.payload.files == null) {
+                this.payload.files = [];
+            }
+            // Create all pending files in parallel
+            const promises = Array.from(this.pendingFiles.entries()).map((_a) => __awaiter(this, [_a], void 0, function* ([fileId, file]) {
+                file.book = this.book;
+                file.setProperty('upload_method_', 'attachment');
+                const createdFile = yield file.create();
+                return { fileId, createdFile };
+            }));
+            const results = yield Promise.all(promises);
+            // Update payload with all created files
+            for (const { fileId, createdFile } of results) {
+                const fileIndex = this.payload.files.findIndex(f => f.id === fileId);
+                if (fileIndex >= 0) {
+                    this.payload.files[fileIndex] = createdFile.json();
+                }
+                else {
+                    this.payload.files.push(createdFile.json());
+                }
+            }
+            // Clear pending files after creation
+            this.pendingFiles.clear();
+        });
+    }
     /**
      * Check if the transaction has the specified tag.
      *
@@ -795,6 +840,7 @@ export class Transaction extends Resource {
      */
     create() {
         return __awaiter(this, void 0, void 0, function* () {
+            yield this.createPendingFiles();
             let operation = yield TransactionService.createTransaction(this.book.getId(), this.payload, this.getConfig());
             this.payload = operation.transaction || {};
             return this;
@@ -807,6 +853,7 @@ export class Transaction extends Resource {
      */
     update() {
         return __awaiter(this, void 0, void 0, function* () {
+            yield this.createPendingFiles();
             let operation = yield TransactionService.updateTransaction(this.book.getId(), this.payload, this.getConfig());
             this.payload = operation.transaction || {};
             return this;
@@ -845,6 +892,7 @@ export class Transaction extends Resource {
      */
     post() {
         return __awaiter(this, void 0, void 0, function* () {
+            yield this.createPendingFiles();
             let operation = yield TransactionService.postTransaction(this.book.getId(), this.payload, this.getConfig());
             this.payload = operation.transaction || {};
             return this;

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bkper-js",
-  "version": "2.12.4",
+  "version": "2.14.0",
   "description": "Javascript client for Bkper REST API",
   "main": "./lib/index.js",
   "module": "./lib/index.js",
@@ -40,7 +40,8 @@
   "dependencies": {
     "big.js": "^6.0.3",
     "dayjs": "^1.10.3",
-    "luxon": "^1.25.0"
+    "luxon": "^1.25.0",
+    "uuid": "^11.0.3"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.52.12",
@@ -50,6 +51,7 @@
     "@types/mocha": "^8.2.0",
     "@types/node": "^14.14.20",
     "@types/node-fetch": "^2.5.8",
+    "@types/uuid": "^10.0.0",
     "chai": "^5.1.1",
     "gts": "^3.0.3",
     "mocha": "^10.7.3",