feat: add worldstate websocket

lib/src/clients/worldstate_client.dart

@@ -3,6 +3,7 @@ import 'dart:convert';
 import 'package:compute/compute.dart';
 import 'package:meta/meta.dart';
 import 'package:warframestat_client/warframestat_client.dart';
+import 'package:web_socket_client/web_socket_client.dart';
 
 /// {@template warframestat_client}
 /// Exposes all endpoints pertaining to worldstate.
@@ -11,6 +12,20 @@ class WorldstateClient extends WarframestatClient {
   /// {@macro warframestat_client}
   WorldstateClient({super.language, super.ua, super.client});
 
+  /// Opens a websocket connection for worldstate updates.
+  Stream<Worldstate> worldstateWebSocket([WebSocket? webSocket]) {
+    final ws = Uri.parse('ws://api.warframestat.us/socket');
+    final socket = webSocket ?? WebSocket(ws);
+
+    return socket.messages
+        .map((event) => json.decode(event as String) as Map<String, dynamic>)
+        .where((event) => event['event'] == 'ws:update')
+        .map((event) => event['packet'] as Map<String, dynamic>)
+        .where((event) => event['language'] == language.name)
+        .map((event) =>
+            Worldstate.fromJson(event['data'] as Map<String, dynamic>));
+  }
+
   /// Retrives a fully translated [Worldstate].
   Future<Worldstate> fetchWorldstate() async {
     final worldstate = await _get<Map<String, dynamic>>('');

pubspec.yaml

@@ -13,6 +13,7 @@ dependencies:
   http: ">=1.1.0 <2.0.0"
   json_annotation: ">=4.8.1 <5.0.0"
   meta: ">=1.9.0 <2.0.0"
+  web_socket_client: ^0.1.1
 
 dev_dependencies:
   build_runner: ^2.4.8