docs: improve configuration file documentation
[e-mobility-charging-stations-simulator.git] / src / types / UIProtocol.ts
index e7635b2e59167f3a3b48b51e9c2eed944700ff1b..4911f9ada2411c53612978878105ba7b5765beba 100644 (file)
@@ -1,4 +1,5 @@
-import type { BroadcastChannelResponsePayload, JsonObject } from './internal';
+import type { JsonObject } from './JsonType.js'
+import type { BroadcastChannelResponsePayload } from './WorkerBroadcastChannel.js'
 
 export enum Protocol {
   UI = 'ui',
@@ -17,14 +18,14 @@ export enum ProtocolVersion {
   '0.0.1' = '0.0.1',
 }
 
-export type ProtocolRequest = [string, ProcedureName, RequestPayload];
-export type ProtocolResponse = [string, ResponsePayload];
+export type ProtocolRequest = [string, ProcedureName, RequestPayload]
+export type ProtocolResponse = [string, ResponsePayload]
 
 export type ProtocolRequestHandler = (
   uuid?: string,
   procedureName?: ProcedureName,
   payload?: RequestPayload
-) => undefined | Promise<undefined> | ResponsePayload | Promise<ResponsePayload>;
+) => undefined | Promise<undefined> | ResponsePayload | Promise<ResponsePayload>
 
 export enum ProcedureName {
   START_SIMULATOR = 'startSimulator',
@@ -50,8 +51,8 @@ export enum ProcedureName {
 }
 
 export interface RequestPayload extends JsonObject {
-  hashIds?: string[];
-  connectorIds?: number[];
+  hashIds?: string[]
+  connectorIds?: number[]
 }
 
 export enum ResponseStatus {
@@ -60,8 +61,8 @@ export enum ResponseStatus {
 }
 
 export interface ResponsePayload extends JsonObject {
-  status: ResponseStatus;
-  hashIdsSucceeded?: string[];
-  hashIdsFailed?: string[];
-  responsesFailed?: BroadcastChannelResponsePayload[];
+  status: ResponseStatus
+  hashIdsSucceeded?: string[]
+  hashIdsFailed?: string[]
+  responsesFailed?: BroadcastChannelResponsePayload[]
 }