fix: Extension now respects access settings set by broadcaster

michaeljolley · Sep 18, 2023 · 0628028 · 0628028
1 parent 7e56780
commit 0628028
Show file tree

Hide file tree

Showing 5 changed files with 159 additions and 62 deletions.
diff --git a/package.json b/package.json
@@ -73,6 +73,20 @@
           "default": "Viewers",
           "description": "Users who are allowed to use the extension via Twitch chat."
         },
+        "twitchThemer.installState": {
+          "title": "Install Access",
+          "type": "string",
+          "enum": [
+            "Viewers",
+            "Followers",
+            "Subscribers",
+            "VIPs",
+            "Moderators",
+            "Broadcaster"
+          ],
+          "default": "Followers",
+          "description": "Users who are allowed to use the install command."
+        },
         "twitchThemer.autoInstall": {
           "title": "Auto-install Theme Install Requests",
           "type": "boolean",

diff --git a/src/api.ts b/src/api.ts
@@ -44,7 +44,7 @@ export default abstract class API {
           });
           if (res.status === 200) {
             const { data } = res;
-            return data && data.length > 0 ? true : false;
+            return data && data.data && data.data.length > 0 ? true : false;
           }
         } catch (err: any) {
           Logger.log(

diff --git a/src/constants.ts b/src/constants.ts
@@ -5,22 +5,22 @@ import { Theme } from "./types/theme";
  */
 export enum AccessState {
   /** All viewers */
-  viewer = 0,
+  Viewers,
 
   /** Followers only */
-  follower = 1,
+  Followers,
 
   /** Subscribers only */
-  subscriber = 2,
+  Subscribers,
 
   /** VIPs only */
-  vip = 3,
+  VIPs,
 
   /** Moderators only */
-  moderator = 4,
+  Moderators,
 
   /** Broadcaster only */
-  broadcaster = 5,
+  Broadcaster,
 }
 
 /**
@@ -106,6 +106,7 @@ export const twitchScopes = [
   `TWITCH_CLIENT_ID:${twitchAPIClientId}`,
   "chat:read",
   "chat:edit",
+  "moderator:read:followers"
 ];
 
 export const messageHelp =
@@ -139,7 +140,7 @@ export const messageOnPaused = (
 minute${minutes === 1 ? "" : "s"}.`;
 
 export const messageInstalled = (user: string, labels: string[]) =>
-  `@${user}, the theme(s) '${labels.join(", ")}' were installed successfully.`;
+  `@${user}, the theme${labels.length > 1 ? "s" : ""} '${labels.join(", ")}' ${labels.length > 1 ? "were" : "was"} installed successfully.`;
 
 export const messageThemeExists = (
   user: string,
@@ -149,3 +150,6 @@ export const messageThemeExists = (
   `@${user}, '${theme}' is already installed. To switch to it, send: !theme ${labels.join(
     " -or- !theme ",
   )}`;
+
+export const messageInstallNotAuthorized = (user: string, installState: string) =>
+  `Sorry @${user}. Only ${installState} are allowed to install new themes.`;
diff --git a/src/test/suite/themer.test.ts b/src/test/suite/themer.test.ts
@@ -180,7 +180,6 @@ suite("Themer Tests", function () {
     fakeChatClient = new ChatClient();
     fakeThemer = new Themer(fakeState);
     fakeThemer.initializeConfiguration();
-    fakeThemer.handleAccessStateChanged(AccessState.viewer);
     getConfigurationStub.resetHistory();
     isTwitchUserFollowingStub.resetHistory();
     isTwitchUserFollowingReturn = false;
@@ -524,7 +523,7 @@ suite("Themer Tests", function () {
     };
     isTwitchUserFollowingReturn = false;
 
-    fakeThemer.handleAccessStateChanged(AccessState.follower);
+    fakeThemer.handleAccessStateChanged(AccessState.Followers);
     fakeThemer.handleCommands(chatMessage).then(() => {
       try {
         fakeWorkspaceConfiguration
@@ -546,7 +545,7 @@ suite("Themer Tests", function () {
     };
     isTwitchUserFollowingReturn = true;
 
-    fakeThemer.handleAccessStateChanged(AccessState.follower);
+    fakeThemer.handleAccessStateChanged(AccessState.Followers);
     fakeThemer.handleCommands(chatMessage).then(() => {
       try {
         fakeWorkspaceConfiguration
@@ -568,7 +567,7 @@ suite("Themer Tests", function () {
     };
     isTwitchUserFollowingReturn = false;
 
-    fakeThemer.handleAccessStateChanged(AccessState.subscriber);
+    fakeThemer.handleAccessStateChanged(AccessState.Subscribers);
     fakeThemer.handleCommands(chatMessage).then(() => {
       try {
         fakeWorkspaceConfiguration
@@ -589,7 +588,7 @@ suite("Themer Tests", function () {
       extra: standardExtra,
     };
     isTwitchUserFollowingReturn = true;
-    fakeThemer.handleAccessStateChanged(AccessState.subscriber);
+    fakeThemer.handleAccessStateChanged(AccessState.Subscribers);
 
     fakeThemer.handleCommands(chatMessage).then(() => {
       try {
@@ -611,7 +610,7 @@ suite("Themer Tests", function () {
       extra: standardExtra,
     };
 
-    fakeThemer.handleAccessStateChanged(AccessState.subscriber);
+    fakeThemer.handleAccessStateChanged(AccessState.Subscribers);
     fakeThemer.handleCommands(chatMessage).then(() => {
       try {
         fakeWorkspaceConfiguration
@@ -632,7 +631,7 @@ suite("Themer Tests", function () {
       extra: standardExtra,
     };
 
-    fakeThemer.handleAccessStateChanged(AccessState.vip);
+    fakeThemer.handleAccessStateChanged(AccessState.VIPs);
     fakeThemer.handleCommands(chatMessage).then(() => {
       try {
         fakeWorkspaceConfiguration
@@ -654,7 +653,7 @@ suite("Themer Tests", function () {
     };
     isTwitchUserFollowingReturn = true;
 
-    fakeThemer.handleAccessStateChanged(AccessState.vip);
+    fakeThemer.handleAccessStateChanged(AccessState.VIPs);
     fakeThemer.handleCommands(chatMessage).then(() => {
       try {
         fakeWorkspaceConfiguration
@@ -676,7 +675,7 @@ suite("Themer Tests", function () {
     };
     isTwitchUserFollowingReturn = true;
 
-    fakeThemer.handleAccessStateChanged(AccessState.moderator);
+    fakeThemer.handleAccessStateChanged(AccessState.Moderators);
     fakeThemer.handleCommands(chatMessage).then(() => {
       try {
         fakeWorkspaceConfiguration
@@ -698,7 +697,7 @@ suite("Themer Tests", function () {
     };
     isTwitchUserFollowingReturn = true;
 
-    fakeThemer.handleAccessStateChanged(AccessState.moderator);
+    fakeThemer.handleAccessStateChanged(AccessState.Moderators);
     fakeThemer.handleCommands(chatMessage).then(() => {
       try {
         fakeWorkspaceConfiguration
@@ -720,7 +719,7 @@ suite("Themer Tests", function () {
     };
     isTwitchUserFollowingReturn = true;
 
-    fakeThemer.handleAccessStateChanged(AccessState.broadcaster);
+    fakeThemer.handleAccessStateChanged(AccessState.Broadcaster);
     fakeThemer.handleCommands(chatMessage).then(() => {
       try {
         fakeWorkspaceConfiguration
@@ -742,7 +741,7 @@ suite("Themer Tests", function () {
     };
     isTwitchUserFollowingReturn = true;
 
-    fakeThemer.handleAccessStateChanged(AccessState.broadcaster);
+    fakeThemer.handleAccessStateChanged(AccessState.Broadcaster);
     fakeThemer.handleCommands(chatMessage).then(() => {
       try {
         fakeWorkspaceConfiguration