@atlaskit/react-ufo 2.0.5 → 2.0.7

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/ufo-interaction-ignore
 
+## 2.0.7
+
+### Patch Changes
+
+- [#155785](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/155785)
+  [`0c6d7f8285d34`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/0c6d7f8285d34) -
+  moved atlaskit ufo-interaction-ignore to atlaskit/react-ufo
+
+## 2.0.6
+
+### Patch Changes
+
+- [#157418](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/157418)
+  [`e6939ccf435a3`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/e6939ccf435a3) -
+  Add payload size as part of UFO payload
+
 ## 2.0.5
 
 ### Patch Changes

package/dist/cjs/create-payload/index.js

@@ -632,6 +632,9 @@ function getSSRDoneTimeValue(config) {
   var _config$ssr, _config$ssr2;
   return config !== null && config !== void 0 && (_config$ssr = config.ssr) !== null && _config$ssr !== void 0 && _config$ssr.getSSRDoneTime ? config === null || config === void 0 || (_config$ssr2 = config.ssr) === null || _config$ssr2 === void 0 ? void 0 : _config$ssr2.getSSRDoneTime() : ssr.getSSRDoneTime();
 }
+function getPayloadSize(payload) {
+  return Math.round(new TextEncoder().encode(JSON.stringify(payload)).length / 1024);
+}
 function createInteractionMetricsPayload(interaction, interactionId) {
   var _window$location, _config$additionalPay;
   var interactionPayloadStart = performance.now();
@@ -716,7 +719,7 @@ function createInteractionMetricsPayload(interaction, interactionId) {
     };
   };
   var newUFOName = (0, _utils.sanitizeUfoName)(ufoName);
-  return {
+  var payload = {
     actionSubject: 'experience',
     action: 'measured',
     eventType: 'operational',
@@ -728,6 +731,7 @@ function createInteractionMetricsPayload(interaction, interactionId) {
         'event:hostname': ((_window$location = window.location) === null || _window$location === void 0 ? void 0 : _window$location.hostname) || 'unknown',
         'event:product': config.product,
         'event:schema': '1.0.0',
+        'event:sizeInKb': 0,
         'event:source': {
           name: 'react-ufo/web',
           version: _constants.REACT_UFO_VERSION,
@@ -773,6 +777,8 @@ function createInteractionMetricsPayload(interaction, interactionId) {
       })
     }
   };
+  payload.attributes.properties['event:sizeInKb'] = getPayloadSize(payload.attributes.properties);
+  return payload;
 }
 function createPayloads(interactionId, interaction) {
   var ufoNameOverride = getUfoNameOverride(interaction);

package/dist/cjs/interaction-ignore/index.js

@@ -0,0 +1,13 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "default", {
+  enumerable: true,
+  get: function get() {
+    return _ufoInteractionIgnore.default;
+  }
+});
+var _ufoInteractionIgnore = _interopRequireDefault(require("./ufo-interaction-ignore"));

package/dist/cjs/interaction-ignore/ufo-interaction-ignore.js

@@ -0,0 +1,60 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = UFOInteractionIgnore;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _react = _interopRequireWildcard(require("react"));
+var _interactionContext = _interopRequireDefault(require("@atlaskit/interaction-context"));
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), 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) { (0, _defineProperty2.default)(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; }
+/**
+ * Prevent a subtree from holding up an interaction
+ * Use this when you have a component which loads in late, but
+ * isn't considered to be a breach of SLO
+ *
+ * ```js
+ * <App>
+ *   <Main />
+ *   <Sidebar>
+ *     <UFOInteractionIgnore>
+ *       <InsightsButton />
+ *     </UFOInteractionIgnore>
+ *   </Sidebar>
+ * </App>
+ * ```
+ *
+ * Has an `ignore` prop, to allow you to use it conditionally
+ */
+function UFOInteractionIgnore(_ref) {
+  var children = _ref.children,
+    _ref$ignore = _ref.ignore,
+    ignore = _ref$ignore === void 0 ? true : _ref$ignore;
+  var parentContext = (0, _react.useContext)(_interactionContext.default);
+  var ignoredInteractionContext = (0, _react.useMemo)(function () {
+    if (!parentContext) {
+      return null;
+    }
+    return _objectSpread(_objectSpread({}, parentContext), {}, {
+      hold: function hold() {
+        if (!ignore) {
+          return parentContext.hold.apply(parentContext, arguments);
+        }
+      }
+    });
+  }, [parentContext, ignore]);
+
+  // react-18: Use children directly
+  var kids = children != null ? children : null;
+  if (!ignoredInteractionContext) {
+    return /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, kids);
+  }
+  return /*#__PURE__*/_react.default.createElement(_interactionContext.default.Provider, {
+    value: ignoredInteractionContext
+  }, kids);
+}

package/dist/es2019/create-payload/index.js

@@ -623,6 +623,9 @@ function getSSRDoneTimeValue(config) {
   var _config$ssr, _config$ssr2;
   return config !== null && config !== void 0 && (_config$ssr = config.ssr) !== null && _config$ssr !== void 0 && _config$ssr.getSSRDoneTime ? config === null || config === void 0 ? void 0 : (_config$ssr2 = config.ssr) === null || _config$ssr2 === void 0 ? void 0 : _config$ssr2.getSSRDoneTime() : ssr.getSSRDoneTime();
 }
+function getPayloadSize(payload) {
+  return Math.round(new TextEncoder().encode(JSON.stringify(payload)).length / 1024);
+}
 function createInteractionMetricsPayload(interaction, interactionId) {
   var _window$location, _config$additionalPay;
   const interactionPayloadStart = performance.now();
@@ -710,7 +713,7 @@ function createInteractionMetricsPayload(interaction, interactionId) {
     };
   };
   const newUFOName = sanitizeUfoName(ufoName);
-  return {
+  const payload = {
     actionSubject: 'experience',
     action: 'measured',
     eventType: 'operational',
@@ -722,6 +725,7 @@ function createInteractionMetricsPayload(interaction, interactionId) {
         'event:hostname': ((_window$location = window.location) === null || _window$location === void 0 ? void 0 : _window$location.hostname) || 'unknown',
         'event:product': config.product,
         'event:schema': '1.0.0',
+        'event:sizeInKb': 0,
         'event:source': {
           name: 'react-ufo/web',
           version: REACT_UFO_VERSION,
@@ -780,6 +784,8 @@ function createInteractionMetricsPayload(interaction, interactionId) {
       }
     }
   };
+  payload.attributes.properties['event:sizeInKb'] = getPayloadSize(payload.attributes.properties);
+  return payload;
 }
 export function createPayloads(interactionId, interaction) {
   const ufoNameOverride = getUfoNameOverride(interaction);

package/dist/es2019/interaction-ignore/index.js

@@ -0,0 +1 @@
+export { default } from './ufo-interaction-ignore';

package/dist/es2019/interaction-ignore/ufo-interaction-ignore.js

@@ -0,0 +1,49 @@
+import React, { useContext, useMemo } from 'react';
+import InteractionContext from '@atlaskit/interaction-context';
+
+/**
+ * Prevent a subtree from holding up an interaction
+ * Use this when you have a component which loads in late, but
+ * isn't considered to be a breach of SLO
+ *
+ * ```js
+ * <App>
+ *   <Main />
+ *   <Sidebar>
+ *     <UFOInteractionIgnore>
+ *       <InsightsButton />
+ *     </UFOInteractionIgnore>
+ *   </Sidebar>
+ * </App>
+ * ```
+ *
+ * Has an `ignore` prop, to allow you to use it conditionally
+ */
+export default function UFOInteractionIgnore({
+  children,
+  ignore = true
+}) {
+  const parentContext = useContext(InteractionContext);
+  const ignoredInteractionContext = useMemo(() => {
+    if (!parentContext) {
+      return null;
+    }
+    return {
+      ...parentContext,
+      hold(...args) {
+        if (!ignore) {
+          return parentContext.hold(...args);
+        }
+      }
+    };
+  }, [parentContext, ignore]);
+
+  // react-18: Use children directly
+  const kids = children != null ? children : null;
+  if (!ignoredInteractionContext) {
+    return /*#__PURE__*/React.createElement(React.Fragment, null, kids);
+  }
+  return /*#__PURE__*/React.createElement(InteractionContext.Provider, {
+    value: ignoredInteractionContext
+  }, kids);
+}

package/dist/esm/create-payload/index.js

@@ -622,6 +622,9 @@ function getSSRDoneTimeValue(config) {
   var _config$ssr, _config$ssr2;
   return config !== null && config !== void 0 && (_config$ssr = config.ssr) !== null && _config$ssr !== void 0 && _config$ssr.getSSRDoneTime ? config === null || config === void 0 || (_config$ssr2 = config.ssr) === null || _config$ssr2 === void 0 ? void 0 : _config$ssr2.getSSRDoneTime() : ssr.getSSRDoneTime();
 }
+function getPayloadSize(payload) {
+  return Math.round(new TextEncoder().encode(JSON.stringify(payload)).length / 1024);
+}
 function createInteractionMetricsPayload(interaction, interactionId) {
   var _window$location, _config$additionalPay;
   var interactionPayloadStart = performance.now();
@@ -706,7 +709,7 @@ function createInteractionMetricsPayload(interaction, interactionId) {
     };
   };
   var newUFOName = sanitizeUfoName(ufoName);
-  return {
+  var payload = {
     actionSubject: 'experience',
     action: 'measured',
     eventType: 'operational',
@@ -718,6 +721,7 @@ function createInteractionMetricsPayload(interaction, interactionId) {
         'event:hostname': ((_window$location = window.location) === null || _window$location === void 0 ? void 0 : _window$location.hostname) || 'unknown',
         'event:product': config.product,
         'event:schema': '1.0.0',
+        'event:sizeInKb': 0,
         'event:source': {
           name: 'react-ufo/web',
           version: REACT_UFO_VERSION,
@@ -763,6 +767,8 @@ function createInteractionMetricsPayload(interaction, interactionId) {
       })
     }
   };
+  payload.attributes.properties['event:sizeInKb'] = getPayloadSize(payload.attributes.properties);
+  return payload;
 }
 export function createPayloads(interactionId, interaction) {
   var ufoNameOverride = getUfoNameOverride(interaction);

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

@@ -0,0 +1 @@
+export { default } from './ufo-interaction-ignore';

package/dist/esm/interaction-ignore/ufo-interaction-ignore.js

@@ -0,0 +1,51 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+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 React, { useContext, useMemo } from 'react';
+import InteractionContext from '@atlaskit/interaction-context';
+
+/**
+ * Prevent a subtree from holding up an interaction
+ * Use this when you have a component which loads in late, but
+ * isn't considered to be a breach of SLO
+ *
+ * ```js
+ * <App>
+ *   <Main />
+ *   <Sidebar>
+ *     <UFOInteractionIgnore>
+ *       <InsightsButton />
+ *     </UFOInteractionIgnore>
+ *   </Sidebar>
+ * </App>
+ * ```
+ *
+ * Has an `ignore` prop, to allow you to use it conditionally
+ */
+export default function UFOInteractionIgnore(_ref) {
+  var children = _ref.children,
+    _ref$ignore = _ref.ignore,
+    ignore = _ref$ignore === void 0 ? true : _ref$ignore;
+  var parentContext = useContext(InteractionContext);
+  var ignoredInteractionContext = useMemo(function () {
+    if (!parentContext) {
+      return null;
+    }
+    return _objectSpread(_objectSpread({}, parentContext), {}, {
+      hold: function hold() {
+        if (!ignore) {
+          return parentContext.hold.apply(parentContext, arguments);
+        }
+      }
+    });
+  }, [parentContext, ignore]);
+
+  // react-18: Use children directly
+  var kids = children != null ? children : null;
+  if (!ignoredInteractionContext) {
+    return /*#__PURE__*/React.createElement(React.Fragment, null, kids);
+  }
+  return /*#__PURE__*/React.createElement(InteractionContext.Provider, {
+    value: ignoredInteractionContext
+  }, kids);
+}

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

@@ -727,6 +727,7 @@ export declare function createPayloads(interactionId: string, interaction: Inter
             'event:hostname': string;
             'event:product': string;
             'event:schema': string;
+            'event:sizeInKb': number;
             'event:source': {
                 name: string;
                 version: string;
@@ -1475,6 +1476,7 @@ export declare function createPayloads(interactionId: string, interaction: Inter
             'event:hostname': string;
             'event:product': string;
             'event:schema': string;
+            'event:sizeInKb': number;
             'event:source': {
                 name: string;
                 version: string;
@@ -2205,6 +2207,7 @@ export declare function createPayloads(interactionId: string, interaction: Inter
             'event:hostname': string;
             'event:product': string;
             'event:schema': string;
+            'event:sizeInKb': number;
             'event:source': {
                 name: string;
                 version: string;
@@ -2956,6 +2959,7 @@ export declare function createPayloads(interactionId: string, interaction: Inter
             'event:hostname': string;
             'event:product': string;
             'event:schema': string;
+            'event:sizeInKb': number;
             'event:source': {
                 name: string;
                 version: string;

package/dist/types/interaction-ignore/index.d.ts

@@ -0,0 +1 @@
+export { default } from './ufo-interaction-ignore';

package/dist/types/interaction-ignore/ufo-interaction-ignore.d.ts

@@ -0,0 +1,23 @@
+import { type ReactNode } from 'react';
+/**
+ * Prevent a subtree from holding up an interaction
+ * Use this when you have a component which loads in late, but
+ * isn't considered to be a breach of SLO
+ *
+ * ```js
+ * <App>
+ *   <Main />
+ *   <Sidebar>
+ *     <UFOInteractionIgnore>
+ *       <InsightsButton />
+ *     </UFOInteractionIgnore>
+ *   </Sidebar>
+ * </App>
+ * ```
+ *
+ * Has an `ignore` prop, to allow you to use it conditionally
+ */
+export default function UFOInteractionIgnore({ children, ignore, }: {
+    children?: ReactNode;
+    ignore?: boolean;
+}): JSX.Element;

package/dist/types-ts4.5/create-payload/index.d.ts

@@ -727,6 +727,7 @@ export declare function createPayloads(interactionId: string, interaction: Inter
             'event:hostname': string;
             'event:product': string;
             'event:schema': string;
+            'event:sizeInKb': number;
             'event:source': {
                 name: string;
                 version: string;
@@ -1475,6 +1476,7 @@ export declare function createPayloads(interactionId: string, interaction: Inter
             'event:hostname': string;
             'event:product': string;
             'event:schema': string;
+            'event:sizeInKb': number;
             'event:source': {
                 name: string;
                 version: string;
@@ -2205,6 +2207,7 @@ export declare function createPayloads(interactionId: string, interaction: Inter
             'event:hostname': string;
             'event:product': string;
             'event:schema': string;
+            'event:sizeInKb': number;
             'event:source': {
                 name: string;
                 version: string;
@@ -2956,6 +2959,7 @@ export declare function createPayloads(interactionId: string, interaction: Inter
             'event:hostname': string;
             'event:product': string;
             'event:schema': string;
+            'event:sizeInKb': number;
             'event:source': {
                 name: string;
                 version: string;

package/dist/types-ts4.5/interaction-ignore/index.d.ts

@@ -0,0 +1 @@
+export { default } from './ufo-interaction-ignore';

package/dist/types-ts4.5/interaction-ignore/ufo-interaction-ignore.d.ts

@@ -0,0 +1,23 @@
+import { type ReactNode } from 'react';
+/**
+ * Prevent a subtree from holding up an interaction
+ * Use this when you have a component which loads in late, but
+ * isn't considered to be a breach of SLO
+ *
+ * ```js
+ * <App>
+ *   <Main />
+ *   <Sidebar>
+ *     <UFOInteractionIgnore>
+ *       <InsightsButton />
+ *     </UFOInteractionIgnore>
+ *   </Sidebar>
+ * </App>
+ * ```
+ *
+ * Has an `ignore` prop, to allow you to use it conditionally
+ */
+export default function UFOInteractionIgnore({ children, ignore, }: {
+    children?: ReactNode;
+    ignore?: boolean;
+}): JSX.Element;

package/interaction-ignore/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@atlaskit/react-ufo/interaction-ignore",
+  "main": "../dist/cjs/interaction-ignore/index.js",
+  "module": "../dist/esm/interaction-ignore/index.js",
+  "module:es2019": "../dist/es2019/interaction-ignore/index.js",
+  "sideEffects": false,
+  "types": "../dist/types/interaction-ignore/index.d.ts",
+  "typesVersions": {
+    ">=4.5 <5.4": {
+      "*": [
+        "../dist/types-ts4.5/interaction-ignore/index.d.ts"
+      ]
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/react-ufo",
-	"version": "2.0.5",
+	"version": "2.0.7",
 	"description": "Parts of React UFO that are publicly available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -46,6 +46,7 @@
 		"./initial-page-load-extra-timing": "./src/initial-page-load-extra-timing/index.ts",
 		"./interaction-context": "./src/interaction-context/index.ts",
 		"./interaction-id-context": "./src/interaction-id-context/index.ts",
+		"./interaction-ignore": "./src/interaction-ignore/index.ts",
 		"./interaction-metrics": "./src/interaction-metrics/index.ts",
 		"./interaction-metrics-init": "./src/interaction-metrics-init/index.ts",
 		"./label": "./src/label/index.ts",
@@ -72,7 +73,7 @@
 		".": "./src/index.ts"
 	},
 	"dependencies": {
-		"@atlaskit/interaction-context": "^2.1.0",
+		"@atlaskit/interaction-context": "^2.1.4",
 		"@atlaskit/platform-feature-flags": "^0.3.0",
 		"@babel/runtime": "^7.0.0",
 		"bind-event-listener": "^3.0.0",