@mkody/twitch-emoticons 2.7.0 → 2.8.0

package/src/struct/EmoteParser.js

@@ -1,81 +1,81 @@
-const Constants = require('../util/Constants');
-
-class EmoteParser {
-    /**
-     * A parser to replace text with emotes.
-     * @param {EmoteFetcher} fetcher - The fetcher to use the cache of.
-     * @param {Object} [options={}] - Options for the parser.
-     * @param {string} [options.template] - The template to be used.
-     * The strings that can be interpolated are:
-     * - `{link}` The link of the emote.
-     * - `{name}` The name of the emote.
-     * - `{size}` The size of the image.
-     * - `{creator}` The channel/owner name of the emote.
-     * @param {string} [options.type='markdown'] - The type of the parser.
-     * Can be one of `markdown`, `html`, `bbcode`, or `plain`.
-     * If the `template` option is provided, this is ignored.
-     * @param {RegExp} [options.match=/:(.+?):/g] - The regular expression that matches an emote.
-     * Must be a global regex, with one capture group for the emote code.
-     */
-    constructor(fetcher, options = {}) {
-        /**
-         * The emote fetcher being used.
-         * @type {EmoteFetcher}
-         */
-        this.fetcher = fetcher;
-
-        /**
-         * The parser options.
-         * @type {Object}
-         */
-        this.options = Object.assign({
-            template: '',
-            type: 'markdown',
-            match: /:(.+?):/g
-        }, options);
-
-        this._validateOptions(this.options);
-    }
-
-    _validateOptions(options) {
-        if (options.template && typeof options.template !== 'string') {
-            throw new TypeError('Template must be a string');
-        }
-
-        if (!['markdown', 'html', 'bbcode', 'plain'].includes(options.type)) {
-            throw new TypeError('Parse type must be one of `markdown`, `html`, `bbcode`, or `plain`');
-        }
-
-        if (!(options.match instanceof RegExp) || !options.match.global) {
-            throw new TypeError('Match must be a global RegExp.');
-        }
-    }
-
-    /**
-     * Parses text.
-     * @param {string} text - Text to parse.
-     * @param {number} size - Size for emotes.
-     * @returns {string}
-     */
-    parse(text, size = 0) {
-        const parsed = text.replace(this.options.match, (matched, id) => {
-            const emote = this.fetcher.emotes.get(id);
-            if (!emote) return matched;
-            if (emote.modifier) return '';
-
-            const template = this.options.template || Constants.Templates[this.options.type];
-            const link = emote.toLink(size);
-            const res = template
-                .replace(/{link}/g, link)
-                .replace(/{name}/g, emote.code)
-                .replace(/{size}/g, size)
-                .replace(/{creator}/g, emote.ownerName || 'global');
-
-            return res;
-        });
-
-        return parsed;
-    }
-}
-
-module.exports = EmoteParser;
+const Constants = require('../util/Constants');
+
+class EmoteParser {
+    /**
+     * A parser to replace text with emotes.
+     * @param {EmoteFetcher} fetcher - The fetcher to use the cache of.
+     * @param {Object} [options={}] - Options for the parser.
+     * @param {string} [options.template] - The template to be used.
+     * The strings that can be interpolated are:
+     * - `{link}` The link of the emote.
+     * - `{name}` The name of the emote.
+     * - `{size}` The size of the image.
+     * - `{creator}` The channel/owner name of the emote.
+     * @param {string} [options.type='markdown'] - The type of the parser.
+     * Can be one of `markdown`, `html`, `bbcode`, or `plain`.
+     * If the `template` option is provided, this is ignored.
+     * @param {RegExp} [options.match=/:(.+?):/g] - The regular expression that matches an emote.
+     * Must be a global regex, with one capture group for the emote code.
+     */
+    constructor(fetcher, options = {}) {
+        /**
+         * The emote fetcher being used.
+         * @type {EmoteFetcher}
+         */
+        this.fetcher = fetcher;
+
+        /**
+         * The parser options.
+         * @type {Object}
+         */
+        this.options = Object.assign({
+            template: '',
+            type: 'markdown',
+            match: /:(.+?):/g
+        }, options);
+
+        this._validateOptions(this.options);
+    }
+
+    _validateOptions(options) {
+        if (options.template && typeof options.template !== 'string') {
+            throw new TypeError('Template must be a string');
+        }
+
+        if (!['markdown', 'html', 'bbcode', 'plain'].includes(options.type)) {
+            throw new TypeError('Parse type must be one of `markdown`, `html`, `bbcode`, or `plain`');
+        }
+
+        if (!(options.match instanceof RegExp) || !options.match.global) {
+            throw new TypeError('Match must be a global RegExp.');
+        }
+    }
+
+    /**
+     * Parses text.
+     * @param {string} text - Text to parse.
+     * @param {number} size - Size for emotes.
+     * @returns {string}
+     */
+    parse(text, size = 0) {
+        const parsed = text.replace(this.options.match, (matched, id) => {
+            const emote = this.fetcher.emotes.get(id);
+            if (!emote) return matched;
+            if (emote.modifier) return '';
+
+            const template = this.options.template || Constants.Templates[this.options.type];
+            const link = emote.toLink(size);
+            const res = template
+                .replace(/{link}/g, link)
+                .replace(/{name}/g, emote.code)
+                .replace(/{size}/g, size)
+                .replace(/{creator}/g, emote.ownerName || 'global');
+
+            return res;
+        });
+
+        return parsed;
+    }
+}
+
+module.exports = EmoteParser;

package/src/struct/EmoteTypeMapper.js

@@ -0,0 +1,13 @@
+const BTTVEmote = require('./BTTVEmote');
+const FFZEmote = require('./FFZEmote');
+const SevenTVEmote = require('./SevenTVEmote');
+const TwitchEmote = require('./TwitchEmote');
+
+class EmoteTypeMapper {
+    static getClassByType(type) {
+        const classMap = { BTTVEmote, FFZEmote, SevenTVEmote, TwitchEmote };
+        return classMap[type] || null;
+    }
+}
+
+module.exports = EmoteTypeMapper;

package/src/struct/FFZEmote.js

@@ -1,74 +1,113 @@
-const Emote = require('./Emote');
-const Constants = require('../util/Constants');
-
-/** @extends Emote */
-class FFZEmote extends Emote {
-    /**
-     * An FFZ 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 = 'ffz';
-    }
-
-    /**
-     * 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.name;
-
-        /**
-         * Available image sizes.
-         * @type {string[]}
-         */
-        this.sizes = 'animated' in data ? Object.keys(data.animated) : Object.keys(data.urls);
-
-        /**
-         * If emote is animated.
-         * @type {boolean}
-         */
-        this.animated = 'animated' in data;
-
-        /**
-         * The image type of the emote.
-         * @type {string}
-         */
-        this.imageType = 'animated' in data ? 'webp' : 'png';
-
-        /**
-         * If the emote is a modifier and should be hidden.
-         * @type {boolean}
-         */
-        this.modifier = data.modifier && (data.modifier_flags & 1) !== 0;
-    }
-
-    /**
-     * Gets the image link of the emote.
-     * @param {number} size - The size of the image.
-     * @returns {string}
-     */
-    toLink(size = 0) {
-        size = this.sizes[size];
-        if (this.animated) return Constants.FFZ.CDNAnimated(this.id, size); // eslint-disable-line new-cap
-        return Constants.FFZ.CDN(this.id, size); // eslint-disable-line new-cap
-    }
-}
-
-module.exports = FFZEmote;
+const Emote = require('./Emote');
+const Constants = require('../util/Constants');
+
+/** @extends Emote */
+class FFZEmote extends Emote {
+    /**
+     * An FFZ 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 = 'ffz';
+    }
+
+    /**
+     * 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 = 'owner' in data ? data.owner.name : null;
+
+        /**
+         * Available image sizes.
+         * @type {string[]}
+         */
+        this.sizes = 'animated' in data ? Object.keys(data.animated) : Object.keys(data.urls);
+
+        /**
+         * If emote is animated.
+         * @type {boolean}
+         */
+        this.animated = 'animated' in data;
+
+        /**
+         * The image type of the emote.
+         * @type {string}
+         */
+        this.imageType = 'animated' in data ? 'webp' : 'png';
+
+        /**
+         * If the emote is a modifier and should be hidden.
+         * @type {boolean}
+         */
+        this.modifier = data.modifier && (data.modifier_flags & 1) !== 0;
+    }
+
+    /**
+     * Gets the image link of the emote.
+     * @param {number} size - The size of the image.
+     * @returns {string}
+     */
+    toLink(size = 0) {
+        size = this.sizes[size];
+        if (this.animated) return Constants.FFZ.CDNAnimated(this.id, size); // eslint-disable-line new-cap
+        return Constants.FFZ.CDN(this.id, size); // eslint-disable-line new-cap
+    }
+
+    /**
+     * Override for `toObject`.
+     * Will result in an Object representation of a FFZEmote
+     * @returns {Object}
+     */
+    toObject() {
+        return Object.assign({}, super.toObject(), {
+            animated: this.animated,
+            sizes: this.sizes,
+            ownerName: this.ownerName,
+            type: this.type,
+            modifier: this.modifier
+        });
+    }
+
+    /**
+     * Converts an emote Object into a FFZEmote
+     * @param {Object} [emoteObject] - Object representation of this emote
+     * @param {Channel} [channel=null] - Channel this emote belongs to.
+     * @returns {FFZEmote}
+     */
+    static fromObject(emoteObject, channel = null) {
+        // Need to convert sizes array to object, e.g. [1, 2, 4] -> { 1: '1', 2: '2', 4: '4' }
+        const sizes_obj = emoteObject.sizes.reduce((acc, curr) => {
+            acc[curr] = curr;
+            return acc;
+        }, {});
+        return new FFZEmote(channel, emoteObject.id,
+            {
+                code: emoteObject.code,
+                name: emoteObject.code,
+                urls: sizes_obj,
+                ...emoteObject.animated ? { animated: sizes_obj } : {},
+                owner: { name: emoteObject.ownerName },
+                modifier: emoteObject.modifier,
+                modifier_flags: emoteObject.modifier
+            });
+    }
+}
+
+module.exports = FFZEmote;

package/src/struct/SevenTVEmote.js

@@ -1,69 +1,106 @@
-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);
-
-        /**
-         * If emote is animated.
-         * @type {boolean}
-         */
-        this.animated = data.animated;
-
-        /**
-         * 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;
+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 = 'owner' in data ? data.owner.display_name : null;
+
+        /**
+         * Available image sizes.
+         * @type {string[]}
+         */
+        this.sizes = data.host.files
+            .filter(el => el.format === this.channel.format.toUpperCase())
+            .map(el => el.name);
+
+        /**
+         * If emote is animated.
+         * @type {boolean}
+         */
+        this.animated = data.animated;
+
+        /**
+         * 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
+    }
+
+    /**
+     * Override for `toObject`.
+     * Will result in an Object representation of a SevenTVEmote
+     * @returns {Object}
+     */
+    toObject() {
+        return Object.assign({}, super.toObject(), {
+            animated: this.animated,
+            sizes: this.sizes,
+            ownerName: this.ownerName,
+            type: this.type,
+            imageType: this.imageType
+        });
+    }
+
+    /**
+     * Converts an emote Object into a SevenTVEmote
+     * @param {Object} [emoteObject] - Object representation of this emote
+     * @param {Channel} [channel] - Channel this emote belongs to.
+     * @returns {SevenTVEmote}
+     */
+    static fromObject(emoteObject, channel) {
+        const sizes = emoteObject.sizes.map(size => { return { format: channel.format.toUpperCase(), name: size }; });
+        return new SevenTVEmote(channel, emoteObject.id,
+            {
+                code: emoteObject.code,
+                name: emoteObject.code,
+                animated: emoteObject.animated,
+                owner: {
+                    display_name: emoteObject.ownerName
+                },
+                host: {
+                    files: sizes
+                }
+            });
+    }
+}
+
+module.exports = SevenTVEmote;