X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Ftypes%2FUIProtocol.ts;h=e7635b2e59167f3a3b48b51e9c2eed944700ff1b;hb=ac7f79af9a7d553aa0806b97fa138b15cd3d9542;hp=a7dfa334ef7f3fbb7c0e1b2ec03782c6a00a2538;hpb=8244f5f080133602e63ce6d985f87782a8af9fbc;p=e-mobility-charging-stations-simulator.git diff --git a/src/types/UIProtocol.ts b/src/types/UIProtocol.ts index a7dfa334..e7635b2e 100644 --- a/src/types/UIProtocol.ts +++ b/src/types/UIProtocol.ts @@ -1,15 +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 | 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[]; +}