X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Ftypes%2FUIProtocol.ts;h=4911f9ada2411c53612978878105ba7b5765beba;hb=0a1dd746244cebb3633d88c6650839d9f32227fe;hp=3e4d6232ba6202ca395fa57791fe8886b0f332e5;hpb=ee0f106b09f38b1561d970ea4377eb199389298e;p=e-mobility-charging-stations-simulator.git diff --git a/src/types/UIProtocol.ts b/src/types/UIProtocol.ts index 3e4d6232..4911f9ad 100644 --- a/src/types/UIProtocol.ts +++ b/src/types/UIProtocol.ts @@ -1,16 +1,68 @@ +import type { JsonObject } from './JsonType.js' +import type { BroadcastChannelResponsePayload } from './WorkerBroadcastChannel.js' + +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 | ResponsePayload | Promise + +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 interface RequestPayload extends JsonObject { + hashIds?: string[] + connectorIds?: number[] } -export type ProtocolRequest = [ProtocolVersion, ProtocolCommand, Record]; +export enum ResponseStatus { + SUCCESS = 'success', + FAILURE = 'failure', +} -export type ProtocolRequestHandler = (payload: Record) => Record | Promise>; +export interface ResponsePayload extends JsonObject { + status: ResponseStatus + hashIdsSucceeded?: string[] + hashIdsFailed?: string[] + responsesFailed?: BroadcastChannelResponsePayload[] +}