@coralogix/browser 2.8.9 → 2.10.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 2.10.0 (2025-09-14)
+
+### 🚀 Features
+
+- **ignoreProxyUrlParams:** Added ignoreProxyUrlParams, which provides the ability to skip appending the Coralogix endpoint to the proxy URL.
+
+## 2.9.0 (2025-08-18)
+
+### 🚀 Features
+
+- **fingerprint:** Added user fingerprint. The fingerprint is generated and stored on each user’s machine for reuse, and will be used to calculate the unique users count.
+
 ## 2.8.9 (2025-07-24)
 
 ### 🩹 Fixes

package/README.md

@@ -420,6 +420,12 @@ CoralogixRum.init({
 });
 ```
 
+### Unique Users
+
+Starting with version `2.9.0`, the SDK calculates unique users based on the user’s `fingerprint`.<br>
+The fingerprint is generated and stored on each user’s machine for reuse.<br>
+In earlier versions, the SDK used user_id to calculate unique users, which is still supported for backward compatibility.<br>
+
 ### Network Extra Configuration
 
 The `networkExtraConfig` property is an array of configuration objects, each specifying custom rules for capturing network requests and responses. This feature collects data from `Fetch` and `XMLHttpRequest` calls, attaching specified request and response information, headers, and payloads to each network event.
@@ -690,6 +696,18 @@ CoralogixRum.init({
 });
 ```
 
+#### ignoreProxyUrlParams
+If you want the SDK to ignore the cxforward parameter and always send data to the proxy URL directly, you can use the ignoreProxyUrlParams option.
+By default, this option is disabled.
+```javascript
+CoralogixRum.init({
+  // ...
+  coralogixDomain: 'EU1',
+  proxyUrl: 'https://proxy.mycompany.com/rum',
+  ignoreProxyUrlParams: true,
+});
+```
+
 ### Collect IP Data
 
 Determines whether the SDK should collect the user's IP address and corresponding geolocation data. Defaults to true.

package/index.esm2.js

@@ -2457,6 +2457,7 @@ var MASK_INPUT_TYPES_DEFAULT = [
     'email',
     'tel',
 ];
+var FINGER_PRINT_KEY = 'cx-fingerprint';
 var idPatterns = [
     {
         pattern: new RegExp(UUID_REGEX),
@@ -3261,13 +3262,23 @@ var Request = (function () {
         this.resolvedHeaders = {};
         this.init();
     }
+    Request.prototype.getResolvedUrl = function (config) {
+        var coralogixDomain = config.coralogixDomain, proxyUrl = config.proxyUrl, ignoreProxyUrlParams = config.ignoreProxyUrlParams;
+        var cxEndpoint = "".concat(CoralogixDomainsApiUrlMap[coralogixDomain]).concat(this.requestConfig.suffix);
+        if (!proxyUrl)
+            return cxEndpoint;
+        if (ignoreProxyUrlParams)
+            return proxyUrl;
+        return "".concat(proxyUrl, "?").concat(PROXY_CX_FORWARD_PARAMETER, "=").concat(encodeURIComponent(cxEndpoint));
+    };
     Request.prototype.init = function () {
-        var _a = getSdkConfig(), proxyUrl = _a.proxyUrl, coralogixDomain = _a.coralogixDomain, public_key = _a.public_key;
-        var _b = this.requestConfig, suffix = _b.suffix, headers = _b.headers;
-        var cxEndpoint = "".concat(CoralogixDomainsApiUrlMap[coralogixDomain]).concat(suffix);
-        this.resolvedUrl = proxyUrl
-            ? "".concat(proxyUrl, "?").concat(PROXY_CX_FORWARD_PARAMETER, "=").concat(encodeURIComponent(cxEndpoint))
-            : cxEndpoint;
+        var _a = getSdkConfig(), proxyUrl = _a.proxyUrl, ignoreProxyUrlParams = _a.ignoreProxyUrlParams, coralogixDomain = _a.coralogixDomain, public_key = _a.public_key;
+        var headers = this.requestConfig.headers;
+        this.resolvedUrl = this.getResolvedUrl({
+            proxyUrl: proxyUrl,
+            ignoreProxyUrlParams: ignoreProxyUrlParams,
+            coralogixDomain: coralogixDomain,
+        });
         if (public_key) {
             headers['Authorization'] = "Bearer ".concat(public_key);
         }
@@ -3674,6 +3685,13 @@ var SessionManager = (function (_super) {
         enumerable: false,
         configurable: true
     });
+    Object.defineProperty(SessionManager.prototype, "fingerPrint", {
+        get: function () {
+            return this._fingerPrint;
+        },
+        enumerable: false,
+        configurable: true
+    });
     SessionManager.prototype.updateCurrentPage = function (fragment) {
         if (this.isIdleActive) {
             this._currentPageFragment = undefined;
@@ -3692,6 +3710,7 @@ var SessionManager = (function (_super) {
         this.startIdleListener();
         this.clearPrevSession();
         this.setSession();
+        this.setFingerPrint();
     };
     SessionManager.prototype.stop = function () {
         this.stopIdleListener();
@@ -3779,6 +3798,17 @@ var SessionManager = (function (_super) {
             sessionExpirationDate: now + SESSION_EXPIRATION_TIME,
         };
     };
+    SessionManager.prototype.setFingerPrint = function () {
+        var generateFingerPrint = function () { return generateUUID(); };
+        var storedFingerPrint = CxGlobal.localStorage.getItem(FINGER_PRINT_KEY);
+        if (storedFingerPrint) {
+            this._fingerPrint = storedFingerPrint;
+            return;
+        }
+        var newFingerPrint = generateFingerPrint();
+        CxGlobal.localStorage.setItem(FINGER_PRINT_KEY, newFingerPrint);
+        this._fingerPrint = newFingerPrint;
+    };
     return SessionManager;
 }(SessionIdle));
 
@@ -3935,7 +3965,7 @@ function resolveUrlBlueprinters(urlBlueprinters) {
     return resolvedUrlBlueprinters;
 }
 
-var SDK_VERSION = '2.8.9';
+var SDK_VERSION = '2.10.0';
 
 function shouldDropEvent(cxRumEvent, options) {
     if (isDocumentErrorWithoutMessage(cxRumEvent)) {
@@ -4050,6 +4080,7 @@ var CoralogixSpanMapProcessor = (function () {
         var eventTypeContext = this._getEventTypeContext(attributes, eventType, span);
         var _e = span.spanContext(), spanId = _e.spanId, traceId = _e.traceId;
         var resourceAttributes = __assign(__assign({}, (_a = span.resource) === null || _a === void 0 ? void 0 : _a.attributes), { 'service.name': application });
+        var fingerPrint = getSessionManager().fingerPrint;
         var labels = JSON.parse(attributes[CoralogixAttributes.CUSTOM_LABELS]);
         var isErrorWithStacktrace = !!((_b = eventTypeContext === null || eventTypeContext === void 0 ? void 0 : eventTypeContext.error_context) === null || _b === void 0 ? void 0 : _b.original_stacktrace);
         var version_metadata = {
@@ -4070,7 +4101,7 @@ var CoralogixSpanMapProcessor = (function () {
             severity: severity,
             timestamp: timestamp,
             text: {
-                cx_rum: __assign(__assign({ platform: 'browser', timestamp: timestamp }, eventTypeContext), { browser_sdk: {
+                cx_rum: __assign(__assign({ fingerPrint: fingerPrint, platform: 'browser', timestamp: timestamp }, eventTypeContext), { browser_sdk: {
                         version: SDK_VERSION,
                     }, version_metadata: version_metadata, session_context: __assign(__assign(__assign(__assign({}, user_context), { session_id: sessionId, session_creation_date: sessionCreationDate, prev_session: prevSessionId
                             ? {
@@ -4453,8 +4484,10 @@ var CoralogixRum = {
         var _a, _b;
         var _this = this;
         try {
-            if (isInited && (options === null || options === void 0 ? void 0 : options.debug)) {
-                console.debug('CoralogixRum already initialized, skipping init');
+            if (isInited) {
+                if (options === null || options === void 0 ? void 0 : options.debug) {
+                    console.debug('CoralogixRum already initialized, skipping init');
+                }
                 return;
             }
             if (!CxGlobal.sessionStorage) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coralogix/browser",
-  "version": "2.8.9",
+  "version": "2.10.0",
   "description": "Official Coralogix SDK for browsers",
   "license": "Apache-2.0",
   "author": "Coralogix",

package/src/Request.d.ts

@@ -7,6 +7,7 @@ export declare class Request {
     private resolvedUrl;
     private resolvedHeaders;
     constructor(requestConfig: RequestConfig);
+    private getResolvedUrl;
     private init;
     send(body: BodyInit): Promise<Response>;
 }

package/src/constants.d.ts

@@ -18,6 +18,7 @@ export declare const RUM_INTERNAL_DATA_KEY = "rumInternalData";
 export declare const MASKED_TEXT = "***";
 export declare const MASK_CLASS_DEFAULT = "cx-mask";
 export declare const MASK_INPUT_TYPES_DEFAULT: InputType[];
+export declare const FINGER_PRINT_KEY = "cx-fingerprint";
 export declare const OPTIONS_DEFAULTS: Partial<CoralogixBrowserSdkConfig>;
 export declare const INSTRUMENTATIONS: readonly InternalInstrumentationConfig[];
 export declare const CoralogixAttributes: {

package/src/session/sessionManager.d.ts

@@ -10,6 +10,7 @@ export declare class SessionManager extends SessionIdle {
     private _cachedLogsSent;
     private _currentPageFragment;
     private _currentPageTimestamp;
+    private _fingerPrint;
     private debugMode;
     constructor(recordConfig?: SessionRecordingConfig);
     get currentPageTimestamp(): number;
@@ -21,6 +22,7 @@ export declare class SessionManager extends SessionIdle {
     get instrumentationsToSend(): Partial<Record<CoralogixEventType, boolean>> | undefined;
     get cachedLogsSent(): boolean;
     get sessionHasError(): boolean;
+    get fingerPrint(): string | undefined;
     set sessionHasError(value: boolean);
     set cachedLogsSent(val: boolean);
     updateCurrentPage(fragment: string): void;
@@ -38,5 +40,6 @@ export declare class SessionManager extends SessionIdle {
     private clearSessionWithErrorMode;
     private handleRefreshedSessions;
     private createNewSession;
+    private setFingerPrint;
     setSession: (afterIdle?: boolean) => Session;
 }

package/src/types.d.ts

@@ -149,6 +149,7 @@ export interface CoralogixBrowserSdkConfig {
     maskClass?: string | RegExp;
     beforeSend?: (event: EditableCxRumEvent) => BeforeSendResult;
     proxyUrl?: string;
+    ignoreProxyUrlParams?: boolean;
     collectIPData?: boolean;
     trackSoftNavigations?: boolean;
     memoryUsageConfig?: MemoryUsageConfig;
@@ -324,6 +325,7 @@ export interface CxRumEvent extends EventTypeContext {
     isSnapshotEvent?: boolean;
     screenshot_context?: ScreenshotContext;
     screenshotId?: string;
+    fingerPrint: string;
 }
 export interface CxSpan {
     version_metadata: VersionMetaData;

package/src/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "2.8.9";
+export declare const SDK_VERSION = "2.10.0";