src/types/UIProtocol.ts

   1 import type { JsonObject } from './JsonType.js'
   2 import type { BroadcastChannelResponsePayload } from './WorkerBroadcastChannel.js'
   3
   4 export enum Protocol {
   5   UI = 'ui'
   6 }
   7
   8 export enum ApplicationProtocol {
   9   HTTP = 'http',
  10   WS = 'ws'
  11 }
  12
  13 export enum AuthenticationType {
  14   BASIC_AUTH = 'basic-auth'
  15 }
  16
  17 export enum ProtocolVersion {
  18   '0.0.1' = '0.0.1'
  19 }
  20
  21 export type ProtocolRequest = [string, ProcedureName, RequestPayload]
  22 export type ProtocolResponse = [string, ResponsePayload]
  23
  24 export type ProtocolRequestHandler = (
  25   uuid?: string,
  26   procedureName?: ProcedureName,
  27   payload?: RequestPayload
  28 ) => undefined | Promise<undefined> | ResponsePayload | Promise<ResponsePayload>
  29
  30 export enum ProcedureName {
  31   START_SIMULATOR = 'startSimulator',
  32   STOP_SIMULATOR = 'stopSimulator',
  33   LIST_TEMPLATES = 'listTemplates',
  34   LIST_CHARGING_STATIONS = 'listChargingStations',
  35   START_CHARGING_STATION = 'startChargingStation',
  36   STOP_CHARGING_STATION = 'stopChargingStation',
  37   OPEN_CONNECTION = 'openConnection',
  38   CLOSE_CONNECTION = 'closeConnection',
  39   START_AUTOMATIC_TRANSACTION_GENERATOR = 'startAutomaticTransactionGenerator',
  40   STOP_AUTOMATIC_TRANSACTION_GENERATOR = 'stopAutomaticTransactionGenerator',
  41   SET_SUPERVISION_URL = 'setSupervisionUrl',
  42   START_TRANSACTION = 'startTransaction',
  43   STOP_TRANSACTION = 'stopTransaction',
  44   AUTHORIZE = 'authorize',
  45   BOOT_NOTIFICATION = 'bootNotification',
  46   STATUS_NOTIFICATION = 'statusNotification',
  47   HEARTBEAT = 'heartbeat',
  48   METER_VALUES = 'meterValues',
  49   DATA_TRANSFER = 'dataTransfer',
  50   DIAGNOSTICS_STATUS_NOTIFICATION = 'diagnosticsStatusNotification',
  51   FIRMWARE_STATUS_NOTIFICATION = 'firmwareStatusNotification'
  52 }
  53
  54 export interface RequestPayload extends JsonObject {
  55   hashIds?: string[]
  56   connectorIds?: number[]
  57 }
  58
  59 export enum ResponseStatus {
  60   SUCCESS = 'success',
  61   FAILURE = 'failure'
  62 }
  63
  64 export interface ResponsePayload extends JsonObject {
  65   status: ResponseStatus
  66   hashIdsSucceeded?: string[]
  67   hashIdsFailed?: string[]
  68   responsesFailed?: BroadcastChannelResponsePayload[]
  69 }