@atlaskit/react-ufo 5.1.3 → 5.2.0

package/dist/types/create-terminal-error-payload/index.d.ts

@@ -21,6 +21,10 @@ export interface TerminalErrorPayload {
             activeInteractionName: string | null;
             activeInteractionId: string | null;
             activeInteractionType: string | null;
+            previousInteractionId: string | null;
+            previousInteractionName: string | null;
+            previousInteractionType: string | null;
+            timeSincePreviousInteraction: number | null;
             labelStack: LabelStack | null;
         };
     };

package/dist/types/hidden-timing/index.d.ts

@@ -9,3 +9,45 @@ export declare function isOpenedInBackground(interactionType: InteractionType):
 export declare function getHasHiddenTimingBeforeSetup(): boolean;
 export declare function setupHiddenTimingCapture(): void;
 export declare function getPageVisibilityState(start: number, end: number): PageVisibility;
+export type ThrottleMeasurement = {
+    time: number;
+    expectedElapsed: number;
+    actualElapsed: number;
+    isThrottled: boolean;
+};
+/**
+ * Sets up the throttle detection mechanism.
+ * This should be called early in the page lifecycle.
+ * Uses a periodic timer to detect browser throttling by measuring timer drift.
+ */
+export declare function setupThrottleDetection(): void;
+/**
+ * Stops the throttle detection mechanism.
+ * Useful for cleanup in tests or when the feature is no longer needed.
+ */
+export declare function stopThrottleDetection(): void;
+/**
+ * Checks if the tab was throttled at any point during the specified time window.
+ * Returns true if any timer measurement showed significant drift (throttling).
+ *
+ * @param startTime - The start timestamp of the window to check (DOMHighResTimeStamp)
+ * @param endTime - The end timestamp of the window to check (DOMHighResTimeStamp)
+ * @returns boolean - true if throttling was detected during the time window, false otherwise
+ */
+export declare function isTabThrottled(startTime: number, endTime: number): boolean;
+/**
+ * Gets detailed throttle information for debugging purposes.
+ * Returns all throttle measurements within the specified time window.
+ *
+ * @param startTime - The start timestamp of the window to check
+ * @param endTime - The end timestamp of the window to check
+ * @returns Array of throttle measurements within the time window
+ */
+export declare function getThrottleMeasurements(startTime: number, endTime: number): ThrottleMeasurement[];
+/**
+ * Injects a fake throttle measurement for testing purposes.
+ * This allows integration tests to simulate throttling scenarios.
+ *
+ * @param measurement - The throttle measurement to inject
+ */
+export declare function __injectThrottleMeasurementForTesting(measurement: ThrottleMeasurement): void;

package/dist/types/interaction-metrics/index.d.ts

@@ -5,6 +5,14 @@ import type { LabelStack } from '../interaction-context';
 import InteractionExtraMetrics from './interaction-extra-metrics';
 import PostInteractionLog from './post-interaction-log';
 export type { InteractionMetrics, LifecycleMarkType, Span, Mark, MarkType, InteractionType, AbortReasonType, ReactProfilerTiming, RequestInfo, ApdexType, CustomData, CustomTiming, InteractionError, };
+export type PreviousInteractionLogType = {
+    id: string | undefined;
+    name: string | undefined;
+    type: string | undefined;
+    isAborted: boolean | undefined;
+    timestamp: number | undefined;
+};
+export declare const PreviousInteractionLog: PreviousInteractionLogType;
 export declare const postInteractionLog: PostInteractionLog;
 export declare const interactionExtraMetrics: InteractionExtraMetrics;
 export declare const segmentUnmountCache: Map<string, number>;

package/dist/types/set-terminal-error/index.d.ts

@@ -18,6 +18,10 @@ export interface TerminalErrorContext {
     activeInteractionName: string | null;
     activeInteractionId: string | null;
     activeInteractionType: string | null;
+    previousInteractionId: string | null;
+    previousInteractionName: string | null;
+    previousInteractionType: string | null;
+    timeSincePreviousInteraction: number | null;
 }
 export declare function sinkTerminalErrorHandler(fn: (errorData: TerminalErrorData, context: TerminalErrorContext) => void | Promise<void>): void;
 export declare function setTerminalError(error: Error, additionalAttributes?: TerminalErrorAdditionalAttributes, labelStack?: LabelStack): void;

package/dist/types/vc/vc-observer-new/metric-calculator/percentile-calc/canvas-heatmap/index.d.ts

@@ -1,9 +1,9 @@
 import type { RevisionPayloadVCDetails } from '../../../../../common/vc/types';
 import type { ViewportEntryData } from '../../../types';
-import type { CalcTTVCPercentilesArg, CalcTTVCPercentilesArgWithDebugInfo, PercentileCalcResult } from '../types';
+import type { CalcTTVCPercentilesArg, CalcTTVCPercentilesArgWithDebugInfo, PercentileCalcResultWithSpeedIndex } from '../types';
 declare function calculateTTVCPercentiles({ viewport, orderedEntries, percentiles, startTime, }: CalcTTVCPercentilesArg): Promise<RevisionPayloadVCDetails>;
-declare function calculateTTVCPercentilesWithDebugInfo({ viewport, orderedEntries, startTime, }: CalcTTVCPercentilesArgWithDebugInfo): Promise<PercentileCalcResult>;
+declare function calculateTTVCPercentilesWithDebugInfo({ viewport, orderedEntries, startTime, calculateSpeedIndex, }: CalcTTVCPercentilesArgWithDebugInfo): Promise<PercentileCalcResultWithSpeedIndex>;
 export default calculateTTVCPercentiles;
 export declare function calculatePercentiles(timePixelCounts: Map<DOMHighResTimeStamp, number>, elementMap: ReadonlyMap<DOMHighResTimeStamp, Set<string>>, unorderedPercentiles: number[], totalPixels: number, startTime: DOMHighResTimeStamp): RevisionPayloadVCDetails;
-export declare function calculatePercentilesWithDebugInfo(timePixelCounts: Map<DOMHighResTimeStamp, number>, elementMap: ReadonlyMap<DOMHighResTimeStamp, ViewportEntryData[]>, totalPixels: number, startTime: DOMHighResTimeStamp): PercentileCalcResult;
+export declare function calculatePercentilesWithDebugInfo(timePixelCounts: Map<DOMHighResTimeStamp, number>, elementMap: ReadonlyMap<DOMHighResTimeStamp, ViewportEntryData[]>, totalPixels: number, startTime: DOMHighResTimeStamp, calculateSpeedIndex?: boolean): PercentileCalcResultWithSpeedIndex;
 export { calculateTTVCPercentilesWithDebugInfo };

package/dist/types/vc/vc-observer-new/metric-calculator/percentile-calc/types.d.ts

@@ -17,6 +17,11 @@ export type CalcTTVCPercentilesArgWithDebugInfo = {
     orderedEntries: ReadonlyArray<VCObserverEntry>;
     startTime: DOMHighResTimeStamp;
     stopTime: DOMHighResTimeStamp;
+    /**
+     * Whether to calculate speed index metric.
+     * Controlled by platform_ufo_ttvc_v4_speed_index feature flag.
+     */
+    calculateSpeedIndex?: boolean;
 };
 export interface PercentileCalcResultItem {
     time: number;
@@ -27,3 +32,10 @@ export interface PercentileCalcResultItem {
  * Ordered by time
  */
 export type PercentileCalcResult = PercentileCalcResultItem[];
+/**
+ * Result of percentile calculation with debug info, including speed index
+ */
+export type PercentileCalcResultWithSpeedIndex = {
+    entries: PercentileCalcResult;
+    speedIndex: number;
+};

package/dist/types-ts4.5/common/react-ufo-payload-schema.d.ts

@@ -121,6 +121,7 @@ export type ReactUFOPayload = {
             'ufo:pageVisibilityHiddenTimestamp'?: number;
             'ufo:wasPageHiddenBeforeInit'?: boolean;
             'ufo:isOpenedInBackground'?: boolean;
+            'ufo:isTabThrottled'?: boolean;
             interactionMetrics: {
                 namePrefix: string;
                 segmentPrefix: string;

package/dist/types-ts4.5/common/vc/types.d.ts

@@ -117,6 +117,7 @@ export type RevisionPayloadVCDetails = Record<string, {
 export type CalculateTTVCResult = {
     vcDetails: RevisionPayloadVCDetails;
     ssrRatio: number;
+    speedIndex: number;
 };
 export type RawObservation = {
     t: number;
@@ -141,6 +142,7 @@ export type RevisionPayloadEntry = {
     vcDetails?: RevisionPayloadVCDetails;
     ratios?: VCRatioType;
     ssrRatio?: number;
+    speedIndex?: number;
     labelStacks?: VCLabelStacks;
     abortReason?: VCAbortReason | null;
     abortTimestamp?: number;

package/dist/types-ts4.5/create-terminal-error-payload/index.d.ts

@@ -21,6 +21,10 @@ export interface TerminalErrorPayload {
             activeInteractionName: string | null;
             activeInteractionId: string | null;
             activeInteractionType: string | null;
+            previousInteractionId: string | null;
+            previousInteractionName: string | null;
+            previousInteractionType: string | null;
+            timeSincePreviousInteraction: number | null;
             labelStack: LabelStack | null;
         };
     };

package/dist/types-ts4.5/hidden-timing/index.d.ts

@@ -9,3 +9,45 @@ export declare function isOpenedInBackground(interactionType: InteractionType):
 export declare function getHasHiddenTimingBeforeSetup(): boolean;
 export declare function setupHiddenTimingCapture(): void;
 export declare function getPageVisibilityState(start: number, end: number): PageVisibility;
+export type ThrottleMeasurement = {
+    time: number;
+    expectedElapsed: number;
+    actualElapsed: number;
+    isThrottled: boolean;
+};
+/**
+ * Sets up the throttle detection mechanism.
+ * This should be called early in the page lifecycle.
+ * Uses a periodic timer to detect browser throttling by measuring timer drift.
+ */
+export declare function setupThrottleDetection(): void;
+/**
+ * Stops the throttle detection mechanism.
+ * Useful for cleanup in tests or when the feature is no longer needed.
+ */
+export declare function stopThrottleDetection(): void;
+/**
+ * Checks if the tab was throttled at any point during the specified time window.
+ * Returns true if any timer measurement showed significant drift (throttling).
+ *
+ * @param startTime - The start timestamp of the window to check (DOMHighResTimeStamp)
+ * @param endTime - The end timestamp of the window to check (DOMHighResTimeStamp)
+ * @returns boolean - true if throttling was detected during the time window, false otherwise
+ */
+export declare function isTabThrottled(startTime: number, endTime: number): boolean;
+/**
+ * Gets detailed throttle information for debugging purposes.
+ * Returns all throttle measurements within the specified time window.
+ *
+ * @param startTime - The start timestamp of the window to check
+ * @param endTime - The end timestamp of the window to check
+ * @returns Array of throttle measurements within the time window
+ */
+export declare function getThrottleMeasurements(startTime: number, endTime: number): ThrottleMeasurement[];
+/**
+ * Injects a fake throttle measurement for testing purposes.
+ * This allows integration tests to simulate throttling scenarios.
+ *
+ * @param measurement - The throttle measurement to inject
+ */
+export declare function __injectThrottleMeasurementForTesting(measurement: ThrottleMeasurement): void;

package/dist/types-ts4.5/interaction-metrics/index.d.ts

@@ -5,6 +5,14 @@ import type { LabelStack } from '../interaction-context';
 import InteractionExtraMetrics from './interaction-extra-metrics';
 import PostInteractionLog from './post-interaction-log';
 export type { InteractionMetrics, LifecycleMarkType, Span, Mark, MarkType, InteractionType, AbortReasonType, ReactProfilerTiming, RequestInfo, ApdexType, CustomData, CustomTiming, InteractionError, };
+export type PreviousInteractionLogType = {
+    id: string | undefined;
+    name: string | undefined;
+    type: string | undefined;
+    isAborted: boolean | undefined;
+    timestamp: number | undefined;
+};
+export declare const PreviousInteractionLog: PreviousInteractionLogType;
 export declare const postInteractionLog: PostInteractionLog;
 export declare const interactionExtraMetrics: InteractionExtraMetrics;
 export declare const segmentUnmountCache: Map<string, number>;

package/dist/types-ts4.5/set-terminal-error/index.d.ts

@@ -18,6 +18,10 @@ export interface TerminalErrorContext {
     activeInteractionName: string | null;
     activeInteractionId: string | null;
     activeInteractionType: string | null;
+    previousInteractionId: string | null;
+    previousInteractionName: string | null;
+    previousInteractionType: string | null;
+    timeSincePreviousInteraction: number | null;
 }
 export declare function sinkTerminalErrorHandler(fn: (errorData: TerminalErrorData, context: TerminalErrorContext) => void | Promise<void>): void;
 export declare function setTerminalError(error: Error, additionalAttributes?: TerminalErrorAdditionalAttributes, labelStack?: LabelStack): void;

package/dist/types-ts4.5/vc/vc-observer-new/metric-calculator/percentile-calc/canvas-heatmap/index.d.ts

@@ -1,9 +1,9 @@
 import type { RevisionPayloadVCDetails } from '../../../../../common/vc/types';
 import type { ViewportEntryData } from '../../../types';
-import type { CalcTTVCPercentilesArg, CalcTTVCPercentilesArgWithDebugInfo, PercentileCalcResult } from '../types';
+import type { CalcTTVCPercentilesArg, CalcTTVCPercentilesArgWithDebugInfo, PercentileCalcResultWithSpeedIndex } from '../types';
 declare function calculateTTVCPercentiles({ viewport, orderedEntries, percentiles, startTime, }: CalcTTVCPercentilesArg): Promise<RevisionPayloadVCDetails>;
-declare function calculateTTVCPercentilesWithDebugInfo({ viewport, orderedEntries, startTime, }: CalcTTVCPercentilesArgWithDebugInfo): Promise<PercentileCalcResult>;
+declare function calculateTTVCPercentilesWithDebugInfo({ viewport, orderedEntries, startTime, calculateSpeedIndex, }: CalcTTVCPercentilesArgWithDebugInfo): Promise<PercentileCalcResultWithSpeedIndex>;
 export default calculateTTVCPercentiles;
 export declare function calculatePercentiles(timePixelCounts: Map<DOMHighResTimeStamp, number>, elementMap: ReadonlyMap<DOMHighResTimeStamp, Set<string>>, unorderedPercentiles: number[], totalPixels: number, startTime: DOMHighResTimeStamp): RevisionPayloadVCDetails;
-export declare function calculatePercentilesWithDebugInfo(timePixelCounts: Map<DOMHighResTimeStamp, number>, elementMap: ReadonlyMap<DOMHighResTimeStamp, ViewportEntryData[]>, totalPixels: number, startTime: DOMHighResTimeStamp): PercentileCalcResult;
+export declare function calculatePercentilesWithDebugInfo(timePixelCounts: Map<DOMHighResTimeStamp, number>, elementMap: ReadonlyMap<DOMHighResTimeStamp, ViewportEntryData[]>, totalPixels: number, startTime: DOMHighResTimeStamp, calculateSpeedIndex?: boolean): PercentileCalcResultWithSpeedIndex;
 export { calculateTTVCPercentilesWithDebugInfo };

package/dist/types-ts4.5/vc/vc-observer-new/metric-calculator/percentile-calc/types.d.ts

@@ -17,6 +17,11 @@ export type CalcTTVCPercentilesArgWithDebugInfo = {
     orderedEntries: ReadonlyArray<VCObserverEntry>;
     startTime: DOMHighResTimeStamp;
     stopTime: DOMHighResTimeStamp;
+    /**
+     * Whether to calculate speed index metric.
+     * Controlled by platform_ufo_ttvc_v4_speed_index feature flag.
+     */
+    calculateSpeedIndex?: boolean;
 };
 export interface PercentileCalcResultItem {
     time: number;
@@ -27,3 +32,10 @@ export interface PercentileCalcResultItem {
  * Ordered by time
  */
 export type PercentileCalcResult = PercentileCalcResultItem[];
+/**
+ * Result of percentile calculation with debug info, including speed index
+ */
+export type PercentileCalcResultWithSpeedIndex = {
+    entries: PercentileCalcResult;
+    speedIndex: number;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/react-ufo",
-	"version": "5.1.3",
+	"version": "5.2.0",
 	"description": "Parts of React UFO that are publicly available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -101,6 +101,9 @@
 		"ufo_payload_use_idle_callback": {
 			"type": "boolean"
 		},
+		"platform_ufo_is_tab_throttled": {
+			"type": "boolean"
+		},
 		"platform_ufo_assets_check_for_nan": {
 			"type": "boolean"
 		},
@@ -200,8 +203,14 @@
 		"rovo_search_page_ttvc_ignoring_smart_answers_fix": {
 			"type": "boolean"
 		},
+		"ufo_remove_featureflags_from_trimmed_fields": {
+			"type": "boolean"
+		},
 		"platform_ufo_enable_terminal_errors": {
 			"type": "boolean"
+		},
+		"platform_ufo_ttvc_v4_speed_index": {
+			"type": "boolean"
 		}
 	}
 }