@mkody/twitch-emoticons 3.0.0-beta.3 → 3.0.0-beta.4

package/README.md

@@ -25,6 +25,7 @@ Gets Twitch, BTTV, FFZ and 7TV emotes as well as parsing text to emotes!
 - The defaults for `EmoteParser` changed to use the `html` template, and it does not require `:colons:` by default (using `/(\w+)/` to match any words).
 - The default `html` template does not have `twitch-emote-{size}` anymore in its `class` attribute.  
   *The `size` is inconsistent between the different sources, so it cannot be reliably used.*
+- If you somehow used `EmoteFetcher.globalChannel`, it has now been removed.
 - The `EmoteFetcher.fetchSevenTVEmotes()`, `Emote.toLink()`, and `EmoteParse.parse()` methods now have their options as an object.
   - `fetcher.fetchSevenTVEmotes(null, { format: 'avif' })` - The first parameter is still the Twitch user ID (or `null` for global).
   - `emote.toLink({ size: 1, forceStatic: true, themeMode: 'light' })`
@@ -122,12 +123,12 @@ pnpm add jsr:@mkody/twitch-emoticons
 # or
 yarn add jsr:@mkody/twitch-emoticons
 # or (version has to be specified while it is a pre-release)
-deno add jsr:@mkody/twitch-emoticons@3.0.0-beta.3
+deno add jsr:@mkody/twitch-emoticons@3.0.0-beta.4
 ```
 
-[npm]: https://www.npmjs.com/package/@mkody/twitch-emoticons/v/3.0.0-beta.3
-[browse on npmx]: https://npmx.dev/package/@mkody/twitch-emoticons/v/3.0.0-beta.3
-[jsr]: https://jsr.io/@mkody/twitch-emoticons@3.0.0-beta.3
+[npm]: https://www.npmjs.com/package/@mkody/twitch-emoticons/v/3.0.0-beta.4
+[browse on npmx]: https://npmx.dev/package/@mkody/twitch-emoticons/v/3.0.0-beta.4
+[jsr]: https://jsr.io/@mkody/twitch-emoticons@3.0.0-beta.4
 
 
 ## Quick docs

package/dist/TwitchEmoticons.cjs

@@ -63,7 +63,7 @@ var Emote = class _Emote {
    */
   /* c8 ignore next 3 */
   toLink() {
-    return null;
+    return "";
   }
   /**
    * Override for `toString`.
@@ -83,7 +83,8 @@ var Emote = class _Emote {
     return {
       code: this.code,
       id: this.id,
-      channel_id: this.channel.channel_id
+      channel_id: this.channel?.channel_id || null,
+      type: this.type
     };
   }
 };
@@ -185,8 +186,8 @@ var BTTVEmote = class _BTTVEmote extends Emote_default {
   _setup(data) {
     super._setup(data);
     this.ownerName = "user" in data ? data.user.name : null;
-    this.animated = data.animated;
     this.imageType = "webp";
+    this.animated = data.animated;
   }
   /**
    * Gets the image link of the emote.
@@ -210,9 +211,9 @@ var BTTVEmote = class _BTTVEmote extends Emote_default {
   toObject() {
     return {
       ...super.toObject(),
-      animated: this.animated,
+      type: this.type,
       ownerName: this.ownerName,
-      type: this.type
+      animated: this.animated
     };
   }
   /**
@@ -368,8 +369,8 @@ var FFZEmote = class _FFZEmote extends Emote_default {
     this.code = data.name;
     this.ownerName = "owner" in data ? data.owner.name : null;
     this.sizes = "animated" in data ? Object.keys(data.animated) : Object.keys(data.urls);
-    this.animated = "animated" in data;
     this.imageType = "animated" in data ? "webp" : "png";
+    this.animated = "animated" in data;
     this.zeroWidth = data.modifier && data.modifier_flags === 0;
     this.modifier = data.modifier && (data.modifier_flags & 1) !== 0;
   }
@@ -397,10 +398,10 @@ var FFZEmote = class _FFZEmote extends Emote_default {
   toObject() {
     return {
       ...super.toObject(),
-      animated: this.animated,
-      sizes: this.sizes,
-      ownerName: this.ownerName,
       type: this.type,
+      ownerName: this.ownerName,
+      sizes: this.sizes,
+      animated: this.animated,
       zeroWidth: this.zeroWidth,
       modifier: this.modifier
     };
@@ -481,10 +482,10 @@ var SevenTVEmote = class _SevenTVEmote extends Emote_default {
     if (this.sizes.length === 0) {
       this.sizes = ["1", "2", "3", "4"];
     }
+    this.imageType = this.channel.format;
     this.animated = Boolean(data.data.animated);
-    this.nsfw = (data.data.flags & EmoteFlags.Sexual) !== 0 || (data.data.flags & EmoteFlags.TwitchDisallowed) !== 0;
     this.zeroWidth = (data.flags & ActiveEmoteFlags.ZeroWidth) !== 0 || (data.data.flags & EmoteFlags.ZeroWidth) !== 0;
-    this.imageType = this.channel.format;
+    this.nsfw = (data.data.flags & EmoteFlags.Sexual) !== 0 || (data.data.flags & EmoteFlags.TwitchDisallowed) !== 0;
   }
   /**
    * Gets the image link of the emote.
@@ -509,13 +510,13 @@ var SevenTVEmote = class _SevenTVEmote extends Emote_default {
   toObject() {
     return {
       ...super.toObject(),
+      type: this.type,
+      ownerName: this.ownerName,
+      sizes: this.sizes,
+      imageType: this.imageType,
       animated: this.animated,
-      nsfw: this.nsfw,
       zeroWidth: this.zeroWidth,
-      sizes: this.sizes,
-      ownerName: this.ownerName,
-      type: this.type,
-      imageType: this.imageType
+      nsfw: this.nsfw
     };
   }
   /**
@@ -564,9 +565,9 @@ var TwitchEmote = class _TwitchEmote extends Emote_default {
   }
   _setup(data) {
     super._setup(data);
-    this.set = data.emoticon_set;
-    this.animated = data.formats?.includes("animated") || false;
+    this.set = data.emoticon_set || null;
     this.imageType = data.formats?.includes("animated") ? "gif" : "png";
+    this.animated = data.formats?.includes("animated") || false;
   }
   /**
    * Gets the image link of the emote.
@@ -592,9 +593,9 @@ var TwitchEmote = class _TwitchEmote extends Emote_default {
   toObject() {
     return {
       ...super.toObject(),
-      animated: this.animated,
+      type: this.type,
       set: this.set,
-      type: this.type
+      animated: this.animated
     };
   }
   /**
@@ -644,14 +645,6 @@ var EmoteFetcher = class {
     this.channels = new Collection_default();
     this.ffzModifiersFetched = false;
   }
-  /**
-   * The global channel for Twitch, BTTV and 7TV.
-   * @readonly
-   * @type {?Channel}
-   */
-  get globalChannel() {
-    return this.channels.get(null);
-  }
   /**
    * Sets up a channel
    * @private
@@ -824,13 +817,17 @@ var EmoteFetcher = class {
    * @returns {Promise<Collection<string, TwitchEmote>>} - A promise that resolves to a collection of TwitchEmotes.
    */
   fetchTwitchEmotes(channel) {
+    if (!channel) channel = null;
     return this._getRawTwitchEmotes(channel).then((rawEmotes) => {
       for (const emote of rawEmotes) {
-        this._cacheTwitchEmote(channel, {
-          code: emote.name,
-          id: emote.id,
-          formats: emote.formats
-        });
+        this._cacheTwitchEmote(
+          channel,
+          {
+            code: emote.name,
+            id: emote.id,
+            formats: emote.formats
+          }
+        );
       }
       return this.channels.get(channel).emotes.filter((e) => e.type === "twitch");
     });
@@ -842,6 +839,7 @@ var EmoteFetcher = class {
    * @returns {Promise<Collection<string, BTTVEmote>>} - A promise that resolves to a collection of BTTVEmotes.
    */
   fetchBTTVEmotes(channel) {
+    if (!channel) channel = null;
     return this._getRawBTTVEmotes(channel).then((rawEmotes) => {
       for (const data of rawEmotes) {
         this._cacheBTTVEmote(channel, data);
@@ -855,6 +853,7 @@ var EmoteFetcher = class {
    * @returns {Promise<Collection<string, FFZEmote>>} - A promise that resolves to a collection of FFZEmotes.
    */
   async fetchFFZEmotes(channel) {
+    if (!channel) channel = null;
     if (!this.ffzModifiersFetched) {
       this.ffzModifiersFetched = true;
       await this._getRawFFZEmoteSet(Constants_default.FFZ.sets.Modifiers).then((rawEmotes) => {
@@ -886,6 +885,7 @@ var EmoteFetcher = class {
    * @returns {Promise<Collection<string, SevenTVEmote>>} - A promise that resolves to a collection of SevenTVEmotes.
    */
   fetchSevenTVEmotes(channel, options) {
+    if (!channel) channel = null;
     const {
       format = "webp"
     } = options || {};
@@ -899,17 +899,29 @@ var EmoteFetcher = class {
   }
   /**
    * Converts emote Objects to emotes
-   * @param {object} [emotesArray] - An array of emote objects
+   * @param {object[]} [emotesArray] - An array of emote objects
    * @throws {TypeError} When an emote has an unknown type.
    * @returns {Emote[]} - An array of Emote instances.
    */
   fromObject(emotesArray) {
     const emotes = [];
     const classMap = {
-      "bttv": { class: BTTVEmote_default, cache: (emoteObject, channelId, existingEmote) => this._cacheBTTVEmote(channelId, null, existingEmote) },
-      "ffz": { class: FFZEmote_default, cache: (emoteObject, channelId, existingEmote) => this._cacheFFZEmote(channelId, null, existingEmote) },
-      "7tv": { class: SevenTVEmote_default, cache: (emoteObject, channelId, existingEmote) => this._cacheSevenTVEmote(channelId, null, emoteObject.imageType, existingEmote) },
-      "twitch": { class: TwitchEmote_default, cache: (emoteObject, channelId, existingEmote) => this._cacheTwitchEmote(channelId, null, existingEmote) }
+      "bttv": {
+        class: BTTVEmote_default,
+        cache: (_, channelId, existingEmote) => this._cacheBTTVEmote(channelId, null, existingEmote)
+      },
+      "ffz": {
+        class: FFZEmote_default,
+        cache: (_, channelId, existingEmote) => this._cacheFFZEmote(channelId, null, existingEmote)
+      },
+      "7tv": {
+        class: SevenTVEmote_default,
+        cache: (emoteObject, channelId, existingEmote) => this._cacheSevenTVEmote(channelId, null, emoteObject.imageType, existingEmote)
+      },
+      "twitch": {
+        class: TwitchEmote_default,
+        cache: (_, channelId, existingEmote) => this._cacheTwitchEmote(channelId, null, existingEmote)
+      }
     };
     for (const emoteObject of emotesArray) {
       const { type } = emoteObject;