@sentry/browser-utils 10.69.0 → 11.0.0-alpha.0

package/build/types-ts3.8/metrics/web-vitals/getINP.d.ts

@@ -1,34 +0,0 @@
-import { INPMetric, INPReportOpts, MetricRatingThresholds } from './types';
-/** Thresholds for INP. See https://web.dev/articles/inp#what_is_a_good_inp_score */
-export declare const INPThresholds: MetricRatingThresholds;
-/**
- * Calculates the [INP](https://web.dev/articles/inp) value for the current
- * page and calls the `callback` function once the value is ready, along with
- * the `event` performance entries reported for that interaction. The reported
- * value is a `DOMHighResTimeStamp`.
- *
- * A custom `durationThreshold` configuration option can optionally be passed
- * to control what `event-timing` entries are considered for INP reporting. The
- * default threshold is `40`, which means INP scores of less than 40 will not
- * be reported. To avoid reporting no interactions in these cases, the library
- * will fall back to the input delay of the first interaction. Note that this
- * will not affect your 75th percentile INP value unless that value is also
- * less than 40 (well below the recommended
- * [good](https://web.dev/articles/inp#what_is_a_good_inp_score) threshold).
- *
- * If the `reportAllChanges` configuration option is set to `true`, the
- * `callback` function will be called as soon as the value is initially
- * determined as well as any time the value changes throughout the page
- * lifespan.
- *
- * _**Important:** INP should be continually monitored for changes throughout
- * the entire lifespan of a page—including if the user returns to the page after
- * it's been hidden/backgrounded. However, since browsers often [will not fire
- * additional callbacks once the user has backgrounded a
- * page](https://developer.chrome.com/blog/page-lifecycle-api/#advice-hidden),
- * `callback` is always called when the page's visibility state changes to
- * hidden. As a result, the `callback` function might be called multiple times
- * during the same page load._
- */
-export declare const onINP: (onReport: (metric: INPMetric) => void, opts?: INPReportOpts) => void;
-//# sourceMappingURL=getINP.d.ts.map

package/build/types-ts3.8/metrics/web-vitals/getLCP.d.ts

@@ -1,16 +0,0 @@
-import { LCPMetric, MetricRatingThresholds, ReportOpts } from './types';
-/** Thresholds for LCP. See https://web.dev/articles/lcp#what_is_a_good_lcp_score */
-export declare const LCPThresholds: MetricRatingThresholds;
-/**
- * Calculates the [LCP](https://web.dev/articles/lcp) value for the current page and
- * calls the `callback` function once the value is ready (along with the
- * relevant `largest-contentful-paint` performance entry used to determine the
- * value). The reported value is a `DOMHighResTimeStamp`.
- *
- * If the `reportAllChanges` configuration option is set to `true`, the
- * `callback` function will be called any time a new `largest-contentful-paint`
- * performance entry is dispatched, or once the final value of the metric has
- * been determined.
- */
-export declare const onLCP: (onReport: (metric: LCPMetric) => void, opts?: ReportOpts) => void;
-//# sourceMappingURL=getLCP.d.ts.map

package/build/types-ts3.8/metrics/web-vitals/lib/InteractionManager.d.ts

@@ -1,37 +0,0 @@
-export interface Interaction {
-    _latency: number;
-    id: number;
-    entries: PerformanceEventTiming[];
-}
-/**
- *
- */
-export declare class InteractionManager {
-    /**
-     * A list of longest interactions on the page (by latency) sorted so the
-     * longest one is first. The list is at most MAX_INTERACTIONS_TO_CONSIDER
-     * long.
-     */
-    _longestInteractionList: Interaction[];
-    /**
-     * A mapping of longest interactions by their interaction ID.
-     * This is used for faster lookup.
-     */
-    _longestInteractionMap: Map<number, Interaction>;
-    _onBeforeProcessingEntry?: (entry: PerformanceEventTiming) => void;
-    _onAfterProcessingINPCandidate?: (interaction: Interaction) => void;
-    _resetInteractions(): void;
-    /**
-     * Returns the estimated p98 longest interaction based on the stored
-     * interaction candidates and the interaction count for the current page.
-     */
-    _estimateP98LongestInteraction(): Interaction | undefined;
-    /**
-     * Takes a performance entry and adds it to the list of worst interactions
-     * if its duration is long enough to make it among the worst. If the
-     * entry is part of an existing interaction, it is merged and the latency
-     * and entries list is updated as needed.
-     */
-    _processEntry(entry: PerformanceEventTiming): void;
-}
-//# sourceMappingURL=InteractionManager.d.ts.map

package/build/types-ts3.8/metrics/web-vitals/lib/LCPEntryManager.d.ts

@@ -1,5 +0,0 @@
-export declare class LCPEntryManager {
-    _onBeforeProcessingEntry?: (entry: LargestContentfulPaint) => void;
-    _processEntry(entry: LargestContentfulPaint): void;
-}
-//# sourceMappingURL=LCPEntryManager.d.ts.map

package/build/types-ts3.8/metrics/web-vitals/lib/LayoutShiftManager.d.ts

@@ -1,7 +0,0 @@
-export declare class LayoutShiftManager {
-    _onAfterProcessingUnexpectedShift?: (entry: LayoutShift) => void;
-    _sessionValue: number;
-    _sessionEntries: LayoutShift[];
-    _processEntry(entry: LayoutShift): void;
-}
-//# sourceMappingURL=LayoutShiftManager.d.ts.map

package/build/types-ts3.8/metrics/web-vitals/lib/bindReporter.d.ts

@@ -1,7 +0,0 @@
-import { MetricRatingThresholds, MetricType } from '../types';
-export declare const bindReporter: <MetricName extends MetricType["name"]>(callback: (metric: Extract<MetricType, {
-    name: MetricName;
-}>) => void, metric: Extract<MetricType, {
-    name: MetricName;
-}>, thresholds: MetricRatingThresholds, reportAllChanges?: boolean) => (forceReport?: boolean) => void;
-//# sourceMappingURL=bindReporter.d.ts.map

package/build/types-ts3.8/metrics/web-vitals/lib/generateUniqueID.d.ts

@@ -1,7 +0,0 @@
-/**
- * Performantly generate a unique, 30-char string by combining a version
- * number, the current timestamp with a 13-digit number integer.
- * @return {string}
- */
-export declare const generateUniqueID: () => string;
-//# sourceMappingURL=generateUniqueID.d.ts.map

package/build/types-ts3.8/metrics/web-vitals/lib/getActivationStart.d.ts

@@ -1,2 +0,0 @@
-export declare const getActivationStart: () => number;
-//# sourceMappingURL=getActivationStart.d.ts.map

package/build/types-ts3.8/metrics/web-vitals/lib/getNavigationEntry.d.ts

@@ -1,2 +0,0 @@
-export declare const getNavigationEntry: (checkResponseStart?: boolean) => PerformanceNavigationTiming | void;
-//# sourceMappingURL=getNavigationEntry.d.ts.map

package/build/types-ts3.8/metrics/web-vitals/lib/getVisibilityWatcher.d.ts

@@ -1,5 +0,0 @@
-export declare const getVisibilityWatcher: () => {
-    readonly firstHiddenTime: number;
-    onHidden(cb: () => void): void;
-};
-//# sourceMappingURL=getVisibilityWatcher.d.ts.map

package/build/types-ts3.8/metrics/web-vitals/lib/globalListeners.d.ts

@@ -1,11 +0,0 @@
-/**
- * web-vitals 5.1.0 switched listeners to be added on the window rather than the document.
- * Instead of having to check for window/document every time we add a listener, we can use this function.
- */
-export declare function addPageListener(type: string, listener: EventListener, options?: boolean | AddEventListenerOptions): void;
-/**
- * web-vitals 5.1.0 switched listeners to be removed from the window rather than the document.
- * Instead of having to check for window/document every time we remove a listener, we can use this function.
- */
-export declare function removePageListener(type: string, listener: EventListener, options?: boolean | AddEventListenerOptions): void;
-//# sourceMappingURL=globalListeners.d.ts.map

package/build/types-ts3.8/metrics/web-vitals/lib/initMetric.d.ts

@@ -1,21 +0,0 @@
-import { MetricType } from '../types';
-export declare const initMetric: <MetricName extends MetricType["name"]>(name: MetricName, value?: number) => {
-    name: MetricName;
-    value: number;
-    rating: "good";
-    delta: number;
-    entries: (Extract<import("../types").CLSMetric, {
-        name: MetricName;
-    }> | Extract<import("../types").FCPMetric, {
-        name: MetricName;
-    }> | Extract<import("../types").INPMetric, {
-        name: MetricName;
-    }> | Extract<import("../types").LCPMetric, {
-        name: MetricName;
-    }> | Extract<import("../types").TTFBMetric, {
-        name: MetricName;
-    }>)["entries"];
-    id: string;
-    navigationType: "navigate" | "reload" | "back-forward" | "back-forward-cache" | "prerender" | "restore";
-};
-//# sourceMappingURL=initMetric.d.ts.map

package/build/types-ts3.8/metrics/web-vitals/lib/initUnique.d.ts

@@ -1,7 +0,0 @@
-/**
- * A function that accepts and identity object and a class object and returns
- * either a new instance of that class or an existing instance, if the
- * identity object was previously used.
- */
-export declare function initUnique<T>(identityObj: object, ClassObj: new () => T): T;
-//# sourceMappingURL=initUnique.d.ts.map

package/build/types-ts3.8/metrics/web-vitals/lib/observe.d.ts

@@ -1,23 +0,0 @@
-interface PerformanceEntryMap {
-    event: PerformanceEventTiming[];
-    'first-input': PerformanceEventTiming[];
-    'layout-shift': LayoutShift[];
-    'largest-contentful-paint': LargestContentfulPaint[];
-    'long-animation-frame': PerformanceLongAnimationFrameTiming[];
-    paint: PerformancePaintTiming[];
-    navigation: PerformanceNavigationTiming[];
-    resource: PerformanceResourceTiming[];
-    longtask: PerformanceEntry[];
-    element: PerformanceEntry[];
-}
-/**
- * Takes a performance entry type and a callback function, and creates a
- * `PerformanceObserver` instance that will observe the specified entry type
- * with buffering enabled and call the callback _for each entry_.
- *
- * This function also feature-detects entry support and wraps the logic in a
- * try/catch to avoid errors in unsupporting browsers.
- */
-export declare const observe: <K extends keyof PerformanceEntryMap>(type: K, callback: (entries: PerformanceEntryMap[K]) => void, opts?: PerformanceObserverInit) => PerformanceObserver | undefined;
-export {};
-//# sourceMappingURL=observe.d.ts.map

package/build/types-ts3.8/metrics/web-vitals/lib/onHidden.d.ts

@@ -1,27 +0,0 @@
-export interface OnHiddenCallback {
-    (event: Event): void;
-}
-/**
- * Sentry-specific change:
- *
- * This function's logic was NOT updated to web-vitals 4.2.4 or 5.x but we continue
- * to use the web-vitals 3.5.2 version due to having stricter browser support.
- *
- * PR with context that made the changes:
- * https://github.com/GoogleChrome/web-vitals/pull/442/files#r1530492402
- *
- * The PR removed listening to the `pagehide` event, in favour of only listening to
- * the `visibilitychange` event. This is "more correct" but some browsers we still
- * support (Safari <14.4) don't fully support `visibilitychange` or have known bugs
- * with respect to the `visibilitychange` event.
- *
- * TODO (v11): If we decide to drop support for Safari 14.4, we can use the logic
- * from web-vitals 4.2.4. In this case, we also need to update the integration tests
- * that currently trigger the `pagehide` event to simulate the page being hidden.
- *
- * @param {OnHiddenCallback} cb - Callback to be executed when the page is hidden or unloaded.
- *
- * @deprecated use `whenIdleOrHidden` or `addPageListener('visibilitychange')` instead
- */
-export declare const onHidden: (cb: OnHiddenCallback) => void;
-//# sourceMappingURL=onHidden.d.ts.map

package/build/types-ts3.8/metrics/web-vitals/lib/polyfills/interactionCountPolyfill.d.ts

@@ -1,15 +0,0 @@
-declare global {
-    interface Performance {
-        interactionCount: number;
-    }
-}
-/**
- * Returns the `interactionCount` value using the native API (if available)
- * or the polyfill estimate in this module.
- */
-export declare const getInteractionCount: () => number;
-/**
- * Feature detects native support or initializes the polyfill if needed.
- */
-export declare const initInteractionCountPolyfill: () => void;
-//# sourceMappingURL=interactionCountPolyfill.d.ts.map

package/build/types-ts3.8/metrics/web-vitals/lib/runOnce.d.ts

@@ -1,2 +0,0 @@
-export declare const runOnce: (cb: () => void) => () => void;
-//# sourceMappingURL=runOnce.d.ts.map

package/build/types-ts3.8/metrics/web-vitals/lib/whenActivated.d.ts

@@ -1,2 +0,0 @@
-export declare const whenActivated: (callback: () => void) => void;
-//# sourceMappingURL=whenActivated.d.ts.map

package/build/types-ts3.8/metrics/web-vitals/lib/whenIdleOrHidden.d.ts

@@ -1,6 +0,0 @@
-/**
- * Runs the passed callback during the next idle period, or immediately
- * if the browser's visibility state is (or becomes) hidden.
- */
-export declare const whenIdleOrHidden: (cb: () => void) => void;
-//# sourceMappingURL=whenIdleOrHidden.d.ts.map

package/build/types-ts3.8/metrics/web-vitals/onFCP.d.ts

@@ -1,11 +0,0 @@
-import { FCPMetric, MetricRatingThresholds, ReportOpts } from './types';
-/** Thresholds for FCP. See https://web.dev/articles/fcp#what_is_a_good_fcp_score */
-export declare const FCPThresholds: MetricRatingThresholds;
-/**
- * Calculates the [FCP](https://web.dev/articles/fcp) value for the current page and
- * calls the `callback` function once the value is ready, along with the
- * relevant `paint` performance entry used to determine the value. The reported
- * value is a `DOMHighResTimeStamp`.
- */
-export declare const onFCP: (onReport: (metric: FCPMetric) => void, opts?: ReportOpts) => void;
-//# sourceMappingURL=onFCP.d.ts.map

package/build/types-ts3.8/metrics/web-vitals/onTTFB.d.ts

@@ -1,20 +0,0 @@
-import { MetricRatingThresholds, ReportOpts, TTFBMetric } from './types';
-/** Thresholds for TTFB. See https://web.dev/articles/ttfb#what_is_a_good_ttfb_score */
-export declare const TTFBThresholds: MetricRatingThresholds;
-/**
- * Calculates the [TTFB](https://web.dev/articles/ttfb) value for the
- * current page and calls the `callback` function once the page has loaded,
- * along with the relevant `navigation` performance entry used to determine the
- * value. The reported value is a `DOMHighResTimeStamp`.
- *
- * Note, this function waits until after the page is loaded to call `callback`
- * in order to ensure all properties of the `navigation` entry are populated.
- * This is useful if you want to report on other metrics exposed by the
- * [Navigation Timing API](https://w3c.github.io/navigation-timing/). For
- * example, the TTFB metric starts from the page's [time
- * origin](https://www.w3.org/TR/hr-time-2/#sec-time-origin), which means it
- * includes time spent on DNS lookup, connection negotiation, network latency,
- * and server processing time.
- */
-export declare const onTTFB: (onReport: (metric: TTFBMetric) => void, opts?: ReportOpts) => void;
-//# sourceMappingURL=onTTFB.d.ts.map

package/build/types-ts3.8/metrics/web-vitals/types/base.d.ts

@@ -1,106 +0,0 @@
-import { CLSMetric, CLSMetricWithAttribution } from './cls';
-import { FCPMetric, FCPMetricWithAttribution } from './fcp';
-import { INPMetric, INPMetricWithAttribution } from './inp';
-import { LCPMetric, LCPMetricWithAttribution } from './lcp';
-import { TTFBMetric, TTFBMetricWithAttribution } from './ttfb';
-export interface Metric {
-    /**
-     * The name of the metric (in acronym form).
-     */
-    name: 'CLS' | 'FCP' | 'INP' | 'LCP' | 'TTFB';
-    /**
-     * 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';
-    /**
-     * The delta between the current value and the last-reported value.
-     * On the first report, `delta` and `value` will always be the same.
-     */
-    delta: number;
-    /**
-     * A unique ID representing this particular metric instance. This ID can
-     * be used by an analytics tool to dedupe multiple values sent for the same
-     * metric instance, or to group multiple deltas together and calculate a
-     * total. It can also be used to differentiate multiple different metric
-     * instances sent from the same page, which can happen if the page is
-     * restored from the back/forward cache (in that case new metrics object
-     * get created).
-     */
-    id: string;
-    /**
-     * 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[];
-    /**
-     * The type of navigation.
-     *
-     * This will be the value returned by the Navigation Timing API (or
-     * `undefined` if the browser doesn't support that API), with the following
-     * exceptions:
-     * - 'back-forward-cache': for pages that are restored from the bfcache.
-     * - 'back_forward' is renamed to 'back-forward' for consistency.
-     * - 'prerender': for pages that were prerendered.
-     * - 'restore': for pages that were discarded by the browser and then
-     * restored by the user.
-     */
-    navigationType: 'navigate' | 'reload' | 'back-forward' | 'back-forward-cache' | 'prerender' | 'restore';
-}
-/** The union of supported metric types. */
-export type MetricType = CLSMetric | FCPMetric | INPMetric | LCPMetric | TTFBMetric;
-/** The union of supported metric attribution types. */
-export type MetricWithAttribution = CLSMetricWithAttribution | FCPMetricWithAttribution | INPMetricWithAttribution | LCPMetricWithAttribution | TTFBMetricWithAttribution;
-/**
- * The thresholds of metric's "good", "needs improvement", and "poor" ratings.
- *
- * - Metric values up to and including [0] are rated "good"
- * - Metric values up to and including [1] are rated "needs improvement"
- * - Metric values above [1] are "poor"
- *
- * | Metric value    | Rating              |
- * | --------------- | ------------------- |
- * | ≦ [0]           | "good"              |
- * | > [0] and ≦ [1] | "needs improvement" |
- * | > [1]           | "poor"              |
- */
-export type MetricRatingThresholds = [
-    number,
-    number
-];
-/**
- * @deprecated Use metric-specific function types instead, such as:
- * `(metric: LCPMetric) => void`. If a single callback type is needed for
- * multiple metrics, use `(metric: MetricType) => void`.
- */
-export interface ReportCallback {
-    (metric: MetricType): void;
-}
-export interface ReportOpts {
-    reportAllChanges?: boolean;
-}
-export interface AttributionReportOpts extends ReportOpts {
-    generateTarget?: (el: Node | null) => string | undefined;
-}
-/**
- * The loading state of the document. Note: this value is similar to
- * `document.readyState` but it subdivides the "interactive" state into the
- * time before and after the DOMContentLoaded event fires.
- *
- * State descriptions:
- * - `loading`: the initial document response has not yet been fully downloaded
- *   and parsed. This is equivalent to the corresponding `readyState` value.
- * - `dom-interactive`: the document has been fully loaded and parsed, but
- *   scripts may not have yet finished loading and executing.
- * - `dom-content-loaded`: the document is fully loaded and parsed, and all
- *   scripts (except `async` scripts) have loaded and finished executing.
- * - `complete`: the document and all of its sub-resources have finished
- *   loading. This is equivalent to the corresponding `readyState` value.
- */
-export type LoadState = 'loading' | 'dom-interactive' | 'dom-content-loaded' | 'complete';
-//# sourceMappingURL=base.d.ts.map

package/build/types-ts3.8/metrics/web-vitals/types/cls.d.ts

@@ -1,58 +0,0 @@
-import { LoadState, Metric } from './base';
-/**
- * A CLS-specific version of the Metric object.
- */
-export interface CLSMetric extends Metric {
-    name: 'CLS';
-    entries: LayoutShift[];
-}
-/**
- * An object containing potentially-helpful debugging information that
- * can be sent along with the CLS value for the current page visit in order
- * to help identify issues happening to real-users in the field.
- */
-export interface CLSAttribution {
-    /**
-     * By default, a selector identifying the first element (in document order)
-     * that shifted when the single largest layout shift that contributed to the
-     * page's CLS score occurred. If the `generateTarget` configuration option
-     * was passed, then this will instead be the return value of that function,
-     * falling back to the default if that returns null or undefined.
-     */
-    largestShiftTarget?: string;
-    /**
-     * The time when the single largest layout shift contributing to the page's
-     * CLS score occurred.
-     */
-    largestShiftTime?: DOMHighResTimeStamp;
-    /**
-     * The layout shift score of the single largest layout shift contributing to
-     * the page's CLS score.
-     */
-    largestShiftValue?: number;
-    /**
-     * The `LayoutShiftEntry` representing the single largest layout shift
-     * contributing to the page's CLS score. (Useful when you need more than just
-     * `largestShiftTarget`, `largestShiftTime`, and `largestShiftValue`).
-     */
-    largestShiftEntry?: LayoutShift;
-    /**
-     * The first element source (in document order) among the `sources` list
-     * of the `largestShiftEntry` object. (Also useful when you need more than
-     * just `largestShiftTarget`, `largestShiftTime`, and `largestShiftValue`).
-     */
-    largestShiftSource?: LayoutShiftAttribution;
-    /**
-     * The loading state of the document at the time when the largest layout
-     * shift contribution to the page's CLS score occurred (see `LoadState`
-     * for details).
-     */
-    loadState?: LoadState;
-}
-/**
- * A CLS-specific version of the Metric object with attribution.
- */
-export interface CLSMetricWithAttribution extends CLSMetric {
-    attribution: CLSAttribution;
-}
-//# sourceMappingURL=cls.d.ts.map

package/build/types-ts3.8/metrics/web-vitals/types/fcp.d.ts

@@ -1,47 +0,0 @@
-import { LoadState, Metric } from './base';
-/**
- * An FCP-specific version of the Metric object.
- */
-export interface FCPMetric extends Metric {
-    name: 'FCP';
-    entries: PerformancePaintTiming[];
-}
-/**
- * An object containing potentially-helpful debugging information that
- * can be sent along with the FCP value for the current page visit in order
- * to help identify issues happening to real-users in the field.
- */
-export interface FCPAttribution {
-    /**
-     * The time from when the user initiates loading the page until when the
-     * browser receives the first byte of the response (a.k.a. TTFB).
-     */
-    timeToFirstByte: number;
-    /**
-     * The delta between TTFB and the first contentful paint (FCP).
-     */
-    firstByteToFCP: number;
-    /**
-     * The loading state of the document at the time when FCP `occurred (see
-     * `LoadState` for details). Ideally, documents can paint before they finish
-     * loading (e.g. the `loading` or `dom-interactive` phases).
-     */
-    loadState: LoadState;
-    /**
-     * The `PerformancePaintTiming` entry corresponding to FCP.
-     */
-    fcpEntry?: PerformancePaintTiming;
-    /**
-     * 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?: PerformanceNavigationTiming;
-}
-/**
- * An FCP-specific version of the Metric object with attribution.
- */
-export interface FCPMetricWithAttribution extends FCPMetric {
-    attribution: FCPAttribution;
-}
-//# sourceMappingURL=fcp.d.ts.map