@atlaskit/editor-common 104.1.2 → 104.1.4

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @atlaskit/editor-common
 
+## 104.1.4
+
+### Patch Changes
+
+- [#149969](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/149969)
+  [`42c3f35e57188`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/42c3f35e57188) -
+  ED-27882: Get rid of parent offset check in \_handleRef in the react node view. Add metadata to
+  these calls in the \_handleRef and \_handleTableRef.
+- Updated dependencies
+
+## 104.1.3
+
+### Patch Changes
+
+- [#142925](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/142925)
+  [`e013698350bef`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/e013698350bef) -
+  This updates the renderer to use the new annotation manager create comment APIs and disables the
+  use of the old create hooks. This should be backward compatible and can be controled by a FG
+- Updated dependencies
+
 ## 104.1.2
 
 ### Patch Changes

package/dist/cjs/annotation/index.js

@@ -35,7 +35,6 @@ var AnnotationUpdateEmitter = exports.AnnotationUpdateEmitter = /*#__PURE__*/fun
     }
   }]);
 }(_events.EventEmitter); // type ActionResult = { step: Step; doc: JSONDocNode } | false;
-// } & AnnotationByMatches)
 // | false;
 // ### Events
 // ### Hook Results

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 && {}.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 = "104.1.2";
+var packageVersion = "104.1.4";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

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

@@ -22,6 +22,7 @@ var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/cl
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _react = _interopRequireDefault(require("react"));
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _analytics = require("../analytics");
 var _eventDispatcher = require("../event-dispatcher");
 var _ErrorBoundary = require("../ui/ErrorBoundary");
@@ -159,13 +160,12 @@ var ReactNodeView = exports.default = /*#__PURE__*/function () {
       // Ignored via go/ees005
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
       var oldIgnoreMutation;
+      var parentOffset = 0; // Remove with feature gate: platform_editor_r18_fix_selection_resync
       var selectionBookmark;
-      var parentOffset = 0;
       var mutationsIgnored = false;
 
       // move the contentDOM node inside the inner reference after rendering
       if (node && contentDOM && !node.contains(contentDOM)) {
-        var _this$view$state$sele;
         // @ts-ignore - ignoreMutation may not be declared
         oldIgnoreMutation = this.ignoreMutation; // store ref to previous ignoreMutation
 
@@ -186,21 +186,40 @@ var ReactNodeView = exports.default = /*#__PURE__*/function () {
         }
 
         // ... and capture parent offset before DOM change
-        if (((_this$view$state$sele = this.view.state.selection) === null || _this$view$state$sele === void 0 ? void 0 : _this$view$state$sele.ranges.length) > 0) {
-          var _this$view$state$sele2, _this$view$state$sele3;
-          parentOffset = (_this$view$state$sele2 = (_this$view$state$sele3 = this.view.state.selection) === null || _this$view$state$sele3 === void 0 || (_this$view$state$sele3 = _this$view$state$sele3.ranges[0].$from) === null || _this$view$state$sele3 === void 0 ? void 0 : _this$view$state$sele3.parentOffset) !== null && _this$view$state$sele2 !== void 0 ? _this$view$state$sele2 : 0;
+        if (!(0, _platformFeatureFlags.fg)('platform_editor_r18_fix_selection_resync')) {
+          var _this$view$state$sele;
+          if (((_this$view$state$sele = this.view.state.selection) === null || _this$view$state$sele === void 0 ? void 0 : _this$view$state$sele.ranges.length) > 0) {
+            var _this$view$state$sele2, _this$view$state$sele3;
+            parentOffset = (_this$view$state$sele2 = (_this$view$state$sele3 = this.view.state.selection) === null || _this$view$state$sele3 === void 0 || (_this$view$state$sele3 = _this$view$state$sele3.ranges[0].$from) === null || _this$view$state$sele3 === void 0 ? void 0 : _this$view$state$sele3.parentOffset) !== null && _this$view$state$sele2 !== void 0 ? _this$view$state$sele2 : 0;
+          }
         }
         node.appendChild(contentDOM);
+
+        // After the next frame:
         requestAnimationFrame(function () {
-          // Reset ignoreMutation after frame ....
+          // Restore the original mutation handler
           // @ts-ignore - this may not have been declared by implementing class
           _this4.ignoreMutation = oldIgnoreMutation;
 
-          // only trigger selection re-sync if the selection is not at the start of the
-          // node, and DOM mutations were ignored
-          if (selectionBookmark && mutationsIgnored && parentOffset > 0) {
-            // ... and dispatch expected selection state
-            _this4.view.dispatch(_this4.view.state.tr.setSelection(selectionBookmark.resolve(_this4.view.state.tr.doc)));
+          // Restore the selection only if:
+          // - We have a selection bookmark
+          // - Mutations were ignored during the table move
+          // - The bookmarked selection is different from the current selection.
+          if (selectionBookmark && mutationsIgnored) {
+            if ((0, _platformFeatureFlags.fg)('platform_editor_r18_fix_selection_resync')) {
+              var resolvedSelection = selectionBookmark.resolve(_this4.view.state.tr.doc);
+              // Don't set the selection if it's the same as the current selection.
+              if (!resolvedSelection.eq(_this4.view.state.selection)) {
+                var tr = _this4.view.state.tr.setSelection(resolvedSelection);
+                tr.setMeta('source', 'ReactNodeView:_handleRef:selection-resync');
+                _this4.view.dispatch(tr);
+              }
+            } else {
+              if (parentOffset > 0) {
+                // ... and dispatch expected selection state
+                _this4.view.dispatch(_this4.view.state.tr.setSelection(selectionBookmark.resolve(_this4.view.state.tr.doc)));
+              }
+            }
           }
         });
       }

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

@@ -23,7 +23,7 @@ function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.
  * @jsx jsx
  */ // eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "104.1.2";
+var packageVersion = "104.1.4";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 // Ignored via go/ees005

package/dist/es2019/annotation/index.js

@@ -11,7 +11,6 @@ export class AnnotationUpdateEmitter extends EventEmitter {
 
 // type ActionResult = { step: Step; doc: JSONDocNode } | false;
 
-// } & AnnotationByMatches)
 // | false;
 
 // ### Events

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 = "104.1.2";
+const packageVersion = "104.1.4";
 const sanitiseSentryEvents = (data, _hint) => {
   // Remove URL as it has UGC
   // Ignored via go/ees007

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

@@ -4,6 +4,7 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 /* eslint-disable @atlaskit/editor/no-re-export */
 
 import React from 'react';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { ACTION_SUBJECT, ACTION_SUBJECT_ID } from '../analytics';
 import { createDispatch } from '../event-dispatcher';
 import { ErrorBoundary } from '../ui/ErrorBoundary';
@@ -122,13 +123,12 @@ export default class ReactNodeView {
     // Ignored via go/ees005
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     let oldIgnoreMutation;
+    let parentOffset = 0; // Remove with feature gate: platform_editor_r18_fix_selection_resync
     let selectionBookmark;
-    let parentOffset = 0;
     let mutationsIgnored = false;
 
     // move the contentDOM node inside the inner reference after rendering
     if (node && contentDOM && !node.contains(contentDOM)) {
-      var _this$view$state$sele;
       // @ts-ignore - ignoreMutation may not be declared
       oldIgnoreMutation = this.ignoreMutation; // store ref to previous ignoreMutation
 
@@ -149,21 +149,40 @@ export default class ReactNodeView {
       }
 
       // ... and capture parent offset before DOM change
-      if (((_this$view$state$sele = this.view.state.selection) === null || _this$view$state$sele === void 0 ? void 0 : _this$view$state$sele.ranges.length) > 0) {
-        var _this$view$state$sele2, _this$view$state$sele3, _this$view$state$sele4;
-        parentOffset = (_this$view$state$sele2 = (_this$view$state$sele3 = this.view.state.selection) === null || _this$view$state$sele3 === void 0 ? void 0 : (_this$view$state$sele4 = _this$view$state$sele3.ranges[0].$from) === null || _this$view$state$sele4 === void 0 ? void 0 : _this$view$state$sele4.parentOffset) !== null && _this$view$state$sele2 !== void 0 ? _this$view$state$sele2 : 0;
+      if (!fg('platform_editor_r18_fix_selection_resync')) {
+        var _this$view$state$sele;
+        if (((_this$view$state$sele = this.view.state.selection) === null || _this$view$state$sele === void 0 ? void 0 : _this$view$state$sele.ranges.length) > 0) {
+          var _this$view$state$sele2, _this$view$state$sele3, _this$view$state$sele4;
+          parentOffset = (_this$view$state$sele2 = (_this$view$state$sele3 = this.view.state.selection) === null || _this$view$state$sele3 === void 0 ? void 0 : (_this$view$state$sele4 = _this$view$state$sele3.ranges[0].$from) === null || _this$view$state$sele4 === void 0 ? void 0 : _this$view$state$sele4.parentOffset) !== null && _this$view$state$sele2 !== void 0 ? _this$view$state$sele2 : 0;
+        }
       }
       node.appendChild(contentDOM);
+
+      // After the next frame:
       requestAnimationFrame(() => {
-        // Reset ignoreMutation after frame ....
+        // Restore the original mutation handler
         // @ts-ignore - this may not have been declared by implementing class
         this.ignoreMutation = oldIgnoreMutation;
 
-        // only trigger selection re-sync if the selection is not at the start of the
-        // node, and DOM mutations were ignored
-        if (selectionBookmark && mutationsIgnored && parentOffset > 0) {
-          // ... and dispatch expected selection state
-          this.view.dispatch(this.view.state.tr.setSelection(selectionBookmark.resolve(this.view.state.tr.doc)));
+        // Restore the selection only if:
+        // - We have a selection bookmark
+        // - Mutations were ignored during the table move
+        // - The bookmarked selection is different from the current selection.
+        if (selectionBookmark && mutationsIgnored) {
+          if (fg('platform_editor_r18_fix_selection_resync')) {
+            const resolvedSelection = selectionBookmark.resolve(this.view.state.tr.doc);
+            // Don't set the selection if it's the same as the current selection.
+            if (!resolvedSelection.eq(this.view.state.selection)) {
+              const tr = this.view.state.tr.setSelection(resolvedSelection);
+              tr.setMeta('source', 'ReactNodeView:_handleRef:selection-resync');
+              this.view.dispatch(tr);
+            }
+          } else {
+            if (parentOffset > 0) {
+              // ... and dispatch expected selection state
+              this.view.dispatch(this.view.state.tr.setSelection(selectionBookmark.resolve(this.view.state.tr.doc)));
+            }
+          }
         }
       });
     }

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

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

package/dist/esm/annotation/index.js

@@ -30,7 +30,6 @@ export var AnnotationUpdateEmitter = /*#__PURE__*/function (_EventEmitter) {
 
 // type ActionResult = { step: Step; doc: JSONDocNode } | false;
 
-// } & AnnotationByMatches)
 // | false;
 
 // ### Events

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 = "104.1.2";
+var packageVersion = "104.1.4";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

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

@@ -6,6 +6,7 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 /* eslint-disable @atlaskit/editor/no-re-export */
 
 import React from 'react';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { ACTION_SUBJECT, ACTION_SUBJECT_ID } from '../analytics';
 import { createDispatch } from '../event-dispatcher';
 import { ErrorBoundary } from '../ui/ErrorBoundary';
@@ -141,13 +142,12 @@ var ReactNodeView = /*#__PURE__*/function () {
       // Ignored via go/ees005
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
       var oldIgnoreMutation;
+      var parentOffset = 0; // Remove with feature gate: platform_editor_r18_fix_selection_resync
       var selectionBookmark;
-      var parentOffset = 0;
       var mutationsIgnored = false;
 
       // move the contentDOM node inside the inner reference after rendering
       if (node && contentDOM && !node.contains(contentDOM)) {
-        var _this$view$state$sele;
         // @ts-ignore - ignoreMutation may not be declared
         oldIgnoreMutation = this.ignoreMutation; // store ref to previous ignoreMutation
 
@@ -168,21 +168,40 @@ var ReactNodeView = /*#__PURE__*/function () {
         }
 
         // ... and capture parent offset before DOM change
-        if (((_this$view$state$sele = this.view.state.selection) === null || _this$view$state$sele === void 0 ? void 0 : _this$view$state$sele.ranges.length) > 0) {
-          var _this$view$state$sele2, _this$view$state$sele3;
-          parentOffset = (_this$view$state$sele2 = (_this$view$state$sele3 = this.view.state.selection) === null || _this$view$state$sele3 === void 0 || (_this$view$state$sele3 = _this$view$state$sele3.ranges[0].$from) === null || _this$view$state$sele3 === void 0 ? void 0 : _this$view$state$sele3.parentOffset) !== null && _this$view$state$sele2 !== void 0 ? _this$view$state$sele2 : 0;
+        if (!fg('platform_editor_r18_fix_selection_resync')) {
+          var _this$view$state$sele;
+          if (((_this$view$state$sele = this.view.state.selection) === null || _this$view$state$sele === void 0 ? void 0 : _this$view$state$sele.ranges.length) > 0) {
+            var _this$view$state$sele2, _this$view$state$sele3;
+            parentOffset = (_this$view$state$sele2 = (_this$view$state$sele3 = this.view.state.selection) === null || _this$view$state$sele3 === void 0 || (_this$view$state$sele3 = _this$view$state$sele3.ranges[0].$from) === null || _this$view$state$sele3 === void 0 ? void 0 : _this$view$state$sele3.parentOffset) !== null && _this$view$state$sele2 !== void 0 ? _this$view$state$sele2 : 0;
+          }
         }
         node.appendChild(contentDOM);
+
+        // After the next frame:
         requestAnimationFrame(function () {
-          // Reset ignoreMutation after frame ....
+          // Restore the original mutation handler
           // @ts-ignore - this may not have been declared by implementing class
           _this4.ignoreMutation = oldIgnoreMutation;
 
-          // only trigger selection re-sync if the selection is not at the start of the
-          // node, and DOM mutations were ignored
-          if (selectionBookmark && mutationsIgnored && parentOffset > 0) {
-            // ... and dispatch expected selection state
-            _this4.view.dispatch(_this4.view.state.tr.setSelection(selectionBookmark.resolve(_this4.view.state.tr.doc)));
+          // Restore the selection only if:
+          // - We have a selection bookmark
+          // - Mutations were ignored during the table move
+          // - The bookmarked selection is different from the current selection.
+          if (selectionBookmark && mutationsIgnored) {
+            if (fg('platform_editor_r18_fix_selection_resync')) {
+              var resolvedSelection = selectionBookmark.resolve(_this4.view.state.tr.doc);
+              // Don't set the selection if it's the same as the current selection.
+              if (!resolvedSelection.eq(_this4.view.state.selection)) {
+                var tr = _this4.view.state.tr.setSelection(resolvedSelection);
+                tr.setMeta('source', 'ReactNodeView:_handleRef:selection-resync');
+                _this4.view.dispatch(tr);
+              }
+            } else {
+              if (parentOffset > 0) {
+                // ... and dispatch expected selection state
+                _this4.view.dispatch(_this4.view.state.tr.setSelection(selectionBookmark.resolve(_this4.view.state.tr.doc)));
+              }
+            }
           }
         });
       }

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 = "104.1.2";
+var packageVersion = "104.1.4";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 // Ignored via go/ees005

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

@@ -4,7 +4,7 @@
 import { EventEmitter } from 'events';
 import type { AnnotationId } from '@atlaskit/adf-schema';
 import type { JSONDocNode } from '@atlaskit/editor-json-transformer';
-import type { Step } from '@atlaskit/editor-prosemirror/transform';
+import type { AddNodeMarkStep, AddMarkStep } from '@atlaskit/editor-prosemirror/transform';
 export type UpdateEvent = 'create' | 'delete' | 'resolve' | 'unresolve' | 'setselectedannotation' | 'sethoveredannotation' | 'removehoveredannotation' | 'closeinlinecomment';
 export type VisibilityEvent = 'setvisibility';
 type AnnotationCallback = (params: string) => void;
@@ -14,13 +14,19 @@ export declare class AnnotationUpdateEmitter extends EventEmitter {
     on(event: UpdateEvent, listener: (annotationId: string) => void): this;
     off(event: string, listener: AnnotationCallback | VisibilityCallback): this;
 }
-type ActionResult = {
-    step: Step;
+type AnnotationByMatches = {
+    originalSelection: string;
+    numMatches: number;
+    matchIndex: number;
+    pos?: number;
+};
+export type ActionResult = {
+    step: AddMarkStep | AddNodeMarkStep;
     doc: JSONDocNode;
     /** The list of types of all inline nodes, which were wrapped by annotation. */
     inlineNodeTypes?: string[];
     targetNodeType?: string;
-};
+} & AnnotationByMatches;
 export type AnnotationDraftStartedData = {
     targetElement: HTMLElement | undefined;
     /**
@@ -64,6 +70,11 @@ export type ApplyDraftResult = {
 } | {
     success: true;
     targetElement: HTMLElement | undefined;
+    /**
+     * The actionResult will be set if the id passed to the applyDraft method is different from the id created
+     * from the startDraft call.
+     */
+    actionResult: ActionResult | undefined;
 };
 export type GetDraftResult = {
     success: false;
@@ -99,7 +110,21 @@ export type AnnotationManagerMethods = {
     allowAnnotation: () => boolean;
     startDraft: () => StartDraftResult;
     clearDraft: () => ClearDraftResult;
+    /**
+     * This will apply the current draft to the document.
+     *
+     * If an id is passed, it will be used to apply the draft, it will
+     * also generate a new actionResult value if the passed id is different from the one returned from the startDraft method.
+     *
+     * @param id The id of the annotation to apply. Ideally the same as the one returned from the startDraft method.
+     * If the id is different, the actionResult will contain a step and document with the new id. Changing the id is discouraged
+     * as this creates different behaviour between the editor and renderer.
+     */
     applyDraft: (id: AnnotationId) => ApplyDraftResult;
+    /**
+     * This can be used to inspect the current active draft.
+     * @returns The current draft data. If the draft is not started, it will return an error.
+     */
     getDraft: () => GetDraftResult;
     setIsAnnotationSelected: (id: AnnotationId, isSelected: boolean) => SelectAnnotationResult;
     setIsAnnotationHovered: (id: AnnotationId, isHovered: boolean) => HoverAnnotationResult;
@@ -113,6 +138,7 @@ export type AnnotationManager = AnnotationManagerMethods & {
     setPreemptiveGate(handler: () => Promise<boolean>): AnnotationManager;
     /**
      * This method is used to run the configured preemptive gate check.
+     * @private
      * @internal
      */
     checkPreemptiveGate(): Promise<boolean>;
@@ -121,6 +147,7 @@ export type AnnotationManager = AnnotationManagerMethods & {
     onAnnotationSelectionChange(handler: (data: AnnotationSelectedChangeData) => void): AnnotationManager;
     offAnnotationSelectionChange(handler: (data: AnnotationSelectedChangeData) => void): AnnotationManager;
     /**
+     * @private
      * @internal
      * This method is intended for internal Platform use only. It is not intended for use by Product code.
      */
@@ -132,11 +159,13 @@ export type AnnotationManager = AnnotationManagerMethods & {
         data: AnnotationSelectedChangeData;
     }): AnnotationManager;
     /**
+     * @private
      * @internal
      * This method is intended for internal Platform use only. It is not intended for use by Product code.
      */
     hook<H extends keyof AnnotationManagerMethods>(method: H, handler: AnnotationManagerMethods[H]): AnnotationManager;
     /**
+     *
      * @internal
      * This method is intended for internal Platform use only. It is not intended for use by Product code.
      */

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

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import type { AnnotationId, AnnotationTypes } from '@atlaskit/adf-schema';
 import type { JSONDocNode } from '@atlaskit/editor-json-transformer';
-import type { Step } from '@atlaskit/editor-prosemirror/transform';
+import type { AddNodeMarkStep, AddMarkStep, Step } from '@atlaskit/editor-prosemirror/transform';
 import type { AnnotationManager } from '../../annotation';
 import type { AnnotationState, AnnotationUpdateEmitter } from './emitter';
 export type AnnotationByMatches = {
@@ -16,7 +16,7 @@ type ActionResult = {
     doc: JSONDocNode;
 } | false;
 export type AnnotationActionResult = ({
-    step: Step;
+    step: AddMarkStep | AddNodeMarkStep;
     doc: JSONDocNode;
     /** The list of types of all inline nodes, which were wrapped by annotation. */
     inlineNodeTypes?: string[];

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

@@ -4,7 +4,7 @@
 import { EventEmitter } from 'events';
 import type { AnnotationId } from '@atlaskit/adf-schema';
 import type { JSONDocNode } from '@atlaskit/editor-json-transformer';
-import type { Step } from '@atlaskit/editor-prosemirror/transform';
+import type { AddNodeMarkStep, AddMarkStep } from '@atlaskit/editor-prosemirror/transform';
 export type UpdateEvent = 'create' | 'delete' | 'resolve' | 'unresolve' | 'setselectedannotation' | 'sethoveredannotation' | 'removehoveredannotation' | 'closeinlinecomment';
 export type VisibilityEvent = 'setvisibility';
 type AnnotationCallback = (params: string) => void;
@@ -14,13 +14,19 @@ export declare class AnnotationUpdateEmitter extends EventEmitter {
     on(event: UpdateEvent, listener: (annotationId: string) => void): this;
     off(event: string, listener: AnnotationCallback | VisibilityCallback): this;
 }
-type ActionResult = {
-    step: Step;
+type AnnotationByMatches = {
+    originalSelection: string;
+    numMatches: number;
+    matchIndex: number;
+    pos?: number;
+};
+export type ActionResult = {
+    step: AddMarkStep | AddNodeMarkStep;
     doc: JSONDocNode;
     /** The list of types of all inline nodes, which were wrapped by annotation. */
     inlineNodeTypes?: string[];
     targetNodeType?: string;
-};
+} & AnnotationByMatches;
 export type AnnotationDraftStartedData = {
     targetElement: HTMLElement | undefined;
     /**
@@ -64,6 +70,11 @@ export type ApplyDraftResult = {
 } | {
     success: true;
     targetElement: HTMLElement | undefined;
+    /**
+     * The actionResult will be set if the id passed to the applyDraft method is different from the id created
+     * from the startDraft call.
+     */
+    actionResult: ActionResult | undefined;
 };
 export type GetDraftResult = {
     success: false;
@@ -99,7 +110,21 @@ export type AnnotationManagerMethods = {
     allowAnnotation: () => boolean;
     startDraft: () => StartDraftResult;
     clearDraft: () => ClearDraftResult;
+    /**
+     * This will apply the current draft to the document.
+     *
+     * If an id is passed, it will be used to apply the draft, it will
+     * also generate a new actionResult value if the passed id is different from the one returned from the startDraft method.
+     *
+     * @param id The id of the annotation to apply. Ideally the same as the one returned from the startDraft method.
+     * If the id is different, the actionResult will contain a step and document with the new id. Changing the id is discouraged
+     * as this creates different behaviour between the editor and renderer.
+     */
     applyDraft: (id: AnnotationId) => ApplyDraftResult;
+    /**
+     * This can be used to inspect the current active draft.
+     * @returns The current draft data. If the draft is not started, it will return an error.
+     */
     getDraft: () => GetDraftResult;
     setIsAnnotationSelected: (id: AnnotationId, isSelected: boolean) => SelectAnnotationResult;
     setIsAnnotationHovered: (id: AnnotationId, isHovered: boolean) => HoverAnnotationResult;
@@ -113,6 +138,7 @@ export type AnnotationManager = AnnotationManagerMethods & {
     setPreemptiveGate(handler: () => Promise<boolean>): AnnotationManager;
     /**
      * This method is used to run the configured preemptive gate check.
+     * @private
      * @internal
      */
     checkPreemptiveGate(): Promise<boolean>;
@@ -121,6 +147,7 @@ export type AnnotationManager = AnnotationManagerMethods & {
     onAnnotationSelectionChange(handler: (data: AnnotationSelectedChangeData) => void): AnnotationManager;
     offAnnotationSelectionChange(handler: (data: AnnotationSelectedChangeData) => void): AnnotationManager;
     /**
+     * @private
      * @internal
      * This method is intended for internal Platform use only. It is not intended for use by Product code.
      */
@@ -132,11 +159,13 @@ export type AnnotationManager = AnnotationManagerMethods & {
         data: AnnotationSelectedChangeData;
     }): AnnotationManager;
     /**
+     * @private
      * @internal
      * This method is intended for internal Platform use only. It is not intended for use by Product code.
      */
     hook<H extends keyof AnnotationManagerMethods>(method: H, handler: AnnotationManagerMethods[H]): AnnotationManager;
     /**
+     *
      * @internal
      * This method is intended for internal Platform use only. It is not intended for use by Product code.
      */

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

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import type { AnnotationId, AnnotationTypes } from '@atlaskit/adf-schema';
 import type { JSONDocNode } from '@atlaskit/editor-json-transformer';
-import type { Step } from '@atlaskit/editor-prosemirror/transform';
+import type { AddNodeMarkStep, AddMarkStep, Step } from '@atlaskit/editor-prosemirror/transform';
 import type { AnnotationManager } from '../../annotation';
 import type { AnnotationState, AnnotationUpdateEmitter } from './emitter';
 export type AnnotationByMatches = {
@@ -16,7 +16,7 @@ type ActionResult = {
     doc: JSONDocNode;
 } | false;
 export type AnnotationActionResult = ({
-    step: Step;
+    step: AddMarkStep | AddNodeMarkStep;
     doc: JSONDocNode;
     /** The list of types of all inline nodes, which were wrapped by annotation. */
     inlineNodeTypes?: string[];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "104.1.2",
+	"version": "104.1.4",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -157,7 +157,7 @@
 		"@atlaskit/platform-feature-flags-react": "^0.2.0",
 		"@atlaskit/popper": "^7.0.0",
 		"@atlaskit/primitives": "^14.7.0",
-		"@atlaskit/profilecard": "^23.10.0",
+		"@atlaskit/profilecard": "^23.11.0",
 		"@atlaskit/react-ufo": "^3.10.0",
 		"@atlaskit/section-message": "^8.2.0",
 		"@atlaskit/smart-card": "^37.1.0",
@@ -378,6 +378,9 @@
 		},
 		"platform_editor_controls_patch_analytics": {
 			"type": "boolean"
+		},
+		"platform_editor_r18_fix_selection_resync": {
+			"type": "boolean"
 		}
 	}
 }