emotesjs 0.0.27 → 1.0.0

package/README.md

@@ -6,4 +6,26 @@
 
 Fast, dependency free, and responsive 7TV inline emotes parse
 
+## Basic usage
+
+```sh
+npm i emotesjs
+```
+
+```ts
+import { EmotesJS } from 'emotesjs'
+
+let emotes = new EmotesJS({ channelId: 123456 })
+
+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"
+// />
+```
+
 [Check the documentation here](https://darckfast.com/docs/emotesjs)

package/dist/index.d.ts

@@ -0,0 +1,124 @@
+interface SevenTVChannelEmotes {
+    id: string;
+    platform: string;
+    username: string;
+    display_name: string;
+    linked_at: number;
+    emote_capacity: number;
+    emote_set_id: string;
+    emote_set: EmoteSet;
+    user: User;
+}
+interface EmoteSet {
+    id: string;
+    name: string;
+    flags: number;
+    tags: any[];
+    immutable: boolean;
+    privileged: boolean;
+    emotes: Emote[];
+    emote_count: number;
+    capacity: number;
+    owner: any;
+}
+interface Emote {
+    id: string;
+    name: string;
+    flags: number;
+    timestamp: number;
+    actor_id?: string;
+    data: Data;
+    origin_id: any;
+}
+interface Data {
+    id: string;
+    name: string;
+    flags: number;
+    lifecycle: number;
+    state: string[];
+    listed: boolean;
+    animated: boolean;
+    owner?: Owner;
+    host: Host;
+    tags?: string[];
+}
+interface Owner {
+    id: string;
+    username: string;
+    display_name: string;
+    avatar_url?: string;
+    style: Style;
+    role_ids: string[];
+    connections: Connection[];
+}
+interface Style {
+    color?: number;
+    paint_id?: string;
+    badge_id?: string;
+}
+interface Connection {
+    id: string;
+    platform: string;
+    username: string;
+    display_name: string;
+    linked_at: number;
+    emote_capacity: number;
+    emote_set_id: string;
+    emote_set: any;
+}
+interface Host {
+    url: string;
+    files: File[];
+}
+interface File {
+    name: string;
+    static_name: string;
+    width: number;
+    height: number;
+    frame_count: number;
+    size: number;
+    format: string;
+}
+interface User {
+    id: string;
+    username: string;
+    display_name: string;
+    created_at: number;
+    avatar_url: string;
+    style: Style;
+    emote_sets: EmoteSet[];
+    editors: Editor[];
+    roles: string[];
+    connections: Connection[];
+}
+interface Editor {
+    id: string;
+    permissions: number;
+    visible: boolean;
+    added_at: number;
+}
+interface Opts {
+    channelId?: number;
+    only?: Array<string>;
+    usePixelDensity?: boolean;
+    colon?: boolean;
+    height?: string;
+    format?: string;
+    cache?: string;
+    proxy?: string;
+}
+declare class EmotesJS {
+    #private;
+    total: number;
+    channelId: number;
+    isLoading: Promise<void>;
+    proxy: string;
+    static instance: EmotesJS;
+    constructor(opts: Opts);
+    static fromCache(cache: string): EmotesJS;
+    cache(): string;
+    load(only?: Array<string>): Promise<void>;
+    parse(text: string): string;
+}
+
+export { type Connection, type Data, type Editor, type Emote, type EmoteSet, EmotesJS, type File, type Host, type Owner, type SevenTVChannelEmotes, type Style, type User };

package/dist/index.js

@@ -0,0 +1 @@
+var u=class a{#e=new Map;#s=!0;#t="1.65rem";#i="WEBP";#r="https://cdn.7tv.app";#n=!1;#a=!1;total=0;channelId=0;isLoading=Promise.resolve();proxy="";static instance;constructor(e){if(a.instance&&a.instance.channelId!==0)return a.instance;let i;e&&(i=e.only,this.channelId=e.channelId||0,this.#s=!!e.colon,this.#t=e.height||this.#t,this.#i=e.format||this.#i,this.#a=!!e.usePixelDensity,e.cache&&typeof e.cache=="string"&&(this.#e=new Map(Object.entries(JSON.parse(e.cache))),this.total=this.#e.size,this.#n=!0),this.proxy=e.proxy||""),this.isLoading=this.load(i),a.instance=this}static fromCache(e){return new a({cache:e})}cache(){return JSON.stringify(Object.fromEntries(this.#e.entries()))}async load(e=[]){let i=fetch("https://7tv.io/v3/emote-sets/global").then(t=>{if(t.ok)return t.json();throw new Error("fetch unsuccessful")}),s=fetch("https://7tv.io/v3/users/twitch/"+this.channelId).then(t=>{if(t.ok)return t.json();throw new Error("fetch unsuccessful")}),[r,n]=await Promise.allSettled([i,s]),o=[];n.status==="fulfilled"&&o.push(...n.value.emote_set.emotes),r.status==="fulfilled"&&o.push(...r.value.emotes),this.#e.size!==0&&this.#e.clear();for(let t of o){let c=t.data.name,l=`https:${t.data.host.url}`;if(!l.includes(this.#r)||(this.proxy&&(l=l.replace(this.#r,this.proxy)),e.length>0&&!e.includes(c)))continue;let f=`<img srcset="${t.data.host.files.filter(m=>m.format===this.#i).reduce((m,h)=>{let g=`${h.width}w`;return this.#a&&([g]=h.name.split(".")||""),`${l}/${h.name} ${g}, ${m}`},"")}" alt="${c}" style="height:${this.#t}" crossorigin/>`;this.#e.set(c,f)}this.total=this.#e.size,this.#n=!0}parse(e){if(!e)return console.log("no text to parse emotes"),"";if(!this.#n)return console.log("emotes are not ready"),e;if(this.#e.size===0)return console.log("no emotes loaded"),e;let i=e.split(" "),s="";for(let r=0;r<i.length;r++){let n=i[r];if(this.#s&&!n?.startsWith(":")){s+=n+" ";continue}let o=n?.replaceAll(":","")||"",t=this.#e.get(o);if(t){s+=t+" ";continue}s+=n+" "}return s.trim()}};export{u as EmotesJS};

package/package.json

@@ -1,32 +1,45 @@
 {
-  "name": "emotesjs",
-  "description": "Fast, dependency free, and responsive 7TV inline emotes parse",
-  "version": "0.0.27",
-  "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": {
-    "vitest": "^3.2.4"
-  },
-  "scripts": {
-    "test": "vitest run"
-  }
-}
+    "name": "emotesjs",
+    "description": "Fast, dependency free, and responsive 7TV inline emotes parse",
+    "version": "1.0.0",
+    "license": "MIT",
+    "author": {
+        "name": "darckfast"
+    },
+    "engines": {
+        "node": ">=22"
+    },
+    "files": [
+        "dist"
+    ],
+    "main": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "type": "module",
+    "exports": {
+        ".": {
+            "import": {
+                "types": "./dist/index.d.ts",
+                "default": "./dist/index.js"
+            }
+        }
+    },
+    "repository": {
+        "type": "git",
+        "url": "git://github.com/darckfast/emotesjs.git"
+    },
+    "keywords": [
+        "twitch",
+        "7tv",
+        "emotes",
+        "responsive"
+    ],
+    "scripts": {
+        "test": "vitest run",
+        "prepublishOnly": "npx tsup && npx terser ./dist/index.js -o ./dist/index.js"
+    },
+    "devDependencies": {
+        "tsup": "^8.5.1",
+        "typescript": "^6.0.3",
+        "vitest": "^3.2.4"
+    }
+}

package/index.js

@@ -1 +0,0 @@
-class EmotesJS{#cachedEmotes=new Map;#colon=true;#height="1.65rem";#format="WEBP";#allowedOrigins="https://cdn.7tv.app";#isReady=false;#usePixelDensity=false;total=0;channelId=0;isLoading=Promise.resolve();proxy="";static instance;constructor(opts){if(EmotesJS.instance&&EmotesJS.instance.channelId!==0){return EmotesJS.instance}let only;if(opts){only=opts.only;this.channelId=opts.channelId||0;this.#colon=Boolean(opts.colon);this.#height=opts.height||this.#height;this.#format=opts.format||this.#format;this.#usePixelDensity=Boolean(opts.usePixelDensity);if(opts.cache&&typeof opts.cache==="string"){this.#cachedEmotes=new Map(Object.entries(JSON.parse(opts.cache)));this.total=this.#cachedEmotes.size;this.#isReady=true}this.proxy=opts.proxy}this.isLoading=this.load(only);EmotesJS.instance=this}static fromCache(cache){return new EmotesJS({cache:cache})}cache(){return JSON.stringify(Object.fromEntries(this.#cachedEmotes.entries()))}async load(only=[]){let globalProm=fetch("https://7tv.io/v3/emote-sets/global").then(r=>{if(r.ok){return r.json()}throw new Error("fetch unsuccessful")});let chProm=fetch("https://7tv.io/v3/users/twitch/"+this.channelId).then(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)}if(this.#cachedEmotes.size!==0){this.#cachedEmotes.clear()}for(let emote of rawEmotes){let name=emote.data.name;let url=`https:${emote.data.host.url}`;if(!url.includes(this.#allowedOrigins)){continue}if(this.proxy){url=url.replace(this.#allowedOrigins,this.proxy)}if(only.length>0&&!only.includes(name)){continue}let files=emote.data.host.files.filter(x=>x.format===this.#format);let srcset=files.reduce((acc,curr)=>{let w=`${curr.width}w`;if(this.#usePixelDensity){[w]=curr.name.split(".")}return`${url}/${curr.name} ${w}, ${acc}`},"");let elementString=`<img srcset="${srcset}" alt="${name}" style="height:${this.#height}" crossorigin/>`;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""}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};