@atlaskit/react-ufo 3.13.17 → 3.13.19

package/dist/types/ssr/index.d.ts

@@ -2,6 +2,7 @@ export type FeatureFlagValue = boolean | string | number | Record<any, any>;
 export type ReportedTiming = {
     startTime: number;
     duration: number;
+    size?: number;
 };
 export type ReportedTimings = {
     [key: string]: ReportedTiming;

package/dist/types/vc/index.d.ts

@@ -1,5 +1,6 @@
 import type { VCRawDataType, VCResult } from '../common/vc/types';
 import type { GetVCResultType, VCObserverInterface, VCObserverOptions } from './types';
+export type { VCRevisionDebugDetails } from './vc-observer/getVCRevisionDebugDetails';
 declare global {
     var __vcObserver: VCObserverInterface;
 }

package/dist/types/vc/vc-observer/getVCRevisionDebugDetails.d.ts

@@ -1,30 +1,31 @@
-import type { ComponentsLogType, VCEntryType } from '../../common/vc/types';
+import type { ComponentsLogType, VCAbortReason, VCEntryType, VCIgnoreReason } from '../../common/vc/types';
 import type { VCObserverEntryType } from '../vc-observer-new/types';
-interface VCRevisionDebugDetails {
+export type VCLogEntry = {
+    time: number;
+    viewportPercentage: number | null;
+    entries: Array<{
+        elementName: string;
+        type: VCObserverEntryType;
+        rect: DOMRect;
+        visible: boolean;
+        attributeName?: string | null;
+        oldValue?: string | null;
+        newValue?: string | null;
+        ignoreReason?: VCIgnoreReason;
+    }>;
+};
+export interface VCRevisionDebugDetails {
     revision: string;
     isClean: boolean;
-    abortReason: string | null;
-    vcLogs: Array<{
-        time: number;
-        viewportPercentage: number;
-        entries: Array<{
-            elementName: string;
-            type: VCObserverEntryType;
-            rect: DOMRect;
-            visible: boolean;
-            attributeName?: string | null;
-            oldValue?: string | null;
-            newValue?: string | null;
-        }>;
-    }>;
+    abortReason?: VCAbortReason | null;
+    vcLogs: VCLogEntry[];
     interactionId?: string;
 }
 export declare function getVCRevisionDebugDetails({ revision, isClean, abortReason, VCEntries, componentsLog, interactionId, }: {
     revision: string;
     isClean: boolean;
-    abortReason: string | null;
+    abortReason?: VCAbortReason | null;
     VCEntries: VCEntryType[];
     componentsLog: ComponentsLogType;
     interactionId?: string;
 }): VCRevisionDebugDetails;
-export {};

package/dist/types/vc/vc-observer/index.d.ts

@@ -1,7 +1,14 @@
 import { type UnbindFn } from 'bind-event-listener';
 import type { ComponentsLogType, VCAbortReasonType, VCEntryType, VCIgnoreReason, VCRatioType, VCRawDataType, VCResult } from '../../common/vc/types';
 import type { GetVCResultType, VCObserverInterface, VCObserverOptions } from '../types';
+import { VCRevisionDebugDetails } from './getVCRevisionDebugDetails';
 import { Observers } from './observers';
+declare global {
+    interface Window {
+        __ufo_devtool_onVCRevisionReady__?: (debugInfo: VCRevisionDebugDetails) => void;
+        __on_ufo_vc_debug_data_ready?: (debugInfo: VCRevisionDebugDetails) => void;
+    }
+}
 export declare class VCObserver implements VCObserverInterface {
     abortReason: VCAbortReasonType;
     outOfBoundaryInfo: string;

package/dist/types/vc/vc-observer/observers/rll-placeholders/index.d.ts

@@ -0,0 +1,49 @@
+export declare class RLLPlaceholderHandlers {
+    private placeholders;
+    private constructor();
+    /**
+     * Gets the global singleton instance of RLLPlaceholderHandlers.
+     * Creates the instance if it doesn't exist and stores it in globalThis.
+     * @returns The singleton instance of RLLPlaceholderHandlers
+     */
+    static getInstance(): RLLPlaceholderHandlers;
+    reset(): void;
+    /**
+     * Collects all React Loosely Lazy (RLL) placeholders from the DOM and caches their viewport intersecting rectangles.
+     * RLL placeholders are marked with data-lazy-begin and data-lazy-end attributes on hidden input elements.
+     * Performance optimized to batch getBoundingClientRect calls and minimize layout thrashing.
+     * Only stores the intersecting portions of rectangles that are currently visible in the viewport.
+     */
+    collectRLLPlaceholders(): void;
+    /**
+     * Traverses DOM siblings to find all elements between RLL begin and end markers.
+     * Based on the refElements pattern from react-loosely-lazy's platform/packages/async/react-loosely-lazy/src/collect/hydrate.ts
+     * Performance optimized to minimize iterations and early exit conditions.
+     *
+     * @param fromEl - The input element with data-lazy-begin attribute
+     * @param id - The placeholder ID to match against data-lazy-end
+     * @returns Array of DOM elements between the begin/end markers
+     */
+    private refElements;
+    /**
+     * Returns the cached intersecting viewport rectangles for all RLL placeholder elements.
+     * @returns Array of DOMRect objects representing the intersecting portions of placeholders within the viewport
+     */
+    getPlaceholders(): DOMRect[];
+    /**
+     * Checks if the given intersecting rectangle matches any of the cached RLL placeholder intersecting rectangles.
+     * This is designed to be called from IntersectionObserver with the intersectionRect.
+     * Performance optimized with early exits and minimal calculations.
+     * @param intersectingRect - The intersecting rectangle from IntersectionObserver
+     * @returns true if the intersecting rectangle matches a cached placeholder rectangle and hasn't exceeded match limit, false otherwise
+     */
+    isRLLPlaceholderHydration(intersectingRect: DOMRect): boolean;
+    /**
+     * Compares two DOMRect objects for equality with ±1 pixel tolerance.
+     * Performance optimized to minimize calculations and early exit on major differences.
+     * @param rect1 - First rectangle to compare
+     * @param rect2 - Second rectangle to compare
+     * @returns true if rectangles are within 1 pixel tolerance for all properties
+     */
+    private areRectsEqual;
+}

package/dist/types/vc/vc-observer-new/metric-calculator/abstract-base-vc-calculator.d.ts

@@ -1,6 +1,13 @@
 import type { RevisionPayloadEntry, VCAbortReason } from '../../../common/vc/types';
+import { VCRevisionDebugDetails } from '../../vc-observer/getVCRevisionDebugDetails';
 import type { VCObserverEntry } from '../types';
 import type { VCCalculator, VCCalculatorParam } from './types';
+declare global {
+    interface Window {
+        __ufo_devtool_onVCRevisionReady__?: (debugInfo: VCRevisionDebugDetails) => void;
+        __on_ufo_vc_debug_data_ready?: (debugInfo: VCRevisionDebugDetails) => void;
+    }
+}
 export default abstract class AbstractVCCalculatorBase implements VCCalculator {
     private revisionNo;
     constructor(revisionNo: string);

package/dist/types/vc/vc-observer-new/types.d.ts

@@ -1,5 +1,5 @@
 import type { ObservedWindowEvent } from './window-event-observer';
-export type VCObserverEntryType = 'mutation:child-element' | 'mutation:remount' | 'mutation:element' | 'mutation:element-replacement' | 'mutation:attribute:no-layout-shift' | 'mutation:attribute:non-visual-style' | 'mutation:attribute' | 'mutation:media' | 'layout-shift' | 'window:event' | 'unknown';
+export type VCObserverEntryType = 'mutation:child-element' | 'mutation:remount' | 'mutation:element' | 'mutation:element-replacement' | 'mutation:attribute:no-layout-shift' | 'mutation:attribute:non-visual-style' | 'mutation:attribute' | 'mutation:media' | 'mutation:rll-placeholder' | 'layout-shift' | 'window:event' | 'unknown';
 export type ViewportEntryData = {
     readonly type: VCObserverEntryType;
     readonly elementName: string;

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

@@ -35,7 +35,7 @@ export type VCEntryType = {
     vc: number;
     elements: string[];
 };
-export type VCIgnoreReason = 'image' | 'ssr-hydration' | 'not-visible' | 'non-visual-style' | '';
+export type VCIgnoreReason = 'image' | 'ssr-hydration' | 'not-visible' | 'non-visual-style' | 'rll-placeholder' | '';
 export type ComponentsLogEntry = {
     type?: string;
     targetName: string;

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

@@ -2,6 +2,7 @@ export type FeatureFlagValue = boolean | string | number | Record<any, any>;
 export type ReportedTiming = {
     startTime: number;
     duration: number;
+    size?: number;
 };
 export type ReportedTimings = {
     [key: string]: ReportedTiming;

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

@@ -1,5 +1,6 @@
 import type { VCRawDataType, VCResult } from '../common/vc/types';
 import type { GetVCResultType, VCObserverInterface, VCObserverOptions } from './types';
+export type { VCRevisionDebugDetails } from './vc-observer/getVCRevisionDebugDetails';
 declare global {
     var __vcObserver: VCObserverInterface;
 }

package/dist/types-ts4.5/vc/vc-observer/getVCRevisionDebugDetails.d.ts

@@ -1,30 +1,31 @@
-import type { ComponentsLogType, VCEntryType } from '../../common/vc/types';
+import type { ComponentsLogType, VCAbortReason, VCEntryType, VCIgnoreReason } from '../../common/vc/types';
 import type { VCObserverEntryType } from '../vc-observer-new/types';
-interface VCRevisionDebugDetails {
+export type VCLogEntry = {
+    time: number;
+    viewportPercentage: number | null;
+    entries: Array<{
+        elementName: string;
+        type: VCObserverEntryType;
+        rect: DOMRect;
+        visible: boolean;
+        attributeName?: string | null;
+        oldValue?: string | null;
+        newValue?: string | null;
+        ignoreReason?: VCIgnoreReason;
+    }>;
+};
+export interface VCRevisionDebugDetails {
     revision: string;
     isClean: boolean;
-    abortReason: string | null;
-    vcLogs: Array<{
-        time: number;
-        viewportPercentage: number;
-        entries: Array<{
-            elementName: string;
-            type: VCObserverEntryType;
-            rect: DOMRect;
-            visible: boolean;
-            attributeName?: string | null;
-            oldValue?: string | null;
-            newValue?: string | null;
-        }>;
-    }>;
+    abortReason?: VCAbortReason | null;
+    vcLogs: VCLogEntry[];
     interactionId?: string;
 }
 export declare function getVCRevisionDebugDetails({ revision, isClean, abortReason, VCEntries, componentsLog, interactionId, }: {
     revision: string;
     isClean: boolean;
-    abortReason: string | null;
+    abortReason?: VCAbortReason | null;
     VCEntries: VCEntryType[];
     componentsLog: ComponentsLogType;
     interactionId?: string;
 }): VCRevisionDebugDetails;
-export {};

package/dist/types-ts4.5/vc/vc-observer/index.d.ts

@@ -1,7 +1,14 @@
 import { type UnbindFn } from 'bind-event-listener';
 import type { ComponentsLogType, VCAbortReasonType, VCEntryType, VCIgnoreReason, VCRatioType, VCRawDataType, VCResult } from '../../common/vc/types';
 import type { GetVCResultType, VCObserverInterface, VCObserverOptions } from '../types';
+import { VCRevisionDebugDetails } from './getVCRevisionDebugDetails';
 import { Observers } from './observers';
+declare global {
+    interface Window {
+        __ufo_devtool_onVCRevisionReady__?: (debugInfo: VCRevisionDebugDetails) => void;
+        __on_ufo_vc_debug_data_ready?: (debugInfo: VCRevisionDebugDetails) => void;
+    }
+}
 export declare class VCObserver implements VCObserverInterface {
     abortReason: VCAbortReasonType;
     outOfBoundaryInfo: string;

package/dist/types-ts4.5/vc/vc-observer/observers/rll-placeholders/index.d.ts

@@ -0,0 +1,49 @@
+export declare class RLLPlaceholderHandlers {
+    private placeholders;
+    private constructor();
+    /**
+     * Gets the global singleton instance of RLLPlaceholderHandlers.
+     * Creates the instance if it doesn't exist and stores it in globalThis.
+     * @returns The singleton instance of RLLPlaceholderHandlers
+     */
+    static getInstance(): RLLPlaceholderHandlers;
+    reset(): void;
+    /**
+     * Collects all React Loosely Lazy (RLL) placeholders from the DOM and caches their viewport intersecting rectangles.
+     * RLL placeholders are marked with data-lazy-begin and data-lazy-end attributes on hidden input elements.
+     * Performance optimized to batch getBoundingClientRect calls and minimize layout thrashing.
+     * Only stores the intersecting portions of rectangles that are currently visible in the viewport.
+     */
+    collectRLLPlaceholders(): void;
+    /**
+     * Traverses DOM siblings to find all elements between RLL begin and end markers.
+     * Based on the refElements pattern from react-loosely-lazy's platform/packages/async/react-loosely-lazy/src/collect/hydrate.ts
+     * Performance optimized to minimize iterations and early exit conditions.
+     *
+     * @param fromEl - The input element with data-lazy-begin attribute
+     * @param id - The placeholder ID to match against data-lazy-end
+     * @returns Array of DOM elements between the begin/end markers
+     */
+    private refElements;
+    /**
+     * Returns the cached intersecting viewport rectangles for all RLL placeholder elements.
+     * @returns Array of DOMRect objects representing the intersecting portions of placeholders within the viewport
+     */
+    getPlaceholders(): DOMRect[];
+    /**
+     * Checks if the given intersecting rectangle matches any of the cached RLL placeholder intersecting rectangles.
+     * This is designed to be called from IntersectionObserver with the intersectionRect.
+     * Performance optimized with early exits and minimal calculations.
+     * @param intersectingRect - The intersecting rectangle from IntersectionObserver
+     * @returns true if the intersecting rectangle matches a cached placeholder rectangle and hasn't exceeded match limit, false otherwise
+     */
+    isRLLPlaceholderHydration(intersectingRect: DOMRect): boolean;
+    /**
+     * Compares two DOMRect objects for equality with ±1 pixel tolerance.
+     * Performance optimized to minimize calculations and early exit on major differences.
+     * @param rect1 - First rectangle to compare
+     * @param rect2 - Second rectangle to compare
+     * @returns true if rectangles are within 1 pixel tolerance for all properties
+     */
+    private areRectsEqual;
+}

package/dist/types-ts4.5/vc/vc-observer-new/metric-calculator/abstract-base-vc-calculator.d.ts

@@ -1,6 +1,13 @@
 import type { RevisionPayloadEntry, VCAbortReason } from '../../../common/vc/types';
+import { VCRevisionDebugDetails } from '../../vc-observer/getVCRevisionDebugDetails';
 import type { VCObserverEntry } from '../types';
 import type { VCCalculator, VCCalculatorParam } from './types';
+declare global {
+    interface Window {
+        __ufo_devtool_onVCRevisionReady__?: (debugInfo: VCRevisionDebugDetails) => void;
+        __on_ufo_vc_debug_data_ready?: (debugInfo: VCRevisionDebugDetails) => void;
+    }
+}
 export default abstract class AbstractVCCalculatorBase implements VCCalculator {
     private revisionNo;
     constructor(revisionNo: string);

package/dist/types-ts4.5/vc/vc-observer-new/types.d.ts

@@ -1,5 +1,5 @@
 import type { ObservedWindowEvent } from './window-event-observer';
-export type VCObserverEntryType = 'mutation:child-element' | 'mutation:remount' | 'mutation:element' | 'mutation:element-replacement' | 'mutation:attribute:no-layout-shift' | 'mutation:attribute:non-visual-style' | 'mutation:attribute' | 'mutation:media' | 'layout-shift' | 'window:event' | 'unknown';
+export type VCObserverEntryType = 'mutation:child-element' | 'mutation:remount' | 'mutation:element' | 'mutation:element-replacement' | 'mutation:attribute:no-layout-shift' | 'mutation:attribute:non-visual-style' | 'mutation:attribute' | 'mutation:media' | 'mutation:rll-placeholder' | 'layout-shift' | 'window:event' | 'unknown';
 export type ViewportEntryData = {
     readonly type: VCObserverEntryType;
     readonly elementName: string;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/react-ufo",
-	"version": "3.13.17",
+	"version": "3.13.19",
 	"description": "Parts of React UFO that are publicly available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -133,6 +133,9 @@
 		"platform_ufo_report_cpu_usage": {
 			"type": "boolean"
 		},
+		"platform_ufo_emit_vc_debug_data": {
+			"type": "boolean"
+		},
 		"ufo_return_relative_request_start": {
 			"type": "boolean"
 		},
@@ -159,6 +162,12 @@
 		},
 		"platform_ufo_rev_ratios": {
 			"type": "boolean"
+		},
+		"platform_ufo_ssr_size_field": {
+			"type": "boolean"
+		},
+		"platform_ufo_rll_placeholder_ignore": {
+			"type": "boolean"
 		}
 	}
 }