@zetra/citrineos-transactions 1.8.3-fork.1

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { TransactionsOcpp201Api } from './module/2.0.1/MessageApi.js';
+export { TransactionsDataApi } from './module/DataApi.js';
+export type { ITransactionsModuleApi } from './module/interface.js';
+export { TransactionsModule } from './module/module.js';

package/dist/index.js

@@ -0,0 +1,7 @@
+// SPDX-FileCopyrightText: 2025 Contributors to the CitrineOS Project
+//
+// SPDX-License-Identifier: Apache-2.0
+export { TransactionsOcpp201Api } from './module/2.0.1/MessageApi.js';
+export { TransactionsDataApi } from './module/DataApi.js';
+export { TransactionsModule } from './module/module.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

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

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

@@ -0,0 +1,30 @@
+import type { ILogObj } from 'tslog';
+import { Logger } from 'tslog';
+import type { ITransactionsModuleApi } from '../interface.js';
+import { TransactionsModule } from '../module.js';
+import type { CallAction, IMessageConfirmation } from '@citrineos/base';
+import { AbstractModuleApi, OCPP2_0_1 } from '@citrineos/base';
+import type { FastifyInstance } from 'fastify';
+/**
+ * Server API for the transaction module.
+ */
+export declare class TransactionsOcpp201Api extends AbstractModuleApi<TransactionsModule> implements ITransactionsModuleApi {
+    /**
+     * Constructor for the class.
+     *
+     * @param {TransactionsModule} transactionModule - The transaction module.
+     * @param {FastifyInstance} server - The server instance.
+     * @param {Logger<ILogObj>} [logger] - Optional logger.
+     */
+    constructor(transactionModule: TransactionsModule, server: FastifyInstance, logger?: Logger<ILogObj>);
+    costUpdated(identifier: string[], request: OCPP2_0_1.CostUpdatedRequest, callbackUrl?: string, tenantId?: number): Promise<IMessageConfirmation[]>;
+    getTransactionStatus(identifier: string[], request: OCPP2_0_1.GetTransactionStatusRequest, callbackUrl?: string, tenantId?: number): Promise<IMessageConfirmation[]>;
+    /**
+     * Overrides superclass method to generate the URL path based on the input {@link CallAction}
+     * and the module's endpoint prefix configuration.
+     *
+     * @param {CallAction} input - The input {@link CallAction}.
+     * @return {string} - The generated URL path.
+     */
+    protected _toMessagePath(input: CallAction): string;
+}

package/dist/module/2.0.1/MessageApi.js

@@ -0,0 +1,62 @@
+// SPDX-FileCopyrightText: 2025 Contributors to the CitrineOS Project
+//
+// SPDX-License-Identifier: Apache-2.0
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { Logger } from 'tslog';
+import { TransactionsModule } from '../module.js';
+import { AbstractModuleApi, AsMessageEndpoint, DEFAULT_TENANT_ID, OCPP2_0_1, OCPP2_0_1_CallAction, OCPPVersion, } from '@citrineos/base';
+/**
+ * Server API for the transaction module.
+ */
+export class TransactionsOcpp201Api extends AbstractModuleApi {
+    /**
+     * Constructor for the class.
+     *
+     * @param {TransactionsModule} transactionModule - The transaction module.
+     * @param {FastifyInstance} server - The server instance.
+     * @param {Logger<ILogObj>} [logger] - Optional logger.
+     */
+    constructor(transactionModule, server, logger) {
+        super(transactionModule, server, OCPPVersion.OCPP2_0_1, logger);
+    }
+    async costUpdated(identifier, request, callbackUrl, tenantId = DEFAULT_TENANT_ID) {
+        const results = identifier.map((id) => this._module.sendCall(id, tenantId, OCPPVersion.OCPP2_0_1, OCPP2_0_1_CallAction.CostUpdated, request, callbackUrl));
+        return Promise.all(results);
+    }
+    getTransactionStatus(identifier, request, callbackUrl, tenantId = DEFAULT_TENANT_ID) {
+        const results = identifier.map((id) => this._module.sendCall(id, tenantId, OCPPVersion.OCPP2_0_1, OCPP2_0_1_CallAction.GetTransactionStatus, request, callbackUrl));
+        return Promise.all(results);
+    }
+    /**
+     * Overrides superclass method to generate the URL path based on the input {@link CallAction}
+     * and the module's endpoint prefix configuration.
+     *
+     * @param {CallAction} input - The input {@link CallAction}.
+     * @return {string} - The generated URL path.
+     */
+    _toMessagePath(input) {
+        const endpointPrefix = this._module.config.modules.transactions.endpointPrefix;
+        return super._toMessagePath(input, endpointPrefix);
+    }
+}
+__decorate([
+    AsMessageEndpoint(OCPP2_0_1_CallAction.CostUpdated, OCPP2_0_1.CostUpdatedRequestSchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Array, Object, String, Number]),
+    __metadata("design:returntype", Promise)
+], TransactionsOcpp201Api.prototype, "costUpdated", null);
+__decorate([
+    AsMessageEndpoint(OCPP2_0_1_CallAction.GetTransactionStatus, OCPP2_0_1.GetTransactionStatusRequestSchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Array, Object, String, Number]),
+    __metadata("design:returntype", Promise)
+], TransactionsOcpp201Api.prototype, "getTransactionStatus", null);
+//# sourceMappingURL=MessageApi.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"MessageApi.js","sourceRoot":"","sources":["../../../src/module/2.0.1/MessageApi.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,EAAE;AACF,sCAAsC;;;;;;;;;;AAGtC,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAElD,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EACjB,iBAAiB,EACjB,SAAS,EACT,oBAAoB,EACpB,WAAW,GACZ,MAAM,iBAAiB,CAAC;AAGzB;;GAEG;AACH,MAAM,OAAO,sBACX,SAAQ,iBAAqC;IAG7C;;;;;;OAMG;IACH,YACE,iBAAqC,EACrC,MAAuB,EACvB,MAAwB;QAExB,KAAK,CAAC,iBAAiB,EAAE,MAAM,EAAE,WAAW,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAGK,AAAN,KAAK,CAAC,WAAW,CACf,UAAoB,EACpB,OAAqC,EACrC,WAAoB,EACpB,WAAmB,iBAAiB;QAEpC,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CACpC,IAAI,CAAC,OAAO,CAAC,QAAQ,CACnB,EAAE,EACF,QAAQ,EACR,WAAW,CAAC,SAAS,EACrB,oBAAoB,CAAC,WAAW,EAChC,OAAO,EACP,WAAW,CACZ,CACF,CAAC;QACF,OAAO,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAMD,oBAAoB,CAClB,UAAoB,EACpB,OAA8C,EAC9C,WAAoB,EACpB,WAAmB,iBAAiB;QAEpC,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CACpC,IAAI,CAAC,OAAO,CAAC,QAAQ,CACnB,EAAE,EACF,QAAQ,EACR,WAAW,CAAC,SAAS,EACrB,oBAAoB,CAAC,oBAAoB,EACzC,OAAO,EACP,WAAW,CACZ,CACF,CAAC;QACF,OAAO,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;OAMG;IACO,cAAc,CAAC,KAAiB;QACxC,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC;QAC/E,OAAO,KAAK,CAAC,cAAc,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;IACrD,CAAC;CACF;AArDO;IADL,iBAAiB,CAAC,oBAAoB,CAAC,WAAW,EAAE,SAAS,CAAC,wBAAwB,CAAC;;;;yDAkBvF;AAMD;IAJC,iBAAiB,CAChB,oBAAoB,CAAC,oBAAoB,EACzC,SAAS,CAAC,iCAAiC,CAC5C;;;;kEAkBA"}

package/dist/module/CostCalculator.d.ts

@@ -0,0 +1,24 @@
+import type { ITariffRepository } from '@citrineos/data';
+import type { ILogObj } from 'tslog';
+import { Logger } from 'tslog';
+import { TransactionService } from './TransactionService.js';
+export declare class CostCalculator {
+    private readonly _logger;
+    private readonly _tariffRepository;
+    private readonly _transactionService;
+    constructor(tariffRepository: ITariffRepository, transactionService: TransactionService, logger?: Logger<ILogObj>);
+    /**
+     * Calculates the total cost for a transaction.
+     *
+     * Computes the cost based on `stationId` and `totalKwh`.
+     * If `totalKwh` is not provided, it is calculated for given transaction.
+     *
+     * @param stationId - The identifier of the station.
+     * @param transactionDbId - The identifier of the transaction.
+     * @param totalKwh - Optional. The total kilowatt-hours.
+     *
+     * @returns A promise that resolves to the total cost.
+     */
+    calculateTotalCost(tenantId: number, stationId: string, totalKwh: number): Promise<number>;
+    private _calculateTotalCost;
+}

package/dist/module/CostCalculator.js

@@ -0,0 +1,52 @@
+// SPDX-FileCopyrightText: 2025 Contributors to the CitrineOS Project
+//
+// SPDX-License-Identifier: Apache-2.0
+import { Money } from '@citrineos/base';
+import { Tariff } from '@citrineos/data';
+import { Logger } from 'tslog';
+import { TransactionService } from './TransactionService.js';
+export class CostCalculator {
+    _logger;
+    _tariffRepository;
+    _transactionService;
+    constructor(tariffRepository, transactionService, logger) {
+        this._tariffRepository = tariffRepository;
+        this._transactionService = transactionService;
+        this._logger = logger
+            ? logger.getSubLogger({ name: this.constructor.name })
+            : new Logger({ name: this.constructor.name });
+    }
+    /**
+     * Calculates the total cost for a transaction.
+     *
+     * Computes the cost based on `stationId` and `totalKwh`.
+     * If `totalKwh` is not provided, it is calculated for given transaction.
+     *
+     * @param stationId - The identifier of the station.
+     * @param transactionDbId - The identifier of the transaction.
+     * @param totalKwh - Optional. The total kilowatt-hours.
+     *
+     * @returns A promise that resolves to the total cost.
+     */
+    async calculateTotalCost(tenantId, stationId, totalKwh) {
+        return this._calculateTotalCost(tenantId, stationId, totalKwh);
+    }
+    async _calculateTotalCost(tenantId, stationId, totalKwh) {
+        // TODO: This is a temp workaround. We need to refactor the calculation of totalCost when tariff
+        //  implementation is finalized
+        this._logger.debug(`Calculating total cost for ${stationId} station and ${totalKwh} kWh`);
+        const tariff = await this._tariffRepository.findByStationId(tenantId, stationId);
+        if (tariff) {
+            this._logger.debug(`Tariff ${tariff.id} found for ${stationId} station`);
+            return Money.of(tariff.pricePerKwh, tariff.currency)
+                .multiply(totalKwh)
+                .roundToCurrencyScale()
+                .toNumber();
+        }
+        else {
+            this._logger.error(`Tariff not found for ${stationId} station`);
+            return 0;
+        }
+    }
+}
+//# sourceMappingURL=CostCalculator.js.map

package/dist/module/CostCalculator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CostCalculator.js","sourceRoot":"","sources":["../../src/module/CostCalculator.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,EAAE;AACF,sCAAsC;AACtC,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAExC,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAEzC,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAE7D,MAAM,OAAO,cAAc;IACR,OAAO,CAAkB;IAEzB,iBAAiB,CAAoB;IACrC,mBAAmB,CAAqB;IAEzD,YACE,gBAAmC,EACnC,kBAAsC,EACtC,MAAwB;QAExB,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAC;QAC1C,IAAI,CAAC,mBAAmB,GAAG,kBAAkB,CAAC;QAC9C,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;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,kBAAkB,CAAC,QAAgB,EAAE,SAAiB,EAAE,QAAgB;QAC5E,OAAO,IAAI,CAAC,mBAAmB,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;IACjE,CAAC;IAEO,KAAK,CAAC,mBAAmB,CAC/B,QAAgB,EAChB,SAAiB,EACjB,QAAgB;QAEhB,gGAAgG;QAChG,+BAA+B;QAC/B,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,8BAA8B,SAAS,gBAAgB,QAAQ,MAAM,CAAC,CAAC;QAC1F,MAAM,MAAM,GAAuB,MAAM,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAC7E,QAAQ,EACR,SAAS,CACV,CAAC;QACF,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,MAAM,CAAC,EAAE,cAAc,SAAS,UAAU,CAAC,CAAC;YACzE,OAAO,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,QAAQ,CAAC;iBACjD,QAAQ,CAAC,QAAQ,CAAC;iBAClB,oBAAoB,EAAE;iBACtB,QAAQ,EAAE,CAAC;QAChB,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,wBAAwB,SAAS,UAAU,CAAC,CAAC;YAChE,OAAO,CAAC,CAAC;QACX,CAAC;IACH,CAAC;CACF"}

package/dist/module/CostNotifier.d.ts

@@ -0,0 +1,27 @@
+import { AbstractModule } from '@citrineos/base';
+import type { ITransactionEventRepository } from '@citrineos/data';
+import { Transaction } from '@citrineos/data';
+import type { ILogObj } from 'tslog';
+import { Logger } from 'tslog';
+import { CostCalculator } from './CostCalculator.js';
+import { Scheduler } from './Scheduler.js';
+export declare class CostNotifier extends Scheduler {
+    private readonly _transactionEventRepository;
+    private readonly _module;
+    private readonly _costCalculator;
+    constructor(module: AbstractModule, transactionEventRepository: ITransactionEventRepository, costCalculator: CostCalculator, logger?: Logger<ILogObj>);
+    /**
+     * Repeatedly sends a CostUpdated call for an ongoing transaction based on the intervalSeconds.
+     * Stops sending requests once the transaction becomes inactive.
+     *
+     * @param {string} stationId - The identifier of the client connection.
+     * @param {string} transactionId - The identifier of the transaction.
+     * @param {number} intervalSeconds - The costUpdated interval in seconds.
+     * @param {number} tenantId - The identifier of the tenant.
+     * @return {void} This function does not return anything.
+     */
+    notifyWhileActive(stationId: string, transactionId: string, tenantId: number, intervalSeconds: number): void;
+    calculateCostAndNotify(transaction: Transaction, tenantId: number): Promise<void>;
+    private _tryNotify;
+    private _key;
+}

package/dist/module/CostNotifier.js

@@ -0,0 +1,60 @@
+// SPDX-FileCopyrightText: 2025 Contributors to the CitrineOS Project
+//
+// SPDX-License-Identifier: Apache-2.0
+import { AbstractModule, OCPP2_0_1_CallAction, OCPPVersion } from '@citrineos/base';
+import { Transaction } from '@citrineos/data';
+import { Logger } from 'tslog';
+import { CostCalculator } from './CostCalculator.js';
+import { Scheduler } from './Scheduler.js';
+export class CostNotifier extends Scheduler {
+    _transactionEventRepository;
+    _module;
+    _costCalculator;
+    constructor(module, transactionEventRepository, costCalculator, logger) {
+        super(logger);
+        this._transactionEventRepository = transactionEventRepository;
+        this._module = module;
+        this._costCalculator = costCalculator;
+    }
+    /**
+     * Repeatedly sends a CostUpdated call for an ongoing transaction based on the intervalSeconds.
+     * Stops sending requests once the transaction becomes inactive.
+     *
+     * @param {string} stationId - The identifier of the client connection.
+     * @param {string} transactionId - The identifier of the transaction.
+     * @param {number} intervalSeconds - The costUpdated interval in seconds.
+     * @param {number} tenantId - The identifier of the tenant.
+     * @return {void} This function does not return anything.
+     */
+    notifyWhileActive(stationId, transactionId, tenantId, intervalSeconds) {
+        this._logger.debug(`Scheduling periodic cost notifications for ${stationId} station, ${transactionId} transaction, ${tenantId} tenant`);
+        this.schedule(this._key(stationId, transactionId), () => this._tryNotify(stationId, transactionId, tenantId), intervalSeconds);
+    }
+    async calculateCostAndNotify(transaction, tenantId) {
+        const cost = await this._costCalculator.calculateTotalCost(tenantId, transaction.stationId, transaction.totalKwh);
+        await this._transactionEventRepository.updateTransactionTotalCostById(tenantId, cost, transaction.id);
+        await this._module.sendCall(transaction.stationId, tenantId, OCPPVersion.OCPP2_0_1, OCPP2_0_1_CallAction.CostUpdated, {
+            totalCost: cost,
+            transactionId: transaction.transactionId,
+        });
+        this._logger.debug(`Sent CostUpdated call for ${transaction.transactionId} transaction with ${cost} cost`);
+    }
+    async _tryNotify(stationId, transactionId, tenantId) {
+        try {
+            const transaction = await this._transactionEventRepository.readTransactionByStationIdAndTransactionId(tenantId, stationId, transactionId);
+            if (!transaction?.isActive) {
+                this._logger.debug(`Unscheduling periodic cost notifications for ${stationId} station, ${transactionId} transaction, ${tenantId} tenant`);
+                this.unschedule(this._key(stationId, transactionId));
+                return;
+            }
+            await this.calculateCostAndNotify(transaction, tenantId);
+        }
+        catch (error) {
+            this._logger.error(`Failed to send CostUpdated call for ${transactionId} transaction`, error);
+        }
+    }
+    _key(stationId, transactionId) {
+        return `${stationId}:${transactionId}`;
+    }
+}
+//# sourceMappingURL=CostNotifier.js.map

package/dist/module/CostNotifier.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CostNotifier.js","sourceRoot":"","sources":["../../src/module/CostNotifier.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,EAAE;AACF,sCAAsC;AACtC,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAEpF,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAE9C,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,MAAM,OAAO,YAAa,SAAQ,SAAS;IACxB,2BAA2B,CAA8B;IACzD,OAAO,CAAiB;IACxB,eAAe,CAAiB;IAEjD,YACE,MAAsB,EACtB,0BAAuD,EACvD,cAA8B,EAC9B,MAAwB;QAExB,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,2BAA2B,GAAG,0BAA0B,CAAC;QAC9D,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;IACxC,CAAC;IAED;;;;;;;;;OASG;IACH,iBAAiB,CACf,SAAiB,EACjB,aAAqB,EACrB,QAAgB,EAChB,eAAuB;QAEvB,IAAI,CAAC,OAAO,CAAC,KAAK,CAChB,8CAA8C,SAAS,aAAa,aAAa,iBAAiB,QAAQ,SAAS,CACpH,CAAC;QACF,IAAI,CAAC,QAAQ,CACX,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,CAAC,EACnC,GAAG,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,aAAa,EAAE,QAAQ,CAAC,EACzD,eAAe,CAChB,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,sBAAsB,CAAC,WAAwB,EAAE,QAAgB;QACrE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,kBAAkB,CACxD,QAAQ,EACR,WAAW,CAAC,SAAS,EACrB,WAAW,CAAC,QAAS,CACtB,CAAC;QAEF,MAAM,IAAI,CAAC,2BAA2B,CAAC,8BAA8B,CACnE,QAAQ,EACR,IAAI,EACJ,WAAW,CAAC,EAAE,CACf,CAAC;QAEF,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CACzB,WAAW,CAAC,SAAS,EACrB,QAAQ,EACR,WAAW,CAAC,SAAS,EACrB,oBAAoB,CAAC,WAAW,EAChC;YACE,SAAS,EAAE,IAAI;YACf,aAAa,EAAE,WAAW,CAAC,aAAa;SACzC,CACF,CAAC;QACF,IAAI,CAAC,OAAO,CAAC,KAAK,CAChB,6BAA6B,WAAW,CAAC,aAAa,qBAAqB,IAAI,OAAO,CACvF,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,UAAU,CAAC,SAAiB,EAAE,aAAqB,EAAE,QAAgB;QACjF,IAAI,CAAC;YACH,MAAM,WAAW,GACf,MAAM,IAAI,CAAC,2BAA2B,CAAC,0CAA0C,CAC/E,QAAQ,EACR,SAAS,EACT,aAAa,CACd,CAAC;YAEJ,IAAI,CAAC,WAAW,EAAE,QAAQ,EAAE,CAAC;gBAC3B,IAAI,CAAC,OAAO,CAAC,KAAK,CAChB,gDAAgD,SAAS,aAAa,aAAa,iBAAiB,QAAQ,SAAS,CACtH,CAAC;gBACF,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC,CAAC;gBACrD,OAAO;YACT,CAAC;YAED,MAAM,IAAI,CAAC,sBAAsB,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;QAC3D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,uCAAuC,aAAa,cAAc,EAAE,KAAK,CAAC,CAAC;QAChG,CAAC;IACH,CAAC;IAEO,IAAI,CAAC,SAAiB,EAAE,aAAqB;QACnD,OAAO,GAAG,SAAS,IAAI,aAAa,EAAE,CAAC;IACzC,CAAC;CACF"}

package/dist/module/DataApi.d.ts

@@ -0,0 +1,43 @@
+import type { TariffQueryString, TenantQueryString, TransactionEventQuerystring } from '@citrineos/data';
+import { Tariff, Transaction } from '@citrineos/data';
+import type { ILogObj } from 'tslog';
+import { Logger } from 'tslog';
+import type { ITransactionsModuleApi } from './interface.js';
+import { TransactionsModule } from './module.js';
+import { AbstractModuleApi, Namespace, OCPP1_6_Namespace, OCPP2_0_1_Namespace } from '@citrineos/base';
+import type { FastifyInstance, FastifyRequest } from 'fastify';
+/**
+ * Server API for the transaction module.
+ */
+export declare class TransactionsDataApi extends AbstractModuleApi<TransactionsModule> implements ITransactionsModuleApi {
+    /**
+     * Constructor for the class.
+     *
+     * @param {TransactionsModule} transactionModule - The transaction module.
+     * @param {FastifyInstance} server - The server instance.
+     * @param {Logger<ILogObj>} [logger] - Optional logger.
+     */
+    constructor(transactionModule: TransactionsModule, server: FastifyInstance, logger?: Logger<ILogObj>);
+    getTransactionByStationIdAndTransactionId(request: FastifyRequest<{
+        Querystring: TransactionEventQuerystring;
+    }>): Promise<Transaction | undefined>;
+    upsertTariff(request: FastifyRequest<{
+        Body: any;
+        Querystring: TenantQueryString;
+    }>): Promise<Tariff>;
+    getTariffs(request: FastifyRequest<{
+        Querystring: TariffQueryString;
+    }>): Promise<Tariff[]>;
+    deleteTariffs(request: FastifyRequest<{
+        Querystring: TariffQueryString;
+    }>): Promise<string>;
+    /**
+     * Overrides superclass method to generate the URL path based on the input {@link Namespace}
+     * and the module's endpoint prefix configuration.
+     *
+     * @param {Namespace} input - The input {@link Namespace}.
+     * @return {string} - The generated URL path.
+     */
+    protected _toDataPath(input: OCPP2_0_1_Namespace | OCPP1_6_Namespace | Namespace): string;
+    private buildTariff;
+}

package/dist/module/DataApi.js

@@ -0,0 +1,94 @@
+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 { Tariff, TariffQuerySchema, TariffSchema, TenantQuerySchema, Transaction, TransactionEventQuerySchema, } from '@citrineos/data';
+import { Logger } from 'tslog';
+import { TransactionsModule } from './module.js';
+import { AbstractModuleApi, AsDataEndpoint, HttpMethod, Namespace, OCPP1_6_Namespace, OCPP2_0_1_Namespace, } from '@citrineos/base';
+import { UpsertTariffRequest } from './model/tariffs.js';
+import { plainToInstance } from 'class-transformer';
+/**
+ * Server API for the transaction module.
+ */
+export class TransactionsDataApi extends AbstractModuleApi {
+    /**
+     * Constructor for the class.
+     *
+     * @param {TransactionsModule} transactionModule - The transaction module.
+     * @param {FastifyInstance} server - The server instance.
+     * @param {Logger<ILogObj>} [logger] - Optional logger.
+     */
+    constructor(transactionModule, server, logger) {
+        super(transactionModule, server, null, logger);
+    }
+    getTransactionByStationIdAndTransactionId(request) {
+        return this._module.transactionEventRepository.readTransactionByStationIdAndTransactionId(request.query.tenantId, request.query.stationId, request.query.transactionId);
+    }
+    async upsertTariff(request) {
+        const tariff = this.buildTariff(plainToInstance(UpsertTariffRequest, request.body));
+        return await this._module.tariffRepository.upsertTariff(request.query.tenantId, tariff);
+    }
+    getTariffs(request) {
+        return this._module.tariffRepository.readAllByQuerystring(request.query.tenantId, request.query);
+    }
+    deleteTariffs(request) {
+        return this._module.tariffRepository
+            .deleteAllByQuerystring(request.query.tenantId, request.query)
+            .then((deletedCount) => deletedCount.toString() + ' rows successfully deleted from ' + OCPP2_0_1_Namespace.Tariff);
+    }
+    /**
+     * Overrides superclass method to generate the URL path based on the input {@link Namespace}
+     * and the module's endpoint prefix configuration.
+     *
+     * @param {Namespace} input - The input {@link Namespace}.
+     * @return {string} - The generated URL path.
+     */
+    _toDataPath(input) {
+        const endpointPrefix = this._module.config.modules.transactions.endpointPrefix;
+        return super._toDataPath(input, endpointPrefix);
+    }
+    // TODO: move to service layer
+    buildTariff(request) {
+        return Tariff.newInstance({
+            id: request.id,
+            currency: request.currency,
+            pricePerKwh: request.pricePerKwh,
+            pricePerMin: request.pricePerMin,
+            pricePerSession: request.pricePerSession,
+            taxRate: request.taxRate,
+            authorizationAmount: request.authorizationAmount,
+            paymentFee: request.paymentFee,
+        });
+    }
+}
+__decorate([
+    AsDataEndpoint(Namespace.TransactionType, HttpMethod.Get, TransactionEventQuerySchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], TransactionsDataApi.prototype, "getTransactionByStationIdAndTransactionId", null);
+__decorate([
+    AsDataEndpoint(OCPP2_0_1_Namespace.Tariff, HttpMethod.Put, TenantQuerySchema, TariffSchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], TransactionsDataApi.prototype, "upsertTariff", null);
+__decorate([
+    AsDataEndpoint(OCPP2_0_1_Namespace.Tariff, HttpMethod.Get, TariffQuerySchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], TransactionsDataApi.prototype, "getTariffs", null);
+__decorate([
+    AsDataEndpoint(OCPP2_0_1_Namespace.Tariff, HttpMethod.Delete, TariffQuerySchema),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], TransactionsDataApi.prototype, "deleteTariffs", 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":";;;;;;;;;AAQA,OAAO,EACL,MAAM,EACN,iBAAiB,EACjB,YAAY,EACZ,iBAAiB,EACjB,WAAW,EACX,2BAA2B,GAC5B,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EACL,iBAAiB,EACjB,cAAc,EACd,UAAU,EACV,SAAS,EACT,iBAAiB,EACjB,mBAAmB,GACpB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD;;GAEG;AACH,MAAM,OAAO,mBACX,SAAQ,iBAAqC;IAG7C;;;;;;OAMG;IACH,YACE,iBAAqC,EACrC,MAAuB,EACvB,MAAwB;QAExB,KAAK,CAAC,iBAAiB,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IACjD,CAAC;IAGD,yCAAyC,CACvC,OAAqE;QAErE,OAAO,IAAI,CAAC,OAAO,CAAC,0BAA0B,CAAC,0CAA0C,CACvF,OAAO,CAAC,KAAK,CAAC,QAAQ,EACtB,OAAO,CAAC,KAAK,CAAC,SAAS,EACvB,OAAO,CAAC,KAAK,CAAC,aAAa,CAC5B,CAAC;IACJ,CAAC;IAGK,AAAN,KAAK,CAAC,YAAY,CAChB,OAGE;QAEF,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC,mBAAmB,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;QACpF,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC1F,CAAC;IAGD,UAAU,CAAC,OAA2D;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,oBAAoB,CACvD,OAAO,CAAC,KAAK,CAAC,QAAQ,EACtB,OAAO,CAAC,KAAK,CACd,CAAC;IACJ,CAAC;IAGD,aAAa,CAAC,OAA2D;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,gBAAgB;aACjC,sBAAsB,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,OAAO,CAAC,KAAK,CAAC;aAC7D,IAAI,CACH,CAAC,YAAwC,EAAE,EAAE,CAC3C,YAAY,CAAC,QAAQ,EAAE,GAAG,kCAAkC,GAAG,mBAAmB,CAAC,MAAM,CAC5F,CAAC;IACN,CAAC;IAED;;;;;;OAMG;IACO,WAAW,CAAC,KAA0D;QAC9E,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC;QAC/E,OAAO,KAAK,CAAC,WAAW,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;IAClD,CAAC;IAED,8BAA8B;IACtB,WAAW,CAAC,OAA4B;QAC9C,OAAO,MAAM,CAAC,WAAW,CAAC;YACxB,EAAE,EAAE,OAAO,CAAC,EAAE;YACd,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,eAAe,EAAE,OAAO,CAAC,eAAe;YACxC,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,mBAAmB,EAAE,OAAO,CAAC,mBAAmB;YAChD,UAAU,EAAE,OAAO,CAAC,UAAU;SAC/B,CAAC,CAAC;IACL,CAAC;CACF;AAhEC;IADC,cAAc,CAAC,SAAS,CAAC,eAAe,EAAE,UAAU,CAAC,GAAG,EAAE,2BAA2B,CAAC;;;;oFAStF;AAGK;IADL,cAAc,CAAC,mBAAmB,CAAC,MAAM,EAAE,UAAU,CAAC,GAAG,EAAE,iBAAiB,EAAE,YAAY,CAAC;;;;uDAS3F;AAGD;IADC,cAAc,CAAC,mBAAmB,CAAC,MAAM,EAAE,UAAU,CAAC,GAAG,EAAE,iBAAiB,CAAC;;;;qDAM7E;AAGD;IADC,cAAc,CAAC,mBAAmB,CAAC,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,iBAAiB,CAAC;;;;wDAQhF"}

package/dist/module/Scheduler.d.ts

@@ -0,0 +1,12 @@
+import type { ILogObj } from 'tslog';
+import { Logger } from 'tslog';
+export declare abstract class Scheduler {
+    protected readonly _logger: Logger<ILogObj>;
+    private _registry;
+    constructor(logger?: Logger<ILogObj>);
+    protected schedule(key: string, task: () => void, intervalSeconds: number): void;
+    protected unschedule(key: string): void;
+    private _register;
+    private _unregister;
+    private _isAlreadyRegistered;
+}

package/dist/module/Scheduler.js

@@ -0,0 +1,33 @@
+import { Logger } from 'tslog';
+export class Scheduler {
+    _logger;
+    _registry = new Map();
+    constructor(logger) {
+        this._logger = logger
+            ? logger.getSubLogger({ name: this.constructor.name })
+            : new Logger({ name: this.constructor.name });
+    }
+    schedule(key, task, intervalSeconds) {
+        if (this._isAlreadyRegistered(key)) {
+            this._logger.debug(`Skipping task registration for ${key} as it is already registered`);
+            return;
+        }
+        this._logger.debug(`Registering scheduled task for ${key}`);
+        this._register(key, setInterval(() => task(), intervalSeconds * 1000));
+    }
+    unschedule(key) {
+        this._logger.debug(`Unregistering scheduled task for ${key}`);
+        this._unregister(key);
+    }
+    _register(key, timeout) {
+        this._registry.set(key, timeout);
+    }
+    _unregister(key) {
+        clearInterval(this._registry.get(key));
+        this._registry.delete(key);
+    }
+    _isAlreadyRegistered(key) {
+        return this._registry.has(key);
+    }
+}
+//# sourceMappingURL=Scheduler.js.map

package/dist/module/Scheduler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Scheduler.js","sourceRoot":"","sources":["../../src/module/Scheduler.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAE/B,MAAM,OAAgB,SAAS;IACV,OAAO,CAAkB;IAEpC,SAAS,GAAgC,IAAI,GAAG,EAAE,CAAC;IAE3D,YAAY,MAAwB;QAClC,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;IAES,QAAQ,CAAC,GAAW,EAAE,IAAgB,EAAE,eAAuB;QACvE,IAAI,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAE,CAAC;YACnC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,kCAAkC,GAAG,8BAA8B,CAAC,CAAC;YACxF,OAAO;QACT,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,kCAAkC,GAAG,EAAE,CAAC,CAAC;QAC5D,IAAI,CAAC,SAAS,CACZ,GAAG,EACH,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,EAAE,eAAe,GAAG,IAAI,CAAC,CAClD,CAAC;IACJ,CAAC;IAES,UAAU,CAAC,GAAW;QAC9B,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,oCAAoC,GAAG,EAAE,CAAC,CAAC;QAC9D,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IACxB,CAAC;IAEO,SAAS,CAAC,GAAW,EAAE,OAAuB;QACpD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IACnC,CAAC;IAEO,WAAW,CAAC,GAAW;QAC7B,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;QACvC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IAEO,oBAAoB,CAAC,GAAW;QACtC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACjC,CAAC;CACF"}

package/dist/module/StatusNotificationService.d.ts

@@ -0,0 +1,19 @@
+import { CrudRepository, OCPP1_6, OCPP2_0_1 } from '@citrineos/base';
+import { Component, type IDeviceModelRepository, type ILocationRepository } from '@citrineos/data';
+import type { ILogObj } from 'tslog';
+import { Logger } from 'tslog';
+export declare class StatusNotificationService {
+    protected _componentRepository: CrudRepository<Component>;
+    protected _deviceModelRepository: IDeviceModelRepository;
+    protected _locationRepository: ILocationRepository;
+    protected _logger: Logger<ILogObj>;
+    constructor(componentRepository: CrudRepository<Component>, deviceModelRepository: IDeviceModelRepository, locationRepository: ILocationRepository, logger?: Logger<ILogObj>);
+    /**
+     * Stores an internal record of the incoming status, then updates the device model for the updated connector.
+     *
+     * @param {string} stationId - The Charging Station sending the status notification request
+     * @param {StatusNotificationRequest} statusNotificationRequest
+     */
+    processStatusNotification(tenantId: number, stationId: string, statusNotificationRequest: OCPP2_0_1.StatusNotificationRequest): Promise<void>;
+    processOcpp16StatusNotification(tenantId: number, stationId: string, statusNotificationRequest: OCPP1_6.StatusNotificationRequest): Promise<void>;
+}