@jeremyckahn/farmhand 1.23.2 → 1.23.3

package/src/data/maps.ts

@@ -47,7 +47,7 @@ export const recipeCategories: Record<
 export const recipesMap: Record<string, farmhand.recipe> = {}
 
 for (const recipeId of Object.keys(recipes)) {
-  const recipe = ((recipes as unknown) as Record<string, farmhand.recipe>)[
+  const recipe = (recipes as unknown as Record<string, farmhand.recipe>)[
     recipeId
   ]
 
@@ -59,10 +59,12 @@ export const upgradesMap: Record<string, farmhand.upgradesMetadatum> = {}
 
 for (let toolType of Object.keys(upgrades)) {
   for (let upgrade of Object.values(
-    ((upgrades as unknown) as Record<
-      string,
-      Record<string, farmhand.upgradesMetadatum>
-    >)[toolType]
+    (
+      upgrades as unknown as Record<
+        string,
+        Record<string, farmhand.upgradesMetadatum>
+      >
+    )[toolType]
   )) {
     upgradesMap[upgrade.id] = upgrade
   }
@@ -74,36 +76,32 @@ export const itemsMap: Record<string, farmhand.item> = {
   ...upgradesMap,
 }
 
-export const fermentableItemsMap: Record<
-  string,
-  farmhand.item
-> = Object.fromEntries(
-  Object.entries(itemsMap).filter(([itemId]) => {
-    const item = itemsMap[itemId]
+export const fermentableItemsMap: Record<string, farmhand.item> =
+  Object.fromEntries(
+    Object.entries(itemsMap).filter(([itemId]) => {
+      const item = itemsMap[itemId]
 
-    return 'daysToFerment' in item
-  })
-)
+      return 'daysToFerment' in item
+    })
+  )
 
-export const cropItemIdToSeedItemMap: Record<
-  string,
-  farmhand.seedItem
-> = Object.entries(baseItemsMap).reduce<Record<string, farmhand.seedItem>>(
-  (acc, [itemId, item]) => {
-    const { growsInto } = item as { growsInto?: string | string[] }
+export const cropItemIdToSeedItemMap: Record<string, farmhand.seedItem> =
+  Object.entries(baseItemsMap).reduce<Record<string, farmhand.seedItem>>(
+    (acc, [itemId, item]) => {
+      const { growsInto } = item as { growsInto?: string | string[] }
 
-    if (growsInto) {
-      const variants = Array.isArray(growsInto) ? growsInto : [growsInto]
+      if (growsInto) {
+        const variants = Array.isArray(growsInto) ? growsInto : [growsInto]
 
-      for (const variantId of variants) {
-        acc[variantId] = baseItemsMap[itemId] as farmhand.seedItem
+        for (const variantId of variants) {
+          acc[variantId] = baseItemsMap[itemId] as farmhand.seedItem
+        }
       }
-    }
 
-    return acc
-  },
-  {}
-)
+      return acc
+    },
+    {}
+  )
 
 export const cropTypeToIdMap: Record<string, string | Array<string>> = {
   [ASPARAGUS]: 'asparagus',

package/src/enums.ts

@@ -27,7 +27,7 @@ export const cropType = {
   WEED: 'WEED',
 } as const
 
-export type cropType = typeof cropType[keyof typeof cropType]
+export type cropType = (typeof cropType)[keyof typeof cropType]
 
 /**
  * @property farmhand.module:enums.recipeType
@@ -42,7 +42,7 @@ export const recipeType = {
   WOOD_CHIPPER: 'WOOD_CHIPPER',
 } as const
 
-export type recipeType = typeof recipeType[keyof typeof recipeType]
+export type recipeType = (typeof recipeType)[keyof typeof recipeType]
 
 /**
  * @property farmhand.module:enums.fieldMode
@@ -63,7 +63,7 @@ export const fieldMode = {
   WATER: 'WATER',
 } as const
 
-export type fieldMode = typeof fieldMode[keyof typeof fieldMode]
+export type fieldMode = (typeof fieldMode)[keyof typeof fieldMode]
 
 /**
  * @property farmhand.module:enums.stageFocusType
@@ -81,7 +81,8 @@ export const stageFocusType = {
   CELLAR: 'CELLAR',
 } as const
 
-export type stageFocusType = typeof stageFocusType[keyof typeof stageFocusType]
+export type stageFocusType =
+  (typeof stageFocusType)[keyof typeof stageFocusType]
 
 /**
  * @property farmhand.module:enums.cropLifeStage
@@ -93,7 +94,7 @@ export const cropLifeStage = {
   GROWN: 'GROWN',
 } as const
 
-export type cropLifeStage = typeof cropLifeStage[keyof typeof cropLifeStage]
+export type cropLifeStage = (typeof cropLifeStage)[keyof typeof cropLifeStage]
 
 /**
  * Tree-only extension of cropLifeStage. DEAD is deliberately not part of
@@ -107,7 +108,7 @@ export const treeLifeStage = {
   DEAD: 'DEAD',
 } as const
 
-export type treeLifeStage = typeof treeLifeStage[keyof typeof treeLifeStage]
+export type treeLifeStage = (typeof treeLifeStage)[keyof typeof treeLifeStage]
 
 /**
  * @property farmhand.module:enums.itemType
@@ -133,7 +134,7 @@ export const itemType = {
   WOOD: 'WOOD',
 } as const
 
-export type itemType = typeof itemType[keyof typeof itemType]
+export type itemType = (typeof itemType)[keyof typeof itemType]
 
 /**
  * @property farmhand.module:enums.treeType
@@ -144,7 +145,7 @@ export const treeType = {
   BANANA: 'BANANA',
 } as const
 
-export type treeType = typeof treeType[keyof typeof treeType]
+export type treeType = (typeof treeType)[keyof typeof treeType]
 
 /**
  * @property farmhand.module:enums.fertilizerType
@@ -156,7 +157,8 @@ export const fertilizerType = {
   RAINBOW: 'RAINBOW',
 } as const
 
-export type fertilizerType = typeof fertilizerType[keyof typeof fertilizerType]
+export type fertilizerType =
+  (typeof fertilizerType)[keyof typeof fertilizerType]
 
 /**
  * @property farmhand.module:enums.genders
@@ -167,7 +169,7 @@ export const genders = {
   MALE: 'MALE',
 } as const
 
-export type genders = typeof genders[keyof typeof genders]
+export type genders = (typeof genders)[keyof typeof genders]
 
 /**
  * @property farmhand.module:enums.cowColors
@@ -184,7 +186,7 @@ export const cowColors = {
   YELLOW: 'YELLOW',
 } as const
 
-export type cowColors = typeof cowColors[keyof typeof cowColors]
+export type cowColors = (typeof cowColors)[keyof typeof cowColors]
 
 const { RAINBOW, ...standardCowColors } = cowColors
 
@@ -206,7 +208,7 @@ export const dialogView = {
   STATS: 'STATS',
 } as const
 
-export type dialogView = typeof dialogView[keyof typeof dialogView]
+export type dialogView = (typeof dialogView)[keyof typeof dialogView]
 
 /**
  * @property farmhand.module:enums.toolType
@@ -221,7 +223,7 @@ export const toolType = {
   WATERING_CAN: 'WATERING_CAN',
 } as const
 
-export type toolType = typeof toolType[keyof typeof toolType]
+export type toolType = (typeof toolType)[keyof typeof toolType]
 
 /**
  * @property farmhand.module:enums.toolLevel
@@ -236,7 +238,7 @@ export const toolLevel = {
   GOLD: 'GOLD',
 } as const
 
-export type toolLevel = typeof toolLevel[keyof typeof toolLevel]
+export type toolLevel = (typeof toolLevel)[keyof typeof toolLevel]
 
 /**
  * @property farmhand.module:enums.notificationSeverity
@@ -249,7 +251,8 @@ export const notificationSeverity = {
   ERROR: 'error',
 } as const
 
-export type notificationSeverity = typeof notificationSeverity[keyof typeof notificationSeverity]
+export type notificationSeverity =
+  (typeof notificationSeverity)[keyof typeof notificationSeverity]
 
 /**
  * @property farmhand.module:enums.cowTradeRejectionReason
@@ -259,7 +262,8 @@ export const cowTradeRejectionReason = {
   REQUESTED_COW_UNAVAILABLE: 'REQUESTED_COW_UNAVAILABLE',
 } as const
 
-export type cowTradeRejectionReason = typeof cowTradeRejectionReason[keyof typeof cowTradeRejectionReason]
+export type cowTradeRejectionReason =
+  (typeof cowTradeRejectionReason)[keyof typeof cowTradeRejectionReason]
 
 /**
  * @property farmhand.module:enums.cropFamily
@@ -270,7 +274,7 @@ export const cropFamily = {
   GRAPE: 'GRAPE',
 } as const
 
-export type cropFamily = typeof cropFamily[keyof typeof cropFamily]
+export type cropFamily = (typeof cropFamily)[keyof typeof cropFamily]
 
 /**
  * @property farmhand.module:enums.grapeVariety
@@ -290,7 +294,7 @@ export const grapeVariety = {
   NEBBIOLO: 'NEBBIOLO',
 } as const
 
-export type grapeVariety = typeof grapeVariety[keyof typeof grapeVariety]
+export type grapeVariety = (typeof grapeVariety)[keyof typeof grapeVariety]
 
 /**
  * @property farmhand.module:enums.season
@@ -303,4 +307,28 @@ export const season = {
   WINTER: 'WINTER',
 } as const
 
-export type season = typeof season[keyof typeof season]
+export type season = (typeof season)[keyof typeof season]
+
+/**
+ * Names of the random number streams that game logic draws from. A stream
+ * name identifies where a value is drawn so that it can be forced with
+ * RandomNumberService#queueRandomNumbers (e.g. in E2E tests).
+ * @property farmhand.module:enums.randomStream
+ * @enum
+ */
+export const randomStream = {
+  PRECIPITATION: 'precipitation',
+  STORM: 'storm',
+  PRICE_EVENT_CHANCE: 'priceEventChance',
+  PRICE_EVENT_CROP: 'priceEventCrop',
+  PRICE_EVENT_TYPE: 'priceEventType',
+} as const
+
+/**
+ * The stream for an item's price adjustment (see generateValueAdjustments in
+ * src/common/utils.ts). Create one with getValueAdjustmentStream.
+ */
+export type valueAdjustmentStream = `valueAdjustment:${string}`
+
+export type randomStream =
+  (typeof randomStream)[keyof typeof randomStream] | valueAdjustmentStream

package/src/factories/OreFactory.ts

@@ -9,7 +9,8 @@ const SPAWNABLE_ORES = [goldOre, ironOre, bronzeOre, silverOre]
  * @constructor
  */
 export default class OreFactory extends Factory {
-  oreOptions: Array<{ ore: typeof SPAWNABLE_ORES[number]; weight: number }> = []
+  oreOptions: Array<{ ore: (typeof SPAWNABLE_ORES)[number]; weight: number }> =
+    []
 
   constructor() {
     super()

package/src/farmhand.d.ts

@@ -181,9 +181,7 @@ declare namespace farmhand {
 
   type achievementCondition = (state: state, prevState?: state) => boolean
   type achievementReward = (state: state) => state
-  type achievementProgress = (
-    state: state
-  ) => {
+  type achievementProgress = (state: state) => {
     currentValue: number
     goal: number
   }
@@ -403,6 +401,7 @@ declare namespace farmhand {
     latestNotification?: notification | null
     newDayNotifications: notification[]
     notificationLog: notificationLogEntry[]
+    notificationDuration: number
     /**
      * Keys are (Trystero) peer ids, values are their respective metadata or null.
      */

package/src/game-logic/reducers/applyPrecipitation.ts

@@ -83,13 +83,13 @@ export const applyPrecipitation = (state: farmhand.state): farmhand.state => {
         message: anyRodWasDestroyed
           ? LIGHTNING_ROD_DESTROYED_MESSAGE
           : anyRodWasReplanted
-          ? LIGHTNING_ROD_REPLANTED_MESSAGE
-          : LIGHTNING_ROD_STRUCK_MESSAGE,
+            ? LIGHTNING_ROD_REPLANTED_MESSAGE
+            : LIGHTNING_ROD_STRUCK_MESSAGE,
         severity: anyRodWasDestroyed
           ? 'error'
           : anyRodWasReplanted
-          ? 'success'
-          : 'info',
+            ? 'success'
+            : 'info',
       }
     } else if (fieldHasScarecrow(field)) {
       notification = {

package/src/game-logic/reducers/generatePriceEvents.ts

@@ -6,6 +6,7 @@ import { getLevelEntitlements } from '../../utils/getLevelEntitlements.js'
 import { PRICE_EVENT_CHANCE } from '../../constants.js'
 import { PRICE_CRASH, PRICE_SURGE } from '../../templates.js'
 import { random } from '../../common/utils.js'
+import { randomStream } from '../../enums.js'
 
 import { createPriceEvent } from './createPriceEvent.js'
 
@@ -20,13 +21,14 @@ export const generatePriceEvents = (state: farmhand.state): farmhand.state => {
 
   // TODO: Use isRandomNumberLessThan here once it supports an exclusive
   // less-than check.
-  if (random() < PRICE_EVENT_CHANCE) {
+  if (random(randomStream.PRICE_EVENT_CHANCE) < PRICE_EVENT_CHANCE) {
     const { items: unlockedItems } = getLevelEntitlements(
       levelAchieved(state.experience)
     )
 
     const cropItem = getRandomUnlockedCrop(
-      filterItemIdsToSeeds(Object.keys(unlockedItems))
+      filterItemIdsToSeeds(Object.keys(unlockedItems)),
+      randomStream.PRICE_EVENT_CROP
     )
     const { id } = cropItem
 
@@ -35,7 +37,8 @@ export const generatePriceEvents = (state: farmhand.state): farmhand.state => {
     )
 
     if (!doesPriceEventAlreadyExist) {
-      const priceEventType = random() < 0.5 ? TYPE_CRASH : TYPE_SURGE
+      const priceEventType =
+        random(randomStream.PRICE_EVENT_TYPE) < 0.5 ? TYPE_CRASH : TYPE_SURGE
 
       priceEvent = createPriceEvent(
         state,

package/src/game-logic/reducers/harvestForestPlot.ts

@@ -50,8 +50,7 @@ export const harvestForestPlot = (
     ...state,
     treeFruitsHarvested: {
       ...state.treeFruitsHarvested,
-      [item.id]:
-        (state.treeFruitsHarvested[item.id] || 0) + receivedFruitYield,
+      [item.id]: (state.treeFruitsHarvested[item.id] || 0) + receivedFruitYield,
     },
   }
 

package/src/game-logic/reducers/makeFermentationRecipe.ts

@@ -35,9 +35,8 @@ export const makeFermentationRecipe = (
     state = addKegToCellarInventory(state, keg)
   }
 
-  const saltRequirements = getSaltRequirementsForFermentationRecipe(
-    fermentationRecipe
-  )
+  const saltRequirements =
+    getSaltRequirementsForFermentationRecipe(fermentationRecipe)
 
   state = decrementItemFromInventory(state, fermentationRecipe.id, howMany)
 

package/src/game-logic/reducers/minePlot.test.ts

@@ -11,9 +11,9 @@ describe('minePlot', () => {
 
   beforeAll(() => {
     vitest.spyOn(randomNumberService, 'generateRandomNumber').mockReturnValue(1)
-    vitest.spyOn(ResourceFactory, 'instance').mockReturnValue(({
+    vitest.spyOn(ResourceFactory, 'instance').mockReturnValue({
       generateResources: () => [goldOre],
-    } as unknown) as typeof ResourceFactory.prototype)
+    } as unknown as typeof ResourceFactory.prototype)
 
     gameState = minePlot(
       testState({

package/src/game-logic/reducers/minePlot.ts

@@ -29,7 +29,7 @@ export const minePlot = (
   }
 
   const shovelLevel = state.toolLevels[toolType.SHOVEL]
-  const factory = (ResourceFactory.instance() as unknown) as {
+  const factory = ResourceFactory.instance() as unknown as {
     generateResources: (l: number) => farmhand.item[]
   }
   const spawnedResources = factory.generateResources(shovelLevel as any)

package/src/game-logic/reducers/processCowFertilizerProduction.test.ts

@@ -53,7 +53,8 @@ describe('processCowFertilizerProduction', () => {
         state.cowInventory = [
           generateCow({
             color: standardCowColors.WHITE,
-            daysSinceProducingFertilizer: COW_FERTILIZER_PRODUCTION_RATE_SLOWEST,
+            daysSinceProducingFertilizer:
+              COW_FERTILIZER_PRODUCTION_RATE_SLOWEST,
             gender: genders.MALE,
           }),
         ]
@@ -85,12 +86,14 @@ describe('processCowFertilizerProduction', () => {
         state.cowInventory = [
           generateCow({
             color: standardCowColors.WHITE,
-            daysSinceProducingFertilizer: COW_FERTILIZER_PRODUCTION_RATE_SLOWEST,
+            daysSinceProducingFertilizer:
+              COW_FERTILIZER_PRODUCTION_RATE_SLOWEST,
             gender: genders.MALE,
           }),
           generateCow({
             color: standardCowColors.WHITE,
-            daysSinceProducingFertilizer: COW_FERTILIZER_PRODUCTION_RATE_SLOWEST,
+            daysSinceProducingFertilizer:
+              COW_FERTILIZER_PRODUCTION_RATE_SLOWEST,
             gender: genders.MALE,
           }),
         ]
@@ -122,14 +125,14 @@ describe('processCowFertilizerProduction', () => {
         state.cowInventory = [
           generateCow({
             color: cowColors.RAINBOW,
-            daysSinceProducingFertilizer: COW_FERTILIZER_PRODUCTION_RATE_SLOWEST,
+            daysSinceProducingFertilizer:
+              COW_FERTILIZER_PRODUCTION_RATE_SLOWEST,
             gender: genders.MALE,
           }),
         ]
 
-        const { hasProducedRainbowFertilizer } = processCowFertilizerProduction(
-          state
-        )
+        const { hasProducedRainbowFertilizer } =
+          processCowFertilizerProduction(state)
 
         expect(hasProducedRainbowFertilizer).toBe(true)
       })
@@ -141,14 +144,14 @@ describe('processCowFertilizerProduction', () => {
         state.cowInventory = [
           generateCow({
             color: standardCowColors.WHITE,
-            daysSinceProducingFertilizer: COW_FERTILIZER_PRODUCTION_RATE_SLOWEST,
+            daysSinceProducingFertilizer:
+              COW_FERTILIZER_PRODUCTION_RATE_SLOWEST,
             gender: genders.MALE,
           }),
         ]
 
-        const { hasProducedRainbowFertilizer } = processCowFertilizerProduction(
-          state
-        )
+        const { hasProducedRainbowFertilizer } =
+          processCowFertilizerProduction(state)
 
         expect(hasProducedRainbowFertilizer).toBe(false)
       })
@@ -159,9 +162,8 @@ describe('processCowFertilizerProduction', () => {
         state.hasProducedRainbowFertilizer = true
         state.cowInventory = []
 
-        const { hasProducedRainbowFertilizer } = processCowFertilizerProduction(
-          state
-        )
+        const { hasProducedRainbowFertilizer } =
+          processCowFertilizerProduction(state)
 
         expect(hasProducedRainbowFertilizer).toBe(true)
       })

package/src/game-logic/reducers/processFeedingCows.test.ts

@@ -74,11 +74,8 @@ describe('processFeedingCows', () => {
     describe('there are more cows to feed than feed units', () => {
       test('units are distributed to cows and remainder goes hungry', () => {
         state.inventory = [{ id: COW_FEED_ITEM_ID, quantity: 1 }]
-        const {
-          cowInventory,
-          inventory,
-          newDayNotifications,
-        } = processFeedingCows(state)
+        const { cowInventory, inventory, newDayNotifications } =
+          processFeedingCows(state)
 
         expect(cowInventory[0].weightMultiplier).toEqual(
           1 + COW_WEIGHT_MULTIPLIER_FEED_BENEFIT

package/src/game-logic/reducers/purchaseCow.ts

@@ -9,13 +9,8 @@ export const purchaseCow = (
   state: farmhand.state,
   cow: farmhand.cow
 ): farmhand.state => {
-  const {
-    cowInventory,
-    cowColorsPurchased,
-    playerId,
-    money,
-    purchasedCowPen,
-  } = state
+  const { cowInventory, cowColorsPurchased, playerId, money, purchasedCowPen } =
+    state
   const { color } = cow
   const cowValue = getCowValue(cow, false)
 

package/src/game-logic/reducers/updateAchievements.ts

@@ -10,7 +10,7 @@ export const updateAchievements = (
   achievements.reduce(
     (
       reducerState: farmhand.state,
-      achievement: Omit<typeof achievements[number], 'condition'> & {
+      achievement: Omit<(typeof achievements)[number], 'condition'> & {
         condition: (s: farmhand.state, ps: farmhand.state) => boolean
       }
     ) => {

package/src/game-logic/reducers/updateFinancialRecords.test.ts

@@ -37,17 +37,15 @@ describe('updateFinancialRecords', () => {
   })
 
   test('truncates logs', () => {
-    const {
-      historicalDailyLosses,
-      historicalDailyRevenue,
-    } = updateFinancialRecords(
-      testState({
-        historicalDailyLosses: [-1, -2, -3, -4, -5, -6, -7],
-        historicalDailyRevenue: [1, 2, 3, 4, 5, 6, 7],
-        todaysLosses: -5,
-        todaysRevenue: 10,
-      })
-    )
+    const { historicalDailyLosses, historicalDailyRevenue } =
+      updateFinancialRecords(
+        testState({
+          historicalDailyLosses: [-1, -2, -3, -4, -5, -6, -7],
+          historicalDailyRevenue: [1, 2, 3, 4, 5, 6, 7],
+          todaysLosses: -5,
+          todaysRevenue: 10,
+        })
+      )
 
     expect(historicalDailyLosses).toEqual([-5, -1, -2, -3, -4, -5, -6])
     expect(historicalDailyRevenue).toEqual([10, 1, 2, 3, 4, 5, 6])
@@ -55,20 +53,18 @@ describe('updateFinancialRecords', () => {
 
   describe('profitabilityStreak', () => {
     test('unprofitable day resets streak', () => {
-      const {
-        profitabilityStreak,
-        recordProfitabilityStreak,
-      } = updateFinancialRecords(
-        testState({
-          historicalDailyLosses: [],
-          historicalDailyRevenue: [],
-          profitabilityStreak: 10,
-          record7dayProfitAverage: 0,
-          recordProfitabilityStreak: 10,
-          todaysLosses: -10,
-          todaysRevenue: 10,
-        })
-      )
+      const { profitabilityStreak, recordProfitabilityStreak } =
+        updateFinancialRecords(
+          testState({
+            historicalDailyLosses: [],
+            historicalDailyRevenue: [],
+            profitabilityStreak: 10,
+            record7dayProfitAverage: 0,
+            recordProfitabilityStreak: 10,
+            todaysLosses: -10,
+            todaysRevenue: 10,
+          })
+        )
 
       expect(profitabilityStreak).toEqual(0)
       expect(recordProfitabilityStreak).toEqual(10)

package/src/game-logic/reducers/updateFinancialRecords.ts

@@ -13,11 +13,8 @@ export const updateFinancialRecords = (
     record7dayProfitAverage,
     recordProfitabilityStreak,
   } = state
-  let {
-    historicalDailyLosses,
-    historicalDailyRevenue,
-    recordSingleDayProfit,
-  } = state
+  let { historicalDailyLosses, historicalDailyRevenue, recordSingleDayProfit } =
+    state
 
   historicalDailyLosses = [todaysLosses, ...historicalDailyLosses].slice(
     0,

package/src/game-logic/reducers/updateInventoryRecordsForNextDay.test.ts

@@ -4,20 +4,18 @@ import { updateInventoryRecordsForNextDay } from './updateInventoryRecordsForNex
 
 describe('updateInventoryRecordsForNextDay', () => {
   test('records inventory records for next day', () => {
-    const {
-      todaysPurchases,
-      todaysStartingInventory,
-    } = updateInventoryRecordsForNextDay(
-      testState({
-        inventory: [
-          { id: 'sample-item-1', quantity: 2 },
-          { id: 'sample-item-2', quantity: 5 },
-        ],
-        todaysPurchases: {
-          'sample-item-3': 3,
-        },
-      })
-    )
+    const { todaysPurchases, todaysStartingInventory } =
+      updateInventoryRecordsForNextDay(
+        testState({
+          inventory: [
+            { id: 'sample-item-1', quantity: 2 },
+            { id: 'sample-item-2', quantity: 5 },
+          ],
+          todaysPurchases: {
+            'sample-item-3': 3,
+          },
+        })
+      )
 
     expect(todaysPurchases).toEqual({})
     expect(todaysStartingInventory).toEqual({