@atlaskit/react-ufo 3.12.3 → 3.12.5

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

@@ -8,6 +8,7 @@ export type GetVCResultType = {
     ssr?: number;
     vc?: VCRawDataType | null;
     experienceKey: string;
+    interactionId?: string;
 };
 export type SelectorConfig = {
     id: boolean;

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

@@ -0,0 +1,30 @@
+import type { ComponentsLogType, VCEntryType } from '../../common/vc/types';
+import type { VCObserverEntryType } from '../vc-observer-new/types';
+interface VCRevisionDebugDetails {
+    revision: string;
+    isClean: boolean;
+    abortReason: string | null;
+    vcLogs: Array<{
+        time: number;
+        viewportPercentage: number;
+        entries: Array<{
+            elementName: string;
+            type: VCObserverEntryType;
+            rect: DOMRect;
+            visible: boolean;
+            attributeName?: string | null;
+            oldValue?: string | null;
+            newValue?: string | null;
+        }>;
+    }>;
+    interactionId?: string;
+}
+export declare function getVCRevisionDebugDetails({ revision, isClean, abortReason, VCEntries, componentsLog, interactionId, }: {
+    revision: string;
+    isClean: boolean;
+    abortReason: string | null;
+    VCEntries: VCEntryType[];
+    componentsLog: ComponentsLogType;
+    interactionId?: string;
+}): VCRevisionDebugDetails;
+export {};

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

@@ -41,7 +41,7 @@ export declare class VCObserver implements VCObserverInterface {
         targetName: string;
         ignoreReason: VCIgnoreReason | undefined;
     }[];
-    getVCResult: ({ start, stop, tti, prefix, ssr, vc, isEventAborted, experienceKey, }: GetVCResultType) => Promise<VCResult>;
+    getVCResult: ({ start, stop, tti, prefix, ssr, vc, isEventAborted, experienceKey, interactionId, }: GetVCResultType) => Promise<VCResult>;
     static calculateVC({ heatmap, ssr, componentsLog, viewport, }: {
         heatmap: number[][];
         ssr?: number;

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

@@ -3,12 +3,14 @@ import { type SelectorConfig } from './get-element-name';
 import type { VCObserverGetVCResultParam } from './types';
 export type VCObserverNewConfig = {
     selectorConfig?: SelectorConfig;
+    isPostInteraction?: boolean;
 };
 export default class VCObserverNew {
     private selectorConfig;
     private viewportObserver;
     private windowEventObserver;
     private entriesTimeline;
+    private isPostInteraction;
     constructor(config: VCObserverNewConfig);
     start({ startTime }: {
         startTime: DOMHighResTimeStamp;

package/dist/types/vc/vc-observer-new/metric-calculator/abstract-base-vc-calculator.d.ts

@@ -10,5 +10,8 @@ export default abstract class AbstractVCCalculatorBase implements VCCalculator {
         isVCClean: boolean;
         dirtyReason?: VCAbortReason;
     };
-    calculate({ startTime, stopTime, orderedEntries, }: VCCalculatorParam): Promise<RevisionPayloadEntry | undefined>;
+    private filterViewportEntries;
+    private calculateBasic;
+    private calculateWithDebugInfo;
+    calculate({ startTime, stopTime, orderedEntries, interactionId, isPostInteraction, }: VCCalculatorParam): Promise<RevisionPayloadEntry | undefined>;
 }

package/dist/types/vc/vc-observer-new/metric-calculator/percentile-calc/canvas-heatmap/index.d.ts

@@ -1,5 +1,9 @@
 import type { RevisionPayloadVCDetails } from '../../../../../common/vc/types';
-import type { CalcTTVCPercentilesArg } from '../types';
+import type { ViewportEntryData } from '../../../types';
+import type { CalcTTVCPercentilesArg, CalcTTVCPercentilesArgWithDebugInfo, PercentileCalcResult } from '../types';
 declare function calculateTTVCPercentiles({ viewport, orderedEntries, percentiles, startTime, }: CalcTTVCPercentilesArg): Promise<RevisionPayloadVCDetails>;
+declare function calculateTTVCPercentilesWithDebugInfo({ viewport, orderedEntries, startTime, }: CalcTTVCPercentilesArgWithDebugInfo): Promise<PercentileCalcResult>;
 export default calculateTTVCPercentiles;
 export declare function calculatePercentiles(timePixelCounts: Map<DOMHighResTimeStamp, number>, elementMap: ReadonlyMap<DOMHighResTimeStamp, Set<string>>, unorderedPercentiles: number[], totalPixels: number, startTime: DOMHighResTimeStamp): RevisionPayloadVCDetails;
+export declare function calculatePercentilesWithDebugInfo(timePixelCounts: Map<DOMHighResTimeStamp, number>, elementMap: ReadonlyMap<DOMHighResTimeStamp, ViewportEntryData[]>, totalPixels: number, startTime: DOMHighResTimeStamp): PercentileCalcResult;
+export { calculateTTVCPercentilesWithDebugInfo };

package/dist/types/vc/vc-observer-new/metric-calculator/percentile-calc/canvas-heatmap/test-with-debug-info.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/vc/vc-observer-new/metric-calculator/percentile-calc/index.d.ts

@@ -1,4 +1,2 @@
-import type { RevisionPayloadVCDetails } from '../../../../common/vc/types';
-import type { CalcTTVCPercentilesArg } from './types';
-declare function calculateTTVCPercentiles(arg: CalcTTVCPercentilesArg): Promise<RevisionPayloadVCDetails | null>;
-export default calculateTTVCPercentiles;
+export { default as calculateTTVCPercentiles } from './canvas-heatmap';
+export { calculateTTVCPercentilesWithDebugInfo } from './canvas-heatmap';

package/dist/types/vc/vc-observer-new/metric-calculator/percentile-calc/types.d.ts

@@ -1,11 +1,29 @@
-import type { VCObserverEntry } from '../../types';
+import type { VCObserverEntry, ViewportEntryData } from '../../types';
 export type CalcTTVCPercentilesArg = {
     viewport: {
         width: number;
         height: number;
     };
+    orderedEntries: ReadonlyArray<VCObserverEntry>;
+    percentiles: number[];
     startTime: DOMHighResTimeStamp;
     stopTime: DOMHighResTimeStamp;
+};
+export type CalcTTVCPercentilesArgWithDebugInfo = {
+    viewport: {
+        width: number;
+        height: number;
+    };
     orderedEntries: ReadonlyArray<VCObserverEntry>;
-    percentiles: number[];
+    startTime: DOMHighResTimeStamp;
+    stopTime: DOMHighResTimeStamp;
 };
+export interface PercentileCalcResultItem {
+    time: number;
+    viewportPercentage: number;
+    entries: ViewportEntryData[];
+}
+/**
+ * Ordered by time
+ */
+export type PercentileCalcResult = PercentileCalcResultItem[];

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

@@ -4,6 +4,8 @@ export type VCCalculatorParam = {
     startTime: DOMHighResTimeStamp;
     stopTime: DOMHighResTimeStamp;
     orderedEntries: ReadonlyArray<VCObserverEntry>;
+    interactionId?: string;
+    isPostInteraction: boolean;
 };
 export interface VCCalculator {
     calculate(param: VCCalculatorParam): Promise<RevisionPayloadEntry | undefined>;

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

@@ -1,21 +1,25 @@
 import type { ObservedWindowEvent } from './window-event-observer';
 export type VCObserverEntryType = 'mutation:child-element' | 'mutation:remount' | 'mutation:element' | 'mutation:element-replacement' | 'mutation:attribute:no-layout-shift' | 'mutation:attribute:non-visual-style' | 'mutation:attribute' | 'mutation:media' | 'layout-shift' | 'window:event' | 'unknown';
 export type ViewportEntryData = {
+    readonly type: VCObserverEntryType;
     readonly elementName: string;
     readonly rect: DOMRect;
     readonly previousRect?: DOMRect | undefined;
     readonly visible: boolean;
     readonly attributeName?: string | null | undefined;
+    readonly oldValue?: string | null | undefined;
+    readonly newValue?: string | null | undefined;
 };
 export type WindowEventEntryData = {
+    readonly type: VCObserverEntryType;
     readonly eventType: ObservedWindowEvent;
 };
 export type VCObserverEntry = {
     readonly time: DOMHighResTimeStamp;
-    readonly type: VCObserverEntryType;
     readonly data: ViewportEntryData | WindowEventEntryData;
 };
 export type VCObserverGetVCResultParam = {
     start: number;
     stop: number;
+    interactionId?: string;
 };

package/dist/types/vc/vc-observer-new/viewport-observer/mutation-observer/index.d.ts

@@ -2,6 +2,8 @@ export type CreateMutationObserverProps = {
     onAttributeMutation: (props: {
         target: HTMLElement;
         attributeName: string;
+        oldValue?: string | undefined | null;
+        newValue?: string | undefined | null;
     }) => void;
     onMutationFinished?: (props: {
         targets: Array<HTMLElement>;

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

@@ -3,6 +3,8 @@ export type MutationRecordWithTimestamp = MutationRecord & {
 };
 export type AttributeMutationData = {
     attributeName: string;
+    oldValue?: string | undefined | null;
+    newValue?: string | undefined | null;
 };
 /**
  * Add here when there are more type of mutation data

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

@@ -8,6 +8,7 @@ export type GetVCResultType = {
     ssr?: number;
     vc?: VCRawDataType | null;
     experienceKey: string;
+    interactionId?: string;
 };
 export type SelectorConfig = {
     id: boolean;

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

@@ -0,0 +1,30 @@
+import type { ComponentsLogType, VCEntryType } from '../../common/vc/types';
+import type { VCObserverEntryType } from '../vc-observer-new/types';
+interface VCRevisionDebugDetails {
+    revision: string;
+    isClean: boolean;
+    abortReason: string | null;
+    vcLogs: Array<{
+        time: number;
+        viewportPercentage: number;
+        entries: Array<{
+            elementName: string;
+            type: VCObserverEntryType;
+            rect: DOMRect;
+            visible: boolean;
+            attributeName?: string | null;
+            oldValue?: string | null;
+            newValue?: string | null;
+        }>;
+    }>;
+    interactionId?: string;
+}
+export declare function getVCRevisionDebugDetails({ revision, isClean, abortReason, VCEntries, componentsLog, interactionId, }: {
+    revision: string;
+    isClean: boolean;
+    abortReason: string | null;
+    VCEntries: VCEntryType[];
+    componentsLog: ComponentsLogType;
+    interactionId?: string;
+}): VCRevisionDebugDetails;
+export {};

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

@@ -51,7 +51,7 @@ export declare class VCObserver implements VCObserverInterface {
         targetName: string;
         ignoreReason: VCIgnoreReason | undefined;
     }[];
-    getVCResult: ({ start, stop, tti, prefix, ssr, vc, isEventAborted, experienceKey, }: GetVCResultType) => Promise<VCResult>;
+    getVCResult: ({ start, stop, tti, prefix, ssr, vc, isEventAborted, experienceKey, interactionId, }: GetVCResultType) => Promise<VCResult>;
     static calculateVC({ heatmap, ssr, componentsLog, viewport, }: {
         heatmap: number[][];
         ssr?: number;

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

@@ -3,12 +3,14 @@ import { type SelectorConfig } from './get-element-name';
 import type { VCObserverGetVCResultParam } from './types';
 export type VCObserverNewConfig = {
     selectorConfig?: SelectorConfig;
+    isPostInteraction?: boolean;
 };
 export default class VCObserverNew {
     private selectorConfig;
     private viewportObserver;
     private windowEventObserver;
     private entriesTimeline;
+    private isPostInteraction;
     constructor(config: VCObserverNewConfig);
     start({ startTime }: {
         startTime: DOMHighResTimeStamp;

package/dist/types-ts4.5/vc/vc-observer-new/metric-calculator/abstract-base-vc-calculator.d.ts

@@ -10,5 +10,8 @@ export default abstract class AbstractVCCalculatorBase implements VCCalculator {
         isVCClean: boolean;
         dirtyReason?: VCAbortReason;
     };
-    calculate({ startTime, stopTime, orderedEntries, }: VCCalculatorParam): Promise<RevisionPayloadEntry | undefined>;
+    private filterViewportEntries;
+    private calculateBasic;
+    private calculateWithDebugInfo;
+    calculate({ startTime, stopTime, orderedEntries, interactionId, isPostInteraction, }: VCCalculatorParam): Promise<RevisionPayloadEntry | undefined>;
 }

package/dist/types-ts4.5/vc/vc-observer-new/metric-calculator/percentile-calc/canvas-heatmap/index.d.ts

@@ -1,5 +1,9 @@
 import type { RevisionPayloadVCDetails } from '../../../../../common/vc/types';
-import type { CalcTTVCPercentilesArg } from '../types';
+import type { ViewportEntryData } from '../../../types';
+import type { CalcTTVCPercentilesArg, CalcTTVCPercentilesArgWithDebugInfo, PercentileCalcResult } from '../types';
 declare function calculateTTVCPercentiles({ viewport, orderedEntries, percentiles, startTime, }: CalcTTVCPercentilesArg): Promise<RevisionPayloadVCDetails>;
+declare function calculateTTVCPercentilesWithDebugInfo({ viewport, orderedEntries, startTime, }: CalcTTVCPercentilesArgWithDebugInfo): Promise<PercentileCalcResult>;
 export default calculateTTVCPercentiles;
 export declare function calculatePercentiles(timePixelCounts: Map<DOMHighResTimeStamp, number>, elementMap: ReadonlyMap<DOMHighResTimeStamp, Set<string>>, unorderedPercentiles: number[], totalPixels: number, startTime: DOMHighResTimeStamp): RevisionPayloadVCDetails;
+export declare function calculatePercentilesWithDebugInfo(timePixelCounts: Map<DOMHighResTimeStamp, number>, elementMap: ReadonlyMap<DOMHighResTimeStamp, ViewportEntryData[]>, totalPixels: number, startTime: DOMHighResTimeStamp): PercentileCalcResult;
+export { calculateTTVCPercentilesWithDebugInfo };

package/dist/types-ts4.5/vc/vc-observer-new/metric-calculator/percentile-calc/canvas-heatmap/test-with-debug-info.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types-ts4.5/vc/vc-observer-new/metric-calculator/percentile-calc/index.d.ts

@@ -1,4 +1,2 @@
-import type { RevisionPayloadVCDetails } from '../../../../common/vc/types';
-import type { CalcTTVCPercentilesArg } from './types';
-declare function calculateTTVCPercentiles(arg: CalcTTVCPercentilesArg): Promise<RevisionPayloadVCDetails | null>;
-export default calculateTTVCPercentiles;
+export { default as calculateTTVCPercentiles } from './canvas-heatmap';
+export { calculateTTVCPercentilesWithDebugInfo } from './canvas-heatmap';

package/dist/types-ts4.5/vc/vc-observer-new/metric-calculator/percentile-calc/types.d.ts

@@ -1,11 +1,29 @@
-import type { VCObserverEntry } from '../../types';
+import type { VCObserverEntry, ViewportEntryData } from '../../types';
 export type CalcTTVCPercentilesArg = {
     viewport: {
         width: number;
         height: number;
     };
+    orderedEntries: ReadonlyArray<VCObserverEntry>;
+    percentiles: number[];
     startTime: DOMHighResTimeStamp;
     stopTime: DOMHighResTimeStamp;
+};
+export type CalcTTVCPercentilesArgWithDebugInfo = {
+    viewport: {
+        width: number;
+        height: number;
+    };
     orderedEntries: ReadonlyArray<VCObserverEntry>;
-    percentiles: number[];
+    startTime: DOMHighResTimeStamp;
+    stopTime: DOMHighResTimeStamp;
 };
+export interface PercentileCalcResultItem {
+    time: number;
+    viewportPercentage: number;
+    entries: ViewportEntryData[];
+}
+/**
+ * Ordered by time
+ */
+export type PercentileCalcResult = PercentileCalcResultItem[];

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

@@ -4,6 +4,8 @@ export type VCCalculatorParam = {
     startTime: DOMHighResTimeStamp;
     stopTime: DOMHighResTimeStamp;
     orderedEntries: ReadonlyArray<VCObserverEntry>;
+    interactionId?: string;
+    isPostInteraction: boolean;
 };
 export interface VCCalculator {
     calculate(param: VCCalculatorParam): Promise<RevisionPayloadEntry | undefined>;

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

@@ -1,21 +1,25 @@
 import type { ObservedWindowEvent } from './window-event-observer';
 export type VCObserverEntryType = 'mutation:child-element' | 'mutation:remount' | 'mutation:element' | 'mutation:element-replacement' | 'mutation:attribute:no-layout-shift' | 'mutation:attribute:non-visual-style' | 'mutation:attribute' | 'mutation:media' | 'layout-shift' | 'window:event' | 'unknown';
 export type ViewportEntryData = {
+    readonly type: VCObserverEntryType;
     readonly elementName: string;
     readonly rect: DOMRect;
     readonly previousRect?: DOMRect | undefined;
     readonly visible: boolean;
     readonly attributeName?: string | null | undefined;
+    readonly oldValue?: string | null | undefined;
+    readonly newValue?: string | null | undefined;
 };
 export type WindowEventEntryData = {
+    readonly type: VCObserverEntryType;
     readonly eventType: ObservedWindowEvent;
 };
 export type VCObserverEntry = {
     readonly time: DOMHighResTimeStamp;
-    readonly type: VCObserverEntryType;
     readonly data: ViewportEntryData | WindowEventEntryData;
 };
 export type VCObserverGetVCResultParam = {
     start: number;
     stop: number;
+    interactionId?: string;
 };

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

@@ -2,6 +2,8 @@ export type CreateMutationObserverProps = {
     onAttributeMutation: (props: {
         target: HTMLElement;
         attributeName: string;
+        oldValue?: string | undefined | null;
+        newValue?: string | undefined | null;
     }) => void;
     onMutationFinished?: (props: {
         targets: Array<HTMLElement>;

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

@@ -3,6 +3,8 @@ export type MutationRecordWithTimestamp = MutationRecord & {
 };
 export type AttributeMutationData = {
     attributeName: string;
+    oldValue?: string | undefined | null;
+    newValue?: string | undefined | null;
 };
 /**
  * Add here when there are more type of mutation data

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/react-ufo",
-	"version": "3.12.3",
+	"version": "3.12.5",
 	"description": "Parts of React UFO that are publicly available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -130,9 +130,6 @@
 		"platform_ufo_use_offscreen_canvas": {
 			"type": "boolean"
 		},
-		"platform_ufo_vc_align_revisions_on_watchdog_event": {
-			"type": "boolean"
-		},
 		"platform_ufo_canvas_heatmap_full_precision": {
 			"type": "boolean"
 		},
@@ -165,6 +162,9 @@
 		},
 		"platform_ufo_post_interaction_use_vc_rev": {
 			"type": "boolean"
+		},
+		"platform_ufo_ttvc_v3_devtool": {
+			"type": "boolean"
 		}
 	}
 }