aboutsummaryrefslogtreecommitdiff
path: root/lib/models/instance/ModLog.ts
blob: c25f0430ca4385f36b86596a272f62a8fea0c086 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
import { type Snowflake } from 'discord.js';
import { nanoid } from 'nanoid';
import { type Sequelize } from 'sequelize';
import { BaseModel } from '../BaseModel.js';
const { DataTypes } = (await import('sequelize')).default;

export enum ModLogType {
	PERM_BAN = 'PERM_BAN',
	TEMP_BAN = 'TEMP_BAN',
	UNBAN = 'UNBAN',
	KICK = 'KICK',
	PERM_MUTE = 'PERM_MUTE',
	TEMP_MUTE = 'TEMP_MUTE',
	UNMUTE = 'UNMUTE',
	WARN = 'WARN',
	PERM_PUNISHMENT_ROLE = 'PERM_PUNISHMENT_ROLE',
	TEMP_PUNISHMENT_ROLE = 'TEMP_PUNISHMENT_ROLE',
	REMOVE_PUNISHMENT_ROLE = 'REMOVE_PUNISHMENT_ROLE',
	PERM_CHANNEL_BLOCK = 'PERM_CHANNEL_BLOCK',
	TEMP_CHANNEL_BLOCK = 'TEMP_CHANNEL_BLOCK',
	CHANNEL_UNBLOCK = 'CHANNEL_UNBLOCK',
	TIMEOUT = 'TIMEOUT',
	REMOVE_TIMEOUT = 'REMOVE_TIMEOUT'
}

export interface ModLogModel {
	id: string;
	type: ModLogType;
	user: Snowflake;
	moderator: Snowflake;
	reason: string | null;
	duration: number | null;
	guild: Snowflake;
	evidence: string;
	pseudo: boolean;
	hidden: boolean;
}

export interface ModLogModelCreationAttributes {
	id?: string;
	type: ModLogType;
	user: Snowflake;
	moderator: Snowflake;
	reason?: string | null;
	duration?: number;
	guild: Snowflake;
	evidence?: string;
	pseudo?: boolean;
	hidden?: boolean;
}

/**
 * A mod log case.
 */
export class ModLog extends BaseModel<ModLogModel, ModLogModelCreationAttributes> implements ModLogModel {
	/**
	 * The primary key of the modlog entry.
	 */
	public declare id: string;

	/**
	 * The type of punishment.
	 */
	public declare type: ModLogType;

	/**
	 * The user being punished.
	 */
	public declare user: Snowflake;

	/**
	 * The user carrying out the punishment.
	 */
	public declare moderator: Snowflake;

	/**
	 * The reason the user is getting punished.
	 */
	public declare reason: string | null;

	/**
	 * The amount of time the user is getting punished for.
	 */
	public declare duration: number | null;

	/**
	 * The guild the user is getting punished in.
	 */
	public declare guild: Snowflake;

	/**
	 * Evidence of what the user is getting punished for.
	 */
	public declare evidence: string;

	/**
	 * Not an actual modlog just used so a punishment entry can be made.
	 */
	public declare pseudo: boolean;

	/**
	 * Hides from the modlog command unless show hidden is specified.
	 */
	public declare hidden: boolean;

	/**
	 * Initializes the model.
	 * @param sequelize The sequelize instance.
	 */
	public static initModel(sequelize: Sequelize): void {
		ModLog.init(
			{
				id: { type: DataTypes.STRING, primaryKey: true, allowNull: false, defaultValue: nanoid },
				type: { type: DataTypes.STRING, allowNull: false }, //? This is not an enum because of a sequelize issue: https://github.com/sequelize/sequelize/issues/2554
				user: { type: DataTypes.STRING, allowNull: false },
				moderator: { type: DataTypes.STRING, allowNull: false },
				duration: { type: DataTypes.STRING, allowNull: true },
				reason: { type: DataTypes.TEXT, allowNull: true },
				guild: { type: DataTypes.STRING, references: { model: 'Guilds', key: 'id' } },
				evidence: { type: DataTypes.TEXT, allowNull: true },
				pseudo: { type: DataTypes.BOOLEAN, allowNull: false, defaultValue: false },
				hidden: { type: DataTypes.BOOLEAN, allowNull: false, defaultValue: false }
			},
			{ sequelize }
		);
	}
}