Add Mention Config. Implements #14, #15 and #20

settings-template.jsonc

@@ -26,19 +26,134 @@
 	// The message ID of the bot's roles message
 	"roles_message": "<Roles message ID>",
 
-	// Whether the bot should send an embed when a full URL to a ticket gets posted.
-	// Optional, false by default
-	"ticketUrlsCauseEmbed": false,
+	// Map of custom embed types
+	"embed_types": {
+		"<name of an embed type>": {
 
-	// A prefix that prevents the bot from posting an embed for a mentioned ticket.
-	// If this prefix is longer than 1, none of the characters can be used.
-	// When omitted or empty, no prefix prevents embeds.
-	"forbiddenTicketPrefix": "<Prefix>",
+			// Optional. Whether to include the embed title
+			// Default: false
+			"title": false,
 
-	// Prefix that needs to preceed any mentioned ticket in order for the bot to post an embed
-	// If this prefix is longer than 1, the entire string needs to prefix any mentioned ticket.
-	// When omitted or empty, no prefix is required for posting embeds.
-	"requiredTicketPrefix": "<Prefix>",
+			// Optional. Settings for the description. Either below's object or boolean.
+			// When true, defaults apply, when false no description is set.
+			// Default: false
+			"description": {
+
+				// If set, the description cannot be longer than n characters.
+				// Maximum value (and default value) is 2048 (restriction by Discord api)
+				"max_characters": 1234,
+
+				// If set, the description cannot include more than n line breaks.
+				"max_line_breaks": 2,
+
+				// If set, everything from the description that matches any of the given regex strings will be stripped.
+				"exclude": [ "<a regex string>" ]
+			},
+
+			// Optional. Whether the author should be included.
+			// Default: false
+			"author": false,
+
+			// Optional. Whether the embed should link to the mentioned ticket.
+			// Default: false
+			"url": false,
+
+			// Optional. Whether the embed should include the first image.
+			// Default: false
+			"thumbnail": false,
+
+			// The color the embed should have
+			"color": "DiscordColorResolvable",
+
+			// Optional. A list of additional fields that should be added. Can be set to false for no fields.
+			// Default: false
+			"fields": [
+				{
+					// Type of the field.
+					// Currently available: status, large_status, field, user, joined_array, array_count, duplicate_count, date, from_now
+					"type": "<type>",
+
+					// Label the field should appear with.
+					"label": "<label>",
+
+					// Path to the field in the jira json response. See jira api documentaion for more details.
+					// Path members are seperated with dots (.) And the path starts at ticketResponse.fields
+					// Not needed for status, large_status and duplicate_count
+					"path": "<path-to-field>",
+
+					// Optional. Whether the field should be inline. A maximum of 3 fields will appear next to each other when set.
+					// Default: true
+					"inline": false,
+
+					// Optional. Currently only for joined_array.
+					// Path for object in the array that should be used for display.
+					// Default: Print entire object. 
+					"inner_path": "<inner path>"
+				}
+				// ... You can add more fields here
+			]
+		}
+		// ... You can define more embed types here
+	},
+
+	// Rules for invoking different embeds when mentioning a ticket.
+	// In case multiple types match, the one defined first will be used.
+	"mention_types": [
+		{
+			// Optional. If set to true, this mention type will only trigger if the mentioned ticket was provided as URL.
+			// Default: false
+			"require_url": false,
+
+			// Optional. If set to true, this mention type will not trigger if the mentioned ticket was provided as URL.
+			// Default: false
+			"forbid_url": false,
+
+			// Optional. If set, this mention type will only trigger if the mentioned ticket was prefixed with the given string.
+			// If require_url is set to true, the prefix applies to the entire url.
+			// Default: no required prefix.
+			"required_prefix": "<prefix>",
+
+			// Optional. If set, this mention type will not trigger if the mentioned ticket was prefixed with one of the given characters.
+			// If require_url is set to true, the prefix applies to the entire url.
+			// Default: no forbidden prefix.
+			"forbidden_prefix": "<prefix>",
+
+			// Optional. If set, this mention type will only trigger if the message includes a keyword somewhere in the message.
+			// Default: no required keyword.
+			"required_keyword": "<keyword>",
+
+			// Optional. If set, this mention type will not trigger if the message includes a keyword somewhere in the message.
+			// Default: no forbidden keyword.
+			"forbidden_keyword": "<keyword>",
+
+			// Optional. Number of ungrouped mentions that will produce an individual embed for this mention type.
+			// If this number is exceeded, a single embed including all ticket keys and summaries will be generated instead.
+			// A number smaller than 1 means no limit.
+			// Default: Same as max_ungrouped_mentions from root.
+			"max_ungrouped_mentions": 1,
+
+			// Optional. An embed name defined in embed_types.
+			// This embed will be used to display the mention.
+			// Default: the embed defined in `default_embed`
+			"embed": "<embed name>"
+		}
+		// ... You can add more mention types here
+	],
+
+	// An embed name defined in embed_types.
+	// The embed type to be used as default.
+	// Currently, this embed is also used for `BugCommand` (!jira mention <tickets>)
+	"default_embed": "<embed name>",
+
+	// Number of ungrouped mentions that will produce an individual embed.
+	// If this number is exceeded, a single embed including all ticket keys and summaries will be generated instead.
+	// A number smaller than 1 means no limit.
+	"max_ungrouped_mentions": 1,
+
+	// Maximum number of mentions that will appear in a grouped embed (see max_ungrouped_mentions).
+	// The number of tickets will automatically be shoretened if the text exceeds Discord's charater limit as well.
+	// If this number is exceeded, a jira search query link will be provided at the end, allowing to view a list of all tickets on jira.
+	"max_grouped_mentions": 10,
 
 	// Settings about channels that handle user requests.
 	"request": {
@@ -135,7 +250,24 @@
 			"title": "{{num}} tickets blabla in the last 15 minutes!",
 
 			// Optional. The message accompanying this feed embed, in case there's only one ticket. If this is not set, `title` will be used instead.
-			"title_single": "One ticket blabla in the last 15 minutes!"
+			"title_single": "One ticket blabla in the last 15 minutes!",
+
+			// Optional. An embed name defined in embed_types.
+			// This embed will be used to display issues from the feed.
+			// Default: the embed defined in `default_embed`
+			"embed": "<embed name>",
+
+			// Optional. Number of ungrouped mentions that will produce an individual embed for this feed.
+			// If this number is exceeded, a single embed including all ticket keys and summaries will be generated instead.
+			// A number smaller than 1 means no limit.
+			// Default: Same as max_ungrouped_mentions from root.
+			"max_ungrouped_mentions": 1,
+
+			// Optional. Maximum number of mentions that will appear in a grouped embed (see max_ungrouped_mentions).
+			// The number of tickets will automatically be shoretened if the text exceeds Discord's charater limit as well.
+			// If this number is exceeded, a jira search query link will be provided at the end, allowing to view a list of all tickets on jira.
+			// Default: Same as max_grouped_mentions from root.
+			"max_grouped_mentions": 10
 		}
 		// ... you can add more feeds here
 	]

src/BotConfig.ts

@@ -1,5 +1,6 @@
 import { Client } from 'discord.js';
 import MojiraBot from './MojiraBot';
+import MentionConfig, { EmbedConfig } from './MentionConfig';
 
 export interface RoleConfig {
 	emoji: string;
@@ -11,7 +12,10 @@ export interface FilterFeedConfig {
 	jql: string;
 	channel: string;
 	title: string;
-	title_single?: string;
+	embed: EmbedConfig;
+	maxUngroupedMentions?: number;
+	maxGroupedMentions?: number;
+	titleSingle?: string;
 }
 
 export enum PrependResonseMessage {
@@ -47,10 +51,11 @@ export default class BotConfig {
 	public static rolesChannel: string;
 	public static rolesMessage: string;
 
-	// settings for mention command
-	public static ticketUrlsCauseEmbed: boolean;
-	public static requiredTicketPrefix: string;
-	public static forbiddenTicketPrefix: string;
+	private static embedTypes: Map<string, EmbedConfig>;
+	public static mentionTypes: MentionConfig[];
+	public static defaultEmbed: EmbedConfig;
+	public static maxUngroupedMentions?: number;
+	public static maxGroupedMentions?: number;
 
 	public static projects: string[];
 
@@ -90,13 +95,28 @@ export default class BotConfig {
 		if ( !settings.roles_message ) throw 'Roles message is not set';
 		this.rolesMessage = settings.roles_message;
 
-		this.ticketUrlsCauseEmbed = !!settings.ticketUrlsCauseEmbed;
+		if ( !settings.embed_types ) throw 'Embed Types are not defined!';
+		this.embedTypes = new Map<string, EmbedConfig>();
+		Object.keys( settings.embed_types ).forEach( ( key: string ) => {
+			this.embedTypes.set( key, new EmbedConfig( settings.embed_types[key] ) );
+		} );
 
-		if ( !settings.forbiddenTicketPrefix ) this.forbiddenTicketPrefix = '';
-		else this.forbiddenTicketPrefix = settings.forbiddenTicketPrefix;
+		if( settings.max_grouped_mentions === undefined ) throw 'Max ungrouped mentions are not defined!';
+		this.maxUngroupedMentions = settings.max_ungrouped_mentions as number;
 
-		if ( !settings.requiredTicketPrefix ) this.requiredTicketPrefix = '';
-		else this.requiredTicketPrefix = settings.requiredTicketPrefix;
+		if( settings.max_grouped_mentions === undefined ) throw 'Max grouped mentions are not defined!';
+		this.maxGroupedMentions = settings.max_grouped_mentions as number;
+
+		if( !settings.default_embed ) throw 'Default embed is not defined!';
+		this.defaultEmbed = this.embedTypes.get( settings.default_embed );
+		if( !this.defaultEmbed ) throw `Default embed is set to an undefined embed type "${ settings.default_embed }"!`;
+
+		if ( !( settings.mention_types instanceof Array ) ) throw 'Mention Types are not defined!';
+		this.mentionTypes = new Array<MentionConfig>();
+
+		for ( const mentionType of settings.mention_types ) {
+			this.mentionTypes.push( new MentionConfig( mentionType, this.embedTypes ) );
+		}
 
 		if ( !settings.projects ) throw 'Projects are not set';
 		this.projects = settings.projects;
@@ -110,7 +130,25 @@ export default class BotConfig {
 		this.filterFeedInterval = settings.filter_feed_interval;
 
 		if ( !settings.filter_feeds ) throw 'Filter feeds are not set';
-		this.filterFeeds = settings.filter_feeds;
+		this.filterFeeds = new Array<FilterFeedConfig>();
+
+		for( const filterFeed of settings.filter_feeds ) {
+			// eslint-disable-next-line @typescript-eslint/no-explicit-any
+			const feed: any = { embed: this.defaultEmbed };
+
+			Object.keys( filterFeed ).forEach( key => {
+				const camelCaseKey = key.replace( /_./g, match => match.substring( 1, 2 ).toUpperCase() );
+				feed[ camelCaseKey ] = filterFeed[ key ];
+
+			} );
+
+			if ( filterFeed.embed ) {
+				feed.embed = this.embedTypes.get( filterFeed.embed );
+				if( !feed.embed ) throw `A filter feed uses an undefined embed type "${ filterFeed.embed }"!`;
+			}
+
+			this.filterFeeds.push( feed as FilterFeedConfig );
+		}
 	}
 
 	public static async login( client: Client ): Promise<boolean> {

src/MentionConfig.ts

@@ -0,0 +1,120 @@
+import { ColorResolvable } from 'discord.js';
+import BotConfig from './BotConfig';
+
+export interface FieldConfig {
+	type: FieldType;
+	label: string;
+	path?: string;
+	inline?: boolean;
+	innerPath?: string;
+}
+
+export enum FieldType {
+	Status, LargeStatus, Field, User, JoinedArray, ArrayCount, DuplicateCount, Date, FromNow
+}
+
+export interface Description {
+	maxCharacters: number;
+	maxLineBreaks?: number;
+	exclude?: RegExp[];
+}
+
+export class EmbedConfig {
+	public title: boolean;
+	public description: boolean | Description;
+	public author: boolean;
+	public url: boolean;
+	public thumbnail: boolean;
+	public color: ColorResolvable;
+	public fields: false | FieldConfig[];
+
+	constructor( json ) {
+		this.title = !!json.title;
+		if ( typeof json.description === 'object' ) {
+			this.description = { maxCharacters: 2048 };
+			if( json.description.max_characters ) {
+				if ( json.description.max_characters < 1 || json.description.max_characters > 2048 ) {
+					throw `An embed type has a character limit of ${ json.description.max_characters } for the description, but value must be between 1 and 2048!`;
+				}
+
+				this.description.maxCharacters = json.description.max_characters;
+			}
+			if( json.description.max_line_breaks ) {
+				this.description.maxLineBreaks = json.description.max_line_breaks;
+			}
+			if( json.description.exclude ) {
+				this.description.exclude = json.description.exclude.map( v => {
+					const components = v.split( '/' ) as Array<string>;
+					if( components && components.length < 3 ) throw `Invalid regex: Not enough slashes (/) (expected: 2): ${ v }`;
+					return new RegExp( components.splice( 1, components.length - 2 ).join( '/' ), components[ components.length - 1 ] );
+				} );
+			}
+		} else {
+			this.description = !!json.description;
+		}
+
+		this.author = !!json.author;
+		this.url = !!json.url;
+		this.thumbnail = !!json.thumbnail;
+
+		if( !json.color ) throw 'An embed type has no color.';
+		this.color = json.color as ColorResolvable;
+		if( !this.color ) throw `An embed type has invalid color ${ json.color }.`;
+
+		if ( json.fields instanceof Array ) {
+			this.fields = new Array<FieldConfig>();
+
+			for( const field of json.fields ) {
+				if( !field.label ) throw 'An embed type contains a field object without any label.';
+				if( !( field.type as string ) ) throw `An embed type contains field "${ field.label }" without any type.`;
+				let type = field.type as string;
+
+				// convert snake_case to PascalCase
+				type = type.replace( /(?:^|_)./g, match => match.substring( match.length - 1, match.length ).toUpperCase() );
+
+				const fieldType = FieldType[type];
+				if( fieldType === undefined ) throw `An embed type contains field "${ field.label }" with invalid type "${ type }".`;
+
+				if( ![ FieldType.Status, FieldType.LargeStatus, FieldType.DuplicateCount ].includes( fieldType ) && !field.path ) throw `An embed type contains field "${ field.label }" without any path.`;
+
+				this.fields.push( {
+					type: fieldType,
+					label: field.label,
+					path: field.path,
+					inline: field.inline !== undefined ? field.inline : true,
+					innerPath: field.innerPath,
+				} );
+			}
+		} else {
+			this.fields = false;
+		}
+	}
+}
+
+export default class MentionConfig {
+	public requireUrl?: boolean;
+	public forbidUrl?: boolean;
+	public requiredPrefix?: string;
+	public forbiddenPrefix?: string;
+	public requiredKeyword?: string;
+	public forbiddenKeyword?: string;
+	public maxUngroupedMentions: number;
+	public embed: EmbedConfig;
+
+	constructor( json, embedTypes: Map<string, EmbedConfig> ) {
+		if( !json.embed ) {
+			this.embed = BotConfig.defaultEmbed;
+		} else {
+			this.embed = embedTypes.get( json.embed );
+			if( !this.embed ) throw `Added mention type with unkown embed ${ json.embed }.`;
+		}
+
+		this.requireUrl = json.require_url;
+		this.forbidUrl = json.forbid_url;
+		this.requiredPrefix = json.required_prefix;
+		this.forbiddenPrefix = json.forbidden_prefix;
+		this.requiredKeyword = json.required_keyword;
+		this.forbiddenKeyword = json.forbidden_keyword;
+		this.maxUngroupedMentions = json.max_ungrouped_mentions !== undefined ? json.max_ungrouped_mentions : BotConfig.maxUngroupedMentions;
+	}
+}