aboutsummaryrefslogtreecommitdiff
path: root/src/lib/models/ModLog.ts
blob: 5c873316a947fac98d00ec3e149420f4d638fa76 (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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
import { Snowflake } from 'discord.js';
import { DataTypes, Sequelize } from 'sequelize';
import { v4 as uuidv4 } from 'uuid';
import { BaseModel } from './BaseModel';
import { jsonParseGet, jsonParseSet, NEVER_USED } from './__helpers';

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'
}

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;
}

export class ModLog extends BaseModel<ModLogModel, ModLogModelCreationAttributes> implements ModLogModel {
	/**
	 * The primary key of the modlog entry.
	 */
	public get id(): string {
		throw new Error(NEVER_USED);
	}
	public set id(_: string) {
		throw new Error(NEVER_USED);
	}

	/**
	 * The type of punishment.
	 */
	public get type(): ModLogType {
		throw new Error(NEVER_USED);
	}
	public set type(_: ModLogType) {
		throw new Error(NEVER_USED);
	}

	/**
	 * The user being punished.
	 */
	public get user(): Snowflake {
		throw new Error(NEVER_USED);
	}
	public set user(_: Snowflake) {
		throw new Error(NEVER_USED);
	}

	/**
	 * The user carrying out the punishment.
	 */
	public get moderator(): Snowflake {
		throw new Error(NEVER_USED);
	}
	public set moderator(_: Snowflake) {
		throw new Error(NEVER_USED);
	}

	/**
	 * The reason the user is getting punished
	 */
	public get reason(): string | null {
		throw new Error(NEVER_USED);
	}
	public set reason(_: string | null) {
		throw new Error(NEVER_USED);
	}

	/**
	 * The amount of time the user is getting punished for.
	 */
	public get duration(): number | null {
		throw new Error(NEVER_USED);
	}
	public set duration(_: number | null) {
		throw new Error(NEVER_USED);
	}

	/**
	 * The guild the user is getting punished in.
	 */
	public get guild(): Snowflake {
		throw new Error(NEVER_USED);
	}
	public set guild(_: Snowflake) {
		throw new Error(NEVER_USED);
	}

	/**
	 * Evidence of what the user is getting punished for.
	 */
	public get evidence(): string {
		throw new Error(NEVER_USED);
	}
	public set evidence(_: string) {
		throw new Error(NEVER_USED);
	}

	/**
	 * Not an actual modlog just used so a punishment entry can be made
	 */
	public get pseudo(): boolean {
		throw new Error(NEVER_USED);
	}
	public set pseudo(_: boolean) {
		throw new Error(NEVER_USED);
	}

	/**
	 * Hides from the modlog command unless show hidden is specified.
	 */
	public get hidden(): boolean {
		throw new Error(NEVER_USED);
	}
	public set hidden(_: boolean) {
		throw new Error(NEVER_USED);
	}

	public static initModel(sequelize: Sequelize): void {
		ModLog.init(
			{
				id: {
					type: DataTypes.STRING,
					primaryKey: true,
					allowNull: false,
					defaultValue: uuidv4
				},
				type: {
					type: DataTypes.STRING, //# This is not an enum because of a sequelize issue: https://github.com/sequelize/sequelize/issues/2554
					allowNull: false
				},
				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.STRING,
					get: function (): boolean {
						return jsonParseGet('pseudo', this);
					},
					set: function (val: boolean) {
						return jsonParseSet('pseudo', this, val);
					},
					allowNull: false,
					defaultValue: 'false'
				},
				hidden: {
					type: DataTypes.STRING,
					get: function (): boolean {
						return jsonParseGet('hidden', this);
					},
					set: function (val: boolean) {
						return jsonParseSet('hidden', this, val);
					},
					allowNull: false,
					defaultValue: 'false'
				}
			},
			{ sequelize: sequelize }
		);
	}
}