bkper-js 2.8.0 → 2.9.0

package/CHANGELOG.md

@@ -6,7 +6,18 @@ See what's new and what has changed in bkper-js
 ----
 
 **September 2025**
-
+* **v2.8.0 - INTERNAL REFACTOR:**
+    * Introduced abstract `Resource` class for all model entities
+    * Improved config management with `getConfig()` pattern for config resolution
+    * Enhanced type safety with explicit Config type usage throughout
+    * Standardized `json()` method across resources for consistent JSON serialization
+    * Maintained full backward compatibility - no breaking changes to existing APIs
+* Added `App.getOwnerWebsiteUrl`
+* Added `App.getReadme`
+* Added `App.getRepositoryUrl`
+* Added `App.getWebsiteUrl`
+* Added `App.isInstallable`
+* Added `App.isRepositoryPrivate`
 * Added `Collaborator`
 * Added `Collaborator.json`
 * Added `Collaborator.getId`

package/lib/index.d.ts

@@ -18,6 +18,11 @@
 export declare class Account extends Resource<bkper.Account> {
 
     constructor(book: Book, payload?: bkper.Account);
+    /**
+     * Gets the configuration object for this Account.
+     *
+     * @returns The Config object from the parent Book
+     */
     getConfig(): Config;
     /**
      * Gets the Account internal id.
@@ -39,6 +44,12 @@ export declare class Account extends Resource<bkper.Account> {
      * @returns This Account, for chaining
      */
     setName(name: string): Account;
+    /**
+     * Tells if the balance of this Account has been verified/audited.
+     *
+     * @returns True if the balance of this Account has been verified/audited
+     */
+    isBalanceVerified(): boolean | undefined;
     /**
      * Gets the normalized name of this Account without spaces or special characters.
      *
@@ -439,6 +450,11 @@ export declare class Amount {
 export declare class App extends Resource<bkper.App> {
     private config?;
     constructor(payload?: bkper.App, config?: Config);
+    /**
+     * Gets the configuration object for this App.
+     *
+     * @returns The Config object for this App or the global config
+     */
     getConfig(): Config;
     /**
      * Sets the webhook url for development.
@@ -1311,6 +1327,11 @@ export declare class Book extends Resource<bkper.Book> {
 
 
     constructor(payload?: bkper.Book, config?: Config);
+    /**
+     * Gets the configuration object for this Book.
+     *
+     * @returns The Config object for this Book or the global config
+     */
     getConfig(): Config;
     /**
      * Gets the unique identifier of this Book.
@@ -1945,6 +1966,11 @@ export declare enum BotResponseType {
 export declare class Collaborator extends Resource<bkper.Collaborator> {
 
     constructor(book: Book, payload?: bkper.Collaborator);
+    /**
+     * Gets the configuration object for this Collaborator.
+     *
+     * @returns The Config object from the parent Book
+     */
     getConfig(): Config;
     /**
      * Gets the Collaborator internal id.
@@ -2008,6 +2034,11 @@ export declare class Collaborator extends Resource<bkper.Collaborator> {
 export declare class Collection extends Resource<bkper.Collection> {
     private config?;
     constructor(payload?: bkper.Collection, config?: Config);
+    /**
+     * Gets the configuration object for this Collection.
+     *
+     * @returns The Config object for this Collection or the global config
+     */
     getConfig(): Config;
     /**
      * Gets the unique identifier of this Collection.
@@ -2144,6 +2175,11 @@ export declare interface Config {
 export declare class Connection extends Resource<bkper.Connection> {
     private config?;
     constructor(payload?: bkper.Connection, config?: Config);
+    /**
+     * Gets the configuration object for this Connection.
+     *
+     * @returns The Config object for this Connection or the global config
+     */
     getConfig(): Config;
     /**
      * Gets the id of the Connection.
@@ -2310,6 +2346,11 @@ export declare class Conversation extends Resource<bkper.Conversation> {
 
     private config?;
     constructor(agent: Agent, payload?: bkper.Conversation, config?: Config);
+    /**
+     * Gets the configuration object for this Conversation.
+     *
+     * @returns The Config object for this Conversation or the global config
+     */
     getConfig(): Config;
     /**
      * Gets the Agent associated to this Conversation.
@@ -2523,6 +2564,11 @@ export declare enum EventType {
 export declare class File extends Resource<bkper.File> {
 
     constructor(book: Book, payload?: bkper.File);
+    /**
+     * Gets the configuration object for this File.
+     *
+     * @returns The Config object from the parent Book
+     */
     getConfig(): Config;
     /**
      * Gets the File id.
@@ -2652,6 +2698,11 @@ export declare class Group extends Resource<bkper.Group> {
 
 
     constructor(book: Book, payload?: bkper.Group);
+    /**
+     * Gets the configuration object for this Group.
+     *
+     * @returns The Config object from the parent Book
+     */
     getConfig(): Config;
     /**
      * Gets the id of this Group.
@@ -2673,6 +2724,12 @@ export declare class Group extends Resource<bkper.Group> {
      * @returns This Group, for chaining
      */
     setName(name: string): Group;
+    /**
+     * Tells if the balance of this Group has been verified/audited.
+     *
+     * @returns True if the balance of this Group has been verified/audited
+     */
+    isBalanceVerified(): Promise<boolean | undefined>;
     /**
      * Tells if the Group is locked by the Book owner.
      *
@@ -2893,6 +2950,11 @@ export declare class Group extends Resource<bkper.Group> {
 export declare class Integration extends Resource<bkper.Integration> {
     private config?;
     constructor(payload?: bkper.Integration, config?: Config);
+    /**
+     * Gets the configuration object for this Integration.
+     *
+     * @returns The Config object for this Integration or the global config
+     */
     getConfig(): Config;
     /**
      * Gets the [[Book]] id of the Integration.
@@ -3004,6 +3066,11 @@ export declare class Message extends Resource<bkper.Message> {
 
 
     constructor(conversation: Conversation, payload?: bkper.Message, config?: Config);
+    /**
+     * Gets the configuration object for this Message.
+     *
+     * @returns The Config object from the parent Conversation
+     */
     getConfig(): Config;
     /**
      * Gets the Message universal identifier.
@@ -3210,6 +3277,11 @@ export declare enum Permission {
 export declare class Query extends Resource<bkper.Query> {
 
     constructor(book: Book, payload?: bkper.Query);
+    /**
+     * Gets the configuration object for this Query.
+     *
+     * @returns The Config object from the parent Book
+     */
     getConfig(): Config;
     /**
      * Gets the Query universal identifier.
@@ -3276,7 +3348,7 @@ declare abstract class Resource<T = any> {
     /**
      * The underlying payload data for this resource
      */
-    protected payload: T;
+    payload: T;
     /**
      * Constructs a new Resource
      * @param payload - The data payload for this resource
@@ -3307,6 +3379,11 @@ declare abstract class Resource<T = any> {
 export declare class Template extends Resource<bkper.Template> {
     private config?;
     constructor(json?: bkper.Template, config?: Config);
+    /**
+     * Gets the configuration object for this Template.
+     *
+     * @returns The Config object for this Template or the global config
+     */
     getConfig(): Config;
     /**
      * Gets the name of the Template.
@@ -3369,6 +3446,11 @@ export declare class Template extends Resource<bkper.Template> {
 export declare class Transaction extends Resource<bkper.Transaction> {
 
     constructor(book: Book, payload?: bkper.Transaction);
+    /**
+     * Gets the configuration object for this Transaction.
+     *
+     * @returns The Config object from the parent Book
+     */
     getConfig(): Config;
     /**
      * Gets the book associated with this transaction.
@@ -3867,6 +3949,11 @@ export declare class TransactionList {
 export declare class User extends Resource<bkper.User> {
     private config?;
     constructor(payload?: bkper.User, config?: Config);
+    /**
+     * Gets the configuration object for this User.
+     *
+     * @returns The Config object for this User or the global config
+     */
     getConfig(): Config;
     /**
      * Gets the id of the User.

package/lib/model/Account.js

@@ -26,6 +26,11 @@ export class Account extends Resource {
         super(payload || { createdAt: `${Date.now()}` });
         this.book = book;
     }
+    /**
+     * Gets the configuration object for this Account.
+     *
+     * @returns The Config object from the parent Book
+     */
     getConfig() {
         return this.book.getConfig();
     }
@@ -56,6 +61,14 @@ export class Account extends Resource {
         this.payload.name = name;
         return this;
     }
+    /**
+     * Tells if the balance of this Account has been verified/audited.
+     *
+     * @returns True if the balance of this Account has been verified/audited
+     */
+    isBalanceVerified() {
+        return this.payload.balanceVerified;
+    }
     /**
      * Gets the normalized name of this Account without spaces or special characters.
      *

package/lib/model/App.js

@@ -22,6 +22,11 @@ export class App extends Resource {
         super(payload);
         this.config = config;
     }
+    /**
+     * Gets the configuration object for this App.
+     *
+     * @returns The Config object for this App or the global config
+     */
     getConfig() {
         return this.config || Bkper.globalConfig;
     }

package/lib/model/Book.js

@@ -51,6 +51,11 @@ export class Book extends Resource {
         this.mapGroups(this.payload.groups);
         this.mapAccounts(this.payload.accounts);
     }
+    /**
+     * Gets the configuration object for this Book.
+     *
+     * @returns The Config object for this Book or the global config
+     */
     getConfig() {
         return this.config || Bkper.globalConfig;
     }

package/lib/model/Collaborator.js

@@ -21,6 +21,11 @@ export class Collaborator extends Resource {
         super(payload);
         this.book = book;
     }
+    /**
+     * Gets the configuration object for this Collaborator.
+     *
+     * @returns The Config object from the parent Book
+     */
     getConfig() {
         return this.book.getConfig();
     }

package/lib/model/Collection.js

@@ -21,6 +21,11 @@ export class Collection extends Resource {
         super(payload);
         this.config = config;
     }
+    /**
+     * Gets the configuration object for this Collection.
+     *
+     * @returns The Config object for this Collection or the global config
+     */
     getConfig() {
         return this.config || Bkper.globalConfig;
     }

package/lib/model/Connection.js

@@ -21,6 +21,11 @@ export class Connection extends Resource {
         super(payload);
         this.config = config;
     }
+    /**
+     * Gets the configuration object for this Connection.
+     *
+     * @returns The Config object for this Connection or the global config
+     */
     getConfig() {
         return this.config || Bkper.globalConfig;
     }

package/lib/model/Conversation.js

@@ -25,6 +25,11 @@ export class Conversation extends Resource {
         this.agent = agent;
         this.config = config;
     }
+    /**
+     * Gets the configuration object for this Conversation.
+     *
+     * @returns The Config object for this Conversation or the global config
+     */
     getConfig() {
         return this.config || Bkper.globalConfig;
     }

package/lib/model/File.js

@@ -22,6 +22,11 @@ export class File extends Resource {
         super(payload || { createdAt: `${Date.now()}` });
         this.book = book;
     }
+    /**
+     * Gets the configuration object for this File.
+     *
+     * @returns The Config object from the parent Book
+     */
     getConfig() {
         return this.book.getConfig();
     }

package/lib/model/Group.js

@@ -27,6 +27,11 @@ export class Group extends Resource {
         this.children = new Map();
         this.book = book;
     }
+    /**
+     * Gets the configuration object for this Group.
+     *
+     * @returns The Config object from the parent Book
+     */
     getConfig() {
         return this.book.getConfig();
     }
@@ -57,6 +62,22 @@ export class Group extends Resource {
         this.payload.name = name;
         return this;
     }
+    /**
+     * Tells if the balance of this Group has been verified/audited.
+     *
+     * @returns True if the balance of this Group has been verified/audited
+     */
+    isBalanceVerified() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const accounts = yield this.getAccounts();
+            for (const account of accounts) {
+                if (!account.isBalanceVerified()) {
+                    return false;
+                }
+            }
+            return true;
+        });
+    }
     /**
      * Tells if the Group is locked by the Book owner.
      *

package/lib/model/Integration.js

@@ -20,6 +20,11 @@ export class Integration extends Resource {
         super(payload || {});
         this.config = config;
     }
+    /**
+     * Gets the configuration object for this Integration.
+     *
+     * @returns The Config object for this Integration or the global config
+     */
     getConfig() {
         return this.config || Bkper.globalConfig;
     }

package/lib/model/Message.js

@@ -23,6 +23,11 @@ export class Message extends Resource {
         super(payload || {});
         this.conversation = conversation;
     }
+    /**
+     * Gets the configuration object for this Message.
+     *
+     * @returns The Config object from the parent Conversation
+     */
     getConfig() {
         return this.conversation.getConfig();
     }

package/lib/model/Query.js

@@ -21,6 +21,11 @@ export class Query extends Resource {
         super(payload);
         this.book = book;
     }
+    /**
+     * Gets the configuration object for this Query.
+     *
+     * @returns The Config object from the parent Book
+     */
     getConfig() {
         return this.book.getConfig();
     }

package/lib/model/Template.js

@@ -12,6 +12,11 @@ export class Template extends Resource {
         super(json);
         this.config = config;
     }
+    /**
+     * Gets the configuration object for this Template.
+     *
+     * @returns The Config object for this Template or the global config
+     */
     getConfig() {
         return this.config || Bkper.globalConfig;
     }

package/lib/model/Transaction.js

@@ -26,6 +26,11 @@ export class Transaction extends Resource {
         super(payload || { createdAt: `${Date.now()}` });
         this.book = book;
     }
+    /**
+     * Gets the configuration object for this Transaction.
+     *
+     * @returns The Config object from the parent Book
+     */
     getConfig() {
         return this.book.getConfig();
     }

package/lib/model/User.js

@@ -25,6 +25,11 @@ export class User extends Resource {
         super(payload);
         this.config = config;
     }
+    /**
+     * Gets the configuration object for this User.
+     *
+     * @returns The Config object for this User or the global config
+     */
     getConfig() {
         return this.config || Bkper.globalConfig;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bkper-js",
-  "version": "2.8.0",
+  "version": "2.9.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.25.0"
+    "@bkper/bkper-api-types": "^5.26.0"
   },
   "dependencies": {
     "big.js": "^6.0.3",