@atlaskit/editor-plugin-table 15.0.11 → 15.0.12

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @atlaskit/editor-plugin-table
 
+## 15.0.12
+
+### Patch Changes
+
+- [`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
+
 ## 15.0.11
 
 ### Patch Changes

package/dist/cjs/pm-plugins/utils/analytics.js

@@ -1,5 +1,6 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
@@ -7,8 +8,10 @@ exports.generateResizedPayload = exports.generateResizeFrameRatePayloads = void
 exports.getSelectedCellInfo = getSelectedCellInfo;
 exports.getSelectedTableInfo = getSelectedTableInfo;
 exports.withEditorAnalyticsAPI = exports.useMeasureFramerate = exports.reduceResizeFrameRateSamples = exports.getWidthInfoPayload = void 0;
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _react = require("react");
 var _analytics = require("@atlaskit/editor-common/analytics");
+var _analytics2 = require("@atlaskit/editor-common/utils/analytics");
 var _tableMap = require("@atlaskit/editor-tables/table-map");
 var _utils = require("@atlaskit/editor-tables/utils");
 var _colgroup = require("../table-resizing/utils/colgroup");
@@ -229,11 +232,25 @@ var getWidthInfoPayload = exports.getWidthInfoPayload = function getWidthInfoPay
       }
     }
   });
+
+  // only send the event if there are tables on the page
+  if (tablesInfo.length === 0) {
+    return undefined;
+  }
+  var maxTableWidth = Math.max.apply(Math, (0, _toConsumableArray2.default)(tablesInfo.map(function (table) {
+    return table.tableWidth;
+  })));
   return {
     action: _analytics.TABLE_ACTION.TABLE_WIDTH_INFO,
     actionSubject: _analytics.ACTION_SUBJECT.TABLE,
     attributes: {
       editorWidth: editorWidth,
+      editorWidthBreakpoint: (0, _analytics2.getBreakpointKey)(editorWidth),
+      hasTableWithScrollbar: tablesInfo.some(function (table) {
+        return table.hasScrollbar;
+      }),
+      hasTableWiderThanEditor: maxTableWidth > editorWidth,
+      maxTableWidthBreakpoint: (0, _analytics2.getBreakpointKey)(maxTableWidth),
       tableWidthInfo: tablesInfo,
       mode: 'editor'
     },

package/dist/cjs/tablePlugin.js

@@ -431,7 +431,10 @@ var tablePlugin = function tablePlugin(_ref) {
                     var _api$width$sharedStat2;
                     var editorWidth = api === null || api === void 0 || (_api$width$sharedStat2 = api.width.sharedState.currentState()) === null || _api$width$sharedStat2 === void 0 ? void 0 : _api$width$sharedStat2.width;
                     if (editorWidth && editorViewRef.current) {
-                      dispatchAnalyticsEvent((0, _analytics2.getWidthInfoPayload)(editorViewRef.current, editorWidth));
+                      var payload = (0, _analytics2.getWidthInfoPayload)(editorViewRef.current, editorWidth);
+                      if (payload) {
+                        dispatchAnalyticsEvent(payload);
+                      }
                     }
                   };
                   if (window && typeof window.requestIdleCallback === 'function') {

package/dist/es2019/pm-plugins/utils/analytics.js

@@ -1,5 +1,6 @@
 import { useEffect, useRef } from 'react';
 import { ACTION_SUBJECT, EVENT_TYPE, TABLE_ACTION } from '@atlaskit/editor-common/analytics';
+import { getBreakpointKey } from '@atlaskit/editor-common/utils/analytics';
 import { TableMap } from '@atlaskit/editor-tables/table-map';
 import { findTable, getSelectionRect } from '@atlaskit/editor-tables/utils';
 import { hasTableBeenResized } from '../table-resizing/utils/colgroup';
@@ -206,11 +207,21 @@ export const getWidthInfoPayload = (editorView, editorWidth) => {
       }
     }
   });
+
+  // only send the event if there are tables on the page
+  if (tablesInfo.length === 0) {
+    return undefined;
+  }
+  const maxTableWidth = Math.max(...tablesInfo.map(table => table.tableWidth));
   return {
     action: TABLE_ACTION.TABLE_WIDTH_INFO,
     actionSubject: ACTION_SUBJECT.TABLE,
     attributes: {
-      editorWidth: editorWidth,
+      editorWidth,
+      editorWidthBreakpoint: getBreakpointKey(editorWidth),
+      hasTableWithScrollbar: tablesInfo.some(table => table.hasScrollbar),
+      hasTableWiderThanEditor: maxTableWidth > editorWidth,
+      maxTableWidthBreakpoint: getBreakpointKey(maxTableWidth),
       tableWidthInfo: tablesInfo,
       mode: 'editor'
     },

package/dist/es2019/tablePlugin.js

@@ -420,7 +420,10 @@ const tablePlugin = ({
                     var _api$width$sharedStat2;
                     const editorWidth = api === null || api === void 0 ? void 0 : (_api$width$sharedStat2 = api.width.sharedState.currentState()) === null || _api$width$sharedStat2 === void 0 ? void 0 : _api$width$sharedStat2.width;
                     if (editorWidth && editorViewRef.current) {
-                      dispatchAnalyticsEvent(getWidthInfoPayload(editorViewRef.current, editorWidth));
+                      const payload = getWidthInfoPayload(editorViewRef.current, editorWidth);
+                      if (payload) {
+                        dispatchAnalyticsEvent(payload);
+                      }
                     }
                   };
                   if (window && typeof window.requestIdleCallback === 'function') {

package/dist/esm/pm-plugins/utils/analytics.js

@@ -1,5 +1,7 @@
+import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
 import { useEffect, useRef } from 'react';
 import { ACTION_SUBJECT, EVENT_TYPE, TABLE_ACTION } from '@atlaskit/editor-common/analytics';
+import { getBreakpointKey } from '@atlaskit/editor-common/utils/analytics';
 import { TableMap } from '@atlaskit/editor-tables/table-map';
 import { findTable, getSelectionRect } from '@atlaskit/editor-tables/utils';
 import { hasTableBeenResized } from '../table-resizing/utils/colgroup';
@@ -220,11 +222,25 @@ export var getWidthInfoPayload = function getWidthInfoPayload(editorView, editor
       }
     }
   });
+
+  // only send the event if there are tables on the page
+  if (tablesInfo.length === 0) {
+    return undefined;
+  }
+  var maxTableWidth = Math.max.apply(Math, _toConsumableArray(tablesInfo.map(function (table) {
+    return table.tableWidth;
+  })));
   return {
     action: TABLE_ACTION.TABLE_WIDTH_INFO,
     actionSubject: ACTION_SUBJECT.TABLE,
     attributes: {
       editorWidth: editorWidth,
+      editorWidthBreakpoint: getBreakpointKey(editorWidth),
+      hasTableWithScrollbar: tablesInfo.some(function (table) {
+        return table.hasScrollbar;
+      }),
+      hasTableWiderThanEditor: maxTableWidth > editorWidth,
+      maxTableWidthBreakpoint: getBreakpointKey(maxTableWidth),
       tableWidthInfo: tablesInfo,
       mode: 'editor'
     },

package/dist/esm/tablePlugin.js

@@ -422,7 +422,10 @@ var tablePlugin = function tablePlugin(_ref) {
                     var _api$width$sharedStat2;
                     var editorWidth = api === null || api === void 0 || (_api$width$sharedStat2 = api.width.sharedState.currentState()) === null || _api$width$sharedStat2 === void 0 ? void 0 : _api$width$sharedStat2.width;
                     if (editorWidth && editorViewRef.current) {
-                      dispatchAnalyticsEvent(getWidthInfoPayload(editorViewRef.current, editorWidth));
+                      var payload = getWidthInfoPayload(editorViewRef.current, editorWidth);
+                      if (payload) {
+                        dispatchAnalyticsEvent(payload);
+                      }
                     }
                   };
                   if (window && typeof window.requestIdleCallback === 'function') {

package/dist/types/pm-plugins/utils/analytics.d.ts

@@ -44,5 +44,5 @@ export declare const useMeasureFramerate: (config?: UseMeasureFramerateConfig) =
     endMeasure: () => number[];
     countFrames: () => void;
 };
-export declare const getWidthInfoPayload: (editorView: EditorView, editorWidth: number) => TableEventPayload;
+export declare const getWidthInfoPayload: (editorView: EditorView, editorWidth: number) => TableEventPayload | undefined;
 export {};

package/dist/types-ts4.5/pm-plugins/utils/analytics.d.ts

@@ -44,5 +44,5 @@ export declare const useMeasureFramerate: (config?: UseMeasureFramerateConfig) =
     endMeasure: () => number[];
     countFrames: () => void;
 };
-export declare const getWidthInfoPayload: (editorView: EditorView, editorWidth: number) => TableEventPayload;
+export declare const getWidthInfoPayload: (editorView: EditorView, editorWidth: number) => TableEventPayload | undefined;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-table",
-	"version": "15.0.11",
+	"version": "15.0.12",
 	"description": "Table plugin for the @atlaskit/editor",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -72,7 +72,7 @@
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^110.10.0",
+		"@atlaskit/editor-common": "^110.11.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0",
 		"react-intl-next": "npm:react-intl@^5.18.1"