@mkody/twitch-emoticons 2.4.1 → 2.5.0

package/README.md

@@ -1,6 +1,6 @@
 # twitch-emoticons
 
-Get a Twitch channel's Twitch emotes, BTTV emotes, and FFZ emotes!
+Gets Twitch, BTTV and FFZ emotes as well as parsing text to emotes!
 
 ### About this fork's 2.3.0+
 You must now use a Twitch user ID instead of the username to fetch user's emotes.  

package/docs/BTTVEmote.html

@@ -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.7</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.11</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.7</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.11</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.7</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.11</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.7</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.11</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/EmoteFetcher.html

@@ -2063,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.7</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.11</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.7</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.11</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/FFZEmote.html

@@ -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.7</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.11</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/TwitchEmote.html

@@ -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.7</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.11</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/index.html

@@ -103,7 +103,6 @@ fetcher.fetchTwitchEmotes(null).then(() => {
 </ul>
 <p>This library uses the following:</p>
 <ul>
-<li><a href="https://twitchemotes.com/apidocs">Twitch Emotes API</a></li>
 <li><a href="https://betterttv.com/">BetterTTV API</a></li>
 <li><a href="http://www.frankerfacez.com/developers">FrankerFaceZ API</a></li>
 </ul></article>
@@ -121,7 +120,7 @@ fetcher.fetchTwitchEmotes(null).then(() => {
 <br class="clear">
 
 <footer>
-    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.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</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.7</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.11</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.7</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.11</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.7</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.11</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/struct_EmoteFetcher.js.html

@@ -283,7 +283,7 @@ module.exports = EmoteFetcher;
 <br class="clear">
 
 <footer>
-    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.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</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.7</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.11</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.7</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.11</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.7</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.11</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.7</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.11</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/package.json

@@ -1,18 +1,19 @@
 {
     "name": "@mkody/twitch-emoticons",
-    "version": "2.4.1",
-    "description": "Gets Twitch emotes and BTTV emotes, as well as parsing text to emotes!",
+    "version": "2.5.0",
+    "description": "Gets Twitch, BTTV and FFZ emotes as well as parsing text to emotes!",
     "main": "src/index.js",
     "typings": "typings/index.d.ts",
     "keywords": [
+        "better",
+        "bttv",
+        "emoji",
         "emote",
         "emoticon",
-        "emoji",
-        "bttv",
-        "better",
-        "twitch",
+        "ffz",
+        "parse",
         "tv",
-        "parse"
+        "twitch"
     ],
     "author": "MKody <gh@kdy.ch> (André Fernandes)",
     "contrubutors": [
@@ -22,14 +23,14 @@
     ],
     "license": "MIT",
     "dependencies": {
-        "@twurple/api": "^5.0.5",
-        "@twurple/auth": "^5.0.5",
-        "got": "^11.8.2"
+        "@twurple/api": "^5.1.7",
+        "@twurple/auth": "^5.1.7",
+        "got": "^11.8.5"
     },
     "devDependencies": {
         "docdash": "^1.2.0",
-        "eslint": "^8.0.1",
-        "jsdoc": "^3.6.7"
+        "eslint": "^8.20.0",
+        "jsdoc": "^3.6.11"
     },
     "scripts": {
         "docs": "jsdoc --configure .jsdoc.json --verbose --package ''",

package/src/util/Constants.js

@@ -1,6 +1,6 @@
 module.exports = {
     Twitch: {
-        CDN: (id, size) => `https://static-cdn.jtvnw.net/emoticons/v1/${id}/${size + 1}.0`
+        CDN: (id, size) => `https://static-cdn.jtvnw.net/emoticons/v2/${id}/default/dark/${size + 1}.0`
     },
     BTTV: {
         Global: 'https://api.betterttv.net/3/cached/emotes/global',

package/test/index.js

@@ -5,7 +5,7 @@ const { env } = require('process');
 const { EmoteFetcher, EmoteParser } = require('../src/index.js');
 
 /**
- * If environement variables are set, test Twitch fetching.
+ * If environement variables are set, test Twitch fetching and parsing.
  *
  * Tests:
  * - Fetch emotes
@@ -28,12 +28,12 @@ if (env.TWITCH_ID !== undefined && env.TWITCH_SECRET !== undefined) {
         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');
+        assert.strictEqual(kappa.toLink(2), 'https://static-cdn.jtvnw.net/emoticons/v2/25/default/dark/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")'
+            '![CoolCat](https://static-cdn.jtvnw.net/emoticons/v2/58127/default/dark/1.0 "CoolCat")',
+            '![tppD](https://static-cdn.jtvnw.net/emoticons/v2/307609315/default/dark/1.0 "tppD")'
         ].join('\n'));
     }).then(() => {
         console.log('Twitch emotes test was successful.');
@@ -61,43 +61,70 @@ try {
 }
 
 /**
+ * Test BetterTTV fetching and parsing.
+ *
  * 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 (SanaeSip)
  */
-const fetcher = new EmoteFetcher();
-const parser = new EmoteParser(fetcher, {
+const bttvFetcher = new EmoteFetcher();
+const bttvParser = new EmoteParser(bttvFetcher, {
     type: 'markdown',
     match: /:(.+?):/g
 });
 
 Promise.all([
-    fetcher.fetchBTTVEmotes(),
-    fetcher.fetchBTTVEmotes(56648155),
-    fetcher.fetchFFZEmotes('sylux98'),
-    fetcher.fetchFFZEmotes(13638332)
+    bttvFetcher.fetchBTTVEmotes(),
+    bttvFetcher.fetchBTTVEmotes(56648155)
 ]).then(() => {
-    const text = parser.parse(':SourPls:\n:tppUrn:\n:MODS:\n:AWOOO:\n:SanaeSip:');
+    const text = bttvParser.parse(':SourPls:\n:tppUrn:\n:MODS:');
     assert.strictEqual(text, [
         '![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")',
+        '![MODS](https://cdn.betterttv.net/emote/5f2c4f9e65fe924464ef6d61/1x "MODS")'
+    ].join('\n'));
+}).then(() => {
+    console.log('BTTV emotes test was successful.');
+}).catch(err => {
+    console.error('BTTV emotes test failed!');
+    console.error(err);
+});
+
+
+/**
+ * Test FrankerFaceZ fetching and parsing.
+ *
+ * Tests:
+ * - Fetch emotes
+ *  - FFZ via user name (sylux98)
+ *  - FFZ via user ID (shizuka_natsume)
+ * - Parse to Markdown
+ *  - FFZ emote from user name (AWOOO)
+ *  - FFZ emote from user ID (SanaeSip)
+ */
+const ffzFetcher = new EmoteFetcher();
+const ffzParser = new EmoteParser(ffzFetcher, {
+    type: 'markdown',
+    match: /:(.+?):/g
+});
+
+Promise.all([
+    ffzFetcher.fetchFFZEmotes('sylux98'),
+    ffzFetcher.fetchFFZEmotes(13638332)
+]).then(() => {
+    const text = ffzParser.parse(':AWOOO:\n:SanaeSip:');
+    assert.strictEqual(text, [
         '![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.');
+    console.log('FFZ emotes test was successful.');
 }).catch(err => {
-    console.error('BTTV/FFZ emotes test failed!');
+    console.error('FFZ emotes test failed!');
     console.error(err);
 });