bkper-js 2.11.0 → 2.12.1

package/CHANGELOG.md

@@ -20,6 +20,9 @@ See what's new and what has changed in bkper-js
 - Added `App.isInstallable`
 - Added `App.isRepositoryPrivate`
 - Added `Book.getCollaborators`
+- Added `Book.getBacklog`
+- Added `Backlog`
+- Added `Backlog.getCount`
 - Added `Collaborator`
 - Added `Collaborator.json`
 - Added `Collaborator.getId`
@@ -31,6 +34,9 @@ See what's new and what has changed in bkper-js
 - Added `Collaborator.update`
 - Added `Collaborator.remove`
 - Added `Group.isBalanceVerified`
+- Deprecated `Integration.getLogo`
+- Added `Integration.getLogoUrl`
+- Added `Integration.getLogoUrlDark`
 - Replaced axios with native Fetch API for better compatibility with multiple environments
 
 **August 2025**

package/lib/index.d.ts

@@ -640,6 +640,26 @@ export declare class App extends Resource<bkper.App> {
     update(): Promise<App>;
 }
 
+/**
+ *
+ * This class defines the Backlog of a [[Book]].
+ *
+ * A Backlog is a list of pending tasks in a Book
+ *
+ * @public
+ */
+export declare class Backlog extends Resource<bkper.Backlog> {
+    private config?;
+    constructor(payload?: bkper.Backlog, config?: Config);
+
+    /**
+     * Returns the number of pending tasks in this Backlog.
+     *
+     * @returns The number of tasks in the Backlog, or undefined if not available.
+     */
+    getCount(): number | undefined;
+}
+
 /**
  * Class that represents an [[Account]] or [[Group]] balance on a window of time (Day / Month / Year).
  *
@@ -1844,6 +1864,12 @@ export declare class Book extends Resource<bkper.Book> {
      * @returns Array of Collaborator objects
      */
     getCollaborators(): Promise<Collaborator[]>;
+    /**
+     * Gets the Backlog of this Book.
+     *
+     * @returns The Backlog object
+     */
+    getBacklog(): Promise<Backlog>;
 }
 
 /**
@@ -3578,6 +3604,12 @@ export declare class Transaction extends Resource<bkper.Transaction> {
      * @returns The date the transaction was created, formatted according to the date pattern of the [[Book]]
      */
     getCreatedAtFormatted(): string;
+    /**
+     * Gets the username of the user who created the transaction.
+     *
+     * @returns The username of the user who created the transaction
+     */
+    getCreatedBy(): string | undefined;
     /**
      * Gets the date when the transaction was last updated.
      *

package/lib/index.js

@@ -9,6 +9,7 @@ export { Account } from "./model/Account.js";
 export { Agent } from "./model/Agent.js";
 export { Amount } from "./model/Amount.js";
 export { App } from "./model/App.js";
+export { Backlog } from "./model/Backlog.js";
 export { Balance } from "./model/Balance.js";
 export { BalancesDataTableBuilder } from "./model/BalancesDataTableBuilder.js";
 export { BalancesReport } from "./model/BalancesReport.js";

package/lib/model/Backlog.js

@@ -0,0 +1,29 @@
+import { Resource } from "./Resource.js";
+import { Bkper } from "./Bkper.js";
+/**
+ *
+ * This class defines the Backlog of a [[Book]].
+ *
+ * A Backlog is a list of pending tasks in a Book
+ *
+ * @public
+ */
+export class Backlog extends Resource {
+    constructor(payload, config) {
+        super(payload);
+        this.config = config;
+    }
+    /** @internal */
+    getConfig() {
+        return this.config || Bkper.globalConfig;
+    }
+    /**
+     * Returns the number of pending tasks in this Backlog.
+     *
+     * @returns The number of tasks in the Backlog, or undefined if not available.
+     */
+    getCount() {
+        return this.payload.count;
+    }
+}
+//# sourceMappingURL=Backlog.js.map

package/lib/model/Book.js

@@ -33,6 +33,7 @@ import { BalancesReport } from "./BalancesReport.js";
 import { App } from "./App.js";
 import { Query } from "./Query.js";
 import { Bkper } from "./Bkper.js";
+import { Backlog } from "./Backlog.js";
 /**
  * A Book represents a [General Ledger](https://en.wikipedia.org/wiki/General_ledger) for a company or business, but can also represent a [Ledger](https://en.wikipedia.org/wiki/Ledger) for a project or department
  *
@@ -1140,5 +1141,16 @@ export class Book extends Resource {
             return this.collaborators;
         });
     }
+    /**
+     * Gets the Backlog of this Book.
+     *
+     * @returns The Backlog object
+     */
+    getBacklog() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const backlogPayload = yield EventService.getBacklog(this, this.getConfig());
+            return new Backlog(backlogPayload);
+        });
+    }
 }
 //# sourceMappingURL=Book.js.map

package/lib/model/Transaction.js

@@ -710,6 +710,14 @@ export class Transaction extends Resource {
     getCreatedAtFormatted() {
         return Utils.formatDate(this.getCreatedAt(), this.book.getDatePattern() + " HH:mm:ss", this.book.getTimeZone());
     }
+    /**
+     * Gets the username of the user who created the transaction.
+     *
+     * @returns The username of the user who created the transaction
+     */
+    getCreatedBy() {
+        return this.payload.createdBy;
+    }
     /**
      * Gets the date when the transaction was last updated.
      *

package/lib/service/event-service.js

@@ -44,4 +44,10 @@ export function replayEventsBatch(book, eventList, errorsOnly, config) {
         yield request.fetch();
     });
 }
+export function getBacklog(book, config) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield new HttpBooksApiV5Request(`${book.getId()}/events/backlog`, config).setMethod("GET").fetch();
+        return response.data;
+    });
+}
 //# sourceMappingURL=event-service.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bkper-js",
-  "version": "2.11.0",
+  "version": "2.12.1",
   "description": "Javascript client for Bkper REST API",
   "main": "./lib/index.js",
   "module": "./lib/index.js",
@@ -17,6 +17,7 @@
   "scripts": {
     "test": "env TS_NODE_COMPILER_OPTIONS='{\"rootDir\": \".\" }' mocha -r ts-node/register 'test/**/*.ts'",
     "clean": "rm -rf ./lib & rm -rf ./node_modules & wait",
+    "prebuild": "bun install",
     "build": "run-s build:*",
     "build:clean": "gts clean",
     "build:compile": "tsc",