@mkody/twitch-emoticons 2.8.1 → 2.8.4

package/test/ToFromObject.test.js

@@ -0,0 +1,155 @@
+const { describe, expect, test, beforeEach } = require('@jest/globals');
+const { env } = require('process');
+const { EmoteFetcher, EmoteParser } = require('../src/index.js');
+
+describe('Test toObject', () => {
+    let emoteFetcher;
+
+    beforeEach(() => {
+        // Make a fresh EmoteFetcher object before each tests
+        // This prevents surprises in case there's an emote name used in multiple sources
+        emoteFetcher = new EmoteFetcher(env.TWITCH_ID, env.TWITCH_SECRET);
+    });
+
+    test('BTTV Global Emote', async() => {
+        await emoteFetcher.fetchBTTVEmotes();
+        expect(emoteFetcher.emotes.get('SourPls').toObject()).toMatchSnapshot();
+    });
+
+    test('BTTV User Emote', async() => {
+        await emoteFetcher.fetchBTTVEmotes(56648155);
+        expect(emoteFetcher.emotes.get('tppUrn').toObject()).toMatchSnapshot();
+    });
+
+    test('BTTV User Animated Emote', async() => {
+        await emoteFetcher.fetchBTTVEmotes(56648155);
+        expect(emoteFetcher.emotes.get('MODS').toObject()).toMatchSnapshot();
+    });
+
+    test('FFZ Global Emote', async() => {
+        await emoteFetcher.fetchFFZEmotes();
+        expect(emoteFetcher.emotes.get('CatBag').toObject()).toMatchSnapshot();
+    });
+
+    test('FFZ User Emote', async() => {
+        await emoteFetcher.fetchFFZEmotes(13638332);
+        expect(emoteFetcher.emotes.get('SanaeSip').toObject()).toMatchSnapshot();
+    });
+
+    test('FFZ User Animated Emote', async() => {
+        await emoteFetcher.fetchFFZEmotes(44317909);
+        expect(emoteFetcher.emotes.get('MikuSway').toObject()).toMatchSnapshot();
+    });
+
+    test('7TV Global Emote (AVIF)', async() => {
+        await emoteFetcher.fetchSevenTVEmotes(null, 'avif');
+        expect(emoteFetcher.emotes.get('EZ').toObject()).toMatchSnapshot();
+    });
+
+    test('7TV User Emote', async() => {
+        await emoteFetcher.fetchSevenTVEmotes(44317909);
+        expect(emoteFetcher.emotes.get('modCheck').toObject()).toMatchSnapshot();
+    });
+
+    if (env.TWITCH_ID === undefined || env.TWITCH_SECRET === undefined
+        || env.TWITCH_ID === '' || env.TWITCH_SECRET === '') {
+        test.todo('Notice: Twitch client id/secret missing, not testing with Twitch emotes.');
+    } else {
+        test('Twitch Global Emote', async() => {
+            await emoteFetcher.fetchTwitchEmotes();
+            // Use inline to not fail when the environment variables are not set
+            expect(emoteFetcher.emotes.get('Kappa').toObject()).toMatchInlineSnapshot(`
+{
+  "animated": false,
+  "channel_id": null,
+  "code": "Kappa",
+  "id": "25",
+  "set": undefined,
+  "type": "twitch",
+}
+`);
+        });
+
+        test('Twitch User Emote', async() => {
+            await emoteFetcher.fetchTwitchEmotes(56648155);
+            // Use inline to not fail when the environment variables are not set
+            expect(emoteFetcher.emotes.get('tppD').toObject()).toMatchInlineSnapshot(`
+{
+  "animated": false,
+  "channel_id": 56648155,
+  "code": "tppD",
+  "id": "307609315",
+  "set": undefined,
+  "type": "twitch",
+}
+`);
+        });
+    }
+});
+
+describe('Test fromObject', () => {
+    const emoteFetcher = new EmoteFetcher();
+    const emoteParser = new EmoteParser(emoteFetcher, {
+        type: 'markdown',
+        match: /(\w+)+?/g
+    });
+
+    const emotes_obj = [
+        {
+            code: 'tppD',
+            id: '307609315',
+            channel_id: 56648155,
+            animated: false,
+            set: undefined,
+            type: 'twitch'
+        },
+        {
+            code: 'SourPls',
+            id: '566ca38765dbbdab32ec0560',
+            channel_id: null,
+            animated: true,
+            ownerName: null,
+            type: 'bttv'
+        },
+        {
+            code: 'modCheck',
+            id: '60abf171870d317bef23d399',
+            channel_id: 44317909,
+            animated: true,
+            sizes: ['1x.webp', '2x.webp', '3x.webp', '4x.webp'],
+            ownerName: 'Laden',
+            type: '7tv',
+            imageType: 'webp'
+        },
+        {
+            code: 'MikuSway',
+            id: 723102,
+            channel_id: 44317909,
+            animated: true,
+            sizes: ['1', '2', '4'],
+            ownerName: 'brian6932',
+            type: 'ffz',
+            modifier: false
+        }
+    ];
+
+    test('Execute fromObject', () => {
+        expect(emoteFetcher.fromObject(emotes_obj)).toBeInstanceOf(Array);
+    });
+
+    test('Get emote (SourPls)', () => {
+        const emote = emoteFetcher.emotes.get('SourPls');
+        expect(emote.toLink()).toBe('https://cdn.betterttv.net/emote/566ca38765dbbdab32ec0560/1x.webp');
+    });
+
+    test('Parse string with emotes (tppD, SourPls, modCheck, MikuSway)', () => {
+        expect(emoteParser.parse('tppD SourPls modCheck MikuSway')).toBe(
+            [
+                '![tppD](https://static-cdn.jtvnw.net/emoticons/v2/307609315/default/dark/1.0 "tppD")',
+                '![SourPls](https://cdn.betterttv.net/emote/566ca38765dbbdab32ec0560/1x.webp "SourPls")',
+                '![modCheck](https://cdn.7tv.app/emote/60abf171870d317bef23d399/1x.webp "modCheck")',
+                '![MikuSway](https://cdn.frankerfacez.com/emote/723102/animated/1.webp "MikuSway")'
+            ].join(' ')
+        );
+    });
+});

package/test/Twitch.test.js

@@ -0,0 +1,64 @@
+const { describe, expect, test } = require('@jest/globals');
+const { env } = require('process');
+const { EmoteFetcher, EmoteParser, Collection } = require('../src/index.js');
+
+describe('Test Twitch emotes', () => {
+    test('Test failing when environment variables are not set', () => {
+        const emoteFetcher = new EmoteFetcher();
+
+        expect(() => {
+            emoteFetcher.fetchTwitchEmotes();
+        }).toThrow(
+            new Error('Client id or client secret not provided.')
+        );
+    });
+
+    if (env.TWITCH_ID === undefined || env.TWITCH_SECRET === undefined
+      || env.TWITCH_ID === '' || env.TWITCH_SECRET === '') {
+        test.todo('Notice: Twitch client id/secret missing, not testing fetching and parsing.');
+    } else {
+        describe('Test global emotes', () => {
+            const emoteFetcher = new EmoteFetcher(env.TWITCH_ID, env.TWITCH_SECRET);
+            const emoteParser = new EmoteParser(emoteFetcher, {
+                type: 'markdown',
+                match: /:(.+?):/g
+            });
+
+            test('Execute fetchTwitchEmotes without any parameters', async() => {
+                expect(await emoteFetcher.fetchTwitchEmotes()).toBeInstanceOf(Collection);
+            });
+
+            test('Get emote (Kappa)', () => {
+                const emote = emoteFetcher.emotes.get('Kappa');
+                expect(emote.toLink(2)).toBe('https://static-cdn.jtvnw.net/emoticons/v2/25/default/dark/3.0');
+            });
+
+            test('Parse string with emote (CoolCat)', () => {
+                const text = emoteParser.parse('This is a test string with :CoolCat: in it.');
+                expect(text).toBe('This is a test string with ![CoolCat](https://static-cdn.jtvnw.net/emoticons/v2/58127/default/dark/1.0 "CoolCat") in it.');
+            });
+        });
+
+        describe('Test user emotes', () => {
+            const emoteFetcher = new EmoteFetcher(env.TWITCH_ID, env.TWITCH_SECRET);
+            const emoteParser = new EmoteParser(emoteFetcher, {
+                type: 'markdown',
+                match: /:(.+?):/g
+            });
+
+            test('Execute fetchTwitchEmotes with user ID', async() => {
+                expect(await emoteFetcher.fetchTwitchEmotes(56648155)).toBeInstanceOf(Collection);
+            });
+
+            test('Get emote (tppD)', () => {
+                const emote = emoteFetcher.emotes.get('tppD');
+                expect(emote.toLink(2)).toBe('https://static-cdn.jtvnw.net/emoticons/v2/307609315/default/dark/3.0');
+            });
+
+            test('Parse string with emote (tppD)', () => {
+                const text = emoteParser.parse('This is a test string with :tppD: in it.');
+                expect(text).toBe('This is a test string with ![tppD](https://static-cdn.jtvnw.net/emoticons/v2/307609315/default/dark/1.0 "tppD") in it.');
+            });
+        });
+    }
+});

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

@@ -0,0 +1,121 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Test toObject 7TV Global Emote (AVIF) 1`] = `
+{
+  "animated": false,
+  "channel_id": null,
+  "code": "EZ",
+  "id": "61525bba20eaf897465aab47",
+  "imageType": "avif",
+  "ownerName": "CycIoneTM",
+  "sizes": [
+    "1x.avif",
+    "2x.avif",
+    "3x.avif",
+    "4x.avif",
+  ],
+  "type": "7tv",
+}
+`;
+
+exports[`Test toObject 7TV User Emote 1`] = `
+{
+  "animated": true,
+  "channel_id": 44317909,
+  "code": "modCheck",
+  "id": "60abf171870d317bef23d399",
+  "imageType": "webp",
+  "ownerName": "Laden",
+  "sizes": [
+    "1x.webp",
+    "2x.webp",
+    "3x.webp",
+    "4x.webp",
+  ],
+  "type": "7tv",
+}
+`;
+
+exports[`Test toObject BTTV Global Emote 1`] = `
+{
+  "animated": true,
+  "channel_id": null,
+  "code": "SourPls",
+  "id": "566ca38765dbbdab32ec0560",
+  "ownerName": null,
+  "type": "bttv",
+}
+`;
+
+exports[`Test toObject BTTV User Animated Emote 1`] = `
+{
+  "animated": true,
+  "channel_id": 56648155,
+  "code": "MODS",
+  "id": "5f2c4f9e65fe924464ef6d61",
+  "ownerName": "bearrrr_",
+  "type": "bttv",
+}
+`;
+
+exports[`Test toObject BTTV User Emote 1`] = `
+{
+  "animated": false,
+  "channel_id": 56648155,
+  "code": "tppUrn",
+  "id": "5f5f7d5f68d9d86c020e8672",
+  "ownerName": null,
+  "type": "bttv",
+}
+`;
+
+exports[`Test toObject FFZ Global Emote 1`] = `
+{
+  "animated": false,
+  "channel_id": null,
+  "code": "CatBag",
+  "id": 25927,
+  "modifier": false,
+  "ownerName": "wolsk",
+  "sizes": [
+    "1",
+    "2",
+    "4",
+  ],
+  "type": "ffz",
+}
+`;
+
+exports[`Test toObject FFZ User Animated Emote 1`] = `
+{
+  "animated": true,
+  "channel_id": 44317909,
+  "code": "MikuSway",
+  "id": 723102,
+  "modifier": false,
+  "ownerName": "brian6932",
+  "sizes": [
+    "1",
+    "2",
+    "4",
+  ],
+  "type": "ffz",
+}
+`;
+
+exports[`Test toObject FFZ User Emote 1`] = `
+{
+  "animated": false,
+  "channel_id": 13638332,
+  "code": "SanaeSip",
+  "id": 305078,
+  "modifier": false,
+  "ownerName": "shizuka_natsume",
+  "sizes": [
+    "1",
+    "2",
+    "4",
+  ],
+  "type": "ffz",
+}
+`;

package/test/other.test.js

@@ -0,0 +1,13 @@
+const { describe, expect, test } = require('@jest/globals');
+const { Emote } = require('../src/index.js');
+
+describe('Emote class', () => {
+    test('Base Emote class should not be used by itself', () => {
+        expect(() => {
+            // eslint-disable-next-line no-unused-vars
+            const emote = new Emote();
+        }).toThrow(
+            new Error('Base Emote class cannot be used')
+        );
+    });
+});

package/typings/index.d.ts

@@ -35,7 +35,7 @@ declare module '@mkody/twitch-emoticons' {
 
         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 fetchFFZEmotes(id?: number): Promise<Collection<string, FFZEmote>>;
         public fetchSevenTVEmotes(id?: number, format?: 'webp' | 'avif'): Promise<Collection<string, SevenTVEmote>>;
         public fromObject(emotesArray: EmoteObject[]): Emote[];
     }

package/.github/codeql/codeql-config.yml

@@ -1,5 +0,0 @@
-name: "CodeQL config"
-
-paths-ignore:
-  - docs
-  - test

package/.github/workflows/codeql.yml

@@ -1,50 +0,0 @@
-name: "CodeQL"
-
-on:
-  push:
-    branches: [ "master" ]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ "master" ]
-  schedule:
-    - cron: '23 11 * * 0'
-
-jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
-
-    strategy:
-      fail-fast: false
-      matrix:
-        language: [ 'javascript' ]
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
-        # Use only 'java' to analyze code written in Java, Kotlin or both
-        # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
-        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
-
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
-
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
-      with:
-        languages: ${{ matrix.language }}
-        config-file: ./.github/codeql/codeql-config.yml
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-
-        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
-        # queries: security-extended,security-and-quality
-
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
-      with:
-        category: "/language:${{matrix.language}}"

package/.github/workflows/eslint.yml

@@ -1,51 +0,0 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# ESLint is a tool for identifying and reporting on patterns
-# found in ECMAScript/JavaScript code.
-# More details at https://github.com/eslint/eslint
-# and https://eslint.org
-
-name: ESLint
-
-on:
-  push:
-    branches: [ "master" ]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ "master" ]
-  schedule:
-    - cron: '26 14 * * 6'
-
-jobs:
-  eslint:
-    name: Run eslint scanning
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      security-events: write
-      actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-
-      - name: Install ESLint
-        run: |
-          npm install eslint@8.29.0
-          npm install @microsoft/eslint-formatter-sarif@3.0.0
-
-      - name: Run ESLint
-        run: npx eslint ./src ./test
-          --config .eslintrc.json
-          --ext .js,.jsx,.ts,.tsx
-          --format @microsoft/eslint-formatter-sarif
-          --output-file eslint-results.sarif
-        continue-on-error: true
-
-      - name: Upload analysis results to GitHub
-        uses: github/codeql-action/upload-sarif@v2
-        if: ${{ !env.ACT }}
-        with:
-          sarif_file: eslint-results.sarif
-          wait-for-processing: true

package/.github/workflows/release.yml

@@ -1,22 +0,0 @@
-name: Publish Package to npmjs
-on:
-  release:
-    types: [ created ]
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-      id-token: write
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version-file: '.nvmrc'
-          registry-url: 'https://registry.npmjs.org'
-      - run: npm install -g npm
-      - run: yarn install --frozen-lockfile
-      - run: yarn test
-      - run: npm publish --provenance --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/yarn-test.yml

@@ -1,17 +0,0 @@
-name: Yarn Test
-
-on: [push, pull_request]
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version-file: '.nvmrc'
-      - run: yarn install --frozen-lockfile
-      - run: yarn test
-        env:
-          TWITCH_ID: ${{ secrets.TWITCH_ID }}
-          TWITCH_SECRET: ${{ secrets.TWITCH_SECRET }}