1 // Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
4 import path from
'path';
5 import { fileURLToPath
} from
'url';
7 import type { JSONSchemaType
} from
'ajv';
9 import OCPPError from
'../../../exception/OCPPError';
10 import type { JsonObject
, JsonType
} from
'../../../types/JsonType';
12 type OCPP20BootNotificationRequest
,
14 } from
'../../../types/ocpp/2.0/Requests';
15 import { ErrorType
} from
'../../../types/ocpp/ErrorType';
16 import { OCPPVersion
} from
'../../../types/ocpp/OCPPVersion';
17 import type { RequestParams
} from
'../../../types/ocpp/Requests';
18 import logger from
'../../../utils/Logger';
19 import Utils from
'../../../utils/Utils';
20 import type ChargingStation from
'../../ChargingStation';
21 import OCPPRequestService from
'../OCPPRequestService';
22 import type OCPPResponseService from
'../OCPPResponseService';
23 import { OCPP20ServiceUtils
} from
'./OCPP20ServiceUtils';
25 const moduleName
= 'OCPP20RequestService';
27 export default class OCPP20RequestService
extends OCPPRequestService
{
28 private jsonSchemas
: Map
<OCPP20RequestCommand
, JSONSchemaType
<JsonObject
>>;
30 public constructor(ocppResponseService
: OCPPResponseService
) {
31 if (new.target
?.name
=== moduleName
) {
32 throw new TypeError(`Cannot construct ${new.target?.name} instances directly`);
34 super(OCPPVersion
.VERSION_20
, ocppResponseService
);
35 this.jsonSchemas
= new Map
<OCPP20RequestCommand
, JSONSchemaType
<JsonObject
>>([
37 OCPP20RequestCommand
.BOOT_NOTIFICATION
,
41 path
.dirname(fileURLToPath(import.meta
.url
)),
42 '../../../assets/json-schemas/ocpp/2.0/BootNotificationRequest.json'
46 ) as JSONSchemaType
<OCPP20BootNotificationRequest
>,
49 this.buildRequestPayload
.bind(this);
50 this.validatePayload
.bind(this);
53 public async requestHandler
<RequestType
extends JsonType
, ResponseType
extends JsonType
>(
54 chargingStation
: ChargingStation
,
55 commandName
: OCPP20RequestCommand
,
56 commandParams
?: JsonType
,
57 params
?: RequestParams
58 ): Promise
<ResponseType
> {
59 if (OCPP20ServiceUtils
.isRequestCommandSupported(chargingStation
, commandName
) === true) {
60 const requestPayload
= this.buildRequestPayload
<RequestType
>(
65 this.validatePayload(chargingStation
, commandName
, requestPayload
);
66 return (await this.sendMessage(
72 )) as unknown
as ResponseType
;
74 // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError().
76 ErrorType
.NOT_SUPPORTED
,
77 `Unsupported OCPP command '${commandName}'`,
83 private buildRequestPayload
<Request
extends JsonType
>(
84 chargingStation
: ChargingStation
,
85 commandName
: OCPP20RequestCommand
,
86 commandParams
?: JsonType
88 commandParams
= commandParams
as JsonObject
;
89 switch (commandName
) {
90 case OCPP20RequestCommand
.BOOT_NOTIFICATION
:
91 commandParams
.modem
= commandParams
.modem
as JsonObject
;
93 reason
: commandParams
?.reason
,
95 model
: commandParams
?.model
,
96 vendorName
: commandParams
?.vendorName
,
97 ...(!Utils
.isUndefined(commandParams
?.firmwareVersion
) && {
98 firmwareVersion
: commandParams
.firmwareVersion
,
100 ...(!Utils
.isUndefined(commandParams
?.serialNumber
) && {
101 serialNumber
: commandParams
.serialNumber
,
104 ...(!Utils
.isUndefined(commandParams
?.modem
?.iccid
) && {
105 iccid
: commandParams
.modem
.iccid
,
107 ...(!Utils
.isUndefined(commandParams
?.modem
?.imsi
) && {
108 imsi
: commandParams
.modem
.imsi
,
112 } as unknown
as Request
;
114 // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError().
116 ErrorType
.NOT_SUPPORTED
,
117 // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
118 `Unsupported OCPP command '${commandName}'`,
125 private validatePayload
<Request
extends JsonType
>(
126 chargingStation
: ChargingStation
,
127 commandName
: OCPP20RequestCommand
,
128 requestPayload
: Request
130 if (this.jsonSchemas
.has(commandName
)) {
131 return this.validateRequestPayload(
134 this.jsonSchemas
.get(commandName
),
139 `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema found for command ${commandName} PDU validation`