fix: fix ATG refresh at template changes
[e-mobility-charging-stations-simulator.git] / src / types / UIProtocol.ts
index 2abefe258dc991de01a9723d3d5fb563de181149..e7635b2e59167f3a3b48b51e9c2eed944700ff1b 100644 (file)
@@ -1,19 +1,67 @@
+import type { BroadcastChannelResponsePayload, JsonObject } from './internal';
+
 export enum Protocol {
   UI = 'ui',
 }
 
+export enum ApplicationProtocol {
+  HTTP = 'http',
+  WS = 'ws',
+}
+
+export enum AuthenticationType {
+  BASIC_AUTH = 'basic-auth',
+}
+
 export enum ProtocolVersion {
   '0.0.1' = '0.0.1',
-  '0.0.2' = '0.0.2',
 }
 
-export enum ProtocolCommand {
+export type ProtocolRequest = [string, ProcedureName, RequestPayload];
+export type ProtocolResponse = [string, ResponsePayload];
+
+export type ProtocolRequestHandler = (
+  uuid?: string,
+  procedureName?: ProcedureName,
+  payload?: RequestPayload
+) => undefined | Promise<undefined> | ResponsePayload | Promise<ResponsePayload>;
+
+export enum ProcedureName {
+  START_SIMULATOR = 'startSimulator',
+  STOP_SIMULATOR = 'stopSimulator',
   LIST_CHARGING_STATIONS = 'listChargingStations',
+  START_CHARGING_STATION = 'startChargingStation',
+  STOP_CHARGING_STATION = 'stopChargingStation',
+  OPEN_CONNECTION = 'openConnection',
+  CLOSE_CONNECTION = 'closeConnection',
+  START_AUTOMATIC_TRANSACTION_GENERATOR = 'startAutomaticTransactionGenerator',
+  STOP_AUTOMATIC_TRANSACTION_GENERATOR = 'stopAutomaticTransactionGenerator',
+  SET_SUPERVISION_URL = 'setSupervisionUrl',
   START_TRANSACTION = 'startTransaction',
   STOP_TRANSACTION = 'stopTransaction',
-  UNKNOWN = 'unknown',
+  AUTHORIZE = 'authorize',
+  BOOT_NOTIFICATION = 'bootNotification',
+  STATUS_NOTIFICATION = 'statusNotification',
+  HEARTBEAT = 'heartbeat',
+  METER_VALUES = 'meterValues',
+  DATA_TRANSFER = 'dataTransfer',
+  DIAGNOSTICS_STATUS_NOTIFICATION = 'diagnosticsStatusNotification',
+  FIRMWARE_STATUS_NOTIFICATION = 'firmwareStatusNotification',
 }
 
-export type ProtocolRequest = [ProtocolCommand, Record<string, unknown>];
+export interface RequestPayload extends JsonObject {
+  hashIds?: string[];
+  connectorIds?: number[];
+}
 
-export type ProtocolRequestHandler = (payload: Record<string, unknown>) => void | Promise<void> | Record<string, unknown> | Promise<Record<string, unknown>>;
+export enum ResponseStatus {
+  SUCCESS = 'success',
+  FAILURE = 'failure',
+}
+
+export interface ResponsePayload extends JsonObject {
+  status: ResponseStatus;
+  hashIdsSucceeded?: string[];
+  hashIdsFailed?: string[];
+  responsesFailed?: BroadcastChannelResponsePayload[];
+}