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
|
import { type Snowflake } from 'discord.js';
import { nanoid } from 'nanoid';
import { DataTypes, type Sequelize } from 'sequelize';
import { BaseModel } from '../BaseModel.js';
export enum ModLogType {
PermBan = 'PERM_BAN',
TempBan = 'TEMP_BAN',
Unban = 'UNBAN',
Kick = 'KICK',
PermMute = 'PERM_MUTE',
TempMute = 'TEMP_MUTE',
Unmute = 'UNMUTE',
Warn = 'WARN',
PermPunishmentRole = 'PERM_PUNISHMENT_ROLE',
TempPunishmentRole = 'TEMP_PUNISHMENT_ROLE',
RemovePunishmentRole = 'REMOVE_PUNISHMENT_ROLE',
PermChannelBlock = 'PERM_CHANNEL_BLOCK',
TempChannelBlock = 'TEMP_CHANNEL_BLOCK',
ChannelUnblock = 'CHANNEL_UNBLOCK',
Timeout = 'TIMEOUT',
RemoveTimeout = 'REMOVE_TIMEOUT'
}
export enum AppealStatus {
None = 'NONE',
Submitted = 'SUBMITTED',
Accepted = 'ACCEPTED',
Denied = 'DENIED'
}
export interface ModLogModel {
/**
* The primary key of the modlog entry.
*/
id: string;
/**
* The type of punishment.
*/
type: ModLogType;
/**
* The user being punished.
*/
user: Snowflake;
/**
* The user carrying out the punishment.
*/
moderator: Snowflake;
/**
* The reason the user is getting punished.
*/
reason: string | null;
/**
* The amount of time the user is getting punished for.
*/
duration: number | null;
/**
* The guild the user is getting punished in.
*/
guild: Snowflake;
/**
* Evidence of what the user is getting punished for.
*/
evidence: string;
/**
* Not an actual modlog just used so a punishment entry can be made.
*/
pseudo: boolean;
/**
* Hides from the modlog command unless show hidden is specified.
*/
hidden: boolean;
/**
* The status of an appeal for this punishment
*/
appeal: AppealStatus;
}
export interface ModLogModelCreationAttributes {
id?: string;
type: ModLogType;
user: Snowflake;
moderator: Snowflake;
reason?: string | null;
duration?: number;
guild: Snowflake;
evidence?: string;
pseudo?: boolean;
hidden?: boolean;
appeal?: AppealStatus;
}
export interface ModLog extends ModLogModel {}
/**
* A mod log case.
*/
export class ModLog extends BaseModel<ModLogModel, ModLogModelCreationAttributes> {
/**
* 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 },
appeal: { type: DataTypes.STRING, allowNull: false, defaultValue: AppealStatus.None }
},
{ sequelize }
);
}
}
|
