Merge branch 'main' into lost-city-stager

src/scripts/main.js

@@ -1184,15 +1184,12 @@ import * as detailingFuncs from './modules/details/legacy';
         "Furoma Rift": stagingFuncs.addFuromaRiftStage,
         "Gnawnian Express Station": stagingFuncs.addTrainStage,
         "Iceberg": stagingFuncs.addIcebergStage,
-        "Living Garden": stagingFuncs.addGardenStage,
-        "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,
         "Toxic Spill": stagingFuncs.addToxicSpillStage,
-        "Twisted Garden": stagingFuncs.addGardenStage,
         "Valour Rift": stagingFuncs.addValourRiftStage,
         "Whisker Woods Rift": stagingFuncs.addWhiskerWoodsRiftStage,
         "Zokor": stagingFuncs.addZokorStage,

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

@@ -0,0 +1,20 @@
+import {type User} from '@scripts/types/hg';
+import {type IntakeMessage} from '@scripts/types/mhct';
+import {type IStager} from '../stages.types';
+
+export class LivingGardenStager implements IStager {
+    readonly environment: string = 'Living Garden';
+
+    /**
+     * Read the bucket / vial state to determine the stage for Living & Twisted garden.
+     */
+    addStage(message: IntakeMessage, userPre: User, userPost: User, journal: unknown): void {
+        const quest = userPre.quests.QuestLivingGarden;
+        if (!quest) {
+            throw new Error('QuestLivingGarden is undefined');
+        }
+
+        const container_status = (quest.is_normal) ? quest.minigame.bucket_state : quest.minigame.vials_state;
+        message.stage = (container_status === "dumped") ? "Pouring" : "Not Pouring";
+    }
+}

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

@@ -0,0 +1,18 @@
+import {type User} from '@scripts/types/hg';
+import {type IntakeMessage} from '@scripts/types/mhct';
+import {type IStager} from '../stages.types';
+
+export class MuridaeMarketStager implements IStager {
+    readonly environment: string = 'Muridae Market';
+
+    /**
+     * Report the Artisan Charm status.
+     */
+    addStage(message: IntakeMessage, userPre: User, userPost: User, journal: unknown): void {
+        const charm = userPre.trinket_name;
+
+        message.stage = charm === "Artisan Charm"
+            ? "Artisan"
+            : "Not Artisan";
+    }
+}

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

@@ -0,0 +1,20 @@
+import {type User} from '@scripts/types/hg';
+import {type IntakeMessage} from '@scripts/types/mhct';
+import {type IStager} from '../stages.types';
+
+export class TwistedGardenStager implements IStager {
+    readonly environment: string = 'Twisted Garden';
+
+    /**
+     * Read the bucket / vial state to determine the stage for Living & Twisted garden.
+     */
+    addStage(message: IntakeMessage, userPre: User, userPost: User, journal: unknown): void {
+        const quest = userPre.quests.QuestLivingGarden;
+        if (!quest) {
+            throw new Error('QuestLivingGarden is undefined');
+        }
+
+        const container_status = (quest.is_normal) ? quest.minigame.bucket_state : quest.minigame.vials_state;
+        message.stage = (container_status === "dumped") ? "Pouring" : "Not Pouring";
+    }
+}

src/scripts/modules/stages/index.ts

@@ -9,11 +9,14 @@ import {FungalCavernStager} from './environments/fungalCavern';
 import {HarbourStager} from './environments/harbour';
 import {IceFortressStager} from './environments/iceFortress';
 import {LabyrinthStager} from './environments/labyrinth';
+import {LivingGardenStager} from './environments/livingGarden';
 import {LostCityStager} from './environments/lostCity';
 import {MoussuPicchuStager} from './environments/moussuPicchu';
 import {MousoleumStager} from './environments/mousoleum';
+import {MuridaeMarketStager} from './environments/muridaeMarket';
 import {SlushyShorelineStager} from './environments/slushyShoreline';
 import {SuperBrieFactoryStager} from './environments/superBrieFactory';
+import {TwistedGardenStager} from './environments/twistedGarden';
 
 const stageModules: IStager[]  = [
     new BalacksCoveStager(),
@@ -26,11 +29,14 @@ const stageModules: IStager[]  = [
     new HarbourStager(),
     new IceFortressStager(),
     new LabyrinthStager(),
+    new LivingGardenStager(),
     new LostCityStager(),
     new MoussuPicchuStager(),
     new MousoleumStager(),
+    new MuridaeMarketStager(),
     new SlushyShorelineStager(),
     new SuperBrieFactoryStager(),
+    new TwistedGardenStager(),
 ];
 
 export {stageModules};

src/scripts/modules/stages/legacy.js

@@ -114,19 +114,6 @@ export function addSeasonalGardenStage(message, user, user_post, hunt) {
     }
 }
 
-/**
- * Read the bucket / vial state to determine the stage for Living & Twisted garden.
- * @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 addGardenStage(message, user, user_post, hunt) {
-    const quest = user.quests.QuestLivingGarden;
-    const container_status = (quest.is_normal) ? quest.minigame.bucket_state : quest.minigame.vials_state;
-    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.
@@ -164,20 +151,6 @@ export function addIcebergStage(message, user, user_post, hunt) {
     }
 }
 
-/**
- * Report the Artisan Charm status.
- * @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 addMuridaeMarketStage(message, user, user_post, hunt) {
-    message.stage = "Not Artisan";
-    if (user.trinket_name === "Artisan Charm") {
-        message.stage = "Artisan";
-    }
-}
-
 /**
  * Report the zone and depth, if any.
  * @param {Object <string, any>} message The message to be sent.

src/scripts/types/hg.ts

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

src/scripts/types/quests/index.ts

@@ -8,6 +8,7 @@ export * from '@scripts/types/quests/harbour';
 export * from '@scripts/types/quests/iceberg';
 export * from '@scripts/types/quests/iceFortress';
 export * from '@scripts/types/quests/labyrinth';
+export * from '@scripts/types/quests/livingGarden';
 export * from '@scripts/types/quests/lostCity';
 export * from '@scripts/types/quests/mousoleum';
 export * from '@scripts/types/quests/moussuPicchu';

src/scripts/types/quests/livingGarden.ts

@@ -0,0 +1,17 @@
+export type QuestLivingGarden = LivingGardenState | TwistedGardenState
+
+interface LivingGardenState {
+    is_normal: true
+    minigame: {
+        bucket_state: PourStatus
+    }
+}
+
+interface TwistedGardenState {
+    is_normal: false
+    minigame: {
+         vials_state: PourStatus
+    }
+}
+
+type PourStatus = 'filling' | 'dumped';

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

@@ -0,0 +1,112 @@
+import {LivingGardenStager} from "@scripts/modules/stages/environments/livingGarden";
+import {TwistedGardenStager} from "@scripts/modules/stages/environments/twistedGarden";
+import {User} from "@scripts/types/hg";
+import {IntakeMessage} from "@scripts/types/mhct";
+
+describe('Living/Twisted Garden stages', () => {
+    describe('Living', () => {
+        it('should be for the "Living Garden" environment', () => {
+            const stager = new LivingGardenStager();
+            expect(stager.environment).toBe('Living Garden');
+        });
+
+        it('should set stage to "Pouring" if bucket dumped', () => {
+            const stager = new LivingGardenStager();
+
+            const message = {} as IntakeMessage;
+            const preUser = {quests: {QuestLivingGarden: {
+                is_normal: true,
+                minigame: {
+                    bucket_state: 'dumped',
+                },
+            }}} as User;
+            const postUser = {} as User;
+            const journal = {};
+
+            stager.addStage(message, preUser, postUser, journal);
+
+            expect(message.stage).toBe('Pouring');
+        });
+
+        it('should set stage to "Not Pouring" if bucket not dumped', () => {
+            const stager = new LivingGardenStager();
+
+            const message = {} as IntakeMessage;
+            const preUser = {quests: {QuestLivingGarden: {
+                is_normal: true,
+                minigame: {
+                    bucket_state: 'filling',
+                },
+            }}} as User;
+            const postUser = {} as User;
+            const journal = {};
+
+            stager.addStage(message, preUser, postUser, journal);
+        });
+
+        it.each([undefined, null])('should throw if quest is %p', (quest) => {
+            const stager = new LivingGardenStager();
+
+            const message = {} as IntakeMessage;
+            const preUser = {quests: {QuestLivingGarden: quest}} as User;
+            const postUser = {} as User;
+            const journal = {};
+
+            expect(() => stager.addStage(message, preUser, postUser, journal))
+                .toThrow('QuestLivingGarden is undefined');
+        });
+    });
+
+    describe('Twisted', () => {
+        it('should be for the "Twisted Garden" environment', () => {
+            const stager = new TwistedGardenStager();
+            expect(stager.environment).toBe('Twisted Garden');
+        });
+
+        it('should set stage to "Pouring" if bucket dumped', () => {
+            const stager = new TwistedGardenStager();
+
+            const message = {} as IntakeMessage;
+            const preUser = {quests: {QuestLivingGarden: {
+                is_normal: false,
+                minigame: {
+                    vials_state: 'dumped',
+                },
+            }}} as User;
+            const postUser = {} as User;
+            const journal = {};
+
+            stager.addStage(message, preUser, postUser, journal);
+
+            expect(message.stage).toBe('Pouring');
+        });
+
+        it('should set stage to "Not Pouring" if bucket not dumped', () => {
+            const stager = new TwistedGardenStager();
+
+            const message = {} as IntakeMessage;
+            const preUser = {quests: {QuestLivingGarden: {
+                is_normal: false,
+                minigame: {
+                    vials_state: 'filling',
+                },
+            }}} as User;
+            const postUser = {} as User;
+            const journal = {};
+
+            stager.addStage(message, preUser, postUser, journal);
+        });
+
+        it.each([undefined, null])('should throw if quest is %p', (quest) => {
+            const stager = new TwistedGardenStager();
+
+            const message = {} as IntakeMessage;
+            const preUser = {quests: {QuestLivingGarden: quest}} as User;
+            const postUser = {} as User;
+            const journal = {};
+
+            expect(() => stager.addStage(message, preUser, postUser, journal))
+                .toThrow('QuestLivingGarden is undefined');
+        });
+    });
+});

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

@@ -0,0 +1,34 @@
+import {MuridaeMarketStager} from "@scripts/modules/stages/environments/muridaeMarket";
+import {User} from "@scripts/types/hg";
+import {IntakeMessage} from "@scripts/types/mhct";
+
+describe('Muridae Market stages', () => {
+    it('should be for the "Muridae Market" environment', () => {
+        const stager = new MuridaeMarketStager();
+        expect(stager.environment).toBe('Muridae Market');
+    });
+
+    it('should set stage to "Artisan" if user has artisan charm equipped', () => {
+        const stager = new MuridaeMarketStager();
+        const message = {} as IntakeMessage;
+        const preUser = {trinket_name: 'Artisan Charm'} as User;
+        const postUser = {} as User;
+        const journal = {};
+
+        stager.addStage(message, preUser, postUser, journal);
+
+        expect(message.stage).toBe('Artisan');
+    });
+
+    it('should set stage to "Not Artisan" if user does not has artisan charm equipped', () => {
+        const stager = new MuridaeMarketStager();
+        const message = {} as IntakeMessage;
+        const preUser = {trinket_name: 'Power Charm'} as User;
+        const postUser = {} as User;
+        const journal = {};
+
+        stager.addStage(message, preUser, postUser, journal);
+
+        expect(message.stage).toBe('Not Artisan');
+    });
+});