docs: Projektstruktur der Dokumentation an Quellcode angepasst

- Verzeichnisstruktur unter /docs spiegelt nun die tatsächliche Projektstruktur wider
- frontend/server-Trennung entfernt zugunsten von /docs/pages, /docs/redux, /docs/utils etc.
- Erhöht Wiederauffindbarkeit, Übersichtlichkeit und Entwicklerfreundlichkeit
This commit is contained in:
ISA
2025-05-27 09:30:40 +02:00
parent 4c6386edea
commit b847b5d2c8
55 changed files with 29 additions and 3 deletions

View File

@@ -0,0 +1,17 @@
# addPoiOnPolylineSlice
Verwaltet den Status für das Hinzufügen eines POIs auf einer bestehenden Polyline.
## 🔧 Zustand
```ts
{
isOpen: false,
latlng: null
}
```
## 🎯 Aktionen
- `openAddPoiOnPolylineModal(latlng)` öffnet das Modal mit Koordinaten
- `closeAddPoiOnPolylineModal()` schließt das Modal

View File

@@ -0,0 +1,22 @@
# 📍 currentPoiSlice
Verwaltet den aktuell ausgewählten POI (z.B. für Bearbeitung oder Anzeige im Modal).
## 🔧 Zustand
```ts
{
currentPoi: null
}
```
## 🎯 Aktionen
- `setCurrentPoi(poi)` setzt den aktiven POI
- `clearCurrentPoi()` löscht aktuellen POI
## 🔎 Selector
```ts
selectCurrentPoi = (state) => state.currentPoi.currentPoi;
```

View File

@@ -0,0 +1,103 @@
# 📦 locationDevicesFromDBSlice
Zuständig für das Laden und Speichern der Geräteinformationen pro Standort (Location) aus der Datenbank.
## 🧠 Zweck
Dieses Slice verwaltet die Geräte, die mit einem bestimmten Standort (Location) verknüpft sind.
Es nutzt ein `createAsyncThunk`, um die Daten vom Webservice bzw. von der lokalen Datenbank zu laden.
---
## 🔁 Datenfluss
1. **Dispatch `fetchLocationDevicesFromDB()`**
2. **Daten werden über `fetchLocationDevices()` geladen**
3. **Status wird aktualisiert (`loading`, `succeeded`, `failed`)**
4. **Geräte-Liste (`devices`) wird gespeichert**
---
## 🧩 Slice-Definition
```js
initialState: {
devices: [], // Geräte-Liste pro Standort
status: "idle", // "idle" | "loading" | "succeeded" | "failed"
error: null // Fehlernachricht im Fehlerfall
}
```
---
## 🔧 Actions
| Action Type | Beschreibung |
|--------------------------------------------|--------------------------------------------------|
| `fetchLocationDevicesFromDB/pending` | Startet den Ladeprozess |
| `fetchLocationDevicesFromDB/fulfilled` | Speichert die empfangenen Geräte in `devices` |
| `fetchLocationDevicesFromDB/rejected` | Speichert die Fehlermeldung in `error` |
---
## 📥 Async Thunk
```ts
export const fetchLocationDevicesFromDB = createAsyncThunk(
"locationDevicesFromDB/fetchLocationDevicesFromDB",
async () => {
return fetchLocationDevices(); // API-Aufruf aus services/api
}
);
```
Die Funktion `fetchLocationDevices()` befindet sich unter:
```
/redux/api/fromDB/fetchLocationDevices.js
```
---
## 🧪 Verwendung in Komponenten
### Beispiel mit `useSelector` & `useDispatch`
```tsx
import { useSelector, useDispatch } from "react-redux";
import { fetchLocationDevicesFromDB } from "@/redux/slices/db/locationDevicesFromDBSlice";
const dispatch = useDispatch();
const devices = useSelector((state) => state.locationDevicesFromDB.devices);
const status = useSelector((state) => state.locationDevicesFromDB.status);
useEffect(() => {
dispatch(fetchLocationDevicesFromDB());
}, []);
```
---
## 🧩 Integration im Store
```ts
import locationDevicesFromDBReducer from "./slices/db/locationDevicesFromDBSlice";
export const store = configureStore({
reducer: {
locationDevicesFromDB: locationDevicesFromDBReducer,
// weitere Slices ...
},
});
```
---
## 📌 Hinweis
Dieses Slice ist Bestandteil der neuen Redux-Architektur (ehemals Recoil)
→ siehe auch `CHANGELOG.md` Version `1.1.97` bis `1.1.98`.
```
Pfad: /redux/slices/db/locationDevicesFromDBSlice.js
```

View File

@@ -0,0 +1,93 @@
# 🧭 poiTypesSlice
Verwaltet die Point-of-Interest (POI) Typen, die vom Server bereitgestellt werden z.B. für die Darstellung von Symbolen oder Layer-Kategorien in der Karte.
---
## 📍 Datei
```
/redux/slices/db/poiTypesSlice.js
```
---
## 📦 Initialer State
```ts
{
data: [], // Liste der POI-Typen
status: "idle" // Ladezustand: "idle" | "loading" | "succeeded" | "failed"
}
```
---
## ⚙️ Async Thunk: `fetchPoiTypes`
```ts
export const fetchPoiTypes = createAsyncThunk("poiTypes/fetchPoiTypes", async () => {
let API_BASE_URL = "";
if (typeof window !== "undefined") {
API_BASE_URL = `${window.location.protocol}//${window.location.hostname}:3000`;
} else {
API_BASE_URL = "http://localhost:3000";
}
const response = await fetch(`${API_BASE_URL}/api/talas_v5_DB/poiTyp/readPoiTyp`);
return await response.json();
});
```
---
## 🔁 Lifecycle im Slice
| Zustand | Beschreibung |
|--------------------|--------------------------------------|
| `pending` | Setzt `status = "loading"` |
| `fulfilled` | Speichert `payload` in `state.data` und setzt `status = "succeeded"` |
| `rejected` | Setzt `status = "failed"` |
---
## 🧪 Verwendung im Component
```tsx
import { useSelector, useDispatch } from "react-redux";
import { fetchPoiTypes } from "@/redux/slices/db/poiTypesSlice";
const dispatch = useDispatch();
const poiTypes = useSelector((state) => state.poiTypes.data);
const status = useSelector((state) => state.poiTypes.status);
useEffect(() => {
dispatch(fetchPoiTypes());
}, []);
```
---
## 🧩 Store Integration
```ts
import poiTypesReducer from "./slices/db/poiTypesSlice";
export const store = configureStore({
reducer: {
poiTypes: poiTypesReducer,
// weitere ...
},
});
```
---
## 🌐 API-Endpunkt
```http
GET /api/talas_v5_DB/poiTyp/readPoiTyp
```
Erwartet JSON-Antwort mit allen verfügbaren POI-Typen für die App.

View File

@@ -0,0 +1,16 @@
# 📶 lineVisibilitySlice
Speichert, welche Linien (Kabelstrecken) aktiv sichtbar sind.
## 🔧 Zustand
```ts
{
activeLines: { [idLD]: true | false }
}
```
## 🎯 Aktionen
- `updateLineStatus({ idLD, active })`
- `setActiveLines({...})`

View File

@@ -0,0 +1,18 @@
# 🗺️ mapLayersSlice
Verwaltet Sichtbarkeit der verschiedenen Map-Layer pro System (TALAS, ECI, GMA usw.).
## 🔧 Zustand
```ts
{
TALAS: true,
ECI: true,
...
}
```
## 🎯 Aktionen
- `toggleLayer(layerName)`
- `setLayerVisibility({ layer, visibility })`

View File

@@ -0,0 +1,16 @@
# 👁️ poiLayerVisibleSlice
Steuert, ob der POI-Layer auf der Karte angezeigt wird.
## 🔧 Zustand
```ts
{
visible: true
}
```
## 🎯 Aktionen
- `setVisible(true|false)`
- `toggleVisible()`

View File

@@ -0,0 +1,16 @@
# 🔄 poiReadFromDbTriggerSlice
Verwaltet einen Trigger, um POIs aus der DB neu zu laden.
## 🔧 Zustand
```ts
{
trigger: 0
}
```
## 🎯 Aktionen
- `incrementTrigger()` erhöht den Wert (z.B. um useEffect auszulösen)
- `resetTrigger()` setzt auf 0 zurück

View File

@@ -0,0 +1,71 @@
# 🧩 poiTypesSlice Redux Slice für POI-Typen
## Zweck
Dieses Slice verwaltet die Liste der POI-Typen (`poiTyp`) aus der Datenbank.
Die Daten werden beim Start der Karte vom Server abgerufen und im Redux Store gespeichert.
---
## Quelle
API-Endpunkt:
```
/api/talas_v5_DB/poiTyp/readPoiTyp
```
Die Daten werden über einen `createAsyncThunk` geladen:
```js
export const fetchPoiTypes = createAsyncThunk("poiTypes/fetchPoiTypes", async () => {
// ...
});
```
---
## Dynamische API-URL
Damit kein Rebuild bei jedem Serverwechsel nötig ist, wird die API-URL dynamisch bestimmt:
```js
let API_BASE_URL = "";
if (typeof window !== "undefined") {
API_BASE_URL = `${window.location.protocol}//${window.location.hostname}:3000`;
} else {
API_BASE_URL = "http://localhost:3000";
}
```
➡ Dadurch kann dieselbe `.next`-Build auf verschiedenen Servern verwendet werden, ohne neu zu builden.
---
## Datenstruktur im Redux Store
```ts
{
poiTypes: {
items: [], // Liste aller POI-Typen
status: "idle" | "loading" | "succeeded" | "failed"
}
}
```
---
## Verwendung in Komponenten
Diese Daten werden typischerweise verwendet in:
- `components/pois/AddPoiModalWindow.js`
- `MapComponent.js` (indirekt)
---
## Siehe auch
- [`useFetchPoiData`](../../frontend/hooks/useFetchPoiData.md)
- API-Datei: `pages/api/talas_v5_DB/poiTyp/readPoiTyp.js`

View File

@@ -0,0 +1,23 @@
# 📋 polylineContextMenuSlice
Verwaltet das Kontextmenü für Polylinien (z.B. für Aktionen wie POI einfügen).
## 🔧 Zustand
```ts
{
isOpen: false,
position: { lat, lng },
forceClose: false,
timerStart: null,
countdown: 20,
countdownActive: false
}
```
## 🎯 Aktionen
- `openPolylineContextMenu(position)`
- `closePolylineContextMenu()`
- `updateCountdown()`
- `forceCloseContextMenu()`

View File

@@ -0,0 +1,16 @@
# 🚫 polylineEventsDisabledSlice
Steuert, ob Events auf Polylinien (z.B. Klicks) deaktiviert sind.
## 🔧 Zustand
```ts
{
disabled: false
}
```
## 🎯 Aktionen
- `setDisabled(true|false)`
- `toggleDisabled()`

View File

@@ -0,0 +1,15 @@
# 📏 polylineLayerVisibleSlice
Steuert, ob der Layer mit Kabelstrecken (Polylinien) angezeigt wird.
## 🔧 Zustand
```ts
{
visible: false
}
```
## 🎯 Aktionen
- `setPolylineVisible(true|false)` → speichert Zustand auch in `localStorage`

View File

@@ -0,0 +1,16 @@
# 📌 readPoiMarkersStoreSlice
Enthält alle POI-Marker, die von der Datenbank gelesen wurden.
## 🔧 Zustand
```ts
{
poiMarkers: []
}
```
## 🎯 Aktionen
- `setPoiMarkers(array)`
- `clearPoiMarkers()`

View File

@@ -0,0 +1,14 @@
# 🔧 selectedDeviceSlice
Speichert das aktuell ausgewählte Gerät (z.B. für Detailanzeige, Popup oder Bearbeitung).
## 🔧 Zustand
```ts
null | { ...deviceData }
```
## 🎯 Aktionen
- `setSelectedDevice(device)`
- `clearSelectedDevice()`

View File

@@ -0,0 +1,14 @@
# 📍 selectedPoiSlice
Speichert den aktuell ausgewählten POI (z.B. für Detailanzeige, Update oder Modal-Interaktion).
## 🔧 Zustand
```ts
null | { ...poiData }
```
## 🎯 Aktionen
- `setSelectedPoi(poi)`
- `clearSelectedPoi()`

View File

@@ -0,0 +1,18 @@
# 🌐 urlParameterSlice
Verwaltet `mapId` und `userId`, die aus der URL gelesen werden.
## 🔧 Zustand
```ts
{
mapId: null | string,
userId: null | string
}
```
## 🎯 Aktionen
- `setMapId(id)`
- `setUserId(id)`
- `setFromURL({ m, u })` gleichzeitig beide setzen aus URL-Params

View File

@@ -0,0 +1,26 @@
# 📈 gisStationsMeasurementsSlice
Verwaltet Messdaten für GIS-Stationen, z.B. Spannungen, Strom, Sensorwerte etc.
## 🔧 Pfad
`/redux/slices/webService/gisStationsMeasurementsSlice.js`
## 📦 Initial State
```ts
{
data: [],
status: "idle",
error: null
}
```
## 🔁 Thunk: `fetchGisStationsMeasurementsFromWebService`
Verwendet `fetchGisStationsMeasurements()` als API-Quelle.
## 📊 Selector
```ts
selectGisStationsMeasurements = (state) => state.gisStationsMeasurements.data;
```

View File

@@ -0,0 +1,18 @@
# 🏙️ gisStationsStaticDistrictSlice
Verwaltet statische Daten für GIS-Bezirksstationen.
## 🔧 Pfad
`/redux/slices/webService/gisStationsStaticDistrictSlice.js`
## 📦 Initial State
```ts
{
data: [],
status: "idle",
error: null
}
```
## 🔁 Thunk: `fetchGisStationsStaticDistrictFromWebService`

View File

@@ -0,0 +1,26 @@
# 🛰️ gisStationsStaticSlice
Verwaltet statische Informationen zu GIS-Stationen z.B. für das Dropdown im DataSheet-Bereich.
## 🔧 Pfad
`/redux/slices/webService/gisStationsStaticSlice.js`
## 📦 Initial State
```ts
{
data: null,
status: "idle",
error: null
}
```
## 🔁 Thunk: `fetchGisStationsStatic`
Lädt Daten über dynamisch erzeugte URL (`idMap` aus `window.location.search`).
## 🧪 Logging
```ts
console.log("📡 API Request URL in redux slice:", url);
```

View File

@@ -0,0 +1,18 @@
# 📶 gisStationsStatusDistrictSlice
Verwaltet Statusinformationen für GIS-Bezirksstationen (z.B. online/offline, Fehlerstatus).
## 🔧 Pfad
`/redux/slices/webService/gisStationsStatusDistrictSlice.js`
## 📦 Initial State
```ts
{
data: [],
status: "idle",
error: null
}
```
## 🔁 Thunk: `fetchGisStationsStatusDistrictFromWebService`

View File

@@ -0,0 +1,25 @@
# 🧭 gisSystemStaticSlice
Verwaltet statische GIS-Systemdaten (`Systems[]`), die vom Server zurückgegeben werden.
## 🔧 Pfad
`/redux/slices/webService/gisSystemStaticSlice.js`
## 📦 Initial State
```ts
{
data: [], // enthält Systems[]
status: "idle", // Ladezustand
error: null
}
```
## 🔁 Thunk: `fetchGisSystemStaticFromWebService`
Ruft `fetchGisSystemStatic()` auf und speichert nur das Feld `Systems` im Redux-State.
## 🧩 Aktionen
- `setGisSystemStatic(data)` → manuelles Setzen von `Systems[]`
- `fulfilled` → speichert Systems[]

View File

@@ -0,0 +1,16 @@
# 🔍 zoomTriggerSlice
Löst ein Neuzeichnen oder eine Zoom-Interaktion aus.
## 🔧 Zustand
```ts
{
trigger: 0
}
```
## 🎯 Aktionen
- `incrementZoomTrigger()` erhöht Trigger-Zähler (z.B. zur Synchronisation)
- `resetZoomTrigger()` setzt Trigger zurück