warframe-worldstate-parser 2.23.2 → 2.25.0

package/lib/SyndicateJob.js

@@ -63,7 +63,9 @@ const getBountyRewards = async (i18n, isVault, raw) => {
     ({ location, locationWRot } = determineLocation(i18n, isVault, raw));
   }
   const url = `${apiBase}/drops/search/${encodeURIComponent(location)}?grouped_by=location`;
-  const reply = await fetch(url).then((res) => res.json()).catch(() => {}); // swallow errors
+  const reply = await fetch(url)
+    .then((res) => res.json())
+    .catch(() => {}); // swallow errors
   const pool = (reply || {})[locationWRot];
   if (!pool) {
     return ['Pattern Mismatch. Results inaccurate.'];
@@ -72,6 +74,7 @@ const getBountyRewards = async (i18n, isVault, raw) => {
   if (results) {
     return Array.from(new Set(results.map((result) => result.item)));
   }
+  /* istanbul ignore next */
   return [];
 };
 
@@ -91,28 +94,34 @@ class SyndicateJob extends WorldstateObject {
    * @param {string} locale Locale to use for translations
    */
   constructor(data, expiry, { translator, timeDate, locale }) {
-    super({ _id: { $oid: data.JobCurrentVersion ? data.JobCurrentVersion.$oid : `${(data.jobType || '').split('/').slice(-1)[0]}${expiry.getTime()}` } }, { timeDate });
+    super(
+      {
+        _id: {
+          $oid: data.JobCurrentVersion
+            ? data.JobCurrentVersion.$oid
+            : `${(data.jobType || '').split('/').slice(-1)[0]}${expiry.getTime()}`,
+        },
+      },
+      { timeDate }
+    );
 
     /**
      * Array of strings describing rewards
      * @type {Array.<String>}
      */
     this.rewardPool = [];
-    getBountyRewards(data.rewards, data.isVault, data)
-      .then((rewards) => {
-        this.rewardPool = rewards;
-      });
+    getBountyRewards(data.rewards, data.isVault, data).then((rewards) => {
+      this.rewardPool = rewards;
+    });
 
-    const chamber = ((data.locationTag || '')
-      .match(/[A-Z]+(?![a-z])|[A-Z]?[a-z]+|\d+/g) || [])
-      .join(' ');
+    const chamber = ((data.locationTag || '').match(/[A-Z]+(?![a-z])|[A-Z]?[a-z]+|\d+/g) || []).join(' ');
 
     /**
      * The type of job this is
      * @type {String}
      */
-    this.type = translator.languageString(data.jobType, locale)
-      || `${data.isVault ? 'Isolation Vault' : ''} ${chamber}`;
+    this.type =
+      translator.languageString(data.jobType, locale) || `${data.isVault ? 'Isolation Vault' : ''} ${chamber}`;
 
     /**
      * Array of enemy levels

package/lib/SyndicateMission.js

@@ -16,13 +16,14 @@ class SyndicateMission extends WorldstateObject {
    * @param   {TimeDateFunctions}  deps.timeDate   The time and date functions
    * @param   {string}             deps.locale     Locale to use for translations
    */
-  constructor(data, {
-    mdConfig, translator, timeDate, locale,
-  }) {
+  constructor(data, { mdConfig, translator, timeDate, locale }) {
     super(data, { timeDate });
 
     const deps = {
-      mdConfig, translator, timeDate, locale,
+      mdConfig,
+      translator,
+      timeDate,
+      locale,
     };
 
     /**
@@ -113,8 +114,7 @@ class SyndicateMission extends WorldstateObject {
   toString() {
     if (this.nodes.length > 0) {
       const missions = this.nodes.map((n) => `  \u2022${n.toString()}`).join(this.mdConfig.lineEnd);
-      return `[${this.getETAString()}] ${this.syndicate} currently has missions on: `
-        + `${this.mdConfig.lineEnd}${missions}`;
+      return `[${this.getETAString()}] ${this.syndicate} currently has missions on:${this.mdConfig.lineEnd}${missions}`;
     }
 
     return `No missions available for ${this.syndicate}`;

package/lib/VallisCycle.js

@@ -21,7 +21,7 @@ function getCurrentCycle() {
     toNextMinor = toNextFull - coldTime;
   }
   const milliAtNext = Date.now() + toNextMinor;
-  const milliAtPrev = (Date.now() + toNextFull) - (state === 'warm' ? loopTime : coldTime);
+  const milliAtPrev = Date.now() + toNextFull - (state === 'warm' ? loopTime : coldTime);
   const timeAtPrevious = new Date(milliAtPrev);
   timeAtPrevious.setSeconds(0);
 
@@ -104,7 +104,7 @@ class VallisCycle extends WorldstateObject {
 
     this.id = `vallisCycle${ec.timeAtPrevious.getTime()}`;
 
-    this.shortString = `${this.timeLeft.replace(/\s\d*s/ig, '')} to ${this.isWarm ? 'Cold' : 'Warm'}`;
+    this.shortString = `${this.timeLeft.replace(/\s\d*s/gi, '')} to ${this.isWarm ? 'Cold' : 'Warm'}`;
   }
 
   /**

package/lib/VoidTrader.js

@@ -17,9 +17,7 @@ class VoidTrader extends WorldstateObject {
    * @param   {TimeDateFunctions}  deps.timeDate   The time and date functions
    * @param   {string}             deps.locale     Locale to use for translations
    */
-  constructor(data, {
-    mdConfig, translator, timeDate, locale,
-  }) {
+  constructor(data, { mdConfig, translator, timeDate, locale }) {
     super(data, { timeDate });
 
     /**
@@ -54,7 +52,7 @@ class VoidTrader extends WorldstateObject {
      * The void trader's name
      * @type {string}
      */
-    this.character = data.Character ? data.Character.replace('Baro\'Ki Teel', 'Baro Ki\'Teer') : '';
+    this.character = data.Character ? data.Character.replace("Baro'Ki Teel", "Baro Ki'Teer") : '';
 
     /**
      * The node at which the Void Trader appears
@@ -66,9 +64,7 @@ class VoidTrader extends WorldstateObject {
      * The trader's inventory
      * @type {VoidTraderItem[]}
      */
-    this.inventory = data.Manifest
-      ? data.Manifest.map((i) => new VoidTraderItem(i, { translator, locale }))
-      : [];
+    this.inventory = data.Manifest ? data.Manifest.map((i) => new VoidTraderItem(i, { translator, locale })) : [];
 
     /**
      * Pseudo Identifier for identifying changes in inventory
@@ -99,8 +95,7 @@ class VoidTrader extends WorldstateObject {
     this.initialStart = timeDate.parseDate(data.InitialStartDate);
     this.completed = data.Completed;
     this.schedule = data.ScheduleInfo
-      ? data.ScheduleInfo
-        .map((i) => new VoidTraderSchedule(i, { timeDate, translator, locale }))
+      ? data.ScheduleInfo.map((i) => new VoidTraderSchedule(i, { timeDate, translator, locale }))
       : [];
   }
 
@@ -109,8 +104,7 @@ class VoidTrader extends WorldstateObject {
    * @returns {boolean}
    */
   isActive() {
-    return (this.timeDate.fromNow(this.activation) < 0)
-      && (this.timeDate.fromNow(this.expiry) > 0);
+    return this.timeDate.fromNow(this.activation) < 0 && this.timeDate.fromNow(this.expiry) > 0;
   }
 
   /**
@@ -137,8 +131,10 @@ class VoidTrader extends WorldstateObject {
     if (!this.isActive()) {
       const timeDelta = this.timeDate.fromNow(this.activation);
       const nextArrivalTime = this.timeDate.timeDeltaToString(timeDelta);
-      return `${this.mdConfig.codeMulti}${this.character} is not here yet, he will arrive in `
-        + `${nextArrivalTime} at ${this.location}${this.mdConfig.blockEnd}`;
+      return (
+        `${this.mdConfig.codeMulti}${this.character} is not here yet, he will arrive in ` +
+        `${nextArrivalTime} at ${this.location}${this.mdConfig.blockEnd}`
+      );
     }
 
     const inventoryString = this.inventory

package/lib/WeeklyChallenge.js

@@ -18,8 +18,7 @@ class WeeklyChallenge extends WorldstateObject {
   constructor(data, { timeDate, translator }) {
     super(data, { timeDate });
 
-    this.challenges = data.Challenges
-      .map((challengeData) => new ChallengeInstance(challengeData, { translator }));
+    this.challenges = data.Challenges.map((challengeData) => new ChallengeInstance(challengeData, { translator }));
   }
 
   /**
@@ -27,7 +26,9 @@ class WeeklyChallenge extends WorldstateObject {
    * @returns {string}
    */
   toString() {
-    return `Starts: ${this.getStartString()}\nEnds: ${this.getEndString()}\nChallenges:\n${this.challenges.map((challenge) => `\t${challenge.toString()}`).join('\n')}`;
+    return `Starts: ${this.getStartString()}\nEnds: ${this.getEndString()}\nChallenges:\n${this.challenges
+      .map((challenge) => `\t${challenge.toString()}`)
+      .join('\n')}`;
   }
 }
 

package/lib/WorldEvent.js

@@ -36,13 +36,15 @@ class WorldEvent extends WorldstateObject {
    * @param   {Reward}            deps.Reward     The Reward parser
    * @param   {string}            deps.locale     Locale to use for translations
    */
-  constructor(data, {
-    mdConfig, translator, timeDate, Reward, locale,
-  }) {
+  constructor(data, { mdConfig, translator, timeDate, Reward, locale }) {
     super(data, { timeDate });
 
     const opts = {
-      translator, mdConfig, Reward, timeDate, locale,
+      translator,
+      mdConfig,
+      Reward,
+      timeDate,
+      locale,
     };
 
     /**
@@ -118,9 +120,7 @@ class WorldEvent extends WorldstateObject {
      * The other nodes where the event takes place
      * @type {string[]}
      */
-    this.concurrentNodes = data.ConcurrentNodes
-      ? data.ConcurrentNodes.map((n) => translator.node(n), locale)
-      : [];
+    this.concurrentNodes = data.ConcurrentNodes ? data.ConcurrentNodes.map((n) => translator.node(n), locale) : [];
 
     /**
      * The victim node
@@ -132,16 +132,14 @@ class WorldEvent extends WorldstateObject {
      * The score description
      * @type {?string}
      */
-    this.scoreLocTag = data.Fomorian
-      ? 'Fomorian Assault Score'
-      : translator.languageString(data.ScoreLocTag, locale);
+    this.scoreLocTag = data.Fomorian ? 'Fomorian Assault Score' : translator.languageString(data.ScoreLocTag, locale);
 
     /**
      * The event's rewards
      * @type {Reward[]}
      */
     this.rewards = Object.keys(data)
-      .filter((k) => (k.includes('Reward') || k.includes('reward')))
+      .filter((k) => k.includes('Reward') || k.includes('reward'))
       .map((k) => new Reward(data[k], opts));
 
     /**
@@ -154,16 +152,14 @@ class WorldEvent extends WorldstateObject {
      * Health remaining for the target
      * @type {Number}
      */
-    this.health = typeof data.HealthPct !== 'undefined'
-      ? Number.parseFloat(((data.HealthPct || 0.00) * 100).toFixed(2))
-      : undefined;
+    this.health =
+      typeof data.HealthPct !== 'undefined' ? Number.parseFloat(((data.HealthPct || 0.0) * 100).toFixed(2)) : undefined;
 
     if (data.JobAffiliationTag) {
       this.affiliatedWith = translator.syndicate(data.JobAffiliationTag, locale);
       if (data.Jobs) {
         this.jobs = (data.Jobs || []).map((j) => new SyndicateJob(j, this.expiry, opts));
-        this.previousJobs = (data.PreviousJobs || [])
-          .map((j) => new SyndicateJob(j, this.expiry, opts));
+        this.previousJobs = (data.PreviousJobs || []).map((j) => new SyndicateJob(j, this.expiry, opts));
       }
     }
 
@@ -180,7 +176,7 @@ class WorldEvent extends WorldstateObject {
     this.interimSteps = [];
 
     (data.InterimRewards || []).forEach((reward, index) => {
-      const msg = ((data.InterimRewardMessages || [])[index] || {});
+      const msg = (data.InterimRewardMessages || [])[index] || {};
       this.interimSteps[index] = {
         goal: Number.parseInt(data.InterimGoals[index], 10),
         reward: reward ? new Reward(reward, opts) : undefined,
@@ -191,13 +187,14 @@ class WorldEvent extends WorldstateObject {
           senderIcon: msg.senderIcon,
           attachments: msg.attachments,
         },
+        // eslint-disable-next-line no-underscore-dangle
         winnerCount: (data._interimWinnerCounts || [])[index],
       };
     });
 
     /**
      * Progress Steps, if any are present
-     * @type {ProgessStep[]}
+     * @type {ProgressStep[]}
      */
     this.progressSteps = [];
 
@@ -213,8 +210,7 @@ class WorldEvent extends WorldstateObject {
        * Total of all MultiProgress
        * @type {Number}
        */
-      this.progressTotal = Number.parseFloat(data.MultiProgress
-        .reduce((accumulator, val) => accumulator + val));
+      this.progressTotal = Number.parseFloat(data.MultiProgress.reduce((accumulator, val) => accumulator + val));
     }
 
     /**
@@ -237,15 +233,13 @@ class WorldEvent extends WorldstateObject {
      * Affectors for this mission
      * @type {string[]}
      */
-    this.regionDrops = (data.RegionDrops || [])
-      .map((drop) => translator.languageString(drop, locale));
+    this.regionDrops = (data.RegionDrops || []).map((drop) => translator.languageString(drop, locale));
 
     /**
      * Archwing Drops in effect while this event is active
      * @type {string[]}
      */
-    this.archwingDrops = (data.ArchwingDrops || [])
-      .map((drop) => translator.languageString(drop, locale));
+    this.archwingDrops = (data.ArchwingDrops || []).map((drop) => translator.languageString(drop, locale));
 
     this.asString = this.toString();
 
@@ -285,9 +279,7 @@ class WorldEvent extends WorldstateObject {
    * @returns {string}
    */
   toString() {
-    let lines = [
-      `${this.description} : ${this.faction}`,
-    ];
+    let lines = [`${this.description} : ${this.faction}`];
 
     if (this.scoreLocTag && this.maximumScore) {
       lines.push(`${this.scoreLocTag} : ${this.maximumScore}`);
@@ -308,8 +300,10 @@ class WorldEvent extends WorldstateObject {
     }
 
     if (this.affiliatedWith && this.jobs) {
-      lines.push(`${this.affiliatedWith} will reward you for performing `
-        + `${this.jobs.map((job) => job.type).join(', ')} job${this.jobs.length > 1 ? 's' : ''}`);
+      lines.push(
+        `${this.affiliatedWith} will reward you for performing ` +
+          `${this.jobs.map((job) => job.type).join(', ')} job${this.jobs.length > 1 ? 's' : ''}`
+      );
     }
 
     return lines.join(this.mdConfig.lineEnd);

package/lib/WorldState.js

@@ -27,6 +27,7 @@ const EarthCycle = require('./EarthCycle');
 const CetusCycle = require('./CetusCycle');
 const ConstructionProgress = require('./ConstructionProgress');
 const VallisCycle = require('./VallisCycle');
+const ZarimanCycle = require('./ZarimanCycle');
 const WeeklyChallenge = require('./WeeklyChallenge');
 const Nightwave = require('./Nightwave');
 const Kuva = require('./Kuva');
@@ -34,15 +35,11 @@ const SentientOutpost = require('./SentientOutpost');
 const CambionCycle = require('./CambionCycle');
 const SteelPathOffering = require('./SteelPathOffering');
 
-/* eslint-disable no-unused-vars */
 // needed for type declarations
-const Dependency = require('./supporting/Dependency');
-const ExternalMission = require('./supporting/ExternalMission');
 const MarkdownSettings = require('./supporting/MarkdownSettings');
-/* eslint-enable no-unused-vars */
 
-const safeArray = (arr) => (arr || []);
-const safeObj = (obj) => (obj || {});
+const safeArray = (arr) => arr || [];
+const safeObj = (obj) => obj || {};
 
 /**
  * Default Dependency object
@@ -77,11 +74,19 @@ const defaultDeps = {
   logger: console,
 };
 
+/**
+ *
+ * @param {Object} ParserClass class for parsing data
+ * @param {Array<BaseContentObject>} dataArray array of raw data
+ * @param {Dependency} deps shared dependency object
+ * @param {*} uniqueField field to treat as unique
+ * @returns {WorldstateObject}
+ */
 function parseArray(ParserClass, dataArray, deps, uniqueField) {
   const arr = (dataArray || []).map((d) => new ParserClass(d, deps));
   if (uniqueField) {
     const utemp = {};
-    arr.sort((a, b) => a.id.localeCompare((b.id)));
+    arr.sort((a, b) => a.id.localeCompare(b.id));
     arr.forEach((obj) => {
       utemp[obj[uniqueField]] = obj;
     });
@@ -89,6 +94,7 @@ function parseArray(ParserClass, dataArray, deps, uniqueField) {
       if (Object.prototype.hasOwnProperty.call(obj, 'active')) {
         return obj.active;
       }
+      /* istanbul ignore next */
       return true;
     });
   }
@@ -126,9 +132,13 @@ module.exports = class WorldState {
      * The in-game news
      * @type {Array.<News>}
      */
-    this.news = parseArray(deps.News, (data.Events
-      ? data.Events.filter((e) => typeof e.Messages.find((msg) => msg.LanguageCode === deps.locale) !== 'undefined')
-      : []), deps);
+    this.news = parseArray(
+      deps.News,
+      data.Events
+        ? data.Events.filter((e) => typeof e.Messages.find((msg) => msg.LanguageCode === deps.locale) !== 'undefined')
+        : [],
+      deps
+    );
 
     /**
      * The current events
@@ -158,8 +168,9 @@ module.exports = class WorldState {
      * The current fissures: 'ActiveMissions' & 'VoidStorms'
      * @type {Array.<News>}
      */
-    this.fissures = parseArray(deps.Fissure, data.ActiveMissions, deps)
-      .concat(parseArray(deps.Fissure, data.VoidStorms, deps));
+    this.fissures = parseArray(deps.Fissure, data.ActiveMissions, deps).concat(
+      parseArray(deps.Fissure, data.VoidStorms, deps)
+    );
 
     /**
      * The current global upgrades
@@ -221,10 +232,8 @@ module.exports = class WorldState {
      */
     this.earthCycle = new EarthCycle(deps);
 
-    const cetusSynd = safeArray(data.SyndicateMissions)
-      .filter((syndicate) => syndicate.Tag === 'CetusSyndicate');
-    const cetusBountyEnd = timeDate
-      .parseDate(cetusSynd.length > 0 ? cetusSynd[0].Expiry : { $date: 0 });
+    const cetusSynd = safeArray(data.SyndicateMissions).filter((syndicate) => syndicate.Tag === 'CetusSyndicate');
+    const cetusBountyEnd = timeDate.parseDate(cetusSynd.length > 0 ? cetusSynd[0].Expiry : { $date: 0 });
 
     /**
      * The current Cetus cycle
@@ -238,28 +247,35 @@ module.exports = class WorldState {
      */
     this.cambionCycle = new CambionCycle(this.cetusCycle, deps);
 
+    const zarimanSynd = safeArray(data.SyndicateMissions).filter((syndicate) => syndicate.Tag === 'ZarimanSyndicate');
+    const zarimanBountyEnd = timeDate.parseDate(zarimanSynd.length > 0 ? zarimanSynd[0].Expiry : { $date: 0 });
+
+    /**
+     * The current Zariman cycle based off current time
+     * @type {ZarimanCycle}
+     */
+    this.zarimanCycle = new ZarimanCycle(zarimanBountyEnd, deps);
+
     /**
      * Weekly challenges
      * @type {Array.<WeeklyChallenge>}
      */
-    this.weeklyChallenges = data.WeeklyChallenges
-      ? new deps.WeeklyChallenge(data.WeeklyChallenges, deps)
-      : [];
+    this.weeklyChallenges = data.WeeklyChallenges ? new deps.WeeklyChallenge(data.WeeklyChallenges, deps) : [];
 
-    const projectPCTwithOid = data.ProjectPct ? {
-      ProjectPct: data.ProjectPct,
-      _id: {
-        $oid: `${Date.now()}${data.ProjectPct[0]}`,
-      },
-    } : undefined;
+    const projectPCTwithOid = data.ProjectPct
+      ? {
+          ProjectPct: data.ProjectPct,
+          _id: {
+            $oid: `${Date.now()}${data.ProjectPct[0]}`,
+          },
+        }
+      : undefined;
 
     /**
      * The Current construction progress for Fomorians/Razorback/etc.
      * @type {ConstructionProgress}
      */
-    this.constructionProgress = projectPCTwithOid
-      ? new ConstructionProgress(projectPCTwithOid, deps)
-      : {};
+    this.constructionProgress = projectPCTwithOid ? new ConstructionProgress(projectPCTwithOid, deps) : {};
 
     /**
      * The current Orb Vallis cycle state
@@ -303,5 +319,11 @@ module.exports = class WorldState {
     this.steelPath = new SteelPathOffering(deps);
 
     [this.vaultTrader] = parseArray(deps.VoidTrader, data.PrimeVaultTraders, deps);
+
+    /**
+     * The current archon hunt
+     * @type {Sortie}
+     */
+    [this.archonHunt] = parseArray(deps.Sortie, data.LiteSorties, deps);
   }
 };

package/lib/WorldstateObject.js

@@ -1,18 +1,44 @@
 'use strict';
 
 /**
- * Represents a generic ojbect from Worldstate
+ * @typedef {Object} Identifier
+ * @property {string} $id older identifier schema
+ * @property {string} $oid newer global identifier schema
  */
-class WorldstateObject {
+/**
+ * @typedef {Object} LegacyTimestamp
+ * @property {number} sec second-based timestamp
+ */
+/**
+ * @typedef {Object} Timestamp
+ * @property {number} $numberLong millisecond-based timestamp
+ */
+/**
+ * @typedef {Object} ContentTimestamp
+ * @property {LegacyTimestamp|Timestamp} $date timestamp number wrapper
+ */
+/**
+ * @typedef {Object} BaseContentObject
+ * @property {Identifier} _id
+ * @property {ContentTimestamp} Activation
+ * @property {ContentTimestamp} Expiry
+ */
+
+/**
+ * Represents a generic object from Worldstate
+ */
+module.exports = class WorldstateObject {
   /**
-   * @param   {Object} data The object data
+   * @param   {BaseContentObject} data The object data
+   * @param   {TimeDateFunctions} timeDate time date functions
    */
   constructor(data, { timeDate }) {
     /**
      * The object's id field
-     * @type {string}
+     * @type {Identifier.$id|Identifier.$oid}
      */
-    this.id = data._id ? (data._id.$oid || data._id.$id) : undefined;
+    // eslint-disable-next-line no-underscore-dangle
+    this.id = data._id ? data._id.$oid || data._id.$id : undefined;
 
     /**
      * The time and date functions
@@ -47,7 +73,7 @@ class WorldstateObject {
 
     if (data.Activation && data.Expiry) {
       /**
-       * Whether or not the void trader is active (at time of object creation)
+       * Whether the void trader is active (at time of object creation)
        * @type {boolean}
        */
       this.active = this.isActive();
@@ -63,12 +89,11 @@ class WorldstateObject {
   }
 
   /**
-   * Get whether or not the trader is currently active
+   * Get whether the trader is currently active
    * @returns {boolean}
    */
   isActive() {
-    return (this.timeDate.fromNow(this.activation) < 0)
-      && (this.timeDate.fromNow(this.expiry) > 0);
+    return this.timeDate.fromNow(this.activation) < 0 && this.timeDate.fromNow(this.expiry) > 0;
   }
 
   /**
@@ -86,6 +111,4 @@ class WorldstateObject {
   getEndString() {
     return this.timeDate.timeDeltaToString(this.timeDate.fromNow(this.expiry));
   }
-}
-
-module.exports = WorldstateObject;
+};