warframe-worldstate-parser 2.31.1 → 3.0.0

package/README.md

@@ -6,6 +6,7 @@ Parse the Warframe worldstate into useable javascript objects.
 [![Crowdin](https://d322cqt584bo4o.cloudfront.net/genesis-parser/localized.svg)](https://crowdin.com/project/genesis-parser)
 [![Coverage Status](https://coveralls.io/repos/github/WFCD/warframe-worldstate-parser/badge.svg?branch=master)](https://coveralls.io/github/WFCD/warframe-worldstate-parser?branch=master)
 [![Discord](https://img.shields.io/discord/256087517353213954.svg?logo=discord)](https://discord.gg/jGZxH9f)
+[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
 
 ## Documentation
 You can find the documentation [here](https://wfcd.github.io/warframe-worldstate-parser/)

package/lib/WorldState.js

@@ -1,45 +1,37 @@
-'use strict';
-
-const sortieData = require('warframe-worldstate-data').sortie;
-
-const News = require('./models/News');
-const WorldEvent = require('./models/WorldEvent');
-const Alert = require('./models/Alert');
-const Sortie = require('./models/Sortie');
-const SortieVariant = require('./models/SortieVariant');
-const SyndicateMission = require('./models/SyndicateMission');
-const Fissure = require('./models/Fissure');
-const GlobalUpgrade = require('./models/GlobalUpgrade');
-const FlashSale = require('./models/FlashSale');
-const Invasion = require('./models/Invasion');
-const DarkSector = require('./models/DarkSector');
-const DarkSectorBattle = require('./models/DarkSectorBattle');
-const Mission = require('./models/Mission');
-const Reward = require('./models/Reward');
-const VoidTrader = require('./models/VoidTrader');
-const DailyDeal = require('./models/DailyDeal');
-const Simaris = require('./models/Simaris');
-const ConclaveChallenge = require('./models/ConclaveChallenge');
-const PersistentEnemy = require('./models/PersistentEnemy');
-const timeDate = require('./utilities/timeDate');
-const translator = require('./utilities/translation');
-const EarthCycle = require('./models/EarthCycle');
-const CetusCycle = require('./models/CetusCycle');
-const ConstructionProgress = require('./models/ConstructionProgress');
-const VallisCycle = require('./models/VallisCycle');
-const ZarimanCycle = require('./models/ZarimanCycle');
-const WeeklyChallenge = require('./models/WeeklyChallenge');
-const Nightwave = require('./models/Nightwave');
-const Kuva = require('./models/Kuva');
-const SentientOutpost = require('./models/SentientOutpost');
-const CambionCycle = require('./models/CambionCycle');
-const SteelPathOffering = require('./models/SteelPathOffering');
-const Dependency = require('./supporting/Dependency'); // eslint-disable-line no-unused-vars
-const DuviriCycle = require('./models/DuviriCycle');
-const DuviriChoice = require('./supporting/DuviriChoice');
-
-// needed for type declarations
-const MarkdownSettings = require('./supporting/MarkdownSettings');
+import wsData from 'warframe-worldstate-data';
+
+import EarthCycle from './models/EarthCycle.js';
+import CetusCycle from './models/CetusCycle.js';
+import ConstructionProgress from './models/ConstructionProgress.js';
+import VallisCycle from './models/VallisCycle.js';
+import ZarimanCycle from './models/ZarimanCycle.js';
+import Nightwave from './models/Nightwave.js';
+import Kuva from './models/Kuva.js';
+import SentientOutpost from './models/SentientOutpost.js';
+import CambionCycle from './models/CambionCycle.js';
+import SteelPathOffering from './models/SteelPathOffering.js';
+import Dependency from './supporting/Dependency.js'; // eslint-disable-line no-unused-vars
+import DuviriCycle from './models/DuviriCycle.js';
+import { parseDate } from './utilities/timeDate.js';
+import WeeklyChallenge from './models/WeeklyChallenge.js';
+import Sortie from './models/Sortie.js';
+import DuviriChoice from './supporting/DuviriChoice.js';
+import VoidTrader from './models/VoidTrader.js';
+import PersistentEnemy from './models/PersistentEnemy.js';
+import ConclaveChallenge from './models/ConclaveChallenge.js';
+import Simaris from './models/Simaris.js';
+import DailyDeal from './models/DailyDeal.js';
+import DarkSector from './models/DarkSector.js';
+import Invasion from './models/Invasion.js';
+import FlashSale from './models/FlashSale.js';
+import GlobalUpgrade from './models/GlobalUpgrade.js';
+import Fissure from './models/Fissure.js';
+import SyndicateMission from './models/SyndicateMission.js';
+import Alert from './models/Alert.js';
+import WorldEvent from './models/WorldEvent.js';
+import News from './models/News.js';
+
+const { sortieData } = wsData;
 
 const safeArray = (arr) => arr || [];
 const safeObj = (obj) => obj || {};
@@ -49,44 +41,20 @@ const safeObj = (obj) => obj || {};
  * @type {Dependency}
  */
 const defaultDeps = {
-  News,
-  WorldEvent,
-  Alert,
-  Sortie,
-  SortieVariant,
-  SyndicateMission,
-  Fissure,
-  GlobalUpgrade,
-  FlashSale,
-  Invasion,
-  DarkSector,
-  DarkSectorBattle,
-  Mission,
-  Reward,
-  VoidTrader,
-  DailyDeal,
-  Simaris,
-  ConclaveChallenge,
-  PersistentEnemy,
-  WeeklyChallenge,
-  timeDate,
-  translator,
   sortieData,
-  mdConfig: new MarkdownSettings(),
   locale: 'en',
   logger: console,
-  DuviriChoice,
 };
 
 /**
  *
- * @param {Object} ParserClass class for parsing data
+ * @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[]}
+ * @returns {WorldstateObject[]} array of parsed objects
  */
-function parseArray(ParserClass, dataArray, deps, uniqueField) {
+export function parseArray(ParserClass, dataArray, deps, uniqueField) {
   const arr = (dataArray || []).map((d) => new ParserClass(d, deps));
   if (uniqueField) {
     const utemp = {};
@@ -106,7 +74,7 @@ function parseArray(ParserClass, dataArray, deps, uniqueField) {
 /**
  * Parses Warframe Worldstate JSON
  */
-module.exports = class WorldState {
+export default class WorldState {
   /**
    * Generates the worldstate json as a string into usable objects
    * @param {string} json The worldstate JSON string
@@ -135,7 +103,7 @@ module.exports = class WorldState {
      * @type {Array.<News>}
      */
     this.news = parseArray(
-      deps.News,
+      News,
       data.Events
         ? data.Events.filter((e) => typeof e.Messages.find((msg) => msg.LanguageCode === deps.locale) !== 'undefined')
         : [],
@@ -146,63 +114,61 @@ module.exports = class WorldState {
      * The current events
      * @type {Array.<WorldEvent>}
      */
-    this.events = parseArray(deps.WorldEvent, data.Goals, deps);
+    this.events = parseArray(WorldEvent, data.Goals, deps);
 
     /**
      * The current alerts
      * @type {Array.<Alert>}
      */
-    this.alerts = parseArray(deps.Alert, data.Alerts, deps);
+    this.alerts = parseArray(Alert, data.Alerts, deps);
 
     /**
      * The current sortie
      * @type {Sortie}
      */
-    [this.sortie] = parseArray(deps.Sortie, data.Sorties, deps);
+    [this.sortie] = parseArray(Sortie, data.Sorties, deps);
 
     /**
      * The current syndicate missions
      * @type {Array.<SyndicateMission>}
      */
-    this.syndicateMissions = parseArray(deps.SyndicateMission, data.SyndicateMissions, deps, 'syndicate');
+    this.syndicateMissions = parseArray(SyndicateMission, data.SyndicateMissions, deps, 'syndicate');
 
     /**
      * The current fissures: 'ActiveMissions' & 'VoidStorms'
      * @type {Array.<Fissure>}
      */
-    this.fissures = parseArray(deps.Fissure, data.ActiveMissions, deps).concat(
-      parseArray(deps.Fissure, data.VoidStorms, deps)
-    );
+    this.fissures = parseArray(Fissure, data.ActiveMissions, deps).concat(parseArray(Fissure, data.VoidStorms, deps));
 
     /**
      * The current global upgrades
      * @type {Array.<GlobalUpgrade>}
      */
-    this.globalUpgrades = parseArray(deps.GlobalUpgrade, data.GlobalUpgrades, deps);
+    this.globalUpgrades = parseArray(GlobalUpgrade, data.GlobalUpgrades, deps);
 
     /**
      * The current flash sales
      * @type {Array.<FlashSale>}
      */
-    this.flashSales = parseArray(deps.FlashSale, data.FlashSales, deps);
+    this.flashSales = parseArray(FlashSale, data.FlashSales, deps);
 
     /**
      * The current invasions
      * @type {Array.<Invasion>}
      */
-    this.invasions = parseArray(deps.Invasion, data.Invasions, deps);
+    this.invasions = parseArray(Invasion, data.Invasions, deps);
 
     /**
      * The state of the dark sectors
      * @type {Array.<DarkSector>}
      */
-    this.darkSectors = parseArray(deps.DarkSector, data.BadlandNodes, deps);
+    this.darkSectors = parseArray(DarkSector, data.BadlandNodes, deps);
 
     /**
      * The state of all Void Traders
      * @type {VoidTrader[]}
      */
-    this.voidTraders = parseArray(deps.VoidTrader, data.VoidTraders, deps).sort(
+    this.voidTraders = parseArray(VoidTrader, data.VoidTraders, deps).sort(
       (a, b) => Date.parse(a.activation) - Date.parse(b.activation)
     );
 
@@ -217,25 +183,25 @@ module.exports = class WorldState {
      * The current daily deals
      * @type {Array.<DailyDeal>}
      */
-    this.dailyDeals = parseArray(deps.DailyDeal, data.DailyDeals, deps);
+    this.dailyDeals = parseArray(DailyDeal, data.DailyDeals, deps);
 
     /**
      * The state of the sanctuary synthesis targets
      * @type {Simaris}
      */
-    this.simaris = new deps.Simaris(safeObj(data.LibraryInfo), deps);
+    this.simaris = new Simaris(safeObj(data.LibraryInfo), deps);
 
     /**
      * The current conclave challenges
      * @type {Array.<ConclaveChallenge>}
      */
-    this.conclaveChallenges = parseArray(deps.ConclaveChallenge, data.PVPChallengeInstances, deps);
+    this.conclaveChallenges = parseArray(ConclaveChallenge, data.PVPChallengeInstances, deps);
 
     /**
      * The currently active persistent enemies
      * @type {Array.<PersistentEnemy>}
      */
-    this.persistentEnemies = parseArray(deps.PersistentEnemy, data.PersistentEnemies, deps);
+    this.persistentEnemies = parseArray(PersistentEnemy, data.PersistentEnemies, deps);
 
     /**
      * The current earth cycle
@@ -244,7 +210,7 @@ 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 cetusBountyEnd = parseDate(cetusSynd.length > 0 ? cetusSynd[0].Expiry : { $date: 0 });
 
     /**
      * The current Cetus cycle
@@ -259,7 +225,7 @@ 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 });
+    const zarimanBountyEnd = parseDate(zarimanSynd.length > 0 ? zarimanSynd[0].Expiry : { $date: 0 });
 
     /**
      * The current Zariman cycle based off current time
@@ -271,7 +237,7 @@ module.exports = class WorldState {
      * Weekly challenges
      * @type {Array.<WeeklyChallenge>}
      */
-    this.weeklyChallenges = data.WeeklyChallenges ? new deps.WeeklyChallenge(data.WeeklyChallenges, deps) : [];
+    this.weeklyChallenges = data.WeeklyChallenges ? new WeeklyChallenge(data.WeeklyChallenges, deps) : [];
 
     const projectPCTwithOid = data.ProjectPct
       ? {
@@ -333,16 +299,16 @@ module.exports = class WorldState {
      */
     this.steelPath = new SteelPathOffering(deps);
 
-    [this.vaultTrader] = parseArray(deps.VoidTrader, data.PrimeVaultTraders, deps);
+    [this.vaultTrader] = parseArray(VoidTrader, data.PrimeVaultTraders, deps);
 
     /**
      * The current archon hunt
      * @type {Sortie}
      */
-    [this.archonHunt] = parseArray(deps.Sortie, data.LiteSorties, deps);
+    [this.archonHunt] = parseArray(Sortie, data.LiteSorties, deps);
 
-    deps.duviriChoices = parseArray(deps.DuviriChoice, data.EndlessXpChoices, deps);
+    deps.duviriChoices = parseArray(DuviriChoice, data.EndlessXpChoices, deps);
 
     this.duviriCycle = new DuviriCycle(deps);
   }
-};
+}

package/lib/models/Alert.js

@@ -1,49 +1,25 @@
-'use strict';
+import mdConfig from '../supporting/MarkdownSettings.js';
+import { fromNow, timeDeltaToString } from '../utilities/timeDate.js';
 
-const WorldstateObject = require('./WorldstateObject');
+import WorldstateObject from './WorldstateObject.js';
+import Mission from './Mission.js';
 
 /**
  * Represents an alert
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-class Alert extends WorldstateObject {
+export default class Alert extends WorldstateObject {
   /**
-   * @param   {Object}             data       The alert data
-   * @param   {MarkdownSettings}   mdConfig   The markdown settings
-   * @param   {Translator}         translator The string translator
-   * @param   {TimeDateFunctions}  timeDate   The time and date functions
-   * @param   {Mission}            Mission    The Mission parser
-   * @param   {Reward}             Reward     The Reward parser
+   * @param   {object}             data       The alert data
    * @param   {string}             locale     Locale to use for translations
    */
-  constructor(data, { mdConfig, translator, timeDate, Mission, Reward, locale }) {
-    super(data, { timeDate });
+  constructor(data, { locale = 'en' } = { locale: 'en' }) {
+    super(data);
 
     const deps = {
-      mdConfig,
-      translator,
-      timeDate,
-      Mission,
-      Reward,
       locale,
     };
 
-    /**
-     * The markdown settings
-     * @type {MarkdownSettings}
-     * @private
-     */
-    this.mdConfig = mdConfig;
-    Object.defineProperty(this, 'mdConfig', { enumerable: false, configurable: false });
-
-    /**
-     * The time and date functions
-     * @type {TimeDateFunctions}
-     * @private
-     */
-    this.timeDate = timeDate;
-    Object.defineProperty(this, 'timeDate', { enumerable: false, configurable: false });
-
     /**
      * The mission that the players have to complete
      * @type {Mission}
@@ -52,7 +28,7 @@ class Alert extends WorldstateObject {
 
     /**
      * ETA string (at time of object creation)
-     * @type {String}
+     * @type {string}
      */
     this.eta = this.getETAString();
 
@@ -64,14 +40,14 @@ class Alert extends WorldstateObject {
 
     /**
      * A tag that DE occasionally provides, such as `LotusGift`
-     * @type {String}
+     * @type {string}
      */
     this.tag = data.Tag || undefined;
   }
 
   /**
    * Get the alert's description text
-   * @returns {string}
+   * @returns {string} the description
    */
   getDescription() {
     return this.mission.description;
@@ -79,7 +55,7 @@ class Alert extends WorldstateObject {
 
   /**
    * Get the alert's reward
-   * @returns {Reward}
+   * @returns {Reward} the reward
    */
   getReward() {
     return this.mission.reward;
@@ -87,15 +63,15 @@ class Alert extends WorldstateObject {
 
   /**
    * Get a string indicating how much time is left before the alert expires
-   * @returns {string}
+   * @returns {string} the time left
    */
   getETAString() {
-    return this.timeDate.timeDeltaToString(this.timeDate.fromNow(this.expiry));
+    return timeDeltaToString(fromNow(this.expiry));
   }
 
   /**
    * Get an array containing the types of all of the alert's rewards
-   * @returns {Array.<string>}
+   * @returns {Array.<string>} an array containing the types of all of the alert's rewards
    */
   getRewardTypes() {
     return this.mission.reward.getTypes();
@@ -103,13 +79,11 @@ class Alert extends WorldstateObject {
 
   /**
    * The alert's string representation
-   * @returns {string}
+   * @returns {string} the string representation
    */
   toString() {
     const lines = [this.mission.toString(), this.getETAString()];
 
-    return `${this.mdConfig.codeMulti}${lines.join(this.mdConfig.lineEnd)}${this.mdConfig.blockEnd}`;
+    return `${mdConfig.codeBlock}${lines.join(mdConfig.lineEnd)}${mdConfig.blockEnd}`;
   }
 }
-
-module.exports = Alert;

package/lib/models/CambionCycle.js

@@ -1,20 +1,18 @@
-'use strict';
+import { fromNow } from '../utilities/timeDate.js';
 
-const WorldstateObject = require('./WorldstateObject');
+import WorldstateObject from './WorldstateObject.js';
 
 /**
  * Represents the current Cambion Drift Fass/Vome Cycle
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  * @property {string} timeLeft time rendering of amount of time left
  */
-class CambionCycle extends WorldstateObject {
+export default class CambionCycle extends WorldstateObject {
   /**
    * @param   {CetusCycle}        cetusCycle Match data from cetus cycle for data
-   * @param   {Object}            deps            The dependencies object
-   * @param   {TimeDateFunctions} deps.timeDate   The time and date functions
    */
-  constructor(cetusCycle, { timeDate }) {
-    super({ _id: { $oid: 'cambionCycle0' } }, { timeDate });
+  constructor(cetusCycle) {
+    super({ _id: { $oid: 'cambionCycle0' } });
 
     ({ activation: this.activation, expiry: this.expiry, timeLeft: this.timeLeft } = cetusCycle);
 
@@ -26,11 +24,9 @@ class CambionCycle extends WorldstateObject {
 
   /**
    * Get whether the event has expired
-   * @returns {boolean}
+   * @returns {boolean} whether the event has expired
    */
   getExpired() {
-    return this.timeDate.fromNow(this.expiry) < 0;
+    return fromNow(this.expiry) < 0;
   }
 }
-
-module.exports = CambionCycle;

package/lib/models/CetusCycle.js

@@ -1,6 +1,7 @@
-'use strict';
+import mdConfig from '../supporting/MarkdownSettings.js';
+import { fromNow, timeDeltaToString } from '../utilities/timeDate.js';
 
-const WorldstateObject = require('./WorldstateObject');
+import WorldstateObject from './WorldstateObject.js';
 
 const nightTime = 3000;
 
@@ -11,79 +12,60 @@ const maximums = {
 
 /**
  * Represents the current Earth Day/Night Cycle
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-class CetusCycle extends WorldstateObject {
+export default class CetusCycle extends WorldstateObject {
   /**
-   * @param   {Date}              bountiesEndDate The end date for Ostron bounties
-   * @param   {Object}            deps            The dependencies object
-   * @param   {MarkdownSettings}  deps.mdConfig   The markdown settings
-   * @param   {TimeDateFunctions} deps.timeDate   The time and date functions
+   * The end of the Ostron bounties timer (marks the end of night)
+   * @type {Date}
+   * @private
    */
-  constructor(bountiesEndDate, { mdConfig, timeDate }) {
-    super({ _id: { $oid: 'cetusCycle0' } }, { timeDate });
-
-    /**
-     * The markdown settings
-     * @type {MarkdownSettings}
-     * @private
-     */
-    this.mdConfig = mdConfig;
-    Object.defineProperty(this, 'mdConfig', { enumerable: false, configurable: false });
-
-    /**
-     * The end of the Ostron bounties timer (marks the end of night)
-     * @type {Date}
-     * @private
-     */
-    this.bountiesEndDate = bountiesEndDate;
-    Object.defineProperty(this, 'bountiesEndDate', { enumerable: false, configurable: false });
+  #bountiesEndDate;
+  /**
+   * The current cetus cycle, for calculating the other fields
+   * @type {object}
+   * @private
+   */
+  #ec;
 
-    /**
-     * The time and date functions
-     * @type {TimeDateFunctions}
-     * @private
-     */
-    this.timeDate = timeDate;
-    Object.defineProperty(this, 'timeDate', { enumerable: false, configurable: false });
+  /**
+   * @param   {Date}              bountiesEndDate The end date for Ostron bounties
+   */
+  constructor(bountiesEndDate) {
+    super({ _id: { $oid: 'cetusCycle0' } });
 
-    /**
-     * The current cetus cycle, for calculating the other fields
-     * @type {Object}
-     * @private
-     */
-    const ec = this.getCurrentCetusCycle();
-    Object.defineProperty(this, 'ec', { enumerable: false, configurable: false });
+    this.#bountiesEndDate = bountiesEndDate;
+    this.#ec = this.getCurrentCetusCycle();
 
     /**
      * The date and time at which the event ends
      * @type {Date}
      */
-    this.expiry = ec.expiry;
+    this.expiry = this.#ec.expiry;
 
     /**
      * The date and time at which the event started
      * @type {Date}
      */
-    this.activation = new Date(ec.start);
+    this.activation = new Date(this.#ec.start);
 
     /**
      * Whether it's daytime
      * @type {boolean}
      */
-    this.isDay = ec.dayTime;
+    this.isDay = this.#ec.dayTime;
 
     /**
      * Current cycle state. One of `day`, `night`
      * @type {string}
      */
-    this.state = ec.state;
+    this.state = this.#ec.state;
 
     /**
      * Time remaining string
      * @type {string}
      */
-    this.timeLeft = ec.timeLeft;
+    this.timeLeft = this.#ec.timeLeft;
 
     /**
      * Whether this is for Cetus Cycle
@@ -98,17 +80,17 @@ class CetusCycle extends WorldstateObject {
 
   /**
    * Get whether or not the event has expired
-   * @returns {boolean}
+   * @returns {boolean} whether the event has expired
    */
   getExpired() {
-    return this.timeDate.fromNow(this.expiry) < 0;
+    return fromNow(this.expiry) < 0;
   }
 
   getCurrentCetusCycle() {
     const now = Date.now();
-    const bountiesClone = this.bountiesEndDate;
+    const bountiesClone = this.#bountiesEndDate;
     bountiesClone.setSeconds(0);
-    let millisLeft = this.timeDate.fromNow(bountiesClone);
+    let millisLeft = fromNow(bountiesClone);
     const secondsToNightEnd = (millisLeft / 1000).toFixed(0);
     const dayTime = secondsToNightEnd > nightTime;
 
@@ -120,7 +102,7 @@ class CetusCycle extends WorldstateObject {
 
     return {
       dayTime,
-      timeLeft: this.timeDate.timeDeltaToString(millisLeft),
+      timeLeft: timeDeltaToString(millisLeft),
       expiry,
       expiresIn: millisLeft,
       state,
@@ -130,7 +112,7 @@ class CetusCycle extends WorldstateObject {
 
   /**
    * The event's string representation
-   * @returns {string}
+   * @returns {string} The string representation of the event
    */
   toString() {
     const lines = [
@@ -138,8 +120,6 @@ class CetusCycle extends WorldstateObject {
       `Time remaining until ${this.isDay ? 'night' : 'day'}: ${this.timeLeft}`,
     ];
 
-    return lines.join(this.mdConfig.lineEnd);
+    return lines.join(mdConfig.lineEnd);
   }
 }
-
-module.exports = CetusCycle;