@sentry/replay - npm Package Compare versions

Comparing version 0.5.15 to 0.5.16

dist/config/types/src/api/captureReplayEvent.d.ts

 import { InitialState } from '@/types';
 export interface CaptureReplayEventParams {
+    /**
+     * Initial state of the replay
+     */
     initialState: InitialState;
+    /**
+     * Include a timestamp that should be deemed as the "starting" timestamp of the
+     * replay. This usually comes from a `window.performance` entry.
+     */
     includeReplayStartTimestamp: boolean;
+    /**
+     * List of error ids contained in current recording segment
+     */
     errorIds: string[];
+    /**
+     * The current replay id
+     */
     replayId: string;
+    /**
+     * The current recording segment id
+     */
     segmentId: number;
@@ -12,5 +28,11 @@ /**
     timestamp: number;
+    /**
+     * List of trace ids contained in current recording segment
+     */
     traceIds: string[];
+    /**
+     * List of URLs visisted in current recording segment
+     */
     urls: string[];
 }
 export declare function captureReplayEvent({ initialState, includeReplayStartTimestamp, errorIds, replayId: replay_id, segmentId: segment_id, timestamp, traceIds, urls, }: CaptureReplayEventParams): void;

dist/config/types/src/createPerformanceEntry.d.ts

@@ -0,1 +1,2 @@
+import { AllPerformanceEntry } from './types';
 export interface ReplayPerformanceEntry {
@@ -28,3 +29,3 @@ /**
 }
-export declare function createPerformanceEntries(entries: PerformanceEntry[]): ReplayPerformanceEntry[];
+export declare function createPerformanceEntries(entries: AllPerformanceEntry[]): ReplayPerformanceEntry[];
 export declare function createMemoryEntry(memoryEntry: MemoryInfo): {
@@ -31,0 +32,0 @@ type: string;

dist/config/types/src/index.d.ts

@@ -0,1 +1,2 @@
+/// <reference types="lodash" />
 import { Breadcrumb, Event, Integration } from '@sentry/types';
@@ -6,3 +7,3 @@ import { CaptureReplayEventParams } from './api/captureReplayEvent';
 import { IEventBuffer } from './eventBuffer';
-import type { InstrumentationTypeBreadcrumb, InstrumentationTypeSpan, RecordedEvents, RecordingConfig, RecordingEvent, ReplayRequest, SentryReplayConfiguration, SentryReplayPluginOptions } from './types';
+import type { AllPerformanceEntry, InstrumentationTypeBreadcrumb, InstrumentationTypeSpan, RecordedEvents, RecordingConfig, RecordingEvent, ReplayRequest, SentryReplayConfiguration, SentryReplayPluginOptions } from './types';
 /**
@@ -25,3 +26,3 @@ * Returns true to return control to calling function, otherwise continue with normal batching
      */
-    performanceEvents: PerformanceEntry[];
+    performanceEvents: AllPerformanceEntry[];
     /**
@@ -50,2 +51,3 @@ * Options to pass to `rrweb.record()`
     private newSessionCreated;
+    private flushLock;
     /**
@@ -216,7 +218,12 @@ * Is the integration currently active?
     /**
+     * Clear context
+     */
+    clearContext(): void;
+    /**
      * Return and clear context
      */
-    popEventContext({ timestamp, }?: {
-        timestamp?: number;
-    }): CaptureReplayEventParams;
+    popEventContext({ timestamp, }: {
+        timestamp: number;
+    }): Omit<CaptureReplayEventParams, 'includeReplayStartTimestamp' | 'segmentId' | 'replayId'>;
+    runFlush(): Promise<void>;
     /**
@@ -228,3 +235,4 @@ * Flushes replay event buffer to Sentry.
      */
-    flushUpdate(): Promise<void>;
+    flushUpdate: () => Promise<void>;
+    throttledFlushUpdate: import("lodash").DebouncedFunc<() => Promise<void>>;
     /**
@@ -231,0 +239,0 @@ * Send replay attachment using `fetch()`

dist/config/types/src/types.d.ts

@@ -6,2 +6,3 @@ import { record } from 'rrweb';
 export declare type RecordedEvents = Uint8Array | string;
+export declare type AllPerformanceEntry = PerformancePaintTiming | PerformanceResourceTiming | PerformanceNavigationTiming;
 export interface ReplayRequest {
@@ -8,0 +9,0 @@ endpoint: string;

dist/types/src/api/captureReplayEvent.d.ts

 import { InitialState } from '@/types';
 export interface CaptureReplayEventParams {
+    /**
+     * Initial state of the replay
+     */
     initialState: InitialState;
+    /**
+     * Include a timestamp that should be deemed as the "starting" timestamp of the
+     * replay. This usually comes from a `window.performance` entry.
+     */
     includeReplayStartTimestamp: boolean;
+    /**
+     * List of error ids contained in current recording segment
+     */
     errorIds: string[];
+    /**
+     * The current replay id
+     */
     replayId: string;
+    /**
+     * The current recording segment id
+     */
     segmentId: number;
@@ -12,5 +28,11 @@ /**
     timestamp: number;
+    /**
+     * List of trace ids contained in current recording segment
+     */
     traceIds: string[];
+    /**
+     * List of URLs visisted in current recording segment
+     */
     urls: string[];
 }
 export declare function captureReplayEvent({ initialState, includeReplayStartTimestamp, errorIds, replayId: replay_id, segmentId: segment_id, timestamp, traceIds, urls, }: CaptureReplayEventParams): void;

dist/types/src/createPerformanceEntry.d.ts

@@ -0,1 +1,2 @@
+import { AllPerformanceEntry } from './types';
 export interface ReplayPerformanceEntry {
@@ -28,3 +29,3 @@ /**
 }
-export declare function createPerformanceEntries(entries: PerformanceEntry[]): ReplayPerformanceEntry[];
+export declare function createPerformanceEntries(entries: AllPerformanceEntry[]): ReplayPerformanceEntry[];
 export declare function createMemoryEntry(memoryEntry: MemoryInfo): {
@@ -31,0 +32,0 @@ type: string;

dist/types/src/index.d.ts

@@ -0,1 +1,2 @@
+/// <reference types="lodash" />
 import { Breadcrumb, Event, Integration } from '@sentry/types';
@@ -6,3 +7,3 @@ import { CaptureReplayEventParams } from './api/captureReplayEvent';
 import { IEventBuffer } from './eventBuffer';
-import type { InstrumentationTypeBreadcrumb, InstrumentationTypeSpan, RecordedEvents, RecordingConfig, RecordingEvent, ReplayRequest, SentryReplayConfiguration, SentryReplayPluginOptions } from './types';
+import type { AllPerformanceEntry, InstrumentationTypeBreadcrumb, InstrumentationTypeSpan, RecordedEvents, RecordingConfig, RecordingEvent, ReplayRequest, SentryReplayConfiguration, SentryReplayPluginOptions } from './types';
 /**
@@ -25,3 +26,3 @@ * Returns true to return control to calling function, otherwise continue with normal batching
      */
-    performanceEvents: PerformanceEntry[];
+    performanceEvents: AllPerformanceEntry[];
     /**
@@ -50,2 +51,3 @@ * Options to pass to `rrweb.record()`
     private newSessionCreated;
+    private flushLock;
     /**
@@ -216,7 +218,12 @@ * Is the integration currently active?
     /**
+     * Clear context
+     */
+    clearContext(): void;
+    /**
      * Return and clear context
      */
-    popEventContext({ timestamp, }?: {
-        timestamp?: number;
-    }): CaptureReplayEventParams;
+    popEventContext({ timestamp, }: {
+        timestamp: number;
+    }): Omit<CaptureReplayEventParams, 'includeReplayStartTimestamp' | 'segmentId' | 'replayId'>;
+    runFlush(): Promise<void>;
     /**
@@ -228,3 +235,4 @@ * Flushes replay event buffer to Sentry.
      */
-    flushUpdate(): Promise<void>;
+    flushUpdate: () => Promise<void>;
+    throttledFlushUpdate: import("lodash").DebouncedFunc<() => Promise<void>>;
     /**
@@ -231,0 +239,0 @@ * Send replay attachment using `fetch()`

dist/types/src/types.d.ts

@@ -6,2 +6,3 @@ import { record } from 'rrweb';
 export declare type RecordedEvents = Uint8Array | string;
+export declare type AllPerformanceEntry = PerformancePaintTiming | PerformanceResourceTiming | PerformanceNavigationTiming;
 export interface ReplayRequest {
@@ -8,0 +9,0 @@ endpoint: string;

package.json

 {
   "name": "@sentry/replay",
-  "version": "0.5.15",
+  "version": "0.5.16",
   "description": "User replays for Sentry",
@@ -47,2 +47,3 @@ "main": "dist/index.js",
     "@types/jest": "^28.1.1",
+    "@types/lodash.throttle": "^4.1.7",
     "@types/node": "^16.0.0",
@@ -75,2 +76,3 @@ "@types/pako": "^2.0.0",
     "@sentry/utils": "^7.7.0",
+    "lodash.throttle": "^4.1.1",
     "pako": "^2.0.4",
@@ -77,0 +79,0 @@ "rrweb": "^1.1.3"

No alert changes

Improved metrics

Total package byte prevSize

467831

increased by1.94%

Lines of code

5146

increased by3.04%

Worsened metrics

Dependency count

6

increased by20%

Dev dependency count

30

increased by3.45%

Dependency changes

• + Addedlodash.throttle@^4.1.1

• + Addedlodash.throttle@4.1.1(transitive)