@tiptap/extension-emoji 2.24.2 → 3.0.0-beta.11

package/src/emoji.ts

@@ -9,8 +9,10 @@ import {
   nodeInputRule,
   PasteRule,
 } from '@tiptap/core'
-import { Plugin, PluginKey, Transaction } from '@tiptap/pm/state'
-import Suggestion, { SuggestionOptions } from '@tiptap/suggestion'
+import type { Transaction } from '@tiptap/pm/state'
+import { Plugin, PluginKey } from '@tiptap/pm/state'
+import type { SuggestionOptions } from '@tiptap/suggestion'
+import Suggestion from '@tiptap/suggestion'
 import emojiRegex from 'emoji-regex'
 import { isEmojiSupported } from 'is-emoji-supported'
 
@@ -25,7 +27,7 @@ declare module '@tiptap/core' {
       /**
        * Add an emoji
        */
-      setEmoji: (shortcode: string) => ReturnType,
+      setEmoji: (shortcode: string) => ReturnType
     }
   }
 }
@@ -34,52 +36,52 @@ export type EmojiItem = {
   /**
    * A unique name of the emoji which will be stored as attribute
    */
-  name: string,
+  name: string
   /**
    * The emoji unicode character
    */
-  emoji?: string,
+  emoji?: string
   /**
    * A list of unique shortcodes that are used by input rules to find the emoji
    */
-  shortcodes: string[],
+  shortcodes: string[]
   /**
    * A list of tags that can help for searching emojis
    */
-  tags: string[],
+  tags: string[]
   /**
    * A name that can help to group emojis
    */
-  group?: string,
+  group?: string
   /**
    * A list of unique emoticons
    */
-  emoticons?: string[],
+  emoticons?: string[]
   /**
    * The unicode version the emoji was introduced
    */
-  version?: number,
+  version?: number
   /**
    * A fallback image if the current system doesn't support the emoji or for custom emojis
    */
-  fallbackImage?: string,
+  fallbackImage?: string
   /**
    * Store some custom data
    */
-  [key: string]: any,
+  [key: string]: any
 }
 
 export type EmojiOptions = {
-  HTMLAttributes: Record<string, any>,
-  emojis: EmojiItem[],
-  enableEmoticons: boolean,
-  forceFallbackImages: boolean,
-  suggestion: Omit<SuggestionOptions, 'editor'>,
+  HTMLAttributes: Record<string, any>
+  emojis: EmojiItem[]
+  enableEmoticons: boolean
+  forceFallbackImages: boolean
+  suggestion: Omit<SuggestionOptions, 'editor'>
 }
 
 export type EmojiStorage = {
-  emojis: EmojiItem[],
-  isSupported: (item: EmojiItem) => boolean,
+  emojis: EmojiItem[]
+  isSupported: (item: EmojiItem) => boolean
 }
 
 export const EmojiSuggestionPluginKey = new PluginKey('emojiSuggestion')
@@ -155,18 +157,14 @@ export const Emoji = Node.create<EmojiOptions, EmojiStorage>({
 
         return {
           ...versions,
-          [version as number]: emoji
-            ? isEmojiSupported(emoji.emoji as string)
-            : false,
+          [version as number]: emoji ? isEmojiSupported(emoji.emoji as string) : false,
         }
       }, {})
 
     return {
       emojis: this.options.emojis,
       isSupported: emojiItem => {
-        return emojiItem.version
-          ? supportMap[emojiItem.version]
-          : false
+        return emojiItem.version ? supportMap[emojiItem.version] : false
       },
     }
   },
@@ -193,43 +191,35 @@ export const Emoji = Node.create<EmojiOptions, EmojiStorage>({
 
   renderHTML({ HTMLAttributes, node }) {
     const emojiItem = shortcodeToEmoji(node.attrs.name, this.options.emojis)
-    const attributes = mergeAttributes(
-      HTMLAttributes,
-      this.options.HTMLAttributes,
-      { 'data-type': this.name },
-    )
+    const attributes = mergeAttributes(HTMLAttributes, this.options.HTMLAttributes, { 'data-type': this.name })
 
     if (!emojiItem) {
-      return [
-        'span',
-        attributes,
-        `:${node.attrs.name}:`,
-      ]
+      return ['span', attributes, `:${node.attrs.name}:`]
     }
 
     const isSupported = this.storage.isSupported(emojiItem)
     const hasEmoji = !!emojiItem?.emoji
     const hasFallbackImage = !!emojiItem?.fallbackImage
 
-    const renderFallbackImage = (this.options.forceFallbackImages && !hasEmoji)
-      || (this.options.forceFallbackImages && hasFallbackImage)
-      || (this.options.forceFallbackImages && !isSupported && hasFallbackImage)
-      || ((!isSupported || !hasEmoji) && hasFallbackImage)
+    const renderFallbackImage =
+      (this.options.forceFallbackImages && !hasEmoji) ||
+      (this.options.forceFallbackImages && hasFallbackImage) ||
+      (this.options.forceFallbackImages && !isSupported && hasFallbackImage) ||
+      ((!isSupported || !hasEmoji) && hasFallbackImage)
 
     return [
       'span',
       attributes,
       renderFallbackImage
         ? [
-          'img',
-          {
-            src: emojiItem.fallbackImage,
-            draggable: 'false',
-            loading: 'lazy',
-            align: 'absmiddle',
-            alt: `${emojiItem.name} emoji`,
-          },
-        ]
+            'img',
+            {
+              src: emojiItem.fallbackImage,
+              draggable: 'false',
+              loading: 'lazy',
+              align: 'absmiddle',
+            },
+          ]
         : emojiItem.emoji || `:${emojiItem.shortcodes[0]}:`,
     ]
   },
@@ -242,27 +232,30 @@ export const Emoji = Node.create<EmojiOptions, EmojiStorage>({
 
   addCommands() {
     return {
-      setEmoji: shortcode => ({ chain }) => {
-        const emojiItem = shortcodeToEmoji(shortcode, this.options.emojis)
+      setEmoji:
+        shortcode =>
+        ({ chain }) => {
+          const emojiItem = shortcodeToEmoji(shortcode, this.options.emojis)
 
-        if (!emojiItem) {
-          return false
-        }
+          if (!emojiItem) {
+            return false
+          }
 
-        chain()
-          .insertContent({
-            type: this.name,
-            attrs: {
-              name: emojiItem.name,
-            },
-          })
-          .command(({ tr, state }) => {
-            tr.setStoredMarks(state.doc.resolve(state.selection.to - 1).marks())
-            return true
-          }).run()
+          chain()
+            .insertContent({
+              type: this.name,
+              attrs: {
+                name: emojiItem.name,
+              },
+            })
+            .command(({ tr, state }) => {
+              tr.setStoredMarks(state.doc.resolve(state.selection.to - 1).marks())
+              return true
+            })
+            .run()
 
-        return true
-      },
+          return true
+        },
     }
   },
 
@@ -289,7 +282,8 @@ export const Emoji = Node.create<EmojiOptions, EmojiStorage>({
             .command(({ tr, state }) => {
               tr.setStoredMarks(state.doc.resolve(state.selection.to - 1).marks())
               return true
-            }).run()
+            })
+            .run()
         },
       }),
     )
@@ -337,14 +331,18 @@ export const Emoji = Node.create<EmojiOptions, EmojiStorage>({
           }
 
           chain()
-            .insertContentAt(range, {
-              type: this.name,
-              attrs: {
-                name,
+            .insertContentAt(
+              range,
+              {
+                type: this.name,
+                attrs: {
+                  name,
+                },
               },
-            }, {
-              updateSelection: false,
-            })
+              {
+                updateSelection: false,
+              },
+            )
             .command(({ tr, state }) => {
               tr.setStoredMarks(state.doc.resolve(state.selection.to - 1).marks())
               return true
@@ -386,8 +384,7 @@ export const Emoji = Node.create<EmojiOptions, EmojiStorage>({
 
         // replace text emojis with emoji node on any change
         appendTransaction: (transactions, oldState, newState) => {
-          const docChanges = transactions.some(transaction => transaction.docChanged)
-            && !oldState.doc.eq(newState.doc)
+          const docChanges = transactions.some(transaction => transaction.docChanged) && !oldState.doc.eq(newState.doc)
 
           if (!docChanges) {
             return
@@ -444,7 +441,6 @@ export const Emoji = Node.create<EmojiOptions, EmojiStorage>({
                 tr.replaceRangeWith(from, to, emojiNode)
 
                 tr.setStoredMarks(newState.doc.resolve(from).marks())
-
               })
             })
           })

package/src/generate.ts

@@ -6,7 +6,7 @@ import gitHubShortcodes from 'emojibase-data/en/shortcodes/github.json'
 import fs from 'fs'
 import json5 from 'json5'
 
-import { EmojiItem } from './emoji.js'
+import type { EmojiItem } from './emoji.js'
 import { removeVariationSelector } from './helpers/removeVariationSelector.js'
 
 const emojis: EmojiItem[] = data
@@ -16,14 +16,9 @@ const emojis: EmojiItem[] = data
       return item.unified === emoji.hexcode || item.non_qualified === emoji.hexcode
     })
     const hasFallbackImage = dataSourceEmoji?.has_img_apple
-    const name = [gitHubShortcodes[emoji.hexcode]].flat()[0]
-      || [emojibaseShortcodes[emoji.hexcode]].flat()[0]
-    const shortcodes = emojibaseShortcodes[emoji.hexcode]
-      ? [emojibaseShortcodes[emoji.hexcode]].flat()
-      : []
-    const emoticons = emoji.emoticon
-      ? [emoji.emoticon].flat()
-      : []
+    const name = [gitHubShortcodes[emoji.hexcode]].flat()[0] || [emojibaseShortcodes[emoji.hexcode]].flat()[0]
+    const shortcodes = emojibaseShortcodes[emoji.hexcode] ? [emojibaseShortcodes[emoji.hexcode]].flat() : []
+    const emoticons = emoji.emoticon ? [emoji.emoticon].flat() : []
 
     return {
       emoji: removeVariationSelector(emoji.emoji),

package/src/helpers/emojiToShortcode.ts

@@ -1,4 +1,4 @@
-import { EmojiItem } from '../emoji.js'
+import type { EmojiItem } from '../emoji.js'
 import { removeVariationSelector } from './removeVariationSelector.js'
 
 export function emojiToShortcode(emoji: string, emojis: EmojiItem[]): string | undefined {

package/src/helpers/removeDuplicates.ts

@@ -8,8 +8,6 @@ export function removeDuplicates<T>(array: T[], by = JSON.stringify): T[] {
   return array.filter(item => {
     const key = by(item)
 
-    return Object.prototype.hasOwnProperty.call(seen, key)
-      ? false
-      : (seen[key] = true)
+    return Object.prototype.hasOwnProperty.call(seen, key) ? false : (seen[key] = true)
   })
 }

package/src/helpers/shortcodeToEmoji.ts

@@ -1,4 +1,4 @@
-import { EmojiItem } from '../emoji.js'
+import type { EmojiItem } from '../emoji.js'
 
 export function shortcodeToEmoji(shortcode: string, emojis: EmojiItem[]): EmojiItem | undefined {
   return emojis.find(item => shortcode === item.name || item.shortcodes.includes(shortcode))

package/dist/data.d.ts

@@ -1,5 +0,0 @@
-import { EmojiItem } from './emoji.js';
-export declare const emojis: EmojiItem[];
-export declare const gitHubCustomEmojis: EmojiItem[];
-export declare const gitHubEmojis: EmojiItem[];
-//# sourceMappingURL=data.d.ts.map

package/dist/data.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"data.d.ts","sourceRoot":"","sources":["../src/data.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAEtC,eAAO,MAAM,MAAM,EAAE,SAAS,EAmp9B7B,CAAA;AAED,eAAO,MAAM,kBAAkB,EAAE,SAAS,EA4KzC,CAAA;AAED,eAAO,MAAM,YAAY,EAAE,SAAS,EAAuC,CAAA"}

package/dist/emoji.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"emoji.d.ts","sourceRoot":"","sources":["../src/emoji.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,IAAI,EAGL,MAAM,cAAc,CAAA;AACrB,OAAO,EAAU,SAAS,EAAe,MAAM,kBAAkB,CAAA;AACjE,OAAmB,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AASlE,OAAO,QAAQ,cAAc,CAAC;IAC5B,UAAU,QAAQ,CAAC,UAAU;QAC3B,KAAK,EAAE;YACL;;eAEG;YACH,QAAQ,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,UAAU,CAAC;SAC7C,CAAA;KACF;CACF;AAED,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,EAAE,CAAC;IACf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACpC,MAAM,EAAE,SAAS,EAAE,CAAC;IACpB,eAAe,EAAE,OAAO,CAAC;IACzB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,UAAU,EAAE,IAAI,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;CAC/C,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,MAAM,EAAE,SAAS,EAAE,CAAC;IACpB,WAAW,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,OAAO,CAAC;CAC3C,CAAA;AAED,eAAO,MAAM,wBAAwB,gBAAmC,CAAA;AAExE,eAAO,MAAM,UAAU,QAAyB,CAAA;AAEhD,eAAO,MAAM,UAAU,QAAyB,CAAA;AAEhD,eAAO,MAAM,KAAK,kCAkXhB,CAAA"}

package/dist/helpers/emojiToShortcode.d.ts

@@ -1,3 +0,0 @@
-import { EmojiItem } from '../emoji.js';
-export declare function emojiToShortcode(emoji: string, emojis: EmojiItem[]): string | undefined;
-//# sourceMappingURL=emojiToShortcode.d.ts.map

package/dist/helpers/emojiToShortcode.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"emojiToShortcode.d.ts","sourceRoot":"","sources":["../../src/helpers/emojiToShortcode.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAGvC,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,GAAG,SAAS,CAEvF"}

package/dist/helpers/removeDuplicates.d.ts

@@ -1,9 +0,0 @@
-/**
- * Removes duplicated values within an array.
- * Supports numbers, strings and objects.
- */
-export declare function removeDuplicates<T>(array: T[], by?: {
-    (value: any, replacer?: (this: any, key: string, value: any) => any, space?: string | number): string;
-    (value: any, replacer?: (number | string)[] | null, space?: string | number): string;
-}): T[];
-//# sourceMappingURL=removeDuplicates.d.ts.map

package/dist/helpers/removeDuplicates.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"removeDuplicates.d.ts","sourceRoot":"","sources":["../../src/helpers/removeDuplicates.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE;;;CAAiB,GAAG,CAAC,EAAE,CAUxE"}

package/dist/helpers/removeVariationSelector.d.ts

@@ -1,2 +0,0 @@
-export declare function removeVariationSelector(value: string): string;
-//# sourceMappingURL=removeVariationSelector.d.ts.map

package/dist/helpers/removeVariationSelector.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"removeVariationSelector.d.ts","sourceRoot":"","sources":["../../src/helpers/removeVariationSelector.ts"],"names":[],"mappings":"AAAA,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE7D"}

package/dist/helpers/shortcodeToEmoji.d.ts

@@ -1,3 +0,0 @@
-import { EmojiItem } from '../emoji.js';
-export declare function shortcodeToEmoji(shortcode: string, emojis: EmojiItem[]): EmojiItem | undefined;
-//# sourceMappingURL=shortcodeToEmoji.d.ts.map

package/dist/helpers/shortcodeToEmoji.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"shortcodeToEmoji.d.ts","sourceRoot":"","sources":["../../src/helpers/shortcodeToEmoji.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAEvC,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,SAAS,GAAG,SAAS,CAE9F"}

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAElC,cAAc,WAAW,CAAA;AACzB,cAAc,YAAY,CAAA;AAC1B,cAAc,+BAA+B,CAAA;AAC7C,cAAc,+BAA+B,CAAA;AAE7C,eAAe,KAAK,CAAA"}