streamer-emotes 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ahmed Rangel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,16 @@
+# streamer-emotes
+A library to get Twitch, BTTV, FFZ and 7TV emotes for a given Twitch channel.
+
+## Usage
+
+```js
+import { getStreamerEmotes } from "streamer-emotes";
+
+const rubiusEmotes = await getStreamerEmotes("rubius", {
+  sevenTV: true, // Get 7TV emotes
+  twitch: { globals: false } // Get Twitch emotes but exclude global ones
+});
+
+console.log(rubiusEmotes);
+
+```

package/dist/index.d.mts

@@ -0,0 +1,43 @@
+//#region src/types/index.d.ts
+interface StreamerEmotesProps {
+  animated: boolean;
+  id: string;
+  images: {
+    url: string;
+    version: string;
+  }[];
+  name: string;
+  provider: "7tv" | "bttv" | "ffz" | "twitch";
+}
+interface StreamerEmotesProviderResponse {
+  channel: StreamerEmotesProps[];
+  global?: StreamerEmotesProps[];
+}
+//#endregion
+//#region src/index.d.ts
+/**
+ *
+ * @param channelLogin
+ * @param options.bttv Get emotes from BetterTTV if `true`. Defaults to `false`.
+ * @param options.ffz Get emotes from FrankerFaceZ if `true`. Defaults to `false`.
+ * @param options.sevenTV Get emotes from 7TV if `true`. Defaults to `false`.
+ * @param options.twitch Get emotes from Twitch if `true`. Defaults to `false`.
+ * @param options.globals Include global emotes in the response. Defaults to `true`.
+ * @returns
+ */
+declare const getStreamerEmotes: (channelLogin: string, options: {
+  bttv?: boolean | StreamerEmotesProviderOptions;
+  ffz?: boolean | StreamerEmotesProviderOptions;
+  sevenTV?: boolean | StreamerEmotesProviderOptions;
+  twitch?: boolean | StreamerEmotesProviderOptions;
+}) => Promise<{
+  bttv?: StreamerEmotesProviderResponse;
+  ffz?: StreamerEmotesProviderResponse;
+  sevenTV?: StreamerEmotesProviderResponse;
+  twitch?: StreamerEmotesProviderResponse;
+}>;
+interface StreamerEmotesProviderOptions {
+  globals: boolean;
+}
+//#endregion
+export { getStreamerEmotes };

package/dist/index.mjs

@@ -0,0 +1,288 @@
+import { $fetch } from "ofetch";
+import { gqlQuery } from "gql-payload";
+//#region src/utils/helpers.ts
+const providersURL = {
+	sevenTV: "https://7tv.io/v3",
+	bttv: "https://api.betterttv.net/3",
+	ffz: "https://api.frankerfacez.com/v1",
+	twitch: "https://gql.twitch.tv/gql"
+};
+let twitchIdMemory = {};
+const getTwitchIdByLogin = async (login) => {
+	login = login.toLowerCase();
+	if (twitchIdMemory[login]) return twitchIdMemory[login];
+	const { data } = await $fetch(providersURL.twitch, {
+		method: "POST",
+		headers: {
+			"Client-ID": "kimne78kx3ncx6brgo4mv6wki5h1ko",
+			"Content-Type": "application/json"
+		},
+		body: gqlQuery({
+			operation: "user",
+			variables: { login: {
+				value: login,
+				type: "String!"
+			} },
+			fields: ["id"]
+		})
+	});
+	const channelId = data?.user?.id;
+	if (!channelId) throw new Error(`Twitch channel with login '${login}' not found.`);
+	twitchIdMemory[login] = channelId;
+	return channelId;
+};
+//#endregion
+//#region src/providers/7tv.ts
+/**
+*
+* @param twitchLogin Twitch channel login.
+* @param {boolean} options.globals Include global Twitch emotes in the response. Defaults to `true`.
+* @returns
+*/
+const get7tvEmotes = async (channelLogin, options) => {
+	channelLogin = channelLogin.toLowerCase();
+	const { globals = true } = options ?? {};
+	const channelId = await getTwitchIdByLogin(channelLogin);
+	const channel = [];
+	const global = [];
+	const channelDataPromise = $fetch(`/users/twitch/${channelId}`, {
+		baseURL: providersURL.sevenTV,
+		method: "GET"
+	});
+	let globalDataPromise;
+	if (globals) globalDataPromise = $fetch("/emote-sets/global", {
+		baseURL: providersURL.sevenTV,
+		method: "GET"
+	});
+	const [channelData, globalData] = await Promise.all([channelDataPromise, globalDataPromise]);
+	channel.push(...channelData.emote_set.emotes);
+	if (globalData) global.push(...globalData.emotes);
+	const normalizeData = (data) => {
+		if (!data?.length) return [];
+		return data.map((emote) => {
+			const images = emote.data.host.files.map((file) => ({
+				url: `https:${emote.data.host.url}/${file.name}`,
+				version: file.name
+			}));
+			return {
+				animated: emote.data?.animated || false,
+				id: emote.id,
+				images,
+				name: emote.name,
+				provider: "7tv"
+			};
+		});
+	};
+	return {
+		channel: normalizeData(channel),
+		...globals && { global: normalizeData(global) }
+	};
+};
+//#endregion
+//#region src/providers/bttv.ts
+/**
+*
+* @param twitchLogin Twitch channel login.
+* @param {boolean} options.globals Include global Twitch emotes in the response. Defaults to `true`.
+* @returns
+*/
+const getBttvEmotes = async (channelLogin, options) => {
+	channelLogin = channelLogin.toLowerCase();
+	const { globals = true } = options ?? {};
+	const channelId = await getTwitchIdByLogin(channelLogin);
+	const channel = [];
+	const global = [];
+	const channelDataPromise = $fetch(`/cached/users/twitch/${channelId}`, {
+		baseURL: providersURL.bttv,
+		method: "GET"
+	});
+	let globalDataPromise;
+	if (globals) globalDataPromise = $fetch("/cached/emotes/global", {
+		baseURL: providersURL.bttv,
+		method: "GET"
+	});
+	const [channelData, globalData] = await Promise.all([channelDataPromise, globalDataPromise]);
+	channel.push(...channelData.channelEmotes, ...channelData.sharedEmotes);
+	if (globalData) global.push(...globalData);
+	const normalizeData = (data) => {
+		if (!data?.length) return [];
+		return data.map((emote) => ({
+			animated: emote.animated,
+			id: emote.id,
+			images: [
+				{
+					url: `https://cdn.betterttv.net/emote/${emote.id}/1x`,
+					version: "1x"
+				},
+				{
+					url: `https://cdn.betterttv.net/emote/${emote.id}/2x`,
+					version: "2x"
+				},
+				{
+					url: `https://cdn.betterttv.net/emote/${emote.id}/3x`,
+					version: "3x"
+				}
+			],
+			name: emote.code,
+			provider: "bttv"
+		}));
+	};
+	return {
+		channel: normalizeData(channel),
+		...globals && { global: normalizeData(global) }
+	};
+};
+//#endregion
+//#region src/providers/ffz.ts
+/**
+*
+* @param twitchLogin Twitch channel login.
+* @param {boolean} options.globals Include global Twitch emotes in the response. Defaults to `true`.
+* @returns
+*/
+const getFfzEmotes = async (channelLogin, options) => {
+	channelLogin = channelLogin.toLowerCase();
+	const { globals = true } = options ?? {};
+	const channelId = await getTwitchIdByLogin(channelLogin);
+	const channel = [];
+	const global = [];
+	const channelDataPromise = $fetch(`/room/id/${channelId}`, {
+		baseURL: providersURL.ffz,
+		method: "GET"
+	});
+	let globalDataPromise;
+	if (globals) globalDataPromise = $fetch("/set/global", {
+		baseURL: providersURL.ffz,
+		method: "GET"
+	});
+	const [channelData, globalData] = await Promise.all([channelDataPromise, globalDataPromise]);
+	channel.push(...channelData.sets[channelData.room.set].emoticons);
+	if (globalData) global.push(...globalData.default_sets.flatMap((setId) => globalData.sets[setId].emoticons));
+	const normalizeData = (data) => {
+		if (!data?.length) return [];
+		return data.map((emote) => {
+			const images = Object.keys(emote.urls).map((key) => ({
+				url: emote.urls[key],
+				version: key
+			}));
+			return {
+				animated: false,
+				id: emote.id,
+				images,
+				name: emote.name,
+				provider: "ffz"
+			};
+		});
+	};
+	return {
+		channel: normalizeData(channel),
+		...globals && { global: normalizeData(global) }
+	};
+};
+//#endregion
+//#region src/providers/twitch.ts
+/**
+*
+* @param twitchLogin Twitch channel login.
+* @param {boolean} options.globals Include global Twitch emotes in the response. Defaults to `true`.
+* @returns
+*/
+const getTwitchEmotes = async (channelLogin, options) => {
+	channelLogin = channelLogin.toLowerCase();
+	const { globals = true } = options ?? {};
+	const emotesFields = [
+		"id",
+		"token",
+		"assetType"
+	];
+	const globalQuery = {
+		operation: "emoteSet",
+		variables: { id: {
+			value: "0",
+			type: "ID!"
+		} },
+		fields: [{ emotes: emotesFields }]
+	};
+	const channelQuery = {
+		operation: "subscriptionProduct",
+		variables: { productName: {
+			value: channelLogin,
+			type: "String!"
+		} },
+		fields: [{ emotes: emotesFields }]
+	};
+	const toQuery = [];
+	if (globals) toQuery.push(globalQuery);
+	toQuery.push(channelQuery);
+	const { data } = await $fetch(providersURL.twitch, {
+		method: "POST",
+		headers: {
+			"Client-ID": "kimne78kx3ncx6brgo4mv6wki5h1ko",
+			"Content-Type": "application/json"
+		},
+		body: gqlQuery(toQuery)
+	});
+	const normalizeData = (data) => {
+		if (!data?.length) return [];
+		return data.map((emote) => ({
+			animated: emote.assetType === "ANIMATED",
+			id: emote.id,
+			images: [
+				{
+					url: `https://static-cdn.jtvnw.net/emoticons/v1/${emote.id}/1.0`,
+					version: "1.0"
+				},
+				{
+					url: `https://static-cdn.jtvnw.net/emoticons/v1/${emote.id}/2.0`,
+					version: "2.0"
+				},
+				{
+					url: `https://static-cdn.jtvnw.net/emoticons/v1/${emote.id}/3.0`,
+					version: "3.0"
+				}
+			],
+			name: emote.token,
+			provider: "twitch"
+		}));
+	};
+	return {
+		channel: normalizeData(data?.subscriptionProduct?.emotes),
+		...globals && { global: normalizeData(data?.emoteSet?.emotes) }
+	};
+};
+//#endregion
+//#region src/index.ts
+/**
+*
+* @param channelLogin
+* @param options.bttv Get emotes from BetterTTV if `true`. Defaults to `false`.
+* @param options.ffz Get emotes from FrankerFaceZ if `true`. Defaults to `false`.
+* @param options.sevenTV Get emotes from 7TV if `true`. Defaults to `false`.
+* @param options.twitch Get emotes from Twitch if `true`. Defaults to `false`.
+* @param options.globals Include global emotes in the response. Defaults to `true`.
+* @returns
+*/
+const getStreamerEmotes = async (channelLogin, options) => {
+	if (!Object.keys(options).length) throw new Error("At least one provider must be enabled");
+	const { bttv, ffz, sevenTV, twitch } = options;
+	const data = {};
+	let bttvPromise, ffzPromise, sevenTvPromise, twitchPromise;
+	if (bttv || ffz || sevenTV) await getTwitchIdByLogin(channelLogin);
+	if (bttv) bttvPromise = getBttvEmotes(channelLogin, { globals: typeof bttv === "boolean" ? true : bttv?.globals });
+	if (ffz) ffzPromise = getFfzEmotes(channelLogin, { globals: typeof ffz === "boolean" ? true : ffz?.globals });
+	if (sevenTV) sevenTvPromise = get7tvEmotes(channelLogin, { globals: typeof sevenTV === "boolean" ? true : sevenTV?.globals });
+	if (twitch) twitchPromise = getTwitchEmotes(channelLogin, { globals: typeof twitch === "boolean" ? true : twitch?.globals });
+	const [bttvEmotes, ffzEmotes, sevenTvEmotes, twitchEmotes] = await Promise.all([
+		bttvPromise,
+		ffzPromise,
+		sevenTvPromise,
+		twitchPromise
+	]);
+	if (bttv) data.bttv = bttvEmotes;
+	if (ffz) data.ffz = ffzEmotes;
+	if (sevenTV) data.sevenTV = sevenTvEmotes;
+	if (twitch) data.twitch = twitchEmotes;
+	return data;
+};
+//#endregion
+export { getStreamerEmotes };

package/package.json

@@ -0,0 +1,58 @@
+{
+	"name": "streamer-emotes",
+	"type": "module",
+	"version": "0.0.1",
+	"description": "A library to get Twitch, BTTV, FFZ and 7TV emotes for a given Twitch channel.",
+	"keywords": [
+		"streamer",
+		"emotes",
+		"twitch",
+		"bttv",
+		"ffz",
+		"7tv"
+	],
+	"license": "MIT",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/ahmedrangel/streamer-emotes.git"
+	},
+	"homepage": "https://github.com/ahmedrangel/streamer-emotes",
+	"author": {
+		"name": "Ahmed Rangel",
+		"email": "ahmedrangel@outlook.com",
+		"url": "https://ahmedrangel.com"
+	},
+	"scripts": {
+		"build": "obuild",
+		"dev": "node playground/index.ts",
+		"lint": "eslint",
+		"test:types": "tsc --noEmit"
+	},
+	"main": "./dist/index.mjs",
+	"exports": {
+		".": {
+			"types": "./dist/index.d.mts",
+			"default": "./dist/index.mjs"
+		}
+	},
+	"files": [
+		"dist"
+	],
+	"dependencies": {
+		"gql-payload": "^2.1.0",
+		"ofetch": "^2.0.0-alpha.3"
+	},
+	"devDependencies": {
+		"@eslint/compat": "^2.0.3",
+		"@stylistic/eslint-plugin": "^5.10.0",
+		"@types/node": "^25.5.0",
+		"@typescript-eslint/eslint-plugin": "^8.57.0",
+		"@typescript-eslint/parser": "^8.57.0",
+		"changelogen": "^0.6.2",
+		"eslint": "^10.0.3",
+		"eslint-plugin-import-x": "^4.16.2",
+		"obuild": "^0.4.32",
+		"typescript": "^5.9.3"
+	},
+	"packageManager": "pnpm@10.32.1"
+}