games: Upload Chess games to Lichess

Author: PartMan7

src/ps/games/chess/index.ts

@@ -28,6 +28,7 @@ export class Chess extends Game<State> {
 	log: Log[] = [];
 	winCtx?: WinCtx | { type: EndType };
 	cache: Record<string, Record<Turn, number>> = {};
+	lichessURL: string | null = null;
 
 	theme: ThemeColours = {
 		W: '#fff',
@@ -45,6 +46,17 @@ export class Chess extends Game<State> {
 		if (ctx.backup) {
 			this.lib.loadPgn(this.state.pgn);
 		}
+
+		this.lib.setHeader('Event', `Room Match ${this.id}`);
+		this.lib.setHeader('Site', 'https://play.pokemonshowdown.com/boardgames');
+	}
+
+	onStart(): ActionResponse {
+		this.lib.setHeader('Date', new Date().toDateString());
+		this.lib.setHeader('White', this.players.W.name);
+		this.lib.setHeader('Black', this.players.B.name);
+
+		return { success: true, data: null };
 	}
 
 	action(user: User, ctx: string): void {
@@ -115,8 +127,9 @@ export class Chess extends Game<State> {
 		this.drawOffered = null;
 	}
 
-	onReplacePlayer(): ActionResponse<null> {
+	onReplacePlayer(turn: Turn, withPlayer: User): ActionResponse<null> {
 		this.cleanup();
+		this.lib.setHeader(turn === 'W' ? 'White' : 'Black', withPlayer.name);
 		return { success: true, data: null };
 	}
 
@@ -141,6 +154,20 @@ export class Chess extends Game<State> {
 		this.throw();
 	}
 
+	async getURL(): Promise<string | null> {
+		if (this.lichessURL) return this.lichessURL;
+
+		this.lichessURL = await fetch('https://lichess.org/api/import', {
+			method: 'POST',
+			body: JSON.stringify({ pgn: this.state.pgn }),
+			headers: { Accept: 'application/json', 'Content-Type': 'application/json' },
+		})
+			.then(res => res.json())
+			.then(res => (res as { url: string }).url);
+
+		return this.lichessURL;
+	}
+
 	// renderEmbed(): EmbedBuilder {
 	// 	// TODO
 	// }

src/ps/games/common.ts

@@ -42,7 +42,7 @@ export interface Player {
 
 export type BaseState = { board: unknown; turn: string };
 
-export type ActionResponse<T = undefined> = { success: true; data: T } | { success: false; error: TranslatedText };
+export type ActionResponse<T = null> = { success: true; data: T } | { success: false; error: TranslatedText };
 
 export type EndType = 'regular' | 'force' | 'dq' | 'loss';
 

src/ps/games/connectfour/index.ts

@@ -103,7 +103,7 @@ export class ConnectFour extends Game<State> {
 		throw new Error(`winCtx not defined for C4 - ${JSON.stringify(this.winCtx)}`);
 	}
 
-	renderEmbed(): EmbedBuilder {
+	async renderEmbed(): Promise<EmbedBuilder> {
 		const winner = this.winCtx && this.winCtx.type === 'win' ? this.winCtx.winner.id : null;
 		const title = Object.values(this.players)
 			.map(player => `${player.name} (${player.turn})${player.id === winner ? ` ${WINNER_ICON}` : ''}`)

src/ps/games/game.ts

@@ -68,7 +68,7 @@ export class Game<State extends BaseState> {
 	render() {
 		return null as unknown as ReactElement;
 	}
-	renderEmbed?(): EmbedBuilder | null;
+	renderEmbed?(): Promise<EmbedBuilder | null>;
 
 	action(user: User, ctx: string, reaction: boolean): void;
 	action() {}
@@ -352,7 +352,7 @@ export class Game<State extends BaseState> {
 		this.startedAt = new Date();
 		this.setTimer('Game started');
 		this.backup();
-		return { success: true, data: undefined };
+		return { success: true, data: null };
 	}
 
 	// Only gets next turn. No side effects.
@@ -403,7 +403,7 @@ export class Game<State extends BaseState> {
 		if (this.spectators.length > 0) this.room.pageHTML(this.spectators, this.render(null), { name: this.id });
 	}
 
-	getURL(): string | null {
+	getURL(): Promise<string | null> | string | null {
 		if (this.meta.players === 'single') return null;
 		return `${process.env.WEB_URL}/${this.meta.id}/${this.id.replace(/^#/, '')}`;
 	}
@@ -419,11 +419,12 @@ export class Game<State extends BaseState> {
 		this.room.send(message);
 		if (this.started && typeof this.renderEmbed === 'function' && this.roomid === 'boardgames') {
 			// Send only for games from BG
-			const embed = this.renderEmbed();
-			if (embed) {
-				const channel = getChannel(BOT_LOG_CHANNEL);
-				channel?.send({ embeds: [embed] });
-			}
+			this.renderEmbed().then(embed => {
+				if (embed) {
+					const channel = getChannel(BOT_LOG_CHANNEL);
+					channel?.send({ embeds: [embed] });
+				}
+			});
 		}
 		// Upload to DB
 		if (IS_ENABLED.DB && this.meta.players !== 'single') {
@@ -439,8 +440,8 @@ export class Game<State extends BaseState> {
 				winCtx: 'winCtx' in this ? this.winCtx : null,
 			};
 			uploadGame(model)
-				.then(() => {
-					const replay = this.getURL();
+				.then(async () => {
+					const replay = await this.getURL();
 					if (replay) this.room.send(replay as NoTranslate);
 				})
 				.catch(err => {

src/ps/games/othello/index.ts

@@ -141,7 +141,7 @@ export class Othello extends Game<State> {
 		});
 	}
 
-	renderEmbed(): EmbedBuilder {
+	async renderEmbed(): Promise<EmbedBuilder> {
 		const winner = this.winCtx && this.winCtx.type === 'win' ? this.winCtx.winner.id : null;
 		const title = Object.values(this.players)
 			.map(player => `${player.name} (${player.turn})${player.id === winner ? ` ${WINNER_ICON}` : ''}`)
@@ -151,7 +151,7 @@ export class Othello extends Game<State> {
 			.setColor('#008000')
 			.setAuthor({ name: 'Othello - Room Match' })
 			.setTitle(title)
-			.setURL(this.getURL())
+			.setURL(await this.getURL())
 			.addFields([
 				{
 					name: [count.B, count.W].join(' - '),

src/ps/games/scrabble/index.ts

@@ -69,7 +69,7 @@ export class Scrabble extends Game<State> {
 			this.state.score[player] = 0;
 			this.state.racks[player] = this.state.bag.splice(0, RACK_SIZE);
 		});
-		return { success: true, data: undefined };
+		return { success: true, data: null };
 	}
 
 	action(user: User, ctx: string): void {
@@ -380,7 +380,7 @@ export class Scrabble extends Game<State> {
 		return render.bind(this.renderCtx)(ctx);
 	}
 
-	renderEmbed(): EmbedBuilder | null {
+	async renderEmbed(): Promise<EmbedBuilder | null> {
 		const winners = this.winCtx && this.winCtx.type === 'win' ? this.winCtx.winnerIds : null;
 		if (!winners) return null;
 		const winnerPlayers = winners.map(winner => ({ ...this.players[winner], best: this.state.best[winner] }));