@zetra/citrineos-base 1.8.3-fork.1

package/dist/interfaces/dto/variable.status.dto.js

@@ -0,0 +1,28 @@
+// SPDX-FileCopyrightText: 2025 Contributors to the CitrineOS Project
+//
+// SPDX-License-Identifier: Apache-2.0
+import { z } from 'zod';
+import { BaseSchema } from './types/base.dto.js';
+import { StatusInfoSchema } from './types/location.js';
+import { VariableAttributeSchema } from './variable.attribute.dto.js';
+export const VariableStatusSchema = BaseSchema.extend({
+    id: z.number().int().optional(),
+    value: z.string().max(4000),
+    status: z.string(),
+    statusInfo: StatusInfoSchema.nullable().optional(),
+    variable: VariableAttributeSchema,
+    variableAttributeId: z.number().int().nullable().optional(),
+});
+export const VariableStatusProps = VariableStatusSchema.keyof().enum;
+export const VariableStatusCreateSchema = VariableStatusSchema.omit({
+    id: true,
+    tenant: true,
+    variable: true,
+    updatedAt: true,
+    createdAt: true,
+});
+export const variableStatusSchemas = {
+    VariableStatus: VariableStatusSchema,
+    VariableStatusCreate: VariableStatusCreateSchema,
+};
+//# sourceMappingURL=variable.status.dto.js.map

package/dist/interfaces/dto/variable.status.dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"variable.status.dto.js","sourceRoot":"","sources":["../../../src/interfaces/dto/variable.status.dto.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,EAAE;AACF,sCAAsC;AAEtC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,uBAAuB,EAAE,MAAM,6BAA6B,CAAC;AAEtE,MAAM,CAAC,MAAM,oBAAoB,GAAG,UAAU,CAAC,MAAM,CAAC;IACpD,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAC/B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC;IAC3B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,UAAU,EAAE,gBAAgB,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAClD,QAAQ,EAAE,uBAAuB;IACjC,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CAC5D,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,mBAAmB,GAAG,oBAAoB,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC;AAIrE,MAAM,CAAC,MAAM,0BAA0B,GAAG,oBAAoB,CAAC,IAAI,CAAC;IAClE,EAAE,EAAE,IAAI;IACR,MAAM,EAAE,IAAI;IACZ,QAAQ,EAAE,IAAI;IACd,SAAS,EAAE,IAAI;IACf,SAAS,EAAE,IAAI;CAChB,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,cAAc,EAAE,oBAAoB;IACpC,oBAAoB,EAAE,0BAA0B;CACjD,CAAC"}

package/dist/interfaces/files/fileAccess.d.ts

@@ -0,0 +1,3 @@
+export interface IFileAccess {
+    getFileURL(): string;
+}

package/dist/interfaces/files/fileAccess.js

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

package/dist/interfaces/files/fileAccess.js.map

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

package/dist/interfaces/files/fileStorage.d.ts

@@ -0,0 +1,20 @@
+import { Buffer } from 'node:buffer';
+export interface IFileStorage {
+    /**
+     *
+     * @param fileName Name of the file
+     * @param content File content
+     * @param filePath The path of the file, if not in root. Used as the bucket name for S3.
+     *
+     * @returns The ID of the file
+     */
+    saveFile(fileName: string, content: Buffer, filePath?: string): Promise<string>;
+    /**
+     *
+     * @param id The ID of the file
+     * @param filePath The path of the file, if not included in the ID. Used as the bucket name for S3.
+     *
+     * @returns The file content
+     */
+    getFile(id: string, filePath?: string): Promise<string | undefined>;
+}

package/dist/interfaces/files/fileStorage.js

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

package/dist/interfaces/files/fileStorage.js.map

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

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

@@ -0,0 +1,2 @@
+export type { IFileStorage } from './fileStorage.js';
+export type { IFileAccess } from './fileAccess.js';

package/dist/interfaces/files/index.js

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

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

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

package/dist/interfaces/messages/AbstractMessageHandler.d.ts

@@ -0,0 +1,44 @@
+import type { ILogObj } from 'tslog';
+import { Logger } from 'tslog';
+import type { IMessage, IMessageHandler, OcppRequest, OcppResponse } from '../../index.js';
+import { OcppError } from '../../index.js';
+import type { SystemConfig } from '../../config/types.js';
+import type { CallAction } from '../../ocpp/rpc/message.js';
+import type { IModule } from '../modules/index.js';
+import type { HandlerProperties } from './index.js';
+/**
+ * Abstract class implementing {@link IMessageHandler}.
+ */
+export declare abstract class AbstractMessageHandler implements IMessageHandler {
+    /**
+     * Fields
+     */
+    protected _config: SystemConfig;
+    protected _module?: IModule;
+    protected _logger: Logger<ILogObj>;
+    /**
+     * Constructor
+     *
+     * @param config The system configuration.
+     * @param logger [Optional] The logger to use.
+     */
+    constructor(config: SystemConfig, logger?: Logger<ILogObj>, module?: IModule);
+    /**
+     * Getter & Setter
+     */
+    get module(): IModule | undefined;
+    set module(value: IModule | undefined);
+    /**
+     * Methods
+     */
+    handle(message: IMessage<OcppRequest | OcppResponse | OcppError>, props?: HandlerProperties): Promise<void>;
+    /**
+     * Abstract Methods
+     */
+    abstract subscribe(identifier: string, actions?: CallAction[], filter?: {
+        [k: string]: string;
+    }): Promise<boolean>;
+    abstract unsubscribe(identifier: string): Promise<boolean>;
+    abstract shutdown(): Promise<void>;
+    abstract initConnection(): Promise<void>;
+}

package/dist/interfaces/messages/AbstractMessageHandler.js

@@ -0,0 +1,42 @@
+import { Logger } from 'tslog';
+import { OcppError } from '../../index.js';
+/**
+ * Abstract class implementing {@link IMessageHandler}.
+ */
+export class AbstractMessageHandler {
+    /**
+     * Fields
+     */
+    _config;
+    _module;
+    _logger;
+    /**
+     * Constructor
+     *
+     * @param config The system configuration.
+     * @param logger [Optional] The logger to use.
+     */
+    constructor(config, logger, module) {
+        this._config = config;
+        this._module = module;
+        this._logger = logger
+            ? logger.getSubLogger({ name: this.constructor.name })
+            : new Logger({ name: this.constructor.name });
+    }
+    /**
+     * Getter & Setter
+     */
+    get module() {
+        return this._module;
+    }
+    set module(value) {
+        this._module = value;
+    }
+    /**
+     * Methods
+     */
+    async handle(message, props) {
+        await this._module?.handle(message, props);
+    }
+}
+//# sourceMappingURL=AbstractMessageHandler.js.map

package/dist/interfaces/messages/AbstractMessageHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractMessageHandler.js","sourceRoot":"","sources":["../../../src/interfaces/messages/AbstractMessageHandler.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAM3C;;GAEG;AACH,MAAM,OAAgB,sBAAsB;IAC1C;;OAEG;IAEO,OAAO,CAAe;IACtB,OAAO,CAAW;IAClB,OAAO,CAAkB;IAEnC;;;;;OAKG;IACH,YAAY,MAAoB,EAAE,MAAwB,EAAE,MAAgB;QAC1E,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,MAAM;YACnB,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;YACtD,CAAC,CAAC,IAAI,MAAM,CAAU,EAAE,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;OAEG;IAEH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IACD,IAAI,MAAM,CAAC,KAA0B;QACnC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;IACvB,CAAC;IAED;;OAEG;IAEH,KAAK,CAAC,MAAM,CACV,OAAyD,EACzD,KAAyB;QAEzB,MAAM,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC7C,CAAC;CAcF"}

package/dist/interfaces/messages/AbstractMessageSender.d.ts

@@ -0,0 +1,17 @@
+import type { ILogObj } from 'tslog';
+import { Logger } from 'tslog';
+import type { SystemConfig } from '../../config/types.js';
+export declare abstract class AbstractMessageSender {
+    /**
+     * Fields
+     */
+    protected _config: SystemConfig;
+    protected _logger: Logger<ILogObj>;
+    /**
+     * Constructor
+     *
+     * @param config The system configuration.
+     * @param logger [Optional] The logger to use.
+     */
+    constructor(config: SystemConfig, logger?: Logger<ILogObj>);
+}

package/dist/interfaces/messages/AbstractMessageSender.js

@@ -0,0 +1,24 @@
+// SPDX-FileCopyrightText: 2025 Contributors to the CitrineOS Project
+//
+// SPDX-License-Identifier: Apache-2.0
+import { Logger } from 'tslog';
+export class AbstractMessageSender {
+    /**
+     * Fields
+     */
+    _config;
+    _logger;
+    /**
+     * Constructor
+     *
+     * @param config The system configuration.
+     * @param logger [Optional] The logger to use.
+     */
+    constructor(config, logger) {
+        this._config = config;
+        this._logger = logger
+            ? logger.getSubLogger({ name: this.constructor.name })
+            : new Logger({ name: this.constructor.name });
+    }
+}
+//# sourceMappingURL=AbstractMessageSender.js.map

package/dist/interfaces/messages/AbstractMessageSender.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractMessageSender.js","sourceRoot":"","sources":["../../../src/interfaces/messages/AbstractMessageSender.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,EAAE;AACF,sCAAsC;AAGtC,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAG/B,MAAM,OAAgB,qBAAqB;IACzC;;OAEG;IAEO,OAAO,CAAe;IACtB,OAAO,CAAkB;IAEnC;;;;;OAKG;IACH,YAAY,MAAoB,EAAE,MAAwB;QACxD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,MAAM;YACnB,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;YACtD,CAAC,CAAC,IAAI,MAAM,CAAU,EAAE,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC;IAC3D,CAAC;CACF"}

package/dist/interfaces/messages/Message.d.ts

@@ -0,0 +1,90 @@
+import type { IMessageContext, OcppError, OcppRequest, OcppResponse } from '../../index.js';
+import type { CallAction, OCPPVersionType } from '../../ocpp/rpc/message.js';
+import { EventGroup, MessageOrigin, MessageState } from './index.js';
+/**
+ * Message
+ *
+ * The base interface for all messages traversing the system.
+ *
+ */
+export interface IMessage<T extends OcppRequest | OcppResponse> {
+    /**
+     * The event group of the source module
+     */
+    get origin(): MessageOrigin;
+    set origin(value: MessageOrigin);
+    /**
+     * The event group of the target module
+     */
+    get eventGroup(): EventGroup;
+    set eventGroup(value: EventGroup);
+    /**
+     * The event type (within the event group)
+     */
+    get action(): CallAction;
+    set action(value: CallAction);
+    /**
+     * The message state representative of the roundtrip status
+     */
+    get state(): MessageState;
+    set state(value: MessageState);
+    /**
+     * The context of the message (the module that sent the message)
+     */
+    get context(): IMessageContext;
+    set context(value: IMessageContext);
+    /**
+     * The payload of the message (the data sent with the message)
+     */
+    get payload(): T;
+    set payload(value: T);
+    /**
+     * The protocol of the message (ocpp1.6, ocpp2.0.1, etc)
+     */
+    get protocol(): OCPPVersionType;
+    set protocol(value: OCPPVersionType);
+}
+/**
+ * Default implementation of IMessage
+ */
+export declare class Message<T extends OcppRequest | OcppResponse | OcppError> implements IMessage<T> {
+    /**
+     * Fields
+     */
+    protected _origin: MessageOrigin;
+    protected _eventGroup: EventGroup;
+    protected _action: CallAction;
+    protected _state: MessageState;
+    protected _context: IMessageContext;
+    protected _payload: T;
+    protected _protocol: OCPPVersionType;
+    /**
+     * Constructs a new instance of Message.
+     *
+     * @param {MessageOrigin} origin - The origin of the message.
+     * @param {EventGroup} eventGroup - The event group of the message.
+     * @param {CallAction} action - The action of the message.
+     * @param {MessageState} state - The state of the message.
+     * @param {IMessageContext} context - The context of the message.
+     * @param {T} payload - The payload of the message.
+     * @param {OCPPVersionType} [protocol] - The protocol of the message, example "ocpp1.6".
+     */
+    constructor(origin: MessageOrigin, eventGroup: EventGroup, action: CallAction, state: MessageState, context: IMessageContext, payload: T, protocol: OCPPVersionType);
+    /**
+     * Getter & Setter
+     */
+    get origin(): MessageOrigin;
+    get eventGroup(): EventGroup;
+    get action(): CallAction;
+    get state(): MessageState;
+    get context(): IMessageContext;
+    get payload(): T;
+    get protocol(): OCPPVersionType;
+    set origin(value: MessageOrigin);
+    set eventGroup(value: EventGroup);
+    set action(value: CallAction);
+    set state(value: MessageState);
+    set context(value: IMessageContext);
+    set payload(value: T);
+    set protocol(value: OCPPVersionType);
+}

package/dist/interfaces/messages/Message.js

@@ -0,0 +1,85 @@
+// SPDX-FileCopyrightText: 2025 Contributors to the CitrineOS Project
+//
+// SPDX-License-Identifier: Apache-2.0
+import { EventGroup, MessageOrigin, MessageState } from './index.js';
+/**
+ * Default implementation of IMessage
+ */
+export class Message {
+    /**
+     * Fields
+     */
+    _origin;
+    _eventGroup;
+    _action;
+    _state;
+    _context;
+    _payload;
+    _protocol;
+    /**
+     * Constructs a new instance of Message.
+     *
+     * @param {MessageOrigin} origin - The origin of the message.
+     * @param {EventGroup} eventGroup - The event group of the message.
+     * @param {CallAction} action - The action of the message.
+     * @param {MessageState} state - The state of the message.
+     * @param {IMessageContext} context - The context of the message.
+     * @param {T} payload - The payload of the message.
+     * @param {OCPPVersionType} [protocol] - The protocol of the message, example "ocpp1.6".
+     */
+    constructor(origin, eventGroup, action, state, context, payload, protocol) {
+        this._origin = origin;
+        this._eventGroup = eventGroup;
+        this._action = action;
+        this._state = state;
+        this._context = context;
+        this._payload = payload;
+        this._protocol = protocol;
+    }
+    /**
+     * Getter & Setter
+     */
+    get origin() {
+        return this._origin;
+    }
+    get eventGroup() {
+        return this._eventGroup;
+    }
+    get action() {
+        return this._action;
+    }
+    get state() {
+        return this._state;
+    }
+    get context() {
+        return this._context;
+    }
+    get payload() {
+        return this._payload;
+    }
+    get protocol() {
+        return this._protocol;
+    }
+    set origin(value) {
+        this._origin = value;
+    }
+    set eventGroup(value) {
+        this._eventGroup = value;
+    }
+    set action(value) {
+        this._action = value;
+    }
+    set state(value) {
+        this._state = value;
+    }
+    set context(value) {
+        this._context = value;
+    }
+    set payload(value) {
+        this._payload = value;
+    }
+    set protocol(value) {
+        this._protocol = value;
+    }
+}
+//# sourceMappingURL=Message.js.map

package/dist/interfaces/messages/Message.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Message.js","sourceRoot":"","sources":["../../../src/interfaces/messages/Message.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,EAAE;AACF,sCAAsC;AAItC,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAmDrE;;GAEG;AACH,MAAM,OAAO,OAAO;IAClB;;OAEG;IACO,OAAO,CAAgB;IACvB,WAAW,CAAa;IACxB,OAAO,CAAa;IACpB,MAAM,CAAe;IACrB,QAAQ,CAAkB;IAC1B,QAAQ,CAAI;IACZ,SAAS,CAAkB;IAErC;;;;;;;;;;OAUG;IACH,YACE,MAAqB,EACrB,UAAsB,EACtB,MAAkB,EAClB,KAAmB,EACnB,OAAwB,EACxB,OAAU,EACV,QAAyB;QAEzB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IACD,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IACD,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IACD,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IACD,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IACD,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IACD,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IACD,IAAI,MAAM,CAAC,KAAoB;QAC7B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;IACvB,CAAC;IACD,IAAI,UAAU,CAAC,KAAiB;QAC9B,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;IAC3B,CAAC;IACD,IAAI,MAAM,CAAC,KAAiB;QAC1B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;IACvB,CAAC;IACD,IAAI,KAAK,CAAC,KAAmB;QAC3B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IACD,IAAI,OAAO,CAAC,KAAsB;QAChC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;IACxB,CAAC;IACD,IAAI,OAAO,CAAC,KAAQ;QAClB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;IACxB,CAAC;IACD,IAAI,QAAQ,CAAC,KAAsB;QACjC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;IACzB,CAAC;CACF"}

package/dist/interfaces/messages/MessageConfirmation.d.ts

@@ -0,0 +1,10 @@
+/**
+ * MessageConfirmation
+ *
+ * The interface for all message confirmations.
+ *
+ */
+export interface IMessageConfirmation {
+    success: boolean;
+    payload?: string | object;
+}

package/dist/interfaces/messages/MessageConfirmation.js

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

package/dist/interfaces/messages/MessageConfirmation.js.map

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

package/dist/interfaces/messages/MessageContext.d.ts

@@ -0,0 +1,11 @@
+/**
+ * IMessageContext
+ *
+ * The context of any OCPP message.
+ */
+export interface IMessageContext {
+    correlationId: string;
+    tenantId: number;
+    stationId: string;
+    timestamp: string;
+}

package/dist/interfaces/messages/MessageContext.js

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

package/dist/interfaces/messages/MessageContext.js.map

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

package/dist/interfaces/messages/MessageHandler.d.ts

@@ -0,0 +1,43 @@
+import type { IMessage, OcppRequest, OcppResponse } from '../../index.js';
+import type { CallAction } from '../../ocpp/rpc/message.js';
+import type { IModule } from '../modules/index.js';
+import type { HandlerProperties } from './index.js';
+/**
+ * MessageHandler
+ *
+ * The interface for all message handlers.
+ *
+ */
+export interface IMessageHandler {
+    /**
+     * Subscribes to messages based on actions and context filters.
+     *
+     * @param identifier - The identifier to subscribe for.
+     * @param actions - Optional. The list of call actions to subscribe to.
+     * @param filter - Optional. An additional message context filter. **Note**: Might not be supported by all implementations. @see {@link IMessageContext} for available attributes.
+     * @returns A promise that resolves to a boolean value indicating whether the initialization was successful.
+     */
+    subscribe(identifier: string, actions?: CallAction[], filter?: {
+        [k: string]: string;
+    }): Promise<boolean>;
+    /**
+     * Unsubscribe from messages. E.g. when a connection drops.
+     *
+     * @param identifier - The identifier to unsubscribe from.
+     * @returns A promise that resolves to a boolean value indicating whether the unsubscription was successful.
+     */
+    unsubscribe(identifier: string): Promise<boolean>;
+    /**
+     * Handles incoming messages.
+     * @param message - The message to be handled.
+     * @param props - Optional properties for the handler.
+     */
+    handle(message: IMessage<OcppRequest | OcppResponse>, props?: HandlerProperties): void;
+    /**
+     * Shuts down the handler. Unregister all handlers and opening up any resources.
+     */
+    shutdown(): Promise<void>;
+    get module(): IModule | undefined;
+    set module(value: IModule | undefined);
+    initConnection(): Promise<void>;
+}

package/dist/interfaces/messages/MessageHandler.js

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

package/dist/interfaces/messages/MessageHandler.js.map

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

package/dist/interfaces/messages/MessageSender.d.ts

@@ -0,0 +1,43 @@
+import type { IMessage, IMessageConfirmation, OcppRequest, OcppResponse } from '../../index.js';
+import { OcppError } from '../../index.js';
+import { MessageState } from './index.js';
+/**
+ * IMessageSender
+ *
+ * Represents an interface for sending messages.
+ *
+ * All implementations of this interface should carry any context from the {@link IMessage}
+ * to be sent as metadata in the underlying message transport. This will allow to route
+ * messages to the correct module and filter them accordingly.
+ */
+export interface IMessageSender {
+    /**
+     * Sends a request message.
+     *
+     * @param message - The message object.
+     * @param payload - The payload object.
+     * @returns A promise that resolves to the message confirmation.
+     */
+    sendRequest(message: IMessage<OcppRequest>, payload?: OcppRequest): Promise<IMessageConfirmation>;
+    /**
+     * Sends a response message.
+     *
+     * @param message - The message object.
+     * @param payload - The payload object.
+     * @returns A promise that resolves to the message confirmation.
+     */
+    sendResponse(message: IMessage<OcppResponse | OcppError>, payload?: OcppResponse | OcppError): Promise<IMessageConfirmation>;
+    /**
+     * Sends a message.
+     *
+     * @param message - The message object.
+     * @param payload - The payload object.
+     * @param state - The message state.
+     * @returns A promise that resolves to the message confirmation.
+     */
+    send(message: IMessage<OcppRequest | OcppResponse | OcppError>, payload?: OcppRequest | OcppResponse | OcppError, state?: MessageState): Promise<IMessageConfirmation>;
+    /**
+     * Shuts down the sender.
+     */
+    shutdown(): Promise<void>;
+}

package/dist/interfaces/messages/MessageSender.js

@@ -0,0 +1,6 @@
+// SPDX-FileCopyrightText: 2025 Contributors to the CitrineOS Project
+//
+// SPDX-License-Identifier: Apache-2.0
+import { OcppError } from '../../index.js';
+import { MessageState } from './index.js';
+//# sourceMappingURL=MessageSender.js.map

package/dist/interfaces/messages/MessageSender.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MessageSender.js","sourceRoot":"","sources":["../../../src/interfaces/messages/MessageSender.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,EAAE;AACF,sCAAsC;AAGtC,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC"}

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

@@ -0,0 +1,44 @@
+export type HandlerProperties = string | object | undefined;
+export declare class RetryMessageError extends Error {
+    constructor(retryReason: string);
+}
+export declare enum MessageState {
+    Request = 1,
+    Response = 2,
+    Unknown = 99
+}
+export declare enum MessageOrigin {
+    ChargingStationManagementSystem = "csms",
+    ChargingStation = "cs"
+}
+export declare enum EventGroup {
+    All = "all",
+    Router = "router",
+    Modules = "modules",
+    Certificates = "certificates",
+    Configuration = "configuration",
+    EVDriver = "evdriver",
+    Monitoring = "monitoring",
+    Reporting = "reporting",
+    SmartCharging = "smartcharging",
+    Tenant = "tenant",
+    Transactions = "transactions",
+    Cdrs = "cdrs",
+    ChargingProfiles = "chargingprofiles",
+    Commands = "commands",
+    Locations = "locations",
+    Sessions = "sessions",
+    Tariffs = "tariffs",
+    Tokens = "tokens",
+    Versions = "versions",
+    Credentials = "credentials"
+}
+export declare const eventGroupFromString: (source: string) => EventGroup;
+export { AbstractMessageHandler } from './AbstractMessageHandler.js';
+export { AbstractMessageSender } from './AbstractMessageSender.js';
+export { Message } from './Message.js';
+export type { IMessage } from './Message.js';
+export type { IMessageConfirmation } from './MessageConfirmation.js';
+export type { IMessageContext } from './MessageContext.js';
+export type { IMessageHandler } from './MessageHandler.js';
+export type { IMessageSender } from './MessageSender.js';