refactor: cleanup RFID tags authorization code
[e-mobility-charging-stations-simulator.git] / ui / web / src / types / UIProtocol.ts
... / ...
CommitLineData
1import type { JsonObject } from './JsonType';
2
3export enum Protocol {
4 UI = 'ui',
5}
6
7export enum ApplicationProtocol {
8 HTTP = 'http',
9 WS = 'ws',
10}
11
12export enum ProtocolVersion {
13 '0.0.1' = '0.0.1',
14}
15
16export type ProtocolRequest = [string, ProcedureName, RequestPayload];
17export type ProtocolResponse = [string, ResponsePayload];
18
19export type ProtocolRequestHandler = (
20 payload: RequestPayload,
21) => ResponsePayload | Promise<ResponsePayload>;
22
23export enum ProcedureName {
24 START_SIMULATOR = 'startSimulator',
25 STOP_SIMULATOR = 'stopSimulator',
26 LIST_CHARGING_STATIONS = 'listChargingStations',
27 START_CHARGING_STATION = 'startChargingStation',
28 STOP_CHARGING_STATION = 'stopChargingStation',
29 OPEN_CONNECTION = 'openConnection',
30 CLOSE_CONNECTION = 'closeConnection',
31 START_AUTOMATIC_TRANSACTION_GENERATOR = 'startAutomaticTransactionGenerator',
32 STOP_AUTOMATIC_TRANSACTION_GENERATOR = 'stopAutomaticTransactionGenerator',
33 START_TRANSACTION = 'startTransaction',
34 STOP_TRANSACTION = 'stopTransaction',
35}
36
37export interface RequestPayload extends JsonObject {
38 hashIds?: string[];
39 connectorIds?: number[];
40}
41
42export enum ResponseStatus {
43 SUCCESS = 'success',
44 FAILURE = 'failure',
45}
46
47export interface ResponsePayload extends JsonObject {
48 status: ResponseStatus;
49 hashIds?: string[];
50}