@tixyel/streamelements 7.0.4 → 7.1.0

package/dist/index.d.ts

@@ -2414,15 +2414,28 @@ declare class ElementHelper {
      * Adds 'container' class and data-index to all parent elements, and wraps each character in a span with class 'char' and data-index.
      * @param htmlString - The input HTML string containing formatted text elements (span, strong, em, etc).
      * @param startIndex - The starting index for the data-index attribute (default is 0).
+     * @param preserveInterElementWhitespace - Whether to preserve whitespace between elements (default is false).
+     * @param options - Optional settings for splitting text, including skipWhitespaceIndex to control index incrementing for whitespace characters.
      * @returns - A new HTML string with containers and character-level indexing.
      * @example
      * ```javascript
      * const result = splitTextToChars('<span>TesTe</span> <strong>bold</strong>', 0);
      * console.log(result);
      * // Output: '<span class="container" data-index="0"><span class="char" data-index="0">T</span><span class="char" data-index="1">e</span>...'
+     *
+     * // Example with skipWhitespaceIndex
+     * const resultSkipWhitespace = splitTextToChars('<span>Hello World</span>', 0, false, { skipWhitespaceIndex: true });
+     * // The space character will have data-index but won't increment index for subsequent characters
      * ```
      */
-    splitTextToChars(htmlString: string, startIndex?: number, preserveInterElementWhitespace?: boolean): string;
+    splitTextToChars(htmlString: string, startIndex?: number, preserveInterElementWhitespace?: boolean, options?: {
+        /**
+         * If true, skips incrementing the index for whitespace characters (space, newline, tab).
+         * These characters will still have a data-index, but it won't be incremented for subsequent characters.
+         * Default is true.
+         */
+        skipWhitespaceIndex?: boolean;
+    }): string;
 }
 
 declare class ObjectHelper {
@@ -2986,7 +2999,7 @@ declare class UtilsHelper {
         userId: string;
         name: string;
         broadcasterId?: string;
-    }, session: StreamElements.Session.Data, checkWithAPI?: boolean): Promise<3 | 1 | 2>;
+    }, session: StreamElements.Session.Data, checkWithAPI?: boolean): Promise<1 | 2 | 3>;
     /**
      * Identifies a user based on the received event and session data, returning their ID, name, role, badges, and top status.
      * @param receivedEvent - The event received from the provider (Twitch or YouTube) containing user information.
@@ -3015,7 +3028,8 @@ declare class UtilsHelper {
      * // }
      * ```
      */
-    identifyUser(receivedEvent: StreamElements.Event.Provider.Twitch.Message | StreamElements.Event.Provider.YouTube.Message, session: StreamElements.Session.Data): Promise<IdentifyYouTubeResult | IdentifyTwitchResult | undefined>;
+    identifyUser(provider: 'twitch', receivedEvent: StreamElements.Event.Provider.Twitch.Message, session: StreamElements.Session.Data): Promise<IdentifyTwitchResult | undefined>;
+    identifyUser(provider: 'youtube', receivedEvent: StreamElements.Event.Provider.YouTube.Message, session: StreamElements.Session.Data): Promise<IdentifyYouTubeResult | undefined>;
 }
 type TopType = {
     gifter: boolean;

package/dist/index.es.js

@@ -289,33 +289,35 @@ var e = class {
 		let s = r * (o.clientWidth * t / e.offsetWidth), c = new i().balance(s, a.minFontSize, a.maxFontSize);
 		return e.style.fontSize = c + "px", e;
 	}
-	splitTextToChars(e, t = 0, n = !1) {
-		let r = new DOMParser(), i = document.createElement("div"), a = t;
-		function o(e) {
+	splitTextToChars(e, t = 0, n = !1, r = {}) {
+		let { skipWhitespaceIndex: i = !0 } = r, a = new DOMParser(), o = document.createElement("div"), s = t;
+		function c(e) {
 			if (e.nodeType === Node.TEXT_NODE) {
-				let t = (e.textContent || "").split("").map((e, t) => {
-					let n = document.createElement("span");
-					return n.classList.add("char"), n.dataset.index = String(a), n.dataset.exclusivityIndex = String(t), n.style.setProperty("--char-index", String(a)), n.style.setProperty("--exclusivity-index", String(t)), e === " " || e === "\n" || e === "	" ? n.style.whiteSpace = "pre-wrap" : a++, n.textContent = e, n;
-				}), n = document.createDocumentFragment();
-				return t.forEach((e) => n.appendChild(e)), n;
+				let t = e.textContent || "", n = 0, r = t.split("").map((e) => {
+					let t = document.createElement("span");
+					t.classList.add("char"), t.dataset.index = String(s), t.dataset.exclusivityIndex = String(n), t.dataset.type = "char", t.style.setProperty("--char-index", String(s)), t.style.setProperty("--exclusivity-index", String(n));
+					let r = e === " " || e === "\n" || e === "	";
+					return r && (t.style.whiteSpace = "pre-wrap", t.classList.remove("char"), t.classList.add("whitespace"), t.dataset.type = "whitespace"), (!r || !i) && (s++, n++), t.textContent = e, t;
+				}), a = document.createDocumentFragment();
+				return r.forEach((e) => a.appendChild(e)), a;
 			} else if (e.nodeType === Node.ELEMENT_NODE) {
 				let t = e.cloneNode(!1);
-				return t.classList.add("container"), t.dataset.index = String(a), t.style.setProperty("--char-index", String(a)), t.style.setProperty("--exclusivity-index", String(a)), a++, e.childNodes.forEach((e) => {
-					let n = o(e);
+				return t.classList.add("container"), t.dataset.index = String(s), t.dataset.type = "container", t.style.setProperty("--char-index", String(s)), t.style.setProperty("--exclusivity-index", String(s)), s++, e.childNodes.forEach((e) => {
+					let n = c(e);
 					t.appendChild(n);
 				}), t;
 			}
 			return e.cloneNode(!0);
 		}
-		r.parseFromString(e, "text/html").body.childNodes.forEach((e) => {
+		a.parseFromString(e, "text/html").body.childNodes.forEach((e) => {
 			if (!n && e.nodeType === Node.TEXT_NODE && !e.textContent?.trim()) return;
-			let t = o(e);
-			i.appendChild(t);
+			let t = c(e);
+			o.appendChild(t);
 		});
-		let s = "";
-		return Array.from(i.childNodes).forEach((e) => {
-			e.nodeType === Node.TEXT_NODE ? s += e.textContent : s += e.outerHTML;
-		}), s;
+		let l = "";
+		return Array.from(o.childNodes).forEach((e) => {
+			e.nodeType === Node.TEXT_NODE ? l += e.textContent : l += e.outerHTML;
+		}), l;
 	}
 }, o = class {
 	flatten(e, t = !0, n = "") {
@@ -10254,11 +10256,7 @@ var M = class {
 				continue;
 			}
 			n.length < c && this.emit("warn", /* @__PURE__ */ Error(`User "${e}" could only receive ${n.length} badge(s), below the configured minimum of ${c}`));
-			let i = o.length + 1, a = n.some((e) => [
-				"subscriber",
-				"prime",
-				"founder"
-			].includes(String(e).toLocaleLowerCase())), s = new I(`fake_user_${i.toString().padStart(2, "0")}_${Math.random().toString(36).slice(2, 8)}+${this.id}`, e, n, a, a ? t.getRandomSubTier() : void 0);
+			let i = o.length + 1, a = n.some((e) => ["subscriber"].includes(String(e).toLocaleLowerCase())), s = new I(`fake_user_${i.toString().padStart(2, "0")}_${Math.random().toString(36).slice(2, 8)}+${this.id}`, e, n, a, a ? t.getRandomSubTier() : void 0);
 			o.push(s);
 		}
 		return o.length < i.length && this.emit("warn", /* @__PURE__ */ Error("Some users could not be assigned badges due to limits. Consider increasing limits or adding more badges.")), o;
@@ -10388,100 +10386,92 @@ var M = class {
 		}
 		return 1;
 	}
-	async identifyUser(e, t) {
-		let n = new D().parseProvider(e), r = (e) => ({
-			gifter: t["subscriber-alltime-gifter"].name === e,
+	async identifyUser(e, t, n) {
+		let r = (e) => ({
+			gifter: n["subscriber-alltime-gifter"].name === e,
 			tip: {
 				session: {
-					donator: t["tip-session-top-donator"].name === e,
-					donation: t["tip-session-top-donation"].name === e
+					donator: n["tip-session-top-donator"].name === e,
+					donation: n["tip-session-top-donation"].name === e
 				},
 				weekly: {
-					donator: t["tip-weekly-top-donator"].name === e,
-					donation: t["tip-weekly-top-donation"].name === e
+					donator: n["tip-weekly-top-donator"].name === e,
+					donation: n["tip-weekly-top-donation"].name === e
 				},
 				monthly: {
-					donator: t["tip-monthly-top-donator"].name === e,
-					donation: t["tip-monthly-top-donation"].name === e
+					donator: n["tip-monthly-top-donator"].name === e,
+					donation: n["tip-monthly-top-donation"].name === e
 				},
 				alltime: {
-					donator: t["tip-alltime-top-donator"].name === e,
-					donation: t["tip-alltime-top-donation"].name === e
+					donator: n["tip-alltime-top-donator"].name === e,
+					donation: n["tip-alltime-top-donation"].name === e
 				}
 			},
 			cheer: {
 				session: {
-					donator: t["cheer-session-top-donator"].name === e,
-					amount: t["cheer-session-top-donation"].name === e
+					donator: n["cheer-session-top-donator"].name === e,
+					amount: n["cheer-session-top-donation"].name === e
 				},
 				weekly: {
-					donator: t["cheer-weekly-top-donator"].name === e,
-					amount: t["cheer-weekly-top-donation"].name === e
+					donator: n["cheer-weekly-top-donator"].name === e,
+					amount: n["cheer-weekly-top-donation"].name === e
 				},
 				monthly: {
-					donator: t["cheer-monthly-top-donator"].name === e,
-					amount: t["cheer-monthly-top-donation"].name === e
+					donator: n["cheer-monthly-top-donator"].name === e,
+					amount: n["cheer-monthly-top-donation"].name === e
 				},
 				alltime: {
-					donator: t["cheer-alltime-top-donator"].name === e,
-					amount: t["cheer-alltime-top-donation"].name === e
+					donator: n["cheer-alltime-top-donator"].name === e,
+					amount: n["cheer-alltime-top-donation"].name === e
 				}
 			},
 			superchat: {
 				session: {
-					donator: t["superchat-session-top-donator"].name === e,
-					amount: t["superchat-session-top-donation"].name === e
+					donator: n["superchat-session-top-donator"].name === e,
+					amount: n["superchat-session-top-donation"].name === e
 				},
 				weekly: {
-					donator: t["superchat-weekly-top-donator"].name === e,
-					amount: t["superchat-weekly-top-donation"].name === e
+					donator: n["superchat-weekly-top-donator"].name === e,
+					amount: n["superchat-weekly-top-donation"].name === e
 				},
 				monthly: {
-					donator: t["superchat-monthly-top-donator"].name === e,
-					amount: t["superchat-monthly-top-donation"].name === e
+					donator: n["superchat-monthly-top-donator"].name === e,
+					amount: n["superchat-monthly-top-donation"].name === e
 				},
 				alltime: {
-					donator: t["superchat-alltime-top-donator"].name === e,
-					amount: t["superchat-alltime-top-donation"].name === e
+					donator: n["superchat-alltime-top-donator"].name === e,
+					amount: n["superchat-alltime-top-donation"].name === e
 				}
 			}
 		});
-		switch (n.provider) {
-			case "twitch":
-				switch (n.data.listener) {
-					case "message": {
-						let e = n.data.event.data, i = await this.findSubscriptionTier({
-							userId: e.userId,
-							name: e.displayName,
-							broadcasterId: e.tags["room-id"]
-						}, t ?? {}, !1);
-						return {
-							id: e.userId,
-							name: e.displayName,
-							color: e.displayColor,
-							role: e.tags.badges.split(",")[0].split("/")[0],
-							tags: e.tags.badges.split(",").map((e) => e.split("/")[0]),
-							badges: e.badges,
-							tier: e.tags.badges.includes("subscriber") ? i : void 0,
-							top: r(e.displayName)
-						};
-					}
-				}
-				break;
-			case "youtube":
-				switch (n.data.listener) {
-					case "message": {
-						let e = n.data.event.data, t = e.authorDetails.isChatOwner ? "broadcaster" : e.authorDetails.isChatModerator ? "moderator" : e.authorDetails.isChatSponsor ? "sponsor" : e.authorDetails.isVerified ? "verified" : "viewer";
-						return {
-							id: e.userId,
-							name: e.displayName,
-							role: t,
-							badges: e.badges,
-							top: r(e.displayName)
-						};
-					}
-				}
-				break;
+		switch (e) {
+			case "twitch": {
+				let e = t.event.data, i = await this.findSubscriptionTier({
+					userId: e.userId,
+					name: e.displayName,
+					broadcasterId: e.tags["room-id"]
+				}, n ?? {}, !1);
+				return {
+					id: e.userId,
+					name: e.displayName,
+					color: e.displayColor,
+					role: e.tags.badges.split(",")[0].split("/")[0],
+					tags: e.tags.badges.split(",").map((e) => e.split("/")[0]),
+					badges: e.badges,
+					tier: e.tags.badges.includes("subscriber") ? i : void 0,
+					top: r(e.displayName)
+				};
+			}
+			case "youtube": {
+				let e = t.event.data, n = e.authorDetails.isChatOwner ? "broadcaster" : e.authorDetails.isChatModerator ? "moderator" : e.authorDetails.isChatSponsor ? "sponsor" : e.authorDetails.isVerified ? "verified" : "viewer";
+				return {
+					id: e.userId,
+					name: e.displayName,
+					role: n,
+					badges: e.badges,
+					top: r(e.displayName)
+				};
+			}
 		}
 	}
 }, B;