@atlaskit/react-ufo 4.15.14 → 4.15.16

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

@@ -6,14 +6,15 @@ import _createClass from "@babel/runtime/helpers/createClass";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
 import { fg } from '@atlaskit/platform-feature-flags';
+import { isVCRevisionEnabled } from '../../config';
 import { getActiveInteraction } from '../../interaction-metrics';
 import { SSRPlaceholderHandlers } from '../vc-observer/observers/ssr-placeholders';
 import EntriesTimeline from './entries-timeline';
 import _getElementName from './get-element-name';
 import VCCalculator_FY25_03 from './metric-calculator/fy25_03';
+import VCCalculator_FY26_04 from './metric-calculator/fy26_04';
 import getViewportHeight from './metric-calculator/utils/get-viewport-height';
 import getViewportWidth from './metric-calculator/utils/get-viewport-width';
-import VCNextCalculator from './metric-calculator/vcnext';
 import RawDataHandler from './raw-data-handler';
 import ViewportObserver from './viewport-observer';
 import WindowEventObserver from './window-event-observer';
@@ -241,7 +242,7 @@ var VCObserverNew = /*#__PURE__*/function () {
     key: "getVCResult",
     value: function () {
       var _getVCResult = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(param) {
-        var start, stop, interactionId, interactionType, interactionAbortReason, isPageVisible, include3p, includeSSRRatio, excludeSmartAnswersInSearch, includeRawData, results, feVCCalculationStartTime, calculator_fy25_03, orderedEntries, fy25_03, calculator_next, vcNext, feVCCalculationEndTime, rawVCCalculationStartTime, rawHandler, raw;
+        var start, stop, interactionId, interactionType, interactionAbortReason, isPageVisible, include3p, includeSSRRatio, excludeSmartAnswersInSearch, includeRawData, results, feVCCalculationStartTime, calculator_fy25_03, orderedEntries, fy25_03, calculator_fy26_04, fy26_04, vcNext, _fy25_, calculator_next, _vcNext, feVCCalculationEndTime, rawVCCalculationStartTime, rawHandler, raw;
         return _regeneratorRuntime.wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
@@ -257,7 +258,15 @@ var VCObserverNew = /*#__PURE__*/function () {
                 start: start,
                 stop: stop
               });
-              _context.next = 9;
+              if (!fg('platform_ufo_vcnext_to_fy26_04_revision_update')) {
+                _context.next = 30;
+                break;
+              }
+              if (!isVCRevisionEnabled('fy25.03')) {
+                _context.next = 14;
+                break;
+              }
+              _context.next = 11;
               return calculator_fy25_03.calculate({
                 orderedEntries: orderedEntries,
                 startTime: start,
@@ -271,8 +280,14 @@ var VCObserverNew = /*#__PURE__*/function () {
                 isPageVisible: isPageVisible,
                 interactionAbortReason: interactionAbortReason
               });
-            case 9:
-              fy25_03 = _context.sent;
+            case 11:
+              _context.t0 = _context.sent;
+              _context.next = 15;
+              break;
+            case 14:
+              _context.t0 = null;
+            case 15:
+              fy25_03 = _context.t0;
               if (fy25_03) {
                 results.push(fy25_03);
               }
@@ -282,10 +297,71 @@ var VCObserverNew = /*#__PURE__*/function () {
               if (param.ssr && !param.includeSSRInV3 && fg('platform_ufo_auto_add_ssr_entry_in_ttvc_v4')) {
                 this.addSSR(param.ssr);
               }
+              calculator_fy26_04 = new VCCalculator_FY26_04();
+              if (!(isVCRevisionEnabled('fy26.04') || isVCRevisionEnabled('next'))) {
+                _context.next = 25;
+                break;
+              }
+              _context.next = 22;
+              return calculator_fy26_04.calculate({
+                orderedEntries: orderedEntries,
+                startTime: start,
+                stopTime: stop,
+                interactionId: interactionId,
+                interactionType: interactionType,
+                isPostInteraction: this.isPostInteraction,
+                include3p: include3p,
+                includeSSRRatio: includeSSRRatio,
+                isPageVisible: isPageVisible,
+                interactionAbortReason: interactionAbortReason
+              });
+            case 22:
+              _context.t1 = _context.sent;
+              _context.next = 26;
+              break;
+            case 25:
+              _context.t1 = null;
+            case 26:
+              fy26_04 = _context.t1;
+              if (fy26_04) {
+                vcNext = {
+                  revision: 'next',
+                  'metric:vc90': fy26_04['metric:vc90'],
+                  clean: fy26_04['clean']
+                };
+                results.push(fy26_04);
+                results.push(vcNext);
+              }
+              _context.next = 40;
+              break;
+            case 30:
+              _context.next = 32;
+              return calculator_fy25_03.calculate({
+                orderedEntries: orderedEntries,
+                startTime: start,
+                stopTime: stop,
+                interactionId: interactionId,
+                interactionType: interactionType,
+                isPostInteraction: this.isPostInteraction,
+                include3p: include3p,
+                excludeSmartAnswersInSearch: excludeSmartAnswersInSearch,
+                includeSSRRatio: includeSSRRatio,
+                isPageVisible: isPageVisible,
+                interactionAbortReason: interactionAbortReason
+              });
+            case 32:
+              _fy25_ = _context.sent;
+              if (_fy25_) {
+                results.push(_fy25_);
+              }
 
-              // TODO on cleanup: put behind `enabledVCRevisions` config
-              calculator_next = new VCNextCalculator();
-              _context.next = 15;
+              // From TTVC v4 onwards, ensuring that SSR entry is always auto-added, whenever it is configured.
+              // From the next major version release (where TTVC v4 becomes the default TTVC version), the config for `includeSSRInV3` will be deprecated
+              if (param.ssr && !param.includeSSRInV3 && fg('platform_ufo_auto_add_ssr_entry_in_ttvc_v4')) {
+                this.addSSR(param.ssr);
+              }
+              calculator_next = new VCCalculator_FY26_04();
+              _context.next = 38;
               return calculator_next.calculate({
                 orderedEntries: orderedEntries,
                 startTime: start,
@@ -298,35 +374,37 @@ var VCObserverNew = /*#__PURE__*/function () {
                 isPageVisible: isPageVisible,
                 interactionAbortReason: interactionAbortReason
               });
-            case 15:
-              vcNext = _context.sent;
-              if (vcNext) {
-                results.push(vcNext);
+            case 38:
+              _vcNext = _context.sent;
+              if (_vcNext) {
+                _vcNext.revision = 'next';
+                results.push(_vcNext);
               }
+            case 40:
               feVCCalculationEndTime = performance.now();
               if (!(includeRawData && fg('platform_ufo_enable_vc_raw_data'))) {
-                _context.next = 25;
+                _context.next = 48;
                 break;
               }
               rawVCCalculationStartTime = performance.now();
               rawHandler = new RawDataHandler();
-              _context.next = 23;
+              _context.next = 46;
               return rawHandler.getRawData({
                 entries: orderedEntries,
                 startTime: start,
                 stopTime: stop,
                 isPageVisible: isPageVisible
               });
-            case 23:
+            case 46:
               raw = _context.sent;
               if (raw) {
                 raw.rawVCTime = Number((performance.now() - rawVCCalculationStartTime).toFixed(2));
                 raw.feVCTime = Number((feVCCalculationEndTime - feVCCalculationStartTime).toFixed(2));
                 results.push(raw);
               }
-            case 25:
+            case 48:
               return _context.abrupt("return", results);
-            case 26:
+            case 49:
             case "end":
               return _context.stop();
           }

package/dist/esm/vc/vc-observer-new/metric-calculator/{vcnext → fy26_04}/index.js

@@ -10,9 +10,6 @@ function _superPropGet(t, o, e, r) { var p = _get(_getPrototypeOf(1 & r ? t.prot
 import { fg } from '@atlaskit/platform-feature-flags';
 import VCCalculator_FY25_03 from '../fy25_03';
 import { KNOWN_ATTRIBUTES_THAT_DOES_NOT_CAUSE_LAYOUT_SHIFTS, NON_VISUAL_ARIA_ATTRIBUTES, THIRD_PARTY_BROWSER_EXTENSION_ATTRIBUTES } from '../utils/constants';
-
-// NOTE: `next` to be renamed `fy26.04` once stable
-var REVISION_NO = 'next';
 var getConsideredEntryTypes = function getConsideredEntryTypes() {
   var consideredEntryTypes = ['mutation:display-contents-children-element'];
   if (fg('platform_ufo_remove_ssr_placeholder_in_ttvc_v4')) {
@@ -30,18 +27,16 @@ var getExcludedEntryTypes = function getExcludedEntryTypes() {
   }
   return excludedEntryTypes;
 };
-
-// NOTE: `VCNext` to be renamed `FY26_04` once stable
-var VCNextCalculator = /*#__PURE__*/function (_VCCalculator_FY25_) {
-  function VCNextCalculator() {
-    _classCallCheck(this, VCNextCalculator);
-    return _callSuper(this, VCNextCalculator, [REVISION_NO]);
+var VCCalculator_FY26_04 = /*#__PURE__*/function (_VCCalculator_FY25_) {
+  function VCCalculator_FY26_04() {
+    _classCallCheck(this, VCCalculator_FY26_04);
+    return _callSuper(this, VCCalculator_FY26_04, ['fy26.04']);
   }
-  _inherits(VCNextCalculator, _VCCalculator_FY25_);
-  return _createClass(VCNextCalculator, [{
+  _inherits(VCCalculator_FY26_04, _VCCalculator_FY25_);
+  return _createClass(VCCalculator_FY26_04, [{
     key: "isEntryIncluded",
     value: function isEntryIncluded(entry, include3p) {
-      var isEntryIncludedInV3 = _superPropGet(VCNextCalculator, "isEntryIncluded", this, 3)([entry, include3p]);
+      var isEntryIncludedInV3 = _superPropGet(VCCalculator_FY26_04, "isEntryIncluded", this, 3)([entry, include3p]);
       if (isEntryIncludedInV3 && !getExcludedEntryTypes().includes(entry.data.type)) {
         return true;
       }
@@ -57,4 +52,4 @@ var VCNextCalculator = /*#__PURE__*/function (_VCCalculator_FY25_) {
     }
   }]);
 }(VCCalculator_FY25_03);
-export { VCNextCalculator as default };
+export { VCCalculator_FY26_04 as default };

package/dist/esm/vc/vc-observer-new/metric-calculator/utils/get-viewport-height.js

@@ -3,7 +3,7 @@ function getViewportHeight() {
   var documentHeight;
   try {
     documentHeight = document.documentElement.clientHeight || 0;
-  } catch (e) {
+  } catch (_unused) {
     documentHeight = 0;
   }
   return Math.max(documentHeight, window.innerHeight || 0);

package/dist/esm/vc/vc-observer-new/metric-calculator/utils/get-viewport-width.js

@@ -3,7 +3,7 @@ function getViewportWidth() {
   var documentWidth;
   try {
     documentWidth = document.documentElement.clientWidth || 0;
-  } catch (e) {
+  } catch (_unused) {
     documentWidth = 0;
   }
   return Math.max(documentWidth, window.innerWidth || 0);

package/dist/esm/vc/vc-observer-new/raw-data-handler/index.js

@@ -13,6 +13,9 @@ import getViewportHeight from '../metric-calculator/utils/get-viewport-height';
 import getViewportWidth from '../metric-calculator/utils/get-viewport-width';
 var ABORTING_WINDOW_EVENT = ['wheel', 'scroll', 'keydown', 'resize'];
 var MAX_OBSERVATIONS = 100;
+function isWindowEventEntryData(data) {
+  return data.type === 'window:event' && 'eventType' in data;
+}
 var RawDataHandler = /*#__PURE__*/function () {
   function RawDataHandler() {
     _classCallCheck(this, RawDataHandler);
@@ -49,7 +52,7 @@ var RawDataHandler = /*#__PURE__*/function () {
     key: "getRawData",
     value: function () {
       var _getRawData = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(_ref) {
-        var entries, startTime, stopTime, isPageVisible, isVCClean, dirtyReason, getVCCleanStatusResult, viewportEntries, targetNameToIdMap, elementMapEntriesMap, nextElementId, typeMap, typeMapEntriesMap, nextTypeId, attributeMap, attributeEntriesMap, nextAttributeId, rawObservations, firstObservation, lastObservations, referencedEids, referencedChgs, referencedAtts, _iterator, _step, observation, _iterator2, _step2, eid, _iterator3, _step3, chg, _iterator4, _step4, att, result;
+        var entries, startTime, stopTime, isPageVisible, isVCClean, dirtyReason, getVCCleanStatusResult, viewportEntries, windowEventEntries, targetNameToIdMap, elementMapEntriesMap, nextElementId, typeMap, typeMapEntriesMap, nextTypeId, attributeMap, attributeEntriesMap, nextAttributeId, eventTypeMap, eventTypeMapEntriesMap, nextEventTypeId, rawObservations, rawEventObservations, firstObservation, lastObservations, referencedEids, referencedChgs, referencedAtts, _iterator, _step, observation, _iterator2, _step2, eid, _iterator3, _step3, chg, _iterator4, _step4, att, firstEventObservation, lastEventObservations, referencedEvts, _iterator5, _step5, _observation, _iterator6, _step6, evt, result;
         return _regeneratorRuntime.wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
@@ -76,6 +79,9 @@ var RawDataHandler = /*#__PURE__*/function () {
               viewportEntries = entries.filter(function (entry) {
                 return entry.time >= startTime && entry.time <= stopTime && entry.data && entry.data.visible;
               });
+              windowEventEntries = entries.filter(function (entry) {
+                return entry.time >= startTime && entry.time <= stopTime && entry.data && isWindowEventEntryData(entry.data);
+              });
               targetNameToIdMap = new Map();
               elementMapEntriesMap = {};
               nextElementId = 1;
@@ -85,6 +91,9 @@ var RawDataHandler = /*#__PURE__*/function () {
               attributeMap = new Map();
               attributeEntriesMap = {};
               nextAttributeId = 1;
+              eventTypeMap = new Map();
+              eventTypeMapEntriesMap = {};
+              nextEventTypeId = 1;
               rawObservations = viewportEntries.map(function (entry) {
                 var viewportEntry = entry.data;
                 var targetName = viewportEntry.elementName || '';
@@ -124,6 +133,22 @@ var RawDataHandler = /*#__PURE__*/function () {
                   att: att
                 } : {});
                 return observation;
+              });
+              rawEventObservations = windowEventEntries.map(function (entry) {
+                var windowEventEntry = entry.data;
+                var eventType = windowEventEntry.eventType;
+                var evtId = eventTypeMap.get(eventType) || 0;
+                if (evtId === 0) {
+                  evtId = nextEventTypeId;
+                  nextEventTypeId += 1;
+                  eventTypeMap.set(eventType, evtId);
+                  eventTypeMapEntriesMap[evtId] = eventType;
+                }
+                var eventObservation = {
+                  t: Math.round(entry.time - startTime),
+                  evt: evtId
+                };
+                return eventObservation;
               }); // If the number of observations is greater than the maximum allowed, we need to trim the observations to the maximum allowed.
               // We do this by keeping the first observation and the last MAX_OBSERVATIONS observations.
               // We then collect the referenced IDs from the remaining observations and remove the unreferenced entries from the maps
@@ -197,6 +222,46 @@ var RawDataHandler = /*#__PURE__*/function () {
                   _iterator4.f();
                 }
               }
+
+              // If the number of event observations is greater than the maximum allowed, we need to trim the event observations to the maximum allowed.
+              // We do this by keeping the first observation and the last MAX_OBSERVATIONS observations.
+              // We then collect the referenced IDs from the remaining observations and remove the unreferenced entries from the maps
+              if (rawEventObservations.length > MAX_OBSERVATIONS) {
+                firstEventObservation = rawEventObservations[0];
+                lastEventObservations = rawEventObservations.slice(-MAX_OBSERVATIONS);
+                rawEventObservations = [firstEventObservation].concat(_toConsumableArray(lastEventObservations));
+
+                // Collect referenced IDs from remaining observations
+                referencedEvts = new Set();
+                _iterator5 = _createForOfIteratorHelper(rawEventObservations);
+                try {
+                  for (_iterator5.s(); !(_step5 = _iterator5.n()).done;) {
+                    _observation = _step5.value;
+                    if (_observation.evt > 0) {
+                      referencedEvts.add(_observation.evt);
+                    }
+                  }
+
+                  // Remove unreferenced entries from maps
+                } catch (err) {
+                  _iterator5.e(err);
+                } finally {
+                  _iterator5.f();
+                }
+                _iterator6 = _createForOfIteratorHelper(Object.keys(eventTypeMapEntriesMap).map(Number));
+                try {
+                  for (_iterator6.s(); !(_step6 = _iterator6.n()).done;) {
+                    evt = _step6.value;
+                    if (!referencedEvts.has(evt)) {
+                      delete eventTypeMapEntriesMap[evt];
+                    }
+                  }
+                } catch (err) {
+                  _iterator6.e(err);
+                } finally {
+                  _iterator6.f();
+                }
+              }
               result = {
                 revision: this.revisionNo,
                 clean: isVCClean,
@@ -205,7 +270,9 @@ var RawDataHandler = /*#__PURE__*/function () {
                   obs: rawObservations !== null && rawObservations !== void 0 ? rawObservations : undefined,
                   eid: elementMapEntriesMap !== null && elementMapEntriesMap !== void 0 ? elementMapEntriesMap : undefined,
                   chg: typeMapEntriesMap !== null && typeMapEntriesMap !== void 0 ? typeMapEntriesMap : undefined,
-                  att: attributeEntriesMap !== null && attributeEntriesMap !== void 0 ? attributeEntriesMap : undefined
+                  att: attributeEntriesMap !== null && attributeEntriesMap !== void 0 ? attributeEntriesMap : undefined,
+                  evts: rawEventObservations.length > 0 ? rawEventObservations : undefined,
+                  evt: Object.keys(eventTypeMapEntriesMap).length > 0 ? eventTypeMapEntriesMap : undefined
                 },
                 abortReason: dirtyReason,
                 abortTimestamp: getVCCleanStatusResult.abortTimestamp,
@@ -215,7 +282,7 @@ var RawDataHandler = /*#__PURE__*/function () {
                 }
               };
               return _context.abrupt("return", result);
-            case 20:
+            case 26:
             case "end":
               return _context.stop();
           }

package/dist/esm/vc/vc-observer-new/viewport-observer/utils/is-element-visible.js

@@ -10,7 +10,7 @@ export function isElementVisible(element) {
       opacityProperty: true
     });
     return visible;
-  } catch (e) {
+  } catch (_unused) {
     // there is no support for checkVisibility
     return true;
   }

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

@@ -125,6 +125,10 @@ export type RawObservation = {
     eid: number;
     att?: number;
 };
+export type RawEventObservation = {
+    t: number;
+    evt: number;
+};
 export type RevisionPayloadEntry = {
     'metric:vc90': number | null;
     revision: string;
@@ -140,6 +144,8 @@ export type RevisionPayloadEntry = {
         eid?: Record<number, string>;
         chg?: Record<number, string>;
         att?: Record<number, string>;
+        evts?: Array<RawEventObservation>;
+        evt?: Record<number, string>;
     };
     viewport?: {
         w: number;

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

@@ -35,7 +35,7 @@ type SegmentThreshold = {
 type Rates = {
     readonly [key: string]: number;
 };
-export type TTVCRevision = 'fy25.01' | 'fy25.02' | 'fy25.03' | 'next';
+export type TTVCRevision = 'fy25.01' | 'fy25.02' | 'fy25.03' | 'fy26.04' | 'next';
 export declare const DEFAULT_TTVC_REVISION = "fy25.03";
 export declare const UNKNOWN_INTERACTION_RATE = 1000;
 export type ReactHydrationStats = {
@@ -55,6 +55,10 @@ export type ReactHydrationStats = {
      * The depth in the React component tree of the deepest warning.
      */
     maxWarningComponentDepth?: number;
+    /**
+     * The ratio of DOM nodes preserved during hydration (between 0 and 1).
+     */
+    preservationRatio?: number;
 };
 export type Config = {
     readonly enabled?: boolean;

package/dist/{types-ts4.5/vc/vc-observer-new/metric-calculator/vcnext → types/vc/vc-observer-new/metric-calculator/fy26_04}/index.d.ts

@@ -1,6 +1,6 @@
 import type { VCObserverEntry } from '../../types';
 import VCCalculator_FY25_03 from '../fy25_03';
-export default class VCNextCalculator extends VCCalculator_FY25_03 {
+export default class VCCalculator_FY26_04 extends VCCalculator_FY25_03 {
     constructor();
     protected isEntryIncluded(entry: VCObserverEntry, include3p?: boolean): boolean;
 }

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

@@ -130,6 +130,10 @@ export type RawObservation = {
     eid: number;
     att?: number;
 };
+export type RawEventObservation = {
+    t: number;
+    evt: number;
+};
 export type RevisionPayloadEntry = {
     'metric:vc90': number | null;
     revision: string;
@@ -145,6 +149,8 @@ export type RevisionPayloadEntry = {
         eid?: Record<number, string>;
         chg?: Record<number, string>;
         att?: Record<number, string>;
+        evts?: Array<RawEventObservation>;
+        evt?: Record<number, string>;
     };
     viewport?: {
         w: number;

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

@@ -35,7 +35,7 @@ type SegmentThreshold = {
 type Rates = {
     readonly [key: string]: number;
 };
-export type TTVCRevision = 'fy25.01' | 'fy25.02' | 'fy25.03' | 'next';
+export type TTVCRevision = 'fy25.01' | 'fy25.02' | 'fy25.03' | 'fy26.04' | 'next';
 export declare const DEFAULT_TTVC_REVISION = "fy25.03";
 export declare const UNKNOWN_INTERACTION_RATE = 1000;
 export type ReactHydrationStats = {
@@ -55,6 +55,10 @@ export type ReactHydrationStats = {
      * The depth in the React component tree of the deepest warning.
      */
     maxWarningComponentDepth?: number;
+    /**
+     * The ratio of DOM nodes preserved during hydration (between 0 and 1).
+     */
+    preservationRatio?: number;
 };
 export type Config = {
     readonly enabled?: boolean;

package/dist/{types/vc/vc-observer-new/metric-calculator/vcnext → types-ts4.5/vc/vc-observer-new/metric-calculator/fy26_04}/index.d.ts

@@ -1,6 +1,6 @@
 import type { VCObserverEntry } from '../../types';
 import VCCalculator_FY25_03 from '../fy25_03';
-export default class VCNextCalculator extends VCCalculator_FY25_03 {
+export default class VCCalculator_FY26_04 extends VCCalculator_FY25_03 {
     constructor();
     protected isEntryIncluded(entry: VCObserverEntry, include3p?: boolean): boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/react-ufo",
-	"version": "4.15.14",
+	"version": "4.15.16",
 	"description": "Parts of React UFO that are publicly available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -128,6 +128,9 @@
 		"platform_ufo_segment_critical_metrics": {
 			"type": "boolean"
 		},
+		"platform_ufo_vcnext_to_fy26_04_revision_update": {
+			"type": "boolean"
+		},
 		"platform_ufo_v4_fix_nested_ssr_placeholder": {
 			"type": "boolean"
 		},