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

package/src/struct/TwitchEmote.js

@@ -1,87 +1,88 @@
-const Emote = require('./Emote');
-const Constants = require('../util/Constants');
+import Emote from './Emote.js'
+import Constants from '../util/Constants.js'
 
 /** @augments 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;
+  /**
+   * 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'
+  }
 
-        /**
-         * 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';
-    }
+  _setup (data) {
+    super._setup(data)
 
     /**
-     * Gets the image link of the emote.
-     * @param {number} size - The size of the image, 0, 1, or 2.
-     * @returns {string}
+     * The set ID of the emote.
+     * @type {?string}
      */
-    toLink(size = 0) {
-        return Constants.Twitch.CDN(this.id, size); // eslint-disable-line new-cap
-    }
+    this.set = data.emoticon_set
 
     /**
-     * Override for `toObject`.
-     * Will result in an Object representation of a TwitchEmote
-     * @returns {object}
+     * If emote is animated.
+     * @type {boolean}
      */
-    toObject() {
-        return Object.assign({}, super.toObject(), {
-            animated: this.animated,
-            set: this.set,
-            type: this.type
-        });
-    }
+    this.animated = 'animated' in data.formats
 
     /**
-     * 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}
+     * The image type of the emote.
+     * @type {string}
      */
-    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 } : {}
-            });
+    this.imageType = 'animated' in data.formats ? 'gif' : 'png'
+  }
+
+  /**
+   * 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`.
+   * @param {'dark' | 'light'} [options.themeMode] - Only for Twitch: the preferred theme mode. Defaults to the fetcher's twitchThemeMode or `dark`.
+   * @returns {string} - The URL to the emote.
+   */
+  toLink (options) {
+    const {
+      size = 0,
+      forceStatic = this.fetcher.forceStatic || false,
+      themeMode = this.fetcher.twitchThemeMode || 'dark',
+    } = options || {}
+
+    return Constants.Twitch.CDN(this.id, size, forceStatic, themeMode)
+  }
+
+  /**
+   * Override for `toObject`.
+   * Will result in an Object representation of a TwitchEmote
+   * @returns {object} - Object representation of the TwitchEmote.
+   */
+  toObject () {
+    return {
+      ...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] - Channel this emote belongs to.
+   * @returns {TwitchEmote} - A TwitchEmote instance.
+   */
+  static fromObject (emoteObject, channel) {
+    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;
+export default TwitchEmote

package/src/util/Collection.js

@@ -4,76 +4,90 @@
  * @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;
-            }
+  /**
+   * 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|null} - The found item or null if none found.
+   */
+  find (propOrFunc, value) {
+    if (typeof propOrFunc === 'string') {
+      if (value === undefined) {
+        return null
+      }
 
-            return null;
+      for (const item of this.values()) {
+        if (item[propOrFunc] === value) {
+          return item
         }
+      }
 
-        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;
+    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);
+    return null
+  }
 
-        const results = new this.constructor();
+  /**
+   * Filters cache by function.
+   * Same as `Array#filter`.
+   * @param {Function} func - Function to test.
+   * @param {any} [thisArg] - The context for the function.
+   * @returns {Collection} - A new collection with the filtered items.
+   */
+  filter (func, thisArg) {
+    if (thisArg) {
+      func = func.bind(thisArg)
+    }
 
-        let i = 0;
-        for (const [key, item] of this) {
-            if (func(item, i, this)) results.set(key, item);
-            i++;
-        }
+    const results = new this.constructor()
 
-        return results;
+    let i = 0
+    for (const [key, item] of this) {
+      if (func(item, i, this)) {
+        results.set(key, item)
+      }
+      i++
     }
 
-    /**
-     * 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);
+    return results
+  }
 
-        const array = new Array(this.size);
-        let i = 0;
-        for (const item of this.values()) {
-            array[i] = func(item, i, this);
-            i++;
-        }
+  /**
+   * Maps cache by function.
+   * Same as `Array#map`.
+   * @param {Function} func - Function to use.
+   * @param {any} [thisArg] - The context for the function.
+   * @returns {any[]} - An array with the mapped items.
+   */
+  map (func, thisArg) {
+    if (thisArg) {
+      func = func.bind(thisArg)
+    }
+
+    const array = new Array(this.size)
 
-        return array;
+    let i = 0
+    for (const item of this.values()) {
+      array[i] = func(item, i, this)
+      i++
     }
+
+    return array
+  }
 }
 
-module.exports = Collection;
+export default 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`
+export default {
+  Twitch: {
+    CDN: (id, size = 0, forceStatic = false, theme = 'dark') => `https://static-cdn.jtvnw.net/emoticons/v2/${id}/${forceStatic ? 'static' : 'default'}/${theme}/${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 = 0, forceStatic = false) => `https://cdn.betterttv.net/emote/${id}/${size + 1}x.${forceStatic ? 'png' : 'webp'}`,
+  },
+  SevenTV: {
+    Global: 'https://7tv.io/v3/emote-sets/global',
+    Channel: (id) => `https://7tv.io/v3/users/twitch/${id}`,
+    CDN: (id, format, size = 1, forceStatic = false) => `https://cdn.7tv.app/emote/${id}/${size}x${forceStatic ? '_static' : ''}.${format}`,
+  },
+  FFZ: {
+    sets: {
+      Global: 3,
+      Modifiers: 1532818,
     },
-    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}'
-    }
-};
+    Set: (id) => `https://api.frankerfacez.com/v1/set/${id}`,
+    Channel: (id) => `https://api.frankerfacez.com/v1/room/id/${id}`,
+    CDN: (id, size = 1) => `https://cdn.frankerfacez.com/emote/${id}/${size}`,
+    CDNAnimated: (id, size = 1) => `https://cdn.frankerfacez.com/emote/${id}/animated/${size}.webp`,
+  },
+  Templates: {
+    html: '<img alt="{name}" title="{name}" class="twitch-emote" src="{link}">',
+    markdown: '![{name}]({link} "{name}")',
+    bbcode: '[img]{link}[/img]',
+    plain: '{link}',
+  },
+}

package/typings/index.d.cts

@@ -0,0 +1,254 @@
+declare class Channel {
+  public constructor (
+    fetcher: EmoteFetcher,
+    id: number
+  )
+
+  public fetcher: EmoteFetcher
+  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>>
+}
+
+declare abstract class Emote {
+  public constructor (
+    channel: Channel,
+    id: string,
+    data: object
+  )
+
+  public fetcher: EmoteFetcher
+  public channel: Channel
+  public id: string
+  public type: 'twitch' | 'bttv' | 'ffz' | '7tv' | null
+  public code: string
+}
+
+declare class EmoteFetcher {
+  public constructor (
+    options?: {
+      twitchAppID?: string,
+      twitchAppSecret?: string,
+      apiClient?: object,
+      forceStatic?: boolean,
+      twitchThemeMode?: 'dark' | 'light'
+    }
+  )
+
+  public emotes: Collection<string, Emote>
+  public channels: Collection<string, Channel>
+  public forceStatic: boolean
+  public twitchThemeMode: 'dark' | 'light'
+
+  public fetchTwitchEmotes (
+    id?: number
+  ): Promise<Collection<string, TwitchEmote>>
+
+  public fetchBTTVEmotes (
+    id?: number
+  ): Promise<Collection<string, BTTVEmote>>
+
+  public fetchFFZEmotes (
+    id?: number
+  ): Promise<Collection<string, FFZEmote>>
+
+  public fetchSevenTVEmotes (
+    id?: number,
+    options?: {
+      format?: 'webp' | 'avif'
+    }
+  ): Promise<Collection<string, SevenTVEmote>>
+
+  public fromObject (
+    emotesArray: EmoteObject[]
+  ): Emote[]
+}
+
+declare class EmoteParser {
+  public constructor (
+    fetcher: EmoteFetcher,
+    options?: {
+      template?: string,
+      type?: 'html' | 'markdown' | 'bbcode' | 'plain',
+      match?: RegExp
+    }
+  )
+
+  public parse (
+    text: string,
+    options?: {
+      size?: number,
+      forceStatic?: boolean,
+      themeMode?: 'dark' | 'light'
+    }
+  ): string
+}
+
+declare class TwitchEmote extends Emote {
+  public constructor (
+    channel: Channel,
+    id: string,
+    data: object
+  )
+
+  public set?: string;
+  public animated: boolean
+  public imageType: 'png' | 'gif'
+  public readonly owner: Channel
+
+  public toLink (
+    options?: {
+      size: number,
+      forceStatic?: boolean,
+      themeMode?: 'dark' | 'light'
+    }
+  ): string
+
+  public toObject (): EmoteObject
+}
+
+declare class BTTVEmote extends Emote {
+  public constructor (
+    channel: Channel,
+    id: string,
+    data: any
+  )
+
+  public ownerName: string | null
+  public animated: boolean
+  public imageType: 'webp'
+  public readonly owner?: Channel
+
+  public toLink (
+    options?: {
+      size: number,
+      forceStatic?: boolean
+    }
+  ): string
+
+  public toObject (): EmoteObject
+}
+
+declare class FFZEmote extends Emote {
+  public constructor (
+    channel: Channel,
+    id: string,
+    data: object
+  )
+
+  public ownerName: string | null
+  public sizes: string[]
+  public animated: boolean
+  public imageType: 'png' | 'webp'
+  public modifier: boolean
+  public readonly owner?: Channel
+
+  public toLink (
+    options?: {
+      size: number,
+      forceStatic?: boolean
+    }
+  ): string
+
+  public toObject (): EmoteObject
+}
+
+declare class SevenTVEmote extends Emote {
+  public constructor (
+    channel: Channel,
+    id: string,
+    data: object
+  )
+
+  public ownerName: string | null
+  public sizes: string[]
+  public animated: boolean
+  public imageType: 'webp' | 'avif'
+  public readonly owner?: Channel
+
+  public toLink (
+    options?: {
+      size: number,
+      forceStatic?: boolean
+    }
+  ): string
+
+  public toObject (): EmoteObject
+}
+
+interface EmoteObject {
+  code: string,
+  id: string,
+  channel_id: string | null,
+  type: 'twitch' | 'bttv' | 'ffz' | '7tv' | null,
+  animated?: boolean,
+  ownerName?: string,
+  sizes?: string[],
+  set?: string,
+  imageType?: string
+}
+
+declare const Constants: {
+  Twitch: {
+    CDN: (id: string, size?: number, forceStatic?: boolean, theme?: 'dark' | 'light') => string;
+  };
+  BTTV: {
+    Global: string;
+    Channel: (id: string) => string;
+    CDN: (id: string, size?: number, forceStatic?: boolean) => string;
+  };
+  SevenTV: {
+    Global: string;
+    Channel: (id: string) => string;
+    CDN: (id: string, format: string, size?: number, forceStatic?: boolean) => string;
+  };
+  FFZ: {
+    sets: {
+      Global: number;
+      Modifiers: number;
+    };
+    Set: (id: string) => string;
+    Channel: (id: string) => string;
+    CDN: (id: string, size?: number) => string;
+    CDNAnimated: (id: string, size?: number) => string;
+  };
+  Templates: {
+    html: string;
+    markdown: string;
+    bbcode: string;
+    plain: string;
+  };
+}
+
+declare class Collection<K, V> extends Map<K, V> {
+  public find (
+    propOrFunc: string | ((item: V, index: number, coll: this) => boolean),
+    value?: any
+  ): V
+
+  public filter (
+    func: (item: V, index: number, coll: this) => boolean
+  ): Collection<K, V>
+
+  public map (
+    func: (item: V, index: number, coll: this) => any
+  ): Array<any>
+}
+
+export {
+  Channel,
+  Emote,
+  EmoteFetcher,
+  EmoteParser,
+  TwitchEmote,
+  BTTVEmote,
+  FFZEmote,
+  SevenTVEmote,
+  Collection,
+  Constants,
+}