Commit | Line | Data |
---|---|---|
edd13439 | 1 | // Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved. |
953d6b02 JB |
2 | |
3 | import type { JSONSchemaType } from 'ajv'; | |
4 | ||
78202038 | 5 | import { OCPP20ServiceUtils } from './OCPP20ServiceUtils'; |
953d6b02 JB |
6 | import OCPPError from '../../../exception/OCPPError'; |
7 | import type { JsonObject, JsonType } from '../../../types/JsonType'; | |
d270cc87 | 8 | import { |
96a52d08 | 9 | type OCPP20BootNotificationRequest, |
81533a20 | 10 | type OCPP20HeartbeatRequest, |
d270cc87 | 11 | OCPP20RequestCommand, |
6e939d9e | 12 | type OCPP20StatusNotificationRequest, |
d270cc87 | 13 | } from '../../../types/ocpp/2.0/Requests'; |
953d6b02 | 14 | import { ErrorType } from '../../../types/ocpp/ErrorType'; |
d270cc87 | 15 | import { OCPPVersion } from '../../../types/ocpp/OCPPVersion'; |
953d6b02 | 16 | import type { RequestParams } from '../../../types/ocpp/Requests'; |
953d6b02 JB |
17 | import Utils from '../../../utils/Utils'; |
18 | import type ChargingStation from '../../ChargingStation'; | |
4d20f040 | 19 | import OCPPConstants from '../OCPPConstants'; |
953d6b02 JB |
20 | import OCPPRequestService from '../OCPPRequestService'; |
21 | import type OCPPResponseService from '../OCPPResponseService'; | |
953d6b02 JB |
22 | |
23 | const moduleName = 'OCPP20RequestService'; | |
24 | ||
25 | export default class OCPP20RequestService extends OCPPRequestService { | |
b3fc3ff5 | 26 | protected jsonSchemas: Map<OCPP20RequestCommand, JSONSchemaType<JsonObject>>; |
953d6b02 JB |
27 | |
28 | public constructor(ocppResponseService: OCPPResponseService) { | |
29 | if (new.target?.name === moduleName) { | |
30 | throw new TypeError(`Cannot construct ${new.target?.name} instances directly`); | |
31 | } | |
d270cc87 JB |
32 | super(OCPPVersion.VERSION_20, ocppResponseService); |
33 | this.jsonSchemas = new Map<OCPP20RequestCommand, JSONSchemaType<JsonObject>>([ | |
34 | [ | |
35 | OCPP20RequestCommand.BOOT_NOTIFICATION, | |
130783a7 | 36 | OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20BootNotificationRequest>( |
1b271a54 JB |
37 | '../../../assets/json-schemas/ocpp/2.0/BootNotificationRequest.json', |
38 | moduleName, | |
39 | 'constructor' | |
e9a4164c | 40 | ), |
d270cc87 | 41 | ], |
81533a20 JB |
42 | [ |
43 | OCPP20RequestCommand.HEARTBEAT, | |
130783a7 | 44 | OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20HeartbeatRequest>( |
1b271a54 JB |
45 | '../../../assets/json-schemas/ocpp/2.0/HeartbeatRequest.json', |
46 | moduleName, | |
47 | 'constructor' | |
e9a4164c | 48 | ), |
81533a20 | 49 | ], |
6e939d9e JB |
50 | [ |
51 | OCPP20RequestCommand.STATUS_NOTIFICATION, | |
130783a7 | 52 | OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20StatusNotificationRequest>( |
1b271a54 JB |
53 | '../../../assets/json-schemas/ocpp/2.0/StatusNotificationRequest.json', |
54 | moduleName, | |
55 | 'constructor' | |
e9a4164c | 56 | ), |
6e939d9e | 57 | ], |
d270cc87 | 58 | ]); |
953d6b02 | 59 | this.buildRequestPayload.bind(this); |
953d6b02 JB |
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) { | |
953d6b02 JB |
69 | return (await this.sendMessage( |
70 | chargingStation, | |
71 | Utils.generateUUID(), | |
18bf8274 | 72 | this.buildRequestPayload<RequestType>(chargingStation, commandName, commandParams), |
953d6b02 JB |
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) { | |
d270cc87 | 93 | case OCPP20RequestCommand.BOOT_NOTIFICATION: |
36c462a4 | 94 | return commandParams as unknown as Request; |
81533a20 | 95 | case OCPP20RequestCommand.HEARTBEAT: |
4d20f040 | 96 | return OCPPConstants.OCPP_RESPONSE_EMPTY as unknown as Request; |
6e939d9e JB |
97 | case OCPP20RequestCommand.STATUS_NOTIFICATION: |
98 | return { | |
36c462a4 JB |
99 | timestamp: new Date(), |
100 | ...commandParams, | |
6e939d9e | 101 | } as unknown as Request; |
953d6b02 JB |
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 | } | |
953d6b02 | 113 | } |