@atlaskit/react-ufo 2.5.2 → 2.6.0

package/dist/esm/segment/segment.js

@@ -79,15 +79,14 @@ export default function UFOSegment(_ref) {
         }
       }
     }
-    function _internalHold(labelStack, name
-    // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
-    ) {
+    function _internalHold(labelStack, name) {
+      var experimental = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
       if (interactionId.current != null) {
         if (parentContext) {
-          return parentContext._internalHold(labelStack, name);
+          return parentContext._internalHold(labelStack, name, experimental);
         } else {
           var capturedInteractionId = interactionId.current;
-          var disposeHold = addHold(interactionId.current, labelStack, name);
+          var disposeHold = addHold(interactionId.current, labelStack, name, experimental);
           return function () {
             if (capturedInteractionId === interactionId.current) {
               disposeHold();
@@ -96,9 +95,7 @@ export default function UFOSegment(_ref) {
         }
       }
     }
-    function _internalHoldByID(labelStack, id, name, remove
-    // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
-    ) {
+    function _internalHoldByID(labelStack, id, name, remove) {
       if (interactionId.current != null) {
         if (parentContext) {
           parentContext._internalHoldByID(labelStack, name, id, remove);
@@ -123,6 +120,10 @@ export default function UFOSegment(_ref) {
         var name = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'unknown';
         return this._internalHold(this.labelStack, name);
       },
+      holdExperimental: function holdExperimental() {
+        var name = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'unknown';
+        return this._internalHold(this.labelStack, name, true);
+      },
       addHoldByID: function addHoldByID(labelStack, id) {
         var name = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 'unknown';
         this._internalHoldByID(labelStack, id, name, false);

package/dist/esm/vc/vc-observer/observers/ssr-placeholders/index.js

@@ -1,6 +1,7 @@
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import { fg } from '@atlaskit/platform-feature-flags';
 var EQUALITY_THRESHOLD = 0.1;
 var ANCESTOR_LOOKUP_LIMIT = 10;
 export var SSRPlaceholderHandlers = /*#__PURE__*/function () {
@@ -28,8 +29,16 @@ export var SSRPlaceholderHandlers = /*#__PURE__*/function () {
             return;
           }
           var rect = _this.staticPlaceholders.get(staticKey);
-          var hasSameSizePosition = _this.hasSameSizePosition(rect, boundingClientRect);
-          _resolve(hasSameSizePosition);
+          if (fg('platform_ufo_ssr_ttvc_use_target_rect')) {
+            requestAnimationFrame(function () {
+              var targetRect = target.getBoundingClientRect();
+              var hasSameSizePosition = _this.hasSameSizePosition(rect, targetRect);
+              _resolve(hasSameSizePosition);
+            });
+          } else {
+            var hasSameSizePosition = _this.hasSameSizePosition(rect, boundingClientRect);
+            _resolve(hasSameSizePosition);
+          }
           _this.callbacks.delete(staticKey);
         }
       } else {
@@ -39,8 +48,16 @@ export var SSRPlaceholderHandlers = /*#__PURE__*/function () {
           return;
         }
         var _rect = _this.staticPlaceholders.get(key);
-        var _hasSameSizePosition = _this.hasSameSizePosition(_rect, boundingClientRect);
-        _resolve2(_hasSameSizePosition);
+        if (fg('platform_ufo_ssr_ttvc_use_target_rect')) {
+          requestAnimationFrame(function () {
+            var targetRect = target.getBoundingClientRect();
+            var hasSameSizePosition = _this.hasSameSizePosition(_rect, targetRect);
+            _resolve2(hasSameSizePosition);
+          });
+        } else {
+          var _hasSameSizePosition = _this.hasSameSizePosition(_rect, boundingClientRect);
+          _resolve2(_hasSameSizePosition);
+        }
         _this.staticPlaceholders.delete(staticKey);
         _this.reactValidateCallbacks.delete(staticKey);
       }

package/dist/types/common/common/types.d.ts

@@ -63,7 +63,7 @@ export interface SegmentInfo {
     labelStack: LabelStack;
 }
 export interface CustomData {
-    [key: string]: null | undefined | string | number | boolean | undefined | CustomData | Record<string, CustomData>;
+    [key: string]: null | string | number | boolean | undefined | CustomData | Record<string, CustomData>;
 }
 export type CustomTiming = Record<string, {
     startTime: number;
@@ -104,7 +104,9 @@ export interface InteractionMetrics {
         labelStack: LabelStack;
     })[];
     holdInfo: HoldInfo[];
+    holdExpInfo: HoldInfo[];
     holdActive: Map<string, HoldActive>;
+    holdExpActive: Map<string, HoldActive>;
     reactProfilerTimings: ReactProfilerTiming[];
     measureStart: number;
     rate: number;
@@ -115,11 +117,11 @@ export interface InteractionMetrics {
     abortReason?: AbortReasonType;
     abortedByInteractionName?: string;
     /**
-     * Apdex is legacy performance measurement where it is
+     * Apdex is a legacy performance measurement where it is
      * capturing TTI at arbitrary point in the code (bm3/UFOv1)
      *
      * We are intercepting its values now just so we can use it for
-     * topline metric, but should encourage teams adopt TTAI
+     * topline metric, but should encourage teams to adopt TTAI
      *
      * This field might be ignored/dropped in the future.
      */
@@ -164,7 +166,7 @@ export interface LazyLoadProfilerContext {
     addLoad(identifier: string, start: number, end: number): void;
 }
 export interface EnhancedUFOInteractionContextType extends UFOInteractionContextType, RelayMetricsRecorder, LazyLoadProfilerContext {
-    _internalHold(labelStack: LabelStack, name: string): void | (() => void);
+    _internalHold(labelStack: LabelStack, name: string, experimental?: boolean): void | (() => void);
     _internalHoldByID(labelStack: LabelStack, id: string, name: string, remove: boolean): void | (() => void);
     addHoldByID(labelStack: LabelStack, id: string, name?: string): void;
     removeHoldByID(labelStack: LabelStack, id: string, name?: string): void;

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

@@ -72,6 +72,11 @@ export type Config = {
         readonly rates?: Rates;
         readonly kind?: Record<InteractionType, number>;
     };
+    readonly experimentalInteractionMetrics?: {
+        readonly enabled?: boolean;
+        readonly rates?: Rates;
+        readonly kind?: Record<InteractionType, number>;
+    };
     readonly enableSegmentHighlighting?: boolean;
     readonly enableAdditionalPerformanceMarks?: boolean;
     readonly shouldCalculateLighthouseMetricsFromTTAI?: boolean;
@@ -85,6 +90,7 @@ export type Config = {
 export declare function setUFOConfig(newConfig: Config): void;
 export declare function getConfig(): Config | 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;
 export declare function getCapabilityRate(capability: Capability): number;
 declare const validTypingMethods: readonly ["timeout", "timeoutNoAlloc", "mutationObserver"];

package/dist/types/create-experimental-interaction-metrics-payload/index.d.ts

@@ -0,0 +1,16 @@
+import type { InteractionMetrics } from '../common';
+import { VCObserver, type VCObserverOptions } from '../vc/vc-observer';
+type InteractionMetricsHandler = (interactionId: string, interaction: InteractionMetrics) => void | Promise<void>;
+export declare function installInteractionSink(handler: InteractionMetricsHandler): void;
+export declare function sinkExperimentalHandler(sinkFn: (interactionId: string, interaction: InteractionMetrics) => void | Promise<void>): void;
+export declare function onExperimentalInteractionComplete(interactionId: string, data: InteractionMetrics, endTime?: number): void;
+export declare class ExperimentalVCMetrics {
+    vcObserver: VCObserver | null;
+    initialize(options: VCObserverOptions): this;
+    start({ startTime }: {
+        startTime: number;
+    }): void;
+}
+export declare const experimentalVC: ExperimentalVCMetrics;
+export declare const getExperimentalVCMetrics: (interaction: InteractionMetrics) => any;
+export {};

package/dist/types/create-payload/common/utils/index.d.ts

@@ -1,4 +1,8 @@
+import type { InteractionMetrics } from '../../../common';
+import { type Config } from '../../../config';
 import type { LabelStack, SegmentLabel } from '../../../interaction-context';
+import PostInteractionLog from '../../../interaction-metrics/post-interaction-log';
+export declare const postInteractionLog: PostInteractionLog;
 export type SegmentItem = {
     n: string;
     c?: Record<string, SegmentItem>;
@@ -15,3 +19,8 @@ export declare function optimizeLabelStack(labelStack: LabelStack): string | {
     s?: string | undefined;
     n: string;
 }[];
+export declare const getPageVisibilityUpToTTAI: (interaction: InteractionMetrics) => import("../../../hidden-timing").PageVisibility;
+export declare const calculateVCMetrics: (interaction: InteractionMetrics, prefix: string, getVCResultFn: (props: any) => any) => any;
+export declare function getSSRDoneTimeValue(config: Config | undefined): number | undefined;
+export declare const getVCMetrics: (interaction: InteractionMetrics) => any;
+export declare const getTTAI: (interaction: InteractionMetrics) => number | undefined;