@zetra/citrineos-ocpprouter 1.8.3-fork.1

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { AdminApi } from './module/DataApi.js';
+export type { IAdminApi } from './module/interface.js';
+export { MessageRouterImpl } from './module/router.js';
+export { WebhookDispatcher } from './module/webhook.dispatcher.js';

package/dist/index.js

@@ -0,0 +1,7 @@
+// SPDX-FileCopyrightText: 2025 Contributors to the CitrineOS Project
+//
+// SPDX-License-Identifier: Apache-2.0
+export { AdminApi } from './module/DataApi.js';
+export { MessageRouterImpl } from './module/router.js';
+export { WebhookDispatcher } from './module/webhook.dispatcher.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,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAE/C,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC"}

package/dist/module/DataApi.d.ts

@@ -0,0 +1,88 @@
+import type { BootstrapConfig, IMessageRouter, INetworkConnection, SystemConfig, WebsocketServerConfig } from '@citrineos/base';
+import { AbstractModuleApi, Namespace, OCPP1_6_Namespace, OCPP2_0_1_Namespace } from '@citrineos/base';
+import type { ChargingStationKeyQuerystring, ConnectionDeleteQuerystring, IServerNetworkProfileRepository, ISubscriptionRepository, ModelKeyQuerystring, TenantQueryString, WebsocketDeleteQuerystring, WebsocketGetQuerystring, WebsocketMappingQuerystring } from '@citrineos/data';
+import { Subscription } from '@citrineos/data';
+import type { FastifyInstance, FastifyRequest } from 'fastify';
+import type { ILogObj } from 'tslog';
+import { Logger } from 'tslog';
+import type { IAdminApi } from './interface.js';
+/**
+ * Admin API for the OcppRouter.
+ */
+export declare class AdminApi extends AbstractModuleApi<IMessageRouter> implements IAdminApi {
+    private _networkConnection;
+    private _subscriptionRepository;
+    private _serverNetworkProfileRepository;
+    /**
+     * Constructs a new instance of the class.
+     *
+     * @param {IMessageRouter} ocppRouter - The OcppRouter module.
+     * @param {INetworkConnection} networkConnection - The network connection instance.
+     * @param {FastifyInstance} server - The Fastify server instance.
+     * @param {BootstrapConfig & SystemConfig} config - The configuration instance.
+     * @param {Logger<ILogObj>} [logger] - The logger instance.
+     * @param {ISubscriptionRepository} [subscriptionRepository] - The subscription repository instance.
+     * @param {IServerNetworkProfileRepository} [serverNetworkProfileRepository] - The server network profile repository instance.
+     */
+    constructor(ocppRouter: IMessageRouter, networkConnection: INetworkConnection, server: FastifyInstance, config: BootstrapConfig & SystemConfig, logger?: Logger<ILogObj>, subscriptionRepository?: ISubscriptionRepository, serverNetworkProfileRepository?: IServerNetworkProfileRepository);
+    /**
+     * Creates a {@link Subscription}.
+     * Will always create a new entity and return its id.
+     *
+     * @param {FastifyRequest<{ Body: Subscription }>} request - The request object, containing the body which is parsed as a {@link Subscription}.
+     * @return {Promise<number>} The id of the created subscription.
+     */
+    postSubscription(request: FastifyRequest<{
+        Body: Subscription;
+        Querystring: TenantQueryString;
+    }>): Promise<number>;
+    getSubscriptionsByChargingStation(request: FastifyRequest<{
+        Querystring: ChargingStationKeyQuerystring;
+    }>): Promise<Subscription[]>;
+    deleteSubscriptionById(request: FastifyRequest<{
+        Querystring: ModelKeyQuerystring;
+    }>): Promise<boolean>;
+    getWebsocketConfigurations(request: FastifyRequest<{
+        Querystring: WebsocketGetQuerystring;
+    }>): Promise<WebsocketServerConfig[] | WebsocketServerConfig>;
+    createWebsocketConfiguration(request: FastifyRequest<{
+        Body: WebsocketServerConfig;
+    }>): Promise<WebsocketServerConfig>;
+    /**
+     * Adds or updates a mapping from a path segment to a tenant for a specific websocket server.
+     */
+    putWebsocketMapping(request: FastifyRequest<{
+        Body: {
+            path: string;
+            tenantId: number;
+        };
+        Querystring: WebsocketMappingQuerystring;
+    }>): Promise<WebsocketServerConfig>;
+    /**
+     * Removes a mapping for a specific path OR all mappings for a specific tenant from a websocket server.
+     */
+    deleteWebsocketMapping(request: FastifyRequest<{
+        Querystring: WebsocketMappingQuerystring & {
+            path?: string;
+            tenantId?: number;
+        };
+    }>): Promise<WebsocketServerConfig>;
+    /**
+     * Helper to validate internal system calls
+     */
+    private _validateSystemToken;
+    deleteWebsocketConfiguration(request: FastifyRequest<{
+        Querystring: WebsocketDeleteQuerystring;
+    }>): Promise<void>;
+    deleteWebsocketConnection(request: FastifyRequest<{
+        Querystring: ConnectionDeleteQuerystring;
+    }>): Promise<void>;
+    /**
+     * 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;
+}

package/dist/module/DataApi.js

@@ -0,0 +1,248 @@
+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 { AbstractModuleApi, AsDataEndpoint, BadRequestError, ConfigStoreFactory, DEFAULT_TENANT_ID, HttpMethod, Namespace, NotFoundError, OCPP1_6_Namespace, OCPP2_0_1_Namespace, UnauthorizedError, } from '@citrineos/base';
+import { ChargingStationKeyQuerySchema, ConnectionDeleteQuerySchema, CreateSubscriptionSchema, ModelKeyQuerystringSchema, sequelize, Subscription, TenantQuerySchema, WebsocketDeleteQuerySchema, WebsocketGetQuerySchema, WebsocketRequestSchema, WebsocketMappingQuerySchema, WebsocketMappingRequestSchema, } from '@citrineos/data';
+import { Logger } from 'tslog';
+/**
+ * Admin API for the OcppRouter.
+ */
+export class AdminApi extends AbstractModuleApi {
+    _networkConnection;
+    _subscriptionRepository;
+    _serverNetworkProfileRepository;
+    /**
+     * Constructs a new instance of the class.
+     *
+     * @param {IMessageRouter} ocppRouter - The OcppRouter module.
+     * @param {INetworkConnection} networkConnection - The network connection instance.
+     * @param {FastifyInstance} server - The Fastify server instance.
+     * @param {BootstrapConfig & SystemConfig} config - The configuration instance.
+     * @param {Logger<ILogObj>} [logger] - The logger instance.
+     * @param {ISubscriptionRepository} [subscriptionRepository] - The subscription repository instance.
+     * @param {IServerNetworkProfileRepository} [serverNetworkProfileRepository] - The server network profile repository instance.
+     */
+    constructor(ocppRouter, networkConnection, server, config, logger, subscriptionRepository, serverNetworkProfileRepository) {
+        super(ocppRouter, server, null, logger);
+        this._networkConnection = networkConnection;
+        this._subscriptionRepository =
+            subscriptionRepository || new sequelize.SequelizeSubscriptionRepository(config, this._logger);
+        this._serverNetworkProfileRepository =
+            serverNetworkProfileRepository ||
+                new sequelize.SequelizeServerNetworkProfileRepository(config, this._logger);
+    }
+    // N.B.: When adding subscriptions, chargers may be connected to a different instance of Citrine.
+    // If this is the case, new subscriptions will not take effect until the charger reconnects.
+    /**
+     * Creates a {@link Subscription}.
+     * Will always create a new entity and return its id.
+     *
+     * @param {FastifyRequest<{ Body: Subscription }>} request - The request object, containing the body which is parsed as a {@link Subscription}.
+     * @return {Promise<number>} The id of the created subscription.
+     */
+    async postSubscription(request) {
+        const tenantId = request.query.tenantId;
+        request.body.tenantId = tenantId;
+        if (!request.body.onClose &&
+            !request.body.onConnect &&
+            !request.body.onMessage &&
+            !request.body.sentMessage) {
+            throw new BadRequestError('Must specify at least one of onConnect, onClose, onMessage, sentMessage to true.');
+        }
+        return this._subscriptionRepository
+            .create(tenantId, request.body)
+            .then((subscription) => subscription?.id);
+    }
+    async getSubscriptionsByChargingStation(request) {
+        return this._subscriptionRepository.readAllByStationId(request.query.tenantId, request.query.stationId);
+    }
+    async deleteSubscriptionById(request) {
+        const tenantId = request.query.tenantId ?? DEFAULT_TENANT_ID;
+        return this._subscriptionRepository
+            .deleteByKey(tenantId, request.query.id.toString())
+            .then(() => true);
+    }
+    async getWebsocketConfigurations(request) {
+        if (request.query.id) {
+            const websocketConfig = this._module.config.util.networkConnection.websocketServers.find((ws) => ws.id === request.query.id);
+            if (!websocketConfig) {
+                throw new NotFoundError(`Could not find websocket configuration with id ${request.query.id}`);
+            }
+            else {
+                return websocketConfig;
+            }
+        }
+        else {
+            // TODO when available (coming soon in a separate feature), filter by tenantId if the tenantId query param exists
+            return this._module.config.util.networkConnection.websocketServers;
+        }
+    }
+    async createWebsocketConfiguration(request) {
+        const existingConfig = this._module.config.util.networkConnection.websocketServers.find((ws) => ws.id === request.body.id);
+        if (existingConfig) {
+            throw new BadRequestError(`Websocket configuration with id ${request.body.id} already exists.`);
+        }
+        else {
+            this._module.config.util.networkConnection.websocketServers.push(request.body);
+            await ConfigStoreFactory.getInstance().saveConfig(this._module.config);
+            return request.body;
+        }
+    }
+    /**
+     * Adds or updates a mapping from a path segment to a tenant for a specific websocket server.
+     */
+    async putWebsocketMapping(request) {
+        this._validateSystemToken(request);
+        const serverId = request.query.id;
+        const { path, tenantId } = request.body;
+        const websocketConfig = this._module.config.util.networkConnection.websocketServers.find((ws) => ws.id === serverId);
+        if (!websocketConfig) {
+            throw new NotFoundError(`Websocket configuration with id ${serverId} not found`);
+        }
+        if (!websocketConfig.tenantPathMapping) {
+            websocketConfig.tenantPathMapping = {};
+        }
+        if (websocketConfig.tenantPathMapping[path] !== undefined &&
+            websocketConfig.tenantPathMapping[path] !== tenantId) {
+            throw new BadRequestError(`Path ${path} is already mapped to tenant ${websocketConfig.tenantPathMapping[path]}`);
+        }
+        websocketConfig.tenantPathMapping[path] = tenantId;
+        websocketConfig.dynamicTenantResolution = true;
+        await ConfigStoreFactory.getInstance().saveConfig(this._module.config);
+        await this._serverNetworkProfileRepository.upsertServerNetworkProfile(websocketConfig, this._module.config.maxCallLengthSeconds);
+        return websocketConfig;
+    }
+    /**
+     * Removes a mapping for a specific path OR all mappings for a specific tenant from a websocket server.
+     */
+    async deleteWebsocketMapping(request) {
+        this._validateSystemToken(request);
+        const serverId = request.query.id;
+        const path = request.query.path;
+        const tenantId = request.query.tenantId;
+        if (!path && !tenantId) {
+            throw new BadRequestError('Either path or tenantId is required to delete a mapping');
+        }
+        const websocketConfig = this._module.config.util.networkConnection.websocketServers.find((ws) => ws.id === serverId);
+        if (!websocketConfig) {
+            throw new NotFoundError(`Websocket configuration with id ${serverId} not found`);
+        }
+        if (websocketConfig.tenantPathMapping) {
+            let changed = false;
+            if (path && websocketConfig.tenantPathMapping[path] !== undefined) {
+                delete websocketConfig.tenantPathMapping[path];
+                changed = true;
+            }
+            else if (tenantId) {
+                const tenantIdNum = Number(tenantId);
+                for (const [key, value] of Object.entries(websocketConfig.tenantPathMapping)) {
+                    if (value === tenantIdNum) {
+                        delete websocketConfig.tenantPathMapping[key];
+                        changed = true;
+                    }
+                }
+            }
+            if (changed) {
+                await ConfigStoreFactory.getInstance().saveConfig(this._module.config);
+                await this._serverNetworkProfileRepository.upsertServerNetworkProfile(websocketConfig, this._module.config.maxCallLengthSeconds);
+            }
+        }
+        return websocketConfig;
+    }
+    /**
+     * Helper to validate internal system calls
+     */
+    _validateSystemToken(request) {
+        const systemToken = this._module.config.centralSystem.systemApiToken;
+        if (!systemToken) {
+            return;
+        }
+        const providedToken = request.headers['x-system-token'];
+        if (providedToken !== systemToken) {
+            throw new UnauthorizedError('Invalid or missing system API token');
+        }
+    }
+    async deleteWebsocketConfiguration(request) {
+        const existingConfigIndex = this._module.config.util.networkConnection.websocketServers.findIndex((ws) => ws.id === request.query.id);
+        if (existingConfigIndex) {
+            this._module.config.util.networkConnection.websocketServers.splice(existingConfigIndex, 1);
+            await ConfigStoreFactory.getInstance().saveConfig(this._module.config);
+        }
+    }
+    // Forcibly disconnect a websocket connection by station id and tenant id and mark the station as offline
+    async deleteWebsocketConnection(request) {
+        await this._networkConnection.disconnect(request.query.tenantId, request.query.stationId);
+    }
+    /**
+     * 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 = '/ocpprouter';
+        return super._toDataPath(input, endpointPrefix);
+    }
+}
+__decorate([
+    AsDataEndpoint(OCPP2_0_1_Namespace.Subscription, HttpMethod.Post, TenantQuerySchema, CreateSubscriptionSchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], AdminApi.prototype, "postSubscription", null);
+__decorate([
+    AsDataEndpoint(OCPP2_0_1_Namespace.Subscription, HttpMethod.Get, ChargingStationKeyQuerySchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], AdminApi.prototype, "getSubscriptionsByChargingStation", null);
+__decorate([
+    AsDataEndpoint(OCPP2_0_1_Namespace.Subscription, HttpMethod.Delete, ModelKeyQuerystringSchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], AdminApi.prototype, "deleteSubscriptionById", null);
+__decorate([
+    AsDataEndpoint(Namespace.Websocket, HttpMethod.Get, WebsocketGetQuerySchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], AdminApi.prototype, "getWebsocketConfigurations", null);
+__decorate([
+    AsDataEndpoint(Namespace.Websocket, HttpMethod.Post, undefined, WebsocketRequestSchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], AdminApi.prototype, "createWebsocketConfiguration", null);
+__decorate([
+    AsDataEndpoint(Namespace.WebsocketMapping, HttpMethod.Put, WebsocketMappingQuerySchema, WebsocketMappingRequestSchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], AdminApi.prototype, "putWebsocketMapping", null);
+__decorate([
+    AsDataEndpoint(Namespace.WebsocketMapping, HttpMethod.Delete, WebsocketMappingQuerySchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], AdminApi.prototype, "deleteWebsocketMapping", null);
+__decorate([
+    AsDataEndpoint(Namespace.Websocket, HttpMethod.Delete, WebsocketDeleteQuerySchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], AdminApi.prototype, "deleteWebsocketConfiguration", null);
+__decorate([
+    AsDataEndpoint(Namespace.Connection, HttpMethod.Delete, ConnectionDeleteQuerySchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], AdminApi.prototype, "deleteWebsocketConnection", 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":";;;;;;;;;AAUA,OAAO,EACL,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,kBAAkB,EAClB,iBAAiB,EACjB,UAAU,EACV,SAAS,EACT,aAAa,EACb,iBAAiB,EACjB,mBAAmB,EACnB,iBAAiB,GAClB,MAAM,iBAAiB,CAAC;AAYzB,OAAO,EACL,6BAA6B,EAC7B,2BAA2B,EAC3B,wBAAwB,EACxB,yBAAyB,EACzB,SAAS,EACT,YAAY,EACZ,iBAAiB,EACjB,0BAA0B,EAC1B,uBAAuB,EACvB,sBAAsB,EACtB,2BAA2B,EAC3B,6BAA6B,GAC9B,MAAM,iBAAiB,CAAC;AAGzB,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAG/B;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,iBAAiC;IACrD,kBAAkB,CAAqB;IACvC,uBAAuB,CAA0B;IACjD,+BAA+B,CAAkC;IAEzE;;;;;;;;;;OAUG;IACH,YACE,UAA0B,EAC1B,iBAAqC,EACrC,MAAuB,EACvB,MAAsC,EACtC,MAAwB,EACxB,sBAAgD,EAChD,8BAAgE;QAEhE,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QACxC,IAAI,CAAC,kBAAkB,GAAG,iBAAiB,CAAC;QAC5C,IAAI,CAAC,uBAAuB;YAC1B,sBAAsB,IAAI,IAAI,SAAS,CAAC,+BAA+B,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAChG,IAAI,CAAC,+BAA+B;YAClC,8BAA8B;gBAC9B,IAAI,SAAS,CAAC,uCAAuC,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IAChF,CAAC;IAED,iGAAiG;IACjG,4FAA4F;IAC5F;;;;;;OAMG;IAOG,AAAN,KAAK,CAAC,gBAAgB,CACpB,OAA+E;QAE/E,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC;QACxC,OAAO,CAAC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACjC,IACE,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO;YACrB,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS;YACvB,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS;YACvB,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EACzB,CAAC;YACD,MAAM,IAAI,eAAe,CACvB,kFAAkF,CACnF,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC,uBAAuB;aAChC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAoB,CAAC;aAC9C,IAAI,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;IAC9C,CAAC;IAGK,AAAN,KAAK,CAAC,iCAAiC,CACrC,OAAuE;QAEvE,OAAO,IAAI,CAAC,uBAAuB,CAAC,kBAAkB,CACpD,OAAO,CAAC,KAAK,CAAC,QAAQ,EACtB,OAAO,CAAC,KAAK,CAAC,SAAS,CACxB,CAAC;IACJ,CAAC;IAGK,AAAN,KAAK,CAAC,sBAAsB,CAC1B,OAA6D;QAE7D,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,IAAI,iBAAiB,CAAC;QAC7D,OAAO,IAAI,CAAC,uBAAuB;aAChC,WAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC;aAClD,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;IACtB,CAAC;IAGK,AAAN,KAAK,CAAC,0BAA0B,CAC9B,OAAiE;QAEjE,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC;YACrB,MAAM,eAAe,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,IAAI,CACtF,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,OAAO,CAAC,KAAK,CAAC,EAAE,CACnC,CAAC;YAEF,IAAI,CAAC,eAAe,EAAE,CAAC;gBACrB,MAAM,IAAI,aAAa,CACrB,kDAAkD,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,CACrE,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,OAAO,eAAe,CAAC;YACzB,CAAC;QACH,CAAC;aAAM,CAAC;YACN,iHAAiH;YACjH,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,CAAC;QACrE,CAAC;IACH,CAAC;IAGK,AAAN,KAAK,CAAC,4BAA4B,CAChC,OAAwD;QAExD,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,IAAI,CACrF,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,EAAE,CAClC,CAAC;QAEF,IAAI,cAAc,EAAE,CAAC;YACnB,MAAM,IAAI,eAAe,CACvB,mCAAmC,OAAO,CAAC,IAAI,CAAC,EAAE,kBAAkB,CACrE,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC/E,MAAM,kBAAkB,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACvE,OAAO,OAAO,CAAC,IAAI,CAAC;QACtB,CAAC;IACH,CAAC;IAED;;OAEG;IAOG,AAAN,KAAK,CAAC,mBAAmB,CACvB,OAGE;QAEF,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAEnC,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAClC,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;QAExC,MAAM,eAAe,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,IAAI,CACtF,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,QAAQ,CAC3B,CAAC;QAEF,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,MAAM,IAAI,aAAa,CAAC,mCAAmC,QAAQ,YAAY,CAAC,CAAC;QACnF,CAAC;QAED,IAAI,CAAC,eAAe,CAAC,iBAAiB,EAAE,CAAC;YACvC,eAAe,CAAC,iBAAiB,GAAG,EAAE,CAAC;QACzC,CAAC;QAED,IACE,eAAe,CAAC,iBAAiB,CAAC,IAAI,CAAC,KAAK,SAAS;YACrD,eAAe,CAAC,iBAAiB,CAAC,IAAI,CAAC,KAAK,QAAQ,EACpD,CAAC;YACD,MAAM,IAAI,eAAe,CACvB,QAAQ,IAAI,gCAAgC,eAAe,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,CACtF,CAAC;QACJ,CAAC;QAED,eAAe,CAAC,iBAAiB,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;QACnD,eAAe,CAAC,uBAAuB,GAAG,IAAI,CAAC;QAE/C,MAAM,kBAAkB,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACvE,MAAM,IAAI,CAAC,+BAA+B,CAAC,0BAA0B,CACnE,eAAe,EACf,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,oBAAoB,CACzC,CAAC;QAEF,OAAO,eAAe,CAAC;IACzB,CAAC;IAED;;OAEG;IAEG,AAAN,KAAK,CAAC,sBAAsB,CAC1B,OAEE;QAEF,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAEnC,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,GAAI,OAAO,CAAC,KAAa,CAAC,IAAI,CAAC;QACzC,MAAM,QAAQ,GAAI,OAAO,CAAC,KAAa,CAAC,QAAQ,CAAC;QAEjD,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACvB,MAAM,IAAI,eAAe,CAAC,yDAAyD,CAAC,CAAC;QACvF,CAAC;QAED,MAAM,eAAe,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,IAAI,CACtF,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,QAAQ,CAC3B,CAAC;QAEF,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,MAAM,IAAI,aAAa,CAAC,mCAAmC,QAAQ,YAAY,CAAC,CAAC;QACnF,CAAC;QAED,IAAI,eAAe,CAAC,iBAAiB,EAAE,CAAC;YACtC,IAAI,OAAO,GAAG,KAAK,CAAC;YACpB,IAAI,IAAI,IAAI,eAAe,CAAC,iBAAiB,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;gBAClE,OAAO,eAAe,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;gBAC/C,OAAO,GAAG,IAAI,CAAC;YACjB,CAAC;iBAAM,IAAI,QAAQ,EAAE,CAAC;gBACpB,MAAM,WAAW,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;gBACrC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,iBAAiB,CAAC,EAAE,CAAC;oBAC7E,IAAI,KAAK,KAAK,WAAW,EAAE,CAAC;wBAC1B,OAAO,eAAe,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;wBAC9C,OAAO,GAAG,IAAI,CAAC;oBACjB,CAAC;gBACH,CAAC;YACH,CAAC;YAED,IAAI,OAAO,EAAE,CAAC;gBACZ,MAAM,kBAAkB,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;gBACvE,MAAM,IAAI,CAAC,+BAA+B,CAAC,0BAA0B,CACnE,eAAe,EACf,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,oBAAoB,CACzC,CAAC;YACJ,CAAC;QACH,CAAC;QAED,OAAO,eAAe,CAAC;IACzB,CAAC;IAED;;OAEG;IACK,oBAAoB,CAAC,OAAuB;QAClD,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC;QACrE,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,OAAO;QACT,CAAC;QAED,MAAM,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;QACxD,IAAI,aAAa,KAAK,WAAW,EAAE,CAAC;YAClC,MAAM,IAAI,iBAAiB,CAAC,qCAAqC,CAAC,CAAC;QACrE,CAAC;IACH,CAAC;IAGK,AAAN,KAAK,CAAC,4BAA4B,CAChC,OAAoE;QAEpE,MAAM,mBAAmB,GACvB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,SAAS,CACnE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,OAAO,CAAC,KAAK,CAAC,EAAE,CACnC,CAAC;QAEJ,IAAI,mBAAmB,EAAE,CAAC;YACxB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,MAAM,CAAC,mBAAmB,EAAE,CAAC,CAAC,CAAC;YAC3F,MAAM,kBAAkB,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACzE,CAAC;IACH,CAAC;IAED,yGAAyG;IAEnG,AAAN,KAAK,CAAC,yBAAyB,CAC7B,OAAqE;QAErE,MAAM,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;OAMG;IACO,WAAW,CAAC,KAA0D;QAC9E,MAAM,cAAc,GAAG,aAAa,CAAC;QACrC,OAAO,KAAK,CAAC,WAAW,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;IAClD,CAAC;CACF;AA7OO;IANL,cAAc,CACb,mBAAmB,CAAC,YAAY,EAChC,UAAU,CAAC,IAAI,EACf,iBAAiB,EACjB,wBAAwB,CACzB;;;;gDAmBA;AAGK;IADL,cAAc,CAAC,mBAAmB,CAAC,YAAY,EAAE,UAAU,CAAC,GAAG,EAAE,6BAA6B,CAAC;;;;iEAQ/F;AAGK;IADL,cAAc,CAAC,mBAAmB,CAAC,YAAY,EAAE,UAAU,CAAC,MAAM,EAAE,yBAAyB,CAAC;;;;sDAQ9F;AAGK;IADL,cAAc,CAAC,SAAS,CAAC,SAAS,EAAE,UAAU,CAAC,GAAG,EAAE,uBAAuB,CAAC;;;;0DAoB5E;AAGK;IADL,cAAc,CAAC,SAAS,CAAC,SAAS,EAAE,UAAU,CAAC,IAAI,EAAE,SAAS,EAAE,sBAAsB,CAAC;;;;4DAiBvF;AAWK;IANL,cAAc,CACb,SAAS,CAAC,gBAAgB,EAC1B,UAAU,CAAC,GAAG,EACd,2BAA2B,EAC3B,6BAA6B,CAC9B;;;;mDA2CA;AAMK;IADL,cAAc,CAAC,SAAS,CAAC,gBAAgB,EAAE,UAAU,CAAC,MAAM,EAAE,2BAA2B,CAAC;;;;sDAiD1F;AAkBK;IADL,cAAc,CAAC,SAAS,CAAC,SAAS,EAAE,UAAU,CAAC,MAAM,EAAE,0BAA0B,CAAC;;;;4DAalF;AAIK;IADL,cAAc,CAAC,SAAS,CAAC,UAAU,EAAE,UAAU,CAAC,MAAM,EAAE,2BAA2B,CAAC;;;;yDAKpF"}

package/dist/module/interface.d.ts

@@ -0,0 +1,6 @@
+/**
+ * TODO: add actual interface
+ * Interface for the admin api.
+ */
+export interface IAdminApi {
+}

package/dist/module/interface.js

@@ -0,0 +1,5 @@
+// SPDX-FileCopyrightText: 2025 Contributors to the CitrineOS Project
+//
+// SPDX-License-Identifier: Apache-2.0
+export {};
+//# sourceMappingURL=interface.js.map

package/dist/module/interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interface.js","sourceRoot":"","sources":["../../src/module/interface.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,EAAE;AACF,sCAAsC"}

package/dist/module/router.d.ts

@@ -0,0 +1,140 @@
+import type { BootstrapConfig, Call, CallAction, CallError, CallResult, CircuitBreakerOptions, CircuitBreakerState, ICache, IMessageConfirmation, IMessageHandler, IMessageRouter, IMessageSender, OcppRequest, OcppResponse, OCPPVersionType, SystemConfig } from '@citrineos/base';
+import { AbstractMessageRouter, CircuitBreaker, MessageOrigin, OcppError, OCPPValidator, OCPPVersion } from '@citrineos/base';
+import type { ILocationRepository } from '@citrineos/data';
+import type { ILogObj } from 'tslog';
+import { Logger } from 'tslog';
+import { WebhookDispatcher } from './webhook.dispatcher.js';
+/**
+ * Implementation of the ocpp router
+ */
+export declare class MessageRouterImpl extends AbstractMessageRouter implements IMessageRouter {
+    /**
+     * Fields
+     */
+    private _webhookDispatcher;
+    protected _cache: ICache;
+    protected _sender: IMessageSender;
+    protected _handler: IMessageHandler;
+    protected _networkHook: (identifier: string, message: string) => Promise<void>;
+    protected _locationRepository: ILocationRepository;
+    protected _circuitBreaker: CircuitBreaker;
+    protected _reconnectInterval?: NodeJS.Timeout;
+    protected static readonly DEFAULT_MAX_RECONNECT_DELAY = 30;
+    protected _maxReconnectDelay: number;
+    protected _failingReconnectDelay: number;
+    private readonly _oidcTokenProvider?;
+    /**
+     * Constructor for the class.
+     *
+     * @param {BootstrapConfig & SystemConfig} config - the system configuration
+     * @param {ICache} cache - the cache object
+     * @param {IMessageSender} [sender] - the message sender
+     * @param {IMessageHandler} [handler] - the message handler
+     * @param {WebhookDispatcher} [dispatcher] - the webhook dispatcher
+     * @param {Function} networkHook - the network hook needed to send messages to chargers
+     * @param {ILocationRepository} [locationRepository] - An optional parameter of type {@link ILocationRepository} which
+     * represents a repository for accessing and manipulating variable data.
+     * If no `locationRepository` is provided, a default {@link locationRepository} instance is created and used.
+     * @param {Logger<ILogObj>} [logger] - the logger object (optional)
+     * @param {OCPPValidator} [ocppValidator] - the OCPPValidator instance, for message validation (optional)
+     * @param {CircuitBreakerOptions} [circuitBreakerOptions] - options to configure the circuit breaker
+     */
+    constructor(config: BootstrapConfig & SystemConfig, cache: ICache, sender: IMessageSender, handler: IMessageHandler, dispatcher: WebhookDispatcher, networkHook: (identifier: string, message: string) => Promise<void>, logger?: Logger<ILogObj>, ocppValidator?: OCPPValidator, locationRepository?: ILocationRepository, circuitBreakerOptions?: CircuitBreakerOptions);
+    doesChargingStationExistByStationId(tenantId: number, stationId: string): Promise<boolean>;
+    registerConnection(tenantId: number, stationId: string, protocol: OCPPVersion): Promise<boolean>;
+    deregisterConnection(tenantId: number, stationId: string): Promise<boolean>;
+    onMessage(identifier: string, message: string, timestamp: Date, protocol: OCPPVersionType): Promise<boolean>;
+    /**
+     * Sends a Call message to a charging station with given identifier.
+     *
+     * @param {string} stationId - The identifier of the station.
+     * @param {number} tenantId - The identifier of the tenant.
+     * @param {OCPPVersionType} protocol The OCPP protocol version of the message.
+     * @param {CallAction} action - The action to be called.
+     * @param {OcppRequest} payload - The payload of the call.
+     * @param {string} correlationId - The correlation ID of the message.
+     * @param {MessageOrigin} _origin - The origin of the message.
+     * @return {Promise<boolean>} A promise that resolves to a boolean indicating if the call was sent successfully.
+     */
+    sendCall(stationId: string, tenantId: number, protocol: OCPPVersionType, action: CallAction, payload: OcppRequest, correlationId?: string, _origin?: MessageOrigin): Promise<IMessageConfirmation>;
+    /**
+     * Sends the CallResult to a charging station with given identifier.
+     *
+     * @param {string} correlationId - The correlation ID of the message.
+     * @param {string} stationId - The identifier of the charging station.
+     * @param {number} tenantId - The identifier of the tenant.
+     * @param {OCPPVersionType} protocol The OCPP protocol version of the message.
+     * @param {CallAction} action - The action to be called.
+     * @param {OcppRequest} payload - The payload of the call.
+     * @param {MessageOrigin} _origin - The origin of the message.
+     * @return {Promise<boolean>} A promise that resolves to true if the call result was sent successfully, or false otherwise.
+     */
+    sendCallResult(correlationId: string, stationId: string, tenantId: number, protocol: OCPPVersionType, action: CallAction, payload: OcppResponse, _origin?: MessageOrigin): Promise<IMessageConfirmation>;
+    /**
+     * Sends a CallError message to a charging station with given identifier.
+     *
+     * @param {string} correlationId - The correlation ID of the message.
+     * @param {string} stationId - The identifier of the charging station.
+     * @param {number} tenantId - The identifier of the tenant.
+     * @param {OCPPVersionType} protocol The OCPP protocol version of the message.
+     * @param {CallAction} _action - The action to be called.
+     * @param {OcppError} error - The error of the call.
+     * @param {MessageOrigin} _origin - The origin of the message.
+     * @return {Promise<boolean>} - A promise that resolves to true if the message was sent successfully.
+     */
+    sendCallError(correlationId: string, stationId: string, tenantId: number, protocol: OCPPVersionType, action: CallAction, error: OcppError, _origin?: MessageOrigin | undefined): Promise<IMessageConfirmation>;
+    shutdown(): Promise<void>;
+    /**
+     * Private Methods
+     */
+    /**
+     * Handles an incoming Call message from a client connection.
+     *
+     * @param {string} identifier - The client identifier.
+     * @param {Call} message - The Call message received.
+     * @param {Date} timestamp Time at which the message was received from the charger.
+     * @param {string} protocol The OCPP protocol version of the message
+     * @return {void}
+     */
+    _onCall(identifier: string, message: Call, timestamp: Date, protocol: OCPPVersionType): Promise<void>;
+    /**
+     * Handles a CallResult made by the client.
+     *
+     * @param {string} identifier - The client identifier that made the call.
+     * @param {CallResult} message - The OCPP CallResult message.
+     * @param {Date} timestamp Time at which the message was received from the charger.
+     * @param {OCPPVersionType} protocol The OCPP protocol version of the message
+     */
+    _onCallResult(identifier: string, message: CallResult, timestamp: Date, protocol: OCPPVersionType): Promise<void>;
+    /**
+     * Handles the CallError that may have occured during a Call exchange.
+     *
+     * @param {string} identifier - The client identifier.
+     * @param {CallError} message - The error message.
+     * @param {Date} timestamp Time at which the message was received from the charger.
+     * @param {OCPPVersionType} protocol The OCPP protocol version of the message
+     */
+    _onCallError(identifier: string, message: CallError, timestamp: Date, protocol: OCPPVersionType): Promise<void>;
+    /**
+     * Determine if the given action for identifier is allowed.
+     *
+     * @param {CallAction} action - The action to be checked.
+     * @param {string} identifier - The identifier to be checked.
+     * @return {Promise<boolean>} A promise that resolves to a boolean indicating if the action and identifier are allowed.
+     */
+    private _onCallIsAllowed;
+    private _sendMessage;
+    private _sendCallIsAllowed;
+    private _routeCall;
+    private _routeCallResult;
+    private _routeCallError;
+    private emitMessage;
+    private _handleMessageApiCallback;
+    protected handleCircuitBreakerStateChange(state: CircuitBreakerState, reason?: string): void;
+    private _attemptExponentialReconnect;
+    protected onCircuitBreakerClosed(reason?: string): void;
+    protected onCircuitBreakerOpen(): void;
+    protected onBrokerDisconnect(reason?: string): void;
+    protected onBrokerReconnect(): void;
+    private getActionFromIncompletelyParsedRpcMessage;
+}