add @types/node

README.md

@@ -1,3 +1,6 @@
+## Build Status
+[![status-badge](https://wood.brudi.xyz/api/badges/kenobi/node-event-bot/status.svg)](https://wood.brudi.xyz/kenobi/node-event-bot)
+
 ## Requirements
 - yarn
 - npm

index.ts

@@ -1,13 +1,3 @@
-import { config } from "./server/configuration"
-import Server from "./server/server"
 import { ExtendedClient } from "./server/structures/client"
-
-const server = Server.init(config.port)
 export const client = new ExtendedClient()
-
-
-server.start(() => {
-	console.log(`Server running on port ${server.getPort()}`)
-	//const discordAdapter = new DiscordAdapter()
 client.start()
-})

package.json

@@ -18,18 +18,14 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@discordjs/rest": "^0.3.0",
+    "@discordjs/rest": "^0.4.1",
     "@tsconfig/recommended": "^1.0.1",
-    "@types/cors": "^2.8.12",
+    "@types/node": "^17.0.31",
-    "@types/express": "^4.17.13",
     "axios": "^0.26.0",
-    "body-parser": "^1.19.0",
-    "cors": "^2.8.5",
     "date-fns": "^2.28.0",
-    "discord-api-types": "^0.27.3",
+    "discord-api-types": "^0.31.2",
     "discord.js": "^13.6.0",
     "dotenv": "^16.0.0",
-    "express": "^4.17.1",
     "ts-node": "^10.7.0",
     "typescript": "^4.4.4",
     "winston": "^3.3.3"

server/handler/repeatingEvents/helper.ts

@@ -1,10 +1,8 @@
 import { format } from "date-fns"
-import add from "date-fns/add"
+import { Guild, GuildScheduledEvent, GuildScheduledEventCreateOptions } from "discord.js"
-import { DateResolvable, Guild, GuildScheduledEvent, GuildScheduledEventCreateOptions } from "discord.js"
+import { sendFailureDM } from "../../helper/sendFailureDM"
-import { client } from "../../.."
-import { findInScheduleTypes } from "../../helper/typeFind"
 import { CustomError, errorCodes, Maybe } from "../../interfaces"
-import { RepetitonInfo, supportedSchedule } from "../../types/scheduledEventTypes"
+import { RepetitonInfo, Schedule, supportedSchedule } from "../../types/scheduledEventTypes"
 
 export const repetitionMarkerIsFound = (desc: string): boolean => desc.includes('$rep')
 export function createEventInGuild(guild: Guild, eventInfo: GuildScheduledEventCreateOptions): Promise<any> {
@@ -16,7 +14,8 @@ export function getRepetitonInfo(description: string): RepetitonInfo {
 	const repetitionString = lines.find(x => x.startsWith('$rep:'))
 	if (!repetitionString)
 		throw new CustomError('Cant find repetition string', errorCodes.no_string_present)
-	const schedule: supportedSchedule = determineSchedule(repetitionString)
+	const scheduleString = determineScheduleString(repetitionString)
+	const schedule: Schedule = new Schedule(scheduleString)
 	const { totalAmount, alreadyOccured } = determineRepetitionCount(repetitionString)
 	const endDate = determineEndDate(repetitionString)
 	return {
@@ -27,14 +26,13 @@ export function getRepetitonInfo(description: string): RepetitonInfo {
 	}
 }
 
-export function determineSchedule(repetitionLine: string): supportedSchedule {
+export function determineScheduleString(repetitionLine: string): supportedSchedule {
 	const segments = repetitionLine.split(':')
 	const scheduleSegment = segments[1]
-	const easilyKnownScheduleName = findInScheduleTypes(scheduleSegment)
+	if (scheduleSegment)
-	if (easilyKnownScheduleName)
+		return scheduleSegment
-		return easilyKnownScheduleName
 	else
-		throw new CustomError('Inferring schedule names is not yet supported', errorCodes.schedule_not_supported)
+		throw new CustomError('No schedule segment found', errorCodes.no_schedule)
 }
 
 export function determineRepetitionCount(description: string): { totalAmount: number; alreadyOccured: number } {
@@ -50,8 +48,8 @@ export function determineRepetitionCount(description: string): { totalAmount: nu
 
 export function buildNewRepetitionString(repetitionInfo: RepetitonInfo) {
 	if (repetitionInfo.endDate)
-		return `$rep:${repetitionInfo.schedule}:${format(repetitionInfo.endDate, 'yyyy-MM-dd')}`
+		return `$rep:${repetitionInfo.schedule.getSanitizedScheduleString()}:${format(repetitionInfo.endDate, 'yyyy-MM-dd')}`
-	return `$rep:${repetitionInfo.schedule}:${repetitionInfo.alreadyOccured + 1}/${repetitionInfo.totalAmount}`
+	return `$rep:${repetitionInfo.schedule.getSanitizedScheduleString()}:${repetitionInfo.alreadyOccured + 1}/${repetitionInfo.totalAmount}`
 }
 
 export function addRepetitonStringToEventDescription(oldguildScheduledEvent: string, newRepetitonString: string): string | undefined {
@@ -62,30 +60,6 @@ export function addRepetitonStringToEventDescription(oldguildScheduledEvent: str
 	return newLines.join('\n')
 }
 
-export function getNewScheduledStart(oldguildScheduledEvent: GuildScheduledEvent<"SCHEDULED" | "ACTIVE" | "COMPLETED" | "CANCELED">, rInfo: RepetitonInfo): DateResolvable {
-	const oldDate = oldguildScheduledEvent.scheduledStartAt
-	let daysToAdd = 0
-	let monthsToAdd = 0
-	switch (rInfo.schedule) {
-		case 'daily':
-			daysToAdd = 1
-			break
-		case 'weekly':
-			daysToAdd = 7
-			break
-		case 'monthly':
-			monthsToAdd = 1
-			break
-		default:
-			throw new CustomError('No schedule found, cant add days', errorCodes.no_schedule)
-	}
-	const duration: Duration = {
-		days: daysToAdd,
-		months: monthsToAdd
-	}
-	const newDate = add(oldDate, duration)
-	return newDate
-}
 function determineEndDate(description: string): Maybe<Date> {
 	const segments = description.split(':')
 	if (segments.length === 3) {
@@ -129,6 +103,7 @@ export function checkIfRepetitionStringIsValid(description: string): string {
 }
 
 export async function validateRepetitionStringAndSendMessageOnFail(event: GuildScheduledEvent): Promise<void> {
+	console.log('This should not be accessed')
 
 	const validResponses = [
 		'valid',
@@ -139,13 +114,6 @@ export async function validateRepetitionStringAndSendMessageOnFail(event: GuildS
 		// do success things?
 	} else {
 		const creatorMessage = `The repetition string in your event could not be parsed. Reason: ${resultstring}`
-		console.log(creatorMessage)
+		sendFailureDM(creatorMessage, event.creatorId ?? undefined)
-		if (!event.creatorId) throw new CustomError('No creator ID present', errorCodes.no_creator_id)
-		const creator = await client.users.fetch(event.creatorId)
-		console.log(`Creator ${JSON.stringify(creator)}`)
-		if (creator)
-			if (!creator.dmChannel)
-				await creator.createDM()
-		await creator.dmChannel?.send(creatorMessage)
 	}
 }

server/handler/repeatingEvents/repeatingEvents.controller.ts

@@ -1,6 +1,6 @@
 import { GuildScheduledEvent, GuildScheduledEventCreateOptions } from "discord.js"
 import { RepetitonInfo } from "../../types/scheduledEventTypes"
-import { addRepetitonStringToEventDescription, buildNewRepetitionString, createEventInGuild, getNewScheduledStart, getRepetitonInfo } from "./helper"
+import { addRepetitonStringToEventDescription, buildNewRepetitionString, createEventInGuild, getRepetitonInfo } from "./helper"
 
 function needsToBeRepeated(rInfo: RepetitonInfo): boolean {
 	if (rInfo.endDate) {
@@ -18,11 +18,16 @@ export function handleRepeatingEvent(oldguildScheduledEvent: GuildScheduledEvent
 	if (needsToBeRepeated(repetitionInfo)) {
 		try {
 
+			const newDate = repetitionInfo.schedule.getNewDate(oldguildScheduledEvent.scheduledStartAt)
+			if (repetitionInfo.endDate && (repetitionInfo.endDate <= newDate)) {
+				console.log(`Wont repeat: EndDate: ${repetitionInfo.endDate} RepetitionDate: ${newDate}`)
+				return
+			}
 			const newRepetitonString = buildNewRepetitionString(repetitionInfo)
 			const newEventOptions: GuildScheduledEventCreateOptions = {
 				name: oldguildScheduledEvent.name,
 				description: addRepetitonStringToEventDescription(oldguildScheduledEvent.description, newRepetitonString),
-				scheduledStartTime: getNewScheduledStart(oldguildScheduledEvent, repetitionInfo),
+				scheduledStartTime: newDate,
 				privacyLevel: oldguildScheduledEvent.privacyLevel,
 				entityType: oldguildScheduledEvent.entityType,
 				channel: oldguildScheduledEvent.channel?.id,

server/helper/sendFailureDM.ts

@@ -0,0 +1,12 @@
+import { client } from "../.."
+import { CustomError, errorCodes } from "../interfaces"
+
+export async function sendFailureDM(creatorMessage: string, creatorId?: string): Promise<void> {
+	if (!creatorId) throw new CustomError('No creator ID present', errorCodes.no_creator_id)
+	const creator = await client.users.fetch(creatorId)
+	console.log(`Creator ${JSON.stringify(creator)}`)
+	if (creator)
+		if (!creator.dmChannel)
+			await creator.createDM()
+	await creator.dmChannel?.send(creatorMessage)
+}

server/helper/typeFind.ts

@@ -1,14 +0,0 @@
-import { CustomError, errorCodes } from "../interfaces";
-import { scheduleNames, supportedSchedule } from "../types/scheduledEventTypes";
-
-export function findInScheduleTypes(inputString: string): supportedSchedule {
-	const maybeScheduleName: unknown = JSON.parse(`"${inputString.toLowerCase()}"`);
-	const scheduleName = scheduleNames.find((validName: supportedSchedule) => validName === maybeScheduleName);
-	if (scheduleName) {
-		// `sheepName` comes from the list of `sheepNames` so the compiler is happy.
-		return scheduleName;
-	}
-	throw new CustomError('That is not a schedule name.', errorCodes.schedule_not_supported);
-}
-
-

server/server.ts

@@ -1,36 +0,0 @@
-import bodyParser from "body-parser"
-import cors from "cors"
-import express from "express"
-import { config } from "./configuration"
-
-export default class Server {
-	private app: express.Application
-	private port: number
-
-	public constructor(port: number) {
-		this.port = port
-		this.app = express()
-	}
-	public static init(port: number): Server {
-		return new Server(port)
-	}
-	public start(callback: (...args: any[]) => void): void {
-		this.setBodyParser()
-		this.setCors()
-		this.getApp().listen(this.port, callback)
-
-	}
-	public getApp(): express.Application {
-		return this.app
-	}
-	public getPort(): number {
-		return this.port
-	}
-	private setBodyParser(): void {
-		this.getApp().use(bodyParser.urlencoded(config.server.bodyParser.urlEncodedOptions))
-		this.getApp().use(bodyParser.json(config.server.bodyParser.jsonOptions))
-	}
-	private setCors(): void {
-		this.getApp().use(cors())
-	}
-}

server/structures/client.ts

@@ -11,6 +11,7 @@ export class ExtendedClient extends Client {
 		super({ intents: [Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_SCHEDULED_EVENTS] })
 	}
 	public start() {
+		if (process.env.NODE_ENV === 'test') return
 		const promises = []
 		promises.push(this.registerSlashCommands())
 		promises.push(this.registerEventCallback())

server/types/scheduledEventTypes.ts

@@ -1,10 +1,102 @@
+import { add } from "date-fns"
+import { DateResolvable } from "discord.js"
+import { CustomError, errorCodes } from "../interfaces"
 
 export interface RepetitonInfo {
 	startDate?: Date, // If defined will take precedence over repetitonAmount
 	endDate?: Date,// If defined will take precedence over repetitonAmount
 	totalAmount: number,
 	alreadyOccured: number,
-	schedule: supportedSchedule
+	schedule: Schedule
 }
-export const scheduleNames = ['daily', 'weekly', 'monthly', 'everyTwoWeeks', 'everyNDays']
+export const scheduleNames = ['daily', 'weekly', 'monthly', 'everyNWeeks', 'everyNDays', 'everyNMonths']
 export type supportedSchedule = typeof scheduleNames[number]
+export interface IScheduleType {
+	name: supportedSchedule,
+	multiplier: number,
+	duration: Duration
+}
+export const scheduleTypes: IScheduleType[] = [
+	{
+		name: 'daily',
+		multiplier: 1,
+		duration: {
+			days: 1
+		}
+	},
+	{
+		name: 'weekly',
+		multiplier: 1,
+		duration: {
+			weeks: 1
+		}
+	},
+]
+export class Schedule {
+	private scheduleName: string
+	private multiplier = 1
+	private duration: Duration
+	private baseScheduleTypes = ['daily', 'weekly', 'monthly', 'yearly']
+	private _scheduleString: string
+	constructor(scheduleString: string) {
+		this._scheduleString = scheduleString.toLowerCase()
+		this.scheduleName = this._scheduleString
+		if (this.baseScheduleTypes.includes(this._scheduleString)) {
+			this.multiplier = 1
+		}
+		if (this._scheduleString.includes('every')) {
+			this.scheduleName = this.getBaseScheduleNameFromVariableString()
+			this.multiplier = this.getMultiplierFromVariableString()
+		}
+
+		switch (this.scheduleName) {
+			case 'daily':
+				this.duration = { days: 1 }
+				break
+			case 'weekly':
+				this.duration = { weeks: 1 }
+				break
+			case 'monthly':
+				this.duration = { months: 1 }
+				break
+			case 'yearly':
+				this.duration = { years: 1 }
+				break
+			default:
+				throw new CustomError('Schedule type not supported', errorCodes.schedule_not_supported)
+		}
+	}
+	public getSanitizedScheduleString(): string {
+		return this._scheduleString
+	}
+	private getBaseScheduleNameFromVariableString(): string {
+		if (this._scheduleString.includes('week')) return 'weekly'
+		if (this._scheduleString.includes('day')) return 'daily'
+		if (this._scheduleString.includes('month')) return 'monthly'
+		if (this._scheduleString.includes('year')) return 'yearly'
+		return ''
+	}
+	public getMultiplierFromVariableString(): number {
+		const matches = this._scheduleString.match(/\d+/)
+		if (matches) {
+			const multi = matches[0]
+			if (multi)
+				return parseInt(multi)
+		}
+		return 1
+	}
+	public calculateDuration(): Duration {
+		const dur: Duration = {
+			days: this.duration.days ? this.duration.days * this.multiplier : undefined,
+			weeks: this.duration.weeks ? this.duration.weeks * this.multiplier : undefined,
+			months: this.duration.months ? this.duration.months * this.multiplier : undefined,
+			years: this.duration.years ? this.duration.years * this.multiplier : undefined,
+		}
+		return dur
+	}
+
+	public getNewDate(oldDate: Date): Date {
+		const newDate = add(oldDate, this.calculateDuration())
+		return newDate
+	}
+}

tests/createdEvent.test.ts

@@ -3,6 +3,7 @@ import { getRepetitonInfo } from "../server/handler/repeatingEvents/helper"
 describe('ScheduledEvent Creation Events', () => {
 
 	test('Daily Event with absolute end date', () => {
+		jest.mock('../server/helper/sendFailureDM.ts')
 		const eventObject = {
 			"id": "965576921410859018",
 			"guildId": "907936880190967850",
@@ -21,10 +22,11 @@ describe('ScheduledEvent Creation Events', () => {
 			"entityMetadata": null
 		}
 		const rInfo = getRepetitonInfo(eventObject.description)
+		const expectedSchedule = { "_scheduleString": "daily", "baseScheduleTypes": ["daily", "weekly", "monthly", "yearly"], "duration": { "days": 1 }, "multiplier": 1, "scheduleName": "daily" }
 		expect(rInfo).toBeDefined()
 		expect(rInfo.endDate).toBeDefined()
 		expect(rInfo.endDate).toEqual(new Date("2022-05-22"))
-		expect(rInfo.schedule).toEqual('daily')
+		expect(rInfo.schedule).toEqual(expectedSchedule)
 	})
 
 })

tests/repetition.test.ts

@@ -1,40 +1,35 @@
-import { findInScheduleTypes } from '../server/helper/typeFind'
+import { Schedule } from '../server/types/scheduledEventTypes'
-import { supportedSchedule } from '../server/types/scheduledEventTypes'
+import { buildNewRepetitionString, getRepetitonInfo } from '../server/handler/repeatingEvents/helper'
-import { createEventInGuild, getRepetitonInfo } from '../server/handler/repeatingEvents/helper'
 import { RepetitonInfo } from '../server/types/scheduledEventTypes'
-import { handleRepeatingEvent } from '../server/handler/repeatingEvents/repeatingEvents.controller'
-import { GuildScheduledEventCreateOptions } from 'discord.js'
-describe('Schedule names are parsed correctly', () => {
-	const dailyValue: supportedSchedule = 'daily'
-	const weeklyValue: supportedSchedule = 'weekly'
-	const monthlyValue: supportedSchedule = 'monthly'
-	test('Easy schedule names', () => {
-		expect(findInScheduleTypes('daily')).toEqual(dailyValue)
-		expect(findInScheduleTypes('weekly')).toEqual(weeklyValue)
-		expect(findInScheduleTypes('monthly')).toEqual(monthlyValue)
-	})
-	test('Medium schedule names', () => {
-		expect(findInScheduleTypes('Daily')).toEqual(dailyValue)
-		expect(findInScheduleTypes('Weekly')).toEqual(weeklyValue)
-		expect(findInScheduleTypes('Monthly')).toEqual(monthlyValue)
-		expect(findInScheduleTypes('DAILY')).toEqual(dailyValue)
-		expect(findInScheduleTypes('WEEKLy')).toEqual(weeklyValue)
-		expect(findInScheduleTypes('MONTHly')).toEqual(monthlyValue)
-	})
-})
 describe('Parsing of Repetition Info from Description String', () => {
 	test('Happy Path', () => {
 		const inputString = '$rep:daily:1/3'
 		const expectedInfo: RepetitonInfo = {
 			totalAmount: 3,
 			alreadyOccured: 1,
-			schedule: 'daily'
+			schedule: new Schedule('daily')
 		}
-
 		expect(getRepetitonInfo(inputString)).toEqual(expectedInfo)
 	})
 
 })
+describe('new RepetitionString for complex schedule', () => {
+	const repString = '$rep:EvEry3WeeKs:2022-12-01'
+	const repInfo = getRepetitonInfo(repString)
+	const schedule = new Schedule(repString)
+	const str = schedule.getSanitizedScheduleString()
+	expect(str).toEqual('$rep:every3weeks:2022-12-01')
+	const oldDate = new Date('2022-01-01')
+	const newDate = schedule.getNewDate(oldDate)
+	expect(newDate).toEqual(new Date('2022-01-22'))
+	expect(buildNewRepetitionString(repInfo)).toEqual('$rep:every3weeks:2022-12-01')
+})
+describe('new RepetitionString for complex schedule', () => {
+	const repString = '$rep:EvEry3WeeKs:2022-12-01'
+	const schedule = new Schedule(repString)
+	const oldDate = new Date('2022-01-01')
+	const newDate = schedule.getNewDate(oldDate)
+})
 const oldEvent = {
 	"id": "965576921410859018",
 	"guildId": "907936880190967850",
@@ -73,24 +68,25 @@ const newEvent = {
 	"creator": null,
 	guild: {}
 }
+jest.mock('../server/helper/sendFailureDM.ts')
 jest.mock('../server/handler/repeatingEvents/helper.ts', () => ({
 	...(jest.requireActual('../server/handler/repeatingEvents/helper.ts')),
 	createEventInGuild: jest.fn().mockImplementation((opt: any) => {
 		return
 	})
 }))
-test('handleRepeatingEvent', () => {
+//test('handleRepeatingEvent', () => {
-
+//
-	const expectedOptions: GuildScheduledEventCreateOptions = {
+//	const expectedOptions: GuildScheduledEventCreateOptions = {
-		channel: "",
+//		channel: "",
-		description: "",
+//		description: "",
-		name: newEvent.name,
+//		name: newEvent.name,
-		entityType: <'VOICE'>newEvent.entityType,
+//		entityType: <'VOICE'>newEvent.entityType,
-		privacyLevel: <'GUILD_ONLY'>newEvent.privacyLevel,
+//		privacyLevel: <'GUILD_ONLY'>newEvent.privacyLevel,
-		reason: 'Repetition',
+//		reason: 'Repetition',
-		scheduledStartTime: ""
+//		scheduledStartTime: ""
-	}
+//	}
-	//@ts-ignore
+//	//@ts-ignore
-	handleRepeatingEvent(oldEvent, newEvent)
+//	//handleRepeatingEvent(oldEvent, newEvent)
-	expect(createEventInGuild).toHaveBeenCalledWith({}, expectedOptions)
+//	expect(createEventInGuild).toHaveBeenCalledWith({}, expectedOptions)
-})
+//})

tests/scheduleparsing.test.ts

@@ -0,0 +1,66 @@
+import { Schedule } from "../server/types/scheduledEventTypes"
+
+test('multiplier is parsed', () => {
+	const schedule = new Schedule('every3weeks')
+	const multi = schedule.getMultiplierFromVariableString()
+	expect(multi).toEqual(3)
+})
+test('get duration 3 weeks', () => {
+	const schedule = new Schedule('every3weeks')
+	const duration = schedule.calculateDuration()
+	expect(duration).toEqual({ weeks: 3 })
+})
+test('get duration 4 years', () => {
+	const schedule = new Schedule('every4years')
+	const duration = schedule.calculateDuration()
+	expect(duration).toEqual({ years: 4 })
+})
+test('get duration 27 days', () => {
+	const schedule = new Schedule('every27days')
+	const duration = schedule.calculateDuration()
+	expect(duration).toEqual({ days: 27 })
+})
+describe('get new Dates', () => {
+	test('every 27 days', () => {
+		const schedule = new Schedule('every27days')
+		const oldDate = new Date('2022-01-01')
+		const newDate = new Date('2022-01-28')
+		expect(schedule.getNewDate(oldDate)).toEqual(newDate)
+	})
+	test('every 2 weeks', () => {
+		const schedule = new Schedule('every2weeks')
+		const oldDate = new Date('2022-01-01')
+		const newDate = new Date('2022-01-15')
+		expect(schedule.getNewDate(oldDate)).toEqual(newDate)
+	})
+	test('every 1 month', () => {
+		const schedule = new Schedule('every1months')
+		const oldDate = new Date('2022-01-01')
+		const newDate = new Date('2022-02-01')
+		expect(schedule.getNewDate(oldDate)).toEqual(newDate)
+	})
+	test('every 4 year', () => {
+		const schedule = new Schedule('every4years')
+		const oldDate = new Date('2022-01-01')
+		const newDate = new Date('2026-01-01')
+		expect(schedule.getNewDate(oldDate)).toEqual(newDate)
+	})
+	test('every 2 days', () => {
+		const schedule = new Schedule('every2days')
+		const oldDate = new Date('2022-01-01')
+		const newDate = new Date('2022-01-03')
+		expect(schedule.getNewDate(oldDate)).toEqual(newDate)
+	})
+	test('every 2 days', () => {
+		const schedule = new Schedule('Every2DAys')
+		const oldDate = new Date('2022-01-01')
+		const newDate = new Date('2022-01-03')
+		expect(schedule.getNewDate(oldDate)).toEqual(newDate)
+	})
+	test('every 2 day[s]', () => {
+		const schedule = new Schedule('Every2DAy')
+		const oldDate = new Date('2022-01-01')
+		const newDate = new Date('2022-01-03')
+		expect(schedule.getNewDate(oldDate)).toEqual(newDate)
+	})
+})