feat: add config to set scanner cooldown by role

example config setup (scanZone accepts the same format)
 "scanNext": {
      ...
      // Discord roles that will be allowed to use scanNext
      "discordRoles": ["Supporter","Scanner", "Mod"],
      // Default cooldown if no role specific cooldown
     "userCooldownSeconds": 60,
      //List of role/cooldown pair shortest matching time will apply
     "discordRoleCooldown":[["Supporter",30],["Mod",0]],
      ...
}

Expected outcome:
Supporter: 30 second cooldown
Mod: 0 second cooldown
Scanner: will get the default 60 second cooldown.
Supporter & Mod role: the lower 0 second cooldown would apply.

Author: sherlocksometimes

packages/types/lib/server.d.ts

@@ -174,6 +174,7 @@ export interface Permissions {
   scanner: string[]
   areaRestrictions: string[]
   webhooks: string[]
+  scannerCooldowns: string[]
 }
 
 export interface Waypoint {

server/src/configs/default.json

@@ -615,6 +615,7 @@
       "pokemon": false,
       "gmf": true,
       "scanNextInstance": "scanNext",
+      "discordRoleCooldown": [],
       "scanNextDevice": "Device01",
       "scanNextSleeptime": 5,
       "userCooldownSeconds": 0,
@@ -634,6 +635,7 @@
       "gmf": false,
       "scanZoneMaxSize": 10,
       "userCooldownSeconds": 0,
+      "discordRoleCooldown": [],
       "advancedScanZoneOptions": false,
       "scanZoneRadius": {
         "pokemon": 70,
@@ -1025,4 +1027,4 @@
       "tracesSampleRate": 0.1
     }
   }
-}
+}

server/src/graphql/resolvers.js

@@ -374,6 +374,7 @@ const resolvers = {
       const scanner = config.getSafe('scanner')
 
       if (perms.scanner?.includes(mode) && scanner[mode].enabled) {
+        const cooldownMap = new Map(perms.cooldownOverride)
         return mode === 'scanZone'
           ? {
               scannerType: scanner.backendConfig.platform,
@@ -384,15 +385,19 @@ const resolvers = {
               gymRadius: scanner.scanZone.scanZoneRadius.gym,
               spacing: scanner.scanZone.scanZoneSpacing,
               maxSize: scanner.scanZone.scanZoneMaxSize,
-              cooldown: scanner.scanZone.userCooldownSeconds,
+              cooldown: cooldownMap.has(mode)
+                ? cooldownMap.get(mode)
+                : scanner.scanZone.userCooldownSeconds,
               refreshQueue: scanner.backendConfig.queueRefreshInterval,
               enabled: scanner[mode].enabled,
             }
           : {
               scannerType: scanner.backendConfig.platform,
               showScanCount: scanner.scanNext.showScanCount,
               showScanQueue: scanner.scanNext.showScanQueue,
-              cooldown: scanner.scanNext.userCooldownSeconds,
+              cooldown: cooldownMap.has(mode)
+                ? cooldownMap.get(mode)
+                : scanner.scanZone.userCooldownSeconds,
               refreshQueue: scanner.backendConfig.queueRefreshInterval,
               enabled: scanner[mode].enabled,
             }

server/src/services/DiscordClient.js

@@ -129,6 +129,7 @@ class DiscordClient {
       webhooks: new Set(),
       scanner: new Set(),
       blockedGuildNames: new Set(),
+      cooldownOverride: new Map(),
     }
     const scanner = config.getSafe('scanner')
     try {
@@ -190,6 +191,24 @@ class DiscordClient {
               scannerPerms(userRoles, 'discordRoles', trialActive).forEach(
                 (x) => permSets.scanner.add(x),
               )
+
+              Object.keys(scanner).forEach((mode) => {
+                if (
+                  scanner[mode]?.enabled &&
+                  scanner[mode].discordRoleCooldown.length
+                ) {
+                  const roleMap = scanner[mode].discordRoleCooldown.sort(
+                    (a, b) => a[1] - b[1],
+                  )
+
+                  for (let i = 0; i < roleMap.length; i += 1) {
+                    if (userRoles.includes(roleMap[i][0])) {
+                      permSets.cooldownOverride.set(mode, roleMap[i][1])
+                      break
+                    }
+                  }
+                }
+              })
             }
           }),
         )

server/src/services/config.js

@@ -340,6 +340,12 @@ if (Array.isArray(config.webhooks)) {
 }
 Object.keys(config.scanner || {}).forEach((key) => {
   config.scanner[key] = replaceBothAliases(config.scanner[key] || {})
+  const roleMap = config.scanner[key].discordRoleCooldown
+  if (roleMap) {
+    roleMap.forEach((pair) => {
+      pair[0] = replaceAliases(pair[0])
+    })
+  }
 })
 
 if (