@atlaskit/editor-plugin-annotation 10.2.4 → 10.3.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @atlaskit/editor-plugin-annotation
 
+## 10.3.0
+
+### Minor Changes
+
+- [`6fc4feadf6433`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/6fc4feadf6433) -
+  Add optional onCreateError() to InlineCommentCreateComponentProps type
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 10.2.4
 
 ### Patch Changes

package/dist/cjs/ui/InlineCommentView.js

@@ -134,6 +134,15 @@ function InlineCommentView(_ref) {
       }
       // eslint-disable-next-line @atlassian/perf-linting/no-unstable-inline-props -- Ignored via go/ees017 (to be fixed)
       ,
+      onCreateError: function onCreateError(id) {
+        return (
+          // This is called when optimistic create inline comment encounters an error,
+          // in which case the optimistically added annotation must be removed.
+          (0, _editorCommands.removeInlineCommentNearSelection)(id, inlineCommentProvider.supportedBlockNodes)(editorView.state, editorView.dispatch)
+        );
+      }
+      // eslint-disable-next-line @atlassian/perf-linting/no-unstable-inline-props -- Ignored via go/ees017 (to be fixed)
+      ,
       onClose: function onClose() {
         if (!isAnnotationManagerEnabled) {
           (0, _editorCommands.setInlineCommentDraftState)(editorAnalyticsAPI, undefined, editorAPI)(false)(editorView.state, editorView.dispatch);

package/dist/es2019/ui/InlineCommentView.js

@@ -134,6 +134,12 @@ export function InlineCommentView({
       }
       // eslint-disable-next-line @atlassian/perf-linting/no-unstable-inline-props -- Ignored via go/ees017 (to be fixed)
       ,
+      onCreateError: id =>
+      // This is called when optimistic create inline comment encounters an error,
+      // in which case the optimistically added annotation must be removed.
+      removeInlineCommentNearSelection(id, inlineCommentProvider.supportedBlockNodes)(editorView.state, editorView.dispatch)
+      // eslint-disable-next-line @atlassian/perf-linting/no-unstable-inline-props -- Ignored via go/ees017 (to be fixed)
+      ,
       onClose: () => {
         if (!isAnnotationManagerEnabled) {
           setInlineCommentDraftState(editorAnalyticsAPI, undefined, editorAPI)(false)(editorView.state, editorView.dispatch);

package/dist/esm/ui/InlineCommentView.js

@@ -127,6 +127,15 @@ export function InlineCommentView(_ref) {
       }
       // eslint-disable-next-line @atlassian/perf-linting/no-unstable-inline-props -- Ignored via go/ees017 (to be fixed)
       ,
+      onCreateError: function onCreateError(id) {
+        return (
+          // This is called when optimistic create inline comment encounters an error,
+          // in which case the optimistically added annotation must be removed.
+          removeInlineCommentNearSelection(id, inlineCommentProvider.supportedBlockNodes)(editorView.state, editorView.dispatch)
+        );
+      }
+      // eslint-disable-next-line @atlassian/perf-linting/no-unstable-inline-props -- Ignored via go/ees017 (to be fixed)
+      ,
       onClose: function onClose() {
         if (!isAnnotationManagerEnabled) {
           setInlineCommentDraftState(editorAnalyticsAPI, undefined, editorAPI)(false)(editorView.state, editorView.dispatch);

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

@@ -44,6 +44,10 @@ export type InlineCommentCreateComponentProps = AnnotationComponentProps & {
      * Creates an annotation mark in the document with the given id.
      */
     onCreate: (id: string) => void;
+    /**
+     * Deletes an annotation mark in the document with the given id.
+     */
+    onCreateError?: (id: string) => void;
 };
 export type InlineCommentViewComponentProps = AnnotationComponentProps & {
     /**

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

@@ -44,6 +44,10 @@ export type InlineCommentCreateComponentProps = AnnotationComponentProps & {
      * Creates an annotation mark in the document with the given id.
      */
     onCreate: (id: string) => void;
+    /**
+     * Deletes an annotation mark in the document with the given id.
+     */
+    onCreateError?: (id: string) => void;
 };
 export type InlineCommentViewComponentProps = AnnotationComponentProps & {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-annotation",
-	"version": "10.2.4",
+	"version": "10.3.0",
 	"description": "Annotation plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -43,7 +43,7 @@
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^114.26.0",
+		"@atlaskit/editor-common": "^114.27.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0",
 		"react-intl": "^5.25.1 || ^6.0.0 || ^7.0.0"