src/types/UIProtocol.ts

   1 import type { JsonObject } from './JsonType';
   2
   3 export enum Protocol {
   4   UI = 'ui',
   5 }
   6
   7 export enum ApplicationProtocol {
   8   HTTP = 'http',
   9   WS = 'ws',
  10 }
  11
  12 export enum ProtocolVersion {
  13   '0.0.1' = '0.0.1',
  14 }
  15
  16 export type ProtocolRequest = [string, ProcedureName, RequestPayload];
  17 export type ProtocolResponse = [string, ResponsePayload];
  18
  19 export type ProtocolRequestHandler = (
  20   uuid?: string,
  21   payload?: RequestPayload
  22 ) => undefined | Promise<undefined> | ResponsePayload | Promise<ResponsePayload>;
  23
  24 export enum ProcedureName {
  25   LIST_CHARGING_STATIONS = 'listChargingStations',
  26   START_CHARGING_STATION = 'startChargingStation',
  27   STOP_CHARGING_STATION = 'stopChargingStation',
  28   START_SIMULATOR = 'startSimulator',
  29   STOP_SIMULATOR = 'stopSimulator',
  30   OPEN_CONNECTION = 'openConnection',
  31   CLOSE_CONNECTION = 'closeConnection',
  32   START_TRANSACTION = 'startTransaction',
  33   STOP_TRANSACTION = 'stopTransaction',
  34   START_AUTOMATIC_TRANSACTION_GENERATOR = 'startAutomaticTransactionGenerator',
  35   STOP_AUTOMATIC_TRANSACTION_GENERATOR = 'stopAutomaticTransactionGenerator',
  36 }
  37
  38 export interface RequestPayload extends JsonObject {
  39   hashIds?: string[];
  40   connectorIds?: number[];
  41 }
  42
  43 export enum ResponseStatus {
  44   SUCCESS = 'success',
  45   FAILURE = 'failure',
  46 }
  47
  48 export interface ResponsePayload extends JsonObject {
  49   status: ResponseStatus;
  50   hashIdsSucceeded?: string[];
  51   hashIdsFailed?: string[];
  52 }