@sentry-internal/replay - npm Package Compare versions

Comparing version 8.8.0 to 8.9.0

package.json

 {
   "name": "@sentry-internal/replay",
-  "version": "8.8.0",
+  "version": "8.9.0",
   "description": "User replays for Sentry",
@@ -50,3 +50,3 @@ "main": "cjs/index.js",
     "@babel/core": "^7.17.5",
-    "@sentry-internal/replay-worker": "8.8.0",
+    "@sentry-internal/replay-worker": "8.9.0",
     "@sentry-internal/rrweb": "2.15.0",
@@ -59,6 +59,6 @@ "@sentry-internal/rrweb-snapshot": "2.15.0",
   "dependencies": {
-    "@sentry-internal/browser-utils": "8.8.0",
-    "@sentry/core": "8.8.0",
-    "@sentry/types": "8.8.0",
-    "@sentry/utils": "8.8.0"
+    "@sentry-internal/browser-utils": "8.9.0",
+    "@sentry/core": "8.9.0",
+    "@sentry/types": "8.9.0",
+    "@sentry/utils": "8.9.0"
   },
@@ -65,0 +65,0 @@ "engines": {

types-ts3.8/types/performance.d.ts

@@ -68,3 +68,3 @@ import { ReplayNetworkRequestOrResponse } from './request';
 };
-export interface LargestContentfulPaintData {
+export interface WebVitalData {
     /**
@@ -76,2 +76,7 @@ * Render time (in ms) of the LCP
     /**
+     * The rating as to whether the metric value is within the "good",
+     * "needs improvement", or "poor" thresholds of the metric.
+     */
+    rating: 'good' | 'needs-improvement' | 'poor';
+    /**
      * The recording id of the LCP node. -1 if not found
@@ -84,3 +89,3 @@ */
  */
-export type AllPerformanceEntryData = PaintData | NavigationData | ResourceData | LargestContentfulPaintData;
+export type AllPerformanceEntryData = PaintData | NavigationData | ResourceData | WebVitalData;
 export interface MemoryData {
@@ -87,0 +92,0 @@ memory: {

types-ts3.8/types/replayFrame.d.ts

 import { Breadcrumb } from '@sentry/types';
-import { HistoryData, LargestContentfulPaintData, MemoryData, NavigationData, NetworkRequestData, PaintData, ResourceData } from './performance';
+import { HistoryData, MemoryData, NavigationData, NetworkRequestData, PaintData, ResourceData, WebVitalData } from './performance';
 import { ReplayEventTypeCustom } from './rrweb';
@@ -123,5 +123,5 @@ type AnyRecord = Record<string, any>;
 }
-interface ReplayLargestContentfulPaintFrame extends ReplayBaseSpanFrame {
-    data: LargestContentfulPaintData;
-    op: 'largest-contentful-paint';
+interface ReplayWebVitalFrame extends ReplayBaseSpanFrame {
+    data: WebVitalData;
+    op: 'largest-contentful-paint' | 'cumulative-layout-shift' | 'first-input-delay' | 'interaction-to-next-paint';
 }
@@ -148,3 +148,3 @@ interface ReplayMemoryFrame extends ReplayBaseSpanFrame {
 }
-export type ReplaySpanFrame = ReplayBaseSpanFrame | ReplayHistoryFrame | ReplayRequestFrame | ReplayLargestContentfulPaintFrame | ReplayMemoryFrame | ReplayNavigationFrame | ReplayPaintFrame | ReplayResourceFrame;
+export type ReplaySpanFrame = ReplayBaseSpanFrame | ReplayHistoryFrame | ReplayRequestFrame | ReplayWebVitalFrame | ReplayMemoryFrame | ReplayNavigationFrame | ReplayPaintFrame | ReplayResourceFrame;
 export type ReplayFrame = ReplayBreadcrumbFrame | ReplaySpanFrame;
@@ -151,0 +151,0 @@ interface RecordingCustomEvent {

types-ts3.8/util/createPerformanceEntries.d.ts

@@ -1,3 +0,26 @@
-import { AllPerformanceEntry, AllPerformanceEntryData, LargestContentfulPaintData, ReplayPerformanceEntry } from '../types';
+import { AllPerformanceEntry, AllPerformanceEntryData, ReplayContainer, ReplayPerformanceEntry, WebVitalData } from '../types';
+export interface Metric {
+    /**
+     * The current value of the metric.
+     */
+    value: number;
+    /**
+     * The rating as to whether the metric value is within the "good",
+     * "needs improvement", or "poor" thresholds of the metric.
+     */
+    rating: 'good' | 'needs-improvement' | 'poor';
+    /**
+     * Any performance entries relevant to the metric value calculation.
+     * The array may also be empty if the metric value was not based on any
+     * entries (e.g. a CLS value of 0 given no layout shifts).
+     */
+    entries: PerformanceEntry[] | PerformanceEventTiming[];
+}
 /**
+ * Handler creater for web vitals
+ */
+export declare function webVitalHandler(getter: (metric: Metric) => ReplayPerformanceEntry<AllPerformanceEntryData>, replay: ReplayContainer): (data: {
+    metric: Metric;
+}) => void;
+/**
  * Create replay performance entries from the browser performance entries.
@@ -7,8 +30,21 @@ */
 /**
- * Add a LCP event to the replay based on an LCP metric.
+ * Add a LCP event to the replay based on a LCP metric.
  */
-export declare function getLargestContentfulPaint(metric: {
-    value: number;
-    entries: PerformanceEntry[];
-}): ReplayPerformanceEntry<LargestContentfulPaintData>;
+export declare function getLargestContentfulPaint(metric: Metric): ReplayPerformanceEntry<WebVitalData>;
+/**
+ * Add a CLS event to the replay based on a CLS metric.
+ */
+export declare function getCumulativeLayoutShift(metric: Metric): ReplayPerformanceEntry<WebVitalData>;
+/**
+ * Add a FID event to the replay based on a FID metric.
+ */
+export declare function getFirstInputDelay(metric: Metric): ReplayPerformanceEntry<WebVitalData>;
+/**
+ * Add an INP event to the replay based on an INP metric.
+ */
+export declare function getInteractionToNextPaint(metric: Metric): ReplayPerformanceEntry<WebVitalData>;
+/**
+ * Add an web vital event to the replay based on the web vital metric.
+ */
+export declare function getWebVital(metric: Metric, name: string, node: Node | undefined): ReplayPerformanceEntry<WebVitalData>;
 //# sourceMappingURL=createPerformanceEntries.d.ts.map

types/types/performance.d.ts

@@ -68,3 +68,3 @@ import type { ReplayNetworkRequestOrResponse } from './request';
 };
-export interface LargestContentfulPaintData {
+export interface WebVitalData {
     /**
@@ -76,2 +76,7 @@ * Render time (in ms) of the LCP
     /**
+     * The rating as to whether the metric value is within the "good",
+     * "needs improvement", or "poor" thresholds of the metric.
+     */
+    rating: 'good' | 'needs-improvement' | 'poor';
+    /**
      * The recording id of the LCP node. -1 if not found
@@ -84,3 +89,3 @@ */
  */
-export type AllPerformanceEntryData = PaintData | NavigationData | ResourceData | LargestContentfulPaintData;
+export type AllPerformanceEntryData = PaintData | NavigationData | ResourceData | WebVitalData;
 export interface MemoryData {
@@ -87,0 +92,0 @@ memory: {

types/types/replayFrame.d.ts

 import type { Breadcrumb } from '@sentry/types';
-import type { HistoryData, LargestContentfulPaintData, MemoryData, NavigationData, NetworkRequestData, PaintData, ResourceData } from './performance';
+import type { HistoryData, MemoryData, NavigationData, NetworkRequestData, PaintData, ResourceData, WebVitalData } from './performance';
 import type { ReplayEventTypeCustom } from './rrweb';
@@ -123,5 +123,5 @@ type AnyRecord = Record<string, any>;
 }
-interface ReplayLargestContentfulPaintFrame extends ReplayBaseSpanFrame {
-    data: LargestContentfulPaintData;
-    op: 'largest-contentful-paint';
+interface ReplayWebVitalFrame extends ReplayBaseSpanFrame {
+    data: WebVitalData;
+    op: 'largest-contentful-paint' | 'cumulative-layout-shift' | 'first-input-delay' | 'interaction-to-next-paint';
 }
@@ -148,3 +148,3 @@ interface ReplayMemoryFrame extends ReplayBaseSpanFrame {
 }
-export type ReplaySpanFrame = ReplayBaseSpanFrame | ReplayHistoryFrame | ReplayRequestFrame | ReplayLargestContentfulPaintFrame | ReplayMemoryFrame | ReplayNavigationFrame | ReplayPaintFrame | ReplayResourceFrame;
+export type ReplaySpanFrame = ReplayBaseSpanFrame | ReplayHistoryFrame | ReplayRequestFrame | ReplayWebVitalFrame | ReplayMemoryFrame | ReplayNavigationFrame | ReplayPaintFrame | ReplayResourceFrame;
 export type ReplayFrame = ReplayBreadcrumbFrame | ReplaySpanFrame;
@@ -151,0 +151,0 @@ interface RecordingCustomEvent {

types/util/createPerformanceEntries.d.ts

@@ -1,3 +0,26 @@
-import type { AllPerformanceEntry, AllPerformanceEntryData, LargestContentfulPaintData, ReplayPerformanceEntry } from '../types';
+import type { AllPerformanceEntry, AllPerformanceEntryData, ReplayContainer, ReplayPerformanceEntry, WebVitalData } from '../types';
+export interface Metric {
+    /**
+     * The current value of the metric.
+     */
+    value: number;
+    /**
+     * The rating as to whether the metric value is within the "good",
+     * "needs improvement", or "poor" thresholds of the metric.
+     */
+    rating: 'good' | 'needs-improvement' | 'poor';
+    /**
+     * Any performance entries relevant to the metric value calculation.
+     * The array may also be empty if the metric value was not based on any
+     * entries (e.g. a CLS value of 0 given no layout shifts).
+     */
+    entries: PerformanceEntry[] | PerformanceEventTiming[];
+}
 /**
+ * Handler creater for web vitals
+ */
+export declare function webVitalHandler(getter: (metric: Metric) => ReplayPerformanceEntry<AllPerformanceEntryData>, replay: ReplayContainer): (data: {
+    metric: Metric;
+}) => void;
+/**
  * Create replay performance entries from the browser performance entries.
@@ -7,8 +30,21 @@ */
 /**
- * Add a LCP event to the replay based on an LCP metric.
+ * Add a LCP event to the replay based on a LCP metric.
  */
-export declare function getLargestContentfulPaint(metric: {
-    value: number;
-    entries: PerformanceEntry[];
-}): ReplayPerformanceEntry<LargestContentfulPaintData>;
+export declare function getLargestContentfulPaint(metric: Metric): ReplayPerformanceEntry<WebVitalData>;
+/**
+ * Add a CLS event to the replay based on a CLS metric.
+ */
+export declare function getCumulativeLayoutShift(metric: Metric): ReplayPerformanceEntry<WebVitalData>;
+/**
+ * Add a FID event to the replay based on a FID metric.
+ */
+export declare function getFirstInputDelay(metric: Metric): ReplayPerformanceEntry<WebVitalData>;
+/**
+ * Add an INP event to the replay based on an INP metric.
+ */
+export declare function getInteractionToNextPaint(metric: Metric): ReplayPerformanceEntry<WebVitalData>;
+/**
+ * Add an web vital event to the replay based on the web vital metric.
+ */
+export declare function getWebVital(metric: Metric, name: string, node: Node | undefined): ReplayPerformanceEntry<WebVitalData>;
 //# sourceMappingURL=createPerformanceEntries.d.ts.map

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

3698940

increased by0.68%

Lines of code

21276

increased by0.83%

Dependency changes

• + Added@sentry-internal/browser-utils@8.9.0(transitive)

• + Added@sentry/core@8.9.0(transitive)

• + Added@sentry/types@8.9.0(transitive)

• + Added@sentry/utils@8.9.0(transitive)

• - Removed@sentry-internal/browser-utils@8.8.0(transitive)

• - Removed@sentry/core@8.8.0(transitive)

• - Removed@sentry/types@8.8.0(transitive)

• - Removed@sentry/utils@8.8.0(transitive)

• Updated@sentry-internal/browser-utils@8.9.0

• Updated@sentry/core@8.9.0

• Updated@sentry/types@8.9.0

• Updated@sentry/utils@8.9.0