warframe-worldstate-parser 2.24.1 → 2.25.0

package/lib/Fissure.js

@@ -2,11 +2,15 @@
 
 const WorldstateObject = require('./WorldstateObject');
 
+/**
+ * @typedef {Object} ContentFissure
+ * @property
+ */
 /**
  * Represents a fissure mission
  * @extends {WorldstateObject}
  */
-class Fissure extends WorldstateObject {
+module.exports = class Fissure extends WorldstateObject {
   /**
    * @param   {Object}             data            The fissure data
    * @param   {Object}             deps            The dependencies object
@@ -90,7 +94,7 @@ class Fissure extends WorldstateObject {
     this.expiry = timeDate.parseDate(data.Expiry);
 
     /**
-     * Whether or not this is expired (at time of object creation)
+     * Whether this is expired (at time of object creation)
      * @type {boolean}
      */
     this.expired = this.getExpired();
@@ -102,14 +106,20 @@ class Fissure extends WorldstateObject {
     this.eta = this.getETAString();
 
     /**
-     * Whether or not this fissure corresponds to a RailJack Void Storm
+     * Whether this fissure corresponds to a RailJack Void Storm
      * @type {Boolean}
      */
     this.isStorm = !!data.ActiveMissionTier;
+
+    /**
+     * Whether this fissure is a Steel Path fissure
+     * @type {boolean}
+     */
+    this.isHard = !!data.Hard;
   }
 
   /**
-   * Get whether or not this deal has expired
+   * Get whether this deal has expired
    * @returns {boolean}
    */
   getExpired() {
@@ -131,6 +141,4 @@ class Fissure extends WorldstateObject {
   toString() {
     return `[${this.getETAString()}] ${this.tier} fissure at ${this.node} - ${this.enemy} ${this.missionType}`;
   }
-}
-
-module.exports = Fissure;
+};

package/lib/Mission.js

@@ -38,13 +38,13 @@ module.exports = class Mission {
      * The node where the mission takes place
      * @type {string}
      */
-    this.node = translator.node(data.location, locale);
+    this.node = translator.node(data.location || data.node, locale);
 
     /**
      * Unlocalized {@link mission#node}
      * @type {string}
      */
-    this.nodeKey = translator.node(data.location, 'en');
+    this.nodeKey = translator.node(data.location || data.node, 'en');
 
     /**
      * The mission's type

package/lib/SentientOutpost.js

@@ -45,6 +45,7 @@ class SentientOutpost {
     if (!data) data = '{"sfn":000}';
     const node = (data.match(/\d{3}/g) || ['000'])[0];
     const id = `CrewBattleNode${node}`;
+    /* istanbul ignore if */
     if (node === '000') {
       this.mission = undefined;
     } else {

package/lib/Sortie.js

@@ -10,14 +10,14 @@ 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, { mdConfig, translator, timeDate, sortieData, SortieVariant, locale }) {
+  constructor(data, { mdConfig, translator, timeDate, sortieData, SortieVariant, locale, Mission }) {
     super(data, { timeDate });
 
     const opts = {
@@ -67,7 +67,9 @@ class Sortie extends WorldstateObject {
      * The sortie's variants
      * @type {Array.<SortieVariant>}
      */
-    this.variants = data.Variants.map((v) => new SortieVariant(v, opts));
+    this.variants = (data.Variants || []).map((v) => new SortieVariant(v, opts));
+
+    this.missions = (data.Missions || []).map((v) => new Mission(v, opts));
 
     /**
      * The sortie's boss
@@ -88,7 +90,7 @@ class Sortie extends WorldstateObject {
     this.factionKey = translator.sortieFaction(data.boss, 'en');
 
     /**
-     * Whether or not this is expired (at time of object creation)
+     * Whether this is expired (at time of object creation)
      * @type {boolean}
      */
     this.expired = this.isExpired();

package/lib/SortieVariant.js

@@ -6,11 +6,10 @@
 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, { mdConfig, translator, locale }) {
     /**
@@ -51,9 +50,9 @@ class SortieVariant {
    * @returns {string}
    */
   toString() {
-    return `${this.node.padEnd(25, ' ')} |  ${this.modifier.padEnd(20, ' ')} | ${this.missionType}${
-      this.mdConfig.lineEnd
-    }`;
+    return this.modifier
+      ? `${this.node.padEnd(25, ' ')} |  ${this.modifier.padEnd(20, ' ')} | ${this.missionType}${this.mdConfig.lineEnd}`
+      : `${this.node.padEnd(25, ' ')} | ${this.missionType}${this.mdConfig.lineEnd}`;
   }
 }
 

package/lib/SteelPathOffering.js

@@ -4,6 +4,7 @@ const monday = 1;
 
 function getFirstDayOfWeek() {
   const resultDate = new Date();
+  /* istanbul ignore next */
   const offset = resultDate.getUTCDay() === 0 ? 6 : resultDate.getUTCDay() - monday;
   resultDate.setUTCDate(resultDate.getUTCDate() - offset);
   resultDate.setUTCHours(0);

package/lib/SyndicateJob.js

@@ -74,6 +74,7 @@ const getBountyRewards = async (i18n, isVault, raw) => {
   if (results) {
     return Array.from(new Set(results.map((result) => result.item)));
   }
+  /* istanbul ignore next */
   return [];
 };
 

package/lib/WorldState.js

@@ -35,12 +35,8 @@ const SentientOutpost = require('./SentientOutpost');
 const CambionCycle = require('./CambionCycle');
 const SteelPathOffering = require('./SteelPathOffering');
 
-/* eslint-disable no-unused-vars */
 // needed for type declarations
-const Dependency = require('./supporting/Dependency');
-const ExternalMission = require('./supporting/ExternalMission');
 const MarkdownSettings = require('./supporting/MarkdownSettings');
-/* eslint-enable no-unused-vars */
 
 const safeArray = (arr) => arr || [];
 const safeObj = (obj) => obj || {};
@@ -78,6 +74,14 @@ const defaultDeps = {
   logger: console,
 };
 
+/**
+ *
+ * @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}
+ */
 function parseArray(ParserClass, dataArray, deps, uniqueField) {
   const arr = (dataArray || []).map((d) => new ParserClass(d, deps));
   if (uniqueField) {
@@ -90,6 +94,7 @@ function parseArray(ParserClass, dataArray, deps, uniqueField) {
       if (Object.prototype.hasOwnProperty.call(obj, 'active')) {
         return obj.active;
       }
+      /* istanbul ignore next */
       return true;
     });
   }
@@ -314,5 +319,11 @@ module.exports = class WorldState {
     this.steelPath = new SteelPathOffering(deps);
 
     [this.vaultTrader] = parseArray(deps.VoidTrader, data.PrimeVaultTraders, deps);
+
+    /**
+     * The current archon hunt
+     * @type {Sortie}
+     */
+    [this.archonHunt] = parseArray(deps.Sortie, data.LiteSorties, deps);
   }
 };

package/lib/WorldstateObject.js

@@ -1,16 +1,41 @@
 'use strict';
 
 /**
- * Represents a generic ojbect from Worldstate
+ * @typedef {Object} Identifier
+ * @property {string} $id older identifier schema
+ * @property {string} $oid newer global identifier schema
  */
-class WorldstateObject {
+/**
+ * @typedef {Object} LegacyTimestamp
+ * @property {number} sec second-based timestamp
+ */
+/**
+ * @typedef {Object} Timestamp
+ * @property {number} $numberLong millisecond-based timestamp
+ */
+/**
+ * @typedef {Object} ContentTimestamp
+ * @property {LegacyTimestamp|Timestamp} $date timestamp number wrapper
+ */
+/**
+ * @typedef {Object} BaseContentObject
+ * @property {Identifier} _id
+ * @property {ContentTimestamp} Activation
+ * @property {ContentTimestamp} Expiry
+ */
+
+/**
+ * Represents a generic object from Worldstate
+ */
+module.exports = class WorldstateObject {
   /**
-   * @param   {Object} data The object data
+   * @param   {BaseContentObject} data The object data
+   * @param   {TimeDateFunctions} timeDate time date functions
    */
   constructor(data, { timeDate }) {
     /**
      * The object's id field
-     * @type {string}
+     * @type {Identifier.$id|Identifier.$oid}
      */
     // eslint-disable-next-line no-underscore-dangle
     this.id = data._id ? data._id.$oid || data._id.$id : undefined;
@@ -48,7 +73,7 @@ class WorldstateObject {
 
     if (data.Activation && data.Expiry) {
       /**
-       * 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}
        */
       this.active = this.isActive();
@@ -64,7 +89,7 @@ class WorldstateObject {
   }
 
   /**
-   * Get whether or not the trader is currently active
+   * Get whether the trader is currently active
    * @returns {boolean}
    */
   isActive() {
@@ -86,6 +111,4 @@ class WorldstateObject {
   getEndString() {
     return this.timeDate.timeDeltaToString(this.timeDate.fromNow(this.expiry));
   }
-}
-
-module.exports = WorldstateObject;
+};

package/lib/ZarimanCycle.js

@@ -91,11 +91,11 @@ module.exports = class ZarimanCycle extends WorldstateObject {
   }
 
   /**
-   * Get whether or not the event has expired
+   * Get whether the event has expired
    * @returns {boolean}
    */
   getExpired() {
-    return this.expiry ? this.timeDate.fromNow(this.expiry) < 0 : true;
+    return this.expiry ? this.timeDate.fromNow(this.expiry) < 0 : /* istanbul ignore next */ true;
   }
 
   getCurrentZarimanCycle() {

package/lib/timeDate.js

@@ -1,15 +1,5 @@
 'use strict';
 
-/**
- * An object containing functions to format dates and times
- * @typedef {Object.<function>}           TimeDateFunctions
- * @property {function} timeDeltaToString - Converts a time difference to a string
- * @property {function} fromNow           - Returns the number of milliseconds between now and
- *                                          a given date
- * @property {function} toNow             - Returns the number of milliseconds between a given
- *                                          date and now
- */
-
 const epochZero = {
   $date: {
     $numberLong: 0,
@@ -42,6 +32,8 @@ function timeDeltaToString(millis) {
     timePieces.push(`${Math.floor(seconds / 60)}m`);
     seconds = Math.floor(seconds) % 60;
   }
+
+  /* istanbul ignore else */
   if (seconds >= 0) {
     timePieces.push(`${Math.floor(seconds)}s`);
   }
@@ -79,6 +71,15 @@ function parseDate(d) {
   return new Date(safeD.$date ? Number(dt.$numberLong) : 1000 * d.sec);
 }
 
+/**
+ * An object containing functions to format dates and times
+ * @typedef {Object.<function>}           TimeDateFunctions
+ * @property {function} timeDeltaToString - Converts a time difference to a string
+ * @property {function} fromNow           - Returns the number of milliseconds between now and
+ *                                          a given date
+ * @property {function} toNow             - Returns the number of milliseconds between a given
+ *                                          date and now
+ */
 module.exports = {
   timeDeltaToString,
   fromNow,

package/lib/translation.js

@@ -1,30 +1,5 @@
 'use strict';
 
-/**
- * An object containing functions to convert in-game names to their localizations
- * @typedef {Object.<function>} Translator
- * @property {function} faction          - Converts faction names
- * @property {function} node             - Converts star map node names
- * @property {function} nodeMissionType  - Returns the mission type of a given node
- * @property {function} nodeEnemy        - Returns the faction that controls a given node
- * @property {function} languageString   - Converts generic language strings
- * @property {function} languageDesc     - Converts generic language strings
- *                                          and retrieves the description
- * @property {function} missionType      - Converts mission types
- * @property {function} conclaveMode     - Converts conclave modes
- * @property {function} conclaveCategory - Converts conclave challenge categories
- * @property {function} fissureModifier  - Converts fissure mission modifiers
- * @property {function} syndicate        - Converts syndicate names
- * @property {function} upgrade          - Converts upgrade types
- * @property {function} operation        - Converts operation types
- * @property {function} sortieBoss       - Converts sortie boss names
- * @property {function} sortieModifer    - Converts sortie modifier types
- * @property {function} sortieModDesc    - Converts sortie modifier type descriptions
- * @property {function} region           - Converts persistent enemy region indicies
- * @property {function} conclaveChallenge - Convert conclave identifiers into standing data
- * @property {function} steelPath        -  Retrieve Steel Path rotation data for locale
- */
-
 const data = require('warframe-worldstate-data');
 
 function toTitleCase(str) {
@@ -218,9 +193,33 @@ function conclaveChallenge(key, dataOverride) {
 }
 
 function steelPath(dataOverride) {
-  return (i18n(dataOverride) || data).steelPath;
+  return (i18n(dataOverride) || /* istanbul ignore next */ data).steelPath;
 }
 
+/**
+ * An object containing functions to convert in-game names to their localizations
+ * @typedef {Object.<function>} Translator
+ * @property {function} faction          - Converts faction names
+ * @property {function} node             - Converts star map node names
+ * @property {function} nodeMissionType  - Returns the mission type of a given node
+ * @property {function} nodeEnemy        - Returns the faction that controls a given node
+ * @property {function} languageString   - Converts generic language strings
+ * @property {function} languageDesc     - Converts generic language strings
+ *                                          and retrieves the description
+ * @property {function} missionType      - Converts mission types
+ * @property {function} conclaveMode     - Converts conclave modes
+ * @property {function} conclaveCategory - Converts conclave challenge categories
+ * @property {function} fissureModifier  - Converts fissure mission modifiers
+ * @property {function} syndicate        - Converts syndicate names
+ * @property {function} upgrade          - Converts upgrade types
+ * @property {function} operation        - Converts operation types
+ * @property {function} sortieBoss       - Converts sortie boss names
+ * @property {function} sortieModifier    - Converts sortie modifier types
+ * @property {function} sortieModDesc    - Converts sortie modifier type descriptions
+ * @property {function} region           - Converts persistent enemy region indicies
+ * @property {function} conclaveChallenge - Convert conclave identifiers into standing data
+ * @property {function} steelPath        -  Retrieve Steel Path rotation data for locale
+ */
 module.exports = {
   faction,
   node,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "warframe-worldstate-parser",
-  "version": "2.24.1",
+  "version": "2.25.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,6 +1,15 @@
 export = CambionCycle;
 declare 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;
+    });
     active: string;
+    id: string;
     /**
      * Get whether or not the event has expired
      * @returns {boolean}

package/types/lib/CetusCycle.d.ts

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

package/types/lib/EarthCycle.d.ts

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

package/types/lib/Fissure.d.ts

@@ -1,8 +1,4 @@
 export = Fissure;
-/**
- * Represents a fissure mission
- * @extends {WorldstateObject}
- */
 declare class Fissure extends WorldstateObject {
     /**
      * @param   {Object}             data            The fissure data
@@ -57,7 +53,7 @@ declare class Fissure extends WorldstateObject {
      */
     tierNum: number;
     /**
-     * Whether or not this is expired (at time of object creation)
+     * Whether this is expired (at time of object creation)
      * @type {boolean}
      */
     expired: boolean;
@@ -67,12 +63,17 @@ declare class Fissure extends WorldstateObject {
      */
     eta: string;
     /**
-     * Whether or not this fissure corresponds to a RailJack Void Storm
+     * Whether this fissure corresponds to a RailJack Void Storm
      * @type {Boolean}
      */
     isStorm: boolean;
     /**
-     * Get whether or not this deal has expired
+     * Whether this fissure is a Steel Path fissure
+     * @type {boolean}
+     */
+    isHard: boolean;
+    /**
+     * Get whether this deal has expired
      * @returns {boolean}
      */
     getExpired(): boolean;

package/types/lib/Nightwave.d.ts

@@ -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

@@ -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/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}

package/types/lib/SyndicateMission.d.ts

@@ -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/WorldState.d.ts

@@ -147,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

@@ -37,9 +37,10 @@ declare class ZarimanCycle extends WorldstateObject {
      * @type {string}
      */
     timeLeft: string;
+    id: string;
     shortString: string;
     /**
-     * Get whether or not the event has expired
+     * Get whether the event has expired
      * @returns {boolean}
      */
     getExpired(): boolean;

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;