@kubesense/kubesense-browser-rum-core 1.8.0 → 2.0.0-beta.1

package/src/rawRumEvent.types.ts

@@ -1,14 +1,13 @@
+import type { Duration, ServerDuration, TimeStamp } from '@kubesense/kubesense-js-core/time'
 import type {
-  Duration,
   ErrorSource,
   ErrorHandling,
   ResourceType,
-  ServerDuration,
-  TimeStamp,
   RawErrorCause,
   DefaultPrivacyLevel,
   Csp,
   Context,
+  DebugIdEntry,
 } from '@kubesense/kubesense-browser-core'
 import type { GraphQlMetadata } from './domain/resource/graphql'
 import type { PageState } from './domain/contexts/pageStateHistory'
@@ -26,6 +25,7 @@ export const RumEventType = {
   ERROR: 'error',
   LONG_TASK: 'long_task',
   VIEW: 'view',
+  VIEW_UPDATE: 'view_update',
   RESOURCE: 'resource',
   VITAL: 'vital',
 } as const
@@ -33,12 +33,7 @@ export const RumEventType = {
 export type RumEventType = (typeof RumEventType)[keyof typeof RumEventType]
 
 export type AssembledRumEvent = (
-  | RumViewEvent
-  | RumActionEvent
-  | RumResourceEvent
-  | RumErrorEvent
-  | RumVitalEvent
-  | RumLongTaskEvent
+  RumViewEvent | RumActionEvent | RumResourceEvent | RumErrorEvent | RumVitalEvent | RumLongTaskEvent
 ) &
   Context
 
@@ -74,6 +69,9 @@ export interface RawRumResourceEvent {
     protocol?: string
     delivery_type?: DeliveryType
     graphql?: GraphQlMetadata
+    websocket?: WebSocketResourceProperties
+    request?: ResourceRequest
+    response?: ResourceResponse
     provider?: {
       domain?: string
       name?: string
@@ -98,9 +96,43 @@ export interface RawRumResourceEvent {
     trace_id?: string
     span_id?: string // not available for initial document tracing
     rule_psr?: number
-    discarded: boolean
+    discarded?: boolean
     page_states?: PageStateServerEntry[]
   }
+  context?: Context
+}
+
+export interface WebSocketResourceProperties {
+  connection_id: string
+  handshake_succeeded: boolean
+  start_time: TimeStamp
+  end_time: TimeStamp
+  start_view_id?: string
+  end_view_id?: string
+  tracking_end_reason: 'close_event' | 'session_end'
+  close_code?: number
+  close_reason?: string
+  was_clean?: boolean
+  messages_in: { count: number; size: number }
+  messages_out: { count: number; size: number }
+  time_to_first_message_in?: ServerDuration
+  time_to_first_message_out?: ServerDuration
+  last_message_in_at?: TimeStamp
+  longest_inbound_silence: ServerDuration
+  inbound_idle_duration_before_close?: ServerDuration
+  buffered_amount_max: number
+  protocol?: string
+  setup_duration: ServerDuration
+}
+
+export type NetworkHeaders = Record<string, string>
+
+export interface ResourceRequest {
+  headers?: NetworkHeaders
+}
+
+export interface ResourceResponse {
+  headers?: NetworkHeaders
 }
 
 export interface ResourceEntryDetailsElement {
@@ -125,8 +157,9 @@ export interface RawRumErrorEvent {
     source_type: 'browser'
     csp?: Csp
   }
-  _kubesense: {
-    discarded: boolean
+  _kubesense?: {
+    debug_ids?: DebugIdEntry[]
+    discarded?: boolean
   }
   view?: {
     in_foreground: boolean
@@ -141,9 +174,6 @@ export interface RawRumViewEvent {
     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
@@ -183,6 +213,7 @@ export interface RawRumViewEvent {
     }
     configuration: {
       start_session_replay_recording_manually: boolean
+      remote_configuration_id?: string
     }
   }
   device?: {
@@ -192,6 +223,19 @@ export interface RawRumViewEvent {
   }
 }
 
+export interface RawRumViewUpdateEvent {
+  date: TimeStamp
+  type: typeof RumEventType.VIEW_UPDATE
+  view: Partial<RawRumViewEvent['view']>
+  _kubesense: Partial<RawRumViewEvent['_kubesense']> & {
+    document_version: number
+  }
+  display?: Partial<ViewDisplay>
+  privacy?: RawRumViewEvent['privacy']
+  device?: RawRumViewEvent['device']
+  feature_flags?: Context
+}
+
 interface ViewDisplay {
   scroll: {
     max_depth?: number
@@ -212,20 +256,25 @@ export interface ViewPerformanceData {
   fcp?: {
     timestamp: number
   }
-  fid?: {
-    duration: ServerDuration
-    timestamp: ServerDuration
-    target_selector?: string
-  }
   inp?: {
     duration: ServerDuration
     timestamp?: ServerDuration
     target_selector?: string
+    sub_parts?: {
+      input_delay: ServerDuration
+      processing_duration: ServerDuration
+      presentation_delay: ServerDuration
+    }
   }
   lcp?: {
     timestamp: ServerDuration
     target_selector?: string
     resource_url?: string
+    sub_parts?: {
+      load_delay: ServerDuration
+      load_time: ServerDuration
+      render_delay: ServerDuration
+    }
   }
 }
 
@@ -245,6 +294,7 @@ export interface PageStateServerEntry {
 export const ViewLoadingType = {
   INITIAL_LOAD: 'initial_load',
   ROUTE_CHANGE: 'route_change',
+  SESSION_RENEWAL: 'session_renewal',
   BF_CACHE: 'bf_cache',
 } as const
 
@@ -256,6 +306,7 @@ export interface ViewCustomTimings {
 
 export interface ReplayStats {
   records_count: number
+  resources_count: number
   segments_count: number
   segments_total_raw_size: number
 }
@@ -280,12 +331,7 @@ export interface RawRumLongTaskEvent {
 export type DeliveryType = 'cache' | 'navigational-prefetch' | 'other'
 
 export type InvokerType =
-  | 'user-callback'
-  | 'event-listener'
-  | 'resolve-promise'
-  | 'reject-promise'
-  | 'classic-script'
-  | 'module-script'
+  'user-callback' | 'event-listener' | 'resolve-promise' | 'reject-promise' | 'classic-script' | 'module-script'
 
 export interface RawRumLongAnimationFrameEvent {
   date: TimeStamp
@@ -315,6 +361,7 @@ export interface RawRumLongAnimationFrameEvent {
   }
   _kubesense: {
     discarded: boolean
+    debug_ids?: DebugIdEntry[]
   }
 }
 
@@ -344,6 +391,7 @@ export interface RawRumActionEvent {
         selector?: string
         width?: number
         height?: number
+        composed_path_selector?: string
       }
       name_source?: string
       position?: {
@@ -359,6 +407,11 @@ export interface RawRumActionEvent {
 export const ActionType = {
   CLICK: 'click',
   CUSTOM: 'custom',
+  TAP: 'tap',
+  SCROLL: 'scroll',
+  SWIPE: 'swipe',
+  APPLICATION_START: 'application_start',
+  BACK: 'back',
 } as const
 
 export type ActionType = (typeof ActionType)[keyof typeof ActionType]
@@ -403,6 +456,7 @@ export type RawRumEvent =
   | RawRumErrorEvent
   | RawRumResourceEvent
   | RawRumViewEvent
+  | RawRumViewUpdateEvent
   | RawRumLongTaskEvent
   | RawRumLongAnimationFrameEvent
   | RawRumActionEvent