chargebee 3.9.0 → 3.10.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+### v3.10.0 (2025-06-30)
+* * * 
+
+### New Features
+* Added `userAgentSuffix` to the environment config to allow appending custom text to the `User-Agent` header.
+
+
 ### v3.9.0 (2025-06-23)
 * * * 
 

package/cjs/RequestWrapper.js

@@ -33,8 +33,9 @@ class RequestWrapper {
         return null;
     }
     async request() {
-        let env = {};
-        (0, util_js_1.extend)(true, env, this.envArg);
+        let _env = {};
+        (0, util_js_1.extend)(true, _env, this.envArg);
+        const env = _env;
         const retryConfig = Object.assign({ enabled: false, maxRetries: 3, delayMs: 200, retryOn: [500, 502, 503, 504] }, env.retryConfig);
         const urlIdParam = this.apiCall.hasIdInUrl ? this.args[0] : null;
         let params = this.apiCall.hasIdInUrl
@@ -74,11 +75,12 @@ class RequestWrapper {
             const contentType = this.apiCall.isJsonRequest
                 ? 'application/json;charset=UTF-8'
                 : 'application/x-www-form-urlencoded; charset=utf-8';
+            const userAgent = `Chargebee-NodeJs-Client ${env.clientVersion}${env.userAgentSuffix ? ';' + env.userAgentSuffix : ''}`;
             (0, util_js_1.extend)(true, requestHeaders, {
                 Authorization: 'Basic ' + node_buffer_1.Buffer.from(env.apiKey + ':').toString('base64'),
                 Accept: 'application/json',
                 'Content-Type': contentType,
-                'User-Agent': 'Chargebee-NodeJs-Client ' + env.clientVersion,
+                'User-Agent': userAgent,
                 'Lang-Version': typeof process === 'undefined' ? '' : process.version,
             });
             if (attempt > 0) {

package/cjs/environment.js

@@ -11,7 +11,7 @@ exports.Environment = {
     hostSuffix: '.chargebee.com',
     apiPath: '/api/v2',
     timeout: DEFAULT_TIME_OUT,
-    clientVersion: 'v3.9.0',
+    clientVersion: 'v3.10.0',
     port: DEFAULT_PORT,
     timemachineWaitInMillis: DEFAULT_TIME_MACHINE_WAIT,
     exportWaitInMillis: DEFAULT_EXPORT_WAIT,

package/esm/RequestWrapper.js

@@ -30,8 +30,9 @@ export class RequestWrapper {
         return null;
     }
     async request() {
-        let env = {};
-        extend(true, env, this.envArg);
+        let _env = {};
+        extend(true, _env, this.envArg);
+        const env = _env;
         const retryConfig = Object.assign({ enabled: false, maxRetries: 3, delayMs: 200, retryOn: [500, 502, 503, 504] }, env.retryConfig);
         const urlIdParam = this.apiCall.hasIdInUrl ? this.args[0] : null;
         let params = this.apiCall.hasIdInUrl
@@ -71,11 +72,12 @@ export class RequestWrapper {
             const contentType = this.apiCall.isJsonRequest
                 ? 'application/json;charset=UTF-8'
                 : 'application/x-www-form-urlencoded; charset=utf-8';
+            const userAgent = `Chargebee-NodeJs-Client ${env.clientVersion}${env.userAgentSuffix ? ';' + env.userAgentSuffix : ''}`;
             extend(true, requestHeaders, {
                 Authorization: 'Basic ' + Buffer.from(env.apiKey + ':').toString('base64'),
                 Accept: 'application/json',
                 'Content-Type': contentType,
-                'User-Agent': 'Chargebee-NodeJs-Client ' + env.clientVersion,
+                'User-Agent': userAgent,
                 'Lang-Version': typeof process === 'undefined' ? '' : process.version,
             });
             if (attempt > 0) {

package/esm/environment.js

@@ -8,7 +8,7 @@ export const Environment = {
     hostSuffix: '.chargebee.com',
     apiPath: '/api/v2',
     timeout: DEFAULT_TIME_OUT,
-    clientVersion: 'v3.9.0',
+    clientVersion: 'v3.10.0',
     port: DEFAULT_PORT,
     timemachineWaitInMillis: DEFAULT_TIME_MACHINE_WAIT,
     exportWaitInMillis: DEFAULT_EXPORT_WAIT,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chargebee",
-  "version": "3.9.0",
+  "version": "3.10.0",
   "description": "A library for integrating with Chargebee.",
   "scripts": {
     "prepack": "npm install && npm run build",

package/types/index.d.ts

@@ -132,6 +132,11 @@ export type Config = {
    * @enableDebugLogs whether to enable debug logs, default value is false
    */
   enableDebugLogs?: boolean;
+
+  /**
+   * @userAgentSuffix optional string appended to the User-Agent header for additional logging
+   */
+  userAgentSuffix?: string;
 };
 
 export type RetryConfig = {