UI Protocol: Build response with the global excecution status on each
[e-mobility-charging-stations-simulator.git] / src / types / UIProtocol.ts
index f7a4ac0c9fa286b2908bbec3ae8c38ab1aa48113..1f78671e2f6a4901c935b41736f1688459c2ff65 100644 (file)
@@ -1,4 +1,4 @@
-import { JsonObject, JsonType } from './JsonType';
+import type { JsonObject } from './JsonType';
 
 export enum Protocol {
   UI = 'ui',
@@ -13,12 +13,31 @@ export enum ProtocolVersion {
   '0.0.1' = '0.0.1',
 }
 
+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_TRANSACTION = 'startTransaction',
-  STOP_TRANSACTION = 'stopTransaction',
+  START_CHARGING_STATION = 'startChargingStation',
+  STOP_CHARGING_STATION = 'stopChargingStation',
   START_SIMULATOR = 'startSimulator',
   STOP_SIMULATOR = 'stopSimulator',
+  OPEN_CONNECTION = 'openConnection',
+  CLOSE_CONNECTION = 'closeConnection',
+  START_TRANSACTION = 'startTransaction',
+  STOP_TRANSACTION = 'stopTransaction',
+  START_AUTOMATIC_TRANSACTION_GENERATOR = 'startAutomaticTransactionGenerator',
+  STOP_AUTOMATIC_TRANSACTION_GENERATOR = 'stopAutomaticTransactionGenerator',
+}
+
+export interface RequestPayload extends JsonObject {
+  hashIds?: string[];
+  connectorIds?: number[];
 }
 
 export enum ResponseStatus {
@@ -28,11 +47,6 @@ export enum ResponseStatus {
 
 export interface ResponsePayload extends JsonObject {
   status: ResponseStatus;
+  hashIdsSucceeded?: string[];
+  hashIdsFailed?: string[];
 }
-
-export type ProtocolRequest = [string, ProcedureName, JsonType];
-export type ProtocolResponse = [string, ResponsePayload];
-
-export type ProtocolRequestHandler = (
-  payload: JsonType
-) => void | Promise<void> | ResponsePayload | Promise<ResponsePayload>;