@zetra/citrineos-configuration 1.8.3-fork.1

package/dist/module/BootNotificationService.js

@@ -0,0 +1,248 @@
+import { Boot, OCPP1_6_Mapper, OCPP2_0_1_Mapper } from '@citrineos/data';
+import { BOOT_STATUS, OCPP1_6, OCPP1_6_CALL_SCHEMA_MAP, OCPP1_6_CallAction, OCPP2_0_1, OCPP2_0_1_CALL_SCHEMA_MAP, OCPP2_0_1_CallAction, } from '@citrineos/base';
+import { Logger } from 'tslog';
+export class BootNotificationService {
+    _bootRepository;
+    _cache;
+    _logger;
+    _config;
+    constructor(bootRepository, cache, config, logger) {
+        this._bootRepository = bootRepository;
+        this._cache = cache;
+        this._config = config;
+        this._logger = logger
+            ? logger.getSubLogger({ name: this.constructor.name })
+            : new Logger({ name: this.constructor.name });
+    }
+    determineBootStatus(bootConfig) {
+        let bootStatus = bootConfig
+            ? OCPP2_0_1_Mapper.BootMapper.toRegistrationStatusEnumType(bootConfig.status)
+            : this._config.ocpp2_0_1.unknownChargerStatus;
+        if (bootStatus === OCPP2_0_1.RegistrationStatusEnumType.Pending) {
+            let needToGetBaseReport = this._config.ocpp2_0_1.getBaseReportOnPending;
+            let needToSetVariables = false;
+            if (bootConfig) {
+                if (bootConfig.getBaseReportOnPending !== undefined &&
+                    bootConfig.getBaseReportOnPending !== null) {
+                    needToGetBaseReport = bootConfig.getBaseReportOnPending;
+                }
+                if (bootConfig.pendingBootSetVariables && bootConfig.pendingBootSetVariables.length > 0) {
+                    needToSetVariables = true;
+                }
+            }
+            if (!needToGetBaseReport && !needToSetVariables && this._config.ocpp2_0_1.autoAccept) {
+                bootStatus = OCPP2_0_1.RegistrationStatusEnumType.Accepted;
+            }
+        }
+        return bootStatus;
+    }
+    async createBootNotificationResponse(tenantId, stationId) {
+        // Unknown chargers, chargers without a BootConfig, will use SystemConfig.unknownChargerStatus for status.
+        const bootConfig = await this._bootRepository.readByKey(tenantId, stationId);
+        const bootStatus = this.determineBootStatus(bootConfig);
+        // When any BootConfig field is not set, the corresponding field on the SystemConfig will be used.
+        return {
+            currentTime: new Date().toISOString(),
+            status: bootStatus,
+            statusInfo: OCPP2_0_1_Mapper.BootMapper.toStatusInfo(bootConfig?.statusInfo),
+            interval: bootStatus === OCPP2_0_1.RegistrationStatusEnumType.Accepted
+                ? bootConfig?.heartbeatInterval || this._config.heartbeatInterval
+                : bootConfig?.bootRetryInterval || this._config.bootRetryInterval,
+        };
+    }
+    async updateBootConfig(bootNotificationResponse, tenantId, stationId) {
+        let bootConfigDbEntity = await this._bootRepository.readByKey(tenantId, stationId);
+        if (!bootConfigDbEntity) {
+            const unknownChargerBootConfig = {
+                status: bootNotificationResponse.status,
+                statusInfo: bootNotificationResponse.statusInfo,
+            };
+            bootConfigDbEntity = await this._bootRepository.createOrUpdateByKey(tenantId, unknownChargerBootConfig, stationId);
+        }
+        if (!bootConfigDbEntity) {
+            throw new Error('Unable to create/update BootConfig...');
+        }
+        else {
+            bootConfigDbEntity.lastBootTime = bootNotificationResponse.currentTime;
+            await bootConfigDbEntity.save();
+        }
+        return bootConfigDbEntity;
+    }
+    /**
+     * Determines whether to blacklist or whitelist charger actions based on its boot status.
+     *
+     * If the new boot is accepted and the charger actions were previously blacklisted, then whitelist the charger actions.
+     * If the new boot is not accepted and charger actions were previously whitelisted, then blacklist the charger actions.
+     *
+     * @param stationId
+     * @param cachedBootStatus
+     * @param bootNotificationResponseStatus
+     */
+    async cacheChargerActionsPermissions(stationId, cachedBootStatus, bootNotificationResponseStatus) {
+        // New boot status is Accepted and cachedBootStatus exists (meaning there was a previous Rejected or Pending boot)
+        if (bootNotificationResponseStatus === OCPP2_0_1.RegistrationStatusEnumType.Accepted) {
+            if (cachedBootStatus) {
+                // Undo blacklisting of charger-originated actions
+                const promises = Array.from(OCPP2_0_1_CALL_SCHEMA_MAP).map(async ([action]) => {
+                    if (action !== OCPP2_0_1_CallAction.BootNotification) {
+                        return this._cache.remove(action, stationId);
+                    }
+                });
+                await Promise.all(promises);
+                // Remove cached boot status
+                await this._cache.remove(BOOT_STATUS, stationId);
+                this._logger.debug('Cached boot status removed: ', cachedBootStatus);
+            }
+        }
+        else if (!cachedBootStatus) {
+            // Status is not Accepted; i.e. Status is Rejected or Pending.
+            // Cached boot status for charger did not exist; i.e. this is the first BootNotificationResponse to be Rejected or Pending.
+            // Blacklist all charger-originated actions except BootNotification
+            // GetReport messages will need to un-blacklist NotifyReport
+            // TriggerMessage will need to un-blacklist the message it triggers
+            const promises = Array.from(OCPP2_0_1_CALL_SCHEMA_MAP).map(async ([action]) => {
+                if (action !== OCPP2_0_1_CallAction.BootNotification) {
+                    return this._cache.set(action, 'blacklisted', stationId);
+                }
+            });
+            await Promise.all(promises);
+        }
+    }
+    async createGetBaseReportRequest(stationId, maxCachingSeconds) {
+        // OCTT tool does not meet B07.FR.04; instead always sends requestId === 0
+        // Commenting out this line, using requestId === 0 until fixed (10/26/2023)
+        // const requestId = Math.floor(Math.random() * ConfigurationModule.GET_BASE_REPORT_REQUEST_ID_MAX);
+        const requestId = 0;
+        await this._cache.set(requestId.toString(), 'ongoing', stationId, maxCachingSeconds);
+        return {
+            requestId: requestId,
+            reportBase: OCPP2_0_1.ReportBaseEnumType.FullInventory,
+        };
+    }
+    /**
+     * Based on the GetBaseReportMessageConfirmation, checks the cache to ensure GetBaseReport truly succeeded.
+     * If GetBaseReport did not succeed, this method will throw. Otherwise, it will finish without throwing.
+     *
+     * @param stationId
+     * @param requestId
+     * @param getBaseReportMessageConfirmation
+     * @param maxCachingSeconds
+     */
+    async confirmGetBaseReportSuccess(stationId, requestId, getBaseReportMessageConfirmation, maxCachingSeconds) {
+        if (getBaseReportMessageConfirmation.success) {
+            this._logger.debug(`GetBaseReport successfully sent to charger: ${getBaseReportMessageConfirmation}`);
+            // Wait for GetBaseReport to complete
+            let getBaseReportCacheValue = await this._cache.onChange(requestId, maxCachingSeconds, stationId);
+            while (getBaseReportCacheValue === 'ongoing') {
+                getBaseReportCacheValue = await this._cache.onChange(requestId, maxCachingSeconds, stationId);
+            }
+            if (getBaseReportCacheValue === 'complete') {
+                this._logger.debug('GetBaseReport process successful.'); // All NotifyReports have been processed
+            }
+            else {
+                throw new Error('GetBaseReport process failed--message timed out without a response.');
+            }
+        }
+        else {
+            throw new Error(`GetBaseReport failed: ${JSON.stringify(getBaseReportMessageConfirmation)}`);
+        }
+    }
+    /**
+     * Methods for OCPP 1.6
+     */
+    determineOcpp16BootStatus(bootConfig) {
+        let bootStatus = bootConfig
+            ? OCPP1_6_Mapper.BootMapper.toRegistrationStatusEnumType(bootConfig.status)
+            : this._config.ocpp1_6.unknownChargerStatus;
+        if (bootStatus === OCPP1_6.BootNotificationResponseStatus.Pending) {
+            let needToGetConfigurations = true;
+            let needToChangeConfigurations = true;
+            if (bootConfig) {
+                if (bootConfig.getConfigurationsOnPending !== undefined &&
+                    bootConfig.getConfigurationsOnPending !== null) {
+                    needToGetConfigurations = bootConfig.getConfigurationsOnPending;
+                }
+                if (bootConfig.changeConfigurationsOnPending !== undefined &&
+                    bootConfig.changeConfigurationsOnPending !== null) {
+                    needToChangeConfigurations = bootConfig.changeConfigurationsOnPending;
+                }
+            }
+            if (!needToGetConfigurations && !needToChangeConfigurations) {
+                bootStatus = OCPP1_6.BootNotificationResponseStatus.Accepted;
+            }
+        }
+        return bootStatus;
+    }
+    async createOcpp16BootNotificationResponse(tenantId, stationId) {
+        const boot = await this._bootRepository.readByKey(tenantId, stationId);
+        const status = this.determineOcpp16BootStatus(boot);
+        return {
+            currentTime: new Date().toISOString(),
+            status,
+            interval: status === OCPP1_6.BootNotificationResponseStatus.Accepted
+                ? boot?.heartbeatInterval || this._config.heartbeatInterval
+                : boot?.bootRetryInterval || this._config.bootRetryInterval,
+        };
+    }
+    /**
+     * Determines whether to blacklist or whitelist charger actions based on its boot status.
+     *
+     * If the new boot is accepted and the charger actions were previously blacklisted, then whitelist the charger actions.
+     * If the new boot is not accepted and charger actions were previously whitelisted, then blacklist the charger actions.
+     *
+     * @param stationId
+     * @param cachedBootStatus
+     * @param bootNotificationResponseStatus
+     */
+    async cacheOcpp16ChargerActionsPermissions(stationId, cachedBootStatus, bootNotificationResponseStatus) {
+        // New boot status is Accepted and cachedBootStatus exists (meaning there was a previous Rejected or Pending boot)
+        if (bootNotificationResponseStatus === OCPP1_6.BootNotificationResponseStatus.Accepted) {
+            if (cachedBootStatus) {
+                // Undo blacklisting of charger-originated actions
+                const promises = Array.from(OCPP1_6_CALL_SCHEMA_MAP).map(async ([action]) => {
+                    if (action !== OCPP1_6_CallAction.BootNotification) {
+                        return this._cache.remove(action, stationId);
+                    }
+                });
+                await Promise.all(promises);
+                // Remove cached boot status
+                await this._cache.remove(BOOT_STATUS, stationId);
+                this._logger.debug(`Cached boot status ${cachedBootStatus} removed for station ${stationId}.`);
+            }
+        }
+        else if (!cachedBootStatus) {
+            // Status is not Accepted; i.e. Status is Rejected or Pending.
+            // Cached boot status for charger did not exist; i.e. this is the first BootNotificationResponse to be Rejected or Pending.
+            // Blacklist all charger-originated actions except BootNotification
+            // ChangeConfiguration, GetConfiguration and TriggerMessage will need to un-blacklist the message it triggers
+            const promises = Array.from(OCPP1_6_CALL_SCHEMA_MAP).map(async ([action]) => {
+                if (action !== OCPP1_6_CallAction.BootNotification) {
+                    return this._cache.set(action, 'blacklisted', stationId);
+                }
+            });
+            await Promise.all(promises);
+        }
+    }
+    async updateOcpp16BootConfig(response, tenantId, stationId) {
+        const heartbeatInterval = response.status === OCPP1_6.BootNotificationResponseStatus.Accepted
+            ? response.interval
+            : undefined;
+        const bootRetryInterval = response.status !== OCPP1_6.BootNotificationResponseStatus.Accepted
+            ? response.interval
+            : undefined;
+        const unknownChargerBootConfig = {
+            status: response.status,
+            heartbeatInterval,
+            bootRetryInterval,
+        };
+        let bootConfigDbEntity = await this._bootRepository.createOrUpdateByKey(tenantId, unknownChargerBootConfig, stationId);
+        if (bootConfigDbEntity) {
+            bootConfigDbEntity = await this._bootRepository.updateLastBootTimeByKey(tenantId, response.currentTime, stationId);
+        }
+        if (!bootConfigDbEntity) {
+            throw new Error('Unable to create/update BootConfig...');
+        }
+        return bootConfigDbEntity;
+    }
+}
+//# sourceMappingURL=BootNotificationService.js.map

package/dist/module/BootNotificationService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BootNotificationService.js","sourceRoot":"","sources":["../../src/module/BootNotificationService.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAEzE,OAAO,EACL,WAAW,EACX,OAAO,EACP,uBAAuB,EACvB,kBAAkB,EAClB,SAAS,EACT,yBAAyB,EACzB,oBAAoB,GACrB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAI/B,MAAM,OAAO,uBAAuB;IACxB,eAAe,CAAkB;IACjC,MAAM,CAAS;IACf,OAAO,CAAkB;IACzB,OAAO,CAAgB;IAEjC,YACE,cAA+B,EAC/B,KAAa,EACb,MAAqB,EACrB,MAAwB;QAExB,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;QACtC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,MAAM;YACnB,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;YACtD,CAAC,CAAC,IAAI,MAAM,CAAU,EAAE,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED,mBAAmB,CAAC,UAA4B;QAC9C,IAAI,UAAU,GAAG,UAAU;YACzB,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,4BAA4B,CAAC,UAAU,CAAC,MAAM,CAAC;YAC7E,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,SAAU,CAAC,oBAAoB,CAAC;QAEjD,IAAI,UAAU,KAAK,SAAS,CAAC,0BAA0B,CAAC,OAAO,EAAE,CAAC;YAChE,IAAI,mBAAmB,GAAG,IAAI,CAAC,OAAO,CAAC,SAAU,CAAC,sBAAsB,CAAC;YACzE,IAAI,kBAAkB,GAAG,KAAK,CAAC;YAC/B,IAAI,UAAU,EAAE,CAAC;gBACf,IACE,UAAU,CAAC,sBAAsB,KAAK,SAAS;oBAC/C,UAAU,CAAC,sBAAsB,KAAK,IAAI,EAC1C,CAAC;oBACD,mBAAmB,GAAG,UAAU,CAAC,sBAAsB,CAAC;gBAC1D,CAAC;gBACD,IAAI,UAAU,CAAC,uBAAuB,IAAI,UAAU,CAAC,uBAAuB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACxF,kBAAkB,GAAG,IAAI,CAAC;gBAC5B,CAAC;YACH,CAAC;YACD,IAAI,CAAC,mBAAmB,IAAI,CAAC,kBAAkB,IAAI,IAAI,CAAC,OAAO,CAAC,SAAU,CAAC,UAAU,EAAE,CAAC;gBACtF,UAAU,GAAG,SAAS,CAAC,0BAA0B,CAAC,QAAQ,CAAC;YAC7D,CAAC;QACH,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,KAAK,CAAC,8BAA8B,CAClC,QAAgB,EAChB,SAAiB;QAEjB,0GAA0G;QAC1G,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QAC7E,MAAM,UAAU,GAAG,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;QAExD,kGAAkG;QAClG,OAAO;YACL,WAAW,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACrC,MAAM,EAAE,UAAU;YAClB,UAAU,EAAE,gBAAgB,CAAC,UAAU,CAAC,YAAY,CAAC,UAAU,EAAE,UAAU,CAAC;YAC5E,QAAQ,EACN,UAAU,KAAK,SAAS,CAAC,0BAA0B,CAAC,QAAQ;gBAC1D,CAAC,CAAC,UAAU,EAAE,iBAAiB,IAAI,IAAI,CAAC,OAAO,CAAC,iBAAiB;gBACjE,CAAC,CAAC,UAAU,EAAE,iBAAiB,IAAI,IAAI,CAAC,OAAO,CAAC,iBAAiB;SACtE,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,gBAAgB,CACpB,wBAA4D,EAC5D,QAAgB,EAChB,SAAiB;QAEjB,IAAI,kBAAkB,GAAqB,MAAM,IAAI,CAAC,eAAe,CAAC,SAAS,CAC7E,QAAQ,EACR,SAAS,CACV,CAAC;QACF,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACxB,MAAM,wBAAwB,GAAe;gBAC3C,MAAM,EAAE,wBAAwB,CAAC,MAAM;gBACvC,UAAU,EAAE,wBAAwB,CAAC,UAAU;aAChD,CAAC;YACF,kBAAkB,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,mBAAmB,CACjE,QAAQ,EACR,wBAAwB,EACxB,SAAS,CACV,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;QAC3D,CAAC;aAAM,CAAC;YACN,kBAAkB,CAAC,YAAY,GAAG,wBAAwB,CAAC,WAAW,CAAC;YACvE,MAAM,kBAAkB,CAAC,IAAI,EAAE,CAAC;QAClC,CAAC;QACD,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,8BAA8B,CAClC,SAAiB,EACjB,gBAA6D,EAC7D,8BAAoE;QAEpE,kHAAkH;QAClH,IAAI,8BAA8B,KAAK,SAAS,CAAC,0BAA0B,CAAC,QAAQ,EAAE,CAAC;YACrF,IAAI,gBAAgB,EAAE,CAAC;gBACrB,kDAAkD;gBAClD,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC,EAAE,EAAE;oBAC5E,IAAI,MAAM,KAAK,oBAAoB,CAAC,gBAAgB,EAAE,CAAC;wBACrD,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;oBAC/C,CAAC;gBACH,CAAC,CAAC,CAAC;gBACH,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBAC5B,4BAA4B;gBAC5B,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;gBACjD,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,8BAA8B,EAAE,gBAAgB,CAAC,CAAC;YACvE,CAAC;QACH,CAAC;aAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC7B,8DAA8D;YAC9D,2HAA2H;YAC3H,mEAAmE;YACnE,4DAA4D;YAC5D,mEAAmE;YACnE,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC,EAAE,EAAE;gBAC5E,IAAI,MAAM,KAAK,oBAAoB,CAAC,gBAAgB,EAAE,CAAC;oBACrD,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,aAAa,EAAE,SAAS,CAAC,CAAC;gBAC3D,CAAC;YACH,CAAC,CAAC,CAAC;YACH,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAED,KAAK,CAAC,0BAA0B,CAC9B,SAAiB,EACjB,iBAAyB;QAEzB,0EAA0E;QAC1E,2EAA2E;QAC3E,oGAAoG;QACpG,MAAM,SAAS,GAAG,CAAC,CAAC;QACpB,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,SAAS,EAAE,iBAAiB,CAAC,CAAC;QAErF,OAAO;YACL,SAAS,EAAE,SAAS;YACpB,UAAU,EAAE,SAAS,CAAC,kBAAkB,CAAC,aAAa;SACrB,CAAC;IACtC,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,2BAA2B,CAC/B,SAAiB,EACjB,SAAiB,EACjB,gCAAsD,EACtD,iBAAyB;QAEzB,IAAI,gCAAgC,CAAC,OAAO,EAAE,CAAC;YAC7C,IAAI,CAAC,OAAO,CAAC,KAAK,CAChB,+CAA+C,gCAAgC,EAAE,CAClF,CAAC;YAEF,qCAAqC;YACrC,IAAI,uBAAuB,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CACtD,SAAS,EACT,iBAAiB,EACjB,SAAS,CACV,CAAC;YAEF,OAAO,uBAAuB,KAAK,SAAS,EAAE,CAAC;gBAC7C,uBAAuB,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAClD,SAAS,EACT,iBAAiB,EACjB,SAAS,CACV,CAAC;YACJ,CAAC;YAED,IAAI,uBAAuB,KAAK,UAAU,EAAE,CAAC;gBAC3C,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC,CAAC,wCAAwC;YACnG,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAC;YACzF,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,yBAAyB,IAAI,CAAC,SAAS,CAAC,gCAAgC,CAAC,EAAE,CAAC,CAAC;QAC/F,CAAC;IACH,CAAC;IAED;;OAEG;IAEH,yBAAyB,CACvB,UAAkC;QAElC,IAAI,UAAU,GAAG,UAAU;YACzB,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC,4BAA4B,CAAC,UAAU,CAAC,MAAM,CAAC;YAC3E,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAQ,CAAC,oBAAoB,CAAC;QAE/C,IAAI,UAAU,KAAK,OAAO,CAAC,8BAA8B,CAAC,OAAO,EAAE,CAAC;YAClE,IAAI,uBAAuB,GAAG,IAAI,CAAC;YACnC,IAAI,0BAA0B,GAAG,IAAI,CAAC;YACtC,IAAI,UAAU,EAAE,CAAC;gBACf,IACE,UAAU,CAAC,0BAA0B,KAAK,SAAS;oBACnD,UAAU,CAAC,0BAA0B,KAAK,IAAI,EAC9C,CAAC;oBACD,uBAAuB,GAAG,UAAU,CAAC,0BAA0B,CAAC;gBAClE,CAAC;gBACD,IACE,UAAU,CAAC,6BAA6B,KAAK,SAAS;oBACtD,UAAU,CAAC,6BAA6B,KAAK,IAAI,EACjD,CAAC;oBACD,0BAA0B,GAAG,UAAU,CAAC,6BAA6B,CAAC;gBACxE,CAAC;YACH,CAAC;YACD,IAAI,CAAC,uBAAuB,IAAI,CAAC,0BAA0B,EAAE,CAAC;gBAC5D,UAAU,GAAG,OAAO,CAAC,8BAA8B,CAAC,QAAQ,CAAC;YAC/D,CAAC;QACH,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,KAAK,CAAC,oCAAoC,CACxC,QAAgB,EAChB,SAAiB;QAEjB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QACvE,MAAM,MAAM,GAAG,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC;QAEpD,OAAO;YACL,WAAW,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACrC,MAAM;YACN,QAAQ,EACN,MAAM,KAAK,OAAO,CAAC,8BAA8B,CAAC,QAAQ;gBACxD,CAAC,CAAC,IAAI,EAAE,iBAAiB,IAAI,IAAI,CAAC,OAAO,CAAC,iBAAiB;gBAC3D,CAAC,CAAC,IAAI,EAAE,iBAAiB,IAAI,IAAI,CAAC,OAAO,CAAC,iBAAiB;SAChE,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,oCAAoC,CACxC,SAAiB,EACjB,gBAA+D,EAC/D,8BAAsE;QAEtE,kHAAkH;QAClH,IAAI,8BAA8B,KAAK,OAAO,CAAC,8BAA8B,CAAC,QAAQ,EAAE,CAAC;YACvF,IAAI,gBAAgB,EAAE,CAAC;gBACrB,kDAAkD;gBAClD,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC,EAAE,EAAE;oBAC1E,IAAI,MAAM,KAAK,kBAAkB,CAAC,gBAAgB,EAAE,CAAC;wBACnD,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;oBAC/C,CAAC;gBACH,CAAC,CAAC,CAAC;gBACH,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBAC5B,4BAA4B;gBAC5B,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;gBACjD,IAAI,CAAC,OAAO,CAAC,KAAK,CAChB,sBAAsB,gBAAgB,wBAAwB,SAAS,GAAG,CAC3E,CAAC;YACJ,CAAC;QACH,CAAC;aAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC7B,8DAA8D;YAC9D,2HAA2H;YAC3H,mEAAmE;YACnE,6GAA6G;YAC7G,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC,EAAE,EAAE;gBAC1E,IAAI,MAAM,KAAK,kBAAkB,CAAC,gBAAgB,EAAE,CAAC;oBACnD,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,aAAa,EAAE,SAAS,CAAC,CAAC;gBAC3D,CAAC;YACH,CAAC,CAAC,CAAC;YACH,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAED,KAAK,CAAC,sBAAsB,CAC1B,QAA0C,EAC1C,QAAgB,EAChB,SAAiB;QAEjB,MAAM,iBAAiB,GACrB,QAAQ,CAAC,MAAM,KAAK,OAAO,CAAC,8BAA8B,CAAC,QAAQ;YACjE,CAAC,CAAC,QAAQ,CAAC,QAAQ;YACnB,CAAC,CAAC,SAAS,CAAC;QAChB,MAAM,iBAAiB,GACrB,QAAQ,CAAC,MAAM,KAAK,OAAO,CAAC,8BAA8B,CAAC,QAAQ;YACjE,CAAC,CAAC,QAAQ,CAAC,QAAQ;YACnB,CAAC,CAAC,SAAS,CAAC;QAEhB,MAAM,wBAAwB,GAAe;YAC3C,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,iBAAiB;YACjB,iBAAiB;SAClB,CAAC;QACF,IAAI,kBAAkB,GAAqB,MAAM,IAAI,CAAC,eAAe,CAAC,mBAAmB,CACvF,QAAQ,EACR,wBAAwB,EACxB,SAAS,CACV,CAAC;QACF,IAAI,kBAAkB,EAAE,CAAC;YACvB,kBAAkB,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,uBAAuB,CACrE,QAAQ,EACR,QAAQ,CAAC,WAAW,EACpB,SAAS,CACV,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;QAC3D,CAAC;QACD,OAAO,kBAAkB,CAAC;IAC5B,CAAC;CACF"}

package/dist/module/DataApi.d.ts

@@ -0,0 +1,52 @@
+import type { FastifyInstance, FastifyRequest } from 'fastify';
+import type { ILogObj } from 'tslog';
+import { Logger } from 'tslog';
+import type { IConfigurationModuleApi } from './interface.js';
+import { ConfigurationModule } from './module.js';
+import type { BootConfig, IMessageConfirmation, UpdateChargingStationPasswordRequest } from '@citrineos/base';
+import { AbstractModuleApi, Namespace, OCPP1_6_Namespace, OCPP2_0_1, OCPP2_0_1_Namespace } from '@citrineos/base';
+import type { ChargingStationKeyQuerystring, NetworkProfileDeleteQuerystring, NetworkProfileQuerystring, UpdateChargingStationPasswordQueryString } from '@citrineos/data';
+import { Boot, ChargingStationNetworkProfile } from '@citrineos/data';
+/**
+ * Server API for the Configuration component.
+ */
+export declare class ConfigurationDataApi extends AbstractModuleApi<ConfigurationModule> implements IConfigurationModuleApi {
+    /**
+     * Constructor for the class.
+     *
+     * @param {ConfigurationModule} ConfigurationComponent - The Configuration component.
+     * @param {FastifyInstance} server - The server instance.
+     * @param {Logger<ILogObj>} [logger] - Optional logger instance.
+     */
+    constructor(ConfigurationComponent: ConfigurationModule, server: FastifyInstance, logger?: Logger<ILogObj>);
+    putBootConfig(request: FastifyRequest<{
+        Body: OCPP2_0_1.BootNotificationResponse;
+        Querystring: ChargingStationKeyQuerystring;
+    }>): Promise<BootConfig | undefined>;
+    getBootConfig(request: FastifyRequest<{
+        Querystring: ChargingStationKeyQuerystring;
+    }>): Promise<Boot | undefined>;
+    deleteBootConfig(request: FastifyRequest<{
+        Querystring: ChargingStationKeyQuerystring;
+    }>): Promise<Boot | undefined>;
+    updatePassword(request: FastifyRequest<{
+        Body: UpdateChargingStationPasswordRequest;
+        Querystring: UpdateChargingStationPasswordQueryString;
+    }>): Promise<IMessageConfirmation>;
+    getNetworkProfiles(request: FastifyRequest<{
+        Querystring: NetworkProfileQuerystring;
+    }>): Promise<ChargingStationNetworkProfile[]>;
+    deleteNetworkProfiles(request: FastifyRequest<{
+        Querystring: NetworkProfileDeleteQuerystring;
+    }>): Promise<IMessageConfirmation>;
+    /**
+     * Overrides superclass method to generate the URL path based on the input {@link Namespace}
+     * and the module's endpoint prefix configuration.
+     *
+     * @param {Namespace} input - The input {@link Namespace}.
+     * @return {string} - The generated URL path.
+     */
+    protected _toDataPath(input: OCPP2_0_1_Namespace | OCPP1_6_Namespace | Namespace): string;
+    private updatePasswordOnStation;
+    private updatePasswordForStation;
+}

package/dist/module/DataApi.js

@@ -0,0 +1,206 @@
+// SPDX-FileCopyrightText: 2025 Contributors to the CitrineOS Project
+//
+// SPDX-License-Identifier: Apache-2.0
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { Logger } from 'tslog';
+import { ConfigurationModule } from './module.js';
+import { AbstractModuleApi, AsDataEndpoint, BootConfigSchema, HttpMethod, Namespace, OCPP1_6_Namespace, OCPP2_0_1, OCPP2_0_1_CallAction, OCPP2_0_1_Namespace, OCPPVersion, UpdateChargingStationPasswordSchema, } from '@citrineos/base';
+import { Boot, ChargingStationKeyQuerySchema, ChargingStationNetworkProfile, Component, NetworkProfileDeleteQuerySchema, NetworkProfileQuerySchema, ServerNetworkProfile, SetNetworkProfile, UpdateChargingStationPasswordQuerySchema, Variable, VariableAttribute, } from '@citrineos/data';
+import { Op } from 'sequelize';
+import { generatePassword, isValidPassword } from '@citrineos/util';
+import { v4 as uuidv4 } from 'uuid';
+/**
+ * Server API for the Configuration component.
+ */
+export class ConfigurationDataApi extends AbstractModuleApi {
+    /**
+     * Constructor for the class.
+     *
+     * @param {ConfigurationModule} ConfigurationComponent - The Configuration component.
+     * @param {FastifyInstance} server - The server instance.
+     * @param {Logger<ILogObj>} [logger] - Optional logger instance.
+     */
+    constructor(ConfigurationComponent, server, logger) {
+        super(ConfigurationComponent, server, null, logger);
+    }
+    putBootConfig(request) {
+        return this._module.bootRepository.createOrUpdateByKey(request.query.tenantId, request.body, request.query.stationId);
+    }
+    getBootConfig(request) {
+        return this._module.bootRepository.readByKey(request.query.tenantId, request.query.stationId);
+    }
+    deleteBootConfig(request) {
+        return this._module.bootRepository.deleteByKey(request.query.tenantId, request.query.stationId);
+    }
+    async updatePassword(request) {
+        const stationId = request.body.stationId;
+        const tenantId = request.query.tenantId;
+        this._logger.debug(`Updating password for ${stationId} station in tenant ${tenantId}`);
+        if (request.body.setOnCharger && !request.body.password) {
+            return {
+                success: false,
+                payload: 'Password is required when setOnCharger is true',
+            };
+        }
+        if (request.body.password && !isValidPassword(request.body.password)) {
+            return { success: false, payload: 'Invalid password' };
+        }
+        const password = request.body.password || generatePassword();
+        if (!request.body.setOnCharger) {
+            try {
+                await this.updatePasswordOnStation(password, stationId, tenantId, request.query.callbackUrl);
+            }
+            catch (error) {
+                this._logger.warn(`Failed updating password on ${stationId} station`, error);
+                return {
+                    success: false,
+                    payload: `Failed updating password on ${stationId} station`,
+                };
+            }
+        }
+        const variableAttributes = await this.updatePasswordForStation(password, tenantId, stationId);
+        this._logger.debug(`Successfully updated password for ${stationId} station`);
+        return {
+            success: true,
+            payload: `Updated ${variableAttributes.length} attributes`,
+        };
+    }
+    async getNetworkProfiles(request) {
+        return ChargingStationNetworkProfile.findAll({
+            where: { stationId: request.query.stationId, tenantId: request.query.tenantId },
+            include: [SetNetworkProfile, ServerNetworkProfile],
+        });
+    }
+    async deleteNetworkProfiles(request) {
+        const destroyedRows = await ChargingStationNetworkProfile.destroy({
+            where: {
+                stationId: request.query.stationId,
+                tenantId: request.query.tenantId,
+                configurationSlot: {
+                    [Op.in]: request.query.configurationSlot,
+                },
+            },
+        });
+        return {
+            success: true,
+            payload: `${destroyedRows} rows successfully destroyed`,
+        };
+    }
+    /**
+     * Overrides superclass method to generate the URL path based on the input {@link Namespace}
+     * and the module's endpoint prefix configuration.
+     *
+     * @param {Namespace} input - The input {@link Namespace}.
+     * @return {string} - The generated URL path.
+     */
+    _toDataPath(input) {
+        const endpointPrefix = this._module.config.modules.configuration.endpointPrefix;
+        return super._toDataPath(input, endpointPrefix);
+    }
+    async updatePasswordOnStation(password, stationId, tenantId, callbackUrl) {
+        const correlationId = uuidv4();
+        const cacheCallbackPromise = this._module.cache.onChange(correlationId, this._module.config.maxCachingSeconds, stationId);
+        const messageConfirmation = await this._module.sendCall(stationId, tenantId, OCPPVersion.OCPP2_0_1, OCPP2_0_1_CallAction.SetVariables, {
+            setVariableData: [
+                {
+                    variable: { name: 'BasicAuthPassword' },
+                    attributeValue: password,
+                    attributeType: OCPP2_0_1.AttributeEnumType.Actual,
+                    component: { name: 'SecurityCtrlr' },
+                },
+            ],
+        }, callbackUrl, correlationId);
+        if (!messageConfirmation.success) {
+            throw new Error(`Failed sending request to ${stationId} station for updating password`);
+        }
+        const responseJsonString = await cacheCallbackPromise;
+        if (!responseJsonString) {
+            throw new Error(`${stationId} station did not respond in time for updating password`);
+        }
+        const setVariablesResponse = JSON.parse(responseJsonString);
+        const passwordUpdated = setVariablesResponse.setVariableResult.every((result) => result.attributeStatus === OCPP2_0_1.SetVariableStatusEnumType.Accepted);
+        if (!passwordUpdated) {
+            throw new Error(`Failure updating password on ${stationId} station`);
+        }
+    }
+    async updatePasswordForStation(password, tenantId, stationId) {
+        const timestamp = new Date().toISOString();
+        const variableAttributes = await this._module.deviceModelRepository.createOrUpdateDeviceModelByStationId(tenantId, {
+            component: {
+                name: 'SecurityCtrlr',
+            },
+            variable: {
+                name: 'BasicAuthPassword',
+            },
+            variableAttribute: [
+                {
+                    type: OCPP2_0_1.AttributeEnumType.Actual,
+                    value: password,
+                    mutability: OCPP2_0_1.MutabilityEnumType.WriteOnly,
+                },
+            ],
+            variableCharacteristics: {
+                dataType: OCPP2_0_1.DataEnumType.passwordString,
+                supportsMonitoring: false,
+            },
+        }, stationId, timestamp);
+        for (let variableAttribute of variableAttributes) {
+            variableAttribute = await variableAttribute.reload({
+                include: [Variable, Component],
+            });
+            await this._module.deviceModelRepository.updateResultByStationId(tenantId, {
+                attributeType: variableAttribute.type,
+                attributeStatus: OCPP2_0_1.SetVariableStatusEnumType.Accepted,
+                attributeStatusInfo: { reasonCode: 'SetOnCharger' },
+                component: variableAttribute.component,
+                variable: variableAttribute.variable,
+            }, stationId, timestamp);
+        }
+        return variableAttributes;
+    }
+}
+__decorate([
+    AsDataEndpoint(Namespace.BootConfig, HttpMethod.Put, ChargingStationKeyQuerySchema, BootConfigSchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], ConfigurationDataApi.prototype, "putBootConfig", null);
+__decorate([
+    AsDataEndpoint(Namespace.BootConfig, HttpMethod.Get, ChargingStationKeyQuerySchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], ConfigurationDataApi.prototype, "getBootConfig", null);
+__decorate([
+    AsDataEndpoint(Namespace.BootConfig, HttpMethod.Delete, ChargingStationKeyQuerySchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], ConfigurationDataApi.prototype, "deleteBootConfig", null);
+__decorate([
+    AsDataEndpoint(OCPP2_0_1_Namespace.PasswordType, HttpMethod.Post, UpdateChargingStationPasswordQuerySchema, UpdateChargingStationPasswordSchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], ConfigurationDataApi.prototype, "updatePassword", null);
+__decorate([
+    AsDataEndpoint(OCPP2_0_1_Namespace.ServerNetworkProfile, HttpMethod.Get, NetworkProfileQuerySchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], ConfigurationDataApi.prototype, "getNetworkProfiles", null);
+__decorate([
+    AsDataEndpoint(OCPP2_0_1_Namespace.ServerNetworkProfile, HttpMethod.Delete, NetworkProfileDeleteQuerySchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], ConfigurationDataApi.prototype, "deleteNetworkProfiles", null);
+//# sourceMappingURL=DataApi.js.map

package/dist/module/DataApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataApi.js","sourceRoot":"","sources":["../../src/module/DataApi.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,EAAE;AACF,sCAAsC;;;;;;;;;;AAItC,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAMlD,OAAO,EACL,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,UAAU,EACV,SAAS,EACT,iBAAiB,EACjB,SAAS,EACT,oBAAoB,EACpB,mBAAmB,EACnB,WAAW,EACX,mCAAmC,GACpC,MAAM,iBAAiB,CAAC;AAOzB,OAAO,EACL,IAAI,EACJ,6BAA6B,EAC7B,6BAA6B,EAC7B,SAAS,EACT,+BAA+B,EAC/B,yBAAyB,EACzB,oBAAoB,EACpB,iBAAiB,EACjB,wCAAwC,EACxC,QAAQ,EACR,iBAAiB,GAClB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,EAAE,EAAE,MAAM,WAAW,CAAC;AAC/B,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AACpE,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AAEpC;;GAEG;AACH,MAAM,OAAO,oBACX,SAAQ,iBAAsC;IAG9C;;;;;;OAMG;IACH,YACE,sBAA2C,EAC3C,MAAuB,EACvB,MAAwB;QAExB,KAAK,CAAC,sBAAsB,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;IAQD,aAAa,CACX,OAGE;QAEF,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,mBAAmB,CACpD,OAAO,CAAC,KAAK,CAAC,QAAQ,EACtB,OAAO,CAAC,IAAI,EACZ,OAAO,CAAC,KAAK,CAAC,SAAS,CACxB,CAAC;IACJ,CAAC;IAGD,aAAa,CACX,OAAuE;QAEvE,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAChG,CAAC;IAGD,gBAAgB,CACd,OAAuE;QAEvE,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAClG,CAAC;IAQK,AAAN,KAAK,CAAC,cAAc,CAClB,OAGE;QAEF,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC;QACzC,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC;QAExC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,yBAAyB,SAAS,sBAAsB,QAAQ,EAAE,CAAC,CAAC;QAEvF,IAAI,OAAO,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACxD,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,OAAO,EAAE,gDAAgD;aAC1D,CAAC;QACJ,CAAC;QACD,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YACrE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,kBAAkB,EAAE,CAAC;QACzD,CAAC;QACD,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,IAAI,gBAAgB,EAAE,CAAC;QAE7D,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;YAC/B,IAAI,CAAC;gBACH,MAAM,IAAI,CAAC,uBAAuB,CAChC,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,OAAO,CAAC,KAAK,CAAC,WAAW,CAC1B,CAAC;YACJ,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,+BAA+B,SAAS,UAAU,EAAE,KAAK,CAAC,CAAC;gBAC7E,OAAO;oBACL,OAAO,EAAE,KAAK;oBACd,OAAO,EAAE,+BAA+B,SAAS,UAAU;iBAC5D,CAAC;YACJ,CAAC;QACH,CAAC;QACD,MAAM,kBAAkB,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;QAC9F,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,qCAAqC,SAAS,UAAU,CAAC,CAAC;QAC7E,OAAO;YACL,OAAO,EAAE,IAAI;YACb,OAAO,EAAE,WAAW,kBAAkB,CAAC,MAAM,aAAa;SAC3D,CAAC;IACJ,CAAC;IAOK,AAAN,KAAK,CAAC,kBAAkB,CACtB,OAAmE;QAEnE,OAAO,6BAA6B,CAAC,OAAO,CAAC;YAC3C,KAAK,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,KAAK,CAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE;YAC/E,OAAO,EAAE,CAAC,iBAAiB,EAAE,oBAAoB,CAAC;SACnD,CAAC,CAAC;IACL,CAAC;IAOK,AAAN,KAAK,CAAC,qBAAqB,CACzB,OAAyE;QAEzE,MAAM,aAAa,GAAG,MAAM,6BAA6B,CAAC,OAAO,CAAC;YAChE,KAAK,EAAE;gBACL,SAAS,EAAE,OAAO,CAAC,KAAK,CAAC,SAAS;gBAClC,QAAQ,EAAE,OAAO,CAAC,KAAK,CAAC,QAAQ;gBAChC,iBAAiB,EAAE;oBACjB,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,iBAAiB;iBACzC;aACF;SACF,CAAC,CAAC;QACH,OAAO;YACL,OAAO,EAAE,IAAI;YACb,OAAO,EAAE,GAAG,aAAa,8BAA8B;SACxD,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACO,WAAW,CAAC,KAA0D;QAC9E,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,cAAc,CAAC;QAChF,OAAO,KAAK,CAAC,WAAW,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;IAClD,CAAC;IAEO,KAAK,CAAC,uBAAuB,CACnC,QAAgB,EAChB,SAAiB,EACjB,QAAgB,EAChB,WAAoB;QAEpB,MAAM,aAAa,GAAG,MAAM,EAAE,CAAC;QAC/B,MAAM,oBAAoB,GAA2B,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAC9E,aAAa,EACb,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,iBAAiB,EACrC,SAAS,CACV,CAAC;QAEF,MAAM,mBAAmB,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CACrD,SAAS,EACT,QAAQ,EACR,WAAW,CAAC,SAAS,EACrB,oBAAoB,CAAC,YAAY,EACjC;YACE,eAAe,EAAE;gBACf;oBACE,QAAQ,EAAE,EAAE,IAAI,EAAE,mBAAmB,EAAE;oBACvC,cAAc,EAAE,QAAQ;oBACxB,aAAa,EAAE,SAAS,CAAC,iBAAiB,CAAC,MAAM;oBACjD,SAAS,EAAE,EAAE,IAAI,EAAE,eAAe,EAAE;iBACJ;aACnC;SAC+B,EAClC,WAAW,EACX,aAAa,CACd,CAAC;QACF,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,6BAA6B,SAAS,gCAAgC,CAAC,CAAC;QAC1F,CAAC;QAED,MAAM,kBAAkB,GAAG,MAAM,oBAAoB,CAAC;QACtD,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,GAAG,SAAS,wDAAwD,CAAC,CAAC;QACxF,CAAC;QAED,MAAM,oBAAoB,GAAmC,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;QAC5F,MAAM,eAAe,GAAG,oBAAoB,CAAC,iBAAiB,CAAC,KAAK,CAClE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,eAAe,KAAK,SAAS,CAAC,yBAAyB,CAAC,QAAQ,CACpF,CAAC;QACF,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,gCAAgC,SAAS,UAAU,CAAC,CAAC;QACvE,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,wBAAwB,CACpC,QAAgB,EAChB,QAAgB,EAChB,SAAiB;QAEjB,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAC3C,MAAM,kBAAkB,GACtB,MAAM,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,oCAAoC,CAC3E,QAAQ,EACR;YACE,SAAS,EAAE;gBACT,IAAI,EAAE,eAAe;aACtB;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,mBAAmB;aAC1B;YACD,iBAAiB,EAAE;gBACjB;oBACE,IAAI,EAAE,SAAS,CAAC,iBAAiB,CAAC,MAAM;oBACxC,KAAK,EAAE,QAAQ;oBACf,UAAU,EAAE,SAAS,CAAC,kBAAkB,CAAC,SAAS;iBACnD;aACF;YACD,uBAAuB,EAAE;gBACvB,QAAQ,EAAE,SAAS,CAAC,YAAY,CAAC,cAAc;gBAC/C,kBAAkB,EAAE,KAAK;aAC1B;SACF,EACD,SAAS,EACT,SAAS,CACV,CAAC;QACJ,KAAK,IAAI,iBAAiB,IAAI,kBAAkB,EAAE,CAAC;YACjD,iBAAiB,GAAG,MAAM,iBAAiB,CAAC,MAAM,CAAC;gBACjD,OAAO,EAAE,CAAC,QAAQ,EAAE,SAAS,CAAC;aAC/B,CAAC,CAAC;YACH,MAAM,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,uBAAuB,CAC9D,QAAQ,EACR;gBACE,aAAa,EAAE,iBAAiB,CAAC,IAAI;gBACrC,eAAe,EAAE,SAAS,CAAC,yBAAyB,CAAC,QAAQ;gBAC7D,mBAAmB,EAAE,EAAE,UAAU,EAAE,cAAc,EAAE;gBACnD,SAAS,EAAE,iBAAiB,CAAC,SAAS;gBACtC,QAAQ,EAAE,iBAAiB,CAAC,QAAQ;aACrC,EACD,SAAS,EACT,SAAS,CACV,CAAC;QACJ,CAAC;QACD,OAAO,kBAAkB,CAAC;IAC5B,CAAC;CACF;AAnOC;IANC,cAAc,CACb,SAAS,CAAC,UAAU,EACpB,UAAU,CAAC,GAAG,EACd,6BAA6B,EAC7B,gBAAgB,CACjB;;;;yDAYA;AAGD;IADC,cAAc,CAAC,SAAS,CAAC,UAAU,EAAE,UAAU,CAAC,GAAG,EAAE,6BAA6B,CAAC;;;;yDAKnF;AAGD;IADC,cAAc,CAAC,SAAS,CAAC,UAAU,EAAE,UAAU,CAAC,MAAM,EAAE,6BAA6B,CAAC;;;;4DAKtF;AAQK;IANL,cAAc,CACb,mBAAmB,CAAC,YAAY,EAChC,UAAU,CAAC,IAAI,EACf,wCAAwC,EACxC,mCAAmC,CACpC;;;;0DA6CA;AAOK;IALL,cAAc,CACb,mBAAmB,CAAC,oBAAoB,EACxC,UAAU,CAAC,GAAG,EACd,yBAAyB,CAC1B;;;;8DAQA;AAOK;IALL,cAAc,CACb,mBAAmB,CAAC,oBAAoB,EACxC,UAAU,CAAC,MAAM,EACjB,+BAA+B,CAChC;;;;iEAiBA"}

package/dist/module/DeviceModelService.d.ts

@@ -0,0 +1,30 @@
+import type { IDeviceModelRepository } from '@citrineos/data';
+export declare class DeviceModelService {
+    protected _deviceModelRepository: IDeviceModelRepository;
+    constructor(deviceModelRepository: IDeviceModelRepository);
+    /**
+     * Fetches the ItemsPerMessageSetVariables attribute from the device model.
+     * Returns null if no such attribute exists.
+     * It is possible for there to be multiple ItemsPerMessageSetVariables attributes if component instances or evses
+     * are associated with alternate options. That structure is not supported by this logic, and that
+     * structure is a violation of Part 2 - Specification of OCPP 2.0.1.
+     * In that case, the first attribute will be returned.
+     * @param tenantId
+     * @param stationId Charging station identifier.
+     * @returns ItemsPerMessageSetVariables as a number or null if no such attribute exists.
+     */
+    getItemsPerMessageSetVariablesByStationId(tenantId: number, stationId: string): Promise<number | null>;
+    /**
+     * Fetches the ItemsPerMessageGetVariables attribute from the device model.
+     * Returns null if no such attribute exists.
+     * It is possible for there to be multiple ItemsPerMessageGetVariables attributes if component instances or evses
+     * are associated with alternate options. That structure is not supported by this logic, and that
+     * structure is a violation of Part 2 - Specification of OCPP 2.0.1.
+     * In that case, the first attribute will be returned.
+     * @param tenantId
+     * @param stationId Charging station identifier.
+     * @returns ItemsPerMessageGetVariables as a number or null if no such attribute exists.
+     */
+    getItemsPerMessageGetVariablesByStationId(tenantId: number, stationId: string): Promise<number | null>;
+    updateDeviceModel(chargingStation: any, tenantId: number, stationId: string, timestamp: string): Promise<void>;
+}