warframe-worldstate-parser 2.31.1 → 3.0.0

package/lib/models/SteelPathOffering.js

@@ -1,7 +1,12 @@
-'use strict';
+import { steelPath } from '../utilities/translation.js';
+import { timeDeltaToString } from '../utilities/timeDate.js';
 
 const monday = 1;
 
+/**
+ * Gets the first day of the week
+ * @returns {Date} first day of the week
+ */
 function getFirstDayOfWeek() {
   const resultDate = new Date();
   /* istanbul ignore next */
@@ -14,6 +19,10 @@ function getFirstDayOfWeek() {
   return resultDate;
 }
 
+/**
+ * Get the last day of the week
+ * @returns {Date} last day of the week
+ */
 function getLastDayOfWeek() {
   const last = new Date(getFirstDayOfWeek());
   last.setUTCDate(last.getUTCDate() + 6);
@@ -24,6 +33,10 @@ function getLastDayOfWeek() {
   return last;
 }
 
+/**
+ * When was the start of the day
+ * @returns {Date} start of the day
+ */
 function getStartOfDay() {
   const today = new Date();
   today.setUTCHours(0);
@@ -33,6 +46,10 @@ function getStartOfDay() {
   return today;
 }
 
+/**
+ * When was the end of the day
+ * @returns {Date} end of the day
+ */
 function getEndOfDay() {
   const last = new Date();
   last.setUTCHours(23);
@@ -48,28 +65,28 @@ function getEndOfDay() {
  */
 const start = new Date('2020-11-16T00:00:00.000Z');
 
-module.exports = class SteelPathOffering {
-  constructor({ timeDate, translator, locale }) {
+export default class SteelPathOffering {
+  constructor({ locale }) {
     const sSinceStart = (Date.now() - start.getTime()) / 1000;
     const eightWeeks = 4838400;
     const sevenDays = 604800;
 
     const ind = Math.floor((sSinceStart % eightWeeks) / sevenDays);
 
-    this.currentReward = translator.steelPath(locale).rotation[ind];
+    this.currentReward = steelPath(locale).rotation[ind];
 
     this.activation = getFirstDayOfWeek();
 
     this.expiry = getLastDayOfWeek();
 
-    this.remaining = timeDate.timeDeltaToString(this.expiry.getTime() - Date.now());
+    this.remaining = timeDeltaToString(this.expiry.getTime() - Date.now());
 
-    this.rotation = translator.steelPath(locale).rotation;
-    this.evergreens = translator.steelPath(locale).evergreen;
+    this.rotation = steelPath(locale).rotation;
+    this.evergreens = steelPath(locale).evergreen;
 
     /**
      * General data pertaining to incursions
-     * @type {Object}
+     * @type {object}
      * @property {string} id Identifier for steel path incursion based on start of day.
      * @property {Date} activation when the current incursions became active
      * @property {Date} expiry when the current incursions become inactive
@@ -80,4 +97,4 @@ module.exports = class SteelPathOffering {
       expiry: getEndOfDay(),
     };
   }
-};
+}

package/lib/models/SyndicateJob.js

@@ -1,8 +1,6 @@
-'use strict';
+import { languageString } from '../utilities/translation.js';
 
-const fetch = require('node-fetch');
-
-const WorldstateObject = require('./WorldstateObject');
+import WorldstateObject from './WorldstateObject.js';
 
 const apiBase = process.env.API_BASE_URL || 'https://api.warframestat.us';
 const bountyRewardRegex = /(?:Tier([ABCDE])|Narmer)Table([ABC])Rewards/i;
@@ -10,7 +8,7 @@ const ghoulRewardRegex = /GhoulBountyTable([AB])Rewards/i;
 
 /**
  * Determine the level string for the bounty
- * @param  {Object} job Original raw job data
+ * @param  {object} job Original raw job data
  * @returns {string}               level range string
  */
 const getLevelString = (job) => `${job.minEnemyLevel} - ${job.maxEnemyLevel}`;
@@ -82,32 +80,27 @@ const FIFTY_MINUTES = 3000000;
 
 /**
  * Represents a syndicate daily mission
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-class SyndicateJob extends WorldstateObject {
+export default class SyndicateJob extends WorldstateObject {
   /**
-   * @param {Object} data The syndicate mission data
+   * @param {object} data The syndicate mission data
    * @param {Date} expiry The syndicate job expiration
-   * @param {Object} deps The dependencies object
-   * @param {Object} timeDate Time/Date functions
-   * @param {Translator} translator The string translator
-   * @param {string} locale Locale to use for translations
+   * @param {object} deps The dependencies object
+   * @param {string} deps.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()}`,
-        },
+  constructor(data, expiry, { locale = 'en' }) {
+    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>}
+     * @type {Array.<string>}
      */
     this.rewardPool = [];
     getBountyRewards(data.rewards, data.isVault, data).then((rewards) => {
@@ -118,10 +111,9 @@ class SyndicateJob extends WorldstateObject {
 
     /**
      * The type of job this is
-     * @type {String}
+     * @type {string}
      */
-    this.type =
-      translator.languageString(data.jobType, locale) || `${data.isVault ? 'Isolation Vault' : ''} ${chamber}`;
+    this.type = languageString(data.jobType, locale) || `${data.isVault ? 'Isolation Vault' : ''} ${chamber}`;
 
     /**
      * Array of enemy levels
@@ -137,14 +129,14 @@ class SyndicateJob extends WorldstateObject {
 
     /**
      * Minimum mastery required to participate
-     * @type {Number}
+     * @type {number}
      */
     this.minMR = data.masteryReq || 0;
 
     /**
      * Whether or not this is a Vault job.
      * No indication for difference of normal vs arcana vaults.
-     * @type {Boolean}
+     * @type {boolean}
      */
     this.isVault = data.isVault;
 
@@ -176,5 +168,3 @@ class SyndicateJob extends WorldstateObject {
     }
   }
 }
-
-module.exports = SyndicateJob;

package/lib/models/SyndicateMission.js

@@ -1,84 +1,56 @@
-'use strict';
+import { node, syndicate } from '../utilities/translation.js';
+import { fromNow, parseDate, timeDeltaToString } from '../utilities/timeDate.js';
+import mdConfig from '../supporting/MarkdownSettings.js';
 
-const WorldstateObject = require('./WorldstateObject');
-const SyndicateJob = require('./SyndicateJob');
+import SyndicateJob from './SyndicateJob.js';
+import WorldstateObject from './WorldstateObject.js';
 
 /**
  * Represents a syndicate daily mission
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-class SyndicateMission extends WorldstateObject {
+export default class SyndicateMission extends WorldstateObject {
   /**
-   * @param   {Object}             data            The syndicate mission data
-   * @param   {Object}             deps            The dependencies object
-   * @param   {MarkdownSettings}   deps.mdConfig   The markdown settings
-   * @param   {Translator}         deps.translator The string translator
-   * @param   {TimeDateFunctions}  deps.timeDate   The time and date functions
+   * @param   {object}             data            The syndicate mission data
+   * @param   {object}             deps            The dependencies object
    * @param   {string}             deps.locale     Locale to use for translations
    */
-  constructor(data, { mdConfig, translator, timeDate, locale }) {
-    super(data, { timeDate });
+  constructor(data, { locale = 'en' } = { locale: 'en' }) {
+    super(data);
 
     const deps = {
-      mdConfig,
-      translator,
-      timeDate,
       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 translation functions
-     * @type {Translator}
-     * @private
-     */
-    this.translator = translator;
-    Object.defineProperty(this, 'translator', { enumerable: false, configurable: false });
-
     /**
      * The date and time at which the syndicate mission starts
      * @type {Date}
      */
-    this.activation = timeDate.parseDate(data.Activation);
+    this.activation = parseDate(data.Activation);
 
     /**
      * The date and time at which the syndicate mission ends
      * @type {Date}
      */
-    this.expiry = timeDate.parseDate(data.Expiry);
+    this.expiry = parseDate(data.Expiry);
 
     /**
      * The syndicate that is offering the mission
      * @type {string}
      */
-    this.syndicate = translator.syndicate(data.Tag, locale);
+    this.syndicate = syndicate(data.Tag, locale);
 
     /**
      * The syndicate that is offering the mission
      * @type {string}
      */
-    this.syndicateKey = translator.syndicate(data.Tag, 'en');
+    this.syndicateKey = syndicate(data.Tag, 'en');
 
     /**
      * The nodes on which the missions are taking place
      * @type {Array.<string>}
      */
-    this.nodes = data.Nodes.map((n) => translator.node(n), locale);
+    this.nodes = data.Nodes.map((n) => node(n), locale);
 
     /**
      * The jobs for this syndicate. Will normally be []
@@ -94,31 +66,29 @@ class SyndicateMission extends WorldstateObject {
 
     /**
      * ETA string (at time of object creation)
-     * @type {String}
+     * @type {string} time delta string from now to the expiry
      */
     this.eta = this.getETAString();
   }
 
   /**
    * Get a string indicating how much time is left before the syndicate mission expries
-   * @returns {string}
+   * @returns {string} time delta string from now to the expiry
    */
   getETAString() {
-    return this.timeDate.timeDeltaToString(this.timeDate.fromNow(this.expiry));
+    return timeDeltaToString(fromNow(this.expiry));
   }
 
   /**
    * Returns a string representation of the syndicate mission
-   * @returns {string}
+   * @returns {string} the string representation
    */
   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}`;
+      const missions = this.nodes.map((n) => `  \u2022${n.toString()}`).join(mdConfig.lineEnd);
+      return `[${this.getETAString()}] ${this.syndicate} currently has missions on:${mdConfig.lineEnd}${missions}`;
     }
 
     return `No missions available for ${this.syndicate}`;
   }
 }
-
-module.exports = SyndicateMission;

package/lib/models/VallisCycle.js

@@ -1,12 +1,26 @@
-'use strict';
+import { fromNow, timeDeltaToString } from '../utilities/timeDate.js';
+import mdConfig from '../supporting/MarkdownSettings.js';
 
-const WorldstateObject = require('./WorldstateObject');
+import WorldstateObject from './WorldstateObject.js';
 
 const lStart = new Date('November 10, 2018 08:13:48 UTC');
 const loopTime = 1600000;
 const warmTime = 400000;
 const coldTime = loopTime - warmTime;
 
+/**
+ * @typedef {object} CurrentCycle
+ * @property {string} state - Current cycle state. One of `warm`, `cold`
+ * @property {number} toNextMinor - Time remaining in the current cycle state
+ * @property {number} toNextFull - Time remaining until the next cycle
+ * @property {Date} timeAtPrevious - Date and time at which the event started
+ * @property {Date} timeAtNext - Date and time at which the event start
+ */
+
+/**
+ * Get the current cycle state for Orb Vallis
+ * @returns {CurrentCycle} current cycle state
+ */
 function getCurrentCycle() {
   const sinceLast = (Date.now() - lStart) % loopTime;
   const toNextFull = loopTime - sinceLast;
@@ -36,88 +50,68 @@ function getCurrentCycle() {
 
 /**
  * Represents the current Earth Day/Night Cycle
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-class VallisCycle extends WorldstateObject {
+export default class VallisCycle 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 current cetus cycle, for calculating the other fields
+   * @property {string} state - Current cycle state. One of `warm`, `cold`
+   * @property {number} toNextMinor - Time remaining in the current cycle state
+   * @property {number} toNextFull - Time remaining until the next cycle
+   * @property {Date} timeAtPrevious - Date and time at which the event started
+   * @private
    */
-  constructor({ mdConfig, timeDate }) {
-    super({ _id: { $oid: 'vallisCycle0' } }, { timeDate });
-
-    /**
-     * The markdown settings
-     * @type {MarkdownSettings}
-     * @private
-     */
-    this.mdConfig = mdConfig;
-    Object.defineProperty(this, 'mdConfig', { enumerable: false, configurable: false });
+  #ec = getCurrentCycle();
 
-    /**
-     * The time and date functions
-     * @type {TimeDateFunctions}
-     * @private
-     */
-    this.timeDate = timeDate;
-    Object.defineProperty(this, 'timeDate', { enumerable: false, configurable: false });
-
-    /**
-     * The current cetus cycle, for calculating the other fields
-     * @type {Object}
-     * @private
-     */
-    const ec = getCurrentCycle();
-    Object.defineProperty(this, 'ec', { enumerable: false, configurable: false });
+  constructor() {
+    super({ _id: { $oid: 'vallisCycle0' } });
 
     /**
      * The date and time at which the event ends
      * @type {Date}
      */
-    this.expiry = ec.timeAtNext;
+    this.expiry = this.#ec.timeAtNext;
 
     /**
      * Whether or not this it's daytime
      * @type {boolean}
      */
-    this.isWarm = ec.state === 'warm';
+    this.isWarm = this.#ec.state === 'warm';
 
     /**
      * Current cycle state. One of `warm`, `cold`
      * @type {string}
      */
-    this.state = ec.state;
+    this.state = this.#ec.state;
 
     /**
      * Date and time at which the event started
      * @type {Date}
      */
-    this.activation = ec.timeAtPrevious;
+    this.activation = this.#ec.timeAtPrevious;
 
     /**
      * Time remaining string
      * @type {string}
      */
-    this.timeLeft = timeDate.timeDeltaToString(ec.toNextMinor);
+    this.timeLeft = timeDeltaToString(this.#ec.toNextMinor);
 
-    this.id = `vallisCycle${ec.timeAtPrevious.getTime()}`;
+    this.id = `vallisCycle${this.#ec.timeAtPrevious.getTime()}`;
 
     this.shortString = `${this.timeLeft.replace(/\s\d*s/gi, '')} to ${this.isWarm ? 'Cold' : 'Warm'}`;
   }
 
   /**
    * Get whether or not the event has expired
-   * @returns {boolean}
+   * @returns {boolean} whether this event has expired
    */
   getExpired() {
-    return this.timeDate.fromNow(this.expiry) < 0;
+    return fromNow(this.expiry) < 0;
   }
 
   /**
    * The event's string representation
-   * @returns {string}
+   * @returns {string} the event's string representation
    */
   toString() {
     const lines = [
@@ -125,8 +119,6 @@ class VallisCycle extends WorldstateObject {
       `Time remaining until ${this.isWarm ? 'Cold' : 'Warm'}: ${this.timeLeft}`,
     ];
 
-    return lines.join(this.mdConfig.lineEnd);
+    return lines.join(mdConfig.lineEnd);
   }
 }
-
-module.exports = VallisCycle;

package/lib/models/VoidTrader.js

@@ -1,52 +1,37 @@
-'use strict';
+import { fromNow, parseDate, timeDeltaToString } from '../utilities/timeDate.js';
+import { node } from '../utilities/translation.js';
+import { insist } from '../utilities/integrity.js';
+import mdConfig from '../supporting/MarkdownSettings.js';
 
-const WorldstateObject = require('./WorldstateObject');
-const VoidTraderItem = require('./VoidTraderItem');
-const VoidTraderSchedule = require('./VoidTraderSchedule');
+import WorldstateObject from './WorldstateObject.js';
+import VoidTraderItem from './VoidTraderItem.js';
+import VoidTraderSchedule from './VoidTraderSchedule.js';
 
 /**
  * Represents a void trader
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-class VoidTrader extends WorldstateObject {
+export default class VoidTrader extends WorldstateObject {
   /**
-   * @param   {Object}             data            The Void trader data
-   * @param   {Object}             deps            The dependencies object
-   * @param   {MarkdownSettings}   deps.mdConfig   The markdown settings
-   * @param   {Translator}         deps.translator The string translator
-   * @param   {TimeDateFunctions}  deps.timeDate   The time and date functions
+   * @param   {object}             data            The Void trader data
+   * @param   {object}             deps            The dependencies object
    * @param   {string}             deps.locale     Locale to use for translations
    */
-  constructor(data, { mdConfig, translator, timeDate, locale }) {
-    super(data, { timeDate });
-
-    /**
-     * 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 });
+  constructor(data, { locale = 'en' } = { locale: 'en' }) {
+    super(data);
+    insist(data, 'Activation', 'Expiry');
 
     /**
      * The date and time at which the void trader arrives
      * @type {Date}
      */
-    this.activation = this.timeDate.parseDate(data.Activation);
+    this.activation = parseDate(data.Activation);
 
     /**
      * The date and time at which the void trader leaves
      * @type {Date}
      */
-    this.expiry = this.timeDate.parseDate(data.Expiry);
+    this.expiry = parseDate(data.Expiry);
 
     /**
      * The void trader's name
@@ -58,13 +43,13 @@ class VoidTrader extends WorldstateObject {
      * The node at which the Void Trader appears
      * @type {string}
      */
-    this.location = translator.node(data.Node, locale);
+    this.location = node(data.Node, locale);
 
     /**
      * 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, { locale })) : [];
 
     /**
      * Pseudo Identifier for identifying changes in inventory
@@ -92,63 +77,59 @@ class VoidTrader extends WorldstateObject {
      */
     this.endString = this.getEndString();
 
-    this.initialStart = timeDate.parseDate(data.InitialStartDate);
+    this.initialStart = parseDate(data.InitialStartDate);
     this.completed = data.Completed;
-    this.schedule = data.ScheduleInfo
-      ? data.ScheduleInfo.map((i) => new VoidTraderSchedule(i, { timeDate, translator, locale }))
-      : [];
+    this.schedule = data.ScheduleInfo ? data.ScheduleInfo.map((i) => new VoidTraderSchedule(i, { locale })) : [];
   }
 
   /**
    * Get whether or not the trader is currently active
-   * @returns {boolean}
+   * @returns {boolean} whether the trader is active
    */
   isActive() {
-    return this.timeDate.fromNow(this.activation) < 0 && this.timeDate.fromNow(this.expiry) > 0;
+    return fromNow(this.activation) < 0 && fromNow(this.expiry) > 0;
   }
 
   /**
    * Get a string indicating how long it will take for the trader to arrive
-   * @returns {string}
+   * @returns {string} time delta string from now to the start
    */
   getStartString() {
-    return this.timeDate.timeDeltaToString(this.timeDate.fromNow(this.activation));
+    return timeDeltaToString(fromNow(this.activation));
   }
 
   /**
    * Get a string indicating how long it will take for the trader to leave
-   * @returns {string}
+   * @returns {string} time delta string from now to the end
    */
   getEndString() {
-    return this.timeDate.timeDeltaToString(this.timeDate.fromNow(this.expiry));
+    return timeDeltaToString(fromNow(this.expiry));
   }
 
   /**
    * Returns a string representation of the trader
-   * @returns {string}
+   * @returns {string} string representation
    */
   toString() {
     if (!this.isActive()) {
-      const timeDelta = this.timeDate.fromNow(this.activation);
-      const nextArrivalTime = this.timeDate.timeDeltaToString(timeDelta);
+      const timeDelta = fromNow(this.activation);
+      const nextArrivalTime = timeDeltaToString(timeDelta);
       return (
-        `${this.mdConfig.codeMulti}${this.character} is not here yet, he will arrive in ` +
-        `${nextArrivalTime} at ${this.location}${this.mdConfig.blockEnd}`
+        `${mdConfig.codeBlock}${this.character} is not here yet, he will arrive in ` +
+        `${nextArrivalTime} at ${this.location}${mdConfig.blockEnd}`
       );
     }
 
     const inventoryString = this.inventory
       .map((i) => `  ${i.item} - ${i.ducats} ducats + ${i.credits}cr%s`)
-      .join(this.mdConfig.lineEnd);
+      .join(mdConfig.lineEnd);
 
     const lines = [
-      `${this.mdConfig.codeMulti}Void Trader at ${this.location}`,
+      `${mdConfig.codeBlock}Void Trader at ${this.location}`,
       inventoryString,
-      `Trader departing in ${this.getEndString()}${this.mdConfig.blockEnd}`,
+      `Trader departing in ${this.getEndString()}${mdConfig.blockEnd}`,
     ];
 
-    return lines.join(this.mdConfig.lineEnd);
+    return lines.join(mdConfig.lineEnd);
   }
 }
-
-module.exports = VoidTrader;

package/lib/models/VoidTraderItem.js

@@ -1,4 +1,4 @@
-'use strict';
+import { languageString } from '../utilities/translation.js';
 
 /**
  * A void trader inventory item
@@ -6,22 +6,19 @@
  * @property {number|string} ducats Ducat cost of the item
  * @property {number|string} credits Credit cost of the item
  */
-class VoidTraderItem {
+export default class VoidTraderItem {
   /**
-   * @param   {Object}             data            The void trader item data
+   * @param   {object}             data            The void trader item data
    * @param   {string}             data.ItemType   Worldstate Item i18n path
    * @param   {string}             data.PrimePrice Ducat cost of the item
    * @param   {string}             data.RegularPrice Credit price of the item
    * @param   {Dependency}         deps            The dependencies object
-   * @param   {Translator}         deps.translator The string translator
    * @param   {string}             deps.locale     Locale to use for translations
    */
-  constructor({ ItemType, PrimePrice, RegularPrice }, { translator, locale }) {
+  constructor({ ItemType, PrimePrice, RegularPrice }, { locale = 'en' } = { locale: 'en' }) {
     this.uniqueName = ItemType;
-    this.item = translator.languageString(ItemType, locale);
+    this.item = languageString(ItemType, locale);
     this.ducats = Number.parseInt(PrimePrice, 10);
     this.credits = Number.parseInt(RegularPrice, 10);
   }
 }
-
-module.exports = VoidTraderItem;