@atlaskit/react-ufo 4.2.6 → 4.3.0

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

@@ -1,3 +1,4 @@
+import type { ReactHydrationStats } from '../../config';
 import type { TraceIdContext } from '../../experience-trace-id-context';
 import type { LabelStack, UFOInteractionContextType } from '../../interaction-context';
 import type { VCObserverInterface } from '../../vc/types';
@@ -162,6 +163,7 @@ export interface InteractionMetrics {
     vcObserver?: VCObserverInterface;
     experimentalVCObserver?: VCObserverInterface;
     vc?: VCRawDataType | null;
+    hydration?: ReactHydrationStats;
     experimentalTTAI?: number;
     experimentalVC90?: number;
     unknownElementName?: string;

package/dist/types-ts4.5/config/index.d.ts

@@ -32,6 +32,24 @@ type Rates = {
 };
 export type TTVCRevision = 'fy25.01' | 'fy25.02' | 'fy25.03';
 export declare const DEFAULT_TTVC_REVISION = "fy25.03";
+export type ReactHydrationStats = {
+    /**
+     * Indicates if hydration of SSR content failed, so React switching to client-side rendering and re-rendered from scratch.
+     */
+    successful: boolean;
+    /**
+     * The total number of hydration errors reported from {@code hydrateRoot#onRecoverableError}.
+     */
+    warningCount?: number;
+    /**
+     * The depth in the React component tree of the shallowest warning.
+     */
+    minWarningComponentDepth?: number;
+    /**
+     * The depth in the React component tree of the deepest warning.
+     */
+    maxWarningComponentDepth?: number;
+};
 export type Config = {
     readonly enabled?: boolean;
     readonly interactionTimeout?: Record<string, number>;
@@ -115,12 +133,18 @@ export type Config = {
     readonly shouldCalculateLighthouseMetricsFromTTAI?: boolean;
     readonly timeWindowForLateMutationsInMilliseconds?: number;
     readonly manuallyTrackReactProfilerMounts?: boolean;
+    /**
+     * Callback for consumers to provide React hydration stats after React has finished.
+     * Return {@code null} if hydration was not attempted or if we do not want to report any stats.
+     */
+    readonly getReactHydrationStats?: (() => ReactHydrationStats | undefined) | undefined;
 };
 export declare function setUFOConfig(newConfig: Config): void;
 export declare function getConfig(): Config | undefined;
 export declare function getEnabledVCRevisions(experienceKey?: string): readonly TTVCRevision[];
 export declare function isVCRevisionEnabled(revision: TTVCRevision, experienceKey?: string): boolean;
 export declare function getMostRecentVCRevision(experienceKey?: string): TTVCRevision;
+export declare function getReactHydrationStats(): ReactHydrationStats | undefined;
 export declare function getInteractionRate(name: string, interactionKind: InteractionKind): number;
 export declare function getExperimentalInteractionRate(name: string, interactionType: InteractionType): number;
 export declare function getPostInteractionRate(name: string, interactionType: InteractionType): number;