@atlaskit/react-ufo 2.4.6 → 2.4.7

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);
@@ -121,7 +118,8 @@ export default function UFOSegment(_ref) {
       labelStack: labelStack,
       hold: function hold() {
         var name = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'unknown';
-        return this._internalHold(this.labelStack, name);
+        var experimental = arguments.length > 1 ? arguments[1] : undefined;
+        return this._internalHold(this.labelStack, name, experimental);
       },
       addHoldByID: function addHoldByID(labelStack, id) {
         var name = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 'unknown';

package/dist/esm/trace-pageload/index.js

@@ -5,7 +5,7 @@ import { getActiveTrace } from '../experience-trace-id-context';
 import { DefaultInteractionID } from '../interaction-id-context';
 import { abort, addHoldByID, addNewInteraction, getActiveInteraction, removeHoldByID, updatePageLoadInteractionName } from '../interaction-metrics';
 import UFORouteName from '../route-name-context';
-var AWAITING_PAGELOAD_NAME = 'awaiting_pageload_name';
+export var AWAITING_PAGELOAD_NAME = 'awaiting_pageload_name';
 export default function traceUFOPageLoad(ufoName) {
   var routeName = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : ufoName;
   var activeInteraction = getActiveInteraction();

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.
      */
@@ -150,6 +152,8 @@ export interface InteractionMetrics {
     trace: TraceIdContext | null;
     legacyMetrics?: BM3Event[];
     vc?: VCRawDataType | null;
+    experimentalTTAI?: number;
+    experimentalVC90?: number;
 }
 export type LoadProfilerEventInfo = {
     identifier: string;
@@ -162,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;
@@ -191,7 +195,7 @@ export type BM3Event = {
     pageVisibleState?: string;
     type: string;
 };
-export type LastInteractionFinishInfo = Pick<InteractionMetrics, 'ufoName' | 'start' | 'end' | 'id' | 'abortReason' | 'abortedByInteractionName' | 'routeName' | 'type'>;
+export type LastInteractionFinishInfo = Pick<InteractionMetrics, 'ufoName' | 'start' | 'end' | 'id' | 'abortReason' | 'abortedByInteractionName' | 'routeName' | 'type' | 'experimentalVC90' | 'experimentalTTAI'>;
 export type PostInteractionLogOutput = {
     lastInteractionFinish: LastInteractionFinishInfo;
     reactProfilerTimings?: ReactProfilerTiming[];

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,31 @@
+import type { InteractionMetrics } from '../common';
+import { VCObserver, type VCObserverOptions } from '../vc/vc-observer';
+export declare class ExperimentalInteractionMetrics {
+    /**
+     * Handler function to process / send the observation data
+     */
+    sinkHandlerFn: (interactionId: string, interactionMetrics: InteractionMetrics) => void | Promise<void>;
+    /**
+     * Set the fn that would be invoked to process / send the observation data
+     */
+    sinkHandler(sinkHandlerFn: (interactionId: string, interaction: InteractionMetrics) => void | Promise<void>): void;
+    onInteractionComplete(interactionId: string, data: InteractionMetrics, endTime?: number): void;
+    /**
+     * independent VC observer that observes until `custom.post-interaction-logs` event is sent
+     */
+    vcObserver: VCObserver | null;
+    initializeVCObserver(options: VCObserverOptions): this;
+    startVCObserver({ startTime }: {
+        startTime: number;
+    }): void;
+}
+export declare function createExperimentalInteractionMetricsPayload(interactionId: string, interaction: InteractionMetrics): {
+    actionSubject: string;
+    action: string;
+    eventType: string;
+    source: string;
+    tags: string[];
+    attributes: {
+        properties: any;
+    };
+} | null;

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

@@ -1,3 +1,5 @@
+import type { InteractionMetrics } from '../../../common';
+import { type Config } from '../../../config';
 import type { LabelStack, SegmentLabel } from '../../../interaction-context';
 export type SegmentItem = {
     n: string;
@@ -15,3 +17,13 @@ export declare function optimizeLabelStack(labelStack: LabelStack): string | {
     s?: string | undefined;
     n: string;
 }[];
+export declare const getInteractionStatus: (interaction: InteractionMetrics) => {
+    readonly originalInteractionStatus: "ABORTED" | "SUCCEEDED";
+    readonly overrideStatus: "ABORTED" | "SUCCEEDED";
+};
+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 getExperimentalVCMetrics: (interaction: InteractionMetrics) => any;
+export declare const getTTAI: (interaction: InteractionMetrics) => number | undefined;