warframe-worldstate-parser 2.31.1 → 3.0.0

package/lib/models/Kuva.js

@@ -1,8 +1,10 @@
-'use strict';
+import { createHash } from 'node:crypto';
+
+import { node, nodeMissionType } from '../utilities/translation.js';
 
 /**
  * External mission data retrieved from https://10o.io/kuvalog.json
- * @typedef {Object} ExternalMission
+ * @typedef {object} ExternalMission
  * @property {Date} activation start time
  * @property {Date} expiry end timer
  * @property {string} node formatted node name with planet
@@ -15,7 +17,7 @@
 
 /**
  * Stores and parses kuva data from https://10o.io/kuvalog.json
- * @typedef {Object} Kuva
+ * @typedef {object} Kuva
  * @property {ExternalMission[]} kuva currently active kuva missions
  * @property {ExternalMission} arbitration current arbitration
  */
@@ -24,7 +26,7 @@ const HOURS_2 = 7200000;
 
 /**
  * Truncate time for a semlar-provided mission
- * @param  {Object} mission parsed mission with re-aligned field names
+ * @param  {object} mission parsed mission with re-aligned field names
  */
 const truncateTime = (mission) => {
   mission.expiry.setHours(mission.activation.getHours() + 1);
@@ -36,7 +38,7 @@ const truncateTime = (mission) => {
 
 /**
  * Scrub unnecessary details from the mission
- * @param  {Object} mission parsed mission with re-aligned field names
+ * @param  {object} mission parsed mission with re-aligned field names
  */
 const scrub = (mission) => {
   /* eslint-disable no-param-reassign */
@@ -48,16 +50,15 @@ const scrub = (mission) => {
   /* eslint-enable no-param-reassign */
 };
 
-const hash = (str) => require('crypto').createHash('sha256').update(str, 'utf8').digest('hex');
+const hash = (str) => createHash('sha256').update(str, 'utf8').digest('hex');
 
 /**
  * Parse kuva & arbitration data
- * @param  {Object} data       Data to split for kuva/arbitration
- * @param  {Object.<function>} translator Translator functions
+ * @param  {object} data       Data to split for kuva/arbitration
  * @param  {string} locale     locale to translate
  * @returns {Kuva}           Split parsed data
  */
-const parse = (data, translator, locale) => {
+const parse = (data, locale) => {
   const parsed = { kuva: [], arbitration: {} };
   const now = new Date();
   data.forEach((mission) => {
@@ -65,10 +66,10 @@ const parse = (data, translator, locale) => {
       activation: new Date(mission.start),
       expiry: new Date(mission.end),
       ...mission.solnodedata,
-      node: translator.node(mission.solnode, locale),
-      nodeKey: translator.node(mission.solnode, 'en'),
-      type: translator.nodeMissionType(mission.solnode, locale),
-      typeKey: translator.nodeMissionType(mission.solnode, 'en'),
+      node: node(mission.solnode, locale),
+      nodeKey: node(mission.solnode, 'en'),
+      type: nodeMissionType(mission.solnode, locale),
+      typeKey: nodeMissionType(mission.solnode, 'en'),
     };
     truncateTime(p);
     p.id = hash(JSON.stringify(p));
@@ -98,30 +99,23 @@ const parse = (data, translator, locale) => {
  * @property {ExternalMission[]} kuva currently active kuva missions
  * @property {ExternalMission} arbitration current arbitration
  */
-module.exports = class Kuva {
-  constructor({ kuvaData, translator, locale, logger }) {
-    /**
-     * The translation functions
-     * @type {Translator}
-     * @private
-     */
-    this.translator = translator;
-    Object.defineProperty(this, 'translator', { enumerable: false, configurable: false });
+export default class Kuva {
+  #locale;
 
+  constructor({ kuvaData, locale, logger }) {
     /**
      * The locale to leverage for translations
      * @type {string}
      * @private
      */
-    this.locale = locale;
-    Object.defineProperty(this, 'locale', { enumerable: false, configurable: false });
+    this.#locale = locale;
 
     if (!kuvaData) {
       // eslint-ignore-next-line no-console
       logger.debug('No defined kuva data, skipping data');
     } else {
-      const parsed = parse(kuvaData, this.translator, this.locale);
+      const parsed = parse(kuvaData, this.locale);
       ({ kuva: this.kuva, arbitration: this.arbitration } = parsed);
     }
   }
-};
+}

package/lib/models/Mission.js

@@ -1,74 +1,64 @@
-'use strict';
+import mdConfig from '../supporting/MarkdownSettings.js';
+import { languageString, faction, missionType, node } from '../utilities/translation.js';
+import { insist } from '../utilities/integrity.js';
+
+import Reward from './Reward.js';
 
 /**
  * Represents an in-game mission
  */
-module.exports = class Mission {
+export default class Mission {
   /**
-   * @param   {Object}             data            The mission data
-   * @param   {Object}             deps            The dependencies object
-   * @param   {MarkdownSettings}   deps.mdConfig   The markdown settings
-   * @param   {Translator}         deps.translator The string translator
-   * @param   {Reward}             deps.Reward     The Reward parser
-   * @param   {string}             deps.locale     Locale to use for translations
+   * @param   {object}             data            The mission data
+   * @param   {string}             locale     Locale to use for translations
    */
-  constructor(data, { mdConfig, translator, Reward, locale }) {
+  constructor(data, { locale = 'en' } = { locale: 'en' }) {
     const deps = {
-      mdConfig,
-      translator,
-      Reward,
       locale,
     };
-
-    /**
-     * The markdown settings
-     * @type {MarkdownSettings}
-     * @private
-     */
-    this.mdConfig = mdConfig;
-    Object.defineProperty(this, 'mdConfig', { enumerable: false, configurable: false });
+    insist(data);
 
     /**
      * The mission's description
      * @type {?string}
      */
-    this.description = translator.languageString(data.descText, locale);
+    this.description = languageString(data.descText, locale);
 
     /**
      * The node where the mission takes place
      * @type {string}
      */
-    this.node = translator.node(data.location || data.node, locale);
+    this.node = node(data.location || data.node, locale);
 
     /**
      * Unlocalized {@link mission#node}
      * @type {string}
      */
-    this.nodeKey = translator.node(data.location || data.node, 'en');
+    this.nodeKey = node(data.location || data.node, 'en');
 
     /**
      * The mission's type
      * @type {string}
      */
-    this.type = translator.missionType(data.missionType, locale);
+    this.type = missionType(data.missionType, locale);
 
     /**
      * The mission's type
      * @type {string}
      */
-    this.typeKey = translator.missionType(data.missionType, 'en');
+    this.typeKey = missionType(data.missionType, 'en');
 
     /**
      * The factions that the players must fight in the mission
      * @type {string}
      */
-    this.faction = translator.faction(data.faction, locale);
+    this.faction = faction(data.faction, locale);
 
     /**
      * The factions that the players must fight in the mission
      * @type {string}
      */
-    this.factionKey = translator.faction(data.faction, 'en');
+    this.factionKey = faction(data.faction, 'en');
 
     /**
      * The mission's reward
@@ -116,25 +106,25 @@ module.exports = class Mission {
      * Override for the map on this mission
      * @type {string}
      */
-    this.levelOverride = translator.languageString(data.levelOverride, locale);
+    this.levelOverride = languageString(data.levelOverride, locale);
 
     /**
      * Enemy specification for the mission
-     * @type {String}
+     * @type {string}
      */
-    this.enemySpec = translator.languageString(data.enemySpec, locale);
+    this.enemySpec = languageString(data.enemySpec, locale);
 
     /**
      * Array of strings denoting extra spawners for a mission
      * @type {string[]}
      */
-    this.advancedSpawners = (data.advancedSpawners || []).map((spawner) => translator.languageString(spawner, locale));
+    this.advancedSpawners = (data.advancedSpawners || []).map((spawner) => languageString(spawner, locale));
 
     /**
      * Items required to enter the mission
      * @type {string[]}
      */
-    this.requiredItems = (data.requiredItems || []).map((reqItem) => translator.languageString(reqItem, locale));
+    this.requiredItems = (data.requiredItems || []).map((reqItem) => languageString(reqItem, locale));
 
     /**
      * Whether or not the required items are consumed
@@ -146,7 +136,7 @@ module.exports = class Mission {
      * Target for the mission
      * @type {string}
      */
-    this.target = translator.languageString(data.vipAgent, locale);
+    this.target = languageString(data.vipAgent, locale);
 
     /**
      * Whether or not leaders are always allowed
@@ -164,18 +154,18 @@ module.exports = class Mission {
      * Affectors for this mission
      * @type {string[]}
      */
-    this.levelAuras = (data.levelAuras || []).map((aura) => translator.languageString(aura, locale));
+    this.levelAuras = (data.levelAuras || []).map((aura) => languageString(aura, locale));
 
     /**
      * Only weapon allowed for the mission
      * @type {string}
      */
-    this.exclusiveWeapon = translator.languageString(data.exclusiveWeapon, locale);
+    this.exclusiveWeapon = languageString(data.exclusiveWeapon, locale);
   }
 
   /**
    * The Mission's string representation
-   * @returns {string}
+   * @returns {string} Mission's string representation
    */
   toString() {
     const lines = [this.reward.toString()];
@@ -184,6 +174,6 @@ module.exports = class Mission {
     lines.push(this.node);
     lines.push(`level ${this.minEnemyLevel} - ${this.maxEnemyLevel}`);
 
-    return lines.join(this.mdConfig.lineEnd);
+    return lines.join(mdConfig.lineEnd);
   }
-};
+}

package/lib/models/News.js

@@ -1,6 +1,8 @@
-'use strict';
+import mdConfig from '../supporting/MarkdownSettings.js';
+import { languageString } from '../utilities/translation.js';
+import { fromNow, parseDate, timeDeltaToString, toNow } from '../utilities/timeDate.js';
 
-const WorldstateObject = require('./WorldstateObject');
+import WorldstateObject from './WorldstateObject.js';
 
 const updateReg = /(update|hotfix)/i;
 const primeAccessReg = /(access)/i;
@@ -9,35 +11,15 @@ const langString = /(\/Lotus\/Language\/)/i;
 
 /**
  * Represents a game news item
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-class News extends WorldstateObject {
+export default class News extends WorldstateObject {
   /**
-   * @param   {Object}             data            The news data
-   * @param   {Dependency}         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   {locale}             deps.locale     Locale to use for determining language
+   * @param   {object}             data            The news data
+   * @param   {string}             locale     Locale to use for determining language
    */
-  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);
 
     /**
      * The news message
@@ -45,7 +27,7 @@ class News extends WorldstateObject {
      */
     this.message = (data.Messages.find((msg) => msg.LanguageCode === locale) || { Message: '' }).Message;
     if (langString.test(this.message)) {
-      this.message = translator.languageString(this.message, locale);
+      this.message = languageString(this.message, locale);
     }
 
     /**
@@ -76,34 +58,34 @@ class News extends WorldstateObject {
      * The date at which the post was published
      * @type {Date}
      */
-    this.date = timeDate.parseDate(data.Date);
+    this.date = parseDate(data.Date);
 
     /**
      * The date at which the event starts
      * @type {?Date}
      */
-    this.startDate = data.EventStartDate ? timeDate.parseDate(data.EventStartDate) : undefined;
+    this.startDate = data.EventStartDate ? parseDate(data.EventStartDate) : undefined;
 
     /**
      * The date at which the event ends
      * @type {?Date}
      */
-    this.endDate = data.EventEndDate ? timeDate.parseDate(data.EventEndDate) : undefined;
+    this.endDate = data.EventEndDate ? parseDate(data.EventEndDate) : undefined;
 
     /**
      * ETA string (at time of object creation)
-     * @type {String}
+     * @type {string}
      */
     this.eta = this.getETAString();
 
     /**
-     * Whther or not this is an update news item
+     * Whether this is an update news item
      * @type {boolean}
      */
     this.update = this.isUpdate();
 
     /**
-     * Whther or not this is a prime access news item
+     * Whether this is a prime access news item
      * @type {boolean}
      */
     this.primeAccess = this.isPrimeAccess();
@@ -116,14 +98,14 @@ class News extends WorldstateObject {
 
     /**
      * Translation of the news item
-     * @type {Object.<string, string>}
+     * @type {Record<string, string>}
      */
     this.translations = {};
     data.Messages.forEach((message) => {
-      this.translations[message.LanguageCode] = message.Message;
+      this.translations[message.LanguageCode ?? 'en'] = message.Message;
 
       if (langString.test(message.Message)) {
-        this.translations[message.LanguageCode] = translator.languageString(message.Message, message.LanguageCode);
+        this.translations[message.LanguageCode] = languageString(message.Message, message.LanguageCode);
       }
     });
 
@@ -137,36 +119,36 @@ class News extends WorldstateObject {
   /**
    * Get a string indicating how long it will take for the event to start or
    * how long it's been since the news went up
-   * @returns {string}
+   * @returns {string} the estimated time of arrival for the event
    */
   getETAString() {
     if (this.endDate) {
-      const timeDelta = this.timeDate.fromNow(this.endDate);
-      return `in ${this.timeDate.timeDeltaToString(timeDelta)}`;
+      const timeDelta = fromNow(this.endDate);
+      return `in ${timeDeltaToString(timeDelta)}`;
     }
-    const timeDelta = this.timeDate.toNow(this.date);
-    return `${this.timeDate.timeDeltaToString(timeDelta)} ago`;
+    const timeDelta = toNow(this.date);
+    return `${timeDeltaToString(timeDelta)} ago`;
   }
 
   /**
    * Whether or not this is about a game update
-   * @returns {boolean}
+   * @returns {boolean} whether the news is about an update
    */
   isUpdate() {
     return updateReg.test(this.link);
   }
 
   /**
-   * Whether or not this is about a new Prime Access
-   * @returns {boolean}
+   * Whether this is about a new Prime Access
+   * @returns {boolean} whether the news is about a new Prime Access
    */
   isPrimeAccess() {
     return primeAccessReg.test(this.link);
   }
 
   /**
-   * Whether or not this is about a new Prime Access
-   * @returns {boolean}
+   * Whether this is about a new stream
+   * @returns {boolean} whether the news is for a stream
    */
   isStream() {
     return streamReg.test(this.message);
@@ -174,23 +156,21 @@ class News extends WorldstateObject {
 
   /**
    * String representation
-   * @returns {string}
+   * @returns {string} string representation
    */
   toString() {
     return (
-      `[${this.getETAString()}] ${this.mdConfig.linkBegin}${this.message}` +
-      `${this.mdConfig.linkMid}${this.link}${this.mdConfig.linkEnd}`
+      `[${this.getETAString()}] ${mdConfig.linkBegin}${this.message}` +
+      `${mdConfig.linkMid}${this.link}${mdConfig.linkEnd}`
     );
   }
 
   /**
    * The title of the news item in the specified language
    * @param {string} langCode Ex. 'es', 'de', 'fr'
-   * @returns {string}
+   * @returns {string} The title of the news item in the specified language
    */
   getTitle(langCode) {
     return langCode in this.translations ? this.translations[langCode] : this.message;
   }
 }
-
-module.exports = News;

package/lib/models/Nightwave.js

@@ -1,56 +1,32 @@
-'use strict';
+import { languageString } from '../utilities/translation.js';
+import { fromNow, timeDeltaToString } from '../utilities/timeDate.js';
+import mdConfig from '../supporting/MarkdownSettings.js';
 
-const WorldstateObject = require('./WorldstateObject');
-const NightwaveChallenge = require('./NightwaveChallenge');
+import WorldstateObject from './WorldstateObject.js';
+import NightwaveChallenge from './NightwaveChallenge.js';
 
 /**
  * Represents an alert
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-class Nightwave extends WorldstateObject {
+export default class Nightwave extends WorldstateObject {
   /**
-   * @param   {Object}             data            The alert 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   {Reward}             deps.Reward     The Reward parser
+   * @param   {object}             data            The alert data
+   * @param   {object}             deps            The dependencies object
    * @param   {string}             deps.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);
 
     this.id = `nightwave${new Date(this.expiry).getTime()}`;
 
     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 current season. 0-indexed.
-     * @type {Number}
+     * @type {number}
      */
     this.season = data.Season;
 
@@ -58,17 +34,17 @@ class Nightwave extends WorldstateObject {
      * Descriptor for affiliation
      * @type {string}
      */
-    this.tag = translator.languageString(data.AffiliationTag, locale);
+    this.tag = languageString(data.AffiliationTag, locale);
 
     /**
      * The current season's current phase. 0-indexed.
-     * @type {Number}
+     * @type {number}
      */
     this.phase = data.Phase;
 
     /**
      * Misc params provided.
-     * @type {Object}
+     * @type {object}
      */
     this.params = JSON.parse(data.Params || '{}');
 
@@ -89,29 +65,27 @@ class Nightwave extends WorldstateObject {
 
   /**
    * Get a string indicating how much time is left before the alert expires
-   * @returns {string}
+   * @returns {string} estimated timer of the alert
    */
   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 nightwave season's rewards
-   * @returns {Array.<string>}
+   * @returns {Array.<string>} an array containing the types of all of the nightwave season's rewards
    */
-  // eslint-disable-next-line class-methods-use-this
   getRewardTypes() {
     return [];
   }
 
   /**
    * The alert's string representation
-   * @returns {string}
+   * @returns {string} string representation of the alert
    */
-  // eslint-disable-next-line class-methods-use-this
   toString() {
-    return '';
+    return `${mdConfig.codeBlock}Nightwave Season ${this.season + 1} - ${this.tag} - Phase ${this.phase + 1}${
+      mdConfig.blockEnd
+    }`;
   }
 }
-
-module.exports = Nightwave;

package/lib/models/NightwaveChallenge.js

@@ -1,33 +1,31 @@
-'use strict';
+import { languageDesc, languageString } from '../utilities/translation.js';
 
-const WorldstateObject = require('./WorldstateObject');
+import WorldstateObject from './WorldstateObject.js';
 
 const repBase = 1000;
 
 /**
  * Represents an alert
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-class NightwaveChallenge extends WorldstateObject {
+export default class NightwaveChallenge extends WorldstateObject {
   /**
-   * @param   {Object}             data            The alert data
-   * @param   {Object}             deps            The dependencies object
-   * @param   {Translator}         deps.translator The string translator
-   * @param   {TimeDateFunctions}  deps.timeDate   The time and date functions
+   * @param   {object}             data            The alert data
+   * @param   {object}             deps            The dependencies object
    * @param   {string}             deps.locale     Locale to use for translations
    */
-  constructor(data, { translator, timeDate, locale }) {
-    super(data, { timeDate });
+  constructor(data, { locale = 'en' } = { locale: 'en' }) {
+    super(data);
 
     /**
      * Whether or not this is a daily challenge
-     * @type {Boolean}
+     * @type {boolean}
      */
     this.isDaily = data.Daily || false;
 
     /**
      * Whether or not the challenge is an elite challenge
-     * @type {Boolean}
+     * @type {boolean}
      */
     this.isElite = /hard/gi.test(data.Challenge);
 
@@ -35,13 +33,13 @@ class NightwaveChallenge extends WorldstateObject {
      * The descriptor for this challenge
      * @type {string}
      */
-    this.desc = translator.languageDesc(data.Challenge, locale);
+    this.desc = languageDesc(data.Challenge, locale);
 
     /**
      * The title for this challenge
      * @type {string}
      */
-    this.title = translator.languageString(data.Challenge, locale);
+    this.title = languageString(data.Challenge, locale);
 
     /**
      * Generated id from expiry, challenge string,
@@ -52,10 +50,14 @@ class NightwaveChallenge extends WorldstateObject {
 
     /**
      * Reputation reward for ranking up in the Nightwave
-     * @type {Number}
+     * @type {number}
      */
     this.reputation = repBase + (!this.isDaily ? 3500 : 0) + (this.isElite ? 2500 : 0);
+
+    /**
+     * Whether this challenge is permanent
+     * @type {boolean}
+     */
+    this.isPermanent = Boolean(data?.Permanent);
   }
 }
-
-module.exports = NightwaveChallenge;