X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Ftypes%2FUIProtocol.ts;h=3a76bd0007302ec8a11540a6c317bd59fd3c4675;hb=cb886184464ed30ee14f538581e511710131b6ef;hp=6d2478924285e3b97dfa67c1de04b28c0272bee5;hpb=5cc4b63bd363814ddc657bd4c9b407e5eb3150cb;p=e-mobility-charging-stations-simulator.git diff --git a/src/types/UIProtocol.ts b/src/types/UIProtocol.ts index 6d247892..3a76bd00 100644 --- a/src/types/UIProtocol.ts +++ b/src/types/UIProtocol.ts @@ -1,22 +1,49 @@ -import { JsonType } from './JsonType'; +import type { 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 | ResponsePayload | Promise; + +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, JsonType]; +export interface RequestPayload extends JsonObject { + hashId?: string; + hashIds?: string[]; +} -export type ProtocolRequestHandler = ( - payload: JsonType -) => void | Promise | JsonType | Promise; +export enum ResponseStatus { + SUCCESS = 'success', + FAILURE = 'failure', +} + +export interface ResponsePayload extends JsonObject { + status: ResponseStatus; + hashIds?: string[]; +}