@atlaskit/editor-plugin-mentions 5.0.0 → 5.1.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-plugin-mentions
 
+## 5.1.0
+
+### Minor Changes
+
+- [#181692](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/181692)
+  [`919d15a436698`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/919d15a436698) -
+  Add insertMention API to mentions so that consumers can create mentions from a toolbar.
+
 ## 5.0.0
 
 ### Major Changes

package/dist/cjs/editor-commands/index.js

@@ -0,0 +1,90 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.insertMention = exports.createSingleMentionFragment = void 0;
+var _uuid = _interopRequireDefault(require("uuid"));
+var _utils = require("@atlaskit/editor-common/utils");
+var _model = require("@atlaskit/editor-prosemirror/model");
+var _resource = require("@atlaskit/mention/resource");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+var createSingleMentionFragment = exports.createSingleMentionFragment = function createSingleMentionFragment(_ref) {
+  var mentionInsertDisplayName = _ref.mentionInsertDisplayName,
+    mentionProvider = _ref.mentionProvider,
+    tr = _ref.tr,
+    sanitizePrivateContent = _ref.sanitizePrivateContent;
+  return function (_ref2) {
+    var name = _ref2.name,
+      id = _ref2.id,
+      userType = _ref2.userType,
+      nickname = _ref2.nickname,
+      localId = _ref2.localId,
+      accessLevel = _ref2.accessLevel,
+      isXProductUser = _ref2.isXProductUser;
+    var schema = tr.doc.type.schema;
+    var trimmedNickname = nickname && nickname.startsWith('@') ? nickname.slice(1) : nickname;
+    var renderName = mentionInsertDisplayName || !trimmedNickname ? name : trimmedNickname;
+    if (isXProductUser && mentionProvider && mentionProvider.inviteXProductUser) {
+      mentionProvider.inviteXProductUser(id, name);
+    }
+
+    // Don't insert into document if document data is sanitized.
+    var text = sanitizePrivateContent ? '' : "@".concat(renderName);
+    if (sanitizePrivateContent && (0, _resource.isResolvingMentionProvider)(mentionProvider)) {
+      // Cache (locally) for later rendering
+      mentionProvider.cacheMentionName(id, renderName);
+    }
+    var annotationMarksForPos = (0, _platformFeatureFlags.fg)(
+    // eslint-disable-next-line @atlaskit/platform/ensure-feature-flag-prefix
+    'editor_inline_comments_paste_insert_nodes') ? (0, _utils.getAnnotationMarksForPos)(tr.selection.$head) : undefined;
+    var mentionNode = schema.nodes.mention.createChecked({
+      text: text,
+      id: id,
+      accessLevel: accessLevel,
+      userType: userType === 'DEFAULT' ? null : userType,
+      localId: localId !== null && localId !== void 0 ? localId : (0, _uuid.default)()
+    }, null,
+    // eslint-disable-next-line @atlaskit/platform/ensure-feature-flag-prefix
+    (0, _platformFeatureFlags.fg)('editor_inline_comments_paste_insert_nodes') ? annotationMarksForPos : undefined);
+    var space = schema.text(' ',
+    // eslint-disable-next-line @atlaskit/platform/ensure-feature-flag-prefix
+    (0, _platformFeatureFlags.fg)('editor_inline_comments_paste_insert_nodes') ? annotationMarksForPos : undefined);
+    return _model.Fragment.from([mentionNode, space]);
+  };
+};
+var insertMention = exports.insertMention = function insertMention(_ref3) {
+  var sanitizePrivateContent = _ref3.sanitizePrivateContent,
+    api = _ref3.api,
+    mentionInsertDisplayName = _ref3.mentionInsertDisplayName;
+  return function (_ref4) {
+    var name = _ref4.name,
+      id = _ref4.id,
+      userType = _ref4.userType,
+      localId = _ref4.localId,
+      nickname = _ref4.nickname,
+      accessLevel = _ref4.accessLevel,
+      isXProductUser = _ref4.isXProductUser;
+    return function (_ref5) {
+      var _api$mention$sharedSt;
+      var tr = _ref5.tr;
+      var mentionProvider = api === null || api === void 0 || (_api$mention$sharedSt = api.mention.sharedState.currentState()) === null || _api$mention$sharedSt === void 0 ? void 0 : _api$mention$sharedSt.mentionProvider;
+      var mentionFragment = createSingleMentionFragment({
+        sanitizePrivateContent: sanitizePrivateContent,
+        mentionProvider: mentionProvider,
+        mentionInsertDisplayName: mentionInsertDisplayName,
+        tr: tr
+      })({
+        name: name,
+        id: id,
+        userType: userType,
+        nickname: nickname,
+        localId: localId,
+        accessLevel: accessLevel,
+        isXProductUser: isXProductUser
+      });
+      return tr.insert(tr.selection.from, mentionFragment);
+    };
+  };
+};

package/dist/cjs/mentionsPlugin.js

@@ -19,6 +19,7 @@ var _quickInsert = require("@atlaskit/editor-common/quick-insert");
 var _resource = require("@atlaskit/mention/resource");
 var _types = require("@atlaskit/mention/types");
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+var _editorCommands = require("./editor-commands");
 var _mentionNodeSpec = require("./nodeviews/mentionNodeSpec");
 var _key = require("./pm-plugins/key");
 var _main = require("./pm-plugins/main");
@@ -79,6 +80,7 @@ function Component(_ref) {
   return null;
 }
 var mentionsPlugin = exports.mentionsPlugin = function mentionsPlugin(_ref3) {
+  var _options$sanitizePriv, _options$insertDispla;
   var options = _ref3.config,
     api = _ref3.api;
   var sessionId = (0, _uuid.default)();
@@ -147,6 +149,13 @@ var mentionsPlugin = exports.mentionsPlugin = function mentionsPlugin(_ref3) {
         typeAhead: typeAhead
       });
     },
+    commands: {
+      insertMention: (0, _editorCommands.insertMention)({
+        sanitizePrivateContent: (_options$sanitizePriv = options === null || options === void 0 ? void 0 : options.sanitizePrivateContent) !== null && _options$sanitizePriv !== void 0 ? _options$sanitizePriv : false,
+        mentionInsertDisplayName: (_options$insertDispla = options === null || options === void 0 ? void 0 : options.insertDisplayName) !== null && _options$insertDispla !== void 0 ? _options$insertDispla : false,
+        api: api
+      })
+    },
     actions: {
       openTypeAhead: function openTypeAhead(inputMethod) {
         var _api$typeAhead;

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

@@ -23,7 +23,7 @@ var ACTIONS = exports.ACTIONS = {
   SET_PROVIDER: 'SET_PROVIDER'
 };
 var PACKAGE_NAME = "@atlaskit/editor-plugin-mentions";
-var PACKAGE_VERSION = "4.7.12";
+var PACKAGE_VERSION = "5.0.0";
 var setProvider = function setProvider(provider) {
   return function (state, dispatch) {
     if (dispatch) {

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

@@ -20,6 +20,7 @@ var _item = require("@atlaskit/mention/item");
 var _resource = require("@atlaskit/mention/resource");
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _experiments = require("@atlaskit/tmp-editor-statsig/experiments");
+var _editorCommands = require("../../editor-commands");
 var _utils3 = require("../../pm-plugins/utils");
 var _InviteItem = _interopRequireWildcard(require("../InviteItem"));
 var _analytics = require("./analytics");
@@ -369,6 +370,24 @@ var createTypeAheadConfig = exports.createTypeAheadConfig = function createTypeA
         mentionProvider.inviteXProductUser(id, name);
       }
 
+      // This replaces logic below
+      if ((0, _platformFeatureFlags.fg)('platform_mention_insert_mention_refactor')) {
+        return insert((0, _editorCommands.createSingleMentionFragment)({
+          mentionProvider: mentionProvider,
+          mentionInsertDisplayName: mentionInsertDisplayName,
+          tr: state.tr,
+          sanitizePrivateContent: sanitizePrivateContent
+        })({
+          name: name,
+          id: id,
+          userType: userType,
+          nickname: nickname,
+          localId: mentionLocalId,
+          accessLevel: accessLevel,
+          isXProductUser: isXProductUser
+        }));
+      }
+
       // Don't insert into document if document data is sanitized.
       var text = sanitizePrivateContent ? '' : "@".concat(renderName);
       if (sanitizePrivateContent && (0, _resource.isResolvingMentionProvider)(mentionProvider)) {

package/dist/es2019/editor-commands/index.js

@@ -0,0 +1,84 @@
+import uuid from 'uuid';
+import { getAnnotationMarksForPos } from '@atlaskit/editor-common/utils';
+import { Fragment } from '@atlaskit/editor-prosemirror/model';
+import { isResolvingMentionProvider } from '@atlaskit/mention/resource';
+import { fg } from '@atlaskit/platform-feature-flags';
+export const createSingleMentionFragment = ({
+  mentionInsertDisplayName,
+  mentionProvider,
+  tr,
+  sanitizePrivateContent
+}) => ({
+  name,
+  id,
+  userType,
+  nickname,
+  localId,
+  accessLevel,
+  isXProductUser
+}) => {
+  const schema = tr.doc.type.schema;
+  const trimmedNickname = nickname && nickname.startsWith('@') ? nickname.slice(1) : nickname;
+  const renderName = mentionInsertDisplayName || !trimmedNickname ? name : trimmedNickname;
+  if (isXProductUser && mentionProvider && mentionProvider.inviteXProductUser) {
+    mentionProvider.inviteXProductUser(id, name);
+  }
+
+  // Don't insert into document if document data is sanitized.
+  const text = sanitizePrivateContent ? '' : `@${renderName}`;
+  if (sanitizePrivateContent && isResolvingMentionProvider(mentionProvider)) {
+    // Cache (locally) for later rendering
+    mentionProvider.cacheMentionName(id, renderName);
+  }
+  const annotationMarksForPos = fg(
+  // eslint-disable-next-line @atlaskit/platform/ensure-feature-flag-prefix
+  'editor_inline_comments_paste_insert_nodes') ? getAnnotationMarksForPos(tr.selection.$head) : undefined;
+  const mentionNode = schema.nodes.mention.createChecked({
+    text,
+    id,
+    accessLevel,
+    userType: userType === 'DEFAULT' ? null : userType,
+    localId: localId !== null && localId !== void 0 ? localId : uuid()
+  }, null,
+  // eslint-disable-next-line @atlaskit/platform/ensure-feature-flag-prefix
+  fg('editor_inline_comments_paste_insert_nodes') ? annotationMarksForPos : undefined);
+  const space = schema.text(' ',
+  // eslint-disable-next-line @atlaskit/platform/ensure-feature-flag-prefix
+  fg('editor_inline_comments_paste_insert_nodes') ? annotationMarksForPos : undefined);
+  return Fragment.from([mentionNode, space]);
+};
+export const insertMention = ({
+  sanitizePrivateContent,
+  api,
+  mentionInsertDisplayName
+}) => ({
+  name,
+  id,
+  userType,
+  localId,
+  nickname,
+  accessLevel,
+  isXProductUser
+}) => {
+  return ({
+    tr
+  }) => {
+    var _api$mention$sharedSt;
+    const mentionProvider = api === null || api === void 0 ? void 0 : (_api$mention$sharedSt = api.mention.sharedState.currentState()) === null || _api$mention$sharedSt === void 0 ? void 0 : _api$mention$sharedSt.mentionProvider;
+    const mentionFragment = createSingleMentionFragment({
+      sanitizePrivateContent,
+      mentionProvider,
+      mentionInsertDisplayName,
+      tr
+    })({
+      name,
+      id,
+      userType,
+      nickname,
+      localId,
+      accessLevel,
+      isXProductUser
+    });
+    return tr.insert(tr.selection.from, mentionFragment);
+  };
+};

package/dist/es2019/mentionsPlugin.js

@@ -8,6 +8,7 @@ import { IconMention } from '@atlaskit/editor-common/quick-insert';
 import { isResolvingMentionProvider } from '@atlaskit/mention/resource';
 import { MentionNameStatus, isPromise } from '@atlaskit/mention/types';
 import { fg } from '@atlaskit/platform-feature-flags';
+import { insertMention } from './editor-commands';
 import { mentionNodeSpec } from './nodeviews/mentionNodeSpec';
 import { mentionPluginKey } from './pm-plugins/key';
 import { ACTIONS, createMentionPlugin } from './pm-plugins/main';
@@ -78,6 +79,7 @@ const mentionsPlugin = ({
   config: options,
   api
 }) => {
+  var _options$sanitizePriv, _options$insertDispla;
   const sessionId = uuid();
   let previousMediaProvider;
   const fireEvent = (payload, channel) => {
@@ -145,6 +147,13 @@ const mentionsPlugin = ({
         typeAhead: typeAhead
       });
     },
+    commands: {
+      insertMention: insertMention({
+        sanitizePrivateContent: (_options$sanitizePriv = options === null || options === void 0 ? void 0 : options.sanitizePrivateContent) !== null && _options$sanitizePriv !== void 0 ? _options$sanitizePriv : false,
+        mentionInsertDisplayName: (_options$insertDispla = options === null || options === void 0 ? void 0 : options.insertDisplayName) !== null && _options$insertDispla !== void 0 ? _options$insertDispla : false,
+        api
+      })
+    },
     actions: {
       openTypeAhead(inputMethod) {
         var _api$typeAhead, _api$typeAhead$action;

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

@@ -12,7 +12,7 @@ export const ACTIONS = {
   SET_PROVIDER: 'SET_PROVIDER'
 };
 const PACKAGE_NAME = "@atlaskit/editor-plugin-mentions";
-const PACKAGE_VERSION = "4.7.12";
+const PACKAGE_VERSION = "5.0.0";
 const setProvider = provider => (state, dispatch) => {
   if (dispatch) {
     dispatch(state.tr.setMeta(mentionPluginKey, {

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

@@ -8,6 +8,7 @@ import { MENTION_ITEM_HEIGHT, MentionItem } from '@atlaskit/mention/item';
 import { isResolvingMentionProvider } from '@atlaskit/mention/resource';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
+import { createSingleMentionFragment } from '../../editor-commands';
 import { getMentionPluginState } from '../../pm-plugins/utils';
 import InviteItem, { INVITE_ITEM_DESCRIPTION } from '../InviteItem';
 import { buildTypeAheadCancelPayload, buildTypeAheadInsertedPayload, buildTypeAheadInviteItemClickedPayload, buildTypeAheadInviteItemViewedPayload, buildTypeAheadRenderedPayload } from './analytics';
@@ -352,6 +353,24 @@ export const createTypeAheadConfig = ({
         mentionProvider.inviteXProductUser(id, name);
       }
 
+      // This replaces logic below
+      if (fg('platform_mention_insert_mention_refactor')) {
+        return insert(createSingleMentionFragment({
+          mentionProvider,
+          mentionInsertDisplayName,
+          tr: state.tr,
+          sanitizePrivateContent
+        })({
+          name,
+          id,
+          userType,
+          nickname,
+          localId: mentionLocalId,
+          accessLevel,
+          isXProductUser
+        }));
+      }
+
       // Don't insert into document if document data is sanitized.
       const text = sanitizePrivateContent ? '' : `@${renderName}`;
       if (sanitizePrivateContent && isResolvingMentionProvider(mentionProvider)) {

package/dist/esm/editor-commands/index.js

@@ -0,0 +1,83 @@
+import uuid from 'uuid';
+import { getAnnotationMarksForPos } from '@atlaskit/editor-common/utils';
+import { Fragment } from '@atlaskit/editor-prosemirror/model';
+import { isResolvingMentionProvider } from '@atlaskit/mention/resource';
+import { fg } from '@atlaskit/platform-feature-flags';
+export var createSingleMentionFragment = function createSingleMentionFragment(_ref) {
+  var mentionInsertDisplayName = _ref.mentionInsertDisplayName,
+    mentionProvider = _ref.mentionProvider,
+    tr = _ref.tr,
+    sanitizePrivateContent = _ref.sanitizePrivateContent;
+  return function (_ref2) {
+    var name = _ref2.name,
+      id = _ref2.id,
+      userType = _ref2.userType,
+      nickname = _ref2.nickname,
+      localId = _ref2.localId,
+      accessLevel = _ref2.accessLevel,
+      isXProductUser = _ref2.isXProductUser;
+    var schema = tr.doc.type.schema;
+    var trimmedNickname = nickname && nickname.startsWith('@') ? nickname.slice(1) : nickname;
+    var renderName = mentionInsertDisplayName || !trimmedNickname ? name : trimmedNickname;
+    if (isXProductUser && mentionProvider && mentionProvider.inviteXProductUser) {
+      mentionProvider.inviteXProductUser(id, name);
+    }
+
+    // Don't insert into document if document data is sanitized.
+    var text = sanitizePrivateContent ? '' : "@".concat(renderName);
+    if (sanitizePrivateContent && isResolvingMentionProvider(mentionProvider)) {
+      // Cache (locally) for later rendering
+      mentionProvider.cacheMentionName(id, renderName);
+    }
+    var annotationMarksForPos = fg(
+    // eslint-disable-next-line @atlaskit/platform/ensure-feature-flag-prefix
+    'editor_inline_comments_paste_insert_nodes') ? getAnnotationMarksForPos(tr.selection.$head) : undefined;
+    var mentionNode = schema.nodes.mention.createChecked({
+      text: text,
+      id: id,
+      accessLevel: accessLevel,
+      userType: userType === 'DEFAULT' ? null : userType,
+      localId: localId !== null && localId !== void 0 ? localId : uuid()
+    }, null,
+    // eslint-disable-next-line @atlaskit/platform/ensure-feature-flag-prefix
+    fg('editor_inline_comments_paste_insert_nodes') ? annotationMarksForPos : undefined);
+    var space = schema.text(' ',
+    // eslint-disable-next-line @atlaskit/platform/ensure-feature-flag-prefix
+    fg('editor_inline_comments_paste_insert_nodes') ? annotationMarksForPos : undefined);
+    return Fragment.from([mentionNode, space]);
+  };
+};
+export var insertMention = function insertMention(_ref3) {
+  var sanitizePrivateContent = _ref3.sanitizePrivateContent,
+    api = _ref3.api,
+    mentionInsertDisplayName = _ref3.mentionInsertDisplayName;
+  return function (_ref4) {
+    var name = _ref4.name,
+      id = _ref4.id,
+      userType = _ref4.userType,
+      localId = _ref4.localId,
+      nickname = _ref4.nickname,
+      accessLevel = _ref4.accessLevel,
+      isXProductUser = _ref4.isXProductUser;
+    return function (_ref5) {
+      var _api$mention$sharedSt;
+      var tr = _ref5.tr;
+      var mentionProvider = api === null || api === void 0 || (_api$mention$sharedSt = api.mention.sharedState.currentState()) === null || _api$mention$sharedSt === void 0 ? void 0 : _api$mention$sharedSt.mentionProvider;
+      var mentionFragment = createSingleMentionFragment({
+        sanitizePrivateContent: sanitizePrivateContent,
+        mentionProvider: mentionProvider,
+        mentionInsertDisplayName: mentionInsertDisplayName,
+        tr: tr
+      })({
+        name: name,
+        id: id,
+        userType: userType,
+        nickname: nickname,
+        localId: localId,
+        accessLevel: accessLevel,
+        isXProductUser: isXProductUser
+      });
+      return tr.insert(tr.selection.from, mentionFragment);
+    };
+  };
+};

package/dist/esm/mentionsPlugin.js

@@ -13,6 +13,7 @@ import { IconMention } from '@atlaskit/editor-common/quick-insert';
 import { isResolvingMentionProvider } from '@atlaskit/mention/resource';
 import { MentionNameStatus, isPromise } from '@atlaskit/mention/types';
 import { fg } from '@atlaskit/platform-feature-flags';
+import { insertMention } from './editor-commands';
 import { mentionNodeSpec } from './nodeviews/mentionNodeSpec';
 import { mentionPluginKey } from './pm-plugins/key';
 import { ACTIONS, createMentionPlugin } from './pm-plugins/main';
@@ -70,6 +71,7 @@ function Component(_ref) {
   return null;
 }
 var mentionsPlugin = function mentionsPlugin(_ref3) {
+  var _options$sanitizePriv, _options$insertDispla;
   var options = _ref3.config,
     api = _ref3.api;
   var sessionId = uuid();
@@ -138,6 +140,13 @@ var mentionsPlugin = function mentionsPlugin(_ref3) {
         typeAhead: typeAhead
       });
     },
+    commands: {
+      insertMention: insertMention({
+        sanitizePrivateContent: (_options$sanitizePriv = options === null || options === void 0 ? void 0 : options.sanitizePrivateContent) !== null && _options$sanitizePriv !== void 0 ? _options$sanitizePriv : false,
+        mentionInsertDisplayName: (_options$insertDispla = options === null || options === void 0 ? void 0 : options.insertDisplayName) !== null && _options$insertDispla !== void 0 ? _options$insertDispla : false,
+        api: api
+      })
+    },
     actions: {
       openTypeAhead: function openTypeAhead(inputMethod) {
         var _api$typeAhead;

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

@@ -15,7 +15,7 @@ export var ACTIONS = {
   SET_PROVIDER: 'SET_PROVIDER'
 };
 var PACKAGE_NAME = "@atlaskit/editor-plugin-mentions";
-var PACKAGE_VERSION = "4.7.12";
+var PACKAGE_VERSION = "5.0.0";
 var setProvider = function setProvider(provider) {
   return function (state, dispatch) {
     if (dispatch) {

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

@@ -15,6 +15,7 @@ import { MENTION_ITEM_HEIGHT, MentionItem } from '@atlaskit/mention/item';
 import { isResolvingMentionProvider } from '@atlaskit/mention/resource';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
+import { createSingleMentionFragment } from '../../editor-commands';
 import { getMentionPluginState } from '../../pm-plugins/utils';
 import InviteItem, { INVITE_ITEM_DESCRIPTION } from '../InviteItem';
 import { buildTypeAheadCancelPayload, buildTypeAheadInsertedPayload, buildTypeAheadInviteItemClickedPayload, buildTypeAheadInviteItemViewedPayload, buildTypeAheadRenderedPayload } from './analytics';
@@ -358,6 +359,24 @@ export var createTypeAheadConfig = function createTypeAheadConfig(_ref6) {
         mentionProvider.inviteXProductUser(id, name);
       }
 
+      // This replaces logic below
+      if (fg('platform_mention_insert_mention_refactor')) {
+        return insert(createSingleMentionFragment({
+          mentionProvider: mentionProvider,
+          mentionInsertDisplayName: mentionInsertDisplayName,
+          tr: state.tr,
+          sanitizePrivateContent: sanitizePrivateContent
+        })({
+          name: name,
+          id: id,
+          userType: userType,
+          nickname: nickname,
+          localId: mentionLocalId,
+          accessLevel: accessLevel,
+          isXProductUser: isXProductUser
+        }));
+      }
+
       // Don't insert into document if document data is sanitized.
       var text = sanitizePrivateContent ? '' : "@".concat(renderName);
       if (sanitizePrivateContent && isResolvingMentionProvider(mentionProvider)) {

package/dist/types/editor-commands/index.d.ts

@@ -0,0 +1,32 @@
+import type { ExtractInjectionAPI, EditorCommand } from '@atlaskit/editor-common/types';
+import { Fragment } from '@atlaskit/editor-prosemirror/model';
+import type { Transaction } from '@atlaskit/editor-prosemirror/state';
+import { type MentionProvider, type MentionDescription } from '@atlaskit/mention/resource';
+import type { MentionsPlugin } from '../mentionsPluginType';
+export type InsertMentionParameters = Pick<MentionDescription, 'name' | 'id' | 'userType' | 'isXProductUser' | 'nickname' | 'accessLevel'> & {
+    /**
+     * The name is the name that will be displayed in the editor and stored in the ADF.
+     * If using "sanitizePrivateContent" with the mentions plugin, you can pass an empty
+     * name (ie. `name: ''`) to ensure the name is resolved by the mention provider (based
+     * on the id).
+     *
+     * !Warning: This is set without check if it matches the value in the mention provider, that
+     * must be done on the client side if using this.
+     */
+    name: string;
+    localId?: string;
+};
+type InternalParams = {
+    sanitizePrivateContent: boolean;
+    api: ExtractInjectionAPI<MentionsPlugin> | undefined;
+    mentionInsertDisplayName: boolean;
+};
+type SingleMentionFragmentParams = {
+    mentionProvider: MentionProvider | undefined;
+    sanitizePrivateContent: boolean | undefined;
+    mentionInsertDisplayName: boolean | undefined;
+    tr: Transaction;
+};
+export declare const createSingleMentionFragment: ({ mentionInsertDisplayName, mentionProvider, tr, sanitizePrivateContent, }: SingleMentionFragmentParams) => ({ name, id, userType, nickname, localId, accessLevel, isXProductUser, }: InsertMentionParameters) => Fragment;
+export declare const insertMention: ({ sanitizePrivateContent, api, mentionInsertDisplayName }: InternalParams) => ({ name, id, userType, localId, nickname, accessLevel, isXProductUser, }: InsertMentionParameters) => EditorCommand;
+export {};

package/dist/types/mentionsPluginType.d.ts

@@ -1,10 +1,11 @@
-import type { NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { NextEditorPlugin, OptionalPlugin, EditorCommand } from '@atlaskit/editor-common/types';
 import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type { BasePlugin } from '@atlaskit/editor-plugin-base';
 import type { ContextIdentifierPlugin } from '@atlaskit/editor-plugin-context-identifier';
 import type { SelectionPlugin } from '@atlaskit/editor-plugin-selection';
 import type { TypeAheadInputMethod, TypeAheadPlugin } from '@atlaskit/editor-plugin-type-ahead';
 import type { MentionProvider } from '@atlaskit/mention/resource';
+import type { InsertMentionParameters } from './editor-commands';
 import type { MentionPluginOptions, MentionSharedState } from './types';
 export type MentionActionOpenTypeAhead = (inputMethod: TypeAheadInputMethod) => boolean;
 export type MentionActionAnnounceMentionsInsertion = (mentionIds: {
@@ -31,4 +32,21 @@ export type MentionsPlugin = NextEditorPlugin<'mention', {
     dependencies: MentionPluginDependencies;
     sharedState: MentionSharedState | undefined;
     actions: MentionActions;
+    commands: {
+        /**
+         * Inserts mention node into the document based on parameters.
+         *
+         * !Warning at this stage only inserts single mentions
+         *
+         * @param params.name string
+         * @param params.id string
+         * @param params.userType string (optional)
+         * @param params.nickname string (optional)
+         * @param params.localId string (optional)
+         * @param params.accessLevel string (optional)
+         * @param params.isXProductUser boolean (optional)
+         * @returns
+         */
+        insertMention: (params: InsertMentionParameters) => EditorCommand;
+    };
 }>;

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

@@ -0,0 +1,32 @@
+import type { ExtractInjectionAPI, EditorCommand } from '@atlaskit/editor-common/types';
+import { Fragment } from '@atlaskit/editor-prosemirror/model';
+import type { Transaction } from '@atlaskit/editor-prosemirror/state';
+import { type MentionProvider, type MentionDescription } from '@atlaskit/mention/resource';
+import type { MentionsPlugin } from '../mentionsPluginType';
+export type InsertMentionParameters = Pick<MentionDescription, 'name' | 'id' | 'userType' | 'isXProductUser' | 'nickname' | 'accessLevel'> & {
+    /**
+     * The name is the name that will be displayed in the editor and stored in the ADF.
+     * If using "sanitizePrivateContent" with the mentions plugin, you can pass an empty
+     * name (ie. `name: ''`) to ensure the name is resolved by the mention provider (based
+     * on the id).
+     *
+     * !Warning: This is set without check if it matches the value in the mention provider, that
+     * must be done on the client side if using this.
+     */
+    name: string;
+    localId?: string;
+};
+type InternalParams = {
+    sanitizePrivateContent: boolean;
+    api: ExtractInjectionAPI<MentionsPlugin> | undefined;
+    mentionInsertDisplayName: boolean;
+};
+type SingleMentionFragmentParams = {
+    mentionProvider: MentionProvider | undefined;
+    sanitizePrivateContent: boolean | undefined;
+    mentionInsertDisplayName: boolean | undefined;
+    tr: Transaction;
+};
+export declare const createSingleMentionFragment: ({ mentionInsertDisplayName, mentionProvider, tr, sanitizePrivateContent, }: SingleMentionFragmentParams) => ({ name, id, userType, nickname, localId, accessLevel, isXProductUser, }: InsertMentionParameters) => Fragment;
+export declare const insertMention: ({ sanitizePrivateContent, api, mentionInsertDisplayName }: InternalParams) => ({ name, id, userType, localId, nickname, accessLevel, isXProductUser, }: InsertMentionParameters) => EditorCommand;
+export {};

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

@@ -1,10 +1,11 @@
-import type { NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { NextEditorPlugin, OptionalPlugin, EditorCommand } from '@atlaskit/editor-common/types';
 import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type { BasePlugin } from '@atlaskit/editor-plugin-base';
 import type { ContextIdentifierPlugin } from '@atlaskit/editor-plugin-context-identifier';
 import type { SelectionPlugin } from '@atlaskit/editor-plugin-selection';
 import type { TypeAheadInputMethod, TypeAheadPlugin } from '@atlaskit/editor-plugin-type-ahead';
 import type { MentionProvider } from '@atlaskit/mention/resource';
+import type { InsertMentionParameters } from './editor-commands';
 import type { MentionPluginOptions, MentionSharedState } from './types';
 export type MentionActionOpenTypeAhead = (inputMethod: TypeAheadInputMethod) => boolean;
 export type MentionActionAnnounceMentionsInsertion = (mentionIds: {
@@ -31,4 +32,21 @@ export type MentionsPlugin = NextEditorPlugin<'mention', {
     dependencies: MentionPluginDependencies;
     sharedState: MentionSharedState | undefined;
     actions: MentionActions;
+    commands: {
+        /**
+         * Inserts mention node into the document based on parameters.
+         *
+         * !Warning at this stage only inserts single mentions
+         *
+         * @param params.name string
+         * @param params.id string
+         * @param params.userType string (optional)
+         * @param params.nickname string (optional)
+         * @param params.localId string (optional)
+         * @param params.accessLevel string (optional)
+         * @param params.isXProductUser boolean (optional)
+         * @returns
+         */
+        insertMention: (params: InsertMentionParameters) => EditorCommand;
+    };
 }>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-mentions",
-	"version": "5.0.0",
+	"version": "5.1.0",
 	"description": "Mentions plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -48,7 +48,7 @@
 		"@atlaskit/portal": "^5.1.0",
 		"@atlaskit/profilecard": "^23.21.0",
 		"@atlaskit/theme": "^18.0.0",
-		"@atlaskit/tmp-editor-statsig": "^8.7.0",
+		"@atlaskit/tmp-editor-statsig": "^8.8.0",
 		"@atlaskit/tokens": "^5.4.0",
 		"@babel/runtime": "^7.0.0",
 		"@compiled/react": "^0.18.3",
@@ -57,7 +57,7 @@
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^107.6.0",
+		"@atlaskit/editor-common": "^107.7.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0",
 		"react-intl-next": "npm:react-intl@^5.18.1"
@@ -117,6 +117,9 @@
 		"platform_editor_mention_provider_via_plugin_config": {
 			"type": "boolean"
 		},
+		"platform_mention_insert_mention_refactor": {
+			"type": "boolean"
+		},
 		"dst-a11y__replace-anchor-with-link__editor-ai": {
 			"type": "boolean"
 		}