feat(simulator): allow to deprecate only template configuration key

[e-mobility-charging-stations-simulator.git] / src / charging-station / ChargingStationConfigurationUtils.ts

diff --git a/src/charging-station/ChargingStationConfigurationUtils.ts b/src/charging-station/ChargingStationConfigurationUtils.ts
index 9a37190be0c7ab5366072ffc4996fd4a5699e240..59e39300bb4c8367abda39f556d587b95892ab64 100644 (file)
--- a/src/charging-station/ChargingStationConfigurationUtils.ts
+++ b/src/charging-station/ChargingStationConfigurationUtils.ts
@@ -1,7 +1,10 @@
-import { ConfigurationKey } from '../types/ChargingStationOcppConfiguration';
-import { StandardParametersKey } from '../types/ocpp/Configuration';
-import logger from '../utils/Logger';
-import type ChargingStation from './ChargingStation';
+import type { ChargingStation } from './ChargingStation';
+import type { ConfigurationKey, ConfigurationKeyType } from '../types';
+import { logger } from '../utils';
+
+type ConfigurationKeyOptions = { readonly?: boolean; visible?: boolean; reboot?: boolean };
+type DeleteConfigurationKeyParams = { save?: boolean; caseInsensitive?: boolean };
+type AddConfigurationKeyParams = { overwrite?: boolean; save?: boolean };
 
 export class ChargingStationConfigurationUtils {
   private constructor() {
@@ -10,10 +13,10 @@ export class ChargingStationConfigurationUtils {
 
   public static getConfigurationKey(
     chargingStation: ChargingStation,
-    key: string | StandardParametersKey,
-    caseInsensitive = false
+    key: ConfigurationKeyType,
+    caseInsensitive = false,
   ): ConfigurationKey | undefined {
-    return chargingStation.ocppConfiguration.configurationKey.find((configElement) => {
+    return chargingStation.ocppConfiguration?.configurationKey?.find((configElement) => {
       if (caseInsensitive) {
         return configElement.key.toLowerCase() === key.toLowerCase();
       }
@@ -23,19 +26,24 @@ export class ChargingStationConfigurationUtils {
 
   public static addConfigurationKey(
     chargingStation: ChargingStation,
-    key: string | StandardParametersKey,
+    key: ConfigurationKeyType,
     value: string,
-    options: { readonly?: boolean; visible?: boolean; reboot?: boolean } = {
+    options: ConfigurationKeyOptions = {
       readonly: false,
       visible: true,
       reboot: false,
     },
-    params: { overwrite?: boolean; save?: boolean } = { overwrite: false, save: false }
+    params: AddConfigurationKeyParams = { overwrite: false, save: false },
   ): void {
-    options = options ?? ({} as { readonly?: boolean; visible?: boolean; reboot?: boolean });
-    options.readonly = options?.readonly ?? false;
-    options.visible = options?.visible ?? true;
-    options.reboot = options?.reboot ?? false;
+    options = {
+      ...{
+        readonly: false,
+        visible: true,
+        reboot: false,
+      },
+      ...options,
+    };
+    params = { ...{ overwrite: false, save: false }, ...params };
     let keyFound = ChargingStationConfigurationUtils.getConfigurationKey(chargingStation, key);
     if (keyFound && params?.overwrite) {
       ChargingStationConfigurationUtils.deleteConfigurationKey(chargingStation, keyFound.key, {
@@ -44,7 +52,7 @@ export class ChargingStationConfigurationUtils {
       keyFound = undefined;
     }
     if (!keyFound) {
-      chargingStation.ocppConfiguration.configurationKey.push({
+      chargingStation.ocppConfiguration?.configurationKey?.push({
         key,
         readonly: options.readonly,
         value,
@@ -55,21 +63,21 @@ export class ChargingStationConfigurationUtils {
     } else {
       logger.error(
         `${chargingStation.logPrefix()} Trying to add an already existing configuration key: %j`,
-        keyFound
+        keyFound,
       );
     }
   }
 
   public static setConfigurationKeyValue(
     chargingStation: ChargingStation,
-    key: string | StandardParametersKey,
+    key: ConfigurationKeyType,
     value: string,
-    caseInsensitive = false
+    caseInsensitive = false,
   ): void {
     const keyFound = ChargingStationConfigurationUtils.getConfigurationKey(
       chargingStation,
       key,
-      caseInsensitive
+      caseInsensitive,
     );
     if (keyFound) {
       chargingStation.ocppConfiguration.configurationKey[
@@ -79,25 +87,26 @@ export class ChargingStationConfigurationUtils {
     } else {
       logger.error(
         `${chargingStation.logPrefix()} Trying to set a value on a non existing configuration key: %j`,
-        { key, value }
+        { key, value },
       );
     }
   }
 
   public static deleteConfigurationKey(
     chargingStation: ChargingStation,
-    key: string | StandardParametersKey,
-    params: { save?: boolean; caseInsensitive?: boolean } = { save: true, caseInsensitive: false }
-  ): ConfigurationKey[] {
+    key: ConfigurationKeyType,
+    params: DeleteConfigurationKeyParams = { save: true, caseInsensitive: false },
+  ): ConfigurationKey[] | undefined {
+    params = { ...{ save: true, caseInsensitive: false }, ...params };
     const keyFound = ChargingStationConfigurationUtils.getConfigurationKey(
       chargingStation,
       key,
-      params?.caseInsensitive
+      params?.caseInsensitive,
     );
     if (keyFound) {
-      const deletedConfigurationKey = chargingStation.ocppConfiguration.configurationKey.splice(
+      const deletedConfigurationKey = chargingStation.ocppConfiguration?.configurationKey?.splice(
         chargingStation.ocppConfiguration.configurationKey.indexOf(keyFound),
-        1
+        1,
       );
       params?.save && chargingStation.saveOcppConfiguration();
       return deletedConfigurationKey;