@atlaskit/react-ufo 2.4.5 → 2.4.7

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);
@@ -121,7 +118,8 @@ export default function UFOSegment(_ref) {
       labelStack: labelStack,
       hold: function hold() {
         var name = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'unknown';
-        return this._internalHold(this.labelStack, name);
+        var experimental = arguments.length > 1 ? arguments[1] : undefined;
+        return this._internalHold(this.labelStack, name, experimental);
       },
       addHoldByID: function addHoldByID(labelStack, id) {
         var name = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 'unknown';

package/dist/esm/trace-pageload/index.js

@@ -5,7 +5,7 @@ import { getActiveTrace } from '../experience-trace-id-context';
 import { DefaultInteractionID } from '../interaction-id-context';
 import { abort, addHoldByID, addNewInteraction, getActiveInteraction, removeHoldByID, updatePageLoadInteractionName } from '../interaction-metrics';
 import UFORouteName from '../route-name-context';
-var AWAITING_PAGELOAD_NAME = 'awaiting_pageload_name';
+export var AWAITING_PAGELOAD_NAME = 'awaiting_pageload_name';
 export default function traceUFOPageLoad(ufoName) {
   var routeName = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : ufoName;
   var activeInteraction = getActiveInteraction();

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

@@ -1,10 +1,6 @@
-import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
-function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
-function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
-function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 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';
@@ -195,8 +191,7 @@ export var Observers = /*#__PURE__*/function () {
             });
           } else if (mutation.type === 'attributes') {
             if (mutation.target instanceof HTMLElement) {
-              var isDisplayStyleAttributeMutation = mutation.attributeName === 'style' && _this2.getStyleDisplay(mutation.target.getAttribute('style')) !== _this2.getStyleDisplay(mutation.oldValue);
-              if (fg('platform-ufo-vc-observe-attributes') || isDisplayStyleAttributeMutation) {
+              if (fg('platform-ufo-vc-observe-attributes')) {
                 _this2.observeElement(mutation.target, mutation, 'attr', ignoreReason);
               }
             }
@@ -205,40 +200,6 @@ export var Observers = /*#__PURE__*/function () {
         _this2.measureStop();
       }) : null;
     }
-  }, {
-    key: "getStyleDisplay",
-    value: function getStyleDisplay(styleAttributeValue) {
-      if (!styleAttributeValue) {
-        return undefined;
-      }
-
-      // Split the style string into individual declarations
-      var declarations = styleAttributeValue.split(';');
-      // Iterate over each declaration
-      var _iterator = _createForOfIteratorHelper(declarations),
-        _step;
-      try {
-        for (_iterator.s(); !(_step = _iterator.n()).done;) {
-          var declaration = _step.value;
-          // Trim whitespace and split into property and value
-          var _declaration$split$ma = declaration.split(':').map(function (part) {
-              return part.trim();
-            }),
-            _declaration$split$ma2 = _slicedToArray(_declaration$split$ma, 2),
-            property = _declaration$split$ma2[0],
-            value = _declaration$split$ma2[1];
-          // Check if the property is 'display'
-          if (property && property.toLowerCase() === 'display') {
-            return value;
-          }
-        }
-      } catch (err) {
-        _iterator.e(err);
-      } finally {
-        _iterator.f();
-      }
-      return undefined;
-    }
   }, {
     key: "getElementName",
     value: function getElementName(element) {

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.
      */
@@ -150,6 +152,8 @@ export interface InteractionMetrics {
     trace: TraceIdContext | null;
     legacyMetrics?: BM3Event[];
     vc?: VCRawDataType | null;
+    experimentalTTAI?: number;
+    experimentalVC90?: number;
 }
 export type LoadProfilerEventInfo = {
     identifier: string;
@@ -162,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;
@@ -191,7 +195,7 @@ export type BM3Event = {
     pageVisibleState?: string;
     type: string;
 };
-export type LastInteractionFinishInfo = Pick<InteractionMetrics, 'ufoName' | 'start' | 'end' | 'id' | 'abortReason' | 'abortedByInteractionName' | 'routeName' | 'type'>;
+export type LastInteractionFinishInfo = Pick<InteractionMetrics, 'ufoName' | 'start' | 'end' | 'id' | 'abortReason' | 'abortedByInteractionName' | 'routeName' | 'type' | 'experimentalVC90' | 'experimentalTTAI'>;
 export type PostInteractionLogOutput = {
     lastInteractionFinish: LastInteractionFinishInfo;
     reactProfilerTimings?: ReactProfilerTiming[];

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

@@ -72,6 +72,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;
@@ -85,6 +90,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,31 @@
+import type { InteractionMetrics } from '../common';
+import { VCObserver, type VCObserverOptions } from '../vc/vc-observer';
+export declare class ExperimentalInteractionMetrics {
+    /**
+     * Handler function to process / send the observation data
+     */
+    sinkHandlerFn: (interactionId: string, interactionMetrics: InteractionMetrics) => void | Promise<void>;
+    /**
+     * Set the fn that would be invoked to process / send the observation data
+     */
+    sinkHandler(sinkHandlerFn: (interactionId: string, interaction: InteractionMetrics) => void | Promise<void>): void;
+    onInteractionComplete(interactionId: string, data: InteractionMetrics, endTime?: number): void;
+    /**
+     * independent VC observer that observes until `custom.post-interaction-logs` event is sent
+     */
+    vcObserver: VCObserver | null;
+    initializeVCObserver(options: VCObserverOptions): this;
+    startVCObserver({ startTime }: {
+        startTime: number;
+    }): void;
+}
+export declare function createExperimentalInteractionMetricsPayload(interactionId: string, interaction: InteractionMetrics): {
+    actionSubject: string;
+    action: string;
+    eventType: string;
+    source: string;
+    tags: string[];
+    attributes: {
+        properties: any;
+    };
+} | null;

package/dist/types/create-payload/common/utils/index.d.ts

@@ -1,3 +1,5 @@
+import type { InteractionMetrics } from '../../../common';
+import { type Config } from '../../../config';
 import type { LabelStack, SegmentLabel } from '../../../interaction-context';
 export type SegmentItem = {
     n: string;
@@ -15,3 +17,13 @@ export declare function optimizeLabelStack(labelStack: LabelStack): string | {
     s?: string | undefined;
     n: string;
 }[];
+export declare const getInteractionStatus: (interaction: InteractionMetrics) => {
+    readonly originalInteractionStatus: "ABORTED" | "SUCCEEDED";
+    readonly overrideStatus: "ABORTED" | "SUCCEEDED";
+};
+export declare const getPageVisibilityUpToTTAI: (interaction: InteractionMetrics) => import("../../../hidden-timing").PageVisibility;
+export declare const calculateVCMetrics: (interaction: InteractionMetrics, prefix: string, getVCResultFn: (props: any) => any) => any;
+export declare function getSSRDoneTimeValue(config: Config | undefined): number | undefined;
+export declare const getVCMetrics: (interaction: InteractionMetrics) => any;
+export declare const getExperimentalVCMetrics: (interaction: InteractionMetrics) => any;
+export declare const getTTAI: (interaction: InteractionMetrics) => number | undefined;