@ckeditor/ckeditor5-emoji 44.2.0-alpha.6 → 44.2.0-alpha.8

package/dist/index.js

@@ -9,10 +9,68 @@ import Fuse from 'fuse.js';
 import { groupBy, escapeRegExp } from 'lodash-es';
 import { View, addKeyboardHandlingForGrid, ButtonView, FocusCycler, SearchTextView, createLabeledInputText, createDropdown, ViewModel, addListToDropdown, SearchInfoView, ContextualBalloon, Dialog, MenuBarMenuListItemButtonView, clickOutsideHandler } from '@ckeditor/ckeditor5-ui/dist/index.js';
 
-// An endpoint from which the emoji database will be downloaded during plugin initialization.
-// The `{version}` placeholder is replaced with the value from editor config.
-const EMOJI_DATABASE_URL = 'https://cdn.ckeditor.com/ckeditor5/data/emoji/{version}/en.json';
-const SKIN_TONE_MAP = {
+/**
+ * @license Copyright (c) 2023, Koala Interactive SAS
+ * For licensing, see https://github.com/koala-interactive/is-emoji-supported/blob/master/LICENSE.md
+ */ /**
+ * @module emoji/utils/isemojisupported
+ */ /**
+ * Checks if the two pixels parts are the same using canvas.
+ */ function isEmojiSupported(unicode) {
+    const ctx = getCanvas();
+    /* istanbul ignore next -- @preserve */ if (!ctx) {
+        return false;
+    }
+    const CANVAS_HEIGHT = 25;
+    const CANVAS_WIDTH = 20;
+    const textSize = Math.floor(CANVAS_HEIGHT / 2);
+    // Initialize canvas context.
+    ctx.font = textSize + 'px Arial, Sans-Serif';
+    ctx.textBaseline = 'top';
+    ctx.canvas.width = CANVAS_WIDTH * 2;
+    ctx.canvas.height = CANVAS_HEIGHT;
+    ctx.clearRect(0, 0, CANVAS_WIDTH * 2, CANVAS_HEIGHT);
+    // Draw in red on the left.
+    ctx.fillStyle = '#FF0000';
+    ctx.fillText(unicode, 0, 22);
+    // Draw in blue on right.
+    ctx.fillStyle = '#0000FF';
+    ctx.fillText(unicode, CANVAS_WIDTH, 22);
+    const a = ctx.getImageData(0, 0, CANVAS_WIDTH, CANVAS_HEIGHT).data;
+    const count = a.length;
+    let i = 0;
+    // Search the first visible pixel.
+    for(; i < count && !a[i + 3]; i += 4);
+    // No visible pixel.
+    /* istanbul ignore next -- @preserve */ if (i >= count) {
+        return false;
+    }
+    // Emoji has immutable color, so we check the color of the emoji in two different colors.
+    // the result show be the same.
+    const x = CANVAS_WIDTH + i / 4 % CANVAS_WIDTH;
+    const y = Math.floor(i / 4 / CANVAS_WIDTH);
+    const b = ctx.getImageData(x, y, 1, 1).data;
+    if (a[i] !== b[0] || a[i + 2] !== b[2]) {
+        return false;
+    }
+    //Some emojis consist of different ones, so they will show multiple characters if they are not supported.
+    /* istanbul ignore next -- @preserve */ if (ctx.measureText(unicode).width >= CANVAS_WIDTH) {
+        return false;
+    }
+    // Supported.
+    return true;
+}
+function getCanvas() {
+    try {
+        return document.createElement('canvas').getContext('2d');
+    } catch  {
+        /* istanbul ignore next -- @preserve */ return null;
+    }
+}
+
+/**
+ * @module emoji/emojiutils
+ */ const SKIN_TONE_MAP = {
     0: 'default',
     1: 'light',
     2: 'medium-light',
@@ -20,12 +78,127 @@ const SKIN_TONE_MAP = {
     4: 'medium-dark',
     5: 'dark'
 };
+/**
+ * A map representing an emoji and its release version.
+ * It's used to identify a user's minimal supported emoji level.
+ */ const EMOJI_SUPPORT_LEVEL = {
+    '🫩': 16,
+    '🫨': 15.1 // Shaking head. Although the version of emoji is 15, it is used to detect versions 15 and 15.1.
+};
 const BASELINE_EMOJI_WIDTH = 24;
+/**
+ * The Emoji utilities plugin.
+ */ class EmojiUtils extends Plugin {
+    /**
+	 * @inheritDoc
+	 */ static get pluginName() {
+        return 'EmojiUtils';
+    }
+    /**
+	 * @inheritDoc
+	 */ static get isOfficialPlugin() {
+        return true;
+    }
+    /**
+	 * Checks if the emoji is supported by verifying the emoji version supported by the system first.
+	 * Then checks if emoji contains a zero width joiner (ZWJ), and if yes, then checks if it is supported by the system.
+	 */ isEmojiSupported(item, emojiSupportedVersionByOs, container) {
+        const isEmojiVersionSupported = item.version <= emojiSupportedVersionByOs;
+        if (!isEmojiVersionSupported) {
+            return false;
+        }
+        if (!this.hasZwj(item.emoji)) {
+            return true;
+        }
+        return this.isEmojiZwjSupported(item, container);
+    }
+    /**
+	 * Checks the supported emoji version by the OS, by sampling some representatives from different emoji releases.
+	 */ getEmojiSupportedVersionByOs() {
+        return Object.entries(EMOJI_SUPPORT_LEVEL).reduce((currentVersion, [emoji, newVersion])=>{
+            if (newVersion > currentVersion && EmojiUtils._isEmojiSupported(emoji)) {
+                return newVersion;
+            }
+            return currentVersion;
+        }, 0);
+    }
+    /**
+	 * Check for ZWJ (zero width joiner) character.
+	 */ hasZwj(emoji) {
+        return emoji.includes('\u200d');
+    }
+    /**
+	 * Checks whether the emoji is supported in the operating system.
+	 */ isEmojiZwjSupported(item, container) {
+        const emojiWidth = this.getNodeWidth(container, item.emoji);
+        // On Windows, some supported emoji are ~50% bigger than the baseline emoji, but what we really want to guard
+        // against are the ones that are 2x the size, because those are truly broken (person with red hair = person with
+        // floating red wig, black cat = cat with black square, polar bear = bear with snowflake, etc.)
+        // So here we set the threshold at 1.8 times the size of the baseline emoji.
+        return emojiWidth < BASELINE_EMOJI_WIDTH * 1.8;
+    }
+    /**
+	 * Returns the width of the provided node.
+	 */ getNodeWidth(container, node) {
+        const span = document.createElement('span');
+        span.textContent = node;
+        container.appendChild(span);
+        const nodeWidth = span.offsetWidth;
+        container.removeChild(span);
+        return nodeWidth;
+    }
+    /**
+	 * Creates a div for emoji width testing purposes.
+	 */ createEmojiWidthTestingContainer() {
+        const container = document.createElement('div');
+        container.setAttribute('aria-hidden', 'true');
+        container.style.position = 'absolute';
+        container.style.left = '-9999px';
+        container.style.whiteSpace = 'nowrap';
+        container.style.fontSize = BASELINE_EMOJI_WIDTH + 'px';
+        return container;
+    }
+    /**
+	 * Adds default skin tone property to each emoji. If emoji defines other skin tones, they are added as well.
+	 */ normalizeEmojiSkinTone(item) {
+        const entry = {
+            ...item,
+            skins: {
+                default: item.emoji
+            }
+        };
+        if (item.skins) {
+            item.skins.forEach((skin)=>{
+                const skinTone = SKIN_TONE_MAP[skin.tone];
+                entry.skins[skinTone] = skin.emoji;
+            });
+        }
+        return entry;
+    }
+    /**
+	 * Checks whether the emoji belongs to a group that is allowed.
+	 */ isEmojiCategoryAllowed(item) {
+        // Category group=2 contains skin tones only, which we do not want to render.
+        return item.group !== 2;
+    }
+    /**
+	 * A function used to determine if emoji is supported by detecting pixels.
+	 *
+	 * Referenced for unit testing purposes. Kept in a separate file because of licensing.
+	 */ static _isEmojiSupported = isEmojiSupported;
+}
+
+// An endpoint from which the emoji database will be downloaded during plugin initialization.
+// The `{version}` placeholder is replaced with the value from editor config.
+const EMOJI_DATABASE_URL = 'https://cdn.ckeditor.com/ckeditor5/data/emoji/{version}/en.json';
 /**
  * The emoji repository plugin.
  *
  * Loads the emoji database from URL during plugin initialization and provides utility methods to search it.
  */ class EmojiRepository extends Plugin {
+    /**
+	 * An instance of the [Fuse.js](https://www.fusejs.io/) library.
+	 */ _fuseSearch;
     /**
 	 * Emoji database.
 	 */ _database;
@@ -34,8 +207,12 @@ const BASELINE_EMOJI_WIDTH = 24;
 	 * The promise resolves with `true` when the database is successfully downloaded or `false` otherwise.
 	 */ _databasePromise;
     /**
-	 * An instance of the [Fuse.js](https://www.fusejs.io/) library.
-	 */ _fuseSearch;
+	 * @inheritDoc
+	 */ static get requires() {
+        return [
+            EmojiUtils
+        ];
+    }
     /**
 	 * @inheritDoc
 	 */ static get pluginName() {
@@ -63,17 +240,20 @@ const BASELINE_EMOJI_WIDTH = 24;
     /**
 	 * @inheritDoc
 	 */ async init() {
+        const emojiUtils = this.editor.plugins.get('EmojiUtils');
         const emojiVersion = this.editor.config.get('emoji.version');
         const emojiDatabaseUrl = EMOJI_DATABASE_URL.replace('{version}', `${emojiVersion}`);
         const emojiDatabase = await loadEmojiDatabase(emojiDatabaseUrl);
+        const emojiSupportedVersionByOs = emojiUtils.getEmojiSupportedVersionByOs();
         // Skip the initialization if the emoji database download has failed.
         // An empty database prevents the initialization of other dependent plugins, such as `EmojiMention` and `EmojiPicker`.
         if (!emojiDatabase.length) {
             return this._databasePromiseResolveCallback(false);
         }
-        const container = createEmojiWidthTestingContainer();
+        const container = emojiUtils.createEmojiWidthTestingContainer();
+        document.body.appendChild(container);
         // Store the emoji database after normalizing the raw data.
-        this._database = emojiDatabase.filter((item)=>isEmojiCategoryAllowed(item)).filter((item)=>EmojiRepository._isEmojiSupported(item, container)).map((item)=>normalizeEmojiSkinTone(item));
+        this._database = emojiDatabase.filter((item)=>emojiUtils.isEmojiCategoryAllowed(item)).filter((item)=>emojiUtils.isEmojiSupported(item, emojiSupportedVersionByOs, container)).map((item)=>emojiUtils.normalizeEmojiSkinTone(item));
         container.remove();
         // Create instance of the Fuse.js library with configured weighted search keys and disabled fuzzy search.
         this._fuseSearch = new Fuse(this._database, {
@@ -239,11 +419,6 @@ const BASELINE_EMOJI_WIDTH = 24;
 	 */ isReady() {
         return this._databasePromise;
     }
-    /**
-	 * A function used to check if the given emoji is supported in the operating system.
-	 *
-	 * Referenced for unit testing purposes.
-	 */ static _isEmojiSupported = isEmojiSupported;
 }
 /**
  * Makes the HTTP request to download the emoji database.
@@ -269,61 +444,6 @@ const BASELINE_EMOJI_WIDTH = 24;
     }
     return result;
 }
-/**
- * Creates a div for emoji width testing purposes.
- */ function createEmojiWidthTestingContainer() {
-    const container = document.createElement('div');
-    container.setAttribute('aria-hidden', 'true');
-    container.style.position = 'absolute';
-    container.style.left = '-9999px';
-    container.style.whiteSpace = 'nowrap';
-    container.style.fontSize = BASELINE_EMOJI_WIDTH + 'px';
-    document.body.appendChild(container);
-    return container;
-}
-/**
- * Returns the width of the provided node.
- */ function getNodeWidth(container, node) {
-    const span = document.createElement('span');
-    span.textContent = node;
-    container.appendChild(span);
-    const nodeWidth = span.offsetWidth;
-    container.removeChild(span);
-    return nodeWidth;
-}
-/**
- * Checks whether the emoji is supported in the operating system.
- */ function isEmojiSupported(item, container) {
-    const emojiWidth = getNodeWidth(container, item.emoji);
-    // On Windows, some supported emoji are ~50% bigger than the baseline emoji, but what we really want to guard
-    // against are the ones that are 2x the size, because those are truly broken (person with red hair = person with
-    // floating red wig, black cat = cat with black square, polar bear = bear with snowflake, etc.)
-    // So here we set the threshold at 1.8 times the size of the baseline emoji.
-    return emojiWidth / 1.8 < BASELINE_EMOJI_WIDTH && emojiWidth >= BASELINE_EMOJI_WIDTH;
-}
-/**
- * Adds default skin tone property to each emoji. If emoji defines other skin tones, they are added as well.
- */ function normalizeEmojiSkinTone(item) {
-    const entry = {
-        ...item,
-        skins: {
-            default: item.emoji
-        }
-    };
-    if (item.skins) {
-        item.skins.forEach((skin)=>{
-            const skinTone = SKIN_TONE_MAP[skin.tone];
-            entry.skins[skinTone] = skin.emoji;
-        });
-    }
-    return entry;
-}
-/**
- * Checks whether the emoji belongs to a group that is allowed.
- */ function isEmojiCategoryAllowed(item) {
-    // Category group=2 contains skin tones only, which we do not want to render.
-    return item.group !== 2;
-}
 
 const EMOJI_MENTION_MARKER = ':';
 const EMOJI_SHOW_ALL_OPTION_ID = ':__EMOJI_SHOW_ALL:';
@@ -411,9 +531,9 @@ const EMOJI_HINT_OPTION_ID = ':__EMOJI_HINT:';
 	 * @inheritDoc
 	 */ async init() {
         const editor = this.editor;
-        this._emojiPickerPlugin = editor.plugins.has('EmojiPicker') ? editor.plugins.get('EmojiPicker') : null;
-        this._emojiRepositoryPlugin = editor.plugins.get('EmojiRepository');
-        this._isEmojiRepositoryAvailable = await this._emojiRepositoryPlugin.isReady();
+        this.emojiPickerPlugin = editor.plugins.has('EmojiPicker') ? editor.plugins.get('EmojiPicker') : null;
+        this.emojiRepositoryPlugin = editor.plugins.get('EmojiRepository');
+        this._isEmojiRepositoryAvailable = await this.emojiRepositoryPlugin.isReady();
         // Override the `mention` command listener if the emoji repository is ready.
         if (this._isEmojiRepositoryAvailable) {
             editor.once('ready', this._overrideMentionExecuteListener.bind(this));
@@ -470,7 +590,7 @@ const EMOJI_HINT_OPTION_ID = ':__EMOJI_HINT:';
                 editor.model.change((writer)=>{
                     editor.model.deleteContent(writer.createSelection(eventData.range));
                 });
-                const emojiPickerPlugin = this._emojiPickerPlugin;
+                const emojiPickerPlugin = this.emojiPickerPlugin;
                 emojiPickerPlugin.showUI(text.slice(1));
                 setTimeout(()=>{
                     emojiPickerPlugin.emojiPickerView.focus();
@@ -497,17 +617,17 @@ const EMOJI_HINT_OPTION_ID = ':__EMOJI_HINT:';
             if (!this._isEmojiRepositoryAvailable) {
                 return [];
             }
-            const emojis = this._emojiRepositoryPlugin.getEmojiByQuery(searchQuery).map((emoji)=>{
+            const emojis = this.emojiRepositoryPlugin.getEmojiByQuery(searchQuery).map((emoji)=>{
                 let text = emoji.skins[this._skinTone] || emoji.skins.default;
-                if (this._emojiPickerPlugin) {
-                    text = emoji.skins[this._emojiPickerPlugin.skinTone] || emoji.skins.default;
+                if (this.emojiPickerPlugin) {
+                    text = emoji.skins[this.emojiPickerPlugin.skinTone] || emoji.skins.default;
                 }
                 return {
                     id: `:${emoji.annotation}:`,
                     text
                 };
             });
-            if (!this._emojiPickerPlugin) {
+            if (!this.emojiPickerPlugin) {
                 return emojis.slice(0, this._emojiDropdownLimit);
             }
             const actionItem = {
@@ -1245,10 +1365,10 @@ const VISUAL_SELECTION_MARKER_NAME = 'emoji-picker';
 	 * @inheritDoc
 	 */ async init() {
         const editor = this.editor;
-        this._balloonPlugin = editor.plugins.get('ContextualBalloon');
-        this._emojiRepositoryPlugin = editor.plugins.get('EmojiRepository');
+        this.balloonPlugin = editor.plugins.get('ContextualBalloon');
+        this.emojiRepositoryPlugin = editor.plugins.get('EmojiRepository');
         // Skip registering a button in the toolbar and list item in the menu bar if the emoji repository is not ready.
-        if (!await this._emojiRepositoryPlugin.isReady()) {
+        if (!await this.emojiRepositoryPlugin.isReady()) {
             return;
         }
         const command = new EmojiCommand(editor);
@@ -1299,8 +1419,8 @@ const VISUAL_SELECTION_MARKER_NAME = 'emoji-picker';
             this.emojiPickerView.searchView.setInputValue(searchValue);
         }
         this.emojiPickerView.searchView.search(searchValue);
-        if (!this._balloonPlugin.hasView(this.emojiPickerView)) {
-            this._balloonPlugin.add({
+        if (!this.balloonPlugin.hasView(this.emojiPickerView)) {
+            this.balloonPlugin.add({
                 view: this.emojiPickerView,
                 position: this._getBalloonPositionData()
             });
@@ -1327,11 +1447,11 @@ const VISUAL_SELECTION_MARKER_NAME = 'emoji-picker';
 	 * Creates an instance of the `EmojiPickerView` class that represents an emoji balloon.
 	 */ _createEmojiPickerView() {
         const emojiPickerView = new EmojiPickerView(this.editor.locale, {
-            emojiCategories: this._emojiRepositoryPlugin.getEmojiCategories(),
+            emojiCategories: this.emojiRepositoryPlugin.getEmojiCategories(),
             skinTone: this.editor.config.get('emoji.skinTone'),
-            skinTones: this._emojiRepositoryPlugin.getSkinTones(),
+            skinTones: this.emojiRepositoryPlugin.getSkinTones(),
             getEmojiByQuery: (query)=>{
-                return this._emojiRepositoryPlugin.getEmojiByQuery(query);
+                return this.emojiRepositoryPlugin.getEmojiByQuery(query);
             }
         });
         // Insert an emoji on a tile click.
@@ -1345,8 +1465,8 @@ const VISUAL_SELECTION_MARKER_NAME = 'emoji-picker';
         });
         // Update the balloon position when layout is changed.
         this.listenTo(emojiPickerView, 'update', ()=>{
-            if (this._balloonPlugin.visibleView === emojiPickerView) {
-                this._balloonPlugin.updatePosition();
+            if (this.balloonPlugin.visibleView === emojiPickerView) {
+                this.balloonPlugin.updatePosition();
             }
         });
         // Close the panel on `Esc` key press when the **actions have focus**.
@@ -1358,17 +1478,17 @@ const VISUAL_SELECTION_MARKER_NAME = 'emoji-picker';
         clickOutsideHandler({
             emitter: emojiPickerView,
             contextElements: [
-                this._balloonPlugin.view.element
+                this.balloonPlugin.view.element
             ],
             callback: ()=>this._hideUI(),
-            activator: ()=>this._balloonPlugin.visibleView === emojiPickerView
+            activator: ()=>this.balloonPlugin.visibleView === emojiPickerView
         });
         return emojiPickerView;
     }
     /**
 	 * Hides the balloon with the emoji picker.
 	 */ _hideUI() {
-        this._balloonPlugin.remove(this.emojiPickerView);
+        this.balloonPlugin.remove(this.emojiPickerView);
         this.emojiPickerView.searchView.setInputValue('');
         this.editor.editing.view.focus();
         this._hideFakeVisualSelection();
@@ -1403,7 +1523,7 @@ const VISUAL_SELECTION_MARKER_NAME = 'emoji-picker';
         });
     }
     /**
-	 * Returns positioning options for the {@link #_balloonPlugin}. They control the way the balloon is attached
+	 * Returns positioning options for the {@link #balloonPlugin}. They control the way the balloon is attached
 	 * to the target element or selection.
 	 */ _getBalloonPositionData() {
         const view = this.editor.editing.view;
@@ -1486,5 +1606,5 @@ const VISUAL_SELECTION_MARKER_NAME = 'emoji-picker';
     }
 }
 
-export { Emoji, EmojiCommand, EmojiMention, EmojiPicker, EmojiRepository };
+export { Emoji, EmojiCommand, EmojiMention, EmojiPicker, EmojiRepository, EmojiUtils };
 //# sourceMappingURL=index.js.map