feat: expose more drop info for bounty rewards (#682)

Co-authored-by: Matt <7128721+TobiTenno@users.noreply.github.com>

Author: SlayerOrnstein

lib/models/SyndicateJob.ts

@@ -48,7 +48,17 @@ const determineLocation = (i18n: string, raw: RawSyndicateJob, isVault?: boolean
   return { location, locationWRot };
 };
 
-const getBountyRewards = async (i18n: string, raw: RawSyndicateJob, isVault?: boolean): Promise<string[]> => {
+interface BountyReward {
+  item: string;
+  rarity: string;
+  chance: number;
+}
+
+const getBountyRewards = async (
+  i18n: string,
+  raw: RawSyndicateJob,
+  isVault?: boolean
+): Promise<(string | BountyReward)[]> => {
   let location: string | undefined;
   let locationWRot: string | undefined;
   if (i18n.endsWith('PlagueStarTableRewards')) {
@@ -59,7 +69,7 @@ const getBountyRewards = async (i18n: string, raw: RawSyndicateJob, isVault?: bo
     ({ location, locationWRot } = determineLocation(i18n, raw, isVault));
   }
   const url = `${apiBase}/drops/search/${encodeURIComponent(location!)}?grouped_by=location`;
-  const reply: Record<string, { rewards: { item: string }[] }> = await fetch(url)
+  const reply: Record<string, { rewards: BountyReward[] }> = await fetch(url)
     .then((res) => res.json())
     .catch(() => {}); // swallow errors
   const pool = reply?.[locationWRot];
@@ -68,7 +78,7 @@ const getBountyRewards = async (i18n: string, raw: RawSyndicateJob, isVault?: bo
   }
   const results = pool.rewards;
   if (results) {
-    return Array.from(new Set(results.map((result) => result.item)));
+    return Array.from(new Set(results));
   }
   return [];
 };
@@ -87,16 +97,30 @@ export interface RawSyndicateJob {
   masteryReq?: number;
 }
 
+export interface RewardDrop extends BountyReward {
+  count: number;
+}
+
 /**
  * Represents a syndicate daily mission
  * @augments {WorldstateObject}
  */
 export default class SyndicateJob extends WorldstateObject {
+  /**
+   * Reward pool unique name
+   */
+  uniqueName: string;
+
   /**
    * Array of strings describing rewards
    */
   rewardPool: string[];
 
+  /**
+   * A structured version of the reward pool
+   */
+  rewardPoolDrops: RewardDrop[];
+
   /**
    * The type of job this is
    */
@@ -142,7 +166,21 @@ export default class SyndicateJob extends WorldstateObject {
    */
   static async build(data: RawSyndicateJob, expiry: Date, deps: Dependency): Promise<SyndicateJob> {
     const job = new SyndicateJob(data, expiry, deps);
-    job.rewardPool = await getBountyRewards(data.rewards, data, data.isVault);
+    const rewards = await getBountyRewards(data.rewards, data, data.isVault);
+    if (typeof rewards[0] === 'string') {
+      job.rewardPool = rewards as string[];
+    } else {
+      job.rewardPoolDrops = (rewards as BountyReward[]).map((reward) => {
+        const fragments = reward.item.split('X');
+        return {
+          ...reward,
+          item: fragments[fragments.length - 1].trim(),
+          count: fragments.length > 1 ? parseInt(fragments[0], 10) : 1,
+        };
+      });
+
+      job.rewardPool = (rewards as BountyReward[]).map((reward) => reward.item);
+    }
 
     return job;
   }
@@ -165,11 +203,19 @@ export default class SyndicateJob extends WorldstateObject {
       },
     });
 
+    this.uniqueName = data.rewards;
+
     this.rewardPool = [];
 
+    this.rewardPoolDrops = [];
+
     const chamber = ((data.locationTag || '').match(/[A-Z]+(?![a-z])|[A-Z]?[a-z]+|\d+/g) || []).join(' ');
 
-    this.type = data.isVault ? `Isolation Vault ${chamber}` : (data.jobType ? languageString(data.jobType, locale): undefined);
+    this.type = data.isVault
+      ? `Isolation Vault ${chamber}`
+      : data.jobType
+        ? languageString(data.jobType, locale)
+        : undefined;
 
     this.enemyLevels = [data.minEnemyLevel, data.maxEnemyLevel];
 

test/unit/syndicatejob.spec.ts

@@ -1,6 +1,6 @@
 import * as chai from 'chai';
 
-import SyndicateJob, { type RawSyndicateJob } from '../../lib/models/SyndicateJob.js';
+import SyndicateJob, { type RewardDrop, type RawSyndicateJob } from '../../lib/models/SyndicateJob.js';
 import CambionFTier from '../data/CambionFTier.json' with { type: 'json' };
 import CetusFTier from '../data/CetusFTier.json' with { type: 'json' };
 import isoVaultBounty from '../data/isoVaultBounty.json' with { type: 'json' };
@@ -28,12 +28,13 @@ describe('SyndicateJob', () => {
       async function () {
         this.timeout(1100000000);
         const job = await SyndicateJob.build(data, new Date(), { locale });
-        const verify = (rewardPool: string[]) => {
+        const verify = (rewardPool: (string | RewardDrop)[]) => {
           rewardPool.should.be.an('array');
           rewardPool.length.should.be.at.least(1);
         };
 
         if (job.rewardPool?.length) verify(job.rewardPool);
+        if (job.rewardPoolDrops?.length) verify(job.rewardPoolDrops);
       };
 
     it('should exist when requested', async () => poolTest(isoVaultBounty));