2.8.7: Dependencies update

This release contains a security update for follow-redirects.
See: CVE-2024-28849 ; GHSA-cxjh-pqwp-8mfp

All other deps have been updated too, including Twurple to 7.1.0.
GitHub Actions workflows have been updated too.

Please check out the 2.8.0 release notes for the what's new in 2.8.x and the 2.8.3 release notes about the experimental ESM bundle.

2.8.6: Dependencies update

This is just a maintenance release, no changes to the library.

Please check out the 2.8.0 release notes for the what's new in 2.8.x and the 2.8.3 release notes about the experimental ESM bundle.

2.8.5: Dependencies update

This is just a maintenance release, no changes to the library.
Happy new year!

Please check out the 2.8.0 release notes for the what's new in 2.8.x and the 2.8.3 release notes about the experimental ESM bundle.

2.8.4: Dependencies update

One of our dependencies - Axios - got a security update.
We're releasing 2.8.4 to clear those big red warnings.

Please check out the 2.8.0 release notes for the what's new in 2.8.x and the 2.8.3 release notes about the experimental ESM bundle.

2.8.3: Update dependencies and experimental bundle

This release is pretty much only updates to our dependencies.

The project is also now being tested using the Jest framework!
Better than the custom solution from upstream.

[EXPERIMENTAL] There's also a bundled ESM version available.
Check out this quick POC and its source code: https://s.kdy.ch/twitch-emoticons/

(This is a republishing of 2.8.2 but with a proper .npmignore)

2.8.1: Update typings

The new options parameter in EmoteFetcher wasn't referenced.

This release also includes a now working "contributors" field in package.json, and the json parameter in EmoteFetcher.fromObject() has
been renamed to emotesArray.

Please look at the 2.8.0 release notes for what's new in 2.8.x.

2.8.0: toObject, fromObject, use your ApiClient

This release, in addition to upgrading our Twurple to 7.x, brings three new features:

• Emote.toObject() (#31 - @Tzahi12345): You can export the data of an emote for caching or offline use.

  const emote = emoteFetcher.emotes.get('Kappa').toObject();
  /*
  {
      id: '25',
      type: 'twitch',
      code: 'Kappa',
      animated: false,
      channel_id: null,
      set: undefined
  }
  */

• EmoteFetcher.fromObject() (#31 - @Tzahi12345): You can import an array of emotes directly into the fetcher.

  emoteFetcher.fromObject([emote]);

• The EmoteFetcher now accepts an object as a third parameter for options. (#33)
  The only option for now is apiClient and it allows you to use your own @twurple/api's ApiClient object, in case you already have one or want to manage authentification without app tokens.
  Note that the first two parameters of EmoteFetcher will be unused in this case and can be left as null.

  const { ApiClient } = require('@twurple/api');
  const { StaticAuthProvider } = require('@twurple/auth');
  
  const authProvider = new StaticAuthProvider('<your client id>', '<your token>');
  const apiClient = new ApiClient({ authProvider });
  
  const fetcher = new EmoteFetcher(null, null, { apiClient });

2.7.1: Emote's owner might be null; Use `axios` for requests

This release handles the case where 7TV or FFZ emotes might not have an owner object.
When it happens, the owner property for the emote will be null.
This was already the case for BTTV. Check for nullable values!

Typings were updated/fixed to reflect that.

This project also switched to axios to make API requests to the 3rd party emotes services.
got 12.x requires us to switch to ESM but I'm not 100% comfortable in doing so yet. And axios got better since the last time I checked.
This change should be transparent for everyone.

2.7.0: BTTV WEBP; FFZ global, animated and modifier emotes support

This release introduces quite some changes.

• An animated property is now present on emotes if they are supposed to be animated.
• We now load the WEBP version of BetterTTV emotes.
• The SEVENTV constant is now called SevenTV - in case you used it.
• The package now supports animated emotes from FrankerFaceZ. They are hosted at a different CDN address.
• Added support to load the FFZ global emotes.
• When you fetch any FFZ global or channel emotes, the package will fetch the list of "modifier" emotes once.
  • They will be removed from the output as they are not supposed to be shown.
  • Modifier emotes who are supposed to be hidden have a modifier property set to true.
  • Support to actually add a class to modified emotes is not planned.
  • Note that there's nothing in place for the BTTV modifiers.
• Updated twurple to 6.0.9.

2.6.2: Maintenance release

This is a maintenance release.

We're now using Twurple 6 to access the Twitch API.
Other devDependencies were updated as well.

(Note about this GitHub repo: it's now detached from upstream and master is the default branch again.)

Bellow a copy of the 2.6.0 release notes.

---

This release adds support for 7TV emotes.
It is also possible to pick between the WEBP and AVIF image formats during the fetching.
Example usage: fetcher.fetchSevenTVEmotes(44317909, 'avif');
(Note that the second parameter is optional and is webp by default.)

Dependencies were also updated.