warframe-worldstate-parser 2.31.1 → 3.0.0

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

@@ -1,27 +1,16 @@
-export = PersistentEnemy;
 /**
  * Represents a persistent enemy
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-declare 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: any, { mdConfig, translator, timeDate, locale }: {
-        mdConfig: MarkdownSettings;
-        translator: Translator;
+    constructor(data: object, { locale }?: {
         locale: string;
     });
-    /**
-     * The markdown settings
-     * @type {MarkdownSettings}
-     * @private
-     */
-    private mdConfig;
     /**
      * The enemy's type
      * @type {string}
@@ -38,7 +27,7 @@ declare class PersistentEnemy extends WorldstateObject {
      */
     rank: number;
     /**
-     * The enemy's remainaing health percentage
+     * The enemy's remaining health percentage
      * @type {number}
      */
     healthPercent: number;
@@ -64,12 +53,12 @@ declare class PersistentEnemy extends WorldstateObject {
     lastDiscoveredAt: string;
     /**
      * Whether or not the enemy is currently available
-     * @type {Boolean}
+     * @type {boolean}
      */
     isDiscovered: boolean;
     /**
      * Whether or not the enemy is using ticketing
-     * @type {Boolean}
+     * @type {boolean}
      */
     isUsingTicketing: boolean;
     /**
@@ -78,4 +67,4 @@ declare class PersistentEnemy extends WorldstateObject {
      */
     pid: string;
 }
-import WorldstateObject = require("./WorldstateObject");
+import WorldstateObject from './WorldstateObject.js';

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

@@ -1,18 +1,37 @@
-export = Reward;
+/**
+ * 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
+ * @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
+ * @property {string} thumbnail     - Thumbnail url for this reward type
+ * @property {string} color         - Summary color representing this reward type
+ */
+/**
+ * Returns the type of a given item
+ * @param   {string}          item The item whose type needs to be determined
+ * @param   {Array.<RewardType>}  [types] The possible types
+ * @returns {string}          The type name
+ */
+export function getItemType(item: string, types?: Array<RewardType>): string;
+/**
+ * Returns the full type of a given item
+ * @param   {string}          item The item whose type needs to be determined
+ * @param   {Array.<RewardType>}  [types] The possible types
+ * @returns {RewardType}      The type
+ */
+export function getItemTypeFull(item: string, types?: Array<RewardType>): RewardType;
 /**
  * Represents a mission reward
  */
-declare 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: any, { translator, locale }: {
-        translator: Translator;
-        locale: string;
-    });
+    constructor(data: object, { locale }?: Dependency);
     /**
      * The items being rewarded
      * @type {Array.<string>}
@@ -20,9 +39,9 @@ declare class Reward {
     items: Array<string>;
     /**
      * The counted items being rewarded
-     * @type {Array.<Object>}
+     * @type {Array.<object>}
      */
-    countedItems: Array<any>;
+    countedItems: Array<object>;
     /**
      * The credits being rewarded
      * @type {number}
@@ -34,28 +53,25 @@ declare class Reward {
     color: string | number;
     /**
      * The types of all items that are being rewarded
-     * @returns {Array.<string>}
+     * @returns {Array.<string>} types as array of string
      */
     getTypes(): Array<string>;
     /**
      * The types of all the items that are being rewarded
-     * @returns {Array.<RewardType>}
+     * @returns {Array.<RewardType>} array of reward types
      */
     getTypesFull(): Array<RewardType>;
     /**
      * The reward's string representation
-     * @returns {string}
+     * @returns {string} reward's string representation
      */
     toString(): string;
 }
-declare namespace Reward {
-    export { RewardType };
-}
 /**
  * An object describing a type of reward, including name, description,
  * test function to verify type from a string, thumbnail url, and color
  */
-type RewardType = {
+export type RewardType = {
     /**
      * - Name of the reward type
      */

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

@@ -1,7 +1,6 @@
-export = SentientOutpost;
 /**
  * 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
@@ -14,35 +13,32 @@ export = SentientOutpost;
  * @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
  */
-declare class SentientOutpost {
-    constructor(data: any, { translator, locale, sentientData, logger }: {
-        translator: any;
+export default class SentientOutpost {
+    constructor(data: any, { locale, sentientData, logger }: {
         locale: any;
         sentientData: any;
         logger: any;
     });
     mission: {
-        node: any;
-        faction: any;
-        type: any;
+        node: string;
+        faction: string;
+        type: string;
     };
     active: boolean;
     id: string;
     activation: Date;
     expiry: Date;
-}
-declare namespace SentientOutpost {
-    export { Mission };
+    #private;
 }
 /**
  * Mission typeDef
  */
-type Mission = {
+export type Mission = {
     /**
      * Mission node name
      */

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

@@ -1,26 +1,15 @@
-export = Simaris;
 /**
  * Contains information about sanctuary targets
  */
-declare 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: any, { mdConfig, translator, locale }: {
-        mdConfig: MarkdownSettings;
-        translator: Translator;
+    constructor(data: object, { locale }?: {
         locale: string;
     });
-    /**
-     * The markdown settings
-     * @type {MarkdownSettings}
-     * @private
-     */
-    private mdConfig;
     /**
      * The sanctuary target
      * @type {string}
@@ -28,7 +17,7 @@ declare class Simaris {
     target: string;
     /**
      * Whether or not the target is currently active
-     * @type {Boolean}
+     * @type {boolean}
      */
     isTargetActive: boolean;
     /**
@@ -38,7 +27,7 @@ declare class Simaris {
     asString: string;
     /**
      * Returns a string representation of the current sanctuary status
-     * @returns {string}
+     * @returns {string} a string representation of the current sanctuary status
      */
     toString(): string;
 }

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

@@ -1,26 +1,16 @@
-export = Sortie;
 /**
  * Represents a daily sortie
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-declare 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: any, { mdConfig, translator, timeDate, sortieData, SortieVariant, locale, Mission }: any);
-    /**
-     * The markdown settings
-     * @type {MarkdownSettings}
-     * @private
-     */
-    private mdConfig;
+    constructor(data: object, { locale }?: {
+        locale: string;
+    });
     /**
      * The sortie's reward pool
      * @type {string}
@@ -30,7 +20,7 @@ declare class Sortie extends WorldstateObject {
      * The sortie's variants
      * @type {Array.<SortieVariant>}
      */
-    variants: Array<any>;
+    variants: Array<SortieVariant>;
     missions: any;
     /**
      * The sortie's boss
@@ -54,28 +44,29 @@ declare class Sortie extends WorldstateObject {
     expired: boolean;
     /**
      * ETA string (at time of object creation)
-     * @type {String}
+     * @type {string}
      */
     eta: string;
     /**
      * Get the sortie's boss
-     * @returns {string}
+     * @returns {string} the sortie's boss
      */
     getBoss(): string;
     /**
      * Get the sortie's faction
-     * @returns {string}
+     * @returns {string} the sortie's faction
      */
     getFaction(): string;
     /**
      * Gets a string indicating how long it will take for the sortie to end
-     * @returns {string}
+     * @returns {string} estimated time of arrival
      */
     getETAString(): string;
     /**
      * Get whether or not the sortie has expired
-     * @returns {boolean}
+     * @returns {boolean} whether the sortie has expired
      */
     isExpired(): boolean;
 }
-import WorldstateObject = require("./WorldstateObject");
+import WorldstateObject from './WorldstateObject.js';
+import SortieVariant from './SortieVariant.js';

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

@@ -1,27 +1,24 @@
-export = SortieVariant;
 /**
  * Represents a sortie variant
+ * @class
  */
-declare 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: any, { mdConfig, translator, locale }: MarkdownSettings);
-    /**
-     * The markdown settings
-     * @type {MarkdownSettings}
-     * @private
-     */
-    private mdConfig;
+    constructor(data: object, { locale }?: {
+        locale: string;
+    });
     /**
      * The variant's mission type
      * @type {string}
      */
     missionType: string;
+    missionTypeKey: string;
     /**
      * The variant's modifier
      * @type {string}
@@ -37,9 +34,10 @@ declare class SortieVariant {
      * @type {string}
      */
     node: string;
+    nodeKey: string;
     /**
      * Returns a string representation of the sortie variant
-     * @returns {string}
+     * @returns {string} string representation
      */
     toString(): string;
 }

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

@@ -1,22 +1,19 @@
-export = SteelPathOffering;
-declare class SteelPathOffering {
-    constructor({ timeDate, translator, locale }: {
-        timeDate: any;
-        translator: any;
+export default class SteelPathOffering {
+    constructor({ locale }: {
         locale: any;
     });
     currentReward: any;
     activation: Date;
     expiry: Date;
-    remaining: any;
+    remaining: string;
     rotation: any;
     evergreens: any;
     /**
      * General data pertaining to incursions
-     * @type {Object}
+     * @type {object}
      * @property {string} id Identifier for steel path incursion based on start of day.
      * @property {Date} activation when the current incursions became active
      * @property {Date} expiry when the current incursions become inactive
      */
-    incursions: any;
+    incursions: object;
 }

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

@@ -1,26 +1,25 @@
-export = SyndicateJob;
 /**
  * Represents a syndicate daily mission
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-declare class SyndicateJob extends WorldstateObject {
+export default class SyndicateJob extends WorldstateObject {
     /**
-     * @param {Object} data The syndicate mission data
+     * @param {object} data The syndicate mission data
      * @param {Date} expiry The syndicate job expiration
-     * @param {Object} deps The dependencies object
-     * @param {Object} timeDate Time/Date functions
-     * @param {Translator} translator The string translator
-     * @param {string} locale Locale to use for translations
+     * @param {object} deps The dependencies object
+     * @param {string} deps.locale Locale to use for translations
      */
-    constructor(data: any, expiry: Date, { translator, timeDate, locale }: any);
+    constructor(data: object, expiry: Date, { locale }: {
+        locale: string;
+    });
     /**
      * Array of strings describing rewards
-     * @type {Array.<String>}
+     * @type {Array.<string>}
      */
     rewardPool: Array<string>;
     /**
      * The type of job this is
-     * @type {String}
+     * @type {string}
      */
     type: string;
     /**
@@ -35,13 +34,13 @@ declare class SyndicateJob extends WorldstateObject {
     standingStages: Array<number>;
     /**
      * Minimum mastery required to participate
-     * @type {Number}
+     * @type {number}
      */
     minMR: number;
     /**
      * Whether or not this is a Vault job.
      * No indication for difference of normal vs arcana vaults.
-     * @type {Boolean}
+     * @type {boolean}
      */
     isVault: boolean;
     /**
@@ -56,4 +55,4 @@ declare class SyndicateJob extends WorldstateObject {
     timeBound: string;
     timeBoound: string;
 }
-import WorldstateObject = require("./WorldstateObject");
+import WorldstateObject from './WorldstateObject.js';

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

@@ -1,29 +1,16 @@
-export = SyndicateMission;
 /**
  * Represents a syndicate daily mission
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-declare class SyndicateMission extends WorldstateObject {
+export default class SyndicateMission extends WorldstateObject {
     /**
-     * @param   {Object}             data            The syndicate mission 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 syndicate mission 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 syndicate that is offering the mission
      * @type {string}
@@ -46,14 +33,14 @@ declare class SyndicateMission extends WorldstateObject {
     jobs: Array<SyndicateJob>;
     /**
      * ETA string (at time of object creation)
-     * @type {String}
+     * @type {string} time delta string from now to the expiry
      */
     eta: string;
     /**
      * Get a string indicating how much time is left before the syndicate mission expries
-     * @returns {string}
+     * @returns {string} time delta string from now to the expiry
      */
     getETAString(): string;
 }
-import WorldstateObject = require("./WorldstateObject");
-import SyndicateJob = require("./SyndicateJob");
+import WorldstateObject from './WorldstateObject.js';
+import SyndicateJob from './SyndicateJob.js';

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

@@ -1,22 +1,9 @@
-export = VallisCycle;
 /**
  * Represents the current Earth Day/Night Cycle
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-declare class VallisCycle 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({ mdConfig, timeDate }: Date);
-    /**
-     * The markdown settings
-     * @type {MarkdownSettings}
-     * @private
-     */
-    private mdConfig;
+export default class VallisCycle extends WorldstateObject {
+    constructor();
     /**
      * Whether or not this it's daytime
      * @type {boolean}
@@ -36,8 +23,31 @@ declare class VallisCycle extends WorldstateObject {
     shortString: string;
     /**
      * Get whether or not the event has expired
-     * @returns {boolean}
+     * @returns {boolean} whether this event has expired
      */
     getExpired(): boolean;
+    #private;
 }
-import WorldstateObject = require("./WorldstateObject");
+export type CurrentCycle = {
+    /**
+     * - Current cycle state. One of `warm`, `cold`
+     */
+    state: string;
+    /**
+     * - Time remaining in the current cycle state
+     */
+    toNextMinor: number;
+    /**
+     * - Time remaining until the next cycle
+     */
+    toNextFull: number;
+    /**
+     * - Date and time at which the event started
+     */
+    timeAtPrevious: Date;
+    /**
+     * - Date and time at which the event start
+     */
+    timeAtNext: Date;
+};
+import WorldstateObject from './WorldstateObject.js';

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

@@ -1,29 +1,16 @@
-export = VoidTrader;
 /**
  * Represents a void trader
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-declare class VoidTrader extends WorldstateObject {
+export default class VoidTrader extends WorldstateObject {
     /**
-     * @param   {Object}             data            The Void trader 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 Void trader 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 void trader's name
      * @type {string}
@@ -50,9 +37,9 @@ declare class VoidTrader extends WorldstateObject {
      * @type {string}
      */
     endString: string;
-    initialStart: any;
+    initialStart: Date;
     completed: any;
     schedule: any;
 }
-import WorldstateObject = require("./WorldstateObject");
-import VoidTraderItem = require("./VoidTraderItem");
+import WorldstateObject from './WorldstateObject.js';
+import VoidTraderItem from './VoidTraderItem.js';

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

@@ -1,27 +1,25 @@
-export = VoidTraderItem;
 /**
  * A void trader inventory item
  * @property {string} item The name of the inventory item
  * @property {number|string} ducats Ducat cost of the item
  * @property {number|string} credits Credit cost of the item
  */
-declare class VoidTraderItem {
+export default class VoidTraderItem {
     /**
-     * @param   {Object}             data            The void trader item data
+     * @param   {object}             data            The void trader item data
      * @param   {string}             data.ItemType   Worldstate Item i18n path
      * @param   {string}             data.PrimePrice Ducat cost of the item
      * @param   {string}             data.RegularPrice Credit price of the item
      * @param   {Dependency}         deps            The dependencies object
-     * @param   {Translator}         deps.translator The string translator
      * @param   {string}             deps.locale     Locale to use for translations
      */
     constructor({ ItemType, PrimePrice, RegularPrice }: {
         ItemType: string;
         PrimePrice: string;
         RegularPrice: string;
-    }, { translator, locale }: Dependency);
+    }, { locale }?: Dependency);
     uniqueName: string;
-    item: any;
+    item: string;
     ducats: number;
     credits: number;
 }