bkper-js 2.0.0 → 2.1.0

package/CHANGELOG.md

@@ -8,7 +8,6 @@ See what's new and what has changed in bkper-js
 **July 2025**
 * **BREAKING CHANGE:** Refactored `Bkper` class from static methods to constructor-based pattern
 * **BREAKING CHANGE:** Removed deprecated methods: `Transaction.remove()`, `Transaction.restore()`, `Account.getBalance()`, `Account.getBalanceRaw()`
-* **MIGRATION:** Replace `Bkper.setConfig(config); Bkper.getBook(id)` with `const bkper = new Bkper(config); bkper.getBook(id)`
 * **MIGRATION:** Use `transaction.trash()` and `transaction.untrash()` instead of `remove()` and `restore()`
 * **MIGRATION:** Use `Book.getBalancesReport()` instead of `Account.getBalance()` methods
 

package/README.md

@@ -32,12 +32,15 @@ bun add bkper-js
 ```typescript
 import { Bkper } from 'bkper-js';
 
-// Create Bkper instance with configuration
-const bkper = new Bkper({
+// Set global configuration
+Bkper.setConfig({
   apiKeyProvider: () => process.env.BKPER_API_KEY,
   oauthTokenProvider: () => process.env.BKPER_OAUTH_TOKEN
 });
 
+// Create Bkper instance (uses global config)
+const bkper = new Bkper();
+
 // Get a book and work with it
 const book = await bkper.getBook('your-book-id');
 console.log(`Book: ${book.getName()}`);

package/lib/index.d.ts

@@ -825,28 +825,36 @@ export declare class BalancesReport {
 /**
  * This is the main entry point of the [bkper-js](https://www.npmjs.com/package/bkper-js) library.
  *
- * You start by setting the API [[Config]] object.
+ * You start by setting the API [[Config]] object using the static setConfig method.
  *
  * Example:
  *
  * ```javascript
- * Bkper.get().setConfig({
+ * Bkper.setConfig({
  *   apiKeyProvider: () => process.env.BKPER_API_KEY,
  *   oauthTokenProvider: () => process.env.BKPER_OAUTH_TOKEN
- * })
+ * });
+ *
+ * const bkper = new Bkper();
+ * const book = await bkper.getBook('bookId');
  * ```
  *
- * Once the config is set, you can start using the library.
+ * Once the config is set, you can create instances and start using the library.
  *
  * @public
  */
 export declare class Bkper {
     /**
-     * Creates a new Bkper instance with the specified API configuration.
+     * Sets the global API configuration for all Bkper operations.
      *
-     * @param config - The Config object
+     * @param config - The Config object containing API key and OAuth token providers
+     */
+    static setConfig(config: Config): void;
+    /**
+     * Creates a new Bkper instance using the global configuration set via setConfig().
+     * Make sure to call Bkper.setConfig() before creating instances.
      */
-    constructor(config: Config);
+    constructor();
     /**
      * Gets the [[Book]] with the specified bookId from url param.
      *

package/lib/model/Bkper.js

@@ -24,30 +24,40 @@ import { Agent } from "./Agent.js";
 /**
  * This is the main entry point of the [bkper-js](https://www.npmjs.com/package/bkper-js) library.
  *
- * You start by setting the API [[Config]] object.
+ * You start by setting the API [[Config]] object using the static setConfig method.
  *
  * Example:
  *
  * ```javascript
- * Bkper.get().setConfig({
+ * Bkper.setConfig({
  *   apiKeyProvider: () => process.env.BKPER_API_KEY,
  *   oauthTokenProvider: () => process.env.BKPER_OAUTH_TOKEN
- * })
+ * });
+ *
+ * const bkper = new Bkper();
+ * const book = await bkper.getBook('bookId');
  * ```
  *
- * Once the config is set, you can start using the library.
+ * Once the config is set, you can create instances and start using the library.
  *
  * @public
  */
 export class Bkper {
     /**
-     * Creates a new Bkper instance with the specified API configuration.
+     * Sets the global API configuration for all Bkper operations.
      *
-     * @param config - The Config object
+     * @param config - The Config object containing API key and OAuth token providers
      */
-    constructor(config) {
+    static setConfig(config) {
         HttpApiRequest.config = config;
     }
+    /**
+     * Creates a new Bkper instance using the global configuration set via setConfig().
+     * Make sure to call Bkper.setConfig() before creating instances.
+     */
+    constructor() {
+        // Uses global configuration set via setConfig()
+    }
     /**
      * Gets the [[Book]] with the specified bookId from url param.
      *

package/package.json

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