@mkody/twitch-emoticons 2.9.6 → 3.0.0-beta.2

package/test/BTTV.test.js

@@ -1,48 +0,0 @@
-const { describe, expect, test } = require('@jest/globals');
-const { EmoteFetcher, EmoteParser, Collection } = require('../src/index.js');
-
-describe('Test BTTV emotes', () => {
-    describe('Test global emotes', () => {
-        const emoteFetcher = new EmoteFetcher();
-        const emoteParser = new EmoteParser(emoteFetcher, {
-            type: 'markdown',
-            match: /:(.+?):/g
-        });
-
-        test('Execute fetchBTTVEmotes without any parameters', async() => {
-            expect(await emoteFetcher.fetchBTTVEmotes()).toBeInstanceOf(Collection);
-        });
-
-        test('Get emote (SourPls)', () => {
-            const emote = emoteFetcher.emotes.get('SourPls');
-            expect(emote.toLink(2)).toBe('https://cdn.betterttv.net/emote/566ca38765dbbdab32ec0560/3x.webp');
-        });
-
-        test('Parse string with emote (SourPls)', () => {
-            const text = emoteParser.parse('This is a test string with :SourPls: in it.');
-            expect(text).toBe('This is a test string with ![SourPls](https://cdn.betterttv.net/emote/566ca38765dbbdab32ec0560/1x.webp "SourPls") in it.');
-        });
-    });
-
-    describe('Test user emotes', () => {
-        const emoteFetcher = new EmoteFetcher();
-        const emoteParser = new EmoteParser(emoteFetcher, {
-            type: 'markdown',
-            match: /:(.+?):/g
-        });
-
-        test('Execute fetchBTTVEmotes with user ID', async() => {
-            expect(await emoteFetcher.fetchBTTVEmotes(56648155)).toBeInstanceOf(Collection);
-        });
-
-        test('Get emote (tppUrn)', () => {
-            const emote = emoteFetcher.emotes.get('tppUrn');
-            expect(emote.toLink(2)).toBe('https://cdn.betterttv.net/emote/5f5f7d5f68d9d86c020e8672/3x.webp');
-        });
-
-        test('Parse string with emote (tppUrn)', () => {
-            const text = emoteParser.parse('This is a test string with :tppUrn: in it.');
-            expect(text).toBe('This is a test string with ![tppUrn](https://cdn.betterttv.net/emote/5f5f7d5f68d9d86c020e8672/1x.webp "tppUrn") in it.');
-        });
-    });
-});

package/test/FFZ.test.js

@@ -1,71 +0,0 @@
-const { describe, expect, test } = require('@jest/globals');
-const { EmoteFetcher, EmoteParser, Collection } = require('../src/index.js');
-
-describe('Test FFZ emotes', () => {
-    describe('Test global emotes', () => {
-        const emoteFetcher = new EmoteFetcher();
-        const emoteParser = new EmoteParser(emoteFetcher, {
-            type: 'markdown',
-            match: /:(.+?):/g
-        });
-
-        test('Execute fetchFFZEmotes without any parameters', async() => {
-            expect(await emoteFetcher.fetchFFZEmotes()).toBeInstanceOf(Collection);
-        });
-
-        test('Get emote (CatBag)', () => {
-            const emote = emoteFetcher.emotes.get('CatBag');
-            expect(emote.toLink(2)).toBe('https://cdn.frankerfacez.com/emote/25927/4');
-        });
-
-        test('Parse string with emote (CatBag)', () => {
-            const text = emoteParser.parse('This is a test string with :CatBag: in it.');
-            expect(text).toBe('This is a test string with ![CatBag](https://cdn.frankerfacez.com/emote/25927/1 "CatBag") in it.');
-        });
-    });
-
-    describe('Test user emotes', () => {
-        const emoteFetcher = new EmoteFetcher();
-        const emoteParser = new EmoteParser(emoteFetcher, {
-            type: 'markdown',
-            match: /:(.+?):/g
-        });
-
-        test('Execute fetchFFZEmotes with user ID', async() => {
-            expect(await emoteFetcher.fetchFFZEmotes(44317909)).toBeInstanceOf(Collection);
-        });
-
-        test('Get emote (5Head)', () => {
-            const emote = emoteFetcher.emotes.get('5Head');
-            expect(emote.toLink(2)).toBe('https://cdn.frankerfacez.com/emote/239504/4');
-        });
-
-        test('Parse string with emote (5Head)', () => {
-            const text = emoteParser.parse('This is a test string with :5Head: in it.');
-            expect(text).toBe('This is a test string with ![5Head](https://cdn.frankerfacez.com/emote/239504/1 "5Head") in it.');
-        });
-    });
-
-    describe('Test animated and modifier emotes', () => {
-        const emoteFetcher = new EmoteFetcher();
-        const emoteParser = new EmoteParser(emoteFetcher, {
-            type: 'markdown',
-            match: /:(.+?):/g
-        });
-
-        test('Execute fetchFFZEmotes with user ID', async() => {
-            expect(await emoteFetcher.fetchFFZEmotes(44317909)).toBeInstanceOf(Collection);
-        });
-
-        test('Get animated emote (MikuSway)', () => {
-            const emote = emoteFetcher.emotes.get('MikuSway');
-            expect(emote.toLink(2)).toBe('https://cdn.frankerfacez.com/emote/723102/animated/4.webp');
-        });
-
-        test('Parse string with emote (monkaEyes) and modifier (ffzHyper)', () => {
-            const text = emoteParser.parse('This is a test string with :monkaEyes: :ffzHyper: in it.');
-            // Note the double space: ffzHyper is removed but not the space before
-            expect(text).toBe('This is a test string with ![monkaEyes](https://cdn.frankerfacez.com/emote/268204/1 "monkaEyes")  in it.');
-        });
-    });
-});

package/test/SevenTV.test.js

@@ -1,71 +0,0 @@
-const { describe, expect, test } = require('@jest/globals');
-const { EmoteFetcher, EmoteParser, Collection } = require('../src/index.js');
-
-describe('Test 7TV emotes', () => {
-    describe('Test global emotes (WEBP)', () => {
-        const emoteFetcher = new EmoteFetcher();
-        const emoteParser = new EmoteParser(emoteFetcher, {
-            type: 'markdown',
-            match: /:(.+?):/g
-        });
-
-        test('Execute fetchSevenTVEmotes with the WEBP format', async() => {
-            expect(await emoteFetcher.fetchSevenTVEmotes(null, 'webp')).toBeInstanceOf(Collection);
-        });
-
-        test('Get emote (EZ)', () => {
-            const emote = emoteFetcher.emotes.get('EZ');
-            expect(emote.toLink(2)).toBe('https://cdn.7tv.app/emote/01GB4CK01800090V9B3D8CGEEX/3x.webp');
-        });
-
-        test('Parse string with emote (EZ)', () => {
-            const text = emoteParser.parse('This is a test string with :EZ: in it.');
-            expect(text).toBe('This is a test string with ![EZ](https://cdn.7tv.app/emote/01GB4CK01800090V9B3D8CGEEX/1x.webp "EZ") in it.');
-        });
-    });
-
-    describe('Test global emotes (AVIF)', () => {
-        const emoteFetcher = new EmoteFetcher();
-        const emoteParser = new EmoteParser(emoteFetcher, {
-            type: 'markdown',
-            match: /:(.+?):/g
-        });
-
-        test('Execute fetchSevenTVEmotes with the AVIF format', async() => {
-            expect(await emoteFetcher.fetchSevenTVEmotes(null, 'avif')).toBeInstanceOf(Collection);
-        });
-
-        test('Get emote (Clap)', () => {
-            const emote = emoteFetcher.emotes.get('Clap');
-            expect(emote.toLink(2)).toBe('https://cdn.7tv.app/emote/01GAM8EFQ00004MXFXAJYKA859/3x.avif');
-        });
-
-        test('Parse string with emote (Clap)', () => {
-            const text = emoteParser.parse('This is a test string with :Clap: in it.');
-            expect(text).toBe('This is a test string with ![Clap](https://cdn.7tv.app/emote/01GAM8EFQ00004MXFXAJYKA859/1x.avif "Clap") in it.');
-        });
-    });
-
-    describe('Test user emotes', () => {
-        const emoteFetcher = new EmoteFetcher();
-        const emoteParser = new EmoteParser(emoteFetcher, {
-            type: 'markdown',
-            match: /:(.+?):/g
-        });
-
-        test('Execute fetchSevenTVEmotes with user ID', async() => {
-            expect(await emoteFetcher.fetchSevenTVEmotes(44317909)).toBeInstanceOf(Collection);
-        });
-
-        // YABE was picked as it has been renamed from "fubukiYabe" on this channel
-        test('Get emote (YABE)', () => {
-            const emote = emoteFetcher.emotes.get('YABE');
-            expect(emote.toLink(2)).toBe('https://cdn.7tv.app/emote/01FFNN7CG00009CAK0J14696HH/3x.webp');
-        });
-
-        test('Parse string with emote (YABE)', () => {
-            const text = emoteParser.parse('This is a test string with :YABE: in it.');
-            expect(text).toBe('This is a test string with ![YABE](https://cdn.7tv.app/emote/01FFNN7CG00009CAK0J14696HH/1x.webp "YABE") in it.');
-        });
-    });
-});

package/test/ToFromObject.test.js

@@ -1,156 +0,0 @@
-const { describe, expect, test, beforeEach } = require('@jest/globals');
-const { env } = require('process');
-const { EmoteFetcher, EmoteParser } = require('../src/index.js');
-
-describe('Test toObject', () => {
-    let emoteFetcher;
-
-    beforeEach(() => {
-        // Make a fresh EmoteFetcher object before each tests
-        // This prevents surprises in case there's an emote name used in multiple sources
-        emoteFetcher = new EmoteFetcher(env.TWITCH_ID, env.TWITCH_SECRET);
-    });
-
-    test('BTTV Global Emote', async() => {
-        await emoteFetcher.fetchBTTVEmotes();
-        expect(emoteFetcher.emotes.get('SourPls').toObject()).toMatchSnapshot();
-    });
-
-    test('BTTV User Emote', async() => {
-        await emoteFetcher.fetchBTTVEmotes(56648155);
-        expect(emoteFetcher.emotes.get('tppUrn').toObject()).toMatchSnapshot();
-    });
-
-    test('BTTV User Animated Emote', async() => {
-        await emoteFetcher.fetchBTTVEmotes(56648155);
-        expect(emoteFetcher.emotes.get('MODS').toObject()).toMatchSnapshot();
-    });
-
-    test('FFZ Global Emote', async() => {
-        await emoteFetcher.fetchFFZEmotes();
-        expect(emoteFetcher.emotes.get('CatBag').toObject()).toMatchSnapshot();
-    });
-
-    test('FFZ User Emote', async() => {
-        await emoteFetcher.fetchFFZEmotes(13638332);
-        expect(emoteFetcher.emotes.get('SanaeSip').toObject()).toMatchSnapshot();
-    });
-
-    test('FFZ User Animated Emote', async() => {
-        await emoteFetcher.fetchFFZEmotes(44317909);
-        expect(emoteFetcher.emotes.get('MikuSway').toObject()).toMatchSnapshot();
-    });
-
-    test('7TV Global Emote (AVIF)', async() => {
-        await emoteFetcher.fetchSevenTVEmotes(null, 'avif');
-        expect(emoteFetcher.emotes.get('EZ').toObject()).toMatchSnapshot();
-    });
-
-    test('7TV User Emote', async() => {
-        await emoteFetcher.fetchSevenTVEmotes(44317909);
-        // YABE was picked as it has been renamed from "fubukiYabe" on this channel
-        expect(emoteFetcher.emotes.get('YABE').toObject()).toMatchSnapshot();
-    });
-
-    if (env.TWITCH_ID === undefined || env.TWITCH_SECRET === undefined
-        || env.TWITCH_ID === '' || env.TWITCH_SECRET === '') {
-        test.todo('Notice: Twitch client id/secret missing, not testing with Twitch emotes.');
-    } else {
-        test('Twitch Global Emote', async() => {
-            await emoteFetcher.fetchTwitchEmotes();
-            // Use inline to not fail when the environment variables are not set
-            expect(emoteFetcher.emotes.get('Kappa').toObject()).toMatchInlineSnapshot(`
-{
-  "animated": false,
-  "channel_id": null,
-  "code": "Kappa",
-  "id": "25",
-  "set": undefined,
-  "type": "twitch",
-}
-`);
-        });
-
-        test('Twitch User Emote', async() => {
-            await emoteFetcher.fetchTwitchEmotes(56648155);
-            // Use inline to not fail when the environment variables are not set
-            expect(emoteFetcher.emotes.get('tppD').toObject()).toMatchInlineSnapshot(`
-{
-  "animated": false,
-  "channel_id": 56648155,
-  "code": "tppD",
-  "id": "307609315",
-  "set": undefined,
-  "type": "twitch",
-}
-`);
-        });
-    }
-});
-
-describe('Test fromObject', () => {
-    const emoteFetcher = new EmoteFetcher();
-    const emoteParser = new EmoteParser(emoteFetcher, {
-        type: 'markdown',
-        match: /(\w+)+?/g
-    });
-
-    const emotes_obj = [
-        {
-            code: 'tppD',
-            id: '307609315',
-            channel_id: 56648155,
-            animated: false,
-            set: undefined,
-            type: 'twitch'
-        },
-        {
-            code: 'SourPls',
-            id: '566ca38765dbbdab32ec0560',
-            channel_id: null,
-            animated: true,
-            ownerName: null,
-            type: 'bttv'
-        },
-        {
-            code: 'modCheck',
-            id: '60abf171870d317bef23d399',
-            channel_id: 44317909,
-            animated: true,
-            sizes: ['1x.webp', '2x.webp', '3x.webp', '4x.webp'],
-            ownerName: 'Laden',
-            type: '7tv',
-            imageType: 'webp'
-        },
-        {
-            code: 'MikuSway',
-            id: 723102,
-            channel_id: 44317909,
-            animated: true,
-            sizes: ['1', '2', '4'],
-            ownerName: 'brian6932',
-            type: 'ffz',
-            modifier: false
-        }
-    ];
-
-    test('Execute fromObject', () => {
-        expect(emoteFetcher.fromObject(emotes_obj)).toBeInstanceOf(Array);
-    });
-
-    test('Get emote (SourPls)', () => {
-        const emote = emoteFetcher.emotes.get('SourPls');
-        expect(emote.toLink()).toBe('https://cdn.betterttv.net/emote/566ca38765dbbdab32ec0560/1x.webp');
-    });
-
-    test('Parse string with emotes (tppD, SourPls, modCheck, MikuSway)', () => {
-        expect(emoteParser.parse('tppD SourPls modCheck MikuSway')).toBe(
-            [
-                '![tppD](https://static-cdn.jtvnw.net/emoticons/v2/307609315/default/dark/1.0 "tppD")',
-                '![SourPls](https://cdn.betterttv.net/emote/566ca38765dbbdab32ec0560/1x.webp "SourPls")',
-                '![modCheck](https://cdn.7tv.app/emote/60abf171870d317bef23d399/1x.webp "modCheck")',
-                '![MikuSway](https://cdn.frankerfacez.com/emote/723102/animated/1.webp "MikuSway")'
-            ].join(' ')
-        );
-    });
-});

package/test/Twitch.test.js

@@ -1,64 +0,0 @@
-const { describe, expect, test } = require('@jest/globals');
-const { env } = require('process');
-const { EmoteFetcher, EmoteParser, Collection } = require('../src/index.js');
-
-describe('Test Twitch emotes', () => {
-    test('Test failing when environment variables are not set', () => {
-        const emoteFetcher = new EmoteFetcher();
-
-        expect(() => {
-            emoteFetcher.fetchTwitchEmotes();
-        }).toThrow(
-            new Error('Client id or client secret not provided.')
-        );
-    });
-
-    if (env.TWITCH_ID === undefined || env.TWITCH_SECRET === undefined
-      || env.TWITCH_ID === '' || env.TWITCH_SECRET === '') {
-        test.todo('Notice: Twitch client id/secret missing, not testing fetching and parsing.');
-    } else {
-        describe('Test global emotes', () => {
-            const emoteFetcher = new EmoteFetcher(env.TWITCH_ID, env.TWITCH_SECRET);
-            const emoteParser = new EmoteParser(emoteFetcher, {
-                type: 'markdown',
-                match: /:(.+?):/g
-            });
-
-            test('Execute fetchTwitchEmotes without any parameters', async() => {
-                expect(await emoteFetcher.fetchTwitchEmotes()).toBeInstanceOf(Collection);
-            });
-
-            test('Get emote (Kappa)', () => {
-                const emote = emoteFetcher.emotes.get('Kappa');
-                expect(emote.toLink(2)).toBe('https://static-cdn.jtvnw.net/emoticons/v2/25/default/dark/3.0');
-            });
-
-            test('Parse string with emote (CoolCat)', () => {
-                const text = emoteParser.parse('This is a test string with :CoolCat: in it.');
-                expect(text).toBe('This is a test string with ![CoolCat](https://static-cdn.jtvnw.net/emoticons/v2/58127/default/dark/1.0 "CoolCat") in it.');
-            });
-        });
-
-        describe('Test user emotes', () => {
-            const emoteFetcher = new EmoteFetcher(env.TWITCH_ID, env.TWITCH_SECRET);
-            const emoteParser = new EmoteParser(emoteFetcher, {
-                type: 'markdown',
-                match: /:(.+?):/g
-            });
-
-            test('Execute fetchTwitchEmotes with user ID', async() => {
-                expect(await emoteFetcher.fetchTwitchEmotes(56648155)).toBeInstanceOf(Collection);
-            });
-
-            test('Get emote (tppD)', () => {
-                const emote = emoteFetcher.emotes.get('tppD');
-                expect(emote.toLink(2)).toBe('https://static-cdn.jtvnw.net/emoticons/v2/307609315/default/dark/3.0');
-            });
-
-            test('Parse string with emote (tppD)', () => {
-                const text = emoteParser.parse('This is a test string with :tppD: in it.');
-                expect(text).toBe('This is a test string with ![tppD](https://static-cdn.jtvnw.net/emoticons/v2/307609315/default/dark/1.0 "tppD") in it.');
-            });
-        });
-    }
-});

package/test/__snapshots__/ToFromObject.test.js.snap

@@ -1,121 +0,0 @@
-// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
-
-exports[`Test toObject 7TV Global Emote (AVIF) 1`] = `
-{
-  "animated": false,
-  "channel_id": null,
-  "code": "EZ",
-  "id": "01GB4CK01800090V9B3D8CGEEX",
-  "imageType": "avif",
-  "ownerName": "TrippyColour",
-  "sizes": [
-    "1x.avif",
-    "2x.avif",
-    "3x.avif",
-    "4x.avif",
-  ],
-  "type": "7tv",
-}
-`;
-
-exports[`Test toObject 7TV User Emote 1`] = `
-{
-  "animated": true,
-  "channel_id": 44317909,
-  "code": "YABE",
-  "id": "01FFNN7CG00009CAK0J14696HH",
-  "imageType": "webp",
-  "ownerName": "jenji333",
-  "sizes": [
-    "1x.webp",
-    "2x.webp",
-    "3x.webp",
-    "4x.webp",
-  ],
-  "type": "7tv",
-}
-`;
-
-exports[`Test toObject BTTV Global Emote 1`] = `
-{
-  "animated": true,
-  "channel_id": null,
-  "code": "SourPls",
-  "id": "566ca38765dbbdab32ec0560",
-  "ownerName": null,
-  "type": "bttv",
-}
-`;
-
-exports[`Test toObject BTTV User Animated Emote 1`] = `
-{
-  "animated": true,
-  "channel_id": 56648155,
-  "code": "MODS",
-  "id": "5f2c4f9e65fe924464ef6d61",
-  "ownerName": "bearrrr_",
-  "type": "bttv",
-}
-`;
-
-exports[`Test toObject BTTV User Emote 1`] = `
-{
-  "animated": false,
-  "channel_id": 56648155,
-  "code": "tppUrn",
-  "id": "5f5f7d5f68d9d86c020e8672",
-  "ownerName": null,
-  "type": "bttv",
-}
-`;
-
-exports[`Test toObject FFZ Global Emote 1`] = `
-{
-  "animated": false,
-  "channel_id": null,
-  "code": "CatBag",
-  "id": 25927,
-  "modifier": false,
-  "ownerName": "wolsk",
-  "sizes": [
-    "1",
-    "2",
-    "4",
-  ],
-  "type": "ffz",
-}
-`;
-
-exports[`Test toObject FFZ User Animated Emote 1`] = `
-{
-  "animated": true,
-  "channel_id": 44317909,
-  "code": "MikuSway",
-  "id": 723102,
-  "modifier": false,
-  "ownerName": "brian6932",
-  "sizes": [
-    "1",
-    "2",
-    "4",
-  ],
-  "type": "ffz",
-}
-`;
-
-exports[`Test toObject FFZ User Emote 1`] = `
-{
-  "animated": false,
-  "channel_id": 13638332,
-  "code": "SanaeSip",
-  "id": 305078,
-  "modifier": false,
-  "ownerName": "shizuka_natsume",
-  "sizes": [
-    "1",
-    "2",
-    "4",
-  ],
-  "type": "ffz",
-}
-`;

package/test/other.test.js

@@ -1,72 +0,0 @@
-const { describe, expect, test } = require('@jest/globals');
-const { Emote, EmoteFetcher, EmoteParser } = require('../src/index.js');
-
-describe('Emote class', () => {
-    test('Base Emote class should not be used by itself', () => {
-        expect(() => {
-            // eslint-disable-next-line no-unused-vars
-            const emote = new Emote();
-        }).toThrow(
-            new Error('Base Emote class cannot be used')
-        );
-    });
-});
-
-describe('EmoteParser\'s _validateOptions', () => {
-    const fetcher = new EmoteFetcher();
-
-    test('Should not throw on valid options', () => {
-        expect(() => {
-            // eslint-disable-next-line no-unused-vars
-            const parser = new EmoteParser(fetcher, {
-                template: '![{name}]({link} "{name}")',
-                type: 'markdown',
-                match: /:(.+?):/g
-            });
-        }).not.toThrow();
-    });
-
-    test('Should throw on invalid template', () => {
-        expect(() => {
-            // eslint-disable-next-line no-unused-vars
-            const parser = new EmoteParser(fetcher, {
-                template: () => { return 'test'; }
-            });
-        }).toThrow(
-            new TypeError('Template must be a string')
-        );
-    });
-
-    test('Should throw on invalid type', () => {
-        expect(() => {
-            // eslint-disable-next-line no-unused-vars
-            const parser = new EmoteParser(fetcher, {
-                type: 'invalid-type'
-            });
-        }).toThrow(
-            new TypeError('Parse type must be one of `markdown`, `html`, `bbcode`, or `plain`')
-        );
-    });
-
-    test('Should throw when not using a global regex', () => {
-        expect(() => {
-            // eslint-disable-next-line no-unused-vars
-            const parser = new EmoteParser(fetcher, {
-                match: /:(.+?):/
-            });
-        }).toThrow(
-            new TypeError('Match must be a global RegExp.')
-        );
-    });
-
-    test('Should throw when not using a regex object', () => {
-        expect(() => {
-            // eslint-disable-next-line no-unused-vars
-            const parser = new EmoteParser(fetcher, {
-                match: 'not-a-regex'
-            });
-        }).toThrow(
-            new TypeError('Match must be a global RegExp.')
-        );
-    });
-});