@atlaskit/react-ufo 4.14.3 → 4.14.4

package/dist/types/common/vc/types.d.ts

@@ -4,7 +4,7 @@ export declare const AbortEvent: {
     readonly keydown: "keydown";
     readonly resize: "resize";
 };
-export type VCAbortReason = 'custom' | 'scroll' | 'keypress' | 'resize' | 'error' | 'not-supported' | 'wheel';
+export type VCAbortReason = 'custom' | 'scroll' | 'keypress' | 'resize' | 'error' | 'not-supported' | 'wheel' | 'browser_backgrounded';
 export type VCAbortReasonType = {
     reason: null | VCAbortReason;
     info: string;
@@ -118,6 +118,13 @@ export type CalculateTTVCResult = {
     vcDetails: RevisionPayloadVCDetails;
     ssrRatio: number;
 };
+export type RawObservation = {
+    t: number;
+    r: [number, number, number, number];
+    chg: number | string;
+    eid: number;
+    att?: number;
+};
 export type RevisionPayloadEntry = {
     'metric:vc90': number | null;
     revision: string;
@@ -128,6 +135,18 @@ export type RevisionPayloadEntry = {
     labelStacks?: VCLabelStacks;
     abortReason?: VCAbortReason | null;
     abortTimestamp?: number;
+    rawData?: {
+        obs?: Array<RawObservation>;
+        eid?: Record<number, string>;
+        chg?: Record<number, string>;
+        att?: Record<number, string>;
+    };
+    viewport?: {
+        w: number;
+        h: number;
+    };
+    feVCTime?: number;
+    rawVCTime?: number;
 };
 export type RevisionPayload = RevisionPayloadEntry[];
 export {};

package/dist/types/config/index.d.ts

@@ -161,6 +161,11 @@ export type Config = {
         readonly enabled: boolean;
         readonly searchPageMetricName: string;
     };
+    readonly enableVCRawDataRates?: {
+        readonly enabled?: boolean;
+        readonly rates?: Rates;
+        readonly kind?: Record<InteractionType, number>;
+    };
 };
 export declare function setUFOConfig(newConfig: Config): void;
 export declare function getConfig(): Config | undefined;
@@ -170,6 +175,7 @@ export declare function getMostRecentVCRevision(experienceKey?: string): TTVCRev
 export declare function getReactHydrationStats(): ReactHydrationStats | undefined;
 export declare function getInteractionRate(name: string, interactionKind: InteractionKind): number;
 export declare function getExperimentalInteractionRate(name: string, interactionType: InteractionType): number;
+export declare function getVCRawDataInteractionRate(name: string, interactionType: InteractionType): number;
 export declare function getPostInteractionRate(name: string, interactionType: InteractionType): number;
 export declare function getCapabilityRate(capability: Capability): number;
 export declare function getExtraInteractionRate(name: string, interactionType: InteractionType): number;

package/dist/types/vc/types.d.ts

@@ -17,6 +17,7 @@ export type GetVCResultType = {
     interactionType: InteractionType;
     isPageVisible: boolean;
     interactionAbortReason?: AbortReasonType;
+    includeRawData?: boolean;
 };
 export type SelectorConfig = {
     id: boolean;

package/dist/types/vc/vc-observer-new/raw-data-handler/index.d.ts

@@ -0,0 +1,20 @@
+import type { RevisionPayloadEntry } from '../../../common/vc/types';
+import type { VCObserverEntry } from '../types';
+export default class RawDataHandler {
+    private readonly revisionNo;
+    protected getVCCleanStatus(filteredEntries: readonly VCObserverEntry[]): {
+        isVCClean: boolean;
+        dirtyReason: never;
+        abortTimestamp: number;
+    } | {
+        isVCClean: boolean;
+        dirtyReason?: undefined;
+        abortTimestamp?: undefined;
+    };
+    getRawData({ entries, startTime, stopTime, isPageVisible, }: {
+        entries: ReadonlyArray<VCObserverEntry>;
+        startTime: number;
+        stopTime: number;
+        isPageVisible: boolean;
+    }): Promise<RevisionPayloadEntry | undefined>;
+}

package/dist/types/vc/vc-observer-new/types.d.ts

@@ -23,6 +23,7 @@ export type WindowEventEntryData = {
 export type VCObserverEntry = {
     readonly time: DOMHighResTimeStamp;
     readonly data: ViewportEntryData | WindowEventEntryData;
+    ignoredInRevision?: string[];
 };
 export type VCObserverGetVCResultParam = {
     start: number;
@@ -35,4 +36,5 @@ export type VCObserverGetVCResultParam = {
     interactionType: InteractionType;
     isPageVisible: boolean;
     interactionAbortReason?: AbortReasonType;
+    includeRawData?: boolean;
 };

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

@@ -4,7 +4,7 @@ export declare const AbortEvent: {
     readonly keydown: "keydown";
     readonly resize: "resize";
 };
-export type VCAbortReason = 'custom' | 'scroll' | 'keypress' | 'resize' | 'error' | 'not-supported' | 'wheel';
+export type VCAbortReason = 'custom' | 'scroll' | 'keypress' | 'resize' | 'error' | 'not-supported' | 'wheel' | 'browser_backgrounded';
 export type VCAbortReasonType = {
     reason: null | VCAbortReason;
     info: string;
@@ -118,6 +118,18 @@ export type CalculateTTVCResult = {
     vcDetails: RevisionPayloadVCDetails;
     ssrRatio: number;
 };
+export type RawObservation = {
+    t: number;
+    r: [
+        number,
+        number,
+        number,
+        number
+    ];
+    chg: number | string;
+    eid: number;
+    att?: number;
+};
 export type RevisionPayloadEntry = {
     'metric:vc90': number | null;
     revision: string;
@@ -128,6 +140,18 @@ export type RevisionPayloadEntry = {
     labelStacks?: VCLabelStacks;
     abortReason?: VCAbortReason | null;
     abortTimestamp?: number;
+    rawData?: {
+        obs?: Array<RawObservation>;
+        eid?: Record<number, string>;
+        chg?: Record<number, string>;
+        att?: Record<number, string>;
+    };
+    viewport?: {
+        w: number;
+        h: number;
+    };
+    feVCTime?: number;
+    rawVCTime?: number;
 };
 export type RevisionPayload = RevisionPayloadEntry[];
 export {};

package/dist/types-ts4.5/config/index.d.ts

@@ -161,6 +161,11 @@ export type Config = {
         readonly enabled: boolean;
         readonly searchPageMetricName: string;
     };
+    readonly enableVCRawDataRates?: {
+        readonly enabled?: boolean;
+        readonly rates?: Rates;
+        readonly kind?: Record<InteractionType, number>;
+    };
 };
 export declare function setUFOConfig(newConfig: Config): void;
 export declare function getConfig(): Config | undefined;
@@ -170,6 +175,7 @@ export declare function getMostRecentVCRevision(experienceKey?: string): TTVCRev
 export declare function getReactHydrationStats(): ReactHydrationStats | undefined;
 export declare function getInteractionRate(name: string, interactionKind: InteractionKind): number;
 export declare function getExperimentalInteractionRate(name: string, interactionType: InteractionType): number;
+export declare function getVCRawDataInteractionRate(name: string, interactionType: InteractionType): number;
 export declare function getPostInteractionRate(name: string, interactionType: InteractionType): number;
 export declare function getCapabilityRate(capability: Capability): number;
 export declare function getExtraInteractionRate(name: string, interactionType: InteractionType): number;

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

@@ -17,6 +17,7 @@ export type GetVCResultType = {
     interactionType: InteractionType;
     isPageVisible: boolean;
     interactionAbortReason?: AbortReasonType;
+    includeRawData?: boolean;
 };
 export type SelectorConfig = {
     id: boolean;

package/dist/types-ts4.5/vc/vc-observer-new/raw-data-handler/index.d.ts

@@ -0,0 +1,20 @@
+import type { RevisionPayloadEntry } from '../../../common/vc/types';
+import type { VCObserverEntry } from '../types';
+export default class RawDataHandler {
+    private readonly revisionNo;
+    protected getVCCleanStatus(filteredEntries: readonly VCObserverEntry[]): {
+        isVCClean: boolean;
+        dirtyReason: never;
+        abortTimestamp: number;
+    } | {
+        isVCClean: boolean;
+        dirtyReason?: undefined;
+        abortTimestamp?: undefined;
+    };
+    getRawData({ entries, startTime, stopTime, isPageVisible, }: {
+        entries: ReadonlyArray<VCObserverEntry>;
+        startTime: number;
+        stopTime: number;
+        isPageVisible: boolean;
+    }): Promise<RevisionPayloadEntry | undefined>;
+}

package/dist/types-ts4.5/vc/vc-observer-new/types.d.ts

@@ -23,6 +23,7 @@ export type WindowEventEntryData = {
 export type VCObserverEntry = {
     readonly time: DOMHighResTimeStamp;
     readonly data: ViewportEntryData | WindowEventEntryData;
+    ignoredInRevision?: string[];
 };
 export type VCObserverGetVCResultParam = {
     start: number;
@@ -35,4 +36,5 @@ export type VCObserverGetVCResultParam = {
     interactionType: InteractionType;
     isPageVisible: boolean;
     interactionAbortReason?: AbortReasonType;
+    includeRawData?: boolean;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/react-ufo",
-	"version": "4.14.3",
+	"version": "4.14.4",
 	"description": "Parts of React UFO that are publicly available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -169,6 +169,9 @@
 		},
 		"platform_ufo_exclude_3p_attribute_changes": {
 			"type": "boolean"
+		},
+		"platform_ufo_enable_vc_raw_data": {
+			"type": "boolean"
 		}
 	}
 }