@coralogix/browser 3.21.1 → 3.22.0

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 3.22.0 (2026-08-13)
+
+### 🚀 Features
+
+- Support an explicit ingress URL via the new `coralogixDomainUrl` option, for accounts whose endpoint has no corresponding `coralogixDomain` key
+
+### 🩹 Fixes
+
+- Abort initialization with a clear message when `coralogixDomain` is not a recognized region, instead of sending data to an invalid endpoint
+
 ## 3.21.1 (2026-08-11)
 
 ### 🩹 Fixes

package/README.md

@@ -46,29 +46,30 @@
 
     - [ignoreProxyUrlParams](#ignoreproxyurlparams)
 
-24. [Collect IP Data](#collect-ip-data)
-25. [SDK Fetch Priority](#sdk-fetch-priority)
-26. [Custom Measurement](#custom-measurement)
-27. [Add Timing](#add-timing)
-28. [Custom Time Measurement](#custom-time-measurement)
-29. [Microfrontend Support](#microfrontend-support)
+24. [Ingress URL](#ingress-url)
+25. [Collect IP Data](#collect-ip-data)
+26. [SDK Fetch Priority](#sdk-fetch-priority)
+27. [Custom Measurement](#custom-measurement)
+28. [Add Timing](#add-timing)
+29. [Custom Time Measurement](#custom-time-measurement)
+30. [Microfrontend Support](#microfrontend-support)
 
     - [Pre Requisites](#pre-requisites)
 
-30. [Custom Spans](#custom-spans)
+31. [Custom Spans](#custom-spans)
 
     - [Ignored Instruments](#ignored-instruments)
 
-31. [OpenTelemetry Batch Configuration](#opentelemetry-batch-configuration)
-32. [Soft Navigations (Experimental)](#soft-navigations--experimental)
-33. [Memory Usage (Experimental)](#memory-usage---experimental)
-34. [Web Worker Support](#web-worker-support)
+32. [OpenTelemetry Batch Configuration](#opentelemetry-batch-configuration)
+33. [Soft Navigations (Experimental)](#soft-navigations--experimental)
+34. [Memory Usage (Experimental)](#memory-usage---experimental)
+35. [Web Worker Support](#web-worker-support)
 
     - [Enabling Web Worker Support](#enabling-web-worker-support)
     - [Examples](#examples)
 
-35. [Angular Zone.js Configuration](#angular-zonejs-configuration)
-36. [CDN](#cdn)
+36. [Angular Zone.js Configuration](#angular-zonejs-configuration)
+37. [CDN](#cdn)
 
     - [Specific Version](#specific-version-recommended)
     - [ES5](#es5)
@@ -77,7 +78,7 @@
       - [Via JS File](#via-js-file)
       - [Via TS File](#via-ts-file)
 
-37. [Flutter Web](#flutter-web)
+38. [Flutter Web](#flutter-web)
 
 ---
 
@@ -872,6 +873,29 @@ CoralogixRum.init({
 });
 ```
 
+### Ingress URL
+
+`coralogixDomain` resolves your account's ingress endpoint from the supported Coralogix regions and is
+the standard way to configure it. `coralogixDomainUrl` accepts an explicit ingress URL, for accounts
+whose endpoint has no corresponding `coralogixDomain` key:
+
+```javascript
+CoralogixRum.init({
+  // ...
+  coralogixDomainUrl: 'https://ingress.<region>.rum-ingress-coralogix.com',
+});
+```
+
+One of `coralogixDomain` or `coralogixDomainUrl` is required; initialization is aborted with a console
+error when neither is provided. When both are provided, `coralogixDomainUrl` takes precedence.
+
+The value must be an absolute `http(s)` URL with no query string or fragment: the SDK appends its
+endpoint paths to it, so a `?` or `#` would truncate the resulting request URL. A trailing slash is
+accepted and normalized.
+
+The option composes with [Proxy URL](#proxy-url): the configured ingress URL is the value the SDK
+places in the request's `cxforward` parameter.
+
 ### 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

@@ -1260,6 +1260,9 @@ function coerceArray(value) {
 function isObject(value) {
     return typeof value === 'object';
 }
+function hasOwn(object, key) {
+    return Object.prototype.hasOwnProperty.call(object, key);
+}
 function omit(object) {
     if (object === void 0) { object = {}; }
     var paths = [];
@@ -2986,7 +2989,7 @@ var CoralogixInternalInstrumentation = (function (_super) {
         span.setAttribute(CoralogixAttributes.SEVERITY, CoralogixLogSeverity.Info);
         switch (event) {
             case 'init': {
-                var config = omit(getSdkConfig(), 'public_key', 'coralogixDomain');
+                var config = omit(getSdkConfig(), 'public_key', 'coralogixDomain', 'coralogixDomainUrl');
                 data = this.stringifyConfig(config);
                 break;
             }
@@ -3133,7 +3136,6 @@ var MAX_CHARACTERS = 1024;
 var REQUIRED_CONFIG_KEYS = [
     'application',
     'version',
-    'coralogixDomain',
 ];
 var ID_MASK_KEY = '{id}';
 var UUID_REGEX = /[0-9a-fA-F-]{36}/g;
@@ -3316,6 +3318,8 @@ var CoralogixDomainsApiUrlMap = {
     AP3: 'https://ingress.ap3.rum-ingress-coralogix.com',
     STAGING: 'https://ingress.staging.rum-ingress-coralogix.com',
 };
+var ALLOWED_INGRESS_PROTOCOLS = ['http:', 'https:'];
+var TRAILING_SLASHES_REGEX = /\/+$/;
 var PROXY_CX_FORWARD_PARAMETER = 'cxforward';
 var CX_MAPPED_SPAN = 'cx_mapped_span';
 var BASE_PATH = '/';
@@ -4026,21 +4030,31 @@ var Request = (function () {
         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);
+        var proxyUrl = config.proxyUrl, ignoreProxyUrlParams = config.ignoreProxyUrlParams;
+        var cxEndpoint = "".concat(this.getIngressBaseUrl(config)).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.getIngressBaseUrl = function (config) {
+        var coralogixDomain = config.coralogixDomain, coralogixDomainUrl = config.coralogixDomainUrl;
+        if (coralogixDomainUrl) {
+            return coralogixDomainUrl.replace(TRAILING_SLASHES_REGEX, '');
+        }
+        return coralogixDomain && hasOwn(CoralogixDomainsApiUrlMap, coralogixDomain)
+            ? CoralogixDomainsApiUrlMap[coralogixDomain]
+            : '';
+    };
     Request.prototype.init = function () {
-        var _a = getSdkConfig(), proxyUrl = _a.proxyUrl, ignoreProxyUrlParams = _a.ignoreProxyUrlParams, coralogixDomain = _a.coralogixDomain, public_key = _a.public_key, sdkFetchPriority = _a.sdkFetchPriority;
+        var _a = getSdkConfig(), proxyUrl = _a.proxyUrl, ignoreProxyUrlParams = _a.ignoreProxyUrlParams, coralogixDomain = _a.coralogixDomain, coralogixDomainUrl = _a.coralogixDomainUrl, public_key = _a.public_key, sdkFetchPriority = _a.sdkFetchPriority;
         var headers = this.requestConfig.headers;
         this.resolvedUrl = this.getResolvedUrl({
             proxyUrl: proxyUrl,
             ignoreProxyUrlParams: ignoreProxyUrlParams,
             coralogixDomain: coralogixDomain,
+            coralogixDomainUrl: coralogixDomainUrl,
         });
         if (public_key) {
             headers['Authorization'] = "Bearer ".concat(public_key);
@@ -5084,8 +5098,39 @@ function isInitialConfigValid(initConfig) {
         }
         finally { if (e_1) throw e_1.error; }
     }
+    if (!isIngressConfigValid(initConfig)) {
+        return;
+    }
     return true;
 }
+function isIngressConfigValid(_a) {
+    var coralogixDomain = _a.coralogixDomain, coralogixDomainUrl = _a.coralogixDomainUrl;
+    if (coralogixDomainUrl) {
+        if (isIngressUrlValid(coralogixDomainUrl)) {
+            return true;
+        }
+        console.error("CoralogixRum: Initialization aborted. \"coralogixDomainUrl\" must be an absolute http(s) URL with no query string or fragment, e.g. \"https://ingress.my-domain.com\". Received \"".concat(coralogixDomainUrl, "\"."));
+        return false;
+    }
+    if (!coralogixDomain) {
+        console.error('CoralogixRum: Initialization aborted. Please provide either "coralogixDomain" or "coralogixDomainUrl".');
+        return false;
+    }
+    if (!hasOwn(CoralogixDomainsApiUrlMap, coralogixDomain)) {
+        console.error("CoralogixRum: Initialization aborted. Unknown \"coralogixDomain\" value \"".concat(coralogixDomain, "\". Use one of: ").concat(Object.keys(CoralogixDomainsApiUrlMap).join(', '), " \u2014 or set \"coralogixDomainUrl\" to your ingress URL."));
+        return false;
+    }
+    return true;
+}
+function isIngressUrlValid(url) {
+    try {
+        var _a = new URL(url), protocol = _a.protocol, search = _a.search, hash = _a.hash;
+        return ALLOWED_INGRESS_PROTOCOLS.includes(protocol) && !search && !hash;
+    }
+    catch (_b) {
+        return false;
+    }
+}
 function validateAndResolveInitConfig(config) {
     var _a, _b, _c, _d;
     if (!isInitialConfigValid(config)) {
@@ -5131,7 +5176,7 @@ function resolveUrlBlueprinters(urlBlueprinters) {
     return resolvedUrlBlueprinters;
 }
 
-var SDK_VERSION = '3.21.1';
+var SDK_VERSION = '3.22.0';
 
 function shouldDropEvent(cxRumEvent, options) {
     if (isDocumentErrorWithoutMessage(cxRumEvent)) {

package/package.json

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

package/src/Request.d.ts

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

package/src/constants.d.ts

@@ -76,6 +76,8 @@ export declare const CoralogixDomainsApiUrlMap: {
     AP3: string;
     STAGING: string;
 };
+export declare const ALLOWED_INGRESS_PROTOCOLS: string[];
+export declare const TRAILING_SLASHES_REGEX: RegExp;
 export declare const PROXY_CX_FORWARD_PARAMETER = "cxforward";
 export declare const CX_MAPPED_SPAN = "cx_mapped_span";
 export declare const BASE_PATH = "/";

package/src/types.d.ts

@@ -142,7 +142,8 @@ export interface OtelConfig {
 export interface CoralogixBrowserSdkConfig {
     public_key?: string;
     application: string;
-    coralogixDomain: CoralogixDomain;
+    coralogixDomain?: CoralogixDomain;
+    coralogixDomainUrl?: string;
     version: string;
     user_context?: UserContextConfig;
     debug?: boolean;

package/src/utils/object.d.ts

@@ -1,4 +1,5 @@
 export declare function isObject(value: unknown): boolean;
+export declare function hasOwn(object: object, key: PropertyKey): boolean;
 type NestedKeyOf<ObjectType extends Record<string, any>> = {
     [Key in keyof ObjectType & (string | number)]: ObjectType[Key] extends object ? `${Key}` | `${Key}.${NestedKeyOf<ObjectType[Key]>}` : `${Key}`;
 }[keyof ObjectType & (string | number)];

package/src/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "3.21.1";
+export declare const SDK_VERSION = "3.22.0";