src/charging-station/ocpp/2.0/OCPP20RequestService.ts

   1 // Partial Copyright Jerome Benoit. 2021-2024. All Rights Reserved.
   2
   3 import type { JSONSchemaType } from 'ajv'
   4
   5 import { OCPP20Constants } from './OCPP20Constants.js'
   6 import { OCPP20ServiceUtils } from './OCPP20ServiceUtils.js'
   7 import type { ChargingStation } from '../../../charging-station/index.js'
   8 import { OCPPError } from '../../../exception/index.js'
   9 import {
  10   ErrorType,
  11   type JsonObject,
  12   type JsonType,
  13   type OCPP20BootNotificationRequest,
  14   type OCPP20HeartbeatRequest,
  15   OCPP20RequestCommand,
  16   type OCPP20StatusNotificationRequest,
  17   OCPPVersion,
  18   type RequestParams
  19 } from '../../../types/index.js'
  20 import { generateUUID } from '../../../utils/index.js'
  21 import { OCPPRequestService } from '../OCPPRequestService.js'
  22 import type { OCPPResponseService } from '../OCPPResponseService.js'
  23
  24 const moduleName = 'OCPP20RequestService'
  25
  26 export class OCPP20RequestService extends OCPPRequestService {
  27   protected jsonSchemas: Map<OCPP20RequestCommand, JSONSchemaType<JsonType>>
  28
  29   public constructor (ocppResponseService: OCPPResponseService) {
  30     // if (new.target.name === moduleName) {
  31     //   throw new TypeError(`Cannot construct ${new.target.name} instances directly`)
  32     // }
  33     super(OCPPVersion.VERSION_20, ocppResponseService)
  34     this.jsonSchemas = new Map<OCPP20RequestCommand, JSONSchemaType<JsonType>>([
  35       [
  36         OCPP20RequestCommand.BOOT_NOTIFICATION,
  37         OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20BootNotificationRequest>(
  38           'assets/json-schemas/ocpp/2.0/BootNotificationRequest.json',
  39           moduleName,
  40           'constructor'
  41         )
  42       ],
  43       [
  44         OCPP20RequestCommand.HEARTBEAT,
  45         OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20HeartbeatRequest>(
  46           'assets/json-schemas/ocpp/2.0/HeartbeatRequest.json',
  47           moduleName,
  48           'constructor'
  49         )
  50       ],
  51       [
  52         OCPP20RequestCommand.STATUS_NOTIFICATION,
  53         OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20StatusNotificationRequest>(
  54           'assets/json-schemas/ocpp/2.0/StatusNotificationRequest.json',
  55           moduleName,
  56           'constructor'
  57         )
  58       ]
  59     ])
  60     this.buildRequestPayload = this.buildRequestPayload.bind(this)
  61   }
  62
  63   public async requestHandler<RequestType extends JsonType, ResponseType extends JsonType>(
  64     chargingStation: ChargingStation,
  65     commandName: OCPP20RequestCommand,
  66     commandParams?: JsonType,
  67     params?: RequestParams
  68   ): Promise<ResponseType> {
  69     // FIXME?: add sanity checks on charging station availability, connector availability, connector status, etc.
  70     if (OCPP20ServiceUtils.isRequestCommandSupported(chargingStation, commandName)) {
  71       return (await this.sendMessage(
  72         chargingStation,
  73         generateUUID(),
  74         this.buildRequestPayload<RequestType>(chargingStation, commandName, commandParams),
  75         commandName,
  76         params
  77       )) as ResponseType
  78     }
  79     // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError().
  80     throw new OCPPError(
  81       ErrorType.NOT_SUPPORTED,
  82       `Unsupported OCPP command '${commandName}'`,
  83       commandName,
  84       commandParams
  85     )
  86   }
  87
  88   private buildRequestPayload<Request extends JsonType>(
  89     chargingStation: ChargingStation,
  90     commandName: OCPP20RequestCommand,
  91     commandParams?: JsonType
  92   ): Request {
  93     commandParams = commandParams as JsonObject
  94     switch (commandName) {
  95       case OCPP20RequestCommand.BOOT_NOTIFICATION:
  96         return commandParams as unknown as Request
  97       case OCPP20RequestCommand.HEARTBEAT:
  98         return OCPP20Constants.OCPP_RESPONSE_EMPTY as unknown as Request
  99       case OCPP20RequestCommand.STATUS_NOTIFICATION:
 100         return {
 101           timestamp: new Date(),
 102           ...commandParams
 103         } as unknown as Request
 104       default:
 105         // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError().
 106         throw new OCPPError(
 107           ErrorType.NOT_SUPPORTED,
 108           // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
 109           `Unsupported OCPP command '${commandName}'`,
 110           commandName,
 111           commandParams
 112         )
 113     }
 114   }
 115 }