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

package/src/struct/EmoteParser.js

@@ -1,100 +1,111 @@
-const Constants = require('../util/Constants');
+import Constants from '../util/Constants.js'
 
 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 index of the image.
+   * - `{creator}` The channel/owner name of the emote.
+   * @param {'html' | 'markdown' | 'bbcode' | 'plain'} [options.type='html'] - The type of the parser.
+   * Can be one of `html`, `markdown`, `bbcode`, or `plain`.
+   * If the `template` option is provided, this is ignored.
+   * @param {RegExp} [options.match=/(\w+)/g] - The regular expression that matches an emote.
+   * Must be a global regex, with one capture group for the emote code.
+   */
+  constructor (fetcher, options = {}) {
     /**
-     * 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.
+     * The emote fetcher being used.
+     * @type {EmoteFetcher}
      */
-    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);
-    }
+    this.fetcher = fetcher
 
     /**
-     * Validates the parser options.
-     * @private
-     * @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] - 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] - The regular expression that matches an emote.
-     * Must be a global regex, with one capture group for the emote code.
-     * @throws {TypeError} When template is not a string.
-     * @throws {TypeError} When type is not one of the supported types.
-     * @throws {TypeError} When match is not a global RegExp.
+     * The parser options.
+     * @type {object}
      */
-    _validateOptions(options) {
-        if (options.template && typeof options.template !== 'string') {
-            throw new TypeError('Template must be a string');
-        }
+    this.options = {
+      template: '',
+      type: 'html',
+      match: /(\w+)/g,
+      ...options,
+    }
 
-        if (!['markdown', 'html', 'bbcode', 'plain'].includes(options.type)) {
-            throw new TypeError('Parse type must be one of `markdown`, `html`, `bbcode`, or `plain`');
-        }
+    this._validateOptions(this.options)
+  }
 
-        if (!(options.match instanceof RegExp) || !options.match.global) {
-            throw new TypeError('Match must be a global RegExp.');
-        }
+  /**
+   * Validates the parser options.
+   * @private
+   * @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 {'html' | 'markdown' | 'bbcode' | 'plain'} [options.type] - The type of the parser.
+   * Can be one of `html`, `markdown`, `bbcode`, or `plain`.
+   * If the `template` option is provided, this is ignored.
+   * @param {RegExp} [options.match] - The regular expression that matches an emote.
+   * Must be a global regex, with one capture group for the emote code.
+   * @throws {TypeError} When template is not a string.
+   * @throws {TypeError} When type is not one of the supported types.
+   * @throws {TypeError} When match is not a global RegExp.
+   */
+  _validateOptions (options) {
+    if (options.template && typeof options.template !== 'string') {
+      throw new TypeError('Template must be a string')
     }
 
-    /**
-     * 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 '';
+    if (!['html', 'markdown', 'bbcode', 'plain'].includes(options.type)) {
+      throw new TypeError('Parse type must be one of `html`, `markdown`, `bbcode`, or `plain`')
+    }
 
-            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');
+    if (!(options.match instanceof RegExp) || !options.match.global) {
+      throw new TypeError('Match must be a global RegExp.')
+    }
+  }
 
-            return res;
-        });
+  /**
+   * Parses text.
+   * @param {string} text - Text to parse.
+   * @param {object} [options] - Parameters for parsing.
+   * @param {number} [options.size] - Size (scale) for emotes.
+   * @param {boolean} [options.forceStatic] - Whether to force the emote to be static (non-animated). Defaults to the fetcher's forceStatic or `false`.
+   * @param {'dark' | 'light'} [options.themeMode] - Only for Twitch: the preferred theme mode. Defaults to the fetcher's twitchThemeMode or `dark`.
+   * @returns {string} - The parsed text.
+   */
+  parse (text, options) {
+    // @NOTE(kody): Not setting defaults here, they'll be handled by each emote's toLink method.
+    const {
+      size,
+      forceStatic,
+      themeMode,
+    } = options || {}
 
-        return parsed;
-    }
+    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, forceStatic, themeMode })
+      const res = template
+        .replaceAll('{link}', link)
+        .replaceAll('{name}', emote.code)
+        .replaceAll('{size}', size)
+        .replaceAll('{creator}', emote.ownerName || 'global')
+
+      return res
+    })
+
+    return parsed
+  }
 }
 
-module.exports = EmoteParser;
+export default EmoteParser

package/src/struct/EmoteTypeMapper.js

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

package/src/struct/FFZEmote.js

@@ -1,113 +1,111 @@
-const Emote = require('./Emote');
-const Constants = require('../util/Constants');
+import Emote from './Emote.js'
+import Constants from '../util/Constants.js'
 
 /** @augments 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'
+  }
+
+  _setup (data) {
+    super._setup(data)
+    this.code = data.name
+
     /**
-     * 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.
+     * The name of the emote creator's channel.
+     * @type {?string}
      */
-    constructor(channel, id, data) {
-        super(channel, id, data);
-        this.type = 'ffz';
-    }
+    this.ownerName = 'owner' in data ? data.owner.name : null
 
     /**
-     * The channel of this emote's creator.
-     * Not guaranteed to contain the emote, or be cached.
-     * @readonly
-     * @type {?Channel}
+     * Available image sizes.
+     * @type {string[]}
      */
-    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;
-    }
+    this.sizes = 'animated' in data ? Object.keys(data.animated) : Object.keys(data.urls)
 
     /**
-     * Gets the image link of the emote.
-     * @param {number} size - The size of the image.
-     * @returns {string}
+     * If emote is animated.
+     * @type {boolean}
      */
-    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
-    }
+    this.animated = 'animated' in data
 
     /**
-     * Override for `toObject`.
-     * Will result in an Object representation of a FFZEmote
-     * @returns {object}
+     * The image type of the emote.
+     * @type {string}
      */
-    toObject() {
-        return Object.assign({}, super.toObject(), {
-            animated: this.animated,
-            sizes: this.sizes,
-            ownerName: this.ownerName,
-            type: this.type,
-            modifier: this.modifier
-        });
-    }
+    this.imageType = 'animated' in data ? 'webp' : 'png'
 
     /**
-     * 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}
+     * If the emote is a modifier and should be hidden.
+     * @type {boolean}
      */
-    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
-            });
+    this.modifier = data.modifier && (data.modifier_flags & 1) !== 0
+  }
+
+  /**
+   * Gets the image link of the emote.
+   * @param {object} [options] - Options for the link.
+   * @param {number} [options.size=0] - Size (scale) for the emote.
+   * @param {boolean} [options.forceStatic] - Whether to force the emote to be static (non-animated). Defaults to the fetcher's forceStatic or `false`.
+   * @returns {string} - The URL to the emote.
+   */
+  toLink (options) {
+    const {
+      size = 0,
+      forceStatic = this.fetcher.forceStatic || false,
+    } = options || {}
+
+    const sizeKey = this.sizes[size]
+    if (this.animated && !forceStatic) return Constants.FFZ.CDNAnimated(this.id, sizeKey)
+    return Constants.FFZ.CDN(this.id, sizeKey)
+  }
+
+  /**
+   * Override for `toObject`.
+   * Will result in an Object representation of a FFZEmote
+   * @returns {object} - Object representation of the FFZEmote.
+   */
+  toObject () {
+    return {
+      ...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] - Channel this emote belongs to.
+   * @returns {FFZEmote} - A FFZEmote instance.
+   */
+  static fromObject (emoteObject, channel) {
+    // Need to convert sizes array to object, e.g. [1, 2, 4] -> { 1: '1', 2: '2', 4: '4' }
+    const sizesObj = emoteObject.sizes.reduce((acc, curr) => {
+      acc[curr] = curr
+      return acc
+    }, {})
+    return new FFZEmote(channel, emoteObject.id,
+      {
+        code: emoteObject.code,
+        name: emoteObject.code,
+        urls: sizesObj,
+        ...emoteObject.animated ? { animated: sizesObj } : {},
+        owner: { name: emoteObject.ownerName },
+        modifier: emoteObject.modifier,
+        modifier_flags: emoteObject.modifier,
+      })
+  }
 }
 
-module.exports = FFZEmote;
+export default FFZEmote

package/src/struct/SevenTVEmote.js

@@ -1,108 +1,106 @@
-const Emote = require('./Emote');
-const Constants = require('../util/Constants');
+import Emote from './Emote.js'
+import Constants from '../util/Constants.js'
 
 /** @augments 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';
-    }
+  /**
+   * 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'
+  }
+
+  _setup (data) {
+    super._setup(data)
+    this.code = data.name
 
     /**
-     * The channel of this emote's creator.
-     * Not guaranteed to contain the emote, or be cached.
-     * @readonly
-     * @type {?Channel}
+     * The name of the emote creator's channel.
+     * @type {?string}
      */
-    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 ? data.data.owner.display_name : null;
-
-        /**
-         * Available image sizes.
-         * @type {string[]}
-         */
-        this.sizes = data.data.host.files
-            .filter(el => el.format === this.channel.format.toUpperCase())
-            .map(el => el.name);
-
-        /**
-         * If emote is animated.
-         * @type {boolean}
-         */
-        this.animated = data.data.animated;
-
-        /**
-         * The image type of the emote.
-         * @type {string}
-         */
-        this.imageType = this.channel.format;
-    }
+    this.ownerName = 'owner' in data.data ? data.data.owner.display_name : null
 
     /**
-     * Gets the image link of the emote.
-     * @param {number} size - The size of the image.
-     * @returns {string}
+     * Available image sizes.
+     * @type {string[]}
      */
-    toLink(size = 0) {
-        size = this.sizes[size];
-        return Constants.SevenTV.CDN(this.id, size); // eslint-disable-line new-cap
-    }
+    this.sizes = data.data.host.files
+      .filter((el) => el.format === this.channel.format.toUpperCase())
+      .map((el) => el.name.replace(/x\.(\w+)/, ''))
 
     /**
-     * Override for `toObject`.
-     * Will result in an Object representation of a SevenTVEmote
-     * @returns {object}
+     * If emote is animated.
+     * @type {boolean}
      */
-    toObject() {
-        return Object.assign({}, super.toObject(), {
-            animated: this.animated,
-            sizes: this.sizes,
-            ownerName: this.ownerName,
-            type: this.type,
-            imageType: this.imageType
-        });
-    }
+    this.animated = data.data.animated
 
     /**
-     * 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}
+     * The image type of the emote.
+     * @type {string}
      */
-    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,
-                data: {
-                    animated: emoteObject.animated,
-                    owner: {
-                        display_name: emoteObject.ownerName
-                    },
-                    host: {
-                        files: sizes
-                    }
-                }
-            });
+    this.imageType = this.channel.format
+  }
+
+  /**
+   * Gets the image link of the emote.
+   * @param {object} [options] - Options for the link.
+   * @param {number} [options.size=0] - Size (scale) for the emote.
+   * @param {boolean} [options.forceStatic] - Whether to force the emote to be static (non-animated). Defaults to the fetcher's forceStatic or `false`.
+   * @returns {string} - The URL to the emote.
+   */
+  toLink (options) {
+    const {
+      size = 0,
+      forceStatic = this.fetcher.forceStatic || false,
+    } = options || {}
+
+    const sizeKey = this.sizes[size]
+    return Constants.SevenTV.CDN(this.id, this.imageType, sizeKey, forceStatic)
+  }
+
+  /**
+   * Override for `toObject`.
+   * Will result in an Object representation of a SevenTVEmote
+   * @returns {object} - Object representation of the SevenTVEmote.
+   */
+  toObject () {
+    return {
+      ...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} - A SevenTVEmote instance.
+   */
+  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,
+        data: {
+          animated: emoteObject.animated,
+          owner: {
+            display_name: emoteObject.ownerName,
+          },
+          host: {
+            files: sizes,
+          },
+        },
+      })
+  }
 }
 
-module.exports = SevenTVEmote;
+export default SevenTVEmote