warframe-worldstate-parser 2.32.0 → 3.0.0

package/types/lib/WorldState.d.ts

@@ -1,5 +1,16 @@
-export = WorldState;
-declare class WorldState {
+/**
+ *
+ * @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[]} array of parsed objects
+ */
+export function parseArray(ParserClass: object, dataArray: Array<BaseContentObject>, deps: Dependency, uniqueField?: any): WorldstateObject[];
+/**
+ * Parses Warframe Worldstate JSON
+ */
+export default class WorldState {
     /**
      * Generates the worldstate json as a string into usable objects
      * @param {string} json The worldstate JSON string
@@ -134,29 +145,29 @@ declare class WorldState {
     steelPath: SteelPathOffering;
     duviriCycle: DuviriCycle;
 }
-import News = require("./models/News");
-import WorldEvent = require("./models/WorldEvent");
-import Alert = require("./models/Alert");
-import SyndicateMission = require("./models/SyndicateMission");
-import Fissure = require("./models/Fissure");
-import GlobalUpgrade = require("./models/GlobalUpgrade");
-import FlashSale = require("./models/FlashSale");
-import Invasion = require("./models/Invasion");
-import DarkSector = require("./models/DarkSector");
-import VoidTrader = require("./models/VoidTrader");
-import DailyDeal = require("./models/DailyDeal");
-import Simaris = require("./models/Simaris");
-import ConclaveChallenge = require("./models/ConclaveChallenge");
-import PersistentEnemy = require("./models/PersistentEnemy");
-import EarthCycle = require("./models/EarthCycle");
-import CetusCycle = require("./models/CetusCycle");
-import CambionCycle = require("./models/CambionCycle");
-import ZarimanCycle = require("./models/ZarimanCycle");
-import WeeklyChallenge = require("./models/WeeklyChallenge");
-import ConstructionProgress = require("./models/ConstructionProgress");
-import VallisCycle = require("./models/VallisCycle");
-import Nightwave = require("./models/Nightwave");
-import SentientOutpost = require("./models/SentientOutpost");
-import SteelPathOffering = require("./models/SteelPathOffering");
-import DuviriCycle = require("./models/DuviriCycle");
-import Dependency = require("./supporting/Dependency");
+import Dependency from './supporting/Dependency.js';
+import News from './models/News.js';
+import WorldEvent from './models/WorldEvent.js';
+import Alert from './models/Alert.js';
+import SyndicateMission from './models/SyndicateMission.js';
+import Fissure from './models/Fissure.js';
+import GlobalUpgrade from './models/GlobalUpgrade.js';
+import FlashSale from './models/FlashSale.js';
+import Invasion from './models/Invasion.js';
+import DarkSector from './models/DarkSector.js';
+import VoidTrader from './models/VoidTrader.js';
+import DailyDeal from './models/DailyDeal.js';
+import Simaris from './models/Simaris.js';
+import ConclaveChallenge from './models/ConclaveChallenge.js';
+import PersistentEnemy from './models/PersistentEnemy.js';
+import EarthCycle from './models/EarthCycle.js';
+import CetusCycle from './models/CetusCycle.js';
+import CambionCycle from './models/CambionCycle.js';
+import ZarimanCycle from './models/ZarimanCycle.js';
+import WeeklyChallenge from './models/WeeklyChallenge.js';
+import ConstructionProgress from './models/ConstructionProgress.js';
+import VallisCycle from './models/VallisCycle.js';
+import Nightwave from './models/Nightwave.js';
+import SentientOutpost from './models/SentientOutpost.js';
+import SteelPathOffering from './models/SteelPathOffering.js';
+import DuviriCycle from './models/DuviriCycle.js';

package/types/lib/models/Alert.d.ts

@@ -1,33 +1,21 @@
-export = Alert;
 /**
  * Represents an alert
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-declare class Alert extends WorldstateObject {
+export default class Alert extends WorldstateObject {
     /**
-     * @param   {Object}             data       The alert data
-     * @param   {MarkdownSettings}   mdConfig   The markdown settings
-     * @param   {Translator}         translator The string translator
-     * @param   {TimeDateFunctions}  timeDate   The time and date functions
-     * @param   {Mission}            Mission    The Mission parser
-     * @param   {Reward}             Reward     The Reward parser
+     * @param   {object}             data       The alert data
      * @param   {string}             locale     Locale to use for translations
      */
-    constructor(data: any, { mdConfig, translator, timeDate, Mission, Reward, locale }: MarkdownSettings);
-    /**
-     * The markdown settings
-     * @type {MarkdownSettings}
-     * @private
-     */
-    private mdConfig;
+    constructor(data: object, { locale }?: string);
     /**
      * The mission that the players have to complete
      * @type {Mission}
      */
-    mission: MarkdownSettings;
+    mission: Mission;
     /**
      * ETA string (at time of object creation)
-     * @type {String}
+     * @type {string}
      */
     eta: string;
     /**
@@ -37,28 +25,29 @@ declare class Alert extends WorldstateObject {
     rewardTypes: Array<string>;
     /**
      * A tag that DE occasionally provides, such as `LotusGift`
-     * @type {String}
+     * @type {string}
      */
     tag: string;
     /**
      * Get the alert's description text
-     * @returns {string}
+     * @returns {string} the description
      */
     getDescription(): string;
     /**
      * Get the alert's reward
-     * @returns {Reward}
+     * @returns {Reward} the reward
      */
     getReward(): Reward;
     /**
      * Get a string indicating how much time is left before the alert expires
-     * @returns {string}
+     * @returns {string} the time left
      */
     getETAString(): string;
     /**
      * Get an array containing the types of all of the alert's rewards
-     * @returns {Array.<string>}
+     * @returns {Array.<string>} an array containing the types of all of the alert's rewards
      */
     getRewardTypes(): Array<string>;
 }
-import WorldstateObject = require("./WorldstateObject");
+import WorldstateObject from './WorldstateObject.js';
+import Mission from './Mission.js';

package/types/lib/models/CambionCycle.d.ts

@@ -1,25 +1,20 @@
-export = CambionCycle;
 /**
  * Represents the current Cambion Drift Fass/Vome Cycle
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  * @property {string} timeLeft time rendering of amount of time left
  */
-declare class CambionCycle extends WorldstateObject {
+export default class CambionCycle extends WorldstateObject {
     /**
      * @param   {CetusCycle}        cetusCycle Match data from cetus cycle for data
-     * @param   {Object}            deps            The dependencies object
-     * @param   {TimeDateFunctions} deps.timeDate   The time and date functions
      */
-    constructor(cetusCycle: CetusCycle, { timeDate }: {
-        timeDate: TimeDateFunctions;
-    });
+    constructor(cetusCycle: CetusCycle);
     state: string;
     active: string;
     id: string;
     /**
      * Get whether the event has expired
-     * @returns {boolean}
+     * @returns {boolean} whether the event has expired
      */
     getExpired(): boolean;
 }
-import WorldstateObject = require("./WorldstateObject");
+import WorldstateObject from './WorldstateObject.js';

package/types/lib/models/CetusCycle.d.ts

@@ -1,31 +1,12 @@
-export = CetusCycle;
 /**
  * Represents the current Earth Day/Night Cycle
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-declare class CetusCycle extends WorldstateObject {
+export default class CetusCycle extends WorldstateObject {
     /**
      * @param   {Date}              bountiesEndDate The end date for Ostron bounties
-     * @param   {Object}            deps            The dependencies object
-     * @param   {MarkdownSettings}  deps.mdConfig   The markdown settings
-     * @param   {TimeDateFunctions} deps.timeDate   The time and date functions
      */
-    constructor(bountiesEndDate: Date, { mdConfig, timeDate }: {
-        mdConfig: MarkdownSettings;
-        timeDate: TimeDateFunctions;
-    });
-    /**
-     * The markdown settings
-     * @type {MarkdownSettings}
-     * @private
-     */
-    private mdConfig;
-    /**
-     * The end of the Ostron bounties timer (marks the end of night)
-     * @type {Date}
-     * @private
-     */
-    private bountiesEndDate;
+    constructor(bountiesEndDate: Date);
     /**
      * Whether it's daytime
      * @type {boolean}
@@ -50,16 +31,17 @@ declare class CetusCycle extends WorldstateObject {
     shortString: string;
     /**
      * Get whether or not the event has expired
-     * @returns {boolean}
+     * @returns {boolean} whether the event has expired
      */
     getExpired(): boolean;
     getCurrentCetusCycle(): {
         dayTime: boolean;
-        timeLeft: any;
+        timeLeft: string;
         expiry: Date;
-        expiresIn: any;
+        expiresIn: number;
         state: string;
         start: number;
     };
+    #private;
 }
-import WorldstateObject = require("./WorldstateObject");
+import WorldstateObject from './WorldstateObject.js';

package/types/lib/models/ChallengeInstance.d.ts

@@ -1,15 +1,13 @@
-export = ChallengeInstance;
 /**
  * Describes a world challenge instance
  */
-declare 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: any, { translator, locale }: Dependency);
+    constructor(data: object, { locale }?: Dependency);
     /**
      * Type of challenge
      * @type {string}
@@ -17,22 +15,22 @@ declare class ChallengeInstance {
     type: string;
     /**
      * Minimum enemy level to fulfill challenge
-     * @type {Number}
+     * @type {number}
      */
     minEnemyLevel: number;
     /**
      * Required number of units to complete challenge
-     * @type {Number}
+     * @type {number}
      */
     requiredAmount: number;
     /**
      * Waypoint for amount of units between progression updates
-     * @type {Number}
+     * @type {number}
      */
     progressAmount: number;
     /**
      * Required damage type
-     * @type {String|undefined}
+     * @type {string | undefined}
      */
     damageType: string | undefined;
     /**

package/types/lib/models/ConclaveChallenge.d.ts

@@ -1,29 +1,16 @@
-export = ConclaveChallenge;
 /**
  * Represents a Conclave challenge
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-declare 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: any, { mdConfig, translator, timeDate, locale }: {
-        mdConfig: MarkdownSettings;
-        translator: Translator;
-        timeDate: TimeDateFunctions;
+    constructor(data: object, { locale }?: {
         locale: string;
     });
-    /**
-     * The markdown settings
-     * @type {MarkdownSettings}
-     * @private
-     */
-    private mdConfig;
     /**
      * The number of times that the challenge's objective needs to be completed
      * @type {number}
@@ -41,7 +28,7 @@ declare class ConclaveChallenge extends WorldstateObject {
     category: string;
     /**
      * ETA string (at time of object creation)
-     * @type {String}
+     * @type {string}
      */
     eta: string;
     /**
@@ -76,7 +63,7 @@ declare class ConclaveChallenge extends WorldstateObject {
     title: string;
     /**
      * Standing granted by completing challenge.
-     * @type {Number}
+     * @type {number}
      */
     standing: number;
     /**
@@ -86,18 +73,18 @@ declare class ConclaveChallenge extends WorldstateObject {
     asString: string;
     /**
      * Get whether or not the challenge is daily
-     * @returns {boolean}
+     * @returns {boolean} whether the category is daily
      */
     isDaily(): boolean;
     /**
      * Get whether or not this is the weekly root challenge
-     * @returns {boolean}
+     * @returns {boolean} whether this is the root challenge
      */
     isRootChallenge(): boolean;
     /**
      * Get whether or not the challenge has expired
-     * @returns {boolean}
+     * @returns {boolean} Whether or not the challenge has expired
      */
     isExpired(): boolean;
 }
-import WorldstateObject = require("./WorldstateObject");
+import WorldstateObject from './WorldstateObject.js';

package/types/lib/models/ConstructionProgress.d.ts

@@ -1,25 +1,14 @@
-export = ConstructionProgress;
 /**
  * Represents enemy construction progress
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-declare 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: any, { mdConfig, timeDate }: {
-        mdConfig: MarkdownSettings;
-    });
-    /**
-     * The markdown settings
-     * @type {MarkdownSettings}
-     * @private
-     */
-    private mdConfig;
+    constructor(data: object);
     fomorianProgress: any;
     razorbackProgress: any;
     unknownProgress: any;
 }
-import WorldstateObject = require("./WorldstateObject");
+import WorldstateObject from './WorldstateObject.js';

package/types/lib/models/DailyDeal.d.ts

@@ -1,34 +1,15 @@
-export = DailyDeal;
 /**
  * Represents a daily deal
  */
-declare 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: any, { mdConfig, translator, timeDate, locale }: {
-        mdConfig: MarkdownSettings;
-        translator: Translator;
-        timeDate: TimeDateFunctions;
+    constructor(data: object, { locale }?: {
         locale: string;
     });
-    /**
-     * The markdown settings
-     * @type {MarkdownSettings}
-     * @private
-     */
-    private mdConfig;
-    /**
-     * The time and date functions
-     * @type {TimeDateFunctions}
-     * @private
-     */
-    private timeDate;
     /**
      * The item that is being offered in the sale
      * @type {string}
@@ -76,7 +57,7 @@ declare class DailyDeal {
     id: string;
     /**
      * ETA string (at time of object creation)
-     * @type {String}
+     * @type {string}
      */
     eta: string;
     /**
@@ -86,12 +67,12 @@ declare class DailyDeal {
     discount: number;
     /**
      * Get a string indicating how much time is left before the deal expires
-     * @returns {string}
+     * @returns {string} estimated time remaining on the deal
      */
     getETAString(): string;
     /**
      * Returns a string representation of the daily deal
-     * @returns {string}
+     * @returns {string} The string representation of the daily deal
      */
     toString(): string;
 }

package/types/lib/models/DarkSector.d.ts

@@ -1,27 +1,14 @@
-export = DarkSector;
 /**
  * Represents a dark sector
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-declare 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
+export default class DarkSector extends WorldstateObject {
+    /**
+     * @param   {object}             data                  The dark sector data
+     * @param   {object}             deps                  The dependencies object
      * @param   {string}             deps.locale           Locale to use for translations
      */
-    constructor(data: any, { mdConfig, translator, timeDate, Mission, DarkSectorBattle, Reward, locale }: {
-        mdConfig: MarkdownSettings;
-        translator: Translator;
-        timeDate: TimeDateFunctions;
-        Mission: Mission;
-        DarkSectorBattle: DarkSectorBattle;
-        Reward: Reward;
+    constructor(data: object, { locale }?: {
         locale: string;
     });
     /**
@@ -46,7 +33,7 @@ declare class DarkSector extends WorldstateObject {
     memberItemsTaxRate: number;
     /**
      * Whether the dark sector holder is an alliance or not
-     * @type {Boolean}
+     * @type {boolean}
      */
     isAlliance: boolean;
     /**
@@ -96,7 +83,7 @@ declare class DarkSector extends WorldstateObject {
      * The dark sector's mission
      * @type {?Mission}
      */
-    mission: Mission;
+    mission: Mission | null;
     battlePayReserve: any;
     /**
      * The battle pay per mission offered to players
@@ -129,4 +116,6 @@ declare class DarkSector extends WorldstateObject {
      */
     history: Array<DarkSectorBattle>;
 }
-import WorldstateObject = require("./WorldstateObject");
+import WorldstateObject from './WorldstateObject.js';
+import Mission from './Mission.js';
+import DarkSectorBattle from './DarkSectorBattle.js';

package/types/lib/models/DarkSectorBattle.d.ts

@@ -1,14 +1,11 @@
-export = DarkSectorBattle;
 /**
  * Represents a battle over a dark sector
  */
-declare class DarkSectorBattle {
+export default class DarkSectorBattle {
     /**
-     * @param   {Object} data The battle data
+     * @param   {object} data The battle data
      */
-    constructor(data: any, { timeDate }: {
-        timeDate: any;
-    });
+    constructor(data: object);
     /**
      * The defenders of the dark sector
      * @type {string}

package/types/lib/models/DuviriCycle.d.ts

@@ -1,12 +1,9 @@
-export = DuviriCycle;
 /**
  * @typedef {WorldstateObject} DuviriCycle
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-declare class DuviriCycle extends WorldstateObject {
-    constructor({ timeDate, translator, duviriChoices }: {
-        timeDate: any;
-        translator: any;
+export default class DuviriCycle extends WorldstateObject {
+    constructor({ duviriChoices }: {
         duviriChoices: any;
     });
     /**
@@ -20,8 +17,5 @@ declare class DuviriCycle extends WorldstateObject {
     choices: any;
     id: string;
 }
-declare namespace DuviriCycle {
-    export { DuviriCycle };
-}
-import WorldstateObject = require("./WorldstateObject");
-type DuviriCycle = WorldstateObject;
+export type DuviriCycle = WorldstateObject;
+import WorldstateObject from './WorldstateObject.js';

package/types/lib/models/EarthCycle.d.ts

@@ -1,21 +1,9 @@
-export = EarthCycle;
 /**
  * Represents the current Earth Day/Night Cycle
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-declare 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 }: any);
-    /**
-     * The markdown settings
-     * @type {MarkdownSettings}
-     * @private
-     */
-    private mdConfig;
+export default class EarthCycle extends WorldstateObject {
+    constructor();
     /**
      * Whether or not this it's daytime
      * @type {boolean}
@@ -34,8 +22,43 @@ declare class EarthCycle extends WorldstateObject {
     id: string;
     /**
      * Get whether or not the event has expired
-     * @returns {boolean}
+     * @returns {boolean} Whether or not the event has expired
      */
     getExpired(): boolean;
+    #private;
 }
-import WorldstateObject = require("./WorldstateObject");
+export type EarthCycle = {
+    /**
+     * The date and time at which the event ends
+     */
+    expiry: Date;
+    /**
+     * The date and time at which the event started
+     */
+    activation: Date;
+    /**
+     * Whether or not this it's daytime
+     */
+    isDay: boolean;
+    /**
+     * Current cycle state. One of `day`, `night`
+     */
+    state: string;
+    /**
+     * Time remaining string
+     */
+    timeLeft: string;
+    /**
+     * The date and time at which the event ends, rounded to the nearest minute
+     */
+    rounded: Date;
+    /**
+     * The date and time at which the event started, 4 hours before the end
+     */
+    start: Date;
+    /**
+     * Whether or not the event has expired
+     */
+    expired: boolean;
+};
+import WorldstateObject from './WorldstateObject.js';