Add Balack's Cove stager

src/scripts/main.js

@@ -1174,7 +1174,6 @@ import * as detailingFuncs from './modules/details/legacy';
 
     /** @type {Object <string, Function>} */
     const location_stage_lookup = {
-        "Balack's Cove": stagingFuncs.addBalacksCoveStage,
         "Bristle Woods Rift": stagingFuncs.addBristleWoodsRiftStage,
         "Burroughs Rift": stagingFuncs.addBurroughsRiftStage,
         "Cursed City": stagingFuncs.addLostCityStage,

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

@@ -0,0 +1,35 @@
+import {type User} from '@scripts/types/hg';
+import {type IntakeMessage} from '@scripts/types/mhct';
+import {type IStager} from '../stages.types';
+
+export class BalacksCoveStager implements IStager {
+    readonly environment: string = 'Balack\'s Cove';
+
+    /**
+     * Set the stage based on the tide. Reject hunts near tide intensity changes.
+     */
+    addStage(message: IntakeMessage, userPre: User, userPost: User, journal: unknown): void {
+        const quest = userPre.quests.QuestBalacksCove;
+
+        if (!quest) {
+            throw new Error('QuestBalacksCove is undefined');
+        }
+
+        const tide = quest.tide.level;
+        const direction = quest.tide.direction;
+        const progress = quest.tide.percent;
+        const imminent_state_change = (progress >= 99
+                // Certain transitions do not change the tide intensity, and are OK to track.
+                && !(tide === "low" && direction === "in")
+                && !(tide === "high" && direction === "out"));
+        if (!imminent_state_change && tide) {
+            message.stage = tide.charAt(0).toUpperCase() + tide.substr(1);
+            if (message.stage === "Med") {
+                message.stage = "Medium";
+            }
+            message.stage += " Tide";
+        } else {
+            throw new Error('Skipping hunt due to imminent tide change');
+        }
+    }
+}

src/scripts/modules/stages/index.ts

@@ -1,4 +1,5 @@
 import {type IStager} from './stages.types';
+import {BalacksCoveStager} from './environments/balacksCove';
 import {BountifulBeanstalkStager} from './environments/bountifulBeanstalk';
 import {ClawShotCityStager} from './environments/clawShotCity';
 import {FloatingIslandsStager} from './environments/floatingIslands';
@@ -11,6 +12,7 @@ import {MousoleumStager} from './environments/mousoleum';
 import {SuperBrieFactoryStager} from './environments/superBrieFactory';
 
 const stageModules: IStager[]  = [
+    new BalacksCoveStager(),
     new BountifulBeanstalkStager(),
     new ClawShotCityStager(),
     new FloatingIslandsStager(),

src/scripts/modules/stages/legacy.js

@@ -102,32 +102,6 @@ export function addFieryWarpathStage(message, user, user_post, hunt) {
     message.stage = (wave === "portal") ? "Portal" : `Wave ${wave}`;
 }
 
-/**
- * Set the stage based on the tide. Reject hunts near tide intensity changes.
- * @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 addBalacksCoveStage(message, user, user_post, hunt) {
-    const tide = user.quests.QuestBalacksCove.tide.level;
-    const direction = user.quests.QuestBalacksCove.tide.direction;
-    const progress = user.quests.QuestBalacksCove.tide.percent;
-    const imminent_state_change = (progress >= 99
-        // Certain transitions do not change the tide intensity, and are OK to track.
-        && !(tide === "low" && direction === "in")
-        && !(tide === "high" && direction === "out"));
-    if (!imminent_state_change && tide) {
-        message.stage = tide.charAt(0).toUpperCase() + tide.substr(1);
-        if (message.stage === "Med") {
-            message.stage = "Medium";
-        }
-        message.stage += " Tide";
-    } else {
-        message.location = null;
-    }
-}
-
 /**
  * Read the viewing attributes to determine the season. Reject hunts where the season changed.
  * @param {Object <string, any>} message The message to be sent.

src/scripts/types/hg.ts

@@ -39,7 +39,7 @@ export interface User {
 // TODO: Define needed interfaces for quests in /types/quests/<QuestName>.ts
 export interface Quests {
     QuestAncientCity?: unknown
-    QuestBalacksCove?: unknown
+    QuestBalacksCove?: quests.QuestBalacksCove
     QuestBountifulBeanstalk?: quests.QuestBountifulBeanstalk
     QuestClawShotCity?: quests.QuestClawShotCity
     QuestFloatingIslands?: quests.QuestFloatingIslands

src/scripts/types/quests/balacksCove.ts

@@ -0,0 +1,7 @@
+export interface QuestBalacksCove {
+    tide: {
+        level: 'low' | 'med' | 'high'
+        direction: 'in' | 'out'
+        percent: number
+    }
+}

src/scripts/types/quests/index.ts

@@ -1,3 +1,4 @@
+export * from '@scripts/types/quests/balacksCove';
 export * from '@scripts/types/quests/bountifulBeanstalk';
 export * from '@scripts/types/quests/clawShotCity';
 export * from '@scripts/types/quests/floatingIslands';

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

@@ -1,15 +1,22 @@
-import {addBalacksCoveStage} from "@scripts/modules/stages/legacy";
+import {BalacksCoveStager} from "@scripts/modules/stages/environments/balacksCove";
 import {User} from "@scripts/types/hg";
 import {IntakeMessage} from "@scripts/types/mhct";
 
 describe('Balack\'s Cove stages', () => {
 
+    it('should be for the "Balack\'s Cove" environment', () => {
+        const stager = new BalacksCoveStager();
+        expect(stager.environment).toBe('Balack\'s Cove');
+    });
+
     it.each`
         tide | expected
         ${'low'}  | ${'Low'}
         ${'med'}  | ${'Medium'}
         ${'high'} | ${'High'}
     `('should set stage to High, Medium, or Low', ({tide, expected}) => {
+        const stager = new BalacksCoveStager();
+
         const message = {} as IntakeMessage;
         const preUser = {quests: {QuestBalacksCove: {tide: {
             level: tide,
@@ -19,12 +26,14 @@ describe('Balack\'s Cove stages', () => {
         const postUser = {} as User;
         const journal = {};
 
-        addBalacksCoveStage(message, preUser, postUser, journal);
+        stager.addStage(message, preUser, postUser, journal);
 
         expect(message.stage).toBe(`${expected} Tide`);
     });
 
     it('should reject imminent tide changes', () => {
+        const stager = new BalacksCoveStager();
+
         const message = {} as IntakeMessage;
         const preUser = {quests: {QuestBalacksCove: {tide: {
             level: 'high',
@@ -34,8 +43,19 @@ describe('Balack\'s Cove stages', () => {
         const postUser = {} as User;
         const journal = {};
 
-        addBalacksCoveStage(message, preUser, postUser, journal);
+        expect(() => stager.addStage(message, preUser, postUser, journal))
+            .toThrow('Skipping hunt due to imminent tide change');
+    });
+
+    it.each([undefined, null])('should throw when quest is %p', (quest) => {
+        const stager = new BalacksCoveStager();
+
+        const message = {} as IntakeMessage;
+        const preUser = {quests: {QuestBalacksCove: quest}} as User;
+        const postUser = {} as User;
+        const journal = {};
 
-        expect(message.location).toBe(null);
+        expect(() => stager.addStage(message, preUser, postUser, journal))
+            .toThrow('QuestBalacksCove is undefined');
     });
 });