@ckeditor/ckeditor5-emoji 44.2.0 → 44.2.1-alpha.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-emoji",
-  "version": "44.2.0",
+  "version": "44.2.1-alpha.0",
   "description": "Emoji feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -13,13 +13,13 @@
   "type": "module",
   "main": "src/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-core": "44.2.0",
-    "@ckeditor/ckeditor5-mention": "44.2.0",
-    "@ckeditor/ckeditor5-typing": "44.2.0",
-    "@ckeditor/ckeditor5-ui": "44.2.0",
-    "@ckeditor/ckeditor5-utils": "44.2.0",
-    "ckeditor5": "44.2.0",
-    "fuse.js": "7.0.0",
+    "@ckeditor/ckeditor5-core": "44.2.1-alpha.0",
+    "@ckeditor/ckeditor5-mention": "44.2.1-alpha.0",
+    "@ckeditor/ckeditor5-typing": "44.2.1-alpha.0",
+    "@ckeditor/ckeditor5-ui": "44.2.1-alpha.0",
+    "@ckeditor/ckeditor5-utils": "44.2.1-alpha.0",
+    "ckeditor5": "44.2.1-alpha.0",
+    "fuzzysort": "3.1.0",
     "lodash-es": "4.17.21"
   },
   "author": "CKSource (http://cksource.com/)",
@@ -41,6 +41,11 @@
     "ckeditor5-metadata.json",
     "CHANGELOG.md"
   ],
+  "sideEffects": [
+    "*.css",
+    "build/**/*.js",
+    "dist/translations/*.umd.js"
+  ],
   "types": "src/index.d.ts",
   "exports": {
     ".": {

package/src/emojirepository.d.ts

@@ -16,9 +16,9 @@ export default class EmojiRepository extends Plugin {
      */
     private _repositoryPromiseResolveCallback;
     /**
-     * An instance of the [Fuse.js](https://www.fusejs.io/) library.
+     * Emoji repository in a configured version.
      */
-    private _fuseSearch;
+    private _items;
     /**
      * The resolved URL from which the emoji repository is downloaded.
      */
@@ -50,8 +50,7 @@ export default class EmojiRepository extends Plugin {
     init(): Promise<void>;
     /**
      * Returns an array of emoji entries that match the search query.
-     * If the emoji repository is not loaded, the [Fuse.js](https://www.fusejs.io/) instance is not created,
-     * hence this method returns an empty array.
+     * If the emoji repository is not loaded this method returns an empty array.
      *
      * @param searchQuery A search query to match emoji.
      * @returns An array of emoji entries that match the search query.

package/src/emojirepository.js

@@ -5,7 +5,7 @@
 /**
  * @module emoji/emojirepository
  */
-import Fuse from 'fuse.js';
+import fuzzysort from 'fuzzysort';
 import { groupBy } from 'lodash-es';
 import { Plugin } from 'ckeditor5/src/core.js';
 import { logWarning, version as editorVersion } from 'ckeditor5/src/utils.js';
@@ -52,7 +52,7 @@ class EmojiRepository extends Plugin {
         this._repositoryPromise = new Promise(resolve => {
             this._repositoryPromiseResolveCallback = resolve;
         });
-        this._fuseSearch = null;
+        this._items = null;
     }
     /**
      * @inheritDoc
@@ -60,35 +60,21 @@ class EmojiRepository extends Plugin {
     async init() {
         this._warnAboutCdnUse();
         await this._loadAndCacheEmoji();
-        const items = this._getItems();
-        // Skip plugin initialization if the emoji repository is not available.
-        // The initialization of other dependent plugins, such as `EmojiMention` and `EmojiPicker`, is prevented as well.
-        if (!items) {
+        this._items = this._getItems();
+        if (!this._items) {
             return this._repositoryPromiseResolveCallback(false);
         }
-        // Create instance of the Fuse.js library with configured weighted search keys and disabled fuzzy search.
-        this._fuseSearch = new Fuse(items, {
-            keys: [
-                { name: 'emoticon', weight: 5 },
-                { name: 'annotation', weight: 3 },
-                { name: 'tags', weight: 1 }
-            ],
-            minMatchCharLength: 2,
-            threshold: 0,
-            ignoreLocation: true
-        });
         return this._repositoryPromiseResolveCallback(true);
     }
     /**
      * Returns an array of emoji entries that match the search query.
-     * If the emoji repository is not loaded, the [Fuse.js](https://www.fusejs.io/) instance is not created,
-     * hence this method returns an empty array.
+     * If the emoji repository is not loaded this method returns an empty array.
      *
      * @param searchQuery A search query to match emoji.
      * @returns An array of emoji entries that match the search query.
      */
     getEmojiByQuery(searchQuery) {
-        if (!this._fuseSearch) {
+        if (!this._items) {
             return [];
         }
         const searchQueryTokens = searchQuery.split(/\s/).filter(Boolean);
@@ -97,21 +83,25 @@ class EmojiRepository extends Plugin {
         if (!shouldSearch) {
             return [];
         }
-        return this._fuseSearch
-            .search({
-            '$or': [
-                {
-                    emoticon: searchQuery
-                },
-                {
-                    '$and': searchQueryTokens.map(token => ({ annotation: token }))
-                },
-                {
-                    '$and': searchQueryTokens.map(token => ({ tags: token }))
+        return fuzzysort
+            .go(searchQuery, this._items, {
+            threshold: 0.6,
+            keys: [
+                'emoticon',
+                'annotation',
+                (emojiEntry) => {
+                    // Instead of searching over all tags, let's use only those that matches the query.
+                    // It enables searching in tags with the space character in names.
+                    const searchQueryTokens = searchQuery.split(/\s/).filter(Boolean);
+                    const matchedTags = searchQueryTokens.flatMap(tok => {
+                        var _a;
+                        return (_a = emojiEntry.tags) === null || _a === void 0 ? void 0 : _a.filter(t => t.startsWith(tok));
+                    });
+                    return matchedTags.join();
                 }
             ]
         })
-            .map(result => result.item);
+            .map(result => result.obj);
     }
     /**
      * Groups all emojis by categories.