@zetra/citrineos-base 1.8.3-fork.1

package/dist/interfaces/repository.js

@@ -0,0 +1,160 @@
+// SPDX-FileCopyrightText: 2025 Contributors to the CitrineOS Project
+//
+// SPDX-License-Identifier: Apache-2.0
+import { EventEmitter } from 'events';
+/**
+ * Represents a generic CRUD repository.
+ *
+ * @template T - The type of the values stored in the repository.
+ */
+export class CrudRepository extends EventEmitter {
+    constructor() {
+        super();
+    }
+    /**
+     * On method overridden to handle events from {@link CrudEvent}.
+     * @param event The name of the event. Must be a key in {@link CrudEvent}.
+     * @param listener The callback for the event. Argument types correspond to the contents of the event key in {@link CrudEvent}.
+     *
+     * @see {@link EventEmitter#on} for the original method.
+     */
+    on(event, listener) {
+        return super.on(event, listener);
+    }
+    /**
+     * Emit method overridden to emit events from {@link CrudEvent}.
+     * @param event The name of the event. Must be a key in {@link CrudEvent}.
+     * @param args The arguments to pass with the event. Allowed types correspond to the contents of the event key in {@link CrudEvent}.
+     *
+     * @see {@link EventEmitter#emit} for the original method.
+     */
+    emit(event, ...args) {
+        return super.emit(event, ...args);
+    }
+    /**
+     * Creates a new entry in the database with the specified value.
+     *
+     * @param tenantId - The tenant ID for which to create the entry.
+     * @param value - The value of the entry.
+     * @param namespace - The optional namespace to create the entry in.
+     * @returns A Promise that resolves to the created entry.
+     */
+    async create(tenantId, value, namespace) {
+        const result = await this._create(tenantId, value, namespace);
+        this.emit('created', [result]);
+        return result;
+    }
+    /**
+     * Creates multiple entries in the database.
+     *
+     * @param tenantId - The tenant ID for which to create the entries.
+     * @param values - The values of the entries.
+     * @param clazz - The class of the model.
+     * @param namespace - The optional namespace to create the entries in.
+     * @returns A Promise that resolves to the created entries.
+     */
+    async bulkCreate(tenantId, values, clazz, namespace) {
+        const result = await this._bulkCreate(tenantId, values, namespace);
+        this.emit('created', result);
+        return result;
+    }
+    /**
+     * Creates a new entry in the database with the specified value and key.
+     *
+     * @param tenantId - The tenant ID for which to create the entry.
+     * @param value - The value of the entry.
+     * @param key - The key of the entry.
+     * @param namespace - The optional namespace to create the entry in.
+     * @returns A Promise that resolves to the created entry.
+     */
+    async createByKey(tenantId, value, key, namespace) {
+        const result = await this._createByKey(tenantId, value, key, namespace);
+        this.emit('created', [result]);
+        return result;
+    }
+    /**
+     * Attempts to read a value from storage based on the given query, or throws an exception if more than one value is found.
+     *
+     * @param tenantId - The tenant ID for which to read the entry.
+     * @param query - The query to use.
+     * @param namespace - Optional namespace for the query.
+     * @returns A promise that resolves to the value associated with the query if it exists. An exception is thrown if more than one value is found.
+     */
+    async readOnlyOneByQuery(tenantId, query, namespace) {
+        const results = await this.readAllByQuery(tenantId, query, namespace);
+        if (results.length > 1) {
+            throw new Error(`More than one value found for query: ${JSON.stringify(query)}`);
+        }
+        return results[0];
+    }
+    /**
+     * Reads the first matching value from storage based on the given query, or creates a matching value if none exists.
+     *
+     * @param tenantId - The tenant ID for which to read or create the entry.
+     * @param query - The query to use.
+     * @param namespace - Optional namespace for the query.
+     * @returns A promise that resolves to an array where the first element is the value associated with the query, either an existing value or the newly created value, and the second element is a boolean indicating whether the entry was created.
+     */
+    async readOrCreateByQuery(tenantId, query, namespace) {
+        const result = await this._readOrCreateByQuery(tenantId, query, namespace);
+        if (result[1]) {
+            this.emit('created', [result[0]]);
+        }
+        return result;
+    }
+    /**
+     * Updates the value associated with the given key.
+     *
+     * @param tenantId - The tenant ID for which to update the entry.
+     * @param value - The new value to associate with the key.
+     * @param key - The key to update.
+     * @param namespace - The namespace in which to update the key.
+     * @returns A promise that resolves to the updated value, or undefined if the key does not exist.
+     */
+    async updateByKey(tenantId, value, key, namespace) {
+        const result = await this._updateByKey(tenantId, value, key, namespace);
+        this.emit('updated', result ? [result] : []);
+        return result;
+    }
+    /**
+     * Updates the values associated with the given query.
+     *
+     * @param tenantId - The tenant ID for which to update the entries.
+     * @param value - The new value to associate with the query.
+     * @param query - The query to use.
+     * @param namespace - Optional namespace for the query.
+     * @returns A promise that resolves to the updated values associated with the query.
+     */
+    async updateAllByQuery(tenantId, value, query, namespace) {
+        const result = await this._updateAllByQuery(tenantId, value, query, namespace);
+        this.emit('updated', result);
+        return result;
+    }
+    /**
+     * Deletes a key from the specified namespace.
+     *
+     * @param tenantId - The tenant ID for which to delete the entry.
+     * @param key - The key to delete.
+     * @param namespace - Optional. The namespace from which to delete the key.
+     * @returns A Promise that resolves to the deleted entry, or undefined there was no matching entry.
+     */
+    async deleteByKey(tenantId, key, namespace) {
+        const result = await this._deleteByKey(tenantId, key, namespace);
+        this.emit('deleted', result ? [result] : []);
+        return result;
+    }
+    /**
+     * Deletes all values associated with a query from the specified namespace.
+     *
+     * @param tenantId - The tenant ID for which to delete the entries.
+     * @param query - The query to use.
+     * @param namespace - Optional. The namespace from which to delete the values.
+     * @returns A Promise that resolves to the deleted entries.
+     */
+    async deleteAllByQuery(tenantId, query, namespace) {
+        const result = await this._deleteAllByQuery(tenantId, query, namespace);
+        this.emit('deleted', result);
+        return result;
+    }
+}
+//# sourceMappingURL=repository.js.map

package/dist/interfaces/repository.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"repository.js","sourceRoot":"","sources":["../../src/interfaces/repository.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,EAAE;AACF,sCAAsC;AAEtC,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAQtC;;;;GAIG;AACH,MAAM,OAAgB,cAAkB,SAAQ,YAAY;IAC1D;QACE,KAAK,EAAE,CAAC;IACV,CAAC;IAED;;;;;;OAMG;IACH,EAAE,CAA+B,KAAQ,EAAE,QAA4C;QACrF,OAAO,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,QAAoC,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CAA+B,KAAQ,EAAE,GAAG,IAAqB;QACnE,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,MAAM,CAAC,QAAgB,EAAE,KAAQ,EAAE,SAAkB;QAChE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;QAC9D,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;QAC/B,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,UAAU,CACrB,QAAgB,EAChB,MAAW,EACX,KAAU,EACV,SAAkB;QAElB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;QACnE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAC7B,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,WAAW,CACtB,QAAgB,EAChB,KAAQ,EACR,GAAW,EACX,SAAkB;QAElB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,CAAC,CAAC;QACxE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;QAC/B,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,kBAAkB,CAC7B,QAAgB,EAChB,KAAa,EACb,SAAkB;QAElB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;QACtE,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,wCAAwC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACnF,CAAC;QACD,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,mBAAmB,CAC9B,QAAgB,EAChB,KAAa,EACb,SAAkB;QAElB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,QAAQ,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;QAC3E,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;YACd,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACpC,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,WAAW,CACtB,QAAgB,EAChB,KAAiB,EACjB,GAAW,EACX,SAAkB;QAElB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,CAAC,CAAC;QACxE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC7C,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,gBAAgB,CAC3B,QAAgB,EAChB,KAAiB,EACjB,KAAa,EACb,SAAkB;QAElB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;QAC/E,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAC7B,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,WAAW,CACtB,QAAgB,EAChB,GAAW,EACX,SAAkB;QAElB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,GAAG,EAAE,SAAS,CAAC,CAAC;QACjE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC7C,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,gBAAgB,CAAC,QAAgB,EAAE,KAAa,EAAE,SAAkB;QAC/E,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;QACxE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAC7B,OAAO,MAAM,CAAC;IAChB,CAAC;CAyGF"}

package/dist/interfaces/router/AbstractRouter.d.ts

@@ -0,0 +1,79 @@
+import type { ErrorObject } from 'ajv';
+import type { ILogObj } from 'tslog';
+import { Logger } from 'tslog';
+import type { Call, CallAction, CallResult, ICache, IMessage, IMessageConfirmation, IMessageHandler, IMessageSender, OcppRequest, OcppResponse, OCPPVersionType, SystemConfig } from '../../index.js';
+import { MessageOrigin, OcppError } from '../../index.js';
+import { OCPPValidator } from '../modules/OCPPValidator.js';
+import type { IMessageRouter } from './Router.js';
+export declare abstract class AbstractMessageRouter implements IMessageRouter {
+    /**
+     * Fields
+     */
+    protected _ocppValidator: OCPPValidator;
+    protected _cache: ICache;
+    protected _config: SystemConfig;
+    protected _logger: Logger<ILogObj>;
+    protected readonly _handler: IMessageHandler;
+    protected readonly _sender: IMessageSender;
+    protected _networkHook: (identifier: string, message: string) => Promise<void>;
+    /**
+     * Constructor of abstract ocpp router.
+     *
+     * @param {OCPPValidator} ocppValidator - The OCPPValidator instance to use for message validation.
+     */
+    constructor(config: SystemConfig, cache: ICache, handler: IMessageHandler, sender: IMessageSender, networkHook: (identifier: string, message: string) => Promise<void>, logger?: Logger<ILogObj>, ocppValidator?: OCPPValidator);
+    /**
+     * Getters & Setters
+     */
+    get ocppValidator(): OCPPValidator;
+    get cache(): ICache;
+    get sender(): IMessageSender;
+    get handler(): IMessageHandler;
+    get config(): SystemConfig;
+    set networkHook(value: (identifier: string, message: string) => Promise<void>);
+    /**
+     * Sets the system configuration for the module.
+     *
+     * @param {SystemConfig} config - The new configuration to set.
+     */
+    set config(config: SystemConfig);
+    /**
+     * Public Methods
+     */
+    handle(message: IMessage<OcppRequest | OcppResponse | OcppError>): Promise<void>;
+    /**
+     * Protected Methods
+     */
+    /**
+     * Validates a Call object against its schema.
+     *
+     * @param {string} identifier - The identifier of the EVSE.
+     * @param {Call} message - The Call object to validate.
+     * @param {string} protocol - The subprotocol of the Websocket, i.e. "ocpp1.6" or "ocpp2.0.1".
+     * @return {boolean} - Returns true if the Call object is valid, false otherwise.
+     */
+    protected _validateCall(identifier: string, message: Call, protocol: string): {
+        isValid: boolean;
+        errors?: ErrorObject[] | null;
+    };
+    /**
+     * Validates a CallResult object against its schema.
+     *
+     * @param {string} identifier - The identifier of the EVSE.
+     * @param {CallAction} action - The original CallAction.
+     * @param {CallResult} message - The CallResult object to validate.
+     * @param {string} protocol - The protocol of the Websocket.
+     * @return {boolean} - Returns true if the CallResult object is valid, false otherwise.
+     */
+    protected _validateCallResult(identifier: string, action: CallAction, message: CallResult, protocol: string): {
+        isValid: boolean;
+        errors?: ErrorObject[] | null;
+    };
+    abstract onMessage(identifier: string, message: string, timestamp: Date, protocol: string): Promise<boolean>;
+    abstract registerConnection(tenantId: number, stationId: string, protocol: string): Promise<boolean>;
+    abstract deregisterConnection(tenantId: number, stationId: string): Promise<boolean>;
+    abstract sendCall(stationId: string, tenantId: number, protocol: OCPPVersionType, action: CallAction, payload: OcppRequest, correlationId?: string, origin?: MessageOrigin): Promise<IMessageConfirmation>;
+    abstract sendCallResult(correlationId: string, stationId: string, tenantId: number, protocol: OCPPVersionType, action: CallAction, payload: OcppResponse, origin?: MessageOrigin): Promise<IMessageConfirmation>;
+    abstract sendCallError(correlationId: string, stationId: string, tenantId: number, protocol: OCPPVersionType, action: CallAction, error: OcppError, origin?: MessageOrigin): Promise<IMessageConfirmation>;
+    abstract shutdown(): Promise<void>;
+}

package/dist/interfaces/router/AbstractRouter.js

@@ -0,0 +1,161 @@
+// SPDX-FileCopyrightText: 2025 Contributors to the CitrineOS Project
+//
+// SPDX-License-Identifier: Apache-2.0
+import { Logger } from 'tslog';
+import { ErrorCode, MessageOrigin, MessageState, OcppError, OCPPVersion } from '../../index.js';
+import { OCPPValidator } from '../modules/OCPPValidator.js';
+export class AbstractMessageRouter {
+    /**
+     * Fields
+     */
+    _ocppValidator;
+    _cache;
+    _config;
+    _logger;
+    _handler;
+    _sender;
+    _networkHook;
+    /**
+     * Constructor of abstract ocpp router.
+     *
+     * @param {OCPPValidator} ocppValidator - The OCPPValidator instance to use for message validation.
+     */
+    constructor(config, cache, handler, sender, networkHook, logger, ocppValidator) {
+        this._config = config;
+        this._cache = cache;
+        this._handler = handler;
+        this._sender = sender;
+        this._networkHook = networkHook;
+        this._ocppValidator = ocppValidator || new OCPPValidator(logger);
+        this._logger = logger
+            ? logger.getSubLogger({ name: this.constructor.name })
+            : new Logger({ name: this.constructor.name });
+        // Set module for proper message flow.
+        this._handler.module = this;
+    }
+    /**
+     * Getters & Setters
+     */
+    get ocppValidator() {
+        return this._ocppValidator;
+    }
+    get cache() {
+        return this._cache;
+    }
+    get sender() {
+        return this._sender;
+    }
+    get handler() {
+        return this._handler;
+    }
+    get config() {
+        return this._config;
+    }
+    set networkHook(value) {
+        this._networkHook = value;
+    }
+    /**
+     * Sets the system configuration for the module.
+     *
+     * @param {SystemConfig} config - The new configuration to set.
+     */
+    set config(config) {
+        this._config = config;
+        // Update all necessary settings for hot reload
+        this._logger.info('Updating system configuration for ocpp router...');
+        this._logger.settings.minLevel = this._config.logLevel;
+    }
+    /**
+     * Public Methods
+     */
+    async handle(message) {
+        message.payload = this._ocppValidator.sanitizeOCPPPayload(message.payload);
+        switch (message.state) {
+            case MessageState.Request: {
+                const { isValid, errors } = this._ocppValidator.validateOCPPRequest(message.action, message.payload, message.protocol);
+                if (!isValid || errors) {
+                    throw new OcppError(message.context.correlationId, ErrorCode.FormatViolation, 'Invalid message format', {
+                        errors: errors,
+                    });
+                }
+                await this.sendCall(message.context.stationId, message.context.tenantId, message.protocol, message.action, message.payload, message.context.correlationId, message.origin);
+                break;
+            }
+            case MessageState.Response: {
+                const { isValid, errors } = this._ocppValidator.validateOCPPResponse(message.action, message.payload, message.protocol);
+                if (!isValid || errors) {
+                    throw new OcppError(message.context.correlationId, ErrorCode.FormatViolation, 'Invalid message format', {
+                        errors: errors,
+                    });
+                }
+                if (message.payload && message.payload._errorCode) {
+                    // Create OcppError from payload properties for sendCallError method
+                    const errorPayload = message.payload;
+                    const ocppError = new OcppError(errorPayload._messageId, errorPayload._errorCode, errorPayload.message || '', errorPayload._errorDetails || {});
+                    await this.sendCallError(message.context.correlationId, message.context.stationId, message.context.tenantId, message.protocol, message.action, ocppError, message.origin);
+                }
+                else {
+                    await this.sendCallResult(message.context.correlationId, message.context.stationId, message.context.tenantId, message.protocol, message.action, message.payload, message.origin);
+                }
+                break;
+            }
+            default:
+                this._logger.error('Unknown message state', message);
+                throw new Error('Unknown message state: ' + message.state);
+        }
+    }
+    /**
+     * Protected Methods
+     */
+    /**
+     * Validates a Call object against its schema.
+     *
+     * @param {string} identifier - The identifier of the EVSE.
+     * @param {Call} message - The Call object to validate.
+     * @param {string} protocol - The subprotocol of the Websocket, i.e. "ocpp1.6" or "ocpp2.0.1".
+     * @return {boolean} - Returns true if the Call object is valid, false otherwise.
+     */
+    _validateCall(identifier, message, protocol) {
+        const action = message[2];
+        const payload = message[3];
+        let protocolEnum;
+        switch (protocol) {
+            case OCPPVersion.OCPP1_6:
+                protocolEnum = OCPPVersion.OCPP1_6;
+                break;
+            case OCPPVersion.OCPP2_0_1:
+                protocolEnum = OCPPVersion.OCPP2_0_1;
+                break;
+            default:
+                this._logger.error('Unknown subprotocol', protocol);
+                return { isValid: false };
+        }
+        return this._ocppValidator.validateOCPPRequest(action, payload, protocolEnum);
+    }
+    /**
+     * Validates a CallResult object against its schema.
+     *
+     * @param {string} identifier - The identifier of the EVSE.
+     * @param {CallAction} action - The original CallAction.
+     * @param {CallResult} message - The CallResult object to validate.
+     * @param {string} protocol - The protocol of the Websocket.
+     * @return {boolean} - Returns true if the CallResult object is valid, false otherwise.
+     */
+    _validateCallResult(identifier, action, message, protocol) {
+        const payload = message[2];
+        let protocolEnum;
+        switch (protocol) {
+            case OCPPVersion.OCPP1_6:
+                protocolEnum = OCPPVersion.OCPP1_6;
+                break;
+            case OCPPVersion.OCPP2_0_1:
+                protocolEnum = OCPPVersion.OCPP2_0_1;
+                break;
+            default:
+                this._logger.error('Unknown subprotocol', protocol);
+                return { isValid: false };
+        }
+        return this._ocppValidator.validateOCPPResponse(action, payload, protocolEnum);
+    }
+}
+//# sourceMappingURL=AbstractRouter.js.map

package/dist/interfaces/router/AbstractRouter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractRouter.js","sourceRoot":"","sources":["../../../src/interfaces/router/AbstractRouter.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,EAAE;AACF,sCAAsC;AAKtC,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAe/B,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAChG,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAG5D,MAAM,OAAgB,qBAAqB;IACzC;;OAEG;IAEO,cAAc,CAAgB;IAC9B,MAAM,CAAS;IACf,OAAO,CAAe;IACtB,OAAO,CAAkB;IAChB,QAAQ,CAAkB;IAC1B,OAAO,CAAiB;IACjC,YAAY,CAAyD;IAE/E;;;;OAIG;IACH,YACE,MAAoB,EACpB,KAAa,EACb,OAAwB,EACxB,MAAsB,EACtB,WAAmE,EACnE,MAAwB,EACxB,aAA6B;QAE7B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,IAAI,CAAC,cAAc,GAAG,aAAa,IAAI,IAAI,aAAa,CAAC,MAAM,CAAC,CAAC;QACjE,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;QAEzD,sCAAsC;QACtC,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC;IAC9B,CAAC;IAED;;OAEG;IAEH,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,IAAI,WAAW,CAAC,KAA6D;QAC3E,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACH,IAAI,MAAM,CAAC,MAAoB;QAC7B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,+CAA+C;QAC/C,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kDAAkD,CAAC,CAAC;QACtE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;IACzD,CAAC;IAED;;OAEG;IAEH,KAAK,CAAC,MAAM,CAAC,OAAyD;QACpE,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC3E,QAAQ,OAAO,CAAC,KAAK,EAAE,CAAC;YACtB,KAAK,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;gBAC1B,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,cAAc,CAAC,mBAAmB,CACjE,OAAO,CAAC,MAAM,EACd,OAAO,CAAC,OAAO,EACf,OAAO,CAAC,QAAuB,CAChC,CAAC;gBAEF,IAAI,CAAC,OAAO,IAAI,MAAM,EAAE,CAAC;oBACvB,MAAM,IAAI,SAAS,CACjB,OAAO,CAAC,OAAO,CAAC,aAAa,EAC7B,SAAS,CAAC,eAAe,EACzB,wBAAwB,EACxB;wBACE,MAAM,EAAE,MAAM;qBACf,CACF,CAAC;gBACJ,CAAC;gBAED,MAAM,IAAI,CAAC,QAAQ,CACjB,OAAO,CAAC,OAAO,CAAC,SAAS,EACzB,OAAO,CAAC,OAAO,CAAC,QAAQ,EACxB,OAAO,CAAC,QAAQ,EAChB,OAAO,CAAC,MAAM,EACd,OAAO,CAAC,OAAO,EACf,OAAO,CAAC,OAAO,CAAC,aAAa,EAC7B,OAAO,CAAC,MAAM,CACf,CAAC;gBAEF,MAAM;YACR,CAAC;YACD,KAAK,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAC3B,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,cAAc,CAAC,oBAAoB,CAClE,OAAO,CAAC,MAAM,EACd,OAAO,CAAC,OAAO,EACf,OAAO,CAAC,QAAuB,CAChC,CAAC;gBAEF,IAAI,CAAC,OAAO,IAAI,MAAM,EAAE,CAAC;oBACvB,MAAM,IAAI,SAAS,CACjB,OAAO,CAAC,OAAO,CAAC,aAAa,EAC7B,SAAS,CAAC,eAAe,EACzB,wBAAwB,EACxB;wBACE,MAAM,EAAE,MAAM;qBACf,CACF,CAAC;gBACJ,CAAC;gBAED,IAAI,OAAO,CAAC,OAAO,IAAK,OAAO,CAAC,OAAe,CAAC,UAAU,EAAE,CAAC;oBAC3D,oEAAoE;oBACpE,MAAM,YAAY,GAAG,OAAO,CAAC,OAAc,CAAC;oBAC5C,MAAM,SAAS,GAAG,IAAI,SAAS,CAC7B,YAAY,CAAC,UAAU,EACvB,YAAY,CAAC,UAAU,EACvB,YAAY,CAAC,OAAO,IAAI,EAAE,EAC1B,YAAY,CAAC,aAAa,IAAI,EAAE,CACjC,CAAC;oBAEF,MAAM,IAAI,CAAC,aAAa,CACtB,OAAO,CAAC,OAAO,CAAC,aAAa,EAC7B,OAAO,CAAC,OAAO,CAAC,SAAS,EACzB,OAAO,CAAC,OAAO,CAAC,QAAQ,EACxB,OAAO,CAAC,QAAQ,EAChB,OAAO,CAAC,MAAM,EACd,SAAS,EACT,OAAO,CAAC,MAAM,CACf,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,MAAM,IAAI,CAAC,cAAc,CACvB,OAAO,CAAC,OAAO,CAAC,aAAa,EAC7B,OAAO,CAAC,OAAO,CAAC,SAAS,EACzB,OAAO,CAAC,OAAO,CAAC,QAAQ,EACxB,OAAO,CAAC,QAAQ,EAChB,OAAO,CAAC,MAAM,EACd,OAAO,CAAC,OAAO,EACf,OAAO,CAAC,MAAM,CACf,CAAC;gBACJ,CAAC;gBAED,MAAM;YACR,CAAC;YACD;gBACE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC;gBACrD,MAAM,IAAI,KAAK,CAAC,yBAAyB,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;IAED;;OAEG;IAEH;;;;;;;OAOG;IACO,aAAa,CACrB,UAAkB,EAClB,OAAa,EACb,QAAgB;QAEhB,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QAC1B,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QAE3B,IAAI,YAAqC,CAAC;QAC1C,QAAQ,QAAQ,EAAE,CAAC;YACjB,KAAK,WAAW,CAAC,OAAO;gBACtB,YAAY,GAAG,WAAW,CAAC,OAAO,CAAC;gBACnC,MAAM;YACR,KAAK,WAAW,CAAC,SAAS;gBACxB,YAAY,GAAG,WAAW,CAAC,SAAS,CAAC;gBACrC,MAAM;YACR;gBACE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,qBAAqB,EAAE,QAAQ,CAAC,CAAC;gBACpD,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;QAC9B,CAAC;QAED,OAAO,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC,MAAM,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;OAQG;IACO,mBAAmB,CAC3B,UAAkB,EAClB,MAAkB,EAClB,OAAmB,EACnB,QAAgB;QAEhB,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QAE3B,IAAI,YAAqC,CAAC;QAC1C,QAAQ,QAAQ,EAAE,CAAC;YACjB,KAAK,WAAW,CAAC,OAAO;gBACtB,YAAY,GAAG,WAAW,CAAC,OAAO,CAAC;gBACnC,MAAM;YACR,KAAK,WAAW,CAAC,SAAS;gBACxB,YAAY,GAAG,WAAW,CAAC,SAAS,CAAC;gBACrC,MAAM;YACR;gBACE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,qBAAqB,EAAE,QAAQ,CAAC,CAAC;gBACpD,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;QAC9B,CAAC;QAED,OAAO,IAAI,CAAC,cAAc,CAAC,oBAAoB,CAAC,MAAM,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC;IACjF,CAAC;CA6CF"}

package/dist/interfaces/router/AuthenticationOptions.d.ts

@@ -0,0 +1,4 @@
+export type AuthenticationOptions = {
+    securityProfile: number;
+    allowUnknownChargingStations: boolean;
+};

package/dist/interfaces/router/AuthenticationOptions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=AuthenticationOptions.js.map

package/dist/interfaces/router/AuthenticationOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AuthenticationOptions.js","sourceRoot":"","sources":["../../../src/interfaces/router/AuthenticationOptions.ts"],"names":[],"mappings":""}

package/dist/interfaces/router/Authenticator.d.ts

@@ -0,0 +1,7 @@
+import { IncomingMessage } from 'http';
+import type { AuthenticationOptions } from './AuthenticationOptions.js';
+export interface IAuthenticator {
+    authenticate(request: IncomingMessage, tenantId: number, options: AuthenticationOptions): Promise<{
+        identifier: string;
+    }>;
+}

package/dist/interfaces/router/Authenticator.js

@@ -0,0 +1,5 @@
+// SPDX-FileCopyrightText: 2025 Contributors to the CitrineOS Project
+//
+// SPDX-License-Identifier: Apache-2.0
+import { IncomingMessage } from 'http';
+//# sourceMappingURL=Authenticator.js.map

package/dist/interfaces/router/Authenticator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Authenticator.js","sourceRoot":"","sources":["../../../src/interfaces/router/Authenticator.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,EAAE;AACF,sCAAsC;AAEtC,OAAO,EAAE,eAAe,EAAE,MAAM,MAAM,CAAC"}

package/dist/interfaces/router/INetworkConnection.d.ts

@@ -0,0 +1,10 @@
+import type { WebsocketServerConfig } from '../../config/types.js';
+/**
+ * Interface for the ocpp network connection
+ */
+export interface INetworkConnection {
+    bindNetworkHook(): (identifier: string, message: string) => Promise<void>;
+    disconnect(tenantId: number, stationId: string): Promise<boolean>;
+    shutdown(): Promise<void>;
+    addWebsocketServer(websocketServerConfig: WebsocketServerConfig): Promise<void>;
+}

package/dist/interfaces/router/INetworkConnection.js

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

package/dist/interfaces/router/INetworkConnection.js.map

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

package/dist/interfaces/router/Router.d.ts

@@ -0,0 +1,38 @@
+import type { IModule } from '../../index.js';
+/**
+ * Interface for the ocpp router
+ */
+export interface IMessageRouter extends IModule {
+    networkHook: (identifier: string, message: string) => Promise<void>;
+    /**
+     * Register a connection to the message handler with the given connection identifier.
+     *
+     * @param {number} tenantId
+     * @param {string} stationId
+     * @param {string} protocol - The protocol of the Websocket.
+     * @return {Promise<boolean>} true if both request and response subscriptions are successful, false otherwise
+     */
+    registerConnection(tenantId: number, stationId: string, protocol: string): Promise<boolean>;
+    deregisterConnection(tenantId: number, stationId: string): Promise<boolean>;
+    /**
+     * Check if a charging station exists for a given tenant.
+     *
+     * @param tenantId The tenant ID.
+     * @param stationId The station ID.
+     * @returns true if the station exists for this tenant, false otherwise
+     */
+    doesChargingStationExistByStationId?(tenantId: number, stationId: string): Promise<boolean>;
+    /**
+     * Receive a message from the Network Connection.
+     * Timestamp here should be when the message was received from the charger.
+     * If CitrineOS is running behind cloud infrastructure, it is optimal for the timestamp to be generated when the infrastructure receives the message rather than when CitrineOS is first notified.
+     * Otherwise, lag or outages could result in a desync, causing CitrineOS to process messages as if they had been generated long after the charging station actually sent them.
+     *
+     * @param identifier Unique identifier for the charging station, i.e. the combination of tenantId and stationId.
+     * @param message The unvalidated, raw OCPP text, i.e. [2, "123", "Heartbeat", {}]
+     * @param timestamp Time at which the message was received from the charger.
+     * @param protocol The OCPP protocol version of the message
+     * @returns true if the message was successfully processed, false otherwise
+     */
+    onMessage(identifier: string, message: string, timestamp: Date, protocol: string): Promise<boolean>;
+}

package/dist/interfaces/router/Router.js

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

package/dist/interfaces/router/Router.js.map

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

package/dist/interfaces/router/index.d.ts

@@ -0,0 +1,5 @@
+export { AbstractMessageRouter } from './AbstractRouter.js';
+export type { AuthenticationOptions } from './AuthenticationOptions.js';
+export type { IAuthenticator } from './Authenticator.js';
+export type { INetworkConnection } from './INetworkConnection.js';
+export type { IMessageRouter } from './Router.js';

package/dist/interfaces/router/index.js

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

package/dist/interfaces/router/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/interfaces/router/index.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,EAAE;AACF,sCAAsC;AAEtC,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC"}

package/dist/interfaces/tenant.d.ts

@@ -0,0 +1,4 @@
+export declare class TenantContextManager {
+    private static readonly schemaPrefix;
+    static getSchemaForTenant(tenantId: number): string;
+}

package/dist/interfaces/tenant.js

@@ -0,0 +1,10 @@
+// SPDX-FileCopyrightText: 2025 Contributors to the CitrineOS Project
+//
+// SPDX-License-Identifier: Apache-2.0
+export class TenantContextManager {
+    static schemaPrefix = 'tenant_';
+    static getSchemaForTenant(tenantId) {
+        return `${this.schemaPrefix}${tenantId}`;
+    }
+}
+//# sourceMappingURL=tenant.js.map

package/dist/interfaces/tenant.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tenant.js","sourceRoot":"","sources":["../../src/interfaces/tenant.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,EAAE;AACF,sCAAsC;AACtC,MAAM,OAAO,oBAAoB;IACvB,MAAM,CAAU,YAAY,GAAG,SAAS,CAAC;IAEjD,MAAM,CAAC,kBAAkB,CAAC,QAAgB;QACxC,OAAO,GAAG,IAAI,CAAC,YAAY,GAAG,QAAQ,EAAE,CAAC;IAC3C,CAAC"}

package/dist/money/Currency.d.ts

@@ -0,0 +1,33 @@
+/**
+ * ISO-4217 currency codes.
+ */
+declare const CURRENCY_CODES: readonly ["USD", "EUR", "CAD", "GBP"];
+export type CurrencyCode = (typeof CURRENCY_CODES)[number];
+export declare function isCurrencyCode(value: string): value is CurrencyCode;
+export declare function currencyCode(value: string): CurrencyCode;
+declare const CURRENCY_SCALES: readonly [2];
+/**
+ * Represents the scale of the currency.
+ *
+ * - `2`: The minor unit is 1/100 of the major unit.
+ */
+type CurrencyScale = (typeof CURRENCY_SCALES)[number];
+export declare function isCurrencyScale(value: number): value is CurrencyScale;
+export declare function currencyScale(value: number): CurrencyScale;
+/**
+ * Represents a currency with decimal precision.
+ *
+ * To add support for a currency:
+ *  1. Add the new currency code to the {@link CURRENCY_CODES} array.
+ *  2. Create a corresponding mapping in the {@link SUPPORTED_CURRENCIES} map.
+ */
+export declare class Currency {
+    private static readonly SUPPORTED_CURRENCIES;
+    private readonly _code;
+    private readonly _scale;
+    constructor(code: string | CurrencyCode, scale: number | CurrencyScale);
+    get code(): "USD" | "EUR" | "CAD" | "GBP";
+    get scale(): 2;
+    static of(code: string | CurrencyCode): Currency;
+}
+export {};

package/dist/money/Currency.js

@@ -0,0 +1,59 @@
+// SPDX-FileCopyrightText: 2025 Contributors to the CitrineOS Project
+//
+// SPDX-License-Identifier: Apache-2.0
+import { assert } from '../assertion/assertion.js';
+/**
+ * ISO-4217 currency codes.
+ */
+const CURRENCY_CODES = ['USD', 'EUR', 'CAD', 'GBP'];
+export function isCurrencyCode(value) {
+    return CURRENCY_CODES.includes(value);
+}
+export function currencyCode(value) {
+    assert(isCurrencyCode(value), `Unsupported currency code: ${value}`);
+    return value;
+}
+const CURRENCY_SCALES = [2];
+export function isCurrencyScale(value) {
+    return CURRENCY_SCALES.includes(value);
+}
+export function currencyScale(value) {
+    assert(isCurrencyScale(value), `Unsupported currency scale: ${value}`);
+    return value;
+}
+/**
+ * Represents a currency with decimal precision.
+ *
+ * To add support for a currency:
+ *  1. Add the new currency code to the {@link CURRENCY_CODES} array.
+ *  2. Create a corresponding mapping in the {@link SUPPORTED_CURRENCIES} map.
+ */
+export class Currency {
+    static SUPPORTED_CURRENCIES = {
+        USD: new Currency('USD', 2),
+        EUR: new Currency('EUR', 2),
+        CAD: new Currency('CAD', 2),
+        GBP: new Currency('GBP', 2),
+    };
+    _code;
+    _scale;
+    constructor(code, scale) {
+        this._code = currencyCode(code);
+        this._scale = currencyScale(scale);
+    }
+    get code() {
+        return this._code;
+    }
+    get scale() {
+        return this._scale;
+    }
+    static of(code) {
+        assert(isCurrencyCode(code), `Unsupported currency code: ${code}`);
+        const currency = Currency.SUPPORTED_CURRENCIES[code];
+        if (currency === undefined) {
+            throw Error(`${code} currency is not supported`);
+        }
+        return currency;
+    }
+}
+//# sourceMappingURL=Currency.js.map