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

package/package.json

@@ -1,75 +1,102 @@
 {
-    "name": "@mkody/twitch-emoticons",
-    "version": "2.9.6",
-    "description": "Gets Twitch, BTTV, FFZ and 7TV emotes as well as parsing text to emotes!",
-    "main": "src/index.js",
-    "typings": "typings/index.d.ts",
-    "keywords": [
-        "7tv",
-        "bettertwitchtv",
-        "bttv",
-        "emotes",
-        "emoticons",
-        "ffz",
-        "frankerfacez",
-        "parse",
-        "seventv",
-        "twitch-api",
-        "twitch"
-    ],
-    "author": "MKody <gh@kdy.ch> (André Fernandes)",
-    "contributors": [
-        "1Computer",
-        "Killusions",
-        "MKody",
-        "Tzahi12345"
-    ],
-    "license": "MIT",
-    "dependencies": {
-        "@twurple/api": "^7.4.0",
-        "@twurple/auth": "^7.4.0",
-        "axios": "^1.13.5"
-    },
-    "devDependencies": {
-        "@eslint/js": "^9.39.3",
-        "@jest/globals": "^30.2.0",
-        "@microsoft/eslint-formatter-sarif": "^3.1.0",
-        "docdash": "^2.0.2",
-        "esbuild": "^0.27.3",
-        "eslint": "^9.39.3",
-        "eslint-plugin-jsdoc": "^61.7.1",
-        "globals": "^16.5.0",
-        "jest": "^30.2.0",
-        "jsdoc": "^4.0.5"
-    },
-    "scripts": {
-        "all": "pnpm run lint && pnpm run test && pnpm run build && pnpm run docs",
-        "build": "esbuild ./src/index.js --bundle --minify --keep-names --sourcemap --format=esm --outfile=./dist/TwitchEmoticons.min.js",
-        "docs": "jsdoc --configure .jsdoc.json",
-        "lint": "eslint ./src ./test",
-        "test": "jest"
-    },
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/mkody/twitch-emoticons.git"
-    },
-    "bugs": {
-        "url": "https://github.com/mkody/twitch-emoticons/issues"
-    },
-    "homepage": "https://github.com/mkody/twitch-emoticons",
-    "directories": {
-        "doc": "docs",
-        "test": "test"
-    },
-    "engines": {
-        "node": ">=18.0.0",
-        "pnpm": ">=9"
-    },
-    "packageManager": "pnpm@10.24.0",
-    "pnpm": {
-        "onlyBuiltDependencies": [
-            "esbuild",
-            "unrs-resolver"
-        ]
+  "name": "@mkody/twitch-emoticons",
+  "version": "3.0.0-beta.2",
+  "description": "Gets Twitch, BTTV, FFZ and 7TV emotes as well as parsing text to emotes!",
+  "type": "module",
+  "license": "MIT",
+  "author": "MKody <gh@kdy.ch> (André Fernandes)",
+  "contributors": [
+    "1Computer",
+    "Killusions",
+    "MKody",
+    "Tzahi12345"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mkody/twitch-emoticons.git"
+  },
+  "bugs": {
+    "url": "https://github.com/mkody/twitch-emoticons/issues"
+  },
+  "homepage": "https://github.com/mkody/twitch-emoticons",
+  "keywords": [
+    "7tv",
+    "bettertwitchtv",
+    "bttv",
+    "emotes",
+    "emoticons",
+    "ffz",
+    "frankerfacez",
+    "parse",
+    "seventv",
+    "twitch-api",
+    "twitch"
+  ],
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./typings/index.d.ts",
+        "default": "./src/index.js"
+      },
+      "require": {
+        "types": "./typings/index.d.cts",
+        "default": "./dist/TwitchEmoticons.cjs"
+      }
     }
+  },
+  "types": "./typings/index.d.ts",
+  "main": "./dist/TwitchEmoticons.cjs",
+  "jsdelivr": "./dist/TwitchEmoticons.min.js",
+  "unpkg": "./dist/TwitchEmoticons.min.js",
+  "dependencies": {
+    "@twurple/api": "^8.0.3",
+    "@twurple/auth": "^8.0.3"
+  },
+  "devDependencies": {
+    "@microsoft/eslint-formatter-sarif": "^3.1.0",
+    "@typescript-eslint/parser": "^8.56.1",
+    "cross-env": "^10.1.0",
+    "docdash": "^2.0.2",
+    "esbuild": "^0.27.3",
+    "eslint": "^9.39.3",
+    "eslint-plugin-jsdoc": "^62.7.1",
+    "jest": "^30.2.0",
+    "jsdoc": "^4.0.5",
+    "neostandard": "^0.13.0"
+  },
+  "scripts": {
+    "all": "pnpm run lint && pnpm run test && pnpm run esbuild && pnpm run build:docs",
+    "build:cjs": "esbuild src/index.js --bundle --platform=node --outfile=dist/TwitchEmoticons.cjs --format=cjs --packages=external",
+    "build:docs": "jsdoc --configure .jsdoc.json",
+    "build:esm": "esbuild src/index.js --bundle --minify --keep-names --sourcemap --format=esm --outfile=dist/TwitchEmoticons.esm.min.js",
+    "build:global": "esbuild src/index.js --bundle --minify --keep-names --sourcemap --format=iife --global-name=TwitchEmoticons --outfile=dist/TwitchEmoticons.min.js",
+    "esbuild": "pnpm run build:cjs && pnpm run build:esm && pnpm run build:global",
+    "lint": "eslint .",
+    "test": "cross-env NODE_OPTIONS=\"--experimental-vm-modules\" jest"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist/",
+    "src/",
+    "typings/",
+    "SECURITY.md"
+  ],
+  "directories": {
+    "doc": "docs",
+    "test": "test"
+  },
+  "engines": {
+    "node": ">=20.18.1",
+    "pnpm": ">=10"
+  },
+  "packageManager": "pnpm@10.30.3",
+  "pnpm": {
+    "onlyBuiltDependencies": [
+      "esbuild",
+      "unrs-resolver"
+    ]
+  }
 }

package/src/index.js

@@ -1,12 +1,38 @@
-module.exports = {
-    BTTVEmote: require('./struct/BTTVEmote'),
-    Channel: require('./struct/Channel'),
-    Collection: require('./util/Collection'),
-    Constants: require('./util/Constants'),
-    Emote: require('./struct/Emote'),
-    EmoteFetcher: require('./struct/EmoteFetcher'),
-    EmoteParser: require('./struct/EmoteParser'),
-    FFZEmote: require('./struct/FFZEmote'),
-    SevenTVEmote: require('./struct/SevenTVEmote'),
-    TwitchEmote: require('./struct/TwitchEmote')
-};
+/// <reference types="../typings/index.d.ts" />
+import BTTVEmote from './struct/BTTVEmote.js'
+import Channel from './struct/Channel.js'
+import Collection from './util/Collection.js'
+import Constants from './util/Constants.js'
+import Emote from './struct/Emote.js'
+import EmoteFetcher from './struct/EmoteFetcher.js'
+import EmoteParser from './struct/EmoteParser.js'
+import FFZEmote from './struct/FFZEmote.js'
+import SevenTVEmote from './struct/SevenTVEmote.js'
+import TwitchEmote from './struct/TwitchEmote.js'
+
+export {
+  BTTVEmote,
+  Channel,
+  Collection,
+  Constants,
+  Emote,
+  EmoteFetcher,
+  EmoteParser,
+  FFZEmote,
+  SevenTVEmote,
+  TwitchEmote,
+}
+
+// Default export for compatibility
+export default {
+  BTTVEmote,
+  Channel,
+  Collection,
+  Constants,
+  Emote,
+  EmoteFetcher,
+  EmoteParser,
+  FFZEmote,
+  SevenTVEmote,
+  TwitchEmote,
+}

package/src/struct/BTTVEmote.js

@@ -1,90 +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 BTTVEmote extends Emote {
-    /**
-     * A BTTV 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 = 'bttv';
-    }
-
-    /**
-     * 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);
-
-        /**
-         * The name of the emote creator's channel.
-         * Will be null for global or channel emotes.
-         * @type {?string}
-         */
-        this.ownerName = 'user' in data ? data.user.name : null;
+  /**
+   * A BTTV 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 = 'bttv'
+  }
 
-        /**
-         * If emote is animated.
-         * @type {boolean}
-         */
-        this.animated = data.animated;
-
-        /**
-         * The image type of the emote.
-         * @type {string}
-         */
-        this.imageType = 'webp';
-    }
+  _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 name of the emote creator's channel.
+     * Will be null for global or channel emotes.
+     * @type {?string}
      */
-    toLink(size = 0) {
-        return Constants.BTTV.CDN(this.id, size); // eslint-disable-line new-cap
-    }
+    this.ownerName = 'user' in data ? data.user.name : null
 
     /**
-     * Override for `toObject`.
-     * Will result in an Object representation of a BTTVEmote
-     * @returns {object}
+     * If emote is animated.
+     * @type {boolean}
      */
-    toObject() {
-        return Object.assign({}, super.toObject(), {
-            animated: this.animated,
-            ownerName: this.ownerName,
-            type: this.type
-        });
-    }
+    this.animated = data.animated
 
     /**
-     * Converts an emote Object into a BTTVEmote
-     * @param {object} [emoteObject] - Object representation of this emote
-     * @param {Channel} [channel=null] - Channel this emote belongs to.
-     * @returns {BTTVEmote}
+     * The image type of the emote.
+     * @type {string}
      */
-    static fromObject(emoteObject, channel = null) {
-        return new BTTVEmote(channel, emoteObject.id,
-            {
-                code: emoteObject.code,
-                animated: emoteObject.animated,
-                user: {
-                    name: emoteObject.ownerName
-                }
-            });
+    this.imageType = 'webp'
+  }
+
+  /**
+   * 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 || {}
+
+    return Constants.BTTV.CDN(this.id, size, forceStatic)
+  }
+
+  /**
+   * Override for `toObject`.
+   * Will result in an Object representation of a BTTVEmote
+   * @returns {object} - Object representation of the BTTVEmote.
+   */
+  toObject () {
+    return {
+      ...super.toObject(),
+      animated: this.animated,
+      ownerName: this.ownerName,
+      type: this.type,
     }
+  }
+
+  /**
+   * Converts an emote Object into a BTTVEmote
+   * @param {object} [emoteObject] - Object representation of this emote
+   * @param {Channel} [channel] - Channel this emote belongs to.
+   * @returns {BTTVEmote} - A BTTVEmote instance.
+   */
+  static fromObject (emoteObject, channel) {
+    return new BTTVEmote(channel, emoteObject.id,
+      {
+        code: emoteObject.code,
+        animated: emoteObject.animated,
+        user: {
+          name: emoteObject.ownerName,
+        },
+      })
+  }
 }
 
-module.exports = BTTVEmote;
+export default BTTVEmote

package/src/struct/Channel.js

@@ -1,60 +1,60 @@
-const Collection = require('../util/Collection');
+import Collection from '../util/Collection.js'
 
 class Channel {
+  /**
+   * A Twitch channel.
+   * @param {EmoteFetcher} fetcher - The emote fetcher.
+   * @param {number} id - ID of the channel.
+   */
+  constructor (fetcher, id) {
     /**
-     * A Twitch channel.
-     * @param {EmoteFetcher} fetcher - The emote fetcher.
-     * @param {int} id - ID of the channel.
+     * The emote fetcher.
+     * @type {EmoteFetcher}
      */
-    constructor(fetcher, id) {
-        /**
-         * The emote fetcher.
-         * @type {EmoteFetcher}
-         */
-        this.fetcher = fetcher;
-
-        /**
-         * The ID of this channel.
-         * For the global channel, the ID will be null.
-         * @type {?int}
-         */
-        this.channel_id = id;
-
-        /**
-         * Cached emotes belonging to this channel.
-         * @type {Collection<string, Emote>}
-         */
-        this.emotes = new Collection();
-    }
-
-    /* There are tests that those are returning Collections, but c8 doesn't get it. */
-    /* c8 ignore start */
+    this.fetcher = fetcher
 
     /**
-     * Fetches the BTTV emotes for this channel.
-     * @returns {Promise<Collection<string, BTTVEmote>>}
+     * The ID of this channel.
+     * For the global channel, the ID will be null.
+     * @type {?number}
      */
-    fetchBTTVEmotes() {
-        return this.fetcher.fetchBTTVEmotes(this.id);
-    }
+    this.channel_id = id || null
 
     /**
-     * Fetches the FFZ emotes for this channel.
-     * @returns {Promise<Collection<string, FFZEmote>>}
+     * Cached emotes belonging to this channel.
+     * @type {Collection<string, Emote>}
      */
-    fetchFFZEmotes() {
-        return this.fetcher.fetchFFZEmotes(this.id);
-    }
-
-    /**
-     * Fetches the 7TV emotes for this channel.
-     * @returns {Promise<Collection<string, SevenTVEmote>>}
-     */
-    fetchSevenTVEmotes() {
-        return this.fetcher.fetchSevenTVEmotes(this.id);
-    }
-
-    /* c8 ignore end */
+    this.emotes = new Collection()
+  }
+
+  /* There are tests that those are returning Collections, but c8 doesn't get it. */
+  /* c8 ignore start */
+
+  /**
+   * Fetches the BTTV emotes for this channel.
+   * @returns {Promise<Collection<string, BTTVEmote>>} - A promise that resolves to a collection of BTTVEmotes.
+   */
+  fetchBTTVEmotes () {
+    return this.fetcher.fetchBTTVEmotes(this.id)
+  }
+
+  /**
+   * Fetches the FFZ emotes for this channel.
+   * @returns {Promise<Collection<string, FFZEmote>>} - A promise that resolves to a collection of FFZEmotes.
+   */
+  fetchFFZEmotes () {
+    return this.fetcher.fetchFFZEmotes(this.id)
+  }
+
+  /**
+   * Fetches the 7TV emotes for this channel.
+   * @returns {Promise<Collection<string, SevenTVEmote>>} - A promise that resolves to a collection of SevenTVEmotes.
+   */
+  fetchSevenTVEmotes () {
+    return this.fetcher.fetchSevenTVEmotes(this.id)
+  }
+
+  /* c8 ignore end */
 }
 
-module.exports = Channel;
+export default Channel

package/src/struct/Emote.js

@@ -1,87 +1,87 @@
 class Emote {
+  /**
+   * Base class for emotes.
+   * This constructor is not to be used.
+   * @param {Channel} channel - Channel this emote belongs to.
+   * @param {string} id - ID of the emote.
+   * @param {data} data - The raw emote data.
+   * @throws {Error} When trying to use the base Emote class directly.
+   */
+  constructor (channel, id, data) {
+    if (new.target.name === Emote.name) {
+      throw new Error('Base Emote class cannot be used')
+    }
+
     /**
-     * Base class for emotes.
-     * This constructor is not to be used.
-     * @param {Channel} channel - Channel this emote belongs to.
-     * @param {string} id - ID of the emote.
-     * @param {data} data - The raw emote data.
-     * @throws {Error} When trying to use the base Emote class directly.
+     * The emote fetcher.
+     * @type {EmoteFetcher}
      */
-    constructor(channel, id, data) {
-        if (new.target.name === Emote.name) {
-            throw new Error('Base Emote class cannot be used');
-        }
-
-        /**
-         * The emote fetcher.
-         * @type {EmoteFetcher}
-         */
-        this.fetcher = channel.fetcher;
-
-        /**
-         * The channel this emote belongs to.
-         * Only accurate and constant on Twitch emotes.
-         * For other types of emotes, use the `owner` or `ownerName` property.
-         * @type {Channel}
-         */
-        this.channel = channel;
-
-        /**
-         * The ID of this emote.
-         * @type {string}
-         */
-        this.id = id;
+    this.fetcher = channel.fetcher
 
-        /**
-         * The type of this emote.
-         * Either `twitch`, `bttv`, `ffz`, or '7tv'.
-         * @type {string}
-         */
-        this.type = null;
-
-        this._setup(data);
-    }
-
-    _setup(data) {
-        /**
-         * The code or name of the emote.
-         * @type {string}
-         */
-        this.code = data.code;
-    }
+    /**
+     * The channel this emote belongs to.
+     * Only accurate and constant on Twitch emotes.
+     * For other types of emotes, use the `owner` or `ownerName` property.
+     * @type {Channel}
+     */
+    this.channel = channel
 
     /**
-     * Gets the image link of the emote.
-     * @param {number} size - The size of the image.
-     * @returns {string}
+     * The ID of this emote.
+     * @type {string}
      */
-    /* c8 ignore next 3*/
-    toLink() {
-        return null;
-    }
+    this.id = id
 
     /**
-     * Override for `toString`.
-     * Will give the emote's name.
-     * @returns {string}
+     * The type of this emote.
+     * Either `twitch`, `bttv`, `ffz`, or '7tv'.
+     * @type {string | null}
      */
-    /* c8 ignore next 3*/
-    toString() {
-        return this.code;
-    }
+    this.type = null
 
+    this._setup(data)
+  }
+
+  _setup (data) {
     /**
-     * Override for `toObject`.
-     * Will result in an Object representation of an Emote
-     * @returns {object}
+     * The code or name of the emote.
+     * @type {string}
      */
-    toObject() {
-        return {
-            code: this.code,
-            id: this.id,
-            channel_id: this.channel.channel_id
-        };
+    this.code = data.code
+  }
+
+  /**
+   * Gets the image link of the emote.
+   * @param {number} size - The size of the image.
+   * @returns {string} - The URL to the emote.
+   */
+  /* c8 ignore next 3 */
+  toLink () {
+    return null
+  }
+
+  /**
+   * Override for `toString`.
+   * Will give the emote's name.
+   * @returns {string} - The emote code.
+   */
+  /* c8 ignore next 3 */
+  toString () {
+    return this.code
+  }
+
+  /**
+   * Override for `toObject`.
+   * Will result in an Object representation of an Emote
+   * @returns {object} - Object representation of the Emote.
+   */
+  toObject () {
+    return {
+      code: this.code,
+      id: this.id,
+      channel_id: this.channel.channel_id,
     }
+  }
 }
 
-module.exports = Emote;
+export default Emote