warframe-worldstate-parser 4.6.2 → 5.0.1

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

@@ -1,86 +0,0 @@
-/**
- * Represents an upgrade that applies to all players
- */
-export default class GlobalUpgrade {
-    /**
-     * @param   {object}             data            The global upgrade data
-     * @param   {object}             deps            The dependencies object
-     * @param   {string}             deps.locale     Locale to use for translations
-     */
-    constructor(data: object, { locale }?: {
-        locale: string;
-    });
-    /**
-     * The time and date at which the global upgrade starts being active
-     * @type {Date}
-     */
-    activation: Date;
-    /**
-     * @deprecated Use `activation` instead
-     */
-    start: Date;
-    /**
-     * The time and date at which the global upgrade stops being active
-     * @type {Date}
-     */
-    expiry: Date;
-    /**
-     * @deprecated Use `expiry` instead
-     */
-    end: any;
-    /**
-     * The effect of the upgrade
-     * @type {string}
-     */
-    upgrade: string;
-    /**
-     * The operation type
-     * @type {string}
-     */
-    operation: string;
-    /**
-     * Symbol for operation
-     * @type {string}
-     */
-    operationSymbol: string;
-    /**
-     * The operation value
-     * @type {string}
-     */
-    upgradeOperationValue: string;
-    /**
-     * Whether or not this is expired (at time of object creation)
-     * @type {boolean}
-     */
-    expired: boolean;
-    /**
-     * ETA string (at time of object creation)
-     * @type {string}
-     */
-    eta: string;
-    /**
-     * Plaintext description of upgrade
-     * @type {string}
-     */
-    desc: string;
-    /**
-     * Get whether or not the event has expired
-     * @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} estimated timer of the upgrade
-     */
-    getETAString(): string;
-    /**
-     * Turn the global upgrade into a plain text description
-     * @returns {string} Descriptio
-     */
-    compileDesription(): string;
-    /**
-     * Returns a string representation of the upgrade
-     * @returns {string} string representation
-     */
-    toString(): string;
-}

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

@@ -1,124 +0,0 @@
-/**
- * An 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)
- */
-/**
- * Represents an invasion
- */
-export default class Invasion extends WorldstateObject {
-    /**
-     * @param   {object}             data            The invasion data
-     * @param   {Dependency}         deps            The dependencies object
-     * @param   {string}             deps.locale     Locale to use for translations
-     */
-    constructor(data: object, { locale }?: Dependency);
-    /**
-     * The node where the invasion is taking place
-     * @type {string}
-     */
-    node: string;
-    /**
-     * The node key where the invasion is taking place
-     * @type {string}
-     */
-    nodeKey: string;
-    /**
-     * The invasion's description
-     * @type {string}
-     */
-    desc: string;
-    /**
-     * The attacking faction
-     * @type {string}
-     */
-    attackingFaction: string;
-    /**
-     * Invasion attacker
-     * @type {InvasionParticipant}
-     */
-    attacker: InvasionParticipant;
-    /**
-     * Invasion defender
-     * @type {InvasionParticipant}
-     */
-    defender: InvasionParticipant;
-    /**
-     * Whether this invasion is against the infestation
-     * @type {boolean}
-     */
-    vsInfestation: boolean;
-    /**
-     * The signed count of completed runs. Supporting the attackers makes the count go up,
-     * supporting the defenders makes it go down
-     * @type {number}
-     */
-    count: number;
-    /**
-     * The number of runs that one side needs to win
-     * @type {number}
-     */
-    requiredRuns: number;
-    /**
-     * The invasion's completion percentage. Defenders win if it gets to 0
-     * Grineer vs. Corpus invasions start at 50, Infested invasions start at 100
-     * @type {number}
-     */
-    completion: number;
-    /**
-     * Whether the invasion has finished
-     * @type {boolean}
-     */
-    completed: boolean;
-    /**
-     * ETA string (at time of object creation)
-     * @type {string}
-     */
-    eta: string;
-    /**
-     * An array containing the types of all of the invasions's rewards
-     * @type {Array.<string>}
-     */
-    rewardTypes: Array<string>;
-    /**
-     * Whether or not the attackers are winning.
-     * This is always false when the infestation is attacking
-     * @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} remaining time in ms
-     */
-    getRemainingTime(): number;
-    /**
-     * Get a string estimating how much time is left before the invasion ends
-     * @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>} types of items being rewarded
-     */
-    getRewardTypes(): Array<string>;
-}
-/**
- * An invasion participant
- */
-export type InvasionParticipant = {
-    /**
-     * Reward for supporting this participant in the invasion
-     */
-    reward: string;
-    /**
-     * Faction of this participant (localized)
-     */
-    faction: string;
-    /**
-     * Faction of this participant (always English)
-     */
-    factionKey: string;
-};
-import WorldstateObject from './WorldstateObject.js';

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

@@ -1,6 +0,0 @@
-export default class Kinepage {
-    constructor(data: any, locale?: string);
-    timestamp: Date;
-    message: any;
-    translations: any;
-}

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

@@ -1,60 +0,0 @@
-/**
- * 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;
-        locale: any;
-        logger: any;
-    });
-    #private;
-}
-/**
- * External mission data retrieved from https://10o.io/kuvalog.json
- */
-export type ExternalMission = {
-    /**
-     * start time
-     */
-    activation: Date;
-    /**
-     * end timer
-     */
-    expiry: Date;
-    /**
-     * formatted node name with planet
-     */
-    node: string;
-    /**
-     * Enemy on tile
-     */
-    enemy: string;
-    /**
-     * Mission type of node
-     */
-    type: string;
-    /**
-     * whether or not the tile requires archwing
-     */
-    archwing: boolean;
-    /**
-     * whether or not the tile requires
-     * sumbersible archwing
-     */
-    sharkwing: boolean;
-};
-/**
- * Stores and parses kuva data from https://10o.io/kuvalog.json
- */
-export type Kuva = {
-    /**
-     * currently active kuva missions
-     */
-    kuva: ExternalMission[];
-    /**
-     * current arbitration
-     */
-    arbitration: ExternalMission;
-};

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

@@ -1,39 +0,0 @@
-export default class MidrathCycle extends WorldstateObject {
-    constructor();
-    isDay: any;
-    state: any;
-    timeLeft: any;
-    /**
-     * Get whether or not the event has expired
-     * @returns {boolean} Whether or not the event has expired
-     */
-    getExpired(): boolean;
-    #private;
-}
-export type MidrathCycle = {
-    /**
-     * The date and time at which the event ends
-     */
-    expiry: Date;
-    /**
-     * The date and time at which the event started
-     */
-    activation: Date;
-    /**
-     * Whether or not this it's daytime
-     */
-    isDay: boolean;
-    /**
-     * Current cycle state. One of `day`, `night`
-     */
-    state: string;
-    /**
-     * Time remaining string
-     */
-    timeLeft: string;
-    /**
-     * Whether or not the event has expired
-     */
-    expired: boolean;
-};
-import WorldstateObject from './WorldstateObject.js';

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

@@ -1,136 +0,0 @@
-/**
- * Represents an in-game mission
- */
-export default class Mission {
-    /**
-     * @param   {object}             data            The mission data
-     * @param   {string}             locale     Locale to use for translations
-     */
-    constructor(data: object, { locale }?: string);
-    /**
-     * The mission's description
-     * @type {?string}
-     */
-    description: string | null;
-    /**
-     * The node where the mission takes place
-     * @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}
-     */
-    faction: string;
-    /**
-     * The factions that the players must fight in the mission
-     * @type {string}
-     */
-    factionKey: string;
-    /**
-     * The mission's reward
-     * @type {?Reward}
-     */
-    reward: Reward | null;
-    /**
-     * The minimum level of the enemies in the mission
-     * @type {number}
-     */
-    minEnemyLevel: number;
-    /**
-     * The maximum level of the enemies in the mission
-     * @type {number}
-     */
-    maxEnemyLevel: number;
-    /**
-     * The number of waves that the players need to complete (undefined if not applicable)
-     * @type {?number}
-     */
-    maxWaveNum: number | null;
-    /**
-     * The Mission's nightmare boolean
-     * @type {boolean}
-     */
-    nightmare: boolean;
-    /**
-     * The Mission's archwing requirement
-     * @type {boolean}
-     */
-    archwingRequired: boolean;
-    /**
-     * The Mission's sharkwing requirement
-     * @type {boolean}
-     */
-    isSharkwing: boolean;
-    /**
-     * Override for the map on this mission
-     * @type {string}
-     */
-    levelOverride: string;
-    /**
-     * Enemy specification for the mission
-     * @type {string}
-     */
-    enemySpec: string;
-    /**
-     * Array of strings denoting extra spawners for a mission
-     * @type {string[]}
-     */
-    advancedSpawners: string[];
-    /**
-     * Items required to enter the mission
-     * @type {string[]}
-     */
-    requiredItems: string[];
-    /**
-     * Whether or not the required items are consumed
-     * @type {boolean}
-     */
-    consumeRequiredItems: boolean;
-    /**
-     * Target for the mission
-     * @type {string}
-     */
-    target: string;
-    /**
-     * Whether or not leaders are always allowed
-     * @type {boolean}
-     */
-    leadersAlwaysAllowed: boolean;
-    /**
-     * A tag for the event that this corresponds to
-     * @type {string}
-     */
-    goalTag: string;
-    /**
-     * Affectors for this mission
-     * @type {string[]}
-     */
-    levelAuras: string[];
-    /**
-     * Only weapon allowed for the mission
-     * @type {string}
-     */
-    exclusiveWeapon: string;
-    /**
-     * The Mission's string representation
-     * @returns {string} Mission's string representation
-     */
-    toString(): string;
-}
-import Reward from './Reward.js';

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

@@ -1,104 +0,0 @@
-/**
- * Represents a game news item
- * @augments {WorldstateObject}
- */
-export default class News extends WorldstateObject {
-    /**
-     * @param   {object}             data            The news data
-     * @param   {string}             locale     Locale to use for determining language
-     */
-    constructor(data: object, { locale }?: string);
-    /**
-     * The news message
-     * @type {string}
-     */
-    message: string;
-    /**
-     * The link to the forum post
-     * @type {string}
-     */
-    link: string;
-    /**
-     * The news's image link
-     * @type {string}
-     */
-    imageLink: string;
-    /**
-     * Whether this has priority over other news or not
-     * @type {boolean}
-     */
-    priority: boolean;
-    /**
-     * The date at which the post was published
-     * @type {Date}
-     */
-    date: Date;
-    /**
-     * The date at which the event starts
-     * @type {?Date}
-     */
-    startDate: Date | null;
-    /**
-     * The date at which the event ends
-     * @type {?Date}
-     */
-    endDate: Date | null;
-    /**
-     * ETA string (at time of object creation)
-     * @type {string}
-     */
-    eta: string;
-    /**
-     * Whether this is an update news item
-     * @type {boolean}
-     */
-    update: boolean;
-    /**
-     * Whether this is a prime access news item
-     * @type {boolean}
-     */
-    primeAccess: boolean;
-    /**
-     * Whether or not this is a stream
-     * @type {boolean}
-     */
-    stream: boolean;
-    /**
-     * Translation of the news item
-     * @type {Record<string, string>}
-     */
-    translations: Record<string, string>;
-    /**
-     * The string representation of this object at creation
-     * @type {string}
-     */
-    asString: string;
-    /**
-     * 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} the estimated time of arrival for the event
-     */
-    getETAString(): string;
-    /**
-     * Whether or not this is about a game update
-     * @returns {boolean} whether the news is about an update
-     */
-    isUpdate(): boolean;
-    /**
-     * Whether this is about a new Prime Access
-     * @returns {boolean} whether the news is about a new Prime Access
-     */
-    isPrimeAccess(): 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} The title of the news item in the specified language
-     */
-    getTitle(langCode: string): string;
-}
-import WorldstateObject from './WorldstateObject.js';

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

@@ -1,53 +0,0 @@
-/**
- * Represents an alert
- * @augments {WorldstateObject}
- */
-export default class Nightwave extends WorldstateObject {
-    /**
-     * @param   {object}             data            The alert data
-     * @param   {object}             deps            The dependencies object
-     * @param   {string}             deps.locale     Locale to use for translations
-     */
-    constructor(data: object, { locale }?: {
-        locale: string;
-    });
-    id: string;
-    /**
-     * The current season. 0-indexed.
-     * @type {number}
-     */
-    season: number;
-    /**
-     * Descriptor for affiliation
-     * @type {string}
-     */
-    tag: string;
-    /**
-     * The current season's current phase. 0-indexed.
-     * @type {number}
-     */
-    phase: number;
-    /**
-     * Misc params provided.
-     * @type {object}
-     */
-    params: object;
-    possibleChallenges: any;
-    activeChallenges: any;
-    /**
-     * An array containing the types of all of the alert's rewards
-     * @type {Array.<string>}
-     */
-    rewardTypes: Array<string>;
-    /**
-     * Get a string indicating how much time is left before the alert expires
-     * @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>} an array containing the types of all of the nightwave season's rewards
-     */
-    getRewardTypes(): Array<string>;
-}
-import WorldstateObject from './WorldstateObject.js';

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

@@ -1,45 +0,0 @@
-/**
- * Represents an alert
- * @augments {WorldstateObject}
- */
-export default class NightwaveChallenge extends WorldstateObject {
-    /**
-     * @param   {object}             data            The alert data
-     * @param   {object}             deps            The dependencies object
-     * @param   {string}             deps.locale     Locale to use for translations
-     */
-    constructor(data: object, { locale }?: {
-        locale: string;
-    });
-    /**
-     * Whether or not this is a daily challenge
-     * @type {boolean}
-     */
-    isDaily: boolean;
-    /**
-     * Whether or not the challenge is an elite challenge
-     * @type {boolean}
-     */
-    isElite: boolean;
-    /**
-     * The descriptor for this challenge
-     * @type {string}
-     */
-    desc: string;
-    /**
-     * The title for this challenge
-     * @type {string}
-     */
-    title: string;
-    /**
-     * Reputation reward for ranking up in the Nightwave
-     * @type {number}
-     */
-    reputation: number;
-    /**
-     * Whether this challenge is permanent
-     * @type {boolean}
-     */
-    isPermanent: boolean;
-}
-import WorldstateObject from './WorldstateObject.js';