bkper-js 2.17.1 → 2.18.0

package/CHANGELOG.md

@@ -4,6 +4,22 @@ See what's new and what has changed in bkper-js
 
 ## 2025
 
+**December 2025**
+- Added `File.update`
+- Added `EventType.FILE_UPDATED`
+
+**November 2025**
+- **v2.15.2 - INTERNAL REFACTOR:**
+  - Introduced `ResourceProperty` abstract class for model entities that support custom properties
+  - Moved shared property methods to ResourceProperty
+  - Refactor 7 model classes to extend ResourceProperty instead of Resource
+  - Eliminate ~350 lines of duplicated property management code
+  - Maintained full backward compatibility - no breaking changes to existing APIs
+- Added `ResourceProperty.setVisibleProperty`
+- Added `ResourceProperty.setVisibleProperties`
+- Added `ResourceProperty.getVisibleProperties`
+- Added `Bkper.getConfig`
+
 **October 2025**
 
 - Files attached to transactions are now created internally when transaction is persisted

package/lib/index.d.ts

@@ -1159,7 +1159,8 @@ export declare enum BalanceType {
  * You can configure the library in two ways:
  *
  * 1. Using static configuration (traditional approach):
- * ```javascript
+ *
+ * ```typescript
  * Bkper.setConfig({
  *   apiKeyProvider: () => process.env.BKPER_API_KEY,
  *   oauthTokenProvider: () => process.env.BKPER_OAUTH_TOKEN
@@ -1170,7 +1171,8 @@ export declare enum BalanceType {
  * ```
  *
  * 2. Using per-instance configuration (recommended for Cloudflare Workers):
- * ```javascript
+ *
+ * ```typescript
  * const bkper = new Bkper({
  *   apiKeyProvider: () => process.env.BKPER_API_KEY,
  *   oauthTokenProvider: () => process.env.BKPER_OAUTH_TOKEN
@@ -2132,6 +2134,13 @@ export declare interface Config {
      * Issue a valid OAuth2 access token with **https://www.googleapis.com/auth/userinfo.email** scope authorized.
      */
     oauthTokenProvider?: () => Promise<string | undefined>;
+    /**
+     * Provides the agent ID to identify the calling agent for attribution purposes.
+     *
+     * This ID is sent via the `bkper-agent-id` header with each API request,
+     * allowing the server to attribute actions to the correct agent.
+     */
+    agentIdProvider?: () => Promise<string | undefined>;
     /**
      * Provides additional headers to append to the API request
      */

package/lib/model/Bkper.js

@@ -23,7 +23,8 @@ import { Collection } from "./Collection.js";
  * You can configure the library in two ways:
  *
  * 1. Using static configuration (traditional approach):
- * ```javascript
+ *
+ * ```typescript
  * Bkper.setConfig({
  *   apiKeyProvider: () => process.env.BKPER_API_KEY,
  *   oauthTokenProvider: () => process.env.BKPER_OAUTH_TOKEN
@@ -34,7 +35,8 @@ import { Collection } from "./Collection.js";
  * ```
  *
  * 2. Using per-instance configuration (recommended for Cloudflare Workers):
- * ```javascript
+ *
+ * ```typescript
  * const bkper = new Bkper({
  *   apiKeyProvider: () => process.env.BKPER_API_KEY,
  *   oauthTokenProvider: () => process.env.BKPER_OAUTH_TOKEN

package/lib/service/http-api-request.js

@@ -21,6 +21,7 @@ export class HttpApiRequest extends HttpRequest {
         });
         return __awaiter(this, void 0, void 0, function* () {
             this.addCustomHeaders();
+            yield this.addAgentIdHeader();
             this.setHeader("Authorization", `Bearer ${yield this.getAccessToken()}`);
             this.addParam("key", yield this.getApiKey());
             try {
@@ -108,6 +109,17 @@ export class HttpApiRequest extends HttpRequest {
             }
         });
     }
+    addAgentIdHeader() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const effectiveConfig = this.config;
+            if (effectiveConfig.agentIdProvider) {
+                const agentId = yield effectiveConfig.agentIdProvider();
+                if (agentId) {
+                    this.setHeader('bkper-agent-id', agentId);
+                }
+            }
+        });
+    }
     getApiKey() {
         return __awaiter(this, void 0, void 0, function* () {
             const effectiveConfig = this.config;

package/package.json

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