warframe-worldstate-parser 2.31.1 → 3.0.0

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

@@ -1,10 +1,7 @@
-export = VoidTraderSchedule;
-declare class VoidTraderSchedule {
-    constructor(data: any, { timeDate, translator, locale }: {
-        timeDate: any;
-        translator: any;
-        locale: any;
+export default class VoidTraderSchedule {
+    constructor(data: any, { locale }?: {
+        locale?: string;
     });
-    expiry: any;
-    item: any;
+    expiry: Date;
+    item: string;
 }

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

@@ -1,21 +1,12 @@
-export = WeeklyChallenge;
 /**
  * Represents a void trader
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-declare class WeeklyChallenge extends WorldstateObject {
+export default class WeeklyChallenge 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
      */
-    constructor(data: any, { timeDate, translator }: {
-        mdConfig: MarkdownSettings;
-        translator: Translator;
-        timeDate: TimeDateFunctions;
-    });
+    constructor(data: object);
     challenges: any;
 }
-import WorldstateObject = require("./WorldstateObject");
+import WorldstateObject from './WorldstateObject.js';

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

@@ -1,48 +1,30 @@
-export = WorldEvent;
 /**
  * Interim step for an event reward system.
- * @typedef {Object} InterimStep
- *
- * @property {Number} goal          Goal amount
+ * @typedef {object} InterimStep
+ * @property {number} goal          Goal amount
  * @property {Reward} reward        Reward for reaching the step
- * @property {Number} winnerCount   Amount of players at this step
- * @property {Object} message       Message received when reaching the interim step
+ * @property {number} winnerCount   Amount of players at this step
+ * @property {object} message       Message received when reaching the interim step
  */
 /**
  * Progress for one of multiple stages
- * @typedef {Object} ProgressStep
- *
- * @property {string} type
- * @property {Number} progressAmt
+ * @typedef {object} ProgressStep
+ * @property {string} type         Type of progress
+ * @property {number} progressAmt Amount of progress
  */
 /**
  * Represents an in-game special event
- *
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-declare class WorldEvent extends WorldstateObject {
-    /**
-     * @param   {Object}            data            The event 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
+export default class WorldEvent extends WorldstateObject {
+    /**
+     * @param   {object}            data            The event data
+     * @param   {object}            deps            The dependencies object
      * @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;
+    constructor(data: object, { locale }?: {
         locale: string;
     });
-    /**
-     * The markdown settings
-     * @type {MarkdownSettings}
-     * @private
-     */
-    private mdConfig;
     /**
      * The event's main score goal
      * @type {number}
@@ -110,15 +92,15 @@ declare class WorldEvent extends WorldstateObject {
     expired: boolean;
     /**
      * Health remaining for the target
-     * @type {Number}
+     * @type {number}
      */
     health: number;
-    affiliatedWith: any;
+    affiliatedWith: string;
     jobs: any;
     previousJobs: any;
     /**
      * Previous job id
-     * @type {String}
+     * @type {string}
      */
     previousId: string;
     /**
@@ -133,7 +115,7 @@ declare class WorldEvent extends WorldstateObject {
     progressSteps: ProgressStep[];
     /**
      * Total of all MultiProgress
-     * @type {Number}
+     * @type {number}
      */
     progressTotal: number;
     /**
@@ -143,12 +125,12 @@ declare class WorldEvent extends WorldstateObject {
     showTotalAtEndOfMission: boolean;
     /**
      * Whether or not the event is personal
-     * @type {Boolean}
+     * @type {boolean}
      */
     isPersonal: boolean;
     /**
      * Whether or not the event is community
-     * @type {Boolean}
+     * @type {boolean}
      */
     isCommunity: boolean;
     /**
@@ -164,35 +146,31 @@ declare class WorldEvent extends WorldstateObject {
     asString: string;
     /**
      * Metadata provided by DE
-     * @type {Object}
+     * @type {object}
      */
-    metadata: any;
+    metadata: object;
     /**
      * Bonuses given for completion
-     * @type {Array.<Number>}
+     * @type {Array.<number>}
      */
     completionBonuses: Array<number>;
     scoreVar: any;
-    altExpiry: any;
-    altActivation: any;
+    altExpiry: Date;
+    altActivation: Date;
     nextAlt: {
-        expiry: any;
-        activation: any;
+        expiry: Date;
+        activation: Date;
     };
     /**
      * Get whether or not the event has expired
-     * @returns {boolean}
+     * @returns {boolean} whether the event has expired
      */
     getExpired(): boolean;
 }
-declare namespace WorldEvent {
-    export { InterimStep, ProgressStep };
-}
-import WorldstateObject = require("./WorldstateObject");
 /**
  * Interim step for an event reward system.
  */
-type InterimStep = {
+export type InterimStep = {
     /**
      * Goal amount
      */
@@ -208,12 +186,20 @@ type InterimStep = {
     /**
      * Message received when reaching the interim step
      */
-    message: any;
+    message: object;
 };
 /**
  * Progress for one of multiple stages
  */
-type ProgressStep = {
+export type ProgressStep = {
+    /**
+     * Type of progress
+     */
     type: string;
+    /**
+     * Amount of progress
+     */
     progressAmt: number;
 };
+import WorldstateObject from './WorldstateObject.js';
+import Reward from './Reward.js';

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

@@ -1,23 +1,39 @@
-export = WorldstateObject;
-declare class WorldstateObject {
+/**
+ * @typedef {object} Identifier
+ * @property {string} $id older identifier schema
+ * @property {string} $oid newer global identifier schema
+ */
+/**
+ * @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 object identifier
+ * @property {ContentTimestamp} Activation activation timestamp
+ * @property {ContentTimestamp} Expiry expiry timestamp
+ */
+/**
+ * Represents a generic object from Worldstate
+ */
+export default class WorldstateObject {
     /**
      * @param   {BaseContentObject} data The object data
-     * @param   {TimeDateFunctions} timeDate time date functions
-     * @param   {Translator} translator translation functions
      */
-    constructor(data: BaseContentObject, { timeDate, translator }: TimeDateFunctions);
+    constructor(data: BaseContentObject);
     /**
      * The object's id field
      * @type {Identifier.$id|Identifier.$oid}
      */
     id: Identifier.$id | Identifier.$oid;
-    /**
-     * The time and date functions
-     * @type {TimeDateFunctions}
-     * @private
-     */
-    private timeDate;
-    translator: any;
     /**
      * The date and time at which the void trader arrives
      * @type {Date}
@@ -41,34 +57,26 @@ declare class WorldstateObject {
     active: boolean;
     /**
      * Returns a string representation of the object
-     * @returns {string}
+     * @returns {string} basic representation from the id
      */
     toString(): string;
     /**
      * Get whether the trader is currently active
-     * @returns {boolean}
+     * @returns {boolean} whether the trader is active
      */
     isActive(): boolean;
     /**
      * Get a string indicating how long it will take for the trader to arrive
-     * @returns {string}
+     * @returns {string} time delta string from now to the start
      */
     getStartString(): string;
     /**
      * Get a string indicating how long it will take for the trader to leave
-     * @returns {string}
+     * @returns {string} time delta string from now to the end
      */
     getEndString(): string;
 }
-declare namespace WorldstateObject {
-    export { Identifier, LegacyTimestamp, Timestamp, ContentTimestamp, BaseContentObject };
-}
-type BaseContentObject = {
-    _id: Identifier;
-    Activation: ContentTimestamp;
-    Expiry: ContentTimestamp;
-};
-type Identifier = {
+export type Identifier = {
     /**
      * older identifier schema
      */
@@ -78,21 +86,35 @@ type Identifier = {
      */
     $oid: string;
 };
-type LegacyTimestamp = {
+export type LegacyTimestamp = {
     /**
      * second-based timestamp
      */
     sec: number;
 };
-type Timestamp = {
+export type Timestamp = {
     /**
      * millisecond-based timestamp
      */
     $numberLong: number;
 };
-type ContentTimestamp = {
+export type ContentTimestamp = {
     /**
      * timestamp number wrapper
      */
     $date: LegacyTimestamp | Timestamp;
 };
+export type BaseContentObject = {
+    /**
+     * object identifier
+     */
+    _id: Identifier;
+    /**
+     * activation timestamp
+     */
+    Activation: ContentTimestamp;
+    /**
+     * expiry timestamp
+     */
+    Expiry: ContentTimestamp;
+};

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

@@ -1,31 +1,12 @@
-export = ZarimanCycle;
 /**
  * Represents the current Zariman Corpus/Grineer Cycle
- * @extends {WorldstateObject}
+ * @augments {WorldstateObject}
  */
-declare class ZarimanCycle extends WorldstateObject {
+export default 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
+     * @param {Date} bountiesEndDate The current Zariman cycle expiry
      */
-    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;
+    constructor(bountiesEndDate: Date);
     /**
      * Whether or not this it's corpus or grineer
      * @type {boolean}
@@ -45,16 +26,17 @@ declare class ZarimanCycle extends WorldstateObject {
     shortString: string;
     /**
      * Get whether the event has expired
-     * @returns {boolean}
+     * @returns {boolean} whether this is expired
      */
     getExpired(): boolean;
     getCurrentZarimanCycle(): {
         isCorpus: 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/supporting/Dependency.d.ts

@@ -1,13 +1,7 @@
-export = Dependency;
 /**
  * Dependency Object
- * @property   {MarkdownSettings}   mdConfig   The markdown settings
- * @property   {Translator}         translator The string translator
- * @property   {TimeDateFunctions}  timeDate   The time and date functions
- * @property   {Mission}            Mission    The Mission parser
- * @property   {Reward}             Reward     The Reward parser
  * @property   {string}             locale     Locale to use for translations
- * @property   {Object}             logger     Generic logger to use if needed
+ * @property   {object}             logger     Generic logger to use if needed
  */
-declare class Dependency {
+export default class Dependency {
 }

package/types/lib/supporting/DuviriChoice.d.ts

@@ -1,8 +1,7 @@
-export = DuviriChoice;
 /**
  * Single category of duviri choices
  */
-declare class DuviriChoice {
+export default class DuviriChoice {
     constructor(data: any);
     category: string;
     categoryKey: any;

package/types/lib/supporting/ExternalMission.d.ts

@@ -1,7 +1,6 @@
-export = ExternalMission;
 /**
  * External mission data retrieved from https://10o.io/kuvalog.json
- * @typedef {Object} ExternalMission
+ * @typedef {object} ExternalMission
  * @property {Date} activation start time
  * @property {Date} expiry end timer
  * @property {string} node formatted node name with planet
@@ -11,15 +10,12 @@ export = ExternalMission;
  * @property {boolean} sharkwing whether or not the tile requires
  *    sumbersible archwing
  */
-declare class ExternalMission {
-}
-declare namespace ExternalMission {
-    export { ExternalMission };
+export default class ExternalMission {
 }
 /**
  * External mission data retrieved from https://10o.io/kuvalog.json
  */
-type ExternalMission = {
+export type ExternalMission = {
     /**
      * start time
      */

package/types/lib/supporting/MarkdownSettings.d.ts

@@ -1,16 +1,30 @@
-export = MarkdownSettings;
-declare class MarkdownSettings {
-    lineEnd: string;
-    blockEnd: string;
-    doubleReturn: string;
-    linkBegin: string;
-    linkMid: string;
-    linkEnd: string;
-    bold: string;
-    italic: string;
-    underline: string;
-    strike: string;
-    codeLine: string;
-    codeBlock: string;
-    spoiler: string;
+/**
+ * A collection of strings that are used by the parser to produce markdown-formatted text
+ * @property {string} lineEnd      - Line return character
+ * @property {string} blockEnd     - Block end string
+ * @property {string} doubleReturn - Double line return string
+ * @property {string} linkBegin    - Link begin string
+ * @property {string} linkMid      - Link middle string
+ * @property {string} linkEnd      - Link end string
+ * @property {string} bold         - String for denoting bold text
+ * @property {string} italic       - String for denoting italicized text
+ * @property {string} underline    - String for denoting underlined text
+ * @property {string} strike       - String for denoting striked-through text
+ * @property {string} codeLine     - String for denoting in-line code
+ * @property {string} codeBlock    - String for denoting multi-line code blocks
+ */
+export default class MarkdownSettings {
+    static lineEnd: string;
+    static blockEnd: string;
+    static doubleReturn: string;
+    static linkBegin: string;
+    static linkMid: string;
+    static linkEnd: string;
+    static bold: string;
+    static italic: string;
+    static underline: string;
+    static strike: string;
+    static codeLine: string;
+    static codeBlock: string;
+    static spoiler: string;
 }

package/types/lib/supporting/RewardData.d.ts

@@ -1,3 +1,9 @@
-export const nightmare: string[];
-export const auras: string[];
 export const resources: string[];
+export const auras: string[];
+export const nightmare: string[];
+declare namespace _default {
+    export { nightmare };
+    export { auras };
+    export { resources };
+}
+export default _default;

package/types/lib/supporting/RewardTypes.d.ts

@@ -1,2 +1,2 @@
-declare const _exports: Array<RewardType>;
-export = _exports;
+declare const _default: Array<RewardType>;
+export default _default;

package/types/lib/utilities/integrity.d.ts

@@ -0,0 +1 @@
+export function insist(thing: any, ...args: any[]): void;

package/types/lib/utilities/timeDate.d.ts

@@ -1,29 +1,36 @@
-/**
- * An object containing functions to format dates and times
- */
-export type TimeDateFunctions = any;
 /**
  * @param   {number} millis The number of milliseconds in the time delta
- * @returns {string}
+ * @returns {string} formatted time delta
  */
 export function timeDeltaToString(millis: number): string;
 /**
  * Returns the number of milliseconds between now and a given date
  * @param   {Date} d         The date from which the current time will be subtracted
- * @param   {function} [now] A function that returns the current UNIX time in milliseconds
- * @returns {number}
+ * @param   {Function} [now] A function that returns the current UNIX time in milliseconds
+ * @returns {number}       The number of milliseconds after the given date to now
  */
 export function fromNow(d: Date, now?: Function): number;
 /**
  * Returns the number of milliseconds between a given date and now
  * @param   {Date} d         The date that the current time will be subtracted from
- * @param   {function} [now] A function that returns the current UNIX time in milliseconds
- * @returns {number}
+ * @param   {Function} [now] A function that returns the current UNIX time in milliseconds
+ * @returns {number}        The number of milliseconds after now to the given date
  */
 export function toNow(d: Date, now?: Function): number;
 /**
  * Returns a new Date constructed from a worldState date object
- * @param {Object} d The worldState date object
- * @returns {Date}
+ * @param {object} d The worldState date object
+ * @returns {Date} parsed date from DE date format
+ */
+export function parseDate(d: object): Date;
+declare namespace _default {
+    export { timeDeltaToString };
+    export { fromNow };
+    export { toNow };
+    export { parseDate };
+}
+export default _default;
+/**
+ * An object containing functions to format dates and times
  */
-export function parseDate(d: any): Date;
+export type TimeDateFunctions = Record<string, Function>;