feat(core): Implement entire game API surface

Author: oliversalzburg

source/BonfireManager.ts

@@ -9,23 +9,23 @@ import {
   type BonfireItem,
   BonfireSettings,
 } from "./settings/BonfireSettings.js";
-import { cwarn } from "./tools/Log.js";
+import { cdebug, cwarn } from "./tools/Log.js";
 import type {
-  BuildButton,
-  Building,
-  BuildingExt,
   BuildingMeta,
-  ButtonModernController,
-  ButtonModernModel,
-  GameTab,
-} from "./types/index.js";
-
-export type BonfireTab = GameTab;
+  BuildingsModern,
+  GatherCatnipButton,
+  GatherCatnipButtonController,
+  RefineCatnipButton,
+  UnsafeBuilding,
+  UnsafeBuildingExt,
+} from "./types/buildings.js";
+import type { ButtonModern, UnsafeButtonModernModel } from "./types/core.js";
+import type { Building } from "./types/index.js";
 
 export class BonfireManager implements Automation {
   private readonly _host: KittenScientists;
   readonly settings: BonfireSettings;
-  readonly manager: TabManager;
+  readonly manager: TabManager<BuildingsModern>;
   private readonly _bulkManager: BulkPurchaseHelper;
   private readonly _workshopManager: WorkshopManager;
 
@@ -36,7 +36,7 @@ export class BonfireManager implements Automation {
   ) {
     this._host = host;
     this.settings = settings;
-    this.manager = new TabManager<BonfireTab>(this._host, "Bonfire");
+    this.manager = new TabManager<BuildingsModern>(this._host, "Bonfire");
 
     this._workshopManager = workshopManager;
     this._bulkManager = new BulkPurchaseHelper(this._host, this._workshopManager);
@@ -69,7 +69,7 @@ export class BonfireManager implements Automation {
     const bulkManager = this._bulkManager;
 
     // Get the current metadata for all the referenced buildings.
-    const metaData: Partial<Record<BonfireItem, BuildingMeta>> = {};
+    const metaData: Partial<Record<BonfireItem, Required<UnsafeBuilding>>> = {};
     for (const build of Object.values(builds)) {
       metaData[build.building] = this.getBuild(
         (build.baseBuilding ?? build.building) as Building,
@@ -125,7 +125,7 @@ export class BonfireManager implements Automation {
             this._host.engine.iactivity("upgrade.building.pasture", [], "ks-upgrade");
 
             // Upgrade the pasture.
-            this._host.game.ui.render();
+            this._host.game.ui?.render();
             this.build("pasture", 1, 1);
             context.requestGameUiRefresh = true;
           }
@@ -158,7 +158,7 @@ export class BonfireManager implements Automation {
 
             this._host.engine.iactivity("upgrade.building.aqueduct", [], "ks-upgrade");
 
-            this._host.game.ui.render();
+            this._host.game.ui?.render();
             this.build("aqueduct", 1, 1);
             context.requestGameUiRefresh = true;
           }
@@ -215,7 +215,7 @@ export class BonfireManager implements Automation {
           // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
           libraryMeta.calculateEffects?.(libraryMeta, this._host.game);
           this._host.engine.iactivity("upgrade.building.library", [], "ks-upgrade");
-          this._host.game.ui.render();
+          this._host.game.ui?.render();
           this.build("library", 1, 1);
           context.requestGameUiRefresh = true;
           return;
@@ -241,7 +241,7 @@ export class BonfireManager implements Automation {
 
           this._host.engine.iactivity("upgrade.building.warehouse", [], "ks-upgrade");
 
-          this._host.game.ui.render();
+          this._host.game.ui?.render();
           this.build("warehouse", 1, 1);
           context.requestGameUiRefresh = true;
 
@@ -272,7 +272,7 @@ export class BonfireManager implements Automation {
 
           this._host.engine.iactivity("upgrade.building.amphitheatre", [], "ks-upgrade");
 
-          this._host.game.ui.render();
+          this._host.game.ui?.render();
           this.build("amphitheatre", 1, 1);
           context.requestGameUiRefresh = true;
         }
@@ -333,7 +333,7 @@ export class BonfireManager implements Automation {
   autoGather(): void {
     const controller = new classes.game.ui.GatherCatnipButtonController(this._host.game);
     for (let clicks = 0; clicks < Math.floor(this._host.engine.settings.interval / 20); ++clicks) {
-      controller.buyItem(null, null);
+      controller.buyItem(undefined, null);
     }
   }
 
@@ -369,22 +369,32 @@ export class BonfireManager implements Automation {
     }
   }
 
-  private _getBuildLabel(meta: BuildingMeta, stage?: number): string {
+  private _getBuildLabel(meta: UnsafeBuilding, stage?: number): string {
     return meta.stages && !isNil(stage) ? meta.stages[stage].label : mustExist(meta.label);
   }
 
-  getBuild(name: Building): BuildingExt {
-    return this._host.game.bld.getBuildingExt(name);
+  getBuild(name: Building): BuildingMeta<Required<UnsafeBuilding>> {
+    return this._host.game.bld.getBuildingExt(name) as BuildingMeta<Required<UnsafeBuilding>>;
   }
 
-  getBuildButton(
-    name: Building,
-    stage?: number,
-  ): BuildButton<string, ButtonModernModel, ButtonModernController> | null {
+  getBuildButton(name: Building, stage?: number) {
     const buttons = this.manager.tab.children;
-    const build = this.getBuild(name);
-    const label = this._getBuildLabel(build.meta, stage);
-    return (buttons.find(button => (button.model?.options.name as string).startsWith(label)) ??
-      null) as BuildButton<string, ButtonModernModel, ButtonModernController> | null;
+
+    const button =
+      (
+        buttons.filter(
+          button =>
+            button instanceof com.nuclearunicorn.game.ui.ButtonModern === false &&
+            button instanceof classes.game.ui.RefineCatnipButton === false,
+        ) as Array<Exclude<(typeof buttons)[number], GatherCatnipButton | RefineCatnipButton>>
+      ).find(
+        button => button.model?.metadata.name === name && button.model?.metadata.stage === stage,
+      ) ?? null;
+
+    if (button === null) {
+      cdebug(`Couldn't find button for ${name}! This will likely create problems.`);
+    }
+
+    return button;
   }
 }

source/KittenScientists.ts

@@ -7,8 +7,9 @@ import { ScienceSettings } from "./settings/ScienceSettings.js";
 import { SpaceSettings } from "./settings/SpaceSettings.js";
 import { WorkshopSettings } from "./settings/WorkshopSettings.js";
 import { cdebug, cerror, cinfo, cwarn } from "./tools/Log.js";
-import type { Game, I18nEngine } from "./types/index.js";
-import type { ReleaseChannel, ReleaseInfoSchema } from "./types/releases.js";
+import type { ReleaseChannel, ReleaseInfoSchema } from "./types/_releases.js";
+import type { GamePage } from "./types/game.js";
+import type { I18nEngine } from "./types/index.js";
 import { UserInterface } from "./ui/UserInterface.js";
 
 declare global {
@@ -25,7 +26,7 @@ export const ksVersion = (prefix = "") => {
 };
 
 export class KittenScientists {
-  readonly game: Game;
+  readonly game: GamePage;
 
   /**
    * A function in the game that allows to retrieve translated messages.
@@ -42,7 +43,7 @@ export class KittenScientists {
   private _serverLoadHandle: ["server/load", number] | undefined;
 
   constructor(
-    game: Game,
+    game: GamePage,
     i18nEngine: I18nEngine,
     gameLanguage: GameLanguage = "en",
     engineState?: EngineState,

source/ReligionManager.ts

@@ -6,30 +6,29 @@ import { TabManager } from "./TabManager.js";
 import type { WorkshopManager } from "./WorkshopManager.js";
 import { BulkPurchaseHelper } from "./helper/BulkPurchaseHelper.js";
 import { BonfireBuildingSetting } from "./settings/BonfireSettings.js";
+import { ReligionSettings, type ReligionSettingsItem } from "./settings/ReligionSettings.js";
+import { negativeOneToInfinity } from "./tools/Format.js";
+import { cdebug, cwarn } from "./tools/Log.js";
+import type { UnsafeButtonModernModel } from "./types/core.js";
 import {
   type FaithItem,
   type ReligionItem,
-  ReligionSettings,
-  type ReligionSettingsItem,
-  type UnicornItem,
-  UnicornItems,
-} from "./settings/ReligionSettings.js";
-import { negativeOneToInfinity } from "./tools/Format.js";
-import { cwarn } from "./tools/Log.js";
-import {
-  type BuildButton,
-  type ButtonModernController,
-  type ButtonModernModel,
-  type ReligionTab,
   type ReligionUpgrade,
-  type ReligionUpgradeInfo,
   type TranscendenceUpgrade,
-  type TranscendenceUpgradeInfo,
-  type TransformBtnController,
+  type UnicornItem,
   UnicornItemVariant,
+  UnicornItems,
   type ZiggurathUpgrade,
-  type ZiggurathUpgradeInfo,
 } from "./types/index.js";
+import type {
+  CryptotheologyPanel,
+  CryptotheologyWGT,
+  ReligionTab,
+  TransformBtnController,
+  UnsafeReligionUpgrade,
+  UnsafeTranscendenceUpgrade,
+  UnsafeZiggurathUpgrade,
+} from "./types/religion.js";
 
 export class ReligionManager implements Automation {
   private readonly _host: KittenScientists;
@@ -170,7 +169,7 @@ export class ReligionManager implements Automation {
           needSacrifice < maxSacrifice &&
           !isNil(this._host.game.religionTab.sacrificeBtn.model)
         ) {
-          this._host.game.religionTab.sacrificeBtn.controller._transform(
+          this._host.game.religionTab.sacrificeBtn?.controller?._transform(
             this._host.game.religionTab.sacrificeBtn.model,
             needSacrifice,
           );
@@ -218,7 +217,7 @@ export class ReligionManager implements Automation {
     this.manager.render();
 
     const metaData: Partial<
-      Record<FaithItem, ReligionUpgradeInfo | TranscendenceUpgradeInfo | ZiggurathUpgradeInfo>
+      Record<FaithItem, UnsafeReligionUpgrade | UnsafeTranscendenceUpgrade | UnsafeZiggurathUpgrade>
     > = this.getBuildMetaData(builds);
     const sectionTrigger = this.settings.trigger;
 
@@ -436,7 +435,7 @@ export class ReligionManager implements Automation {
 
   getBuildMetaData(builds: Partial<Record<FaithItem, ReligionSettingsItem>>) {
     const metaData: Partial<
-      Record<FaithItem, ReligionUpgradeInfo | TranscendenceUpgradeInfo | ZiggurathUpgradeInfo>
+      Record<FaithItem, UnsafeReligionUpgrade | UnsafeTranscendenceUpgrade | UnsafeZiggurathUpgrade>
     > = {};
     for (const build of Object.values(builds)) {
       const buildInfo = this.getBuild(build.building, build.variant);
@@ -470,10 +469,7 @@ export class ReligionManager implements Automation {
    * @param variant The variant of the upgrade.
    * @returns The build information for the upgrade.
    */
-  getBuild(
-    name: ReligionItem | "unicornPasture",
-    variant: UnicornItemVariant,
-  ): ReligionUpgradeInfo | TranscendenceUpgradeInfo | ZiggurathUpgradeInfo | null {
+  getBuild(name: ReligionItem | "unicornPasture", variant: UnicornItemVariant) {
     switch (variant) {
       case UnicornItemVariant.Ziggurat:
         return this._host.game.religion.getZU(name as ZiggurathUpgrade) ?? null;
@@ -482,7 +478,7 @@ export class ReligionManager implements Automation {
       case UnicornItemVariant.Cryptotheology:
         return this._host.game.religion.getTU(name as TranscendenceUpgrade) ?? null;
     }
-    return null;
+    throw new Error(`Unknown build: ${name} (${variant})`);
   }
 
   /**
@@ -492,11 +488,11 @@ export class ReligionManager implements Automation {
    * @param variant The variant of the upgrade.
    * @returns The button to buy the upgrade, or `null`.
    */
-  private _getBuildButton(
-    name: ReligionItem | "unicornPasture",
-    variant: UnicornItemVariant,
-  ): BuildButton<string, ButtonModernModel, ButtonModernController> | null {
-    let buttons: Array<BuildButton>;
+  private _getBuildButton(name: ReligionItem | "unicornPasture", variant: UnicornItemVariant) {
+    let buttons:
+      | typeof this.manager.tab.zgUpgradeButtons
+      | typeof this.manager.tab.rUpgradeButtons
+      | CryptotheologyWGT["children"];
     switch (variant) {
       case UnicornItemVariant.Ziggurat:
         buttons = this.manager.tab.zgUpgradeButtons;
@@ -505,7 +501,7 @@ export class ReligionManager implements Automation {
         buttons = this.manager.tab.rUpgradeButtons;
         break;
       case UnicornItemVariant.Cryptotheology:
-        buttons = this.manager.tab.children[0].children[0].children;
+        buttons = (this.manager.tab.children[0] as CryptotheologyPanel).children[0].children;
         break;
       default:
         throw new Error(`Invalid variant '${variant}'`);
@@ -516,26 +512,28 @@ export class ReligionManager implements Automation {
       return null;
     }
 
-    return (buttons.find(button => button.id === name) ?? null) as BuildButton<
-      string,
-      ButtonModernModel,
-      ButtonModernController
-    > | null;
+    const button = buttons.find(button => button.id === name) ?? null;
+
+    if (button === null) {
+      cdebug(`Couldn't find button for ${name}! This will likely create problems.`);
+    }
+
+    return button;
   }
 
   private _transformBtnSacrificeHelper(
     available: number,
     total: number,
     controller: TransformBtnController,
-    model: ButtonModernModel,
+    model: UnsafeButtonModernModel,
   ) {
     const conversionPercentage = available / total;
     const percentageInverse = 1 / conversionPercentage;
 
     const customController = new classes.ui.religion.TransformBtnController(
       game,
       controller.controllerOpts,
-    ) as TransformBtnController;
+    );
 
     const link = customController._newLink(model, percentageInverse);
     return new Promise<boolean>(resolve => {
@@ -796,9 +794,9 @@ export class ReligionManager implements Automation {
         this._host.game.religion.transcendenceTier += 1;
 
         const atheism = mustExist(this._host.game.challenges.getChallenge("atheism"));
-        atheism.calculateEffects(atheism, this._host.game);
+        atheism.calculateEffects?.(atheism, this._host.game);
         const blackObelisk = mustExist(this._host.game.religion.getTU("blackObelisk"));
-        blackObelisk.calculateEffects(blackObelisk, this._host.game);
+        blackObelisk.calculateEffects?.(blackObelisk, this._host.game);
 
         this._host.game.msg(
           this._host.engine.i18n("$religion.transcend.msg.success", [

source/ScienceManager.ts

@@ -7,10 +7,10 @@ import { UserScriptLoader } from "./UserScriptLoader.js";
 import type { WorkshopManager } from "./WorkshopManager.js";
 import { ScienceSettings } from "./settings/ScienceSettings.js";
 import { cerror } from "./tools/Log.js";
-import type { PolicyInfo, ScienceTab, TechInfo } from "./types/index.js";
+import type { Library, UnsafePolicy, UnsafeTech } from "./types/science.js";
 
 export class ScienceManager extends UpgradeManager {
-  readonly manager: TabManager<ScienceTab>;
+  readonly manager: TabManager<Library>;
   readonly settings: ScienceSettings;
   private readonly _workshopManager: WorkshopManager;
 
@@ -51,7 +51,7 @@ export class ScienceManager extends UpgradeManager {
 
   async autoUnlock() {
     const techs = this._host.game.science.techs;
-    const toUnlock = new Array<TechInfo>();
+    const toUnlock = new Array<UnsafeTech>();
 
     workLoop: for (const setting of Object.values(this.settings.techs.techs)) {
       if (!setting.enabled) {
@@ -92,7 +92,7 @@ export class ScienceManager extends UpgradeManager {
 
   async autoPolicy() {
     const policies = this._host.game.science.policies;
-    const toUnlock = new Array<PolicyInfo>();
+    const toUnlock = new Array<UnsafePolicy>();
 
     for (const setting of Object.values(this.settings.policies.policies)) {
       if (!setting.enabled) {