feat: add command to list templates on UI services

[e-mobility-charging-stations-simulator.git] / src / types / UIProtocol.ts

diff --git a/src/types/UIProtocol.ts b/src/types/UIProtocol.ts
index 463b205ec33b29982dcec20f5beb28c885e2e6e3..13da330efc3094f2c117d067e9e787cc02fd9c6e 100644 (file)
--- a/src/types/UIProtocol.ts
+++ b/src/types/UIProtocol.ts
@@ -1,48 +1,69 @@
-import type { JsonObject } from './JsonType';
+import type { JsonObject } from './JsonType.js'
+import type { BroadcastChannelResponsePayload } from './WorkerBroadcastChannel.js'
 
 export enum Protocol {
-  UI = 'ui',
+  UI = 'ui'
 }
 
 export enum ApplicationProtocol {
   HTTP = 'http',
-  WS = 'ws',
+  WS = 'ws'
+}
+
+export enum AuthenticationType {
+  BASIC_AUTH = 'basic-auth'
 }
 
 export enum ProtocolVersion {
-  '0.0.1' = '0.0.1',
+  '0.0.1' = '0.0.1'
 }
 
-export type ProtocolRequest = [string, ProcedureName, RequestPayload];
-export type ProtocolResponse = [string, ResponsePayload];
+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>;
+) => undefined | Promise<undefined> | ResponsePayload | Promise<ResponsePayload>
 
 export enum ProcedureName {
+  START_SIMULATOR = 'startSimulator',
+  STOP_SIMULATOR = 'stopSimulator',
+  LIST_TEMPLATES = 'listTemplates',
   LIST_CHARGING_STATIONS = 'listChargingStations',
   START_CHARGING_STATION = 'startChargingStation',
   STOP_CHARGING_STATION = 'stopChargingStation',
-  START_TRANSACTION = 'startTransaction',
-  STOP_TRANSACTION = 'stopTransaction',
-  START_SIMULATOR = 'startSimulator',
-  STOP_SIMULATOR = 'stopSimulator',
   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',
+  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 interface RequestPayload extends JsonObject {
-  hashId?: string;
-  hashIds?: string[];
+  hashIds?: string[]
+  connectorIds?: number[]
 }
 
 export enum ResponseStatus {
   SUCCESS = 'success',
-  FAILURE = 'failure',
+  FAILURE = 'failure'
 }
 
 export interface ResponsePayload extends JsonObject {
-  status: ResponseStatus;
+  status: ResponseStatus
+  hashIdsSucceeded?: string[]
+  hashIdsFailed?: string[]
+  responsesFailed?: BroadcastChannelResponsePayload[]
 }