@atlaskit/react-ufo 3.10.4 → 3.11.0

package/dist/esm/vc/vc-observer/index.js

@@ -11,6 +11,7 @@ function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbol
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 import { fg } from '@atlaskit/platform-feature-flags';
 import { isVCRevisionEnabled } from '../../config';
+import { getActiveInteraction } from '../../interaction-metrics';
 import { attachAbortListeners } from './attachAbortListeners';
 import { getVCRevisionsData } from './getVCRevisionsData';
 import { getViewportHeight, getViewportWidth } from './getViewport';
@@ -98,11 +99,11 @@ export var VCObserver = /*#__PURE__*/function () {
     });
     _defineProperty(this, "getVCResult", /*#__PURE__*/function () {
       var _ref4 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(_ref3) {
-        var start, stop, tti, prefix, ssr, vc, isEventAborted, startTime, fullPrefix, rawData, abortReason, abortReasonInfo, heatmap, heatmapNext, outOfBoundaryInfo, totalTime, componentsLog, viewport, devToolsEnabled, ratios, multiHeatmap, isTTVCv1Disabled, vcAbortedResultWithRevisions, ttvcV1Result, VC, VCBox, VCEntries, totalPainted, _componentsLog, vcNext, outOfBoundary, stopTime, ttvcV1DevToolInfo, ttvcV2DevToolInfo, isVCClean, revisionsData, speedIndex, isTTVCv3Enabled;
+        var start, stop, tti, prefix, ssr, vc, isEventAborted, experienceKey, startTime, fullPrefix, rawData, abortReason, abortReasonInfo, heatmap, heatmapNext, outOfBoundaryInfo, totalTime, componentsLog, viewport, devToolsEnabled, ratios, multiHeatmap, isTTVCv1Disabled, vcAbortedResultWithRevisions, ttvcV1Result, VC, VCBox, VCEntries, totalPainted, _componentsLog, vcNext, outOfBoundary, stopTime, ttvcV1DevToolInfo, ttvcV2DevToolInfo, isVCClean, revisionsData, speedIndex, isTTVCv3Enabled;
         return _regeneratorRuntime.wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
-              start = _ref3.start, stop = _ref3.stop, tti = _ref3.tti, prefix = _ref3.prefix, ssr = _ref3.ssr, vc = _ref3.vc, isEventAborted = _ref3.isEventAborted;
+              start = _ref3.start, stop = _ref3.stop, tti = _ref3.tti, prefix = _ref3.prefix, ssr = _ref3.ssr, vc = _ref3.vc, isEventAborted = _ref3.isEventAborted, experienceKey = _ref3.experienceKey;
               startTime = performance.now(); // add local measurement
               fullPrefix = prefix !== undefined && prefix !== '' ? "".concat(prefix, ":") : '';
               rawData = vc !== undefined ? vc : _this.getVCRawData();
@@ -113,7 +114,7 @@ export var VCObserver = /*#__PURE__*/function () {
               return _context.abrupt("return", {});
             case 6:
               abortReason = rawData.abortReason, abortReasonInfo = rawData.abortReasonInfo, heatmap = rawData.heatmap, heatmapNext = rawData.heatmapNext, outOfBoundaryInfo = rawData.outOfBoundaryInfo, totalTime = rawData.totalTime, componentsLog = rawData.componentsLog, viewport = rawData.viewport, devToolsEnabled = rawData.devToolsEnabled, ratios = rawData.ratios, multiHeatmap = rawData.multiHeatmap;
-              isTTVCv1Disabled = !isVCRevisionEnabled('fy25.01'); // NOTE: as part of platform_ufo_add_vc_abort_reason_by_revisions feature,
+              isTTVCv1Disabled = fg('platform_ufo_vc_enable_revisions_by_experience') ? !isVCRevisionEnabled('fy25.01', experienceKey) : !isVCRevisionEnabled('fy25.01'); // NOTE: as part of platform_ufo_add_vc_abort_reason_by_revisions feature,
               // we want to report abort by scroll events the same way as other abort reasons
               // i.e. not have the concept of `abortReason.blocking` anymore
               if (!(abortReasonInfo !== null && fg('platform_ufo_add_vc_abort_reason_by_revisions'))) {
@@ -301,7 +302,8 @@ export var VCObserver = /*#__PURE__*/function () {
                   VC: vcNext.VC,
                   VCBox: vcNext.VCBox
                 },
-                isEventAborted: isEventAborted
+                isEventAborted: isEventAborted,
+                experienceKey: experienceKey
               });
               speedIndex = _defineProperty(_defineProperty({}, "ufo:speedIndex", isTTVCv1Disabled ? vcNext.VCEntries.speedIndex : VCEntries.speedIndex), "ufo:next:speedIndex", vcNext.VCEntries.speedIndex);
               if (!isTTVCv1Disabled) {
@@ -310,7 +312,7 @@ export var VCObserver = /*#__PURE__*/function () {
               }
               return _context.abrupt("return", _objectSpread(_objectSpread(_objectSpread(_defineProperty(_defineProperty(_defineProperty({}, "".concat(fullPrefix, "vc:size"), viewport), "".concat(fullPrefix, "vc:time"), Math.round(totalTime + (stopTime - startTime))), "".concat(fullPrefix, "vc:ratios"), ratios), outOfBoundary), {}, _defineProperty({}, "".concat(fullPrefix, "vc:ignored"), _this.getIgnoredElements(componentsLog)), revisionsData), speedIndex));
             case 32:
-              isTTVCv3Enabled = isVCRevisionEnabled('fy25.03');
+              isTTVCv3Enabled = fg('platform_ufo_vc_enable_revisions_by_experience') ? isVCRevisionEnabled('fy25.03', experienceKey) : isVCRevisionEnabled('fy25.03');
               return _context.abrupt("return", _objectSpread(_objectSpread(_objectSpread(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty({
                 'metrics:vc': VC
               }, "".concat(fullPrefix, "vc:state"), true), "".concat(fullPrefix, "vc:clean"), isVCClean), "".concat(fullPrefix, "vc:dom"), VCBox), "".concat(fullPrefix, "vc:updates"), isTTVCv3Enabled ? undefined : VCEntries.rel.slice(0, 50)), "".concat(fullPrefix, "vc:size"), viewport), "".concat(fullPrefix, "vc:time"), Math.round(totalTime + (stopTime - startTime))), "".concat(fullPrefix, "vc:total"), totalPainted), "".concat(fullPrefix, "vc:ratios"), ratios), outOfBoundary), {}, _defineProperty(_defineProperty(_defineProperty(_defineProperty({}, "".concat(fullPrefix, "vc:next"), vcNext.VC), "".concat(fullPrefix, "vc:next:updates"), isTTVCv3Enabled ? undefined : vcNext.VCEntries.rel.slice(0, 50)), "".concat(fullPrefix, "vc:next:dom"), vcNext.VCBox), "".concat(fullPrefix, "vc:ignored"), _this.getIgnoredElements(componentsLog)), revisionsData), speedIndex));
@@ -327,7 +329,12 @@ export var VCObserver = /*#__PURE__*/function () {
     _defineProperty(this, "handleUpdate", function (rawTime, intersectionRect, targetName, element, type, ignoreReason, attributeName, oldValue, newValue) {
       _this.measureStart();
       _this.legacyHandleUpdate(rawTime, intersectionRect, targetName, element, type, ignoreReason, attributeName, oldValue, newValue);
-      if (!isVCRevisionEnabled('fy25.03')) {
+      var isTTVCv3Disabled = !isVCRevisionEnabled('fy25.03');
+      if (fg('platform_ufo_vc_enable_revisions_by_experience')) {
+        var interaction = getActiveInteraction();
+        isTTVCv3Disabled = !isVCRevisionEnabled('fy25.03', interaction === null || interaction === void 0 ? void 0 : interaction.ufoName);
+      }
+      if (isTTVCv3Disabled) {
         _this.onViewportChangeDetected({
           timestamp: rawTime,
           intersectionRect: intersectionRect,
@@ -351,6 +358,10 @@ export var VCObserver = /*#__PURE__*/function () {
           _this.applyChangesToHeatMap(mappedValues, time, _this.heatmapNext);
         }
         var isTTVCv1Disabled = !isVCRevisionEnabled('fy25.01');
+        if (fg('platform_ufo_vc_enable_revisions_by_experience')) {
+          var interaction = getActiveInteraction();
+          isTTVCv1Disabled = !isVCRevisionEnabled('fy25.01', interaction === null || interaction === void 0 ? void 0 : interaction.ufoName);
+        }
         if (!isTTVCv1Disabled && (!ignoreReason || ignoreReason === 'not-visible') && type !== 'attr') {
           _this.applyChangesToHeatMap(mappedValues, time, _this.heatmap);
         }

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

@@ -74,7 +74,17 @@ export type Config = {
         readonly ssr?: boolean;
         readonly ssrWhitelist?: string[];
         readonly stopVCAtInteractionFinish?: boolean;
-        readonly enabledVCRevisions?: readonly TTVCRevisions[];
+        /**
+         * The revisions of TTVC that will be calculated
+         * - `all` is the TTVC revisions that are used on a product level
+         * - `byExperience` is the version that is used on an experience level.
+         *   Note that an entry in the `byExperience` config should only be a SUBSET of the `all` config,
+         *   i.e. every element for all `byExperience` entry configs should exist in the `all` config
+         */
+        readonly enabledVCRevisions?: {
+            all: readonly TTVCRevisions[];
+            byExperience?: Record<string, readonly TTVCRevisions[]>;
+        };
     };
     readonly postInteractionLog?: {
         readonly enabled?: boolean;
@@ -99,8 +109,9 @@ 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 getEnabledVCRevisions(experienceKey?: string): readonly TTVCRevisions[];
+export declare function isVCRevisionEnabled(revision: TTVCRevisions, experienceKey?: string): boolean;
+export declare function getMostRecentVCRevision(experienceKey?: string): TTVCRevisions;
 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/create-post-interaction-log-payload/index.d.ts

@@ -26,12 +26,12 @@ declare function createPostInteractionLogPayload({ lastInteractionFinish, reactP
                     vc90: number | null;
                     vcClean: boolean;
                     type: import("../common").InteractionType;
-                    id: string;
                     abortReason?: import("../common").AbortReasonType | undefined;
+                    id: string;
                     abortedByInteractionName?: string | undefined;
                     routeName: string | null;
-                    experimentalTTAI?: number | undefined;
                     experimentalVC90?: number | undefined;
+                    experimentalTTAI?: number | undefined;
                 };
                 revisedEndTime: number;
                 revisedTtai: number;

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

@@ -7,6 +7,7 @@ export type GetVCResultType = {
     prefix?: string;
     ssr?: number;
     vc?: VCRawDataType | null;
+    experienceKey: string;
 };
 export type SelectorConfig = {
     id: boolean;
@@ -25,8 +26,9 @@ export type VCObserverOptions = {
 export interface VCObserverInterface {
     start(startArg: {
         startTime: number;
+        experienceKey?: string;
     }): void;
-    stop(): void;
+    stop(experienceKey?: string): void;
     getVCRawData(): VCRawDataType | null;
     getVCResult(param: GetVCResultType): Promise<VCResult>;
     setSSRElement(element: HTMLElement): void;

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

@@ -1,4 +1,5 @@
 import { InteractionMetrics } from '../../common/common/types';
+import { RevisionPayload } from '../../common/vc/types';
 import type { MultiRevisionHeatmap } from './heatmap/heatmap';
 type CalculatedVC = {
     VC: {
@@ -8,7 +9,7 @@ type CalculatedVC = {
         [key: string]: string[] | null;
     };
 };
-export declare function getVCRevisionsData({ fullPrefix, interaction, isVCClean, isEventAborted, multiHeatmap, ssr, calculatedVC, calculatedVCNext, }: {
+export declare function getVCRevisionsData({ fullPrefix, interaction, isVCClean, isEventAborted, multiHeatmap, ssr, calculatedVC, calculatedVCNext, experienceKey, }: {
     fullPrefix?: string;
     interaction: Pick<InteractionMetrics, 'start' | 'end'>;
     isVCClean: boolean;
@@ -16,9 +17,10 @@ export declare function getVCRevisionsData({ fullPrefix, interaction, isVCClean,
     multiHeatmap: MultiRevisionHeatmap | null;
     calculatedVC: CalculatedVC;
     calculatedVCNext: CalculatedVC;
+    experienceKey: string;
     ssr?: number;
 }): {
-    [x: string]: import("../../common").RevisionPayload;
+    [x: string]: RevisionPayload;
 } | {
     [x: string]: {
         revision: string;
@@ -26,7 +28,7 @@ export declare function getVCRevisionsData({ fullPrefix, interaction, isVCClean,
         'metric:vc90': number | null;
         vcDetails: {
             [key: string]: {
-                t: number | null | undefined;
+                t: number;
                 e: string[];
             };
         };

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, }: GetVCResultType) => Promise<VCResult>;
+    getVCResult: ({ start, stop, tti, prefix, ssr, vc, isEventAborted, experienceKey, }: GetVCResultType) => Promise<VCResult>;
     static calculateVC({ heatmap, ssr, componentsLog, viewport, }: {
         heatmap: number[][];
         ssr?: number;

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

@@ -74,7 +74,17 @@ export type Config = {
         readonly ssr?: boolean;
         readonly ssrWhitelist?: string[];
         readonly stopVCAtInteractionFinish?: boolean;
-        readonly enabledVCRevisions?: readonly TTVCRevisions[];
+        /**
+         * The revisions of TTVC that will be calculated
+         * - `all` is the TTVC revisions that are used on a product level
+         * - `byExperience` is the version that is used on an experience level.
+         *   Note that an entry in the `byExperience` config should only be a SUBSET of the `all` config,
+         *   i.e. every element for all `byExperience` entry configs should exist in the `all` config
+         */
+        readonly enabledVCRevisions?: {
+            all: readonly TTVCRevisions[];
+            byExperience?: Record<string, readonly TTVCRevisions[]>;
+        };
     };
     readonly postInteractionLog?: {
         readonly enabled?: boolean;
@@ -99,8 +109,9 @@ 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 getEnabledVCRevisions(experienceKey?: string): readonly TTVCRevisions[];
+export declare function isVCRevisionEnabled(revision: TTVCRevisions, experienceKey?: string): boolean;
+export declare function getMostRecentVCRevision(experienceKey?: string): TTVCRevisions;
 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/create-post-interaction-log-payload/index.d.ts

@@ -26,12 +26,12 @@ declare function createPostInteractionLogPayload({ lastInteractionFinish, reactP
                     vc90: number | null;
                     vcClean: boolean;
                     type: import("../common").InteractionType;
-                    id: string;
                     abortReason?: import("../common").AbortReasonType | undefined;
+                    id: string;
                     abortedByInteractionName?: string | undefined;
                     routeName: string | null;
-                    experimentalTTAI?: number | undefined;
                     experimentalVC90?: number | undefined;
+                    experimentalTTAI?: number | undefined;
                 };
                 revisedEndTime: number;
                 revisedTtai: number;

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

@@ -7,6 +7,7 @@ export type GetVCResultType = {
     prefix?: string;
     ssr?: number;
     vc?: VCRawDataType | null;
+    experienceKey: string;
 };
 export type SelectorConfig = {
     id: boolean;
@@ -25,8 +26,9 @@ export type VCObserverOptions = {
 export interface VCObserverInterface {
     start(startArg: {
         startTime: number;
+        experienceKey?: string;
     }): void;
-    stop(): void;
+    stop(experienceKey?: string): void;
     getVCRawData(): VCRawDataType | null;
     getVCResult(param: GetVCResultType): Promise<VCResult>;
     setSSRElement(element: HTMLElement): void;

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

@@ -1,4 +1,5 @@
 import { InteractionMetrics } from '../../common/common/types';
+import { RevisionPayload } from '../../common/vc/types';
 import type { MultiRevisionHeatmap } from './heatmap/heatmap';
 type CalculatedVC = {
     VC: {
@@ -8,7 +9,7 @@ type CalculatedVC = {
         [key: string]: string[] | null;
     };
 };
-export declare function getVCRevisionsData({ fullPrefix, interaction, isVCClean, isEventAborted, multiHeatmap, ssr, calculatedVC, calculatedVCNext, }: {
+export declare function getVCRevisionsData({ fullPrefix, interaction, isVCClean, isEventAborted, multiHeatmap, ssr, calculatedVC, calculatedVCNext, experienceKey, }: {
     fullPrefix?: string;
     interaction: Pick<InteractionMetrics, 'start' | 'end'>;
     isVCClean: boolean;
@@ -16,9 +17,10 @@ export declare function getVCRevisionsData({ fullPrefix, interaction, isVCClean,
     multiHeatmap: MultiRevisionHeatmap | null;
     calculatedVC: CalculatedVC;
     calculatedVCNext: CalculatedVC;
+    experienceKey: string;
     ssr?: number;
 }): {
-    [x: string]: import("../../common").RevisionPayload;
+    [x: string]: RevisionPayload;
 } | {
     [x: string]: {
         revision: string;
@@ -26,7 +28,7 @@ export declare function getVCRevisionsData({ fullPrefix, interaction, isVCClean,
         'metric:vc90': number | null;
         vcDetails: {
             [key: string]: {
-                t: number | null | undefined;
+                t: number;
                 e: string[];
             };
         };

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, }: GetVCResultType) => Promise<VCResult>;
+    getVCResult: ({ start, stop, tti, prefix, ssr, vc, isEventAborted, experienceKey, }: GetVCResultType) => Promise<VCResult>;
     static calculateVC({ heatmap, ssr, componentsLog, viewport, }: {
         heatmap: number[][];
         ssr?: number;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/react-ufo",
-	"version": "3.10.4",
+	"version": "3.11.0",
 	"description": "Parts of React UFO that are publicly available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -133,6 +133,9 @@
 		"platform_ufo_canvas_heatmap_full_precision": {
 			"type": "boolean"
 		},
+		"platform_ufo_vc_enable_revisions_by_experience": {
+			"type": "boolean"
+		},
 		"ufo_return_relative_request_start": {
 			"type": "boolean"
 		},