From 7ebbb5b6a2804d0995255ef621542999519ddd32 Mon Sep 17 00:00:00 2001 From: Matej Voboril Date: Wed, 13 Oct 2021 20:31:20 -0500 Subject: [PATCH] feat: cambion cycle timeLeft closes #329 --- lib/CambionCycle.js | 2 + types/lib/Alert.d.ts | 64 ------ types/lib/CetusCycle.d.ts | 64 ------ types/lib/ChallengeInstance.d.ts | 44 ----- types/lib/ConclaveChallenge.d.ts | 93 --------- types/lib/ConstructionProgress.d.ts | 25 --- types/lib/DailyDeal.d.ts | 92 --------- types/lib/DarkSector.d.ts | 132 ------------- types/lib/DarkSectorBattle.d.ts | 47 ----- types/lib/Dependency.d.ts | 35 ---- types/lib/EarthCycle.d.ts | 40 ---- types/lib/ExternalMission.d.ts | 36 ---- types/lib/Fissure.d.ts | 65 ------ types/lib/FlashSale.d.ts | 107 ---------- types/lib/GlobalUpgrade.d.ts | 97 --------- types/lib/Invasion.d.ts | 117 ----------- types/lib/Kuva.d.ts | 76 ------- types/lib/MarkdownSettings.d.ts | 22 --- types/lib/Mission.d.ts | 136 ------------- types/lib/News.d.ts | 116 ----------- types/lib/Nightwave.d.ts | 69 ------- types/lib/NightwaveChallenge.d.ts | 45 ----- types/lib/PersistentEnemy.d.ts | 81 -------- types/lib/Reward.d.ts | 79 -------- types/lib/SentientOutpost.d.ts | 58 ------ types/lib/Simaris.d.ts | 44 ----- types/lib/Sortie.d.ts | 82 -------- types/lib/SortieVariant.d.ts | 61 ------ types/lib/SyndicateJob.d.ts | 44 ----- types/lib/SyndicateMission.d.ts | 59 ------ types/lib/VallisCycle.d.ts | 42 ---- types/lib/VoidTrader.d.ts | 54 ----- types/lib/VoidTraderItem.d.ts | 26 --- types/lib/WeeklyChallenge.d.ts | 21 -- types/lib/WorldEvent.d.ts | 219 --------------------- types/lib/WorldState.d.ts | 117 ----------- types/lib/WorldstateObject.d.ts | 64 ------ types/lib/supporting/Dependency.d.ts | 13 -- types/lib/supporting/ExternalMission.d.ts | 52 ----- types/lib/supporting/MarkdownSettings.d.ts | 18 -- types/lib/timeDate.d.ts | 29 --- types/lib/translation.d.ts | 24 --- types/main.d.ts | 2 - 43 files changed, 2 insertions(+), 2711 deletions(-) delete mode 100644 types/lib/Alert.d.ts delete mode 100644 types/lib/CetusCycle.d.ts delete mode 100644 types/lib/ChallengeInstance.d.ts delete mode 100644 types/lib/ConclaveChallenge.d.ts delete mode 100644 types/lib/ConstructionProgress.d.ts delete mode 100644 types/lib/DailyDeal.d.ts delete mode 100644 types/lib/DarkSector.d.ts delete mode 100644 types/lib/DarkSectorBattle.d.ts delete mode 100644 types/lib/Dependency.d.ts delete mode 100644 types/lib/EarthCycle.d.ts delete mode 100644 types/lib/ExternalMission.d.ts delete mode 100644 types/lib/Fissure.d.ts delete mode 100644 types/lib/FlashSale.d.ts delete mode 100644 types/lib/GlobalUpgrade.d.ts delete mode 100644 types/lib/Invasion.d.ts delete mode 100644 types/lib/Kuva.d.ts delete mode 100644 types/lib/MarkdownSettings.d.ts delete mode 100644 types/lib/Mission.d.ts delete mode 100644 types/lib/News.d.ts delete mode 100644 types/lib/Nightwave.d.ts delete mode 100644 types/lib/NightwaveChallenge.d.ts delete mode 100644 types/lib/PersistentEnemy.d.ts delete mode 100644 types/lib/Reward.d.ts delete mode 100644 types/lib/SentientOutpost.d.ts delete mode 100644 types/lib/Simaris.d.ts delete mode 100644 types/lib/Sortie.d.ts delete mode 100644 types/lib/SortieVariant.d.ts delete mode 100644 types/lib/SyndicateJob.d.ts delete mode 100644 types/lib/SyndicateMission.d.ts delete mode 100644 types/lib/VallisCycle.d.ts delete mode 100644 types/lib/VoidTrader.d.ts delete mode 100644 types/lib/VoidTraderItem.d.ts delete mode 100644 types/lib/WeeklyChallenge.d.ts delete mode 100644 types/lib/WorldEvent.d.ts delete mode 100644 types/lib/WorldState.d.ts delete mode 100644 types/lib/WorldstateObject.d.ts delete mode 100644 types/lib/supporting/Dependency.d.ts delete mode 100644 types/lib/supporting/ExternalMission.d.ts delete mode 100644 types/lib/supporting/MarkdownSettings.d.ts delete mode 100644 types/lib/timeDate.d.ts delete mode 100644 types/lib/translation.d.ts delete mode 100644 types/main.d.ts diff --git a/lib/CambionCycle.js b/lib/CambionCycle.js index 2dac4e354..66e7dac28 100644 --- a/lib/CambionCycle.js +++ b/lib/CambionCycle.js @@ -5,6 +5,7 @@ const WorldstateObject = require('./WorldstateObject'); /** * Represents the current Cambion Drift Fass/Vome Cycle * @extends {WorldstateObject} + * @property {string} timeLeft time rendering of amount of time left */ module.exports = class CambionCycle extends WorldstateObject { /** @@ -18,6 +19,7 @@ module.exports = class CambionCycle extends WorldstateObject { ({ activation: this.activation, expiry: this.expiry, + timeLeft: this.timeLeft, } = cetusCycle); this.active = cetusCycle.isDay ? 'fass' : 'vome'; diff --git a/types/lib/Alert.d.ts b/types/lib/Alert.d.ts deleted file mode 100644 index 07383f8e1..000000000 --- a/types/lib/Alert.d.ts +++ /dev/null @@ -1,64 +0,0 @@ -export = Alert; -declare const Alert_base: typeof import("./WorldstateObject.js"); -/** - * Represents an alert - * @extends {WorldstateObject} - */ -declare class Alert extends Alert_base { - /** - * @param {Object} data The alert data - * @param {MarkdownSettings} mdConfig The markdown settings - * @param {Translator} translator The string translator - * @param {TimeDateFunctions} timeDate The time and date functions - * @param {Mission} Mission The Mission parser - * @param {Reward} Reward The Reward parser - * @param {string} locale Locale to use for translations - */ - constructor(data: any, { mdConfig, translator, timeDate, Mission, Reward, locale, }: any); - /** - * The markdown settings - * @type {MarkdownSettings} - * @private - */ - private mdConfig; - /** - * The mission that the players have to complete - * @type {Mission} - */ - mission: any; - /** - * ETA string (at time of object creation) - * @type {String} - */ - eta: string; - /** - * An array containing the types of all of the alert's rewards - * @type {Array.} - */ - rewardTypes: Array; - /** - * A tag that DE occasionally provides, such as `LotusGift` - * @type {String} - */ - tag: string; - /** - * Get the alert's description text - * @returns {string} - */ - getDescription(): string; - /** - * Get the alert's reward - * @returns {Reward} - */ - getReward(): any; - /** - * Get a string indicating how much time is left before the alert expires - * @returns {string} - */ - getETAString(): string; - /** - * Get an array containing the types of all of the alert's rewards - * @returns {Array.} - */ - getRewardTypes(): Array; -} diff --git a/types/lib/CetusCycle.d.ts b/types/lib/CetusCycle.d.ts deleted file mode 100644 index 7410b8d24..000000000 --- a/types/lib/CetusCycle.d.ts +++ /dev/null @@ -1,64 +0,0 @@ -export = CetusCycle; -declare const CetusCycle_base: typeof import("./WorldstateObject.js"); -/** - * Represents the current Earth Day/Night Cycle - * @extends {WorldstateObject} - */ -declare class CetusCycle extends CetusCycle_base { - /** - * @param {Date} bountiesEndDate The end date for Ostron bounties - * @param {Object} deps The dependencies object - * @param {MarkdownSettings} deps.mdConfig The markdown settings - * @param {TimeDateFunctions} deps.timeDate The time and date functions - */ - constructor(bountiesEndDate: Date, { mdConfig, timeDate }: { - mdConfig: any; - timeDate: any; - }); - /** - * The markdown settings - * @type {MarkdownSettings} - * @private - */ - private mdConfig; - /** - * The end of the Ostron bounties timer (marks the end of night) - * @type {Date} - * @private - */ - private bountiesEndDate; - /** - * Whether or not this it's daytime - * @type {boolean} - */ - isDay: boolean; - /** - * Current cycle state. One of `day`, `night` - * @type {string} - */ - state: string; - /** - * Time remaining string - * @type {string} - */ - timeLeft: string; - /** - * Whether or not this is for Cetus Cycle - * @type {boolean} - */ - isCetus: boolean; - shortString: string; - /** - * Get whether or not the event has expired - * @returns {boolean} - */ - getExpired(): boolean; - getCurrentCetusCycle(): { - dayTime: boolean; - timeLeft: any; - expiry: Date; - expiresIn: any; - state: string; - start: number; - }; -} diff --git a/types/lib/ChallengeInstance.d.ts b/types/lib/ChallengeInstance.d.ts deleted file mode 100644 index 4cf5eb829..000000000 --- a/types/lib/ChallengeInstance.d.ts +++ /dev/null @@ -1,44 +0,0 @@ -export = ChallengeInstance; -/** - * Describes a world challenge instance - */ -declare class ChallengeInstance { - /** - * @param {Object} data The challenge instance data - * @param {Dependency} deps The dependencies object - * @param {Translator} deps.translator The string translator - * @param {string} deps.locale Locale to use for translations - */ - constructor(data: any, { translator, locale }: any); - /** - * Type of challenge - * @type {string} - */ - type: string; - /** - * Minimum enemy level to fulfill challenge - * @type {Number} - */ - minEnemyLevel: number; - /** - * Required number of units to complete challenge - * @type {Number} - */ - requiredAmount: number; - /** - * Waypoint for amount of units between progression updates - * @type {Number} - */ - progressAmount: number; - /** - * Required damage type - * @type {String|undefined} - */ - damageType: string | undefined; - /** - * Target to fulfill challenge - * @type {string} - */ - target: string; - toString(): string; -} diff --git a/types/lib/ConclaveChallenge.d.ts b/types/lib/ConclaveChallenge.d.ts deleted file mode 100644 index 035c63889..000000000 --- a/types/lib/ConclaveChallenge.d.ts +++ /dev/null @@ -1,93 +0,0 @@ -export = ConclaveChallenge; -declare const ConclaveChallenge_base: typeof import("./WorldstateObject.js"); -/** - * Represents a Conclave challenge - * @extends {WorldstateObject} - */ -declare class ConclaveChallenge extends ConclaveChallenge_base { - /** - * @param {Object} data The challenge 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 {string} deps.locale Locale to use for translations - */ - constructor(data: any, { mdConfig, translator, timeDate, locale, }: { - mdConfig: any; - translator: any; - timeDate: any; - locale: string; - }); - /** - * The markdown settings - * @type {MarkdownSettings} - * @private - */ - private mdConfig; - /** - * The challenge's description text - * @type {string} - */ - description: string; - /** - * The number of times that the challenge's objective needs to be completed - * @type {number} - */ - amount: number; - /** - * The PVP mode that the challenge must be completed in - * @type {string} - */ - mode: string; - /** - * The challenge's category (daily, weekly...) - * @type {string} - */ - category: string; - /** - * ETA string (at time of object creation) - * @type {String} - */ - eta: string; - /** - * Whether or not this is expired (at time of object creation) - * @type {boolean} - */ - expired: boolean; - /** - * Whether or not this is a daily conclave challenge. - * @type {boolean} - */ - daily: boolean; - /** - * Whether or not this is the root challenge - * @type {boolean} - */ - rootChallenge: boolean; - /** - * the end string - * @type {string} - */ - endString: string; - /** - * This challenge as a string - * @type {string} - */ - asString: string; - /** - * Get whether or not the challenge is daily - * @returns {boolean} - */ - isDaily(): boolean; - /** - * Get whether or not this is the weekly root challenge - * @returns {boolean} - */ - isRootChallenge(): boolean; - /** - * Get whether or not the challenge has expired - * @returns {boolean} - */ - isExpired(): boolean; -} diff --git a/types/lib/ConstructionProgress.d.ts b/types/lib/ConstructionProgress.d.ts deleted file mode 100644 index ca7e46ad6..000000000 --- a/types/lib/ConstructionProgress.d.ts +++ /dev/null @@ -1,25 +0,0 @@ -export = ConstructionProgress; -declare const ConstructionProgress_base: typeof import("./WorldstateObject.js"); -/** - * Represents enemy construction progress - * @extends {WorldstateObject} - */ -declare class ConstructionProgress extends ConstructionProgress_base { - /** - * @param {Object} data The construction data - * @param {Object} deps The dependencies object - * @param {MarkdownSettings} deps.mdConfig The markdown settings - */ - constructor(data: any, { mdConfig, timeDate }: { - mdConfig: any; - }); - /** - * The markdown settings - * @type {MarkdownSettings} - * @private - */ - private mdConfig; - fomorianProgress: any; - razorbackProgress: any; - unknownProgress: any; -} diff --git a/types/lib/DailyDeal.d.ts b/types/lib/DailyDeal.d.ts deleted file mode 100644 index 412d00406..000000000 --- a/types/lib/DailyDeal.d.ts +++ /dev/null @@ -1,92 +0,0 @@ -export = DailyDeal; -/** - * Represents a daily deal - */ -declare class DailyDeal { - /** - * @param {Object} data The deal 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 {string} deps.locale Locale to use for translations - */ - constructor(data: any, { mdConfig, translator, timeDate, locale, }: { - mdConfig: any; - translator: any; - timeDate: any; - locale: string; - }); - /** - * The markdown settings - * @type {MarkdownSettings} - * @private - */ - private mdConfig; - /** - * The time and date functions - * @type {TimeDateFunctions} - * @private - */ - private timeDate; - /** - * The item that is being offered in the sale - * @type {string} - */ - item: string; - /** - * The date and time at which the deal will expire - * @type {Date} - */ - expiry: Date; - /** - * The date and time at which the deal will or did start - * @type {Date} - */ - activation: Date; - /** - * The item's original price - * @type {number} - */ - originalPrice: number; - /** - * The item's discounted price - * @type {number} - */ - salePrice: number; - /** - * The number of available items on sale - * @type {number} - */ - total: number; - /** - * The number of items that have already been sold - * @type {number} - */ - sold: number; - /** - * Unique identifier for this deal built from the end time and item - * @type {string} - */ - id: string; - /** - * ETA string (at time of object creation) - * @type {String} - */ - eta: string; - /** - * Percent discount - * @type {number} - */ - discount: number; - /** - * Get a string indicating how much time is left before the deal expires - * @returns {string} - */ - getETAString(): string; - /** - * Returns a string representation of the daily deal - * @returns {string} - */ - toString(): string; -} diff --git a/types/lib/DarkSector.d.ts b/types/lib/DarkSector.d.ts deleted file mode 100644 index 34f7e05a9..000000000 --- a/types/lib/DarkSector.d.ts +++ /dev/null @@ -1,132 +0,0 @@ -export = DarkSector; -declare const DarkSector_base: typeof import("./WorldstateObject.js"); -/** - * Represents a dark sector - * @extends {WorldstateObject} - */ -declare class DarkSector extends DarkSector_base { - /** - * @param {Object} data The dark sector 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 {Mission} deps.Mission The mission parser - * @param {DarkSectorBattle} deps.DarkSectorBattle The dark sector battle parser - * @param {Reward} deps.Reward The reward parser - * @param {string} deps.locale Locale to use for translations - */ - constructor(data: any, { mdConfig, translator, timeDate, Mission, DarkSectorBattle, Reward, locale, }: { - mdConfig: any; - translator: any; - timeDate: any; - Mission: any; - DarkSectorBattle: any; - Reward: any; - locale: string; - }); - /** - * The dark sector credit tax rate - * @type {number} - */ - creditTaxRate: number; - /** - * The dark sector credit tax rate for clan/alliance members - * @type {number} - */ - memberCreditsTaxRate: number; - /** - * The dark sector resource tax rate - * @type {number} - */ - itemsTaxRate: number; - /** - * The dark sector resource tax rate for clan/alliance members - * @type {number} - */ - memberItemsTaxRate: number; - /** - * Whether the dark sector holder is an alliance or not - * @type {Boolean} - */ - isAlliance: boolean; - /** - * The current holder of the dark sector - * @type {string} - */ - defenderName: string; - /** - * The remaining health of the current solar rail - * @type {number} - */ - defenderPoolRemaining: number; - /** - * The maximum health of the solar rail - * @type {number} - */ - defenderMaxPool: number; - /** - * The date and time at which the rail was deployed - * @type {Date} - */ - defenderDeployemntActivation: Date; - /** - * The solar rail type - * @type {string} - */ - railType: string; - /** - * The MOTD set by the dark sector holder - * @type {string} - */ - defenderMOTD: string; - /** - * The player who deployed the solar rail - * @type {string} - */ - deployerName: string; - /** - * The clan of the player who deployed the solar rail - * @type {string} - */ - deployerClan: string; - defenderRailHealReserve: any; - healRate: number; - damagePerMission: any; - /** - * The dark sector's mission - * @type {?Mission} - */ - mission: any; - battlePayReserve: any; - /** - * The battle pay per mission offered to players - * @type {number} - */ - perMissionBattlePay: number; - /** - * The player who set the battle pay - * @type {string} - */ - battlePaySetBy: string; - /** - * The clan of the player who set the battle pay - * @type {string} - */ - battlePaySetByClan: string; - /** - * The player who changed the tax - * @type {string} - */ - taxChangedBy: string; - /** - * The clan of the player who set the tax - * @type {string} - */ - taxChangedByClan: string; - /** - * The history of the dark sector - * @type {Array.} - */ - history: Array; -} diff --git a/types/lib/DarkSectorBattle.d.ts b/types/lib/DarkSectorBattle.d.ts deleted file mode 100644 index 924cff643..000000000 --- a/types/lib/DarkSectorBattle.d.ts +++ /dev/null @@ -1,47 +0,0 @@ -export = DarkSectorBattle; -/** - * Represents a battle over a dark sector - */ -declare class DarkSectorBattle { - /** - * @param {Object} data The battle data - */ - constructor(data: any, { timeDate }: { - timeDate: any; - }); - /** - * The defenders of the dark sector - * @type {string} - */ - defender: string; - /** - * Whether the defenders are an alliance or not - * @type {boolean} - */ - defenderIsAlliance: boolean; - /** - * The attackers of the dark sector - * @type {string} - */ - attacker: string; - /** - * Whether the attackers are an alliance or not - * @type {boolean} - */ - attackerIsAlliance: boolean; - /** - * The winner of the battle - * @type {string} - */ - winner: string; - /** - * The date and time at which the battle started - * @type {Date} - */ - start: Date; - /** - * The date and time at which the battle ended - * @type {Date} - */ - end: Date; -} diff --git a/types/lib/Dependency.d.ts b/types/lib/Dependency.d.ts deleted file mode 100644 index 78d584db1..000000000 --- a/types/lib/Dependency.d.ts +++ /dev/null @@ -1,35 +0,0 @@ -export = Dependency; - -/** - * Dependency Object - */ -declare type Dependency = { - /** - * The markdown settings - */ - mdConfig: import("./MarkdownSettings"); - /** - * The string translator - */ - translator: any; - /** - * The time and date functions - */ - timeDate: any; - /** - * The Mission parser - */ - Mission: import("./Mission.js"); - /** - * The Reward parser - */ - Reward: import("./Reward.js"); - /** - * Locale to use for translations - */ - locale: string; - /** - * Generic logger to use if needed - */ - logger: object; -}; \ No newline at end of file diff --git a/types/lib/EarthCycle.d.ts b/types/lib/EarthCycle.d.ts deleted file mode 100644 index c9eafb51f..000000000 --- a/types/lib/EarthCycle.d.ts +++ /dev/null @@ -1,40 +0,0 @@ -export = EarthCycle; -declare const EarthCycle_base: typeof import("./WorldstateObject.js"); -/** - * Represents the current Earth Day/Night Cycle - * @extends {WorldstateObject} - */ -declare class EarthCycle extends EarthCycle_base { - /** - * @param {Object} data The event data - * @param {Object} deps The dependencies object - * @param {MarkdownSettings} deps.mdConfig The markdown settings - */ - constructor({ mdConfig, timeDate }: any); - /** - * The markdown settings - * @type {MarkdownSettings} - * @private - */ - private mdConfig; - /** - * Whether or not this it's daytime - * @type {boolean} - */ - isDay: boolean; - /** - * Current cycle state. One of `day`, `night` - * @type {string} - */ - state: string; - /** - * Time remaining string - * @type {string} - */ - timeLeft: string; - /** - * Get whether or not the event has expired - * @returns {boolean} - */ - getExpired(): boolean; -} diff --git a/types/lib/ExternalMission.d.ts b/types/lib/ExternalMission.d.ts deleted file mode 100644 index bec65da48..000000000 --- a/types/lib/ExternalMission.d.ts +++ /dev/null @@ -1,36 +0,0 @@ -export = ExternalMission; - -/** - * External mission data retrieved from https://10o.io/kuvalog.json - */ -declare 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; -}; \ No newline at end of file diff --git a/types/lib/Fissure.d.ts b/types/lib/Fissure.d.ts deleted file mode 100644 index c53af892d..000000000 --- a/types/lib/Fissure.d.ts +++ /dev/null @@ -1,65 +0,0 @@ -export = Fissure; -declare const Fissure_base: typeof import("./WorldstateObject.js"); -/** - * Represents a fissure mission - * @extends {WorldstateObject} - */ -declare class Fissure extends Fissure_base { - /** - * @param {Object} data The fissure data - * @param {Object} deps The dependencies object - * @param {Translator} deps.translator The string translator - * @param {TimeDateFunctions} deps.timeDate The time and date functions - * @param {string} deps.locale Locale to use for translations - */ - constructor(data: any, { translator, timeDate, locale }: { - translator: any; - timeDate: any; - locale: string; - }); - /** - * The node where the fissure has appeared - * @type {string} - */ - node: string; - /** - * The fissure mission type - * @type {string} - */ - missionType: string; - /** - * The faction controlling the node where the fissure has appeared - * @type {string} - */ - enemy: string; - /** - * The fissure's tier - * @type {string} - */ - tier: string; - /** - * The fissure's tier as a number - * @type {number} - */ - tierNum: number; - /** - * 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; - /** - * Get whether or not this deal has expired - * @returns {boolean} - */ - getExpired(): boolean; - /** - * Get a string representation of how long the void fissure will remain active - * @returns {string} - */ - getETAString(): string; -} diff --git a/types/lib/FlashSale.d.ts b/types/lib/FlashSale.d.ts deleted file mode 100644 index fc4e7b781..000000000 --- a/types/lib/FlashSale.d.ts +++ /dev/null @@ -1,107 +0,0 @@ -export = FlashSale; -/** - * Represents a flash sale - */ -declare class FlashSale { - /** - * @param {Object} data The flash sale 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 {string} deps.locale Locale to use for translations - */ - constructor(data: any, { translator, mdConfig, timeDate, locale, }: { - mdConfig: any; - translator: any; - timeDate: any; - locale: string; - }); - /** - * The markdown settings - * @type {MarkdownSettings} - * @private - */ - private mdConfig; - /** - * The time and date functions - * @type {TimeDateFunctions} - * @private - */ - private timeDate; - /** - * The item being offered in the flash sale - * @type {string} - */ - item: string; - /** - * The date and time at which the sale will end - * @type {Date} - */ - expiry: Date; - /** - * The date and time at which the sale will or did start - * @type {Date} - */ - activation: Date; - /** - * The item's discount percentage - * @type {number} - */ - discount: number; - /** - * The item's discounted credit price - * @type {number} - */ - regularOverride: number; - /** - * The item's discounted platinum price - * @type {number} - */ - premiumOverride: number; - /** - * Whether this item is show in the in-game market - * @type {boolean} - */ - isShownInMarket: boolean; - /** - * Whether this item is featured in the in-game market - * @type {boolean} - */ - isFeatured: boolean; - /** - * Whether this item is marked as popular in the in-game market - * @type {boolean} - */ - isPopular: boolean; - /** - * Unique identifier for this sale built from the end time and reward - * @type {string} - */ - id: 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; - /** - * Get how much time is left before the deal expires - * @returns {string} - */ - getETAString(): string; - /** - * Get whether or not this deal has expired - * @returns {boolean} - */ - getExpired(): boolean; - /** - * Returns a string representation of the flash sale - * @returns {string} - */ - toString(): string; -} diff --git a/types/lib/GlobalUpgrade.d.ts b/types/lib/GlobalUpgrade.d.ts deleted file mode 100644 index 5000b8ee8..000000000 --- a/types/lib/GlobalUpgrade.d.ts +++ /dev/null @@ -1,97 +0,0 @@ -export = GlobalUpgrade; -/** - * Represents an upgrade that applies to all players - */ -declare class GlobalUpgrade { - /** - * @param {Object} data The global upgrade data - * @param {Object} deps The dependencies object - * @param {Translator} deps.translator The string translator - * @param {TimeDateFunctions} deps.timeDate The time and date functions - * @param {MarkdownSettings} deps.mdConfig The markdown settings - * @param {string} deps.locale Locale to use for translations - */ - constructor(data: any, { translator, timeDate, mdConfig, locale, }: { - translator: any; - timeDate: any; - mdConfig: any; - locale: string; - }); - /** - * The time and date functions - * @type {TimeDateFunctions} - * @private - */ - private timeDate; - /** - * The markdown settings - * @type {MarkdownSettings} - * @private - */ - private mdConfig; - /** - * The time and date at which the global upgrade starts being active - * @type {Date} - */ - start: Date; - /** - * The time and date at which the global upgrade stops being active - * @type {Date} - */ - end: Date; - /** - * 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} - */ - getExpired(): boolean; - /** - * Get a string indicating how long it will take for the upgrade to expire - * @returns {string} - */ - 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} - */ - toString(): string; -} diff --git a/types/lib/Invasion.d.ts b/types/lib/Invasion.d.ts deleted file mode 100644 index ff012fc3d..000000000 --- a/types/lib/Invasion.d.ts +++ /dev/null @@ -1,117 +0,0 @@ -export = Invasion; -declare const Invasion_base: typeof import("./WorldstateObject.js"); -/** - * Represents an invasion - */ -declare class Invasion extends Invasion_base { - /** - * @param {Object} data The invasion 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 - * @param {string} deps.locale Locale to use for translations - */ - constructor(data: any, { mdConfig, translator, timeDate, Reward, locale, }: { - mdConfig: any; - translator: any; - timeDate: any; - Reward: any; - locale: string; - }); - /** - * The markdown settings - * @type {MarkdownSettings} - * @private - */ - private mdConfig; - /** - * The node where the invasion is taking place - * @type {string} - */ - node: string; - /** - * The invasion's description - * @type {string} - */ - desc: string; - /** - * The attacker's reward - * @type {Reward} - */ - attackerReward: any; - /** - * The attacking faction - * @type {string} - */ - attackingFaction: string; - /** - * The defender's reward - * @type {Reward} - */ - defenderReward: any; - /** - * The defending faction - * @type {string} - */ - defendingFaction: string; - /** - * 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 alert's rewards - * @type {Array.} - */ - rewardTypes: Array; - /** - * Whether or not the attackers are winning. - * This is always false when the infestation is attacking - * @returns {boolean} - */ - isAttackerWinning(): boolean; - /** - * Get an estimation of how much time is left before the invasion ends in milliseconds - * @returns {number} - */ - getRemainingTime(): number; - /** - * Get a string estimating how much time is left before the invasion ends - * @returns {string} - */ - getETAString(): string; - /** - * Get the types of the items being rewarded in the invasion - * @returns {Array.} - */ - getRewardTypes(): Array; -} diff --git a/types/lib/Kuva.d.ts b/types/lib/Kuva.d.ts deleted file mode 100644 index 2511c610f..000000000 --- a/types/lib/Kuva.d.ts +++ /dev/null @@ -1,76 +0,0 @@ -export = Kuva; -/** - * Stores and parses kuva data from https://10o.io/kuvalog.json - * @property {ExternalMission[]} kuva currently active kuva missions - * @property {ExternalMission} arbitration current arbitration - */ -declare class Kuva { - constructor({ kuvaData, translator, locale, logger, }: { - kuvaData: any; - translator: any; - locale: any; - logger: any; - }); - /** - * The translation functions - * @type {Translator} - * @private - */ - private translator; - /** - * The locale to leverage for translations - * @type {string} - * @private - */ - private locale; -} -declare namespace Kuva { - export { ExternalMission, Kuva }; -} -/** - * External mission data retrieved from https://10o.io/kuvalog.json - */ -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 - */ -type Kuva = { - /** - * currently active kuva missions - */ - kuva: ExternalMission[]; - /** - * current arbitration - */ - arbitration: ExternalMission; -}; diff --git a/types/lib/MarkdownSettings.d.ts b/types/lib/MarkdownSettings.d.ts deleted file mode 100644 index 9b1fd3edf..000000000 --- a/types/lib/MarkdownSettings.d.ts +++ /dev/null @@ -1,22 +0,0 @@ -export = MarkdownSettings; - -/** - * A collection of strings that are used by the parser to produce markdown-formatted text - */ -declare type MarkdownSettings = { - /** - * Line return character - */ - lineEnd: String; - blockEnd: String; - doubleReturn: String; - linkBegin: String; - linkMid: String; - linkEnd: String; - bold: String; - italic: String; - underline: String; - strike: String; - codeLine: String; - codeBlock: String; -}; \ No newline at end of file diff --git a/types/lib/Mission.d.ts b/types/lib/Mission.d.ts deleted file mode 100644 index 5d7897e87..000000000 --- a/types/lib/Mission.d.ts +++ /dev/null @@ -1,136 +0,0 @@ -export = Mission; -/** - * Represents an in-game mission - */ -declare class Mission { - /** - * @param {Object} data The mission data - * @param {Object} deps The dependencies object - * @param {MarkdownSettings} deps.mdConfig The markdown settings - * @param {Translator} deps.translator The string translator - * @param {Reward} deps.Reward The Reward parser - * @param {string} deps.locale Locale to use for translations - */ - constructor(data: any, { mdConfig, translator, Reward, locale, }: { - mdConfig: any; - translator: any; - Reward: any; - locale: string; - }); - /** - * The markdown settings - * @type {MarkdownSettings} - * @private - */ - private mdConfig; - /** - * The mission's description - * @type {?string} - */ - description: string | null; - /** - * The node where the mission takes place - * @type {string} - */ - node: string; - /** - * The mission's type - * @type {string} - */ - type: string; - /** - * The factions that the players must fight in the mission - * @type {string} - */ - faction: string; - /** - * The mission's reward - * @type {?Reward} - */ - reward: any; - /** - * 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} - */ - toString(): string; -} diff --git a/types/lib/News.d.ts b/types/lib/News.d.ts deleted file mode 100644 index 8beec7d97..000000000 --- a/types/lib/News.d.ts +++ /dev/null @@ -1,116 +0,0 @@ -export = News; -declare const News_base: typeof import("./WorldstateObject.js"); -/** - * Represents a game news item - * @extends {WorldstateObject} - */ -declare class News extends News_base { - /** - * @param {Object} data The news data - * @param {Dependency} deps The dependencies object - * @param {MarkdownSettings} deps.mdConfig The markdown settings - * @param {TimeDateFunctions} deps.timeDate The time and date functions - * @param {locale} deps.locale Locale to use for determining language - */ - constructor(data: any, { mdConfig, timeDate, locale }: any); - /** - * The markdown settings - * @type {MarkdownSettings} - * @private - */ - private mdConfig; - /** - * 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; - /** - * Whther or not this is an update news item - * @type {boolean} - */ - update: boolean; - /** - * Whther or not 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 {Object.} - */ - translations: { - [x: 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} - */ - getETAString(): string; - /** - * Whether or not this is about a game update - * @returns {boolean} - */ - isUpdate(): boolean; - /** - * Whether or not this is about a new Prime Access - * @returns {boolean} - */ - isPrimeAccess(): boolean; - /** - * Whether or not this is about a new Prime Access - * @returns {boolean} - */ - isStream(): boolean; - /** - * The title of the news item in the specified language - * @param {string} langCode Ex. 'es', 'de', 'fr' - * @returns {string} - */ - getTitle(langCode: string): string; -} diff --git a/types/lib/Nightwave.d.ts b/types/lib/Nightwave.d.ts deleted file mode 100644 index 2f52f4388..000000000 --- a/types/lib/Nightwave.d.ts +++ /dev/null @@ -1,69 +0,0 @@ -export = Nightwave; -declare const Nightwave_base: typeof import("./WorldstateObject.js"); -/** - * Represents an alert - * @extends {WorldstateObject} - */ -declare class Nightwave extends Nightwave_base { - /** - * @param {Object} data The alert 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 {Mission} deps.Mission The Mission parser - * @param {Reward} deps.Reward The Reward parser - * @param {string} deps.locale Locale to use for translations - */ - constructor(data: any, { mdConfig, translator, timeDate, Mission, Reward, locale, }: { - mdConfig: any; - translator: any; - timeDate: any; - Mission: any; - Reward: any; - locale: string; - }); - /** - * The markdown settings - * @type {MarkdownSettings} - * @private - */ - private mdConfig; - /** - * 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: any; - possibleChallenges: any; - activeChallenges: any; - /** - * An array containing the types of all of the alert's rewards - * @type {Array.} - */ - rewardTypes: Array; - /** - * Get a string indicating how much time is left before the alert expires - * @returns {string} - */ - getETAString(): string; - /** - * Get an array containing the types of all of the nightwave season's rewards - * @returns {Array.} - */ - getRewardTypes(): Array; -} diff --git a/types/lib/NightwaveChallenge.d.ts b/types/lib/NightwaveChallenge.d.ts deleted file mode 100644 index 9555366c5..000000000 --- a/types/lib/NightwaveChallenge.d.ts +++ /dev/null @@ -1,45 +0,0 @@ -export = NightwaveChallenge; -declare const NightwaveChallenge_base: typeof import("./WorldstateObject.js"); -/** - * Represents an alert - * @extends {WorldstateObject} - */ -declare class NightwaveChallenge extends NightwaveChallenge_base { - /** - * @param {Object} data The alert data - * @param {Object} deps The dependencies object - * @param {Translator} deps.translator The string translator - * @param {TimeDateFunctions} deps.timeDate The time and date functions - * @param {string} deps.locale Locale to use for translations - */ - constructor(data: any, { translator, timeDate, locale, }: { - translator: any; - timeDate: any; - 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; -} diff --git a/types/lib/PersistentEnemy.d.ts b/types/lib/PersistentEnemy.d.ts deleted file mode 100644 index 44babc395..000000000 --- a/types/lib/PersistentEnemy.d.ts +++ /dev/null @@ -1,81 +0,0 @@ -export = PersistentEnemy; -declare const PersistentEnemy_base: typeof import("./WorldstateObject.js"); -/** - * Represents a persistent enemy - * @extends {WorldstateObject} - */ -declare class PersistentEnemy extends PersistentEnemy_base { - /** - * @param {Object} data The persistent enemy data - * @param {Object} deps The dependencies object - * @param {MarkdownSettings} deps.mdConfig The markdown settings - * @param {Translator} deps.translator The string translator - * @param {string} deps.locale Locale to use for translations - */ - constructor(data: any, { mdConfig, translator, timeDate, locale, }: { - mdConfig: any; - translator: any; - locale: string; - }); - /** - * The markdown settings - * @type {MarkdownSettings} - * @private - */ - private mdConfig; - /** - * 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 remainaing 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; -} diff --git a/types/lib/Reward.d.ts b/types/lib/Reward.d.ts deleted file mode 100644 index cd2cf0a75..000000000 --- a/types/lib/Reward.d.ts +++ /dev/null @@ -1,79 +0,0 @@ -export = Reward; -/** - * Represents a mission reward - */ -declare class Reward { - /** - * @param {Object} data The mission data - * @param {Object} deps The dependencies object - * @param {Translator} deps.translator The string translator - * @param {string} deps.locale Locale to use for translations - */ - constructor(data: any, { translator, locale }: { - translator: any; - locale: string; - }); - /** - * The items being rewarded - * @type {Array.} - */ - items: Array; - /** - * The counted items being rewarded - * @type {Array.} - */ - countedItems: Array; - /** - * 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.} - */ - getTypes(): Array; - /** - * The types of all the items that are being rewarded - * @returns {Array.} - */ - getTypesFull(): Array; - /** - * The reward's string representation - * @returns {string} - */ - toString(): string; -} -declare namespace Reward { - export { RewardType }; -} -/** - * An object describing a type of reward, including name, description, - * test function to verify type from a string, thumbnail url, and color - */ -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; -}; diff --git a/types/lib/SentientOutpost.d.ts b/types/lib/SentientOutpost.d.ts deleted file mode 100644 index a57cfc1c5..000000000 --- a/types/lib/SentientOutpost.d.ts +++ /dev/null @@ -1,58 +0,0 @@ -export = SentientOutpost; -/** - * 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 - */ -declare class SentientOutpost { - constructor(data: string, { translator, locale, sentientData, logger, }: { - translator: any; - locale: any; - sentientData: any; - logger: any; - }); - mission: { - node: any; - faction: any; - type: any; - }; - active: boolean; - id: string; - activation: Date; - expiry: Date; -} -declare namespace SentientOutpost { - export { Mission }; -} -/** - * Mission typeDef - */ -type Mission = { - /** - * Mission node name - */ - node: string; - /** - * Node enemy - */ - enemy: string; - /** - * Mission type of the node - */ - type: string; -}; diff --git a/types/lib/Simaris.d.ts b/types/lib/Simaris.d.ts deleted file mode 100644 index 983219d25..000000000 --- a/types/lib/Simaris.d.ts +++ /dev/null @@ -1,44 +0,0 @@ -export = Simaris; -/** - * Contains information about sanctuary targets - */ -declare class Simaris { - /** - * @param {Object} data The sanctuary data - * @param {Object} deps The dependencies object - * @param {MarkdownSettings} deps.mdConfig The markdown settings - * @param {Translator} deps.translator The string translator - * @param {string} deps.locale Locale to use for translations - */ - constructor(data: any, { mdConfig, translator, locale }: { - mdConfig: any; - translator: any; - locale: string; - }); - /** - * The markdown settings - * @type {MarkdownSettings} - * @private - */ - private mdConfig; - /** - * 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} - */ - toString(): string; -} diff --git a/types/lib/Sortie.d.ts b/types/lib/Sortie.d.ts deleted file mode 100644 index 8fa8be2a6..000000000 --- a/types/lib/Sortie.d.ts +++ /dev/null @@ -1,82 +0,0 @@ -export = Sortie; -declare const Sortie_base: typeof import("./WorldstateObject.js"); -/** - * Represents a daily sortie - * @extends {WorldstateObject} - */ -declare class Sortie extends Sortie_base { - /** - * @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 - */ - constructor(data: any, { mdConfig, translator, timeDate, sortieData, SortieVariant, locale, }: { - mdConfig: any; - translator: any; - timeDate: any; - sortieData: any; - SortieVariant: any; - locale: string; - }); - /** - * The markdown settings - * @type {MarkdownSettings} - * @private - */ - private mdConfig; - /** - * The sortie's reward pool - * @type {string} - */ - rewardPool: string; - /** - * The sortie's variants - * @type {Array.} - */ - variants: Array; - /** - * The sortie's boss - * @type {string} - */ - boss: string; - /** - * The sortie's faction - * @type {string} - */ - faction: 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; - /** - * Get the sortie's boss - * @returns {string} - */ - getBoss(): string; - /** - * Get the sortie's faction - * @returns {string} - */ - getFaction(): string; - /** - * Gets a string indicating how long it will take for the sortie to end - * @returns {string} - */ - getETAString(): string; - /** - * Get whether or not the sortie has expired - * @returns {boolean} - */ - isExpired(): boolean; -} diff --git a/types/lib/SortieVariant.d.ts b/types/lib/SortieVariant.d.ts deleted file mode 100644 index 9c60c6d0f..000000000 --- a/types/lib/SortieVariant.d.ts +++ /dev/null @@ -1,61 +0,0 @@ -export = SortieVariant; -/** - * Represents a sortie variant - */ -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 - */ - constructor(data: any, { mdConfig, translator, sortieData, locale, }: { - mdConfig: any; - translator: any; - sortieData: any; - locale: string; - }); - /** - * The markdown settings - * @type {MarkdownSettings} - * @private - */ - private mdConfig; - /** - * The variant's boss - * @type {string} - */ - boss: string; - /** - * The planet where the variant takes place - * @type {string} - */ - planet: string; - /** - * The variant's mission type - * @type {string} - */ - missionType: string; - /** - * 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; - /** - * Returns a string representation of the sortie variant - * @returns {string} - */ - toString(): string; -} diff --git a/types/lib/SyndicateJob.d.ts b/types/lib/SyndicateJob.d.ts deleted file mode 100644 index ae8bdf439..000000000 --- a/types/lib/SyndicateJob.d.ts +++ /dev/null @@ -1,44 +0,0 @@ -export = SyndicateJob; -declare const SyndicateJob_base: typeof import("./WorldstateObject.js"); -/** - * Represents a syndicate daily mission - * @extends {WorldstateObject} - */ -declare class SyndicateJob extends SyndicateJob_base { - /** - * @param {Object} data The syndicate mission data - * @param {Date} expiry The syndicate job expiration - * @param {Object} deps The dependencies object - * @param {Translator} deps.translator The string translator - * @param {string} deps.locale Locale to use for translations - */ - constructor(data: any, expiry: Date, { translator, timeDate, locale }: { - translator: any; - locale: string; - }); - /** - * Array of strings describing rewards - * @type {Array.} - */ - rewardPool: Array; - /** - * The type of job this is - * @type {String} - */ - type: string; - /** - * Array of enemy levels - * @type {Array.} - */ - enemyLevels: Array; - /** - * Array of standing gains per stage of job - * @type {Array.} - */ - standingStages: Array; - /** - * Minimum mastery required to participate - * @type {Number} - */ - minMR: number; -} diff --git a/types/lib/SyndicateMission.d.ts b/types/lib/SyndicateMission.d.ts deleted file mode 100644 index e6c166933..000000000 --- a/types/lib/SyndicateMission.d.ts +++ /dev/null @@ -1,59 +0,0 @@ -export = SyndicateMission; -declare const SyndicateMission_base: typeof import("./WorldstateObject.js"); -/** - * Represents a syndicate daily mission - * @extends {WorldstateObject} - */ -declare class SyndicateMission extends SyndicateMission_base { - /** - * @param {Object} data The syndicate mission 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 {string} deps.locale Locale to use for translations - */ - constructor(data: any, { mdConfig, translator, timeDate, locale, }: { - mdConfig: any; - translator: any; - timeDate: any; - locale: string; - }); - /** - * The markdown settings - * @type {MarkdownSettings} - * @private - */ - private mdConfig; - /** - * The translation functions - * @type {Translator} - * @private - */ - private translator; - /** - * The syndicate that is offering the mission - * @type {string} - */ - syndicate: string; - /** - * The nodes on which the missions are taking place - * @type {Array.} - */ - nodes: Array; - /** - * The jobs for this syndicate. Will normally be [] - * @type {Array.} - */ - jobs: Array; - /** - * ETA string (at time of object creation) - * @type {String} - */ - eta: string; - /** - * Get a string indicating how much time is left before the syndicate mission expries - * @returns {string} - */ - getETAString(): string; -} diff --git a/types/lib/VallisCycle.d.ts b/types/lib/VallisCycle.d.ts deleted file mode 100644 index a5dee5de3..000000000 --- a/types/lib/VallisCycle.d.ts +++ /dev/null @@ -1,42 +0,0 @@ -export = VallisCycle; -declare const VallisCycle_base: typeof import("./WorldstateObject.js"); -/** - * Represents the current Earth Day/Night Cycle - * @extends {WorldstateObject} - */ -declare class VallisCycle extends VallisCycle_base { - /** - * @param {Date} bountiesEndDate The end date for Ostron bounties - * @param {Object} deps The dependencies object - * @param {MarkdownSettings} deps.mdConfig The markdown settings - * @param {TimeDateFunctions} deps.timeDate The time and date functions - */ - constructor({ mdConfig, timeDate }: Date); - /** - * The markdown settings - * @type {MarkdownSettings} - * @private - */ - private mdConfig; - /** - * 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; - shortString: string; - /** - * Get whether or not the event has expired - * @returns {boolean} - */ - getExpired(): boolean; -} diff --git a/types/lib/VoidTrader.d.ts b/types/lib/VoidTrader.d.ts deleted file mode 100644 index 455196486..000000000 --- a/types/lib/VoidTrader.d.ts +++ /dev/null @@ -1,54 +0,0 @@ -export = VoidTrader; -declare const VoidTrader_base: typeof import("./WorldstateObject.js"); -/** - * Represents a void trader - * @extends {WorldstateObject} - */ -declare class VoidTrader extends VoidTrader_base { - /** - * @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 {string} deps.locale Locale to use for translations - */ - constructor(data: any, { mdConfig, translator, timeDate, locale, }: { - mdConfig: any; - translator: any; - timeDate: any; - locale: string; - }); - /** - * The markdown settings - * @type {MarkdownSettings} - * @private - */ - private mdConfig; - /** - * 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: import("./VoidTraderItem.js")[]; - /** - * 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; -} diff --git a/types/lib/VoidTraderItem.d.ts b/types/lib/VoidTraderItem.d.ts deleted file mode 100644 index 9a5fb86df..000000000 --- a/types/lib/VoidTraderItem.d.ts +++ /dev/null @@ -1,26 +0,0 @@ -export = VoidTraderItem; -/** - * 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 - */ -declare class VoidTraderItem { - /** - * @param {Object} data The challenge instance 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 {Translator} deps.translator The string translator - * @param {string} deps.locale Locale to use for translations - */ - constructor({ ItemType, PrimePrice, RegularPrice }: { - ItemType: string; - PrimePrice: string; - RegularPrice: string; - }, { translator, locale }: any); - item: any; - ducats: number; - credits: number; -} diff --git a/types/lib/WeeklyChallenge.d.ts b/types/lib/WeeklyChallenge.d.ts deleted file mode 100644 index 4fac63abd..000000000 --- a/types/lib/WeeklyChallenge.d.ts +++ /dev/null @@ -1,21 +0,0 @@ -export = WeeklyChallenge; -declare const WeeklyChallenge_base: typeof import("./WorldstateObject"); -/** - * Represents a void trader - * @extends {WorldstateObject} - */ -declare class WeeklyChallenge extends WeeklyChallenge_base { - /** - * @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 - */ - constructor(data: any, { timeDate, translator }: { - mdConfig: any; - translator: any; - timeDate: any; - }); - challenges: any; -} diff --git a/types/lib/WorldEvent.d.ts b/types/lib/WorldEvent.d.ts deleted file mode 100644 index 7ac3c9db7..000000000 --- a/types/lib/WorldEvent.d.ts +++ /dev/null @@ -1,219 +0,0 @@ -export = WorldEvent; -declare const WorldEvent_base: typeof import("./WorldstateObject.js"); -/** - * 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} ProgessStep - * - * @property {string} type - * @property {Number} progressAmt - */ -/** - * Represents an in-game special event - * - * @extends {WorldstateObject} - */ -declare class WorldEvent extends WorldEvent_base { - /** - * @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 - * @param {string} deps.locale Locale to use for translations - */ - constructor(data: any, { mdConfig, translator, timeDate, Reward, locale, }: { - mdConfig: any; - translator: any; - timeDate: any; - Reward: any; - locale: string; - }); - /** - * The markdown settings - * @type {MarkdownSettings} - * @private - */ - private mdConfig; - /** - * 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: any[]; - /** - * Whether or not this is expired (at time of object creation) - * @type {boolean} - */ - expired: boolean; - /** - * Health remaining for the target - * @type {Number} - */ - health: number; - affiliatedWith: any; - 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 {ProgessStep[]} - */ - progressSteps: ProgessStep[]; - /** - * Total of all MultiProgress - * @type {Number} - */ - progressTotal: number; - /** - * Whether or not to show the total score at the end of the mission - * @type {boolean} - */ - showTotalAtEndOfMission: boolean; - /** - * Whether or not the event is personal - * @type {Boolean} - */ - isPersonal: boolean; - /** - * Whether or not the event is community - * @type {Boolean} - */ - isCommunity: boolean; - /** - * Affectors for this mission - * @type {string[]} - */ - regionDrops: string[]; - /** - * Archwing Drops in effect while this event is active - * @type {string[]} - */ - archwingDrops: string[]; - asString: string; - /** - * Metadata provided by DE - * @type {Object} - */ - metadata: any; - /** - * Bonuses given for completion - * @type {Array.} - */ - completionBonuses: Array; - scoreVar: any; - altExpiry: any; - altActivation: any; - nextAlt: { - expiry: any; - activation: any; - }; - /** - * Get whether or not the event has expired - * @returns {boolean} - */ - getExpired(): boolean; -} -declare namespace WorldEvent { - export { InterimStep, ProgessStep }; -} -/** - * Interim step for an event reward system. - */ -type InterimStep = { - /** - * Goal amount - */ - goal: number; - /** - * Reward for reaching the step - */ - reward: any; - /** - * Amount of players at this step - */ - winnerCount: number; - /** - * Message received when reaching the interim step - */ - message: any; -}; -/** - * Progress for one of multiple stages - */ -type ProgessStep = { - type: string; - progressAmt: number; -}; diff --git a/types/lib/WorldState.d.ts b/types/lib/WorldState.d.ts deleted file mode 100644 index 9600890ff..000000000 --- a/types/lib/WorldState.d.ts +++ /dev/null @@ -1,117 +0,0 @@ -export = WorldState; -/** - * Parses Warframe Worldstate JSON - */ -declare class WorldState { - /** - * Generates the worldstate json as a string into usable objects - * @param {string} json The worldstate JSON string - * @param {Dependency} [deps] The options object - */ - constructor(json: string, deps?: import("./supporting/Dependency.js")); - /** - * The date and time at which the World State was generated - * @type {Date} - */ - timestamp: Date; - /** - * The in-game news - * @type {Array.} - */ - news: Array; - /** - * The current events - * @type {Array.} - */ - events: Array; - /** - * The current alerts - * @type {Array.} - */ - alerts: Array; - /** - * The current syndicate missions - * @type {Array.} - */ - syndicateMissions: Array; - /** - * The current fissures - * @type {Array.} - */ - fissures: Array; - /** - * The current global upgrades - * @type {Array.} - */ - globalUpgrades: Array; - /** - * The current flash sales - * @type {Array.} - */ - flashSales: Array; - /** - * The current invasions - * @type {Array.} - */ - invasions: Array; - /** - * The state of the dark sectors - * @type {Array.} - */ - darkSectors: Array; - /** - * The current daily deals - * @type {Array.} - */ - dailyDeals: Array; - /** - * The state of the sanctuary synthesis targets - * @type {Simaris} - */ - simaris: import("./Simaris.js"); - /** - * The current conclave challenges - * @type {Array.} - */ - conclaveChallenges: Array; - /** - * The currently active persistent enemies - * @type {Array.} - */ - persistentEnemies: Array; - /** - * The current earth cycle - * @type {EarthCycle} - */ - earthCycle: import("./EarthCycle.js"); - /** - * The current Cetus cycle - * @type {CetusCycle} - */ - cetusCycle: import("./CetusCycle.js"); - /** - * Weekly challenges - * @type {Array.} - */ - weeklyChallenges: Array; - /** - * The Current construction progress for Fomorians/Razorback/etc. - * @type {ConstructionProgress} - */ - constructionProgress: import("./ConstructionProgress.js"); - /** - * The current Orb Vallis cycle state - * @type {VallisCycle} - */ - vallisCycle: import("./VallisCycle.js"); - /** - * The current nightwave season - * @type {Nightwave} - */ - nightwave: import("./Nightwave.js"); - /** - * Current syndicate outposts - * @type {SyndicateOutpost} - */ - sentientOutposts: import("./SentientOutpost.js"); -} diff --git a/types/lib/WorldstateObject.d.ts b/types/lib/WorldstateObject.d.ts deleted file mode 100644 index ef8654a1b..000000000 --- a/types/lib/WorldstateObject.d.ts +++ /dev/null @@ -1,64 +0,0 @@ -export = WorldstateObject; -/** - * Represents a generic ojbect from Worldstate - */ -declare class WorldstateObject { - /** - * @param {Object} data The object data - */ - constructor(data: any, { timeDate }: { - timeDate: any; - }); - /** - * The object's id field - * @type {string} - */ - id: string; - /** - * The time and date functions - * @type {TimeDateFunctions} - * @private - */ - private timeDate; - /** - * 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 or not the void trader is active (at time of object creation) - * @type {boolean} - */ - active: boolean; - /** - * Returns a string representation of the object - * @returns {string} - */ - toString(): string; - /** - * Get whether or not the trader is currently active - * @returns {boolean} - */ - isActive(): boolean; - /** - * Get a string indicating how long it will take for the trader to arrive - * @returns {string} - */ - getStartString(): string; - /** - * Get a string indicating how long it will take for the trader to leave - * @returns {string} - */ - getEndString(): string; -} diff --git a/types/lib/supporting/Dependency.d.ts b/types/lib/supporting/Dependency.d.ts deleted file mode 100644 index 55366a939..000000000 --- a/types/lib/supporting/Dependency.d.ts +++ /dev/null @@ -1,13 +0,0 @@ -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 - */ -declare class Dependency { -} diff --git a/types/lib/supporting/ExternalMission.d.ts b/types/lib/supporting/ExternalMission.d.ts deleted file mode 100644 index 94cd4a9b5..000000000 --- a/types/lib/supporting/ExternalMission.d.ts +++ /dev/null @@ -1,52 +0,0 @@ -export = ExternalMission; -/** - * 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 - */ -declare class ExternalMission { -} -declare namespace ExternalMission { - export { ExternalMission }; -} -/** - * External mission data retrieved from https://10o.io/kuvalog.json - */ -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; -}; diff --git a/types/lib/supporting/MarkdownSettings.d.ts b/types/lib/supporting/MarkdownSettings.d.ts deleted file mode 100644 index 245e8d33f..000000000 --- a/types/lib/supporting/MarkdownSettings.d.ts +++ /dev/null @@ -1,18 +0,0 @@ -export = MarkdownSettings; -/** - * 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 - */ -declare class MarkdownSettings { -} diff --git a/types/lib/timeDate.d.ts b/types/lib/timeDate.d.ts deleted file mode 100644 index 02906f2ab..000000000 --- a/types/lib/timeDate.d.ts +++ /dev/null @@ -1,29 +0,0 @@ -/** - * 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} - */ -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} - */ -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} - */ -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} - */ -export function parseDate(d: any): Date; diff --git a/types/lib/translation.d.ts b/types/lib/translation.d.ts deleted file mode 100644 index 5250c2e96..000000000 --- a/types/lib/translation.d.ts +++ /dev/null @@ -1,24 +0,0 @@ -/** - * An object containing functions to convert in-game names to their localizations - */ -export type Translator = any; -export function faction(key: any, dataOverride: any): any; -export function node(key: any, dataOverride: any): any; -export function nodeMissionType(key: any, dataOverride: any): any; -export function nodeEnemy(key: any, dataOverride: any): any; -export function languageString(key: any, dataOverride: any): any; -export function languageDesc(key: any, dataOverride: any): any; -export function missionType(key: any, dataOverride: any): any; -export function conclaveMode(key: any, dataOverride: any): any; -export function conclaveCategory(key: any, dataOverride: any): any; -export function fissureModifier(key: any, dataOverride: any): any; -export function fissureTier(key: any, dataOverride: any): any; -export function syndicate(key: any, dataOverride: any): any; -export function upgrade(key: any, dataOverride: any): any; -export function operation(key: any, dataOverride: any): any; -export function operationSymbol(key: any, dataOverride: any): any; -export function sortieBoss(key: any, dataOverride: any): any; -export function sortieModifier(key: any, dataOverride: any): any; -export function sortieModDesc(key: any, dataOverride: any): any; -export function sortieFaction(key: any, dataOverride: any): any; -export function region(key: any, dataOverride: any): any; diff --git a/types/main.d.ts b/types/main.d.ts deleted file mode 100644 index fe9614b6a..000000000 --- a/types/main.d.ts +++ /dev/null @@ -1,2 +0,0 @@ -declare const _exports: typeof import("./lib/WorldState.js"); -export = _exports;