warframe-worldstate-parser 4.6.1 → 5.0.1

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

@@ -1,70 +0,0 @@
-/**
- * Represents a persistent enemy
- * @augments {WorldstateObject}
- */
-export default class PersistentEnemy extends WorldstateObject {
-    /**
-     * @param   {object}             data            The persistent enemy data
-     * @param   {object}             deps            The dependencies object
-     * @param   {string}             deps.locale     Locale to use for translations
-     */
-    constructor(data: object, { locale }?: {
-        locale: string;
-    });
-    /**
-     * The enemy's type
-     * @type {string}
-     */
-    agentType: string;
-    /**
-     * The location tag
-     * @type {string}
-     */
-    locationTag: string;
-    /**
-     * The enemy's rank
-     * @type {number}
-     */
-    rank: number;
-    /**
-     * The enemy's remaining health percentage
-     * @type {number}
-     */
-    healthPercent: number;
-    /**
-     * The percentual damage that the enemy takes when it's defeated
-     * @type {number}
-     */
-    fleeDamage: number;
-    /**
-     * The region where the enemy is located
-     * @type {string}
-     */
-    region: string;
-    /**
-     * The last time the enemy was discovered
-     * @type {Date}
-     */
-    lastDiscoveredTime: Date;
-    /**
-     * The node at which the enemy was last discovered
-     * @type {string}
-     */
-    lastDiscoveredAt: string;
-    /**
-     * Whether or not the enemy is currently available
-     * @type {boolean}
-     */
-    isDiscovered: boolean;
-    /**
-     * Whether or not the enemy is using ticketing
-     * @type {boolean}
-     */
-    isUsingTicketing: boolean;
-    /**
-     * Fake ID incorporating discovery
-     * @type {string}
-     */
-    pid: string;
-}
-import WorldstateObject from './WorldstateObject.js';

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

@@ -1,95 +0,0 @@
-/**
- * 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
- */
-export default class Reward {
-    /**
-     * @param   {object} data        The mission data
-     * @param   {Dependency}         deps            The dependencies object
-     * @param   {string}             deps.locale     Locale to use for translations
-     */
-    constructor(data: object, { locale }?: Dependency);
-    /**
-     * The items being rewarded
-     * @type {Array.<string>}
-     */
-    items: Array<string>;
-    /**
-     * The counted items being rewarded
-     * @type {Array.<object>}
-     */
-    countedItems: Array<object>;
-    /**
-     * The credits being rewarded
-     * @type {number}
-     */
-    credits: number;
-    asString: string;
-    itemString: string;
-    thumbnail: string;
-    color: string | number;
-    /**
-     * The types of all items that are being rewarded
-     * @returns {Array.<string>} types as array of string
-     */
-    getTypes(): Array<string>;
-    /**
-     * The types of all the items that are being rewarded
-     * @returns {Array.<RewardType>} array of reward types
-     */
-    getTypesFull(): Array<RewardType>;
-    /**
-     * The reward's string representation
-     * @returns {string} reward's string representation
-     */
-    toString(): string;
-}
-/**
- * An object describing a type of reward, including name, description,
- * test function to verify type from a string, thumbnail url, and color
- */
-export type RewardType = {
-    /**
-     * - Name of the reward type
-     */
-    name: string;
-    /**
-     * - Description of the reward type
-     */
-    description: string;
-    /**
-     * - Function for testing the return type against a string
-     */
-    test: string;
-    /**
-     * - Thumbnail url for this reward type
-     */
-    thumbnail: string;
-    /**
-     * - Summary color representing this reward type
-     */
-    color: string;
-};

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

@@ -1,54 +0,0 @@
-/**
- * Mission typeDef
- * @typedef {object} Mission
- * @property {string} node Mission node name
- * @property {string} enemy Node enemy
- * @property {string} type Mission type of the node
- */
-/**
- * Represents a set of sentient outposts that are present
- * Parsed source is combined data from DE's worldstate and semlar.com/anomaly.json
- * @property {Mission} mission    List of current missions
- * @property {string}  id         Identifier for the mission node with active indicator
- * @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.
- *                                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
- */
-export default class SentientOutpost {
-    constructor(sfn: any, { locale, sentientData, logger }: {
-        locale: any;
-        sentientData: any;
-        logger: any;
-    });
-    mission: {
-        node: any;
-        faction: any;
-        type: any;
-    };
-    active: boolean;
-    id: string;
-    activation: Date;
-    expiry: Date;
-    #private;
-}
-/**
- * Mission typeDef
- */
-export type Mission = {
-    /**
-     * Mission node name
-     */
-    node: string;
-    /**
-     * Node enemy
-     */
-    enemy: string;
-    /**
-     * Mission type of the node
-     */
-    type: string;
-};

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

@@ -1,33 +0,0 @@
-/**
- * Contains information about sanctuary targets
- */
-export default class Simaris {
-    /**
-     * @param   {object}             data            The sanctuary data
-     * @param   {object}             deps            The dependencies object
-     * @param   {string}             deps.locale     Locale to use for translations
-     */
-    constructor(data: object, { locale }?: {
-        locale: string;
-    });
-    /**
-     * The sanctuary target
-     * @type {string}
-     */
-    target: string;
-    /**
-     * Whether or not the target is currently active
-     * @type {boolean}
-     */
-    isTargetActive: boolean;
-    /**
-     * A string representation of the current sanctuary status
-     * @type {string}
-     */
-    asString: string;
-    /**
-     * Returns a string representation of the current sanctuary status
-     * @returns {string} a string representation of the current sanctuary status
-     */
-    toString(): string;
-}

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

@@ -1,72 +0,0 @@
-/**
- * Represents a daily sortie
- * @augments {WorldstateObject}
- */
-export default class Sortie extends WorldstateObject {
-    /**
-     * @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: object, { locale }?: {
-        locale: string;
-    });
-    /**
-     * The sortie's reward pool
-     * @type {string}
-     */
-    rewardPool: string;
-    /**
-     * The sortie's variants
-     * @type {Array.<SortieVariant>}
-     */
-    variants: Array<SortieVariant>;
-    missions: any;
-    /**
-     * The sortie's boss
-     * @type {string}
-     */
-    boss: string;
-    /**
-     * The sortie's faction
-     * @type {string}
-     */
-    faction: string;
-    /**
-     * The sortie's faction
-     * @type {string}
-     */
-    factionKey: string;
-    /**
-     * Whether this is expired (at time of object creation)
-     * @type {boolean}
-     */
-    expired: boolean;
-    /**
-     * ETA string (at time of object creation)
-     * @type {string}
-     */
-    eta: string;
-    /**
-     * Get the sortie's boss
-     * @returns {string} the sortie's boss
-     */
-    getBoss(): string;
-    /**
-     * Get the sortie's faction
-     * @returns {string} the sortie's faction
-     */
-    getFaction(): string;
-    /**
-     * Gets a string indicating how long it will take for the sortie to end
-     * @returns {string} estimated time of arrival
-     */
-    getETAString(): string;
-    /**
-     * Get whether or not the sortie has expired
-     * @returns {boolean} whether the sortie has expired
-     */
-    isExpired(): boolean;
-}
-import WorldstateObject from './WorldstateObject.js';
-import SortieVariant from './SortieVariant.js';

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

@@ -1,43 +0,0 @@
-/**
- * Represents a sortie variant
- * @class
- */
-export default class SortieVariant {
-    /**
-     * 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: object, { locale }?: {
-        locale: string;
-    });
-    /**
-     * The variant's mission type
-     * @type {string}
-     */
-    missionType: string;
-    missionTypeKey: any;
-    /**
-     * The variant's modifier
-     * @type {string}
-     */
-    modifier: string;
-    /**
-     * The variant's modifier description
-     * @type {string}
-     */
-    modifierDescription: string;
-    /**
-     * The node where the variant takes place
-     * @type {string}
-     */
-    node: string;
-    nodeKey: any;
-    /**
-     * Returns a string representation of the sortie variant
-     * @returns {string} string representation
-     */
-    toString(): string;
-}

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

@@ -1,19 +0,0 @@
-export default class SteelPathOffering {
-    constructor({ locale }: {
-        locale: any;
-    });
-    currentReward: any;
-    activation: Date;
-    expiry: Date;
-    remaining: any;
-    rotation: any;
-    evergreens: any;
-    /**
-     * General data pertaining to incursions
-     * @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: object;
-}

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

@@ -1,72 +0,0 @@
-/**
- * Represents a syndicate daily mission
- * @augments {WorldstateObject}
- */
-export default class SyndicateJob extends WorldstateObject {
-    /**
-     * Generate a job with async data (reward pool)
-     * @param {object} data The syndicate mission data
-     * @param {Date} expiry The syndicate job expiration
-     * @param {object} deps The dependencies object
-     * @param {string} deps.locale Locale to use for translations
-     * @returns {Promise<SyndicateJob>} The created SyndicateJob object with rewardPool
-     */
-    static build(data: object, expiry: Date, deps: {
-        locale: string;
-    }): Promise<SyndicateJob>;
-    /**
-     * Construct a job without async data (reward pool)
-     * @param {object} data The syndicate mission data
-     * @param {Date} expiry The syndicate job expiration
-     * @param {object} deps The dependencies object
-     * @param {string} deps.locale Locale to use for translations
-     *
-     * This DOES NOT populate the reward pool
-     */
-    constructor(data: object, expiry: Date, { locale }: {
-        locale: string;
-    });
-    /**
-     * Array of strings describing rewards
-     * @type {Array.<string>}
-     */
-    rewardPool: Array<string>;
-    /**
-     * The type of job this is
-     * @type {string}
-     */
-    type: string;
-    /**
-     * Array of enemy levels
-     * @type {Array.<number>}
-     */
-    enemyLevels: Array<number>;
-    /**
-     * Array of standing gains per stage of job
-     * @type {Array.<number>}
-     */
-    standingStages: Array<number>;
-    /**
-     * Minimum mastery required to participate
-     * @type {number}
-     */
-    minMR: number;
-    /**
-     * Whether or not this is a Vault job.
-     * No indication for difference of normal vs arcana vaults.
-     * @type {boolean}
-     */
-    isVault: boolean;
-    /**
-     * Corresponding chamber. Nullable
-     * @type {string|null}
-     */
-    locationTag: string | null;
-    /**
-     * What time phase this bounty is bound to
-     * @type {string}
-     */
-    timeBound: string;
-    timeBoound: string;
-}
-import WorldstateObject from './WorldstateObject.js';

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

@@ -1,56 +0,0 @@
-/**
- * Represents a syndicate daily mission
- * @augments {WorldstateObject}
- */
-export default class SyndicateMission extends WorldstateObject {
-    /**
-     * Build a new SyndicateMission with async operations & data
-     * @param   {object}             data            The syndicate mission data
-     * @param   {object}             deps            The dependencies object
-     * @param   {string}             deps.locale     Locale to use for translations
-     * @returns {Promise.<SyndicateMission>}         SyndicateMission object w/ async resolution of jobs
-     */
-    static build(data: object, deps: {
-        locale: string;
-    }): Promise<SyndicateMission>;
-    /**
-     * @param   {object}             data            The syndicate mission data
-     * @param   {object}             deps            The dependencies object
-     * @param   {string}             deps.locale     Locale to use for translations
-     */
-    constructor(data: object, { locale }?: {
-        locale: string;
-    });
-    /**
-     * The syndicate that is offering the mission
-     * @type {string}
-     */
-    syndicate: string;
-    /**
-     * The syndicate that is offering the mission
-     * @type {string}
-     */
-    syndicateKey: string;
-    /**
-     * The nodes on which the missions are taking place
-     * @type {Array.<string>}
-     */
-    nodes: Array<string>;
-    /**
-     * The jobs for this syndicate. Will normally be []
-     * @type {Array.<SyndicateJob>}
-     */
-    jobs: Array<SyndicateJob>;
-    /**
-     * ETA string (at time of object creation)
-     * @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} time delta string from now to the expiry
-     */
-    getETAString(): string;
-}
-import WorldstateObject from './WorldstateObject.js';
-import SyndicateJob from './SyndicateJob.js';

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

@@ -1,53 +0,0 @@
-/**
- * Represents the current Earth Day/Night Cycle
- * @augments {WorldstateObject}
- */
-export default class VallisCycle extends WorldstateObject {
-    constructor();
-    /**
-     * Whether or not this it's daytime
-     * @type {boolean}
-     */
-    isWarm: boolean;
-    /**
-     * Current cycle state. One of `warm`, `cold`
-     * @type {string}
-     */
-    state: string;
-    /**
-     * Time remaining string
-     * @type {string}
-     */
-    timeLeft: string;
-    id: string;
-    shortString: string;
-    /**
-     * Get whether or not the event has expired
-     * @returns {boolean} whether this event has expired
-     */
-    getExpired(): boolean;
-    #private;
-}
-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,45 +0,0 @@
-/**
- * Represents a void trader
- * @augments {WorldstateObject}
- */
-export default class VoidTrader extends WorldstateObject {
-    /**
-     * @param   {object}             data            The Void trader data
-     * @param   {object}             deps            The dependencies object
-     * @param   {string}             deps.locale     Locale to use for translations
-     */
-    constructor(data: object, { locale }?: {
-        locale: string;
-    });
-    /**
-     * The void trader's name
-     * @type {string}
-     */
-    character: string;
-    /**
-     * The node at which the Void Trader appears
-     * @type {string}
-     */
-    location: string;
-    /**
-     * The trader's inventory
-     * @type {VoidTraderItem[]}
-     */
-    inventory: VoidTraderItem[];
-    /**
-     * Pseudo Identifier for identifying changes in inventory
-     * @type {string}
-     */
-    psId: string;
-    /**
-     * A string indicating how long it will take for the trader to leave
-     *  (at time of object creation)
-     * @type {string}
-     */
-    endString: string;
-    initialStart: any;
-    completed: any;
-    schedule: any;
-}
-import WorldstateObject from './WorldstateObject.js';
-import VoidTraderItem from './VoidTraderItem.js';

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

@@ -1,25 +0,0 @@
-/**
- * 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
- */
-export default class VoidTraderItem {
-    /**
-     * @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   {string}             deps.locale     Locale to use for translations
-     */
-    constructor({ ItemType, PrimePrice, RegularPrice }: {
-        ItemType: string;
-        PrimePrice: string;
-        RegularPrice: string;
-    }, { locale }?: Dependency);
-    uniqueName: string;
-    item: any;
-    ducats: number;
-    credits: number;
-}

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

@@ -1,7 +0,0 @@
-export default class VoidTraderSchedule {
-    constructor(data: any, { locale }?: {
-        locale?: string;
-    });
-    expiry: any;
-    item: any;
-}

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

@@ -1,12 +0,0 @@
-/**
- * Represents a void trader
- * @augments {WorldstateObject}
- */
-export default class WeeklyChallenge extends WorldstateObject {
-    /**
-     * @param   {object}             data            The Void trader data
-     */
-    constructor(data: object);
-    challenges: any;
-}
-import WorldstateObject from './WorldstateObject.js';