@atlaskit/react-ufo 3.2.0 → 3.3.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/ufo-interaction-ignore
 
+## 3.3.0
+
+### Minor Changes
+
+- [#120083](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/120083)
+  [`25a022df71ba2`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/25a022df71ba2) -
+  add UFO devtools chrome extension api for more events
+
 ## 3.2.0
 
 ### Minor Changes

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

@@ -8,6 +8,7 @@ exports.init = void 0;
 var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _scheduler = require("scheduler");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _additionalPayload = require("../additional-payload");
 var _config = require("../config");
 var _createExperimentalInteractionMetricsPayload = require("../create-experimental-interaction-metrics-payload");
@@ -21,6 +22,7 @@ function sinkInteraction(instance, payloadPackage) {
   (0, _interactionMetrics.sinkInteractionHandler)(function (interactionId, interaction) {
     (0, _scheduler.unstable_scheduleCallback)(_scheduler.unstable_IdlePriority, function () {
       payloadPackage.createPayloads(interactionId, interaction).then(function (payloads) {
+        // NOTE: This API is used by the UFO DevTool Chrome Extension and Criterion
         var devToolObserver = globalThis.__ufo_devtool_onUfoPayload;
         payloads === null || payloads === void 0 || payloads.forEach(function (payload) {
           if (typeof devToolObserver === 'function') {
@@ -39,6 +41,13 @@ function sinkExperimentalInteractionMetrics(instance, payloadPackage) {
     (0, _scheduler.unstable_scheduleCallback)(_scheduler.unstable_IdlePriority, function () {
       var payload = payloadPackage.createExperimentalMetricsPayload(interactionId, interaction);
       if (payload) {
+        if ((0, _platformFeatureFlags.fg)('enable_ufo_devtools_api_for_extra_events')) {
+          // NOTE: This API is used by the UFO DevTool Chrome Extension and Criterion
+          var devToolObserver = globalThis.__ufo_devtool_onUfoPayload;
+          if (typeof devToolObserver === 'function') {
+            devToolObserver === null || devToolObserver === void 0 || devToolObserver(payload);
+          }
+        }
         instance.sendOperationalEvent(payload);
       }
     });
@@ -49,6 +58,13 @@ function sinkPostInteractionLog(instance, createPostInteractionLogPayload) {
     (0, _scheduler.unstable_scheduleCallback)(_scheduler.unstable_IdlePriority, function () {
       var payload = createPostInteractionLogPayload(logOutput);
       if (payload) {
+        // NOTE: This API is used by the UFO DevTool Chrome Extension and also by Criterion
+        if ((0, _platformFeatureFlags.fg)('enable_ufo_devtools_api_for_extra_events')) {
+          var devToolObserver = globalThis.__ufo_devtool_onUfoPayload;
+          if (typeof devToolObserver === 'function') {
+            devToolObserver === null || devToolObserver === void 0 || devToolObserver(payload);
+          }
+        }
         instance.sendOperationalEvent(payload);
       }
     });

package/dist/cjs/vc/vc-observer-new/metric-calculator/percentile-calc/canvas-heatmap/canvas-pixel.js

@@ -63,7 +63,7 @@ var ViewportCanvas = exports.ViewportCanvas = /*#__PURE__*/function () {
       throw new Error('Could not get canvas context');
     }
     this.ctx = ctx;
-    this.ctx.globalCompositeOperation = "source-over";
+    this.ctx.globalCompositeOperation = 'source-over';
     this.clear();
   }
   return (0, _createClass2.default)(ViewportCanvas, [{

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

@@ -1,4 +1,5 @@
 import { unstable_IdlePriority as idlePriority, unstable_scheduleCallback as scheduleCallback } from 'scheduler';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { startLighthouseObserver } from '../additional-payload';
 import { setUFOConfig } from '../config';
 import { experimentalVC, sinkExperimentalHandler } from '../create-experimental-interaction-metrics-payload';
@@ -10,6 +11,7 @@ function sinkInteraction(instance, payloadPackage) {
   sinkInteractionHandler((interactionId, interaction) => {
     scheduleCallback(idlePriority, () => {
       payloadPackage.createPayloads(interactionId, interaction).then(payloads => {
+        // NOTE: This API is used by the UFO DevTool Chrome Extension and Criterion
         const devToolObserver = globalThis.__ufo_devtool_onUfoPayload;
         payloads === null || payloads === void 0 ? void 0 : payloads.forEach(payload => {
           if (typeof devToolObserver === 'function') {
@@ -28,6 +30,13 @@ function sinkExperimentalInteractionMetrics(instance, payloadPackage) {
     scheduleCallback(idlePriority, () => {
       const payload = payloadPackage.createExperimentalMetricsPayload(interactionId, interaction);
       if (payload) {
+        if (fg('enable_ufo_devtools_api_for_extra_events')) {
+          // NOTE: This API is used by the UFO DevTool Chrome Extension and Criterion
+          const devToolObserver = globalThis.__ufo_devtool_onUfoPayload;
+          if (typeof devToolObserver === 'function') {
+            devToolObserver === null || devToolObserver === void 0 ? void 0 : devToolObserver(payload);
+          }
+        }
         instance.sendOperationalEvent(payload);
       }
     });
@@ -38,6 +47,13 @@ function sinkPostInteractionLog(instance, createPostInteractionLogPayload) {
     scheduleCallback(idlePriority, () => {
       const payload = createPostInteractionLogPayload(logOutput);
       if (payload) {
+        // NOTE: This API is used by the UFO DevTool Chrome Extension and also by Criterion
+        if (fg('enable_ufo_devtools_api_for_extra_events')) {
+          const devToolObserver = globalThis.__ufo_devtool_onUfoPayload;
+          if (typeof devToolObserver === 'function') {
+            devToolObserver === null || devToolObserver === void 0 ? void 0 : devToolObserver(payload);
+          }
+        }
         instance.sendOperationalEvent(payload);
       }
     });

package/dist/es2019/vc/vc-observer-new/metric-calculator/percentile-calc/canvas-heatmap/canvas-pixel.js

@@ -50,7 +50,7 @@ export class ViewportCanvas {
       throw new Error('Could not get canvas context');
     }
     this.ctx = ctx;
-    this.ctx.globalCompositeOperation = "source-over";
+    this.ctx.globalCompositeOperation = 'source-over';
     this.clear();
   }
   getScaledDimensions() {

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

@@ -1,5 +1,6 @@
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import { unstable_IdlePriority as idlePriority, unstable_scheduleCallback as scheduleCallback } from 'scheduler';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { startLighthouseObserver } from '../additional-payload';
 import { setUFOConfig } from '../config';
 import { experimentalVC, sinkExperimentalHandler } from '../create-experimental-interaction-metrics-payload';
@@ -11,6 +12,7 @@ function sinkInteraction(instance, payloadPackage) {
   sinkInteractionHandler(function (interactionId, interaction) {
     scheduleCallback(idlePriority, function () {
       payloadPackage.createPayloads(interactionId, interaction).then(function (payloads) {
+        // NOTE: This API is used by the UFO DevTool Chrome Extension and Criterion
         var devToolObserver = globalThis.__ufo_devtool_onUfoPayload;
         payloads === null || payloads === void 0 || payloads.forEach(function (payload) {
           if (typeof devToolObserver === 'function') {
@@ -29,6 +31,13 @@ function sinkExperimentalInteractionMetrics(instance, payloadPackage) {
     scheduleCallback(idlePriority, function () {
       var payload = payloadPackage.createExperimentalMetricsPayload(interactionId, interaction);
       if (payload) {
+        if (fg('enable_ufo_devtools_api_for_extra_events')) {
+          // NOTE: This API is used by the UFO DevTool Chrome Extension and Criterion
+          var devToolObserver = globalThis.__ufo_devtool_onUfoPayload;
+          if (typeof devToolObserver === 'function') {
+            devToolObserver === null || devToolObserver === void 0 || devToolObserver(payload);
+          }
+        }
         instance.sendOperationalEvent(payload);
       }
     });
@@ -39,6 +48,13 @@ function sinkPostInteractionLog(instance, createPostInteractionLogPayload) {
     scheduleCallback(idlePriority, function () {
       var payload = createPostInteractionLogPayload(logOutput);
       if (payload) {
+        // NOTE: This API is used by the UFO DevTool Chrome Extension and also by Criterion
+        if (fg('enable_ufo_devtools_api_for_extra_events')) {
+          var devToolObserver = globalThis.__ufo_devtool_onUfoPayload;
+          if (typeof devToolObserver === 'function') {
+            devToolObserver === null || devToolObserver === void 0 || devToolObserver(payload);
+          }
+        }
         instance.sendOperationalEvent(payload);
       }
     });

package/dist/esm/vc/vc-observer-new/metric-calculator/percentile-calc/canvas-heatmap/canvas-pixel.js

@@ -56,7 +56,7 @@ export var ViewportCanvas = /*#__PURE__*/function () {
       throw new Error('Could not get canvas context');
     }
     this.ctx = ctx;
-    this.ctx.globalCompositeOperation = "source-over";
+    this.ctx.globalCompositeOperation = 'source-over';
     this.clear();
   }
   return _createClass(ViewportCanvas, [{

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

@@ -1,6 +1,6 @@
 export type { AssetResourceEntry, AssetsClassification, AssetsData, AssetsReporter, } from './assets/types';
 export type { LifecycleMarkType, MarkType, SpanType, InteractionType, AbortReasonType, CustomTiming, HoldInfo, LoadProfilerEventInfo, ReactProfilerTiming, Span, Mark, InteractionError, RequestInfo, ApdexType, SegmentInfo, CustomData, HoldActive, Redirect, InteractionMetrics, EnhancedUFOInteractionContextType, BM3Event, PostInteractionLogOutput, LastInteractionFinishInfo, } from './common/types';
-export type { MultiHeatmapPayload, } from './vc/types';
+export type { MultiHeatmapPayload } from './vc/types';
 /**
  * @deprecated Prefer import from @atlaskit/react-ufo/interaction-context
  */

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

@@ -1,6 +1,6 @@
 export type { AssetResourceEntry, AssetsClassification, AssetsData, AssetsReporter, } from './assets/types';
 export type { LifecycleMarkType, MarkType, SpanType, InteractionType, AbortReasonType, CustomTiming, HoldInfo, LoadProfilerEventInfo, ReactProfilerTiming, Span, Mark, InteractionError, RequestInfo, ApdexType, SegmentInfo, CustomData, HoldActive, Redirect, InteractionMetrics, EnhancedUFOInteractionContextType, BM3Event, PostInteractionLogOutput, LastInteractionFinishInfo, } from './common/types';
-export type { MultiHeatmapPayload, } from './vc/types';
+export type { MultiHeatmapPayload } from './vc/types';
 /**
  * @deprecated Prefer import from @atlaskit/react-ufo/interaction-context
  */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/react-ufo",
-	"version": "3.2.0",
+	"version": "3.3.0",
 	"description": "Parts of React UFO that are publicly available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -171,6 +171,9 @@
 		},
 		"platform_ufo_vc_ttai_on_paint": {
 			"type": "boolean"
+		},
+		"enable_ufo_devtools_api_for_extra_events": {
+			"type": "boolean"
 		}
 	}
 }