@mkody/twitch-emoticons 2.7.0 → 2.8.0

package/src/struct/TwitchEmote.js

@@ -1,58 +1,87 @@
-const Emote = require('./Emote');
-const Constants = require('../util/Constants');
-
-/** @extends Emote */
-class TwitchEmote extends Emote {
-    /**
-     * A Twitch 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 = 'twitch';
-    }
-
-    /**
-     * The channel of this emote's creator.
-     * @readonly
-     * @type {Channel}
-     */
-    get owner() {
-        return this.channel;
-    }
-
-    _setup(data) {
-        super._setup(data);
-
-        /**
-         * The set ID of the emote.
-         * @type {?string}
-         */
-        this.set = data.emoticon_set;
-
-        /**
-         * If emote is animated.
-         * @type {boolean}
-         */
-        this.animated = 'animated' in data.formats;
-
-        /**
-         * The image type of the emote.
-         * @type {string}
-         */
-        this.imageType = 'animated' in data.formats ? 'gif' : 'png';
-    }
-
-    /**
-     * Gets the image link of the emote.
-     * @param {number} size - The size of the image, 0, 1, or 2.
-     * @returns {string}
-     */
-    toLink(size = 0) {
-        return Constants.Twitch.CDN(this.id, size); // eslint-disable-line new-cap
-    }
-}
-
-module.exports = TwitchEmote;
+const Emote = require('./Emote');
+const Constants = require('../util/Constants');
+
+/** @extends Emote */
+class TwitchEmote extends Emote {
+    /**
+     * A Twitch 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 = 'twitch';
+    }
+
+    /**
+     * The channel of this emote's creator.
+     * @readonly
+     * @type {Channel}
+     */
+    get owner() {
+        return this.channel;
+    }
+
+    _setup(data) {
+        super._setup(data);
+
+        /**
+         * The set ID of the emote.
+         * @type {?string}
+         */
+        this.set = data.emoticon_set;
+
+        /**
+         * If emote is animated.
+         * @type {boolean}
+         */
+        this.animated = 'animated' in data.formats;
+
+        /**
+         * The image type of the emote.
+         * @type {string}
+         */
+        this.imageType = 'animated' in data.formats ? 'gif' : 'png';
+    }
+
+    /**
+     * Gets the image link of the emote.
+     * @param {number} size - The size of the image, 0, 1, or 2.
+     * @returns {string}
+     */
+    toLink(size = 0) {
+        return Constants.Twitch.CDN(this.id, size); // eslint-disable-line new-cap
+    }
+
+    /**
+     * Override for `toObject`.
+     * Will result in an Object representation of a TwitchEmote
+     * @returns {Object}
+     */
+    toObject() {
+        return Object.assign({}, super.toObject(), {
+            animated: this.animated,
+            set: this.set,
+            type: this.type
+        });
+    }
+
+    /**
+     * Converts an emote Object into a TwitchEmote
+     * @param {Object} [emoteObject] - Object representation of this emote
+     * @param {Channel} [channel=null] - Channel this emote belongs to.
+     * @returns {TwitchEmote}
+     */
+    static fromObject(emoteObject, channel = null) {
+        return new TwitchEmote(channel, emoteObject.id,
+            {
+                code: emoteObject.code,
+                animated: emoteObject.animated,
+                emoticon_set: emoteObject.set,
+                formats: emoteObject.animated ? { animated: emoteObject.animated } : {}
+            });
+    }
+}
+
+module.exports = TwitchEmote;

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}'
+    }
+};