refactor: fix TS issues for events

backend/src/@types/mongoose.d.ts

@@ -1,3 +1,7 @@
+import ModelCreatedEvent from "@/modules/DataModule/ModelCreatedEvent";
+import ModelDeletedEvent from "@/modules/DataModule/ModelDeletedEvent";
+import ModelUpdatedEvent from "@/modules/DataModule/ModelUpdatedEvent";
+
 declare module "mongoose" {
 	// Add some additional possible config options to Mongoose's schema options
 	interface SchemaOptions<
@@ -7,12 +11,12 @@ declare module "mongoose" {
 		QueryHelpers = {},
 		TStaticMethods = {},
 		TVirtuals = {},
-		/* eslint-enable */
 		THydratedDocumentType = HydratedDocument<
 			DocType,
 			TInstanceMethods,
 			QueryHelpers
 		>
+		/* eslint-enable */
 	> {
 		patchHistory?: {
 			enabled: boolean;
@@ -40,13 +44,13 @@ declare module "mongoose" {
 
 		eventListeners?: {
 			[key: `${string}.created`]: (
-				doc: THydratedDocumentType
+				event: ModelCreatedEvent
 			) => Promise<void>;
 			[key: `${string}.updated`]: (
-				doc: THydratedDocumentType
+				event: ModelUpdatedEvent
 			) => Promise<void>;
 			[key: `${string}.deleted`]: (
-				oldDoc: THydratedDocumentType
+				event: ModelDeletedEvent
 			) => Promise<void>;
 		};
 	}

backend/src/BaseModule.ts

@@ -4,7 +4,7 @@ import { forEachIn } from "@common/utils/forEachIn";
 import LogBook, { Log } from "@/LogBook";
 import ModuleManager from "@/ModuleManager";
 import Job from "./Job";
-import Event from "./modules/EventsModule/Event";
+import { EventClass } from "./modules/EventsModule/Event";
 
 export enum ModuleStatus {
 	LOADED = "LOADED",
@@ -25,7 +25,7 @@ export default abstract class BaseModule {
 
 	protected _jobs: Record<string, typeof Job>;
 
-	protected _events: Record<string, typeof Event>;
+	protected _events: Record<string, EventClass>;
 
 	/**
 	 * Base Module
@@ -182,7 +182,7 @@ export default abstract class BaseModule {
 	/**
 	 * getEvent - Get module event
 	 */
-	public getEvent(name: string) {
+	public getEvent(name: string): EventClass {
 		const [, Event] =
 			Object.entries(this._events).find(
 				([eventName]) => eventName === name

backend/src/modules/DataModule/DataModuleEvent.ts

@@ -13,8 +13,4 @@ export default abstract class DataModuleEvent extends ModuleEvent {
 	public static getModelName() {
 		return this._modelName;
 	}
-
-	public getModelName() {
-		return (this.constructor as typeof DataModuleEvent).getModelName();
-	}
 }

backend/src/modules/EventsModule.ts

@@ -12,8 +12,6 @@ import { forEachIn } from "@common/utils/forEachIn";
 import BaseModule, { ModuleStatus } from "@/BaseModule";
 import WebSocketModule from "./WebSocketModule";
 import Event from "@/modules/EventsModule/Event";
-import { EventDerived } from "@/types/EventDerived";
-import assertEventDerived from "@/utils/assertEventDerived";
 import ModuleManager from "@/ModuleManager";
 
 export class EventsModule extends BaseModule {
@@ -33,7 +31,7 @@ export class EventsModule extends BaseModule {
 
 	private _pSubscriptions: Record<
 		string,
-		((message: string, key: string) => Promise<void>)[]
+		((event: Event) => Promise<void>)[]
 	>;
 
 	private _socketSubscriptions: Record<string, Set<string>>;
@@ -210,7 +208,7 @@ export class EventsModule extends BaseModule {
 	/**
 	 * publish - Publish an event
 	 */
-	public async publish(event: typeof Event) {
+	public async publish(event: Event) {
 		if (!this._pubClient) throw new Error("Redis pubClient unavailable.");
 
 		const channel = event.getKey();
@@ -231,7 +229,7 @@ export class EventsModule extends BaseModule {
 
 		const { path, scope } = Event.parseKey(key);
 		const EventClass = this.getEvent(path);
-		const parsedMessage = EventClass.parseMessage(message);
+		const parsedMessage = Event.parseMessage(message);
 		const event = new EventClass(parsedMessage, scope);
 
 		if (this._subscriptions && this._subscriptions[key])
@@ -285,7 +283,7 @@ export class EventsModule extends BaseModule {
 	 */
 	public async pSubscribe(
 		pattern: string,
-		callback: (message: string, key: string) => Promise<void>
+		callback: (event: Event) => Promise<void>
 	) {
 		if (!this._subClient) throw new Error("Redis subClient unavailable.");
 

backend/src/modules/EventsModule/Event.ts

@@ -1,4 +1,4 @@
-import { HydratedDocument, Model } from "mongoose";
+import { HydratedDocument } from "mongoose";
 import { UserSchema } from "@models/users/schema";
 
 export default abstract class Event {
@@ -122,3 +122,7 @@ export default abstract class Event {
 		return (this.constructor as typeof Event).makeMessage(this._data);
 	}
 }
+
+export type EventClass = {
+	new (...params: ConstructorParameters<typeof Event>): Event;
+};