@ckeditor/ckeditor5-mention 38.1.1 → 38.2.0-alpha.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-mention",
-  "version": "38.1.1",
+  "version": "38.2.0-alpha.1",
   "description": "Mention feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -11,8 +11,9 @@
     "ckeditor5-dll"
   ],
   "main": "src/index.js",
+  "type": "module",
   "dependencies": {
-    "ckeditor5": "38.1.1",
+    "ckeditor5": "38.2.0-alpha.1",
     "lodash-es": "^4.17.15"
   },
   "engines": {

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.js';
+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.js';
+export { default as MentionEditing } from './mentionediting.js';
+export { default as MentionUI } from './mentionui.js';
+export type { MentionConfig, MentionFeed, ItemRenderer } from './mentionconfig.js';
+export type { default as MentionCommand } from './mentioncommand.js';
+import './augmentation.js';

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.js';
+export { default as MentionEditing } from './mentionediting.js';
+export { default as MentionUI } from './mentionui.js';
+import './augmentation.js';

package/src/mention.d.ts

@@ -1,66 +1,66 @@
-/**
- * @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 optional 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 viewElement
-     * @param data Additional data to be stored in the mention attribute.
-     */
-    toMentionAttribute(viewElement: Element, data?: MentionAttribute): 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.js';
+import type { Element } from 'ckeditor5/src/engine.js';
+import MentionEditing from './mentionediting.js';
+import MentionUI from './mentionui.js';
+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 optional 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 viewElement
+     * @param data Additional data to be stored in the mention attribute.
+     */
+    toMentionAttribute(viewElement: Element, data?: MentionAttribute): 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,47 +1,47 @@
-/**
- * @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 {
-    /**
-     * Creates a mention attribute value from the provided view element and optional 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 viewElement
-     * @param data Additional data to be stored in the mention attribute.
-     */
-    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.js';
+import MentionEditing, { _toMentionAttribute } from './mentionediting.js';
+import MentionUI from './mentionui.js';
+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 optional 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 viewElement
+     * @param data Additional data to be stored in the mention attribute.
+     */
+    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,75 +1,75 @@
-/**
- * @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';
-import type { MentionAttribute } from './mention';
-/**
- * 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 | MentionAttribute;
-        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.js';
+import type { Range } from 'ckeditor5/src/engine.js';
+import type { MentionAttribute } from './mention.js';
+/**
+ * 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 | MentionAttribute;
+        marker: string;
+        text?: string;
+        range?: Range;
+    }): void;
+}