Add WASM support for reading ShieldBattery data.

Author: tec27

Cargo.lock

@@ -18,6 +18,10 @@ js-sys = "0.3"
 serde = { version = "1.0", features = ["derive"] }
 serde-wasm-bindgen = "0.6"
 tsify = { version = "0.5", default-features = false, features = ["js"] }
+uuid = { version = "1.18", default-features = false, features = [
+  "js",
+  "serde",
+] }
 wasm-bindgen = "0.2"
 
 [dependencies.web-sys]

broodrep-wasm/Cargo.toml

@@ -2,8 +2,14 @@ use js_sys::Uint8Array;
 use serde::{Deserialize, Serialize};
 use std::io::Cursor;
 use tsify::Tsify;
+use uuid::Uuid;
 use wasm_bindgen::prelude::*;
 
+#[wasm_bindgen(typescript_custom_section)]
+const TS_APPEND_CONTENT: &'static str = r#"
+export type Uuid = string;
+"#;
+
 /// Decompression configuration options. These settings help prevent zip bomb attacks and excessive
 /// resource usage.
 #[derive(Clone, Debug, Default, Tsify, Serialize, Deserialize)]
@@ -305,6 +311,33 @@ impl From<ReplaySection> for broodrep::ReplaySection {
     }
 }
 
+#[derive(Debug, Clone, PartialEq, Eq, Hash, Tsify, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+#[tsify(into_wasm_abi)]
+pub struct ShieldBatteryData {
+    pub starcraft_exe_build: u32,
+    pub shieldbattery_version: String,
+    pub team_game_main_players: [u8; 4],
+    pub starting_races: [u8; 12],
+    pub game_id: Uuid,
+    pub user_ids: [u32; 8],
+    pub game_logic_version: Option<u16>,
+}
+
+impl From<broodrep::ShieldBatteryData> for ShieldBatteryData {
+    fn from(data: broodrep::ShieldBatteryData) -> Self {
+        ShieldBatteryData {
+            starcraft_exe_build: data.starcraft_exe_build(),
+            shieldbattery_version: data.shieldbattery_version().to_string(),
+            team_game_main_players: data.team_game_main_players(),
+            starting_races: data.starting_races(),
+            game_id: Uuid::from_u128(data.game_id()),
+            user_ids: data.user_ids(),
+            game_logic_version: data.game_logic_version(),
+        }
+    }
+}
+
 /// A parsed StarCraft replay. Only the header will be parsed eagerly, other sections may be
 /// processed on demand.
 ///
@@ -370,6 +403,16 @@ impl Replay {
             .get_raw_section(section_id.to_le_bytes().into())
             .map_err(|e| JsValue::from_str(&e.to_string()))
     }
+
+    /// Returns the parsed ShieldBattery section, or `undefined` if not present in the replay.
+    #[wasm_bindgen(js_name = getShieldBatterySection)]
+    pub fn get_shieldbattery_section(&mut self) -> Result<Option<ShieldBatteryData>, JsValue> {
+        Ok(self
+            .replay
+            .get_shieldbattery_section()
+            .map_err(|e| JsValue::from_str(&e.to_string()))?
+            .map(Into::into))
+    }
 }
 
 /// Parse a StarCraft replay from a Uint8Array (synchronously).

broodrep-wasm/src/lib.rs

@@ -1080,10 +1080,10 @@ mod tests {
 
         assert_eq!(data.starcraft_exe_build(), 13515);
         assert_eq!(data.shieldbattery_version(), "10.1.0");
-        assert_eq!(data.team_game_main_players(), &[0, 0, 0, 0]);
-        assert_eq!(data.starting_races(), &[2, 1, 0, 1, 1, 0, 1, 1, 0, 0, 0, 0]);
+        assert_eq!(data.team_game_main_players(), [0, 0, 0, 0]);
+        assert_eq!(data.starting_races(), [2, 1, 0, 1, 1, 0, 1, 1, 0, 0, 0, 0]);
         assert_eq!(data.game_id(), 56542772156747381282200559102402795521);
-        assert_eq!(data.user_ids(), &[101, 112, 1, 113, 0, 0, 0, 0]);
+        assert_eq!(data.user_ids(), [101, 112, 1, 113, 0, 0, 0, 0]);
         assert_eq!(data.game_logic_version(), Some(3));
     }
 

broodrep/src/lib.rs

@@ -53,18 +53,18 @@ impl ShieldBatteryData {
     }
 
     /// Which players were the "main" players in a team game (e.g. Team Melee).
-    pub fn team_game_main_players(&self) -> &[u8; 4] {
+    pub fn team_game_main_players(&self) -> [u8; 4] {
         match self {
-            ShieldBatteryData::Version0(data) => &data.team_game_main_players,
-            ShieldBatteryData::Version1(data, _) => &data.team_game_main_players,
+            ShieldBatteryData::Version0(data) => data.team_game_main_players,
+            ShieldBatteryData::Version1(data, _) => data.team_game_main_players,
         }
     }
 
     /// The starting race for each player in the game.
-    pub fn starting_races(&self) -> &[u8; 12] {
+    pub fn starting_races(&self) -> [u8; 12] {
         match self {
-            ShieldBatteryData::Version0(data) => &data.starting_races,
-            ShieldBatteryData::Version1(data, _) => &data.starting_races,
+            ShieldBatteryData::Version0(data) => data.starting_races,
+            ShieldBatteryData::Version1(data, _) => data.starting_races,
         }
     }
 
@@ -78,10 +78,10 @@ impl ShieldBatteryData {
 
     /// The ShieldBattery user IDs of the players ingame, in the same order as the players in the
     /// replay header.
-    pub fn user_ids(&self) -> &[u32; 8] {
+    pub fn user_ids(&self) -> [u32; 8] {
         match self {
-            ShieldBatteryData::Version0(data) => &data.user_ids,
-            ShieldBatteryData::Version1(data, _) => &data.user_ids,
+            ShieldBatteryData::Version0(data) => data.user_ids,
+            ShieldBatteryData::Version1(data, _) => data.user_ids,
         }
     }