@kubesense/kubesense-browser-rum-core 1.0.0

package/cjs/rawRumEvent.types.d.ts

@@ -0,0 +1,326 @@
+import type { Duration, ErrorSource, ErrorHandling, ResourceType, ServerDuration, TimeStamp, RawErrorCause, DefaultPrivacyLevel, Csp, Context } from '@kubesense/kubesense-browser-core';
+import type { GraphQlMetadata } from './domain/resource/graphql';
+import type { PageState } from './domain/contexts/pageStateHistory';
+import type { RumActionEvent, RumErrorEvent, RumLongTaskEvent, RumResourceEvent, RumViewEvent, RumVitalEvent } from './rumEvent.types';
+export declare const RumEventType: {
+    readonly ACTION: "action";
+    readonly ERROR: "error";
+    readonly LONG_TASK: "long_task";
+    readonly VIEW: "view";
+    readonly RESOURCE: "resource";
+    readonly VITAL: "vital";
+};
+export type RumEventType = (typeof RumEventType)[keyof typeof RumEventType];
+export type AssembledRumEvent = (RumViewEvent | RumActionEvent | RumResourceEvent | RumErrorEvent | RumVitalEvent | RumLongTaskEvent) & Context;
+export declare const RumLongTaskEntryType: {
+    readonly LONG_TASK: "long-task";
+    readonly LONG_ANIMATION_FRAME: "long-animation-frame";
+};
+export type RumLongTaskEntryType = (typeof RumLongTaskEntryType)[keyof typeof RumLongTaskEntryType];
+export interface RawRumResourceEvent {
+    date: TimeStamp;
+    type: typeof RumEventType.RESOURCE;
+    resource: {
+        type: ResourceType;
+        id: string;
+        duration?: ServerDuration;
+        url: string;
+        method?: string;
+        status_code?: number;
+        size?: number;
+        encoded_body_size?: number;
+        decoded_body_size?: number;
+        transfer_size?: number;
+        render_blocking_status?: string;
+        redirect?: ResourceEntryDetailsElement;
+        dns?: ResourceEntryDetailsElement;
+        connect?: ResourceEntryDetailsElement;
+        ssl?: ResourceEntryDetailsElement;
+        worker?: ResourceEntryDetailsElement;
+        first_byte?: ResourceEntryDetailsElement;
+        download?: ResourceEntryDetailsElement;
+        protocol?: string;
+        delivery_type?: DeliveryType;
+        graphql?: GraphQlMetadata;
+        provider?: {
+            domain?: string;
+            name?: string;
+            type?: 'ad' | 'advertising' | 'analytics' | 'cdn' | 'content' | 'customer-success' | 'first party' | 'hosting' | 'marketing' | 'other' | 'social' | 'tag-manager' | 'utility' | 'video';
+        };
+    };
+    _kubesense: {
+        trace_id?: string;
+        span_id?: string;
+        rule_psr?: number;
+        discarded: boolean;
+        page_states?: PageStateServerEntry[];
+    };
+}
+export interface ResourceEntryDetailsElement {
+    duration: ServerDuration;
+    start: ServerDuration;
+}
+export interface RawRumErrorEvent {
+    date: TimeStamp;
+    type: typeof RumEventType.ERROR;
+    error: {
+        id: string;
+        type?: string;
+        stack?: string;
+        handling_stack?: string;
+        component_stack?: string;
+        fingerprint?: string;
+        source: ErrorSource;
+        message: string;
+        handling?: ErrorHandling;
+        causes?: RawErrorCause[];
+        source_type: 'browser';
+        csp?: Csp;
+    };
+    _kubesense: {
+        discarded: boolean;
+    };
+    view?: {
+        in_foreground: boolean;
+    };
+    context?: Context;
+}
+export interface RawRumViewEvent {
+    date: TimeStamp;
+    type: typeof RumEventType.VIEW;
+    view: {
+        loading_type: ViewLoadingType;
+        first_byte?: ServerDuration;
+        first_contentful_paint?: ServerDuration;
+        first_input_delay?: ServerDuration;
+        first_input_time?: ServerDuration;
+        first_input_target_selector?: string;
+        interaction_to_next_paint?: ServerDuration;
+        interaction_to_next_paint_time?: ServerDuration;
+        interaction_to_next_paint_target_selector?: string;
+        cumulative_layout_shift?: number;
+        cumulative_layout_shift_time?: ServerDuration;
+        cumulative_layout_shift_target_selector?: string;
+        custom_timings?: {
+            [key: string]: ServerDuration;
+        };
+        largest_contentful_paint?: ServerDuration;
+        largest_contentful_paint_target_selector?: string;
+        dom_interactive?: ServerDuration;
+        dom_content_loaded?: ServerDuration;
+        dom_complete?: ServerDuration;
+        load_event?: ServerDuration;
+        loading_time?: ServerDuration;
+        time_spent: ServerDuration;
+        is_active: boolean;
+        name?: string;
+        error: Count;
+        action: Count;
+        long_task: Count;
+        resource: Count;
+        frustration: Count;
+        performance?: ViewPerformanceData;
+    };
+    display?: ViewDisplay;
+    privacy?: {
+        replay_level: DefaultPrivacyLevel;
+    };
+    _kubesense: {
+        document_version: number;
+        replay_stats?: ReplayStats;
+        page_states?: PageStateServerEntry[];
+        cls?: {
+            device_pixel_ratio: number;
+        };
+        configuration: {
+            start_session_replay_recording_manually: boolean;
+        };
+    };
+    device?: {
+        locale?: string;
+        locales?: readonly string[];
+        time_zone?: string;
+    };
+}
+interface ViewDisplay {
+    scroll: {
+        max_depth?: number;
+        max_depth_scroll_top?: number;
+        max_scroll_height?: number;
+        max_scroll_height_time?: ServerDuration;
+    };
+}
+export interface ViewPerformanceData {
+    cls?: {
+        score: number;
+        timestamp?: ServerDuration;
+        target_selector?: string;
+        previous_rect?: RumRect;
+        current_rect?: RumRect;
+    };
+    fcp?: {
+        timestamp: number;
+    };
+    fid?: {
+        duration: ServerDuration;
+        timestamp: ServerDuration;
+        target_selector?: string;
+    };
+    inp?: {
+        duration: ServerDuration;
+        timestamp?: ServerDuration;
+        target_selector?: string;
+    };
+    lcp?: {
+        timestamp: ServerDuration;
+        target_selector?: string;
+        resource_url?: string;
+    };
+}
+export interface RumRect {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+export interface PageStateServerEntry {
+    state: PageState;
+    start: ServerDuration;
+    [k: string]: unknown;
+}
+export declare const ViewLoadingType: {
+    readonly INITIAL_LOAD: "initial_load";
+    readonly ROUTE_CHANGE: "route_change";
+    readonly BF_CACHE: "bf_cache";
+};
+export type ViewLoadingType = (typeof ViewLoadingType)[keyof typeof ViewLoadingType];
+export interface ViewCustomTimings {
+    [key: string]: Duration;
+}
+export interface ReplayStats {
+    records_count: number;
+    segments_count: number;
+    segments_total_raw_size: number;
+}
+interface Count {
+    count: number;
+}
+export interface RawRumLongTaskEvent {
+    date: TimeStamp;
+    type: typeof RumEventType.LONG_TASK;
+    long_task: {
+        id: string;
+        entry_type: typeof RumLongTaskEntryType.LONG_TASK;
+        duration: ServerDuration;
+    };
+    _kubesense: {
+        discarded: boolean;
+    };
+}
+export type DeliveryType = 'cache' | 'navigational-prefetch' | 'other';
+export type InvokerType = 'user-callback' | 'event-listener' | 'resolve-promise' | 'reject-promise' | 'classic-script' | 'module-script';
+export interface RawRumLongAnimationFrameEvent {
+    date: TimeStamp;
+    type: typeof RumEventType.LONG_TASK;
+    long_task: {
+        id: string;
+        entry_type: typeof RumLongTaskEntryType.LONG_ANIMATION_FRAME;
+        duration: ServerDuration;
+        blocking_duration: ServerDuration;
+        first_ui_event_timestamp: ServerDuration;
+        render_start: ServerDuration;
+        style_and_layout_start: ServerDuration;
+        start_time: ServerDuration;
+        scripts: Array<{
+            duration: ServerDuration;
+            pause_duration: ServerDuration;
+            forced_style_and_layout_duration: ServerDuration;
+            start_time: ServerDuration;
+            execution_start: ServerDuration;
+            source_url: string;
+            source_function_name: string;
+            source_char_position: number;
+            invoker: string;
+            invoker_type: InvokerType;
+            window_attribution: string;
+        }>;
+    };
+    _kubesense: {
+        discarded: boolean;
+    };
+}
+export interface RawRumActionEvent {
+    date: TimeStamp;
+    type: typeof RumEventType.ACTION;
+    action: {
+        id: string;
+        type: ActionType;
+        loading_time?: ServerDuration;
+        frustration?: {
+            type: FrustrationType[];
+        };
+        error?: Count;
+        long_task?: Count;
+        resource?: Count;
+        target: {
+            name: string;
+        };
+    };
+    view?: {
+        in_foreground: boolean;
+    };
+    _kubesense?: {
+        action?: {
+            target?: {
+                selector?: string;
+                width?: number;
+                height?: number;
+            };
+            name_source?: string;
+            position?: {
+                x: number;
+                y: number;
+            };
+            pointer_up_delay?: Duration;
+        };
+    };
+    context?: Context;
+}
+export declare const ActionType: {
+    readonly CLICK: "click";
+    readonly CUSTOM: "custom";
+};
+export type ActionType = (typeof ActionType)[keyof typeof ActionType];
+export declare const FrustrationType: {
+    readonly RAGE_CLICK: "rage_click";
+    readonly ERROR_CLICK: "error_click";
+    readonly DEAD_CLICK: "dead_click";
+};
+export type FrustrationType = (typeof FrustrationType)[keyof typeof FrustrationType];
+export interface RawRumVitalEvent {
+    date: TimeStamp;
+    type: typeof RumEventType.VITAL;
+    vital: {
+        id: string;
+        name: string;
+        type: VitalType;
+        step_type?: string;
+        operation_key?: string;
+        failure_reason?: string;
+        description?: string;
+        duration?: number;
+    };
+    _kubesense?: {
+        vital: {
+            computed_value: true;
+        };
+    };
+    context?: Context;
+}
+export declare const VitalType: {
+    readonly DURATION: "duration";
+    readonly OPERATION_STEP: "operation_step";
+};
+export type VitalType = (typeof VitalType)[keyof typeof VitalType];
+export type RawRumEvent = RawRumErrorEvent | RawRumResourceEvent | RawRumViewEvent | RawRumLongTaskEvent | RawRumLongAnimationFrameEvent | RawRumActionEvent | RawRumVitalEvent;
+export {};

package/cjs/rawRumEvent.types.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VitalType = exports.FrustrationType = exports.ActionType = exports.ViewLoadingType = exports.RumLongTaskEntryType = exports.RumEventType = void 0;
+exports.RumEventType = {
+    ACTION: 'action',
+    ERROR: 'error',
+    LONG_TASK: 'long_task',
+    VIEW: 'view',
+    RESOURCE: 'resource',
+    VITAL: 'vital',
+};
+exports.RumLongTaskEntryType = {
+    LONG_TASK: 'long-task',
+    LONG_ANIMATION_FRAME: 'long-animation-frame',
+};
+exports.ViewLoadingType = {
+    INITIAL_LOAD: 'initial_load',
+    ROUTE_CHANGE: 'route_change',
+    BF_CACHE: 'bf_cache',
+};
+exports.ActionType = {
+    CLICK: 'click',
+    CUSTOM: 'custom',
+};
+exports.FrustrationType = {
+    RAGE_CLICK: 'rage_click',
+    ERROR_CLICK: 'error_click',
+    DEAD_CLICK: 'dead_click',
+};
+exports.VitalType = {
+    DURATION: 'duration',
+    OPERATION_STEP: 'operation_step',
+};
+//# sourceMappingURL=rawRumEvent.types.js.map

package/cjs/rawRumEvent.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rawRumEvent.types.js","sourceRoot":"","sources":["../src/rawRumEvent.types.ts"],"names":[],"mappings":";;;AAuBa,QAAA,YAAY,GAAG;IAC1B,MAAM,EAAE,QAAQ;IAChB,KAAK,EAAE,OAAO;IACd,SAAS,EAAE,WAAW;IACtB,IAAI,EAAE,MAAM;IACZ,QAAQ,EAAE,UAAU;IACpB,KAAK,EAAE,OAAO;CACN,CAAA;AAcG,QAAA,oBAAoB,GAAG;IAClC,SAAS,EAAE,WAAW;IACtB,oBAAoB,EAAE,sBAAsB;CACpC,CAAA;AAqMG,QAAA,eAAe,GAAG;IAC7B,YAAY,EAAE,cAAc;IAC5B,YAAY,EAAE,cAAc;IAC5B,QAAQ,EAAE,UAAU;CACZ,CAAA;AA8GG,QAAA,UAAU,GAAG;IACxB,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,QAAQ;CACR,CAAA;AAIG,QAAA,eAAe,GAAG;IAC7B,UAAU,EAAE,YAAY;IACxB,WAAW,EAAE,aAAa;IAC1B,UAAU,EAAE,YAAY;CAChB,CAAA;AAyBG,QAAA,SAAS,GAAG;IACvB,QAAQ,EAAE,UAAU;IACpB,cAAc,EAAE,gBAAgB;CACxB,CAAA"}