@kubesense/kubesense-browser-rum-core 1.0.0

package/cjs/boot/rumPublicApi.d.ts

@@ -0,0 +1,409 @@
+import type { Context, DeflateWorker, DeflateEncoderStreamId, DeflateEncoder, PublicApi, ContextManager, TrackingConsent, User, Account, RumInternalContext, Telemetry, Encoder } from '@kubesense/kubesense-browser-core';
+import type { LifeCycle } from '../domain/lifeCycle';
+import type { ViewHistory } from '../domain/contexts/viewHistory';
+import type { RumSessionManager } from '../domain/rumSessionManager';
+import type { ReplayStats } from '../rawRumEvent.types';
+import type { RumConfiguration, RumInitConfiguration } from '../domain/configuration';
+import type { ViewOptions } from '../domain/view/trackViews';
+import type { AddDurationVitalOptions, DurationVitalReference, DurationVitalOptions, FeatureOperationOptions, FailureReason } from '../domain/vital/vitalCollection';
+import type { Hooks } from '../domain/hooks';
+import type { SdkName } from '../domain/contexts/defaultContext';
+import type { LongTaskContexts } from '../domain/longTask/longTaskCollection';
+import type { StartRum, StartRumResult } from './startRum';
+export interface StartRecordingOptions {
+    force: boolean;
+}
+/**
+ * Public API for the RUM browser SDK.
+ *
+ * @category Main
+ */
+export interface RumPublicApi extends PublicApi {
+    /**
+     * Init the RUM browser SDK.
+     *
+     * @category Init
+     * @param initConfiguration - Configuration options of the SDK
+     * @example
+     * ```ts
+     * kubesenseSdk.init({
+     *   applicationId: '<KUBESENSE_APPLICATION_ID>',
+     *   clientToken: '<KUBESENSE_CLIENT_TOKEN>',
+     *   kubesenseRumEndpoint: '<KUBESENSE_RUM_ENDPOINT>',
+     *   // ...
+     * })
+     * ```
+     *
+     */
+    init: (initConfiguration: RumInitConfiguration) => void;
+    /**
+     * Set the tracking consent of the current user.
+     *
+     *
+     * Data will be sent only if it is set to "granted". This value won't be stored by the library
+     * across page loads: you will need to call this method or set the appropriate `trackingConsent`
+     * field in the init() method at each page load.
+     *
+     * If this method is called before the init() method, the provided value will take precedence
+     * over the one provided as initialization parameter.
+     *
+     * *
+     * @category Privacy
+     * @param trackingConsent - The user tracking consent
+     */
+    setTrackingConsent: (trackingConsent: TrackingConsent) => void;
+    /**
+     * Set View Name.
+     *
+     * Enable to manually change the name of the current view.
+     * @category Context - View
+     * @param name name of the view
+     */
+    setViewName: (name: string) => void;
+    /**
+     * Set View Context.
+     *
+     * Enable to manually set the context of the current view.
+     * @category Context - View
+     * @param context context of the view
+     */
+    setViewContext: (context: Context) => void;
+    /**
+     * Set View Context Property.
+     *
+     * Enable to manually set a property of the context of the current view.
+     * @category Context - View
+     * @param key - key of the property
+     * @param value - value of the property
+     */
+    setViewContextProperty: (key: string, value: any) => void;
+    /**
+     * Get View Context.
+     * @category Context - View
+     *
+     */
+    getViewContext(): Context;
+    /**
+     * Set the global context information to all events, stored in `@context`
+     *
+     * @category internal - View
+     * @param context Global context
+     *
+     */
+    getInternalContext: (startTime?: number) => RumInternalContext | undefined;
+    /**
+     * Get the init configuration
+     */
+    getInitConfiguration: () => RumInitConfiguration | undefined;
+    /**
+     * Add a custom action, stored in `@action`
+     * @category Data Collection
+     * @param name Name of the action
+     * @param context Context of the action
+     *
+     */
+    addAction: (name: string, context?: object) => void;
+    /**
+     * Add a custom error, stored in `@error`.
+     * @category Data Collection
+     * @param error Error. Favor sending a [Javascript Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) to have a stack trace attached to the error event.
+     * @param context Context of the error
+     *
+     */
+    addError: (error: unknown, context?: object) => void;
+    /**
+     * Add a custom timing relative to the start of the current view,
+     * stored in `@view.custom_timings.<timing_name>`
+     *
+     * @category Data Collection
+     * @param name Name of the custom timing
+     * @param [time] Epoch timestamp of the custom timing (if not set, will use current time)
+     *
+     * Note: passing a relative time is discouraged since it is actually used as-is but displayed relative to the view start.
+     * We currently don't provide a way to retrieve the view start time, so it can be challenging to provide a timing relative to the view start.
+     */
+    addTiming: (name: string, time?: number) => void;
+    /**
+     * Set the global context information to all events, stored in `@context`
+     * See [Global context](https://docs.kubesense.ai/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.
+     *
+     * @category Context - Global Context
+     * @param context - Global context
+     */
+    setGlobalContext: (context: Context) => void;
+    /**
+     * Get the global Context
+     *
+     * See [Global context](https://docs.kubesense.ai/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.
+     *
+     * @category Context - Global Context
+     */
+    getGlobalContext: () => Context;
+    /**
+     * Set or update a global context property, stored in `@context.<key>`
+     *
+     * See [Global context](https://docs.kubesense.ai/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.
+     *
+     * @category Context - Global Context
+     * @param key - Key of the property
+     * @param value - Value of the property
+     */
+    setGlobalContextProperty: (key: any, value: any) => void;
+    /**
+     * Remove a global context property
+     *
+     * See [Global context](https://docs.kubesense.ai/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.
+     *
+     * @category Context - Global Context
+     */
+    removeGlobalContextProperty: (key: any) => void;
+    /**
+     * Clear the global context
+     *
+     * See [Global context](https://docs.kubesense.ai/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.
+     *
+     * @category Context - Global Context
+     */
+    clearGlobalContext(): void;
+    /**
+     * Set user information to all events, stored in `@usr`
+     *
+     * See [User session](https://docs.kubesense.ai/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.
+     *
+     * @category Context - User
+     * @param newUser - User information
+     */
+    setUser(newUser: User & {
+        id: string;
+    }): void;
+    /**
+     * Set user information to all events, stored in `@usr`
+     *
+     * @category Context - User
+     * @deprecated You must specify a user id, favor using {@link setUser} instead
+     * @param newUser - User information with optional id
+     */
+    setUser(newUser: User): void;
+    /**
+     * Get user information
+     *
+     * See [User session](https://docs.kubesense.ai/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.
+     *
+     * @category Context - User
+     * @returns User information
+     */
+    getUser: () => Context;
+    /**
+     * Set or update the user property, stored in `@usr.<key>`
+     *
+     * See [User session](https://docs.kubesense.ai/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.
+     *
+     * @category Context - User
+     * @param key - Key of the property
+     * @param property - Value of the property
+     */
+    setUserProperty: (key: any, property: any) => void;
+    /**
+     * Remove a user property
+     *
+     * @category Context - User
+     * @param key - Key of the property to remove
+     * @see [User session](https://docs.kubesense.ai/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.
+     */
+    removeUserProperty: (key: any) => void;
+    /**
+     * Clear all user information
+     *
+     * See [User session](https://docs.kubesense.ai/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.
+     *
+     * @category Context - User
+     */
+    clearUser: () => void;
+    /**
+     * Set account information to all events, stored in `@account`
+     *
+     * @category Context - Account
+     * @param newAccount - Account information
+     */
+    setAccount: (newAccount: Account) => void;
+    /**
+     * Get account information
+     *
+     * @category Context - Account
+     * @returns Account information
+     */
+    getAccount: () => Context;
+    /**
+     * Set or update the account property, stored in `@account.<key>`
+     *
+     * @category Context - Account
+     * @param key - Key of the property
+     * @param property - Value of the property
+     */
+    setAccountProperty: (key: string, property: any) => void;
+    /**
+     * Remove an account property
+     *
+     * @category Context - Account
+     * @param key - Key of the property to remove
+     */
+    removeAccountProperty: (key: string) => void;
+    /**
+     * Clear all account information
+     *
+     * @category Context - Account
+     * @returns Clear all account information
+     */
+    clearAccount: () => void;
+    /**
+     * Start a view manually.
+     * Enable to manual start a view, use `trackViewsManually: true` init parameter and call `startView()` to create RUM views and be aligned with how you’ve defined them in your SPA application routing.
+     *
+     * See [Override default RUM view names](https://docs.kubesense.ai/real_user_monitoring/browser/advanced_configuration/#override-default-rum-view-names) for further information.
+     *
+     * Context - @category Data Collection
+     *
+     * @param nameOrOptions - Name or options (name, service, version) for the view
+     */
+    startView(nameOrOptions?: string | ViewOptions): void;
+    /**
+     * Stop the session. A new session will start at the next user interaction with the page.
+     *
+     * @category Session
+     */
+    stopSession(): void;
+    /**
+     * Add a feature flag evaluation,
+     * stored in `@feature_flags.<feature_flag_key>`
+     *
+     * We recommend enabling the intake request compression when using feature flags `compressIntakeRequests: true`.
+     *
+     * See [Feature Flag Tracking](https://docs.kubesense.ai/real_user_monitoring/feature_flag_tracking/) for further information.
+     *
+     * @category Data Collection
+     * @param key - The key of the feature flag.
+     * @param value - The value of the feature flag.
+     */
+    addFeatureFlagEvaluation: (key: string, value: any) => void;
+    /**
+     * Get the Session Replay Link.
+     *
+     * See [Connect Session Replay To Your Third-Party Tools](https://docs.kubesense.ai/real_user_monitoring/guide/connect-session-replay-to-your-third-party-tools) for further information.
+     *
+     * @category Session Replay
+     */
+    getSessionReplayLink: () => string | undefined;
+    /**
+     * Start Session Replay recording.
+     * Enable to conditionally start the recording, use the `startSessionReplayRecordingManually:true` init parameter and call `startSessionReplayRecording()`
+     *
+     * See [Browser Session Replay](https://docs.kubesense.ai/real_user_monitoring/session_replay/browser) for further information.
+     *
+     * @category Session Replay
+     */
+    startSessionReplayRecording: (options?: StartRecordingOptions) => void;
+    /**
+     * Stop Session Replay recording.
+     *
+     * See [Browser Session Replay](https://docs.kubesense.ai/real_user_monitoring/session_replay/browser) for further information.
+     *
+     * @category Session Replay
+     */
+    stopSessionReplayRecording: () => void;
+    /**
+     * Add a custom duration vital
+     *
+     * @category Vital - Duration
+     * @param name - Name of the custom vital
+     * @param options - Options for the custom vital (startTime, duration, context, description)
+     */
+    addDurationVital: (name: string, options: AddDurationVitalOptions) => void;
+    /**
+     * Start a custom duration vital.
+     *
+     * If you plan to have multiple durations for the same vital, you should use the reference returned by this method.
+     *
+     * @category Vital - Duration
+     * @param name - Name of the custom vital
+     * @param options - Options for the custom vital (context, description)
+     * @returns reference to the custom vital
+     */
+    startDurationVital: (name: string, options?: DurationVitalOptions) => DurationVitalReference;
+    /**
+     * Stop a custom duration vital
+     *
+     * @category Vital - Duration
+     * @param nameOrRef - Name or reference of the custom vital
+     * @param options - Options for the custom vital (operationKey, context, description)
+     */
+    stopDurationVital: (nameOrRef: string | DurationVitalReference, options?: DurationVitalOptions) => void;
+    /**
+     * start a feature operation
+     *
+     * @category Vital - Feature Operation
+     * @param name - Name of the operation step
+     * @param options - Options for the operation step (operationKey, context, description)
+     * @hidden // TODO: replace by @since when GA
+     */
+    startFeatureOperation: (name: string, options?: FeatureOperationOptions) => void;
+    /**
+     * succeed a feature operation
+     *
+     * @category Vital - Feature Operation
+     * @param name - Name of the operation step
+     * @param options - Options for the operation step (operationKey, context, description)
+     * @hidden // TODO: replace by @since when GA
+     */
+    succeedFeatureOperation: (name: string, options?: FeatureOperationOptions) => void;
+    /**
+     * fail a feature operation
+     *
+     * @category Vital - Feature Operation
+     * @param name - Name of the operation step
+     * @param failureReason
+     * @param options - Options for the operation step (operationKey, context, description)
+     * @hidden // TODO: replace by @since when GA
+     */
+    failFeatureOperation: (name: string, failureReaon: FailureReason, options?: FeatureOperationOptions) => void;
+}
+export interface RecorderApi {
+    start: (options?: StartRecordingOptions) => void;
+    stop: () => void;
+    onRumStart: (lifeCycle: LifeCycle, configuration: RumConfiguration, sessionManager: RumSessionManager, viewHistory: ViewHistory, deflateWorker: DeflateWorker | undefined, telemetry: Telemetry) => void;
+    isRecording: () => boolean;
+    getReplayStats: (viewId: string) => ReplayStats | undefined;
+    getSessionReplayLink: () => string | undefined;
+}
+export interface ProfilerApi {
+    stop: () => void;
+    onRumStart: (lifeCycle: LifeCycle, hooks: Hooks, configuration: RumConfiguration, sessionManager: RumSessionManager, viewHistory: ViewHistory, longTaskContexts: LongTaskContexts, createEncoder: (streamId: DeflateEncoderStreamId) => Encoder) => void;
+}
+export interface RumPublicApiOptions {
+    ignoreInitIfSyntheticsWillInjectRum?: boolean;
+    startDeflateWorker?: (configuration: RumConfiguration, source: string, onInitializationFailure: () => void) => DeflateWorker | undefined;
+    createDeflateEncoder?: (configuration: RumConfiguration, worker: DeflateWorker, streamId: DeflateEncoderStreamId) => DeflateEncoder;
+    sdkName?: SdkName;
+}
+export interface Strategy {
+    init: (initConfiguration: RumInitConfiguration, publicApi: RumPublicApi, errorStack?: string) => void;
+    initConfiguration: RumInitConfiguration | undefined;
+    getInternalContext: StartRumResult['getInternalContext'];
+    stopSession: StartRumResult['stopSession'];
+    addTiming: StartRumResult['addTiming'];
+    startView: StartRumResult['startView'];
+    setViewName: StartRumResult['setViewName'];
+    setViewContext: StartRumResult['setViewContext'];
+    setViewContextProperty: StartRumResult['setViewContextProperty'];
+    getViewContext: StartRumResult['getViewContext'];
+    globalContext: ContextManager;
+    userContext: ContextManager;
+    accountContext: ContextManager;
+    addAction: StartRumResult['addAction'];
+    addError: StartRumResult['addError'];
+    addFeatureFlagEvaluation: StartRumResult['addFeatureFlagEvaluation'];
+    startDurationVital: StartRumResult['startDurationVital'];
+    stopDurationVital: StartRumResult['stopDurationVital'];
+    addDurationVital: StartRumResult['addDurationVital'];
+    addOperationStepVital: StartRumResult['addOperationStepVital'];
+}
+export declare function makeRumPublicApi(startRumImpl: StartRum, recorderApi: RecorderApi, profilerApi: ProfilerApi, options?: RumPublicApiOptions): RumPublicApi;

package/cjs/boot/rumPublicApi.js

@@ -0,0 +1,168 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeRumPublicApi = makeRumPublicApi;
+const kubesense_browser_core_1 = require("@kubesense/kubesense-browser-core");
+const rawRumEvent_types_1 = require("../rawRumEvent.types");
+const vitalCollection_1 = require("../domain/vital/vitalCollection");
+const plugins_1 = require("../domain/plugins");
+const preStartRum_1 = require("./preStartRum");
+function makeRumPublicApi(startRumImpl, recorderApi, profilerApi, options = {}) {
+    const trackingConsentState = (0, kubesense_browser_core_1.createTrackingConsentState)();
+    const customVitalsState = (0, vitalCollection_1.createCustomVitalsState)();
+    const bufferedDataObservable = (0, kubesense_browser_core_1.startBufferingData)().observable;
+    let strategy = (0, preStartRum_1.createPreStartStrategy)(options, trackingConsentState, customVitalsState, (configuration, deflateWorker, initialViewOptions) => {
+        const createEncoder = deflateWorker && options.createDeflateEncoder
+            ? (streamId) => options.createDeflateEncoder(configuration, deflateWorker, streamId)
+            : kubesense_browser_core_1.createIdentityEncoder;
+        const startRumResult = startRumImpl(configuration, recorderApi, profilerApi, initialViewOptions, createEncoder, trackingConsentState, customVitalsState, bufferedDataObservable, options.sdkName);
+        recorderApi.onRumStart(startRumResult.lifeCycle, configuration, startRumResult.session, startRumResult.viewHistory, deflateWorker, startRumResult.telemetry);
+        profilerApi.onRumStart(startRumResult.lifeCycle, startRumResult.hooks, configuration, startRumResult.session, startRumResult.viewHistory, startRumResult.longTaskContexts, createEncoder);
+        strategy = createPostStartStrategy(strategy, startRumResult);
+        (0, plugins_1.callPluginsMethod)(configuration.plugins, 'onRumStart', {
+            strategy, // TODO: remove this in the next major release
+            addEvent: startRumResult.addEvent,
+        });
+        return startRumResult;
+    });
+    const getStrategy = () => strategy;
+    const startView = (0, kubesense_browser_core_1.monitor)((options) => {
+        const sanitizedOptions = typeof options === 'object' ? options : { name: options };
+        strategy.startView(sanitizedOptions);
+        (0, kubesense_browser_core_1.addTelemetryUsage)({ feature: 'start-view' });
+    });
+    const rumPublicApi = (0, kubesense_browser_core_1.makePublicApi)({
+        init: (initConfiguration) => {
+            const errorStack = new Error().stack;
+            (0, kubesense_browser_core_1.callMonitored)(() => strategy.init(initConfiguration, rumPublicApi, errorStack));
+        },
+        setTrackingConsent: (0, kubesense_browser_core_1.monitor)((trackingConsent) => {
+            trackingConsentState.update(trackingConsent);
+            (0, kubesense_browser_core_1.addTelemetryUsage)({ feature: 'set-tracking-consent', tracking_consent: trackingConsent });
+        }),
+        setViewName: (0, kubesense_browser_core_1.monitor)((name) => {
+            strategy.setViewName(name);
+            (0, kubesense_browser_core_1.addTelemetryUsage)({ feature: 'set-view-name' });
+        }),
+        setViewContext: (0, kubesense_browser_core_1.monitor)((context) => {
+            strategy.setViewContext(context);
+            (0, kubesense_browser_core_1.addTelemetryUsage)({ feature: 'set-view-context' });
+        }),
+        setViewContextProperty: (0, kubesense_browser_core_1.monitor)((key, value) => {
+            strategy.setViewContextProperty(key, value);
+            (0, kubesense_browser_core_1.addTelemetryUsage)({ feature: 'set-view-context-property' });
+        }),
+        getViewContext: (0, kubesense_browser_core_1.monitor)(() => {
+            (0, kubesense_browser_core_1.addTelemetryUsage)({ feature: 'set-view-context-property' });
+            return strategy.getViewContext();
+        }),
+        getInternalContext: (0, kubesense_browser_core_1.monitor)((startTime) => strategy.getInternalContext(startTime)),
+        getInitConfiguration: (0, kubesense_browser_core_1.monitor)(() => (0, kubesense_browser_core_1.deepClone)(strategy.initConfiguration)),
+        addAction: (name, context) => {
+            const handlingStack = (0, kubesense_browser_core_1.createHandlingStack)('action');
+            (0, kubesense_browser_core_1.callMonitored)(() => {
+                strategy.addAction({
+                    name: (0, kubesense_browser_core_1.sanitize)(name),
+                    context: (0, kubesense_browser_core_1.sanitize)(context),
+                    startClocks: (0, kubesense_browser_core_1.clocksNow)(),
+                    type: rawRumEvent_types_1.ActionType.CUSTOM,
+                    handlingStack,
+                });
+                (0, kubesense_browser_core_1.addTelemetryUsage)({ feature: 'add-action' });
+            });
+        },
+        addError: (error, context) => {
+            const handlingStack = (0, kubesense_browser_core_1.createHandlingStack)('error');
+            (0, kubesense_browser_core_1.callMonitored)(() => {
+                strategy.addError({
+                    error, // Do not sanitize error here, it is needed unserialized by computeRawError()
+                    handlingStack,
+                    context: (0, kubesense_browser_core_1.sanitize)(context),
+                    startClocks: (0, kubesense_browser_core_1.clocksNow)(),
+                });
+                (0, kubesense_browser_core_1.addTelemetryUsage)({ feature: 'add-error' });
+            });
+        },
+        addTiming: (0, kubesense_browser_core_1.monitor)((name, time) => {
+            // TODO: next major decide to drop relative time support or update its behaviour
+            strategy.addTiming((0, kubesense_browser_core_1.sanitize)(name), time);
+        }),
+        setGlobalContext: (0, kubesense_browser_core_1.defineContextMethod)(getStrategy, kubesense_browser_core_1.CustomerContextKey.globalContext, kubesense_browser_core_1.ContextManagerMethod.setContext, 'set-global-context'),
+        getGlobalContext: (0, kubesense_browser_core_1.defineContextMethod)(getStrategy, kubesense_browser_core_1.CustomerContextKey.globalContext, kubesense_browser_core_1.ContextManagerMethod.getContext, 'get-global-context'),
+        setGlobalContextProperty: (0, kubesense_browser_core_1.defineContextMethod)(getStrategy, kubesense_browser_core_1.CustomerContextKey.globalContext, kubesense_browser_core_1.ContextManagerMethod.setContextProperty, 'set-global-context-property'),
+        removeGlobalContextProperty: (0, kubesense_browser_core_1.defineContextMethod)(getStrategy, kubesense_browser_core_1.CustomerContextKey.globalContext, kubesense_browser_core_1.ContextManagerMethod.removeContextProperty, 'remove-global-context-property'),
+        clearGlobalContext: (0, kubesense_browser_core_1.defineContextMethod)(getStrategy, kubesense_browser_core_1.CustomerContextKey.globalContext, kubesense_browser_core_1.ContextManagerMethod.clearContext, 'clear-global-context'),
+        setUser: (0, kubesense_browser_core_1.defineContextMethod)(getStrategy, kubesense_browser_core_1.CustomerContextKey.userContext, kubesense_browser_core_1.ContextManagerMethod.setContext, 'set-user'),
+        getUser: (0, kubesense_browser_core_1.defineContextMethod)(getStrategy, kubesense_browser_core_1.CustomerContextKey.userContext, kubesense_browser_core_1.ContextManagerMethod.getContext, 'get-user'),
+        setUserProperty: (0, kubesense_browser_core_1.defineContextMethod)(getStrategy, kubesense_browser_core_1.CustomerContextKey.userContext, kubesense_browser_core_1.ContextManagerMethod.setContextProperty, 'set-user-property'),
+        removeUserProperty: (0, kubesense_browser_core_1.defineContextMethod)(getStrategy, kubesense_browser_core_1.CustomerContextKey.userContext, kubesense_browser_core_1.ContextManagerMethod.removeContextProperty, 'remove-user-property'),
+        clearUser: (0, kubesense_browser_core_1.defineContextMethod)(getStrategy, kubesense_browser_core_1.CustomerContextKey.userContext, kubesense_browser_core_1.ContextManagerMethod.clearContext, 'clear-user'),
+        setAccount: (0, kubesense_browser_core_1.defineContextMethod)(getStrategy, kubesense_browser_core_1.CustomerContextKey.accountContext, kubesense_browser_core_1.ContextManagerMethod.setContext, 'set-account'),
+        getAccount: (0, kubesense_browser_core_1.defineContextMethod)(getStrategy, kubesense_browser_core_1.CustomerContextKey.accountContext, kubesense_browser_core_1.ContextManagerMethod.getContext, 'get-account'),
+        setAccountProperty: (0, kubesense_browser_core_1.defineContextMethod)(getStrategy, kubesense_browser_core_1.CustomerContextKey.accountContext, kubesense_browser_core_1.ContextManagerMethod.setContextProperty, 'set-account-property'),
+        removeAccountProperty: (0, kubesense_browser_core_1.defineContextMethod)(getStrategy, kubesense_browser_core_1.CustomerContextKey.accountContext, kubesense_browser_core_1.ContextManagerMethod.removeContextProperty, 'remove-account-property'),
+        clearAccount: (0, kubesense_browser_core_1.defineContextMethod)(getStrategy, kubesense_browser_core_1.CustomerContextKey.accountContext, kubesense_browser_core_1.ContextManagerMethod.clearContext, 'clear-account'),
+        startView,
+        stopSession: (0, kubesense_browser_core_1.monitor)(() => {
+            strategy.stopSession();
+            (0, kubesense_browser_core_1.addTelemetryUsage)({ feature: 'stop-session' });
+        }),
+        addFeatureFlagEvaluation: (0, kubesense_browser_core_1.monitor)((key, value) => {
+            strategy.addFeatureFlagEvaluation((0, kubesense_browser_core_1.sanitize)(key), (0, kubesense_browser_core_1.sanitize)(value));
+            (0, kubesense_browser_core_1.addTelemetryUsage)({ feature: 'add-feature-flag-evaluation' });
+        }),
+        getSessionReplayLink: (0, kubesense_browser_core_1.monitor)(() => recorderApi.getSessionReplayLink()),
+        startSessionReplayRecording: (0, kubesense_browser_core_1.monitor)((options) => {
+            recorderApi.start(options);
+            (0, kubesense_browser_core_1.addTelemetryUsage)({ feature: 'start-session-replay-recording', force: options && options.force });
+        }),
+        stopSessionReplayRecording: (0, kubesense_browser_core_1.monitor)(() => recorderApi.stop()),
+        addDurationVital: (0, kubesense_browser_core_1.monitor)((name, options) => {
+            (0, kubesense_browser_core_1.addTelemetryUsage)({ feature: 'add-duration-vital' });
+            strategy.addDurationVital({
+                name: (0, kubesense_browser_core_1.sanitize)(name),
+                type: rawRumEvent_types_1.VitalType.DURATION,
+                startClocks: (0, kubesense_browser_core_1.timeStampToClocks)(options.startTime),
+                duration: options.duration,
+                context: (0, kubesense_browser_core_1.sanitize)(options && options.context),
+                description: (0, kubesense_browser_core_1.sanitize)(options && options.description),
+            });
+        }),
+        startDurationVital: (0, kubesense_browser_core_1.monitor)((name, options) => {
+            (0, kubesense_browser_core_1.addTelemetryUsage)({ feature: 'start-duration-vital' });
+            return strategy.startDurationVital((0, kubesense_browser_core_1.sanitize)(name), {
+                context: (0, kubesense_browser_core_1.sanitize)(options && options.context),
+                description: (0, kubesense_browser_core_1.sanitize)(options && options.description),
+            });
+        }),
+        stopDurationVital: (0, kubesense_browser_core_1.monitor)((nameOrRef, options) => {
+            (0, kubesense_browser_core_1.addTelemetryUsage)({ feature: 'stop-duration-vital' });
+            strategy.stopDurationVital(typeof nameOrRef === 'string' ? (0, kubesense_browser_core_1.sanitize)(nameOrRef) : nameOrRef, {
+                context: (0, kubesense_browser_core_1.sanitize)(options && options.context),
+                description: (0, kubesense_browser_core_1.sanitize)(options && options.description),
+            });
+        }),
+        startFeatureOperation: (0, kubesense_browser_core_1.monitor)((name, options) => {
+            (0, kubesense_browser_core_1.addTelemetryUsage)({ feature: 'add-operation-step-vital', action_type: 'start' });
+            strategy.addOperationStepVital(name, 'start', options);
+        }),
+        succeedFeatureOperation: (0, kubesense_browser_core_1.monitor)((name, options) => {
+            (0, kubesense_browser_core_1.addTelemetryUsage)({ feature: 'add-operation-step-vital', action_type: 'succeed' });
+            strategy.addOperationStepVital(name, 'end', options);
+        }),
+        failFeatureOperation: (0, kubesense_browser_core_1.monitor)((name, failureReason, options) => {
+            (0, kubesense_browser_core_1.addTelemetryUsage)({ feature: 'add-operation-step-vital', action_type: 'fail' });
+            strategy.addOperationStepVital(name, 'end', options, failureReason);
+        }),
+    });
+    return rumPublicApi;
+}
+function createPostStartStrategy(preStartStrategy, startRumResult) {
+    return {
+        init: (initConfiguration) => {
+            (0, kubesense_browser_core_1.displayAlreadyInitializedError)('KUBESENSE_SDK', initConfiguration);
+        },
+        initConfiguration: preStartStrategy.initConfiguration,
+        ...startRumResult,
+    };
+}
+//# sourceMappingURL=rumPublicApi.js.map

package/cjs/boot/rumPublicApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rumPublicApi.js","sourceRoot":"","sources":["../../src/boot/rumPublicApi.ts"],"names":[],"mappings":";;AAwgBA,4CA2SC;AAlyBD,8EAiB0C;AAM1C,4DAA4D;AAU5D,qEAAyE;AACzE,+CAAqD;AAIrD,+CAAsD;AAidtD,SAAgB,gBAAgB,CAC9B,YAAsB,EACtB,WAAwB,EACxB,WAAwB,EACxB,UAA+B,EAAE;IAEjC,MAAM,oBAAoB,GAAG,IAAA,mDAA0B,GAAE,CAAA;IACzD,MAAM,iBAAiB,GAAG,IAAA,yCAAuB,GAAE,CAAA;IACnD,MAAM,sBAAsB,GAAG,IAAA,2CAAkB,GAAE,CAAC,UAAU,CAAA;IAE9D,IAAI,QAAQ,GAAG,IAAA,oCAAsB,EACnC,OAAO,EACP,oBAAoB,EACpB,iBAAiB,EACjB,CAAC,aAAa,EAAE,aAAa,EAAE,kBAAkB,EAAE,EAAE;QACnD,MAAM,aAAa,GACjB,aAAa,IAAI,OAAO,CAAC,oBAAoB;YAC3C,CAAC,CAAC,CAAC,QAAgC,EAAE,EAAE,CAAC,OAAO,CAAC,oBAAqB,CAAC,aAAa,EAAE,aAAa,EAAE,QAAQ,CAAC;YAC7G,CAAC,CAAC,8CAAqB,CAAA;QAE3B,MAAM,cAAc,GAAG,YAAY,CACjC,aAAa,EACb,WAAW,EACX,WAAW,EACX,kBAAkB,EAClB,aAAa,EACb,oBAAoB,EACpB,iBAAiB,EACjB,sBAAsB,EACtB,OAAO,CAAC,OAAO,CAChB,CAAA;QAED,WAAW,CAAC,UAAU,CACpB,cAAc,CAAC,SAAS,EACxB,aAAa,EACb,cAAc,CAAC,OAAO,EACtB,cAAc,CAAC,WAAW,EAC1B,aAAa,EACb,cAAc,CAAC,SAAS,CACzB,CAAA;QAED,WAAW,CAAC,UAAU,CACpB,cAAc,CAAC,SAAS,EACxB,cAAc,CAAC,KAAK,EACpB,aAAa,EACb,cAAc,CAAC,OAAO,EACtB,cAAc,CAAC,WAAW,EAC1B,cAAc,CAAC,gBAAgB,EAC/B,aAAa,CACd,CAAA;QAED,QAAQ,GAAG,uBAAuB,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAA;QAE5D,IAAA,2BAAiB,EAAC,aAAa,CAAC,OAAO,EAAE,YAAY,EAAE;YACrD,QAAQ,EAAE,8CAA8C;YACxD,QAAQ,EAAE,cAAc,CAAC,QAAQ;SAClC,CAAC,CAAA;QAEF,OAAO,cAAc,CAAA;IACvB,CAAC,CACF,CAAA;IACD,MAAM,WAAW,GAAG,GAAG,EAAE,CAAC,QAAQ,CAAA;IAElC,MAAM,SAAS,GAGX,IAAA,gCAAO,EAAC,CAAC,OAA8B,EAAE,EAAE;QAC7C,MAAM,gBAAgB,GAAG,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAA;QAClF,QAAQ,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAA;QACpC,IAAA,0CAAiB,EAAC,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,CAAA;IAC9C,CAAC,CAAC,CAAA;IAEF,MAAM,YAAY,GAAiB,IAAA,sCAAa,EAAe;QAC7D,IAAI,EAAE,CAAC,iBAAiB,EAAE,EAAE;YAC1B,MAAM,UAAU,GAAG,IAAI,KAAK,EAAE,CAAC,KAAK,CAAA;YACpC,IAAA,sCAAa,EAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,iBAAiB,EAAE,YAAY,EAAE,UAAU,CAAC,CAAC,CAAA;QACjF,CAAC;QAED,kBAAkB,EAAE,IAAA,gCAAO,EAAC,CAAC,eAAe,EAAE,EAAE;YAC9C,oBAAoB,CAAC,MAAM,CAAC,eAAe,CAAC,CAAA;YAC5C,IAAA,0CAAiB,EAAC,EAAE,OAAO,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,eAAe,EAAE,CAAC,CAAA;QAC3F,CAAC,CAAC;QAEF,WAAW,EAAE,IAAA,gCAAO,EAAC,CAAC,IAAY,EAAE,EAAE;YACpC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;YAC1B,IAAA,0CAAiB,EAAC,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC,CAAA;QACjD,CAAC,CAAC;QAEF,cAAc,EAAE,IAAA,gCAAO,EAAC,CAAC,OAAgB,EAAE,EAAE;YAC3C,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,CAAA;YAChC,IAAA,0CAAiB,EAAC,EAAE,OAAO,EAAE,kBAAkB,EAAE,CAAC,CAAA;QACpD,CAAC,CAAC;QAEF,sBAAsB,EAAE,IAAA,gCAAO,EAAC,CAAC,GAAW,EAAE,KAAU,EAAE,EAAE;YAC1D,QAAQ,CAAC,sBAAsB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;YAC3C,IAAA,0CAAiB,EAAC,EAAE,OAAO,EAAE,2BAA2B,EAAE,CAAC,CAAA;QAC7D,CAAC,CAAC;QAEF,cAAc,EAAE,IAAA,gCAAO,EAAC,GAAG,EAAE;YAC3B,IAAA,0CAAiB,EAAC,EAAE,OAAO,EAAE,2BAA2B,EAAE,CAAC,CAAA;YAC3D,OAAO,QAAQ,CAAC,cAAc,EAAE,CAAA;QAClC,CAAC,CAAC;QAEF,kBAAkB,EAAE,IAAA,gCAAO,EAAC,CAAC,SAAS,EAAE,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;QAElF,oBAAoB,EAAE,IAAA,gCAAO,EAAC,GAAG,EAAE,CAAC,IAAA,kCAAS,EAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC;QAE1E,SAAS,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE;YAC3B,MAAM,aAAa,GAAG,IAAA,4CAAmB,EAAC,QAAQ,CAAC,CAAA;YAEnD,IAAA,sCAAa,EAAC,GAAG,EAAE;gBACjB,QAAQ,CAAC,SAAS,CAAC;oBACjB,IAAI,EAAE,IAAA,iCAAQ,EAAC,IAAI,CAAE;oBACrB,OAAO,EAAE,IAAA,iCAAQ,EAAC,OAAO,CAAY;oBACrC,WAAW,EAAE,IAAA,kCAAS,GAAE;oBACxB,IAAI,EAAE,8BAAU,CAAC,MAAM;oBACvB,aAAa;iBACd,CAAC,CAAA;gBACF,IAAA,0CAAiB,EAAC,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,CAAA;YAC9C,CAAC,CAAC,CAAA;QACJ,CAAC;QAED,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;YAC3B,MAAM,aAAa,GAAG,IAAA,4CAAmB,EAAC,OAAO,CAAC,CAAA;YAClD,IAAA,sCAAa,EAAC,GAAG,EAAE;gBACjB,QAAQ,CAAC,QAAQ,CAAC;oBAChB,KAAK,EAAE,6EAA6E;oBACpF,aAAa;oBACb,OAAO,EAAE,IAAA,iCAAQ,EAAC,OAAO,CAAY;oBACrC,WAAW,EAAE,IAAA,kCAAS,GAAE;iBACzB,CAAC,CAAA;gBACF,IAAA,0CAAiB,EAAC,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC,CAAA;YAC7C,CAAC,CAAC,CAAA;QACJ,CAAC;QAED,SAAS,EAAE,IAAA,gCAAO,EAAC,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;YAChC,gFAAgF;YAChF,QAAQ,CAAC,SAAS,CAAC,IAAA,iCAAQ,EAAC,IAAI,CAAE,EAAE,IAA4C,CAAC,CAAA;QACnF,CAAC,CAAC;QAEF,gBAAgB,EAAE,IAAA,4CAAmB,EACnC,WAAW,EACX,2CAAkB,CAAC,aAAa,EAChC,6CAAoB,CAAC,UAAU,EAC/B,oBAAoB,CACrB;QACD,gBAAgB,EAAE,IAAA,4CAAmB,EACnC,WAAW,EACX,2CAAkB,CAAC,aAAa,EAChC,6CAAoB,CAAC,UAAU,EAC/B,oBAAoB,CACrB;QACD,wBAAwB,EAAE,IAAA,4CAAmB,EAC3C,WAAW,EACX,2CAAkB,CAAC,aAAa,EAChC,6CAAoB,CAAC,kBAAkB,EACvC,6BAA6B,CAC9B;QACD,2BAA2B,EAAE,IAAA,4CAAmB,EAC9C,WAAW,EACX,2CAAkB,CAAC,aAAa,EAChC,6CAAoB,CAAC,qBAAqB,EAC1C,gCAAgC,CACjC;QACD,kBAAkB,EAAE,IAAA,4CAAmB,EACrC,WAAW,EACX,2CAAkB,CAAC,aAAa,EAChC,6CAAoB,CAAC,YAAY,EACjC,sBAAsB,CACvB;QAED,OAAO,EAAE,IAAA,4CAAmB,EAC1B,WAAW,EACX,2CAAkB,CAAC,WAAW,EAC9B,6CAAoB,CAAC,UAAU,EAC/B,UAAU,CACX;QACD,OAAO,EAAE,IAAA,4CAAmB,EAC1B,WAAW,EACX,2CAAkB,CAAC,WAAW,EAC9B,6CAAoB,CAAC,UAAU,EAC/B,UAAU,CACX;QACD,eAAe,EAAE,IAAA,4CAAmB,EAClC,WAAW,EACX,2CAAkB,CAAC,WAAW,EAC9B,6CAAoB,CAAC,kBAAkB,EACvC,mBAAmB,CACpB;QACD,kBAAkB,EAAE,IAAA,4CAAmB,EACrC,WAAW,EACX,2CAAkB,CAAC,WAAW,EAC9B,6CAAoB,CAAC,qBAAqB,EAC1C,sBAAsB,CACvB;QACD,SAAS,EAAE,IAAA,4CAAmB,EAC5B,WAAW,EACX,2CAAkB,CAAC,WAAW,EAC9B,6CAAoB,CAAC,YAAY,EACjC,YAAY,CACb;QAED,UAAU,EAAE,IAAA,4CAAmB,EAC7B,WAAW,EACX,2CAAkB,CAAC,cAAc,EACjC,6CAAoB,CAAC,UAAU,EAC/B,aAAa,CACd;QACD,UAAU,EAAE,IAAA,4CAAmB,EAC7B,WAAW,EACX,2CAAkB,CAAC,cAAc,EACjC,6CAAoB,CAAC,UAAU,EAC/B,aAAa,CACd;QACD,kBAAkB,EAAE,IAAA,4CAAmB,EACrC,WAAW,EACX,2CAAkB,CAAC,cAAc,EACjC,6CAAoB,CAAC,kBAAkB,EACvC,sBAAsB,CACvB;QACD,qBAAqB,EAAE,IAAA,4CAAmB,EACxC,WAAW,EACX,2CAAkB,CAAC,cAAc,EACjC,6CAAoB,CAAC,qBAAqB,EAC1C,yBAAyB,CAC1B;QACD,YAAY,EAAE,IAAA,4CAAmB,EAC/B,WAAW,EACX,2CAAkB,CAAC,cAAc,EACjC,6CAAoB,CAAC,YAAY,EACjC,eAAe,CAChB;QAED,SAAS;QAET,WAAW,EAAE,IAAA,gCAAO,EAAC,GAAG,EAAE;YACxB,QAAQ,CAAC,WAAW,EAAE,CAAA;YACtB,IAAA,0CAAiB,EAAC,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAA;QAChD,CAAC,CAAC;QAEF,wBAAwB,EAAE,IAAA,gCAAO,EAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;YAC/C,QAAQ,CAAC,wBAAwB,CAAC,IAAA,iCAAQ,EAAC,GAAG,CAAE,EAAE,IAAA,iCAAQ,EAAC,KAAK,CAAC,CAAC,CAAA;YAClE,IAAA,0CAAiB,EAAC,EAAE,OAAO,EAAE,6BAA6B,EAAE,CAAC,CAAA;QAC/D,CAAC,CAAC;QAEF,oBAAoB,EAAE,IAAA,gCAAO,EAAC,GAAG,EAAE,CAAC,WAAW,CAAC,oBAAoB,EAAE,CAAC;QAEvE,2BAA2B,EAAE,IAAA,gCAAO,EAAC,CAAC,OAA+B,EAAE,EAAE;YACvE,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;YAC1B,IAAA,0CAAiB,EAAC,EAAE,OAAO,EAAE,gCAAgC,EAAE,KAAK,EAAE,OAAO,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC,CAAA;QACnG,CAAC,CAAC;QAEF,0BAA0B,EAAE,IAAA,gCAAO,EAAC,GAAG,EAAE,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;QAE7D,gBAAgB,EAAE,IAAA,gCAAO,EAAC,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE;YAC1C,IAAA,0CAAiB,EAAC,EAAE,OAAO,EAAE,oBAAoB,EAAE,CAAC,CAAA;YACpD,QAAQ,CAAC,gBAAgB,CAAC;gBACxB,IAAI,EAAE,IAAA,iCAAQ,EAAC,IAAI,CAAE;gBACrB,IAAI,EAAE,6BAAS,CAAC,QAAQ;gBACxB,WAAW,EAAE,IAAA,0CAAiB,EAAC,OAAO,CAAC,SAAsB,CAAC;gBAC9D,QAAQ,EAAE,OAAO,CAAC,QAAoB;gBACtC,OAAO,EAAE,IAAA,iCAAQ,EAAC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAY;gBACxD,WAAW,EAAE,IAAA,iCAAQ,EAAC,OAAO,IAAI,OAAO,CAAC,WAAW,CAAuB;aAC5E,CAAC,CAAA;QACJ,CAAC,CAAC;QAEF,kBAAkB,EAAE,IAAA,gCAAO,EAAC,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE;YAC5C,IAAA,0CAAiB,EAAC,EAAE,OAAO,EAAE,sBAAsB,EAAE,CAAC,CAAA;YACtD,OAAO,QAAQ,CAAC,kBAAkB,CAAC,IAAA,iCAAQ,EAAC,IAAI,CAAE,EAAE;gBAClD,OAAO,EAAE,IAAA,iCAAQ,EAAC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAY;gBACxD,WAAW,EAAE,IAAA,iCAAQ,EAAC,OAAO,IAAI,OAAO,CAAC,WAAW,CAAuB;aAC5E,CAAC,CAAA;QACJ,CAAC,CAAC;QAEF,iBAAiB,EAAE,IAAA,gCAAO,EAAC,CAAC,SAAS,EAAE,OAAO,EAAE,EAAE;YAChD,IAAA,0CAAiB,EAAC,EAAE,OAAO,EAAE,qBAAqB,EAAE,CAAC,CAAA;YACrD,QAAQ,CAAC,iBAAiB,CAAC,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAA,iCAAQ,EAAC,SAAS,CAAE,CAAC,CAAC,CAAC,SAAS,EAAE;gBAC3F,OAAO,EAAE,IAAA,iCAAQ,EAAC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAY;gBACxD,WAAW,EAAE,IAAA,iCAAQ,EAAC,OAAO,IAAI,OAAO,CAAC,WAAW,CAAuB;aAC5E,CAAC,CAAA;QACJ,CAAC,CAAC;QAEF,qBAAqB,EAAE,IAAA,gCAAO,EAAC,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE;YAC/C,IAAA,0CAAiB,EAAC,EAAE,OAAO,EAAE,0BAA0B,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAA;YAChF,QAAQ,CAAC,qBAAqB,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,CAAA;QACxD,CAAC,CAAC;QAEF,uBAAuB,EAAE,IAAA,gCAAO,EAAC,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE;YACjD,IAAA,0CAAiB,EAAC,EAAE,OAAO,EAAE,0BAA0B,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC,CAAA;YAClF,QAAQ,CAAC,qBAAqB,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;QACtD,CAAC,CAAC;QAEF,oBAAoB,EAAE,IAAA,gCAAO,EAAC,CAAC,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,EAAE;YAC7D,IAAA,0CAAiB,EAAC,EAAE,OAAO,EAAE,0BAA0B,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,CAAA;YAC/E,QAAQ,CAAC,qBAAqB,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,aAAa,CAAC,CAAA;QACrE,CAAC,CAAC;KACH,CAAC,CAAA;IAEF,OAAO,YAAY,CAAA;AACrB,CAAC;AAED,SAAS,uBAAuB,CAAC,gBAA0B,EAAE,cAA8B;IACzF,OAAO;QACL,IAAI,EAAE,CAAC,iBAAuC,EAAE,EAAE;YAChD,IAAA,uDAA8B,EAAC,eAAe,EAAE,iBAAiB,CAAC,CAAA;QACpE,CAAC;QACD,iBAAiB,EAAE,gBAAgB,CAAC,iBAAiB;QACrD,GAAG,cAAc;KAClB,CAAA;AACH,CAAC"}