@mkody/twitch-emoticons 2.4.1 → 2.6.0

package/src/struct/SevenTVEmote.js

@@ -0,0 +1,63 @@
+const Emote = require('./Emote');
+const Constants = require('../util/Constants');
+
+/** @extends Emote */
+class SevenTVEmote extends Emote {
+    /**
+     * A 7TV emote.
+     * @param {Channel} channel - Channel this emote belongs to.
+     * @param {string} id - ID of the emote.
+     * @param {data} data - The raw emote data.
+     */
+    constructor(channel, id, data) {
+        super(channel, id, data);
+        this.type = '7tv';
+    }
+
+    /**
+     * The channel of this emote's creator.
+     * Not guaranteed to contain the emote, or be cached.
+     * @readonly
+     * @type {?Channel}
+     */
+    get owner() {
+        return this.fetcher.channels.get(this.ownerName);
+    }
+
+    _setup(data) {
+        super._setup(data);
+        this.code = data.name;
+
+        /**
+         * The name of the emote creator's channel.
+         * @type {string}
+         */
+        this.ownerName = data.owner.display_name;
+
+        /**
+         * Available image sizes.
+         * @type {string[]}
+         */
+        this.sizes = data.host.files
+            .filter(el => el.format === this.channel.format.toUpperCase())
+            .map(el => el.name);
+
+        /**
+         * The image type of the emote.
+         * @type {string}
+         */
+        this.imageType = this.channel.format;
+    }
+
+    /**
+     * Gets the image link of the emote.
+     * @param {number} size - The size of the image.
+     * @returns {string}
+     */
+    toLink(size = 0) {
+        size = this.sizes[size];
+        return Constants.SEVENTV.CDN(this.id, size); // eslint-disable-line new-cap
+    }
+}
+
+module.exports = SevenTVEmote;

package/src/util/Constants.js

@@ -1,15 +1,19 @@
 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',
         Channel: id => `https://api.betterttv.net/3/cached/users/twitch/${id}`,
         CDN: (id, size) => `https://cdn.betterttv.net/emote/${id}/${size + 1}x`
     },
+    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: {
         Channel: id => `https://api.frankerfacez.com/v1/room/id/${id}`,
-        ChannelName: name => `https://api.frankerfacez.com/v1/room/${name}`,
         CDN: (id, size) => `https://cdn.frankerfacez.com/emote/${id}/${size}`
     },
     Templates: {

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,106 @@ 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 Channel (sylux98)
+ *  - FFZ Channel (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(21490561),
+    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('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/60dd13426ef5a66f4134f804/1x.avif "EZ")',
+        '![Clap](https://cdn.7tv.app/emote/603cb71c73d7a5001441f995/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('BTTV/FFZ emotes test failed!');
+    console.error('7TV emotes test failed!');
+    console.error('(Note that they might be different during certain events like Halloween.)');
     console.error(err);
 });

package/typings/index.d.ts

@@ -1,21 +1,14 @@
 declare module '@mkody/twitch-emoticons' {
-    export class BTTVEmote extends Emote {
-        public constructor(channel: Channel, id: string, data: any);
-
-        public ownerName: string;
-        public imageType: string;
-        public readonly owner?: Channel;
-    }
-
     export class Channel {
-        public constructor(fetcher: EmoteFetcher, name: string);
+        public constructor(fetcher: EmoteFetcher, id: number);
 
         public fetcher: EmoteFetcher;
-        public name: string;
+        public id: number;
         public emotes: Collection<string, Emote>;
 
         public fetchBTTVEmotes(): Promise<Collection<string, BTTVEmote>>;
         public fetchFFZEmotes(): Promise<Collection<string, FFZEmote>>;
+        public fetchSevenTVEmotes(): Promise<Collection<string, SevenTVEmote>>;
     }
 
     export abstract class Emote {
@@ -24,10 +17,8 @@ declare module '@mkody/twitch-emoticons' {
         public fetcher: EmoteFetcher;
         public channel: Channel;
         public id: string;
-        public type: 'twitch' | 'bttv' | 'ffz';
+        public type: 'twitch' | 'bttv' | 'ffz' | '7tv';
         public code: string;
-
-        public toLink(size: number): string;
     }
 
     export class EmoteFetcher {
@@ -38,19 +29,40 @@ declare module '@mkody/twitch-emoticons' {
 
         public fetchTwitchEmotes(id?: number): Promise<Collection<string, TwitchEmote>>;
         public fetchBTTVEmotes(id?: number): Promise<Collection<string, BTTVEmote>>;
-        public fetchFFZEmotes(id: number | string): Promise<Collection<string, FFZEmote>>;
+        public fetchFFZEmotes(id: number): Promise<Collection<string, FFZEmote>>;
+        public fetchSevenTVEmotes(id?: number, format?: 'webp' | 'avif'): Promise<Collection<string, SevenTVEmote>>;
     }
 
     export class EmoteParser {
         public constructor(fetcher: EmoteFetcher, options: {
             template?: string,
             type?: string,
-            match?: RegExp 
+            match?: RegExp
         });
 
         public parse(text: string, size?: number): string;
     }
 
+    export class TwitchEmote extends Emote {
+        public constructor(channel: Channel, id: string, data: object);
+
+        public set?: string;
+        public imageType: string;
+        public readonly owner: Channel;
+
+        public toLink(size: number): string;
+    }
+
+    export class BTTVEmote extends Emote {
+        public constructor(channel: Channel, id: string, data: any);
+
+        public ownerName: string;
+        public imageType: string;
+        public readonly owner?: Channel;
+
+        public toLink(size: number): string;
+    }
+
     export class FFZEmote extends Emote {
         public constructor(channel: Channel, id: string, data: object);
 
@@ -58,14 +70,19 @@ declare module '@mkody/twitch-emoticons' {
         public sizes: string[];
         public imageType: string;
         public readonly owner?: Channel;
+
+        public toLink(size: number): string;
     }
 
-    export class TwitchEmote extends Emote {
+    export class SevenTVEmote extends Emote {
         public constructor(channel: Channel, id: string, data: object);
 
-        public set?: string;
+        public ownerName: string;
+        public sizes: string[];
         public imageType: string;
-        public readonly owner: Channel;
+        public readonly owner?: Channel;
+
+        public toLink(size: number): string;
     }
 
     export class Collection<K, V> extends Map<K, V> {

package/typings/test.ts

@@ -1,24 +0,0 @@
-/// <reference path='index.d.ts' />
-
-import { EmoteFetcher, EmoteParser, TwitchEmote } from 'twitch-emoticons';
-
-const fetcher = new EmoteFetcher();
-const parser = new EmoteParser(fetcher, {
-    type: 'markdown',
-    match: /:(.+?):/g
-});
-
-Promise.all([
-    fetcher.fetchTwitchEmotes(),
-    fetcher.fetchBTTVEmotes(),
-    fetcher.fetchBTTVEmotes('11computer'),
-    fetcher.fetchFFZEmotes('sylux98')
-]).then(() => {
-    const kappa = fetcher.emotes.get('Kappa');
-    if (kappa instanceof TwitchEmote) {
-        console.log(kappa.description);
-    }
-
-    const parsed = parser.parse('Hello world :Kappa:');
-    console.log(parsed);
-});