@atlaskit/editor-common 128.2.0 → 128.3.0

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @atlaskit/editor-common
 
+## 128.3.0
+
+### Minor Changes
+
+- [`faf42b91fb5b1`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/faf42b91fb5b1) -
+  Extend the `AnnotationManager` API ahead of media (block node) annotation support and the
+  Confluence comments migration. Types and manager plumbing only — the hooks behind these methods
+  land with the editor and renderer changes.
+  - `startDraft` takes an optional `localId`, so a draft can target a block node instead of the
+    current text selection. `StartDraftResult` gains an `invalid-localId` failure reason.
+  - New `clearSelectedAnnotation()` and `clearHoveredAnnotation()`: clear the selection or hover
+    without the caller having to track which annotation id is active. Both return the id they
+    cleared (`undefined` when nothing was active); `clearSelectedAnnotation` fails with
+    `draft-in-progress` while a draft is open.
+  - `AnnotationDraftStartedData` gains `targetNodeType`, and `AnnotationSelectedChangeData` gains
+    `targetNodeType` and `viewMethod`.
+  - `draftAnnotationCleared` is now subscribable via `onDraftAnnotationCleared` /
+    `offDraftAnnotationCleared`.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 128.2.0
 
 ### Minor Changes

package/dist/cjs/annotation/manager.js

@@ -74,6 +74,18 @@ var SharedAnnotationManager = exports.SharedAnnotationManager = /*#__PURE__*/fun
       this.emitter.off('annotationSelectionChanged', handler);
       return this;
     }
+  }, {
+    key: "onDraftAnnotationCleared",
+    value: function onDraftAnnotationCleared(handler) {
+      this.emitter.on('draftAnnotationCleared', handler);
+      return this;
+    }
+  }, {
+    key: "offDraftAnnotationCleared",
+    value: function offDraftAnnotationCleared(handler) {
+      this.emitter.off('draftAnnotationCleared', handler);
+      return this;
+    }
   }, {
     key: "emit",
     value: function emit(event) {
@@ -110,7 +122,7 @@ var SharedAnnotationManager = exports.SharedAnnotationManager = /*#__PURE__*/fun
     }
   }, {
     key: "startDraft",
-    value: function startDraft() {
+    value: function startDraft(localId) {
       var fn = this.hooks.get('startDraft');
       if (!fn) {
         return {
@@ -119,7 +131,7 @@ var SharedAnnotationManager = exports.SharedAnnotationManager = /*#__PURE__*/fun
         };
       }
       try {
-        return fn();
+        return fn(localId);
       } catch (_unused2) {
         return {
           success: false,
@@ -244,5 +256,43 @@ var SharedAnnotationManager = exports.SharedAnnotationManager = /*#__PURE__*/fun
         };
       }
     }
+  }, {
+    key: "clearSelectedAnnotation",
+    value: function clearSelectedAnnotation() {
+      var fn = this.hooks.get('clearSelectedAnnotation');
+      if (!fn) {
+        return {
+          success: false,
+          reason: 'manager-not-initialized'
+        };
+      }
+      try {
+        return fn();
+      } catch (_unused9) {
+        return {
+          success: false,
+          reason: 'hook-execution-error'
+        };
+      }
+    }
+  }, {
+    key: "clearHoveredAnnotation",
+    value: function clearHoveredAnnotation() {
+      var fn = this.hooks.get('clearHoveredAnnotation');
+      if (!fn) {
+        return {
+          success: false,
+          reason: 'manager-not-initialized'
+        };
+      }
+      try {
+        return fn();
+      } catch (_unused0) {
+        return {
+          success: false,
+          reason: 'hook-execution-error'
+        };
+      }
+    }
   }]);
 }();

package/dist/cjs/monitoring/error.js

@@ -27,7 +27,7 @@ var NETWORK_FAILURE_REGEX = /^network failure/i;
 var RESIZE_OBSERVER_LOOP_REGEX = /ResizeObserver loop completed with undelivered notifications/;
 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 = "128.1.0";
+var packageVersion = "128.2.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

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

@@ -24,7 +24,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 = "128.1.0";
+var packageVersion = "128.2.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var fadeIn = (0, _react2.keyframes)({

package/dist/es2019/annotation/manager.js

@@ -49,6 +49,14 @@ export class SharedAnnotationManager {
     this.emitter.off('annotationSelectionChanged', handler);
     return this;
   }
+  onDraftAnnotationCleared(handler) {
+    this.emitter.on('draftAnnotationCleared', handler);
+    return this;
+  }
+  offDraftAnnotationCleared(handler) {
+    this.emitter.off('draftAnnotationCleared', handler);
+    return this;
+  }
   emit(event) {
     this.emitter.emit(event.name, 'data' in event ? event.data : undefined);
     return this;
@@ -75,7 +83,7 @@ export class SharedAnnotationManager {
       return false;
     }
   }
-  startDraft() {
+  startDraft(localId) {
     const fn = this.hooks.get('startDraft');
     if (!fn) {
       return {
@@ -84,7 +92,7 @@ export class SharedAnnotationManager {
       };
     }
     try {
-      return fn();
+      return fn(localId);
     } catch {
       return {
         success: false,
@@ -197,4 +205,38 @@ export class SharedAnnotationManager {
       };
     }
   }
+  clearSelectedAnnotation() {
+    const fn = this.hooks.get('clearSelectedAnnotation');
+    if (!fn) {
+      return {
+        success: false,
+        reason: 'manager-not-initialized'
+      };
+    }
+    try {
+      return fn();
+    } catch {
+      return {
+        success: false,
+        reason: 'hook-execution-error'
+      };
+    }
+  }
+  clearHoveredAnnotation() {
+    const fn = this.hooks.get('clearHoveredAnnotation');
+    if (!fn) {
+      return {
+        success: false,
+        reason: 'manager-not-initialized'
+      };
+    }
+    try {
+      return fn();
+    } catch {
+      return {
+        success: false,
+        reason: 'hook-execution-error'
+      };
+    }
+  }
 }

package/dist/es2019/monitoring/error.js

@@ -13,7 +13,7 @@ const NETWORK_FAILURE_REGEX = /^network failure/i;
 const RESIZE_OBSERVER_LOOP_REGEX = /ResizeObserver loop completed with undelivered notifications/;
 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 = "128.1.0";
+const packageVersion = "128.2.0";
 const sanitiseSentryEvents = (data, _hint) => {
   // Remove URL as it has UGC
   // Ignored via go/ees007

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

@@ -14,7 +14,7 @@ import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
 import { fg } from '@atlaskit/platform-feature-flags/fg';
 import Layer from '../Layer';
 const packageName = "@atlaskit/editor-common";
-const packageVersion = "128.1.0";
+const packageVersion = "128.2.0";
 const halfFocusRing = 1;
 const dropOffset = '0, 8';
 const fadeIn = keyframes({

package/dist/esm/annotation/manager.js

@@ -67,6 +67,18 @@ export var SharedAnnotationManager = /*#__PURE__*/function () {
       this.emitter.off('annotationSelectionChanged', handler);
       return this;
     }
+  }, {
+    key: "onDraftAnnotationCleared",
+    value: function onDraftAnnotationCleared(handler) {
+      this.emitter.on('draftAnnotationCleared', handler);
+      return this;
+    }
+  }, {
+    key: "offDraftAnnotationCleared",
+    value: function offDraftAnnotationCleared(handler) {
+      this.emitter.off('draftAnnotationCleared', handler);
+      return this;
+    }
   }, {
     key: "emit",
     value: function emit(event) {
@@ -103,7 +115,7 @@ export var SharedAnnotationManager = /*#__PURE__*/function () {
     }
   }, {
     key: "startDraft",
-    value: function startDraft() {
+    value: function startDraft(localId) {
       var fn = this.hooks.get('startDraft');
       if (!fn) {
         return {
@@ -112,7 +124,7 @@ export var SharedAnnotationManager = /*#__PURE__*/function () {
         };
       }
       try {
-        return fn();
+        return fn(localId);
       } catch (_unused2) {
         return {
           success: false,
@@ -237,5 +249,43 @@ export var SharedAnnotationManager = /*#__PURE__*/function () {
         };
       }
     }
+  }, {
+    key: "clearSelectedAnnotation",
+    value: function clearSelectedAnnotation() {
+      var fn = this.hooks.get('clearSelectedAnnotation');
+      if (!fn) {
+        return {
+          success: false,
+          reason: 'manager-not-initialized'
+        };
+      }
+      try {
+        return fn();
+      } catch (_unused9) {
+        return {
+          success: false,
+          reason: 'hook-execution-error'
+        };
+      }
+    }
+  }, {
+    key: "clearHoveredAnnotation",
+    value: function clearHoveredAnnotation() {
+      var fn = this.hooks.get('clearHoveredAnnotation');
+      if (!fn) {
+        return {
+          success: false,
+          reason: 'manager-not-initialized'
+        };
+      }
+      try {
+        return fn();
+      } catch (_unused0) {
+        return {
+          success: false,
+          reason: 'hook-execution-error'
+        };
+      }
+    }
   }]);
 }();

package/dist/esm/monitoring/error.js

@@ -19,7 +19,7 @@ var NETWORK_FAILURE_REGEX = /^network failure/i;
 var RESIZE_OBSERVER_LOOP_REGEX = /ResizeObserver loop completed with undelivered notifications/;
 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 = "128.1.0";
+var packageVersion = "128.2.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

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

@@ -21,7 +21,7 @@ import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
 import { fg } from '@atlaskit/platform-feature-flags/fg';
 import Layer from '../Layer';
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "128.1.0";
+var packageVersion = "128.2.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var fadeIn = keyframes({

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

@@ -41,11 +41,17 @@ export type AnnotationDraftStartedData = {
      */
     inlineNodeTypes: string[];
     targetElement: HTMLElement | undefined;
+    /** The type of the node the draft targets, e.g. `'media'`. Undefined for an inline text draft. */
+    targetNodeType?: string;
 };
 export type AnnotationSelectedChangeData = {
     annotationId: AnnotationId;
     inlineNodeTypes: string[];
     isSelected: boolean;
+    /** The type of the node the annotation is on, e.g. `'media'`. Undefined for inline text. */
+    targetNodeType?: string;
+    /** How the annotation came to be selected, for analytics parity with the surface events. */
+    viewMethod?: string;
 };
 export type AnnotationManagerEvents = {
     data: AnnotationDraftStartedData;
@@ -58,7 +64,7 @@ export type AnnotationManagerEvents = {
 };
 export type ManagerFailureReasons = 'manager-not-initialized' | 'hook-execution-error';
 export type StartDraftResult = {
-    reason: ManagerFailureReasons | 'invalid-range' | 'draft-in-progress';
+    reason: ManagerFailureReasons | 'invalid-range' | 'draft-in-progress' | 'invalid-localId';
     success: false;
 } | ({
     success: true;
@@ -108,6 +114,20 @@ export type HoverAnnotationResult = {
     isHovered: boolean;
     success: true;
 };
+export type ClearSelectedAnnotationResult = {
+    reason: ManagerFailureReasons | 'draft-in-progress';
+    success: false;
+} | {
+    annotationId: AnnotationId | undefined;
+    success: true;
+};
+export type ClearHoveredAnnotationResult = {
+    reason: ManagerFailureReasons;
+    success: false;
+} | {
+    annotationId: AnnotationId | undefined;
+    success: true;
+};
 /**
  * This is the list of methods which exist on the Manager interface. These are the methods that can be hooked into.
  */
@@ -126,6 +146,17 @@ export type AnnotationManagerMethods = {
     applyDraft: (id: AnnotationId) => ApplyDraftResult;
     clearAnnotation: (id: AnnotationId) => ClearAnnotationResult;
     clearDraft: () => ClearDraftResult;
+    /**
+     * Clears the hover state without needing to know which annotation is hovered.
+     * @returns The annotation that was hovered, or undefined when nothing was.
+     */
+    clearHoveredAnnotation: () => ClearHoveredAnnotationResult;
+    /**
+     * Deselects the selected annotation without needing to know which one it is, for surfaces
+     * outside the document (the comments panel, the comment button) that only want to clear it.
+     * @returns The annotation that was selected, or undefined when nothing was.
+     */
+    clearSelectedAnnotation: () => ClearSelectedAnnotationResult;
     /**
      * 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.
@@ -133,7 +164,14 @@ export type AnnotationManagerMethods = {
     getDraft: () => GetDraftResult;
     setIsAnnotationHovered: (id: AnnotationId, isHovered: boolean) => HoverAnnotationResult;
     setIsAnnotationSelected: (id: AnnotationId, isSelected: boolean) => SelectAnnotationResult;
-    startDraft: () => StartDraftResult;
+    /**
+     * Starts a draft annotation.
+     *
+     * @param localId Targets the block node with this `localId`, resolving to its closest
+     * annotatable ancestor when the node itself does not accept annotations. Without it the draft
+     * targets the current text selection.
+     */
+    startDraft: (localId?: string) => StartDraftResult;
 };
 export type AnnotationManager = AnnotationManagerMethods & {
     /**
@@ -163,8 +201,11 @@ export type AnnotationManager = AnnotationManagerMethods & {
      */
     hook: <H extends keyof AnnotationManagerMethods>(method: H, handler: AnnotationManagerMethods[H]) => AnnotationManager;
     offAnnotationSelectionChange: (handler: (data: AnnotationSelectedChangeData) => void) => AnnotationManager;
+    offDraftAnnotationCleared: (handler: () => void) => AnnotationManager;
     offDraftAnnotationStarted: (handler: (data: AnnotationDraftStartedData) => void) => AnnotationManager;
     onAnnotationSelectionChange: (handler: (data: AnnotationSelectedChangeData) => void) => AnnotationManager;
+    /** Subscribe to `draftAnnotationCleared`, fired when an in-progress draft is discarded. */
+    onDraftAnnotationCleared: (handler: () => void) => AnnotationManager;
     onDraftAnnotationStarted: (handler: (data: AnnotationDraftStartedData) => void) => AnnotationManager;
     /**
      * This method is used to set a preemptive gate. A preemptive gate is a function that will be called

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

@@ -1,5 +1,5 @@
 import type { AnnotationId } from '@atlaskit/adf-schema/annotation';
-import type { AnnotationDraftStartedData, AnnotationManager, AnnotationManagerEvents, AnnotationManagerMethods, AnnotationSelectedChangeData, ApplyDraftResult, ClearAnnotationResult, ClearDraftResult, GetDraftResult, HoverAnnotationResult, SelectAnnotationResult, StartDraftResult } from './index';
+import type { AnnotationDraftStartedData, AnnotationManager, AnnotationManagerEvents, AnnotationManagerMethods, AnnotationSelectedChangeData, ApplyDraftResult, ClearAnnotationResult, ClearDraftResult, ClearHoveredAnnotationResult, ClearSelectedAnnotationResult, GetDraftResult, HoverAnnotationResult, SelectAnnotationResult, StartDraftResult } from './index';
 export declare class SharedAnnotationManager implements AnnotationManager {
     /**
      * This is the event emitter that is used to emit events from the manager. It is used to communicate with
@@ -19,15 +19,19 @@ export declare class SharedAnnotationManager implements AnnotationManager {
     offDraftAnnotationStarted(handler: (data: AnnotationDraftStartedData) => void): AnnotationManager;
     onAnnotationSelectionChange(handler: (data: AnnotationSelectedChangeData) => void): AnnotationManager;
     offAnnotationSelectionChange(handler: (data: AnnotationSelectedChangeData) => void): AnnotationManager;
+    onDraftAnnotationCleared(handler: () => void): AnnotationManager;
+    offDraftAnnotationCleared(handler: () => void): AnnotationManager;
     emit(event: AnnotationManagerEvents): AnnotationManager;
     hook<H extends keyof AnnotationManagerMethods>(method: H, handler: AnnotationManagerMethods[H]): AnnotationManager;
     unhook<H extends keyof AnnotationManagerMethods>(method: H, handler: AnnotationManagerMethods[H]): AnnotationManager;
     allowAnnotation(): boolean;
-    startDraft(): StartDraftResult;
+    startDraft(localId?: string): StartDraftResult;
     clearDraft(): ClearDraftResult;
     applyDraft(id: AnnotationId): ApplyDraftResult;
     getDraft(): GetDraftResult;
     setIsAnnotationSelected(id: string, isSelected: boolean): SelectAnnotationResult;
     setIsAnnotationHovered(id: string, isHovered: boolean): HoverAnnotationResult;
     clearAnnotation(id: AnnotationId): ClearAnnotationResult;
+    clearSelectedAnnotation(): ClearSelectedAnnotationResult;
+    clearHoveredAnnotation(): ClearHoveredAnnotationResult;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "128.2.0",
+	"version": "128.3.0",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -85,8 +85,8 @@
 		"@atlaskit/task-decision": "^21.12.0",
 		"@atlaskit/teams-app-config": "^3.1.0",
 		"@atlaskit/textfield": "^10.2.0",
-		"@atlaskit/tmp-editor-statsig": "^221.0.0",
-		"@atlaskit/tokens": "^20.2.0",
+		"@atlaskit/tmp-editor-statsig": "^222.0.0",
+		"@atlaskit/tokens": "^20.3.0",
 		"@atlaskit/tooltip": "^24.4.0",
 		"@atlaskit/width-detector": "^7.2.0",
 		"@babel/runtime": "^7.0.0",