@kubesense/kubesense-browser-core 1.7.0 → 2.0.0-beta.0

package/cjs/domain/bufferedData.js

@@ -1,22 +1,44 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.startBufferingData = startBufferingData;
-const observable_1 = require("../tools/observable");
-const trackRuntimeError_1 = require("./error/trackRuntimeError");
+const require_observable = require("../tools/observable.js");
+const require_mockable = require("../tools/mockable.js");
+const require_telemetry = require("./telemetry/telemetry.js");
+const require_trackRuntimeError = require("./error/trackRuntimeError.js");
+const require_xhrObservable = require("../browser/xhrObservable.js");
+const require_fetchObservable = require("../browser/fetchObservable.js");
+const require_consoleObservable = require("./console/consoleObservable.js");
+let _kubesense_kubesense_js_core_util = require("@kubesense/kubesense-js-core/util");
+//#region src/domain/bufferedData.ts
 const BUFFER_LIMIT = 500;
-function startBufferingData(trackRuntimeErrorImpl = trackRuntimeError_1.trackRuntimeError) {
-    const observable = new observable_1.BufferedObservable(BUFFER_LIMIT);
-    const runtimeErrorSubscription = trackRuntimeErrorImpl().subscribe((error) => {
-        observable.notify({
-            type: 0 /* BufferedDataType.RUNTIME_ERROR */,
-            error,
-        });
-    });
-    return {
-        observable,
-        stop: () => {
-            runtimeErrorSubscription.unsubscribe();
-        },
-    };
+let BufferedDataType = /* @__PURE__ */ function(BufferedDataType) {
+	BufferedDataType[BufferedDataType["RUNTIME_ERROR"] = 0] = "RUNTIME_ERROR";
+	BufferedDataType[BufferedDataType["FETCH"] = 1] = "FETCH";
+	BufferedDataType[BufferedDataType["XHR"] = 2] = "XHR";
+	BufferedDataType[BufferedDataType["CONSOLE"] = 3] = "CONSOLE";
+	return BufferedDataType;
+}({});
+function startBufferingData() {
+	const observable = new require_observable.BufferedObservable(BUFFER_LIMIT, (count) => {
+		require_telemetry.addTelemetryDebug("Early data collection dropped data on unbuffer", { count });
+	});
+	const subscriptions = [];
+	function subscribe(type, source) {
+		subscriptions.push(source.subscribe((data) => {
+			observable.notify({
+				type,
+				data
+			});
+		}));
+	}
+	subscribe(0, require_mockable.mockable(require_trackRuntimeError.trackRuntimeError)());
+	subscribe(1, require_fetchObservable.initFetchObservable());
+	subscribe(2, require_xhrObservable.initXhrObservable());
+	subscribe(3, require_consoleObservable.initConsoleObservable(Object.values(_kubesense_kubesense_js_core_util.ConsoleApiName)));
+	return {
+		observable,
+		stop: () => subscriptions.forEach((subscription) => subscription.unsubscribe())
+	};
 }
+//#endregion
+exports.BufferedDataType = BufferedDataType;
+exports.startBufferingData = startBufferingData;
+
 //# sourceMappingURL=bufferedData.js.map

package/cjs/domain/bufferedData.js.map

@@ -1 +1 @@
-{"version":3,"file":"bufferedData.js","sourceRoot":"","sources":["../../src/domain/bufferedData.ts"],"names":[],"mappings":";;AAeA,gDAgBC;AA/BD,oDAAwD;AAExD,iEAA6D;AAE7D,MAAM,YAAY,GAAG,GAAG,CAAA;AAWxB,SAAgB,kBAAkB,CAAC,qBAAqB,GAAG,qCAAiB;IAC1E,MAAM,UAAU,GAAG,IAAI,+BAAkB,CAAe,YAAY,CAAC,CAAA;IAErE,MAAM,wBAAwB,GAAG,qBAAqB,EAAE,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;QAC3E,UAAU,CAAC,MAAM,CAAC;YAChB,IAAI,wCAAgC;YACpC,KAAK;SACN,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,OAAO;QACL,UAAU;QACV,IAAI,EAAE,GAAG,EAAE;YACT,wBAAwB,CAAC,WAAW,EAAE,CAAA;QACxC,CAAC;KACF,CAAA;AACH,CAAC"}
+{"version":3,"file":"bufferedData.js","names":["BufferedObservable","mockable","trackRuntimeError","initFetchObservable","initXhrObservable","initConsoleObservable","ConsoleApiName"],"sources":["../../src/domain/bufferedData.ts"],"sourcesContent":["import { ConsoleApiName } from '@kubesense/kubesense-js-core/util'\nimport type { Observable, Subscription } from '../tools/observable'\nimport { BufferedObservable } from '../tools/observable'\nimport { mockable } from '../tools/mockable'\nimport type { FetchContext } from '../browser/fetchObservable'\nimport { initFetchObservable } from '../browser/fetchObservable'\nimport type { XhrContext } from '../browser/xhrObservable'\nimport { initXhrObservable } from '../browser/xhrObservable'\nimport { addTelemetryDebug } from './telemetry'\nimport type { RawError } from './error/error.types'\nimport { trackRuntimeError } from './error/trackRuntimeError'\nimport type { ConsoleLog } from './console/consoleObservable'\nimport { initConsoleObservable } from './console/consoleObservable'\n\nconst BUFFER_LIMIT = 500\n\nexport const enum BufferedDataType {\n  RUNTIME_ERROR,\n  FETCH,\n  XHR,\n  CONSOLE,\n}\n\nexport type BufferedData =\n  | { type: BufferedDataType.RUNTIME_ERROR; data: RawError }\n  | { type: BufferedDataType.FETCH; data: FetchContext }\n  | { type: BufferedDataType.XHR; data: XhrContext }\n  | { type: BufferedDataType.CONSOLE; data: ConsoleLog }\n\nexport function startBufferingData() {\n  const observable = new BufferedObservable<BufferedData>(BUFFER_LIMIT, (count) => {\n    // monitor-until: 2026-10-14\n    addTelemetryDebug('Early data collection dropped data on unbuffer', {\n      count,\n    })\n  })\n  const subscriptions: Subscription[] = []\n\n  function subscribe<T extends BufferedDataType>(\n    type: T,\n    source: Observable<Extract<BufferedData, { type: T }>['data']>\n  ) {\n    subscriptions.push(\n      source.subscribe((data) => {\n        observable.notify({ type, data } as BufferedData)\n      })\n    )\n  }\n\n  subscribe(BufferedDataType.RUNTIME_ERROR, mockable(trackRuntimeError)())\n  subscribe(BufferedDataType.FETCH, initFetchObservable())\n  subscribe(BufferedDataType.XHR, initXhrObservable())\n  subscribe(BufferedDataType.CONSOLE, initConsoleObservable(Object.values(ConsoleApiName)))\n\n  return {\n    observable,\n    stop: () => subscriptions.forEach((subscription) => subscription.unsubscribe()),\n  }\n}\n"],"mappings":";;;;;;;;;AAcA,MAAM,eAAe;AAErB,IAAkB,mBAAX,yBAAA,kBAAA;CACL,iBAAA,iBAAA,mBAAA,KAAA;CACA,iBAAA,iBAAA,WAAA,KAAA;CACA,iBAAA,iBAAA,SAAA,KAAA;CACA,iBAAA,iBAAA,aAAA,KAAA;;AACF,EAAA,CAAA,CAAA;AAQA,SAAgB,qBAAqB;CACnC,MAAM,aAAa,IAAIA,mBAAAA,mBAAiC,eAAe,UAAU;EAE/E,kBAAA,kBAAkB,kDAAkD,EAClE,MACF,CAAC;CACH,CAAC;CACD,MAAM,gBAAgC,CAAC;CAEvC,SAAS,UACP,MACA,QACA;EACA,cAAc,KACZ,OAAO,WAAW,SAAS;GACzB,WAAW,OAAO;IAAE;IAAM;GAAK,CAAiB;EAClD,CAAC,CACH;CACF;CAEA,UAAA,GAA0CC,iBAAAA,SAASC,0BAAAA,iBAAiB,CAAC,CAAC,CAAC;CACvE,UAAA,GAAkCC,wBAAAA,oBAAoB,CAAC;CACvD,UAAA,GAAgCC,sBAAAA,kBAAkB,CAAC;CACnD,UAAA,GAAoCC,0BAAAA,sBAAsB,OAAO,OAAOC,kCAAAA,cAAc,CAAC,CAAC;CAExF,OAAO;EACL;EACA,YAAY,cAAc,SAAS,iBAAiB,aAAa,YAAY,CAAC;CAChF;AACF"}

package/cjs/domain/configuration/configuration.d.ts

@@ -1,9 +1,7 @@
-import type { SessionStoreStrategyType } from '../session/storeStrategies/sessionStoreStrategy';
+import type { ProxyFn, Site } from '@kubesense/kubesense-js-core/transport';
+import type { InferredConfig, MatchOption } from '@kubesense/kubesense-js-core/configuration';
 import { TrackingConsent } from '../trackingConsent';
 import type { SessionPersistence } from '../session/sessionConstants';
-import type { MatchOption } from '../../tools/matchOption';
-import type { TransportConfiguration } from './transportConfiguration';
-import type { Site } from '../intakeSites';
 /**
  * Default privacy level for the browser SDK.
  *
@@ -42,7 +40,7 @@ export interface InitConfiguration {
     /**
      * A callback function that can be used to modify events before they are sent to KubeSense.
      *
-     *  @category Data Collection
+     * @category Data Collection
      */
     beforeSend?: GenericBeforeSendCallback | undefined;
     /**
@@ -61,38 +59,38 @@ export interface InitConfiguration {
     telemetrySampleRate?: number | undefined;
     /**
      * Initialization fails silently if the RUM Browser SDK is already initialized on the page.
+     *
      * @defaultValue false
      */
     silentMultipleInit?: boolean | undefined;
     /**
-     * Which storage strategy to use for persisting sessions. Can be either 'cookie' or 'local-storage'.
+     * Which storage strategy to use for persisting sessions. Can be 'cookie', 'local-storage', or 'memory'.
+     * When an array is provided, the SDK will attempt each persistence type in the order specified.
      *
      * Important: If you are using the RUM and Logs Browser SDKs, this option must be configured with identical values
      *
-     * @category Session Persistence
-     * @defaultValue "cookie"
-     */
-    sessionPersistence?: SessionPersistence | undefined;
-    /**
-     * Allows the use of localStorage when cookies cannot be set. This enables the RUM Browser SDK to run in environments that do not provide cookie support.
+     * Note: 'memory' option is only for use with single-page applications. All page loads will start a new session, likely resulting in an increase in total number of RUM sessions
      *
-     * Important: If you are using the RUM and Logs Browser SDKs, this option must be configured with identical values
      * @category Session Persistence
-     * @deprecated use `sessionPersistence: local-storage` where you want to use localStorage instead
+     * @defaultValue "cookie"
      */
-    allowFallbackToLocalStorage?: boolean | undefined;
+    sessionPersistence?: SessionPersistence | SessionPersistence[] | undefined;
     /**
      * Allow listening to DOM events dispatched programmatically ([untrusted events](https://developer.mozilla.org/en-US/docs/Web/API/Event/isTrusted)). Enabling this option can be useful if you heavily rely on programmatic events, such as in an automated UI test environment.
+     *
      * @defaultValue false
      */
     allowUntrustedEvents?: boolean | undefined;
     /**
      * Store global context and user context in localStorage to preserve them along the user navigation.
+     * See [Contexts life cycle](https://docs.kubesense.ai/real_user_monitoring/browser/advanced_configuration/?tab=npm#contexts-life-cycle) for further information.
+     *
      * @defaultValue false
      */
     storeContextsAcrossPages?: boolean | undefined;
     /**
      * Set the initial user tracking consent state.
+     * See [User tracking consent](https://docs.kubesense.ai/real_user_monitoring/browser/advanced_configuration/?tab=npm#user-tracking-consent) for further information.
      *
      * @category Privacy
      * @defaultValue granted
@@ -106,38 +104,41 @@ export interface InitConfiguration {
     allowedTrackingOrigins?: MatchOption[] | undefined;
     /**
      * Optional proxy URL, for example: https://www.proxy.com/path.
+     * See [Proxy Your Browser RUM Data](https://docs.kubesense.ai/real_user_monitoring/guide/proxy-rum-data) for further information.
      *
      * @category Transport
      */
     proxy?: string | ProxyFn | undefined;
     /**
+     * The KubeSense RUM intake host that events are sent to, for example `us2.kubesense.ai`.
      *
      * @category Transport
-     * @defaultValue rum.kubesense.ai
+     * @defaultValue us2.kubesense.ai
      */
-    kubesenseRumEndpoint?: Site | undefined | null;
+    kubesenseRumEndpoint?: Site | undefined;
     /**
-     * The service name for your application.
+     * The service name for your application. Follows the [tag syntax requirements](https://docs.kubesense.ai/getting_started/tagging/#define-tags).
      *
-     *  @category Data Collection
+     * @category Data Collection
      */
     service?: string | undefined | null;
     /**
-     * The application’s environment, for example: prod, pre-prod, and staging.
+     * The application’s environment, for example: prod, pre-prod, and staging. Follows the [tag syntax requirements](https://docs.kubesense.ai/getting_started/tagging/#define-tags).
      *
-     *  @category Data Collection
+     * @category Data Collection
      */
     env?: string | undefined | null;
     /**
-     * The application’s version, for example: 1.2.3, 6c44da20, and 2020.02.13.
+     * The application’s version, for example: 1.2.3, 6c44da20, and 2020.02.13. Follows the [tag syntax requirements](https://docs.kubesense.ai/getting_started/tagging/#define-tags).
      *
-     *  @category Data Collection
+     * @category Data Collection
      */
     version?: string | undefined | null;
     /**
      * Use a partitioned secure cross-site session cookie. This allows the RUM Browser SDK to run when the site is loaded from another one (iframe). Implies `useSecureSessionCookie`.
      *
      * Important: If you are using the RUM and Logs Browser SDKs, this option must be configured with identical values
+     *
      * @category Session Persistence
      * @defaultValue false
      */
@@ -146,6 +147,7 @@ export interface InitConfiguration {
      * Use a secure session cookie. This disables RUM events sent on insecure (non-HTTPS) connections.
      *
      * Important: If you are using the RUM and Logs Browser SDKs, this option must be configured with identical values
+     *
      * @category Session Persistence
      * @defaultValue false
      */
@@ -154,52 +156,46 @@ export interface InitConfiguration {
      * Preserve the session across subdomains for the same site.
      *
      * Important: If you are using the RUM and Logs Browser SDKs, this option must be configured with identical values
+     *
      * @category Session Persistence
      * @defaultValue false
      */
     trackSessionAcrossSubdomains?: boolean | undefined;
     /**
      * Track anonymous user for the same site and extend cookie expiration date
+     *
      * @category Data Collection
      * @defaultValue true
      */
     trackAnonymousUser?: boolean | undefined;
-    /**
-     * Encode cookie options in the cookie value. This can be used as a mitigation for microssession issues.
-     * ⚠️ This is a beta feature and may be changed or removed in the future.
-     *
-     * @category Beta
-     * @defaultValue false
-     */
-    betaEncodeCookieOptions?: boolean | undefined;
     /**
      * [Internal option] Enable experimental features
+     *
      * @internal
      */
     enableExperimentalFeatures?: string[] | undefined;
     /**
      * [Internal option] Configure the dual shipping to another datacenter
+     *
      * @internal
      */
-    replica?: ReplicaUserConfiguration | undefined;
+    replica?: ReplicaInitConfiguration | undefined;
     /**
      * [Internal option] Set the datacenter from where the data is dual shipped
+     *
      * @internal
      */
     datacenter?: string;
-    /**
-     * [Internal option] KubeSense internal analytics subdomain
-     * @internal
-     */
-    internalAnalyticsSubdomain?: string;
     /**
      * [Internal option] The percentage of telemetry configuration sent. A value between 0 and 100.
+     *
      * @internal
      * @defaultValue 5
      */
     telemetryConfigurationSampleRate?: number;
     /**
      * [Internal option] The percentage of telemetry usage sent. A value between 0 and 100.
+     *
      * @internal
      * @defaultValue 5
      */
@@ -211,53 +207,152 @@ export interface InitConfiguration {
      */
     source?: 'browser' | 'flutter' | 'unity' | undefined;
     /**
-    * [Internal option] Additional configuration for the SDK.
-    *
-    * @internal
-    */
+     * [Internal option] Additional configuration for the SDK.
+     *
+     * @internal
+     */
     sdkVersion?: string | undefined;
     /**
-    * [Internal option] Additional configuration for the SDK.
-    *
-    * @internal
-    */
+     * [Internal option] Additional configuration for the SDK.
+     *
+     * @internal
+     */
     variant?: string | undefined;
 }
 type GenericBeforeSendCallback = (event: any, context?: any) => unknown;
 /**
- * path: /api/vX/product
- * parameters: xxx=yyy&zzz=aaa
+ * @internal
  */
-export type ProxyFn = (options: {
-    path: string;
-    parameters: string;
-}) => string;
-export interface ReplicaUserConfiguration {
+export interface ReplicaInitConfiguration {
     applicationId?: string;
     clientToken: string;
 }
-export interface Configuration extends TransportConfiguration {
-    beforeSend: GenericBeforeSendCallback | undefined;
-    sessionStoreStrategyType: SessionStoreStrategyType | undefined;
-    sessionSampleRate: number;
-    telemetrySampleRate: number;
-    telemetryConfigurationSampleRate: number;
-    telemetryUsageSampleRate: number;
-    service: string | undefined;
-    version?: string | undefined;
-    env?: string | undefined;
-    silentMultipleInit: boolean;
-    allowUntrustedEvents: boolean;
-    trackingConsent: TrackingConsent;
-    storeContextsAcrossPages: boolean;
-    trackAnonymousUser?: boolean;
-    betaEncodeCookieOptions: boolean;
-    sdkVersion: string | undefined;
-    source: 'browser' | 'flutter' | 'unity';
-    variant: string | undefined;
-}
-export declare function isSampleRate(sampleRate: unknown, name: string): boolean;
-export declare function validateAndBuildConfiguration(initConfiguration: InitConfiguration, errorStack?: string): Configuration | undefined;
+export type SdkSource = 'browser' | 'flutter' | 'unity';
+export declare const BROWSER_CORE_SCHEMA: {
+    readonly clientToken: {
+        readonly type: "string";
+        readonly required: true;
+    };
+    readonly service: {
+        readonly type: "string";
+    };
+    readonly env: {
+        readonly type: "string";
+    };
+    readonly version: {
+        readonly type: "string";
+    };
+    readonly kubesenseRumEndpoint: {
+        readonly type: "site";
+        readonly default: string;
+    };
+    readonly proxy: {
+        readonly type: "union";
+        readonly variants: readonly [{
+            readonly type: "string";
+        }, {
+            readonly type: "function";
+            readonly signature: ProxyFn | undefined;
+        }];
+    };
+    readonly sessionSampleRate: {
+        readonly type: "percentage";
+        readonly default: 100;
+    };
+    readonly telemetrySampleRate: {
+        readonly type: "percentage";
+        readonly default: 20;
+    };
+    readonly telemetryConfigurationSampleRate: {
+        readonly type: "percentage";
+        readonly default: 5;
+    };
+    readonly telemetryUsageSampleRate: {
+        readonly type: "percentage";
+        readonly default: 5;
+    };
+    readonly silentMultipleInit: {
+        readonly type: "boolean";
+        readonly default: false;
+        readonly strict: false;
+    };
+    readonly storeContextsAcrossPages: {
+        readonly type: "boolean";
+        readonly default: false;
+        readonly strict: false;
+    };
+    readonly trackAnonymousUser: {
+        readonly type: "boolean";
+        readonly default: true;
+        readonly strict: false;
+    };
+    readonly useSecureSessionCookie: {
+        readonly type: "boolean";
+        readonly default: false;
+        readonly strict: false;
+    };
+    readonly usePartitionedCrossSiteSessionCookie: {
+        readonly type: "boolean";
+        readonly default: false;
+        readonly strict: false;
+    };
+    readonly trackSessionAcrossSubdomains: {
+        readonly type: "boolean";
+        readonly default: false;
+        readonly strict: false;
+    };
+    readonly allowedTrackingOrigins: {
+        readonly type: "match-option";
+        readonly multiple: true;
+        readonly strict: false;
+    };
+    readonly trackingConsent: {
+        readonly type: "enum";
+        readonly values: {
+            readonly GRANTED: "granted";
+            readonly NOT_GRANTED: "not-granted";
+        };
+        readonly default: "granted";
+    };
+    readonly beforeSend: {
+        readonly type: "function";
+        readonly signature: GenericBeforeSendCallback | undefined;
+    };
+    readonly source: {
+        readonly type: "enum";
+        readonly values: readonly ["browser", "flutter", "unity"];
+        readonly default: "browser";
+        readonly strict: false;
+    };
+    readonly sessionPersistence: {
+        readonly type: "enum";
+        readonly values: readonly ["cookie", "local-storage", "memory"];
+        readonly multiple: true;
+        readonly strict: false;
+    };
+    readonly replica: {
+        readonly type: "schema";
+        readonly schema: {
+            readonly clientToken: {
+                readonly type: "string";
+                readonly required: true;
+            };
+            readonly applicationId: {
+                readonly type: "string";
+            };
+        };
+    };
+    readonly datacenter: {
+        readonly type: "string";
+    };
+    readonly sdkVersion: {
+        readonly type: "string";
+    };
+    readonly variant: {
+        readonly type: "string";
+    };
+};
+export type Configuration = InferredConfig<typeof BROWSER_CORE_SCHEMA>;
 export declare function serializeConfiguration(initConfiguration: InitConfiguration): {
     session_sample_rate: number | undefined;
     telemetry_sample_rate: number | undefined;
@@ -271,12 +366,10 @@ export declare function serializeConfiguration(initConfiguration: InitConfigurat
     track_session_across_subdomains: boolean | undefined;
     track_anonymous_user: boolean | undefined;
     session_persistence: SessionPersistence | undefined;
-    allow_fallback_to_local_storage: boolean;
     store_contexts_across_pages: boolean;
     allow_untrusted_events: boolean;
     tracking_consent: TrackingConsent | undefined;
     use_allowed_tracking_origins: boolean;
-    beta_encode_cookie_options: boolean | undefined;
     source: "browser" | "flutter" | "unity" | undefined;
     sdk_version: string | undefined;
     variant: string | undefined;