@allior/wmake-streamelements-events 2.0.1 → 2.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@allior/wmake-streamelements-events",
-	"version": "2.0.1",
+	"version": "2.0.3",
 	"description": "Twitch/StreamElements subscription event normalizer for widgets (alerts).",
 	"type": "module",
 	"types": "./dist/root/index.d.ts",
@@ -13,12 +13,10 @@
 		"./react": {
 			"types": "./dist/react/index.d.ts",
 			"import": "./dist/react/index.js"
-		},
-		"./src/*": "./src/*"
+		}
 	},
 	"files": [
 		"dist",
-		"src",
 		"README.md"
 	],
 	"scripts": {

package/src/react/hooks/index.ts

@@ -1,3 +0,0 @@
-export * from "./use-event-listener.js";
-export * from "./use-on-event-received.js";
-export * from "./use-on-widget-load.js";

package/src/react/hooks/use-event-listener.ts

@@ -1,20 +0,0 @@
-import { type DependencyList, useEffect, useRef } from "react";
-import type {
-	WindowEventKey,
-	WindowEventListener,
-} from "../types/window-events.js";
-
-export function useEventListener<K extends WindowEventKey>(
-	eventName: K,
-	handler: WindowEventListener<K>,
-	deps: DependencyList = [],
-): void {
-	const callbackRef = useRef<WindowEventListener<K>>(handler);
-	callbackRef.current = handler;
-
-	useEffect(() => {
-		const fn = (ev: WindowEventMap[K]) => callbackRef.current.call(window, ev);
-		window.addEventListener(eventName, fn);
-		return () => window.removeEventListener(eventName, fn);
-	}, [eventName, ...deps]);
-}

package/src/react/hooks/use-on-event-received.ts

@@ -1,108 +0,0 @@
-import type { DependencyList } from "react";
-import {
-	isCheerDetail,
-	isCommunityGiftPurchaseDetail,
-	isDeleteMessageDetail,
-	isDeleteMessagesDetail,
-	isDonationDetail,
-	isFollowerDetail,
-	isRaidDetail,
-	isSubscriberDetail,
-	isSubscriberLatestDetail,
-	isTwitchMessageEvent,
-	isWidgetButtonDetail,
-} from "@/root/guards";
-import type {
-	CheerDetail,
-	CommunityGiftPurchaseDetail,
-	DeleteMessageDetail,
-	DeleteMessagesDetail,
-	DonationDetail,
-	FollowerDetail,
-	MinimalEvent,
-	RaidDetail,
-	SubscriberDetail,
-	SubscriberLatestDetail,
-	TwitchMessageDetail,
-	WidgetButtonDetail,
-} from "@/root/types/on-event-received";
-import type { WindowEventListener } from "../types/window-events";
-import { useEventListener } from "./use-event-listener";
-
-function useOnEvent<T extends MinimalEvent>(
-	guard: (d: unknown) => d is T,
-	handler: (ev: CustomEvent<T>) => void,
-	deps: DependencyList = [],
-) {
-	useEventListener(
-		"onEventReceived",
-		(ev) => {
-			if (guard(ev.detail)) handler(ev as CustomEvent<T>);
-		},
-		deps,
-	);
-}
-
-export function useOnEventReceived(
-	handler: WindowEventListener<"onEventReceived">,
-	deps: DependencyList = [],
-): void {
-	useEventListener("onEventReceived", handler, deps);
-}
-
-export const useOnTwitchMessageReceived = (
-	handler: (ev: CustomEvent<TwitchMessageDetail>) => void,
-	deps?: DependencyList,
-) => useOnEvent(isTwitchMessageEvent, handler, deps);
-
-export const useOnMessageReceived = useOnTwitchMessageReceived;
-
-export const useOnWidgetButtonReceived = (
-	handler: (ev: CustomEvent<WidgetButtonDetail>) => void,
-	deps?: DependencyList,
-) => useOnEvent(isWidgetButtonDetail, handler, deps);
-
-export const useOnFollowerReceived = (
-	handler: (ev: CustomEvent<FollowerDetail>) => void,
-	deps?: DependencyList,
-) => useOnEvent(isFollowerDetail, handler, deps);
-
-export const useOnCommunityGiftPurchaseReceived = (
-	handler: (ev: CustomEvent<CommunityGiftPurchaseDetail>) => void,
-	deps?: DependencyList,
-) => useOnEvent(isCommunityGiftPurchaseDetail, handler, deps);
-
-export const useOnSubscriberLatestReceived = (
-	handler: (ev: CustomEvent<SubscriberLatestDetail>) => void,
-	deps?: DependencyList,
-) => useOnEvent(isSubscriberLatestDetail, handler, deps);
-
-export const useOnSubscriberReceived = (
-	handler: (ev: CustomEvent<SubscriberDetail>) => void,
-	deps?: DependencyList,
-) => useOnEvent(isSubscriberDetail, handler, deps);
-
-export const useOnCheerReceived = (
-	handler: (ev: CustomEvent<CheerDetail>) => void,
-	deps?: DependencyList,
-) => useOnEvent(isCheerDetail, handler, deps);
-
-export const useOnRaidReceived = (
-	handler: (ev: CustomEvent<RaidDetail>) => void,
-	deps?: DependencyList,
-) => useOnEvent(isRaidDetail, handler, deps);
-
-export const useOnDonationReceived = (
-	handler: (ev: CustomEvent<DonationDetail>) => void,
-	deps?: DependencyList,
-) => useOnEvent(isDonationDetail, handler, deps);
-
-export const useOnDeleteMessage = (
-	handler: (ev: CustomEvent<DeleteMessageDetail>) => void,
-	deps?: DependencyList,
-) => useOnEvent(isDeleteMessageDetail, handler, deps);
-
-export const useOnDeleteMessages = (
-	handler: (ev: CustomEvent<DeleteMessagesDetail>) => void,
-	deps?: DependencyList,
-) => useOnEvent(isDeleteMessagesDetail, handler, deps);

package/src/react/hooks/use-on-widget-load.ts

@@ -1,15 +0,0 @@
-import type { DependencyList } from "react";
-import type { WindowEventListener } from "@/react/types/window-events.js";
-import type { OnWidgetLoadEventDetails } from "@/root/types/on-widget-load";
-import { useEventListener } from "./use-event-listener.js";
-
-export function useOnWidgetLoad<FieldData = unknown>(
-	handler: (ev: CustomEvent<OnWidgetLoadEventDetails<FieldData>>) => void,
-	deps: DependencyList = [],
-): void {
-	useEventListener(
-		"onWidgetLoad",
-		handler as WindowEventListener<"onWidgetLoad">,
-		deps,
-	);
-}

package/src/react/index.ts

@@ -1,3 +0,0 @@
-export * from "../root";
-export * from "./hooks";
-export * from "./types";

package/src/react/types/index.ts

@@ -1 +0,0 @@
-export * from "./window-events";

package/src/react/types/window-events.ts

@@ -1,6 +0,0 @@
-export type WindowEventKey = keyof WindowEventMap;
-
-export type WindowEventListener<K extends WindowEventKey> = (
-	this: Window,
-	ev: WindowEventMap[K],
-) => unknown;

package/src/root/aggregate.ts

@@ -1,257 +0,0 @@
-/**
- * Event normalizer — aggregate mode: buffer events by activityGroup,
- * merge into one normalized event per action (timeout 2.5s).
- */
-
-import { classifyEvent, getCacheKey } from "./classifier.js";
-import type {
-	CacheSubsByType,
-	ClassifiedCommunityGiftPurchase,
-	ClassifiedEvent,
-	ClassifiedRecipient,
-	IncomingDetail,
-	NormalizerOptions,
-} from "./types";
-
-const AGGREGATE_TIMEOUT_MS = 2500;
-
-interface BufferEntry {
-	type: string;
-	subscribers: Array<{
-		recipient?: string;
-		username?: string;
-		name?: string;
-		sender?: string;
-	}>;
-	tier: number;
-	tierText: string;
-	totalAmount: number;
-	purchase?: ClassifiedCommunityGiftPurchase;
-	sender?: string;
-}
-
-const bufferByGroup: Record<string, BufferEntry> = {};
-const bufferTimers: Record<string, ReturnType<typeof setTimeout>> = {};
-
-function getCacheForType(
-	cacheSubs: CacheSubsByType | undefined,
-	type: string,
-): {
-	_has: (k: string) => boolean;
-	_set: (k: string, v: boolean) => void;
-} | null {
-	if (!cacheSubs) return null;
-	if (
-		typeof cacheSubs._has === "function" &&
-		typeof cacheSubs._set === "function"
-	) {
-		return cacheSubs as unknown as {
-			_has: (k: string) => boolean;
-			_set: (k: string, v: boolean) => void;
-		};
-	}
-	const c = cacheSubs[type];
-	return c && typeof (c as { _has?: unknown })._has === "function"
-		? (c as {
-				_has: (k: string) => boolean;
-				_set: (k: string, v: boolean) => void;
-			})
-		: null;
-}
-
-function emitAggregated(
-	groupKey: string,
-	merged: ClassifiedCommunityGiftPurchase,
-	cacheSubs: CacheSubsByType | undefined,
-	onNormalized: (event: ClassifiedEvent | null) => void,
-): void {
-	const cache = getCacheForType(cacheSubs, merged.type as string);
-	if (cache?._has(groupKey)) return;
-	if (cache) cache._set(groupKey, true);
-	onNormalized(merged);
-}
-
-function flushBuffer(
-	groupKey: string,
-	cacheSubs: CacheSubsByType | undefined,
-	onNormalized: (event: ClassifiedEvent | null) => void,
-	broadcaster: string,
-): void {
-	const buf = bufferByGroup[groupKey];
-	if (!buf) return;
-	delete bufferByGroup[groupKey];
-	if (bufferTimers[groupKey]) {
-		clearTimeout(bufferTimers[groupKey]);
-		delete bufferTimers[groupKey];
-	}
-	const purchase = buf.purchase;
-	const subscribers = buf.subscribers ?? [];
-	const type = buf.type;
-	const tier = buf.tier;
-	const tierText = buf.tierText;
-	const totalAmount = buf.totalAmount ?? subscribers.length;
-	const recipients = subscribers
-		.map((s) => s.recipient ?? s.username ?? s.name)
-		.filter(Boolean) as string[];
-	const firstSub = subscribers[0];
-	const senderFromSub = firstSub?.sender;
-	const sender = purchase?.sender ?? buf.sender ?? senderFromSub;
-	if (type === "community-gift" && broadcaster && sender === broadcaster) {
-		return;
-	}
-	if (type === "community-gift-anonymous") {
-		emitAggregated(
-			groupKey,
-			{
-				type: "community-gift-anonymous",
-				tier,
-				tierText,
-				totalAmount,
-				recipients,
-				anonymousDisplayName: purchase?.anonymousDisplayName,
-			},
-			cacheSubs,
-			onNormalized,
-		);
-	} else {
-		emitAggregated(
-			groupKey,
-			{
-				type: "community-gift",
-				sender,
-				tier,
-				tierText,
-				totalAmount,
-				recipients,
-			},
-			cacheSubs,
-			onNormalized,
-		);
-	}
-}
-
-/**
- * Normalizes an incoming subscription event (StreamElements/Twitch).
- * Buffers community-gift recipients by activityGroup, then emits one normalized event per group.
- * For self-sub, solo-sub, sub-renewal emits immediately (with optional cache dedup).
- */
-export function normalizeIncomingEvent(
-	detail: IncomingDetail,
-	options: NormalizerOptions | undefined,
-	onNormalized: (event: ClassifiedEvent | null) => void,
-): void {
-	const cacheSubs = options?.cacheSubs;
-	const broadcaster = options?.broadcasterLogin ?? "";
-
-	const classified = classifyEvent(detail);
-	if (!classified) {
-		onNormalized(null);
-		return;
-	}
-
-	const cache = getCacheForType(cacheSubs, classified.type);
-	const cacheKey = getCacheKey(detail);
-	const event = detail.event ?? {};
-	const data = (event.data ?? event) as Record<string, unknown>;
-
-	if ((classified as ClassifiedRecipient)._role === "recipient") {
-		const recipient = classified as ClassifiedRecipient;
-		const ag = recipient.activityGroup ?? cacheKey;
-		if (!bufferByGroup[ag]) {
-			bufferByGroup[ag] = {
-				type: recipient.type,
-				subscribers: [],
-				tier: recipient.tier,
-				tierText: recipient.tierText,
-				totalAmount: 0,
-			};
-		}
-		if (bufferTimers[ag]) clearTimeout(bufferTimers[ag]);
-		bufferTimers[ag] = setTimeout(() => {
-			flushBuffer(ag, cacheSubs, onNormalized, broadcaster);
-		}, AGGREGATE_TIMEOUT_MS);
-		bufferByGroup[ag].subscribers.push({
-			recipient: recipient.recipient,
-			username: data.username as string,
-			name: data.displayName as string,
-			sender: data.sender as string,
-		});
-		if (bufferByGroup[ag].totalAmount === 0) bufferByGroup[ag].totalAmount = 1;
-		return;
-	}
-
-	if (
-		classified.type === "community-gift-anonymous" ||
-		classified.type === "community-gift"
-	) {
-		const isPurchase =
-			detail.listener === "event" && event.type === "communityGiftPurchase";
-		if (isPurchase) {
-			const ag = (event.activityGroup ??
-				data?.activityGroup ??
-				cacheKey) as string;
-			const cg = classified as ClassifiedCommunityGiftPurchase;
-			if (!bufferByGroup[ag]) {
-				bufferByGroup[ag] = {
-					type: cg.type,
-					purchase: cg,
-					subscribers: [],
-					tier: cg.tier,
-					tierText: cg.tierText,
-					totalAmount: Number(cg.totalAmount) || 0,
-					sender: cg.sender,
-				};
-				bufferTimers[ag] = setTimeout(() => {
-					flushBuffer(ag, cacheSubs, onNormalized, broadcaster);
-				}, AGGREGATE_TIMEOUT_MS);
-			} else {
-				bufferByGroup[ag].purchase = cg;
-				bufferByGroup[ag].tier = cg.tier;
-				bufferByGroup[ag].tierText = cg.tierText;
-				bufferByGroup[ag].totalAmount =
-					(cg.totalAmount as number) ?? bufferByGroup[ag].totalAmount;
-				bufferByGroup[ag].sender = cg.sender as string;
-				if (bufferTimers[ag]) clearTimeout(bufferTimers[ag]);
-				bufferTimers[ag] = setTimeout(() => {
-					flushBuffer(ag, cacheSubs, onNormalized, broadcaster);
-				}, AGGREGATE_TIMEOUT_MS);
-			}
-			return;
-		}
-		if (detail.listener === "subscriber-latest") {
-			const c = classified as ClassifiedCommunityGiftPurchase;
-			if (
-				classified.type === "community-gift" &&
-				broadcaster &&
-				c.sender === broadcaster
-			) {
-				onNormalized(null);
-				return;
-			}
-			return;
-		}
-		return;
-	}
-
-	if (
-		classified.type === "self-sub" ||
-		classified.type === "solo-sub-to-someone" ||
-		classified.type === "sub-renewal"
-	) {
-		if (cache?._has(cacheKey)) {
-			onNormalized(null);
-			return;
-		}
-		if (cache) cache._set(cacheKey, true);
-		const c = classified as unknown as Record<string, unknown>;
-		if (
-			classified.type === "solo-sub-to-someone" &&
-			broadcaster &&
-			c.sender === broadcaster
-		) {
-			onNormalized(null);
-			return;
-		}
-		onNormalized(classified);
-	}
-}