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

export interface StickyRoleModel {
	user: Snowflake;
	guild: Snowflake;
	roles: Snowflake[];
	nickname: string;
}
export interface StickyRoleModelCreationAttributes {
	user: Snowflake;
	guild: Snowflake;
	roles: Snowflake[];
	nickname?: string;
}

/**
 * Information about a user's roles and nickname when they leave a guild.
 */
export class StickyRole extends BaseModel<StickyRoleModel, StickyRoleModelCreationAttributes> implements StickyRoleModel {
	/**
	 * The id of the user the roles belongs to.
	 */
	public declare user: Snowflake;

	/**
	 * The guild where this should happen.
	 */
	public declare guild: Snowflake;

	/**
	 * The roles that the user should have returned
	 */
	public declare roles: Snowflake[];

	/**
	 * The user's previous nickname
	 */
	public declare nickname: string;

	/**
	 * Initializes the model.
	 * @param sequelize The sequelize instance.
	 */
	public static initModel(sequelize: Sequelize): void {
		StickyRole.init(
			{
				user: { type: DataTypes.STRING, allowNull: false },
				guild: { type: DataTypes.STRING, allowNull: false },
				roles: { type: DataTypes.JSONB, allowNull: false, defaultValue: [] },
				nickname: { type: DataTypes.STRING, allowNull: true }
			},
			{ sequelize }
		);
	}
}