0.16.1-1 release snapshot

2026-04-29 08:35:24 +00:00
parent 6115090da1
commit 901a3b1ad7
269 changed files with 127336 additions and 1 deletions
@@ -0,0 +1,294 @@
+# WebSocket Events
+
+Ripster sendet Echtzeit-Updates über `/ws`.
+
+---
+
+## Verbindung
+
+```js
+const ws = new WebSocket('ws://localhost:3001/ws');
+
+ws.onmessage = (event) => {
+  const msg = JSON.parse(event.data);
+  console.log(msg.type, msg.payload);
+};
+```
+
+---
+
+## Nachrichtenformat
+
+Die meisten Broadcasts haben dieses Schema:
+
+```json
+{
+  "type": "EVENT_TYPE",
+  "payload": {},
+  "timestamp": "2026-03-10T09:00:00.000Z"
+}
+```
+
+Ausnahme: `WS_CONNECTED` beim Verbindungsaufbau enthält kein `timestamp`.
+
+---
+
+## Event-Typen
+
+### WS_CONNECTED
+
+Sofort nach erfolgreicher Verbindung.
+
+```json
+{
+  "type": "WS_CONNECTED",
+  "payload": {
+    "connectedAt": "2026-03-10T09:00:00.000Z"
+  }
+}
+```
+
+### PIPELINE_STATE_CHANGED
+
+Neuer Pipeline-Snapshot.
+
+```json
+{
+  "type": "PIPELINE_STATE_CHANGED",
+  "payload": {
+    "state": "ENCODING",
+    "activeJobId": 42,
+    "progress": 62.5,
+    "eta": "00:12:34",
+    "statusText": "ENCODING 62.50%",
+    "context": {},
+    "jobProgress": {
+      "42": {
+        "state": "ENCODING",
+        "progress": 62.5,
+        "eta": "00:12:34",
+        "statusText": "ENCODING 62.50%"
+      }
+    },
+    "queue": {
+      "maxParallelJobs": 1,
+      "runningCount": 1,
+      "queuedCount": 2,
+      "runningJobs": [],
+      "queuedJobs": []
+    }
+  }
+}
+```
+
+### PIPELINE_PROGRESS
+
+Laufende Fortschrittsupdates.
+
+```json
+{
+  "type": "PIPELINE_PROGRESS",
+  "payload": {
+    "state": "ENCODING",
+    "activeJobId": 42,
+    "progress": 62.5,
+    "eta": "00:12:34",
+    "statusText": "ENCODING 62.50%"
+  }
+}
+```
+
+### PIPELINE_QUEUE_CHANGED
+
+Queue-Snapshot aktualisiert.
+
+### DISC_DETECTED / DISC_REMOVED
+
+Disc-Insertion/-Removal.
+
+```json
+{
+  "type": "DISC_DETECTED",
+  "payload": {
+    "device": {
+      "path": "/dev/sr0",
+      "discLabel": "INCEPTION",
+      "model": "ASUS BW-16D1HT",
+      "fstype": "udf",
+      "mountpoint": null,
+      "mediaProfile": "bluray"
+    }
+  }
+}
+```
+
+`mediaProfile`: `bluray` | `dvd` | `other` | `null`
+
+### HARDWARE_MONITOR_UPDATE
+
+Snapshot aus Hardware-Monitoring.
+
+```json
+{
+  "type": "HARDWARE_MONITOR_UPDATE",
+  "payload": {
+    "enabled": true,
+    "intervalMs": 5000,
+    "updatedAt": "2026-03-10T09:00:00.000Z",
+    "sample": {
+      "cpu": {},
+      "memory": {},
+      "gpu": {},
+      "storage": {}
+    },
+    "error": null
+  }
+}
+```
+
+### PIPELINE_ERROR
+
+Fehler bei Disc-Event-Verarbeitung in Pipeline.
+
+### DISK_DETECTION_ERROR
+
+Fehler in Laufwerkserkennung.
+
+### SETTINGS_UPDATED
+
+Einzelnes Setting wurde gespeichert.
+
+### SETTINGS_BULK_UPDATED
+
+Bulk-Settings gespeichert.
+
+```json
+{
+  "type": "SETTINGS_BULK_UPDATED",
+  "payload": {
+    "count": 3,
+    "keys": ["raw_dir", "movie_dir", "handbrake_preset_bluray"]
+  }
+}
+```
+
+### SETTINGS_SCRIPTS_UPDATED
+
+Skript geändert (`created|updated|deleted|reordered`).
+
+### SETTINGS_SCRIPT_CHAINS_UPDATED
+
+Skript-Kette geändert (`created|updated|deleted|reordered`).
+
+### USER_PRESETS_UPDATED
+
+User-Preset geändert (`created|updated|deleted`).
+
+### CRON_JOBS_UPDATED
+
+Cron-Config geändert (`created|updated|deleted`).
+
+### CRON_JOB_UPDATED
+
+Laufzeitstatus eines Cron-Jobs geändert.
+
+```json
+{
+  "type": "CRON_JOB_UPDATED",
+  "payload": {
+    "id": 1,
+    "lastRunStatus": "running",
+    "lastRunAt": "2026-03-10T10:00:00.000Z",
+    "nextRunAt": null
+  }
+}
+```
+
+### RUNTIME_ACTIVITY_CHANGED
+
+Vollständiger Snapshot aller laufenden und kürzlich abgeschlossenen Aktivitäten.
+
+Wird ausgelöst, wenn eine Aktivität gestartet, aktualisiert oder abgeschlossen wird sowie nach `clear-recent`.
+
+```json
+{
+  "type": "RUNTIME_ACTIVITY_CHANGED",
+  "payload": {
+    "active": [
+      {
+        "id": 7,
+        "type": "chain",
+        "name": "Post-Encode Aufräumen",
+        "status": "running",
+        "source": "cron",
+        "message": "Schritt 2 von 3",
+        "currentStep": "cleanup.sh",
+        "currentStepType": "script",
+        "stepIndex": 2,
+        "stepTotal": 3,
+        "canCancel": true,
+        "canNextStep": false,
+        "outcome": "running",
+        "startedAt": "2026-03-10T10:00:00.000Z",
+        "finishedAt": null,
+        "durationMs": null
+      }
+    ],
+    "recent": [],
+    "updatedAt": "2026-03-10T10:00:05.000Z"
+  }
+}
+```
+
+Vollständige Feldbeschreibung: [Runtime Activities API](runtime-activities.md).
+
+### CONVERTER_SCAN_UPDATE
+
+Wird nach einem Scan des Converter-Eingangsordners gesendet (manuell oder per Polling).
+
+```json
+{
+  "type": "CONVERTER_SCAN_UPDATE",
+  "payload": {
+    "entryCount": 12
+  }
+}
+```
+
+### DOWNLOADS_UPDATED
+
+Wird bei jeder Statusänderung in der Download-Queue gesendet.
+
+```json
+{
+  "type": "DOWNLOADS_UPDATED",
+  "payload": {
+    "reason": "ready",
+    "item": {
+      "id": "dl-1",
+      "jobId": 42,
+      "status": "ready",
+      "archiveName": "Job_42_movie.zip",
+      "createdAt": "2026-03-30T10:00:00.000Z"
+    },
+    "summary": {
+      "total": 3,
+      "pending": 1,
+      "processing": 0,
+      "ready": 1,
+      "failed": 1
+    }
+  }
+}
+```
+
+Mögliche `reason`-Werte: `queued`, `processing`, `ready`, `failed`, `deleted`.
+
+---
+
+## Reconnect-Verhalten
+
+`useWebSocket` verbindet bei Abbruch automatisch neu:
+
+- Retry-Intervall: `1500ms`
+- Wiederverbindung bis Komponente unmounted wird