src/utils/userflags.ts

/*
* This file is part of SudoBot.
*
* Copyright (C) 2021-2023 OSN Developers.
*
* SudoBot is free software; you can redistribute it and/or modify it
* under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* SudoBot is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with SudoBot. If not, see <https://www.gnu.org/licenses/>.
*/

import { User, UserFlags } from "discord.js";

const flagmap = new Map<UserFlags, string>([
    [UserFlags.ActiveDeveloper, "User is an active developer"],
    [UserFlags.BotHTTPInteractions, "Uses application commands"],
    [UserFlags.BugHunterLevel1, "Bug hunter: Level 1"],
    [UserFlags.BugHunterLevel2, "Bug hunter: Level 2"],
    [UserFlags.CertifiedModerator, "Discord Certified Moderator"],
    [UserFlags.Collaborator, "User is a collaborator and has staff permissions"],
    [UserFlags.DisablePremium, "Nitro features are forcefully turned off for this account"],
    [UserFlags.HasUnreadUrgentMessages, "This user has unread urgent messages from Discord"],
    [UserFlags.HypeSquadOnlineHouse1, "Hypesquad Bravery"],
    [UserFlags.HypeSquadOnlineHouse2, "Hypesquad Brilliance"],
    [UserFlags.HypeSquadOnlineHouse3, "Hypesquad Balance"],
    [UserFlags.Hypesquad, "This user is a Hypesquad Events member"],
    [UserFlags.MFASMS, "This user has SMS-verification enabled"],
    [UserFlags.Partner, "This user owns a Discord-partnered server"],
    [UserFlags.PremiumEarlySupporter, "This user is a early supporter"],
    [UserFlags.PremiumPromoDismissed, "PremiumPromoDismissed (This flag is not exactly known yet)"],
    [UserFlags.Quarantined, "This account has been quarantined due to recent activity (Limited access)"],
    [UserFlags.RestrictedCollaborator, "User is a restricted collaborator and has staff permissions."],
    [UserFlags.Spammer, "This user has been flagged as a spammer"],
    [UserFlags.Staff, "This user is a Discord Employee"],
    [UserFlags.TeamPseudoUser, "This account is a Team account."],
    [UserFlags.VerifiedBot, "This bot is verified"],
    [UserFlags.VerifiedDeveloper, "This user is a verified bot developer"]
]);

export const flagsToString = (flags: Exclude<User["flags"], null>) => {
    const strings = [];

    for (const [flag, description] of flagmap.entries()) {
        if (flags.has(flag as any)) {
            strings.push(description);
        }
    }

    return strings;
};
1	/*
2	* This file is part of SudoBot.
3	*
4	* Copyright (C) 2021-2023 OSN Developers.
5	*
6	* SudoBot is free software; you can redistribute it and/or modify it
7	* under the terms of the GNU Affero General Public License as published by
8	* the Free Software Foundation, either version 3 of the License, or
9	* (at your option) any later version.
10	*
11	* SudoBot is distributed in the hope that it will be useful, but
12	* WITHOUT ANY WARRANTY; without even the implied warranty of
13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14	* GNU Affero General Public License for more details.
15	*
16	* You should have received a copy of the GNU Affero General Public License
17	* along with SudoBot. If not, see <https://www.gnu.org/licenses/>.
18	*/
19
20	import { User, UserFlags } from "discord.js";
21
22	const flagmap = new Map<UserFlags, string>([
23	[UserFlags.ActiveDeveloper, "User is an active developer"],
24	[UserFlags.BotHTTPInteractions, "Uses application commands"],
25	[UserFlags.BugHunterLevel1, "Bug hunter: Level 1"],
26	[UserFlags.BugHunterLevel2, "Bug hunter: Level 2"],
27	[UserFlags.CertifiedModerator, "Discord Certified Moderator"],
28	[UserFlags.Collaborator, "User is a collaborator and has staff permissions"],
29	[UserFlags.DisablePremium, "Nitro features are forcefully turned off for this account"],
30	[UserFlags.HasUnreadUrgentMessages, "This user has unread urgent messages from Discord"],
31	[UserFlags.HypeSquadOnlineHouse1, "Hypesquad Bravery"],
32	[UserFlags.HypeSquadOnlineHouse2, "Hypesquad Brilliance"],
33	[UserFlags.HypeSquadOnlineHouse3, "Hypesquad Balance"],
34	[UserFlags.Hypesquad, "This user is a Hypesquad Events member"],
35	[UserFlags.MFASMS, "This user has SMS-verification enabled"],
36	[UserFlags.Partner, "This user owns a Discord-partnered server"],
37	[UserFlags.PremiumEarlySupporter, "This user is a early supporter"],
38	[UserFlags.PremiumPromoDismissed, "PremiumPromoDismissed (This flag is not exactly known yet)"],
39	[UserFlags.Quarantined, "This account has been quarantined due to recent activity (Limited access)"],
40	[UserFlags.RestrictedCollaborator, "User is a restricted collaborator and has staff permissions."],
41	[UserFlags.Spammer, "This user has been flagged as a spammer"],
42	[UserFlags.Staff, "This user is a Discord Employee"],
43	[UserFlags.TeamPseudoUser, "This account is a Team account."],
44	[UserFlags.VerifiedBot, "This bot is verified"],
45	[UserFlags.VerifiedDeveloper, "This user is a verified bot developer"]
46	]);
47
48	export const flagsToString = (flags: Exclude<User["flags"], null>) => {
49	const strings = [];
50
51	for (const [flag, description] of flagmap.entries()) {
52	if (flags.has(flag as any)) {
53	strings.push(description);
54	}
55	}
56
57	return strings;
58	};