@ckeditor/ckeditor5-mention 40.0.0 → 40.2.0

package/CHANGELOG.md

@@ -5,7 +5,7 @@ All changes in the package are documented in the main repository. See: https://g
 
 Changes for the past releases are available below.
 
-## [19.0.0](https://github.com/ckeditor/ckeditor5-mention/compare/v18.0.0...v19.0.0) (2020-04-29)
+## [19.0.0](https://github.com/ckeditor/ckeditor5-mention/compare/v18.0.0...v19.0.0) (April 29, 2020)
 
 ### Bug fixes
 
@@ -13,24 +13,24 @@ Changes for the past releases are available below.
 * Mentions can now be matched by any character typed. Closes [ckeditor/ckeditor5#6398](https://github.com/ckeditor/ckeditor5/issues/6398). ([aa7d04d](https://github.com/ckeditor/ckeditor5-mention/commit/aa7d04d))
 
 
-## [18.0.0](https://github.com/ckeditor/ckeditor5-mention/compare/v17.0.0...v18.0.0) (2020-03-19)
+## [18.0.0](https://github.com/ckeditor/ckeditor5-mention/compare/v17.0.0...v18.0.0) (March 19, 2020)
 
 Internal changes only (updated dependencies, documentation, etc.).
 
 
-## [17.0.0](https://github.com/ckeditor/ckeditor5-mention/compare/v16.0.0...v17.0.0) (2020-02-19)
+## [17.0.0](https://github.com/ckeditor/ckeditor5-mention/compare/v16.0.0...v17.0.0) (February 19, 2020)
 
 ### Features
 
 * Implemented debounced mechanism for requesting a mention feed. Closes [ckeditor/ckeditor5#4619](https://github.com/ckeditor/ckeditor5/issues/4619). ([f50db9c](https://github.com/ckeditor/ckeditor5-mention/commit/f50db9c))
 
 
-## [16.0.0](https://github.com/ckeditor/ckeditor5-mention/compare/v15.0.0...v16.0.0) (2019-12-04)
+## [16.0.0](https://github.com/ckeditor/ckeditor5-mention/compare/v15.0.0...v16.0.0) (December 4, 2019)
 
 Internal changes only (updated dependencies, documentation, etc.).
 
 
-## [15.0.0](https://github.com/ckeditor/ckeditor5-mention/compare/v13.0.0...v15.0.0) (2019-10-23)
+## [15.0.0](https://github.com/ckeditor/ckeditor5-mention/compare/v13.0.0...v15.0.0) (October 23, 2019)
 
 ### Other changes
 
@@ -39,7 +39,7 @@ Internal changes only (updated dependencies, documentation, etc.).
   Thanks [@oliverguenther](https://github.com/oliverguenther) for the contribution!
 
 
-## [13.0.0](https://github.com/ckeditor/ckeditor5-mention/compare/v12.0.1...v13.0.0) (2019-08-26)
+## [13.0.0](https://github.com/ckeditor/ckeditor5-mention/compare/v12.0.1...v13.0.0) (August 26, 2019)
 
 ### Other changes
 
@@ -51,12 +51,12 @@ Internal changes only (updated dependencies, documentation, etc.).
 * The `mention/featuredetection` namespace is removed. Please use `env.features` from ckeditor5-utils instead.
 
 
-## [12.0.1](https://github.com/ckeditor/ckeditor5-mention/compare/v12.0.0...v12.0.1) (2019-07-10)
+## [12.0.1](https://github.com/ckeditor/ckeditor5-mention/compare/v12.0.0...v12.0.1) (July 10, 2019)
 
 Internal changes only (updated dependencies, documentation, etc.).
 
 
-## [12.0.0](https://github.com/ckeditor/ckeditor5-mention/compare/v11.0.0...v12.0.0) (2019-07-04)
+## [12.0.0](https://github.com/ckeditor/ckeditor5-mention/compare/v11.0.0...v12.0.0) (July 4, 2019)
 
 ### Bug fixes
 
@@ -73,7 +73,7 @@ Internal changes only (updated dependencies, documentation, etc.).
 * The `TextWatcher` util was moved to `@ckeditor/ckeditor5-typing`.
 
 
-## [11.0.0](https://github.com/ckeditor/ckeditor5-mention/compare/v10.0.0...v11.0.0) (2019-06-05)
+## [11.0.0](https://github.com/ckeditor/ckeditor5-mention/compare/v10.0.0...v11.0.0) (June 6, 2019)
 
 ### Bug fixes
 
@@ -92,6 +92,6 @@ Internal changes only (updated dependencies, documentation, etc.).
 * The `MentionUI#panelView` property is removed. The mention feature now uses the `ContextualBalloon` plugin.
 
 
-## [10.0.0](https://github.com/ckeditor/ckeditor5-mention/tree/v10.0.0) (2019-04-10)
+## [10.0.0](https://github.com/ckeditor/ckeditor5-mention/tree/v10.0.0) (April 4, 2019)
 
 The initial release.

package/LICENSE.md

@@ -2,7 +2,7 @@ Software License Agreement
 ==========================
 
 **CKEditor&nbsp;5 mention feature** – https://github.com/ckeditor/ckeditor5-mention <br>
-Copyright (c) 2003-2023, [CKSource Holding sp. z o.o.](https://cksource.com) All rights reserved.
+Copyright (c) 2003–2023, [CKSource Holding sp. z o.o.](https://cksource.com) All rights reserved.
 
 Licensed under the terms of [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html).
 
@@ -13,9 +13,9 @@ Where not otherwise indicated, all CKEditor content is authored by CKSource engi
 
 The following libraries are included in CKEditor under the [MIT license](https://opensource.org/licenses/MIT):
 
-* lodash - Copyright (c) JS Foundation and other contributors https://js.foundation/. Based on Underscore.js, copyright Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors http://underscorejs.org/.
+* Lodash - Copyright (c) JS Foundation and other contributors https://js.foundation/. Based on Underscore.js, copyright Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors http://underscorejs.org/.
 
 Trademarks
 ----------
 
-**CKEditor** is a trademark of [CKSource Holding sp. z o.o.](https://cksource.com) All other brand and product names are trademarks, registered trademarks or service marks of their respective holders.
+**CKEditor** is a trademark of [CKSource Holding sp. z o.o.](https://cksource.com) All other brand and product names are trademarks, registered trademarks, or service marks of their respective holders.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-mention",
-  "version": "40.0.0",
+  "version": "40.2.0",
   "description": "Mention feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -12,7 +12,7 @@
   ],
   "main": "src/index.js",
   "dependencies": {
-    "ckeditor5": "40.0.0",
+    "ckeditor5": "40.2.0",
     "lodash-es": "4.17.21"
   },
   "author": "CKSource (http://cksource.com/)",

package/src/augmentation.d.ts

@@ -1,23 +1,23 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-import type { MentionConfig, Mention, MentionEditing, MentionUI, MentionCommand } from './index';
-declare module '@ckeditor/ckeditor5-core' {
-    interface EditorConfig {
-        /**
-         * The configuration of the {@link module:mention/mention~Mention} feature.
-         *
-         * Read more in {@link module:mention/mentionconfig~MentionConfig}.
-         */
-        mention?: MentionConfig;
-    }
-    interface PluginsMap {
-        [Mention.pluginName]: Mention;
-        [MentionEditing.pluginName]: MentionEditing;
-        [MentionUI.pluginName]: MentionUI;
-    }
-    interface CommandsMap {
-        mention: MentionCommand;
-    }
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import type { MentionConfig, Mention, MentionEditing, MentionUI, MentionCommand } from './index';
+declare module '@ckeditor/ckeditor5-core' {
+    interface EditorConfig {
+        /**
+         * The configuration of the {@link module:mention/mention~Mention} feature.
+         *
+         * Read more in {@link module:mention/mentionconfig~MentionConfig}.
+         */
+        mention?: MentionConfig;
+    }
+    interface PluginsMap {
+        [Mention.pluginName]: Mention;
+        [MentionEditing.pluginName]: MentionEditing;
+        [MentionUI.pluginName]: MentionUI;
+    }
+    interface CommandsMap {
+        mention: MentionCommand;
+    }
+}

package/src/augmentation.js

@@ -1,5 +1,5 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-export {};
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+export {};

package/src/index.d.ts

@@ -1,13 +1,13 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module mention
- */
-export { default as Mention } from './mention';
-export { default as MentionEditing } from './mentionediting';
-export { default as MentionUI } from './mentionui';
-export type { MentionConfig, MentionFeed, ItemRenderer } from './mentionconfig';
-export type { default as MentionCommand } from './mentioncommand';
-import './augmentation';
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module mention
+ */
+export { default as Mention } from './mention';
+export { default as MentionEditing } from './mentionediting';
+export { default as MentionUI } from './mentionui';
+export type { MentionConfig, MentionFeed, ItemRenderer } from './mentionconfig';
+export type { default as MentionCommand } from './mentioncommand';
+import './augmentation';

package/src/index.js

@@ -1,11 +1,11 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module mention
- */
-export { default as Mention } from './mention';
-export { default as MentionEditing } from './mentionediting';
-export { default as MentionUI } from './mentionui';
-import './augmentation';
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module mention
+ */
+export { default as Mention } from './mention';
+export { default as MentionEditing } from './mentionediting';
+export { default as MentionUI } from './mentionui';
+import './augmentation';

package/src/mention.d.ts

@@ -1,77 +1,77 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module mention/mention
- */
-import { Plugin } from 'ckeditor5/src/core';
-import type { Element } from 'ckeditor5/src/engine';
-import MentionEditing from './mentionediting';
-import MentionUI from './mentionui';
-import '../theme/mention.css';
-/**
- * The mention plugin.
- *
- * For a detailed overview, check the {@glink features/mentions Mention feature} guide.
- */
-export default class Mention extends Plugin {
-    /**
-     * Creates a mention attribute value from the provided view element and additional data.
-     *
-     * ```ts
-     * editor.plugins.get( 'Mention' ).toMentionAttribute( viewElement, { userId: '1234' } );
-     *
-     * // For a view element: <span data-mention="@joe">@John Doe</span>
-     * // it will return:
-     * // { id: '@joe', userId: '1234', uid: '7a7bc7...', _text: '@John Doe' }
-     * ```
-     *
-     * @param data Additional data to be stored in the mention attribute.
-     */
-    toMentionAttribute<MentionData extends Record<string, unknown>>(viewElement: Element, data: MentionData): (MentionAttribute & MentionData) | undefined;
-    /**
-     * Creates a mention attribute value from the provided view element.
-     *
-     * ```ts
-     * editor.plugins.get( 'Mention' ).toMentionAttribute( viewElement );
-     *
-     * // For a view element: <span data-mention="@joe">@John Doe</span>
-     * // it will return:
-     * // { id: '@joe', uid: '7a7bc7...', _text: '@John Doe' }
-     * ```
-     */
-    toMentionAttribute(viewElement: Element): MentionAttribute | undefined;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "Mention";
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof MentionEditing, typeof MentionUI];
-}
-/**
- * Represents a mention in the model.
- *
- * See {@link module:mention/mention~Mention#toMentionAttribute `Mention#toMentionAttribute()`}.
- */
-export type MentionAttribute = {
-    /**
-     * The ID of a mention. It identifies the mention item in the mention feed. There can be multiple mentions
-     * in the document with the same ID (e.g. the same hashtag being mentioned).
-     */
-    id: string;
-    /**
-     * A unique ID of this mention instance. Should be passed as an `option.id` when using
-     * {@link module:engine/view/downcastwriter~DowncastWriter#createAttributeElement writer.createAttributeElement()}.
-     */
-    uid: string;
-    /**
-     * Helper property that stores the text of the inserted mention. Used for detecting a broken mention
-     * in the editing area.
-     *
-     * @internal
-     */
-    _text: string;
-};
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module mention/mention
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import type { Element } from 'ckeditor5/src/engine';
+import MentionEditing from './mentionediting';
+import MentionUI from './mentionui';
+import '../theme/mention.css';
+/**
+ * The mention plugin.
+ *
+ * For a detailed overview, check the {@glink features/mentions Mention feature} guide.
+ */
+export default class Mention extends Plugin {
+    /**
+     * Creates a mention attribute value from the provided view element and additional data.
+     *
+     * ```ts
+     * editor.plugins.get( 'Mention' ).toMentionAttribute( viewElement, { userId: '1234' } );
+     *
+     * // For a view element: <span data-mention="@joe">@John Doe</span>
+     * // it will return:
+     * // { id: '@joe', userId: '1234', uid: '7a7bc7...', _text: '@John Doe' }
+     * ```
+     *
+     * @param data Additional data to be stored in the mention attribute.
+     */
+    toMentionAttribute<MentionData extends Record<string, unknown>>(viewElement: Element, data: MentionData): (MentionAttribute & MentionData) | undefined;
+    /**
+     * Creates a mention attribute value from the provided view element.
+     *
+     * ```ts
+     * editor.plugins.get( 'Mention' ).toMentionAttribute( viewElement );
+     *
+     * // For a view element: <span data-mention="@joe">@John Doe</span>
+     * // it will return:
+     * // { id: '@joe', uid: '7a7bc7...', _text: '@John Doe' }
+     * ```
+     */
+    toMentionAttribute(viewElement: Element): MentionAttribute | undefined;
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "Mention";
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof MentionEditing, typeof MentionUI];
+}
+/**
+ * Represents a mention in the model.
+ *
+ * See {@link module:mention/mention~Mention#toMentionAttribute `Mention#toMentionAttribute()`}.
+ */
+export type MentionAttribute = {
+    /**
+     * The ID of a mention. It identifies the mention item in the mention feed. There can be multiple mentions
+     * in the document with the same ID (e.g. the same hashtag being mentioned).
+     */
+    id: string;
+    /**
+     * A unique ID of this mention instance. Should be passed as an `option.id` when using
+     * {@link module:engine/view/downcastwriter~DowncastWriter#createAttributeElement writer.createAttributeElement()}.
+     */
+    uid: string;
+    /**
+     * Helper property that stores the text of the inserted mention. Used for detecting a broken mention
+     * in the editing area.
+     *
+     * @internal
+     */
+    _text: string;
+};

package/src/mention.js

@@ -1,33 +1,33 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module mention/mention
- */
-import { Plugin } from 'ckeditor5/src/core';
-import MentionEditing, { _toMentionAttribute } from './mentionediting';
-import MentionUI from './mentionui';
-import '../theme/mention.css';
-/**
- * The mention plugin.
- *
- * For a detailed overview, check the {@glink features/mentions Mention feature} guide.
- */
-export default class Mention extends Plugin {
-    toMentionAttribute(viewElement, data) {
-        return _toMentionAttribute(viewElement, data);
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'Mention';
-    }
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [MentionEditing, MentionUI];
-    }
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module mention/mention
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import MentionEditing, { _toMentionAttribute } from './mentionediting';
+import MentionUI from './mentionui';
+import '../theme/mention.css';
+/**
+ * The mention plugin.
+ *
+ * For a detailed overview, check the {@glink features/mentions Mention feature} guide.
+ */
+export default class Mention extends Plugin {
+    toMentionAttribute(viewElement, data) {
+        return _toMentionAttribute(viewElement, data);
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'Mention';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [MentionEditing, MentionUI];
+    }
+}

package/src/mentioncommand.d.ts

@@ -1,77 +1,77 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module mention/mentioncommand
- */
-import { Command, type Editor } from 'ckeditor5/src/core';
-import type { Range } from 'ckeditor5/src/engine';
-/**
- * The mention command.
- *
- * The command is registered by {@link module:mention/mentionediting~MentionEditing} as `'mention'`.
- *
- * To insert a mention into a range, execute the command and specify a mention object with a range to replace:
- *
- * ```ts
- * const focus = editor.model.document.selection.focus;
- *
- * // It will replace one character before the selection focus with the '#1234' text
- * // with the mention attribute filled with passed attributes.
- * editor.execute( 'mention', {
- * 	marker: '#',
- * 	mention: {
- * 		id: '#1234',
- * 		name: 'Foo',
- * 		title: 'Big Foo'
- * 	},
- * 	range: editor.model.createRange( focus.getShiftedBy( -1 ), focus )
- * } );
- *
- * // It will replace one character before the selection focus with the 'The "Big Foo"' text
- * // with the mention attribute filled with passed attributes.
- * editor.execute( 'mention', {
- * 	marker: '#',
- * 	mention: {
- * 		id: '#1234',
- * 		name: 'Foo',
- * 		title: 'Big Foo'
- * 	},
- * 	text: 'The "Big Foo"',
- * 	range: editor.model.createRange( focus.getShiftedBy( -1 ), focus )
- * } );
- *	```
- */
-export default class MentionCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command.
-     *
-     * @param options Options for the executed command.
-     * @param options.mention The mention object to insert. When a string is passed, it will be used to create a plain
-     * object with the name attribute that equals the passed string.
-     * @param options.marker The marker character (e.g. `'@'`).
-     * @param options.text The text of the inserted mention. Defaults to the full mention string composed from `marker` and
-     * `mention` string or `mention.id` if an object is passed.
-     * @param options.range The range to replace.
-     * Note that the replaced range might be shorter than the inserted text with the mention attribute.
-     * @fires execute
-     */
-    execute(options: {
-        mention: string | {
-            id: string;
-            [key: string]: unknown;
-        };
-        marker: string;
-        text?: string;
-        range?: Range;
-    }): void;
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module mention/mentioncommand
+ */
+import { Command, type Editor } from 'ckeditor5/src/core';
+import type { Range } from 'ckeditor5/src/engine';
+/**
+ * The mention command.
+ *
+ * The command is registered by {@link module:mention/mentionediting~MentionEditing} as `'mention'`.
+ *
+ * To insert a mention into a range, execute the command and specify a mention object with a range to replace:
+ *
+ * ```ts
+ * const focus = editor.model.document.selection.focus;
+ *
+ * // It will replace one character before the selection focus with the '#1234' text
+ * // with the mention attribute filled with passed attributes.
+ * editor.execute( 'mention', {
+ * 	marker: '#',
+ * 	mention: {
+ * 		id: '#1234',
+ * 		name: 'Foo',
+ * 		title: 'Big Foo'
+ * 	},
+ * 	range: editor.model.createRange( focus.getShiftedBy( -1 ), focus )
+ * } );
+ *
+ * // It will replace one character before the selection focus with the 'The "Big Foo"' text
+ * // with the mention attribute filled with passed attributes.
+ * editor.execute( 'mention', {
+ * 	marker: '#',
+ * 	mention: {
+ * 		id: '#1234',
+ * 		name: 'Foo',
+ * 		title: 'Big Foo'
+ * 	},
+ * 	text: 'The "Big Foo"',
+ * 	range: editor.model.createRange( focus.getShiftedBy( -1 ), focus )
+ * } );
+ *	```
+ */
+export default class MentionCommand extends Command {
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Executes the command.
+     *
+     * @param options Options for the executed command.
+     * @param options.mention The mention object to insert. When a string is passed, it will be used to create a plain
+     * object with the name attribute that equals the passed string.
+     * @param options.marker The marker character (e.g. `'@'`).
+     * @param options.text The text of the inserted mention. Defaults to the full mention string composed from `marker` and
+     * `mention` string or `mention.id` if an object is passed.
+     * @param options.range The range to replace.
+     * Note that the replaced range might be shorter than the inserted text with the mention attribute.
+     * @fires execute
+     */
+    execute(options: {
+        mention: string | {
+            id: string;
+            [key: string]: unknown;
+        };
+        marker: string;
+        text?: string;
+        range?: Range;
+    }): void;
+}