@mkody/twitch-emoticons 2.5.0 → 2.6.1

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

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

package/.github/workflows/codeql.yml

@@ -0,0 +1,50 @@
+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

@@ -0,0 +1,51 @@
+# 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/yarn-test.yml

@@ -11,7 +11,6 @@ jobs:
         with:
           node-version: 16
       - run: yarn
-      - run: yarn lint
       - run: yarn test
         env:
           TWITCH_ID: ${{ secrets.TWITCH_ID }}

package/.jsdoc.json

@@ -30,5 +30,10 @@
     "plugins": ["plugins/markdown"],
     "markdown": {
         "hardwrap": true
+    },
+    "docdash": {
+        "scopeInOutputPath": false,
+        "nameInOutputPath": false,
+        "versionInOutputPath": false
     }
 }

package/LICENSE

@@ -1,6 +1,7 @@
 MIT License
 
 Copyright (c) 2017 1Computer1
+Copyright (c) 2019 André "Kody" Fernandes
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,18 +1,13 @@
 # twitch-emoticons
 
-Gets Twitch, BTTV and FFZ emotes as well as parsing text to emotes!
+Gets Twitch, BTTV, FFZ and 7TV emotes as well as parsing text to emotes!
 
-### About this fork's 2.3.0+
+### Migrating from upstream
 You must now use a Twitch user ID instead of the username to fetch user's emotes.  
 You can use [this page to quickly grab it](https://s.kdy.ch/twitchid/).
 
-_FFZ still supports names, but usage of the ID is recommended._
-
-### About this fork's 2.4.0+
-You now need to use the official Twitch API to get emotes. For this you need to provide your client id and client secret.
-To get a client and secret create a Twitch app [here](https://dev.twitch.tv/console/apps/create), it's free.
-
-If you are only using BetterTTV and FrankerFaceZ you don't need to provide anything as they are independent from the Twitch API.
+To fetch Twitch emotes you need to get a client and secret from Twitch [here](https://dev.twitch.tv/console/apps/create), it's free.  
+If you are only using BetterTTV, FrankerFaceZ and 7TV you don't need to provide Twitch app keys as they are independent from the Twitch API.
 
 ### Install
 ```sh
@@ -21,11 +16,18 @@ npm install @mkody/twitch-emoticons
 yarn add @mkody/twitch-emoticons
 ```
 
-### Example
+### Examples
+
+#### Basic Twitch emote parsing
 
 ```js
+// With ESM import
+import TwitchEmoticons from '@mkody/twitch-emoticons';
+const { EmoteFetcher, EmoteParser } = TwitchEmoticons;
+// ... or require()
 const { EmoteFetcher, EmoteParser } = require('@mkody/twitch-emoticons');
 
+// Your Twitch app keys
 const clientId = '<your client id>';
 const clientSecret = '<your client secret>';
 
@@ -38,13 +40,82 @@ const parser = new EmoteParser(fetcher, {
 fetcher.fetchTwitchEmotes(null).then(() => {
     const kappa = fetcher.emotes.get('Kappa').toLink();
     console.log(kappa);
-    // https://static-cdn.jtvnw.net/emoticons/v1/25/1.0
+    // https://static-cdn.jtvnw.net/emoticons/v2/25/default/dark/1.0
 
     const text = 'Hello :CoolCat:!';
     const parsed = parser.parse(text);
     console.log(parsed);
-    // Hello ![CoolCat](https://static-cdn.jtvnw.net/emoticons/v1/58127/1.0 "CoolCat")!
+    // Hello ![CoolCat](https://static-cdn.jtvnw.net/emoticons/v2/58127/default/dark/1.0 "CoolCat")!
+});
+```
+
+#### All providers, global + channel, custom template and match pattern
+
+```js
+const { EmoteFetcher, EmoteParser } = require('@mkody/twitch-emoticons');
+
+// Your channel ID
+const channelId = 44317909;
+
+// Your Twitch app keys
+const clientId = '<your client id>';
+const clientSecret = '<your client secret>';
+
+const fetcher = new EmoteFetcher(clientId, clientSecret);
+const parser = new EmoteParser(fetcher, {
+    template: '<img class="emote" alt="{name}" src="{link}">', // Custom HTML format
+    match: /(\w+)+?/g // Match without :colons:
 });
+
+Promise.all([
+    // Twitch global
+    fetcher.fetchTwitchEmotes(),
+    // Twitch channel
+    fetcher.fetchTwitchEmotes(channelId),
+    // BTTV global
+    fetcher.fetchBTTVEmotes(),
+    // BTTV channel
+    fetcher.fetchBTTVEmotes(channelId),
+    // 7TV global
+    fetcher.fetchSevenTVEmotes(),
+    // 7TV channel
+    fetcher.fetchSevenTVEmotes(channelId),
+    // FFZ channel
+    fetcher.fetchFFZEmotes(channelId)
+]).then(() => {
+    const globalEmotes = parser.parse('EZ Clap way too easy LUL now for the last bost monkaS');
+    console.log(globalEmotes);
+    // <img class="emote" alt="EZ" src="https://cdn.7tv.app/emote/6320bf2ad461b9ebf9413812/1x.webp"> <img class="emote" alt="Clap" src="https://cdn.7tv.app/emote/636b877aada75990352334c7/1x.webp"> way too easy <img class="emote" alt="LUL" src="https://static-cdn.jtvnw.net/emoticons/v2/425618/default/dark/1.0"> now for the last bost <img class="emote" alt="monkaS" src="https://cdn.betterttv.net/emote/56e9f494fff3cc5c35e5287e/1x">
+
+    const channelEmotes = parser.parse('KEKW that was 3Head TeriPoint');
+    console.log(channelEmotes);
+    // <img class="emote" alt="KEKW" src="https://cdn.betterttv.net/emote/5e9c6c187e090362f8b0b9e8/1x"> that was <img class="emote" alt="3Head" src="https://cdn.frankerfacez.com/emote/274406/1"> <img class="emote" alt="TeriPoint" src="https://cdn.7tv.app/emote/61dc299b600369a98b38ebef/1x.webp">
+}).catch(err => {
+    console.error('Error loading emotes...');
+    console.error(err);
+});
+```
+
+#### 7TV formats
+
+7TV v3 delivers emotes in either WEBP or AVIF.  
+By default we'll return WEBP emotes but you can override this.
+
+```js
+const { EmoteFetcher } = require('@mkody/twitch-emoticons');
+const fetcher = new EmoteFetcher();
+
+// Fetch global emotes in AVIF (channel id has to be `null` for global)
+fetcher.fetchSevenTVEmotes(null, 'avif');
+
+// Fetch 0kody's emotes with the package's default format (WEBP)
+fetcher.fetchSevenTVEmotes(44317909);
+
+// ... which is currently the same as
+fetcher.fetchSevenTVEmotes(44317909, 'webp');
+
+// Fetch Anatole's emotes in AVIF
+fetcher.fetchSevenTVEmotes(24377667, 'avif');
 ```
 
 ### Links
@@ -55,4 +126,5 @@ fetcher.fetchTwitchEmotes(null).then(() => {
 
 This library uses the following:
 - [BetterTTV API](https://betterttv.com/)
-- [FrankerFaceZ API](http://www.frankerfacez.com/developers)
+- [FrankerFaceZ API](https://www.frankerfacez.com/developers)
+- [7TV API](https://7tv.app/)