api.ts

// Copyright (c) 2023 S44, LLC
// Copyright Contributors to the CitrineOS Project
//
// SPDX-License-Identifier: Apache 2.0

import { ILogObj, Logger } from 'tslog';
import { ISmartChargingModuleApi } from './interface';
import { SmartChargingModule } from './module';
import {
  AbstractModuleApi,
  AsMessageEndpoint,
  CallAction,
  ClearChargingProfileRequest,
  ClearChargingProfileRequestSchema,
  ClearedChargingLimitRequestSchema,
  CustomerInformationRequest,
  GetChargingProfilesRequest,
  GetChargingProfilesRequestSchema,
  GetCompositeScheduleRequest,
  GetCompositeScheduleRequestSchema,
  IMessageConfirmation,
  Namespace,
  SetChargingProfileRequest,
  SetChargingProfileRequestSchema,
} from '@citrineos/base';
import { FastifyInstance } from 'fastify';

/**
 * Server API for the SmartCharging module.
 */
export class SmartChargingModuleApi
  extends AbstractModuleApi<SmartChargingModule>
  implements ISmartChargingModuleApi {
  /**
   * Constructs a new instance of the class.
   *
   * @param {SmartChargingModule} SmartChargingModule - The SmartCharging module.
   * @param {FastifyInstance} server - The Fastify server instance.
   * @param {Logger<ILogObj>} [logger] - The logger instance.
   */
  constructor(
    smartChargingModule: SmartChargingModule,
    server: FastifyInstance,
    logger?: Logger<ILogObj>,
  ) {
    super(smartChargingModule, server, logger);
  }

  /**
   * Message endpoints
   */
  @AsMessageEndpoint(
    CallAction.ClearChargingProfile,
    ClearChargingProfileRequestSchema,
  )
  clearChargingProfile(
    identifier: string,
    tenantId: string,
    request: ClearChargingProfileRequest,
    callbackUrl?: string,
  ): Promise<IMessageConfirmation> {
    return this._module.sendCall(
      identifier,
      tenantId,
      CallAction.ClearChargingProfile,
      request,
      callbackUrl,
    );
  }

  @AsMessageEndpoint(
    CallAction.GetChargingProfiles,
    GetChargingProfilesRequestSchema,
  )
  getChargingProfile(
    identifier: string,
    tenantId: string,
    request: GetChargingProfilesRequest,
    callbackUrl?: string,
  ): Promise<IMessageConfirmation> {
    return this._module.sendCall(
      identifier,
      tenantId,
      CallAction.GetChargingProfiles,
      request,
      callbackUrl,
    );
  }

  @AsMessageEndpoint(
    CallAction.SetChargingProfile,
    SetChargingProfileRequestSchema,
  )
  setChargingProfile(
    identifier: string,
    tenantId: string,
    request: SetChargingProfileRequest,
    callbackUrl?: string,
  ): Promise<IMessageConfirmation> {
    return this._module.sendCall(
      identifier,
      tenantId,
      CallAction.SetChargingProfile,
      request,
      callbackUrl,
    );
  }

  @AsMessageEndpoint(
    CallAction.ClearedChargingLimit,
    ClearedChargingLimitRequestSchema,
  )
  clearedChargingLimit(
    identifier: string,
    tenantId: string,
    request: CustomerInformationRequest,
    callbackUrl?: string,
  ): Promise<IMessageConfirmation> {
    return this._module.sendCall(
      identifier,
      tenantId,
      CallAction.ClearedChargingLimit,
      request,
      callbackUrl,
    );
  }

  @AsMessageEndpoint(
    CallAction.GetCompositeSchedule,
    GetCompositeScheduleRequestSchema,
  )
  getCompositeSchedule(
    identifier: string,
    tenantId: string,
    request: GetCompositeScheduleRequest,
    callbackUrl?: string,
  ): Promise<IMessageConfirmation> {
    return this._module.sendCall(
      identifier,
      tenantId,
      CallAction.GetCompositeSchedule,
      request,
      callbackUrl,
    );
  }

  /**
   * Data endpoints
   */

  /**
   * 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 {
    const endpointPrefix =
      this._module.config.modules.smartcharging?.endpointPrefix;
    return super._toMessagePath(input, endpointPrefix);
  }

  /**
   * Overrides superclass method to generate the URL path based on the input {@link Namespace} and the module's endpoint prefix configuration.
   *
   * @param {CallAction} input - The input {@link Namespace}.
   * @return {string} - The generated URL path.
   */
  protected _toDataPath(input: Namespace): string {
    const endpointPrefix =
      this._module.config.modules.smartcharging?.endpointPrefix;
    return super._toDataPath(input, endpointPrefix);
  }
}