README.md: document missing UI protocol commands

[e-mobility-charging-stations-simulator.git] / src / types / UIProtocol.ts

diff --git a/src/types/UIProtocol.ts b/src/types/UIProtocol.ts
index 05ddaa235da3e016cbdac2a1033b1419f308be62..63bb7ca1a5bc61c90bb99a1b62e598478eefa2da 100644 (file)
--- a/src/types/UIProtocol.ts
+++ b/src/types/UIProtocol.ts
@@ -1,18 +1,47 @@
+import { JsonObject } from './JsonType';
+
 export enum Protocol {
   UI = 'ui',
 }
 
+export enum ApplicationProtocol {
+  HTTP = 'http',
+  WS = 'ws',
+}
+
 export enum ProtocolVersion {
   '0.0.1' = '0.0.1',
 }
 
-export enum ProtocolCommand {
+export type ProtocolRequest = [string, ProcedureName, RequestPayload];
+export type ProtocolResponse = [string, ResponsePayload];
+
+export type ProtocolRequestHandler = (
+  uuid?: string,
+  payload?: RequestPayload
+) => undefined | Promise<undefined> | ResponsePayload | Promise<ResponsePayload>;
+
+export enum ProcedureName {
   LIST_CHARGING_STATIONS = 'listChargingStations',
+  START_CHARGING_STATION = 'startChargingStation',
+  STOP_CHARGING_STATION = 'stopChargingStation',
   START_TRANSACTION = 'startTransaction',
   STOP_TRANSACTION = 'stopTransaction',
-  UNKNOWN = 'unknown',
+  START_SIMULATOR = 'startSimulator',
+  STOP_SIMULATOR = 'stopSimulator',
+  OPEN_CONNECTION = 'openConnection',
+  CLOSE_CONNECTION = 'closeConnection',
 }
 
-export type ProtocolRequest = [ProtocolCommand, Record<string, unknown>];
+export interface RequestPayload extends JsonObject {
+  hashId?: string;
+}
+
+export enum ResponseStatus {
+  SUCCESS = 'success',
+  FAILURE = 'failure',
+}
 
-export type ProtocolRequestHandler = (payload: Record<string, unknown>) => void | Promise<void> | Record<string, unknown> | Promise<Record<string, unknown>>;
+export interface ResponsePayload extends JsonObject {
+  status: ResponseStatus;
+}