@ckeditor/ckeditor5-mention 37.0.0-alpha.0 → 37.0.0-alpha.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-mention",
-  "version": "37.0.0-alpha.0",
+  "version": "37.0.0-alpha.2",
   "description": "Mention feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -12,28 +12,28 @@
   ],
   "main": "src/index.js",
   "dependencies": {
-    "ckeditor5": "^37.0.0-alpha.0",
+    "ckeditor5": "^37.0.0-alpha.2",
     "lodash-es": "^4.17.15"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-basic-styles": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-block-quote": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-clipboard": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-cloud-services": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-core": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-dev-utils": "^34.0.0",
-    "@ckeditor/ckeditor5-editor-classic": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-engine": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-font": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-link": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-paragraph": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-table": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-theme-lark": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-typing": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-ui": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-undo": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-utils": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-widget": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-basic-styles": "^37.0.0-alpha.2",
+    "@ckeditor/ckeditor5-block-quote": "^37.0.0-alpha.2",
+    "@ckeditor/ckeditor5-clipboard": "^37.0.0-alpha.2",
+    "@ckeditor/ckeditor5-cloud-services": "^37.0.0-alpha.2",
+    "@ckeditor/ckeditor5-core": "^37.0.0-alpha.2",
+    "@ckeditor/ckeditor5-dev-utils": "^35.0.0",
+    "@ckeditor/ckeditor5-editor-classic": "^37.0.0-alpha.2",
+    "@ckeditor/ckeditor5-engine": "^37.0.0-alpha.2",
+    "@ckeditor/ckeditor5-font": "^37.0.0-alpha.2",
+    "@ckeditor/ckeditor5-link": "^37.0.0-alpha.2",
+    "@ckeditor/ckeditor5-paragraph": "^37.0.0-alpha.2",
+    "@ckeditor/ckeditor5-table": "^37.0.0-alpha.2",
+    "@ckeditor/ckeditor5-theme-lark": "^37.0.0-alpha.2",
+    "@ckeditor/ckeditor5-typing": "^37.0.0-alpha.2",
+    "@ckeditor/ckeditor5-ui": "^37.0.0-alpha.2",
+    "@ckeditor/ckeditor5-undo": "^37.0.0-alpha.2",
+    "@ckeditor/ckeditor5-utils": "^37.0.0-alpha.2",
+    "@ckeditor/ckeditor5-widget": "^37.0.0-alpha.2",
     "lodash": "^4.17.15",
     "typescript": "^4.8.4",
     "webpack": "^5.58.1",
@@ -63,7 +63,7 @@
   ],
   "scripts": {
     "dll:build": "webpack",
-    "build": "tsc -p ./tsconfig.release.json",
+    "build": "tsc -p ./tsconfig.json",
     "postversion": "npm run build"
   },
   "types": "src/index.d.ts"

package/src/augmentation.d.ts

@@ -0,0 +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;
+    }
+}

package/src/augmentation.js

@@ -0,0 +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 {};

package/src/index.d.ts

@@ -8,3 +8,6 @@
 export { default as Mention } from './mention';
 export { default as MentionEditing } from './mentionediting';
 export { default as MentionUI } from './mentionui';
+export type { MentionConfig } from './mentionconfig';
+export type { default as MentionCommand } from './mentioncommand';
+import './augmentation';

package/src/index.js

@@ -8,3 +8,4 @@
 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

@@ -62,8 +62,3 @@ export type MentionAttribute = {
      */
     _text?: string;
 };
-declare module '@ckeditor/ckeditor5-core' {
-    interface PluginsMap {
-        [Mention.pluginName]: Mention;
-    }
-}

package/src/mentioncommand.d.ts

@@ -69,8 +69,3 @@ export default class MentionCommand extends Command {
         range?: Range;
     }): void;
 }
-declare module '@ckeditor/ckeditor5-core' {
-    interface CommandsMap {
-        mention: MentionCommand;
-    }
-}

package/src/mentionconfig.d.ts

@@ -195,9 +195,9 @@ export interface MentionFeed {
  */
 export type FeedCallback = (searchString: string) => Array<MentionFeedItem> | Promise<Array<MentionFeedItem>>;
 /**
- * Function that takes renders a {@link module:mention/mentionconfig~MentionFeedItem} as HTMLElement.
+ * Function that takes renders a {@link module:mention/mentionconfig~MentionFeedObjectItem} as HTMLElement.
  */
-export type ItemRenderer = (item: MentionFeedItem) => HTMLElement;
+export type ItemRenderer = (item: MentionFeedObjectItem) => HTMLElement | string;
 /**
  * The mention feed item. It may be defined as a string or a plain object.
  *
@@ -261,15 +261,5 @@ export type MentionFeedObjectItem = {
     /**
      * Text inserted into the editor when creating a mention.
      */
-    text: string;
+    text?: string;
 };
-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;
-    }
-}

package/src/mentionediting.d.ts

@@ -38,8 +38,3 @@ export declare function _addMentionAttributes(baseMentionData: MentionAttribute,
  * @internal
  */
 export declare function _toMentionAttribute(viewElementOrMention: Element, data?: MentionAttribute): MentionAttribute | undefined;
-declare module '@ckeditor/ckeditor5-core' {
-    interface PluginsMap {
-        [MentionEditing.pluginName]: MentionEditing;
-    }
-}

package/src/mentionui.d.ts

@@ -63,10 +63,6 @@ export default class MentionUI extends Plugin {
     private _getItemRenderer;
     /**
      * Requests a feed from a configured callbacks.
-     *
-     * @fires response
-     * @fires discarded
-     * @fires error
      */
     private _requestFeed;
     /**
@@ -103,8 +99,3 @@ export default class MentionUI extends Plugin {
  * Function has to be exported to achieve 100% code coverage.
  */
 export declare function createRegExp(marker: string, minimumCharacters: number): RegExp;
-declare module '@ckeditor/ckeditor5-core' {
-    interface PluginsMap {
-        [MentionUI.pluginName]: MentionUI;
-    }
-}

package/src/mentionui.js

@@ -195,10 +195,6 @@ export default class MentionUI extends Plugin {
     }
     /**
      * Requests a feed from a configured callbacks.
-     *
-     * @fires response
-     * @fires discarded
-     * @fires error
      */
     _requestFeed(marker, feedText) {
         // @if CK_DEBUG_MENTION // console.log( '%c[Feed]%c Requesting for', 'color: blue', 'color: black', `"${ feedText }"` );