Add Sand Dunes stager

src/scripts/main.js

@@ -1189,7 +1189,6 @@ import * as detailingFuncs from './modules/details/legacy';
         "Lost City": stagingFuncs.addLostCityStage,
         "Muridae Market": stagingFuncs.addMuridaeMarketStage,
         "Queso Geyser": stagingFuncs.addQuesoGeyserStage,
-        "Sand Dunes": stagingFuncs.addSandDunesStage,
         "Seasonal Garden": stagingFuncs.addSeasonalGardenStage,
         "Sunken City": stagingFuncs.addSunkenCityStage,
         "Table of Contents": stagingFuncs.addTableOfContentsStage,

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

@@ -0,0 +1,16 @@
+import * as hg from '@scripts/types/hg';
+import * as mhct from '@scripts/types/mhct';
+import {type IStager} from '../stages.types';
+
+export class SandDunesStager implements IStager {
+    readonly environment: string = 'Sand Dunes';
+
+    addStage(message: mhct.IntakeMessage, userPre: hg.User, userPost: hg.User, journal: unknown): void {
+        const quest = userPre.quests.QuestSandDunes;
+        if (!quest) {
+            throw new Error('QuestSandDunes is undefined');
+        }
+
+        message.stage = (quest.minigame.has_stampede) ? "Stampede" : "No Stampede";
+    }
+}

src/scripts/modules/stages/index.ts

@@ -10,6 +10,7 @@ import {IceFortressStager} from './environments/iceFortress';
 import {LabyrinthStager} from './environments/labyrinth';
 import {MoussuPicchuStager} from './environments/moussuPicchu';
 import {MousoleumStager} from './environments/mousoleum';
+import {SandDunesStager} from './environments/sandDunes';
 import {SlushyShorelineStager} from './environments/slushyShoreline';
 import {SuperBrieFactoryStager} from './environments/superBrieFactory';
 
@@ -25,6 +26,7 @@ const stageModules: IStager[]  = [
     new LabyrinthStager(),
     new MoussuPicchuStager(),
     new MousoleumStager(),
+    new SandDunesStager(),
     new SlushyShorelineStager(),
     new SuperBrieFactoryStager(),
 ];

src/scripts/modules/stages/legacy.js

@@ -127,17 +127,6 @@ export function addGardenStage(message, user, user_post, hunt) {
     message.stage = (container_status === "dumped") ? "Pouring" : "Not Pouring";
 }
 
-/**
- * Determine if there is a stampede active
- * @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 addSandDunesStage(message, user, user_post, hunt) {
-    message.stage = (user.quests.QuestSandDunes.minigame.has_stampede) ? "Stampede" : "No Stampede";
-}
-
 /**
  * Indicate whether or not the Cursed / Corrupt mouse is present
  * @param {Object <string, any>} message The message to be sent.

src/scripts/types/hg.ts

@@ -62,7 +62,7 @@ export interface Quests {
     QuestRiftBurroughs?: unknown
     QuestRiftFuroma?: unknown
     QuestRiftWhiskerWoods?: unknown
-    QuestSandDunes?: unknown
+    QuestSandDunes?: quests.QuestSandDunes
     QuestSunkenCity?: unknown
     QuestSuperBrieFactory?: quests.QuestSuperBrieFactory
     QuestSpringHunt?: quests.QuestSpringHunt

src/scripts/types/quests/index.ts

@@ -10,6 +10,7 @@ export * from '@scripts/types/quests/iceFortress';
 export * from '@scripts/types/quests/labyrinth';
 export * from '@scripts/types/quests/mousoleum';
 export * from '@scripts/types/quests/moussuPicchu';
+export * from '@scripts/types/quests/sandDunes';
 export * from '@scripts/types/quests/superBrieFactory';
 export * from '@scripts/types/quests/tableOfContents';
 export * from '@scripts/types/quests/springHunt';

src/scripts/types/quests/sandDunes.ts

@@ -0,0 +1,6 @@
+export interface QuestSandDunes {
+    // this is for Sand Dunes only. Not currently needed for Sand Crypts. See QuestLivingGarden for example of both
+    minigame: {
+        has_stampede: boolean
+    }
+}

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

@@ -1,31 +1,49 @@
-import {addSandDunesStage} from "@scripts/modules/stages/legacy";
+import {SandDunesStager} from "@scripts/modules/stages/environments/sandDunes";
 import {User} from "@scripts/types/hg";
 import {IntakeMessage} from "@scripts/types/mhct";
 
 describe('Sand Dunes stages', () => {
+    it('should be for the "Sand Dunes" environment', () => {
+        const stager = new SandDunesStager();
+        expect(stager.environment).toBe('Sand Dunes');
+    });
+
     it('should set stage to "Stampede" when there is a stampede', () => {
+        const stager = new SandDunesStager();
         const message = {} as IntakeMessage;
         const preUser = {quests: {QuestSandDunes: {minigame: {
             has_stampede: true,
         }}}} as User;
         const postUser = {} as User;
         const journal = {};
 
-        addSandDunesStage(message, preUser, postUser, journal);
+        stager.addStage(message, preUser, postUser, journal);
 
         expect(message.stage).toBe('Stampede');
     });
 
     it('should set stage to "No Stampede" when there is not a stampede', () => {
+        const stager = new SandDunesStager();
         const message = {} as IntakeMessage;
         const preUser = {quests: {QuestSandDunes: {minigame: {
             has_stampede: false,
         }}}} as User;
         const postUser = {} as User;
         const journal = {};
 
-        addSandDunesStage(message, preUser, postUser, journal);
+        stager.addStage(message, preUser, postUser, journal);
 
         expect(message.stage).toBe('No Stampede');
     });
+
+    it.each([undefined, null])('should throw if quest is %p', (quest) => {
+        const stager = new SandDunesStager();
+        const message = {} as IntakeMessage;
+        const preUser = {quests: {QuestSandDunes: quest}} as User;
+        const postUser = {} as User;
+        const journal = {};
+
+        expect(() => stager.addStage(message, preUser, postUser, journal))
+            .toThrow('QuestSandDunes is undefined');
+    });
 });