@atlaskit/react-ufo 3.14.2 → 3.14.4

package/dist/types/create-payload/utils/find-matching-legacy-metric.d.ts

@@ -0,0 +1,5 @@
+import type { BM3Event, InteractionMetrics } from '../../common';
+/**
+ * Find matching legacy metric by experience name and type
+ */
+export declare function findMatchingLegacyMetric(interaction: InteractionMetrics, experienceName: string): BM3Event | undefined;

package/dist/types/create-payload/utils/get-browser-metadata.d.ts

@@ -0,0 +1,21 @@
+export default function getBrowserMetadata(): {
+    browser?: {
+        name: string;
+        version: string;
+    } | undefined;
+    device?: {
+        cpus?: number | undefined;
+        memory?: number | undefined;
+    } | undefined;
+    network?: {
+        effectiveType: string;
+        rtt: number;
+        downlink: number;
+    } | undefined;
+    time: {
+        localHour: number;
+        localDayOfWeek: number;
+        localTimezoneOffset: number;
+    };
+};
+export declare function getBrowserMetadataToLegacyFormat(): Record<string, any>;

package/dist/types/create-payload/utils/get-fmp.d.ts

@@ -0,0 +1,6 @@
+import type { InteractionMetrics } from '../../common';
+/**
+ * Calculate FMP (First Meaningful Paint) based on interaction type and configuration
+ * FMP is calculated based on legacy metrics or marks depending on interaction type and configuration
+ */
+export declare function getFMP(interaction: InteractionMetrics, experienceName: string): number | undefined;

package/dist/types/create-payload/utils/get-navigation-metrics.d.ts

@@ -0,0 +1,29 @@
+import type { InteractionType } from '../../common';
+export interface NavigationMetrics {
+    redirectStart: number;
+    redirectEnd: number;
+    fetchStart: number;
+    domainLookupStart: number;
+    domainLookupEnd: number;
+    connectStart: number;
+    connectEnd: number;
+    secureConnectionStart: number;
+    requestStart: number;
+    responseStart: number;
+    responseEnd: number;
+    encodedBodySize: number;
+    decodedBodySize: number;
+    transferSize: number;
+    redirectCount: number;
+    type: string;
+    unloadEventEnd: number;
+    unloadEventStart: number;
+    workerStart: number;
+    nextHopProtocol: string;
+}
+export default function getNavigationMetrics(type: InteractionType): NavigationMetrics | null;
+export declare function getNavigationMetricsToLegacyFormat(type: InteractionType): {
+    'metrics:navigation'?: undefined;
+} | {
+    'metrics:navigation': NavigationMetrics;
+};

package/dist/types/create-payload/utils/get-paint-metrics.d.ts

@@ -0,0 +1,13 @@
+import type { InteractionType } from '../../common';
+export interface PaintMetrics {
+    fp?: number;
+    fcp?: number;
+    lcp?: number;
+}
+export interface LegacyPaintMetrics {
+    'metric:fp'?: number;
+    'metric:fcp'?: number;
+    'metric:lcp'?: number;
+}
+export default function getPaintMetrics(type: InteractionType, end: number): Promise<PaintMetrics>;
+export declare function getPaintMetricsToLegacyFormat(type: InteractionType, end: number): Promise<LegacyPaintMetrics>;

package/dist/types/create-payload/utils/get-payload-size.d.ts

@@ -0,0 +1 @@
+export default function getPayloadSize(payload: object): number;

package/dist/types/create-payload/utils/get-react-ufo-payload-version.d.ts

@@ -1,2 +1,3 @@
 import type { InteractionType } from '../../interaction-metrics';
-export declare function getReactUFOPayloadVersion(interactionType: InteractionType, isPostInteractionLog?: boolean): "1.0.1" | "2.0.0";
+export declare const LATEST_REACT_UFO_PAYLOAD_VERSION = "2.0.0";
+export declare function getReactUFOPayloadVersion(interactionType: InteractionType, isPostInteractionLog?: boolean): "2.0.0" | "1.0.1";

package/dist/types/create-payload/utils/get-ssr-success.d.ts

@@ -0,0 +1,2 @@
+import type { InteractionType } from '../../common';
+export default function getSSRSuccess(type: InteractionType): boolean | undefined;

package/dist/types/create-payload/utils/get-ttai.d.ts

@@ -0,0 +1,2 @@
+import type { InteractionMetrics } from '../../common';
+export default function getTTAI(interaction: InteractionMetrics): number | undefined;

package/dist/types/create-payload/utils/get-tti.d.ts

@@ -0,0 +1,7 @@
+import type { InteractionMetrics } from '../../common';
+/**
+ * Calculate TTI (Time to Interactive) based on server-side logic
+ * TTI is the time from interaction start to the end of the first matching legacy metric,
+ * or falls back to apdex/UFO end time if no legacy metrics exist
+ */
+export declare function getTTI(interaction: InteractionMetrics, experienceName: string): number | undefined;

package/dist/types/create-post-interaction-log-payload/get-late-mutations.d.ts

@@ -1,5 +1,5 @@
 import type { LastInteractionFinishInfo } from '../common';
-import { LateMutation } from '../common/react-ufo-payload-schema';
+import type { LateMutation } from '../common/react-ufo-payload-schema';
 import type { RevisionPayloadVCDetails } from '../common/vc/types';
 declare function getLateMutations(vcDetails: RevisionPayloadVCDetails, lastInteractionFinish: LastInteractionFinishInfo, postInteractionFinishVCRatios: Record<string, number>): LateMutation[];
 export default getLateMutations;

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

@@ -1,5 +1,5 @@
 import { type PostInteractionLogOutput } from '../common';
-import { LateMutation } from '../common/react-ufo-payload-schema';
+import type { LateMutation } from '../common/react-ufo-payload-schema';
 declare function createPostInteractionLogPayload({ lastInteractionFinish, reactProfilerTimings, lastInteractionFinishVCResult, postInteractionFinishVCResult, }: PostInteractionLogOutput): {
     actionSubject: string;
     action: string;
@@ -26,13 +26,13 @@ declare function createPostInteractionLogPayload({ lastInteractionFinish, reactP
                     vc90: number | null;
                     vcClean: boolean;
                     type: import("../common").InteractionType;
-                    id: string;
                     abortReason?: import("../common").AbortReasonType | undefined;
+                    id: string;
+                    errors: import("../common").InteractionError[];
                     abortedByInteractionName?: string | undefined;
                     routeName: string | null;
-                    experimentalVC90?: number | undefined;
                     experimentalTTAI?: number | undefined;
-                    errors: import("../common").InteractionError[];
+                    experimentalVC90?: number | undefined;
                 };
                 revisedEndTime: number;
                 revisedTtai: number;

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

@@ -1,5 +1,6 @@
 import { type Context } from 'react';
 import { type InteractionContextType } from '@atlaskit/interaction-context';
+import { UFOSegmentType } from '../segment/segment';
 export type CustomData = {
     [key: string]: null | string | number | boolean | undefined | CustomData;
 };
@@ -16,6 +17,7 @@ export type SegmentLabel = Readonly<{
     name: string;
     segmentId?: string;
     mode?: 'list' | 'single';
+    type?: UFOSegmentType;
 }>;
 export type LabelStack = ReadonlyArray<SegmentLabel | Label>;
 export interface UFOInteractionContextType extends InteractionContextType {

package/dist/types/interaction-ignore/ufo-interaction-ignore.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-import { UFOIgnoreHoldsProps } from '../ignore-holds';
+import { type UFOIgnoreHoldsProps } from '../ignore-holds';
 /**
  * Legacy wrapper component that delegates to `UFOIgnoreHolds`.
  * Use `UFOIgnoreHolds` instead for new implementations.

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

@@ -12,6 +12,7 @@ export declare function remove(interactionId: string): void;
 export declare function updatePageLoadInteractionName(ufoName: string, routeName?: string | null | undefined): void;
 export declare function addMetadata(interactionId: string, data: Record<string, unknown>): void;
 export declare function addCustomData(interactionId: string, labelStack: LabelStack, data: CustomData): void;
+export declare function addCohortingCustomData(interactionId: string, key: string, value: number | boolean | string | null | undefined): void;
 export declare function addCustomTiming(interactionId: string, labelStack: LabelStack, data: CustomTiming): void;
 export declare function addMark(interactionId: string, type: MarkType, name: string, labelStack: LabelStack | null, time?: number): void;
 export declare function addMarkToAll(type: MarkType, name: string, labelStack: LabelStack | null, time?: number): void;

package/dist/types/segment/third-party-segment.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-import { Props as SegmentProps } from './segment';
+import { type Props as SegmentProps } from './segment';
 export declare function UFOThirdPartySegment(props: Omit<SegmentProps, 'type'>): React.JSX.Element;
 export declare namespace UFOThirdPartySegment {
     var displayName: string;

package/dist/types/vc/vc-observer-new/viewport-observer/utils/get-component-name-and-child-props.d.ts

@@ -1,5 +1,5 @@
-import { UFOIgnoreHoldsReason } from '../../../../ignore-holds';
-import { VCObserverEntryType } from '../../types';
+import type { UFOIgnoreHoldsReason } from '../../../../ignore-holds';
+import type { VCObserverEntryType } from '../../types';
 export declare function checkWithinComponentAndExtractChildProps<T = string>(node: HTMLElement, targetComponentName: string, childComponentConfig?: {
     componentName: string;
     propName: string;

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

@@ -101,6 +101,7 @@ export interface InteractionMetrics {
         labelStack: LabelStack;
         data: CustomData;
     }[];
+    cohortingCustomData: Map<string, number | boolean | string | null | undefined>;
     customTimings: {
         labelStack: LabelStack;
         data: CustomTiming;
@@ -142,7 +143,6 @@ export interface InteractionMetrics {
      *  { name: 'issue-navigator', segmentId: 'xxx' },
      *  { name: 'ui', segmentId: 'xxx' }
      * ]
-     * ```
      */
     responsiveness?: ResponsivenessMetric;
     labelStack: LabelStack | null;

package/dist/types-ts4.5/common/react-ufo-payload-schema.d.ts

@@ -1,7 +1,7 @@
 import { createPayloads } from '../create-payload';
 import { type LabelStack } from '../interaction-context';
 import { VCObserver } from '../vc/vc-observer';
-import type { AbortReasonType, ApdexType, InteractionError, InteractionType, SegmentInfo } from './common/types';
+import type { AbortReasonType, ApdexType, HoldActive, InteractionError, InteractionType, SegmentInfo } from './common/types';
 import type { RevisionPayload } from './vc/types';
 type ExtractPromise<T> = T extends Promise<infer U> ? U : never;
 export type PageVisibility = 'hidden' | 'mixed' | 'visible';
@@ -36,6 +36,11 @@ export type HoldInfo = {
     startTime: number;
     endTime: number;
 };
+export type OptimizedHoldInfo = {
+    labelStack: string;
+    startTime: number;
+    endTime: number;
+};
 export type VCParts = (typeof VCObserver.VCParts)[number];
 export type LeafSegment = {
     n: string;
@@ -109,6 +114,7 @@ export type ReactUFOPayload = {
             };
             'ufo:errors:globalCount': number;
             'ufo:errors:count': number;
+            'ufo:payloadTime'?: number;
             interactionMetrics: {
                 namePrefix: string;
                 segmentPrefix: string;
@@ -136,8 +142,23 @@ export type ReactUFOPayload = {
                 resourceTimings: ResourceTiming[];
                 segments: SegmentInfo[] | RootSegment;
                 reactProfilerTimings: ReactProfilerTiming[];
-                holdInfo: HoldInfo[];
+                holdInfo: OptimizedHoldInfo[];
                 errors: InteractionError[];
+                responsiveness?: {
+                    inputDelay?: number;
+                    experimentalInputToNextPaint?: number;
+                };
+                customData: Array<{
+                    labelStack: LabelStack;
+                    data: any;
+                }>;
+                SSRTimings: Array<{
+                    label: string;
+                    data: any;
+                }>;
+                holdActive: HoldActive[];
+                unknownElementName?: string;
+                unknownElementHierarchy?: string;
             };
             'ufo:vc:rev': RevisionPayload;
             'ufo:vc:ratios': Record<string, number>;

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

@@ -1,8 +1,10 @@
 import type { LabelStack, SegmentLabel } from '../../../interaction-context';
+import { UFOSegmentType } from '../../../segment/segment';
 import { getReactUFOPayloadVersion } from '../../utils/get-react-ufo-payload-version';
 export type SegmentItem = {
     n: string;
     c?: Record<string, SegmentItem>;
+    t?: UFOSegmentType;
 };
 export type SegmentTree = {
     r: SegmentItem;
@@ -13,6 +15,7 @@ export declare function buildSegmentTree(labelStacks: LabelStack[]): SegmentTree
 export declare function stringifyLabelStackFully(labelStack: LabelStack): string;
 export declare function labelStackStartWith(labelStack: LabelStack, startWith: LabelStack): boolean;
 export declare function optimizeLabelStack(labelStack: LabelStack, reactUFOVersion: ReturnType<typeof getReactUFOPayloadVersion>): string | {
+    t?: UFOSegmentType | undefined;
     s?: string | undefined;
     n: string;
 }[];

package/dist/types-ts4.5/create-payload/critical-metrics-payload/index.d.ts

@@ -0,0 +1,6 @@
+import type { InteractionMetrics } from '../../common';
+import type { VCResult } from '../../common/vc/types';
+import { CriticalMetricsPayload } from './types';
+export declare function createCriticalMetricsPayloads(interactionId: string, interaction: InteractionMetrics, vcMetrics?: VCResult & {
+    'metric:vc90'?: number | null;
+}): Promise<CriticalMetricsPayload[]>;

package/dist/types-ts4.5/create-payload/critical-metrics-payload/root-metrics.d.ts

@@ -0,0 +1,7 @@
+import type { InteractionMetrics } from '../../common';
+import type { VCResult } from '../../common/vc/types';
+import type { CriticalMetricsPayload } from './types';
+export type { CriticalMetricsPayload, CriticalMetricsPayloadProperties } from './types';
+export declare function createRootCriticalMetricsPayload(interactionId: string, interaction: InteractionMetrics, vcMetrics?: VCResult & {
+    'metric:vc90'?: number | null;
+}): Promise<CriticalMetricsPayload>;

package/dist/types-ts4.5/create-payload/critical-metrics-payload/segment-metrics/create-segment-metrics.d.ts

@@ -0,0 +1,3 @@
+import { InteractionMetrics } from '../../../common';
+import { CriticalMetricsPayload } from '../types';
+export declare function createSegmentMetricsPayloads(interactionId: string, interaction: InteractionMetrics): Promise<CriticalMetricsPayload[]>;

package/dist/types-ts4.5/create-payload/critical-metrics-payload/segment-metrics/get-is-root-segment.d.ts

@@ -0,0 +1,2 @@
+import type { LabelStack } from '../../../interaction-context';
+export default function getIsRootSegment(labelStack: LabelStack): boolean;

package/dist/types-ts4.5/create-payload/critical-metrics-payload/segment-metrics/get-segment-id.d.ts

@@ -0,0 +1,2 @@
+import type { LabelStack } from '../../../interaction-context';
+export default function getSegmentId(labelStack: LabelStack): string | undefined;

package/dist/types-ts4.5/create-payload/critical-metrics-payload/segment-metrics/get-segment-status.d.ts

@@ -0,0 +1,7 @@
+import type { InteractionMetrics, LabelStack } from '../../../common';
+export default function getSegmentStatus(interaction: InteractionMetrics, segment: {
+    labelStack: LabelStack;
+}): {
+    status: string;
+    abortReason: string | undefined;
+};

package/dist/types-ts4.5/create-payload/critical-metrics-payload/segment-metrics/has-segment-failed.d.ts

@@ -0,0 +1,2 @@
+import type { InteractionMetrics } from '../../../common';
+export default function hasSegmentFailed(errors: InteractionMetrics['errors'], segmentId: string): boolean;

package/dist/types-ts4.5/create-payload/critical-metrics-payload/segment-metrics/is-label-stack-under-segment.d.ts

@@ -0,0 +1,2 @@
+import type { LabelStack } from '../../../interaction-context';
+export default function isLabelStackUnderSegment(labelStack: LabelStack, segmentId: string): boolean;

package/dist/types-ts4.5/create-payload/critical-metrics-payload/types.d.ts

@@ -0,0 +1,130 @@
+import type { InteractionType } from '../../common';
+import { NavigationMetrics } from '../utils/get-navigation-metrics';
+export interface CriticalMetricsPayloadProperties {
+    'event:hostname': string;
+    'event:product': string;
+    'event:schema': string;
+    'event:region': string;
+    'event:source': {
+        name: string;
+        version: string;
+    };
+    'experience:key': string;
+    'experience:name': string;
+    browser?: {
+        name: string;
+        version: string;
+    };
+    device?: {
+        cpus?: number;
+        memory?: number;
+    };
+    network?: {
+        effectiveType: string;
+        rtt: number;
+        downlink: number;
+    };
+    time: {
+        localHour: number;
+        localDayOfWeek: number;
+        localTimezoneOffset: number;
+    };
+    metrics: {
+        /**
+         * First Paint
+         */
+        fp?: number;
+        /**
+         * First Contentful Paint
+         */
+        fcp?: number;
+        /**
+         * Largest Contentful Paint
+         */
+        lcp?: number;
+        /**
+         * Time to App Idle
+         */
+        ttai?: number;
+        /**
+         * Time to Interactive
+         * This is legacy metric, that was marked manually by the team
+         */
+        tti?: number;
+        /**
+         * First Meaningful Paint
+         */
+        fmp?: number;
+        /**
+         * Total Blocking Time
+         */
+        tbt?: number;
+        /**
+         * Total Blocking Time Observed
+         */
+        tbtObserved?: number;
+        /**
+         * Cumulative Layout Shift
+         */
+        cls?: number;
+        /**
+         * Time to Visually Complete
+         * Contains array of multiple versions of the metric
+         */
+        ttvc?: {
+            /**
+             * Revision of the metric. e.g. 'fy25.02'
+             */
+            revision: string;
+            /**
+             * Time to Visually Complete 90% of the view port
+             */
+            vc90: number;
+        }[];
+        /**
+         * Earliest Hold Start, for Interaction Response
+         */
+        earliestHoldStart?: number;
+        /**
+         * Input Delay
+         */
+        inputDelay?: number;
+        /**
+         * Input to Next Paint
+         */
+        inp?: number;
+        /**
+         * Navigation metrics, only valid for initial page load from:
+         *  https://www.w3.org/TR/resource-timing/
+         *  https://www.w3.org/TR/navigation-timing-2/
+         */
+        navigation?: NavigationMetrics;
+    };
+    interactionId: string;
+    type: InteractionType | 'page_segment_load';
+    rate: number;
+    routeName?: string;
+    start: number;
+    end: number;
+    status: string;
+    abortReason?: string;
+    previousInteractionName?: string;
+    isPreviousInteractionAborted?: boolean;
+    abortedByInteractionName?: string;
+    pageVisibilityAtTTAI?: string;
+    pageVisibilityAtTTI?: string;
+    errorCount: number;
+    cohortingCustomData?: Record<string, number | boolean | string | null | undefined>;
+}
+export interface CriticalMetricsPayload {
+    actionSubject: 'experience';
+    action: 'measured';
+    eventType: 'operational';
+    source: 'measured';
+    tags: [
+        'observability'
+    ];
+    attributes: {
+        properties: CriticalMetricsPayloadProperties;
+    };
+}