X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=src%2Ftypes%2FUIProtocol.ts;h=174ae7dd0cbccf00cab4f49c7fdced2098f9ab5b;hb=981ebfbeeb421a4b620aa61861f9ddb313a03f67;hp=2abefe258dc991de01a9723d3d5fb563de181149;hpb=4198ad5c76ad58e444c1dd2d3f81b5f8fd2846d4;p=e-mobility-charging-stations-simulator.git diff --git a/src/types/UIProtocol.ts b/src/types/UIProtocol.ts index 2abefe25..174ae7dd 100644 --- a/src/types/UIProtocol.ts +++ b/src/types/UIProtocol.ts @@ -1,19 +1,64 @@ +import type { JsonObject } from './JsonType'; +import type { BroadcastChannelResponsePayload } from './WorkerBroadcastChannel'; + 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', START_TRANSACTION = 'startTransaction', STOP_TRANSACTION = 'stopTransaction', - UNKNOWN = 'unknown', + AUTHORIZE = 'authorize', + BOOT_NOTIFICATION = 'bootNotification', + STATUS_NOTIFICATION = 'statusNotification', + HEARTBEAT = 'heartbeat', + METER_VALUES = 'meterValues', } -export type ProtocolRequest = [ProtocolCommand, Record]; +export interface RequestPayload extends JsonObject { + hashIds?: string[]; + connectorIds?: number[]; +} -export type ProtocolRequestHandler = (payload: Record) => void | Promise | Record | Promise>; +export enum ResponseStatus { + SUCCESS = 'success', + FAILURE = 'failure', +} + +export interface ResponsePayload extends JsonObject { + status: ResponseStatus; + hashIdsSucceeded?: string[]; + hashIdsFailed?: string[]; + responsesFailed?: BroadcastChannelResponsePayload[]; +}