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

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

// declaration merging so that the fields don't override Sequelize's getters
export interface ActivePunishment {
	/** The ID of this punishment (no real use just for a primary key) */
	id: string;

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

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

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

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

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

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

export class ActivePunishment
	extends BaseModel<ActivePunishmentModel, ActivePunishmentModelCreationAttributes>
	implements ActivePunishmentModel
{
	public static initModel(sequelize: Sequelize): void {
		ActivePunishment.init(
			{
				id: { type: DataTypes.STRING, primaryKey: true, allowNull: false, 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 }
		);
	}
}