README.md: formatting fixes
[e-mobility-charging-stations-simulator.git] / src / charging-station / ui-server / AbstractUIServer.ts
index e0b1207106e34ab1755a68cf9d3974d27a8d3088..91c69a76765b835447988ba46e106ed87829caf2 100644 (file)
@@ -1,10 +1,17 @@
-import { Server as HttpServer } from 'http';
+import type { Server as HttpServer } from 'http';
 
-import WebSocket from 'ws';
+import type WebSocket from 'ws';
 
-import { ChargingStationData } from '../../types/ChargingStationWorker';
-import { ProtocolVersion } from '../../types/UIProtocol';
-import AbstractUIService from './ui-services/AbstractUIService';
+import type { ChargingStationData } from '../../types/ChargingStationWorker';
+import type {
+  ProcedureName,
+  ProtocolRequest,
+  ProtocolResponse,
+  ProtocolVersion,
+  RequestPayload,
+  ResponsePayload,
+} from '../../types/UIProtocol';
+import type AbstractUIService from './ui-services/AbstractUIService';
 
 export abstract class AbstractUIServer {
   public readonly chargingStations: Map<string, ChargingStationData>;
@@ -16,9 +23,21 @@ export abstract class AbstractUIServer {
     this.uiServices = new Map<ProtocolVersion, AbstractUIService>();
   }
 
+  public buildProtocolRequest(
+    id: string,
+    procedureName: ProcedureName,
+    requestPayload: RequestPayload
+  ): string {
+    return JSON.stringify([id, procedureName, requestPayload] as ProtocolRequest);
+  }
+
+  public buildProtocolResponse(id: string, responsePayload: ResponsePayload): string {
+    return JSON.stringify([id, responsePayload] as ProtocolResponse);
+  }
+
   public abstract start(): void;
   public abstract stop(): void;
   public abstract sendRequest(request: string): void;
   public abstract sendResponse(response: string): void;
-  public abstract logPrefix(modName?: string, methodName?: string): string;
+  public abstract logPrefix(modName?: string, methodName?: string, prefixSuffix?: string): string;
 }