@zetra/citrineos-configuration 1.8.3-fork.1

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export { ConfigurationDataApi } from './module/DataApi.js';
+export { ConfigurationOcpp201Api } from './module/2.0.1/MessageApi.js';
+export { ConfigurationOcpp16Api } from './module/1.6/MessageApi.js';
+export type { IConfigurationModuleApi } from './module/interface.js';
+export { ConfigurationModule } from './module/module.js';

package/dist/index.js

@@ -0,0 +1,8 @@
+// SPDX-FileCopyrightText: 2025 Contributors to the CitrineOS Project
+//
+// SPDX-License-Identifier: Apache-2.0
+export { ConfigurationDataApi } from './module/DataApi.js';
+export { ConfigurationOcpp201Api } from './module/2.0.1/MessageApi.js';
+export { ConfigurationOcpp16Api } from './module/1.6/MessageApi.js';
+export { ConfigurationModule } from './module/module.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,EAAE;AACF,sCAAsC;AAEtC,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAEpE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC"}

package/dist/module/1.6/MessageApi.d.ts

@@ -0,0 +1,34 @@
+import type { FastifyInstance } from 'fastify';
+import type { ILogObj } from 'tslog';
+import { Logger } from 'tslog';
+import type { IConfigurationModuleApi } from '../interface.js';
+import { ConfigurationModule } from '../module.js';
+import type { CallAction, IMessageConfirmation } from '@citrineos/base';
+import { AbstractModuleApi, OCPP1_6 } from '@citrineos/base';
+/**
+ * Server API for the Configuration component.
+ */
+export declare class ConfigurationOcpp16Api 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>);
+    triggerMessage(identifier: string[], request: OCPP1_6.TriggerMessageRequest, callbackUrl?: string, tenantId?: number): Promise<IMessageConfirmation[]>;
+    changeConfiguration(identifier: string[], request: OCPP1_6.ChangeConfigurationRequest, callbackUrl?: string, tenantId?: number): Promise<IMessageConfirmation[]>;
+    getConfiguration(identifier: string[], request: OCPP1_6.GetConfigurationRequest, callbackUrl?: string, tenantId?: number): Promise<IMessageConfirmation[]>;
+    reset(identifier: string[], request: OCPP1_6.ResetRequest, callbackUrl?: string, tenantId?: number): Promise<IMessageConfirmation[]>;
+    changeAvailability(identifier: string[], request: OCPP1_6.ChangeAvailabilityRequest, callbackUrl?: string, tenantId?: number): Promise<IMessageConfirmation[]>;
+    updateFirmware(identifier: string[], request: OCPP1_6.UpdateFirmwareRequest, callbackUrl?: string, tenantId?: number): Promise<IMessageConfirmation[]>;
+    dataTransfer(identifier: string[], request: OCPP1_6.DataTransferRequest, callbackUrl?: string, tenantId?: number): Promise<IMessageConfirmation[]>;
+    /**
+     * Overrides superclass method to generate the URL path based on the input {@link CallAction} and the module's endpoint prefix configuration.
+     *
+     * @param {CallAction} input - The input {@link CallAction}.
+     * @return {string} - The generated URL path.
+     */
+    protected _toMessagePath(input: CallAction): string;
+}

package/dist/module/1.6/MessageApi.js

@@ -0,0 +1,190 @@
+// 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, AsMessageEndpoint, DEFAULT_TENANT_ID, OCPP1_6, OCPP1_6_CallAction, OCPP2_0_1_CallAction, OCPPVersion, } from '@citrineos/base';
+import { v4 as uuidv4 } from 'uuid';
+/**
+ * Server API for the Configuration component.
+ */
+export class ConfigurationOcpp16Api 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, OCPPVersion.OCPP1_6, logger);
+    }
+    async triggerMessage(identifier, request, callbackUrl, tenantId = DEFAULT_TENANT_ID) {
+        const connectorId = request.connectorId;
+        if (connectorId && connectorId <= 0) {
+            const errorMsg = `connectorId should be either omitted or greater than 0.`;
+            this._logger.error(errorMsg);
+            return [{ success: false, payload: errorMsg }];
+        }
+        const results = identifier.map((id) => this._module.sendCall(id, tenantId, OCPPVersion.OCPP1_6, OCPP2_0_1_CallAction.TriggerMessage, request, callbackUrl));
+        return Promise.all(results);
+    }
+    async changeConfiguration(identifier, request, callbackUrl, tenantId = DEFAULT_TENANT_ID) {
+        this._logger.debug('ChangeConfiguration request received:', request);
+        const confirmations = identifier.map(async (stationId) => {
+            const chargingStation = await this._module.locationRepository.readChargingStationByStationId(tenantId, stationId);
+            if (!chargingStation) {
+                return {
+                    success: false,
+                    payload: `Charging station ${stationId} not found`,
+                };
+            }
+            return await this._module.sendCall(stationId, tenantId, OCPPVersion.OCPP1_6, OCPP1_6_CallAction.ChangeConfiguration, request, callbackUrl);
+        });
+        return Promise.all(confirmations);
+    }
+    async getConfiguration(identifier, request, callbackUrl, tenantId = DEFAULT_TENANT_ID) {
+        this._logger.debug('GetConfiguration request received:', request);
+        const confirmations = [];
+        await Promise.all(identifier.map(async (stationId) => {
+            const chargingStation = await this._module.locationRepository.readChargingStationByStationId(tenantId, stationId);
+            if (!chargingStation) {
+                confirmations.push({
+                    success: false,
+                    payload: {
+                        batch: `Station ${stationId}`,
+                        message: `Charging station ${stationId} not found`,
+                        stationId,
+                    },
+                });
+                return;
+            }
+            const maxKeysConfig = await this._module.changeConfigurationRepository.readOnlyOneByQuery(tenantId, {
+                where: {
+                    tenantId: tenantId,
+                    stationId: stationId,
+                    key: 'GetConfigurationMaxKeys',
+                },
+            });
+            const maxKeys = maxKeysConfig?.value
+                ? parseInt(maxKeysConfig.value, 10)
+                : Number.MAX_SAFE_INTEGER;
+            const keys = request.key || [];
+            const sendBatches = async (batches) => {
+                return Promise.all(batches.map(async (batch, index) => {
+                    try {
+                        const correlationId = uuidv4();
+                        const batchResult = await this._module.sendCall(stationId, tenantId, OCPPVersion.OCPP1_6, OCPP1_6_CallAction.GetConfiguration, { key: batch }, callbackUrl, correlationId);
+                        confirmations.push({
+                            success: batchResult.success,
+                            payload: {
+                                batch: `[${index}:${index + batch.length}]`,
+                                message: `${batchResult.payload}`,
+                                stationId,
+                            },
+                        });
+                    }
+                    catch (error) {
+                        confirmations.push({
+                            success: false,
+                            payload: {
+                                batch: `[${index}:${index + batch.length}]`,
+                                message: `${error}`,
+                                stationId,
+                            },
+                        });
+                    }
+                }));
+            };
+            if (keys.length === 0 || keys.length <= maxKeys) {
+                await sendBatches([keys]);
+            }
+            else {
+                const batches = [];
+                for (let i = 0; i < keys.length; i += maxKeys) {
+                    batches.push(keys.slice(i, i + maxKeys));
+                }
+                await sendBatches(batches);
+            }
+        }));
+        return confirmations;
+    }
+    reset(identifier, request, callbackUrl, tenantId = DEFAULT_TENANT_ID) {
+        const results = identifier.map((id) => this._module.sendCall(id, tenantId, OCPPVersion.OCPP1_6, OCPP1_6_CallAction.Reset, request, callbackUrl));
+        return Promise.all(results);
+    }
+    changeAvailability(identifier, request, callbackUrl, tenantId = DEFAULT_TENANT_ID) {
+        const results = identifier.map((id) => this._module.sendCall(id, tenantId, OCPPVersion.OCPP1_6, OCPP1_6_CallAction.ChangeAvailability, request, callbackUrl));
+        return Promise.all(results);
+    }
+    updateFirmware(identifier, request, callbackUrl, tenantId = DEFAULT_TENANT_ID) {
+        const results = identifier.map((id) => this._module.sendCall(id, tenantId, OCPPVersion.OCPP1_6, OCPP1_6_CallAction.UpdateFirmware, request, callbackUrl));
+        return Promise.all(results);
+    }
+    dataTransfer(identifier, request, callbackUrl, tenantId = DEFAULT_TENANT_ID) {
+        const results = identifier.map((id) => this._module.sendCall(id, tenantId, OCPPVersion.OCPP1_6, OCPP1_6_CallAction.DataTransfer, request, callbackUrl));
+        return Promise.all(results);
+    }
+    /**
+     * Overrides superclass method to generate the URL path based on the input {@link CallAction} and the module's endpoint prefix configuration.
+     *
+     * @param {CallAction} input - The input {@link CallAction}.
+     * @return {string} - The generated URL path.
+     */
+    _toMessagePath(input) {
+        const endpointPrefix = this._module.config.modules.configuration.endpointPrefix;
+        return super._toMessagePath(input, endpointPrefix);
+    }
+}
+__decorate([
+    AsMessageEndpoint(OCPP1_6_CallAction.TriggerMessage, OCPP1_6.TriggerMessageRequestSchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Array, Object, String, Number]),
+    __metadata("design:returntype", Promise)
+], ConfigurationOcpp16Api.prototype, "triggerMessage", null);
+__decorate([
+    AsMessageEndpoint(OCPP1_6_CallAction.ChangeConfiguration, OCPP1_6.ChangeConfigurationRequestSchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Array, Object, String, Number]),
+    __metadata("design:returntype", Promise)
+], ConfigurationOcpp16Api.prototype, "changeConfiguration", null);
+__decorate([
+    AsMessageEndpoint(OCPP1_6_CallAction.GetConfiguration, OCPP1_6.GetConfigurationRequestSchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Array, Object, String, Number]),
+    __metadata("design:returntype", Promise)
+], ConfigurationOcpp16Api.prototype, "getConfiguration", null);
+__decorate([
+    AsMessageEndpoint(OCPP1_6_CallAction.Reset, OCPP1_6.ResetRequestSchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Array, Object, String, Number]),
+    __metadata("design:returntype", Promise)
+], ConfigurationOcpp16Api.prototype, "reset", null);
+__decorate([
+    AsMessageEndpoint(OCPP1_6_CallAction.ChangeAvailability, OCPP1_6.ChangeAvailabilityRequestSchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Array, Object, String, Number]),
+    __metadata("design:returntype", Promise)
+], ConfigurationOcpp16Api.prototype, "changeAvailability", null);
+__decorate([
+    AsMessageEndpoint(OCPP1_6_CallAction.UpdateFirmware, OCPP1_6.UpdateFirmwareRequestSchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Array, Object, String, Number]),
+    __metadata("design:returntype", Promise)
+], ConfigurationOcpp16Api.prototype, "updateFirmware", null);
+__decorate([
+    AsMessageEndpoint(OCPP1_6_CallAction.DataTransfer, OCPP1_6.DataTransferRequestSchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Array, Object, String, Number]),
+    __metadata("design:returntype", Promise)
+], ConfigurationOcpp16Api.prototype, "dataTransfer", null);
+//# sourceMappingURL=MessageApi.js.map

package/dist/module/1.6/MessageApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MessageApi.js","sourceRoot":"","sources":["../../../src/module/1.6/MessageApi.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,EAAE;AACF,sCAAsC;;;;;;;;;;AAItC,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAEnD,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EACjB,iBAAiB,EACjB,OAAO,EACP,kBAAkB,EAClB,oBAAoB,EACpB,WAAW,GACZ,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AAEpC;;GAEG;AACH,MAAM,OAAO,sBACX,SAAQ,iBAAsC;IAG9C;;;;;;OAMG;IACH,YACE,sBAA2C,EAC3C,MAAuB,EACvB,MAAwB;QAExB,KAAK,CAAC,sBAAsB,EAAE,MAAM,EAAE,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IACrE,CAAC;IAGK,AAAN,KAAK,CAAC,cAAc,CAClB,UAAoB,EACpB,OAAsC,EACtC,WAAoB,EACpB,WAAmB,iBAAiB;QAEpC,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACxC,IAAI,WAAW,IAAI,WAAW,IAAI,CAAC,EAAE,CAAC;YACpC,MAAM,QAAQ,GAAW,yDAAyD,CAAC;YACnF,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YAC7B,OAAO,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;QACjD,CAAC;QAED,MAAM,OAAO,GAAoC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CACrE,IAAI,CAAC,OAAO,CAAC,QAAQ,CACnB,EAAE,EACF,QAAQ,EACR,WAAW,CAAC,OAAO,EACnB,oBAAoB,CAAC,cAAc,EACnC,OAAO,EACP,WAAW,CACZ,CACF,CAAC;QACF,OAAO,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAMK,AAAN,KAAK,CAAC,mBAAmB,CACvB,UAAoB,EACpB,OAA2C,EAC3C,WAAoB,EACpB,WAAmB,iBAAiB;QAEpC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,uCAAuC,EAAE,OAAO,CAAC,CAAC;QACrE,MAAM,aAAa,GAAG,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE;YACvD,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,8BAA8B,CAC1F,QAAQ,EACR,SAAS,CACV,CAAC;YACF,IAAI,CAAC,eAAe,EAAE,CAAC;gBACrB,OAAO;oBACL,OAAO,EAAE,KAAK;oBACd,OAAO,EAAE,oBAAoB,SAAS,YAAY;iBACnD,CAAC;YACJ,CAAC;YAED,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAChC,SAAS,EACT,QAAQ,EACR,WAAW,CAAC,OAAO,EACnB,kBAAkB,CAAC,mBAAmB,EACtC,OAAO,EACP,WAAW,CACZ,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,OAAO,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IACpC,CAAC;IAGK,AAAN,KAAK,CAAC,gBAAgB,CACpB,UAAoB,EACpB,OAAwC,EACxC,WAAoB,EACpB,WAAmB,iBAAiB;QAEpC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,oCAAoC,EAAE,OAAO,CAAC,CAAC;QAElE,MAAM,aAAa,GAA2B,EAAE,CAAC;QAEjD,MAAM,OAAO,CAAC,GAAG,CACf,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE;YACjC,MAAM,eAAe,GACnB,MAAM,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,8BAA8B,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;YAC5F,IAAI,CAAC,eAAe,EAAE,CAAC;gBACrB,aAAa,CAAC,IAAI,CAAC;oBACjB,OAAO,EAAE,KAAK;oBACd,OAAO,EAAE;wBACP,KAAK,EAAE,WAAW,SAAS,EAAE;wBAC7B,OAAO,EAAE,oBAAoB,SAAS,YAAY;wBAClD,SAAS;qBACV;iBACF,CAAC,CAAC;gBACH,OAAO;YACT,CAAC;YAED,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,6BAA6B,CAAC,kBAAkB,CACvF,QAAQ,EACR;gBACE,KAAK,EAAE;oBACL,QAAQ,EAAE,QAAQ;oBAClB,SAAS,EAAE,SAAS;oBACpB,GAAG,EAAE,yBAAyB;iBAC/B;aACF,CACF,CAAC;YACF,MAAM,OAAO,GAAG,aAAa,EAAE,KAAK;gBAClC,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,EAAE,EAAE,CAAC;gBACnC,CAAC,CAAC,MAAM,CAAC,gBAAgB,CAAC;YAC5B,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,IAAI,EAAE,CAAC;YAE/B,MAAM,WAAW,GAAG,KAAK,EAAE,OAAmB,EAAE,EAAE;gBAChD,OAAO,OAAO,CAAC,GAAG,CAChB,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;oBACjC,IAAI,CAAC;wBACH,MAAM,aAAa,GAAG,MAAM,EAAE,CAAC;wBAC/B,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAC7C,SAAS,EACT,QAAQ,EACR,WAAW,CAAC,OAAO,EACnB,kBAAkB,CAAC,gBAAgB,EACnC,EAAE,GAAG,EAAE,KAAK,EAAE,EACd,WAAW,EACX,aAAa,CACd,CAAC;wBAEF,aAAa,CAAC,IAAI,CAAC;4BACjB,OAAO,EAAE,WAAW,CAAC,OAAO;4BAC5B,OAAO,EAAE;gCACP,KAAK,EAAE,IAAI,KAAK,IAAI,KAAK,GAAG,KAAK,CAAC,MAAM,GAAG;gCAC3C,OAAO,EAAE,GAAG,WAAW,CAAC,OAAO,EAAE;gCACjC,SAAS;6BACV;yBACF,CAAC,CAAC;oBACL,CAAC;oBAAC,OAAO,KAAK,EAAE,CAAC;wBACf,aAAa,CAAC,IAAI,CAAC;4BACjB,OAAO,EAAE,KAAK;4BACd,OAAO,EAAE;gCACP,KAAK,EAAE,IAAI,KAAK,IAAI,KAAK,GAAG,KAAK,CAAC,MAAM,GAAG;gCAC3C,OAAO,EAAE,GAAG,KAAK,EAAE;gCACnB,SAAS;6BACV;yBACF,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC,CAAC,CACH,CAAC;YACJ,CAAC,CAAC;YAEF,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,MAAM,IAAI,OAAO,EAAE,CAAC;gBAChD,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;YAC5B,CAAC;iBAAM,CAAC;gBACN,MAAM,OAAO,GAAG,EAAE,CAAC;gBACnB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,OAAO,EAAE,CAAC;oBAC9C,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;gBAC3C,CAAC;gBACD,MAAM,WAAW,CAAC,OAAO,CAAC,CAAC;YAC7B,CAAC;QACH,CAAC,CAAC,CACH,CAAC;QAEF,OAAO,aAAa,CAAC;IACvB,CAAC;IAGD,KAAK,CACH,UAAoB,EACpB,OAA6B,EAC7B,WAAoB,EACpB,WAAmB,iBAAiB;QAEpC,MAAM,OAAO,GAAoC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CACrE,IAAI,CAAC,OAAO,CAAC,QAAQ,CACnB,EAAE,EACF,QAAQ,EACR,WAAW,CAAC,OAAO,EACnB,kBAAkB,CAAC,KAAK,EACxB,OAAO,EACP,WAAW,CACZ,CACF,CAAC;QACF,OAAO,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAGD,kBAAkB,CAChB,UAAoB,EACpB,OAA0C,EAC1C,WAAoB,EACpB,WAAmB,iBAAiB;QAEpC,MAAM,OAAO,GAAoC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CACrE,IAAI,CAAC,OAAO,CAAC,QAAQ,CACnB,EAAE,EACF,QAAQ,EACR,WAAW,CAAC,OAAO,EACnB,kBAAkB,CAAC,kBAAkB,EACrC,OAAO,EACP,WAAW,CACZ,CACF,CAAC;QACF,OAAO,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAGD,cAAc,CACZ,UAAoB,EACpB,OAAsC,EACtC,WAAoB,EACpB,WAAmB,iBAAiB;QAEpC,MAAM,OAAO,GAAoC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CACrE,IAAI,CAAC,OAAO,CAAC,QAAQ,CACnB,EAAE,EACF,QAAQ,EACR,WAAW,CAAC,OAAO,EACnB,kBAAkB,CAAC,cAAc,EACjC,OAAO,EACP,WAAW,CACZ,CACF,CAAC;QACF,OAAO,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAGD,YAAY,CACV,UAAoB,EACpB,OAAoC,EACpC,WAAoB,EACpB,WAAmB,iBAAiB;QAEpC,MAAM,OAAO,GAAoC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CACrE,IAAI,CAAC,OAAO,CAAC,QAAQ,CACnB,EAAE,EACF,QAAQ,EACR,WAAW,CAAC,OAAO,EACnB,kBAAkB,CAAC,YAAY,EAC/B,OAAO,EACP,WAAW,CACZ,CACF,CAAC;QACF,OAAO,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACO,cAAc,CAAC,KAAiB;QACxC,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,cAAc,CAAC;QAChF,OAAO,KAAK,CAAC,cAAc,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;IACrD,CAAC;CACF;AAtPO;IADL,iBAAiB,CAAC,kBAAkB,CAAC,cAAc,EAAE,OAAO,CAAC,2BAA2B,CAAC;;;;4DAyBzF;AAMK;IAJL,iBAAiB,CAChB,kBAAkB,CAAC,mBAAmB,EACtC,OAAO,CAAC,gCAAgC,CACzC;;;;iEA+BA;AAGK;IADL,iBAAiB,CAAC,kBAAkB,CAAC,gBAAgB,EAAE,OAAO,CAAC,6BAA6B,CAAC;;;;8DA4F7F;AAGD;IADC,iBAAiB,CAAC,kBAAkB,CAAC,KAAK,EAAE,OAAO,CAAC,kBAAkB,CAAC;;;;mDAkBvE;AAGD;IADC,iBAAiB,CAAC,kBAAkB,CAAC,kBAAkB,EAAE,OAAO,CAAC,+BAA+B,CAAC;;;;gEAkBjG;AAGD;IADC,iBAAiB,CAAC,kBAAkB,CAAC,cAAc,EAAE,OAAO,CAAC,2BAA2B,CAAC;;;;4DAkBzF;AAGD;IADC,iBAAiB,CAAC,kBAAkB,CAAC,YAAY,EAAE,OAAO,CAAC,yBAAyB,CAAC;;;;0DAkBrF"}

package/dist/module/2.0.1/MessageApi.d.ts

@@ -0,0 +1,38 @@
+import type { FastifyInstance } from 'fastify';
+import type { ILogObj } from 'tslog';
+import { Logger } from 'tslog';
+import type { IConfigurationModuleApi } from '../interface.js';
+import { ConfigurationModule } from '../module.js';
+import type { CallAction, IMessageConfirmation } from '@citrineos/base';
+import { AbstractModuleApi, OCPP2_0_1 } from '@citrineos/base';
+/**
+ * Server API for the Configuration component.
+ */
+export declare class ConfigurationOcpp201Api 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>);
+    setNetworkProfile(identifier: string[], request: OCPP2_0_1.SetNetworkProfileRequest, callbackUrl?: string, extraQueries?: Record<string, any>, tenantId?: number): Promise<IMessageConfirmation[]>;
+    clearDisplayMessage(identifier: string[], request: OCPP2_0_1.ClearDisplayMessageRequest, callbackUrl?: string, tenantId?: number): Promise<IMessageConfirmation[]>;
+    getDisplayMessages(identifier: string[], request: OCPP2_0_1.GetDisplayMessagesRequest, callbackUrl?: string, tenantId?: number): Promise<IMessageConfirmation[]>;
+    publishFirmware(identifier: string[], request: OCPP2_0_1.PublishFirmwareRequest, callbackUrl?: string, tenantId?: number): Promise<IMessageConfirmation[]>;
+    setDisplayMessage(identifier: string[], request: OCPP2_0_1.SetDisplayMessageRequest, callbackUrl?: string, tenantId?: number): Promise<IMessageConfirmation[]>;
+    unpublishFirmware(identifier: string[], request: OCPP2_0_1.UnpublishFirmwareRequest, callbackUrl?: string, tenantId?: number): Promise<IMessageConfirmation[]>;
+    updateFirmware(identifier: string[], request: OCPP2_0_1.UpdateFirmwareRequest, callbackUrl?: string, tenantId?: number): Promise<IMessageConfirmation[]>;
+    reset(identifier: string[], request: OCPP2_0_1.ResetRequest, callbackUrl?: string, tenantId?: number): Promise<IMessageConfirmation[]>;
+    changeAvailability(identifier: string[], request: OCPP2_0_1.ChangeAvailabilityRequest, callbackUrl?: string, tenantId?: number): Promise<IMessageConfirmation[]>;
+    triggerMessage(identifier: string[], request: OCPP2_0_1.TriggerMessageRequest, callbackUrl?: string, tenantId?: number): Promise<IMessageConfirmation[]>;
+    dataTransfer(identifier: string[], request: OCPP2_0_1.DataTransferRequest, callbackUrl?: string, tenantId?: number): Promise<IMessageConfirmation[]>;
+    /**
+     * Overrides superclass method to generate the URL path based on the input {@link CallAction} and the module's endpoint prefix configuration.
+     *
+     * @param {CallAction} input - The input {@link CallAction}.
+     * @return {string} - The generated URL path.
+     */
+    protected _toMessagePath(input: CallAction): string;
+}

package/dist/module/2.0.1/MessageApi.js

@@ -0,0 +1,183 @@
+// 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, AsMessageEndpoint, DEFAULT_TENANT_ID, OCPP2_0_1, OCPP2_0_1_CallAction, OCPPVersion, } from '@citrineos/base';
+import { SetNetworkProfile } from '@citrineos/data';
+import { validateLanguageTag } from '@citrineos/util';
+import { v4 as uuidv4 } from 'uuid';
+var SetNetworkProfileExtraQuerystrings;
+(function (SetNetworkProfileExtraQuerystrings) {
+    SetNetworkProfileExtraQuerystrings["websocketServerConfigId"] = "websocketServerConfigId";
+})(SetNetworkProfileExtraQuerystrings || (SetNetworkProfileExtraQuerystrings = {}));
+/**
+ * Server API for the Configuration component.
+ */
+export class ConfigurationOcpp201Api 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, OCPPVersion.OCPP2_0_1, logger);
+    }
+    async setNetworkProfile(identifier, request, callbackUrl, extraQueries, tenantId = DEFAULT_TENANT_ID) {
+        const correlationId = uuidv4();
+        if (extraQueries) {
+            const websocketServerConfigId = extraQueries[SetNetworkProfileExtraQuerystrings.websocketServerConfigId];
+            await SetNetworkProfile.build({
+                stationId: identifier,
+                tenantId,
+                correlationId,
+                configurationSlot: request.configurationSlot,
+                websocketServerConfigId,
+                apn: JSON.stringify(request.connectionData.apn),
+                vpn: JSON.stringify(request.connectionData.vpn),
+                ...request.connectionData,
+            }).save();
+        }
+        const results = identifier.map((id) => this._module.sendCall(id, tenantId, OCPPVersion.OCPP2_0_1, OCPP2_0_1_CallAction.SetNetworkProfile, request, callbackUrl, correlationId));
+        return Promise.all(results);
+    }
+    clearDisplayMessage(identifier, request, callbackUrl, tenantId = DEFAULT_TENANT_ID) {
+        const results = identifier.map((id) => this._module.sendCall(id, tenantId, OCPPVersion.OCPP2_0_1, OCPP2_0_1_CallAction.ClearDisplayMessage, request, callbackUrl));
+        return Promise.all(results);
+    }
+    getDisplayMessages(identifier, request, callbackUrl, tenantId = DEFAULT_TENANT_ID) {
+        const results = identifier.map((id) => this._module.sendCall(id, tenantId, OCPPVersion.OCPP2_0_1, OCPP2_0_1_CallAction.GetDisplayMessages, request, callbackUrl));
+        return Promise.all(results);
+    }
+    publishFirmware(identifier, request, callbackUrl, tenantId = DEFAULT_TENANT_ID) {
+        const results = identifier.map((id) => this._module.sendCall(id, tenantId, OCPPVersion.OCPP2_0_1, OCPP2_0_1_CallAction.PublishFirmware, request, callbackUrl));
+        return Promise.all(results);
+    }
+    async setDisplayMessage(identifier, request, callbackUrl, tenantId = DEFAULT_TENANT_ID) {
+        const messageInfo = request.message;
+        const languageTag = messageInfo.message.language;
+        if (languageTag && !validateLanguageTag(languageTag)) {
+            const errorMsg = 'Language shall be specified as RFC-5646 tags, example: en-US for US English.';
+            this._logger.error(errorMsg);
+            return [{ success: false, payload: errorMsg }];
+        }
+        // If omitted, startDateTime defaults to "now".
+        if (!messageInfo.startDateTime) {
+            messageInfo.startDateTime = new Date().toISOString();
+        }
+        const results = identifier.map((id) => this._module.sendCall(id, tenantId, OCPPVersion.OCPP2_0_1, OCPP2_0_1_CallAction.SetDisplayMessage, request, callbackUrl));
+        return Promise.all(results);
+    }
+    unpublishFirmware(identifier, request, callbackUrl, tenantId = DEFAULT_TENANT_ID) {
+        const results = identifier.map((id) => this._module.sendCall(id, tenantId, OCPPVersion.OCPP2_0_1, OCPP2_0_1_CallAction.UnpublishFirmware, request, callbackUrl));
+        return Promise.all(results);
+    }
+    updateFirmware(identifier, request, callbackUrl, tenantId = DEFAULT_TENANT_ID) {
+        const results = identifier.map((id) => this._module.sendCall(id, tenantId, OCPPVersion.OCPP2_0_1, OCPP2_0_1_CallAction.UpdateFirmware, request, callbackUrl));
+        return Promise.all(results);
+    }
+    reset(identifier, request, callbackUrl, tenantId = DEFAULT_TENANT_ID) {
+        const results = identifier.map((id) => this._module.sendCall(id, tenantId, OCPPVersion.OCPP2_0_1, OCPP2_0_1_CallAction.Reset, request, callbackUrl));
+        return Promise.all(results);
+    }
+    changeAvailability(identifier, request, callbackUrl, tenantId = DEFAULT_TENANT_ID) {
+        const results = identifier.map((id) => this._module.sendCall(id, tenantId, OCPPVersion.OCPP2_0_1, OCPP2_0_1_CallAction.ChangeAvailability, request, callbackUrl));
+        return Promise.all(results);
+    }
+    triggerMessage(identifier, request, callbackUrl, tenantId = DEFAULT_TENANT_ID) {
+        const results = identifier.map((id) => this._module.sendCall(id, tenantId, OCPPVersion.OCPP2_0_1, OCPP2_0_1_CallAction.TriggerMessage, request, callbackUrl));
+        return Promise.all(results);
+    }
+    dataTransfer(identifier, request, callbackUrl, tenantId = DEFAULT_TENANT_ID) {
+        const results = identifier.map((id) => this._module.sendCall(id, tenantId, OCPPVersion.OCPP2_0_1, OCPP2_0_1_CallAction.DataTransfer, request, callbackUrl));
+        return Promise.all(results);
+    }
+    /**
+     * Overrides superclass method to generate the URL path based on the input {@link CallAction} and the module's endpoint prefix configuration.
+     *
+     * @param {CallAction} input - The input {@link CallAction}.
+     * @return {string} - The generated URL path.
+     */
+    _toMessagePath(input) {
+        const endpointPrefix = this._module.config.modules.configuration.endpointPrefix;
+        return super._toMessagePath(input, endpointPrefix);
+    }
+}
+__decorate([
+    AsMessageEndpoint(OCPP2_0_1_CallAction.SetNetworkProfile, OCPP2_0_1.SetNetworkProfileRequestSchema, { websocketServerConfigId: { type: 'string' } }),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Array, Object, String, Object, Number]),
+    __metadata("design:returntype", Promise)
+], ConfigurationOcpp201Api.prototype, "setNetworkProfile", null);
+__decorate([
+    AsMessageEndpoint(OCPP2_0_1_CallAction.ClearDisplayMessage, OCPP2_0_1.ClearDisplayMessageRequestSchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Array, Object, String, Number]),
+    __metadata("design:returntype", Promise)
+], ConfigurationOcpp201Api.prototype, "clearDisplayMessage", null);
+__decorate([
+    AsMessageEndpoint(OCPP2_0_1_CallAction.GetDisplayMessages, OCPP2_0_1.GetDisplayMessagesRequestSchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Array, Object, String, Number]),
+    __metadata("design:returntype", Promise)
+], ConfigurationOcpp201Api.prototype, "getDisplayMessages", null);
+__decorate([
+    AsMessageEndpoint(OCPP2_0_1_CallAction.PublishFirmware, OCPP2_0_1.PublishFirmwareRequestSchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Array, Object, String, Number]),
+    __metadata("design:returntype", Promise)
+], ConfigurationOcpp201Api.prototype, "publishFirmware", null);
+__decorate([
+    AsMessageEndpoint(OCPP2_0_1_CallAction.SetDisplayMessage, OCPP2_0_1.SetDisplayMessageRequestSchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Array, Object, String, Number]),
+    __metadata("design:returntype", Promise)
+], ConfigurationOcpp201Api.prototype, "setDisplayMessage", null);
+__decorate([
+    AsMessageEndpoint(OCPP2_0_1_CallAction.UnpublishFirmware, OCPP2_0_1.UnpublishFirmwareRequestSchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Array, Object, String, Number]),
+    __metadata("design:returntype", Promise)
+], ConfigurationOcpp201Api.prototype, "unpublishFirmware", null);
+__decorate([
+    AsMessageEndpoint(OCPP2_0_1_CallAction.UpdateFirmware, OCPP2_0_1.UpdateFirmwareRequestSchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Array, Object, String, Number]),
+    __metadata("design:returntype", Promise)
+], ConfigurationOcpp201Api.prototype, "updateFirmware", null);
+__decorate([
+    AsMessageEndpoint(OCPP2_0_1_CallAction.Reset, OCPP2_0_1.ResetRequestSchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Array, Object, String, Number]),
+    __metadata("design:returntype", Promise)
+], ConfigurationOcpp201Api.prototype, "reset", null);
+__decorate([
+    AsMessageEndpoint(OCPP2_0_1_CallAction.ChangeAvailability, OCPP2_0_1.ChangeAvailabilityRequestSchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Array, Object, String, Number]),
+    __metadata("design:returntype", Promise)
+], ConfigurationOcpp201Api.prototype, "changeAvailability", null);
+__decorate([
+    AsMessageEndpoint(OCPP2_0_1_CallAction.TriggerMessage, OCPP2_0_1.TriggerMessageRequestSchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Array, Object, String, Number]),
+    __metadata("design:returntype", Promise)
+], ConfigurationOcpp201Api.prototype, "triggerMessage", null);
+__decorate([
+    AsMessageEndpoint(OCPP2_0_1_CallAction.DataTransfer, OCPP2_0_1.DataTransferRequestSchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Array, Object, String, Number]),
+    __metadata("design:returntype", Promise)
+], ConfigurationOcpp201Api.prototype, "dataTransfer", null);
+//# sourceMappingURL=MessageApi.js.map

package/dist/module/2.0.1/MessageApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MessageApi.js","sourceRoot":"","sources":["../../../src/module/2.0.1/MessageApi.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,EAAE;AACF,sCAAsC;;;;;;;;;;AAItC,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAEnD,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EACjB,iBAAiB,EACjB,SAAS,EACT,oBAAoB,EACpB,WAAW,GACZ,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AAEpC,IAAK,kCAEJ;AAFD,WAAK,kCAAkC;IACrC,yFAAmD,CAAA;AACrD,CAAC,EAFI,kCAAkC,KAAlC,kCAAkC,QAEtC;AAED;;GAEG;AACH,MAAM,OAAO,uBACX,SAAQ,iBAAsC;IAG9C;;;;;;OAMG;IACH,YACE,sBAA2C,EAC3C,MAAuB,EACvB,MAAwB;QAExB,KAAK,CAAC,sBAAsB,EAAE,MAAM,EAAE,WAAW,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IACvE,CAAC;IAOK,AAAN,KAAK,CAAC,iBAAiB,CACrB,UAAoB,EACpB,OAA2C,EAC3C,WAAoB,EACpB,YAAkC,EAClC,WAAmB,iBAAiB;QAEpC,MAAM,aAAa,GAAG,MAAM,EAAE,CAAC;QAC/B,IAAI,YAAY,EAAE,CAAC;YACjB,MAAM,uBAAuB,GAC3B,YAAY,CAAC,kCAAkC,CAAC,uBAAuB,CAAC,CAAC;YAC3E,MAAM,iBAAiB,CAAC,KAAK,CAAC;gBAC5B,SAAS,EAAE,UAAU;gBACrB,QAAQ;gBACR,aAAa;gBACb,iBAAiB,EAAE,OAAO,CAAC,iBAAiB;gBAC5C,uBAAuB;gBACvB,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC;gBAC/C,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC;gBAC/C,GAAG,OAAO,CAAC,cAAc;aAC1B,CAAC,CAAC,IAAI,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,OAAO,GAAoC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CACrE,IAAI,CAAC,OAAO,CAAC,QAAQ,CACnB,EAAE,EACF,QAAQ,EACR,WAAW,CAAC,SAAS,EACrB,oBAAoB,CAAC,iBAAiB,EACtC,OAAO,EACP,WAAW,EACX,aAAa,CACd,CACF,CAAC;QACF,OAAO,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAMD,mBAAmB,CACjB,UAAoB,EACpB,OAA6C,EAC7C,WAAoB,EACpB,WAAmB,iBAAiB;QAEpC,MAAM,OAAO,GAAoC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CACrE,IAAI,CAAC,OAAO,CAAC,QAAQ,CACnB,EAAE,EACF,QAAQ,EACR,WAAW,CAAC,SAAS,EACrB,oBAAoB,CAAC,mBAAmB,EACxC,OAAO,EACP,WAAW,CACZ,CACF,CAAC;QACF,OAAO,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAMD,kBAAkB,CAChB,UAAoB,EACpB,OAA4C,EAC5C,WAAoB,EACpB,WAAmB,iBAAiB;QAEpC,MAAM,OAAO,GAAoC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CACrE,IAAI,CAAC,OAAO,CAAC,QAAQ,CACnB,EAAE,EACF,QAAQ,EACR,WAAW,CAAC,SAAS,EACrB,oBAAoB,CAAC,kBAAkB,EACvC,OAAO,EACP,WAAW,CACZ,CACF,CAAC;QACF,OAAO,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAGD,eAAe,CACb,UAAoB,EACpB,OAAyC,EACzC,WAAoB,EACpB,WAAmB,iBAAiB;QAEpC,MAAM,OAAO,GAAoC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CACrE,IAAI,CAAC,OAAO,CAAC,QAAQ,CACnB,EAAE,EACF,QAAQ,EACR,WAAW,CAAC,SAAS,EACrB,oBAAoB,CAAC,eAAe,EACpC,OAAO,EACP,WAAW,CACZ,CACF,CAAC;QACF,OAAO,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAMK,AAAN,KAAK,CAAC,iBAAiB,CACrB,UAAoB,EACpB,OAA2C,EAC3C,WAAoB,EACpB,WAAmB,iBAAiB;QAEpC,MAAM,WAAW,GAAG,OAAO,CAAC,OAAoC,CAAC;QAEjE,MAAM,WAAW,GAAG,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC;QACjD,IAAI,WAAW,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,EAAE,CAAC;YACrD,MAAM,QAAQ,GACZ,8EAA8E,CAAC;YACjF,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YAC7B,OAAO,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;QACjD,CAAC;QAED,+CAA+C;QAC/C,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE,CAAC;YAC/B,WAAW,CAAC,aAAa,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QACvD,CAAC;QAED,MAAM,OAAO,GAAoC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CACrE,IAAI,CAAC,OAAO,CAAC,QAAQ,CACnB,EAAE,EACF,QAAQ,EACR,WAAW,CAAC,SAAS,EACrB,oBAAoB,CAAC,iBAAiB,EACtC,OAAO,EACP,WAAW,CACZ,CACF,CAAC;QACF,OAAO,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAMD,iBAAiB,CACf,UAAoB,EACpB,OAA2C,EAC3C,WAAoB,EACpB,WAAmB,iBAAiB;QAEpC,MAAM,OAAO,GAAoC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CACrE,IAAI,CAAC,OAAO,CAAC,QAAQ,CACnB,EAAE,EACF,QAAQ,EACR,WAAW,CAAC,SAAS,EACrB,oBAAoB,CAAC,iBAAiB,EACtC,OAAO,EACP,WAAW,CACZ,CACF,CAAC;QACF,OAAO,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAGD,cAAc,CACZ,UAAoB,EACpB,OAAwC,EACxC,WAAoB,EACpB,WAAmB,iBAAiB;QAEpC,MAAM,OAAO,GAAoC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CACrE,IAAI,CAAC,OAAO,CAAC,QAAQ,CACnB,EAAE,EACF,QAAQ,EACR,WAAW,CAAC,SAAS,EACrB,oBAAoB,CAAC,cAAc,EACnC,OAAO,EACP,WAAW,CACZ,CACF,CAAC;QACF,OAAO,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAGD,KAAK,CACH,UAAoB,EACpB,OAA+B,EAC/B,WAAoB,EACpB,WAAmB,iBAAiB;QAEpC,MAAM,OAAO,GAAoC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CACrE,IAAI,CAAC,OAAO,CAAC,QAAQ,CACnB,EAAE,EACF,QAAQ,EACR,WAAW,CAAC,SAAS,EACrB,oBAAoB,CAAC,KAAK,EAC1B,OAAO,EACP,WAAW,CACZ,CACF,CAAC;QACF,OAAO,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAMD,kBAAkB,CAChB,UAAoB,EACpB,OAA4C,EAC5C,WAAoB,EACpB,WAAmB,iBAAiB;QAEpC,MAAM,OAAO,GAAoC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CACrE,IAAI,CAAC,OAAO,CAAC,QAAQ,CACnB,EAAE,EACF,QAAQ,EACR,WAAW,CAAC,SAAS,EACrB,oBAAoB,CAAC,kBAAkB,EACvC,OAAO,EACP,WAAW,CACZ,CACF,CAAC;QACF,OAAO,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAGD,cAAc,CACZ,UAAoB,EACpB,OAAwC,EACxC,WAAoB,EACpB,WAAmB,iBAAiB;QAEpC,MAAM,OAAO,GAAoC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CACrE,IAAI,CAAC,OAAO,CAAC,QAAQ,CACnB,EAAE,EACF,QAAQ,EACR,WAAW,CAAC,SAAS,EACrB,oBAAoB,CAAC,cAAc,EACnC,OAAO,EACP,WAAW,CACZ,CACF,CAAC;QACF,OAAO,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAGD,YAAY,CACV,UAAoB,EACpB,OAAsC,EACtC,WAAoB,EACpB,WAAmB,iBAAiB;QAEpC,MAAM,OAAO,GAAoC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CACrE,IAAI,CAAC,OAAO,CAAC,QAAQ,CACnB,EAAE,EACF,QAAQ,EACR,WAAW,CAAC,SAAS,EACrB,oBAAoB,CAAC,YAAY,EACjC,OAAO,EACP,WAAW,CACZ,CACF,CAAC;QACF,OAAO,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACO,cAAc,CAAC,KAAiB;QACxC,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,cAAc,CAAC;QAChF,OAAO,KAAK,CAAC,cAAc,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;IACrD,CAAC;CACF;AArRO;IALL,iBAAiB,CAChB,oBAAoB,CAAC,iBAAiB,EACtC,SAAS,CAAC,8BAA8B,EACxC,EAAE,uBAAuB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,CAChD;;;;gEAoCA;AAMD;IAJC,iBAAiB,CAChB,oBAAoB,CAAC,mBAAmB,EACxC,SAAS,CAAC,gCAAgC,CAC3C;;;;kEAkBA;AAMD;IAJC,iBAAiB,CAChB,oBAAoB,CAAC,kBAAkB,EACvC,SAAS,CAAC,+BAA+B,CAC1C;;;;iEAkBA;AAGD;IADC,iBAAiB,CAAC,oBAAoB,CAAC,eAAe,EAAE,SAAS,CAAC,4BAA4B,CAAC;;;;8DAkB/F;AAMK;IAJL,iBAAiB,CAChB,oBAAoB,CAAC,iBAAiB,EACtC,SAAS,CAAC,8BAA8B,CACzC;;;;gEAiCA;AAMD;IAJC,iBAAiB,CAChB,oBAAoB,CAAC,iBAAiB,EACtC,SAAS,CAAC,8BAA8B,CACzC;;;;gEAkBA;AAGD;IADC,iBAAiB,CAAC,oBAAoB,CAAC,cAAc,EAAE,SAAS,CAAC,2BAA2B,CAAC;;;;6DAkB7F;AAGD;IADC,iBAAiB,CAAC,oBAAoB,CAAC,KAAK,EAAE,SAAS,CAAC,kBAAkB,CAAC;;;;oDAkB3E;AAMD;IAJC,iBAAiB,CAChB,oBAAoB,CAAC,kBAAkB,EACvC,SAAS,CAAC,+BAA+B,CAC1C;;;;iEAkBA;AAGD;IADC,iBAAiB,CAAC,oBAAoB,CAAC,cAAc,EAAE,SAAS,CAAC,2BAA2B,CAAC;;;;6DAkB7F;AAGD;IADC,iBAAiB,CAAC,oBAAoB,CAAC,YAAY,EAAE,SAAS,CAAC,yBAAyB,CAAC;;;;2DAkBzF"}

package/dist/module/BootNotificationService.d.ts

@@ -0,0 +1,57 @@
+import type { IBootRepository } from '@citrineos/data';
+import { Boot } from '@citrineos/data';
+import type { BootConfig, ICache, IMessageConfirmation, SystemConfig } from '@citrineos/base';
+import { OCPP1_6, OCPP2_0_1 } from '@citrineos/base';
+import type { ILogObj } from 'tslog';
+import { Logger } from 'tslog';
+type Configuration = SystemConfig['modules']['configuration'];
+export declare class BootNotificationService {
+    protected _bootRepository: IBootRepository;
+    protected _cache: ICache;
+    protected _logger: Logger<ILogObj>;
+    protected _config: Configuration;
+    constructor(bootRepository: IBootRepository, cache: ICache, config: Configuration, logger?: Logger<ILogObj>);
+    determineBootStatus(bootConfig: Boot | undefined): OCPP2_0_1.RegistrationStatusEnumType;
+    createBootNotificationResponse(tenantId: number, stationId: string): Promise<OCPP2_0_1.BootNotificationResponse>;
+    updateBootConfig(bootNotificationResponse: OCPP2_0_1.BootNotificationResponse, tenantId: number, stationId: string): Promise<Boot>;
+    /**
+     * 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
+     */
+    cacheChargerActionsPermissions(stationId: string, cachedBootStatus: OCPP2_0_1.RegistrationStatusEnumType | null, bootNotificationResponseStatus: OCPP2_0_1.RegistrationStatusEnumType): Promise<void>;
+    createGetBaseReportRequest(stationId: string, maxCachingSeconds: number): Promise<OCPP2_0_1.GetBaseReportRequest>;
+    /**
+     * 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
+     */
+    confirmGetBaseReportSuccess(stationId: string, requestId: string, getBaseReportMessageConfirmation: IMessageConfirmation, maxCachingSeconds: number): Promise<void>;
+    /**
+     * Methods for OCPP 1.6
+     */
+    determineOcpp16BootStatus(bootConfig: BootConfig | undefined): OCPP1_6.BootNotificationResponseStatus;
+    createOcpp16BootNotificationResponse(tenantId: number, stationId: string): Promise<OCPP1_6.BootNotificationResponse>;
+    /**
+     * 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
+     */
+    cacheOcpp16ChargerActionsPermissions(stationId: string, cachedBootStatus: OCPP1_6.BootNotificationResponseStatus | null, bootNotificationResponseStatus: OCPP1_6.BootNotificationResponseStatus): Promise<void>;
+    updateOcpp16BootConfig(response: OCPP1_6.BootNotificationResponse, tenantId: number, stationId: string): Promise<Boot>;
+}
+export {};