🏗️ add body type to BridgeRequest

Author: MalteSehmer

src/middlewares/extract-header.middleware.ts

@@ -4,7 +4,7 @@ import { BridgeRequest } from "../models";
 const DEFAULT_LOCALE = "en-GB";
 
 export function extractHeaderMiddleware(
-  req: BridgeRequest,
+  req: BridgeRequest<any>,
   res: Response,
   next: NextFunction
 ): void {

src/models/bridge-request.model.ts

@@ -2,10 +2,11 @@ import { IntegrationEntityType } from "./integration-entity.model";
 import { Request } from "express";
 import { Config } from "./config.model";
 
-export interface BridgeRequest extends Request {
+export interface BridgeRequest<BodyType> extends Request {
   providerConfig?: Config;
+  body: BodyType;
 }
 
-export interface IntegrationEntityBridgeRequest extends BridgeRequest {
+export interface IntegrationEntityBridgeRequest extends BridgeRequest<unknown> {
   params: { id: string; type: IntegrationEntityType };
 }

src/models/controller.model.test.ts

@@ -7,7 +7,9 @@ import {
 } from "node-mocks-http";
 import {
   CalendarEvent,
+  CalendarEventTemplate,
   CallDirection,
+  CallEvent,
   CallParticipantType,
   CallState,
   Contact,
@@ -127,7 +129,7 @@ console.log = jest.fn();
 jest.useFakeTimers();
 
 describe("getContacts", () => {
-  let request: MockRequest<BridgeRequest>;
+  let request: MockRequest<BridgeRequest<unknown>>;
   let response: MockResponse<Response>;
   let next: jest.Mock;
 
@@ -230,7 +232,7 @@ describe("getContacts", () => {
 });
 
 describe("getCalendarEvents", () => {
-  let request: MockRequest<BridgeRequest>;
+  let request: MockRequest<BridgeRequest<unknown>>;
   let response: MockResponse<Response>;
   let next: jest.Mock;
 
@@ -298,7 +300,7 @@ describe("getCalendarEvents", () => {
 });
 
 describe("createCalendarEvent", () => {
-  let request: MockRequest<BridgeRequest>;
+  let request: MockRequest<BridgeRequest<CalendarEventTemplate>>;
   let response: MockResponse<Response>;
   let next: jest.Mock;
 
@@ -366,7 +368,7 @@ describe("createCalendarEvent", () => {
 });
 
 describe("updateCalendarEvent", () => {
-  let request: MockRequest<BridgeRequest>;
+  let request: MockRequest<BridgeRequest<CalendarEventTemplate>>;
   let response: MockResponse<Response>;
   let next: jest.Mock;
 
@@ -434,7 +436,7 @@ describe("updateCalendarEvent", () => {
 });
 
 describe("deleteCalendarEvent", () => {
-  let request: MockRequest<BridgeRequest>;
+  let request: MockRequest<BridgeRequest<unknown>>;
   let response: MockResponse<Response>;
   let next: jest.Mock;
 
@@ -481,7 +483,7 @@ describe("deleteCalendarEvent", () => {
 });
 
 describe("getOAuth2RedirectUrl", () => {
-  let request: MockRequest<BridgeRequest>;
+  let request: MockRequest<BridgeRequest<unknown>>;
   let response: MockResponse<Response>;
   let next: jest.Mock;
 
@@ -544,7 +546,7 @@ describe("getOAuth2RedirectUrl", () => {
 });
 
 describe("getHealth", () => {
-  let request: MockRequest<BridgeRequest>;
+  let request: MockRequest<BridgeRequest<unknown>>;
   let response: MockResponse<Response>;
   let next: jest.Mock;
 
@@ -604,7 +606,7 @@ describe("getHealth", () => {
 });
 
 describe("handleCallEvent", () => {
-  let request: MockRequest<BridgeRequest>;
+  let request: MockRequest<BridgeRequest<CallEvent>>;
   let response: MockResponse<Response>;
   let next: jest.Mock;
 
@@ -729,7 +731,7 @@ describe("handleCallEvent", () => {
 });
 
 describe("updateCallEvent", () => {
-  let request: MockRequest<BridgeRequest>;
+  let request: MockRequest<BridgeRequest<CallEvent>>;
   let response: MockResponse<Response>;
   let next: jest.Mock;
 

src/models/controller.model.ts

@@ -51,7 +51,7 @@ export class Controller {
   }
 
   public async getContacts(
-    req: BridgeRequest,
+    req: BridgeRequest<unknown>,
     res: Response,
     next: NextFunction
   ): Promise<void> {
@@ -137,7 +137,7 @@ export class Controller {
   }
 
   public async createContact(
-    req: BridgeRequest,
+    req: BridgeRequest<ContactTemplate>,
     res: Response,
     next: NextFunction
   ): Promise<void> {
@@ -155,7 +155,7 @@ export class Controller {
 
       const contact: Contact = await this.adapter.createContact(
         req.providerConfig,
-        req.body as ContactTemplate
+        req.body
       );
 
       const valid = validate(this.ajv, contactsSchema, [contact]);
@@ -201,7 +201,7 @@ export class Controller {
   }
 
   public async updateContact(
-    req: BridgeRequest,
+    req: BridgeRequest<ContactUpdate>,
     res: Response,
     next: NextFunction
   ): Promise<void> {
@@ -220,7 +220,7 @@ export class Controller {
       const contact: Contact = await this.adapter.updateContact(
         req.providerConfig,
         req.params.id,
-        req.body as ContactUpdate
+        req.body
       );
 
       const valid = validate(this.ajv, contactsSchema, [contact]);
@@ -265,7 +265,7 @@ export class Controller {
   }
 
   public async deleteContact(
-    req: BridgeRequest,
+    req: BridgeRequest<unknown>,
     res: Response,
     next: NextFunction
   ): Promise<void> {
@@ -315,7 +315,7 @@ export class Controller {
   }
 
   public async getCalendarEvents(
-    req: BridgeRequest,
+    req: BridgeRequest<unknown>,
     res: Response,
     next: NextFunction
   ): Promise<void> {
@@ -372,7 +372,7 @@ export class Controller {
   }
 
   public async createCalendarEvent(
-    req: BridgeRequest,
+    req: BridgeRequest<CalendarEventTemplate>,
     res: Response,
     next: NextFunction
   ): Promise<void> {
@@ -392,10 +392,7 @@ export class Controller {
       console.log(`[${anonymizeKey(apiKey)}] Creating calendar event`);
 
       const calendarEvent: CalendarEvent =
-        await this.adapter.createCalendarEvent(
-          req.providerConfig,
-          req.body as CalendarEventTemplate
-        );
+        await this.adapter.createCalendarEvent(req.providerConfig, req.body);
 
       const valid = validate(this.ajv, calendarEventsSchema, [calendarEvent]);
       if (!valid) {
@@ -417,7 +414,7 @@ export class Controller {
   }
 
   public async updateCalendarEvent(
-    req: BridgeRequest,
+    req: BridgeRequest<CalendarEventTemplate>,
     res: Response,
     next: NextFunction
   ): Promise<void> {
@@ -440,7 +437,7 @@ export class Controller {
         await this.adapter.updateCalendarEvent(
           req.providerConfig,
           req.params.id,
-          req.body as CalendarEventTemplate
+          req.body
         );
 
       const valid = validate(this.ajv, calendarEventsSchema, [calendarEvent]);
@@ -463,7 +460,7 @@ export class Controller {
   }
 
   public async deleteCalendarEvent(
-    req: BridgeRequest,
+    req: BridgeRequest<unknown>,
     res: Response,
     next: NextFunction
   ): Promise<void> {
@@ -491,7 +488,7 @@ export class Controller {
   }
 
   public async handleCallEvent(
-    req: BridgeRequest,
+    req: BridgeRequest<CallEvent>,
     res: Response,
     next: NextFunction
   ): Promise<void> {
@@ -506,7 +503,7 @@ export class Controller {
         throw new ServerError(501, "Handling call event is not implemented");
       }
 
-      if (shouldSkipCallEvent(req.body as CallEvent)) {
+      if (shouldSkipCallEvent(req.body)) {
         infoLogger(
           `Skipping call event for call id ${req.body.id}`,
           providerConfig
@@ -534,7 +531,7 @@ export class Controller {
   }
 
   public async handleConnectedEvent(
-    req: BridgeRequest,
+    req: BridgeRequest<unknown>,
     res: Response,
     next: NextFunction
   ): Promise<void> {
@@ -563,7 +560,7 @@ export class Controller {
   }
 
   public async updateCallEvent(
-    req: BridgeRequest,
+    req: BridgeRequest<CallEvent>,
     res: Response,
     next: NextFunction
   ): Promise<void> {
@@ -619,7 +616,7 @@ export class Controller {
   }
 
   public async getHealth(
-    req: BridgeRequest,
+    req: BridgeRequest<unknown>,
     res: Response,
     next: NextFunction
   ): Promise<void> {