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

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