feat(sg): added custom serializers

src/languages/en-US.ts

@@ -4361,16 +4361,23 @@ export default class extends Language {
 		 * #################################
 		 */
 
-		SERIALIZER_PERMISSION_NODE_INVALID: 'Invalid data.',
-		SERIALIZER_PERMISSION_NODE_INVALID_TARGET: 'No data could be found from the ID.',
-		SERIALIZER_PERMISSION_NODE_INVALID_COMMAND: command => `The command \`${command}\` does not exist or is invalid.`,
+		SERIALIZER_AUTOROLE_INVALID: 'Invalid autorole data.',
+		SERIALIZER_COMMAND_AUTO_DELETE_INVALID: 'Invalid command auto-delete data.',
 		SERIALIZER_CUSTOM_COMMAND_INVALID: 'Invalid custom command data.',
-		SERIALIZER_TWITCH_SUBSCRIPTION_INVALID: 'Invalid data.',
-		SERIALIZER_TWITCH_SUBSCRIPTION_INVALID_STREAMER: 'Invalid data streamer.',
+		SERIALIZER_DISABLED_COMMAND_CHANNEL_INVALID: 'Invalid disabled command channel data.',
 		SERIALIZER_PERMISSION_NODE_DUPLICATED_COMMAND: command => `You have set \`${command}\` twice, either allow it, or deny it.`,
-		SERIALIZER_PERMISSION_NODE_SECURITY_OWNER: 'You cannot set permission overrides on the server owner.',
+		SERIALIZER_PERMISSION_NODE_INVALID_COMMAND: command => `The command \`${command}\` does not exist or is invalid.`,
+		SERIALIZER_PERMISSION_NODE_INVALID_TARGET: 'No data could be found from the ID.',
+		SERIALIZER_PERMISSION_NODE_INVALID: 'Invalid data.',
 		SERIALIZER_PERMISSION_NODE_SECURITY_EVERYONE_ALLOWS: 'For security, the everyone role cannot have allows.',
 		SERIALIZER_PERMISSION_NODE_SECURITY_GUARDED: command => `For security and for me to work properly, you cannot deny the usage for the command \`${command}\`.`,
+		SERIALIZER_PERMISSION_NODE_SECURITY_OWNER: 'You cannot set permission overrides on the server owner.',
+		SERIALIZER_STICKY_ROLE_INVALID: 'Invalid sticky role data.',
+		SERIALIZER_TRIGGER_ALIAS_INVALID: 'Invalid trigger alias data.',
+		SERIALIZER_TRIGGER_INCLUDE_INVALID: 'Invalid trigger includes data.',
+		SERIALIZER_TWITCH_SUBSCRIPTION_INVALID_STREAMER: 'Invalid data streamer.',
+		SERIALIZER_TWITCH_SUBSCRIPTION_INVALID: 'Invalid data.',
+		SERIALIZER_UNIQUE_ROLE_SET_INVALID: 'Invalid unique role set data.',
 
 		/**
 		 * #################################
@@ -4646,7 +4653,9 @@ export default class extends Language {
 		EVENTS_ERROR_STRING: (mention, message) => `${REDCROSS} Dear ${mention}, ${message}`,
 
 		CONST_USERS: 'Users',
-		UNKNOWN_USER: 'Unknown user.'
+		UNKNOWN_CHANNEL: 'Unknown channel',
+		UNKNOWN_ROLE: 'Unknown role',
+		UNKNOWN_USER: 'Unknown user'
 	};
 
 	public async init() {

src/languages/es-ES.ts

@@ -4375,16 +4375,23 @@ export default class extends Language {
 		 * #################################
 		 */
 
-		SERIALIZER_PERMISSION_NODE_INVALID: 'Invalid data.',
-		SERIALIZER_PERMISSION_NODE_INVALID_TARGET: 'No data could be found from the ID.',
-		SERIALIZER_PERMISSION_NODE_INVALID_COMMAND: command => `The command \`${command}\` does not exist or is invalid.`,
+		SERIALIZER_AUTOROLE_INVALID: 'Invalid autorole data.',
+		SERIALIZER_COMMAND_AUTO_DELETE_INVALID: 'Invalid command auto-delete data.',
 		SERIALIZER_CUSTOM_COMMAND_INVALID: 'Invalid custom command data.',
-		SERIALIZER_TWITCH_SUBSCRIPTION_INVALID: 'Invalid data.',
-		SERIALIZER_TWITCH_SUBSCRIPTION_INVALID_STREAMER: 'Invalid data streamer.',
+		SERIALIZER_DISABLED_COMMAND_CHANNEL_INVALID: 'Invalid disabled command channel data.',
 		SERIALIZER_PERMISSION_NODE_DUPLICATED_COMMAND: command => `You have set \`${command}\` twice, either allow it, or deny it.`,
-		SERIALIZER_PERMISSION_NODE_SECURITY_OWNER: 'You cannot set permission overrides on the server owner.',
+		SERIALIZER_PERMISSION_NODE_INVALID_COMMAND: command => `The command \`${command}\` does not exist or is invalid.`,
+		SERIALIZER_PERMISSION_NODE_INVALID_TARGET: 'No data could be found from the ID.',
+		SERIALIZER_PERMISSION_NODE_INVALID: 'Invalid data.',
 		SERIALIZER_PERMISSION_NODE_SECURITY_EVERYONE_ALLOWS: 'For security, the everyone role cannot have allows.',
 		SERIALIZER_PERMISSION_NODE_SECURITY_GUARDED: command => `For security and for me to work properly, you cannot deny the usage for the command \`${command}\`.`,
+		SERIALIZER_PERMISSION_NODE_SECURITY_OWNER: 'You cannot set permission overrides on the server owner.',
+		SERIALIZER_STICKY_ROLE_INVALID: 'Invalid sticky role data.',
+		SERIALIZER_TRIGGER_ALIAS_INVALID: 'Invalid trigger alias data.',
+		SERIALIZER_TRIGGER_INCLUDE_INVALID: 'Invalid trigger includes data.',
+		SERIALIZER_TWITCH_SUBSCRIPTION_INVALID_STREAMER: 'Invalid data streamer.',
+		SERIALIZER_TWITCH_SUBSCRIPTION_INVALID: 'Invalid data.',
+		SERIALIZER_UNIQUE_ROLE_SET_INVALID: 'Invalid unique role set data.',
 
 		/**
 		 * #################################
@@ -4660,7 +4667,9 @@ export default class extends Language {
 		EVENTS_ERROR_STRING: (mention, message) => `Querido ${mention}, ${message}`,
 
 		CONST_USERS: 'Usuarios',
-		UNKNOWN_USER: 'Usuario desconocido.'
+		UNKNOWN_CHANNEL: 'Canal desconocido',
+		UNKNOWN_ROLE: 'Rol desconocido',
+		UNKNOWN_USER: 'Usuario desconocido'
 	};
 
 	public async init() {

src/lib/schemas/Guilds.ts

@@ -22,9 +22,9 @@ export default Client.defaultGuildSchema
 		.add('reaction-logs', 'TextChannel')
 		.add('roles', 'TextChannel')
 		.add('spam', 'TextChannel'))
-	.add('command-autodelete', 'any', { array: true })
-	.add('disabledChannels', 'TextChannel', { array: true })
-	.add('disabledCommandsChannels', 'any', { array: true, configurable: false })
+	.add('command-autodelete', 'CommandAutoDelete', { array: true, configurable: false })
+	.add('disabledChannels', 'TextChannel', { array: true, configurable: false })
+	.add('disabledCommandsChannels', 'DisabledCommandChannel', { array: true, configurable: false })
 	.add('events', folder => folder
 		.add('banAdd', 'Boolean', { 'default': false })
 		.add('banRemove', 'Boolean', { 'default': false })
@@ -46,10 +46,10 @@ export default Client.defaultGuildSchema
 		.add('moderation-message-display', 'Boolean', { 'default': true })
 		.add('moderation-auto-delete', 'Boolean', { 'default': false })
 		.add('moderator-name-display', 'Boolean', { 'default': true }))
-	.add('stickyRoles', 'any', { array: true })
+	.add('stickyRoles', 'StickyRole', { array: true, configurable: false })
 	.add('roles', folder => folder
 		.add('admin', 'Role')
-		.add('auto', 'any', { array: true })
+		.add('auto', 'AutoRole', { array: true, configurable: false })
 		.add('initial', 'Role')
 		.add('messageReaction', 'Snowflake', { configurable: false })
 		.add('moderator', 'Role')
@@ -60,11 +60,12 @@ export default Client.defaultGuildSchema
 		.add('restricted-attachment', 'Role')
 		.add('restricted-voice', 'Role')
 		.add('public', 'Role', { array: true })
+		// TODO(kyranet): Migrate to new reaction system
 		.add('reactions', 'any', { array: true })
 		.add('removeInitial', 'Boolean')
 		.add('dj', 'Role')
 		.add('subscriber', 'Role')
-		.add('uniqueRoleSets', 'any', { array: true }))
+		.add('uniqueRoleSets', 'UniqueRoleSet', { array: true, configurable: false }))
 	.add('selfmod', folder => folder
 		.add('attachment', 'Boolean', { 'default': false })
 		.add('attachmentMaximum', 'Integer', { 'default': 20, 'minimum': 0, 'maximum': 60 })
@@ -166,8 +167,8 @@ export default Client.defaultGuildSchema
 		.add('ignoreChannels', 'TextChannel', { array: true })
 		.add('minimum', 'Integer', { 'default': 1, 'minimum': 1, 'inclusive': true }))
 	.add('trigger', folder => folder
-		.add('alias', 'any', { array: true, configurable: false })
-		.add('includes', 'any', { array: true, configurable: false }))
+		.add('alias', 'TriggerAlias', { array: true, configurable: false })
+		.add('includes', 'TriggerInclude', { array: true, configurable: false }))
 	.add('music', folder => folder
 		.add('default-volume', 'Number', { 'minimum': 0, 'maximum': 200, 'default': 100 })
 		.add('maximum-duration', 'Number', { 'minimum': 0, 'maximum': Time.Hour * 12, 'default': Time.Hour * 2 })

src/lib/types/Languages.d.ts

@@ -1728,16 +1728,23 @@ export interface LanguageKeys {
 	HG_BLOODBATH: readonly HungerGamesUsage[];
 	HG_DAY: readonly HungerGamesUsage[];
 	HG_NIGHT: readonly HungerGamesUsage[];
-	SERIALIZER_PERMISSION_NODE_INVALID: string;
-	SERIALIZER_PERMISSION_NODE_INVALID_TARGET: string;
-	SERIALIZER_PERMISSION_NODE_INVALID_COMMAND: (command: string) => string;
+	SERIALIZER_AUTOROLE_INVALID: string;
+	SERIALIZER_COMMAND_AUTO_DELETE_INVALID: string;
 	SERIALIZER_CUSTOM_COMMAND_INVALID: string;
-	SERIALIZER_TWITCH_SUBSCRIPTION_INVALID: string;
-	SERIALIZER_TWITCH_SUBSCRIPTION_INVALID_STREAMER: string;
+	SERIALIZER_DISABLED_COMMAND_CHANNEL_INVALID: string;
 	SERIALIZER_PERMISSION_NODE_DUPLICATED_COMMAND: (command: string) => string;
-	SERIALIZER_PERMISSION_NODE_SECURITY_OWNER: string;
+	SERIALIZER_PERMISSION_NODE_INVALID_COMMAND: (command: string) => string;
+	SERIALIZER_PERMISSION_NODE_INVALID_TARGET: string;
+	SERIALIZER_PERMISSION_NODE_INVALID: string;
 	SERIALIZER_PERMISSION_NODE_SECURITY_EVERYONE_ALLOWS: string;
 	SERIALIZER_PERMISSION_NODE_SECURITY_GUARDED: (command: string) => string;
+	SERIALIZER_PERMISSION_NODE_SECURITY_OWNER: string;
+	SERIALIZER_STICKY_ROLE_INVALID: string;
+	SERIALIZER_TRIGGER_ALIAS_INVALID: string;
+	SERIALIZER_TRIGGER_INCLUDE_INVALID: string;
+	SERIALIZER_TWITCH_SUBSCRIPTION_INVALID_STREAMER: string;
+	SERIALIZER_TWITCH_SUBSCRIPTION_INVALID: string;
+	SERIALIZER_UNIQUE_ROLE_SET_INVALID: string;
 	SELF_MODERATION_COMMAND_INVALID_MISSING_ACTION: (name: string) => string;
 	SELF_MODERATION_COMMAND_INVALID_MISSING_ARGUMENTS: (name: string) => string;
 	SELF_MODERATION_COMMAND_INVALID_SOFTACTION: (name: string) => string;
@@ -1892,6 +1899,8 @@ export interface LanguageKeys {
 	CONST_USERS: string;
 	CONST_MONITOR_MESSAGEFILTER: string;
 	CONST_MONITOR_NEWLINEFILTER: string;
+	UNKNOWN_CHANNEL: string;
+	UNKNOWN_ROLE: string;
 	UNKNOWN_USER: string;
 	NOTIFICATIONS_TWITCH_NO_GAME_NAME: string;
 	NOTIFICATIONS_TWITCH_EMBED_DESCRIPTION: (userName: string, gameName: string | undefined) => string;

src/providers/postgres.ts

@@ -23,6 +23,13 @@ export default class extends SQLProvider {
 		.add('customcommand', { 'extends': 'any' })
 		.add('permissionnode', { 'extends': 'any' })
 		.add('twitchsubscription', { 'extends': 'any' })
+		.add('autorole', { 'extends': 'any' })
+		.add('commandautodelete', { 'extends': 'any' })
+		.add('disabledcommandchannel', { 'extends': 'any' })
+		.add('stickyrole', { 'extends': 'any' })
+		.add('triggeralias', { 'extends': 'any' })
+		.add('triggerinclude', { 'extends': 'any' })
+		.add('uniqueroleset', { 'extends': 'any' })
 		.add('emoji', { 'type': 'VARCHAR(128)', 'extends': 'string' })
 		.add('url', { 'type': 'VARCHAR(128)', 'extends': 'string' });
 	/* eslint-enable @typescript-eslint/no-invalid-this */

src/serializers/autorole.ts

@@ -0,0 +1,20 @@
+import { Serializer, SerializerUpdateContext } from 'klasa';
+import { RolesAuto } from '@lib/types/settings/GuildSettings';
+import { isObject } from '@klasa/utils';
+
+export default class extends Serializer {
+
+	public validate(data: RolesAuto, { language }: SerializerUpdateContext) {
+		if (isObject(data)
+			&& Object.keys(data).length === 2
+			&& typeof data.id === 'string'
+			&& typeof data.points === 'number') return data;
+
+		throw language.tget('SERIALIZER_AUTOROLE_INVALID');
+	}
+
+	public stringify(value: RolesAuto) {
+		return `[${value.id} -> ${value.points.toLocaleString()}]`;
+	}
+
+}

src/serializers/commandautodelete.ts

@@ -0,0 +1,20 @@
+import { Serializer, SerializerUpdateContext } from 'klasa';
+import { Guild } from 'discord.js';
+
+export default class extends Serializer {
+
+	public validate(data: [string, number], { language }: SerializerUpdateContext) {
+		if (Array.isArray(data)
+			&& data.length === 2
+			&& typeof data[0] === 'string'
+			&& typeof data[1] === 'number'
+			&& this.client.commands.has(data[0])) return data;
+
+		throw language.tget('SERIALIZER_COMMAND_AUTO_DELETE_INVALID');
+	}
+
+	public stringify(value: [string, number], guild: Guild) {
+		return `[${value[0]} -> ${guild.language.duration(value[1], 2)}]`;
+	}
+
+}

src/serializers/disabledcommandchannel.ts

@@ -0,0 +1,22 @@
+import type { DisabledCommandChannel } from '@lib/types/settings/GuildSettings';
+import { Serializer, SerializerUpdateContext } from 'klasa';
+import { isObject } from '@klasa/utils';
+import { Guild } from 'discord.js';
+
+export default class extends Serializer {
+
+	public validate(data: DisabledCommandChannel, { language }: SerializerUpdateContext) {
+		if (isObject(data)
+			&& Object.keys(data).length === 2
+			&& typeof data.channel === 'string'
+			&& Array.isArray(data.commands)
+			&& data.commands.every(cmd => typeof cmd === 'string')) return data;
+
+		throw language.tget('SERIALIZER_DISABLED_COMMAND_CHANNEL_INVALID');
+	}
+
+	public stringify(value: DisabledCommandChannel, guild: Guild) {
+		return `[${guild.channels.get(value.channel)?.name ?? guild.language.tget('UNKNOWN_CHANNEL')} -> ${value.commands.join(' | ')}]`;
+	}
+
+}

src/serializers/stickyrole.ts

@@ -0,0 +1,24 @@
+import { Serializer, SerializerUpdateContext } from 'klasa';
+import { Guild } from 'discord.js';
+import { StickyRole } from '@lib/types/settings/GuildSettings';
+import { isObject } from '@klasa/utils';
+
+export default class extends Serializer {
+
+	public validate(data: StickyRole, { language, guild }: SerializerUpdateContext) {
+		if (isObject(data)
+			&& Object.keys(data).length === 2
+			&& typeof data.user === 'string'
+			&& Array.isArray(data.roles)
+			&& data.roles.every(role => typeof role === 'string' && guild!.roles.has(role))) return data;
+
+		throw language.tget('SERIALIZER_STICKY_ROLE_INVALID');
+	}
+
+	public stringify(value: StickyRole, guild: Guild) {
+		const username = this.client.userTags.get(value.user)?.username ?? guild.language.tget('UNKNOWN_USER');
+		const roles = value.roles.map(role => guild.roles.get(role)?.name ?? guild.language.tget('UNKNOWN_ROLE'));
+		return `[${username} -> ${roles}]`;
+	}
+
+}

src/serializers/triggeralias.ts

@@ -0,0 +1,20 @@
+import { Serializer, SerializerUpdateContext } from 'klasa';
+import { TriggerAlias } from '@lib/types/settings/GuildSettings';
+import { isObject } from '@klasa/utils';
+
+export default class extends Serializer {
+
+	public validate(data: TriggerAlias, { language }: SerializerUpdateContext) {
+		if (isObject(data)
+			&& Object.keys(data).length === 2
+			&& typeof data.input === 'string'
+			&& typeof data.output === 'string') return data;
+
+		throw language.tget('SERIALIZER_TRIGGER_ALIAS_INVALID');
+	}
+
+	public stringify(value: TriggerAlias) {
+		return `[${value.input} -> ${value.output}]`;
+	}
+
+}

src/serializers/triggerinclude.ts

@@ -0,0 +1,21 @@
+import { Serializer, SerializerUpdateContext } from 'klasa';
+import { TriggerIncludes } from '@lib/types/settings/GuildSettings';
+import { isObject } from '@klasa/utils';
+
+export default class extends Serializer {
+
+	public validate(data: TriggerIncludes, { language }: SerializerUpdateContext) {
+		if (isObject(data)
+			&& Object.keys(data).length === 3
+			&& data.action === 'react'
+			&& typeof data.input === 'string'
+			&& typeof data.output === 'string') return data;
+
+		throw language.tget('SERIALIZER_TRIGGER_INCLUDE_INVALID');
+	}
+
+	public stringify(value: TriggerIncludes) {
+		return `[${value.action} | ${value.input} -> ${value.output}]`;
+	}
+
+}

src/serializers/uniqueroleset.ts

@@ -0,0 +1,22 @@
+import { Serializer, SerializerUpdateContext } from 'klasa';
+import { Guild } from 'discord.js';
+import { UniqueRoleSet } from '@lib/types/settings/GuildSettings';
+import { isObject } from '@klasa/utils';
+
+export default class extends Serializer {
+
+	public validate(data: UniqueRoleSet, { language, guild }: SerializerUpdateContext) {
+		if (isObject(data)
+			&& Object.keys(data).length === 2
+			&& typeof data.name === 'string'
+			&& Array.isArray(data.roles)
+			&& data.roles.every(role => typeof role === 'string' && guild!.roles.has(role))) return data;
+
+		throw language.tget('SERIALIZER_UNIQUE_ROLE_SET_INVALID');
+	}
+
+	public stringify(value: UniqueRoleSet, guild: Guild) {
+		return `[${value.name} -> ${value.roles.map(role => guild.roles.get(role)?.name ?? guild.language.tget('UNKNOWN_ROLE'))}]`;
+	}
+
+}