@atlaskit/editor-common 86.1.0 → 86.2.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/editor-common
 
+## 86.2.0
+
+### Minor Changes
+
+- [`ca831efa17dd5`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/ca831efa17dd5) -
+  [ED-23922] Added utility to count the number of unique elements, text formats, macros and layouts
+  in a JSONDocNode or JSONNode
+
+### Patch Changes
+
+- [#121046](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/121046)
+  [`c5cbf1d63b0c8`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/c5cbf1d63b0c8) -
+  [ED-24241] Memonize the document.body to avoid multiple Layout Reflows for the same page
+
 ## 86.1.0
 
 ### Minor Changes

package/dist/cjs/monitoring/error.js

@@ -17,7 +17,7 @@ function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return
 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 && Object.prototype.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; }
 var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-var packageVersion = "86.1.0";
+var packageVersion = "86.2.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // TODO: Sanitise the URL instead of just removing it

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

@@ -20,7 +20,7 @@ var _Layer = _interopRequireDefault(require("../Layer"));
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
 function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); } /** @jsx jsx */ // eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "86.1.0";
+var packageVersion = "86.2.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var DropList = /*#__PURE__*/function (_Component) {

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

@@ -11,6 +11,7 @@ exports.getBreakpoint = getBreakpoint;
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _react = _interopRequireWildcard(require("react"));
 var _react2 = require("@emotion/react");
+var _memoizeOne = _interopRequireDefault(require("memoize-one"));
 var _rafSchd = _interopRequireDefault(require("raf-schd"));
 var _widthDetector = require("@atlaskit/width-detector");
 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); }
@@ -45,13 +46,28 @@ function createWidthContext() {
 var WidthContext = exports.WidthContext = /*#__PURE__*/_react.default.createContext(createWidthContext());
 var Provider = WidthContext.Provider,
   Consumer = exports.WidthConsumer = WidthContext.Consumer;
-var WidthProvider = exports.WidthProvider = function WidthProvider(_ref) {
+/**
+ * 🧱 Internal function: Editor FE Platform
+ *
+ * Returns the width of the document body.
+ *
+ * This function is memoized to avoid forcing a layout reflow multiple times.
+ * It uses `document.body.offsetWidth` as the source of the width, which can lead to
+ * a layout reflow if accessed repeatedly. To mitigate performance issues, the result
+ * is cached using `memoizeOne`.
+ *
+ * @returns {number} The width of the document body or 0 if the document is undefined.
+ */
+var getBodyWidth = (0, _memoizeOne.default)(function () {
   var _document$body$offset, _document$body;
+  return typeof document !== 'undefined' ? (_document$body$offset = (_document$body = document.body) === null || _document$body === void 0 ? void 0 : _document$body.offsetWidth) !== null && _document$body$offset !== void 0 ? _document$body$offset : 0 : 0;
+});
+var WidthProvider = exports.WidthProvider = function WidthProvider(_ref) {
   var className = _ref.className,
     shouldCheckExistingValue = _ref.shouldCheckExistingValue,
     children = _ref.children;
   var existingContextValue = _react.default.useContext(WidthContext);
-  var _React$useState = _react.default.useState(typeof document !== 'undefined' ? (_document$body$offset = (_document$body = document.body) === null || _document$body === void 0 ? void 0 : _document$body.offsetWidth) !== null && _document$body$offset !== void 0 ? _document$body$offset : 0 : 0),
+  var _React$useState = _react.default.useState(getBodyWidth),
     _React$useState2 = (0, _slicedToArray2.default)(_React$useState, 2),
     width = _React$useState2[0],
     setWidth = _React$useState2[1];

package/dist/cjs/utils/index.js

@@ -492,6 +492,12 @@ Object.defineProperty(exports, "getOrderFromOrderedListNode", {
     return _list.getOrderFromOrderedListNode;
   }
 });
+Object.defineProperty(exports, "getPageElementCounts", {
+  enumerable: true,
+  get: function get() {
+    return _pageElementCounts.getPageElementCounts;
+  }
+});
 Object.defineProperty(exports, "getPerformanceOptions", {
   enumerable: true,
   get: function get() {
@@ -1181,6 +1187,7 @@ var _insertNodeIntoOrderedList = require("./insert-node-into-ordered-list");
 var _wrapSelectionIn = require("./wrap-selection-in");
 var _calculateToolbarPosition = require("./calculate-toolbar-position");
 var _nodesByLocalIds = require("./nodes-by-localIds");
+var _pageElementCounts = require("./page-element-counts");
 /**
  * @deprecated - [ED-23844] moving to own entry point @atlaskit/editor-common/whitespace
  */

package/dist/cjs/utils/page-element-counts.js

@@ -0,0 +1,44 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getPageElementCounts = void 0;
+var _traverse = require("@atlaskit/adf-utils/traverse");
+/**
+ * Traverses a JSON document and counts the number of unique elements, text formatting and macros.
+ *
+ **/
+var getPageElementCounts = exports.getPageElementCounts = function getPageElementCounts(doc) {
+  var pageElementCounts = {
+    elements: {},
+    textFormats: {},
+    macros: {}
+  };
+  (0, _traverse.reduce)(doc, function (acc, node) {
+    if (node.type === 'text') {
+      var _acc$elements$node$ty;
+      if (node.marks) {
+        node.marks.forEach(function (mark) {
+          var _acc$textFormats$mark;
+          var markType = mark.type;
+          acc.textFormats[markType] = ((_acc$textFormats$mark = acc.textFormats[markType]) !== null && _acc$textFormats$mark !== void 0 ? _acc$textFormats$mark : 0) + 1;
+        });
+      }
+      acc.elements[node.type] = ((_acc$elements$node$ty = acc.elements[node.type]) !== null && _acc$elements$node$ty !== void 0 ? _acc$elements$node$ty : 0) + 1;
+    }
+    // If the node is a 'macro'or extension
+    else if (node.type === 'extension' || node.type === 'inlineExtension' || node.type === 'bodiedExtension' || node.type === 'multiBodiedExtension' || node.type === 'extensionFrame') {
+      if ('attrs' in node && node.attrs && 'extensionKey' in node.attrs && node.attrs.extensionKey) {
+        var _acc$macros$extension;
+        var extensionKey = node.attrs.extensionKey;
+        acc.macros[extensionKey] = ((_acc$macros$extension = acc.macros[extensionKey]) !== null && _acc$macros$extension !== void 0 ? _acc$macros$extension : 0) + 1;
+      }
+    } else {
+      var _acc$elements$node$ty2;
+      acc.elements[node.type] = ((_acc$elements$node$ty2 = acc.elements[node.type]) !== null && _acc$elements$node$ty2 !== void 0 ? _acc$elements$node$ty2 : 0) + 1;
+    }
+    return acc;
+  }, pageElementCounts);
+  return pageElementCounts;
+};

package/dist/es2019/monitoring/error.js

@@ -1,7 +1,7 @@
 import { isFedRamp } from './environment';
 const SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 const packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-const packageVersion = "86.1.0";
+const packageVersion = "86.2.0";
 const sanitiseSentryEvents = (data, _hint) => {
   // Remove URL as it has UGC
   // TODO: Sanitise the URL instead of just removing it

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

@@ -9,7 +9,7 @@ import { createAndFireEvent, withAnalyticsContext, withAnalyticsEvents } from '@
 import { N0, N50A, N60A, N900 } from '@atlaskit/theme/colors';
 import Layer from '../Layer';
 const packageName = "@atlaskit/editor-common";
-const packageVersion = "86.1.0";
+const packageVersion = "86.2.0";
 const halfFocusRing = 1;
 const dropOffset = '0, 8';
 class DropList extends Component {

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

@@ -3,6 +3,7 @@ import React, { Fragment } from 'react';
 
 // eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
 import { css, jsx } from '@emotion/react';
+import memoizeOne from 'memoize-one';
 import rafSchedule from 'raf-schd';
 import { WidthObserver } from '@atlaskit/width-detector';
 const styles = css({
@@ -31,14 +32,29 @@ const {
   Provider,
   Consumer
 } = WidthContext;
+/**
+ * 🧱 Internal function: Editor FE Platform
+ *
+ * Returns the width of the document body.
+ *
+ * This function is memoized to avoid forcing a layout reflow multiple times.
+ * It uses `document.body.offsetWidth` as the source of the width, which can lead to
+ * a layout reflow if accessed repeatedly. To mitigate performance issues, the result
+ * is cached using `memoizeOne`.
+ *
+ * @returns {number} The width of the document body or 0 if the document is undefined.
+ */
+const getBodyWidth = memoizeOne(() => {
+  var _document$body$offset, _document$body;
+  return typeof document !== 'undefined' ? (_document$body$offset = (_document$body = document.body) === null || _document$body === void 0 ? void 0 : _document$body.offsetWidth) !== null && _document$body$offset !== void 0 ? _document$body$offset : 0 : 0;
+});
 export const WidthProvider = ({
   className,
   shouldCheckExistingValue,
   children
 }) => {
-  var _document$body$offset, _document$body;
   const existingContextValue = React.useContext(WidthContext);
-  const [width, setWidth] = React.useState(typeof document !== 'undefined' ? (_document$body$offset = (_document$body = document.body) === null || _document$body === void 0 ? void 0 : _document$body.offsetWidth) !== null && _document$body$offset !== void 0 ? _document$body$offset : 0 : 0);
+  const [width, setWidth] = React.useState(getBodyWidth);
   const widthRef = React.useRef(width);
   const isMountedRef = React.useRef(true);
   const providerValue = React.useMemo(() => createWidthContext(width), [width]);

package/dist/es2019/utils/index.js

@@ -221,4 +221,5 @@ export { transformNodeIntoListItem } from './insert-node-into-ordered-list';
 export { wrapSelectionIn } from './wrap-selection-in';
 export { toJSON, nodeToJSON } from './nodes';
 export { calculateToolbarPositionAboveSelection, calculateToolbarPositionTrackHead } from './calculate-toolbar-position';
-export { findNodePosByLocalIds } from './nodes-by-localIds';
+export { findNodePosByLocalIds } from './nodes-by-localIds';
+export { getPageElementCounts } from './page-element-counts';

package/dist/es2019/utils/page-element-counts.js

@@ -0,0 +1,38 @@
+import { reduce } from '@atlaskit/adf-utils/traverse';
+/**
+ * Traverses a JSON document and counts the number of unique elements, text formatting and macros.
+ *
+ **/
+export const getPageElementCounts = doc => {
+  const pageElementCounts = {
+    elements: {},
+    textFormats: {},
+    macros: {}
+  };
+  reduce(doc, (acc, node) => {
+    if (node.type === 'text') {
+      var _acc$elements$node$ty;
+      if (node.marks) {
+        node.marks.forEach(mark => {
+          var _acc$textFormats$mark;
+          const markType = mark.type;
+          acc.textFormats[markType] = ((_acc$textFormats$mark = acc.textFormats[markType]) !== null && _acc$textFormats$mark !== void 0 ? _acc$textFormats$mark : 0) + 1;
+        });
+      }
+      acc.elements[node.type] = ((_acc$elements$node$ty = acc.elements[node.type]) !== null && _acc$elements$node$ty !== void 0 ? _acc$elements$node$ty : 0) + 1;
+    }
+    // If the node is a 'macro'or extension
+    else if (node.type === 'extension' || node.type === 'inlineExtension' || node.type === 'bodiedExtension' || node.type === 'multiBodiedExtension' || node.type === 'extensionFrame') {
+      if ('attrs' in node && node.attrs && 'extensionKey' in node.attrs && node.attrs.extensionKey) {
+        var _acc$macros$extension;
+        const extensionKey = node.attrs.extensionKey;
+        acc.macros[extensionKey] = ((_acc$macros$extension = acc.macros[extensionKey]) !== null && _acc$macros$extension !== void 0 ? _acc$macros$extension : 0) + 1;
+      }
+    } else {
+      var _acc$elements$node$ty2;
+      acc.elements[node.type] = ((_acc$elements$node$ty2 = acc.elements[node.type]) !== null && _acc$elements$node$ty2 !== void 0 ? _acc$elements$node$ty2 : 0) + 1;
+    }
+    return acc;
+  }, pageElementCounts);
+  return pageElementCounts;
+};

package/dist/esm/monitoring/error.js

@@ -7,7 +7,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 import { isFedRamp } from './environment';
 var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-var packageVersion = "86.1.0";
+var packageVersion = "86.2.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // TODO: Sanitise the URL instead of just removing it

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

@@ -17,7 +17,7 @@ import { createAndFireEvent, withAnalyticsContext, withAnalyticsEvents } from '@
 import { N0, N50A, N60A, N900 } from '@atlaskit/theme/colors';
 import Layer from '../Layer';
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "86.1.0";
+var packageVersion = "86.2.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var DropList = /*#__PURE__*/function (_Component) {

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

@@ -4,6 +4,7 @@ import React, { Fragment } from 'react';
 
 // eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
 import { css, jsx } from '@emotion/react';
+import memoizeOne from 'memoize-one';
 import rafSchedule from 'raf-schd';
 import { WidthObserver } from '@atlaskit/width-detector';
 var styles = css({
@@ -32,13 +33,28 @@ export function createWidthContext() {
 export var WidthContext = /*#__PURE__*/React.createContext(createWidthContext());
 var Provider = WidthContext.Provider,
   Consumer = WidthContext.Consumer;
-export var WidthProvider = function WidthProvider(_ref) {
+/**
+ * 🧱 Internal function: Editor FE Platform
+ *
+ * Returns the width of the document body.
+ *
+ * This function is memoized to avoid forcing a layout reflow multiple times.
+ * It uses `document.body.offsetWidth` as the source of the width, which can lead to
+ * a layout reflow if accessed repeatedly. To mitigate performance issues, the result
+ * is cached using `memoizeOne`.
+ *
+ * @returns {number} The width of the document body or 0 if the document is undefined.
+ */
+var getBodyWidth = memoizeOne(function () {
   var _document$body$offset, _document$body;
+  return typeof document !== 'undefined' ? (_document$body$offset = (_document$body = document.body) === null || _document$body === void 0 ? void 0 : _document$body.offsetWidth) !== null && _document$body$offset !== void 0 ? _document$body$offset : 0 : 0;
+});
+export var WidthProvider = function WidthProvider(_ref) {
   var className = _ref.className,
     shouldCheckExistingValue = _ref.shouldCheckExistingValue,
     children = _ref.children;
   var existingContextValue = React.useContext(WidthContext);
-  var _React$useState = React.useState(typeof document !== 'undefined' ? (_document$body$offset = (_document$body = document.body) === null || _document$body === void 0 ? void 0 : _document$body.offsetWidth) !== null && _document$body$offset !== void 0 ? _document$body$offset : 0 : 0),
+  var _React$useState = React.useState(getBodyWidth),
     _React$useState2 = _slicedToArray(_React$useState, 2),
     width = _React$useState2[0],
     setWidth = _React$useState2[1];

package/dist/esm/utils/index.js

@@ -224,4 +224,5 @@ export { transformNodeIntoListItem } from './insert-node-into-ordered-list';
 export { wrapSelectionIn } from './wrap-selection-in';
 export { toJSON, nodeToJSON } from './nodes';
 export { calculateToolbarPositionAboveSelection, calculateToolbarPositionTrackHead } from './calculate-toolbar-position';
-export { findNodePosByLocalIds } from './nodes-by-localIds';
+export { findNodePosByLocalIds } from './nodes-by-localIds';
+export { getPageElementCounts } from './page-element-counts';

package/dist/esm/utils/page-element-counts.js

@@ -0,0 +1,38 @@
+import { reduce } from '@atlaskit/adf-utils/traverse';
+/**
+ * Traverses a JSON document and counts the number of unique elements, text formatting and macros.
+ *
+ **/
+export var getPageElementCounts = function getPageElementCounts(doc) {
+  var pageElementCounts = {
+    elements: {},
+    textFormats: {},
+    macros: {}
+  };
+  reduce(doc, function (acc, node) {
+    if (node.type === 'text') {
+      var _acc$elements$node$ty;
+      if (node.marks) {
+        node.marks.forEach(function (mark) {
+          var _acc$textFormats$mark;
+          var markType = mark.type;
+          acc.textFormats[markType] = ((_acc$textFormats$mark = acc.textFormats[markType]) !== null && _acc$textFormats$mark !== void 0 ? _acc$textFormats$mark : 0) + 1;
+        });
+      }
+      acc.elements[node.type] = ((_acc$elements$node$ty = acc.elements[node.type]) !== null && _acc$elements$node$ty !== void 0 ? _acc$elements$node$ty : 0) + 1;
+    }
+    // If the node is a 'macro'or extension
+    else if (node.type === 'extension' || node.type === 'inlineExtension' || node.type === 'bodiedExtension' || node.type === 'multiBodiedExtension' || node.type === 'extensionFrame') {
+      if ('attrs' in node && node.attrs && 'extensionKey' in node.attrs && node.attrs.extensionKey) {
+        var _acc$macros$extension;
+        var extensionKey = node.attrs.extensionKey;
+        acc.macros[extensionKey] = ((_acc$macros$extension = acc.macros[extensionKey]) !== null && _acc$macros$extension !== void 0 ? _acc$macros$extension : 0) + 1;
+      }
+    } else {
+      var _acc$elements$node$ty2;
+      acc.elements[node.type] = ((_acc$elements$node$ty2 = acc.elements[node.type]) !== null && _acc$elements$node$ty2 !== void 0 ? _acc$elements$node$ty2 : 0) + 1;
+    }
+    return acc;
+  }, pageElementCounts);
+  return pageElementCounts;
+};

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

@@ -91,3 +91,4 @@ export { wrapSelectionIn } from './wrap-selection-in';
 export { toJSON, nodeToJSON } from './nodes';
 export { calculateToolbarPositionAboveSelection, calculateToolbarPositionTrackHead, } from './calculate-toolbar-position';
 export { findNodePosByLocalIds } from './nodes-by-localIds';
+export { getPageElementCounts } from './page-element-counts';

package/dist/types/utils/page-element-counts.d.ts

@@ -0,0 +1,17 @@
+import type { JSONDocNode } from '@atlaskit/editor-json-transformer';
+export type PageElementCounts = {
+    elements: {
+        [key: string]: number;
+    };
+    textFormats: {
+        [key: string]: number;
+    };
+    macros: {
+        [key: string]: number;
+    };
+};
+/**
+ * Traverses a JSON document and counts the number of unique elements, text formatting and macros.
+ *
+ **/
+export declare const getPageElementCounts: (doc: JSONDocNode) => PageElementCounts;

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

@@ -91,3 +91,4 @@ export { wrapSelectionIn } from './wrap-selection-in';
 export { toJSON, nodeToJSON } from './nodes';
 export { calculateToolbarPositionAboveSelection, calculateToolbarPositionTrackHead, } from './calculate-toolbar-position';
 export { findNodePosByLocalIds } from './nodes-by-localIds';
+export { getPageElementCounts } from './page-element-counts';

package/dist/types-ts4.5/utils/page-element-counts.d.ts

@@ -0,0 +1,17 @@
+import type { JSONDocNode } from '@atlaskit/editor-json-transformer';
+export type PageElementCounts = {
+    elements: {
+        [key: string]: number;
+    };
+    textFormats: {
+        [key: string]: number;
+    };
+    macros: {
+        [key: string]: number;
+    };
+};
+/**
+ * Traverses a JSON document and counts the number of unique elements, text formatting and macros.
+ *
+ **/
+export declare const getPageElementCounts: (doc: JSONDocNode) => PageElementCounts;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "86.1.0",
+	"version": "86.2.0",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"