emotesjs 0.0.18 → 0.0.21

package/README.md

@@ -0,0 +1,50 @@
+![banner](.github/images/banner.png)
+
+![NPM Version](https://img.shields.io/npm/v/emotesjs) ![npm package minimized gzipped size](https://img.shields.io/bundlejs/size/emotesjs)
+
+# EmotesJS
+
+Fast, dependency free, and responsive 7TV inline emotes parse
+
+## Usage
+
+### Installation
+```sh
+pnpm i emotesjs
+```
+or using a CDN
+```html
+<script src="https://cdn.jsdelivr.net/npm/emotesjs@0.0.21/index.min.js"></script>
+```
+
+### Parsing
+```js
+// const { EmotesJS } = require('emotesjs')
+import { EmotesJS } from 'emotesjs'
+
+let emotes = new EmotesJS({ channelId: 123456 })
+
+// optional - once fetched, the emotes will be cached in memory
+await emotes.isLoading
+
+let html = emotes.parse('this is pretty Pog')
+
+console.log(html) 
+// this is pretty <img srcset="https://cdn.7tv.app/emote/01EZTCN91800012PTN006Q50PR/4x.webp 128w, 
+//      https://cdn.7tv.app/emote/01EZTCN91800012PTN006Q50PR/3x.webp 96w, 
+//      https://cdn.7tv.app/emote/01EZTCN91800012PTN006Q50PR/2x.webp 64w, 
+//      https://cdn.7tv.app/emote/01EZTCN91800012PTN006Q50PR/1x.webp 32w" 
+//      alt="Pog" style="height:1.65rem"
+// />
+```
+
+## Configuration
+
+```js
+new EmotesJS({ 
+    channelId: 123456, // twitch channel id (or user id) to load the emotes
+    colon: false, // if true, the string must start with : e.g. :Pog
+    height: '1.65rem', // the element <img> height
+    format: 'WEBP' // or AVIF
+})
+```

package/index.js

@@ -1,120 +1 @@
-class EmotesJS {
-    #cachedEmotes = new Map()
-    #isReady = false
-    #requireColon = true
-    #height = "1.65rem"
-    #format = "WEBP"
-    #allowedOrigins = "https://cdn.7tv.app"
-
-    loadedEmotes = 0
-    channelId = 0
-    isLoading = Promise.resolve()
-    static instance
-
-    constructor(opts) {
-        if (EmotesJS.instance && EmotesJS.instance.channelId !== 0) {
-            return EmotesJS.instance
-        }
-
-        if (opts) {
-            this.channelId = opts.channelId
-            this.#requireColon = opts.requireColon
-            this.#requireColon ||= false
-            this.#height = opts.height || this.#height
-            this.#format = opts.format || this.#format
-        }
-
-        this.isLoading = this.load()
-        EmotesJS.instance = this
-    }
-
-    async load() {
-        let globalProm = fetch("https://7tv.io/v3/emote-sets/global").then(async r => {
-            if (r.ok) {
-                return r.json()
-            }
-
-            throw new Error("fetch unsuccessful")
-        })
-
-        let chProm = fetch("https://7tv.io/v3/users/twitch/" + this.channelId).then(async r => {
-            if (r.ok) {
-                return r.json()
-            }
-
-            throw new Error("fetch unsuccessful")
-        })
-
-        let [global, ch] = await Promise.allSettled([globalProm, chProm])
-
-        let rawEmotes = []
-
-        if (ch.status === "fulfilled") {
-            rawEmotes.push(...ch.value.emote_set.emotes)
-        }
-
-        if (global.status === "fulfilled") {
-            rawEmotes.push(...global.value.emotes)
-        }
-
-        for (let emote of rawEmotes) {
-            let name = emote.data.name
-            let url = `https:${emote.data.host.url}`
-
-            if (!url.includes(this.#allowedOrigins)) {
-                continue
-            }
-
-            let files = emote.data.host.files.filter(x => x.format === this.#format)
-            let srcset = files.reduce((acc, curr) => `${url}/${curr.name} ${curr.width}w, ${acc}`, "")
-            let elementString = `<img srcset="${srcset}" alt="${name}" style="height:${this.#height}"/>`
-
-            this.#cachedEmotes.set(name, elementString)
-        }
-
-        this.loadedEmotes = this.#cachedEmotes.size
-
-        this.#isReady = true
-    }
-
-    parse(text) {
-        if (!text || !this.#isReady) {
-            console.log("emotes not ready")
-            return text
-        }
-
-        if (this.#isReady && this.#cachedEmotes.size === 0) {
-            console.log("no emotes loaded")
-            return text
-        }
-
-        let words = text.split(" ")
-
-        let fullText = ""
-        for (let i = 0; i < words.length; i++) {
-            let word = words[i]
-
-
-            if (this.#requireColon && !word.startsWith(":")) {
-                fullText += word + " "
-                continue
-            }
-
-            let wordKey = word.replaceAll(":", "")
-            let emote = this.#cachedEmotes.get(wordKey)
-
-            if (emote) {
-                fullText += emote + " "
-                continue;
-            }
-
-            fullText += word + " "
-        }
-
-        return fullText.trim()
-    }
-
-}
-
-module.exports.EmotesJS = EmotesJS
-
+class EmotesJS{#cachedEmotes=new Map;#isReady=false;#colon=true;#height="1.65rem";#format="WEBP";#allowedOrigins="https://cdn.7tv.app";total=0;channelId=0;isLoading=Promise.resolve();static instance;constructor(opts){if(EmotesJS.instance&&EmotesJS.instance.channelId!==0){return EmotesJS.instance}if(opts){this.channelId=opts.channelId;this.#colon=opts.colon;this.#colon||=false;this.#height=opts.height||this.#height;this.#format=opts.format||this.#format}this.isLoading=this.load();EmotesJS.instance=this}async load(){let globalProm=fetch("https://7tv.io/v3/emote-sets/global").then(async r=>{if(r.ok){return r.json()}throw new Error("fetch unsuccessful")});let chProm=fetch("https://7tv.io/v3/users/twitch/"+this.channelId).then(async r=>{if(r.ok){return r.json()}throw new Error("fetch unsuccessful")});let[global,ch]=await Promise.allSettled([globalProm,chProm]);let rawEmotes=[];if(ch.status==="fulfilled"){rawEmotes.push(...ch.value.emote_set.emotes)}if(global.status==="fulfilled"){rawEmotes.push(...global.value.emotes)}for(let emote of rawEmotes){let name=emote.data.name;let url=`https:${emote.data.host.url}`;if(!url.includes(this.#allowedOrigins)){continue}let files=emote.data.host.files.filter(x=>x.format===this.#format);let srcset=files.reduce((acc,curr)=>`${url}/${curr.name} ${curr.width}w, ${acc}`,"");let elementString=`<img srcset="${srcset}" alt="${name}" style="height:${this.#height}"/>`;this.#cachedEmotes.set(name,elementString)}this.total=this.#cachedEmotes.size;this.#isReady=true}parse(text){if(!text){console.log("no text to parse emotes");return text}if(!this.#isReady){console.log("emotes are not ready");return text}if(this.#cachedEmotes.size===0){console.log("no emotes loaded");return text}let words=text.split(" ");let fullText="";for(let i=0;i<words.length;i++){let word=words[i];if(this.#colon&&!word.startsWith(":")){fullText+=word+" ";continue}let wordKey=word.replaceAll(":","");let emote=this.#cachedEmotes.get(wordKey);if(emote){fullText+=emote+" ";continue}fullText+=word+" "}return fullText.trim()}}module.exports.EmotesJS=EmotesJS;

package/package.json

@@ -1,31 +1,33 @@
 {
-    "name": "emotesjs",
-    "description": "",
-    "version": "0.0.18",
-    "license": "MIT",
-    "author": {
-        "name": "darckfast"
-    },
-    "engines": {
-        "node": ">=22"
-    },
-    "files": [
-        "index.js"
-    ],
-    "main": "index.js",
-    "repository": {
-        "type": "git",
-        "url": "git://github.com/darckfast/emotesjs.git"
-    },
-    "keywords": [
-        "twitch",
-        "7tv",
-        "emotes"
-    ],
-    "scripts": {
-        "test": "vitest run"
-    },
-    "devDependencies": {
-        "vitest": "^3.2.4"
-    }
-}
+  "name": "emotesjs",
+  "description": "Fast, dependency free, and responsive 7TV inline emotes parse",
+  "version": "0.0.21",
+  "license": "MIT",
+  "author": {
+    "name": "darckfast"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "files": [
+    "index.js"
+  ],
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/darckfast/emotesjs.git"
+  },
+  "keywords": [
+    "twitch",
+    "7tv",
+    "emotes",
+    "responsive"
+  ],
+  "devDependencies": {
+    "terser": "^5.43.1",
+    "vitest": "^3.2.4"
+  },
+  "scripts": {
+    "test": "vitest run"
+  }
+}