docs: add code comment

[e-mobility-charging-stations-simulator.git] / src / types / ocpp / Responses.ts

import type { OCPP16MeterValuesResponse } from './1.6/MeterValues';
import {
  OCPP16AvailabilityStatus,
  type OCPP16BootNotificationResponse,
  OCPP16ChargingProfileStatus,
  OCPP16ClearChargingProfileStatus,
  OCPP16ConfigurationStatus,
  type OCPP16DataTransferResponse,
  OCPP16DataTransferStatus,
  type OCPP16DiagnosticsStatusNotificationResponse,
  type OCPP16FirmwareStatusNotificationResponse,
  type OCPP16HeartbeatResponse,
  OCPP16ReservationStatus,
  type OCPP16StatusNotificationResponse,
  OCPP16TriggerMessageStatus,
  OCPP16UnlockStatus,
} from './1.6/Responses';
import type { OCPP20BootNotificationResponse, OCPP20ClearCacheResponse } from './2.0/Responses';
import { type GenericResponse, GenericStatus } from './Common';
import type { ErrorType } from './ErrorType';
import type { MessageType } from './MessageType';
import type { ChargingStation } from '../../charging-station';
import type { JsonType } from '../JsonType';

export type Response = [MessageType.CALL_RESULT_MESSAGE, string, JsonType];

export type ErrorResponse = [MessageType.CALL_ERROR_MESSAGE, string, ErrorType, string, JsonType];

export type ResponseHandler = (
  chargingStation: ChargingStation,
  payload: JsonType,
  requestPayload?: JsonType,
) => void | Promise<void>;

export type BootNotificationResponse =
  | OCPP16BootNotificationResponse
  | OCPP20BootNotificationResponse;

export type HeartbeatResponse = OCPP16HeartbeatResponse;

export type ClearCacheResponse = GenericResponse | OCPP20ClearCacheResponse;

export type StatusNotificationResponse = OCPP16StatusNotificationResponse;

export type MeterValuesResponse = OCPP16MeterValuesResponse;

export type DataTransferResponse = OCPP16DataTransferResponse;

export type DiagnosticsStatusNotificationResponse = OCPP16DiagnosticsStatusNotificationResponse;

export type FirmwareStatusNotificationResponse = OCPP16FirmwareStatusNotificationResponse;

export const AvailabilityStatus = {
  ...OCPP16AvailabilityStatus,
} as const;
export type AvailabilityStatus = OCPP16AvailabilityStatus;

export const ChargingProfileStatus = {
  ...OCPP16ChargingProfileStatus,
} as const;
export type ChargingProfileStatus = OCPP16ChargingProfileStatus;

export const ClearChargingProfileStatus = {
  ...OCPP16ClearChargingProfileStatus,
} as const;
export type ClearChargingProfileStatus = OCPP16ClearChargingProfileStatus;

export const ConfigurationStatus = {
  ...OCPP16ConfigurationStatus,
} as const;
export type ConfigurationStatus = OCPP16ConfigurationStatus;

export const UnlockStatus = {
  ...OCPP16UnlockStatus,
} as const;
export type UnlockStatus = OCPP16UnlockStatus;

export const TriggerMessageStatus = {
  ...OCPP16TriggerMessageStatus,
} as const;
export type TriggerMessageStatus = OCPP16TriggerMessageStatus;

export const DataTransferStatus = {
  ...OCPP16DataTransferStatus,
} as const;
export type DataTransferStatus = OCPP16DataTransferStatus;

export type ReservationStatus = OCPP16ReservationStatus;
export const ReservationStatus = {
  ...OCPP16ReservationStatus,
} as const;

export type CancelReservationStatus = GenericStatus;
export const CancelReservationStatus = {
  ...GenericStatus,
} as const;

export type CancelReservationResponse = GenericResponse;