@atlaskit/editor-plugin-mentions 0.1.0

package/dist/types/pm-plugins/main.d.ts

@@ -0,0 +1,6 @@
+import type { ContextIdentifierProvider } from '@atlaskit/editor-common/provider-factory';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { Command, PMPluginFactoryParams } from '@atlaskit/editor-common/types';
+import type { MentionPluginOptions, MentionPluginState } from '../types';
+export declare const setContext: (context: ContextIdentifierProvider | undefined) => Command;
+export declare function createMentionPlugin(pmPluginFactoryParams: PMPluginFactoryParams, fireEvent: (payload: any) => void, options?: MentionPluginOptions): SafePlugin<MentionPluginState>;

package/dist/types/pm-plugins/utils.d.ts

@@ -0,0 +1,4 @@
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import type { MentionPluginState } from '../types';
+export declare function getMentionPluginState(state: EditorState): MentionPluginState;
+export declare const canMentionBeCreatedInRange: (from: number, to: number) => (state: EditorState) => boolean;

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

@@ -0,0 +1,17 @@
+import React from 'react';
+import type { TypeAheadHandler, TypeAheadItem } from '@atlaskit/editor-common/types';
+import type { MentionDescription } from '@atlaskit/mention/resource';
+import type { FireElementsChannelEvent } from '../types';
+export declare const mentionToTypeaheadItem: (mention: MentionDescription) => TypeAheadItem;
+export declare function memoize<ResultFn extends (mention: MentionDescription) => TypeAheadItem>(fn: ResultFn): {
+    call: ResultFn;
+    clear(): void;
+};
+type Props = {
+    sanitizePrivateContent?: boolean;
+    mentionInsertDisplayName?: boolean;
+    HighlightComponent?: React.ComponentType;
+    fireEvent: FireElementsChannelEvent;
+};
+export declare const createTypeAheadConfig: ({ sanitizePrivateContent, mentionInsertDisplayName, fireEvent, HighlightComponent, }: Props) => TypeAheadHandler;
+export {};

package/dist/types/types.d.ts

@@ -0,0 +1,38 @@
+/// <reference types="react" />
+import type { AnalyticsEventPayload } from '@atlaskit/analytics-next';
+import type { ContextIdentifierProvider } from '@atlaskit/editor-common/provider-factory';
+import type { NextEditorPlugin, OptionalPlugin, TypeAheadHandler } from '@atlaskit/editor-common/types';
+import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { TypeAheadInputMethod, TypeAheadPlugin } from '@atlaskit/editor-plugin-type-ahead';
+import type { MentionDescription, MentionProvider } from '@atlaskit/mention';
+export interface TeamInfoAttrAnalytics {
+    teamId: string;
+    includesYou: boolean;
+    memberCount: number;
+}
+export interface MentionPluginConfig {
+    HighlightComponent?: React.ComponentType;
+    insertDisplayName?: boolean;
+}
+export interface MentionPluginOptions extends MentionPluginConfig {
+    sanitizePrivateContent?: boolean;
+    allowZeroWidthSpaceAfter?: boolean;
+}
+export type MentionPluginState = {
+    mentionProvider?: MentionProvider;
+    contextIdentifierProvider?: ContextIdentifierProvider;
+    mentions?: Array<MentionDescription>;
+    canInsertMention?: boolean;
+};
+export type FireElementsChannelEvent = <T extends AnalyticsEventPayload>(payload: T) => void;
+export type MentionSharedState = MentionPluginState & {
+    typeAheadHandler: TypeAheadHandler;
+};
+export type MentionsPlugin = NextEditorPlugin<'mention', {
+    pluginConfiguration: MentionPluginOptions | undefined;
+    dependencies: [OptionalPlugin<AnalyticsPlugin>, TypeAheadPlugin];
+    sharedState: MentionSharedState | undefined;
+    actions: {
+        openTypeAhead: (inputMethod: TypeAheadInputMethod) => boolean;
+    };
+}>;

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

@@ -0,0 +1,24 @@
+/** @jsx jsx */
+import type { SyntheticEvent } from 'react';
+import React from 'react';
+import type { WrappedComponentProps } from 'react-intl-next';
+import type { UserRole } from '@atlaskit/mention';
+import type { MentionDescription } from '@atlaskit/mention/resource';
+interface OnMentionEvent {
+    (mention: MentionDescription, event?: SyntheticEvent<any>): void;
+}
+export declare const INVITE_ITEM_DESCRIPTION: {
+    id: string;
+};
+interface Props {
+    productName?: string;
+    onMount?: () => void;
+    onMouseEnter?: OnMentionEvent;
+    onSelection?: OnMentionEvent;
+    selected?: boolean;
+    userRole?: UserRole;
+}
+declare const _default: React.FC<import("react-intl-next").WithIntlProps<Props & WrappedComponentProps<"intl">>> & {
+    WrappedComponent: React.ComponentType<Props & WrappedComponentProps<"intl">>;
+};
+export default _default;

package/dist/types/ui/InviteItem/styles.d.ts

@@ -0,0 +1,8 @@
+export declare const ROW_SIDE_PADDING = 14;
+export declare const rowStyle: import("@emotion/react").SerializedStyles;
+export declare const AVATAR_HEIGHT = 36;
+export declare const avatarStyle: import("@emotion/react").SerializedStyles;
+export declare const nameSectionStyle: import("@emotion/react").SerializedStyles;
+export declare const mentionItemStyle: import("@emotion/react").SerializedStyles;
+export declare const mentionItemSelectedStyle: import("@emotion/react").SerializedStyles;
+export declare const capitalizedStyle: import("@emotion/react").SerializedStyles;

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

@@ -0,0 +1,19 @@
+import { PureComponent } from 'react';
+import { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
+import type { MentionEventHandlers } from '@atlaskit/editor-common/ui';
+export interface MentionProps {
+    id: string;
+    providers?: ProviderFactory;
+    eventHandlers?: MentionEventHandlers;
+    text: string;
+    accessLevel?: string;
+}
+export default class Mention extends PureComponent<MentionProps, {}> {
+    static displayName: string;
+    private providerFactory;
+    constructor(props: MentionProps);
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    private renderWithProvider;
+    render(): JSX.Element;
+}

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

@@ -0,0 +1,13 @@
+import React from 'react';
+import type { WrappedComponentProps } from 'react-intl-next';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+interface Props {
+    onInsertMention: () => void;
+    editorView?: EditorView;
+    isDisabled?: boolean;
+    testId?: string;
+}
+declare const _default: React.FC<import("react-intl-next").WithIntlProps<Props & WrappedComponentProps<"intl">>> & {
+    WrappedComponent: React.ComponentType<Props & WrappedComponentProps<"intl">>;
+};
+export default _default;

package/dist/types/utils.d.ts

@@ -0,0 +1,8 @@
+import type { MentionDescription } from '@atlaskit/mention';
+export declare const isTeamType: (userType: any) => boolean;
+export declare const isTeamStats: (stat: any) => boolean;
+export declare const isInviteItem: (mention: MentionDescription) => boolean;
+/**
+ * Actions
+ */
+export declare const shouldKeepInviteItem: (query: string, firstQueryWithoutResults: string) => boolean;

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

@@ -0,0 +1,13 @@
+import type { EventType, GasPayload } from '@atlaskit/analytics-gas-types';
+import type { ContextIdentifierProvider } from '@atlaskit/editor-common/provider-factory';
+import type { SelectItemMode } from '@atlaskit/editor-common/type-ahead';
+import type { InviteExperimentCohort, UserRole } from '@atlaskit/mention';
+import type { MentionDescription } from '@atlaskit/mention/resource';
+import type { TeamInfoAttrAnalytics } from './types';
+export declare const buildAnalyticsPayload: (actionSubject: string, action: string, eventType: EventType, sessionId: string, otherAttributes?: {}, tags?: Array<string>) => GasPayload;
+export declare const buildTypeAheadCancelPayload: (duration: number, upKeyCount: number, downKeyCount: number, sessionId: string, query?: string) => GasPayload;
+export declare const buildTypeAheadInviteItemViewedPayload: (sessionId: string, contextIdentifierProvider?: ContextIdentifierProvider, userRole?: UserRole) => GasPayload;
+export declare const buildTypeAheadInviteExposurePayload: (sessionId: string, contextIdentifierProvider?: ContextIdentifierProvider, inviteExperimentCohort?: InviteExperimentCohort, userRole?: UserRole) => GasPayload;
+export declare const buildTypeAheadInviteItemClickedPayload: (duration: number, upKeyCount: number, downKeyCount: number, sessionId: string, insertType: SelectItemMode, query?: string, contextIdentifierProvider?: ContextIdentifierProvider, userRole?: UserRole) => GasPayload;
+export declare const buildTypeAheadInsertedPayload: (duration: number, upKeyCount: number, downKeyCount: number, sessionId: string, insertType: SelectItemMode, mention: MentionDescription, mentionList?: MentionDescription[], query?: string, contextIdentifierProvider?: ContextIdentifierProvider) => GasPayload;
+export declare const buildTypeAheadRenderedPayload: (duration: number, userIds: Array<string> | null, query: string, teams: TeamInfoAttrAnalytics[] | null) => GasPayload;

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

@@ -0,0 +1,2 @@
+export { mentionsPlugin } from './plugin';
+export type { MentionPluginConfig, MentionsPlugin } from './types';

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

@@ -0,0 +1,22 @@
+export declare const messages: {
+    inviteItemTitle: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    mentionsAddLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    mentionsIconLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    mentionsNodeLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};

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

@@ -0,0 +1,9 @@
+import React from 'react';
+import type { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
+import type { InlineNodeViewComponentProps } from '@atlaskit/editor-common/react-node-view';
+import type { MentionPluginOptions } from '../types';
+export type Props = InlineNodeViewComponentProps & {
+    options: MentionPluginOptions | undefined;
+    providerFactory: ProviderFactory;
+};
+export declare const MentionNodeView: React.FC<Props>;

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

@@ -0,0 +1,3 @@
+import type { MentionsPlugin } from './types';
+declare const mentionsPlugin: MentionsPlugin;
+export { mentionsPlugin };

package/dist/types-ts4.5/pm-plugins/key.d.ts

@@ -0,0 +1,3 @@
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import type { MentionPluginState } from '../types';
+export declare const mentionPluginKey: PluginKey<MentionPluginState>;

package/dist/types-ts4.5/pm-plugins/main.d.ts

@@ -0,0 +1,6 @@
+import type { ContextIdentifierProvider } from '@atlaskit/editor-common/provider-factory';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { Command, PMPluginFactoryParams } from '@atlaskit/editor-common/types';
+import type { MentionPluginOptions, MentionPluginState } from '../types';
+export declare const setContext: (context: ContextIdentifierProvider | undefined) => Command;
+export declare function createMentionPlugin(pmPluginFactoryParams: PMPluginFactoryParams, fireEvent: (payload: any) => void, options?: MentionPluginOptions): SafePlugin<MentionPluginState>;

package/dist/types-ts4.5/pm-plugins/utils.d.ts

@@ -0,0 +1,4 @@
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import type { MentionPluginState } from '../types';
+export declare function getMentionPluginState(state: EditorState): MentionPluginState;
+export declare const canMentionBeCreatedInRange: (from: number, to: number) => (state: EditorState) => boolean;

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

@@ -0,0 +1,17 @@
+import React from 'react';
+import type { TypeAheadHandler, TypeAheadItem } from '@atlaskit/editor-common/types';
+import type { MentionDescription } from '@atlaskit/mention/resource';
+import type { FireElementsChannelEvent } from '../types';
+export declare const mentionToTypeaheadItem: (mention: MentionDescription) => TypeAheadItem;
+export declare function memoize<ResultFn extends (mention: MentionDescription) => TypeAheadItem>(fn: ResultFn): {
+    call: ResultFn;
+    clear(): void;
+};
+type Props = {
+    sanitizePrivateContent?: boolean;
+    mentionInsertDisplayName?: boolean;
+    HighlightComponent?: React.ComponentType;
+    fireEvent: FireElementsChannelEvent;
+};
+export declare const createTypeAheadConfig: ({ sanitizePrivateContent, mentionInsertDisplayName, fireEvent, HighlightComponent, }: Props) => TypeAheadHandler;
+export {};

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

@@ -0,0 +1,41 @@
+/// <reference types="react" />
+import type { AnalyticsEventPayload } from '@atlaskit/analytics-next';
+import type { ContextIdentifierProvider } from '@atlaskit/editor-common/provider-factory';
+import type { NextEditorPlugin, OptionalPlugin, TypeAheadHandler } from '@atlaskit/editor-common/types';
+import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { TypeAheadInputMethod, TypeAheadPlugin } from '@atlaskit/editor-plugin-type-ahead';
+import type { MentionDescription, MentionProvider } from '@atlaskit/mention';
+export interface TeamInfoAttrAnalytics {
+    teamId: string;
+    includesYou: boolean;
+    memberCount: number;
+}
+export interface MentionPluginConfig {
+    HighlightComponent?: React.ComponentType;
+    insertDisplayName?: boolean;
+}
+export interface MentionPluginOptions extends MentionPluginConfig {
+    sanitizePrivateContent?: boolean;
+    allowZeroWidthSpaceAfter?: boolean;
+}
+export type MentionPluginState = {
+    mentionProvider?: MentionProvider;
+    contextIdentifierProvider?: ContextIdentifierProvider;
+    mentions?: Array<MentionDescription>;
+    canInsertMention?: boolean;
+};
+export type FireElementsChannelEvent = <T extends AnalyticsEventPayload>(payload: T) => void;
+export type MentionSharedState = MentionPluginState & {
+    typeAheadHandler: TypeAheadHandler;
+};
+export type MentionsPlugin = NextEditorPlugin<'mention', {
+    pluginConfiguration: MentionPluginOptions | undefined;
+    dependencies: [
+        OptionalPlugin<AnalyticsPlugin>,
+        TypeAheadPlugin
+    ];
+    sharedState: MentionSharedState | undefined;
+    actions: {
+        openTypeAhead: (inputMethod: TypeAheadInputMethod) => boolean;
+    };
+}>;

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

@@ -0,0 +1,24 @@
+/** @jsx jsx */
+import type { SyntheticEvent } from 'react';
+import React from 'react';
+import type { WrappedComponentProps } from 'react-intl-next';
+import type { UserRole } from '@atlaskit/mention';
+import type { MentionDescription } from '@atlaskit/mention/resource';
+interface OnMentionEvent {
+    (mention: MentionDescription, event?: SyntheticEvent<any>): void;
+}
+export declare const INVITE_ITEM_DESCRIPTION: {
+    id: string;
+};
+interface Props {
+    productName?: string;
+    onMount?: () => void;
+    onMouseEnter?: OnMentionEvent;
+    onSelection?: OnMentionEvent;
+    selected?: boolean;
+    userRole?: UserRole;
+}
+declare const _default: React.FC<import("react-intl-next").WithIntlProps<Props & WrappedComponentProps<"intl">>> & {
+    WrappedComponent: React.ComponentType<Props & WrappedComponentProps<"intl">>;
+};
+export default _default;

package/dist/types-ts4.5/ui/InviteItem/styles.d.ts

@@ -0,0 +1,8 @@
+export declare const ROW_SIDE_PADDING = 14;
+export declare const rowStyle: import("@emotion/react").SerializedStyles;
+export declare const AVATAR_HEIGHT = 36;
+export declare const avatarStyle: import("@emotion/react").SerializedStyles;
+export declare const nameSectionStyle: import("@emotion/react").SerializedStyles;
+export declare const mentionItemStyle: import("@emotion/react").SerializedStyles;
+export declare const mentionItemSelectedStyle: import("@emotion/react").SerializedStyles;
+export declare const capitalizedStyle: import("@emotion/react").SerializedStyles;

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

@@ -0,0 +1,19 @@
+import { PureComponent } from 'react';
+import { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
+import type { MentionEventHandlers } from '@atlaskit/editor-common/ui';
+export interface MentionProps {
+    id: string;
+    providers?: ProviderFactory;
+    eventHandlers?: MentionEventHandlers;
+    text: string;
+    accessLevel?: string;
+}
+export default class Mention extends PureComponent<MentionProps, {}> {
+    static displayName: string;
+    private providerFactory;
+    constructor(props: MentionProps);
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    private renderWithProvider;
+    render(): JSX.Element;
+}

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

@@ -0,0 +1,13 @@
+import React from 'react';
+import type { WrappedComponentProps } from 'react-intl-next';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+interface Props {
+    onInsertMention: () => void;
+    editorView?: EditorView;
+    isDisabled?: boolean;
+    testId?: string;
+}
+declare const _default: React.FC<import("react-intl-next").WithIntlProps<Props & WrappedComponentProps<"intl">>> & {
+    WrappedComponent: React.ComponentType<Props & WrappedComponentProps<"intl">>;
+};
+export default _default;

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

@@ -0,0 +1,8 @@
+import type { MentionDescription } from '@atlaskit/mention';
+export declare const isTeamType: (userType: any) => boolean;
+export declare const isTeamStats: (stat: any) => boolean;
+export declare const isInviteItem: (mention: MentionDescription) => boolean;
+/**
+ * Actions
+ */
+export declare const shouldKeepInviteItem: (query: string, firstQueryWithoutResults: string) => boolean;

package/package.json

@@ -0,0 +1,112 @@
+{
+  "name": "@atlaskit/editor-plugin-mentions",
+  "version": "0.1.0",
+  "description": "Mentions plugin for @atlaskit/editor-core",
+  "author": "Atlassian Pty Ltd",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "atlassian": {
+    "team": "Editor: Lego",
+    "inPublicMirror": false,
+    "releaseModel": "continuous",
+    "website": {
+      "name": "EditorPluginMentions",
+      "category": "Components"
+    }
+  },
+  "repository": "https://bitbucket.org/atlassian/atlassian-frontend",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "module:es2019": "dist/es2019/index.js",
+  "types": "dist/types/index.d.ts",
+  "typesVersions": {
+    ">=4.5 <4.9": {
+      "*": [
+        "dist/types-ts4.5/*",
+        "dist/types-ts4.5/index.d.ts"
+      ]
+    }
+  },
+  "sideEffects": false,
+  "atlaskit:src": "src/index.ts",
+  "af:exports": {
+    ".": "./src/index.ts"
+  },
+  "dependencies": {
+    "@atlaskit/adf-schema": "^32.0.0",
+    "@atlaskit/analytics-gas-types": "^5.1.0",
+    "@atlaskit/editor-common": "^76.11.0",
+    "@atlaskit/editor-plugin-analytics": "^0.2.0",
+    "@atlaskit/editor-plugin-type-ahead": "^0.7.0",
+    "@atlaskit/editor-prosemirror": "1.1.0",
+    "@atlaskit/icon": "^21.12.0",
+    "@atlaskit/mention": "^22.1.0",
+    "@atlaskit/theme": "^12.6.0",
+    "@atlaskit/tokens": "^1.26.0",
+    "@babel/runtime": "^7.0.0",
+    "@emotion/react": "^11.7.1",
+    "uuid": "^3.1.0"
+  },
+  "peerDependencies": {
+    "react": "^16.8.0",
+    "react-dom": "^16.8.0",
+    "react-intl-next": "npm:react-intl@^5.18.1"
+  },
+  "devDependencies": {
+    "@af/visual-regression": "*",
+    "@atlaskit/ssr": "*",
+    "@atlaskit/visual-regression": "*",
+    "@atlaskit/webdriver-runner": "*",
+    "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
+    "@testing-library/react": "^12.1.5",
+    "react-dom": "^16.8.0",
+    "typescript": "~4.9.5",
+    "wait-for-expect": "^1.2.0"
+  },
+  "techstack": {
+    "@atlassian/frontend": {
+      "code-structure": [
+        "tangerine-next"
+      ],
+      "import-structure": [
+        "atlassian-conventions"
+      ],
+      "circular-dependencies": [
+        "file-and-folder-level"
+      ]
+    },
+    "@repo/internal": {
+      "dom-events": "use-bind-event-listener",
+      "analytics": [
+        "analytics-next"
+      ],
+      "design-tokens": [
+        "color"
+      ],
+      "theming": [
+        "react-context"
+      ],
+      "ui-components": [
+        "lite-mode"
+      ],
+      "deprecation": [
+        "no-deprecated-imports"
+      ],
+      "styling": [
+        "static",
+        "emotion"
+      ],
+      "imports": [
+        "import-no-extraneous-disable-for-examples-and-docs"
+      ]
+    }
+  },
+  "techstackIgnore": {
+    "stricter": [
+      "@atlassian/tangerine/project-structure"
+    ]
+  },
+  "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.0"
+}

package/report.api.md

@@ -0,0 +1,92 @@
+<!-- API Report Version: 2.3 -->
+
+## API Report File for "@atlaskit/editor-plugin-mentions"
+
+> Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
+> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+
+### Table of contents
+
+- [Main Entry Types](#main-entry-types)
+- [Peer Dependencies](#peer-dependencies)
+
+### Main Entry Types
+
+<!--SECTION START: Main Entry Types-->
+
+```ts
+/// <reference types="react" />
+
+import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { ContextIdentifierProvider } from '@atlaskit/editor-common/provider-factory';
+import type { MentionDescription } from '@atlaskit/mention';
+import type { MentionProvider } from '@atlaskit/mention';
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { TypeAheadHandler } from '@atlaskit/editor-common/types';
+import type { TypeAheadInputMethod } from '@atlaskit/editor-plugin-type-ahead';
+import type { TypeAheadPlugin } from '@atlaskit/editor-plugin-type-ahead';
+
+// @public (undocumented)
+export interface MentionPluginConfig {
+  // (undocumented)
+  HighlightComponent?: React.ComponentType;
+  // (undocumented)
+  insertDisplayName?: boolean;
+}
+
+// @public (undocumented)
+interface MentionPluginOptions extends MentionPluginConfig {
+  // (undocumented)
+  allowZeroWidthSpaceAfter?: boolean;
+  // (undocumented)
+  sanitizePrivateContent?: boolean;
+}
+
+// @public (undocumented)
+type MentionPluginState = {
+  mentionProvider?: MentionProvider;
+  contextIdentifierProvider?: ContextIdentifierProvider;
+  mentions?: Array<MentionDescription>;
+  canInsertMention?: boolean;
+};
+
+// @public (undocumented)
+type MentionSharedState = MentionPluginState & {
+  typeAheadHandler: TypeAheadHandler;
+};
+
+// @public (undocumented)
+export type MentionsPlugin = NextEditorPlugin<
+  'mention',
+  {
+    pluginConfiguration: MentionPluginOptions | undefined;
+    dependencies: [OptionalPlugin<AnalyticsPlugin>, TypeAheadPlugin];
+    sharedState: MentionSharedState | undefined;
+    actions: {
+      openTypeAhead: (inputMethod: TypeAheadInputMethod) => boolean;
+    };
+  }
+>;
+
+// @public (undocumented)
+export const mentionsPlugin: MentionsPlugin;
+
+// (No @packageDocumentation comment for this package)
+```
+
+<!--SECTION END: Main Entry Types-->
+
+### Peer Dependencies
+
+<!--SECTION START: Peer Dependencies-->
+
+```json
+{
+  "react": "^16.8.0",
+  "react-dom": "^16.8.0",
+  "react-intl-next": "npm:react-intl@^5.18.1"
+}
+```
+
+<!--SECTION END: Peer Dependencies-->

package/tmp/api-report-tmp.d.ts

@@ -0,0 +1,63 @@
+## API Report File for "@atlaskit/editor-plugin-mentions"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+/// <reference types="react" />
+
+import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { ContextIdentifierProvider } from '@atlaskit/editor-common/provider-factory';
+import type { MentionDescription } from '@atlaskit/mention';
+import type { MentionProvider } from '@atlaskit/mention';
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { TypeAheadHandler } from '@atlaskit/editor-common/types';
+import type { TypeAheadInputMethod } from '@atlaskit/editor-plugin-type-ahead';
+import type { TypeAheadPlugin } from '@atlaskit/editor-plugin-type-ahead';
+
+// @public (undocumented)
+export interface MentionPluginConfig {
+    // (undocumented)
+    HighlightComponent?: React.ComponentType;
+    // (undocumented)
+    insertDisplayName?: boolean;
+}
+
+// @public (undocumented)
+interface MentionPluginOptions extends MentionPluginConfig {
+    // (undocumented)
+    allowZeroWidthSpaceAfter?: boolean;
+    // (undocumented)
+    sanitizePrivateContent?: boolean;
+}
+
+// @public (undocumented)
+type MentionPluginState = {
+    mentionProvider?: MentionProvider;
+    contextIdentifierProvider?: ContextIdentifierProvider;
+    mentions?: Array<MentionDescription>;
+    canInsertMention?: boolean;
+};
+
+// @public (undocumented)
+type MentionSharedState = MentionPluginState & {
+    typeAheadHandler: TypeAheadHandler;
+};
+
+// @public (undocumented)
+export type MentionsPlugin = NextEditorPlugin<'mention', {
+    pluginConfiguration: MentionPluginOptions | undefined;
+    dependencies: [OptionalPlugin<AnalyticsPlugin>, TypeAheadPlugin];
+    sharedState: MentionSharedState | undefined;
+    actions: {
+        openTypeAhead: (inputMethod: TypeAheadInputMethod) => boolean;
+    };
+}>;
+
+// @public (undocumented)
+export const mentionsPlugin: MentionsPlugin;
+
+// (No @packageDocumentation comment for this package)
+
+```