docs(README.md): refine volta installation on windows

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

import type { JsonObject } from './JsonType'

export enum Protocol {
  UI = 'ui'
}

export enum ApplicationProtocol {
  WS = 'ws',
  WSS = 'wss'
}

export enum ProtocolVersion {
  '0.0.1' = '0.0.1'
}

export enum AuthenticationType {
  PROTOCOL_BASIC_AUTH = 'protocol-basic-auth'
}

export type ProtocolRequest = [
  `${string}-${string}-${string}-${string}-${string}`,
  ProcedureName,
  RequestPayload
]
export type ProtocolResponse = [
  `${string}-${string}-${string}-${string}-${string}`,
  ResponsePayload
]

export type ProtocolRequestHandler = (
  payload: RequestPayload
) => ResponsePayload | Promise<ResponsePayload>

export enum ProcedureName {
  SIMULATOR_STATE = 'simulatorState',
  START_SIMULATOR = 'startSimulator',
  STOP_SIMULATOR = 'stopSimulator',
  LIST_TEMPLATES = 'listTemplates',
  LIST_CHARGING_STATIONS = 'listChargingStations',
  ADD_CHARGING_STATIONS = 'addChargingStations',
  DELETE_CHARGING_STATIONS = 'deleteChargingStations',
  SET_SUPERVISION_URL = 'setSupervisionUrl',
  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'
}

export interface RequestPayload extends JsonObject {
  hashIds?: string[]
  connectorIds?: number[]
}

export enum ResponseStatus {
  SUCCESS = 'success',
  FAILURE = 'failure'
}

export interface ResponsePayload extends JsonObject {
  status: ResponseStatus
  hashIds?: string[]
}

interface TemplateStatistics extends JsonObject {
  configured: number
  added: number
  started: number
  indexes: number[]
}

export interface SimulatorState extends JsonObject {
  version: string
  started: boolean
  templateStatistics: Record<string, TemplateStatistics>
}