@mkody/twitch-emoticons 2.9.2 → 2.9.4

package/docs/util_Collection.js.html

@@ -29,7 +29,7 @@
 <nav >
     
     
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BTTVEmote.html">BTTVEmote</a><ul class='methods'><li data-type='method'><a href="BTTVEmote.html#toLink">toLink</a></li><li data-type='method'><a href="BTTVEmote.html#toObject">toObject</a></li><li data-type='method'><a href="BTTVEmote.html#.fromObject">fromObject</a></li></ul></li><li><a href="Channel.html">Channel</a><ul class='methods'><li data-type='method'><a href="Channel.html#fetchBTTVEmotes">fetchBTTVEmotes</a></li><li data-type='method'><a href="Channel.html#fetchFFZEmotes">fetchFFZEmotes</a></li><li data-type='method'><a href="Channel.html#fetchSevenTVEmotes">fetchSevenTVEmotes</a></li></ul></li><li><a href="Collection.html">Collection</a><ul class='methods'><li data-type='method'><a href="Collection.html#filter">filter</a></li><li data-type='method'><a href="Collection.html#find">find</a></li><li data-type='method'><a href="Collection.html#map">map</a></li></ul></li><li><a href="Emote.html">Emote</a><ul class='methods'><li data-type='method'><a href="Emote.html#toObject">toObject</a></li></ul></li><li><a href="EmoteFetcher.html">EmoteFetcher</a><ul class='methods'><li data-type='method'><a href="EmoteFetcher.html#_cacheBTTVEmote">_cacheBTTVEmote</a></li><li data-type='method'><a href="EmoteFetcher.html#_cacheFFZEmote">_cacheFFZEmote</a></li><li data-type='method'><a href="EmoteFetcher.html#_cacheSevenTVEmote">_cacheSevenTVEmote</a></li><li data-type='method'><a href="EmoteFetcher.html#_cacheTwitchEmote">_cacheTwitchEmote</a></li><li data-type='method'><a href="EmoteFetcher.html#_getRawBTTVEmotes">_getRawBTTVEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#_getRawFFZEmoteSet">_getRawFFZEmoteSet</a></li><li data-type='method'><a href="EmoteFetcher.html#_getRawFFZEmotes">_getRawFFZEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#_getRawSevenTVEmotes">_getRawSevenTVEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#_getRawTwitchEmotes">_getRawTwitchEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#_setupChannel">_setupChannel</a></li><li data-type='method'><a href="EmoteFetcher.html#fetchBTTVEmotes">fetchBTTVEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#fetchFFZEmotes">fetchFFZEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#fetchSevenTVEmotes">fetchSevenTVEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#fetchTwitchEmotes">fetchTwitchEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#fromObject">fromObject</a></li></ul></li><li><a href="EmoteParser.html">EmoteParser</a><ul class='methods'><li data-type='method'><a href="EmoteParser.html#parse">parse</a></li></ul></li><li><a href="FFZEmote.html">FFZEmote</a><ul class='methods'><li data-type='method'><a href="FFZEmote.html#toLink">toLink</a></li><li data-type='method'><a href="FFZEmote.html#toObject">toObject</a></li><li data-type='method'><a href="FFZEmote.html#.fromObject">fromObject</a></li></ul></li><li><a href="SevenTVEmote.html">SevenTVEmote</a><ul class='methods'><li data-type='method'><a href="SevenTVEmote.html#toLink">toLink</a></li><li data-type='method'><a href="SevenTVEmote.html#toObject">toObject</a></li><li data-type='method'><a href="SevenTVEmote.html#.fromObject">fromObject</a></li></ul></li><li><a href="TwitchEmote.html">TwitchEmote</a><ul class='methods'><li data-type='method'><a href="TwitchEmote.html#toLink">toLink</a></li><li data-type='method'><a href="TwitchEmote.html#toObject">toObject</a></li><li data-type='method'><a href="TwitchEmote.html#.fromObject">fromObject</a></li></ul></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BTTVEmote.html">BTTVEmote</a><ul class='methods'><li data-type='method'><a href="BTTVEmote.html#toLink">toLink</a></li><li data-type='method'><a href="BTTVEmote.html#toObject">toObject</a></li><li data-type='method'><a href="BTTVEmote.html#.fromObject">fromObject</a></li></ul></li><li><a href="Channel.html">Channel</a><ul class='methods'><li data-type='method'><a href="Channel.html#fetchBTTVEmotes">fetchBTTVEmotes</a></li><li data-type='method'><a href="Channel.html#fetchFFZEmotes">fetchFFZEmotes</a></li><li data-type='method'><a href="Channel.html#fetchSevenTVEmotes">fetchSevenTVEmotes</a></li></ul></li><li><a href="Collection.html">Collection</a><ul class='methods'><li data-type='method'><a href="Collection.html#filter">filter</a></li><li data-type='method'><a href="Collection.html#find">find</a></li><li data-type='method'><a href="Collection.html#map">map</a></li></ul></li><li><a href="Emote.html">Emote</a><ul class='methods'><li data-type='method'><a href="Emote.html#toObject">toObject</a></li></ul></li><li><a href="EmoteFetcher.html">EmoteFetcher</a><ul class='methods'><li data-type='method'><a href="EmoteFetcher.html#_cacheBTTVEmote">_cacheBTTVEmote</a></li><li data-type='method'><a href="EmoteFetcher.html#_cacheFFZEmote">_cacheFFZEmote</a></li><li data-type='method'><a href="EmoteFetcher.html#_cacheSevenTVEmote">_cacheSevenTVEmote</a></li><li data-type='method'><a href="EmoteFetcher.html#_cacheTwitchEmote">_cacheTwitchEmote</a></li><li data-type='method'><a href="EmoteFetcher.html#_getRawBTTVEmotes">_getRawBTTVEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#_getRawFFZEmoteSet">_getRawFFZEmoteSet</a></li><li data-type='method'><a href="EmoteFetcher.html#_getRawFFZEmotes">_getRawFFZEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#_getRawSevenTVEmotes">_getRawSevenTVEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#_getRawTwitchEmotes">_getRawTwitchEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#_setupChannel">_setupChannel</a></li><li data-type='method'><a href="EmoteFetcher.html#fetchBTTVEmotes">fetchBTTVEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#fetchFFZEmotes">fetchFFZEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#fetchSevenTVEmotes">fetchSevenTVEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#fetchTwitchEmotes">fetchTwitchEmotes</a></li><li data-type='method'><a href="EmoteFetcher.html#fromObject">fromObject</a></li></ul></li><li><a href="EmoteParser.html">EmoteParser</a><ul class='methods'><li data-type='method'><a href="EmoteParser.html#_validateOptions">_validateOptions</a></li><li data-type='method'><a href="EmoteParser.html#parse">parse</a></li></ul></li><li><a href="FFZEmote.html">FFZEmote</a><ul class='methods'><li data-type='method'><a href="FFZEmote.html#toLink">toLink</a></li><li data-type='method'><a href="FFZEmote.html#toObject">toObject</a></li><li data-type='method'><a href="FFZEmote.html#.fromObject">fromObject</a></li></ul></li><li><a href="SevenTVEmote.html">SevenTVEmote</a><ul class='methods'><li data-type='method'><a href="SevenTVEmote.html#toLink">toLink</a></li><li data-type='method'><a href="SevenTVEmote.html#toObject">toObject</a></li><li data-type='method'><a href="SevenTVEmote.html#.fromObject">fromObject</a></li></ul></li><li><a href="TwitchEmote.html">TwitchEmote</a><ul class='methods'><li data-type='method'><a href="TwitchEmote.html#toLink">toLink</a></li><li data-type='method'><a href="TwitchEmote.html#toObject">toObject</a></li><li data-type='method'><a href="TwitchEmote.html#.fromObject">fromObject</a></li></ul></li></ul>
     
 </nav>
 
@@ -45,7 +45,8 @@
     
     <section>
         <article>
-            <pre class="prettyprint source linenums"><code>/**
+            <pre class="prettyprint source linenums"><code>/* eslint-disable jsdoc/reject-function-type, jsdoc/reject-any-type */
+/**
  * An extended Map with utility methods.
  * @class Collection
  */
@@ -137,7 +138,7 @@ module.exports = Collection;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.5</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mkody/twitch-emoticons",
-    "version": "2.9.2",
+    "version": "2.9.4",
     "description": "Gets Twitch, BTTV, FFZ and 7TV emotes as well as parsing text to emotes!",
     "main": "src/index.js",
     "typings": "typings/index.d.ts",
@@ -26,21 +26,21 @@
     ],
     "license": "MIT",
     "dependencies": {
-        "@twurple/api": "^7.3.0",
-        "@twurple/auth": "^7.3.0",
-        "axios": "^1.9.0"
+        "@twurple/api": "^7.4.0",
+        "@twurple/auth": "^7.4.0",
+        "axios": "^1.12.2"
     },
     "devDependencies": {
-        "@eslint/js": "^9.27.0",
-        "@jest/globals": "^29.7.0",
+        "@eslint/js": "^9.38.0",
+        "@jest/globals": "^30.2.0",
         "@microsoft/eslint-formatter-sarif": "^3.1.0",
         "docdash": "^2.0.2",
-        "esbuild": "^0.25.4",
-        "eslint": "^9.27.0",
-        "eslint-plugin-jsdoc": "^50.6.17",
-        "globals": "^16.1.0",
-        "jest": "^29.7.0",
-        "jsdoc": "^4.0.4"
+        "esbuild": "^0.25.11",
+        "eslint": "^9.38.0",
+        "eslint-plugin-jsdoc": "^61.1.5",
+        "globals": "^16.4.0",
+        "jest": "^30.2.0",
+        "jsdoc": "^4.0.5"
     },
     "scripts": {
         "all": "pnpm run lint && pnpm run test && pnpm run build && pnpm run docs",
@@ -65,10 +65,11 @@
         "node": ">=18.0.0",
         "pnpm": ">=9"
     },
-    "packageManager": "pnpm@10.11.0",
+    "packageManager": "pnpm@10.18.3",
     "pnpm": {
         "onlyBuiltDependencies": [
-            "esbuild"
+            "esbuild",
+            "unrs-resolver"
         ]
     }
 }

package/src/struct/Emote.js

@@ -5,6 +5,7 @@ class Emote {
      * @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) {

package/src/struct/EmoteFetcher.js

@@ -65,6 +65,7 @@ class EmoteFetcher {
      * @private
      * @param {int} channel_id - ID of the channel.
      * @param {string} [format=null] - The type file format to use (webp/avif).
+     * @throws {Error} When Twitch Client ID or Client Secret were not provided.
      * @returns {Channel}
      */
     _setupChannel(channel_id, format = null) {
@@ -326,6 +327,7 @@ class EmoteFetcher {
     /**
      * Converts emote Objects to emotes
      * @param {object} [emotesArray] - An array of emote objects
+     * @throws {TypeError} When an emote has an unknown type.
      * @returns {Emote[]}
      */
     fromObject(emotesArray) {

package/src/struct/EmoteParser.js

@@ -5,7 +5,7 @@ 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.
+     * @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.
@@ -37,6 +37,25 @@ class EmoteParser {
         this._validateOptions(this.options);
     }
 
+    /**
+     * 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.
+     */
     _validateOptions(options) {
         if (options.template && typeof options.template !== 'string') {
             throw new TypeError('Template must be a string');

package/src/util/Collection.js

@@ -1,3 +1,4 @@
+/* eslint-disable jsdoc/reject-function-type, jsdoc/reject-any-type */
 /**
  * An extended Map with utility methods.
  * @class Collection

package/test/SevenTV.test.js

@@ -15,12 +15,12 @@ describe('Test 7TV emotes', () => {
 
         test('Get emote (EZ)', () => {
             const emote = emoteFetcher.emotes.get('EZ');
-            expect(emote.toLink(2)).toBe('https://cdn.7tv.app/emote/01GB9W6V0000098BZVD7GKTW0F/3x.webp');
+            expect(emote.toLink(2)).toBe('https://cdn.7tv.app/emote/01K6WWG0R4T5A9FVNN4TWCWXA7/3x.webp');
         });
 
         test('Parse string with emote (EZ)', () => {
             const text = emoteParser.parse('This is a test string with :EZ: in it.');
-            expect(text).toBe('This is a test string with ![EZ](https://cdn.7tv.app/emote/01GB9W6V0000098BZVD7GKTW0F/1x.webp "EZ") in it.');
+            expect(text).toBe('This is a test string with ![EZ](https://cdn.7tv.app/emote/01K6WWG0R4T5A9FVNN4TWCWXA7/1x.webp "EZ") in it.');
         });
     });
 
@@ -37,12 +37,12 @@ describe('Test 7TV emotes', () => {
 
         test('Get emote (Clap)', () => {
             const emote = emoteFetcher.emotes.get('Clap');
-            expect(emote.toLink(2)).toBe('https://cdn.7tv.app/emote/01GAM8EFQ00004MXFXAJYKA859/3x.avif');
+            expect(emote.toLink(2)).toBe('https://cdn.7tv.app/emote/01GF9MNXQ8000E85YTZ0P4TWJ7/3x.avif');
         });
 
         test('Parse string with emote (Clap)', () => {
             const text = emoteParser.parse('This is a test string with :Clap: in it.');
-            expect(text).toBe('This is a test string with ![Clap](https://cdn.7tv.app/emote/01GAM8EFQ00004MXFXAJYKA859/1x.avif "Clap") in it.');
+            expect(text).toBe('This is a test string with ![Clap](https://cdn.7tv.app/emote/01GF9MNXQ8000E85YTZ0P4TWJ7/1x.avif "Clap") in it.');
         });
     });
 

package/test/__snapshots__/ToFromObject.test.js.snap

@@ -1,13 +1,13 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
 
 exports[`Test toObject 7TV Global Emote (AVIF) 1`] = `
 {
   "animated": false,
   "channel_id": null,
   "code": "EZ",
-  "id": "01GB9W6V0000098BZVD7GKTW0F",
+  "id": "01K6WWG0R4T5A9FVNN4TWCWXA7",
   "imageType": "avif",
-  "ownerName": "Kh4N_02",
+  "ownerName": "TrippyColour",
   "sizes": [
     "1x.avif",
     "2x.avif",

package/test/other.test.js

@@ -1,5 +1,5 @@
 const { describe, expect, test } = require('@jest/globals');
-const { Emote } = require('../src/index.js');
+const { Emote, EmoteFetcher, EmoteParser } = require('../src/index.js');
 
 describe('Emote class', () => {
     test('Base Emote class should not be used by itself', () => {
@@ -11,3 +11,62 @@ describe('Emote class', () => {
         );
     });
 });
+
+describe('EmoteParser\'s _validateOptions', () => {
+    const fetcher = new EmoteFetcher();
+
+    test('Should not throw on valid options', () => {
+        expect(() => {
+            // eslint-disable-next-line no-unused-vars
+            const parser = new EmoteParser(fetcher, {
+                template: '![{name}]({link} "{name}")',
+                type: 'markdown',
+                match: /:(.+?):/g
+            });
+        }).not.toThrow();
+    });
+
+    test('Should throw on invalid template', () => {
+        expect(() => {
+            // eslint-disable-next-line no-unused-vars
+            const parser = new EmoteParser(fetcher, {
+                template: () => { return 'test'; }
+            });
+        }).toThrow(
+            new TypeError('Template must be a string')
+        );
+    });
+
+    test('Should throw on invalid type', () => {
+        expect(() => {
+            // eslint-disable-next-line no-unused-vars
+            const parser = new EmoteParser(fetcher, {
+                type: 'invalid-type'
+            });
+        }).toThrow(
+            new TypeError('Parse type must be one of `markdown`, `html`, `bbcode`, or `plain`')
+        );
+    });
+
+    test('Should throw when not using a global regex', () => {
+        expect(() => {
+            // eslint-disable-next-line no-unused-vars
+            const parser = new EmoteParser(fetcher, {
+                match: /:(.+?):/
+            });
+        }).toThrow(
+            new TypeError('Match must be a global RegExp.')
+        );
+    });
+
+    test('Should throw when not using a regex object', () => {
+        expect(() => {
+            // eslint-disable-next-line no-unused-vars
+            const parser = new EmoteParser(fetcher, {
+                match: 'not-a-regex'
+            });
+        }).toThrow(
+            new TypeError('Match must be a global RegExp.')
+        );
+    });
+});

package/typings/index.d.ts

@@ -45,7 +45,7 @@ declare module '@mkody/twitch-emoticons' {
             fetcher: EmoteFetcher, 
             options: {
                 template?: string,
-                type?: string,
+                type?: 'html' | 'markdown' | 'bbcode' | 'plain',
                 match?: RegExp
             }
         );