feat(auth): allow user-specific permissions

Author: Codex Agent

packages/types/lib/config.d.ts

@@ -1,212 +1,215 @@
-import type { LogLevelNames } from 'loglevel'
-import type { DialogProps } from '@mui/material'
-import type { UiconsIndex } from 'uicons.js'
-
-import { Props as ImgProps } from '@components/Img'
-
-import type { CustomComponent } from './blocks'
-import config = require('../../../config/default.json')
-import example = require('../../../config/local.example.json')
-
-import type { Schema } from './server'
-import {
-  OnlyType,
-  DeepMerge,
-  ComparisonReport,
-  Paths,
-  ObjectPathValue,
-} from './utility'
-import { Strategy } from './general'
-import { TileLayer } from './client'
-
+import type { LogLevelNames } from 'loglevel'
+import type { DialogProps } from '@mui/material'
+import type { UiconsIndex } from 'uicons.js'
+
+import { Props as ImgProps } from '@components/Img'
+
+import type { CustomComponent } from './blocks'
+import config = require('../../../config/default.json')
+import example = require('../../../config/local.example.json')
+
+import type { Schema } from './server'
+import {
+  OnlyType,
+  DeepMerge,
+  ComparisonReport,
+  Paths,
+  ObjectPathValue,
+} from './utility'
+import { Strategy } from './general'
+import { TileLayer } from './client'
+
 type BaseConfig = typeof config
 type ExampleConfig = typeof example
 
+/** Discord role ID or user ID that can gate access to resources */
+type AuthIdentifier = string
+
 export type ConfigAreas = Awaited<
   ReturnType<(typeof import('server/src/services/areas'))['loadLatestAreas']>
 >
-
-export type Config<Client extends boolean = false> = DeepMerge<
-  Omit<BaseConfig, 'icons' | 'manualAreas'>,
-  {
-    client: Client extends true
-      ? {
-          version: string
-          locales: string[]
-          localeStatus: ReturnType<
-            (typeof import('@rm/locales/lib/utils'))['getStatus']
-          >
-          hasCustom: boolean
-          title: string
-        }
-      : never
-    webhooks: Webhook[]
-    tileServers: TileLayer[]
-    devOptions: {
-      logLevel: LogLevelNames
-      skipUpdateCheck?: boolean
-    }
-    defaultFilters: {
-      s2cells: {
-        cells: number[]
-      }
-    }
-    areas: ConfigAreas
+
+export type Config<Client extends boolean = false> = DeepMerge<
+  Omit<BaseConfig, 'icons' | 'manualAreas'>,
+  {
+    client: Client extends true
+      ? {
+          version: string
+          locales: string[]
+          localeStatus: ReturnType<
+            (typeof import('@rm/locales/lib/utils'))['getStatus']
+          >
+          hasCustom: boolean
+          title: string
+        }
+      : never
+    webhooks: Webhook[]
+    tileServers: TileLayer[]
+    devOptions: {
+      logLevel: LogLevelNames
+      skipUpdateCheck?: boolean
+    }
+    defaultFilters: {
+      s2cells: {
+        cells: number[]
+      }
+    }
+    areas: ConfigAreas
     authentication: {
-      areaRestrictions: { roles: string[]; areas: string[] }[]
-      // Unfortunately these types are not convenient for looping the `perms` object...
-      // excludeFromTutorial: (keyof BaseConfig['authentication']['perms'])[]
-      // alwaysEnabledPerms: (keyof BaseConfig['authentication']['perms'])[]
-      excludeFromTutorial: string[]
-      alwaysEnabledPerms: string[]
-      aliases: { role: string | string[]; name: string }[]
-      methods: Strategy[]
-      strategies: {
-        type: Strategy
+      areaRestrictions: { roles: AuthIdentifier[]; areas: string[] }[]
+      // Unfortunately these types are not convenient for looping the `perms` object...
+      // excludeFromTutorial: (keyof BaseConfig['authentication']['perms'])[]
+      // alwaysEnabledPerms: (keyof BaseConfig['authentication']['perms'])[]
+      excludeFromTutorial: string[]
+      alwaysEnabledPerms: string[]
+      aliases: { role: AuthIdentifier | AuthIdentifier[]; name: string }[]
+      methods: Strategy[]
+      strategies: {
+        type: Strategy
         trialPeriod: {
           start: TrialPeriodDate
           end: TrialPeriodDate
-          roles: string[]
+          roles: AuthIdentifier[]
         }
-        allowedGuilds: string[]
-        blockedGuilds: string[]
-        allowedUsers: string[]
-      }[]
-      perms: {
-        [K in keyof BaseConfig['authentication']['perms']]: Omit<
-          BaseConfig['authentication']['perms'][K],
-          'roles'
-        > & { roles: string[] }
-      }
-    }
-    api: {
-      pvp: {
-        leagues: {
-          minRank?: number
-          maxRank?: number
-          littleCupRules?: boolean
-        }[]
-        leagueObj: {
-          [key in BaseConfig['api']['pvp']['leagues'][number]['name']]:
-            | number
-            | { little: false; cap: number }
-        }
-      }
-    }
-    map: {
-      domain?: string
-      misc: {
-        /** @deprecated */
-        distance?: string
-      }
-      messageOfTheDay: {
-        settings: {
-          parentStyle: Record<string, string> // should be CSS properties but performance seems to die
-        }
-        titles: string[]
-        components: CustomComponent[]
-        footerButtons: CustomComponent[]
-        dialogMaxWidth: DialogProps['maxWidth']
-      }
-      donationPage: {
-        settings: {
-          parentStyle: Record<string, string> // should be CSS properties but performance seems to die
-        }
-        titles: string[]
-        components: CustomComponent[]
-        footerButtons: CustomComponent[]
-      }
-      loginPage: {
-        settings: {
-          parentStyle: Record<string, string> // should be CSS properties but performance seems to die
-        }
-        components: CustomComponent[]
-      }
-    }
-    multiDomains: MultiDomain[]
-    multiDomainsObj: Record<string, MultiDomain>
-    database: {
-      schemas: Schema[]
-      settings: {
-        extraUserFields: (ExtraField | string)[]
+        allowedGuilds: string[]
+        blockedGuilds: string[]
+        allowedUsers: string[]
+      }[]
+      perms: {
+        [K in keyof BaseConfig['authentication']['perms']]: Omit<
+          BaseConfig['authentication']['perms'][K],
+          'roles'
+        > & { roles: AuthIdentifier[] }
       }
     }
+    api: {
+      pvp: {
+        leagues: {
+          minRank?: number
+          maxRank?: number
+          littleCupRules?: boolean
+        }[]
+        leagueObj: {
+          [key in BaseConfig['api']['pvp']['leagues'][number]['name']]:
+            | number
+            | { little: false; cap: number }
+        }
+      }
+    }
+    map: {
+      domain?: string
+      misc: {
+        /** @deprecated */
+        distance?: string
+      }
+      messageOfTheDay: {
+        settings: {
+          parentStyle: Record<string, string> // should be CSS properties but performance seems to die
+        }
+        titles: string[]
+        components: CustomComponent[]
+        footerButtons: CustomComponent[]
+        dialogMaxWidth: DialogProps['maxWidth']
+      }
+      donationPage: {
+        settings: {
+          parentStyle: Record<string, string> // should be CSS properties but performance seems to die
+        }
+        titles: string[]
+        components: CustomComponent[]
+        footerButtons: CustomComponent[]
+      }
+      loginPage: {
+        settings: {
+          parentStyle: Record<string, string> // should be CSS properties but performance seems to die
+        }
+        components: CustomComponent[]
+      }
+    }
+    multiDomains: MultiDomain[]
+    multiDomainsObj: Record<string, MultiDomain>
+    database: {
+      schemas: Schema[]
+      settings: {
+        extraUserFields: (ExtraField | string)[]
+      }
+    }
     scanner: {
       scanNext: {
-        discordRoles: string[]
+        discordRoles: AuthIdentifier[]
         telegramGroups: string[]
         local: string[]
       }
       scanZone: {
-        discordRoles: string[]
+        discordRoles: AuthIdentifier[]
         telegramGroups: string[]
         local: string[]
       }
     }
-    icons: Icons
-    manualAreas: ExampleConfig['manualAreas'][number][]
-  }
->
-
-// unclear why this is needed, but it is for the MultiDomain type to parse...
-type Map = Config['map']
-
-export interface MultiDomain extends Map {
-  domain: string
-}
-
-export interface Icons extends Omit<BaseConfig['icons'], 'styles'> {
-  customizable: string[]
-  styles: (ExampleConfig['icons']['styles'][number] & {
-    data?: UiconsIndex
-  })[]
-  defaultIcons: Record<string, string>
-}
-
-export type StrategyConfig = Config['authentication']['strategies'][number]
-
-export interface TrialPeriodDate {
-  year?: number
-  month?: number
-  day?: number
-  hour?: number
-  minute?: number
-  second?: number
-  millisecond?: number
-}
-
-export interface ExtraField {
-  name: string
-  database: string
-  disabled: boolean
-}
-
-export interface Webhook {
-  enabled: boolean
-  provider: 'poracle'
-  name: string
-  host: string
-  port: number
-  poracleSecret: string
-  addressFormat?: string
-  nominatimUrl?: string
+    icons: Icons
+    manualAreas: ExampleConfig['manualAreas'][number][]
+  }
+>
+
+// unclear why this is needed, but it is for the MultiDomain type to parse...
+type Map = Config['map']
+
+export interface MultiDomain extends Map {
+  domain: string
+}
+
+export interface Icons extends Omit<BaseConfig['icons'], 'styles'> {
+  customizable: string[]
+  styles: (ExampleConfig['icons']['styles'][number] & {
+    data?: UiconsIndex
+  })[]
+  defaultIcons: Record<string, string>
+}
+
+export type StrategyConfig = Config['authentication']['strategies'][number]
+
+export interface TrialPeriodDate {
+  year?: number
+  month?: number
+  day?: number
+  hour?: number
+  minute?: number
+  second?: number
+  millisecond?: number
+}
+
+export interface ExtraField {
+  name: string
+  database: string
+  disabled: boolean
+}
+
+export interface Webhook {
+  enabled: boolean
+  provider: 'poracle'
+  name: string
+  host: string
+  port: number
+  poracleSecret: string
+  addressFormat?: string
+  nominatimUrl?: string
   trialPeriodEligible?: boolean
   areasToSkip: string[]
-  discordRoles: []
+  discordRoles: AuthIdentifier[]
   telegramGroups: []
   local: []
 }
-
-export interface GridSizes {
-  xs?: number
-  sm?: number
-  md?: number
-  lg?: number
-  xl?: number
-}
-
-export type GetSafeConfig = <P extends Paths<Config>>(
-  path: P,
-) => ObjectPathValue<Config, P>
-
-export type ConfigEqualReport = ComparisonReport<Omit<Config, 'areas'>>
+
+export interface GridSizes {
+  xs?: number
+  sm?: number
+  md?: number
+  lg?: number
+  xl?: number
+}
+
+export type GetSafeConfig = <P extends Paths<Config>>(
+  path: P,
+) => ObjectPathValue<Config, P>
+
+export type ConfigEqualReport = ComparisonReport<Omit<Config, 'areas'>>