warframe-worldstate-parser 2.32.0 → 3.0.0

package/lib/models/ChallengeInstance.js

@@ -1,45 +1,44 @@
-'use strict';
+import { languageString } from '../utilities/translation.js';
 
 /**
  * Describes a world challenge instance
  */
-class ChallengeInstance {
+export default class ChallengeInstance {
   /**
-   * @param   {Object}             data            The challenge instance data
+   * @param   {object}             data            The challenge instance data
    * @param   {Dependency}         deps            The dependencies object
-   * @param   {Translator}         deps.translator The string translator
    * @param   {string}             deps.locale     Locale to use for translations
    */
-  constructor(data, { translator, locale }) {
+  constructor(data, { locale = 'en' } = { locale: 'en' }) {
     /**
      * Type of challenge
      * @type {string}
      */
-    this.type = translator.languageString(data.Type, locale);
+    this.type = languageString(data.Type, locale);
 
     /**
      * Minimum enemy level to fulfill challenge
-     * @type {Number}
+     * @type {number}
      */
     this.minEnemyLevel = Number(data.MinimumEnemyLevel);
 
     /**
      * Required number of units to complete challenge
-     * @type {Number}
+     * @type {number}
      */
     this.requiredAmount = Number(data.RequiredCount);
 
     /**
      * Waypoint for amount of units between progression updates
-     * @type {Number}
+     * @type {number}
      */
     this.progressAmount = Number(data.ProgressIndicatorFreq);
 
     /**
      * Required damage type
-     * @type {String|undefined}
+     * @type {string | undefined}
      */
-    this.damageType = data.DamageType ? translator.languageString(data.DamageType, locale) : undefined;
+    this.damageType = data.DamageType ? languageString(data.DamageType, locale) : undefined;
 
     /**
      * Target to fulfill challenge
@@ -47,7 +46,7 @@ class ChallengeInstance {
      */
     this.target =
       data.VictimType && data.VictimType[0]
-        ? translator.languageString(data.VictimType[0], locale)
+        ? languageString(data.VictimType[0], locale)
         : // eslint-disable-next-line no-underscore-dangle
           data.Script._faction;
   }
@@ -56,5 +55,3 @@ class ChallengeInstance {
     return `Task: ${this.type}\nAmount: ${this.requiredAmount}\nTarget: ${this.target}`;
   }
 }
-
-module.exports = ChallengeInstance;

package/lib/models/ConclaveChallenge.js

@@ -1,50 +1,32 @@
-'use strict';
+import { parseDate, fromNow, timeDeltaToString } from '../utilities/timeDate.js';
+import { conclaveMode, conclaveCategory, conclaveChallenge } from '../utilities/translation.js';
 
-const WorldstateObject = require('./WorldstateObject');
+import WorldstateObject from './WorldstateObject.js';
 
 /**
  * Represents a Conclave challenge
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-class ConclaveChallenge extends WorldstateObject {
+export default class ConclaveChallenge extends WorldstateObject {
   /**
-   * @param   {Object}             data            The challenge 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 challenge 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 });
-
-    /**
-     * 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);
 
     /**
      * The time and date at which the challenge expires
      * @type {Date}
      */
-    this.expiry = timeDate.parseDate(data.endDate);
+    this.expiry = parseDate(data.endDate);
 
     /**
      * The time and date at which the challenge starts
      * @type {Date}
      */
-    this.activation = timeDate.parseDate(data.startDate);
+    this.activation = parseDate(data.startDate);
 
     /**
      * The number of times that the challenge's objective needs to be completed
@@ -56,17 +38,17 @@ class ConclaveChallenge extends WorldstateObject {
      * The PVP mode that the challenge must be completed in
      * @type {string}
      */
-    this.mode = translator.conclaveMode(data.PVPMode, locale);
+    this.mode = conclaveMode(data.PVPMode, locale);
 
     /**
      * The challenge's category (daily, weekly...)
      * @type {string}
      */
-    this.category = translator.conclaveCategory(data.Category, locale);
+    this.category = conclaveCategory(data.Category, locale);
 
     /**
      * ETA string (at time of object creation)
-     * @type {String}
+     * @type {string}
      */
     this.eta = this.getEndString();
 
@@ -108,11 +90,11 @@ class ConclaveChallenge extends WorldstateObject {
 
     /**
      * Standing granted by completing challenge.
-     * @type {Number}
+     * @type {number}
      */
     this.standing = undefined;
 
-    const challenge = translator.conclaveChallenge(data.challengeTypeRefID, locale);
+    const challenge = conclaveChallenge(data.challengeTypeRefID, locale);
 
     ({ title: this.title, description: this.description, standing: this.standing } = challenge);
 
@@ -125,7 +107,7 @@ class ConclaveChallenge extends WorldstateObject {
 
   /**
    * Get whether or not the challenge is daily
-   * @returns {boolean}
+   * @returns {boolean} whether the category is daily
    */
   isDaily() {
     return this.category.toLowerCase() === 'day';
@@ -133,7 +115,7 @@ class ConclaveChallenge extends WorldstateObject {
 
   /**
    * Get whether or not this is the weekly root challenge
-   * @returns {boolean}
+   * @returns {boolean} whether this is the root challenge
    */
   isRootChallenge() {
     return this.category.toLowerCase() === 'week_root';
@@ -141,28 +123,26 @@ class ConclaveChallenge extends WorldstateObject {
 
   /**
    * Get whether or not the challenge has expired
-   * @returns {boolean}
+   * @returns {boolean} Whether or not the challenge has expired
    */
   isExpired() {
-    return this.timeDate.fromNow(this.expiry) < 0;
+    return fromNow(this.expiry) < 0;
   }
 
   /**
    * Get a string indicating how much time is left before the challenge expires
-   * @returns {string}
+   * @returns {string} The time left before the challenge expires
    */
   getEndString() {
-    const timeDelta = this.timeDate.fromNow(this.expiry);
-    return this.timeDate.timeDeltaToString(timeDelta);
+    const timeDelta = fromNow(this.expiry);
+    return timeDeltaToString(timeDelta);
   }
 
   /**
    * The conclave challenge's string representation
-   * @returns {string}
+   * @returns {string} The string representation of the conclave challenge
    */
   toString() {
     return `${this.description} on ${this.mode} ${this.amount} times in a ${this.category}`;
   }
 }
-
-module.exports = ConclaveChallenge;

package/lib/models/ConstructionProgress.js

@@ -1,27 +1,17 @@
-'use strict';
+import mdConfig from '../supporting/MarkdownSettings.js';
 
-const WorldstateObject = require('./WorldstateObject');
+import WorldstateObject from './WorldstateObject.js';
 
 /**
  * Represents enemy construction progress
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-class ConstructionProgress extends WorldstateObject {
+export default class ConstructionProgress extends WorldstateObject {
   /**
-   * @param   {Object}             data            The construction data
-   * @param   {Object}             deps            The dependencies object
-   * @param   {MarkdownSettings}   deps.mdConfig   The markdown settings
+   * @param   {object}             data            The construction data
    */
-  constructor(data, { mdConfig, timeDate }) {
-    super(data, { timeDate });
-
-    /**
-     * The markdown settings
-     * @type {MarkdownSettings}
-     * @private
-     */
-    this.mdConfig = mdConfig;
-    Object.defineProperty(this, 'mdConfig', { enumerable: false, configurable: false });
+  constructor(data) {
+    super(data);
 
     this.fomorianProgress = (data.ProjectPct[0] || 0.0).toFixed(2);
     this.razorbackProgress = (data.ProjectPct[1] || 0.0).toFixed(2);
@@ -30,14 +20,12 @@ class ConstructionProgress extends WorldstateObject {
 
   /**
    * The alert's string representation
-   * @returns {string}
+   * @returns {string} string representation
    */
   toString() {
     return (
-      `${this.mdConfig.codeMulti}Fomorian: ${this.fomorianProgress}%${this.mdConfig.lineEnd}Razorback: ` +
-      `${this.razorbackProgress}%${this.mdConfig.lineEnd}Unknown: ${this.unknownProgress}%${this.mdConfig.blockEnd}`
+      `${mdConfig.codeBlock}Fomorian: ${this.fomorianProgress}%${mdConfig.lineEnd}Razorback: ` +
+      `${this.razorbackProgress}%${mdConfig.lineEnd}Unknown: ${this.unknownProgress}%${mdConfig.blockEnd}`
     );
   }
 }
-
-module.exports = ConstructionProgress;

package/lib/models/DailyDeal.js

@@ -1,39 +1,22 @@
-'use strict';
+import mdConfig from '../supporting/MarkdownSettings.js';
+import { languageString } from '../utilities/translation.js';
+import { parseDate, timeDeltaToString, fromNow } from '../utilities/timeDate.js';
 
 /**
  * Represents a daily deal
  */
-class DailyDeal {
+export default class DailyDeal {
   /**
-   * @param   {Object}            data            The deal 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 deal data
+   * @param   {object}            deps            The dependencies object
    * @param   {string}            deps.locale     Locale to use for translations
    */
-  constructor(data, { 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 });
-
+  constructor(data, { locale = 'en' } = { locale: 'en' }) {
     /**
      * The item that is being offered in the sale
      * @type {string}
      */
-    this.item = translator.languageString(data.StoreItem, locale);
+    this.item = languageString(data.StoreItem, locale);
 
     /**
      * The uniqueName for the item on sale.
@@ -45,13 +28,13 @@ class DailyDeal {
      * The date and time at which the deal will expire
      * @type {Date}
      */
-    this.expiry = timeDate.parseDate(data.Expiry);
+    this.expiry = parseDate(data.Expiry);
 
     /**
      * The date and time at which the deal will or did start
      * @type {Date}
      */
-    this.activation = timeDate.parseDate(data.Activation);
+    this.activation = parseDate(data.Activation);
 
     /**
      * The item's original price
@@ -85,7 +68,7 @@ class DailyDeal {
 
     /**
      * ETA string (at time of object creation)
-     * @type {String}
+     * @type {string}
      */
     this.eta = this.getETAString();
 
@@ -98,15 +81,15 @@ class DailyDeal {
 
   /**
    * Get a string indicating how much time is left before the deal expires
-   * @returns {string}
+   * @returns {string} estimated time remaining on the deal
    */
   getETAString() {
-    return this.timeDate.timeDeltaToString(this.timeDate.fromNow(this.expiry));
+    return timeDeltaToString(fromNow(this.expiry));
   }
 
   /**
    * Returns a string representation of the daily deal
-   * @returns {string}
+   * @returns {string} The string representation of the daily deal
    */
   toString() {
     const lines = [
@@ -115,8 +98,6 @@ class DailyDeal {
       `${this.sold} / ${this.total} sold`,
       `Expires in ${this.getETAString()}`,
     ];
-    return lines.join(this.mdConfig.lineEnd);
+    return lines.join(mdConfig.lineEnd);
   }
 }
-
-module.exports = DailyDeal;

package/lib/models/DarkSector.js

@@ -1,33 +1,24 @@
-'use strict';
+import { parseDate } from '../utilities/timeDate.js';
+import { languageString } from '../utilities/translation.js';
 
-const WorldstateObject = require('./WorldstateObject');
+import WorldstateObject from './WorldstateObject.js';
+import Mission from './Mission.js';
+import DarkSectorBattle from './DarkSectorBattle.js';
 
 /**
  * Represents a dark sector
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-class DarkSector extends WorldstateObject {
+export default class DarkSector extends WorldstateObject {
   /**
-   * @param   {Object}             data                  The dark sector 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   {Mission}            deps.Mission          The mission parser
-   * @param   {DarkSectorBattle}   deps.DarkSectorBattle The dark sector battle parser
-   * @param   {Reward}             deps.Reward           The reward parser
+   * @param   {object}             data                  The dark sector data
+   * @param   {object}             deps                  The dependencies object
    * @param   {string}             deps.locale           Locale to use for translations
    */
-  constructor(data, { mdConfig, translator, timeDate, Mission, DarkSectorBattle, Reward, locale }) {
-    super(data, { timeDate });
+  constructor(data, { locale = 'en' } = { locale: 'en' }) {
+    super(data);
 
     const deps = {
-      translator,
-      Mission,
-      DarkSectorBattle,
-      mdConfig,
-      Reward,
-      timeDate,
       locale,
     };
 
@@ -57,7 +48,7 @@ class DarkSector extends WorldstateObject {
 
     /**
      * Whether the dark sector holder is an alliance or not
-     * @type {Boolean}
+     * @type {boolean}
      */
     this.isAlliance = data.DefenderInfo.IsAlliance;
 
@@ -84,14 +75,14 @@ class DarkSector extends WorldstateObject {
      * @type {Date}
      */
     this.defenderDeployemntActivation = data.DefenderInfo.DeploymentActivationTime
-      ? timeDate.parseDate(data.DefenderInfo.DeploymentActivationTime)
+      ? parseDate(data.DefenderInfo.DeploymentActivationTime)
       : 0;
 
     /**
      * The solar rail type
      * @type {string}
      */
-    this.railType = translator.languageString(data.DefenderInfo.RailType, locale);
+    this.railType = languageString(data.DefenderInfo.RailType, locale);
 
     /**
      * The MOTD set by the dark sector holder
@@ -162,5 +153,3 @@ class DarkSector extends WorldstateObject {
     this.history = data.History ? data.History.map((b) => new DarkSectorBattle(b, deps)) : [];
   }
 }
-
-module.exports = DarkSector;

package/lib/models/DarkSectorBattle.js

@@ -1,13 +1,13 @@
-'use strict';
+import { parseDate } from '../utilities/timeDate.js';
 
 /**
  * Represents a battle over a dark sector
  */
-class DarkSectorBattle {
+export default class DarkSectorBattle {
   /**
-   * @param   {Object} data The battle data
+   * @param   {object} data The battle data
    */
-  constructor(data, { timeDate }) {
+  constructor(data) {
     /**
      * The defenders of the dark sector
      * @type {string}
@@ -45,14 +45,12 @@ class DarkSectorBattle {
      * The date and time at which the battle started
      * @type {Date}
      */
-    this.start = timeDate.parseDate(data.Start);
+    this.start = parseDate(data.Start);
 
     /**
      * The date and time at which the battle ended
      * @type {Date}
      */
-    this.end = timeDate.parseDate(data.End);
+    this.end = parseDate(data.End);
   }
 }
-
-module.exports = DarkSectorBattle;

package/lib/models/DuviriCycle.js

@@ -1,6 +1,7 @@
-'use strict';
+import { toTitleCase } from '../utilities/translation.js';
+import { timeDeltaToString } from '../utilities/timeDate.js';
 
-const WorldstateObject = require('./WorldstateObject');
+import WorldstateObject from './WorldstateObject.js';
 
 const cycleTime = 36000;
 const stateTime = 7200;
@@ -27,11 +28,11 @@ const getStageInfo = () => {
 
 /**
  * @typedef {WorldstateObject} DuviriCycle
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-class DuviriCycle extends WorldstateObject {
-  constructor({ timeDate, translator, duviriChoices }) {
-    super({ _id: { $oid: 'duviriCycle0' } }, { timeDate, translator });
+export default class DuviriCycle extends WorldstateObject {
+  constructor({ duviriChoices }) {
+    super({ _id: { $oid: 'duviriCycle0' } });
     const { activation, expiry, state } = getStageInfo();
 
     /**
@@ -58,10 +59,8 @@ class DuviriCycle extends WorldstateObject {
   }
 
   toString() {
-    return `${this.translator.toTitleCase(this.state)} spiral. ${this.translator.toTitleCase(
+    return `${toTitleCase(this.state)} spiral. ${toTitleCase(
       states[(states.indexOf(this.state) + 1) % 5]
-    )} in ${this.timeDate.timeDeltaToString(new Date(this.expiry).getTime() - Date.now())}`;
+    )} in ${timeDeltaToString(new Date(this.expiry).getTime() - Date.now())}`;
   }
 }
-
-module.exports = DuviriCycle;

package/lib/models/EarthCycle.js

@@ -1,7 +1,24 @@
-'use strict';
+import { fromNow } from '../utilities/timeDate.js';
+import mdConfig from '../supporting/MarkdownSettings.js';
 
-const WorldstateObject = require('./WorldstateObject');
+import WorldstateObject from './WorldstateObject.js';
 
+/**
+ * @typedef {object} EarthCycle
+ * @property {Date} expiry The date and time at which the event ends
+ * @property {Date} activation The date and time at which the event started
+ * @property {boolean} isDay Whether or not this it's daytime
+ * @property {string} state Current cycle state. One of `day`, `night`
+ * @property {string} timeLeft Time remaining string
+ * @property {Date} rounded The date and time at which the event ends, rounded to the nearest minute
+ * @property {Date} start The date and time at which the event started, 4 hours before the end
+ * @property {boolean} expired Whether or not the event has expired
+ */
+
+/**
+ * Get the current Earth Day/Night Cycle
+ * @returns {EarthCycle} The current Earth Day/Night Cycle
+ */
 function getCurrentEarthCycle() {
   const now = Date.now();
   const cycleSeconds = Math.floor(now / 1000) % 28800; // One cycle = 8 hours = 28800 seconds
@@ -38,80 +55,64 @@ function getCurrentEarthCycle() {
 
 /**
  * Represents the current Earth Day/Night Cycle
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-class EarthCycle extends WorldstateObject {
-  /**
-   * @param   {Object}            data            The event data
-   * @param   {Object}            deps            The dependencies object
-   * @param   {MarkdownSettings}  deps.mdConfig   The markdown settings
-   */
-  constructor({ mdConfig, timeDate }) {
-    super({ _id: { $oid: 'earthCycle0' } }, { timeDate });
-
-    const ec = getCurrentEarthCycle();
-
-    /**
-     * The markdown settings
-     * @type {MarkdownSettings}
-     * @private
-     */
-    this.mdConfig = mdConfig;
-    Object.defineProperty(this, 'mdConfig', { enumerable: false, configurable: false });
+export default class EarthCycle extends WorldstateObject {
+  #ec = getCurrentEarthCycle();
+  constructor() {
+    super({ _id: { $oid: 'earthCycle0' } });
 
     /**
      * 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 = ec.start;
+    this.activation = this.#ec.start;
 
     /**
      * Whether or not this 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;
 
-    this.id = `earthCycle${ec.rounded.getTime()}`;
+    this.id = `earthCycle${this.#ec.rounded.getTime()}`;
   }
 
   /**
    * Get whether or not the event has expired
-   * @returns {boolean}
+   * @returns {boolean} Whether or not the 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 string representation of the event
    */
   toString() {
     const lines = [
-      `Operator, Earth is currently in ${this.dayTime ? 'Day' : 'Night'}time`,
-      `Time remaining until ${this.dayTime ? 'night' : 'day'}: ${this.timeLeft}`,
+      `Operator, Earth is currently in ${this.isDay ? 'Day' : 'Night'}time`,
+      `Time remaining until ${this.isDay ? 'night' : 'day'}: ${this.timeLeft}`,
     ];
 
-    return lines.join(this.mdConfig.lineEnd);
+    return lines.join(mdConfig.lineEnd);
   }
 }
-
-module.exports = EarthCycle;