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

export interface GlobalModel {
	environment: 'production' | 'development' | 'beta';
	disabledCommands: string[];
	blacklistedUsers: Snowflake[];
	blacklistedGuilds: Snowflake[];
	blacklistedChannels: Snowflake[];
}

export interface GlobalModelCreationAttributes {
	environment: 'production' | 'development' | 'beta';
	disabledCommands?: string[];
	blacklistedUsers?: Snowflake[];
	blacklistedGuilds?: Snowflake[];
	blacklistedChannels?: Snowflake[];
}

/**
 * Data specific to a certain instance of the bot.
 */
export class Global extends BaseModel<GlobalModel, GlobalModelCreationAttributes> implements GlobalModel {
	/**
	 * The bot's environment.
	 */
	public declare environment: 'production' | 'development' | 'beta';

	/**
	 * Globally disabled commands.
	 */
	public declare disabledCommands: string[];

	/**
	 * Globally blacklisted users.
	 */
	public declare blacklistedUsers: Snowflake[];

	/**
	 * Guilds blacklisted from using the bot.
	 */
	public declare blacklistedGuilds: Snowflake[];

	/**
	 * Channels where the bot is prevented from running commands in.
	 */
	public declare blacklistedChannels: Snowflake[];

	/**
	 * Initializes the model.
	 * @param sequelize The sequelize instance.
	 */
	public static initModel(sequelize: Sequelize): void {
		Global.init(
			{
				environment: { type: DataTypes.STRING, primaryKey: true },
				disabledCommands: { type: DataTypes.JSONB, allowNull: false, defaultValue: [] },
				blacklistedUsers: { type: DataTypes.JSONB, allowNull: false, defaultValue: [] },
				blacklistedGuilds: { type: DataTypes.JSONB, allowNull: false, defaultValue: [] },
				blacklistedChannels: { type: DataTypes.JSONB, allowNull: false, defaultValue: [] }
			},
			{ sequelize }
		);
	}
}