@mkody/twitch-emoticons 2.7.0 → 2.7.1

package/src/util/Collection.js

@@ -1,78 +1,78 @@
-/**
- * An extended Map with utility methods.
- * @class Collection
- */
-class Collection extends Map {
-    /**
-     * Finds first matching value by property or function.
-     * Same as `Array#find`.
-     * @param {string|Function} propOrFunc - Property or function to test.
-     * @param {any} [value] - Value to find.
-     * @returns {any}
-     */
-    find(propOrFunc, value) {
-        if (typeof propOrFunc === 'string') {
-            if (typeof value === 'undefined') return null;
-            for (const item of this.values()) {
-                if (item[propOrFunc] === value) return item;
-            }
-
-            return null;
-        }
-
-        if (typeof propOrFunc === 'function') {
-            let i = 0;
-            for (const item of this.values()) {
-                if (propOrFunc(item, i, this)) return item;
-                i++;
-            }
-
-            return null;
-        }
-
-        return null;
-    }
-
-    /**
-     * Filters cache by function.
-     * Same as `Array#filter`.
-     * @param {Function} func - Function to test.
-     * @param {any} [thisArg] - The context for the function.
-     * @returns {Collection}
-     */
-    filter(func, thisArg) {
-        if (thisArg) func = func.bind(thisArg);
-
-        const results = new this.constructor();
-
-        let i = 0;
-        for (const [key, item] of this) {
-            if (func(item, i, this)) results.set(key, item);
-            i++;
-        }
-
-        return results;
-    }
-
-    /**
-     * Maps cache by function.
-     * Same as `Array#map`.
-     * @param {Function} func - Function to use.
-     * @param {any} [thisArg] - The context for the function.
-     * @returns {any[]}
-     */
-    map(func, thisArg) {
-        if (thisArg) func = func.bind(thisArg);
-
-        const array = new Array(this.size);
-        let i = 0;
-        for (const item of this.values()) {
-            array[i] = func(item, i, this);
-            i++;
-        }
-
-        return array;
-    }
-}
-
-module.exports = Collection;
+/**
+ * An extended Map with utility methods.
+ * @class Collection
+ */
+class Collection extends Map {
+    /**
+     * Finds first matching value by property or function.
+     * Same as `Array#find`.
+     * @param {string|Function} propOrFunc - Property or function to test.
+     * @param {any} [value] - Value to find.
+     * @returns {any}
+     */
+    find(propOrFunc, value) {
+        if (typeof propOrFunc === 'string') {
+            if (typeof value === 'undefined') return null;
+            for (const item of this.values()) {
+                if (item[propOrFunc] === value) return item;
+            }
+
+            return null;
+        }
+
+        if (typeof propOrFunc === 'function') {
+            let i = 0;
+            for (const item of this.values()) {
+                if (propOrFunc(item, i, this)) return item;
+                i++;
+            }
+
+            return null;
+        }
+
+        return null;
+    }
+
+    /**
+     * Filters cache by function.
+     * Same as `Array#filter`.
+     * @param {Function} func - Function to test.
+     * @param {any} [thisArg] - The context for the function.
+     * @returns {Collection}
+     */
+    filter(func, thisArg) {
+        if (thisArg) func = func.bind(thisArg);
+
+        const results = new this.constructor();
+
+        let i = 0;
+        for (const [key, item] of this) {
+            if (func(item, i, this)) results.set(key, item);
+            i++;
+        }
+
+        return results;
+    }
+
+    /**
+     * Maps cache by function.
+     * Same as `Array#map`.
+     * @param {Function} func - Function to use.
+     * @param {any} [thisArg] - The context for the function.
+     * @returns {any[]}
+     */
+    map(func, thisArg) {
+        if (thisArg) func = func.bind(thisArg);
+
+        const array = new Array(this.size);
+        let i = 0;
+        for (const item of this.values()) {
+            array[i] = func(item, i, this);
+            i++;
+        }
+
+        return array;
+    }
+}
+
+module.exports = Collection;

package/src/util/Constants.js

@@ -1,31 +1,31 @@
-module.exports = {
-    Twitch: {
-        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',
-        Channel: id => `https://api.betterttv.net/3/cached/users/twitch/${id}`,
-        CDN: (id, size) => `https://cdn.betterttv.net/emote/${id}/${size + 1}x.webp`
-    },
-    SevenTV: {
-        Global: 'https://7tv.io/v3/emote-sets/global',
-        Channel: id => `https://7tv.io/v3/users/twitch/${id}`,
-        CDN: (id, size) => `https://cdn.7tv.app/emote/${id}/${size}`
-    },
-    FFZ: {
-        sets: {
-            Global: 3,
-            Modifiers: 1532818
-        },
-        Set: id => `https://api.frankerfacez.com/v1/set/${id}`,
-        Channel: id => `https://api.frankerfacez.com/v1/room/id/${id}`,
-        CDN: (id, size) => `https://cdn.frankerfacez.com/emote/${id}/${size}`,
-        CDNAnimated: (id, size) => `https://cdn.frankerfacez.com/emote/${id}/animated/${size}.webp`
-    },
-    Templates: {
-        html: '<img alt="{name}" title="{name}" class="twitch-emote twitch-emote-{size}" src="{link}">',
-        markdown: '![{name}]({link} "{name}")',
-        bbcode: '[img]{link}[/img]',
-        plain: '{link}'
-    }
-};
+module.exports = {
+    Twitch: {
+        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',
+        Channel: id => `https://api.betterttv.net/3/cached/users/twitch/${id}`,
+        CDN: (id, size) => `https://cdn.betterttv.net/emote/${id}/${size + 1}x.webp`
+    },
+    SevenTV: {
+        Global: 'https://7tv.io/v3/emote-sets/global',
+        Channel: id => `https://7tv.io/v3/users/twitch/${id}`,
+        CDN: (id, size) => `https://cdn.7tv.app/emote/${id}/${size}`
+    },
+    FFZ: {
+        sets: {
+            Global: 3,
+            Modifiers: 1532818
+        },
+        Set: id => `https://api.frankerfacez.com/v1/set/${id}`,
+        Channel: id => `https://api.frankerfacez.com/v1/room/id/${id}`,
+        CDN: (id, size) => `https://cdn.frankerfacez.com/emote/${id}/${size}`,
+        CDNAnimated: (id, size) => `https://cdn.frankerfacez.com/emote/${id}/animated/${size}.webp`
+    },
+    Templates: {
+        html: '<img alt="{name}" title="{name}" class="twitch-emote twitch-emote-{size}" src="{link}">',
+        markdown: '![{name}]({link} "{name}")',
+        bbcode: '[img]{link}[/img]',
+        plain: '{link}'
+    }
+};

package/test/index.js

@@ -1,174 +1,174 @@
-/* eslint-disable no-console */
-
-const assert = require('assert');
-const { env } = require('process');
-const { EmoteFetcher, EmoteParser } = require('../src/index.js');
-
-/**
- * If environement variables are set, test Twitch fetching and parsing.
- *
- * Tests:
- * - Fetch emotes
- *  - Twitch Global
- *  - Twitch Channel (twitchplayspokemon)
- * - Link to Kappa
- * - Parse to Markdown
- *  - 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/v2/25/default/dark/3.0');
-
-        const text = twitchParser.parse(':CoolCat:\n:tppD:');
-        assert.strictEqual(text, [
-            '![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.');
-    }).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);
-}
-
-/**
- * Test BetterTTV fetching and parsing.
- *
- * Tests:
- * - Fetch emotes
- *  - BTTV Global
- *  - BTTV Channel (twitchplayspokemon)
- * - Parse to Markdown
- *  - BTTV Global emote (SourPls)
- *  - BTTV Channel emote (tppUrn)
- *  - BTTV Shared emote (MODS)
- */
-const bttvFetcher = new EmoteFetcher();
-const bttvParser = new EmoteParser(bttvFetcher, {
-    type: 'markdown',
-    match: /:(.+?):/g
-});
-
-Promise.all([
-    bttvFetcher.fetchBTTVEmotes(),
-    bttvFetcher.fetchBTTVEmotes(56648155)
-]).then(() => {
-    const text = bttvParser.parse(':SourPls:\n:tppUrn:\n:MODS:');
-    assert.strictEqual(text, [
-        '![SourPls](https://cdn.betterttv.net/emote/566ca38765dbbdab32ec0560/1x.webp "SourPls")',
-        '![tppUrn](https://cdn.betterttv.net/emote/5f5f7d5f68d9d86c020e8672/1x.webp "tppUrn")',
-        '![MODS](https://cdn.betterttv.net/emote/5f2c4f9e65fe924464ef6d61/1x.webp "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 Global
- *  - FFZ Channel (0kody)
- *  - FFZ Channel (shizuka_natsume)
- * - Parse to Markdown
- *  - FFZ Global emote (CatBag)
- *  - FFZ Channel emote (5Head)
- *  - FFZ Channel animated emote (MikuSway)
- *  - FFZ Channel emote (SanaeSip)
- *  - FFZ modifier (ffzHyper)
- */
-const ffzFetcher = new EmoteFetcher();
-const ffzParser = new EmoteParser(ffzFetcher, {
-    type: 'markdown',
-    match: /:(.+?):/g
-});
-
-Promise.all([
-    ffzFetcher.fetchFFZEmotes(),
-    ffzFetcher.fetchFFZEmotes(44317909),
-    ffzFetcher.fetchFFZEmotes(13638332)
-]).then(() => {
-    const text = ffzParser.parse(':CatBag:\n:5Head:\n:MikuSway:\n:SanaeSip: :ffzHyper:');
-    assert.strictEqual(text, [
-        '![CatBag](https://cdn.frankerfacez.com/emote/25927/1 "CatBag")',
-        '![5Head](https://cdn.frankerfacez.com/emote/239504/1 "5Head")',
-        '![MikuSway](https://cdn.frankerfacez.com/emote/723102/animated/1.webp "MikuSway")',
-        // Note the trailing space as ffZHyper is removed but not the space before
-        '![SanaeSip](https://cdn.frankerfacez.com/emote/305078/1 "SanaeSip") '
-    ].join('\n'));
-}).then(() => {
-    console.log('FFZ emotes test was successful.');
-}).catch(err => {
-    console.error('FFZ emotes test failed!');
-    console.error(err);
-});
-
-/**
- * Test 7TV fetching and parsing.
- *
- * Tests:
- * - Fetch emotes
- *  - 7TV Global (in AVIF format)
- *  - 7TV Channel (0kody)
- * - Parse to Markdown
- *  - 7TV Global emote (EZ)
- *  - 7TV Global emote (Clap)
- *  - 7TV Channel emote (modCheck)
- */
-const sevenFetcher = new EmoteFetcher();
-const sevenParser = new EmoteParser(sevenFetcher, {
-    type: 'markdown',
-    match: /:(.+?):/g
-});
-
-Promise.all([
-    sevenFetcher.fetchSevenTVEmotes(null, 'avif'),
-    sevenFetcher.fetchSevenTVEmotes(44317909)
-]).then(() => {
-    const text = sevenParser.parse(':EZ:\n:Clap:\n:modCheck:');
-    assert.strictEqual(text, [
-        '![EZ](https://cdn.7tv.app/emote/63071b80942ffb69e13d700f/1x.avif "EZ")',
-        '![Clap](https://cdn.7tv.app/emote/62fc0a0c4a75fd54bd3520a9/1x.avif "Clap")',
-        '![modCheck](https://cdn.7tv.app/emote/60abf171870d317bef23d399/1x.webp "modCheck")'
-    ].join('\n'));
-}).then(() => {
-    console.log('7TV emotes test was successful.');
-}).catch(err => {
-    console.error('7TV emotes test failed!');
-    console.error('(Note that they might be different during certain events like Halloween.)');
-    console.error(err);
-});
+/* eslint-disable no-console */
+
+const assert = require('assert');
+const { env } = require('process');
+const { EmoteFetcher, EmoteParser } = require('../src/index.js');
+
+/**
+ * If environement variables are set, test Twitch fetching and parsing.
+ *
+ * Tests:
+ * - Fetch emotes
+ *  - Twitch Global
+ *  - Twitch Channel (twitchplayspokemon)
+ * - Link to Kappa
+ * - Parse to Markdown
+ *  - 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/v2/25/default/dark/3.0');
+
+        const text = twitchParser.parse(':CoolCat:\n:tppD:');
+        assert.strictEqual(text, [
+            '![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.');
+    }).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);
+}
+
+/**
+ * Test BetterTTV fetching and parsing.
+ *
+ * Tests:
+ * - Fetch emotes
+ *  - BTTV Global
+ *  - BTTV Channel (twitchplayspokemon)
+ * - Parse to Markdown
+ *  - BTTV Global emote (SourPls)
+ *  - BTTV Channel emote (tppUrn)
+ *  - BTTV Shared emote (MODS)
+ */
+const bttvFetcher = new EmoteFetcher();
+const bttvParser = new EmoteParser(bttvFetcher, {
+    type: 'markdown',
+    match: /:(.+?):/g
+});
+
+Promise.all([
+    bttvFetcher.fetchBTTVEmotes(),
+    bttvFetcher.fetchBTTVEmotes(56648155)
+]).then(() => {
+    const text = bttvParser.parse(':SourPls:\n:tppUrn:\n:MODS:');
+    assert.strictEqual(text, [
+        '![SourPls](https://cdn.betterttv.net/emote/566ca38765dbbdab32ec0560/1x.webp "SourPls")',
+        '![tppUrn](https://cdn.betterttv.net/emote/5f5f7d5f68d9d86c020e8672/1x.webp "tppUrn")',
+        '![MODS](https://cdn.betterttv.net/emote/5f2c4f9e65fe924464ef6d61/1x.webp "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 Global
+ *  - FFZ Channel (0kody)
+ *  - FFZ Channel (shizuka_natsume)
+ * - Parse to Markdown
+ *  - FFZ Global emote (CatBag)
+ *  - FFZ Channel emote (5Head)
+ *  - FFZ Channel animated emote (MikuSway)
+ *  - FFZ Channel emote (SanaeSip)
+ *  - FFZ modifier (ffzHyper)
+ */
+const ffzFetcher = new EmoteFetcher();
+const ffzParser = new EmoteParser(ffzFetcher, {
+    type: 'markdown',
+    match: /:(.+?):/g
+});
+
+Promise.all([
+    ffzFetcher.fetchFFZEmotes(),
+    ffzFetcher.fetchFFZEmotes(44317909),
+    ffzFetcher.fetchFFZEmotes(13638332)
+]).then(() => {
+    const text = ffzParser.parse(':CatBag:\n:5Head:\n:MikuSway:\n:SanaeSip: :ffzHyper:');
+    assert.strictEqual(text, [
+        '![CatBag](https://cdn.frankerfacez.com/emote/25927/1 "CatBag")',
+        '![5Head](https://cdn.frankerfacez.com/emote/239504/1 "5Head")',
+        '![MikuSway](https://cdn.frankerfacez.com/emote/723102/animated/1.webp "MikuSway")',
+        // Note the trailing space as ffZHyper is removed but not the space before
+        '![SanaeSip](https://cdn.frankerfacez.com/emote/305078/1 "SanaeSip") '
+    ].join('\n'));
+}).then(() => {
+    console.log('FFZ emotes test was successful.');
+}).catch(err => {
+    console.error('FFZ emotes test failed!');
+    console.error(err);
+});
+
+/**
+ * Test 7TV fetching and parsing.
+ *
+ * Tests:
+ * - Fetch emotes
+ *  - 7TV Global (in AVIF format)
+ *  - 7TV Channel (0kody)
+ * - Parse to Markdown
+ *  - 7TV Global emote (EZ)
+ *  - 7TV Global emote (Clap)
+ *  - 7TV Channel emote (modCheck)
+ */
+const sevenFetcher = new EmoteFetcher();
+const sevenParser = new EmoteParser(sevenFetcher, {
+    type: 'markdown',
+    match: /:(.+?):/g
+});
+
+Promise.all([
+    sevenFetcher.fetchSevenTVEmotes(null, 'avif'),
+    sevenFetcher.fetchSevenTVEmotes(44317909)
+]).then(() => {
+    const text = sevenParser.parse(':EZ:\n:Clap:\n:modCheck:');
+    assert.strictEqual(text, [
+        '![EZ](https://cdn.7tv.app/emote/63071b80942ffb69e13d700f/1x.avif "EZ")',
+        '![Clap](https://cdn.7tv.app/emote/62fc0a0c4a75fd54bd3520a9/1x.avif "Clap")',
+        '![modCheck](https://cdn.7tv.app/emote/60abf171870d317bef23d399/1x.webp "modCheck")'
+    ].join('\n'));
+}).then(() => {
+    console.log('7TV emotes test was successful.');
+}).catch(err => {
+    console.error('7TV emotes test failed!');
+    console.error('(Note that they might be different during certain events like Halloween.)');
+    console.error(err);
+});