feat: update types

Author: logaretm

packages/browser-utils/src/metrics/web-vitals/types.ts

@@ -30,6 +30,8 @@ interface PerformanceEntryMap {
   navigation: PerformanceNavigationTiming;
   resource: PerformanceResourceTiming;
   paint: PerformancePaintTiming;
+  'interaction-contentful-paint': InteractionContentfulPaint;
+  'soft-navigation': SoftNavigationEntry;
 }
 
 // Update built-in types to be more accurate.
@@ -45,27 +47,36 @@ declare global {
     getEntriesByType<K extends keyof PerformanceEntryMap>(type: K): PerformanceEntryMap[K][];
   }
 
+  // https://w3c.github.io/event-timing/#sec-modifications-perf-timeline
+  interface PerformancePaintTiming extends PerformanceEntry {
+    navigationId?: string;
+  }
+
   // https://w3c.github.io/event-timing/#sec-modifications-perf-timeline
   interface PerformanceObserverInit {
     durationThreshold?: number;
+    includeSoftNavigationObservations?: boolean;
   }
 
   // https://wicg.github.io/nav-speculation/prerendering.html#performance-navigation-timing-extension
   interface PerformanceNavigationTiming {
     activationStart?: number;
+    navigationId?: string;
   }
 
   // https://wicg.github.io/event-timing/#sec-performance-event-timing
   interface PerformanceEventTiming extends PerformanceEntry {
     duration: DOMHighResTimeStamp;
     interactionId: number;
+    navigationId?: string;
   }
 
   // https://wicg.github.io/layout-instability/#sec-layout-shift-attribution
   interface LayoutShiftAttribution {
     node: Node | null;
     previousRect: DOMRectReadOnly;
     currentRect: DOMRectReadOnly;
+    navigationId?: string;
   }
 
   // https://wicg.github.io/layout-instability/#sec-layout-shift
@@ -83,6 +94,22 @@ declare global {
     readonly id: string;
     readonly url: string;
     readonly element: Element | null;
+    navigationId?: string;
+  }
+
+  // https://github.com/WICG/soft-navigations
+  interface SoftNavigationEntry extends PerformanceEntry {
+    navigationId?: string;
+  }
+
+  interface InteractionContentfulPaint extends PerformanceEntry {
+    readonly renderTime: DOMHighResTimeStamp;
+    readonly loadTime: DOMHighResTimeStamp;
+    readonly size: number;
+    readonly id: string;
+    readonly url: string;
+    readonly element: Element | null;
+    navigationId?: string;
   }
 
   // https://w3c.github.io/long-animation-frame/#sec-PerformanceLongAnimationFrameTiming

packages/browser-utils/src/metrics/web-vitals/types/base.ts

@@ -72,8 +72,30 @@ export interface Metric {
    * - 'prerender': for pages that were prerendered.
    * - 'restore': for pages that were discarded by the browser and then
    * restored by the user.
+   * - 'soft-navigation': for soft navigations.
    */
-  navigationType: 'navigate' | 'reload' | 'back-forward' | 'back-forward-cache' | 'prerender' | 'restore';
+  navigationType:
+    | 'navigate'
+    | 'reload'
+    | 'back-forward'
+    | 'back-forward-cache'
+    | 'prerender'
+    | 'restore'
+    | 'soft-navigation';
+
+  /**
+   * The navigationId the metric happened for. This is particularly relevant for soft navigations where
+   * the metric may be reported for a previous URL.
+   *
+   * navigationIds are UUID strings.
+   */
+  navigationId: string;
+
+  /**
+   * The navigation URL the metric happened for. This is particularly relevant for soft navigations where
+   * the metric may be reported for a previous URL.
+   */
+  navigationURL?: string;
 }
 
 /** The union of supported metric types. */
@@ -113,6 +135,8 @@ export interface ReportCallback {
 
 export interface ReportOpts {
   reportAllChanges?: boolean;
+  durationThreshold?: number;
+  reportSoftNavs?: boolean;
 }
 
 export interface AttributionReportOpts extends ReportOpts {

packages/browser-utils/src/metrics/web-vitals/types/fcp.ts

@@ -52,9 +52,9 @@ export interface FCPAttribution {
   /**
    * The `navigation` entry of the current page, which is useful for diagnosing
    * general page load issues. This can be used to access `serverTiming` for example:
-   * navigationEntry?.serverTiming
+   * navigationEntry.serverTiming
    */
-  navigationEntry?: PerformanceNavigationTiming;
+  navigationEntry?: PerformanceNavigationTiming | SoftNavigationEntry;
 }
 
 /**

packages/browser-utils/src/metrics/web-vitals/types/lcp.ts

@@ -21,7 +21,7 @@ import type { Metric } from './base.js';
  */
 export interface LCPMetric extends Metric {
   name: 'LCP';
-  entries: LargestContentfulPaint[];
+  entries: (LargestContentfulPaint | InteractionContentfulPaint)[];
 }
 
 /**
@@ -70,18 +70,19 @@ export interface LCPAttribution {
   /**
    * The `navigation` entry of the current page, which is useful for diagnosing
    * general page load issues. This can be used to access `serverTiming` for example:
-   * navigationEntry?.serverTiming
+   * navigationEntry.serverTiming
    */
-  navigationEntry?: PerformanceNavigationTiming;
+  navigationEntry?: PerformanceNavigationTiming | SoftNavigationEntry;
   /**
    * The `resource` entry for the LCP resource (if applicable), which is useful
    * for diagnosing resource load issues.
    */
   lcpResourceEntry?: PerformanceResourceTiming;
   /**
-   * The `LargestContentfulPaint` entry corresponding to LCP.
+   * The `LargestContentfulPaint` entry corresponding to LCP
+   * (or `InteractionContentfulPaint` for soft navigations).
    */
-  lcpEntry?: LargestContentfulPaint;
+  lcpEntry?: LargestContentfulPaint | InteractionContentfulPaint;
 }
 
 /**

packages/browser-utils/src/metrics/web-vitals/types/ttfb.ts

@@ -21,7 +21,7 @@ import type { Metric } from './base';
  */
 export interface TTFBMetric extends Metric {
   name: 'TTFB';
-  entries: PerformanceNavigationTiming[];
+  entries: PerformanceNavigationTiming[] | SoftNavigationEntry[];
 }
 
 /**
@@ -65,9 +65,9 @@ export interface TTFBAttribution {
   /**
    * The `navigation` entry of the current page, which is useful for diagnosing
    * general page load issues. This can be used to access `serverTiming` for
-   * example: navigationEntry?.serverTiming
+   * example: navigationEntry.serverTiming
    */
-  navigationEntry?: PerformanceNavigationTiming;
+  navigationEntry?: PerformanceNavigationTiming | SoftNavigationEntry;
 }
 
 /**