@atlaskit/renderer 124.4.1 → 124.4.2

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @atlaskit/renderer
 
+## 124.4.2
+
+### Patch Changes
+
+- [`71cac2e4cf915`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/71cac2e4cf915) -
+  [FF-CLEANUP] platform_editor_add_border_for_nested_panel
+- [`c0ef0bedb49c0`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/c0ef0bedb49c0) -
+  EDITOR-1391 only send table width information events if there are tables, add enums and boolean
+  values for table width, editor width and scrollbar existence for ingestion in signalfx
+- Updated dependencies
+
 ## 124.4.1
 
 ### Patch Changes

package/dist/cjs/ui/Renderer/analytics-utils.js

@@ -1,13 +1,21 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getWidthInfoPayload = void 0;
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _analytics = require("@atlaskit/editor-common/analytics");
+var _analytics2 = require("@atlaskit/editor-common/utils/analytics");
 var getWidthInfoPayload = exports.getWidthInfoPayload = function getWidthInfoPayload(renderer) {
   var tablesInfo = [];
   var tableWrappers = renderer.querySelectorAll('.pm-table-wrapper');
+
+  // only send the event if there are tables on the page
+  if (tableWrappers.length === 0) {
+    return undefined;
+  }
   tableWrappers.forEach(function (tableWrapper) {
     var table = tableWrapper.querySelector(':scope > table');
     if (table) {
@@ -19,12 +27,22 @@ var getWidthInfoPayload = exports.getWidthInfoPayload = function getWidthInfoPay
       });
     }
   });
+  var maxTableWidth = Math.max.apply(Math, (0, _toConsumableArray2.default)(tablesInfo.map(function (table) {
+    return table.tableWidth;
+  })));
+  var editorWidth = renderer.scrollWidth;
   return {
     action: _analytics.TABLE_ACTION.TABLE_WIDTH_INFO,
     actionSubject: _analytics.ACTION_SUBJECT.TABLE,
     attributes: {
-      editorWidth: renderer.scrollWidth,
+      editorWidth: editorWidth,
+      editorWidthBreakpoint: (0, _analytics2.getBreakpointKey)(editorWidth),
       tableWidthInfo: tablesInfo,
+      maxTableWidthBreakpoint: (0, _analytics2.getBreakpointKey)(maxTableWidth),
+      hasTableWiderThanEditor: maxTableWidth > editorWidth,
+      hasTableWithScrollbar: tablesInfo.some(function (table) {
+        return table.hasScrollbar;
+      }),
       mode: _analytics.MODE.RENDERER
     },
     eventType: _analytics.EVENT_TYPE.OPERATIONAL

package/dist/cjs/ui/Renderer/index.js

@@ -68,7 +68,7 @@ var DEGRADED_SEVERITY_THRESHOLD = exports.DEGRADED_SEVERITY_THRESHOLD = 3000;
 // we want to calculate all the table widths (which causes reflows) after the renderer has finished loading to mitigate performance impact
 var TABLE_WIDTH_INFO_TIMEOUT = 10000;
 var packageName = "@atlaskit/renderer";
-var packageVersion = "124.4.0";
+var packageVersion = "124.4.1";
 var setAsQueryContainerStyles = (0, _react2.css)({
   containerName: 'ak-renderer-wrapper',
   containerType: 'inline-size'
@@ -369,7 +369,10 @@ var RendererFunctionalComponent = exports.RendererFunctionalComponent = function
             var _props$innerRef;
             var renderer = (_props$innerRef = props.innerRef) === null || _props$innerRef === void 0 || (_props$innerRef = _props$innerRef.current) === null || _props$innerRef === void 0 ? void 0 : _props$innerRef.querySelector('.ak-renderer-document');
             if (renderer) {
-              _fireAnalyticsEvent((0, _analyticsUtils.getWidthInfoPayload)(renderer));
+              var payload = (0, _analyticsUtils.getWidthInfoPayload)(renderer);
+              if (payload) {
+                _fireAnalyticsEvent(payload);
+              }
             }
           };
           if (window && typeof window.requestIdleCallback === 'function') {

package/dist/es2019/ui/Renderer/analytics-utils.js

@@ -1,7 +1,13 @@
 import { TABLE_ACTION, ACTION_SUBJECT, EVENT_TYPE, MODE } from '@atlaskit/editor-common/analytics';
+import { getBreakpointKey } from '@atlaskit/editor-common/utils/analytics';
 export const getWidthInfoPayload = renderer => {
   const tablesInfo = [];
   const tableWrappers = renderer.querySelectorAll('.pm-table-wrapper');
+
+  // only send the event if there are tables on the page
+  if (tableWrappers.length === 0) {
+    return undefined;
+  }
   tableWrappers.forEach(tableWrapper => {
     const table = tableWrapper.querySelector(':scope > table');
     if (table) {
@@ -13,12 +19,18 @@ export const getWidthInfoPayload = renderer => {
       });
     }
   });
+  const maxTableWidth = Math.max(...tablesInfo.map(table => table.tableWidth));
+  const editorWidth = renderer.scrollWidth;
   return {
     action: TABLE_ACTION.TABLE_WIDTH_INFO,
     actionSubject: ACTION_SUBJECT.TABLE,
     attributes: {
-      editorWidth: renderer.scrollWidth,
+      editorWidth,
+      editorWidthBreakpoint: getBreakpointKey(editorWidth),
       tableWidthInfo: tablesInfo,
+      maxTableWidthBreakpoint: getBreakpointKey(maxTableWidth),
+      hasTableWiderThanEditor: maxTableWidth > editorWidth,
+      hasTableWithScrollbar: tablesInfo.some(table => table.hasScrollbar),
       mode: MODE.RENDERER
     },
     eventType: EVENT_TYPE.OPERATIONAL

package/dist/es2019/ui/Renderer/index.js

@@ -54,7 +54,7 @@ export const DEGRADED_SEVERITY_THRESHOLD = 3000;
 // we want to calculate all the table widths (which causes reflows) after the renderer has finished loading to mitigate performance impact
 const TABLE_WIDTH_INFO_TIMEOUT = 10000;
 const packageName = "@atlaskit/renderer";
-const packageVersion = "124.4.0";
+const packageVersion = "124.4.1";
 const setAsQueryContainerStyles = css({
   containerName: 'ak-renderer-wrapper',
   containerType: 'inline-size'
@@ -359,7 +359,10 @@ export const RendererFunctionalComponent = props => {
             var _props$innerRef, _props$innerRef$curre;
             const renderer = (_props$innerRef = props.innerRef) === null || _props$innerRef === void 0 ? void 0 : (_props$innerRef$curre = _props$innerRef.current) === null || _props$innerRef$curre === void 0 ? void 0 : _props$innerRef$curre.querySelector('.ak-renderer-document');
             if (renderer) {
-              fireAnalyticsEvent(getWidthInfoPayload(renderer));
+              const payload = getWidthInfoPayload(renderer);
+              if (payload) {
+                fireAnalyticsEvent(payload);
+              }
             }
           };
           if (window && typeof window.requestIdleCallback === 'function') {

package/dist/esm/ui/Renderer/analytics-utils.js

@@ -1,7 +1,14 @@
+import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
 import { TABLE_ACTION, ACTION_SUBJECT, EVENT_TYPE, MODE } from '@atlaskit/editor-common/analytics';
+import { getBreakpointKey } from '@atlaskit/editor-common/utils/analytics';
 export var getWidthInfoPayload = function getWidthInfoPayload(renderer) {
   var tablesInfo = [];
   var tableWrappers = renderer.querySelectorAll('.pm-table-wrapper');
+
+  // only send the event if there are tables on the page
+  if (tableWrappers.length === 0) {
+    return undefined;
+  }
   tableWrappers.forEach(function (tableWrapper) {
     var table = tableWrapper.querySelector(':scope > table');
     if (table) {
@@ -13,12 +20,22 @@ export var getWidthInfoPayload = function getWidthInfoPayload(renderer) {
       });
     }
   });
+  var maxTableWidth = Math.max.apply(Math, _toConsumableArray(tablesInfo.map(function (table) {
+    return table.tableWidth;
+  })));
+  var editorWidth = renderer.scrollWidth;
   return {
     action: TABLE_ACTION.TABLE_WIDTH_INFO,
     actionSubject: ACTION_SUBJECT.TABLE,
     attributes: {
-      editorWidth: renderer.scrollWidth,
+      editorWidth: editorWidth,
+      editorWidthBreakpoint: getBreakpointKey(editorWidth),
       tableWidthInfo: tablesInfo,
+      maxTableWidthBreakpoint: getBreakpointKey(maxTableWidth),
+      hasTableWiderThanEditor: maxTableWidth > editorWidth,
+      hasTableWithScrollbar: tablesInfo.some(function (table) {
+        return table.hasScrollbar;
+      }),
       mode: MODE.RENDERER
     },
     eventType: EVENT_TYPE.OPERATIONAL

package/dist/esm/ui/Renderer/index.js

@@ -59,7 +59,7 @@ export var DEGRADED_SEVERITY_THRESHOLD = 3000;
 // we want to calculate all the table widths (which causes reflows) after the renderer has finished loading to mitigate performance impact
 var TABLE_WIDTH_INFO_TIMEOUT = 10000;
 var packageName = "@atlaskit/renderer";
-var packageVersion = "124.4.0";
+var packageVersion = "124.4.1";
 var setAsQueryContainerStyles = css({
   containerName: 'ak-renderer-wrapper',
   containerType: 'inline-size'
@@ -360,7 +360,10 @@ export var RendererFunctionalComponent = function RendererFunctionalComponent(pr
             var _props$innerRef;
             var renderer = (_props$innerRef = props.innerRef) === null || _props$innerRef === void 0 || (_props$innerRef = _props$innerRef.current) === null || _props$innerRef === void 0 ? void 0 : _props$innerRef.querySelector('.ak-renderer-document');
             if (renderer) {
-              _fireAnalyticsEvent(getWidthInfoPayload(renderer));
+              var payload = getWidthInfoPayload(renderer);
+              if (payload) {
+                _fireAnalyticsEvent(payload);
+              }
             }
           };
           if (window && typeof window.requestIdleCallback === 'function') {

package/dist/types/analytics/events.d.ts

@@ -2,6 +2,7 @@ import type { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, Operational
 import type { AEP } from './enums';
 import type { SortOrder } from '@atlaskit/editor-common/types';
 import type { SEVERITY, UNSUPPORTED_CONTENT_LEVEL_SEVERITY, UnsupportedContentPayload, UnsupportedContentTooltipPayload } from '@atlaskit/editor-common/utils';
+import type { EditorBreakpointKey } from '@atlaskit/editor-common/utils/analytics';
 export declare enum PLATFORM {
     NATIVE = "mobileNative",
     HYBRID = "mobileHybrid",
@@ -84,6 +85,10 @@ type TableSortColumnAEP = AEP<ACTION.SORT_COLUMN, ACTION_SUBJECT.TABLE, undefine
 }, EVENT_TYPE.TRACK>;
 type TableWidthInfoAEP = AEP<TABLE_ACTION.TABLE_WIDTH_INFO, ACTION_SUBJECT.TABLE, undefined, {
     editorWidth: number;
+    editorWidthBreakpoint: EditorBreakpointKey;
+    hasTableWiderThanEditor: boolean;
+    hasTableWithScrollbar: boolean;
+    maxTableWidthBreakpoint: EditorBreakpointKey;
     mode: MODE.RENDERER;
     tableWidthInfo: Array<{
         hasScrollbar: boolean;

package/dist/types/ui/Renderer/analytics-utils.d.ts

@@ -1,2 +1,2 @@
 import type { AnalyticsEventPayload } from '../../analytics/events';
-export declare const getWidthInfoPayload: (renderer: HTMLElement) => AnalyticsEventPayload;
+export declare const getWidthInfoPayload: (renderer: HTMLElement) => AnalyticsEventPayload | undefined;

package/dist/types-ts4.5/analytics/events.d.ts

@@ -2,6 +2,7 @@ import type { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, Operational
 import type { AEP } from './enums';
 import type { SortOrder } from '@atlaskit/editor-common/types';
 import type { SEVERITY, UNSUPPORTED_CONTENT_LEVEL_SEVERITY, UnsupportedContentPayload, UnsupportedContentTooltipPayload } from '@atlaskit/editor-common/utils';
+import type { EditorBreakpointKey } from '@atlaskit/editor-common/utils/analytics';
 export declare enum PLATFORM {
     NATIVE = "mobileNative",
     HYBRID = "mobileHybrid",
@@ -84,6 +85,10 @@ type TableSortColumnAEP = AEP<ACTION.SORT_COLUMN, ACTION_SUBJECT.TABLE, undefine
 }, EVENT_TYPE.TRACK>;
 type TableWidthInfoAEP = AEP<TABLE_ACTION.TABLE_WIDTH_INFO, ACTION_SUBJECT.TABLE, undefined, {
     editorWidth: number;
+    editorWidthBreakpoint: EditorBreakpointKey;
+    hasTableWiderThanEditor: boolean;
+    hasTableWithScrollbar: boolean;
+    maxTableWidthBreakpoint: EditorBreakpointKey;
     mode: MODE.RENDERER;
     tableWidthInfo: Array<{
         hasScrollbar: boolean;

package/dist/types-ts4.5/ui/Renderer/analytics-utils.d.ts

@@ -1,2 +1,2 @@
 import type { AnalyticsEventPayload } from '../../analytics/events';
-export declare const getWidthInfoPayload: (renderer: HTMLElement) => AnalyticsEventPayload;
+export declare const getWidthInfoPayload: (renderer: HTMLElement) => AnalyticsEventPayload | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/renderer",
-	"version": "124.4.1",
+	"version": "124.4.2",
 	"description": "Renderer component",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -92,7 +92,7 @@
 		"@atlaskit/mention": "^24.3.0",
 		"@atlaskit/modal-dialog": "^14.5.0",
 		"@atlaskit/navigation-next": "patch:@atlaskit/navigation-next@npm%3A9.0.17#~/.yarn/patches/@atlaskit-navigation-next-npm-9.0.17-958ca0ab9d.patch",
-		"@atlaskit/profilecard": "^24.18.0",
+		"@atlaskit/profilecard": "^24.19.0",
 		"@atlaskit/util-data-test": "^18.3.0",
 		"@atlassian/feature-flags-test-utils": "^0.3.0",
 		"@testing-library/react": "^13.4.0",
@@ -206,9 +206,6 @@
 		"platform_editor_renderer_rm_usespecbasedvalidator": {
 			"type": "boolean"
 		},
-		"platform_editor_add_border_for_nested_panel": {
-			"type": "boolean"
-		},
 		"platform_editor_bordered_panel_nested_in_table": {
 			"type": "boolean"
 		},