@ckeditor/ckeditor5-mention 0.0.0-nightly-20230906.0 → 0.0.0-nightly-20230908.0

package/package.json

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

package/src/mention.d.ts

@@ -17,7 +17,7 @@ import '../theme/mention.css';
  */
 export default class Mention extends Plugin {
     /**
-     * Creates a mention attribute value from the provided view element and optional data.
+     * Creates a mention attribute value from the provided view element and additional data.
      *
      * ```ts
      * editor.plugins.get( 'Mention' ).toMentionAttribute( viewElement, { userId: '1234' } );
@@ -27,10 +27,21 @@ export default class Mention extends Plugin {
      * // { 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;
+    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
      */
@@ -55,12 +66,12 @@ export type MentionAttribute = {
      * 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;
+    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;
+    _text: string;
 };

package/src/mention.js

@@ -15,20 +15,6 @@ import '../theme/mention.css';
  * 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);
     }

package/src/mentioncommand.d.ts

@@ -7,7 +7,6 @@
  */
 import { Command, type Editor } from 'ckeditor5/src/core';
 import type { Range } from 'ckeditor5/src/engine';
-import type { MentionAttribute } from './mention';
 /**
  * The mention command.
  *
@@ -67,7 +66,10 @@ export default class MentionCommand extends Command {
      * @fires execute
      */
     execute(options: {
-        mention: string | MentionAttribute;
+        mention: string | {
+            id: string;
+            [key: string]: unknown;
+        };
         marker: string;
         text?: string;
         range?: Range;

package/src/mentionediting.d.ts

@@ -28,7 +28,10 @@ export default class MentionEditing extends Plugin {
 /**
  * @internal
  */
-export declare function _addMentionAttributes(baseMentionData: MentionAttribute, data?: MentionAttribute): MentionAttribute;
+export declare function _addMentionAttributes(baseMentionData: {
+    id: string;
+    _text: string;
+}, data?: Record<string, unknown>): MentionAttribute;
 /**
  * Creates a mention attribute value from the provided view element and optional data.
  *
@@ -37,4 +40,4 @@ export declare function _addMentionAttributes(baseMentionData: MentionAttribute,
  *
  * @internal
  */
-export declare function _toMentionAttribute(viewElementOrMention: Element, data?: MentionAttribute): MentionAttribute | undefined;
+export declare function _toMentionAttribute(viewElementOrMention: Element, data?: Record<string, unknown>): MentionAttribute | undefined;