@coralogix/browser 2.8.5 → 2.8.6

package/src/constants.d.ts

@@ -19,10 +19,6 @@ export declare const MASKED_TEXT = "***";
 export declare const MASK_CLASS_DEFAULT = "cx-mask";
 export declare const MASK_INPUT_TYPES_DEFAULT: InputType[];
 export declare const OPTIONS_DEFAULTS: Partial<CoralogixBrowserSdkConfig>;
-/**
- * Note: For any instrumentation added to CoralogixOtelWebOptionsInstrumentations,
- * The `confKey` must match one of its keys.
- */
 export declare const INSTRUMENTATIONS: readonly InternalInstrumentationConfig[];
 export declare const CoralogixAttributes: {
     EVENT_TYPE: string;

package/src/otel/otel.consts.d.ts

@@ -2,17 +2,7 @@ export declare const IS_OTEL_READY = "otelReady";
 export declare const MAIN_TRACER_KEY = "@";
 export declare const ATTR_PROCESSOR_KEY = "attrProcessor";
 export declare enum SpanStatusCode {
-    /**
-     * The default status.
-     */
     UNSET = 0,
-    /**
-     * The operation has been validated by an Application developer or
-     * Operator to have completed successfully.
-     */
     OK = 1,
-    /**
-     * The operation contains an error.
-     */
     ERROR = 2
 }

package/src/session/session.model.d.ts

@@ -2,47 +2,12 @@ import { eventWithTime } from '@rrweb/types';
 import { SlimDOMOptions } from 'rrweb-snapshot';
 import { CoralogixEventType } from '../types';
 import { recordOptions } from 'rrweb';
-/**
- * Record config properties - based on rrweb
- *
- * | key                      | default            | description                                                                                                                                                                                   |
- * | ------------------------ | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
- * | emit                     | required           | the callback function to get emitted events                                                                                                                                                   |
- * | checkoutEveryNth         | -                  | take a full snapshot after every N events<br />refer to the [checkout](#checkout) chapter                                                                                                     |
- * | checkoutEveryNms         | -                  | take a full snapshot after every N ms<br />refer to the [checkout](#checkout) chapter                                                                                                         |
- * | blockClass               | 'rr-block'         | Use a string or RegExp to configure which elements should be blocked, refer to the [privacy](#privacy) chapter                                                                                |
- * | blockSelector            | null               | Use a string to configure which selector should be blocked, refer to the [privacy](#privacy) chapter                                                                                          |
- * | ignoreClass              | 'rr-ignore'        | Use a string or RegExp to configure which elements should be ignored, refer to the [privacy](#privacy) chapter                                                                                |
- * | ignoreSelector           | null               | Use a string to configure which selector should be ignored, refer to the [privacy](#privacy) chapter                                                                                          |
- * | ignoreCSSAttributes      | null               | array of CSS attributes that should be ignored                                                                                                                                                |
- * | maskTextClass            | 'rr-mask'          | Use a string or RegExp to configure which elements should be masked, refer to the [privacy](#privacy) chapter                                                                                 |
- * | maskTextSelector         | null               | Use a string to configure which selector should be masked, refer to the [privacy](#privacy) chapter                                                                                           |
- * | maskAllInputs            | false              | mask all input content as \*                                                                                                                                                                  |
- * | maskInputOptions         | { password: true } | mask some kinds of input \*<br />refer to the [list](https://github.com/rrweb-io/rrweb/blob/588164aa12f1d94576f89ae0210b98f6e971c895/packages/rrweb-snapshot/src/types.ts#L77-L95)            |
- * | maskInputFn              | -                  | customize mask input content recording logic                                                                                                                                                  |
- * | maskTextFn               | -                  | customize mask text content recording logic                                                                                                                                                   |
- * | slimDOMOptions           | {}                 | remove unnecessary parts of the DOM <br />refer to the [list](https://github.com/rrweb-io/rrweb/blob/588164aa12f1d94576f89ae0210b98f6e971c895/packages/rrweb-snapshot/src/types.ts#L97-L108)  |
- * | dataURLOptions           | {}                 | Canvas image format and quality ,This parameter will be passed to the OffscreenCanvas.convertToBlob(),Using this parameter effectively reduces the size of the recorded data                  |
- * | inlineStylesheet         | true               | whether to inline the stylesheet in the events                                                                                                                                                |
- * | hooks                    | {}                 | hooks for events<br />refer to the [list](https://github.com/rrweb-io/rrweb/blob/9488deb6d54a5f04350c063d942da5e96ab74075/src/types.ts#L207)                                                  |
- * | packFn                   | -                  | refer to the [storage optimization recipe](./docs/recipes/optimize-storage.md)                                                                                                                |
- * | sampling                 | -                  | refer to the [storage optimization recipe](./docs/recipes/optimize-storage.md)                                                                                                                |
- * | recordCanvas             | false              | Whether to record the canvas element. Available options:<br/>`false`, <br/>`true`                                                                                                             |
- * | recordCrossOriginIframes | false              | Whether to record cross origin iframes. rrweb has to be injected in each child iframe for this to work. Available options:<br/>`false`, <br/>`true`                                           |
- * | recordAfter              | 'load'             | If the document is not ready, then the recorder will start recording after the specified event is fired. Available options: `DOMContentLoaded`, `load`                                        |
- * | inlineImages             | false              | whether to record the image content                                                                                                                                                           |
- * | collectFonts             | false              | whether to collect fonts in the website                                                                                                                                                       |
- * | userTriggeredOnInput     | false              | whether to add `userTriggered` on input events that indicates if this event was triggered directly by the user or not. [What is `userTriggered`?](https://github.com/rrweb-io/rrweb/pull/495) |
- * | plugins                  | []                 | load plugins to provide extended record functions. [What is plugins?](./docs/recipes/plugin.md)                                                                                               |
- * | errorHandler             | -                  | A callback that is called if something inside of rrweb throws an error. The callback receives the error as argument.
- */
 export interface SessionRecordingConfig extends Omit<recordOptions<eventWithTime>, 'emit' | 'packFn' | 'plugins' | 'hooks' | 'slimDOMOptions'> {
     enable: boolean;
     autoStartSessionRecording: boolean;
     recordConsoleEvents?: boolean;
     maxMutations?: number;
     excludeDOMOptions?: SlimDOMOptions;
-    /** Percentage of overall sessions recording being tracked, defaults to 100% and applied after the overall sample rate sessionSampleRate  */
     sessionRecordingSampleRate?: number;
     workerUrl?: string;
 }
@@ -50,11 +15,6 @@ export interface SessionWithErrorConfig {
     enable: boolean;
     maxRumEvents?: number;
     maxRecordTime?: number;
-    /**
-     * Specifies the instrumentation data to be sent for sessions with errors, defaulting to web-vitals only.
-     * The instrumentation data will only be sent if it is enabled in the main configuration.
-     * This data will be sent immediately, even if no error has occurred.
-     */
     instrumentationsToSend?: Partial<Record<CoralogixEventType, boolean>>;
 }
 export interface SessionConfig {

package/src/tools/addEventListener.d.ts

@@ -10,16 +10,9 @@ type EventMap<T> = T extends Window ? WindowEventMap & {
     freeze: Event;
     resume: Event;
 } : T extends Document ? DocumentEventMap : T extends HTMLElement ? HTMLElementEventMap : T extends VisualViewport ? VisualViewportEventMap : T extends ShadowRoot ? GlobalEventHandlersEventMap : T extends XMLHttpRequest ? XMLHttpRequestEventMap : T extends Performance ? PerformanceEventMap : T extends Worker ? WorkerEventMap : Record<never, never>;
-/**
- * Add an event listener to an event target object (Window, Element, mock...).
- * Returns a `stop` function to remove the listener
- */
 export declare function addEventListener<Target extends EventTarget, EventName extends keyof EventMap<Target> & string>(eventTarget: Target, eventName: EventName, listener: (event: EventMap<Target>[EventName]) => void, options?: AddEventListenerOptions): {
     stop: () => void;
 };
-/**
- * Add event listeners to an event target object.
- */
 export declare function addEventListeners<Target extends EventTarget, EventName extends keyof EventMap<Target> & string>(eventTarget: Target, eventNames: EventName[], listener: (event: EventMap<Target>[EventName]) => void, { once, capture, passive }?: AddEventListenerOptions): {
     stop: () => void;
 };

package/src/tools/getZoneJsOriginalDom.d.ts

@@ -3,7 +3,4 @@ export interface BrowserWindowWithZoneJs extends Window {
         __symbol__?: (name: string) => string;
     };
 }
-/**
- * Gets the original value for a DOM API that was potentially patched by Zone.js.
- */
 export declare function getZoneJsOriginalDom<Target, Name extends keyof Target & string>(target: Target, name: Name): Target[Name];

package/src/types.d.ts

@@ -81,15 +81,9 @@ export interface ApplicationContextConfig {
 export interface TraceHeaderConfiguration {
     enabled: boolean;
     options?: {
-        /** urls outside of origin that should also add Traceparent to header */
         propagateTraceHeaderCorsUrls?: Array<string | RegExp>;
-        /** first-party origins urls called by your browser application.
-         * If array is passed, only urls that match the array will add Traceparent to header.
-         * */
         allowedTracingUrls?: Array<string | RegExp>;
-        /** provides HTTP header propagation for systems that are using AWS X-Amzn-Trace-Id format. */
         propagateAwsXrayTraceHeader?: boolean;
-        /** provides HTTP header propagation for systems that are using B3 format. */
         propagateB3TraceHeader?: {
             singleHeader?: boolean;
             multiHeader?: boolean;
@@ -133,134 +127,53 @@ export interface NetworkExtraConfig {
     collectResPayload?: boolean;
 }
 export interface CoralogixBrowserSdkConfig {
-    /** Publicly-visible `public_key` value */
     public_key?: string;
-    /** Sets a value for the `application` attribute */
     application: string;
-    /** Coralogix account domain */
     coralogixDomain: CoralogixDomain;
-    /** Sets a value for the 'app.version' attribute */
     version: string;
-    /** Configuration for user context. */
     user_context?: UserContextConfig;
-    /** Turns on/off internal debug logging */
     debug?: boolean;
-    /** Sets labels added to every Span. */
     labels?: CoralogixRumLabels;
-    /**
-     * Applies for XHR and Fetch URLs. URLs that partially match any regex in ignoreUrls will not be traced.
-     * In addition, URLs that are _exact matches_ of strings in ignoreUrls will also not be traced.
-     * */
     ignoreUrls?: Array<string | RegExp>;
-    /**
-     A pattern for error messages which should not be sent to Coralogix. By default, all errors will be sent.
-     * */
     ignoreErrors?: Array<string | RegExp>;
-    /** Configuration for instrumentation modules. */
     instrumentations?: CoralogixOtelWebOptionsInstrumentations;
-    /** Add trace context propagation in headers across service boundaries */
     traceParentInHeader?: TraceHeaderConfiguration;
-    /** Sets a value for the `environment` attribute */
     environment?: string;
-    /** Stringify custom log data property */
     stringifyCustomLogData?: boolean;
-    /** Modify the event's page or network url based on custom-defined functions */
     urlBlueprinters?: UrlBlueprinters;
-    /** Sets recording config for session replay */
     sessionRecordingConfig?: SessionRecordingConfig;
-    /** Sets session config */
     sessionConfig?: SessionConfig;
-    /** Provide labels based on url or event */
     labelProviders?: Array<LabelProvider>;
-    /**
-     * @deprecated Use `sessionConfig` instead.
-     * Percentage of overall sessions being tracked, defaults to 100%
-     * */
     sessionSampleRate?: number;
-    /** Mask input types, defaults to ['password', 'email', 'tel'] */
     maskInputTypes?: InputType[];
-    /** Class name that will mask elements, string or RegExp. defaults to 'cx-mask' */
     maskClass?: string | RegExp;
-    /** Enable event access and modification before sending to Coralogix, supporting content modification, and event discarding. */
     beforeSend?: (event: EditableCxRumEvent) => BeforeSendResult;
-    /** Send requests through a proxy */
     proxyUrl?: string;
-    /** Collect IP address and geolocation data. Defaults to true. */
     collectIPData?: boolean;
-    /** Track soft navigations such as SPA navigations. Defaults to false  */
     trackSoftNavigations?: boolean;
-    /** Measure memory usage
-     * @prop enabled Enable memory usage measurement. Defaults to false
-     * @prop interval usage will be measured every `interval` millisecond. Default to 5 minutes.
-     * */
     memoryUsageConfig?: MemoryUsageConfig;
-    /** networkExtraConfig is an array of rules for capturing and enhancing network request and response data,
-     * including headers and payloads, from Fetch and XMLHttpRequest. */
     networkExtraConfig?: NetworkExtraConfig[];
-    /** Enable MFE support. Defaults to false */
     supportMfe?: boolean;
-    /** Enable Web Worker support. Defaults to false */
     workerSupport?: boolean;
 }
 export interface CoralogixOtelWebType extends SendLog {
-    /**
-     * Init CoralogixRum.
-     */
     init: (options: CoralogixBrowserSdkConfig) => void;
-    /**
-     * Turn CoralogixRum off.
-     */
     shutdown: () => void;
-    /** Sets labels to be added to every log after CoralogixRum initialization. */
     setLabels: (labels: CoralogixRumLabels) => void;
-    /**
-     * Provides access to computed, final value of global attributes, which are applied to all created logs.
-     */
     getLabels: () => CoralogixRumLabels;
-    /** Sets user context to be added to every log after CoralogixRum initialization. */
     setUserContext: (userContext: UserContextConfig) => void;
-    /** Sets application context to be added to every log after CoralogixRum initialization. */
     setApplicationContext: (applicationContext: ApplicationContextConfig) => void;
-    /** Manually capture error. */
     captureError: (error: Error, customData?: unknown, labels?: CoralogixRumLabels) => void;
-    /** Manually send custom measurement. */
     sendCustomMeasurement: (name: string, value: CustomMeasurementData) => void;
-    /** Add extra performance timing. */
     addTiming: (name: string, duration?: number) => void;
-    /** Manually measure user-agent-specific memory. */
     measureUserAgentSpecificMemory: () => void;
-    /**
-     * Provides access to computed, final value of user context, which applied to all created logs.
-     */
     getUserContext: () => UserContextConfig | undefined;
-    /**
-     * Provides the session id.
-     */
     getSessionId: () => string | undefined;
-    /**
-     * Stop session recording
-     */
     stopSessionRecording: () => void;
-    /**
-     * Start session recording
-     */
     startSessionRecording: () => void;
-    /**
-     * Take screenshot
-     */
     screenshot: (description?: string) => string | undefined;
-    /**
-     * Starts measuring time for a given key. Key should be a unique identifier for the measurement.
-     */
     startTimeMeasure: (name: string, labels?: CoralogixRumLabels) => void;
-    /**
-     * Ends the measurement for a given key.
-     */
     endTimeMeasure: (name: string) => void;
-    /**
-     * Starts a new custom trace.
-     @param ignoredInstruments - list of instruments to ignore in the trace
-     */
     getCustomTracer: (ignoredList?: {
         ignoredInstruments: CustomTracerIgnoredInstruments[];
     }) => CustomTracer | undefined;

package/src/utils/array.d.ts

@@ -1,10 +1 @@
-/**
- * Ensures a given value is converted into an array of elements.
- *
- * @template T - The type of the input value and the elements in the resulting array.
- *
- * @param value - The input value, which can be a single instance of type `T`, an array of instances of type `T`, or a Set of instances of type `T`.
- *
- * @returns An array of elements of type `T`. If the input is `null` or `undefined`, returns an empty array.
- */
 export declare function coerceArray<T>(value: T | T[]): T[];

package/src/utils/general.d.ts

@@ -1,7 +1 @@
-/**
- * Checks if value is null or undefined.
- *
- * @param value The value to check.
- * @returns Returns true if value is null or undefined, else false.
- */
 export declare function isNil(value: any): boolean;

package/src/utils/object.d.ts

@@ -2,34 +2,8 @@ export declare function isObject(value: unknown): 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)];
-/**
- * Creates an object composed of the properties of the input object, excluding the specified paths.
- *
- * @param object The source object from which to omit properties.
- * @param paths An array or a single path (including nested paths) to omit from the source object.
- * @returns Returns a new object with the specified paths omitted.
- */
 export declare function omit<const T extends Record<string, any>, const K extends string | NestedKeyOf<T>>(object?: T, ...paths: K[]): Omit<T, K> | Partial<T> | T;
-/**
- * Creates an object composed of the picked object properties, including support for nested paths.
- *
- * @param object The source object from which to pick properties.
- * @param keys An array or a single key (including nested paths) to pick from the source object.
- * @returns Returns a new object with properties picked from the source object.
- */
 export declare function pick<const T extends Record<string, any>, const K extends string | NestedKeyOf<T>>(object?: T, ...keys: K[]): Pick<T, K> | Partial<T> | T;
-/**
- * Checks if a Set, Array, Map, or Object is empty.
- *
- * @param value - The value to check.
- * @returns Returns true if the value is an empty Set, Map, Array, String or Object, else false.
- */
 export declare function isEmpty(value: any): boolean;
-/**
- * Checks if a Set, Array, Map, or Object is not empty.
- *
- * @param value - The value to check.
- * @returns Returns false if the value is an empty Set, Map, Array, String or Object, else true.
- */
 export declare function isNotEmpty(value: any): boolean;
 export {};

package/src/utils/string.d.ts

@@ -1,7 +1,3 @@
 export declare function isMatchingPattern(value: string, pattern: RegExp | string, requireExactStringMatch?: boolean): boolean;
 export declare function stringMatchesSomePattern(testString: string, patterns?: Array<string | RegExp>, requireExactStringMatch?: boolean): boolean;
-/**
- * UUID v4
- * https://gist.github.com/jed/982883
- */
 export declare function generateUUID(placeholder?: string): string;

package/src/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "2.8.5";
+export declare const SDK_VERSION = "2.8.6";