@atlaskit/editor-plugin-mentions 2.4.1 → 2.5.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-plugin-mentions
 
+## 2.5.0
+
+### Minor Changes
+
+- [#133315](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/133315)
+  [`5c94ca338de14`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/5c94ca338de14) -
+  Updating mentions plugin config for handling deleted mentions and refactor
+
 ## 2.4.1
 
 ### Patch Changes

package/dist/cjs/plugin.js

@@ -39,7 +39,7 @@ var mentionsPlugin = exports.mentionsPlugin = function mentionsPlugin(_ref) {
     sanitizePrivateContent: options === null || options === void 0 ? void 0 : options.sanitizePrivateContent,
     mentionInsertDisplayName: options === null || options === void 0 ? void 0 : options.insertDisplayName,
     HighlightComponent: options === null || options === void 0 ? void 0 : options.HighlightComponent,
-    handleMentionsInserted: options === null || options === void 0 ? void 0 : options.handleMentionsInserted,
+    handleMentionsChanged: options === null || options === void 0 ? void 0 : options.handleMentionsChanged,
     fireEvent: fireEvent,
     api: api
   });
@@ -77,9 +77,9 @@ var mentionsPlugin = exports.mentionsPlugin = function mentionsPlugin(_ref) {
           inputMethod: inputMethod
         }));
       },
-      announceMentionsInsertion: function announceMentionsInsertion(mentionIds) {
-        if (options !== null && options !== void 0 && options.handleMentionsInserted) {
-          options.handleMentionsInserted(mentionIds);
+      announceMentionsInsertion: function announceMentionsInsertion(mentionChanges) {
+        if (options !== null && options !== void 0 && options.handleMentionsChanged) {
+          options.handleMentionsChanged(mentionChanges);
         }
       }
     },

package/dist/cjs/pm-plugins/main.js

@@ -8,10 +8,12 @@ exports.createMentionPlugin = createMentionPlugin;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _reactNodeView = require("@atlaskit/editor-common/react-node-view");
 var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
+var _utils = require("@atlaskit/editor-prosemirror/utils");
 var _resource = require("@atlaskit/mention/resource");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _mention = require("../nodeviews/mention");
 var _key = require("./key");
-var _utils = require("./utils");
+var _utils2 = require("./utils");
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 var ACTIONS = {
@@ -41,7 +43,7 @@ function createMentionPlugin(pmPluginFactoryParams, fireEvent, options) {
     key: _key.mentionPluginKey,
     state: {
       init: function init(_, state) {
-        var canInsertMention = (0, _utils.canMentionBeCreatedInRange)(state.selection.from, state.selection.to)(state);
+        var canInsertMention = (0, _utils2.canMentionBeCreatedInRange)(state.selection.from, state.selection.to)(state);
         return {
           canInsertMention: canInsertMention
         };
@@ -58,7 +60,7 @@ function createMentionPlugin(pmPluginFactoryParams, fireEvent, options) {
         var hasPositionChanged = oldState.selection.from !== newState.selection.from || oldState.selection.to !== newState.selection.to;
         if (tr.docChanged || tr.selectionSet && hasPositionChanged) {
           newPluginState = _objectSpread(_objectSpread({}, pluginState), {}, {
-            canInsertMention: (0, _utils.canMentionBeCreatedInRange)(newState.selection.from, newState.selection.to)(newState)
+            canInsertMention: (0, _utils2.canMentionBeCreatedInRange)(newState.selection.from, newState.selection.to)(newState)
           });
           hasNewPluginState = true;
         }
@@ -118,6 +120,33 @@ function createMentionPlugin(pmPluginFactoryParams, fireEvent, options) {
           if (mentionProvider) {
             mentionProvider.unsubscribe('mentionPlugin');
           }
+        },
+        update: function update(view, prevState) {
+          var newState = view.state;
+          if (options !== null && options !== void 0 && options.handleMentionsChanged && (0, _platformFeatureFlags.fg)('confluence_updated_mentions_livepages')) {
+            var mentionSchema = newState.schema.nodes.mention;
+            var mentionNodesBefore = (0, _utils.findChildrenByType)(prevState.doc, mentionSchema);
+            var mentionLocalIdsAfter = new Set((0, _utils.findChildrenByType)(newState.doc, mentionSchema).map(function (_ref2) {
+              var node = _ref2.node;
+              return node.attrs.localId;
+            }));
+            if (mentionNodesBefore.length > mentionLocalIdsAfter.size) {
+              var deletedMentions = mentionNodesBefore.filter(function (_ref3) {
+                var node = _ref3.node;
+                return !mentionLocalIdsAfter.has(node.attrs.localId);
+              }).map(function (_ref4) {
+                var node = _ref4.node;
+                return {
+                  type: 'deleted',
+                  id: node.attrs.id,
+                  localId: node.attrs.localId
+                };
+              });
+              if (deletedMentions.length > 0) {
+                options.handleMentionsChanged(deletedMentions);
+              }
+            }
+          }
         }
       };
     }

package/dist/cjs/type-ahead/index.js

@@ -198,7 +198,7 @@ var createTypeAheadConfig = exports.createTypeAheadConfig = function createTypeA
     fireEvent = _ref6.fireEvent,
     HighlightComponent = _ref6.HighlightComponent,
     api = _ref6.api,
-    handleMentionsInserted = _ref6.handleMentionsInserted;
+    handleMentionsChanged = _ref6.handleMentionsChanged;
   var sessionId = (0, _uuid.default)();
   var firstQueryWithoutResults = null;
   var subscriptionKeys = new Set();
@@ -319,8 +319,9 @@ var createTypeAheadConfig = exports.createTypeAheadConfig = function createTypeA
         }
       }
       var mentionLocalId = (0, _uuid.default)();
-      if (handleMentionsInserted) {
-        handleMentionsInserted([{
+      if (handleMentionsChanged) {
+        handleMentionsChanged([{
+          type: 'added',
           localId: mentionLocalId,
           id: id
         }]);

package/dist/es2019/plugin.js

@@ -31,7 +31,7 @@ const mentionsPlugin = ({
     sanitizePrivateContent: options === null || options === void 0 ? void 0 : options.sanitizePrivateContent,
     mentionInsertDisplayName: options === null || options === void 0 ? void 0 : options.insertDisplayName,
     HighlightComponent: options === null || options === void 0 ? void 0 : options.HighlightComponent,
-    handleMentionsInserted: options === null || options === void 0 ? void 0 : options.handleMentionsInserted,
+    handleMentionsChanged: options === null || options === void 0 ? void 0 : options.handleMentionsChanged,
     fireEvent,
     api
   });
@@ -68,9 +68,9 @@ const mentionsPlugin = ({
           inputMethod
         }));
       },
-      announceMentionsInsertion: mentionIds => {
-        if (options !== null && options !== void 0 && options.handleMentionsInserted) {
-          options.handleMentionsInserted(mentionIds);
+      announceMentionsInsertion: mentionChanges => {
+        if (options !== null && options !== void 0 && options.handleMentionsChanged) {
+          options.handleMentionsChanged(mentionChanges);
         }
       }
     },

package/dist/es2019/pm-plugins/main.js

@@ -1,6 +1,8 @@
 import { getInlineNodeViewProducer } from '@atlaskit/editor-common/react-node-view';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { findChildrenByType } from '@atlaskit/editor-prosemirror/utils';
 import { buildSliPayload, SLI_EVENT_TYPE, SMART_EVENT_TYPE } from '@atlaskit/mention/resource';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { MentionNodeView } from '../nodeviews/mention';
 import { mentionPluginKey } from './key';
 import { canMentionBeCreatedInRange } from './utils';
@@ -107,6 +109,30 @@ export function createMentionPlugin(pmPluginFactoryParams, fireEvent, options) {
           if (mentionProvider) {
             mentionProvider.unsubscribe('mentionPlugin');
           }
+        },
+        update(view, prevState) {
+          const newState = view.state;
+          if (options !== null && options !== void 0 && options.handleMentionsChanged && fg('confluence_updated_mentions_livepages')) {
+            const mentionSchema = newState.schema.nodes.mention;
+            const mentionNodesBefore = findChildrenByType(prevState.doc, mentionSchema);
+            const mentionLocalIdsAfter = new Set(findChildrenByType(newState.doc, mentionSchema).map(({
+              node
+            }) => node.attrs.localId));
+            if (mentionNodesBefore.length > mentionLocalIdsAfter.size) {
+              const deletedMentions = mentionNodesBefore.filter(({
+                node
+              }) => !mentionLocalIdsAfter.has(node.attrs.localId)).map(({
+                node
+              }) => ({
+                type: 'deleted',
+                id: node.attrs.id,
+                localId: node.attrs.localId
+              }));
+              if (deletedMentions.length > 0) {
+                options.handleMentionsChanged(deletedMentions);
+              }
+            }
+          }
         }
       };
     }

package/dist/es2019/type-ahead/index.js

@@ -174,7 +174,7 @@ export const createTypeAheadConfig = ({
   fireEvent,
   HighlightComponent,
   api,
-  handleMentionsInserted
+  handleMentionsChanged
 }) => {
   let sessionId = uuid();
   let firstQueryWithoutResults = null;
@@ -305,8 +305,9 @@ export const createTypeAheadConfig = ({
         }
       }
       const mentionLocalId = uuid();
-      if (handleMentionsInserted) {
-        handleMentionsInserted([{
+      if (handleMentionsChanged) {
+        handleMentionsChanged([{
+          type: 'added',
           localId: mentionLocalId,
           id: id
         }]);

package/dist/esm/plugin.js

@@ -32,7 +32,7 @@ var mentionsPlugin = function mentionsPlugin(_ref) {
     sanitizePrivateContent: options === null || options === void 0 ? void 0 : options.sanitizePrivateContent,
     mentionInsertDisplayName: options === null || options === void 0 ? void 0 : options.insertDisplayName,
     HighlightComponent: options === null || options === void 0 ? void 0 : options.HighlightComponent,
-    handleMentionsInserted: options === null || options === void 0 ? void 0 : options.handleMentionsInserted,
+    handleMentionsChanged: options === null || options === void 0 ? void 0 : options.handleMentionsChanged,
     fireEvent: fireEvent,
     api: api
   });
@@ -70,9 +70,9 @@ var mentionsPlugin = function mentionsPlugin(_ref) {
           inputMethod: inputMethod
         }));
       },
-      announceMentionsInsertion: function announceMentionsInsertion(mentionIds) {
-        if (options !== null && options !== void 0 && options.handleMentionsInserted) {
-          options.handleMentionsInserted(mentionIds);
+      announceMentionsInsertion: function announceMentionsInsertion(mentionChanges) {
+        if (options !== null && options !== void 0 && options.handleMentionsChanged) {
+          options.handleMentionsChanged(mentionChanges);
         }
       }
     },

package/dist/esm/pm-plugins/main.js

@@ -3,7 +3,9 @@ function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbol
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 import { getInlineNodeViewProducer } from '@atlaskit/editor-common/react-node-view';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { findChildrenByType } from '@atlaskit/editor-prosemirror/utils';
 import { buildSliPayload, SLI_EVENT_TYPE, SMART_EVENT_TYPE } from '@atlaskit/mention/resource';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { MentionNodeView } from '../nodeviews/mention';
 import { mentionPluginKey } from './key';
 import { canMentionBeCreatedInRange } from './utils';
@@ -111,6 +113,33 @@ export function createMentionPlugin(pmPluginFactoryParams, fireEvent, options) {
           if (mentionProvider) {
             mentionProvider.unsubscribe('mentionPlugin');
           }
+        },
+        update: function update(view, prevState) {
+          var newState = view.state;
+          if (options !== null && options !== void 0 && options.handleMentionsChanged && fg('confluence_updated_mentions_livepages')) {
+            var mentionSchema = newState.schema.nodes.mention;
+            var mentionNodesBefore = findChildrenByType(prevState.doc, mentionSchema);
+            var mentionLocalIdsAfter = new Set(findChildrenByType(newState.doc, mentionSchema).map(function (_ref2) {
+              var node = _ref2.node;
+              return node.attrs.localId;
+            }));
+            if (mentionNodesBefore.length > mentionLocalIdsAfter.size) {
+              var deletedMentions = mentionNodesBefore.filter(function (_ref3) {
+                var node = _ref3.node;
+                return !mentionLocalIdsAfter.has(node.attrs.localId);
+              }).map(function (_ref4) {
+                var node = _ref4.node;
+                return {
+                  type: 'deleted',
+                  id: node.attrs.id,
+                  localId: node.attrs.localId
+                };
+              });
+              if (deletedMentions.length > 0) {
+                options.handleMentionsChanged(deletedMentions);
+              }
+            }
+          }
         }
       };
     }

package/dist/esm/type-ahead/index.js

@@ -186,7 +186,7 @@ export var createTypeAheadConfig = function createTypeAheadConfig(_ref6) {
     fireEvent = _ref6.fireEvent,
     HighlightComponent = _ref6.HighlightComponent,
     api = _ref6.api,
-    handleMentionsInserted = _ref6.handleMentionsInserted;
+    handleMentionsChanged = _ref6.handleMentionsChanged;
   var sessionId = uuid();
   var firstQueryWithoutResults = null;
   var subscriptionKeys = new Set();
@@ -307,8 +307,9 @@ export var createTypeAheadConfig = function createTypeAheadConfig(_ref6) {
         }
       }
       var mentionLocalId = uuid();
-      if (handleMentionsInserted) {
-        handleMentionsInserted([{
+      if (handleMentionsChanged) {
+        handleMentionsChanged([{
+          type: 'added',
           localId: mentionLocalId,
           id: id
         }]);

package/dist/types/type-ahead/index.d.ts

@@ -13,10 +13,11 @@ type Props = {
     HighlightComponent?: React.ComponentType<React.PropsWithChildren<unknown>>;
     fireEvent: FireElementsChannelEvent;
     api: ExtractInjectionAPI<MentionsPlugin> | undefined;
-    handleMentionsInserted?: (mentionIds: {
+    handleMentionsChanged?: (mentionChanges: {
+        type: 'added' | 'deleted';
         localId: string;
         id: string;
     }[]) => void;
 };
-export declare const createTypeAheadConfig: ({ sanitizePrivateContent, mentionInsertDisplayName, fireEvent, HighlightComponent, api, handleMentionsInserted, }: Props) => TypeAheadHandler;
+export declare const createTypeAheadConfig: ({ sanitizePrivateContent, mentionInsertDisplayName, fireEvent, HighlightComponent, api, handleMentionsChanged, }: Props) => TypeAheadHandler;
 export {};

package/dist/types/types.d.ts

@@ -19,7 +19,8 @@ export interface MentionPluginConfig {
 export interface MentionPluginOptions extends MentionPluginConfig {
     sanitizePrivateContent?: boolean;
     allowZeroWidthSpaceAfter?: boolean;
-    handleMentionsInserted?: (mentionIds: {
+    handleMentionsChanged?: (mentionChanges: {
+        type: 'added' | 'deleted';
         localId: string;
         id: string;
     }[]) => void;
@@ -44,6 +45,7 @@ export type MentionsPlugin = NextEditorPlugin<'mention', {
     actions: {
         openTypeAhead: (inputMethod: TypeAheadInputMethod) => boolean;
         announceMentionsInsertion: (mentionIds: {
+            type: 'added' | 'deleted';
             localId: string;
             id: string;
         }[]) => void;

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

@@ -13,10 +13,11 @@ type Props = {
     HighlightComponent?: React.ComponentType<React.PropsWithChildren<unknown>>;
     fireEvent: FireElementsChannelEvent;
     api: ExtractInjectionAPI<MentionsPlugin> | undefined;
-    handleMentionsInserted?: (mentionIds: {
+    handleMentionsChanged?: (mentionChanges: {
+        type: 'added' | 'deleted';
         localId: string;
         id: string;
     }[]) => void;
 };
-export declare const createTypeAheadConfig: ({ sanitizePrivateContent, mentionInsertDisplayName, fireEvent, HighlightComponent, api, handleMentionsInserted, }: Props) => TypeAheadHandler;
+export declare const createTypeAheadConfig: ({ sanitizePrivateContent, mentionInsertDisplayName, fireEvent, HighlightComponent, api, handleMentionsChanged, }: Props) => TypeAheadHandler;
 export {};

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

@@ -19,7 +19,8 @@ export interface MentionPluginConfig {
 export interface MentionPluginOptions extends MentionPluginConfig {
     sanitizePrivateContent?: boolean;
     allowZeroWidthSpaceAfter?: boolean;
-    handleMentionsInserted?: (mentionIds: {
+    handleMentionsChanged?: (mentionChanges: {
+        type: 'added' | 'deleted';
         localId: string;
         id: string;
     }[]) => void;
@@ -44,6 +45,7 @@ export type MentionsPlugin = NextEditorPlugin<'mention', {
     actions: {
         openTypeAhead: (inputMethod: TypeAheadInputMethod) => boolean;
         announceMentionsInsertion: (mentionIds: {
+            type: 'added' | 'deleted';
             localId: string;
             id: string;
         }[]) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-mentions",
-	"version": "2.4.1",
+	"version": "2.5.0",
 	"description": "Mentions plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -35,7 +35,7 @@
 	"dependencies": {
 		"@atlaskit/adf-schema": "^40.8.1",
 		"@atlaskit/analytics-gas-types": "^5.1.0",
-		"@atlaskit/editor-common": "^88.0.0",
+		"@atlaskit/editor-common": "^88.1.0",
 		"@atlaskit/editor-plugin-analytics": "^1.8.0",
 		"@atlaskit/editor-plugin-context-identifier": "^1.3.0",
 		"@atlaskit/editor-plugin-type-ahead": "^1.8.0",
@@ -110,6 +110,9 @@
 		},
 		"editor_inline_comments_paste_insert_nodes": {
 			"type": "boolean"
+		},
+		"confluence_updated_mentions_livepages": {
+			"type": "boolean"
 		}
 	}
 }