refactor: cleanup get composite schedule code
[e-mobility-charging-stations-simulator.git] / src / charging-station / ocpp / OCPPResponseService.ts
index 871f93ab5f4c48f5d3954a55491c65f893def2fa..7934500ed3ebd7612cfb05ad58b0c68699396dc1 100644 (file)
@@ -1,25 +1,51 @@
-import type { JSONSchemaType } from 'ajv';
-import Ajv from 'ajv-draft-04';
+import Ajv, { type JSONSchemaType } from 'ajv';
 import ajvFormats from 'ajv-formats';
 
-import OCPPError from '../../exception/OCPPError';
-import type { JsonType } from '../../types/JsonType';
-import type { RequestCommand } from '../../types/ocpp/Requests';
-import logger from '../../utils/Logger';
-import type ChargingStation from '../ChargingStation';
 import { OCPPServiceUtils } from './OCPPServiceUtils';
+import type { ChargingStation } from '../../charging-station';
+import { OCPPError } from '../../exception';
+import type {
+  IncomingRequestCommand,
+  JsonObject,
+  JsonType,
+  OCPPVersion,
+  RequestCommand,
+} from '../../types';
+import { logger } from '../../utils';
 
 const moduleName = 'OCPPResponseService';
 
-export default abstract class OCPPResponseService {
+export abstract class OCPPResponseService {
   private static instance: OCPPResponseService | null = null;
+  private readonly version: OCPPVersion;
   private readonly ajv: Ajv;
+  public abstract jsonIncomingRequestResponseSchemas: Map<
+    IncomingRequestCommand,
+    JSONSchemaType<JsonObject>
+  >;
 
-  protected constructor() {
-    this.ajv = new Ajv();
+  protected constructor(version: OCPPVersion) {
+    this.version = version;
+    this.ajv = new Ajv({
+      keywords: ['javaType'],
+      multipleOfPrecision: 2,
+    });
     ajvFormats(this.ajv);
-    this.responseHandler.bind(this);
-    this.validateResponsePayload.bind(this);
+    this.responseHandler = this.responseHandler.bind(this) as <
+      ReqType extends JsonType,
+      ResType extends JsonType,
+    >(
+      chargingStation: ChargingStation,
+      commandName: RequestCommand,
+      payload: ResType,
+      requestPayload: ReqType,
+    ) => Promise<void>;
+    this.validateResponsePayload = this.validateResponsePayload.bind(this) as <T extends JsonType>(
+      chargingStation: ChargingStation,
+      commandName: RequestCommand,
+      schema: JSONSchemaType<T>,
+      payload: T,
+    ) => boolean;
   }
 
   public static getInstance<T extends OCPPResponseService>(this: new () => T): T {
@@ -33,9 +59,9 @@ export default abstract class OCPPResponseService {
     chargingStation: ChargingStation,
     commandName: RequestCommand,
     schema: JSONSchemaType<T>,
-    payload: T
+    payload: T,
   ): boolean {
-    if (chargingStation.getPayloadSchemaValidation() === false) {
+    if (chargingStation.getOcppStrictCompliance() === false) {
       return true;
     }
     const validate = this.ajv.compile(schema);
@@ -43,25 +69,25 @@ export default abstract class OCPPResponseService {
       return true;
     }
     logger.error(
-      `${chargingStation.logPrefix()} ${moduleName}.validateResponsePayload: Response PDU is invalid: %j`,
-      validate.errors
+      `${chargingStation.logPrefix()} ${moduleName}.validateResponsePayload: Command '${commandName}' response PDU is invalid: %j`,
+      validate.errors,
     );
     throw new OCPPError(
-      OCPPServiceUtils.ajvErrorsToErrorType(validate.errors),
+      OCPPServiceUtils.ajvErrorsToErrorType(validate.errors!),
       'Response PDU is invalid',
       commandName,
-      JSON.stringify(validate.errors, null, 2)
+      JSON.stringify(validate.errors, null, 2),
     );
   }
 
   protected emptyResponseHandler() {
-    /* This is intentional  */
+    /* This is intentional */
   }
 
-  public abstract responseHandler(
+  public abstract responseHandler<ReqType extends JsonType, ResType extends JsonType>(
     chargingStation: ChargingStation,
     commandName: RequestCommand,
-    payload: JsonType,
-    requestPayload: JsonType
+    payload: ResType,
+    requestPayload: ReqType,
   ): Promise<void>;
 }