src/types/ocpp/Requests.ts

   1 import type ChargingStation from '../../charging-station/ChargingStation';
   2 import type OCPPError from '../../exception/OCPPError';
   3 import type { JsonType } from '../JsonType';
   4 import { OCPP16DiagnosticsStatus } from './1.6/DiagnosticsStatus';
   5 import type { OCPP16MeterValuesRequest } from './1.6/MeterValues';
   6 import {
   7   OCPP16AvailabilityType,
   8   type OCPP16BootNotificationRequest,
   9   type OCPP16DataTransferRequest,
  10   type OCPP16DiagnosticsStatusNotificationRequest,
  11   OCPP16FirmwareStatus,
  12   type OCPP16FirmwareStatusNotificationRequest,
  13   type OCPP16HeartbeatRequest,
  14   OCPP16IncomingRequestCommand,
  15   OCPP16MessageTrigger,
  16   OCPP16RequestCommand,
  17   type OCPP16StatusNotificationRequest,
  18 } from './1.6/Requests';
  19 import {
  20   type OCPP20BootNotificationRequest,
  21   OCPP20IncomingRequestCommand,
  22   OCPP20RequestCommand,
  23 } from './2.0/Requests';
  24 import type { MessageType } from './MessageType';
  25
  26 export const RequestCommand = {
  27   ...OCPP16RequestCommand,
  28   ...OCPP20RequestCommand,
  29 } as const;
  30 export type RequestCommand = OCPP16RequestCommand | OCPP20RequestCommand;
  31
  32 export type OutgoingRequest = [MessageType.CALL_MESSAGE, string, RequestCommand, JsonType];
  33
  34 export type RequestParams = {
  35   skipBufferingOnError?: boolean;
  36   triggerMessage?: boolean;
  37 };
  38
  39 export const IncomingRequestCommand = {
  40   ...OCPP16IncomingRequestCommand,
  41   ...OCPP20IncomingRequestCommand,
  42 } as const;
  43 export type IncomingRequestCommand = OCPP16IncomingRequestCommand | OCPP20IncomingRequestCommand;
  44
  45 export type IncomingRequest = [MessageType.CALL_MESSAGE, string, IncomingRequestCommand, JsonType];
  46
  47 export type ResponseCallback = (payload: JsonType, requestPayload: JsonType) => void;
  48
  49 export type ErrorCallback = (error: OCPPError, requestStatistic?: boolean) => void;
  50
  51 export type CachedRequest = [
  52   ResponseCallback,
  53   ErrorCallback,
  54   RequestCommand | IncomingRequestCommand,
  55   JsonType
  56 ];
  57
  58 export const MessageTrigger = {
  59   ...OCPP16MessageTrigger,
  60 } as const;
  61 export type MessageTrigger = OCPP16MessageTrigger;
  62
  63 export type BootNotificationRequest = OCPP16BootNotificationRequest | OCPP20BootNotificationRequest;
  64
  65 export type HeartbeatRequest = OCPP16HeartbeatRequest;
  66
  67 export type StatusNotificationRequest = OCPP16StatusNotificationRequest;
  68
  69 export type MeterValuesRequest = OCPP16MeterValuesRequest;
  70
  71 export type DataTransferRequest = OCPP16DataTransferRequest;
  72
  73 export type DiagnosticsStatusNotificationRequest = OCPP16DiagnosticsStatusNotificationRequest;
  74
  75 export type FirmwareStatusNotificationRequest = OCPP16FirmwareStatusNotificationRequest;
  76
  77 export type IncomingRequestHandler = (
  78   chargingStation: ChargingStation,
  79   commandPayload: JsonType
  80 ) => JsonType | Promise<JsonType>;
  81
  82 export const AvailabilityType = {
  83   ...OCPP16AvailabilityType,
  84 } as const;
  85 export type AvailabilityType = OCPP16AvailabilityType;
  86
  87 export const DiagnosticsStatus = {
  88   ...OCPP16DiagnosticsStatus,
  89 } as const;
  90 export type DiagnosticsStatus = OCPP16DiagnosticsStatus;
  91
  92 export const FirmwareStatus = {
  93   ...OCPP16FirmwareStatus,
  94 } as const;
  95 export type FirmwareStatus = OCPP16FirmwareStatus;
  96
  97 export type ResponseType = JsonType | OCPPError;