streamer-emotes 0.0.5 → 0.1.1

package/README.md

@@ -1,4 +1,8 @@
 # streamer-emotes
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+
 A library to get Twitch, BTTV, FFZ and 7TV emotes for a given Twitch channel.
 
 ## Usage
@@ -6,11 +10,56 @@ A library to get Twitch, BTTV, FFZ and 7TV emotes for a given Twitch channel.
 ```js
 import { getStreamerEmotes } from "streamer-emotes";
 
-const rubiusEmotes = await getStreamerEmotes("rubius", {
+const emotes = await getStreamerEmotes("rubius", {
+  bttv: true, // Get BTTV emotes
+  ffz: true, // Get FFZ emotes
   sevenTV: true, // Get 7TV emotes
   twitch: { globals: false } // Get Twitch emotes but exclude global ones
 });
 
-console.log(rubiusEmotes);
+console.info(emotes);
+```
 
+## Output example
+```jsonc
+{
+  "<provider>": { // Provider prop
+    "channel": [ // Channel Emotes
+      {
+        "animated": true,
+        "id": "string",
+        "images": [
+          {
+            "url": "string",
+            "version": "string"
+          }
+        ],
+        "name": "string",
+        "provider": "string",
+        "zeroWidth": true // 7TV zero width emotes only
+      }
+    ],
+    "global": [ // Global Emotes
+      {
+        "animated": false,
+        "id": "string",
+        "images": [
+          {
+            "url": "string",
+            "version": "string"
+          }
+        ],
+        "name": "string",
+        "provider": "string",
+      }
+    ]
+  }
+}
 ```
+
+<!-- Badges -->
+[npm-version-src]: https://img.shields.io/npm/v/streamer-emotes.svg?style=flat
+[npm-version-href]: https://npmjs.com/package/streamer-emotes
+
+[npm-downloads-src]: https://img.shields.io/npm/dm/streamer-emotes.svg?style=flat
+[npm-downloads-href]: https://npmjs.com/package/streamer-emotes

package/dist/index.d.mts

@@ -1,5 +1,5 @@
 //#region src/types/index.d.ts
-interface StreamerEmotesProps {
+interface StreamerEmotesProps<T> {
   animated: boolean;
   id: string;
   images: {
@@ -7,17 +7,18 @@ interface StreamerEmotesProps {
     version: string;
   }[];
   name: string;
-  provider: "7tv" | "bttv" | "ffz" | "twitch";
+  provider: T;
+  zeroWidth?: boolean;
 }
-interface StreamerEmotesProviderResponse {
-  channel: StreamerEmotesProps[];
-  global?: StreamerEmotesProps[];
+interface StreamerEmotesProviderResponse<T> {
+  channel: StreamerEmotesProps<T>[];
+  global?: StreamerEmotesProps<T>[];
 }
 //#endregion
 //#region src/index.d.ts
 /**
  *
- * @param channelLogin
+ * @param channelLogin Twitch channel login.
  * @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`.
@@ -31,10 +32,10 @@ declare const getStreamerEmotes: (channelLogin: string, options: {
   sevenTV?: boolean | StreamerEmotesProviderOptions;
   twitch?: boolean | StreamerEmotesProviderOptions;
 }) => Promise<{
-  bttv?: StreamerEmotesProviderResponse;
-  ffz?: StreamerEmotesProviderResponse;
-  sevenTV?: StreamerEmotesProviderResponse;
-  twitch?: StreamerEmotesProviderResponse;
+  bttv?: StreamerEmotesProviderResponse<"bttv">;
+  ffz?: StreamerEmotesProviderResponse<"ffz">;
+  sevenTV?: StreamerEmotesProviderResponse<"7tv">;
+  twitch?: StreamerEmotesProviderResponse<"twitch">;
 }>;
 interface StreamerEmotesProviderOptions {
   globals: boolean;

package/dist/index.mjs

@@ -69,7 +69,8 @@ const get7tvEmotes = async (channelLogin, options) => {
 				id: emote.id,
 				images,
 				name: emote.name,
-				provider: "7tv"
+				provider: "7tv",
+				zeroWidth: emote.flags === 1 && emote.data.flags === 256
 			};
 		});
 	};
@@ -265,7 +266,7 @@ const getTwitchEmotes = async (channelLogin, options) => {
 //#region src/index.ts
 /**
 *
-* @param channelLogin
+* @param channelLogin Twitch channel login.
 * @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`.
@@ -278,11 +279,11 @@ const getStreamerEmotes = async (channelLogin, options) => {
 	const { bttv, ffz, sevenTV, twitch } = options;
 	const data = {};
 	let bttvPromise, ffzPromise, sevenTvPromise, twitchPromise;
-	if (bttv || ffz || sevenTV || twitch) await getTwitchIdByLogin(channelLogin);
 	if (bttv) bttvPromise = getBttvEmotes(channelLogin, { globals: typeof bttv === "boolean" ? true : bttv?.globals ?? true }).catch(() => null);
 	if (ffz) ffzPromise = getFfzEmotes(channelLogin, { globals: typeof ffz === "boolean" ? true : ffz?.globals ?? true }).catch(() => null);
 	if (sevenTV) sevenTvPromise = get7tvEmotes(channelLogin, { globals: typeof sevenTV === "boolean" ? true : sevenTV?.globals ?? true }).catch(() => null);
 	if (twitch) twitchPromise = getTwitchEmotes(channelLogin, { globals: typeof twitch === "boolean" ? true : twitch?.globals ?? true }).catch(() => null);
+	await getTwitchIdByLogin(channelLogin);
 	const [bttvEmotes, ffzEmotes, sevenTvEmotes, twitchEmotes] = await Promise.all([
 		bttvPromise,
 		ffzPromise,

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "streamer-emotes",
 	"type": "module",
-	"version": "0.0.5",
+	"version": "0.1.1",
 	"description": "A library to get Twitch, BTTV, FFZ and 7TV emotes for a given Twitch channel.",
 	"keywords": [
 		"streamer",
@@ -55,4 +55,4 @@
 		"typescript": "^5.9.3"
 	},
 	"packageManager": "pnpm@10.32.1"
-}
+}