warframe-worldstate-parser 2.31.1 → 3.0.0

package/lib/supporting/ExternalMission.js

@@ -1,8 +1,6 @@
-'use strict';
-
 /**
  * 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
@@ -12,6 +10,4 @@
  * @property {boolean} sharkwing whether or not the tile requires
  *    sumbersible archwing
  */
-class ExternalMission {}
-
-module.exports = ExternalMission;
+export default class ExternalMission {}

package/lib/supporting/MarkdownSettings.js

@@ -1,5 +1,3 @@
-'use strict';
-
 /**
  * A collection of strings that are used by the parser to produce markdown-formatted text
  * @property {string} lineEnd      - Line return character
@@ -15,20 +13,18 @@
  * @property {string} codeLine     - String for denoting in-line code
  * @property {string} codeBlock    - String for denoting multi-line code blocks
  */
-module.exports = class MarkdownSettings {
-  constructor() {
-    this.lineEnd = '\n';
-    this.blockEnd = '\n```';
-    this.doubleReturn = '\n\n';
-    this.linkBegin = '[';
-    this.linkMid = '](';
-    this.linkEnd = ')';
-    this.bold = '**';
-    this.italic = '*';
-    this.underline = '__';
-    this.strike = '~~';
-    this.codeLine = '`';
-    this.codeBlock = '```';
-    this.spoiler = '||';
-  }
-};
+export default class MarkdownSettings {
+  static lineEnd = '\n';
+  static blockEnd = '\n```';
+  static doubleReturn = '\n\n';
+  static linkBegin = '[';
+  static linkMid = '](';
+  static linkEnd = ')';
+  static bold = '**';
+  static italic = '*';
+  static underline = '__';
+  static strike = '~~';
+  static codeLine = '`';
+  static codeBlock = '```';
+  static spoiler = '||';
+}

package/lib/supporting/RewardData.js

@@ -1,6 +1,4 @@
-'use strict';
-
-const resources = [
+export const resources = [
   'Alloy Plate',
   'Argon Crystal',
   'Circuits',
@@ -22,7 +20,7 @@ const resources = [
 ];
 
 // Aura names
-const auras = [
+export const auras = [
   'Brief Respite',
   'Corrosive Projection',
   'Dead Eye',
@@ -50,7 +48,7 @@ const auras = [
 ];
 
 // Nightmare mod names
-const nightmare = [
+export const nightmare = [
   'Accelerated Blast',
   'Animal Instinct',
   'Armored Agility',
@@ -72,7 +70,7 @@ const nightmare = [
   'Vigor',
 ];
 
-module.exports = {
+export default {
   nightmare,
   auras,
   resources,

package/lib/supporting/RewardTypes.js

@@ -1,12 +1,10 @@
-'use strict';
-
-const { auras, nightmare, resources } = require('./RewardData');
+import { auras, nightmare, resources } from './RewardData.js';
 
 /**
  * All possible RewardTypes
  * @type {Array.<RewardType>}
  */
-module.exports = [
+export default [
   {
     name: 'vauban',
     description: 'Vauban parts',

package/lib/utilities/integrity.js

@@ -0,0 +1,11 @@
+// eslint-disable-next-line import/prefer-default-export
+export const insist = (thing, ...args) => {
+  if (!thing || !Object.keys(thing).length) {
+    throw new TypeError(`The provided data does not have the required properties.`);
+  }
+  args.forEach((arg) => {
+    if (!thing[arg]) {
+      throw new TypeError(`The provided data does not have the required properties.`);
+    }
+  });
+};

package/lib/utilities/timeDate.js

@@ -1,5 +1,3 @@
-'use strict';
-
 const epochZero = {
   $date: {
     $numberLong: 0,
@@ -8,9 +6,9 @@ const epochZero = {
 
 /**
  * @param   {number} millis The number of milliseconds in the time delta
- * @returns {string}
+ * @returns {string} formatted time delta
  */
-function timeDeltaToString(millis) {
+export function timeDeltaToString(millis) {
   if (typeof millis !== 'number') {
     throw new TypeError('millis should be a number');
   }
@@ -43,29 +41,29 @@ function timeDeltaToString(millis) {
 /**
  * Returns the number of milliseconds between now and a given date
  * @param   {Date} d         The date from which the current time will be subtracted
- * @param   {function} [now] A function that returns the current UNIX time in milliseconds
- * @returns {number}
+ * @param   {Function} [now] A function that returns the current UNIX time in milliseconds
+ * @returns {number}       The number of milliseconds after the given date to now
  */
-function fromNow(d, now = Date.now) {
+export function fromNow(d, now = Date.now) {
   return d.getTime() - now();
 }
 
 /**
  * Returns the number of milliseconds between a given date and now
  * @param   {Date} d         The date that the current time will be subtracted from
- * @param   {function} [now] A function that returns the current UNIX time in milliseconds
- * @returns {number}
+ * @param   {Function} [now] A function that returns the current UNIX time in milliseconds
+ * @returns {number}        The number of milliseconds after now to the given date
  */
-function toNow(d, now = Date.now) {
+export function toNow(d, now = Date.now) {
   return now() - d.getTime();
 }
 
 /**
  * Returns a new Date constructed from a worldState date object
- * @param {Object} d The worldState date object
- * @returns {Date}
+ * @param {object} d The worldState date object
+ * @returns {Date} parsed date from DE date format
  */
-function parseDate(d) {
+export function parseDate(d) {
   const safeD = d || epochZero;
   const dt = safeD.$date || epochZero.$date;
   return new Date(safeD.$date ? Number(dt.$numberLong) : 1000 * d.sec);
@@ -73,14 +71,14 @@ function parseDate(d) {
 
 /**
  * An object containing functions to format dates and times
- * @typedef {Object.<function>}           TimeDateFunctions
- * @property {function} timeDeltaToString - Converts a time difference to a string
- * @property {function} fromNow           - Returns the number of milliseconds between now and
+ * @typedef {Record<string, Function>}           TimeDateFunctions
+ * @property {Function} timeDeltaToString - Converts a time difference to a string
+ * @property {Function} fromNow           - Returns the number of milliseconds between now and
  *                                          a given date
- * @property {function} toNow             - Returns the number of milliseconds between a given
+ * @property {Function} toNow             - Returns the number of milliseconds between a given
  *                                          date and now
  */
-module.exports = {
+export default {
   timeDeltaToString,
   fromNow,
   toNow,

package/lib/utilities/translation.js

@@ -1,28 +1,48 @@
-'use strict';
+import data from 'warframe-worldstate-data';
 
-const data = require('warframe-worldstate-data');
-
-function toTitleCase(str) {
+/**
+ * Rough Titlecase!
+ * @param {string} str string to be titlecased
+ * @returns {string} titlecased string
+ */
+export function toTitleCase(str) {
   return str.replace(/\w\S*/g, (txt) => txt.charAt(0).toUpperCase() + txt.substr(1).toLowerCase());
 }
 
-function splitResourceName(str) {
+/**
+ * Utility function to split the resource name and return somewhat human-readable string
+ * @param {string} str localization resource key
+ * @returns {string} human-readable string
+ */
+export function splitResourceName(str) {
   return str
     .split(/([A-Z]?[^A-Z]*)/g)
-    .filter((item) => item)
+    .filter(Boolean)
     .join(' ');
 }
 
 const i18n = (locale = 'en') => data[locale] || data;
 
-function faction(key, dataOverride) {
+/**
+ *
+ * @param {string} key - The data key
+ * @param {string} dataOverride locale for use with translation
+ * @returns {string} faction name
+ */
+export function faction(key, dataOverride) {
   if (key in i18n(dataOverride).factions) {
     return i18n(dataOverride).factions[key].value;
   }
   return key;
 }
 
-function node(key, dataOverride) {
+/**
+ *
+ * @param {string} key - The data key
+ * @param {string} dataOverride locale for use with translation
+ * @returns {string} node name
+ */
+export function node(key, dataOverride) {
   if (key in i18n(dataOverride).solNodes) {
     return i18n(dataOverride).solNodes[key].value;
   }
@@ -32,7 +52,13 @@ function node(key, dataOverride) {
   return key;
 }
 
-function nodeMissionType(key, dataOverride) {
+/**
+ *
+ * @param {string} key - The data key
+ * @param {string} dataOverride locale for use with translation
+ * @returns {string} mission type of the node
+ */
+export function nodeMissionType(key, dataOverride) {
   if (key in i18n(dataOverride).solNodes) {
     return i18n(dataOverride).solNodes[key].type;
   }
@@ -42,7 +68,13 @@ function nodeMissionType(key, dataOverride) {
   return key;
 }
 
-function nodeEnemy(key, dataOverride) {
+/**
+ *
+ * @param {string} key - The data key
+ * @param {string} dataOverride locale for use with translation
+ * @returns {string} faction that controls the node
+ */
+export function nodeEnemy(key, dataOverride) {
   if (key in i18n(dataOverride).solNodes) {
     return i18n(dataOverride).solNodes[key].enemy;
   }
@@ -52,7 +84,13 @@ function nodeEnemy(key, dataOverride) {
   return key;
 }
 
-function languageString(key, dataOverride) {
+/**
+ *
+ * @param {string} key - The data key
+ * @param {string} dataOverride locale for use with translation
+ * @returns {string} localization for language string
+ */
+export function languageString(key, dataOverride) {
   const lowerKey = String(key).toLowerCase();
   if (lowerKey in i18n(dataOverride).languages) {
     return i18n(dataOverride).languages[lowerKey].value;
@@ -66,7 +104,13 @@ function languageString(key, dataOverride) {
   return key;
 }
 
-function languageDesc(key, dataOverride) {
+/**
+ *
+ * @param {string} key - The data key
+ * @param {string} dataOverride locale for use with translation
+ * @returns {string} localization for language description
+ */
+export function languageDesc(key, dataOverride) {
   const lowerKey = String(key).toLowerCase();
   if (lowerKey in i18n(dataOverride).languages) {
     return i18n(dataOverride).languages[lowerKey].desc;
@@ -80,7 +124,13 @@ function languageDesc(key, dataOverride) {
   return key;
 }
 
-function missionType(key, dataOverride) {
+/**
+ *
+ * @param {string} key - The data key
+ * @param {string} dataOverride locale for use with translation
+ * @returns {string} translation for mission type
+ */
+export function missionType(key, dataOverride) {
   if (key in i18n(dataOverride).missionTypes) {
     return i18n(dataOverride).missionTypes[key].value;
   }
@@ -90,105 +140,182 @@ function missionType(key, dataOverride) {
   return key;
 }
 
-function conclaveMode(key, dataOverride) {
+/**
+ *
+ * @param {string} key - The data key
+ * @param {string} dataOverride locale for use with translation
+ * @returns {string} conclave mode
+ */
+export function conclaveMode(key, dataOverride) {
   if (key in i18n(dataOverride).conclave.modes) {
     return i18n(dataOverride).conclave.modes[key].value;
   }
   return key;
 }
 
-function conclaveCategory(key, dataOverride) {
+/**
+ *
+ * @param {string} key - The data key
+ * @param {string} dataOverride locale for use with translation
+ * @returns {string} conclave category
+ */
+export function conclaveCategory(key, dataOverride) {
   if (key in i18n(dataOverride).conclave.categories) {
     return i18n(dataOverride).conclave.categories[key].value;
   }
   return key;
 }
 
-function fissureModifier(key, dataOverride) {
+/**
+ *
+ * @param {string} key - The data key
+ * @param {string} dataOverride locale for use with translation
+ * @returns {string} fissure modifier data
+ */
+export function fissureModifier(key, dataOverride) {
   if (key in i18n(dataOverride).fissureModifiers) {
     return i18n(dataOverride).fissureModifiers[key].value;
   }
   return key;
 }
 
-function fissureTier(key, dataOverride) {
+/**
+ *
+ * @param {string} key - The data key
+ * @param {string} dataOverride locale for use with translation
+ * @returns {number | string} fissure tier
+ */
+export function fissureTier(key, dataOverride) {
   if (key in i18n(dataOverride).fissureModifiers) {
     return i18n(dataOverride).fissureModifiers[key].num;
   }
   return key;
 }
 
-function syndicate(key, dataOverride) {
+/**
+ *
+ * @param {string} key - The data key
+ * @param {string} dataOverride locale for use with translation
+ * @returns {string} syndicate name
+ */
+export function syndicate(key, dataOverride) {
   if (key in i18n(dataOverride).syndicates) {
     return i18n(dataOverride).syndicates[key].name;
   }
   return key;
 }
 
-function upgrade(key, dataOverride) {
+/**
+ *
+ * @param {string} key - The data key
+ * @param {string} dataOverride locale for use with translation
+ * @returns {string} upgrade type
+ */
+export function upgrade(key, dataOverride) {
   if (key in i18n(dataOverride).upgradeTypes) {
     return i18n(dataOverride).upgradeTypes[key].value;
   }
   return key;
 }
 
-function operation(key, dataOverride) {
+/**
+ *
+ * @param {string} key - The data key
+ * @param {string} dataOverride locale for use with translation
+ * @returns {string} mathematical operation value
+ */
+export function operation(key, dataOverride) {
   if (key in i18n(dataOverride).operationTypes) {
     return i18n(dataOverride).operationTypes[key].value;
   }
   return key;
 }
 
-function operationSymbol(key, dataOverride) {
+/**
+ *
+ * @param {string} key - The data key
+ * @param {string} dataOverride locale for use with translation
+ * @returns {string} symbol of mathematical operation
+ */
+export function operationSymbol(key, dataOverride) {
   if (key in i18n(dataOverride).operationTypes) {
     return i18n(dataOverride).operationTypes[key].symbol;
   }
   return key;
 }
 
-function sortieBoss(key, dataOverride) {
+/**
+ * @param {string} key - The data key
+ * @param {string} dataOverride locale for use with translation
+ * @returns {string} sortie boss name
+ */
+export function sortieBoss(key, dataOverride) {
   if (key in i18n(dataOverride).sortie.bosses) {
     return i18n(dataOverride).sortie.bosses[key].name;
   }
   return key;
 }
 
-function sortieFaction(key, dataOverride) {
+/**
+ * @param {string} key - The data key
+ * @param {string} dataOverride locale for use with translation
+ * @returns {string} faction for a sortie based on the boss
+ */
+export function sortieFaction(key, dataOverride) {
   if (key in i18n(dataOverride).sortie.bosses) {
     return i18n(dataOverride).sortie.bosses[key].faction;
   }
   return key;
 }
 
-function sortieModifier(key, dataOverride) {
+/**
+ *
+ * @param {string} key - The data key
+ * @param {string} dataOverride locale for use with translation
+ * @returns {string} sortie modifier data
+ */
+export function sortieModifier(key, dataOverride) {
   if (key in i18n(dataOverride).sortie.modifierTypes) {
     return i18n(dataOverride).sortie.modifierTypes[key];
   }
   return key;
 }
 
-function sortieModDesc(key, dataOverride) {
+/**
+ * @param {string} key - The data key
+ * @param {string} dataOverride locale for use with translation
+ * @returns {string} sortie modifier description
+ */
+export function sortieModDesc(key, dataOverride) {
   if (i18n(dataOverride).sortie.modifierDescriptions && key in i18n(dataOverride).sortie.modifierDescriptions) {
     return i18n(dataOverride).sortie.modifierDescriptions[key];
   }
   return key;
 }
 
-function region(key, dataOverride) {
+/**
+ * Retrieve the localized region for a given key
+ * @param {string} key - The region key
+ * @param {string} dataOverride - The locale to use for translations
+ * @returns {string} localized region name
+ */
+export function region(key, dataOverride) {
   if (key && i18n(dataOverride).persistentEnemy.regions[key]) {
     return i18n(dataOverride).persistentEnemy.regions[key];
   }
   return key;
 }
 
-function conclaveChallenge(key, dataOverride) {
+/**
+ * Retrieve conclave challenge name for the given key and locale
+ * @param {string} key key to retrieve
+ * @param {string} dataOverride locale key override
+ * @returns {string} - The conclave challenge name for the given key
+ */
+export function conclaveChallenge(key, dataOverride) {
   const splitKey = String(key).split('/').slice(-1)[0];
 
-  if (
-    i18n(dataOverride).conclave &&
-    i18n(dataOverride).conclave.challenges &&
-    i18n(dataOverride).conclave.challenges[splitKey]
-  ) {
+  if (i18n(dataOverride).conclave?.challenges?.[splitKey]) {
     return i18n(dataOverride).conclave.challenges[splitKey];
   }
   return {
@@ -198,36 +325,41 @@ function conclaveChallenge(key, dataOverride) {
   };
 }
 
-function steelPath(dataOverride) {
+/**
+ * Get the steel path data for given key
+ * @param {string} dataOverride - The locale to use for translations
+ * @returns {string} - The steel path data for the given key
+ */
+export function steelPath(dataOverride) {
   return (i18n(dataOverride) || /* istanbul ignore next */ data).steelPath;
 }
 
 /**
  * An object containing functions to convert in-game names to their localizations
- * @typedef {Record<string, function>} Translator
- * @property {function} faction          - Converts faction names
- * @property {function} node             - Converts star map node names
- * @property {function} nodeMissionType  - Returns the mission type of given node
- * @property {function} nodeEnemy        - Returns the faction that controls a given node
- * @property {function} languageString   - Converts generic language strings
- * @property {function} languageDesc     - Converts generic language strings
+ * @typedef {Record<string, Function>} Translator
+ * @property {Function} faction          - Converts faction names
+ * @property {Function} node             - Converts star map node names
+ * @property {Function} nodeMissionType  - Returns the mission type of given node
+ * @property {Function} nodeEnemy        - Returns the faction that controls a given node
+ * @property {Function} languageString   - Converts generic language strings
+ * @property {Function} languageDesc     - Converts generic language strings
  *                                          and retrieves the description
- * @property {function} missionType      - Converts mission types
- * @property {function} conclaveMode     - Converts conclave modes
- * @property {function} conclaveCategory - Converts conclave challenge categories
- * @property {function} fissureModifier  - Converts fissure mission modifiers
- * @property {function} syndicate        - Converts syndicate names
- * @property {function} upgrade          - Converts upgrade types
- * @property {function} operation        - Converts operation types
- * @property {function} sortieBoss       - Converts sortie boss names
- * @property {function} sortieModifier    - Converts sortie modifier types
- * @property {function} sortieModDesc    - Converts sortie modifier type descriptions
- * @property {function} region           - Converts persistent enemy region indicies
- * @property {function} conclaveChallenge - Convert conclave identifiers into standing data
- * @property {function} steelPath        -  Retrieve Steel Path rotation data for locale
- * @property {function} toTitleCase      - Format provided string as titlecase
- */
-module.exports = {
+ * @property {Function} missionType      - Converts mission types
+ * @property {Function} conclaveMode     - Converts conclave modes
+ * @property {Function} conclaveCategory - Converts conclave challenge categories
+ * @property {Function} fissureModifier  - Converts fissure mission modifiers
+ * @property {Function} syndicate        - Converts syndicate names
+ * @property {Function} upgrade          - Converts upgrade types
+ * @property {Function} operation        - Converts operation types
+ * @property {Function} sortieBoss       - Converts sortie boss names
+ * @property {Function} sortieModifier    - Converts sortie modifier types
+ * @property {Function} sortieModDesc    - Converts sortie modifier type descriptions
+ * @property {Function} region           - Converts persistent enemy region indicies
+ * @property {Function} conclaveChallenge - Convert conclave identifiers into standing data
+ * @property {Function} steelPath        -  Retrieve Steel Path rotation data for locale
+ * @property {Function} toTitleCase      - Format provided string as titlecase
+ */
+export default {
   faction,
   node,
   nodeMissionType,

package/main.js

@@ -1,3 +1,3 @@
-'use strict';
+import WorldState from './lib/WorldState.js';
 
-module.exports = require('./lib/WorldState');
+export default WorldState;

package/package.json

@@ -1,12 +1,9 @@
 {
   "name": "warframe-worldstate-parser",
-  "version": "2.31.1",
+  "version": "3.0.0",
   "description": "An Open parser for Warframe's Worldstate in Javascript",
   "types": "./types/main.d.ts",
   "main": "main.js",
-  "dependencies": {
-    "node-fetch": "^2.6.1"
-  },
   "peerDependencies": {
     "warframe-worldstate-data": ">=1.0"
   },
@@ -32,5 +29,6 @@
   "bugs": {
     "url": "https://github.com/wfcd/warframe-worldstate-parser/issues"
   },
-  "homepage": "https://github.com/wfcd/warframe-worldstate-parser#readme"
+  "homepage": "https://github.com/wfcd/warframe-worldstate-parser#readme",
+  "type": "module"
 }