@allior/wmake-streamelements-events 0.0.1

package/src/root/types/index.ts

@@ -0,0 +1,2 @@
+export * from "./on-event-received";
+export * from "./on-widget-load";

package/src/root/types/on-event-received.ts

@@ -0,0 +1,198 @@
+/**
+ * Типы для входящих событий StreamElements/Twitch и результата классификации.
+ */
+
+/** Алерт: новый подписчик (follower-latest). */
+export interface FollowerDetail {
+  listener: "follower-latest";
+  event: { name: string };
+}
+
+/** Алерт: массовая раздача подписок (communityGiftPurchase). */
+export interface CommunityGiftPurchaseDetail {
+  listener: "event";
+  event: {
+    type: "communityGiftPurchase";
+    provider: string;
+    channel: string;
+    activityGroup: string;
+    data: {
+      amount: number;
+      username: string;
+      displayName: string;
+      tier: string;
+      sender?: string;
+    };
+    _id: string;
+    activityId: string;
+  };
+}
+
+/** Алерт: подписка latest (subscriber-latest). */
+export interface SubscriberLatestDetail {
+  listener: "subscriber-latest";
+  event: { name: string; amount: number };
+}
+
+/** Алерт: подписка (self, подарок одному, продление). */
+export interface SubscriberDetail {
+  listener: "event";
+  event: {
+    type: "subscriber";
+    provider: string;
+    channel: string;
+    data: {
+      amount: number;
+      username: string;
+      displayName: string;
+      tier: string;
+      sender?: string;
+      gifted?: boolean;
+      message?: string;
+    };
+    _id: string;
+    activityId: string;
+  };
+}
+
+/** Алерт: чиры (bits). */
+export interface CheerDetail {
+  listener: "cheer-latest";
+  event: { name: string; amount: number };
+}
+
+/** Алерт: рейд. */
+export interface RaidDetail {
+  listener: "raid-latest";
+  event: { name: string; amount: number };
+}
+
+/** Алерт: донат. */
+export interface DonationDetail {
+  listener: "donation";
+  event: {
+    data: {
+      alert_type?: string;
+      currency?: string;
+      billing_system?: string;
+      id?: number;
+      amount_main?: number;
+      amount?: number;
+      username?: string;
+      message?: string;
+      [key: string]: unknown;
+    };
+  };
+}
+
+/** Все типы алертов (onEventReceived). */
+export type AlertDetail =
+  | FollowerDetail
+  | SubscriberLatestDetail
+  | CommunityGiftPurchaseDetail
+  | SubscriberDetail
+  | CheerDetail
+  | RaidDetail
+  | DonationDetail;
+
+/** Входящее событие (обобщённый вид для classifyEvent и т.д.). */
+export interface IncomingDetail {
+  listener: string;
+  event?: {
+    type?: string;
+    provider?: string;
+    channel?: string;
+    activityGroup?: string;
+    activityId?: string;
+    _id?: string;
+    bulkGifted?: boolean;
+    sender?: string;
+    name?: string;
+    amount?: number;
+    tier?: string | number;
+    gifted?: boolean;
+    isCommunityGift?: boolean;
+    communityGifted?: boolean;
+    message?: string;
+    data?: Record<string, unknown>;
+    [key: string]: unknown;
+  };
+}
+
+export interface TierInfo {
+  tier: number;
+  tierText: string;
+}
+
+export type NormalizedType =
+  | "community-gift-anonymous"
+  | "community-gift"
+  | "self-sub"
+  | "solo-sub-to-someone"
+  | "sub-renewal";
+
+export interface ClassifiedBase {
+  type: NormalizedType;
+  tier: number;
+  tierText: string;
+}
+
+export interface ClassifiedCommunityGiftPurchase extends ClassifiedBase {
+  type: "community-gift" | "community-gift-anonymous";
+  totalAmount: number;
+  recipients: string[];
+  sender?: string;
+  anonymousDisplayName?: string;
+}
+
+export interface ClassifiedRecipient extends ClassifiedBase {
+  _role: "recipient";
+  activityGroup: string;
+  recipient: string;
+}
+
+export interface ClassifiedSoloSub extends ClassifiedBase {
+  type: "solo-sub-to-someone";
+  sender: string;
+  recipient: string;
+  firstGiftInChannel?: boolean;
+}
+
+export interface ClassifiedSubRenewal extends ClassifiedBase {
+  type: "sub-renewal";
+  name: string;
+  months: number;
+}
+
+export interface ClassifiedSelfSub extends ClassifiedBase {
+  type: "self-sub";
+  name: string;
+}
+
+export type ClassifiedEvent =
+  | ClassifiedCommunityGiftPurchase
+  | ClassifiedRecipient
+  | ClassifiedSoloSub
+  | ClassifiedSubRenewal
+  | ClassifiedSelfSub
+  | (ClassifiedBase & { type: NormalizedType; [key: string]: unknown });
+
+export interface CacheLike {
+  _has(key: string): boolean;
+  _set(key: string, value: boolean): void;
+}
+
+export interface CacheSubsByType {
+  _has?(key: string): boolean;
+  _set?(key: string, value: boolean): void;
+  [type: string]:
+    | CacheLike
+    | ((k: string) => boolean)
+    | ((k: string, v: boolean) => void)
+    | undefined;
+}
+
+export interface NormalizerOptions {
+  cacheSubs?: CacheSubsByType;
+  broadcasterLogin?: string;
+}

package/src/root/types/on-widget-load.ts

@@ -0,0 +1,171 @@
+export interface OnWidgetLoadEventDetails {
+  channel: Channel;
+  currency: Currency;
+  fieldData: FieldData;
+  overlay: Overlay;
+  recents: Recents;
+  session: Session;
+}
+
+export interface Channel {
+  /**
+   * StreamElements API Token (not JWT Token)
+   */
+  apiToken: string;
+  avatar: string;
+  id: string;
+  providerId: string;
+  username: string;
+}
+
+export interface Currency {
+  code: string;
+  name: string;
+  symbol: string;
+}
+
+export type FieldData = Record<string, unknown>;
+
+export interface Overlay {
+  isEditorMode: boolean;
+  muted: boolean;
+}
+
+/** Base for recent (onWidgetLoad): follower / subscriber / cheer / raid */
+export interface RecentItemBase {
+  name: string;
+  createdAt: string;
+}
+
+export interface RecentItemFollower extends RecentItemBase {
+  type: "follower";
+}
+
+export interface RecentItemSubscriber extends RecentItemBase {
+  type: "subscriber";
+  tier: string;
+  amount: number;
+}
+
+export interface RecentItemCheer extends RecentItemBase {
+  type: "cheer";
+  amount: number;
+}
+
+export interface RecentItemRaid extends RecentItemBase {
+  type: "raid";
+  amount: number;
+}
+
+export type RecentsItem =
+  | RecentItemFollower
+  | RecentItemSubscriber
+  | RecentItemCheer
+  | RecentItemRaid;
+
+export type Recents = RecentsItem[];
+
+// --- Session (StreamElements overlay session data) ---
+
+export interface SessionSettings {
+  autoReset: boolean;
+  calendar: boolean;
+  resetOnStart: boolean;
+}
+
+/** Запись в списке follower-recent / subscriber-recent / raid-recent / cheer-recent */
+export interface SessionRecentItem {
+  name: string;
+  createdAt: string;
+  type: string;
+  amount?: number;
+  tier?: string;
+}
+
+/** Объект *-latest с полями name и amount (subscriber, cheer, tip, host, raid и т.д.) */
+export interface SessionLatestNamedAmount {
+  name: string;
+  amount: number;
+  message?: string;
+  tier?: string;
+  sender?: string;
+  redemption?: string;
+  items?: unknown[];
+}
+
+/** Объект *-session / *-total и т.п. с полем count */
+export interface SessionCountEntry {
+  count: number;
+}
+
+/** Объект *-goal / *-session (amount) и т.п. с полем amount */
+export interface SessionAmountEntry {
+  amount: number;
+}
+
+/** Объект top-donation / top-donator */
+export interface SessionTopEntry {
+  name: string;
+  amount: number;
+}
+
+/** channel-points-latest */
+export interface SessionChannelPointsLatest {
+  name: string;
+  amount: number;
+  message: string;
+  redemption: string;
+}
+
+/** community-gift-latest */
+export interface SessionCommunityGiftLatest {
+  name: string;
+  amount: number;
+  tier: string;
+}
+
+/** hypetrain-latest */
+export interface SessionHypetrainLatest {
+  active: number;
+  amount: number;
+  level: number;
+  levelChanged: number;
+  name: string;
+  type: string;
+}
+
+/** merch-latest */
+export interface SessionMerchLatest {
+  name: string;
+  amount: number;
+  items: unknown[];
+}
+
+/** Элемент массива purchase-latest */
+export interface SessionPurchaseLatest {
+  name: string;
+  amount: number;
+  avatar: string;
+  message: string;
+  items: unknown[];
+}
+
+export type SessionDataEntry =
+  | SessionLatestNamedAmount
+  | SessionCountEntry
+  | SessionAmountEntry
+  | SessionTopEntry
+  | SessionChannelPointsLatest
+  | SessionCommunityGiftLatest
+  | SessionHypetrainLatest
+  | SessionMerchLatest
+  | SessionPurchaseLatest
+  | SessionRecentItem[]
+  | { name: string }
+  | { level?: number; percent?: number; amount?: number }
+  | Record<string, unknown>;
+
+export interface Session {
+  data: Record<string, SessionDataEntry>;
+  settings: SessionSettings;
+}

package/src/root/window-event-map.ts

@@ -0,0 +1,11 @@
+import type { EventDetail } from "./data/event-detail.js";
+import type { WidgetLoadDetail } from "./data/widget-load.js";
+
+declare global {
+  interface WindowEventMap {
+    onEventReceived: CustomEvent<EventDetail>;
+    onWidgetLoad: CustomEvent<WidgetLoadDetail>;
+  }
+}
+
+export {};