warframe-worldstate-parser 2.31.1 → 3.0.0

package/lib/models/PersistentEnemy.js

@@ -1,40 +1,33 @@
-'use strict';
+import { languageString, node, region } from '../utilities/translation.js';
+import { parseDate } from '../utilities/timeDate.js';
+import mdConfig from '../supporting/MarkdownSettings.js';
+
+import WorldstateObject from './WorldstateObject.js';
 
-const WorldstateObject = require('./WorldstateObject');
 /**
  * Represents a persistent enemy
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-class PersistentEnemy extends WorldstateObject {
+export default class PersistentEnemy extends WorldstateObject {
   /**
-   * @param   {Object}             data            The persistent enemy data
-   * @param   {Object}             deps            The dependencies object
-   * @param   {MarkdownSettings}   deps.mdConfig   The markdown settings
-   * @param   {Translator}         deps.translator The string translator
+   * @param   {object}             data            The persistent enemy 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 });
+  constructor(data, { locale = 'en' } = { locale: 'en' }) {
+    super(data);
 
     /**
      * The enemy's type
      * @type {string}
      */
-    this.agentType = translator.languageString(data.AgentType, locale);
+    this.agentType = languageString(data.AgentType, locale);
 
     /**
      * The location tag
      * @type {string}
      */
-    this.locationTag = translator.languageString(data.LocTag, locale);
+    this.locationTag = languageString(data.LocTag, locale);
 
     /**
      * The enemy's rank
@@ -43,7 +36,7 @@ class PersistentEnemy extends WorldstateObject {
     this.rank = data.Rank;
 
     /**
-     * The enemy's remainaing health percentage
+     * The enemy's remaining health percentage
      * @type {number}
      */
     this.healthPercent = Number.parseFloat(data.HealthPercent);
@@ -58,29 +51,29 @@ class PersistentEnemy extends WorldstateObject {
      * The region where the enemy is located
      * @type {string}
      */
-    this.region = translator.region(data.Region, locale);
+    this.region = region(data.Region, locale);
 
     /**
      * The last time the enemy was discovered
      * @type {Date}
      */
-    this.lastDiscoveredTime = timeDate.parseDate(data.LastDiscoveredTime);
+    this.lastDiscoveredTime = parseDate(data.LastDiscoveredTime);
 
     /**
      * The node at which the enemy was last discovered
      * @type {string}
      */
-    this.lastDiscoveredAt = translator.node(data.LastDiscoveredLocation, locale);
+    this.lastDiscoveredAt = node(data.LastDiscoveredLocation, locale);
 
     /**
      * Whether or not the enemy is currently available
-     * @type {Boolean}
+     * @type {boolean}
      */
     this.isDiscovered = data.Discovered;
 
     /**
      * Whether or not the enemy is using ticketing
-     * @type {Boolean}
+     * @type {boolean}
      */
     this.isUsingTicketing = data.UseTicketing;
 
@@ -93,7 +86,7 @@ class PersistentEnemy extends WorldstateObject {
 
   /**
    * Returns a string representation of the persistent enemy
-   * @returns {string}
+   * @returns {string} string representation
    */
   toString() {
     const status = this.isDiscovered ? 'discovered' : 'not discovered';
@@ -102,8 +95,6 @@ class PersistentEnemy extends WorldstateObject {
       `It has ${this.healthPercent}% health remaining and is currently ${status}`,
     ];
 
-    return lines.join(this.mdConfig.lineEnd);
+    return lines.join(mdConfig.lineEnd);
   }
 }
-
-module.exports = PersistentEnemy;

package/lib/models/Reward.js

@@ -1,11 +1,11 @@
-'use strict';
-
-const rewardTypes = require('../supporting/RewardTypes');
+import rewardTypes from '../supporting/RewardTypes.js';
+import { languageString } from '../utilities/translation.js';
+import { insist } from '../utilities/integrity.js';
 
 /**
  * An object describing a type of reward, including name, description,
  * test function to verify type from a string, thumbnail url, and color
- * @typedef {Object} RewardType
+ * @typedef {object} RewardType
  * @property {string} name          - Name of the reward type
  * @property {string} description   - Description of the reward type
  * @property {string} test          - Function for testing the return type against a string
@@ -19,7 +19,7 @@ const rewardTypes = require('../supporting/RewardTypes');
  * @param   {Array.<RewardType>}  [types] The possible types
  * @returns {string}          The type name
  */
-function getItemType(item, types = rewardTypes) {
+export function getItemType(item, types = rewardTypes) {
   return types.find((t) => t.test(item)).name;
 }
 
@@ -29,36 +29,36 @@ function getItemType(item, types = rewardTypes) {
  * @param   {Array.<RewardType>}  [types] The possible types
  * @returns {RewardType}      The type
  */
-function getItemTypeFull(item, types = rewardTypes) {
+export function getItemTypeFull(item, types = rewardTypes) {
   return types.find((t) => t.test(item));
 }
 
 /**
  * Represents a mission reward
  */
-class Reward {
+export default class Reward {
   /**
-   * @param   {Object} data                 The mission data
-   * @param   {Object}             deps            The dependencies object
-   * @param   {Translator}         deps.translator The string translator
+   * @param   {object} data        The mission data
+   * @param   {Dependency}         deps            The dependencies object
    * @param   {string}             deps.locale     Locale to use for translations
    */
-  constructor(data, { translator, locale }) {
+  constructor(data, { locale = 'en' } = { locale: 'en' }) {
+    insist(data);
     /**
      * The items being rewarded
      * @type {Array.<string>}
      */
-    this.items = data.items ? data.items.map((i) => translator.languageString(i), locale) : [];
+    this.items = data.items ? data.items.map((i) => languageString(i), locale) : [];
 
     /**
      * The counted items being rewarded
-     * @type {Array.<Object>}
+     * @type {Array.<object>}
      */
     this.countedItems = data.countedItems
       ? data.countedItems.map((i) => ({
           count: i.ItemCount,
-          type: translator.languageString(i.ItemType, locale),
-          key: translator.languageString(i.ItemType),
+          type: languageString(i.ItemType, locale),
+          key: languageString(i.ItemType),
         }))
       : [];
 
@@ -81,7 +81,7 @@ class Reward {
 
   /**
    * The types of all items that are being rewarded
-   * @returns {Array.<string>}
+   * @returns {Array.<string>} types as array of string
    */
   getTypes() {
     return this.items.concat(this.countedItems.map((i) => i.key)).map((t) => getItemType(t));
@@ -89,7 +89,7 @@ class Reward {
 
   /**
    * The types of all the items that are being rewarded
-   * @returns {Array.<RewardType>}
+   * @returns {Array.<RewardType>} array of reward types
    */
   getTypesFull() {
     return this.items.concat(this.countedItems.map((i) => i.key)).map((t) => getItemTypeFull(t));
@@ -97,7 +97,7 @@ class Reward {
 
   /**
    * The reward's string representation
-   * @returns {string}
+   * @returns {string} reward's string representation
    */
   toString() {
     const tokens = this.items.concat(this.countedItems.map((i) => `${i.count > 1 ? i.count : ''} ${i.type}`.trim()));
@@ -109,5 +109,3 @@ class Reward {
     return tokens.join(' + ');
   }
 }
-
-module.exports = Reward;

package/lib/models/SentientOutpost.js

@@ -1,4 +1,4 @@
-'use strict';
+import { node, nodeEnemy, nodeMissionType } from '../utilities/translation.js';
 
 const duration = 1800;
 
@@ -20,7 +20,7 @@ const sat = () => {
 
 /**
  * Mission typeDef
- * @typedef {Object} Mission
+ * @typedef {object} Mission
  * @property {string} node Mission node name
  * @property {string} enemy Node enemy
  * @property {string} type Mission type of the node
@@ -34,29 +34,30 @@ const sat = () => {
  * @property {boolean} active     Whether or not the mission is active
  * @property {Date}    activation When the mission became or becomes active
  * @property {Date}    expiry     When the mission became or becomes inactive
- * @property {Object}  previous   Estimation data for the last mission that was active.
+ * @property {object}  previous   Estimation data for the last mission that was active.
  *                                Could also be the current.
  * @property {Date}    previous.activation  When the mission became or becomes active
  * @property {Date}    previous.expiry     When the mission became or becomes inactive
  */
-class SentientOutpost {
-  constructor(data, { translator, locale, sentientData, logger }) {
+export default class SentientOutpost {
+  #node;
+  constructor(data, { locale, sentientData, logger }) {
     // eslint-disable-next-line no-param-reassign
     if (!data) data = '{"sfn":000}';
-    const node = (data.match(/\d{3}/g) || ['000'])[0];
+    [this.#node] = data.match(/\d{3}/g) || ['000'];
     const id = `CrewBattleNode${node}`;
     /* istanbul ignore if */
     if (node === '000') {
       this.mission = undefined;
     } else {
       this.mission = {
-        node: translator.node(id, locale),
-        faction: translator.nodeEnemy(id, locale),
-        type: translator.nodeMissionType(id, locale),
+        node: node(id, locale),
+        faction: nodeEnemy(id, locale),
+        type: nodeMissionType(id, locale),
       };
     }
     ({ activation: this.activation, expiry: this.expiry } = sat());
-    this.active = !!this.mission;
+    this.active = Boolean(this.mission);
     this.id = `${id}:${this.active}`;
 
     if (!sentientData) {
@@ -67,5 +68,3 @@ class SentientOutpost {
     }
   }
 }
-
-module.exports = SentientOutpost;

package/lib/models/Simaris.js

@@ -1,39 +1,29 @@
-'use strict';
+import { languageString } from '../utilities/translation.js';
 
 /**
  * Contains information about sanctuary targets
  */
-class Simaris {
+export default class Simaris {
   /**
-   * @param   {Object}             data            The sanctuary data
-   * @param   {Object}             deps            The dependencies object
-   * @param   {MarkdownSettings}   deps.mdConfig   The markdown settings
-   * @param   {Translator}         deps.translator The string translator
+   * @param   {object}             data            The sanctuary data
+   * @param   {object}             deps            The dependencies object
    * @param   {string}             deps.locale     Locale to use for translations
    */
-  constructor(data, { mdConfig, translator, locale }) {
-    if (!data) {
+  constructor(data, { locale = 'en' } = { locale: 'en' }) {
+    if (!data || !Object.keys(data).length) {
       // eslint-disable-next-line no-param-reassign
       data = {};
     }
 
-    /**
-     * The markdown settings
-     * @type {MarkdownSettings}
-     * @private
-     */
-    this.mdConfig = mdConfig;
-    Object.defineProperty(this, 'mdConfig', { enumerable: false, configurable: false });
-
     /**
      * The sanctuary target
      * @type {string}
      */
-    this.target = translator.languageString(data.LastCompletedTargetType, locale) || 'N/A';
+    this.target = languageString(data.LastCompletedTargetType, locale) || 'N/A';
 
     /**
      * Whether or not the target is currently active
-     * @type {Boolean}
+     * @type {boolean}
      */
     this.isTargetActive = !data.LastCompletedTargetType;
 
@@ -46,7 +36,7 @@ class Simaris {
 
   /**
    * Returns a string representation of the current sanctuary status
-   * @returns {string}
+   * @returns {string} a string representation of the current sanctuary status
    */
   toString() {
     return (
@@ -55,5 +45,3 @@ class Simaris {
     );
   }
 }
-
-module.exports = Simaris;

package/lib/models/Sortie.js

@@ -1,93 +1,77 @@
-'use strict';
+import wsData from 'warframe-worldstate-data';
 
-const WorldstateObject = require('./WorldstateObject');
+import mdConfig from '../supporting/MarkdownSettings.js';
+import { fromNow, parseDate, timeDeltaToString } from '../utilities/timeDate.js';
+import { languageString, sortieBoss, sortieFaction } from '../utilities/translation.js';
+
+import WorldstateObject from './WorldstateObject.js';
+import SortieVariant from './SortieVariant.js';
+import Mission from './Mission.js';
+
+const { sortie: sortieData } = wsData;
 
 /**
  * Represents a daily sortie
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-class Sortie extends WorldstateObject {
+export default class Sortie extends WorldstateObject {
   /**
-   * @param   {Object}            data               The data for all daily sorties
-   * @param   {Object}            deps               The dependencies object
-   * @param   {MarkdownSettings}  mdConfig      The markdown settings
-   * @param   {Translator}        translator    The string translator
-   * @param   {TimeDateFunctions} timeDate      The time and date functions
-   * @param   {Object}            sortieData    The data used to parse sorties
-   * @param   {SortieVariant}     SortieVariant The sortie variant parser
-   * @param   {string}            locale        Locale to use for translations
+   * @param   {object}            data               The data for all daily sorties
+   * @param   {object}            deps               The dependencies object
+   * @param {string} deps.locale Locale to use for translations
    */
-  constructor(data, { mdConfig, translator, timeDate, sortieData, SortieVariant, locale, Mission }) {
-    super(data, { timeDate });
+  constructor(data, { locale = 'en' } = { locale: 'en' }) {
+    super(data);
 
     const opts = {
       mdConfig,
-      translator,
-      timeDate,
       sortieData,
-      SortieVariant,
       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 date and time at which the sortie starts
      * @type {Date}
      */
-    this.activation = timeDate.parseDate(data.Activation);
+    this.activation = parseDate(data.Activation);
 
     /**
      * The date and time at which the sortie ends
      * @type {Date}
      */
-    this.expiry = timeDate.parseDate(data.Expiry);
+    this.expiry = parseDate(data.Expiry);
 
     /**
      * The sortie's reward pool
      * @type {string}
      */
-    this.rewardPool = translator.languageString(data.Reward, locale);
+    this.rewardPool = languageString(data.Reward, locale);
 
     /**
      * The sortie's variants
      * @type {Array.<SortieVariant>}
      */
-    this.variants = (data.Variants || []).map((v) => new SortieVariant(v, opts));
+    this.variants = (data.Variants ?? []).map((v) => new SortieVariant(v, opts));
 
-    this.missions = (data.Missions || []).map((v) => new Mission(v, opts));
+    this.missions = (data.Missions ?? []).map((v) => new Mission(v, opts));
 
     /**
      * The sortie's boss
      * @type {string}
      */
-    this.boss = translator.sortieBoss(data.Boss, locale);
+    this.boss = sortieBoss(data.Boss, locale);
 
     /**
      * The sortie's faction
      * @type {string}
      */
-    this.faction = translator.sortieFaction(data.Boss, locale);
+    this.faction = sortieFaction(data.Boss, locale);
 
     /**
      * The sortie's faction
      * @type {string}
      */
-    this.factionKey = translator.sortieFaction(data.boss, 'en');
+    this.factionKey = sortieFaction(data.Boss, 'en');
 
     /**
      * Whether this is expired (at time of object creation)
@@ -97,14 +81,14 @@ class Sortie extends WorldstateObject {
 
     /**
      * ETA string (at time of object creation)
-     * @type {String}
+     * @type {string}
      */
     this.eta = this.getETAString();
   }
 
   /**
    * Get the sortie's boss
-   * @returns {string}
+   * @returns {string} the sortie's boss
    */
   getBoss() {
     return this.boss;
@@ -112,7 +96,7 @@ class Sortie extends WorldstateObject {
 
   /**
    * Get the sortie's faction
-   * @returns {string}
+   * @returns {string} the sortie's faction
    */
   getFaction() {
     return this.faction;
@@ -120,36 +104,34 @@ class Sortie extends WorldstateObject {
 
   /**
    * Gets a string indicating how long it will take for the sortie to end
-   * @returns {string}
+   * @returns {string} estimated time of arrival
    */
   getETAString() {
-    return this.timeDate.timeDeltaToString(this.timeDate.fromNow(this.expiry));
+    return timeDeltaToString(fromNow(this.expiry));
   }
 
   /**
    * Get whether or not the sortie has expired
-   * @returns {boolean}
+   * @returns {boolean} whether the sortie has expired
    */
   isExpired() {
-    return this.timeDate.fromNow(this.expiry) < 0;
+    return fromNow(this.expiry) < 0;
   }
 
   /**
    * Returns the sortie's string representation
-   * @returns {string}
+   * @returns {string} the string representation
    */
   toString() {
     if (this.isExpired()) {
-      return `${this.mdConfig.codeMulti}There's currently no sortie${this.mdConfig.lineEnd}${this.mdConfig.blockEnd}`;
+      return `${mdConfig.codeBlock}There's currently no sortie${mdConfig.blockEnd}`;
     }
 
     const variantString = this.variants.map((v) => v.toString()).join('');
 
     return (
-      `${this.mdConfig.codeMulti}${this.getBoss()}: ends in ${this.getETAString()}` +
-      `${this.mdConfig.doubleReturn}${variantString}${this.mdConfig.blockEnd}`
+      `${mdConfig.codeBlock}${this.getBoss()}: ends in ${this.getETAString()}` +
+      `${mdConfig.doubleReturn}${variantString}${mdConfig.blockEnd}`
     );
   }
 }
-
-module.exports = Sortie;

package/lib/models/SortieVariant.js

@@ -1,59 +1,57 @@
-'use strict';
+import { missionType, node, sortieModDesc, sortieModifier } from '../utilities/translation.js';
+import mdConfig from '../supporting/MarkdownSettings.js';
+import { insist } from '../utilities/integrity.js';
 
 /**
  * Represents a sortie variant
+ * @class
  */
-class SortieVariant {
+export default class SortieVariant {
   /**
-   * @param   {Object}            data               Sortie variant data
-   * @param   {MarkdownSettings}  mdConfig      The markdown settings
-   * @param   {Translator}        translator    The string translator
-   * @param   {Object}            sortieData    The data used to parse sorties
-   * @param   {string}            locale        Locale to use for translations
+   * Make the SortieVariant
+   * @class
+   * @param {object} data Sortie variant data
+   * @param {object} deps Dependencies
+   * @param {string} deps.locale Locale to use for translations
    */
-  constructor(data, { mdConfig, translator, locale }) {
-    /**
-     * The markdown settings
-     * @type {MarkdownSettings}
-     * @private
-     */
-    this.mdConfig = mdConfig;
-    Object.defineProperty(this, 'mdConfig', { enumerable: false, configurable: false });
-
+  constructor(data, { locale = 'en' } = { locale: 'en' }) {
+    insist(data);
     /**
      * The variant's mission type
      * @type {string}
      */
-    this.missionType = translator.missionType(data.missionType, locale);
+    this.missionType = missionType(data.missionType, locale);
+
+    this.missionTypeKey = missionType(data.missionType, 'en');
 
     /**
      * The variant's modifier
      * @type {string}
      */
-    this.modifier = translator.sortieModifier(data.modifierType, locale);
+    this.modifier = sortieModifier(data.modifierType, locale);
 
     /**
      * The variant's modifier description
      * @type {string}
      */
-    this.modifierDescription = translator.sortieModDesc(data.modifierType, locale);
+    this.modifierDescription = sortieModDesc(data.modifierType, locale);
 
     /**
      * The node where the variant takes place
      * @type {string}
      */
-    this.node = translator.node(data.node, locale);
+    this.node = node(data.node, locale);
+
+    this.nodeKey = node(data.node, 'en');
   }
 
   /**
    * Returns a string representation of the sortie variant
-   * @returns {string}
+   * @returns {string} string representation
    */
   toString() {
     return this.modifier
-      ? `${this.node.padEnd(25, ' ')} |  ${this.modifier.padEnd(20, ' ')} | ${this.missionType}${this.mdConfig.lineEnd}`
-      : `${this.node.padEnd(25, ' ')} | ${this.missionType}${this.mdConfig.lineEnd}`;
+      ? `${this.node.padEnd(25, ' ')} |  ${this.modifier.padEnd(20, ' ')} | ${this.missionType}${mdConfig.lineEnd}`
+      : `${this.node.padEnd(25, ' ')} | ${this.missionType}${mdConfig.lineEnd}`;
   }
 }
-
-module.exports = SortieVariant;