aboutsummaryrefslogtreecommitdiff
path: root/lib/models/instance/ActivePunishment.ts
blob: 9bd9d0136891fe494a1325c116e3d89e5140f3e0 (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
import { type Snowflake } from 'discord.js';
import { nanoid } from 'nanoid';
import { DataTypes, type Sequelize } from 'sequelize';
import { BaseModel } from '../BaseModel.js';

export enum ActivePunishmentType {
	BAN = 'BAN',
	MUTE = 'MUTE',
	ROLE = 'ROLE',
	BLOCK = 'BLOCK'
}

export interface ActivePunishmentModel {
	id: string;
	type: ActivePunishmentType;
	user: Snowflake;
	guild: Snowflake;
	extraInfo: Snowflake;
	expires: Date | null;
	modlog: string;
}

export interface ActivePunishmentModelCreationAttributes {
	id?: string;
	type: ActivePunishmentType;
	user: Snowflake;
	guild: Snowflake;
	extraInfo?: Snowflake;
	expires?: Date;
	modlog: string;
}

/**
 * Keeps track of active punishments so they can be removed later.
 */
export class ActivePunishment
	extends BaseModel<ActivePunishmentModel, ActivePunishmentModelCreationAttributes>
	implements ActivePunishmentModel
{
	/**
	 * The ID of this punishment (no real use just for a primary key)
	 */
	public declare id: string;

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

	/**
	 * The user who is punished.
	 */
	public declare user: Snowflake;

	/**
	 * The guild they are punished in.
	 */
	public declare guild: Snowflake;

	/**
	 * Additional info about the punishment if applicable. The channel id for channel blocks and role for punishment roles.
	 */
	public declare extraInfo: Snowflake;

	/**
	 * The date when this punishment expires (optional).
	 */
	public declare expires: Date | null;

	/**
	 * The reference to the modlog entry.
	 */
	public declare modlog: string;

	/**
	 * Initializes the model.
	 * @param sequelize The sequelize instance.
	 */
	public static initModel(sequelize: Sequelize): void {
		ActivePunishment.init(
			{
				id: { type: DataTypes.STRING, primaryKey: true, defaultValue: nanoid },
				type: { type: DataTypes.STRING, allowNull: false },
				user: { type: DataTypes.STRING, allowNull: false },
				guild: { type: DataTypes.STRING, allowNull: false, references: { model: 'Guilds', key: 'id' } },
				extraInfo: { type: DataTypes.STRING, allowNull: true },
				expires: { type: DataTypes.DATE, allowNull: true },
				modlog: { type: DataTypes.STRING, allowNull: true, references: { model: 'ModLogs', key: 'id' } }
			},
			{ sequelize }
		);
	}
}