@atlaskit/editor-common 102.0.0 → 102.1.0

package/dist/esm/keymaps/keymap.js

@@ -34,9 +34,11 @@ export function keymap(bindings) {
         var isDeadKey = name === 'Dead';
         if (isModKeyPressed && (isNonLatinKey || isDeadKey)) {
           keyboardEvent = new KeyboardEvent(event.type, {
+            // Ignored via go/ees007
+            // eslint-disable-next-line @atlaskit/editor/enforce-todo-comment-format
             // FIXME: The event.keyCode is deprecated (see https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/keyCode),
-            //        and could be removed in any time, but the w3c-keyname library doesn't provide a way to get
-            //        a key by event.code.
+            // and could be removed in any time, but the w3c-keyname library doesn't provide a way to get
+            // a key by event.code.
             key: base[event.keyCode],
             code: event.code,
             ctrlKey: event.ctrlKey,

package/dist/esm/lazy-node-view/index.js

@@ -177,7 +177,7 @@ export var withLazyLoading = function withLazyLoading(_ref) {
     });
     requestedNodes.set(nodeName, loaderPromise);
     if (typeof ((_node$type = node.type) === null || _node$type === void 0 || (_node$type = _node$type.spec) === null || _node$type === void 0 ? void 0 : _node$type.toDOM) !== 'function') {
-      // TODO: Analytics ED-23982
+      // TODO: ED-23982 - Analytics
       // dispatchAnalyticsEvent({
       //   action: ACTION.LAZY_NODE_VIEW_ERROR,
       //   actionSubject: ACTION_SUBJECT.LAZY_NODE_VIEW,

package/dist/esm/media-inline/inline-image-card.js

@@ -26,6 +26,8 @@ export var InlineImageCard = function InlineImageCard(_ref) {
     };
   }, []);
 
+  // Ignored via go/ees007
+  // eslint-disable-next-line @atlaskit/editor/enforce-todo-comment-format
   // TODO do we need to handle nonCriticalError
   var _useFilePreview = useFilePreview({
       identifier: identifier,

package/dist/esm/messages/annotation.js

@@ -5,6 +5,8 @@ export var annotationMessages = defineMessages({
     defaultMessage: 'Comment',
     description: 'Create/add an inline comment based on the users selection'
   },
+  // Ignored via go/ees007
+  // eslint-disable-next-line @atlaskit/editor/enforce-todo-comment-format
   // TODO: Remove this message when the editor_inline_comments_on_inline_nodes FF is removed
   createCommentInvalid: {
     id: 'fabric.editor.createCommentInvalid',

package/dist/esm/messages/help-dialog.js

@@ -85,6 +85,8 @@ export var helpDialogMessages = defineMessages({
     defaultMessage: 'Close help dialog',
     description: ''
   },
+  // Ignored via go/ees007
+  // eslint-disable-next-line @atlaskit/editor/enforce-todo-comment-format
   // TODO: Move it inside quick insert plugin
   quickInsert: {
     id: 'fabric.editor.quickInsert',

package/dist/esm/monitoring/environment.js

@@ -3,6 +3,8 @@ var FEDRAMP_MODERATE = 'fedramp-moderate';
 // To determine whether an instance is a FedRAMP instance
 // Copied from platform/packages/uip/atl-context/src/services/is-fedramp/index.tsx
 // We cannot import the same-named function from @atlassian/atl-context due to editor-common being a public package (and atl-context being private)
+// Ignored via go/ees007
+// eslint-disable-next-line @atlaskit/editor/enforce-todo-comment-format
 // TODO: Seek alternatives
 export function isFedRamp() {
   var _global$location;

package/dist/esm/monitoring/error.js

@@ -7,9 +7,11 @@ 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 = "102.0.0";
+var packageVersion = "102.1.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
+  // Ignored via go/ees007
+  // eslint-disable-next-line @atlaskit/editor/enforce-todo-comment-format
   // TODO: Sanitise the URL instead of just removing it
   if (data.request) {
     delete data.request.url;

package/dist/esm/node-width/index.js

@@ -35,7 +35,6 @@ export var getParentNodeWidth = function getParentNodeWidth(pos, state, containe
   }
   var parentWidth = calcBreakoutNodeWidth(layout, containerWidth, isFullWidthModeEnabled);
 
-  // TODO: ED-15663
   // Please, do not copy or use this kind of code below
   // @ts-ignore
   var contextPanelPluginKey = {

package/dist/esm/quick-insert/assets/datasource-assets-objects.js

@@ -1,4 +1,4 @@
-// TODO: https://product-fabric.atlassian.net/browse/DSP-4138
+// TODO: DSP-4138 - migrate to @atlaskit/design-system
 /* eslint-disable @atlaskit/design-system/ensure-design-token-usage */
 import React from 'react';
 export default function IconDatasourceAssetsObjects() {

package/dist/esm/quick-insert/assets/datasource-jira-issue.js

@@ -1,4 +1,4 @@
-// TODO: https://product-fabric.atlassian.net/browse/DSP-4138
+// TODO: DSP-4138 - Migrate to @atlaskit/design-system
 /* eslint-disable @atlaskit/design-system/ensure-design-token-usage */
 import React from 'react';
 export default function IconDatasourceJiraIssue() {

package/dist/esm/quick-insert/assets/feedback.js

@@ -1,4 +1,4 @@
-// TODO: https://product-fabric.atlassian.net/browse/DSP-4138
+// TODO: DSP-4138 - Migrate to @atlaskit/design-system
 /* eslint-disable @atlaskit/design-system/ensure-design-token-usage */
 import React from 'react';
 export default function IconFeedback() {

package/dist/esm/quick-insert/assets/quote.js

@@ -1,4 +1,4 @@
-// TODO: https://product-fabric.atlassian.net/browse/DSP-4138
+// TODO: DSP-4138 - Migrate to @atlaskit/design-system
 /* eslint-disable @atlaskit/design-system/ensure-design-token-usage */
 import React from 'react';
 import { useIconThemed } from '../use-icon-themed';

package/dist/esm/react-node-view/getInlineNodeViewProducer.js

@@ -267,7 +267,7 @@ function getPortalChildren(_ref2) {
       className: "".concat(inlineNodeViewClassname, "AddZeroWidthSpace")
     }), ZERO_WIDTH_SPACE), jsx(Component, _extends({
       view: nodeViewParams.view
-      // TODO:  ED-13910 - Remove the boolean to fix the prosemirror view type
+      // TODO: ED-13910 - Remove the boolean to fix the prosemirror view type
       // Ignored via go/ees005
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
       ,

package/dist/esm/react-node-view/index.js

@@ -221,7 +221,7 @@ var ReactNodeView = /*#__PURE__*/function () {
 
       // View should not process a re-render if this is false.
       // We dont want to destroy the view, so we return true.
-      // TODO: ED-13910 Fix viewShouldUpdate readonly decoration array
+      // TODO: ED-13910 - Fix viewShouldUpdate readonly decoration array
       if (!this.viewShouldUpdate(node, decorations)) {
         this.node = node;
         return true;

package/dist/esm/selection/gap-cursor/selection.js

@@ -87,7 +87,7 @@ export var GapCursorSelection = /*#__PURE__*/function (_Selection) {
       }
       var pos = $pos.pos;
 
-      // TODO: Fix any, potential issue. ED-5048
+      // TODO: ED-5048 - Fix any, potential issue.
       // Ignored via go/ees005
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
       var next = null;

package/dist/esm/styles/shared/annotation.js

@@ -61,7 +61,7 @@ export var AnnotationSharedCSSByState = function AnnotationSharedCSSByState() {
         // emotion and token look up
         background: "var(--ds-background-accent-yellow-subtler, #F8E6A0)",
         borderBottom: "2px solid ".concat("var(--ds-border-accent-yellow, #B38600)"),
-        // TODO: https://product-fabric.atlassian.net/browse/DSP-4147
+        // TODO: DSP-4147 - Annotation shadow
         boxShadow: "var(--ds-shadow-overlay, 0px 8px 12px #091E4226, 0px 0px 1px #091E424f)",
         cursor: 'pointer'
       }),

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

@@ -20,7 +20,7 @@ import withAnalyticsContext from '@atlaskit/analytics-next/withAnalyticsContext'
 import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
 import Layer from '../Layer';
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "102.0.0";
+var packageVersion = "102.1.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 // Ignored via go/ees005

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

@@ -23,7 +23,6 @@ var defaultState = {
       position: null
     }
   },
-  // fix Safari parent width: https://product-fabric.atlassian.net/browse/ED-1784
   cssPosition: 'absolute',
   originalHeight: null,
   maxHeight: null

package/dist/esm/ui-menu/ColorPickerButton/index.js

@@ -51,7 +51,7 @@ var colorPickerButtonStyle = css({
 });
 
 // Control the size of color picker buttons and preview
-// TODO: https://product-fabric.atlassian.net/browse/DSP-4134
+// TODO: DSP-4134 - Color picking UI
 /* eslint-disable @atlaskit/design-system/ensure-design-token-usage */
 // eslint-disable-next-line @atlaskit/design-system/consistent-css-prop-usage -- Ignored via go/DSP-18766
 var colorPickerWrapper = function colorPickerWrapper() {

package/dist/esm/ui-menu/ToolbarButton/styles.js

@@ -9,6 +9,8 @@ export default /*#__PURE__*/React.forwardRef(function (props, ref) {
     // Ignored via go/ees005
     // eslint-disable-next-line react/jsx-props-no-spreading
   }, props, {
+    // Ignored via go/ees007
+    // eslint-disable-next-line @atlaskit/editor/enforce-todo-comment-format
     // TODO: (from codemod) Buttons with "component", "css" or "style" prop can't be automatically migrated with codemods. Please migrate it manually.
     // eslint-disable-next-line @atlaskit/ui-styling-standard/enforce-style-prop -- Ignored via go/DSP-18766
     style: {

package/dist/esm/ui-react/with-react-editor-view-outer-listeners.js

@@ -6,10 +6,11 @@ import _possibleConstructorReturn from "@babel/runtime/helpers/possibleConstruct
 import _getPrototypeOf from "@babel/runtime/helpers/getPrototypeOf";
 import _inherits from "@babel/runtime/helpers/inherits";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
-var _excluded = ["handleClickOutside", "handleEnterKeydown", "handleEscapeKeydown", "closeOnTab"];
+var _excluded = ["handleClickOutside", "handleEnterKeydown", "handleEscapeKeydown", "closeOnTab", "captureClick"];
 function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(t).constructor) : o.apply(t, e)); }
 function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
 import React, { PureComponent, useCallback, useEffect, useRef, useState } from 'react';
+import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
 import ReactEditorViewContext from './ReactEditorViewContext';
 // Use this context to pass in the reference of the element that should be considered as the outside click target
 // The outside click target is the element that should be clicked outside of to trigger the `handleClickOutside` event
@@ -68,9 +69,12 @@ var WithOutsideClick = /*#__PURE__*/function (_PureComponent) {
     key: "componentDidMount",
     value: function componentDidMount() {
       if (this.props.handleClickOutside) {
+        var options = this.props.captureClick && editorExperiment('platform_editor_controls', 'variant1') ? {
+          capture: true
+        } : false;
         // Ignored via go/ees005
         // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
-        document.addEventListener('click', this.handleClick, false);
+        document.addEventListener('click', this.handleClick, options);
       }
       if (this.props.handleEscapeKeydown) {
         var _this$props$editorRef;
@@ -88,9 +92,12 @@ var WithOutsideClick = /*#__PURE__*/function (_PureComponent) {
     key: "componentWillUnmount",
     value: function componentWillUnmount() {
       if (this.props.handleClickOutside) {
+        var options = this.props.captureClick && editorExperiment('platform_editor_controls', 'variant1') ? {
+          capture: true
+        } : false;
         // Ignored via go/ees005
         // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
-        document.removeEventListener('click', this.handleClick, false);
+        document.removeEventListener('click', this.handleClick, options);
       }
       if (this.props.handleEscapeKeydown) {
         var _this$props$editorRef2;
@@ -121,6 +128,7 @@ export default function withReactEditorViewOuterListeners(Component) {
       handleEnterKeydown = _ref.handleEnterKeydown,
       handleEscapeKeydown = _ref.handleEscapeKeydown,
       closeOnTab = _ref.closeOnTab,
+      captureClick = _ref.captureClick,
       props = _objectWithoutProperties(_ref, _excluded);
     var isActiveProp = hasIsOpen(props) ? props.isOpen : true;
     var _useState = useState(false),
@@ -152,7 +160,8 @@ export default function withReactEditorViewOuterListeners(Component) {
         handleClickOutside: handleClickOutside,
         handleEnterKeydown: handleEnterKeydown,
         handleEscapeKeydown: handleEscapeKeydown,
-        closeOnTab: closeOnTab
+        closeOnTab: closeOnTab,
+        captureClick: captureClick
       }, /*#__PURE__*/React.createElement(Component
       // Ignored via go/ees005
       // eslint-disable-next-line react/jsx-props-no-spreading

package/dist/esm/utils/calculate-toolbar-position.js

@@ -18,6 +18,8 @@ export var calculateToolbarPositionAboveSelection = function calculateToolbarPos
       return nextPos;
     }
     // scroll wrapper for full page, fall back to document body
+    // Ignored via go/ees007
+    // eslint-disable-next-line @atlaskit/editor/enforce-todo-comment-format
     // TODO: look into using getScrollGutterOptions()
     var scrollWrapper = editorView.dom.closest('.fabric-editor-popup-scroll-parent') || document.body;
     var wrapperBounds = scrollWrapper.getBoundingClientRect();
@@ -92,6 +94,8 @@ export var calculateToolbarPositionTrackHead = function calculateToolbarPosition
       return nextPos;
     }
     // scroll wrapper for full page, fall back to document body
+    // Ignored via go/ees007
+    // eslint-disable-next-line @atlaskit/editor/enforce-todo-comment-format
     // TODO: look into using getScrollGutterOptions()
     var scrollWrapper = editorView.dom.closest('.fabric-editor-popup-scroll-parent') || document.body;
     var wrapperBounds = scrollWrapper.getBoundingClientRect();

package/dist/esm/utils/compareNodes.js

@@ -157,7 +157,6 @@ function getMetaFromNode(node, options, normalizeTextParser) {
       }
     case 'mention':
       {
-        // TODO: Check what should be the fallback when mention does not have a text
         var _text2 = firstChild.attrs.text || '';
         return {
           type: ContentType.MENTION,

package/dist/esm/utils/get-performance-options.js

@@ -8,7 +8,6 @@ var DEFAULT_SAMPLING_RATE = 100;
 var DEFAULT_SLOW_THRESHOLD = 7;
 export function getPerformanceOptions(view) {
   var _nodeViewTracking$sam, _nodeViewTracking$slo;
-  // TODO: ED-15663
   // Please, do not copy or use this kind of code below
   // @ts-ignore
   var fakePluginKey = {

package/dist/esm/utils/is-text-input.js

@@ -1,6 +1,4 @@
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
-// TODO: remove from editor-core utils, re-export from editor-common
-
 import { ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
 export var isTextInput = function isTextInput(tr) {
   var _tr$steps = _slicedToArray(tr.steps, 1),

package/dist/esm/utils/table.js

@@ -33,6 +33,8 @@ export function getColumnWidths(node) {
   return tableColumnWidths;
 }
 export function calcTableColumnWidths(node) {
+  // Ignored via go/ees007
+  // eslint-disable-next-line @atlaskit/editor/enforce-todo-comment-format
   // TODO: replaced with getColumnWidths, which correctly scans entire table for column widths
   if (fg('platform_editor_table_row_span_fix')) {
     var _firstRow = node.firstChild;

package/dist/esm/utils/validate-using-spec.js

@@ -42,6 +42,8 @@ export var validationErrorHandler = function validationErrorHandler(entity, erro
     };
   }
 
+  // Ignored via go/ees007
+  // eslint-disable-next-line @atlaskit/editor/enforce-todo-comment-format
   // TODO: We can repair missing content like `panel` without a `paragraph`.
   if (error.code === 'INVALID_CONTENT_LENGTH') {
     if (error.meta && options.allowUnsupportedBlock && entity.content) {

package/dist/esm/with-plugin-state/index.js

@@ -210,7 +210,6 @@ export var WithPluginStateInner = /*#__PURE__*/function (_React$Component2) {
         return;
       }
 
-      // TODO: ED-15663
       // Please, do not copy or use this kind of code below
       // @ts-ignore
       var fakePluginKey = {

package/dist/types/ai-messages/ai.d.ts

@@ -4,6 +4,11 @@ export declare const aiMessages: {
         defaultMessage: string;
         description: string;
     };
+    eventHubfallbackSuggestedTitlePrefix: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
     aiToolbarTitle: {
         id: string;
         defaultMessage: string;

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

@@ -84,9 +84,6 @@ export type InlineCommentViewComponentProps = {
      * for annotation with given ID.
      *
      * The `undefined` will be returned if `editor_inline_comments_on_inline_nodes` is off.
-     *
-     * @todo: Do not forget to remove `undefined` when the
-     *        `editor_inline_comments_on_inline_nodes` is removed.
      */
     getInlineNodeTypes: (annotationId: string) => string[] | undefined;
 };

package/dist/types/ui-react/with-react-editor-view-outer-listeners.d.ts

@@ -7,6 +7,12 @@ export interface WithOutsideClickProps {
     handleEnterKeydown?: SimpleEventHandler<KeyboardEvent>;
     targetRef?: any;
     closeOnTab?: boolean;
+    /**
+     * Use when you want the click handler to call on the capture phase instead of during bubbling.
+     * This is useful when you're in a popup with interative UI elements that may disappear on click
+     * like when toggling UI states
+     */
+    captureClick?: boolean;
 }
 export default function withReactEditorViewOuterListeners<P extends Object>(Component: React.ComponentType<React.PropsWithChildren<P>>): React.ComponentType<React.PropsWithChildren<P & WithOutsideClickProps>>;
 export {};

package/dist/types-ts4.5/ai-messages/ai.d.ts

@@ -4,6 +4,11 @@ export declare const aiMessages: {
         defaultMessage: string;
         description: string;
     };
+    eventHubfallbackSuggestedTitlePrefix: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
     aiToolbarTitle: {
         id: string;
         defaultMessage: string;

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

@@ -84,9 +84,6 @@ export type InlineCommentViewComponentProps = {
      * for annotation with given ID.
      *
      * The `undefined` will be returned if `editor_inline_comments_on_inline_nodes` is off.
-     *
-     * @todo: Do not forget to remove `undefined` when the
-     *        `editor_inline_comments_on_inline_nodes` is removed.
      */
     getInlineNodeTypes: (annotationId: string) => string[] | undefined;
 };

package/dist/types-ts4.5/ui-react/with-react-editor-view-outer-listeners.d.ts

@@ -7,6 +7,12 @@ export interface WithOutsideClickProps {
     handleEnterKeydown?: SimpleEventHandler<KeyboardEvent>;
     targetRef?: any;
     closeOnTab?: boolean;
+    /**
+     * Use when you want the click handler to call on the capture phase instead of during bubbling.
+     * This is useful when you're in a popup with interative UI elements that may disappear on click
+     * like when toggling UI states
+     */
+    captureClick?: boolean;
 }
 export default function withReactEditorViewOuterListeners<P extends Object>(Component: React.ComponentType<React.PropsWithChildren<P>>): React.ComponentType<React.PropsWithChildren<P & WithOutsideClickProps>>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "102.0.0",
+	"version": "102.1.0",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -256,9 +256,6 @@
 		"platform_editor_react18_phase2_v2": {
 			"type": "boolean"
 		},
-		"platform_editor_is_disabled_state_element_browser": {
-			"type": "boolean"
-		},
 		"platform_editor_allow_annotation_triple_click": {
 			"type": "boolean"
 		},