@atlaskit/react-ufo 3.9.5 → 3.10.1

package/dist/esm/vc/vc-observer-new/metric-calculator/fy25_03/index.js

@@ -54,6 +54,30 @@ var VCCalculator_FY25_03 = /*#__PURE__*/function (_AbstractVCCalculator) {
       });
       return !hasAbortEvent;
     }
+  }, {
+    key: "getVCCleanStatus",
+    value: function getVCCleanStatus(filteredEntries) {
+      var dirtyReason = '';
+      var hasAbortEvent = filteredEntries.some(function (entry) {
+        if (entry.type === 'window:event') {
+          var data = entry.data;
+          if (ABORTING_WINDOW_EVENT.includes(data.eventType)) {
+            dirtyReason = data.eventType === 'keydown' ? 'keypress' : data.eventType;
+            return true;
+          }
+        }
+        return false;
+      });
+      if (hasAbortEvent && dirtyReason) {
+        return {
+          isVCClean: false,
+          dirtyReason: dirtyReason
+        };
+      }
+      return {
+        isVCClean: true
+      };
+    }
   }]);
 }(AbstractVCCalculatorBase);
 export { VCCalculator_FY25_03 as default };

package/dist/esm/vc/vc-observer-new/metric-calculator/percentile-calc/index.js

@@ -1,7 +1,7 @@
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
 import calcUsingCanvas from './canvas-heatmap';
-import caclUsingOldHeatmap from './heatmap';
+import calcUsingOldHeatmap from './heatmap';
 import calcUsingRectSweepingLine from './rect-sweeping-line';
 function calculateTTVCPercentiles(_x) {
   return _calculateTTVCPercentiles.apply(this, arguments);
@@ -38,7 +38,7 @@ function _calculateTTVCPercentiles() {
             break;
           }
           _context.next = 14;
-          return caclUsingOldHeatmap(arg);
+          return calcUsingOldHeatmap(arg);
         case 14:
           _vcDetails2 = _context.sent;
           return _context.abrupt("return", _vcDetails2);

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

@@ -5,7 +5,7 @@ export declare const AbortEvent: {
     readonly keydown: "keydown";
     readonly resize: "resize";
 };
-export type VCAbortReason = 'custom' | 'scroll' | 'keypress' | 'resize' | 'error' | 'not-supported';
+export type VCAbortReason = 'custom' | 'scroll' | 'keypress' | 'resize' | 'error' | 'not-supported' | 'wheel';
 export type VCAbortReasonType = {
     reason: null | VCAbortReason;
     info: string;
@@ -115,6 +115,7 @@ export type RevisionPayloadEntry = {
     revision: string;
     clean: boolean;
     vcDetails?: RevisionPayloadVCDetails;
+    abortReason?: VCAbortReason | null;
 };
 export type RevisionPayload = RevisionPayloadEntry[];
 export {};

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

@@ -99,6 +99,8 @@ export type Config = {
 };
 export declare function setUFOConfig(newConfig: Config): void;
 export declare function getConfig(): Config | undefined;
+export declare function getEnabledVCRevisions(): TTVCRevisions[];
+export declare function isVCRevisionEnabled(revision: TTVCRevisions): boolean;
 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;

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

@@ -1,5 +1,5 @@
+import { RevisionPayloadEntry } from '../../common/vc/types';
 import { type SelectorConfig } from './get-element-name';
-import type { RevisionPayloadEntry } from './metric-calculator/types';
 import type { VCObserverGetVCResultParam } from './types';
 export type VCObserverNewConfig = {
     selectorConfig?: SelectorConfig;

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

@@ -1,9 +1,14 @@
+import { RevisionPayloadEntry, VCAbortReason } from '../../../common/vc/types';
 import type { VCObserverEntry } from '../types';
-import type { RevisionPayloadEntry, VCCalculator, VCCalculatorParam } from './types';
+import type { VCCalculator, VCCalculatorParam } from './types';
 export default abstract class AbstractVCCalculatorBase implements VCCalculator {
     private revisionNo;
     constructor(revisionNo: string);
     protected abstract isEntryIncluded(entry: VCObserverEntry): boolean;
     protected abstract isVCClean(filteredEntries: ReadonlyArray<VCObserverEntry>): boolean;
+    protected abstract getVCCleanStatus(filteredEntries: ReadonlyArray<VCObserverEntry>): {
+        isVCClean: boolean;
+        dirtyReason?: VCAbortReason;
+    };
     calculate({ startTime, stopTime, orderedEntries, }: VCCalculatorParam): Promise<RevisionPayloadEntry | undefined>;
 }

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

@@ -5,4 +5,11 @@ export default class VCCalculator_FY25_03 extends AbstractVCCalculatorBase {
     constructor();
     protected isEntryIncluded(entry: VCObserverEntry): boolean;
     protected isVCClean(filteredEntries: readonly VCObserverEntry[]): boolean;
+    protected getVCCleanStatus(filteredEntries: readonly VCObserverEntry[]): {
+        isVCClean: boolean;
+        dirtyReason: never;
+    } | {
+        isVCClean: boolean;
+        dirtyReason?: undefined;
+    };
 }

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

@@ -1,4 +1,4 @@
-import type { RevisionPayloadVCDetails } from '../../types';
+import type { RevisionPayloadVCDetails } from '../../../../../common/vc/types';
 import type { CalcTTVCPercentilesArg } from '../types';
 declare function calculateTTVCPercentiles({ viewport, orderedEntries, percentiles, startTime, }: CalcTTVCPercentilesArg): Promise<RevisionPayloadVCDetails>;
 export default calculateTTVCPercentiles;

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

@@ -1,5 +1,5 @@
+import type { RevisionPayloadVCDetails } from '../../../../../common/vc/types';
 import type { VCObserverEntry } from '../../../types';
-import type { RevisionPayloadVCDetails } from '../../types';
 import type { Viewport } from './types';
 declare function calculateTTVCPercentiles({ orderedEntries, viewport, percentiles, startTime, }: {
     orderedEntries: ReadonlyArray<VCObserverEntry>;

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

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

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

@@ -1,17 +1,5 @@
+import { RevisionPayloadEntry } from '../../../common/vc/types';
 import type { VCObserverEntry } from '../types';
-export type RevisionPayloadVCDetails = {
-    [key: string]: {
-        t: number;
-        e: string[];
-    };
-};
-export type RevisionPayloadEntry = {
-    'metric:vc90': number | null;
-    revision: string;
-    clean: boolean;
-    vcDetails?: RevisionPayloadVCDetails;
-};
-export type RevisionPayload = RevisionPayloadEntry[];
 export type VCCalculatorParam = {
     startTime: DOMHighResTimeStamp;
     stopTime: DOMHighResTimeStamp;

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

@@ -5,7 +5,7 @@ export declare const AbortEvent: {
     readonly keydown: "keydown";
     readonly resize: "resize";
 };
-export type VCAbortReason = 'custom' | 'scroll' | 'keypress' | 'resize' | 'error' | 'not-supported';
+export type VCAbortReason = 'custom' | 'scroll' | 'keypress' | 'resize' | 'error' | 'not-supported' | 'wheel';
 export type VCAbortReasonType = {
     reason: null | VCAbortReason;
     info: string;
@@ -115,6 +115,7 @@ export type RevisionPayloadEntry = {
     revision: string;
     clean: boolean;
     vcDetails?: RevisionPayloadVCDetails;
+    abortReason?: VCAbortReason | null;
 };
 export type RevisionPayload = RevisionPayloadEntry[];
 export {};

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

@@ -99,6 +99,8 @@ export type Config = {
 };
 export declare function setUFOConfig(newConfig: Config): void;
 export declare function getConfig(): Config | undefined;
+export declare function getEnabledVCRevisions(): TTVCRevisions[];
+export declare function isVCRevisionEnabled(revision: TTVCRevisions): boolean;
 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;

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

@@ -1,5 +1,5 @@
+import { RevisionPayloadEntry } from '../../common/vc/types';
 import { type SelectorConfig } from './get-element-name';
-import type { RevisionPayloadEntry } from './metric-calculator/types';
 import type { VCObserverGetVCResultParam } from './types';
 export type VCObserverNewConfig = {
     selectorConfig?: SelectorConfig;

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

@@ -1,9 +1,14 @@
+import { RevisionPayloadEntry, VCAbortReason } from '../../../common/vc/types';
 import type { VCObserverEntry } from '../types';
-import type { RevisionPayloadEntry, VCCalculator, VCCalculatorParam } from './types';
+import type { VCCalculator, VCCalculatorParam } from './types';
 export default abstract class AbstractVCCalculatorBase implements VCCalculator {
     private revisionNo;
     constructor(revisionNo: string);
     protected abstract isEntryIncluded(entry: VCObserverEntry): boolean;
     protected abstract isVCClean(filteredEntries: ReadonlyArray<VCObserverEntry>): boolean;
+    protected abstract getVCCleanStatus(filteredEntries: ReadonlyArray<VCObserverEntry>): {
+        isVCClean: boolean;
+        dirtyReason?: VCAbortReason;
+    };
     calculate({ startTime, stopTime, orderedEntries, }: VCCalculatorParam): Promise<RevisionPayloadEntry | undefined>;
 }

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

@@ -5,4 +5,11 @@ export default class VCCalculator_FY25_03 extends AbstractVCCalculatorBase {
     constructor();
     protected isEntryIncluded(entry: VCObserverEntry): boolean;
     protected isVCClean(filteredEntries: readonly VCObserverEntry[]): boolean;
+    protected getVCCleanStatus(filteredEntries: readonly VCObserverEntry[]): {
+        isVCClean: boolean;
+        dirtyReason: never;
+    } | {
+        isVCClean: boolean;
+        dirtyReason?: undefined;
+    };
 }

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

@@ -1,4 +1,4 @@
-import type { RevisionPayloadVCDetails } from '../../types';
+import type { RevisionPayloadVCDetails } from '../../../../../common/vc/types';
 import type { CalcTTVCPercentilesArg } from '../types';
 declare function calculateTTVCPercentiles({ viewport, orderedEntries, percentiles, startTime, }: CalcTTVCPercentilesArg): Promise<RevisionPayloadVCDetails>;
 export default calculateTTVCPercentiles;

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

@@ -1,5 +1,5 @@
+import type { RevisionPayloadVCDetails } from '../../../../../common/vc/types';
 import type { VCObserverEntry } from '../../../types';
-import type { RevisionPayloadVCDetails } from '../../types';
 import type { Viewport } from './types';
 declare function calculateTTVCPercentiles({ orderedEntries, viewport, percentiles, startTime, }: {
     orderedEntries: ReadonlyArray<VCObserverEntry>;

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

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

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

@@ -1,17 +1,5 @@
+import { RevisionPayloadEntry } from '../../../common/vc/types';
 import type { VCObserverEntry } from '../types';
-export type RevisionPayloadVCDetails = {
-    [key: string]: {
-        t: number;
-        e: string[];
-    };
-};
-export type RevisionPayloadEntry = {
-    'metric:vc90': number | null;
-    revision: string;
-    clean: boolean;
-    vcDetails?: RevisionPayloadVCDetails;
-};
-export type RevisionPayload = RevisionPayloadEntry[];
 export type VCCalculatorParam = {
     startTime: DOMHighResTimeStamp;
     stopTime: DOMHighResTimeStamp;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/react-ufo",
-	"version": "3.9.5",
+	"version": "3.10.1",
 	"description": "Parts of React UFO that are publicly available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -133,7 +133,7 @@
 		"ufo_return_relative_request_start": {
 			"type": "boolean"
 		},
-		"platform_ufo_vc_observer_new": {
+		"platform_ufo_add_vc_abort_reason_by_revisions": {
 			"type": "boolean"
 		},
 		"enable_ufo_devtools_api_for_extra_events": {