@atlaskit/react-ufo 2.4.5 → 2.4.7

package/dist/types/create-post-interaction-log-payload/index.d.ts

@@ -30,6 +30,8 @@ export default function createPostInteractionLogPayload({ lastInteractionFinish,
                     abortReason?: import("../common").AbortReasonType | undefined;
                     abortedByInteractionName?: string | undefined;
                     routeName: string | null;
+                    experimentalVC90?: number | undefined;
+                    experimentalTTAI?: number | undefined;
                 };
                 revisedEndTime: number;
                 revisedTtai: number;

package/dist/types/interaction-metrics/common/constants.d.ts

@@ -1,3 +1,33 @@
-import type { InteractionMetrics } from '../../common';
+import type { InteractionMetrics, SegmentInfo } from '../../common';
+import type { FeatureFlagValue } from '../../feature-flags-accessed';
 declare const interactions: Map<string, InteractionMetrics>;
+export declare const CLEANUP_TIMEOUT: number;
+export declare const CLEANUP_TIMEOUT_AFTER_APDEX: number;
+export type SegmentObserver = {
+    onAdd: (segment: SegmentInfo) => void;
+    onRemove: (segment: SegmentInfo) => void;
+};
+export declare const interactionQueue: {
+    id: string;
+    data: InteractionMetrics;
+}[];
+export declare const segmentCache: Map<string, SegmentInfo>;
+export declare const segmentObservers: SegmentObserver[];
+export declare const moduleLoadingRequests: Record<string, {
+    start: number;
+    timeoutId: ReturnType<typeof setTimeout> | number | undefined;
+}>;
+declare global {
+    interface Window {
+        __REACT_UFO_ENABLE_PERF_TRACING?: boolean;
+        __UFO_COMPACT_PAYLOAD__?: boolean;
+        __CRITERION__?: {
+            addFeatureFlagAccessed?: (flagName: string, flagValue: FeatureFlagValue) => void;
+            addUFOHold?: (id: string, name: string, labelStack: string, startTime: number) => void;
+            removeUFOHold?: (id: string) => void;
+            getFeatureFlagOverride?: (flagName: string) => boolean | undefined;
+            getExperimentValueOverride?: <T>(experimentName: string, parameterName: string) => T;
+        };
+    }
+}
 export default interactions;

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

@@ -0,0 +1,16 @@
+import type { InteractionMetrics } from '../../common';
+import type { LabelStack, SegmentLabel } from '../../interaction-context';
+import { type SegmentObserver } from './constants';
+export declare function isPerformanceTracingEnabled(): boolean;
+export declare function labelStackToString(labelStack: LabelStack | null | undefined, name?: string): string;
+export declare function labelStackToIdString(labelStack: LabelStack | null | undefined): string | undefined;
+export declare function addSegmentObserver(observer: SegmentObserver): void;
+export declare function removeSegmentObserver(observer: SegmentObserver): void;
+export declare function addHoldCriterion(id: string, labelStack: LabelStack, name: string, startTime: number): void;
+export declare function removeHoldCriterion(id: string): void;
+export declare const pushToQueue: (id: string, data: InteractionMetrics) => void;
+export declare function callCleanUpCallbacks(interaction: InteractionMetrics): void;
+export declare function reactProfilerTimingMap(data: InteractionMetrics): void;
+export declare function callCancelCallbacks(interaction: InteractionMetrics): void;
+export declare function isSegmentLabel(obj: any): obj is SegmentLabel;
+export declare function getSegmentCacheKey(labelStack: LabelStack): string;

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

@@ -1,10 +1,11 @@
 import type { AbortReasonType, ApdexType, BM3Event, CustomData, CustomTiming, InteractionError, InteractionMetrics, InteractionType, LifecycleMarkType, LoadProfilerEventInfo, Mark, MarkType, PostInteractionLogOutput, ReactProfilerTiming, RequestInfo, Span, SpanType } from '../common';
+import { ExperimentalInteractionMetrics } from '../create-experimental-interaction-metrics-payload';
 import { type TraceIdContext } from '../experience-trace-id-context';
-import { type FeatureFlagValue } from '../feature-flags-accessed';
 import type { LabelStack } from '../interaction-context';
 import PostInteractionLog from './post-interaction-log';
 export type { InteractionMetrics, LifecycleMarkType, Span, Mark, MarkType, InteractionType, AbortReasonType, ReactProfilerTiming, RequestInfo, ApdexType, CustomData, CustomTiming, InteractionError, };
 export declare const postInteractionLog: PostInteractionLog;
+export declare const experimentalInteractionLog: ExperimentalInteractionMetrics;
 export declare function getActiveInteraction(): InteractionMetrics | undefined;
 export declare function remove(interactionId: string): void;
 export declare function updatePageLoadInteractionName(ufoName: string, routeName?: string | null | undefined): void;
@@ -18,7 +19,7 @@ export declare function addSpanToAll(type: SpanType, name: string, labelStack: L
 export declare function addPreload(moduleId: string, timestamp: number): void;
 export declare function addLoad(identifier: string, start: number, end: number): void;
 export declare function extractModuleName(input: string): string;
-export declare function addHold(interactionId: string, labelStack: LabelStack, name: string): () => void;
+export declare function addHold(interactionId: string, labelStack: LabelStack, name: string, experimental: boolean): () => void;
 export declare function addHoldByID(interactionId: string, labelStack: LabelStack, name: string, id: string, ignoreOnSubmit?: boolean): () => void;
 export declare function removeHoldByID(interactionId: string, id: string): void;
 export declare function getCurrentInteractionType(interactionId: string): InteractionType | null;
@@ -33,6 +34,7 @@ export declare function addError(interactionId: string, name: string, labelStack
 export declare function addErrorToAll(name: string, labelStack: LabelStack | null, errorType: string, errorMessage: string, errorStack?: string): void;
 export declare const addProfilerTimings: (interactionId: string, labelStack: LabelStack, type: 'mount' | 'update' | 'nested-update', actualDuration: number, baseDuration: number, startTime: number, commitTime: number) => void;
 export declare const sinkInteractionHandler: (sinkFn: (id: string, data: InteractionMetrics) => void) => void;
+export declare const sinkExperimentalHandler: (sinkFn: (interactionId: string, interaction: InteractionMetrics) => void | Promise<void>) => void;
 export declare const sinkPostInteractionLogHandler: (sinkFn: (output: PostInteractionLogOutput) => void | Promise<void>) => void;
 export declare function tryComplete(interactionId: string, endTime?: number): void;
 export declare function abort(interactionId: string, abortReason: AbortReasonType): void;
@@ -52,18 +54,5 @@ export declare function addRequestInfo(interactionId: string, labelStack: LabelS
 export declare function addSegment(labelStack: LabelStack): void;
 export declare function removeSegment(labelStack: LabelStack): void;
 export declare function addRedirect(interactionId: string, fromUfoName: string, nextUfoName: string, nextRouteName: string, time: number): void;
-declare global {
-    interface Window {
-        __REACT_UFO_ENABLE_PERF_TRACING?: boolean;
-        __UFO_COMPACT_PAYLOAD__?: boolean;
-        __CRITERION__?: {
-            addFeatureFlagAccessed?: (flagName: string, flagValue: FeatureFlagValue) => void;
-            addUFOHold?: (id: string, name: string, labelStack: string, startTime: number) => void;
-            removeUFOHold?: (id: string) => void;
-            getFeatureFlagOverride?: (flagName: string) => boolean | undefined;
-            getExperimentValueOverride?: <T>(experimentName: string, parameterName: string) => T;
-        };
-    }
-}
 export declare const interactionSpans: Span[];
 export declare function addCustomSpans(name: string, start: number, end?: number, size?: number, labelStack?: LabelStack): void;

package/dist/types/interaction-metrics/post-interaction-log.d.ts

@@ -61,7 +61,7 @@ export default class PostInteractionLog {
      * Basic details about the finished interaction will be recorded
      * A timeout will be setup to send the post interaction observation after some time.
      */
-    onInteractionComplete({ ufoName, start, end, id, abortReason, abortedByInteractionName, routeName, type, }: LastInteractionFinishInfo): void;
+    onInteractionComplete({ ufoName, start, end, id, abortReason, abortedByInteractionName, routeName, type, experimentalTTAI, experimentalVC90, }: LastInteractionFinishInfo): void;
     /**
      * This fn should be invoked when a React render happens after interaction has finished
      */

package/dist/types/load-hold/UFOLoadHold.d.ts

@@ -19,8 +19,7 @@ import { type ReactNode } from 'react';
  *   return (
  *     <>
  *       <Skeleton />
- *       <UFOLoadHold name="card">
- *     </UFOLoadHold>
+ *       <UFOLoadHold name="card" />
  *   )
  * }
  * ```

package/dist/types/trace-pageload/index.d.ts

@@ -1,2 +1,3 @@
+export declare const AWAITING_PAGELOAD_NAME = "awaiting_pageload_name";
 export default function traceUFOPageLoad(ufoName?: string | null | undefined, routeName?: string | null | undefined): void;
 export declare function updatePageloadName(ufoName: string, routeName?: string | null | undefined): void;

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

@@ -33,7 +33,6 @@ export declare class Observers implements BrowserObservers {
     setReactRootRenderStop(stopTime?: number): void;
     private observeElement;
     private getMutationObserver;
-    private getStyleDisplay;
     private getElementName;
     private getIntersectionObserver;
     private measureStart;

package/dist/types-ts4.5/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-ts4.5/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 [

package/dist/types-ts4.5/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-ts4.5/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;