src/utils/AbstractPermissionManager.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 { Awaitable, GuildMember, PermissionResolvable } from "discord.js";
import Client from "../core/Client";
import { GetMemberPermissionInGuildResult } from "../services/PermissionManager";

export default abstract class AbstractPermissionManager {
    protected hasSyncedInitially = false;

    constructor(protected readonly client: Client) {}

    triggerSyncIfNeeded() {
        if (!this.hasSyncedInitially) {
            this.hasSyncedInitially = true;
            return this.sync?.();
        }

        return null;
    }

    sync?(): Awaitable<void>;
    abstract shouldModerate(member: GuildMember, moderator: GuildMember): Awaitable<boolean>;
    abstract isImmuneToAutoMod(
        member: GuildMember,
        permission?: PermissionResolvable[] | PermissionResolvable
    ): Awaitable<boolean>;
    abstract getMemberPermissions(member: GuildMember, mergeWithDiscordPermissions?: boolean): GetMemberPermissionInGuildResult;
}
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 { Awaitable, GuildMember, PermissionResolvable } from "discord.js";
21	import Client from "../core/Client";
22	import { GetMemberPermissionInGuildResult } from "../services/PermissionManager";
23
24	export default abstract class AbstractPermissionManager {
25	protected hasSyncedInitially = false;
26
27	constructor(protected readonly client: Client) {}
28
29	triggerSyncIfNeeded() {
30	if (!this.hasSyncedInitially) {
31	this.hasSyncedInitially = true;
32	return this.sync?.();
33	}
34
35	return null;
36	}
37
38	sync?(): Awaitable<void>;
39	abstract shouldModerate(member: GuildMember, moderator: GuildMember): Awaitable<boolean>;
40	abstract isImmuneToAutoMod(
41	member: GuildMember,
42	permission?: PermissionResolvable[] \| PermissionResolvable
43	): Awaitable<boolean>;
44	abstract getMemberPermissions(member: GuildMember, mergeWithDiscordPermissions?: boolean): GetMemberPermissionInGuildResult;
45	}