Add Mousoleum stager

Author: hymccord

src/scripts/main.js

@@ -1210,7 +1210,6 @@ import * as detailingFuncs from './modules/details/legacy';
         "Labyrinth": stagingFuncs.addLabyrinthStage,
         "Living Garden": stagingFuncs.addGardenStage,
         "Lost City": stagingFuncs.addLostCityStage,
-        "Mousoleum": stagingFuncs.addMousoleumStage,
         "Moussu Picchu": stagingFuncs.addMoussuPicchuStage,
         "Muridae Market": stagingFuncs.addMuridaeMarketStage,
         "Queso Geyser": stagingFuncs.addQuesoGeyserStage,

src/scripts/modules/stages/environments/mousoleum.ts

@@ -0,0 +1,16 @@
+import {type User} from '@scripts/types/hg';
+import {type IntakeMessage} from '@scripts/types/mhct';
+import {type IStager} from '../stages.types';
+
+export class MousoleumStager implements IStager {
+    readonly environment: string = 'Mousoleum';
+
+    /* Add the "wall state" for Mousoleum hunts */
+    addStage(message: IntakeMessage, userPre: User, userPost: User, journal: unknown): void {
+        if (!userPre.quests.QuestMousoleum) {
+            throw new Error('QuestMousoleum is undefined');
+        }
+
+        message.stage = (userPre.quests.QuestMousoleum.has_wall) ? "Has Wall" : "No Wall";
+    }
+}

src/scripts/modules/stages/index.ts

@@ -3,13 +3,15 @@ import {BountifulBeanstalkStager} from './environments/bountifulBeanstalk';
 import {ForbiddenGroveStager} from './environments/forbiddenGrove';
 import {FungalCavernStager} from './environments/fungalCavern';
 import {IceFortressStager} from './environments/iceFortress';
+import {MousoleumStager} from './environments/mousoleum';
 import {SuperBrieFactoryStager} from './environments/superBrieFactory';
 
 const stageModules: IStager[]  = [
     new BountifulBeanstalkStager(),
     new ForbiddenGroveStager(),
     new FungalCavernStager(),
     new IceFortressStager(),
+    new MousoleumStager(),
     new SuperBrieFactoryStager(),
 ];
 

src/scripts/modules/stages/legacy.js

@@ -1,14 +1,3 @@
-/**
- * Add the "wall state" for Mousoleum hunts.
- * @param {Object <string, any>} message The message to be sent.
- * @param {Object <string, any>} user The user state object, when the hunt was invoked (pre-hunt).
- * @param {Object <string, any>} user_post The user state object, after the hunt.
- * @param {Object <string, any>} hunt The journal entry corresponding to the active hunt.
- */
-export function addMousoleumStage(message, user, user_post, hunt) {
-    message.stage = (user.quests.QuestMousoleum.has_wall) ? "Has Wall" : "No Wall";
-}
-
 /**
  * Separate hunts with certain mice available from those without.
  * @param {Object <string, any>} message The message to be sent.

src/scripts/types/hg.ts

@@ -51,7 +51,7 @@ export interface Quests {
     QuestLabyrinth?: unknown
     QuestLivingGarden?: unknown
     QuestLostCity?: unknown
-    QuestMousoleum?: unknown
+    QuestMousoleum?: quests.QuestMousoleum
     QuestMoussuPicchu?: unknown
     QuestPollutionOutbreak?: unknown
     QuestQuesoGeyser?: unknown

src/scripts/types/quests/index.ts

@@ -3,6 +3,7 @@ export * from '@scripts/types/quests/clawShotCity';
 export * from '@scripts/types/quests/forbiddenGrove';
 export * from '@scripts/types/quests/iceberg';
 export * from '@scripts/types/quests/iceFortress';
+export * from '@scripts/types/quests/mousoleum';
 export * from '@scripts/types/quests/superBrieFactory';
 export * from '@scripts/types/quests/tableOfContents';
 export * from '@scripts/types/quests/springHunt';

src/scripts/types/quests/mousoleum.ts

@@ -0,0 +1,3 @@
+export interface QuestMousoleum {
+    has_wall: boolean;
+}

tests/scripts/modules/stages/environments/mousoleum.spec.ts

@@ -1,23 +1,39 @@
-import {addMousoleumStage} from '@scripts/modules/stages/legacy';
+import {MousoleumStager} from '@scripts/modules/stages/environments/mousoleum';
 import {User} from '@scripts/types/hg';
 import {IntakeMessage} from '@scripts/types/mhct';
 
 describe('MousoleumStager', () => {
     it('sets stage to "Has Wall" if user has Mousoleum wall', () => {
+        const stager = new MousoleumStager();
+
         const message = {stage: null} as IntakeMessage;
         const userPre = {quests: {QuestMousoleum: {has_wall: true}}} as User;
-        const userPost: User = {} as User;
+        const userPost = {} as User;
         const journal = {};
-        addMousoleumStage(message, userPre, userPost, journal);
+        stager.addStage(message, userPre, userPost, journal);
         expect(message.stage).toBe('Has Wall');
     });
 
     it('sets stage to "No Wall" if user does not have Mousoleum wall', () => {
+        const stager = new MousoleumStager();
+
         const message = {stage: null} as IntakeMessage;
         const userPre = {quests: {QuestMousoleum: {has_wall: false}}} as User;
         const userPost = {} as User;
         const journal = {};
-        addMousoleumStage(message, userPre, userPost, journal);
+        stager.addStage(message, userPre, userPost, journal);
         expect(message.stage).toBe('No Wall');
     });
+
+    it('throws an error if QuestMousoleum is undefined', () => {
+        const stager = new MousoleumStager();
+
+        const message = {stage: null} as IntakeMessage;
+        const userPre = {quests: {}} as User;
+        const userPost = {} as User;
+        const journal = {};
+        expect(() => {
+            stager.addStage(message, userPre, userPost, journal);
+        }).toThrowError('QuestMousoleum is undefined');
+    });
 });