@atlaskit/react-ufo 2.3.1 → 2.3.3

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/ufo-interaction-ignore
 
+## 2.3.3
+
+### Patch Changes
+
+- [#169231](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/169231)
+  [`bf7c1455e4d57`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/bf7c1455e4d57) -
+  allow for custom VC abort reasons
+
+## 2.3.2
+
+### Patch Changes
+
+- [#167556](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/167556)
+  [`63da6ebbd7549`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/63da6ebbd7549) -
+  add try catch to sessionStorage access within ufo init script
+
 ## 2.3.1
 
 ### Patch Changes

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

@@ -41,8 +41,12 @@ var init = exports.init = function init(analyticsWebClientAsync, config) {
   if (initialized) {
     return;
   }
-  if (window !== undefined) {
-    window.__REACT_UFO_ENABLE_PERF_TRACING = Boolean(sessionStorage.getItem('additionalPerfMarks') === 'true');
+  try {
+    if (window !== undefined) {
+      window.__REACT_UFO_ENABLE_PERF_TRACING = Boolean(sessionStorage.getItem('additionalPerfMarks') === 'true');
+    }
+  } catch (err) {
+    /* do nothing */
   }
   (0, _config.setUFOConfig)(config);
   if ((_config$vc = config.vc) !== null && _config$vc !== void 0 && _config$vc.enabled) {

package/dist/cjs/vc/index.js

@@ -5,11 +5,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.getVCObserver = void 0;
 var _vcObserver = require("./vc-observer");
-var instance = null;
 var getVCObserver = exports.getVCObserver = function getVCObserver() {
   var opts = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  if (instance === null) {
-    instance = new _vcObserver.VCObserver(opts);
+  if (!globalThis.__vcObserver) {
+    globalThis.__vcObserver = new _vcObserver.VCObserver(opts);
   }
-  return instance;
+  return globalThis.__vcObserver;
 };

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

@@ -364,6 +364,12 @@ var VCObserver = exports.VCObserver = /*#__PURE__*/function () {
       var stopTime = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : performance.now();
       this.observers.setReactRootRenderStop(stopTime);
     }
+  }, {
+    key: "abortObservation",
+    value: function abortObservation() {
+      var abortReason = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'custom';
+      this.setAbortReason(abortReason, performance.now());
+    }
   }, {
     key: "setAbortReason",
     value: function setAbortReason(abort, timestamp) {

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

@@ -30,8 +30,12 @@ export const init = (analyticsWebClientAsync, config) => {
   if (initialized) {
     return;
   }
-  if (window !== undefined) {
-    window.__REACT_UFO_ENABLE_PERF_TRACING = Boolean(sessionStorage.getItem('additionalPerfMarks') === 'true');
+  try {
+    if (window !== undefined) {
+      window.__REACT_UFO_ENABLE_PERF_TRACING = Boolean(sessionStorage.getItem('additionalPerfMarks') === 'true');
+    }
+  } catch (err) {
+    /* do nothing */
   }
   setUFOConfig(config);
   if ((_config$vc = config.vc) !== null && _config$vc !== void 0 && _config$vc.enabled) {

package/dist/es2019/vc/index.js

@@ -1,8 +1,7 @@
 import { VCObserver } from './vc-observer';
-let instance = null;
 export const getVCObserver = (opts = {}) => {
-  if (instance === null) {
-    instance = new VCObserver(opts);
+  if (!globalThis.__vcObserver) {
+    globalThis.__vcObserver = new VCObserver(opts);
   }
-  return instance;
+  return globalThis.__vcObserver;
 };

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

@@ -441,6 +441,9 @@ export class VCObserver {
   setReactRootRenderStop(stopTime = performance.now()) {
     this.observers.setReactRootRenderStop(stopTime);
   }
+  abortObservation(abortReason = 'custom') {
+    this.setAbortReason(abortReason, performance.now());
+  }
   setAbortReason(abort, timestamp, info = '') {
     if (this.abortReason.reason === null || this.abortReason.blocking === false) {
       this.abortReason.reason = abort;

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

@@ -31,8 +31,12 @@ export var init = function init(analyticsWebClientAsync, config) {
   if (initialized) {
     return;
   }
-  if (window !== undefined) {
-    window.__REACT_UFO_ENABLE_PERF_TRACING = Boolean(sessionStorage.getItem('additionalPerfMarks') === 'true');
+  try {
+    if (window !== undefined) {
+      window.__REACT_UFO_ENABLE_PERF_TRACING = Boolean(sessionStorage.getItem('additionalPerfMarks') === 'true');
+    }
+  } catch (err) {
+    /* do nothing */
   }
   setUFOConfig(config);
   if ((_config$vc = config.vc) !== null && _config$vc !== void 0 && _config$vc.enabled) {

package/dist/esm/vc/index.js

@@ -1,9 +1,8 @@
 import { VCObserver } from './vc-observer';
-var instance = null;
 export var getVCObserver = function getVCObserver() {
   var opts = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  if (instance === null) {
-    instance = new VCObserver(opts);
+  if (!globalThis.__vcObserver) {
+    globalThis.__vcObserver = new VCObserver(opts);
   }
-  return instance;
+  return globalThis.__vcObserver;
 };

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

@@ -357,6 +357,12 @@ export var VCObserver = /*#__PURE__*/function () {
       var stopTime = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : performance.now();
       this.observers.setReactRootRenderStop(stopTime);
     }
+  }, {
+    key: "abortObservation",
+    value: function abortObservation() {
+      var abortReason = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'custom';
+      this.setAbortReason(abortReason, performance.now());
+    }
   }, {
     key: "setAbortReason",
     value: function setAbortReason(abort, timestamp) {

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

@@ -4,7 +4,7 @@ export declare const AbortEvent: {
     readonly keydown: "keydown";
     readonly resize: "resize";
 };
-export type VCAbortReason = 'scroll' | 'keypress' | 'resize' | 'error' | 'not-supported';
+export type VCAbortReason = 'custom' | 'scroll' | 'keypress' | 'resize' | 'error' | 'not-supported';
 export type VCAbortReasonType = {
     reason: null | VCAbortReason;
     info: string;

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

@@ -1,2 +1,5 @@
 import { VCObserver, type VCObserverOptions } from './vc-observer';
+declare global {
+    var __vcObserver: VCObserver;
+}
 export declare const getVCObserver: (opts?: VCObserverOptions) => VCObserver;

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

@@ -1,5 +1,5 @@
 import { type UnbindFn } from 'bind-event-listener';
-import type { ComponentsLogType, VCAbortReasonType, VCEntryType, VCIgnoreReason, VCRatioType, VCRawDataType, VCResult } from '../../common/vc/types';
+import type { ComponentsLogType, VCAbortReason, VCAbortReasonType, VCEntryType, VCIgnoreReason, VCRatioType, VCRawDataType, VCResult } from '../../common/vc/types';
 import { Observers, type SelectorConfig } from './observers';
 type GetVCResultType = {
     start: number;
@@ -79,6 +79,7 @@ export declare class VCObserver {
     setReactRootRenderStart(startTime?: number): void;
     setReactRootRenderStop(stopTime?: number): void;
     private handleUpdate;
+    abortObservation(abortReason?: VCAbortReason): void;
     private setAbortReason;
     private resetState;
     private getCleanHeatmap;

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

@@ -4,7 +4,7 @@ export declare const AbortEvent: {
     readonly keydown: "keydown";
     readonly resize: "resize";
 };
-export type VCAbortReason = 'scroll' | 'keypress' | 'resize' | 'error' | 'not-supported';
+export type VCAbortReason = 'custom' | 'scroll' | 'keypress' | 'resize' | 'error' | 'not-supported';
 export type VCAbortReasonType = {
     reason: null | VCAbortReason;
     info: string;

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

@@ -1,2 +1,5 @@
 import { VCObserver, type VCObserverOptions } from './vc-observer';
+declare global {
+    var __vcObserver: VCObserver;
+}
 export declare const getVCObserver: (opts?: VCObserverOptions) => VCObserver;

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

@@ -1,5 +1,5 @@
 import { type UnbindFn } from 'bind-event-listener';
-import type { ComponentsLogType, VCAbortReasonType, VCEntryType, VCIgnoreReason, VCRatioType, VCRawDataType, VCResult } from '../../common/vc/types';
+import type { ComponentsLogType, VCAbortReason, VCAbortReasonType, VCEntryType, VCIgnoreReason, VCRatioType, VCRawDataType, VCResult } from '../../common/vc/types';
 import { Observers, type SelectorConfig } from './observers';
 type GetVCResultType = {
     start: number;
@@ -79,6 +79,7 @@ export declare class VCObserver {
     setReactRootRenderStart(startTime?: number): void;
     setReactRootRenderStop(stopTime?: number): void;
     private handleUpdate;
+    abortObservation(abortReason?: VCAbortReason): void;
     private setAbortReason;
     private resetState;
     private getCleanHeatmap;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/react-ufo",
-	"version": "2.3.1",
+	"version": "2.3.3",
 	"description": "Parts of React UFO that are publicly available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",