Make ConfigValue a directory, move defaults to those classes instead of a separate object

src/util/config/Config.ts

@@ -0,0 +1,22 @@
+import { ApiConfiguration, ClientConfiguration, DefaultsConfiguration, EndpointConfiguration, GeneralConfiguration, GifConfiguration, GuildConfiguration, KafkaConfiguration, LimitsConfiguration, LoginConfiguration, MetricsConfiguration, RabbitMQConfiguration, RegionConfiguration, RegisterConfiguration, SecurityConfiguration, SentryConfiguration, TemplateConfiguration } from "../config";
+
+export class ConfigValue {
+	gateway: EndpointConfiguration = new EndpointConfiguration();
+	cdn: EndpointConfiguration = new EndpointConfiguration();
+	api: ApiConfiguration = new ApiConfiguration();
+	general: GeneralConfiguration = new GeneralConfiguration();
+	limits: LimitsConfiguration = new LimitsConfiguration();
+	security: SecurityConfiguration = new SecurityConfiguration();
+	login: LoginConfiguration = new LoginConfiguration();
+	register: RegisterConfiguration = new RegisterConfiguration();
+	regions: RegionConfiguration = new RegionConfiguration();
+	guild: GuildConfiguration = new GuildConfiguration();
+	gif: GifConfiguration = new GifConfiguration();
+	rabbitmq: RabbitMQConfiguration = new RabbitMQConfiguration();
+	kafka: KafkaConfiguration = new KafkaConfiguration();
+	templates: TemplateConfiguration = new TemplateConfiguration();
+	client: ClientConfiguration = new ClientConfiguration();
+	metrics: MetricsConfiguration = new MetricsConfiguration();
+	sentry: SentryConfiguration = new SentryConfiguration();
+	defaults: DefaultsConfiguration = new DefaultsConfiguration();
+}

src/util/config/index.ts

@@ -0,0 +1,2 @@
+export * from "./Config";
+export * from "./types/index";

src/util/config/types/ApiConfiguration.ts

@@ -0,0 +1,5 @@
+export class ApiConfiguration {
+	defaultVersion: string = "9";
+	activeVersions: string[] = ["6", "7", "8", "9"];
+	useFosscordEnhancements: boolean = true;
+}

src/util/config/types/ClientConfiguration.ts

@@ -0,0 +1,8 @@
+import { ClientReleaseConfiguration } from ".";
+
+export class ClientConfiguration {
+    //classes
+    releases: ClientReleaseConfiguration = new ClientReleaseConfiguration();
+    //base types
+    useTestClient: boolean = true;
+}

src/util/config/types/DefaultsConfiguration.ts

@@ -0,0 +1,5 @@
+import { GuildDefaults } from ".";
+
+export class DefaultsConfiguration {
+    guild: GuildDefaults = new GuildDefaults();
+}

src/util/config/types/EndpointConfiguration.ts

@@ -0,0 +1,5 @@
+export class EndpointConfiguration {
+	endpointClient: string | null = null;
+	endpointPrivate: string | null = null;
+	endpointPublic: string | null = null;
+}

src/util/config/types/GeneralConfiguration.ts

@@ -0,0 +1,12 @@
+import { Snowflake } from "../../util";
+
+export class GeneralConfiguration {
+	instanceName: string = "Fosscord Instance";
+	instanceDescription: string | null = "This is a Fosscord instance made in the pre-release days";
+	frontPage: string | null = null;
+	tosPage: string | null = null;
+	correspondenceEmail: string | null = "noreply@localhost.local";
+	correspondenceUserID: string | null = null;
+	image: string | null = null;
+	instanceId: string = Snowflake.generate();
+}

src/util/config/types/GifConfiguration.ts

@@ -0,0 +1,5 @@
+export class GifConfiguration {
+    enabled: boolean = true;
+    provider: "tenor" = "tenor"; // more coming soon
+    apiKey?: string = "LIVDSRZULELA";
+}

src/util/config/types/GuildConfiguration.ts

@@ -0,0 +1,6 @@
+import { DiscoveryConfiguration, AutoJoinConfiguration } from ".";
+
+export class GuildConfiguration {
+    discovery: DiscoveryConfiguration = new DiscoveryConfiguration();
+    autoJoin: AutoJoinConfiguration = new AutoJoinConfiguration();
+}

src/util/config/types/KafkaConfiguration.ts

@@ -0,0 +1,5 @@
+import { KafkaBroker } from ".";
+
+export class KafkaConfiguration {
+    brokers: KafkaBroker[] | null = null;
+}

src/util/config/types/LimitConfigurations.ts

@@ -0,0 +1,9 @@
+import { ChannelLimits, GuildLimits, MessageLimits, RateLimits, UserLimits } from ".";
+
+export class LimitsConfiguration {
+	user: UserLimits = new UserLimits();
+	guild: GuildLimits = new GuildLimits();
+	message: MessageLimits = new MessageLimits();
+	channel: ChannelLimits = new ChannelLimits();
+	rate: RateLimits = new RateLimits();
+}

src/util/config/types/LoginConfiguration.ts

@@ -0,0 +1,3 @@
+export class LoginConfiguration {
+    requireCaptcha: boolean = false;
+}

src/util/config/types/MetricsConfiguration.ts

@@ -0,0 +1,3 @@
+export class MetricsConfiguration {
+    timeout: number = 30000;
+}

src/util/config/types/RabbitMQConfiguration.ts

@@ -0,0 +1,3 @@
+export class RabbitMQConfiguration {
+    host: string | null = null;
+}

src/util/config/types/RegionConfiguration.ts

@@ -0,0 +1,16 @@
+import { Region } from ".";
+
+export class RegionConfiguration {
+    default: string = "fosscord";
+    useDefaultAsOptimal: boolean = true;
+    available: Region[] = [
+        {
+            id: "fosscord",
+            name: "Fosscord",
+            endpoint: "127.0.0.1:3004",
+            vip: false,
+            custom: false,
+            deprecated: false,
+        },
+    ];
+}

src/util/config/types/RegisterConfiguration.ts

@@ -0,0 +1,18 @@
+import { DateOfBirthConfiguration, EmailConfiguration, PasswordConfiguration } from ".";
+
+export class RegisterConfiguration {
+    //classes
+    email: EmailConfiguration = new EmailConfiguration();
+    dateOfBirth: DateOfBirthConfiguration = new DateOfBirthConfiguration();
+    password: PasswordConfiguration = new PasswordConfiguration();
+    //base types
+    disabled: boolean = false;
+    requireCaptcha: boolean = true;
+    requireInvite: boolean = false;
+    guestsRequireInvite: boolean = true;
+    allowNewRegistration: boolean = true;
+    allowMultipleAccounts: boolean = true;
+    blockProxies: boolean = true;
+    incrementingDiscriminators: boolean = false; // random otherwise
+    defaultRights: string = "0";
+}

src/util/config/types/SecurityConfiguration.ts

@@ -0,0 +1,17 @@
+import crypto from "crypto";
+import { CaptchaConfiguration, TwoFactorConfiguration } from ".";
+
+export class SecurityConfiguration {
+    //classes
+    captcha: CaptchaConfiguration = new CaptchaConfiguration();
+    twoFactor: TwoFactorConfiguration = new TwoFactorConfiguration();
+    //base types
+    autoUpdate: boolean | number = true;
+    requestSignature: string = crypto.randomBytes(32).toString("base64");
+    jwtSecret: string = crypto.randomBytes(256).toString("base64");
+    // header to get the real user ip address
+    // X-Forwarded-For for nginx/reverse proxies
+    // CF-Connecting-IP for cloudflare
+    forwadedFor: string | null = null;
+    ipdataApiKey: string | null = "eca677b284b3bac29eb72f5e496aa9047f26543605efe99ff2ce35c9";
+}

src/util/config/types/SentryConfiguration.ts

@@ -0,0 +1,8 @@
+import { hostname } from "os";
+
+export class SentryConfiguration {
+    enabled: boolean = false;
+    endpoint: string = "https://05e8e3d005f34b7d97e920ae5870a5e5@sentry.thearcanebrony.net/6";
+    traceSampleRate: number = 1.0;
+    environment: string = hostname();
+}

src/util/config/types/TemplateConfiguration.ts

@@ -0,0 +1,6 @@
+export class TemplateConfiguration {
+    enabled: boolean = true;
+    allowTemplateCreation: boolean = true;
+    allowDiscordTemplates: boolean = true;
+    allowRaws: boolean = true;
+}

src/util/config/types/index.ts

@@ -0,0 +1,18 @@
+export * from "./ApiConfiguration";
+export * from "./ClientConfiguration";
+export * from "./DefaultsConfiguration";
+export * from "./EndpointConfiguration";
+export * from "./GeneralConfiguration";
+export * from "./GifConfiguration";
+export * from "./GuildConfiguration";
+export * from "./KafkaConfiguration";
+export * from "./LimitConfigurations";
+export * from "./LoginConfiguration";
+export * from "./MetricsConfiguration";
+export * from "./RabbitMQConfiguration";
+export * from "./RegionConfiguration";
+export * from "./RegisterConfiguration";
+export * from "./SecurityConfiguration";
+export * from "./SentryConfiguration";
+export * from "./TemplateConfiguration";
+export * from "./subconfigurations/index";

src/util/config/types/subconfigurations/client/ClientReleaseConfiguration.ts

@@ -0,0 +1,4 @@
+export class ClientReleaseConfiguration {
+    useLocalRelease: boolean = true; //TODO
+    upstreamVersion: string = "0.0.264";
+}

src/util/config/types/subconfigurations/client/index.ts

@@ -0,0 +1 @@
+export * from "./ClientReleaseConfiguration";

src/util/config/types/subconfigurations/defaults/GuildDefaults.ts

@@ -0,0 +1,8 @@
+export class GuildDefaults {
+    maxPresences: number = 250000;
+    maxVideoChannelUsers: number = 200;
+    afkTimeout: number = 300;
+    defaultMessageNotifications: number = 1;
+    explicitContentFilter: number = 0;
+    test: number = 123;
+}

src/util/config/types/subconfigurations/defaults/index.ts

@@ -0,0 +1 @@
+export * from "./GuildDefaults";

src/util/config/types/subconfigurations/guild/AutoJoin.ts

@@ -0,0 +1,5 @@
+export class AutoJoinConfiguration {
+    enabled: boolean = true;
+    guilds: string[] = [];
+    canLeave: boolean = true;
+}

src/util/config/types/subconfigurations/guild/Discovery.ts

@@ -0,0 +1,6 @@
+export class DiscoveryConfiguration {
+    showAllGuilds: boolean = false;
+    useRecommendation: boolean = false; // TODO: Recommendation, privacy concern?
+    offset: number = 0;
+    limit: number = 24;
+}

src/util/config/types/subconfigurations/guild/index.ts

@@ -0,0 +1,2 @@
+export * from "./AutoJoin";
+export * from "./Discovery";

src/util/config/types/subconfigurations/index.ts

@@ -0,0 +1,8 @@
+export * from "./client/index";
+export * from "./defaults/index";
+export * from "./guild/index";
+export * from "./kafka/index";
+export * from "./limits/index";
+export * from "./region/index";
+export * from "./register/index";
+export * from "./security/index";

src/util/config/types/subconfigurations/kafka/KafkaBroker.ts

@@ -0,0 +1,4 @@
+export interface KafkaBroker {
+	ip: string;
+	port: number;
+}

src/util/config/types/subconfigurations/kafka/index.ts

@@ -0,0 +1 @@
+export * from "./KafkaBroker";

src/util/config/types/subconfigurations/limits/ChannelLimits.ts

@@ -0,0 +1,5 @@
+export class ChannelLimits {
+    maxPins: number = 500;
+    maxTopic: number = 1024;
+    maxWebhooks: number = 100;
+}

src/util/config/types/subconfigurations/limits/GuildLimits.ts

@@ -0,0 +1,8 @@
+export class GuildLimits {
+    maxRoles: number = 1000;
+    maxEmojis: number = 2000;
+    maxMembers: number = 25000000;
+    maxChannels: number = 65535;
+    maxChannelsInCategory: number = 65535;
+    hideOfflineMember: number = 3;
+}

src/util/config/types/subconfigurations/limits/MessageLimits.ts

@@ -0,0 +1,8 @@
+export class MessageLimits {
+    maxCharacters: number = 1048576;
+    maxTTSCharacters: number = 160;
+    maxReactions: number = 2048;
+    maxAttachmentSize: number = 1024 * 1024 * 1024;
+    maxBulkDelete: number = 1000;
+    maxEmbedDownloadSize: number = 1024 * 1024 * 5;
+}

src/util/config/types/subconfigurations/limits/RateLimits.ts

@@ -0,0 +1,18 @@
+import { RouteRateLimit, RateLimitOptions } from ".";
+
+export class RateLimits {
+    disabled: boolean = true;
+    ip: Omit<RateLimitOptions, "bot_count"> = {
+        count: 500,
+        window: 5
+    };
+    global: RateLimitOptions = {
+        count: 250,
+        window: 5
+    };
+    error: RateLimitOptions = {
+        count: 10,
+        window: 5
+    };
+    routes: RouteRateLimit;
+}

src/util/config/types/subconfigurations/limits/UserLimits.ts

@@ -0,0 +1,5 @@
+export class UserLimits {
+    maxGuilds: number = 1048576;
+    maxUsername: number = 127;
+    maxFriends: number = 5000;
+}

src/util/config/types/subconfigurations/limits/index.ts

@@ -0,0 +1,6 @@
+export * from "./ChannelLimits";
+export * from "./GuildLimits";
+export * from "./MessageLimits";
+export * from "./RateLimits";
+export * from "./UserLimits";
+export * from "./ratelimits/index";

src/util/config/types/subconfigurations/limits/ratelimits/Auth.ts

@@ -0,0 +1,12 @@
+import { RateLimitOptions } from "./RateLimitOptions";
+
+export class AuthRateLimit {
+    login: RateLimitOptions = {
+        count: 5,
+        window: 60
+    };
+    register: RateLimitOptions = {
+        count: 2,
+        window: 60 * 60 * 12
+    };
+}

src/util/config/types/subconfigurations/limits/ratelimits/RateLimitOptions.ts

@@ -0,0 +1,6 @@
+export interface RateLimitOptions {
+	bot?: number;
+	count: number;
+	window: number;
+	onyIp?: boolean;
+}

src/util/config/types/subconfigurations/limits/ratelimits/Route.ts

@@ -0,0 +1,19 @@
+import { AuthRateLimit } from ".";
+import { RateLimitOptions } from "./RateLimitOptions";
+
+export class RouteRateLimit {
+    guild: RateLimitOptions = {
+        count: 5,
+        window: 5
+    };
+    webhook: RateLimitOptions = {
+        count: 10,
+        window: 5
+    };
+    channel: RateLimitOptions = {
+        count: 10,
+        window: 5
+    };
+    auth: AuthRateLimit;
+    // TODO: rate limit configuration for all routes
+}

src/util/config/types/subconfigurations/limits/ratelimits/index.ts

@@ -0,0 +1,3 @@
+export * from "./Auth";
+export * from "./RateLimitOptions";
+export * from "./Route";

src/util/config/types/subconfigurations/region/Region.ts

@@ -0,0 +1,12 @@
+export interface Region {
+	id: string;
+	name: string;
+	endpoint: string;
+	location?: {
+		latitude: number;
+		longitude: number;
+	};
+	vip: boolean;
+	custom: boolean;
+	deprecated: boolean;
+}

src/util/config/types/subconfigurations/region/index.ts

@@ -0,0 +1 @@
+export * from "./Region";

src/util/config/types/subconfigurations/register/DateOfBirth.ts

@@ -0,0 +1,4 @@
+export class DateOfBirthConfiguration {
+    required: boolean = true;
+    minimum: number = 13; // in years
+}

src/util/config/types/subconfigurations/register/Email.ts

@@ -0,0 +1,7 @@
+export class EmailConfiguration {
+    required: boolean = false;
+    allowlist: boolean = false;
+    blocklist: boolean = true;
+    domains: string[] = [];// TODO: efficiently save domain blocklist in database
+    // domains: fs.readFileSync(__dirname + "/blockedEmailDomains.txt", { encoding: "utf8" }).split("\n"),
+}

src/util/config/types/subconfigurations/register/Password.ts

@@ -0,0 +1,7 @@
+export class PasswordConfiguration {
+    required: boolean = false;
+    minLength: number = 8;
+    minNumbers: number = 2;
+    minUpperCase: number =2;
+    minSymbols: number = 0;
+}

src/util/config/types/subconfigurations/register/index.ts

@@ -0,0 +1,3 @@
+export * from "./DateOfBirth";
+export * from "./Email";
+export * from "./Password";

src/util/config/types/subconfigurations/security/Captcha.ts

@@ -0,0 +1,6 @@
+export class CaptchaConfiguration {
+    enabled: boolean = false;
+    service: "recaptcha" | "hcaptcha" | null = null; // TODO: hcaptcha, custom
+    sitekey: string | null = null;
+    secret: string | null = null;
+}

src/util/config/types/subconfigurations/security/TwoFactor.ts

@@ -0,0 +1,3 @@
+export class TwoFactorConfiguration {
+    generateBackupCodes: boolean = true;
+}

src/util/config/types/subconfigurations/security/index.ts

@@ -0,0 +1,2 @@
+export * from "./Captcha";
+export * from "./TwoFactor";