@mkody/twitch-emoticons 2.3.0 → 2.4.1

package/.eslintrc.json

@@ -83,7 +83,6 @@
     "array-bracket-spacing": "error",
     "block-spacing": "error",
     "brace-style": ["error", "1tbs", { "allowSingleLine": true }],
-    "capitalized-comments": ["error", "always", { "ignoreConsecutiveComments": true }],
     "comma-dangle": ["error", "never"],
     "comma-spacing": "error",
     "comma-style": "error",

package/.github/workflows/yarn-test.yml

@@ -9,7 +9,10 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
-          node-version: 12
+          node-version: 16
       - run: yarn
       - run: yarn lint
       - run: yarn test
+        env:
+          TWITCH_ID: ${{ secrets.TWITCH_ID }}
+          TWITCH_SECRET: ${{ secrets.TWITCH_SECRET }}

package/README.md

@@ -8,6 +8,12 @@ You can use [this page to quickly grab it](https://s.kdy.ch/twitchid/).
 
 _FFZ still supports names, but usage of the ID is recommended._
 
+### About this fork's 2.4.0+
+You now need to use the official Twitch API to get emotes. For this you need to provide your client id and client secret.
+To get a client and secret create a Twitch app [here](https://dev.twitch.tv/console/apps/create), it's free.
+
+If you are only using BetterTTV and FrankerFaceZ you don't need to provide anything as they are independent from the Twitch API.
+
 ### Install
 ```sh
 npm install @mkody/twitch-emoticons
@@ -18,9 +24,12 @@ yarn add @mkody/twitch-emoticons
 ### Example
 
 ```js
-const { EmoteFetcher, EmoteParser } = require('twitch-emoticons');
+const { EmoteFetcher, EmoteParser } = require('@mkody/twitch-emoticons');
+
+const clientId = '<your client id>';
+const clientSecret = '<your client secret>';
 
-const fetcher = new EmoteFetcher();
+const fetcher = new EmoteFetcher(clientId, clientSecret);
 const parser = new EmoteParser(fetcher, {
     type: 'markdown',
     match: /:(.+?):/g
@@ -45,6 +54,5 @@ fetcher.fetchTwitchEmotes(null).then(() => {
 - [Changelog](https://github.com/mkody/twitch-emoticons/releases)
 
 This library uses the following:
-- [Twitch Emotes API](https://twitchemotes.com/apidocs)
 - [BetterTTV API](https://betterttv.com/)
 - [FrankerFaceZ API](http://www.frankerfacez.com/developers)

package/docs/BTTVEmote.html

@@ -71,7 +71,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="struct_BTTVEmote.js.html">struct/BTTVEmote.js</a>, <a href="struct_BTTVEmote.js.html#line12">line 12</a>
+        <a href="struct_BTTVEmote.js.html">struct/BTTVEmote.js</a>, <a href="struct_BTTVEmote.js.html#line5">line 5</a>
     </li></ul></dd>
     
 
@@ -1179,7 +1179,7 @@ Will give the emote's name.</p>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.5</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/Channel.html

@@ -688,7 +688,7 @@ For the global channel, the name will be null.</p>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.5</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/Collection.html

@@ -779,7 +779,7 @@ Same as <code>Array#map</code>.</p>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.5</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/Emote.html

@@ -756,7 +756,7 @@ Will give the emote's name.</p>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.5</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/EmoteFetcher.html

@@ -59,7 +59,7 @@
 
     
 
-    <h4 class="name" id="EmoteFetcher"><span class="type-signature"></span>new EmoteFetcher<span class="signature">()</span><span class="type-signature"></span></h4>
+    <h4 class="name" id="EmoteFetcher"><span class="type-signature"></span>new EmoteFetcher<span class="signature">(clientId, clientSecret)</span><span class="type-signature"></span></h4>
 
     
 
@@ -71,7 +71,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="struct_EmoteFetcher.js.html">struct/EmoteFetcher.js</a>, <a href="struct_EmoteFetcher.js.html#line17">line 17</a>
+        <a href="struct_EmoteFetcher.js.html">struct/EmoteFetcher.js</a>, <a href="struct_EmoteFetcher.js.html#line21">line 21</a>
     </li></ul></dd>
     
 
@@ -124,6 +124,78 @@
 
 
 
+    <h5>Parameters:</h5>
+    
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>clientId</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">string</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"><p>The client id for the twitch api.</p></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>clientSecret</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">string</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"><p>The client secret for the twitch api.</p></td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
 
 
 
@@ -162,6 +234,69 @@
 
         
             
+<h4 class="name" id="apiClient"><span class="type-signature"></span>apiClient<span class="type-signature"></span></h4>
+
+
+
+
+
+<dl class="details">
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="struct_EmoteFetcher.js.html">struct/EmoteFetcher.js</a>, <a href="struct_EmoteFetcher.js.html#line28">line 28</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+<div class="description usertext">
+    <p>Twitch api client.</p>
+</div>
+
+
+
+
+
+
+
+
+        
+            
 <h4 class="name" id="channels"><span class="type-signature"></span>channels<span class="type-signature"> :<a href="Collection.html">Collection</a>.&lt;string, <a href="Channel.html">Channel</a>></span></h4>
 
 
@@ -173,7 +308,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="struct_EmoteFetcher.js.html">struct/EmoteFetcher.js</a>, <a href="struct_EmoteFetcher.js.html#line30">line 30</a>
+        <a href="struct_EmoteFetcher.js.html">struct/EmoteFetcher.js</a>, <a href="struct_EmoteFetcher.js.html#line43">line 43</a>
     </li></ul></dd>
     
 
@@ -247,7 +382,7 @@ Collectionped by name to Channel instance.</p>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="struct_EmoteFetcher.js.html">struct/EmoteFetcher.js</a>, <a href="struct_EmoteFetcher.js.html#line23">line 23</a>
+        <a href="struct_EmoteFetcher.js.html">struct/EmoteFetcher.js</a>, <a href="struct_EmoteFetcher.js.html#line36">line 36</a>
     </li></ul></dd>
     
 
@@ -321,7 +456,7 @@ Collectionped by emote code to Emote instance.</p>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="struct_EmoteFetcher.js.html">struct/EmoteFetcher.js</a>, <a href="struct_EmoteFetcher.js.html#line38">line 38</a>
+        <a href="struct_EmoteFetcher.js.html">struct/EmoteFetcher.js</a>, <a href="struct_EmoteFetcher.js.html#line51">line 51</a>
     </li></ul></dd>
     
 
@@ -404,7 +539,7 @@ Collectionped by emote code to Emote instance.</p>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="struct_EmoteFetcher.js.html">struct/EmoteFetcher.js</a>, <a href="struct_EmoteFetcher.js.html#line103">line 103</a>
+        <a href="struct_EmoteFetcher.js.html">struct/EmoteFetcher.js</a>, <a href="struct_EmoteFetcher.js.html#line120">line 120</a>
     </li></ul></dd>
     
 
@@ -581,7 +716,7 @@ Collectionped by emote code to Emote instance.</p>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="struct_EmoteFetcher.js.html">struct/EmoteFetcher.js</a>, <a href="struct_EmoteFetcher.js.html#line149">line 149</a>
+        <a href="struct_EmoteFetcher.js.html">struct/EmoteFetcher.js</a>, <a href="struct_EmoteFetcher.js.html#line166">line 166</a>
     </li></ul></dd>
     
 
@@ -758,7 +893,7 @@ Collectionped by emote code to Emote instance.</p>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="struct_EmoteFetcher.js.html">struct/EmoteFetcher.js</a>, <a href="struct_EmoteFetcher.js.html#line63">line 63</a>
+        <a href="struct_EmoteFetcher.js.html">struct/EmoteFetcher.js</a>, <a href="struct_EmoteFetcher.js.html#line80">line 80</a>
     </li></ul></dd>
     
 
@@ -935,7 +1070,7 @@ Collectionped by emote code to Emote instance.</p>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="struct_EmoteFetcher.js.html">struct/EmoteFetcher.js</a>, <a href="struct_EmoteFetcher.js.html#line83">line 83</a>
+        <a href="struct_EmoteFetcher.js.html">struct/EmoteFetcher.js</a>, <a href="struct_EmoteFetcher.js.html#line100">line 100</a>
     </li></ul></dd>
     
 
@@ -1110,7 +1245,7 @@ Use <code>null</code> for the global emotes channel.</p>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="struct_EmoteFetcher.js.html">struct/EmoteFetcher.js</a>, <a href="struct_EmoteFetcher.js.html#line122">line 122</a>
+        <a href="struct_EmoteFetcher.js.html">struct/EmoteFetcher.js</a>, <a href="struct_EmoteFetcher.js.html#line139">line 139</a>
     </li></ul></dd>
     
 
@@ -1267,7 +1402,7 @@ Use <code>null</code> for the global emotes channel.</p>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="struct_EmoteFetcher.js.html">struct/EmoteFetcher.js</a>, <a href="struct_EmoteFetcher.js.html#line48">line 48</a>
+        <a href="struct_EmoteFetcher.js.html">struct/EmoteFetcher.js</a>, <a href="struct_EmoteFetcher.js.html#line61">line 61</a>
     </li></ul></dd>
     
 
@@ -1421,7 +1556,7 @@ Use <code>null</code> for the global emotes channel.</p>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="struct_EmoteFetcher.js.html">struct/EmoteFetcher.js</a>, <a href="struct_EmoteFetcher.js.html#line184">line 184</a>
+        <a href="struct_EmoteFetcher.js.html">struct/EmoteFetcher.js</a>, <a href="struct_EmoteFetcher.js.html#line201">line 201</a>
     </li></ul></dd>
     
 
@@ -1596,7 +1731,7 @@ Use <code>null</code> for the global emotes channel.</p>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="struct_EmoteFetcher.js.html">struct/EmoteFetcher.js</a>, <a href="struct_EmoteFetcher.js.html#line199">line 199</a>
+        <a href="struct_EmoteFetcher.js.html">struct/EmoteFetcher.js</a>, <a href="struct_EmoteFetcher.js.html#line216">line 216</a>
     </li></ul></dd>
     
 
@@ -1750,7 +1885,7 @@ Use <code>null</code> for the global emotes channel.</p>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="struct_EmoteFetcher.js.html">struct/EmoteFetcher.js</a>, <a href="struct_EmoteFetcher.js.html#line168">line 168</a>
+        <a href="struct_EmoteFetcher.js.html">struct/EmoteFetcher.js</a>, <a href="struct_EmoteFetcher.js.html#line185">line 185</a>
     </li></ul></dd>
     
 
@@ -1928,7 +2063,7 @@ Use <code>null</code> for the global emotes channel.</p>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.5</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/EmoteParser.html

@@ -780,7 +780,7 @@ Must be a global regex, with one capture group for the emote code.</p></td>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.5</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/FFZEmote.html

@@ -71,7 +71,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="struct_FFZEmote.js.html">struct/FFZEmote.js</a>, <a href="struct_FFZEmote.js.html#line12">line 12</a>
+        <a href="struct_FFZEmote.js.html">struct/FFZEmote.js</a>, <a href="struct_FFZEmote.js.html#line5">line 5</a>
     </li></ul></dd>
     
 
@@ -1251,7 +1251,7 @@ Will give the emote's name.</p>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.5</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/TwitchEmote.html

@@ -71,7 +71,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="struct_TwitchEmote.js.html">struct/TwitchEmote.js</a>, <a href="struct_TwitchEmote.js.html#line12">line 12</a>
+        <a href="struct_TwitchEmote.js.html">struct/TwitchEmote.js</a>, <a href="struct_TwitchEmote.js.html#line5">line 5</a>
     </li></ul></dd>
     
 
@@ -1177,7 +1177,7 @@ Will give the emote's name.</p>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.5</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/index.html

@@ -59,15 +59,26 @@
     <section class="readme usertext">
         <article><h1>twitch-emoticons</h1>
 <p>Get a Twitch channel's Twitch emotes, BTTV emotes, and FFZ emotes!</p>
+<h3>About this fork's 2.3.0+</h3>
+<p>You must now use a Twitch user ID instead of the username to fetch user's emotes.<br>
+You can use <a href="https://s.kdy.ch/twitchid/">this page to quickly grab it</a>.</p>
+<p><em>FFZ still supports names, but usage of the ID is recommended.</em></p>
+<h3>About this fork's 2.4.0+</h3>
+<p>You now need to use the official Twitch API to get emotes. For this you need to provide your client id and client secret.<br>
+To get a client and secret create a Twitch app <a href="https://dev.twitch.tv/console/apps/create">here</a>, it's free.</p>
+<p>If you are only using BetterTTV and FrankerFaceZ you don't need to provide anything as they are independent from the Twitch API.</p>
 <h3>Install</h3>
 <pre class="prettyprint source lang-sh"><code>npm install @mkody/twitch-emoticons
 # or
 yarn add @mkody/twitch-emoticons
 </code></pre>
 <h3>Example</h3>
-<pre class="prettyprint source lang-js"><code>const { EmoteFetcher, EmoteParser } = require('twitch-emoticons');
+<pre class="prettyprint source lang-js"><code>const { EmoteFetcher, EmoteParser } = require('@mkody/twitch-emoticons');
 
-const fetcher = new EmoteFetcher();
+const clientId = '&lt;your client id>';
+const clientSecret = '&lt;your client secret>';
+
+const fetcher = new EmoteFetcher(clientId, clientSecret);
 const parser = new EmoteParser(fetcher, {
     type: 'markdown',
     match: /:(.+?):/g
@@ -89,7 +100,6 @@ fetcher.fetchTwitchEmotes(null).then(() => {
 <li><a href="https://github.com/mkody/twitch-emoticons">Github</a></li>
 <li><a href="https://mkody.github.io/twitch-emoticons/">Documentation</a></li>
 <li><a href="https://github.com/mkody/twitch-emoticons/releases">Changelog</a></li>
-<li><a href="https://s.kdy.ch/twitchid/">Grab a Twitch user's ID</a></li>
 </ul>
 <p>This library uses the following:</p>
 <ul>
@@ -111,7 +121,7 @@ fetcher.fetchTwitchEmotes(null).then(() => {
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.5</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/struct_BTTVEmote.js.html

@@ -110,7 +110,7 @@ module.exports = BTTVEmote;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.5</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/struct_Channel.js.html

@@ -103,7 +103,7 @@ module.exports = Channel;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.5</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/struct_Emote.js.html

@@ -121,7 +121,7 @@ module.exports = Emote;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.5</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/struct_EmoteFetcher.js.html

@@ -47,18 +47,31 @@ const Channel = require('./Channel');
 const Collection = require('../util/Collection');
 const Constants = require('../util/Constants');
 const FFZEmote = require('./FFZEmote');
-const request = require('request-promise');
+const got = require('got');
 const TwitchEmote = require('./TwitchEmote');
+const { ApiClient } = require('@twurple/api');
+const { ClientCredentialsAuthProvider } = require('@twurple/auth');
 
 const options = {
-    json: true
+    responseType: 'json'
 };
 
 class EmoteFetcher {
     /**
      * Fetches and caches emotes.
+     * @param {string} clientId The client id for the twitch api.
+     * @param {string} clientSecret The client secret for the twitch api.
      */
-    constructor() {
+    constructor(clientId, clientSecret) {
+        if (clientId !== undefined && clientSecret !== undefined) {
+            const authProvider = new ClientCredentialsAuthProvider(clientId, clientSecret);
+
+            /**
+             * Twitch api client.
+             */
+            this.apiClient = new ApiClient({ authProvider });
+        }
+
         /**
          * Cached emotes.
          * Collectionped by emote code to Emote instance.
@@ -90,11 +103,15 @@ class EmoteFetcher {
      * @returns {Promise<Object[]>}
      */
     _getRawTwitchEmotes(id) {
-        const endpoint = !id
-            ? Constants.Twitch.Global
-            : Constants.Twitch.Channel(id); // eslint-disable-line new-cap
+        if (!this.apiClient) {
+            throw new Error('Client id or client secret not provided.');
+        }
 
-        return request({ uri: endpoint, ...options });
+        if (id) {
+            return this.apiClient.chat.getChannelEmotes(id);
+        } else {
+            return this.apiClient.chat.getGlobalEmotes();
+        }
     }
 
     /**
@@ -129,11 +146,11 @@ class EmoteFetcher {
             ? Constants.BTTV.Global
             : Constants.BTTV.Channel(id); // eslint-disable-line new-cap
 
-        return request({ uri: endpoint, ...options }).then(body => {
+        return got(endpoint, options).then(req => {
             // Global emotes
-            if (body instanceof Array) return body;
+            if (req.body instanceof Array) return req.body;
             // Channel emotes
-            return [...body.channelEmotes, ...body.sharedEmotes];
+            return [...req.body.channelEmotes, ...req.body.sharedEmotes];
         });
     }
 
@@ -172,10 +189,10 @@ class EmoteFetcher {
             endpoint = Constants.FFZ.ChannelName(id); // eslint-disable-line new-cap
         }
 
-        return request({ uri: endpoint, ...options }).then(body => {
+        return got(endpoint, options).then(req => {
             const emotes = [];
-            for (const key of Object.keys(body.sets)) {
-                const set = body.sets[key];
+            for (const key of Object.keys(req.body.sets)) {
+                const set = req.body.sets[key];
                 emotes.push(...set.emoticons);
             }
 
@@ -211,11 +228,11 @@ class EmoteFetcher {
      */
     fetchTwitchEmotes(id = null) {
         return this._getRawTwitchEmotes(id).then(rawEmotes => {
-            for (const data of rawEmotes.emotes) {
-                this._cacheTwitchEmote(rawEmotes.channel_name, data);
+            for (const emote of rawEmotes) {
+                this._cacheTwitchEmote(id, { code: emote.name, id: emote.id });
             }
 
-            return this.channels.get(rawEmotes.channel_name).emotes.filter(e => e.type === 'twitch');
+            return this.channels.get(id).emotes.filter(e => e.type === 'twitch');
         });
     }
 
@@ -266,7 +283,7 @@ module.exports = EmoteFetcher;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.5</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/struct_EmoteParser.js.html

@@ -136,7 +136,7 @@ module.exports = EmoteParser;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.5</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/struct_FFZEmote.js.html

@@ -117,7 +117,7 @@ module.exports = FFZEmote;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.5</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/struct_TwitchEmote.js.html

@@ -108,7 +108,7 @@ module.exports = TwitchEmote;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.5</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/util_Collection.js.html

@@ -134,7 +134,7 @@ module.exports = Collection;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.5</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/package.json

@@ -1,49 +1,51 @@
 {
-  "name": "@mkody/twitch-emoticons",
-  "version": "2.3.0",
-  "description": "Gets Twitch emotes and BTTV emotes, as well as parsing text to emotes!",
-  "main": "src/index.js",
-  "typings": "typings/index.d.ts",
-  "keywords": [
-    "emote",
-    "emoticon",
-    "emoji",
-    "bttv",
-    "better",
-    "twitch",
-    "tv",
-    "parse"
-  ],
-  "author": "MKody <gh@kdy.ch> (André Fernandes)",
-  "contrubutors": [
-    "1Computer",
-    "MKody"
-  ],
-  "license": "MIT",
-  "dependencies": {
-    "request": "^2.88.2",
-    "request-promise": "^4.2.5"
-  },
-  "devDependencies": {
-    "docdash": "^1.2.0",
-    "eslint": "7.18.0",
-    "jsdoc": "^3.6.6"
-  },
-  "scripts": {
-    "docs": "jsdoc --configure .jsdoc.json --verbose --package ''",
-    "test": "node test/index.js",
-    "lint": "eslint ./src"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/mkody/twitch-emoticons.git"
-  },
-  "bugs": {
-    "url": "https://github.com/mkody/twitch-emoticons/issues"
-  },
-  "homepage": "https://github.com/mkody/twitch-emoticons",
-  "directories": {
-    "doc": "docs",
-    "test": "test"
-  }
+    "name": "@mkody/twitch-emoticons",
+    "version": "2.4.1",
+    "description": "Gets Twitch emotes and BTTV emotes, as well as parsing text to emotes!",
+    "main": "src/index.js",
+    "typings": "typings/index.d.ts",
+    "keywords": [
+        "emote",
+        "emoticon",
+        "emoji",
+        "bttv",
+        "better",
+        "twitch",
+        "tv",
+        "parse"
+    ],
+    "author": "MKody <gh@kdy.ch> (André Fernandes)",
+    "contrubutors": [
+        "1Computer",
+        "Killusions",
+        "MKody"
+    ],
+    "license": "MIT",
+    "dependencies": {
+        "@twurple/api": "^5.0.5",
+        "@twurple/auth": "^5.0.5",
+        "got": "^11.8.2"
+    },
+    "devDependencies": {
+        "docdash": "^1.2.0",
+        "eslint": "^8.0.1",
+        "jsdoc": "^3.6.7"
+    },
+    "scripts": {
+        "docs": "jsdoc --configure .jsdoc.json --verbose --package ''",
+        "test": "node test/index.js",
+        "lint": "eslint ./src ./test"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/mkody/twitch-emoticons.git"
+    },
+    "bugs": {
+        "url": "https://github.com/mkody/twitch-emoticons/issues"
+    },
+    "homepage": "https://github.com/mkody/twitch-emoticons",
+    "directories": {
+        "doc": "docs",
+        "test": "test"
+    }
 }

package/src/struct/EmoteFetcher.js

@@ -3,18 +3,31 @@ const Channel = require('./Channel');
 const Collection = require('../util/Collection');
 const Constants = require('../util/Constants');
 const FFZEmote = require('./FFZEmote');
-const request = require('request-promise');
+const got = require('got');
 const TwitchEmote = require('./TwitchEmote');
+const { ApiClient } = require('@twurple/api');
+const { ClientCredentialsAuthProvider } = require('@twurple/auth');
 
 const options = {
-    json: true
+    responseType: 'json'
 };
 
 class EmoteFetcher {
     /**
      * Fetches and caches emotes.
+     * @param {string} clientId The client id for the twitch api.
+     * @param {string} clientSecret The client secret for the twitch api.
      */
-    constructor() {
+    constructor(clientId, clientSecret) {
+        if (clientId !== undefined && clientSecret !== undefined) {
+            const authProvider = new ClientCredentialsAuthProvider(clientId, clientSecret);
+
+            /**
+             * Twitch api client.
+             */
+            this.apiClient = new ApiClient({ authProvider });
+        }
+
         /**
          * Cached emotes.
          * Collectionped by emote code to Emote instance.
@@ -46,11 +59,15 @@ class EmoteFetcher {
      * @returns {Promise<Object[]>}
      */
     _getRawTwitchEmotes(id) {
-        const endpoint = !id
-            ? Constants.Twitch.Global
-            : Constants.Twitch.Channel(id); // eslint-disable-line new-cap
+        if (!this.apiClient) {
+            throw new Error('Client id or client secret not provided.');
+        }
 
-        return request({ uri: endpoint, ...options });
+        if (id) {
+            return this.apiClient.chat.getChannelEmotes(id);
+        } else {
+            return this.apiClient.chat.getGlobalEmotes();
+        }
     }
 
     /**
@@ -85,11 +102,11 @@ class EmoteFetcher {
             ? Constants.BTTV.Global
             : Constants.BTTV.Channel(id); // eslint-disable-line new-cap
 
-        return request({ uri: endpoint, ...options }).then(body => {
+        return got(endpoint, options).then(req => {
             // Global emotes
-            if (body instanceof Array) return body;
+            if (req.body instanceof Array) return req.body;
             // Channel emotes
-            return [...body.channelEmotes, ...body.sharedEmotes];
+            return [...req.body.channelEmotes, ...req.body.sharedEmotes];
         });
     }
 
@@ -128,10 +145,10 @@ class EmoteFetcher {
             endpoint = Constants.FFZ.ChannelName(id); // eslint-disable-line new-cap
         }
 
-        return request({ uri: endpoint, ...options }).then(body => {
+        return got(endpoint, options).then(req => {
             const emotes = [];
-            for (const key of Object.keys(body.sets)) {
-                const set = body.sets[key];
+            for (const key of Object.keys(req.body.sets)) {
+                const set = req.body.sets[key];
                 emotes.push(...set.emoticons);
             }
 
@@ -167,11 +184,11 @@ class EmoteFetcher {
      */
     fetchTwitchEmotes(id = null) {
         return this._getRawTwitchEmotes(id).then(rawEmotes => {
-            for (const data of rawEmotes.emotes) {
-                this._cacheTwitchEmote(rawEmotes.channel_name, data);
+            for (const emote of rawEmotes) {
+                this._cacheTwitchEmote(id, { code: emote.name, id: emote.id });
             }
 
-            return this.channels.get(rawEmotes.channel_name).emotes.filter(e => e.type === 'twitch');
+            return this.channels.get(id).emotes.filter(e => e.type === 'twitch');
         });
     }
 

package/src/util/Constants.js

@@ -1,7 +1,5 @@
 module.exports = {
     Twitch: {
-        Global: 'https://api.twitchemotes.com/api/v4/channels/0',
-        Channel: id => `https://api.twitchemotes.com/api/v4/channels/${id}`,
         CDN: (id, size) => `https://static-cdn.jtvnw.net/emoticons/v1/${id}/${size + 1}.0`
     },
     BTTV: {

package/test/index.js

@@ -1,48 +1,103 @@
 /* eslint-disable no-console */
 
 const assert = require('assert');
+const { env } = require('process');
 const { EmoteFetcher, EmoteParser } = require('../src/index.js');
 
-const fetcher = new EmoteFetcher();
-const parser = new EmoteParser(fetcher, {
-    type: 'markdown',
-    match: /:(.+?):/g
-});
-
 /**
+ * If environement variables are set, test Twitch fetching.
+ *
  * Tests:
+ * - Fetch emotes
+ *  - Twitch Global
+ *  - Twitch Channel (twitchplayspokemon)
  * - Link to Kappa
  * - Parse to Markdown
- *  - Global Twitch emote (CoolCat)
- *  - User Twitch emote (tppD)
- *  - Global BTTV emote (SourPls)
- *  - Channel BTTV emote (tppUrn)
- *  - Shared BTTV emote (MODS)
+ *  - Twitch Global emote (CoolCat)
+ *  - Twitch Channel emote (tppD)
+ */
+if (env.TWITCH_ID !== undefined && env.TWITCH_SECRET !== undefined) {
+    const twitchFetcher = new EmoteFetcher(env.TWITCH_ID, env.TWITCH_SECRET);
+    const twitchParser = new EmoteParser(twitchFetcher, {
+        type: 'markdown',
+        match: /:(.+?):/g
+    });
+
+    Promise.all([
+        twitchFetcher.fetchTwitchEmotes(),
+        twitchFetcher.fetchTwitchEmotes(56648155)
+    ]).then(() => {
+        const kappa = twitchFetcher.emotes.get('Kappa');
+        assert.strictEqual(kappa.toLink(2), 'https://static-cdn.jtvnw.net/emoticons/v1/25/3.0');
+
+        const text = twitchParser.parse(':CoolCat:\n:tppD:');
+        assert.strictEqual(text, [
+            '![CoolCat](https://static-cdn.jtvnw.net/emoticons/v1/58127/1.0 "CoolCat")',
+            '![tppD](https://static-cdn.jtvnw.net/emoticons/v1/307609315/1.0 "tppD")'
+        ].join('\n'));
+    }).then(() => {
+        console.log('Twitch emotes test was successful.');
+    }).catch(err => {
+        console.error('Twitch emotes test failed!');
+        console.error(err);
+    });
+} else {
+    console.log('Notice: Twitch client id/secret missing.');
+}
+
+/*
+ * Code should throw if we try to fetch Twitch emotes without a Client ID and Secret
+ */
+const twitchFaultyFetcher = new EmoteFetcher();
+
+try {
+    assert.throws(() => {
+        twitchFaultyFetcher.fetchTwitchEmotes();
+    }, new Error('Client id or client secret not provided.'));
+    console.log('Twitch emotes test (without API keys) was successful.');
+} catch (err) {
+    console.error('Twitch emotes test (without API keys) failed!');
+    console.error(err);
+}
+
+/**
+ * Tests:
+ * - Fetch emotes
+ *  - BTTV Global
+ *  - BTTV Channel (twitchplayspokemon)
+ *  - FFZ via user name (sylux98)
+ *  - FFZ via user ID (shizuka_natsume)
+ *
+ * - Parse to Markdown
+ *  - BTTV Global emote (SourPls)
+ *  - BTTV Channel emote (tppUrn)
+ *  - BTTV Shared emote (MODS)
  *  - FFZ emote from user name (AWOOO)
- *  - FFZ emote from user ID (AWOOO)
+ *  - FFZ emote from user ID (SanaeSip)
  */
+const fetcher = new EmoteFetcher();
+const parser = new EmoteParser(fetcher, {
+    type: 'markdown',
+    match: /:(.+?):/g
+});
+
 Promise.all([
-    fetcher.fetchTwitchEmotes(),
-    fetcher.fetchTwitchEmotes(56648155),
     fetcher.fetchBTTVEmotes(),
     fetcher.fetchBTTVEmotes(56648155),
     fetcher.fetchFFZEmotes('sylux98'),
     fetcher.fetchFFZEmotes(13638332)
 ]).then(() => {
-    const kappa = fetcher.emotes.get('Kappa');
-    assert.strictEqual(kappa.toLink(2), 'https://static-cdn.jtvnw.net/emoticons/v1/25/3.0');
-
-    const text = parser.parse(':CoolCat:\n:tppD:\n:SourPls:\n:tppUrn:\n:MODS:\n:AWOOO:\n:SanaeSip:');
+    const text = parser.parse(':SourPls:\n:tppUrn:\n:MODS:\n:AWOOO:\n:SanaeSip:');
     assert.strictEqual(text, [
-        '![CoolCat](https://static-cdn.jtvnw.net/emoticons/v1/58127/1.0 "CoolCat")',
-        '![tppD](https://static-cdn.jtvnw.net/emoticons/v1/303132934/1.0 "tppD")',
         '![SourPls](https://cdn.betterttv.net/emote/566ca38765dbbdab32ec0560/1x "SourPls")',
         '![tppUrn](https://cdn.betterttv.net/emote/5f5f7d5f68d9d86c020e8672/1x "tppUrn")',
         '![MODS](https://cdn.betterttv.net/emote/5f2c4f9e65fe924464ef6d61/1x "MODS")',
         '![AWOOO](https://cdn.frankerfacez.com/emote/67/1 "AWOOO")',
         '![SanaeSip](https://cdn.frankerfacez.com/emote/305078/1 "SanaeSip")'
     ].join('\n'));
+}).then(() => {
+    console.log('BTTV/FFZ emotes test was successful.');
 }).catch(err => {
-    console.error('Test failed!');
+    console.error('BTTV/FFZ emotes test failed!');
     console.error(err);
 });

package/typings/index.d.ts

@@ -31,6 +31,8 @@ declare module '@mkody/twitch-emoticons' {
     }
 
     export class EmoteFetcher {
+        public constructor(clientId?: string, clientSecret?: string);
+
         public emotes: Collection<string, Emote>;
         public channels: Collection<string, Channel>;