From: Jérôme Benoit <jerome.benoit@sap.com>
Date: Thu, 16 Apr 2026 01:30:18 +0000 (+0200)
Subject: refactor: consolidate all types into ui-common — single import source
X-Git-Tag: v4.5~70
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=9739ffe201bf3d5b0060ff038af83f515b7d6921;p=e-mobility-charging-stations-simulator.git

refactor: consolidate all types into ui-common — single import source
---

diff --git a/ui/common/src/client/browser-adapter.ts b/ui/common/src/client/browser-adapter.ts
index 397a4b75..04258c54 100644
--- a/ui/common/src/client/browser-adapter.ts
+++ b/ui/common/src/client/browser-adapter.ts
@@ -1,6 +1,7 @@
-import type { WebSocketLike } from './types.js'
 import type { WebSocketReadyState } from './types.js'
 
+import { type WebSocketLike } from './types.js'
+
 interface BrowserWebSocket {
   close(code?: number, reason?: string): void
   set onclose(handler: ((event: { code: number; reason: string }) => void) | null)
diff --git a/ui/common/src/config/schema.ts b/ui/common/src/config/schema.ts
index 5f1ceb19..34e9f852 100644
--- a/ui/common/src/config/schema.ts
+++ b/ui/common/src/config/schema.ts
@@ -40,4 +40,3 @@ export const configurationSchema = z.object({
 
 export type Configuration = z.infer<typeof configurationSchema>
 export type UIServerConfig = z.infer<typeof uiServerConfigSchema>
-export type { UIServerConfig as UIServerConfigurationSection }
diff --git a/ui/common/src/index.ts b/ui/common/src/index.ts
index 2424f85b..17671897 100644
--- a/ui/common/src/index.ts
+++ b/ui/common/src/index.ts
@@ -3,6 +3,8 @@ export * from './client/types.js'
 export * from './client/WebSocketClient.js'
 export * from './config/schema.js'
 export * from './constants.js'
+export * from './types/ChargingStationType.js'
+export * from './types/ConfigurationType.js'
 export * from './types/JsonType.js'
 export * from './types/UIProtocol.js'
 export * from './types/UUID.js'
diff --git a/ui/web/src/types/ChargingStationType.ts b/ui/common/src/types/ChargingStationType.ts
similarity index 98%
rename from ui/web/src/types/ChargingStationType.ts
rename to ui/common/src/types/ChargingStationType.ts
index bfce74dd..d1789200 100644
--- a/ui/web/src/types/ChargingStationType.ts
+++ b/ui/common/src/types/ChargingStationType.ts
@@ -1,4 +1,4 @@
-import type { JsonObject } from 'ui-common'
+import type { JsonObject } from './JsonType.js'
 
 export enum AmpereUnits {
   AMPERE = 'A',
@@ -161,9 +161,7 @@ export interface ChargingStationData extends JsonObject {
   supervisionUrl: string
   wsState?:
     | typeof WebSocket.CLOSED
-    | typeof WebSocket.CLOSING
-    | typeof WebSocket.CONNECTING
-    | typeof WebSocket.OPEN
+
 }
 
 export interface ChargingStationInfo extends JsonObject {
diff --git a/ui/web/src/types/ConfigurationType.ts b/ui/common/src/types/ConfigurationType.ts
similarity index 77%
rename from ui/web/src/types/ConfigurationType.ts
rename to ui/common/src/types/ConfigurationType.ts
index 6fe0af4a..2a3641b6 100644
--- a/ui/web/src/types/ConfigurationType.ts
+++ b/ui/common/src/types/ConfigurationType.ts
@@ -1,6 +1,5 @@
-import type { AuthenticationType, ProtocolVersion } from 'ui-common'
-
-import type { Protocol } from './UIProtocol'
+import type { AuthenticationType, ProtocolVersion } from './UIProtocol.js'
+import type { Protocol } from './UIProtocol.js'
 
 export interface ConfigurationData {
   theme?: string
diff --git a/ui/common/src/types/UIProtocol.ts b/ui/common/src/types/UIProtocol.ts
index 6fb1e547..3e28bd30 100644
--- a/ui/common/src/types/UIProtocol.ts
+++ b/ui/common/src/types/UIProtocol.ts
@@ -1,6 +1,11 @@
 import type { JsonObject } from './JsonType.js'
 import type { UUIDv4 } from './UUID.js'
 
+export enum ApplicationProtocol {
+  WS = 'ws',
+  WSS = 'wss',
+}
+
 export enum AuthenticationType {
   PROTOCOL_BASIC_AUTH = 'protocol-basic-auth',
 }
@@ -43,6 +48,10 @@ export enum ProcedureName {
   UNLOCK_CONNECTOR = 'unlockConnector',
 }
 
+export enum Protocol {
+  UI = 'ui',
+}
+
 export enum ProtocolVersion {
   '0.0.1' = '0.0.1',
 }
@@ -86,3 +95,16 @@ export interface ResponsePayload extends JsonObject {
   responsesFailed?: BroadcastChannelResponsePayload[]
   status: ResponseStatus
 }
+
+export interface SimulatorState {
+  started: boolean
+  templateStatistics: Record<string, TemplateStatistics>
+  version: string
+}
+
+export interface TemplateStatistics {
+  added: number
+  configured: number
+  indexes: number[]
+  started: number
+}
diff --git a/ui/web/docker/Dockerfile b/ui/web/docker/Dockerfile
index dc15dc34..bb618847 100644
--- a/ui/web/docker/Dockerfile
+++ b/ui/web/docker/Dockerfile
@@ -26,4 +26,5 @@ RUN set -ex \
   && chmod +x /run.sh \
   && chmod +x /autoconfig.sh
 
+EXPOSE 3030
 ENTRYPOINT ["/bin/sh", "-c", "/autoconfig.sh && /run.sh"]
diff --git a/ui/web/src/components/actions/StartTransaction.vue b/ui/web/src/components/actions/StartTransaction.vue
index 73a47d30..cd0cac67 100644
--- a/ui/web/src/components/actions/StartTransaction.vue
+++ b/ui/web/src/components/actions/StartTransaction.vue
@@ -37,13 +37,13 @@
 </template>
 
 <script setup lang="ts">
+import { type OCPPVersion } from 'ui-common'
 import { computed, ref } from 'vue'
 import { useRoute, useRouter } from 'vue-router'
 import { useToast } from 'vue-toast-notification'
 
 import Button from '@/components/buttons/Button.vue'
 import { convertToInt, resetToggleButtonState, ROUTE_NAMES, useUIClient } from '@/composables'
-import { type OCPPVersion } from '@/types/ChargingStationType'
 
 const props = defineProps<{
   chargingStationId: string
diff --git a/ui/web/src/components/charging-stations/CSConnector.vue b/ui/web/src/components/charging-stations/CSConnector.vue
index b55b0d74..531c8078 100644
--- a/ui/web/src/components/charging-stations/CSConnector.vue
+++ b/ui/web/src/components/charging-stations/CSConnector.vue
@@ -66,9 +66,9 @@
 </template>
 
 <script setup lang="ts">
-import { useToast } from 'vue-toast-notification'
+import type { ConnectorStatus, OCPPVersion, Status } from 'ui-common'
 
-import type { ConnectorStatus, OCPPVersion, Status } from '@/types/ChargingStationType'
+import { useToast } from 'vue-toast-notification'
 
 import Button from '@/components/buttons/Button.vue'
 import StateButton from '@/components/buttons/StateButton.vue'
diff --git a/ui/web/src/components/charging-stations/CSData.vue b/ui/web/src/components/charging-stations/CSData.vue
index ff703b59..0a3a5391 100644
--- a/ui/web/src/components/charging-stations/CSData.vue
+++ b/ui/web/src/components/charging-stations/CSData.vue
@@ -134,11 +134,11 @@
 </template>
 
 <script setup lang="ts">
+import type { ChargingStationData, ConnectorEntry, Status } from 'ui-common'
+
 import { computed } from 'vue'
 import { useToast } from 'vue-toast-notification'
 
-import type { ChargingStationData, ConnectorEntry, Status } from '@/types/ChargingStationType'
-
 import Button from '@/components/buttons/Button.vue'
 import StateButton from '@/components/buttons/StateButton.vue'
 import ToggleButton from '@/components/buttons/ToggleButton.vue'
diff --git a/ui/web/src/components/charging-stations/CSTable.vue b/ui/web/src/components/charging-stations/CSTable.vue
index 4cd86cb5..d76ce71d 100644
--- a/ui/web/src/components/charging-stations/CSTable.vue
+++ b/ui/web/src/components/charging-stations/CSTable.vue
@@ -107,7 +107,7 @@
 </template>
 
 <script setup lang="ts">
-import type { ChargingStationData } from '@/types/ChargingStationType'
+import type { ChargingStationData } from 'ui-common'
 
 import CSData from '@/components/charging-stations/CSData.vue'
 
diff --git a/ui/web/src/composables/UIClient.ts b/ui/web/src/composables/UIClient.ts
index f0d5093b..ba5bdbf7 100644
--- a/ui/web/src/composables/UIClient.ts
+++ b/ui/web/src/composables/UIClient.ts
@@ -1,25 +1,21 @@
 import {
+  type ChargingStationOptions,
   createBrowserWsAdapter,
+  OCPP20IdTokenEnumType,
+  OCPP20TransactionEventEnumType,
+  type OCPP20TransactionEventRequest,
+  OCPPVersion,
   ProcedureName,
   type RequestPayload,
   type ResponsePayload,
   ResponseStatus,
   ServerNotification,
+  type UIServerConfigurationSection,
   WebSocketClient,
   type WebSocketFactory,
 } from 'ui-common'
 import { useToast } from 'vue-toast-notification'
 
-import type { UIServerConfigurationSection } from '@/types/ConfigurationType'
-
-import {
-  type ChargingStationOptions,
-  OCPP20IdTokenEnumType,
-  OCPP20TransactionEventEnumType,
-  type OCPP20TransactionEventRequest,
-  OCPPVersion,
-} from '@/types/ChargingStationType'
-
 export class UIClient {
   private static instance: null | UIClient = null
   private abortConnection: () => void
diff --git a/ui/web/src/composables/Utils.ts b/ui/web/src/composables/Utils.ts
index 80797b7f..97908d8c 100644
--- a/ui/web/src/composables/Utils.ts
+++ b/ui/web/src/composables/Utils.ts
@@ -1,12 +1,9 @@
-import type { UUIDv4 } from 'ui-common'
+import type { ChargingStationData, ConfigurationData, UUIDv4 } from 'ui-common'
 import type { InjectionKey, Ref } from 'vue'
 
 import { inject } from 'vue'
 import { useToast } from 'vue-toast-notification'
 
-import type { ChargingStationData } from '@/types/ChargingStationType'
-import type { ConfigurationData } from '@/types/ConfigurationType'
-
 import {
   EMPTY_VALUE_PLACEHOLDER,
   SHARED_TOGGLE_BUTTON_KEY_PREFIX,
diff --git a/ui/web/src/main.ts b/ui/web/src/main.ts
index 1ccae670..9e1a7020 100644
--- a/ui/web/src/main.ts
+++ b/ui/web/src/main.ts
@@ -1,9 +1,12 @@
+import type {
+  ChargingStationData,
+  ConfigurationData,
+  UIServerConfigurationSection,
+} from 'ui-common'
+
 import { type App as AppType, type Component, createApp, ref } from 'vue'
 import ToastPlugin from 'vue-toast-notification'
 
-import type { ChargingStationData } from '@/types/ChargingStationType'
-import type { ConfigurationData, UIServerConfigurationSection } from '@/types/ConfigurationType'
-
 import App from '@/App.vue'
 import {
   chargingStationsKey,
diff --git a/ui/web/src/types/UIProtocol.ts b/ui/web/src/types/UIProtocol.ts
deleted file mode 100644
index c97fbfcc..00000000
--- a/ui/web/src/types/UIProtocol.ts
+++ /dev/null
@@ -1,21 +0,0 @@
-export enum ApplicationProtocol {
-  WS = 'ws',
-  WSS = 'wss',
-}
-
-export enum Protocol {
-  UI = 'ui',
-}
-
-export interface SimulatorState {
-  started: boolean
-  templateStatistics: Record<string, TemplateStatistics>
-  version: string
-}
-
-interface TemplateStatistics {
-  added: number
-  configured: number
-  indexes: number[]
-  started: number
-}
diff --git a/ui/web/src/views/ChargingStationsView.vue b/ui/web/src/views/ChargingStationsView.vue
index 7f903c78..df37db8d 100644
--- a/ui/web/src/views/ChargingStationsView.vue
+++ b/ui/web/src/views/ChargingStationsView.vue
@@ -104,15 +104,11 @@
 </template>
 
 <script setup lang="ts">
-import type { ResponsePayload, UUIDv4 } from 'ui-common'
+import type { ChargingStationData, ResponsePayload, SimulatorState, UIServerConfigurationSection, UUIDv4 } from 'ui-common'
 
 import { computed, onMounted, onUnmounted, ref, watch } from 'vue'
 import { useToast } from 'vue-toast-notification'
 
-import type { ChargingStationData } from '@/types/ChargingStationType'
-import type { UIServerConfigurationSection } from '@/types/ConfigurationType'
-import type { SimulatorState } from '@/types/UIProtocol'
-
 import StateButton from '@/components/buttons/StateButton.vue'
 import ToggleButton from '@/components/buttons/ToggleButton.vue'
 import CSTable from '@/components/charging-stations/CSTable.vue'
diff --git a/ui/web/tests/unit/CSConnector.test.ts b/ui/web/tests/unit/CSConnector.test.ts
index dedbebb9..8377a933 100644
--- a/ui/web/tests/unit/CSConnector.test.ts
+++ b/ui/web/tests/unit/CSConnector.test.ts
@@ -3,13 +3,13 @@
  * @description Unit tests for connector row display, transaction actions, and ATG controls.
  */
 import { flushPromises, mount } from '@vue/test-utils'
+import { OCPP16ChargePointStatus } from 'ui-common'
 import { beforeEach, describe, expect, it, vi } from 'vitest'
 
 import type { UIClient } from '@/composables'
 
 import CSConnector from '@/components/charging-stations/CSConnector.vue'
 import { EMPTY_VALUE_PLACEHOLDER, useUIClient } from '@/composables'
-import { OCPP16ChargePointStatus } from '@/types/ChargingStationType'
 
 import { toastMock } from '../setup'
 import { createConnectorStatus, TEST_HASH_ID, TEST_STATION_ID } from './constants'
diff --git a/ui/web/tests/unit/CSData.test.ts b/ui/web/tests/unit/CSData.test.ts
index 500c5f5c..c36fc76a 100644
--- a/ui/web/tests/unit/CSData.test.ts
+++ b/ui/web/tests/unit/CSData.test.ts
@@ -1,17 +1,18 @@
+import type { ChargingStationData } from 'ui-common'
+
 /**
  * @file Tests for CSData component
  * @description Unit tests for charging station row display, actions, and connector entry generation.
  */
 import { flushPromises, mount } from '@vue/test-utils'
+import { OCPPVersion } from 'ui-common'
 import { beforeEach, describe, expect, it, vi } from 'vitest'
 
 import type { UIClient } from '@/composables'
-import type { ChargingStationData } from '@/types/ChargingStationType'
 
 import CSConnector from '@/components/charging-stations/CSConnector.vue'
 import CSData from '@/components/charging-stations/CSData.vue'
 import { EMPTY_VALUE_PLACEHOLDER, useUIClient } from '@/composables'
-import { OCPPVersion } from '@/types/ChargingStationType'
 
 import { toastMock } from '../setup'
 import {
diff --git a/ui/web/tests/unit/CSTable.test.ts b/ui/web/tests/unit/CSTable.test.ts
index 26194dd5..1c311f5b 100644
--- a/ui/web/tests/unit/CSTable.test.ts
+++ b/ui/web/tests/unit/CSTable.test.ts
@@ -1,3 +1,5 @@
+import type { ChargingStationData } from 'ui-common'
+
 /**
  * @file Tests for CSTable component
  * @description Unit tests for charging station table column headers and row rendering.
@@ -5,8 +7,6 @@
 import { mount } from '@vue/test-utils'
 import { describe, expect, it } from 'vitest'
 
-import type { ChargingStationData } from '@/types/ChargingStationType'
-
 import CSTable from '@/components/charging-stations/CSTable.vue'
 
 import { createChargingStationData, createStationInfo } from './constants'
diff --git a/ui/web/tests/unit/StartTransaction.test.ts b/ui/web/tests/unit/StartTransaction.test.ts
index ebffb5e4..17a7cebf 100644
--- a/ui/web/tests/unit/StartTransaction.test.ts
+++ b/ui/web/tests/unit/StartTransaction.test.ts
@@ -3,13 +3,13 @@
  * @description Unit tests for start transaction form — OCPP version branching, authorization flow, and navigation.
  */
 import { flushPromises, mount } from '@vue/test-utils'
+import { OCPPVersion } from 'ui-common'
 import { describe, expect, it, vi } from 'vitest'
 
 import type { UIClient } from '@/composables'
 
 import StartTransaction from '@/components/actions/StartTransaction.vue'
 import { useUIClient } from '@/composables'
-import { OCPPVersion } from '@/types/ChargingStationType'
 
 import { toastMock } from '../setup'
 import { TEST_HASH_ID, TEST_ID_TAG, TEST_STATION_ID } from './constants'
diff --git a/ui/web/tests/unit/UIClient.test.ts b/ui/web/tests/unit/UIClient.test.ts
index 6337c09c..81429aa6 100644
--- a/ui/web/tests/unit/UIClient.test.ts
+++ b/ui/web/tests/unit/UIClient.test.ts
@@ -1,14 +1,20 @@
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
-import { AuthenticationType, ProcedureName, ResponseStatus, ServerNotification } from 'ui-common'
 /**
  * @file Tests for UIClient composable
  * @description Unit tests for WebSocket client singleton, connection lifecycle,
  *   request/response handling, and all simulator/station operations.
  */
+import {
+  AuthenticationType,
+  OCPP20TransactionEventEnumType,
+  OCPPVersion,
+  ProcedureName,
+  ResponseStatus,
+  ServerNotification,
+} from 'ui-common'
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
 
 import { UIClient } from '@/composables'
-import { OCPP20TransactionEventEnumType, OCPPVersion } from '@/types/ChargingStationType'
 
 import { toastMock } from '../setup'
 import { createUIServerConfig, TEST_HASH_ID, TEST_ID_TAG } from './constants'
diff --git a/ui/web/tests/unit/constants.ts b/ui/web/tests/unit/constants.ts
index ea1dd5b9..e1c920a9 100644
--- a/ui/web/tests/unit/constants.ts
+++ b/ui/web/tests/unit/constants.ts
@@ -3,10 +3,6 @@
  * @description Factory functions (NOT static objects) for ChargingStationData,
  *   ConnectorStatus, and other test fixtures. Using factories prevents shared state.
  */
-import { ProtocolVersion } from 'ui-common'
-
-import type { UIServerConfigurationSection } from '@/types/ConfigurationType'
-
 import {
   type ChargingStationData,
   type ChargingStationInfo,
@@ -16,8 +12,10 @@ import {
   OCPP16ChargePointStatus,
   OCPP16RegistrationStatus,
   OCPPVersion,
-} from '@/types/ChargingStationType'
-import { Protocol } from '@/types/UIProtocol'
+  Protocol,
+  ProtocolVersion,
+  type UIServerConfigurationSection,
+} from 'ui-common'
 
 // ── Shared Test Constants ─────────────────────────────────────────────────────