Introduce auto-generated GameXpInfo

Author: DaPigGuy

build/generate_xp_info.ts

@@ -0,0 +1,68 @@
+import { writeFile } from "fs/promises";
+import { GameXpInfo } from "../src/games/info";
+import { Game } from "../src/games/data";
+import { getGameMetainfo } from "../src/index";
+
+(async () => {
+	// Ensure order consistency between runs
+	const xpInfo: Partial<typeof GameXpInfo> = Object.values(Game).reduce(
+		(xpInfo, game) => {
+			return { ...xpInfo, [game]: {} };
+		},
+		{}
+	);
+
+	await Promise.all(
+		Object.values(Game).map(async game => {
+			// The `/game/meta/ground` endpoint returns an error
+			if (game === Game.GroundWars) {
+				xpInfo[game] = {
+					increment: 150,
+					max: 20
+				};
+				return;
+			}
+
+			const metaInfo = await getGameMetainfo(game);
+
+            // The Bridge has its own level XP scaling.
+			const increment =
+				game === Game.Bridge
+					? 0
+					: parseInt(Object.keys(metaInfo.experienceToLevel)[1]);
+			const maxLevel = Object.keys(metaInfo.experienceToLevel).length;
+
+			let incrementCap;
+			if (game !== Game.Bridge) {
+				let previousDiff = increment;
+
+				for (let level = 2; level < maxLevel; level++) {
+					const diff =
+						parseInt(Object.keys(metaInfo.experienceToLevel)[level]) -
+						parseInt(Object.keys(metaInfo.experienceToLevel)[level - 1]);
+					if (diff === previousDiff) {
+						incrementCap = level;
+						break;
+					}
+					previousDiff = diff;
+				}
+			}
+
+			xpInfo[game] = {
+				increment: increment,
+				increment_cap: incrementCap,
+				max: maxLevel,
+				max_prestige: metaInfo.allowPrestiging
+					? metaInfo.maxPrestige
+					: undefined
+			};
+		})
+	);
+
+	await writeFile(
+		"src/games/xp_info.json",
+		JSON.stringify(xpInfo, undefined, "\t"),
+		"utf-8"
+	);
+})();
+

package.json

@@ -5,7 +5,8 @@
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
 	"scripts": {
-		"build": "tsc",
+		"generate_xp_info": "ts-node build/generate_xp_info",
+		"build": "pnpm run generate_xp_info && tsc",
 		"lint": "eslint src"
 	},
 	"keywords": [
@@ -23,10 +24,12 @@
 	},
 	"homepage": "https://github.com/Paroxity/hive-tools-wrapper",
 	"devDependencies": {
+		"@types/node": "^20.12.5",
 		"@typescript-eslint/eslint-plugin": "^7.3.1",
 		"@typescript-eslint/parser": "^7.3.1",
 		"eslint": "^8.57.0",
 		"prettier": "^3.2.5",
+		"ts-node": "^10.9.2",
 		"typescript": "^5.4.2"
 	}
 }

pnpm-lock.yaml

@@ -1,4 +1,5 @@
 import { Game } from "./data";
+import _GameXpInfo from "./xp_info.json";
 
 export const GameInfo: Record<
 	Game,
@@ -169,9 +170,20 @@ export const GameInfo: Record<
 			year: 2024,
 			month: 3
 		}
-	},
+	}
 };
 
+//@ts-ignore `xp_info.json` will be missing newly added games prior to regenerating the file
+export const GameXpInfo: Record<
+	Game,
+	{
+		increment: number;
+		increment_cap?: number;
+		max: number;
+		max_prestige?: number;
+	}
+> = _GameXpInfo;
+
 export type GameMetainfo = {
 	name: string;
 	shortName: string;