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