added more precise types to LichessApi event types

Author: CodingFactoryT

RaspberryPi-WebServer/backend/src/controllers/Streams/Stream.ts

@@ -31,7 +31,12 @@ export default class Stream {
 				const dataStr = data.toString().trim();
 				if (dataStr.length > 0) {
 					dataStr.split("\n").forEach((element: string) => {
-						this.dataFunction(JSON.parse(element));
+						const parsedObject = JSON.parse(element);
+						if(this.#isLichessError(parsedObject)) {
+							this.errorFunction(parsedObject.error);
+						} else {
+							this.dataFunction(parsedObject);
+						}
 					});
 				}
 			});
@@ -56,4 +61,9 @@ export default class Stream {
 	getName() {
 		return this.streamName;
 	}
+
+	#isLichessError(obj: any): obj is LichessError {
+  	return typeof obj === "object" && typeof obj?.error === "string";
+	}
+
 }

RaspberryPi-WebServer/backend/src/controllers/WebSocketController.ts

@@ -60,7 +60,7 @@ export default class WebSocketController {
 		});
 	}
 
-	#handleIncomingData(message) {
+	#handleIncomingData(message: any) {
 		switch (message.type) {
 			case "challengeAccepted":
 				return LichessChallengeController.acceptChallenge(message.data.id);

RaspberryPi-WebServer/backend/tsconfig.json

@@ -36,7 +36,7 @@
     },                                                   /* Specify a set of entries that re-map imports to additional lookup locations. */
     // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
     "typeRoots": [
-      "./types",
+      "./types/**/*",
       "./node_modules/@types"
     ],                                                   /* Specify multiple folders that act like './node_modules/@types'. */
     // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
@@ -115,5 +115,5 @@
     // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
     "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
   },
-  "include": ["src/**/*", "types"]
+  "include": ["src/**/*", "types/**/*"]
 }

RaspberryPi-WebServer/backend/types/Lichess/GameStreamTypes.d.ts

@@ -0,0 +1,62 @@
+
+type GameStreamEvent = GameFullEvent | GameStateEvent | ChatLineEvent | OpponentGoneEvent;
+
+interface GameFullEvent {
+  type: "gameFull",
+  id: string,
+  variant: Variant,
+  clock: {
+    initial: number,
+    increment: number
+  },
+  speed: Speed,
+  perf: {
+    name: string
+  },
+  rated: boolean,
+  createdAt: number,
+  white: GameEventPlayer,
+  black: GameEventPlayer,
+  initialFen: string,
+  state: GameStateEvent
+  tournamentId: string,
+}
+
+interface GameStateEvent {
+  type: "gameState",
+  moves: string,
+  wtime: number,
+  btime: number,
+  winc: number,
+  binc: number,
+  status: GameStatus,
+  winner: string,
+  wdraw: boolean,
+  bdraw: boolean,
+  wtakeback: boolean,
+  btakeback: boolean,
+}
+
+interface ChatLineEvent {
+  type: "chatLine",
+  room: "player" | "spectator",
+  username: string,
+  text: string,
+}
+
+interface OpponentGoneEvent {
+  type: "opponentGone",
+  gone: boolean,
+  claimWinInSeconds: number,
+}
+
+interface GameEventPlayer {
+  aiLevel: number,
+  id: string,
+  name: string,
+  title: Title | null
+  rating: number,
+  provisional: boolean,
+}
+
+type GameStatus =  | "created" | "started" | "aborted" | "mate" | "resign" | "stalemate" | "timeout" | "draw" | "outoftime" | "cheat" | "noStart" | "unknownFinish" | "variantEnd";

RaspberryPi-WebServer/backend/types/Lichess/MainEventStreamTypes.d.ts

@@ -0,0 +1,97 @@
+
+type MainEventStreamEvent = GameStartEvent | GameFinishEvent | ChallengeEvent | ChallengeCanceledEvent | ChallengeDeclinedEvent;
+
+interface GameStartEvent {
+  type: "gameStart",
+  game: GameEventInfo
+}
+
+interface GameFinishEvent {
+  type: "gameFinish",
+  game: GameEventInfo
+}
+
+interface ChallengeEvent { 
+  type: "challenge",
+  challenge: ChallengeJson,
+  compat: GameCompat,
+}
+
+interface ChallengeCanceledEvent {
+  type: "challengeCanceled",
+  challenge: ChallengeJson
+}
+
+interface ChallengeDeclinedEvent {
+  type: "challengeDeclined",
+  challenge: ChallengeDeclinedJson
+}
+
+interface GameEventInfo {
+  fullId: string,
+  gameId: string,
+  fen: string,
+  color: Color
+  lastMove: string,
+  source: GameSource
+  status: EventStatus
+  variant: {
+    key: string,
+    name: string
+  },
+  speed: Speed,
+  perf: string,
+  rated: boolean,
+  hasMoved: boolean,
+  opponent: {
+    id: string,
+    username: string,
+    rating: number
+  },
+  isMyTurn: boolean,
+  secondsLeft: number,
+  compat: GameCompat
+  id: string
+}
+
+interface ChallengeJson {
+  id: string,
+  url: string,
+  status: ChallengeStatus,
+  challenger: ChallengeUser,
+  destUser: ChallengeUser | null,
+  variant: Variant,
+  rated: boolean,
+  speed: Speed
+  timeControl: RealTimeTimeControl | CorrespondenceTimeControl | UnlimitedTimeControl,
+  color: Color | "random",
+  finalColor: Color,
+  perf: {
+    icon: string,
+    name: string,
+  },
+  direction: "in" | "out",
+  initialFen: string,
+}
+
+interface ChallengeDeclinedJson {
+  declineReason: string,
+  declineReasonKey: DeclineReasonKey,
+  id: string,
+  url: string,
+  status: ChallengeStatus,
+  challenger: ChallengeUser,
+  destUser: ChallengeUser | null,
+  variant: Variant,
+  rated: boolean,
+  speed: Speed,
+  timeControl: RealTimeTimeControl | CorrespondenceTimeControl | UnlimitedTimeControl,
+  color: Color | "random",
+  finalColor: Color,
+  perf: {
+    icon: string,
+    name: string
+  },
+  direction: "in" | "out",
+  initialFen: string
+}

RaspberryPi-WebServer/backend/types/Lichess/OtherLichessTypes.d.ts

@@ -0,0 +1,60 @@
+interface LichessError {
+  error: string
+}
+
+interface RealTimeTimeControl {
+  type: "clock",
+  limit: number,
+  increment: number,
+  show: string
+}
+
+interface CorrespondenceTimeControl {
+  type: "correspondence",
+  daysPerTurn: number
+}
+
+interface UnlimitedTimeControl {
+  type: "unlimited"
+}
+
+type GameSource = "lobby" | "friend" | "ai" | "api" | "tournament" | "position" | "import" | "importlive" | "simul" | "relay" | "pool" | "swiss";
+type Color = "white" | "black";
+
+interface EventStatus {
+  id: 10 | 20 | 25 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 60,
+  name: "created" | "started" | "aborted" | "mate" | "resign" | "stalemate" | "timeout" | "draw" | "outoftime" | "cheat" | "noStart" | "unknownFinish" | "variantEnd",
+}
+
+type Speed = "ultraBullet" | "bullet" | "blitz" | "rapid" | "classical" | "correspondence";
+
+type ChallengeStatus = "created" | "offline" | "canceled" | "declined" | "accepted";
+
+type Title = "GM" | "WGM" | "IM" | "WIM" | "FM" | "WFM" | "NM" | "CM" | "WCM" | "WNM" | "LM" | "BOT";
+
+interface ChallengeUser {
+  id: string,
+  name: string,
+  rating: number,
+  title: Title | null,
+  flair: string,
+  patron: boolean
+  provisional: boolean,
+  online: boolean,
+  lag: number
+}
+
+type VariantKey = "standard" | "chess960" | "crazyhouse" | "antichess" | "atomic" | "horde" | "kingOfTheHill" | "racingKings" | "threeCheck" | "fromPosition";
+
+interface Variant {
+  key: VariantKey
+  name: string,
+  short: string
+}
+
+type DeclineReasonKey = "generic" | "later" | "tooFast" | "tooSlow" | "timeControl" | "rated" | "casual" | "standard" | "variant" | "noBot" | "onlyBot";
+
+interface GameCompat { 
+  bot: boolean,
+  board: boolean
+}