warframe-worldstate-parser 4.6.2 → 5.0.1

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

@@ -1,216 +0,0 @@
-/**
- * Interim step for an event reward system.
- * @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
- */
-/**
- * Progress for one of multiple stages
- * @typedef {object} ProgressStep
- * @property {string} type         Type of progress
- * @property {number} progressAmt Amount of progress
- */
-/**
- * Represents an in-game special event
- * @augments {WorldstateObject}
- */
-export default class WorldEvent extends WorldstateObject {
-    /**
-     * Asynchronously build a new WorldEvent
-     * @param   {object}            data            The event data
-     * @param   {object}            deps            The dependencies object
-     * @param   {string}            deps.locale     Locale to use for translations
-     * @returns {Promise.<WorldEvent>}              The created WorldEvent object
-     */
-    static build(data: object, deps: {
-        locale: string;
-    }): Promise<WorldEvent>;
-    /**
-     * @param   {object}            data            The event data
-     * @param   {object}            deps            The dependencies object
-     * @param   {string}            deps.locale     Locale to use for translations
-     */
-    constructor(data: object, { locale }?: {
-        locale: string;
-    });
-    /**
-     * The event's main score goal
-     * @type {number}
-     */
-    maximumScore: number;
-    /**
-     * The current score on the event
-     * @type {number}
-     */
-    currentScore: number;
-    /**
-     * The first intermediate score goal
-     * @type {?number}
-     */
-    smallInterval: number | null;
-    /**
-     * The second intermediate score goal
-     * @type {?number}
-     */
-    largeInterval: number | null;
-    /**
-     * The faction that the players must fight in the event
-     * @type {string}
-     */
-    faction: string;
-    /**
-     * The description of the event
-     * @type {string}
-     */
-    description: string;
-    /**
-     * Tooltip for the event
-     * @type {?string}
-     */
-    tooltip: string | null;
-    /**
-     * The node where the event takes place
-     * @type {?string}
-     */
-    node: string | null;
-    /**
-     * The other nodes where the event takes place
-     * @type {string[]}
-     */
-    concurrentNodes: string[];
-    /**
-     * The victim node
-     * @type {?string}
-     */
-    victimNode: string | null;
-    /**
-     * The score description
-     * @type {?string}
-     */
-    scoreLocTag: string | null;
-    /**
-     * The event's rewards
-     * @type {Reward[]}
-     */
-    rewards: Reward[];
-    /**
-     * Whether or not this is expired (at time of object creation)
-     * @type {boolean}
-     */
-    expired: boolean;
-    /**
-     * Health remaining for the target
-     * @type {number}
-     */
-    health: number;
-    jobs: any[];
-    previousJobs: any[];
-    /**
-     * Previous job id
-     * @type {string}
-     */
-    previousId: string;
-    /**
-     * Array of steps
-     * @type {InterimStep[]}
-     */
-    interimSteps: InterimStep[];
-    /**
-     * Progress Steps, if any are present
-     * @type {ProgressStep[]}
-     */
-    progressSteps: ProgressStep[];
-    /**
-     * Total of all MultiProgress
-     * @type {number}
-     */
-    progressTotal: number;
-    /**
-     * Whether to show the total score at the end of the mission
-     * @type {boolean}
-     */
-    showTotalAtEndOfMission: boolean;
-    /**
-     * Whether the event is personal
-     * @type {boolean}
-     */
-    isPersonal: boolean;
-    /**
-     * Whether the event is community
-     * @type {boolean}
-     */
-    isCommunity: boolean;
-    regionDrops: any;
-    /**
-     * Archwing Drops in effect while this event is active
-     * @type {string[]}
-     */
-    archwingDrops: string[];
-    asString: string;
-    /**
-     * Metadata provided by DE
-     * @type {object}
-     */
-    metadata: object;
-    /**
-     * Bonuses given for completion
-     * @type {Array.<number>}
-     */
-    completionBonuses: Array<number>;
-    scoreVar: any;
-    altExpiry: any;
-    altActivation: any;
-    nextAlt: {
-        expiry: any;
-        activation: any;
-    };
-    affiliatedWith: any;
-    /**
-     * The event's tag
-     * @type {string}
-     */
-    tag: string;
-    /**
-     * Get whether the event has expired
-     * @returns {boolean} whether the event has expired
-     */
-    getExpired(): boolean;
-}
-/**
- * Interim step for an event reward system.
- */
-export type InterimStep = {
-    /**
-     * Goal amount
-     */
-    goal: number;
-    /**
-     * Reward for reaching the step
-     */
-    reward: Reward;
-    /**
-     * Amount of players at this step
-     */
-    winnerCount: number;
-    /**
-     * Message received when reaching the interim step
-     */
-    message: object;
-};
-/**
- * Progress for one of multiple stages
- */
-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,120 +0,0 @@
-/**
- * @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
-     */
-    constructor(data: BaseContentObject);
-    /**
-     * The object's id field
-     * @type {Identifier.$id|Identifier.$oid}
-     */
-    id: Identifier.$id | Identifier.$oid;
-    /**
-     * The date and time at which the void trader arrives
-     * @type {Date}
-     */
-    activation: Date;
-    /**
-     * A string indicating how long it will take for the trader to arrive
-     *  (at time of object creation)
-     * @type {string}
-     */
-    startString: string;
-    /**
-     * The date and time at which the void trader leaves
-     * @type {Date}
-     */
-    expiry: Date;
-    /**
-     * Whether the void trader is active (at time of object creation)
-     * @type {boolean}
-     */
-    active: boolean;
-    /**
-     * Returns a string representation of the object
-     * @returns {string} basic representation from the id
-     */
-    toString(): string;
-    /**
-     * Get whether the trader is currently active
-     * @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} 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} time delta string from now to the end
-     */
-    getEndString(): string;
-}
-export type Identifier = {
-    /**
-     * older identifier schema
-     */
-    $id: string;
-    /**
-     * newer global identifier schema
-     */
-    $oid: string;
-};
-export type LegacyTimestamp = {
-    /**
-     * second-based timestamp
-     */
-    sec: number;
-};
-export type Timestamp = {
-    /**
-     * millisecond-based timestamp
-     */
-    $numberLong: number;
-};
-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,42 +0,0 @@
-/**
- * Represents the current Zariman Corpus/Grineer Cycle
- * @augments {WorldstateObject}
- */
-export default class ZarimanCycle extends WorldstateObject {
-    /**
-     * @param {Date} bountiesEndDate The current Zariman cycle expiry
-     */
-    constructor(bountiesEndDate: Date);
-    /**
-     * 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} whether this is expired
-     */
-    getExpired(): boolean;
-    getCurrentZarimanCycle(): {
-        isCorpus: boolean;
-        timeLeft: any;
-        expiry: Date;
-        expiresIn: any;
-        state: string;
-        start: number;
-    };
-    #private;
-}
-import WorldstateObject from './WorldstateObject.js';

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

@@ -1,7 +0,0 @@
-/**
- * Dependency Object
- * @property   {string}             locale     Locale to use for translations
- * @property   {object}             logger     Generic logger to use if needed
- */
-export default class Dependency {
-}

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

@@ -1,9 +0,0 @@
-/**
- * Single category of duviri choices
- */
-export default class DuviriChoice {
-    constructor(data: any);
-    category: string;
-    categoryKey: any;
-    choices: any;
-}

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

@@ -1,48 +0,0 @@
-/**
- * External mission data retrieved from https://10o.io/kuvalog.json
- * @typedef {object} ExternalMission
- * @property {Date} activation start time
- * @property {Date} expiry end timer
- * @property {string} node formatted node name with planet
- * @property {string} enemy Enemy on tile
- * @property {string} type Mission type of node
- * @property {boolean} archwing whether or not the tile requires archwing
- * @property {boolean} sharkwing whether or not the tile requires
- *    sumbersible archwing
- */
-export default class ExternalMission {
-}
-/**
- * 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;
-};

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

@@ -1,3 +0,0 @@
-export function cdn(path: any): string;
-export function wfCdn(path: any): string;
-export function deProxy(url: any): any;

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

@@ -1,30 +0,0 @@
-/**
- * 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,9 +0,0 @@
-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,8 +0,0 @@
-declare const _default: {
-    name: string;
-    description: string;
-    test: (s: any) => any;
-    thumbnail: string;
-    color: number;
-}[];
-export default _default;

package/types/main.d.ts

@@ -1,3 +0,0 @@
-export default WorldState;
-export * from "./lib/WorldState.js";
-import { WorldState } from './lib/WorldState.js';