@mkody/twitch-emoticons 2.4.0 → 2.4.1

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

@@ -54,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/index.html

@@ -63,7 +63,7 @@
 <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>Note about Twitch emotes</h3>
+<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>

package/docs/struct_EmoteFetcher.js.html

@@ -63,7 +63,7 @@ class EmoteFetcher {
      * @param {string} clientSecret The client secret for the twitch api.
      */
     constructor(clientId, clientSecret) {
-        if (clientId && clientSecret) {
+        if (clientId !== undefined && clientSecret !== undefined) {
             const authProvider = new ClientCredentialsAuthProvider(clientId, clientSecret);
 
             /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mkody/twitch-emoticons",
-    "version": "2.4.0",
+    "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",
@@ -17,6 +17,7 @@
     "author": "MKody <gh@kdy.ch> (André Fernandes)",
     "contrubutors": [
         "1Computer",
+        "Killusions",
         "MKody"
     ],
     "license": "MIT",
@@ -27,13 +28,13 @@
     },
     "devDependencies": {
         "docdash": "^1.2.0",
-        "eslint": "^7.27.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"
+        "lint": "eslint ./src ./test"
     },
     "repository": {
         "type": "git",

package/test/index.js

@@ -6,16 +6,15 @@ const { EmoteFetcher, EmoteParser } = require('../src/index.js');
 
 /**
  * If environement variables are set, test Twitch fetching.
- * If not it has to throws an error.
  *
  * Tests:
  * - Fetch emotes
- *  - Global Twitch
- *  - Channel Twitch (twitchplayspokemon)
+ *  - Twitch Global
+ *  - Twitch Channel (twitchplayspokemon)
  * - Link to Kappa
  * - Parse to Markdown
- *  - Global Twitch emote (CoolCat)
- *  - User Twitch emote (tppD)
+ *  - 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);
@@ -44,30 +43,35 @@ if (env.TWITCH_ID !== undefined && env.TWITCH_SECRET !== undefined) {
     });
 } else {
     console.log('Notice: Twitch client id/secret missing.');
-    const twitchFetcher = new EmoteFetcher();
+}
 
-    try {
-        assert.throws(() => {
-            twitchFetcher.fetchTwitchEmotes();
-        }, new Error('Client id or client secret not provided.'));
-    } catch (err) {
-        console.error('Twitch emotes test failed!');
-        console.error(err);
-    }
+/*
+ * 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
- *  - Global BTTV
- *  - Channel BTTV (twitchplayspokemon)
- *  - FFZ user via user name (sylux98)
- *  - FFZ user via user ID (shizuka_natsume)
+ *  - BTTV Global
+ *  - BTTV Channel (twitchplayspokemon)
+ *  - FFZ via user name (sylux98)
+ *  - FFZ via user ID (shizuka_natsume)
  *
  * - Parse to Markdown
- *  - Global BTTV emote (SourPls)
- *  - Channel BTTV emote (tppUrn)
- *  - Shared BTTV emote (MODS)
+ *  - BTTV Global emote (SourPls)
+ *  - BTTV Channel emote (tppUrn)
+ *  - BTTV Shared emote (MODS)
  *  - FFZ emote from user name (AWOOO)
  *  - FFZ emote from user ID (SanaeSip)
  */

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>;