@atlaskit/react-ufo 3.14.3 → 3.14.4

package/dist/types-ts4.5/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-ts4.5/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-ts4.5/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-ts4.5/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-ts4.5/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-ts4.5/create-payload/utils/get-payload-size.d.ts

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

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

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/react-ufo",
-	"version": "3.14.3",
+	"version": "3.14.4",
 	"description": "Parts of React UFO that are publicly available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -74,6 +74,7 @@
 		".": "./src/index.ts"
 	},
 	"dependencies": {
+		"@atlaskit/browser-apis": "^0.0.1",
 		"@atlaskit/interaction-context": "^3.0.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@babel/runtime": "^7.0.0",
@@ -178,6 +179,9 @@
 		"platform_ufo_enable_timeout_config": {
 			"type": "boolean"
 		},
+		"platform_ufo_critical_metrics_payload": {
+			"type": "boolean"
+		},
 		"platform_ufo_enable_interactivity_jsm": {
 			"type": "boolean"
 		},