@atlaskit/react-ufo 2.11.0 → 2.12.1

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

@@ -27,6 +27,7 @@ export interface UFOInteractionContextType extends InteractionContextType {
         startTime?: number;
         stopTime: number;
     }): void;
+    holdExperimental?(name: string): void | (() => void);
 }
 declare const _default: Context<UFOInteractionContextType | null>;
 export default _default;

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

@@ -1,3 +1,2 @@
 import type { InteractionMetrics } from '../../common';
-declare const interactions: Map<string, InteractionMetrics>;
-export default interactions;
+export declare const interactions: Map<string, InteractionMetrics>;

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

@@ -18,7 +18,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;

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-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.
      */
@@ -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-ts4.5/config/index.d.ts

@@ -73,6 +73,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;
@@ -87,6 +92,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,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) => import("../common/vc/types").VCResult | null;
+export {};