Merge branch 'development'

Author: ReadieFur

Diff for: README.md

@@ -33,4 +33,9 @@ This webapp is still very new and there should be a lot of changes to come in th
 ### Default overlay:  
 <img src="./previews/Default.gif" width="480">  
 
-I'm always open to new ideas and sugguestions, so if you feel like something could be added or improved feel free to drop me a message on Github or Discord.
+I'm always open to new ideas and sugguestions, so if you feel like something could be added or improved feel free to drop me a message on Github or Discord.
+
+### A note to developers:  
+If you would like a web template for obtaining the data from DataPuller, feel free to use the files in [this](./src/assets/js/overlay/) folder.  
+In my update for BSDP 2.1 I had patched a bit of the `client.ts` file to make it compatiable with the new `types/` folder, as a result you may want to clean up that file if you wish to use it.  
+The `types/` folder contains a set of classes and interfaces that can convert any of the data from BSDP version 2.0 and above into a single format that can be used in your peoject, this will save you from having to bother about getting different bits of data for each specific version of BSDP as I have done that for you. All you need to do is pass the json data into the `Parser` class (found in `types/web`) and depending on the data method you passed to, you will recieve the formatted data for that endpoint.

Diff for: src/.todo

@@ -26,6 +26,7 @@ Todo:
 
     //The project is in a good enough state to be made public without these being done. I will work on these in the future but cant really be bothered for this release.
     Public release:
+        ☐ Rewrite the client helper to match nicer with the new version parser.
         ☐ Add scores with modifiers.
         ☐ Replace browser location when redirected to http (possibly fixed).
         ☐ Tell the browser to cache the elements for faster loading.
@@ -53,7 +54,7 @@ Todo:
         ☐ add some browser specific features (styles).
         ☐ Fix 'history.replaceState' https to http.
         ☐ Fix arg redirection from 'u-readie...' to 'readie...'.
-    
+
     Optional:
         ☐ Convert all colours to HSL.
         ☐ add a rotation option.

Diff for: src/assets/js/overlay/client.ts

@@ -1,5 +1,6 @@
 import { Dictionary, Main } from "../main.js";
 import { EventDispatcher } from "../eventDispatcher.js";
+import { Parser, MapData, LiveData } from "./types/web.js";
 
 export class Client
 {
@@ -106,177 +107,34 @@ class CustomWebSocket
         //setTimeout(() => { this.Connect(); }, 5000); //This is causing the websocket to fill up memory.
     }
 
-    private OnMessage(ev: MessageEvent<any>): void
+    private async OnMessage(ev: MessageEvent<any>): Promise<void>
     {
-        var jsonData: MapData | LiveData = JSON.parse(ev.data);
-        this.eventDispatcher.DispatchEvent("message", jsonData);
-        if (Main.urlParams.has("debug")) { console.log(jsonData); }
-    }
-}
-
-//Get new data types for these (null)
-export type MapData =
-{
-    //Level
-    InLevel: boolean,
-    LevelPaused: boolean,
-    LevelFinished: boolean,
-    LevelFailed: boolean,
-    LevelQuit: boolean,
-
-    //Map
-    Hash: string | null,
-    SongName: string | null,
-    SongSubName: string | null,
-    SongAuthor: string,
-    Mapper: string | null,
-    BSRKey: string | null,
-    coverImage: string | null,
-    Length: number,
-    TimeScale: number,
-
-    //Difficulty
-    MapType: string | null,
-    Difficulty: string | null,
-    CustomDifficultyLabel: string | null,
-    BPM: number,
-    NJS: number,
-    Modifiers:
-    {
-        noFailOn0Energy: boolean,
-        oneLife: boolean,
-        fourLives: boolean,
-        noBombs: boolean,
-        noWalls: boolean,
-        noArrows: boolean,
-        ghostNotes: boolean,
-        disappearingArrows: boolean,
-        smallNotes: boolean,
-        proMode: boolean,
-        strictAngles: boolean,
-        zenMode: boolean,
-        slowerSong: boolean,
-        fasterSong: boolean,
-        superFastSong: boolean
-    },
-    ModifiersMultiplier: number,
-    PracticeMode: boolean,
-    PracticeModeModifiers:
-    {
-        songSpeedMul: number,
-        startInAdvanceAndClearNotes: number,
-        startSongTime: number
-    },
-    PP: number,
-    Star: number,
-
-    //Misc
-    GameVersion: string,
-    PluginVersion: string,
-    IsMultiplayer: boolean,
-    PreviousRecord: number,
-    PreviousBSR: string | null,
-    unixTimestamp: number
-}
-
-export type LiveData =
-{
-    //Score
-    Score: number,
-    ScoreWithMultipliers: number,
-    MaxScore: number,
-    MaxScoreWithMultipliers: number,
-    Rank: string | null,
-    FullCombo: boolean,
-    Combo: number,
-    Misses: number,
-    Accuracy: number,
-    BlockHitScore: number[] | null,
-    PlayerHealth: number,
+        const deserializedData: object = JSON.parse(ev.data);
 
-    //Misc
-    TimeElapsed: number,
-    unixTimestamp: number
-}
-
-export class SampleData
-{
-    public static readonly mapData: MapData =
-    {
-        GameVersion: "1.13.2",
-        PluginVersion: "2.0.2.0",
-        InLevel: true,
-        LevelPaused: false,
-        LevelFinished: false,
-        LevelFailed: false,
-        LevelQuit: false,
-        Hash: "648B6FE961C398DE638FA1E614878F1194ADF92E",
-        SongName: "Tera I/O",
-        SongSubName: "[200 Step]",
-        SongAuthor: "Camellia",
-        Mapper: "cerret",
-        BSRKey: "11a27",
-        coverImage: `https://readiefur.com/bsdp-overlay/assets/images/TeraIO.jpg`,
-        Length: 336,
-        TimeScale: 0,
-        MapType: "Standard",
-        Difficulty: "ExpertPlus",
-        CustomDifficultyLabel: "Normal",
-        BPM: 200,
-        NJS: 23,
-        Modifiers:
+        //This has been put together in a somewhat sort of hacky way to be compatible with the old (existing) website.
+        //I would rewrite parts of the site but I can't be bothered to do that right now.
+        let parsedData: MapData | LiveData | null = null;
+        try
         {
-            noFailOn0Energy: false,
-            oneLife: false,
-            fourLives: false,
-            noBombs: false,
-            noWalls: false,
-            noArrows: false,
-            ghostNotes: false,
-            disappearingArrows: true,
-            smallNotes: false,
-            proMode: false,
-            strictAngles: true,
-            zenMode: false,
-            slowerSong: false,
-            fasterSong: false,
-            superFastSong: false
-        },
-        ModifiersMultiplier: 1,
-        PracticeMode: false,
-        PracticeModeModifiers:
+            //This will fail if the data does not contain a "PluginVersion" property/
+            parsedData = await Parser.ParseMapDataObj(deserializedData);
+        }
+        catch
         {
-            songSpeedMul: 1,
-            startInAdvanceAndClearNotes: 0,
-            startSongTime: 0
-        },
-        PP: 0,
-        Star: 0,
-        IsMultiplayer: false,
-        PreviousRecord: 2714014,
-        PreviousBSR: "123ba",
-        unixTimestamp: 1631935482036
-    }
+            //If it fails, we can assume the data is a type of LiveData.
+            //However we still want to try/catch this becuase it could fail if a converter hasn't been loaded yet.
+            try { parsedData = await Parser.ParseLiveDataObj(deserializedData); }
+            catch {}
+        }
 
-    public static readonly liveData: LiveData =
-    {
-        Score: 574728,
-        ScoreWithMultipliers: 574728,
-        MaxScore: 612835,
-        MaxScoreWithMultipliers: 612835,
-        Rank: "SS",
-        FullCombo: false,
-        Combo: 352,
-        Misses: 2,
-        Accuracy: 94.20143961906433,
-        BlockHitScore:
-        [
-            70,
-            30,
-            14
-        ],
-        PlayerHealth: 87,
-        TimeElapsed: 77,
-        unixTimestamp: 1631935485375
+        if (parsedData == null)
+        {
+            //If we failed to parse the data, log an error to the console with the input data and return early (drop the message).
+            console.error("Failed to parse data from websocket.", deserializedData);
+            return;
+        }
+
+        this.eventDispatcher.DispatchEvent("message", parsedData);
+        if (Main.urlParams.has("debug")) { console.log(parsedData); }
     }
-}
+}

Diff for: src/assets/js/overlay/overlayHelper.ts

@@ -1,6 +1,6 @@
 import { DragElement } from "../dragElement.js";
 import { Dictionary, Main, ReturnData } from "../main.js";
-import { LiveData, MapData } from "./client.js";
+import { MapData, LiveData } from "./types/web.js";
 
 export class OverlayHelper
 {
@@ -187,4 +187,4 @@ export interface ElementScript
     ResetData(): void;
     UpdateMapData(data: MapData): void;
     UpdateLiveData(data: LiveData): void;
-}
+}