warframe-worldstate-parser 2.23.2 → 2.25.0

package/types/lib/Mission.d.ts

@@ -1,7 +1,4 @@
 export = Mission;
-/**
- * Represents an in-game mission
- */
 declare class Mission {
     /**
      * @param   {Object}             data            The mission data
@@ -11,7 +8,7 @@ declare class Mission {
      * @param   {Reward}             deps.Reward     The Reward parser
      * @param   {string}             deps.locale     Locale to use for translations
      */
-    constructor(data: any, { mdConfig, translator, Reward, locale, }: {
+    constructor(data: any, { mdConfig, translator, Reward, locale }: {
         mdConfig: MarkdownSettings;
         translator: Translator;
         Reward: Reward;
@@ -33,11 +30,21 @@ declare class Mission {
      * @type {string}
      */
     node: string;
+    /**
+     * Unlocalized {@link mission#node}
+     * @type {string}
+     */
+    nodeKey: string;
     /**
      * The mission's type
      * @type {string}
      */
     type: string;
+    /**
+     * The mission's type
+     * @type {string}
+     */
+    typeKey: string;
     /**
      * The factions that the players must fight in the mission
      * @type {string}

package/types/lib/News.d.ts

@@ -107,10 +107,10 @@ declare class News extends WorldstateObject {
      */
     isStream(): boolean;
     /**
-    * The title of the news item in the specified language
-    * @param {string} langCode Ex. 'es', 'de', 'fr'
-    * @returns {string}
-    */
+     * The title of the news item in the specified language
+     * @param {string} langCode Ex. 'es', 'de', 'fr'
+     * @returns {string}
+     */
     getTitle(langCode: string): string;
 }
 import WorldstateObject = require("./WorldstateObject");

package/types/lib/Nightwave.d.ts

@@ -14,7 +14,7 @@ declare class Nightwave extends WorldstateObject {
      * @param   {Reward}             deps.Reward     The Reward parser
      * @param   {string}             deps.locale     Locale to use for translations
      */
-    constructor(data: any, { mdConfig, translator, timeDate, Mission, Reward, locale, }: {
+    constructor(data: any, { mdConfig, translator, timeDate, Mission, Reward, locale }: {
         mdConfig: MarkdownSettings;
         translator: Translator;
         timeDate: TimeDateFunctions;
@@ -22,6 +22,7 @@ declare class Nightwave extends WorldstateObject {
         Reward: Reward;
         locale: string;
     });
+    id: string;
     /**
      * The markdown settings
      * @type {MarkdownSettings}

package/types/lib/NightwaveChallenge.d.ts

@@ -11,7 +11,7 @@ declare class NightwaveChallenge extends WorldstateObject {
      * @param   {TimeDateFunctions}  deps.timeDate   The time and date functions
      * @param   {string}             deps.locale     Locale to use for translations
      */
-    constructor(data: any, { translator, timeDate, locale, }: {
+    constructor(data: any, { translator, timeDate, locale }: {
         translator: Translator;
         timeDate: TimeDateFunctions;
         locale: string;
@@ -36,6 +36,12 @@ declare class NightwaveChallenge extends WorldstateObject {
      * @type {string}
      */
     title: string;
+    /**
+     * Generated id from expiry, challenge string,
+     *  and whether or not it has `[PH]` (designating placeholder text)
+     * @type {string}
+     */
+    id: string;
     /**
      * Reputation reward for ranking up in the Nightwave
      * @type {Number}

package/types/lib/PersistentEnemy.d.ts

@@ -11,7 +11,7 @@ declare class PersistentEnemy extends WorldstateObject {
      * @param   {Translator}         deps.translator The string translator
      * @param   {string}             deps.locale     Locale to use for translations
      */
-    constructor(data: any, { mdConfig, translator, timeDate, locale, }: {
+    constructor(data: any, { mdConfig, translator, timeDate, locale }: {
         mdConfig: MarkdownSettings;
         translator: Translator;
         locale: string;

package/types/lib/SentientOutpost.d.ts

@@ -20,7 +20,7 @@ export = SentientOutpost;
  * @property {Date}    previous.expiry     When the mission became or becomes inactive
  */
 declare class SentientOutpost {
-    constructor(data: any, { translator, locale, sentientData, logger, }: {
+    constructor(data: any, { translator, locale, sentientData, logger }: {
         translator: any;
         locale: any;
         sentientData: any;

package/types/lib/Sortie.d.ts

@@ -7,21 +7,14 @@ declare class Sortie extends WorldstateObject {
     /**
      * @param   {Object}            data               The data for all daily sorties
      * @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}            deps.sortieData    The data used to parse sorties
-     * @param   {SortieVariant}     deps.SortieVariant The sortie variant parser
-     * @param   {string}            deps.locale        Locale to use for translations
+     * @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
      */
-    constructor(data: any, { mdConfig, translator, timeDate, sortieData, SortieVariant, locale, }: {
-        mdConfig: MarkdownSettings;
-        translator: Translator;
-        timeDate: TimeDateFunctions;
-        sortieData: any;
-        SortieVariant: SortieVariant;
-        locale: string;
-    });
+    constructor(data: any, { mdConfig, translator, timeDate, sortieData, SortieVariant, locale, Mission }: any);
     /**
      * The markdown settings
      * @type {MarkdownSettings}
@@ -37,7 +30,8 @@ declare class Sortie extends WorldstateObject {
      * The sortie's variants
      * @type {Array.<SortieVariant>}
      */
-    variants: Array<SortieVariant>;
+    variants: Array<any>;
+    missions: any;
     /**
      * The sortie's boss
      * @type {string}
@@ -54,7 +48,7 @@ declare class Sortie extends WorldstateObject {
      */
     factionKey: string;
     /**
-     * Whether or not this is expired (at time of object creation)
+     * Whether this is expired (at time of object creation)
      * @type {boolean}
      */
     expired: boolean;

package/types/lib/SortieVariant.d.ts

@@ -5,18 +5,12 @@ export = SortieVariant;
 declare class SortieVariant {
     /**
      * @param   {Object}            data               Sortie variant data
-     * @param   {Object}            deps               The dependencies object
-     * @param   {MarkdownSettings}  deps.mdConfig      The markdown settings
-     * @param   {Translator}        deps.translator    The string translator
-     * @param   {Object}            deps.sortieData    The data used to parse sorties
-     * @param   {string}            deps.locale        Locale to use for translations
+     * @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
      */
-    constructor(data: any, { mdConfig, translator, locale, }: {
-        mdConfig: MarkdownSettings;
-        translator: Translator;
-        sortieData: any;
-        locale: string;
-    });
+    constructor(data: any, { mdConfig, translator, locale }: MarkdownSettings);
     /**
      * The markdown settings
      * @type {MarkdownSettings}
@@ -24,19 +18,19 @@ declare class SortieVariant {
      */
     private mdConfig;
     /**
-       * The variant's mission type
-       * @type {string}
-       */
+     * The variant's mission type
+     * @type {string}
+     */
     missionType: string;
     /**
-       * The variant's modifier
-       * @type {string}
-       */
+     * The variant's modifier
+     * @type {string}
+     */
     modifier: string;
     /**
-       * The variant's modifier description
-       * @type {string}
-       */
+     * The variant's modifier description
+     * @type {string}
+     */
     modifierDescription: string;
     /**
      * The node where the variant takes place

package/types/lib/SyndicateMission.d.ts

@@ -12,7 +12,7 @@ declare class SyndicateMission extends WorldstateObject {
      * @param   {TimeDateFunctions}  deps.timeDate   The time and date functions
      * @param   {string}             deps.locale     Locale to use for translations
      */
-    constructor(data: any, { mdConfig, translator, timeDate, locale, }: {
+    constructor(data: any, { mdConfig, translator, timeDate, locale }: {
         mdConfig: MarkdownSettings;
         translator: Translator;
         timeDate: TimeDateFunctions;
@@ -50,6 +50,11 @@ declare class SyndicateMission extends WorldstateObject {
      * @type {Array.<SyndicateJob>}
      */
     jobs: Array<SyndicateJob>;
+    /**
+     * Unique identifier for this mission set built from the end time and syndicate
+     * @type {string}
+     */
+    id: string;
     /**
      * ETA string (at time of object creation)
      * @type {String}

package/types/lib/VallisCycle.d.ts

@@ -32,6 +32,7 @@ declare class VallisCycle extends WorldstateObject {
      * @type {string}
      */
     timeLeft: string;
+    id: string;
     shortString: string;
     /**
      * Get whether or not the event has expired

package/types/lib/VoidTrader.d.ts

@@ -12,7 +12,7 @@ declare class VoidTrader extends WorldstateObject {
      * @param   {TimeDateFunctions}  deps.timeDate   The time and date functions
      * @param   {string}             deps.locale     Locale to use for translations
      */
-    constructor(data: any, { mdConfig, translator, timeDate, locale, }: {
+    constructor(data: any, { mdConfig, translator, timeDate, locale }: {
         mdConfig: MarkdownSettings;
         translator: Translator;
         timeDate: TimeDateFunctions;

package/types/lib/WorldEvent.d.ts

@@ -30,7 +30,7 @@ declare class WorldEvent extends WorldstateObject {
      * @param   {Reward}            deps.Reward     The Reward parser
      * @param   {string}            deps.locale     Locale to use for translations
      */
-    constructor(data: any, { mdConfig, translator, timeDate, Reward, locale, }: {
+    constructor(data: any, { mdConfig, translator, timeDate, Reward, locale }: {
         mdConfig: MarkdownSettings;
         translator: Translator;
         timeDate: TimeDateFunctions;
@@ -128,9 +128,9 @@ declare class WorldEvent extends WorldstateObject {
     interimSteps: InterimStep[];
     /**
      * Progress Steps, if any are present
-     * @type {ProgessStep[]}
+     * @type {ProgressStep[]}
      */
-    progressSteps: ProgessStep[];
+    progressSteps: ProgressStep[];
     /**
      * Total of all MultiProgress
      * @type {Number}

package/types/lib/WorldState.d.ts

@@ -91,6 +91,11 @@ declare class WorldState {
      * @type {CambionCycle}
      */
     cambionCycle: CambionCycle;
+    /**
+     * The current Zariman cycle based off current time
+     * @type {ZarimanCycle}
+     */
+    zarimanCycle: ZarimanCycle;
     /**
      * Weekly challenges
      * @type {Array.<WeeklyChallenge>}
@@ -142,4 +147,3 @@ import VallisCycle = require("./VallisCycle");
 import Nightwave = require("./Nightwave");
 import SentientOutpost = require("./SentientOutpost");
 import SteelPathOffering = require("./SteelPathOffering");
-import Dependency = require("./supporting/Dependency");

package/types/lib/WorldstateObject.d.ts

@@ -1,19 +1,15 @@
 export = WorldstateObject;
-/**
- * Represents a generic ojbect from Worldstate
- */
 declare class WorldstateObject {
     /**
-     * @param   {Object} data The object data
+     * @param   {BaseContentObject} data The object data
+     * @param   {TimeDateFunctions} timeDate time date functions
      */
-    constructor(data: any, { timeDate }: {
-        timeDate: any;
-    });
+    constructor(data: BaseContentObject, { timeDate }: TimeDateFunctions);
     /**
      * The object's id field
-     * @type {string}
+     * @type {Identifier.$id|Identifier.$oid}
      */
-    id: string;
+    id: Identifier.$id | Identifier.$oid;
     /**
      * The time and date functions
      * @type {TimeDateFunctions}
@@ -37,7 +33,7 @@ declare class WorldstateObject {
      */
     expiry: Date;
     /**
-     * Whether or not the void trader is active (at time of object creation)
+     * Whether the void trader is active (at time of object creation)
      * @type {boolean}
      */
     active: boolean;
@@ -47,7 +43,7 @@ declare class WorldstateObject {
      */
     toString(): string;
     /**
-     * Get whether or not the trader is currently active
+     * Get whether the trader is currently active
      * @returns {boolean}
      */
     isActive(): boolean;
@@ -62,3 +58,39 @@ declare class WorldstateObject {
      */
     getEndString(): string;
 }
+declare namespace WorldstateObject {
+    export { Identifier, LegacyTimestamp, Timestamp, ContentTimestamp, BaseContentObject };
+}
+type BaseContentObject = {
+    _id: Identifier;
+    Activation: ContentTimestamp;
+    Expiry: ContentTimestamp;
+};
+type Identifier = {
+    /**
+     * older identifier schema
+     */
+    $id: string;
+    /**
+     * newer global identifier schema
+     */
+    $oid: string;
+};
+type LegacyTimestamp = {
+    /**
+     * second-based timestamp
+     */
+    sec: number;
+};
+type Timestamp = {
+    /**
+     * millisecond-based timestamp
+     */
+    $numberLong: number;
+};
+type ContentTimestamp = {
+    /**
+     * timestamp number wrapper
+     */
+    $date: LegacyTimestamp | Timestamp;
+};

package/types/lib/ZarimanCycle.d.ts

@@ -0,0 +1,56 @@
+export = ZarimanCycle;
+declare class ZarimanCycle extends WorldstateObject {
+    /**
+     * @param   {Date}              bountiesEndDate The current zariman cycle expiry
+     * @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 Zariman bounties timer, the faction changes exactly half way through
+     * @type {Date}
+     * @private
+     */
+    private bountiesEndDate;
+    /**
+     * Whether or not this it's corpus or grineer
+     * @type {boolean}
+     */
+    isCorpus: boolean;
+    /**
+     * Current cycle state. One of `corpus`, `grineer`
+     * @type {string}
+     */
+    state: string;
+    /**
+     * Time remaining string
+     * @type {string}
+     */
+    timeLeft: string;
+    id: string;
+    shortString: string;
+    /**
+     * Get whether the event has expired
+     * @returns {boolean}
+     */
+    getExpired(): boolean;
+    getCurrentZarimanCycle(): {
+        isCorpus: boolean;
+        timeLeft: any;
+        expiry: Date;
+        expiresIn: any;
+        state: string;
+        start: number;
+    };
+}
+import WorldstateObject = require("./WorldstateObject");

package/types/main.d.ts

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