Updated help docs to show EventSub topics instead of aliases. Previou…

…s aliases still work, but are not prreferred to be used by users going forward.
twitchdev · Feb 15, 2023 · e7c5e07 · e7c5e07
1 parent 78ce45b
commit e7c5e07
Show file tree

Hide file tree

Showing 30 changed files with 198 additions and 74 deletions.
diff --git a/cmd/events.go b/cmd/events.go
@@ -12,6 +12,7 @@ import (
 	"github.com/twitchdev/twitch-cli/internal/events"
 	"github.com/twitchdev/twitch-cli/internal/events/mock_wss_server"
 	"github.com/twitchdev/twitch-cli/internal/events/trigger"
+	"github.com/twitchdev/twitch-cli/internal/events/types"
 	"github.com/twitchdev/twitch-cli/internal/events/verify"
 	"github.com/twitchdev/twitch-cli/internal/util"
 )
@@ -54,9 +55,9 @@ var triggerCmd = &cobra.Command{
 	Short: "Creates mock events that can be forwarded to a local webserver for event testing.",
 	Long: fmt.Sprintf(`Creates mock events that can be forwarded to a local webserver for event testing.
 	Supported:
-	%s`, events.ValidTriggers()),
+	%s`, types.AllEventTopics()),
 	Args:      cobra.MaximumNArgs(1),
-	ValidArgs: events.ValidTriggers(),
+	ValidArgs: types.AllEventTopics(),
 	Run:       triggerCmdRun,
 	Example:   `twitch event trigger subscribe`,
 	Aliases: []string{
@@ -69,9 +70,9 @@ var verifyCmd = &cobra.Command{
 	Short: "Mocks the subscription verification event. Can be forwarded to a local webserver for testing.",
 	Long: fmt.Sprintf(`Mocks the subscription verification event that can be forwarded to a local webserver for testing.
 	Supported:
-	%s`, events.ValidTriggers()),
+	%s`, types.AllEventTopics()),
 	Args:      cobra.MaximumNArgs(1),
-	ValidArgs: events.ValidTriggers(),
+	ValidArgs: types.AllEventTopics(),
 	Run:       verifyCmdRun,
 	Example:   `twitch event verify-subscription subscribe`,
 	Aliases: []string{

diff --git a/internal/events/cmd_helpers.go b/internal/events/cmd_helpers.go
@@ -2,20 +2,9 @@
 // SPDX-License-Identifier: Apache-2.0
 package events
 
-import "sort"
-
-func ValidTriggers() []string {
-	names := []string{}
-
-	for name, enabled := range triggerSupported {
-		if enabled == true {
-			names = append(names, name)
-		}
-	}
-	sort.Strings(names)
-
-	return names
-}
+import (
+	"sort"
+)
 
 func ValidTransports() []string {
 	names := []string{}

diff --git a/internal/events/cmd_helpers_test.go b/internal/events/cmd_helpers_test.go
@@ -8,13 +8,6 @@ import (
 	"github.com/twitchdev/twitch-cli/test_setup"
 )
 
-func TestValidTriggers(t *testing.T) {
-	a := test_setup.SetupTestEnv(t)
-
-	t1 := ValidTriggers()
-	a.NotEmpty(t1)
-}
-
 func TestValidTransports(t *testing.T) {
 	a := test_setup.SetupTestEnv(t)
 

diff --git a/internal/events/event.go b/internal/events/event.go
@@ -46,6 +46,9 @@ type MockEvent interface {
 	// Returns whether a given event supports a supplied transport
 	ValidTransport(transport string) bool
 
+	// Returns
+	GetAllTopicsByTransport(transport string) []string
+
 	// Returns the string of the topic
 	GetTopic(transport string, trigger string) string
 

diff --git a/internal/events/models.go b/internal/events/models.go
@@ -2,53 +2,6 @@
 // SPDX-License-Identifier: Apache-2.0
 package events
 
-var triggerSupported = map[string]bool{
-	"add-moderator":       true,
-	"add-redemption":      true,
-	"add-reward":          true,
-	"ban":                 true,
-	"charity-donate":      true,
-	"charity-progress":    true,
-	"charity-start":       true,
-	"charity-stop":        true,
-	"cheer":               true,
-	"drop":                true,
-	"follow":              true,
-	"gift":                true,
-	"goal-begin":          true,
-	"goal-end":            true,
-	"goal-progress":       true,
-	"grant":               true,
-	"hype-train-begin":    true,
-	"hype-train-end":      true,
-	"hype-train-progress": true,
-	"poll-begin":          true,
-	"poll-progress":       true,
-	"poll-end":            true,
-	"prediction-begin":    true,
-	"prediction-progress": true,
-	"prediction-lock":     true,
-	"prediction-end":      true,
-	"raid":                true,
-	"remove-moderator":    true,
-	"remove-reward":       true,
-	"revoke":              true,
-	"shield-mode-begin":   true,
-	"shield-mode-end":     true,
-	"shoutout-create":     true,
-	"shoutout-received":   true,
-	"stream-change":       true,
-	"streamdown":          true,
-	"streamup":            true,
-	"subscribe":           true,
-	"transaction":         true,
-	"unban":               true,
-	"unsubscribe":         true,
-	"update-redemption":   true,
-	"update-reward":       true,
-	"user-update":         true,
-}
-
 var transportSupported = map[string]bool{
 	"websub":     false,
 	"eventsub":   true,

diff --git a/internal/events/types/authorization/authorization.go b/internal/events/types/authorization/authorization.go
@@ -108,6 +108,13 @@ func (e Event) ValidTrigger(t string) bool {
 func (e Event) GetTopic(transport string, trigger string) string {
 	return triggerMapping[transport][trigger]
 }
+func (e Event) GetAllTopicsByTransport(transport string) []string {
+	allTopics := []string{}
+	for _, topic := range triggerMapping[transport] {
+		allTopics = append(allTopics, topic)
+	}
+	return allTopics
+}
 func (e Event) GetEventSubAlias(t string) string {
 	// check for aliases
 	for trigger, topic := range triggerMapping[models.TransportEventSub] {

diff --git a/internal/events/types/ban/ban.go b/internal/events/types/ban/ban.go
@@ -131,6 +131,13 @@ func (e Event) ValidTrigger(t string) bool {
 func (e Event) GetTopic(transport string, trigger string) string {
 	return triggerMapping[transport][trigger]
 }
+func (e Event) GetAllTopicsByTransport(transport string) []string {
+	allTopics := []string{}
+	for _, topic := range triggerMapping[transport] {
+		allTopics = append(allTopics, topic)
+	}
+	return allTopics
+}
 func (e Event) GetEventSubAlias(t string) string {
 	// check for aliases
 	for trigger, topic := range triggerMapping[models.TransportEventSub] {

diff --git a/internal/events/types/channel_points_redemption/redemption_event.go b/internal/events/types/channel_points_redemption/redemption_event.go
@@ -131,6 +131,13 @@ func (e Event) ValidTrigger(t string) bool {
 func (e Event) GetTopic(transport string, trigger string) string {
 	return triggerMapping[transport][trigger]
 }
+func (e Event) GetAllTopicsByTransport(transport string) []string {
+	allTopics := []string{}
+	for _, topic := range triggerMapping[transport] {
+		allTopics = append(allTopics, topic)
+	}
+	return allTopics
+}
 func (e Event) GetEventSubAlias(t string) string {
 	// check for aliases
 	for trigger, topic := range triggerMapping[models.TransportEventSub] {

diff --git a/internal/events/types/channel_points_reward/reward_event.go b/internal/events/types/channel_points_reward/reward_event.go
@@ -144,6 +144,13 @@ func (e Event) ValidTrigger(t string) bool {
 func (e Event) GetTopic(transport string, trigger string) string {
 	return triggerMapping[transport][trigger]
 }
+func (e Event) GetAllTopicsByTransport(transport string) []string {
+	allTopics := []string{}
+	for _, topic := range triggerMapping[transport] {
+		allTopics = append(allTopics, topic)
+	}
+	return allTopics
+}
 func (e Event) GetEventSubAlias(t string) string {
 	// check for aliases
 	for trigger, topic := range triggerMapping[models.TransportEventSub] {

diff --git a/internal/events/types/charity/charity_event.go b/internal/events/types/charity/charity_event.go
@@ -219,6 +219,13 @@ func (e Event) ValidTrigger(trigger string) bool {
 func (e Event) GetTopic(transport string, trigger string) string {
 	return triggerMapping[transport][trigger]
 }
+func (e Event) GetAllTopicsByTransport(transport string) []string {
+	allTopics := []string{}
+	for _, topic := range triggerMapping[transport] {
+		allTopics = append(allTopics, topic)
+	}
+	return allTopics
+}
 func (e Event) GetEventSubAlias(t string) string {
 	// check for aliases
 	for trigger, topic := range triggerMapping[models.TransportEventSub] {

diff --git a/internal/events/types/cheer/cheer_event.go b/internal/events/types/cheer/cheer_event.go
@@ -116,6 +116,13 @@ func (e Event) ValidTrigger(t string) bool {
 func (e Event) GetTopic(transport string, trigger string) string {
 	return triggerMapping[transport][trigger]
 }
+func (e Event) GetAllTopicsByTransport(transport string) []string {
+	allTopics := []string{}
+	for _, topic := range triggerMapping[transport] {
+		allTopics = append(allTopics, topic)
+	}
+	return allTopics
+}
 func (e Event) GetEventSubAlias(t string) string {
 	// check for aliases
 	for trigger, topic := range triggerMapping[models.TransportEventSub] {

diff --git a/internal/events/types/drop/drop.go b/internal/events/types/drop/drop.go
@@ -124,6 +124,13 @@ func (e Event) ValidTrigger(t string) bool {
 func (e Event) GetTopic(transport string, trigger string) string {
 	return triggerMapping[transport][trigger]
 }
+func (e Event) GetAllTopicsByTransport(transport string) []string {
+	allTopics := []string{}
+	for _, topic := range triggerMapping[transport] {
+		allTopics = append(allTopics, topic)
+	}
+	return allTopics
+}
 func (e Event) GetEventSubAlias(t string) string {
 	// check for aliases
 	for trigger, topic := range triggerMapping[models.TransportEventSub] {

diff --git a/internal/events/types/extension_transaction/transaction_event.go b/internal/events/types/extension_transaction/transaction_event.go
@@ -131,6 +131,13 @@ func (e Event) ValidTrigger(t string) bool {
 func (e Event) GetTopic(transport string, trigger string) string {
 	return triggerMapping[transport][trigger]
 }
+func (e Event) GetAllTopicsByTransport(transport string) []string {
+	allTopics := []string{}
+	for _, topic := range triggerMapping[transport] {
+		allTopics = append(allTopics, topic)
+	}
+	return allTopics
+}
 func (e Event) GetEventSubAlias(t string) string {
 	// check for aliases
 	for trigger, topic := range triggerMapping[models.TransportEventSub] {

diff --git a/internal/events/types/follow/follow_event.go b/internal/events/types/follow/follow_event.go
@@ -103,6 +103,13 @@ func (e Event) ValidTrigger(trigger string) bool {
 func (e Event) GetTopic(transport string, trigger string) string {
 	return triggerMapping[transport][trigger]
 }
+func (e Event) GetAllTopicsByTransport(transport string) []string {
+	allTopics := []string{}
+	for _, topic := range triggerMapping[transport] {
+		allTopics = append(allTopics, topic)
+	}
+	return allTopics
+}
 func (e Event) GetEventSubAlias(t string) string {
 	// check for aliases
 	for trigger, topic := range triggerMapping[models.TransportEventSub] {

diff --git a/internal/events/types/gift/channel_gift.go b/internal/events/types/gift/channel_gift.go
@@ -121,6 +121,13 @@ func (e Event) ValidTrigger(t string) bool {
 func (e Event) GetTopic(transport string, trigger string) string {
 	return triggerMapping[transport][trigger]
 }
+func (e Event) GetAllTopicsByTransport(transport string) []string {
+	allTopics := []string{}
+	for _, topic := range triggerMapping[transport] {
+		allTopics = append(allTopics, topic)
+	}
+	return allTopics
+}
 func (e Event) GetEventSubAlias(t string) string {
 	// check for aliases
 	for trigger, topic := range triggerMapping[models.TransportEventSub] {

diff --git a/internal/events/types/goal/goal_event.go b/internal/events/types/goal/goal_event.go
@@ -143,6 +143,14 @@ func (e Event) GetTopic(transport string, trigger string) string {
 	return triggerMapping[transport][trigger]
 }
 
+func (e Event) GetAllTopicsByTransport(transport string) []string {
+	allTopics := []string{}
+	for _, topic := range triggerMapping[transport] {
+		allTopics = append(allTopics, topic)
+	}
+	return allTopics
+}
+
 func (e Event) GetEventSubAlias(t string) string {
 	// check for aliases
 	for trigger, topic := range triggerMapping[models.TransportEventSub] {

diff --git a/internal/events/types/hype_train/hype_train_event.go b/internal/events/types/hype_train/hype_train_event.go
@@ -150,6 +150,13 @@ func (e Event) ValidTrigger(t string) bool {
 func (e Event) GetTopic(transport string, trigger string) string {
 	return triggerMapping[transport][trigger]
 }
+func (e Event) GetAllTopicsByTransport(transport string) []string {
+	allTopics := []string{}
+	for _, topic := range triggerMapping[transport] {
+		allTopics = append(allTopics, topic)
+	}
+	return allTopics
+}
 func (e Event) GetEventSubAlias(t string) string {
 	// check for aliases
 	for trigger, topic := range triggerMapping[models.TransportEventSub] {

diff --git a/internal/events/types/moderator_change/moderator_change_event.go b/internal/events/types/moderator_change/moderator_change_event.go
@@ -105,6 +105,13 @@ func (e Event) ValidTrigger(t string) bool {
 func (e Event) GetTopic(transport string, trigger string) string {
 	return triggerMapping[transport][trigger]
 }
+func (e Event) GetAllTopicsByTransport(transport string) []string {
+	allTopics := []string{}
+	for _, topic := range triggerMapping[transport] {
+		allTopics = append(allTopics, topic)
+	}
+	return allTopics
+}
 func (e Event) GetEventSubAlias(t string) string {
 	// check for aliases
 	for trigger, topic := range triggerMapping[models.TransportEventSub] {

diff --git a/internal/events/types/poll/poll.go b/internal/events/types/poll/poll.go
@@ -144,6 +144,13 @@ func (e Event) ValidTrigger(t string) bool {
 func (e Event) GetTopic(transport string, trigger string) string {
 	return triggerMapping[transport][trigger]
 }
+func (e Event) GetAllTopicsByTransport(transport string) []string {
+	allTopics := []string{}
+	for _, topic := range triggerMapping[transport] {
+		allTopics = append(allTopics, topic)
+	}
+	return allTopics
+}
 
 func intPointer(i int) *int {
 	return &i

diff --git a/internal/events/types/prediction/prediction.go b/internal/events/types/prediction/prediction.go
@@ -169,6 +169,13 @@ func (e Event) ValidTrigger(t string) bool {
 func (e Event) GetTopic(transport string, trigger string) string {
 	return triggerMapping[transport][trigger]
 }
+func (e Event) GetAllTopicsByTransport(transport string) []string {
+	allTopics := []string{}
+	for _, topic := range triggerMapping[transport] {
+		allTopics = append(allTopics, topic)
+	}
+	return allTopics
+}
 
 func intPointer(i int) *int {
 	return &i

diff --git a/internal/events/types/raid/raid.go b/internal/events/types/raid/raid.go
@@ -104,6 +104,13 @@ func (e Event) ValidTrigger(t string) bool {
 func (e Event) GetTopic(transport string, trigger string) string {
 	return triggerMapping[transport][trigger]
 }
+func (e Event) GetAllTopicsByTransport(transport string) []string {
+	allTopics := []string{}
+	for _, topic := range triggerMapping[transport] {
+		allTopics = append(allTopics, topic)
+	}
+	return allTopics
+}
 func (e Event) GetEventSubAlias(t string) string {
 	// check for aliases
 	for trigger, topic := range triggerMapping[models.TransportEventSub] {

diff --git a/internal/events/types/shield_mode/shield_mode.go b/internal/events/types/shield_mode/shield_mode.go
@@ -114,6 +114,13 @@ func (e Event) ValidTrigger(trigger string) bool {
 func (e Event) GetTopic(transport string, trigger string) string {
 	return triggerMapping[transport][trigger]
 }
+func (e Event) GetAllTopicsByTransport(transport string) []string {
+	allTopics := []string{}
+	for _, topic := range triggerMapping[transport] {
+		allTopics = append(allTopics, topic)
+	}
+	return allTopics
+}
 func (e Event) GetEventSubAlias(t string) string {
 	// check for aliases
 	for trigger, topic := range triggerMapping[models.TransportEventSub] {

diff --git a/internal/events/types/shoutout/shoutout.go b/internal/events/types/shoutout/shoutout.go
@@ -154,6 +154,13 @@ func (e Event) ValidTrigger(trigger string) bool {
 func (e Event) GetTopic(transport string, trigger string) string {
 	return triggerMapping[transport][trigger]
 }
+func (e Event) GetAllTopicsByTransport(transport string) []string {
+	allTopics := []string{}
+	for _, topic := range triggerMapping[transport] {
+		allTopics = append(allTopics, topic)
+	}
+	return allTopics
+}
 func (e Event) GetEventSubAlias(t string) string {
 	// check for aliases
 	for trigger, topic := range triggerMapping[models.TransportEventSub] {