@overlaysymphony/twitch 0.3.4 → 0.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@overlaysymphony/twitch",
-  "version": "0.3.4",
+  "version": "0.4.0",
   "description": "Twitch module for the OverlaySymphony interactive streaming framework.",
   "homepage": "https://github.com/OverlaySymphony/overlaysymphony",
   "repository": {
@@ -12,13 +12,14 @@
     "./authentication": "./src/authentication/index.ts",
     "./chat": "./src/chat/index.ts",
     "./eventsub": "./src/eventsub/index.ts",
+    "./helix": "./src/helix/index.ts",
     "./helix/*": "./src/helix/*/index.ts",
     "./helpers/*": "./src/helpers/*/index.ts",
     "./ui/*": "./src/ui/*.ts",
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@overlaysymphony/core": "0.2.3"
+    "@overlaysymphony/core": "0.2.4"
   },
   "devDependencies": {
     "@vitest/coverage-v8": "^2.1.2",

package/src/chat/chat.ts

@@ -32,9 +32,11 @@ export interface TwitchChat {
 
 export default async function createChat(
   authentication: Authentication,
-  eventsub?: TwitchEventSub,
+  eventsub?: TwitchEventSub | string,
 ): Promise<TwitchChat> {
-  eventsub ??= await createEventSub(authentication)
+  if (!eventsub || typeof eventsub === "string") {
+    eventsub = await createEventSub(authentication, eventsub)
+  }
 
   const send: ChatSender = async (message) => {
     await sendChatMessage(authentication, message)
@@ -46,7 +48,7 @@ export default async function createChat(
 
   const onMessage: ChatMessageSubscriber = (callback) => {
     return eventsub.on(["channel.chat.message"], (payload) => {
-      if (payload.event.broadcaster_user_id !== authentication.user.id) return
+      if (payload.event.source_broadcaster_user_id) return
 
       callback(payload.event)
     })

package/src/eventsub/events/automod.message.hold-2.ts

@@ -70,12 +70,12 @@ type AutomodMessageHold = EventConfig<{
 
 registerEvent("automod.message.hold", {
   scopes: ["moderator:manage:automod"],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "automod.message.hold",
     version: "2",
     condition: {
-      broadcaster_user_id: userId,
-      moderator_user_id: userId,
+      broadcaster_user_id: targetUserId,
+      moderator_user_id: currentUserId,
     },
   }),
 })

package/src/eventsub/events/automod.message.update-2.ts

@@ -83,12 +83,12 @@ type AutomodMessageUpdate = EventConfig<{
 
 registerEvent("automod.message.update", {
   scopes: ["moderator:manage:automod"],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "automod.message.update",
     version: "2",
     condition: {
-      broadcaster_user_id: userId,
-      moderator_user_id: userId,
+      broadcaster_user_id: targetUserId,
+      moderator_user_id: currentUserId,
     },
   }),
 })

package/src/eventsub/events/automod.settings.update-1.ts

@@ -54,12 +54,12 @@ type AutomodSettingsUpdate = EventConfig<{
 
 registerEvent("automod.settings.update", {
   scopes: ["moderator:read:automod"],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "automod.settings.update",
     version: "1",
     condition: {
-      broadcaster_user_id: userId,
-      moderator_user_id: userId,
+      broadcaster_user_id: targetUserId,
+      moderator_user_id: currentUserId,
     },
   }),
 })

package/src/eventsub/events/automod.terms.update-1.ts

@@ -48,12 +48,12 @@ type AutomodTermsUpdate = EventConfig<{
 
 registerEvent("automod.terms.update", {
   scopes: ["moderator:manage:automod"],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "automod.terms.update",
     version: "1",
     condition: {
-      broadcaster_user_id: userId,
-      moderator_user_id: userId,
+      broadcaster_user_id: targetUserId,
+      moderator_user_id: currentUserId,
     },
   }),
 })

package/src/eventsub/events/channel.ad_break.begin-1.ts

@@ -40,11 +40,11 @@ type ChannelAdBreakBegin = EventConfig<{
 
 registerEvent("channel.ad_break.begin", {
   scopes: ["channel:read:ads"],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "channel.ad_break.begin",
     version: "1",
     condition: {
-      broadcaster_id: userId,
+      broadcaster_id: targetUserId,
     },
   }),
 })

package/src/eventsub/events/channel.ban-1.ts

@@ -48,11 +48,11 @@ type ChannelBan = EventConfig<{
 
 registerEvent("channel.ban", {
   scopes: ["channel:moderate"],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "channel.ban",
     version: "1",
     condition: {
-      broadcaster_user_id: userId,
+      broadcaster_user_id: targetUserId,
     },
   }),
 })

package/src/eventsub/events/channel.bits.use-1.ts

@@ -102,11 +102,11 @@ type ChannelBitsUse = EventConfig<{
 
 registerEvent("channel.bits.use", {
   scopes: ["bits:read"],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "channel.bits.use",
     version: "1",
     condition: {
-      broadcaster_user_id: userId,
+      broadcaster_user_id: targetUserId,
     },
   }),
 })

package/src/eventsub/events/channel.channel_points_automatic_reward_redemption.add-2.ts

@@ -78,11 +78,11 @@ type ChannelChannelPointsAutomaticRewardRedemptionAdd = EventConfig<{
 
 registerEvent("channel.channel_points_automatic_reward_redemption.add", {
   scopes: ["channel:manage:redemptions", "channel:read:redemptions"],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "channel.channel_points_automatic_reward_redemption.add",
     version: "2",
     condition: {
-      broadcaster_user_id: userId,
+      broadcaster_user_id: targetUserId,
     },
   }),
 })

package/src/eventsub/events/channel.channel_points_custom_reward.add-1.ts

@@ -91,11 +91,11 @@ type ChannelChannelPointsCustomRewardAdd = EventConfig<{
 
 registerEvent("channel.channel_points_custom_reward.add", {
   scopes: ["channel:manage:redemptions", "channel:read:redemptions"],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "channel.channel_points_custom_reward.add",
     version: "1",
     condition: {
-      broadcaster_user_id: userId,
+      broadcaster_user_id: targetUserId,
     },
   }),
 })

package/src/eventsub/events/channel.channel_points_custom_reward.remove-1.ts

@@ -93,11 +93,11 @@ type ChannelChannelPointsCustomRewardRemove = EventConfig<{
 
 registerEvent("channel.channel_points_custom_reward.remove", {
   scopes: ["channel:manage:redemptions", "channel:read:redemptions"],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "channel.channel_points_custom_reward.remove",
     version: "1",
     condition: {
-      broadcaster_user_id: userId,
+      broadcaster_user_id: targetUserId,
     },
   }),
 })

package/src/eventsub/events/channel.channel_points_custom_reward.update-1.ts

@@ -93,11 +93,11 @@ type ChannelChannelPointsCustomRewardUpdate = EventConfig<{
 
 registerEvent("channel.channel_points_custom_reward.update", {
   scopes: ["channel:manage:redemptions", "channel:read:redemptions"],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "channel.channel_points_custom_reward.update",
     version: "1",
     condition: {
-      broadcaster_user_id: userId,
+      broadcaster_user_id: targetUserId,
     },
   }),
 })

package/src/eventsub/events/channel.channel_points_custom_reward_redemption.add-1.ts

@@ -55,11 +55,11 @@ type ChannelChannelPointsCustomRewardRedemptionAdd = EventConfig<{
 
 registerEvent("channel.channel_points_custom_reward_redemption.add", {
   scopes: ["channel:manage:redemptions", "channel:read:redemptions"],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "channel.channel_points_custom_reward_redemption.add",
     version: "1",
     condition: {
-      broadcaster_user_id: userId,
+      broadcaster_user_id: targetUserId,
     },
   }),
 })

package/src/eventsub/events/channel.channel_points_custom_reward_redemption.update-1.ts

@@ -55,11 +55,11 @@ type ChannelChannelPointsCustomRewardRedemptionUpdate = EventConfig<{
 
 registerEvent("channel.channel_points_custom_reward_redemption.update", {
   scopes: ["channel:manage:redemptions", "channel:read:redemptions"],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "channel.channel_points_custom_reward_redemption.update",
     version: "1",
     condition: {
-      broadcaster_user_id: userId,
+      broadcaster_user_id: targetUserId,
     },
   }),
 })

package/src/eventsub/events/channel.charity_campaign.donate-1.ts

@@ -59,11 +59,11 @@ type ChannelCharityCampaignDonate = EventConfig<{
 
 registerEvent("channel.charity_campaign.donate", {
   scopes: ["channel:read:charity"],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "channel.charity_campaign.donate",
     version: "1",
     condition: {
-      broadcaster_user_id: userId,
+      broadcaster_user_id: targetUserId,
     },
   }),
 })

package/src/eventsub/events/channel.charity_campaign.progress-1.ts

@@ -64,11 +64,11 @@ type ChannelCharityCampaignProgress = EventConfig<{
 
 registerEvent("channel.charity_campaign.progress", {
   scopes: ["channel:read:charity"],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "channel.charity_campaign.progress",
     version: "1",
     condition: {
-      broadcaster_user_id: userId,
+      broadcaster_user_id: targetUserId,
     },
   }),
 })

package/src/eventsub/events/channel.charity_campaign.start-1.ts

@@ -66,11 +66,11 @@ type ChannelCharityCampaignStart = EventConfig<{
 
 registerEvent("channel.charity_campaign.start", {
   scopes: ["channel:read:charity"],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "channel.charity_campaign.start",
     version: "1",
     condition: {
-      broadcaster_user_id: userId,
+      broadcaster_user_id: targetUserId,
     },
   }),
 })

package/src/eventsub/events/channel.charity_campaign.stop-1.ts

@@ -66,11 +66,11 @@ type ChannelCharityCampaignStop = EventConfig<{
 
 registerEvent("channel.charity_campaign.stop", {
   scopes: ["channel:read:charity"],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "channel.charity_campaign.stop",
     version: "1",
     condition: {
-      broadcaster_user_id: userId,
+      broadcaster_user_id: targetUserId,
     },
   }),
 })

package/src/eventsub/events/channel.chat.clear-1.ts

@@ -30,12 +30,12 @@ type ChannelChatClear = EventConfig<{
 
 registerEvent("channel.chat.clear", {
   scopes: ["user:read:chat"],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "channel.chat.clear",
     version: "1",
     condition: {
-      broadcaster_user_id: userId,
-      user_id: userId,
+      broadcaster_user_id: targetUserId,
+      user_id: currentUserId,
     },
   }),
 })

package/src/eventsub/events/channel.chat.clear_user_messages-1.ts

@@ -36,12 +36,12 @@ type ChannelChatClearUserMessages = EventConfig<{
 
 registerEvent("channel.chat.clear_user_messages", {
   scopes: ["user:read:chat"],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "channel.chat.clear_user_messages",
     version: "1",
     condition: {
-      broadcaster_user_id: userId,
-      user_id: userId,
+      broadcaster_user_id: targetUserId,
+      user_id: currentUserId,
     },
   }),
 })

package/src/eventsub/events/channel.chat.message-1.ts

@@ -149,12 +149,12 @@ type ChannelChatMessage = EventConfig<{
 
 registerEvent("channel.chat.message", {
   scopes: ["user:read:chat"],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "channel.chat.message",
     version: "1",
     condition: {
-      broadcaster_user_id: userId,
-      user_id: userId,
+      broadcaster_user_id: targetUserId,
+      user_id: currentUserId,
     },
   }),
 })

package/src/eventsub/events/channel.chat.message_delete-1.ts

@@ -38,12 +38,12 @@ type ChannelChatMessageDelete = EventConfig<{
 
 registerEvent("channel.chat.message_delete", {
   scopes: ["user:read:chat"],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "channel.chat.message_delete",
     version: "1",
     condition: {
-      broadcaster_user_id: userId,
-      user_id: userId,
+      broadcaster_user_id: targetUserId,
+      user_id: currentUserId,
     },
   }),
 })

package/src/eventsub/events/channel.chat.notification-1.ts

@@ -306,12 +306,12 @@ type ChannelChatNotification = EventConfig<{
 
 registerEvent("channel.chat.notification", {
   scopes: ["user:read:chat"],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "channel.chat.notification",
     version: "1",
     condition: {
-      broadcaster_user_id: userId,
-      user_id: userId,
+      broadcaster_user_id: targetUserId,
+      user_id: currentUserId,
     },
   }),
 })

package/src/eventsub/events/channel.chat.user_message_hold-1.ts

@@ -64,12 +64,12 @@ type ChannelChatUserMessageHold = EventConfig<{
 
 registerEvent("channel.chat.user_message_hold", {
   scopes: ["user:read:chat"],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "channel.chat.user_message_hold",
     version: "1",
     condition: {
-      broadcaster_user_id: userId,
-      user_id: userId,
+      broadcaster_user_id: targetUserId,
+      user_id: currentUserId,
     },
   }),
 })

package/src/eventsub/events/channel.chat.user_message_update-1.ts

@@ -71,12 +71,12 @@ type ChannelChatUserMessageUpdate = EventConfig<{
 
 registerEvent("channel.chat.user_message_update", {
   scopes: ["user:read:chat"],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "channel.chat.user_message_update",
     version: "1",
     condition: {
-      broadcaster_user_id: userId,
-      user_id: userId,
+      broadcaster_user_id: targetUserId,
+      user_id: currentUserId,
     },
   }),
 })

package/src/eventsub/events/channel.chat_settings.update-1.ts

@@ -72,12 +72,12 @@ type ChannelChatSettingsUpdate = EventConfig<{
 
 registerEvent("channel.chat_settings.update", {
   scopes: ["user:read:chat"],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "channel.chat_settings.update",
     version: "1",
     condition: {
-      broadcaster_user_id: userId,
-      user_id: userId,
+      broadcaster_user_id: targetUserId,
+      user_id: currentUserId,
     },
   }),
 })

package/src/eventsub/events/channel.cheer-1.ts

@@ -40,11 +40,11 @@ type ChannelCheer = EventConfig<{
 
 registerEvent("channel.cheer", {
   scopes: ["bits:read"],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "channel.cheer",
     version: "1",
     condition: {
-      broadcaster_user_id: userId,
+      broadcaster_user_id: targetUserId,
     },
   }),
 })

package/src/eventsub/events/channel.follow-2.ts

@@ -38,12 +38,12 @@ type ChannelFollow = EventConfig<{
 
 registerEvent("channel.follow", {
   scopes: ["moderator:read:followers"],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "channel.follow",
     version: "2",
     condition: {
-      broadcaster_user_id: userId,
-      moderator_user_id: userId,
+      broadcaster_user_id: targetUserId,
+      moderator_user_id: currentUserId,
     },
   }),
 })

package/src/eventsub/events/channel.goal.begin-1.ts

@@ -70,11 +70,11 @@ type ChannelGoalBegin = EventConfig<{
 
 registerEvent("channel.goal.begin", {
   scopes: ["channel:read:goals"],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "channel.goal.begin",
     version: "1",
     condition: {
-      broadcaster_user_id: userId,
+      broadcaster_user_id: targetUserId,
     },
   }),
 })

package/src/eventsub/events/channel.goal.end-1.ts

@@ -70,11 +70,11 @@ type ChannelGoalEnd = EventConfig<{
 
 registerEvent("channel.goal.end", {
   scopes: ["channel:read:goals"],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "channel.goal.end",
     version: "1",
     condition: {
-      broadcaster_user_id: userId,
+      broadcaster_user_id: targetUserId,
     },
   }),
 })

package/src/eventsub/events/channel.goal.progress-1.ts

@@ -70,11 +70,11 @@ type ChannelGoalProgress = EventConfig<{
 
 registerEvent("channel.goal.progress", {
   scopes: ["channel:read:goals"],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "channel.goal.progress",
     version: "1",
     condition: {
-      broadcaster_user_id: userId,
+      broadcaster_user_id: targetUserId,
     },
   }),
 })

package/src/eventsub/events/channel.guest_star_guest.update-beta.ts

@@ -74,12 +74,12 @@ registerEvent("channel.guest_star_guest.update@be", {
     "moderator:manage:guest",
     "moderator:read:guest",
   ],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "channel.guest_star_guest.update@be",
     version: "beta",
     condition: {
-      broadcaster_user_id: userId,
-      moderator_user_id: userId,
+      broadcaster_user_id: targetUserId,
+      moderator_user_id: currentUserId,
     },
   }),
 })

package/src/eventsub/events/channel.guest_star_session.begin-beta.ts

@@ -39,12 +39,12 @@ registerEvent("channel.guest_star_session.begin@be", {
     "moderator:manage:guest",
     "moderator:read:guest",
   ],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "channel.guest_star_session.begin@be",
     version: "beta",
     condition: {
-      broadcaster_user_id: userId,
-      moderator_user_id: userId,
+      broadcaster_user_id: targetUserId,
+      moderator_user_id: currentUserId,
     },
   }),
 })

package/src/eventsub/events/channel.guest_star_session.end-beta.ts

@@ -47,12 +47,12 @@ registerEvent("channel.guest_star_session.end@be", {
     "moderator:manage:guest",
     "moderator:read:guest",
   ],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "channel.guest_star_session.end@be",
     version: "beta",
     condition: {
-      broadcaster_user_id: userId,
-      moderator_user_id: userId,
+      broadcaster_user_id: targetUserId,
+      moderator_user_id: currentUserId,
     },
   }),
 })

package/src/eventsub/events/channel.guest_star_settings.update-beta.ts

@@ -51,12 +51,12 @@ registerEvent("channel.guest_star_settings.update@be", {
     "moderator:manage:guest",
     "moderator:read:guest",
   ],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "channel.guest_star_settings.update@be",
     version: "beta",
     condition: {
-      broadcaster_user_id: userId,
-      moderator_user_id: userId,
+      broadcaster_user_id: targetUserId,
+      moderator_user_id: currentUserId,
     },
   }),
 })

package/src/eventsub/events/channel.hype_train.begin-2.ts

@@ -80,11 +80,11 @@ type ChannelHypeTrainBegin = EventConfig<{
 
 registerEvent("channel.hype_train.begin", {
   scopes: ["channel:read:hype"],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "channel.hype_train.begin",
     version: "2",
     condition: {
-      broadcaster_user_id: userId,
+      broadcaster_user_id: targetUserId,
     },
   }),
 })

package/src/eventsub/events/channel.hype_train.end-2.ts

@@ -60,11 +60,11 @@ type ChannelHypeTrainEnd = EventConfig<{
 
 registerEvent("channel.hype_train.end", {
   scopes: ["channel:read:hype"],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "channel.hype_train.end",
     version: "2",
     condition: {
-      broadcaster_user_id: userId,
+      broadcaster_user_id: targetUserId,
     },
   }),
 })

package/src/eventsub/events/channel.hype_train.progress-2.ts

@@ -80,11 +80,11 @@ type ChannelHypeTrainProgress = EventConfig<{
 
 registerEvent("channel.hype_train.progress", {
   scopes: ["channel:read:hype"],
-  subscriber: (userId) => ({
+  subscriber: (currentUserId, targetUserId) => ({
     type: "channel.hype_train.progress",
     version: "2",
     condition: {
-      broadcaster_user_id: userId,
+      broadcaster_user_id: targetUserId,
     },
   }),
 })