warframe-worldstate-parser 2.31.1 → 3.0.0

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

@@ -1,21 +1,14 @@
-export = Fissure;
 /**
  * Represents a fissure mission
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-declare class Fissure extends WorldstateObject {
+export default class Fissure extends WorldstateObject {
     /**
-     * @param   {Object}             data            The fissure 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 fissure data
+     * @param   {Dependency}             deps            The dependencies object
      * @param   {string}             deps.locale     Locale to use for translations
      */
-    constructor(data: any, { translator, timeDate, locale }: {
-        translator: Translator;
-        timeDate: TimeDateFunctions;
-        locale: string;
-    });
+    constructor(data: object, { locale }?: Dependency);
     /**
      * The node where the fissure has appeared
      * @type {string}
@@ -63,12 +56,12 @@ declare class Fissure extends WorldstateObject {
     expired: boolean;
     /**
      * ETA string (at time of object creation)
-     * @type {String}
+     * @type {string}
      */
     eta: string;
     /**
      * Whether this fissure corresponds to a RailJack Void Storm
-     * @type {Boolean}
+     * @type {boolean}
      */
     isStorm: boolean;
     /**
@@ -78,13 +71,13 @@ declare class Fissure extends WorldstateObject {
     isHard: boolean;
     /**
      * Get whether this deal has expired
-     * @returns {boolean}
+     * @returns {boolean} Whether or not the deal has expired
      */
     getExpired(): boolean;
     /**
      * Get a string representation of how long the void fissure will remain active
-     * @returns {string}
+     * @returns {string} The string representation of the fissure's remaining time
      */
     getETAString(): string;
 }
-import WorldstateObject = require("./WorldstateObject");
+import WorldstateObject from './WorldstateObject.js';

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

@@ -1,34 +1,13 @@
-export = FlashSale;
 /**
  * Represents a flash sale
  */
-declare class FlashSale {
+export default class FlashSale {
     /**
-     * @param   {Object}             data            The flash sale 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 flash sale data
+     * @param   {Dependency}             deps            The dependencies object
      * @param   {string}             deps.locale     Locale to use for translations
      */
-    constructor(data: any, { translator, mdConfig, timeDate, locale }: {
-        mdConfig: MarkdownSettings;
-        translator: Translator;
-        timeDate: TimeDateFunctions;
-        locale: string;
-    });
-    /**
-     * The markdown settings
-     * @type {MarkdownSettings}
-     * @private
-     */
-    private mdConfig;
-    /**
-     * The time and date functions
-     * @type {TimeDateFunctions}
-     * @private
-     */
-    private timeDate;
+    constructor(data: object, { locale }?: Dependency);
     /**
      * The item being offered in the flash sale
      * @type {string}
@@ -86,22 +65,22 @@ declare class FlashSale {
     expired: boolean;
     /**
      * ETA string (at time of object creation)
-     * @type {String}
+     * @type {string}
      */
     eta: string;
     /**
      * Get how much time is left before the deal expires
-     * @returns {string}
+     * @returns {string} The time left before the deal expires
      */
     getETAString(): string;
     /**
      * Get whether or not this deal has expired
-     * @returns {boolean}
+     * @returns {boolean} Whether or not the deal has expired
      */
     getExpired(): boolean;
     /**
      * Returns a string representation of the flash sale
-     * @returns {string}
+     * @returns {string} The string representation of the flash sale
      */
     toString(): string;
 }

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

@@ -1,34 +1,15 @@
-export = GlobalUpgrade;
 /**
  * Represents an upgrade that applies to all players
  */
-declare class GlobalUpgrade {
+export default class GlobalUpgrade {
     /**
-     * @param   {Object}             data            The global upgrade data
-     * @param   {Object}             deps            The dependencies object
-     * @param   {Translator}         deps.translator The string translator
-     * @param   {TimeDateFunctions}  deps.timeDate   The time and date functions
-     * @param   {MarkdownSettings}   deps.mdConfig   The markdown settings
+     * @param   {object}             data            The global upgrade data
+     * @param   {object}             deps            The dependencies object
      * @param   {string}             deps.locale     Locale to use for translations
      */
-    constructor(data: any, { translator, timeDate, mdConfig, locale }: {
-        translator: Translator;
-        timeDate: TimeDateFunctions;
-        mdConfig: MarkdownSettings;
+    constructor(data: object, { locale }?: {
         locale: string;
     });
-    /**
-     * The time and date functions
-     * @type {TimeDateFunctions}
-     * @private
-     */
-    private timeDate;
-    /**
-     * The markdown settings
-     * @type {MarkdownSettings}
-     * @private
-     */
-    private mdConfig;
     /**
      * The time and date at which the global upgrade starts being active
      * @type {Date}
@@ -66,7 +47,7 @@ declare class GlobalUpgrade {
     expired: boolean;
     /**
      * ETA string (at time of object creation)
-     * @type {String}
+     * @type {string}
      */
     eta: string;
     /**
@@ -76,12 +57,12 @@ declare class GlobalUpgrade {
     desc: string;
     /**
      * Get whether or not the event has expired
-     * @returns {boolean}
+     * @returns {boolean} whether the event has expired
      */
     getExpired(): boolean;
     /**
      * Get a string indicating how long it will take for the upgrade to expire
-     * @returns {string}
+     * @returns {string} estimated timer of the upgrade
      */
     getETAString(): string;
     /**
@@ -91,7 +72,7 @@ declare class GlobalUpgrade {
     compileDesription(): string;
     /**
      * Returns a string representation of the upgrade
-     * @returns {string}
+     * @returns {string} string representation
      */
     toString(): string;
 }

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

@@ -1,7 +1,6 @@
-export = Invasion;
 /**
  * An invasion participant
- * @typedef {Object} Invasion~Participant
+ * @typedef {object} InvasionParticipant
  * @property {string} reward Reward for supporting this participant in the invasion
  * @property {string} faction Faction of this participant (localized)
  * @property {string} factionKey Faction of this participant (always English)
@@ -9,29 +8,13 @@ export = Invasion;
 /**
  * Represents an invasion
  */
-declare class Invasion extends WorldstateObject {
-    /**
-     * @param   {Object}             data            The invasion 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   {Reward}             deps.Reward     The Reward parser
-     * @param   {string}             deps.locale     Locale to use for translations
-     */
-    constructor(data: any, { mdConfig, translator, timeDate, Reward, locale }: {
-        mdConfig: MarkdownSettings;
-        translator: Translator;
-        timeDate: TimeDateFunctions;
-        Reward: Reward;
-        locale: string;
-    });
+export default class Invasion extends WorldstateObject {
     /**
-     * The markdown settings
-     * @type {MarkdownSettings}
-     * @private
+     * @param   {object}             data            The invasion data
+     * @param   {Dependency}         deps            The dependencies object
+     * @param   {string}             deps.locale     Locale to use for translations
      */
-    private mdConfig;
+    constructor(data: object, { locale }?: Dependency);
     /**
      * The node where the invasion is taking place
      * @type {string}
@@ -47,11 +30,6 @@ declare class Invasion extends WorldstateObject {
      * @type {string}
      */
     desc: string;
-    /**
-     * The attacker's reward
-     * @type {Reward}
-     */
-    attackerReward: Reward;
     /**
      * The attacking faction
      * @type {string}
@@ -59,24 +37,14 @@ declare class Invasion extends WorldstateObject {
     attackingFaction: string;
     /**
      * Invasion attacker
-     * @type {Invasion~Partipant}
-     */
-    attacker: Invasion;
-    /**
-     * The defender's reward
-     * @type {Reward}
+     * @type {InvasionParticipant}
      */
-    defenderReward: Reward;
-    /**
-     * The defending faction
-     * @type {string}
-     */
-    defendingFaction: string;
+    attacker: InvasionParticipant;
     /**
      * Invasion defender
-     * @type {Partipant}
+     * @type {InvasionParticipant}
      */
-    defender: Partipant;
+    defender: InvasionParticipant;
     /**
      * Whether this invasion is against the infestation
      * @type {boolean}
@@ -106,7 +74,7 @@ declare class Invasion extends WorldstateObject {
     completed: boolean;
     /**
      * ETA string (at time of object creation)
-     * @type {String}
+     * @type {string}
      */
     eta: string;
     /**
@@ -117,33 +85,29 @@ declare class Invasion extends WorldstateObject {
     /**
      * Whether or not the attackers are winning.
      * This is always false when the infestation is attacking
-     * @returns {boolean}
+     * @returns {boolean} whether the attacker is winning
      */
     isAttackerWinning(): boolean;
     /**
      * Get an estimation of how much time is left before the invasion ends in milliseconds
-     * @returns {number}
+     * @returns {number} remaining time in ms
      */
     getRemainingTime(): number;
     /**
      * Get a string estimating how much time is left before the invasion ends
-     * @returns {string}
+     * @returns {string} time delta string from now to the end
      */
     getETAString(): string;
     /**
      * Get the types of the items being rewarded in the invasion
-     * @returns {Array.<string>}
+     * @returns {Array<string>} types of items being rewarded
      */
     getRewardTypes(): Array<string>;
 }
-declare namespace Invasion {
-    export { Invasion };
-}
-import WorldstateObject = require("./WorldstateObject");
 /**
- * ~Participant
+ * An invasion participant
  */
-type Invasion = {
+export type InvasionParticipant = {
     /**
      * Reward for supporting this participant in the invasion
      */
@@ -157,3 +121,4 @@ type Invasion = {
      */
     factionKey: string;
 };
+import WorldstateObject from './WorldstateObject.js';

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

@@ -1,31 +1,20 @@
-export = Kuva;
-declare class Kuva {
-    constructor({ kuvaData, translator, locale, logger }: {
+/**
+ * Stores and parses kuva data from https://10o.io/kuvalog.json
+ * @property {ExternalMission[]} kuva currently active kuva missions
+ * @property {ExternalMission} arbitration current arbitration
+ */
+export default class Kuva {
+    constructor({ kuvaData, locale, logger }: {
         kuvaData: any;
-        translator: any;
         locale: any;
         logger: any;
     });
-    /**
-     * The translation functions
-     * @type {Translator}
-     * @private
-     */
-    private translator;
-    /**
-     * The locale to leverage for translations
-     * @type {string}
-     * @private
-     */
-    private locale;
-}
-declare namespace Kuva {
-    export { ExternalMission, Kuva };
+    #private;
 }
 /**
  * External mission data retrieved from https://10o.io/kuvalog.json
  */
-type ExternalMission = {
+export type ExternalMission = {
     /**
      * start time
      */
@@ -59,7 +48,7 @@ type ExternalMission = {
 /**
  * Stores and parses kuva data from https://10o.io/kuvalog.json
  */
-type Kuva = {
+export type Kuva = {
     /**
      * currently active kuva missions
      */

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

@@ -1,25 +1,12 @@
-export = Mission;
-declare class Mission {
+/**
+ * Represents an in-game 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: any, { mdConfig, translator, Reward, locale }: {
-        mdConfig: MarkdownSettings;
-        translator: Translator;
-        Reward: Reward;
-        locale: string;
-    });
-    /**
-     * The markdown settings
-     * @type {MarkdownSettings}
-     * @private
-     */
-    private mdConfig;
+    constructor(data: object, { locale }?: string);
     /**
      * The mission's description
      * @type {?string}
@@ -59,7 +46,7 @@ declare class Mission {
      * The mission's reward
      * @type {?Reward}
      */
-    reward: Reward;
+    reward: Reward | null;
     /**
      * The minimum level of the enemies in the mission
      * @type {number}
@@ -97,7 +84,7 @@ declare class Mission {
     levelOverride: string;
     /**
      * Enemy specification for the mission
-     * @type {String}
+     * @type {string}
      */
     enemySpec: string;
     /**
@@ -142,7 +129,8 @@ declare class Mission {
     exclusiveWeapon: string;
     /**
      * The Mission's string representation
-     * @returns {string}
+     * @returns {string} Mission's string representation
      */
     toString(): string;
 }
+import Reward from './Reward.js';

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

@@ -1,24 +1,13 @@
-export = News;
 /**
  * Represents a game news item
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-declare 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: any, { mdConfig, translator, timeDate, locale }: Dependency);
-    /**
-     * The markdown settings
-     * @type {MarkdownSettings}
-     * @private
-     */
-    private mdConfig;
+    constructor(data: object, { locale }?: string);
     /**
      * The news message
      * @type {string}
@@ -56,16 +45,16 @@ declare class News extends WorldstateObject {
     endDate: Date | null;
     /**
      * ETA string (at time of object creation)
-     * @type {String}
+     * @type {string}
      */
     eta: string;
     /**
-     * Whther or not this is an update news item
+     * Whether this is an update news item
      * @type {boolean}
      */
     update: boolean;
     /**
-     * Whther or not this is a prime access news item
+     * Whether this is a prime access news item
      * @type {boolean}
      */
     primeAccess: boolean;
@@ -76,11 +65,9 @@ declare class News extends WorldstateObject {
     stream: boolean;
     /**
      * Translation of the news item
-     * @type {Object.<string, string>}
+     * @type {Record<string, string>}
      */
-    translations: {
-        [x: string]: string;
-    };
+    translations: Record<string, string>;
     /**
      * The string representation of this object at creation
      * @type {string}
@@ -89,29 +76,29 @@ declare 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(): string;
     /**
      * Whether or not this is about a game update
-     * @returns {boolean}
+     * @returns {boolean} whether the news is about an update
      */
     isUpdate(): boolean;
     /**
-     * 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(): boolean;
     /**
-     * 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(): boolean;
     /**
      * 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: string): string;
 }
-import WorldstateObject = require("./WorldstateObject");
+import WorldstateObject from './WorldstateObject.js';

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

@@ -1,37 +1,20 @@
-export = Nightwave;
 /**
  * Represents an alert
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-declare 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: any, { mdConfig, translator, timeDate, Mission, Reward, locale }: {
-        mdConfig: MarkdownSettings;
-        translator: Translator;
-        timeDate: TimeDateFunctions;
-        Mission: Mission;
-        Reward: Reward;
+    constructor(data: object, { locale }?: {
         locale: string;
     });
     id: string;
-    /**
-     * The markdown settings
-     * @type {MarkdownSettings}
-     * @private
-     */
-    private mdConfig;
     /**
      * The current season. 0-indexed.
-     * @type {Number}
+     * @type {number}
      */
     season: number;
     /**
@@ -41,14 +24,14 @@ declare class Nightwave extends WorldstateObject {
     tag: string;
     /**
      * The current season's current phase. 0-indexed.
-     * @type {Number}
+     * @type {number}
      */
     phase: number;
     /**
      * Misc params provided.
-     * @type {Object}
+     * @type {object}
      */
-    params: any;
+    params: object;
     possibleChallenges: any;
     activeChallenges: any;
     /**
@@ -58,13 +41,13 @@ declare class Nightwave extends WorldstateObject {
     rewardTypes: Array<string>;
     /**
      * Get a string indicating how much time is left before the alert expires
-     * @returns {string}
+     * @returns {string} estimated timer of the alert
      */
     getETAString(): string;
     /**
      * 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
      */
     getRewardTypes(): Array<string>;
 }
-import WorldstateObject = require("./WorldstateObject");
+import WorldstateObject from './WorldstateObject.js';

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

@@ -1,29 +1,24 @@
-export = NightwaveChallenge;
 /**
  * Represents an alert
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-declare 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: any, { translator, timeDate, locale }: {
-        translator: Translator;
-        timeDate: TimeDateFunctions;
+    constructor(data: object, { locale }?: {
         locale: string;
     });
     /**
      * Whether or not this is a daily challenge
-     * @type {Boolean}
+     * @type {boolean}
      */
     isDaily: boolean;
     /**
      * Whether or not the challenge is an elite challenge
-     * @type {Boolean}
+     * @type {boolean}
      */
     isElite: boolean;
     /**
@@ -38,8 +33,13 @@ declare class NightwaveChallenge extends WorldstateObject {
     title: string;
     /**
      * Reputation reward for ranking up in the Nightwave
-     * @type {Number}
+     * @type {number}
      */
     reputation: number;
+    /**
+     * Whether this challenge is permanent
+     * @type {boolean}
+     */
+    isPermanent: boolean;
 }
-import WorldstateObject = require("./WorldstateObject");
+import WorldstateObject from './WorldstateObject.js';