@atlaskit/react-ufo 2.11.0 → 2.12.1

package/dist/esm/interaction-metrics/index.js

@@ -9,11 +9,12 @@ function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length)
 import { v4 as createUUID } from 'uuid';
 import coinflip from '../coinflip';
 import { getAwaitBM3TTIList, getCapabilityRate, getConfig } from '../config';
+import { experimentalVC, getExperimentalVCMetrics, onExperimentalInteractionComplete } from '../create-experimental-interaction-metrics-payload';
 import { clearActiveTrace } from '../experience-trace-id-context';
 import { allFeatureFlagsAccessed, currentFeatureFlagsAccessed } from '../feature-flags-accessed';
 import { getInteractionId } from '../interaction-id-context';
 import { getVCObserver } from '../vc';
-import interactions from './common/constants';
+import { interactions } from './common/constants';
 import PostInteractionLog from './post-interaction-log';
 var PreviousInteractionLog = {
   name: undefined,
@@ -247,16 +248,27 @@ function removeHoldCriterion(id) {
   }
   window.__CRITERION__.removeUFOHold(id);
 }
-export function addHold(interactionId, labelStack, name) {
+export function addHold(interactionId, labelStack, name, experimental) {
   var interaction = interactions.get(interactionId);
   var id = createUUID();
   if (interaction != null) {
+    var _getConfig2;
     var start = performance.now();
-    interaction.holdActive.set(id, {
+    var holdActive = {
       labelStack: labelStack,
       name: name,
       start: start
-    });
+    };
+    if ((_getConfig2 = getConfig()) !== null && _getConfig2 !== void 0 && (_getConfig2 = _getConfig2.experimentalInteractionMetrics) !== null && _getConfig2 !== void 0 && _getConfig2.enabled && experimental) {
+      interaction.holdExpActive.set(id, _objectSpread(_objectSpread({}, holdActive), {}, {
+        start: start
+      }));
+    }
+    if (!experimental) {
+      interaction.holdActive.set(id, _objectSpread(_objectSpread({}, holdActive), {}, {
+        start: start
+      }));
+    }
     addHoldCriterion(id, labelStack, name, start);
     return function () {
       var end = performance.now();
@@ -274,11 +286,20 @@ export function addHold(interactionId, labelStack, name) {
       removeHoldCriterion(id);
       var currentInteraction = interactions.get(interactionId);
       var currentHold = interaction.holdActive.get(id);
-      if (currentInteraction != null && currentHold != null) {
-        currentInteraction.holdInfo.push(_objectSpread(_objectSpread({}, currentHold), {}, {
-          end: end
-        }));
-        interaction.holdActive.delete(id);
+      var expHold = interaction.holdExpActive.get(id);
+      if (currentInteraction != null) {
+        if (currentHold != null) {
+          currentInteraction.holdInfo.push(_objectSpread(_objectSpread({}, currentHold), {}, {
+            end: end
+          }));
+          interaction.holdActive.delete(id);
+        }
+        if (expHold != null) {
+          currentInteraction.holdExpInfo.push(_objectSpread(_objectSpread({}, expHold), {}, {
+            end: end
+          }));
+          interaction.holdExpActive.delete(id);
+        }
       }
     };
   }
@@ -380,7 +401,7 @@ export function addErrorToAll(name, labelStack, errorType, errorMessage, errorSt
   });
 }
 export var addProfilerTimings = function addProfilerTimings(interactionId, labelStack, type, actualDuration, baseDuration, startTime, commitTime) {
-  var _getConfig2;
+  var _getConfig3;
   if (isPerformanceTracingEnabled()) {
     try {
       // for Firefox 102 and older
@@ -402,7 +423,7 @@ export var addProfilerTimings = function addProfilerTimings(interactionId, label
       startTime: startTime,
       commitTime: commitTime
     });
-  } else if ((_getConfig2 = getConfig()) !== null && _getConfig2 !== void 0 && (_getConfig2 = _getConfig2.postInteractionLog) !== null && _getConfig2 !== void 0 && _getConfig2.enabled) {
+  } else if ((_getConfig3 = getConfig()) !== null && _getConfig3 !== void 0 && (_getConfig3 = _getConfig3.postInteractionLog) !== null && _getConfig3 !== void 0 && _getConfig3.enabled) {
     postInteractionLog.addProfilerTimings(labelStack, type, actualDuration, baseDuration, startTime, commitTime);
   }
 };
@@ -419,9 +440,8 @@ function callCleanUpCallbacks(interaction) {
   });
 }
 var finishInteraction = function finishInteraction(id, data) {
-  var _getConfig3;
+  var _getConfig4, _getConfig5;
   var endTime = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : performance.now();
-  // eslint-disable-next-line no-param-reassign
   data.end = endTime;
   try {
     // for Firefox 102 and older
@@ -433,15 +453,16 @@ var finishInteraction = function finishInteraction(id, data) {
     // do nothing
   }
   if (data.featureFlags) {
-    // eslint-disable-next-line no-param-reassign
     data.featureFlags.during = Object.fromEntries(currentFeatureFlagsAccessed);
   }
   clearActiveTrace();
   callCleanUpCallbacks(data);
-  if ((_getConfig3 = getConfig()) !== null && _getConfig3 !== void 0 && (_getConfig3 = _getConfig3.vc) !== null && _getConfig3 !== void 0 && _getConfig3.stopVCAtInteractionFinish) {
+  if ((_getConfig4 = getConfig()) !== null && _getConfig4 !== void 0 && (_getConfig4 = _getConfig4.vc) !== null && _getConfig4 !== void 0 && _getConfig4.stopVCAtInteractionFinish) {
     data.vc = getVCObserver().getVCRawData();
   }
-  remove(id);
+  if (!((_getConfig5 = getConfig()) !== null && _getConfig5 !== void 0 && (_getConfig5 = _getConfig5.experimentalInteractionMetrics) !== null && _getConfig5 !== void 0 && _getConfig5.enabled)) {
+    remove(id);
+  }
   PreviousInteractionLog.name = data.ufoName || 'unknown';
   PreviousInteractionLog.isAborted = data.abortReason != null;
   if (data.ufoName) {
@@ -507,15 +528,48 @@ export var sinkInteractionHandler = function sinkInteractionHandler(sinkFn) {
 export var sinkPostInteractionLogHandler = function sinkPostInteractionLogHandler(sinkFn) {
   postInteractionLog.sinkHandler(sinkFn);
 };
+
+// a flag to prevent multiple submitting
+var activeSubmitted = false;
 export function tryComplete(interactionId, endTime) {
   var interaction = interactions.get(interactionId);
   if (interaction != null) {
-    var noMoreHolds = interaction.holdActive.size === 0;
-    if (noMoreHolds) {
-      var _getConfig4;
-      finishInteraction(interactionId, interaction, endTime);
-      if ((_getConfig4 = getConfig()) !== null && _getConfig4 !== void 0 && (_getConfig4 = _getConfig4.postInteractionLog) !== null && _getConfig4 !== void 0 && _getConfig4.enabled) {
-        postInteractionLog.onInteractionComplete(interaction);
+    var noMoreActiveHolds = interaction.holdActive.size === 0;
+    var noMoreExpHolds = interaction.holdExpActive.size === 0;
+    var postInteraction = function postInteraction() {
+      var _getConfig6, _getConfig8;
+      if ((_getConfig6 = getConfig()) !== null && _getConfig6 !== void 0 && (_getConfig6 = _getConfig6.postInteractionLog) !== null && _getConfig6 !== void 0 && _getConfig6.enabled) {
+        var _getConfig7;
+        var experimentalVC90;
+        var experimentalTTAI;
+        if ((_getConfig7 = getConfig()) !== null && _getConfig7 !== void 0 && (_getConfig7 = _getConfig7.experimentalInteractionMetrics) !== null && _getConfig7 !== void 0 && _getConfig7.enabled) {
+          var _getExperimentalVCMet;
+          experimentalVC90 = (_getExperimentalVCMet = getExperimentalVCMetrics(interaction)) === null || _getExperimentalVCMet === void 0 ? void 0 : _getExperimentalVCMet['metric:experimental:vc90'];
+          var start = interaction.start,
+            end = interaction.end;
+          experimentalTTAI = !interaction.abortReason ? Math.round(end - start) : undefined;
+        }
+        postInteractionLog.onInteractionComplete(_objectSpread(_objectSpread({}, interaction), {}, {
+          experimentalTTAI: experimentalTTAI,
+          experimentalVC90: experimentalVC90
+        }));
+      }
+      if ((_getConfig8 = getConfig()) !== null && _getConfig8 !== void 0 && (_getConfig8 = _getConfig8.experimentalInteractionMetrics) !== null && _getConfig8 !== void 0 && _getConfig8.enabled) {
+        remove(interactionId);
+      }
+      activeSubmitted = false;
+    };
+    if (noMoreActiveHolds) {
+      if (!activeSubmitted) {
+        finishInteraction(interactionId, interaction, endTime);
+        activeSubmitted = true;
+      }
+      if (noMoreExpHolds) {
+        var _getConfig9;
+        if ((_getConfig9 = getConfig()) !== null && _getConfig9 !== void 0 && (_getConfig9 = _getConfig9.experimentalInteractionMetrics) !== null && _getConfig9 !== void 0 && _getConfig9.enabled) {
+          onExperimentalInteractionComplete(interactionId, interaction, endTime);
+        }
+        postInteraction();
       }
     }
   }
@@ -528,33 +582,46 @@ function callCancelCallbacks(interaction) {
 export function abort(interactionId, abortReason) {
   var interaction = interactions.get(interactionId);
   if (interaction != null) {
+    var _getConfig10;
     callCancelCallbacks(interaction);
     interaction.abortReason = abortReason;
     finishInteraction(interactionId, interaction);
+    if ((_getConfig10 = getConfig()) !== null && _getConfig10 !== void 0 && (_getConfig10 = _getConfig10.experimentalInteractionMetrics) !== null && _getConfig10 !== void 0 && _getConfig10.enabled) {
+      onExperimentalInteractionComplete(interactionId, interaction);
+      remove(interactionId);
+    }
   }
 }
 export function abortByNewInteraction(interactionId, interactionName) {
   var interaction = interactions.get(interactionId);
   if (interaction != null) {
+    var _getConfig11;
     callCancelCallbacks(interaction);
     interaction.abortReason = 'new_interaction';
     interaction.abortedByInteractionName = interactionName;
     finishInteraction(interactionId, interaction);
+    if ((_getConfig11 = getConfig()) !== null && _getConfig11 !== void 0 && (_getConfig11 = _getConfig11.experimentalInteractionMetrics) !== null && _getConfig11 !== void 0 && _getConfig11.enabled) {
+      onExperimentalInteractionComplete(interactionId, interaction);
+      remove(interactionId);
+    }
   }
 }
 export function abortAll(abortReason, abortedByInteractionName) {
   interactions.forEach(function (interaction, interactionId) {
+    var _getConfig12;
     var noMoreHolds = interaction.holdActive.size === 0;
     if (!noMoreHolds) {
       callCancelCallbacks(interaction);
-      // eslint-disable-next-line no-param-reassign
       interaction.abortReason = abortReason;
       if (abortedByInteractionName != null) {
-        // eslint-disable-next-line no-param-reassign
         interaction.abortedByInteractionName = abortedByInteractionName;
       }
     }
     finishInteraction(interactionId, interaction);
+    if ((_getConfig12 = getConfig()) !== null && _getConfig12 !== void 0 && (_getConfig12 = _getConfig12.experimentalInteractionMetrics) !== null && _getConfig12 !== void 0 && _getConfig12.enabled) {
+      onExperimentalInteractionComplete(interactionId, interaction);
+      remove(interactionId);
+    }
   });
 }
 export function addOnCancelCallback(id, cancelCallback) {
@@ -562,9 +629,9 @@ export function addOnCancelCallback(id, cancelCallback) {
   interaction === null || interaction === void 0 || interaction.cancelCallbacks.push(cancelCallback);
 }
 export function addNewInteraction(interactionId, ufoName, type, startTime, rate, labelStack, routeName) {
-  var _getConfig5;
+  var _getConfig13;
   var trace = arguments.length > 7 && arguments[7] !== undefined ? arguments[7] : null;
-  if ((_getConfig5 = getConfig()) !== null && _getConfig5 !== void 0 && (_getConfig5 = _getConfig5.postInteractionLog) !== null && _getConfig5 !== void 0 && _getConfig5.enabled) {
+  if ((_getConfig13 = getConfig()) !== null && _getConfig13 !== void 0 && (_getConfig13 = _getConfig13.postInteractionLog) !== null && _getConfig13 !== void 0 && _getConfig13.enabled) {
     postInteractionLog.reset();
   }
   var previousTime = startTime;
@@ -604,9 +671,11 @@ export function addNewInteraction(interactionId, ufoName, type, startTime, rate,
     requestInfo: [],
     reactProfilerTimings: [],
     holdInfo: [],
+    holdExpInfo: [],
     holdActive: new Map(),
+    holdExpActive: new Map(),
     // measure when we execute this code
-    // from this we can measure the input delay -
+    // from this, we can measure the input delay -
     // how long the browser took to hand execution back to JS)
     measureStart: performance.now(),
     rate: rate,
@@ -650,12 +719,18 @@ export function addNewInteraction(interactionId, ufoName, type, startTime, rate,
     addHoldByID(interactionId, [], ufoName, ufoName, true);
   }
   if (type === 'transition') {
+    var _getConfig14;
     getVCObserver().start({
       startTime: startTime
     });
     postInteractionLog.startVCObserver({
       startTime: startTime
     });
+    if ((_getConfig14 = getConfig()) !== null && _getConfig14 !== void 0 && (_getConfig14 = _getConfig14.experimentalInteractionMetrics) !== null && _getConfig14 !== void 0 && _getConfig14.enabled) {
+      experimentalVC.start({
+        startTime: startTime
+      });
+    }
   }
 }
 export function addBrowserMetricEvent(event) {

package/dist/esm/interaction-metrics/post-interaction-log.js

@@ -106,22 +106,32 @@ var PostInteractionLog = /*#__PURE__*/function () {
   }, {
     key: "sendPostInteractionLog",
     value: function sendPostInteractionLog() {
-      var _this$vcObserver2;
+      var _this$vcObserver3, _getConfig2;
       if (!this.hasData() || !this.lastInteractionFinish || !this.sinkHandlerFn) {
+        var _getConfig;
         this.reset();
+        if ((_getConfig = getConfig()) !== null && _getConfig !== void 0 && (_getConfig = _getConfig.experimentalInteractionMetrics) !== null && _getConfig !== void 0 && _getConfig.enabled) {
+          var _this$vcObserver2;
+          (_this$vcObserver2 = this.vcObserver) === null || _this$vcObserver2 === void 0 || _this$vcObserver2.stop();
+        }
         return;
       }
+      var postInteractionFinishVCResult = (_this$vcObserver3 = this.vcObserver) === null || _this$vcObserver3 === void 0 ? void 0 : _this$vcObserver3.getVCResult(_objectSpread({
+        start: this.lastInteractionFinish.start,
+        stop: performance.now(),
+        tti: -1,
+        // no need for TTI value here
+        prefix: 'ufo'
+      }, this.vcObserverSSRConfig));
+      if ((_getConfig2 = getConfig()) !== null && _getConfig2 !== void 0 && (_getConfig2 = _getConfig2.experimentalInteractionMetrics) !== null && _getConfig2 !== void 0 && _getConfig2.enabled) {
+        var _this$vcObserver4;
+        (_this$vcObserver4 = this.vcObserver) === null || _this$vcObserver4 === void 0 || _this$vcObserver4.stop();
+      }
       this.sinkHandlerFn({
         lastInteractionFinish: this.lastInteractionFinish,
         reactProfilerTimings: this.reactProfilerTimings,
         // NOTE: invoking `getVCResult` at latest possible point in time here (not earlier) to get the most accurate result (from performance.now())
-        postInteractionFinishVCResult: (_this$vcObserver2 = this.vcObserver) === null || _this$vcObserver2 === void 0 ? void 0 : _this$vcObserver2.getVCResult(_objectSpread({
-          start: this.lastInteractionFinish.start,
-          stop: performance.now(),
-          tti: -1,
-          // no need for TTI value here
-          prefix: 'ufo'
-        }, this.vcObserverSSRConfig)),
+        postInteractionFinishVCResult: postInteractionFinishVCResult,
         lastInteractionFinishVCResult: this.lastInteractionFinishVCResult
       });
       this.reset();
@@ -135,7 +145,7 @@ var PostInteractionLog = /*#__PURE__*/function () {
   }, {
     key: "onInteractionComplete",
     value: function onInteractionComplete(_ref2) {
-      var _getConfig,
+      var _getConfig3,
         _this = this;
       var ufoName = _ref2.ufoName,
         start = _ref2.start,
@@ -159,7 +169,7 @@ var PostInteractionLog = /*#__PURE__*/function () {
         experimentalTTAI: experimentalTTAI,
         experimentalVC90: experimentalVC90
       };
-      var timeout = ((_getConfig = getConfig()) === null || _getConfig === void 0 ? void 0 : _getConfig.timeWindowForLateMutationsInMilliseconds) || POST_INTERACTION_LOG_SEND_DEFAULT_TIMEOUT;
+      var timeout = ((_getConfig3 = getConfig()) === null || _getConfig3 === void 0 ? void 0 : _getConfig3.timeWindowForLateMutationsInMilliseconds) || POST_INTERACTION_LOG_SEND_DEFAULT_TIMEOUT;
       this.sinkTimeoutId = window.setTimeout(function () {
         _this.sendPostInteractionLog();
       }, timeout);

package/dist/esm/interaction-metrics-init/index.js

@@ -2,6 +2,7 @@ import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import { unstable_IdlePriority as idlePriority, unstable_scheduleCallback as scheduleCallback } from 'scheduler';
 import { startLighthouseObserver } from '../additional-payload';
 import { setUFOConfig } from '../config';
+import { experimentalVC, sinkExperimentalHandler } from '../create-experimental-interaction-metrics-payload';
 import { setupHiddenTimingCapture } from '../hidden-timing';
 import { postInteractionLog, sinkInteractionHandler, sinkPostInteractionLogHandler } from '../interaction-metrics';
 import { getVCObserver } from '../vc';
@@ -16,6 +17,16 @@ function sinkInteraction(instance, payloadPackage) {
     });
   });
 }
+function sinkExperimentalInteractionMetrics(instance, payloadPackage) {
+  sinkExperimentalHandler(function (interactionId, interaction) {
+    scheduleCallback(idlePriority, function () {
+      var payload = payloadPackage.createExperimentalMetricsPayload(interactionId, interaction);
+      if (payload) {
+        instance.sendOperationalEvent(payload);
+      }
+    });
+  });
+}
 function sinkPostInteractionLog(instance, createPostInteractionLogPayload) {
   sinkPostInteractionLogHandler(function (logOutput) {
     scheduleCallback(idlePriority, function () {
@@ -33,6 +44,7 @@ export var init = function init(analyticsWebClientAsync, config) {
   }
   setUFOConfig(config);
   if ((_config$vc = config.vc) !== null && _config$vc !== void 0 && _config$vc.enabled) {
+    var _config$experimentalI;
     var vcOptions = {
       heatmapSize: config.vc.heatmapSize,
       oldDomUpdates: config.vc.oldDomUpdates,
@@ -46,31 +58,38 @@ export var init = function init(analyticsWebClientAsync, config) {
     postInteractionLog.startVCObserver({
       startTime: 0
     });
+    if (config !== null && config !== void 0 && (_config$experimentalI = config.experimentalInteractionMetrics) !== null && _config$experimentalI !== void 0 && _config$experimentalI.enabled) {
+      experimentalVC.initialize(vcOptions).start({
+        startTime: 0
+      });
+    }
   }
   setupHiddenTimingCapture();
   startLighthouseObserver();
   initialized = true;
-  Promise.all([analyticsWebClientAsync,
-  // eslint-disable-next-line import/dynamic-import-chunkname
-  import( /* webpackChunkName: "create-payloads" */'../create-payload'),
-  // eslint-disable-next-line import/dynamic-import-chunkname
-  import( /* webpackChunkName: "create-post-intreaction-log-payload" */'../create-post-interaction-log-payload')]).then(function (_ref) {
+  Promise.all([analyticsWebClientAsync, import( /* webpackChunkName: "create-payloads" */'../create-payload'), import( /* webpackChunkName: "create-post-interaction-log-payload" */'../create-post-interaction-log-payload')]).then(function (_ref) {
     var _ref2 = _slicedToArray(_ref, 3),
       awc = _ref2[0],
       payloadPackage = _ref2[1],
       createPostInteractionLogPayloadPackage = _ref2[2];
     if (awc.getAnalyticsWebClientPromise) {
       awc.getAnalyticsWebClientPromise().then(function (client) {
-        var _config$postInteracti;
+        var _config$experimentalI2, _config$postInteracti;
         var instance = client.getInstance();
         sinkInteraction(instance, payloadPackage);
+        if (config !== null && config !== void 0 && (_config$experimentalI2 = config.experimentalInteractionMetrics) !== null && _config$experimentalI2 !== void 0 && _config$experimentalI2.enabled) {
+          sinkExperimentalInteractionMetrics(instance, payloadPackage);
+        }
         if ((_config$postInteracti = config.postInteractionLog) !== null && _config$postInteracti !== void 0 && _config$postInteracti.enabled) {
           sinkPostInteractionLog(instance, createPostInteractionLogPayloadPackage.default);
         }
       });
     } else if (awc.sendOperationalEvent) {
-      var _config$postInteracti2;
+      var _config$experimentalI3, _config$postInteracti2;
       sinkInteraction(awc, payloadPackage);
+      if (config !== null && config !== void 0 && (_config$experimentalI3 = config.experimentalInteractionMetrics) !== null && _config$experimentalI3 !== void 0 && _config$experimentalI3.enabled) {
+        sinkExperimentalInteractionMetrics(awc, payloadPackage);
+      }
       if ((_config$postInteracti2 = config.postInteractionLog) !== null && _config$postInteracti2 !== void 0 && _config$postInteracti2.enabled) {
         sinkPostInteractionLog(awc, createPostInteractionLogPayloadPackage.default);
       }

package/dist/esm/load-hold/UFOLoadHold.js

@@ -22,8 +22,7 @@ var useLayoutEffectSAFE = typeof window === 'undefined' ? useEffect : useLayoutE
  *   return (
  *     <>
  *       <Skeleton />
- *       <UFOLoadHold name="card">
- *     </UFOLoadHold>
+ *       <UFOLoadHold name="card" />
  *   )
  * }
  * ```
@@ -58,7 +57,10 @@ export default function UFOLoadHold(_ref) {
   // react-18: useId instead
   var context = useContext(UFOInteractionContext);
   useLayoutEffectSAFE(function () {
-    if (hold && !experimental && context != null) {
+    if (hold && context != null) {
+      if (experimental && context.holdExperimental) {
+        return context.holdExperimental(name);
+      }
       return context.hold(name);
     }
   }, [hold, context, name]);

package/dist/esm/segment/segment.js

@@ -79,15 +79,14 @@ export default function UFOSegment(_ref) {
         }
       }
     }
-    function _internalHold(labelStack, name
-    // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
-    ) {
+    function _internalHold(labelStack, name) {
+      var experimental = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
       if (interactionId.current != null) {
         if (parentContext) {
-          return parentContext._internalHold(labelStack, name);
+          return parentContext._internalHold(labelStack, name, experimental);
         } else {
           var capturedInteractionId = interactionId.current;
-          var disposeHold = addHold(interactionId.current, labelStack, name);
+          var disposeHold = addHold(interactionId.current, labelStack, name, experimental);
           return function () {
             if (capturedInteractionId === interactionId.current) {
               disposeHold();
@@ -96,9 +95,7 @@ export default function UFOSegment(_ref) {
         }
       }
     }
-    function _internalHoldByID(labelStack, id, name, remove
-    // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
-    ) {
+    function _internalHoldByID(labelStack, id, name, remove) {
       if (interactionId.current != null) {
         if (parentContext) {
           parentContext._internalHoldByID(labelStack, name, id, remove);
@@ -123,6 +120,10 @@ export default function UFOSegment(_ref) {
         var name = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'unknown';
         return this._internalHold(this.labelStack, name);
       },
+      holdExperimental: function holdExperimental() {
+        var name = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'unknown';
+        return this._internalHold(this.labelStack, name, true);
+      },
       addHoldByID: function addHoldByID(labelStack, id) {
         var name = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 'unknown';
         this._internalHoldByID(labelStack, id, name, false);

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

@@ -204,7 +204,7 @@ export var VCObserver = /*#__PURE__*/function () {
       }
       return _objectSpread(_objectSpread(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty({
         'metrics:vc': VC
-      }, "".concat(fullPrefix, "vc:state"), true), "".concat(fullPrefix, "vc:clean"), !abortReasonInfo), "".concat(fullPrefix, "vc:dom"), VCBox), "".concat(fullPrefix, "vc:updates"), 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({}, "".concat(fullPrefix, "vc:next"), vcNext.VC), "".concat(fullPrefix, "vc:ignored"), _this.getIgnoredElements(componentsLog)));
+      }, "".concat(fullPrefix, "vc:state"), true), "".concat(fullPrefix, "vc:clean"), !abortReasonInfo), "".concat(fullPrefix, "vc:dom"), VCBox), "".concat(fullPrefix, "vc:updates"), 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({}, "".concat(fullPrefix, "vc:next"), vcNext.VC), "".concat(fullPrefix, "vc:next:updates"), vcNext.VCEntries.rel.slice(0, 50)), "".concat(fullPrefix, "vc:ignored"), _this.getIgnoredElements(componentsLog)));
     });
     _defineProperty(this, "handleUpdate", function (rawTime, intersectionRect, targetName, element, type, ignoreReason) {
       _this.measureStart();

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

@@ -63,7 +63,7 @@ export interface SegmentInfo {
     labelStack: LabelStack;
 }
 export interface CustomData {
-    [key: string]: null | undefined | string | number | boolean | undefined | CustomData | Record<string, CustomData>;
+    [key: string]: null | string | number | boolean | undefined | CustomData | Record<string, CustomData>;
 }
 export type CustomTiming = Record<string, {
     startTime: number;
@@ -104,7 +104,9 @@ export interface InteractionMetrics {
         labelStack: LabelStack;
     })[];
     holdInfo: HoldInfo[];
+    holdExpInfo: HoldInfo[];
     holdActive: Map<string, HoldActive>;
+    holdExpActive: Map<string, HoldActive>;
     reactProfilerTimings: ReactProfilerTiming[];
     measureStart: number;
     rate: number;
@@ -115,11 +117,11 @@ export interface InteractionMetrics {
     abortReason?: AbortReasonType;
     abortedByInteractionName?: string;
     /**
-     * Apdex is legacy performance measurement where it is
+     * Apdex is a legacy performance measurement where it is
      * capturing TTI at arbitrary point in the code (bm3/UFOv1)
      *
      * We are intercepting its values now just so we can use it for
-     * topline metric, but should encourage teams adopt TTAI
+     * topline metric, but should encourage teams to adopt TTAI
      *
      * This field might be ignored/dropped in the future.
      */
@@ -164,7 +166,7 @@ export interface LazyLoadProfilerContext {
     addLoad(identifier: string, start: number, end: number): void;
 }
 export interface EnhancedUFOInteractionContextType extends UFOInteractionContextType, RelayMetricsRecorder, LazyLoadProfilerContext {
-    _internalHold(labelStack: LabelStack, name: string): void | (() => void);
+    _internalHold(labelStack: LabelStack, name: string, experimental?: boolean): void | (() => void);
     _internalHoldByID(labelStack: LabelStack, id: string, name: string, remove: boolean): void | (() => void);
     addHoldByID(labelStack: LabelStack, id: string, name?: string): void;
     removeHoldByID(labelStack: LabelStack, id: string, name?: string): void;

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

@@ -73,6 +73,11 @@ export type Config = {
         readonly rates?: Rates;
         readonly kind?: Record<InteractionType, number>;
     };
+    readonly experimentalInteractionMetrics?: {
+        readonly enabled?: boolean;
+        readonly rates?: Rates;
+        readonly kind?: Record<InteractionType, number>;
+    };
     readonly enableSegmentHighlighting?: boolean;
     readonly enableAdditionalPerformanceMarks?: boolean;
     readonly shouldCalculateLighthouseMetricsFromTTAI?: boolean;
@@ -87,6 +92,7 @@ export type Config = {
 export declare function setUFOConfig(newConfig: Config): void;
 export declare function getConfig(): Config | undefined;
 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;
 export declare function getCapabilityRate(capability: Capability): number;
 declare const validTypingMethods: readonly ["timeout", "timeoutNoAlloc", "mutationObserver"];

package/dist/types/create-experimental-interaction-metrics-payload/index.d.ts

@@ -0,0 +1,16 @@
+import type { InteractionMetrics } from '../common';
+import { VCObserver, type VCObserverOptions } from '../vc/vc-observer';
+type InteractionMetricsHandler = (interactionId: string, interaction: InteractionMetrics) => void | Promise<void>;
+export declare function installInteractionSink(handler: InteractionMetricsHandler): void;
+export declare function sinkExperimentalHandler(sinkFn: (interactionId: string, interaction: InteractionMetrics) => void | Promise<void>): void;
+export declare function onExperimentalInteractionComplete(interactionId: string, data: InteractionMetrics, endTime?: number): void;
+export declare class ExperimentalVCMetrics {
+    vcObserver: VCObserver | null;
+    initialize(options: VCObserverOptions): this;
+    start({ startTime }: {
+        startTime: number;
+    }): void;
+}
+export declare const experimentalVC: ExperimentalVCMetrics;
+export declare const getExperimentalVCMetrics: (interaction: InteractionMetrics) => import("../common/vc/types").VCResult | null;
+export {};