warframe-worldstate-parser 2.26.1 → 2.27.0

package/lib/CambionCycle.js

@@ -7,7 +7,7 @@ const WorldstateObject = require('./WorldstateObject');
  * @extends {WorldstateObject}
  * @property {string} timeLeft time rendering of amount of time left
  */
-module.exports = class CambionCycle extends WorldstateObject {
+class CambionCycle extends WorldstateObject {
   /**
    * @param   {CetusCycle}        cetusCycle Match data from cetus cycle for data
    * @param   {Object}            deps            The dependencies object
@@ -25,10 +25,12 @@ module.exports = class CambionCycle extends WorldstateObject {
   }
 
   /**
-   * Get whether or not the event has expired
+   * Get whether the event has expired
    * @returns {boolean}
    */
   getExpired() {
     return this.timeDate.fromNow(this.expiry) < 0;
   }
-};
+}
+
+module.exports = CambionCycle;

package/lib/DailyDeal.js

@@ -35,6 +35,12 @@ class DailyDeal {
      */
     this.item = translator.languageString(data.StoreItem, locale);
 
+    /**
+     * The uniqueName for the item on sale.
+     * @type {string}
+     */
+    this.uniqueName = data.StoreItem;
+
     /**
      * The date and time at which the deal will expire
      * @type {Date}

package/lib/Fissure.js

@@ -6,7 +6,7 @@ const WorldstateObject = require('./WorldstateObject');
  * Represents a fissure mission
  * @extends {WorldstateObject}
  */
-module.exports = class Fissure extends WorldstateObject {
+class Fissure extends WorldstateObject {
   /**
    * @param   {Object}             data            The fissure data
    * @param   {Object}             deps            The dependencies object
@@ -137,4 +137,6 @@ module.exports = class Fissure extends WorldstateObject {
   toString() {
     return `[${this.getETAString()}] ${this.tier} fissure at ${this.node} - ${this.enemy} ${this.missionType}`;
   }
-};
+}
+
+module.exports = Fissure;

package/lib/WorldState.js

@@ -34,6 +34,7 @@ const Kuva = require('./Kuva');
 const SentientOutpost = require('./SentientOutpost');
 const CambionCycle = require('./CambionCycle');
 const SteelPathOffering = require('./SteelPathOffering');
+const Dependency = require('./supporting/Dependency'); // eslint-disable-line no-unused-vars
 
 // needed for type declarations
 const MarkdownSettings = require('./supporting/MarkdownSettings');
@@ -79,8 +80,8 @@ const defaultDeps = {
  * @param {Object} ParserClass class for parsing data
  * @param {Array<BaseContentObject>} dataArray array of raw data
  * @param {Dependency} deps shared dependency object
- * @param {*} uniqueField field to treat as unique
- * @returns {WorldstateObject}
+ * @param {*} [uniqueField] field to treat as unique
+ * @returns {WorldstateObject[]}
  */
 function parseArray(ParserClass, dataArray, deps, uniqueField) {
   const arr = (dataArray || []).map((d) => new ParserClass(d, deps));
@@ -164,7 +165,7 @@ module.exports = class WorldState {
 
     /**
      * The current fissures: 'ActiveMissions' & 'VoidStorms'
-     * @type {Array.<News>}
+     * @type {Array.<Fissure>}
      */
     this.fissures = parseArray(deps.Fissure, data.ActiveMissions, deps).concat(
       parseArray(deps.Fissure, data.VoidStorms, deps)

package/lib/ZarimanCycle.js

@@ -13,7 +13,7 @@ const stateMaximum = 9000000;
  * Represents the current Zariman Corpus/Grineer Cycle
  * @extends {WorldstateObject}
  */
-module.exports = class ZarimanCycle extends WorldstateObject {
+class ZarimanCycle extends WorldstateObject {
   /**
    * @param   {Date}              bountiesEndDate The current zariman cycle expiry
    * @param   {Object}            deps            The dependencies object
@@ -138,4 +138,6 @@ module.exports = class ZarimanCycle extends WorldstateObject {
 
     return lines.join(this.mdConfig.lineEnd);
   }
-};
+}
+
+module.exports = ZarimanCycle;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "warframe-worldstate-parser",
-  "version": "2.26.1",
+  "version": "2.27.0",
   "description": "An Open parser for Warframe's Worldstate in Javascript",
   "types": "./types/main.d.ts",
   "main": "main.js",

package/types/lib/CambionCycle.d.ts

@@ -1,4 +1,9 @@
 export = CambionCycle;
+/**
+ * Represents the current Cambion Drift Fass/Vome Cycle
+ * @extends {WorldstateObject}
+ * @property {string} timeLeft time rendering of amount of time left
+ */
 declare class CambionCycle extends WorldstateObject {
     /**
      * @param   {CetusCycle}        cetusCycle Match data from cetus cycle for data
@@ -12,7 +17,7 @@ declare class CambionCycle extends WorldstateObject {
     active: string;
     id: string;
     /**
-     * Get whether or not the event has expired
+     * Get whether the event has expired
      * @returns {boolean}
      */
     getExpired(): boolean;

package/types/lib/DailyDeal.d.ts

@@ -34,6 +34,11 @@ declare class DailyDeal {
      * @type {string}
      */
     item: string;
+    /**
+     * The uniqueName for the item on sale.
+     * @type {string}
+     */
+    uniqueName: string;
     /**
      * The date and time at which the deal will expire
      * @type {Date}

package/types/lib/Fissure.d.ts

@@ -1,4 +1,8 @@
 export = Fissure;
+/**
+ * Represents a fissure mission
+ * @extends {WorldstateObject}
+ */
 declare class Fissure extends WorldstateObject {
     /**
      * @param   {Object}             data            The fissure data

package/types/lib/WorldState.d.ts

@@ -33,9 +33,9 @@ declare class WorldState {
     syndicateMissions: Array<SyndicateMission>;
     /**
      * The current fissures: 'ActiveMissions' & 'VoidStorms'
-     * @type {Array.<News>}
+     * @type {Array.<Fissure>}
      */
-    fissures: Array<News>;
+    fissures: Array<Fissure>;
     /**
      * The current global upgrades
      * @type {Array.<GlobalUpgrade>}
@@ -132,6 +132,7 @@ import News = require("./News");
 import WorldEvent = require("./WorldEvent");
 import Alert = require("./Alert");
 import SyndicateMission = require("./SyndicateMission");
+import Fissure = require("./Fissure");
 import GlobalUpgrade = require("./GlobalUpgrade");
 import FlashSale = require("./FlashSale");
 import Invasion = require("./Invasion");
@@ -142,9 +143,12 @@ import ConclaveChallenge = require("./ConclaveChallenge");
 import PersistentEnemy = require("./PersistentEnemy");
 import EarthCycle = require("./EarthCycle");
 import CetusCycle = require("./CetusCycle");
+import CambionCycle = require("./CambionCycle");
+import ZarimanCycle = require("./ZarimanCycle");
 import WeeklyChallenge = require("./WeeklyChallenge");
 import ConstructionProgress = require("./ConstructionProgress");
 import VallisCycle = require("./VallisCycle");
 import Nightwave = require("./Nightwave");
 import SentientOutpost = require("./SentientOutpost");
 import SteelPathOffering = require("./SteelPathOffering");
+import Dependency = require("./supporting/Dependency");

package/types/lib/ZarimanCycle.d.ts

@@ -1,4 +1,8 @@
 export = ZarimanCycle;
+/**
+ * Represents the current Zariman Corpus/Grineer Cycle
+ * @extends {WorldstateObject}
+ */
 declare class ZarimanCycle extends WorldstateObject {
     /**
      * @param   {Date}              bountiesEndDate The current zariman cycle expiry

package/types/main.d.ts

@@ -1,4 +1,4 @@
 declare const _exports: {
-    new (json: string, deps?: Dependency): import("./lib/WorldState");
+    new (json: string, deps?: import("./lib/supporting/Dependency")): import("./lib/WorldState");
 };
 export = _exports;