feat: add performance statistics to UI protocol
[e-mobility-charging-stations-simulator.git] / src / types / UIProtocol.ts
1 import type { JsonObject } from './JsonType.js'
2 import type { BroadcastChannelResponsePayload } from './WorkerBroadcastChannel.js'
3
4 export enum Protocol {
5 UI = 'ui'
6 }
7
8 export enum ApplicationProtocol {
9 HTTP = 'http',
10 WS = 'ws'
11 }
12
13 export enum AuthenticationType {
14 BASIC_AUTH = 'basic-auth'
15 }
16
17 export enum ProtocolVersion {
18 '0.0.1' = '0.0.1'
19 }
20
21 export type ProtocolRequest = [string, ProcedureName, RequestPayload]
22 export type ProtocolResponse = [string, ResponsePayload]
23
24 export type ProtocolRequestHandler = (
25 uuid?: string,
26 procedureName?: ProcedureName,
27 payload?: RequestPayload
28 ) => undefined | Promise<undefined> | ResponsePayload | Promise<ResponsePayload>
29
30 export enum ProcedureName {
31 START_SIMULATOR = 'startSimulator',
32 STOP_SIMULATOR = 'stopSimulator',
33 LIST_TEMPLATES = 'listTemplates',
34 LIST_CHARGING_STATIONS = 'listChargingStations',
35 ADD_CHARGING_STATIONS = 'addChargingStations',
36 PERFORMANCE_STATISTICS = 'performanceStatistics',
37 START_CHARGING_STATION = 'startChargingStation',
38 STOP_CHARGING_STATION = 'stopChargingStation',
39 OPEN_CONNECTION = 'openConnection',
40 CLOSE_CONNECTION = 'closeConnection',
41 START_AUTOMATIC_TRANSACTION_GENERATOR = 'startAutomaticTransactionGenerator',
42 STOP_AUTOMATIC_TRANSACTION_GENERATOR = 'stopAutomaticTransactionGenerator',
43 SET_SUPERVISION_URL = 'setSupervisionUrl',
44 START_TRANSACTION = 'startTransaction',
45 STOP_TRANSACTION = 'stopTransaction',
46 AUTHORIZE = 'authorize',
47 BOOT_NOTIFICATION = 'bootNotification',
48 STATUS_NOTIFICATION = 'statusNotification',
49 HEARTBEAT = 'heartbeat',
50 METER_VALUES = 'meterValues',
51 DATA_TRANSFER = 'dataTransfer',
52 DIAGNOSTICS_STATUS_NOTIFICATION = 'diagnosticsStatusNotification',
53 FIRMWARE_STATUS_NOTIFICATION = 'firmwareStatusNotification'
54 }
55
56 export interface RequestPayload extends JsonObject {
57 hashIds?: string[]
58 connectorIds?: number[]
59 }
60
61 export enum ResponseStatus {
62 SUCCESS = 'success',
63 FAILURE = 'failure'
64 }
65
66 export interface ResponsePayload extends JsonObject {
67 status: ResponseStatus
68 hashIdsSucceeded?: string[]
69 hashIdsFailed?: string[]
70 responsesFailed?: BroadcastChannelResponsePayload[]
71 }