warframe-worldstate-parser 4.6.2 → 5.0.1

package/dist/FlashSale-PDG4uQq4.d.ts

@@ -0,0 +1,71 @@
+import { Dependency } from "./Dependency-DkOHLql6.js";
+import { BaseContentObject, WorldstateObject } from "./WorldstateObject-wfRTeGpm.js";
+import { ContentTimestamp } from "warframe-worldstate-data/utilities";
+
+//#region lib/models/FlashSale.d.ts
+interface RawFlashSale extends BaseContentObject {
+  TypeName: string;
+  EndDate: ContentTimestamp;
+  StartDate: ContentTimestamp;
+  Discount: number;
+  RegularOverride: number;
+  PremiumOverride: number;
+  ShowInMarket: boolean;
+  Featured: boolean;
+  Popular: boolean;
+}
+/**
+ * Represents a flash sale
+ */
+declare class FlashSale extends WorldstateObject {
+  /**
+   * The item being offered in the flash sale
+   */
+  item: string;
+  /**
+   * The item's discount percentage
+   */
+  discount: number;
+  /**
+   * The item's discounted credit price
+   */
+  regularOverride: number;
+  /**
+   * The item's discounted platinum price
+   */
+  premiumOverride: number;
+  /**
+   * Whether this item is show in the in-game market
+   */
+  isShownInMarket: boolean;
+  /**
+   * Whether this item is featured in the in-game market
+   */
+  isFeatured: boolean;
+  /**
+   * Whether this item is marked as popular in the in-game market
+   */
+  isPopular: boolean;
+  /**
+   * Unique identifier for this sale built from the end time and reward
+   */
+  id: string;
+  /**
+   * @param   {object}             data            The flash sale data
+   * @param   {Dependency}             deps            The dependencies object
+   * @param   {string}             deps.locale     Locale to use for translations
+   */
+  constructor(data: RawFlashSale, {
+    locale
+  }?: Dependency);
+  /**
+   * ETA string (at time of object creation)
+   */
+  get eta(): string;
+  /**
+   * Whether or not this is expired (at time of object creation)
+   */
+  get expired(): boolean;
+}
+//#endregion
+export { FlashSale, RawFlashSale };

package/dist/GlobalUpgrade-BRQXf3JM.d.ts

@@ -0,0 +1,55 @@
+import { Dependency } from "./Dependency-DkOHLql6.js";
+import { BaseContentObject, WorldstateObject } from "./WorldstateObject-wfRTeGpm.js";
+import { ContentTimestamp } from "warframe-worldstate-data/utilities";
+
+//#region lib/models/GlobalUpgrade.d.ts
+interface RawGlobalUpgrade extends BaseContentObject {
+  Activation: ContentTimestamp;
+  Expiry: ContentTimestamp;
+  UpgradeType: string;
+  OperationType: string;
+  Value: number;
+}
+/**
+ * Represents an upgrade that applies to all players
+ */
+declare class GlobalUpgrade extends WorldstateObject {
+  /**
+   * The effect of the upgrade
+   */
+  upgrade: string;
+  /**
+   * The operation type
+   */
+  operation: string;
+  /**
+   * Symbol for operation
+   */
+  operationSymbol: string;
+  /**
+   * The operation value
+   */
+  upgradeOperationValue: number;
+  /**
+   * @param   {object}             data            The global upgrade data
+   * @param   {object}             deps            The dependencies object
+   * @param   {string}             deps.locale     Locale to use for translations
+   */
+  constructor(data: RawGlobalUpgrade, {
+    locale
+  }?: Dependency);
+  /**
+   * Plaintext description of upgrade
+   */
+  get desc(): string;
+  /**
+   * ETA string (at time of object creation)
+   */
+  get eta(): string;
+  /**
+   * Whether or not this is expired (at time of object creation)
+   */
+  get expired(): boolean;
+}
+//#endregion
+export { GlobalUpgrade, RawGlobalUpgrade };

package/dist/GlobalUpgrade-B_TKK1m_.js

@@ -0,0 +1,58 @@
+import { WorldstateObject } from "./WorldstateObject-BSTYuZwm.js";
+import { fromNow, operation, operationSymbol, timeDeltaToString, upgrade } from "warframe-worldstate-data/utilities";
+
+//#region lib/models/GlobalUpgrade.ts
+/**
+* Represents an upgrade that applies to all players
+*/
+var GlobalUpgrade = class extends WorldstateObject {
+	/**
+	* The effect of the upgrade
+	*/
+	upgrade;
+	/**
+	* The operation type
+	*/
+	operation;
+	/**
+	* Symbol for operation
+	*/
+	operationSymbol;
+	/**
+	* The operation value
+	*/
+	upgradeOperationValue;
+	/**
+	* @param   {object}             data            The global upgrade data
+	* @param   {object}             deps            The dependencies object
+	* @param   {string}             deps.locale     Locale to use for translations
+	*/
+	constructor(data, { locale = "en" } = { locale: "en" }) {
+		super(data);
+		this.upgrade = upgrade(data.UpgradeType, locale);
+		this.operation = operation(data.OperationType, locale);
+		this.operationSymbol = operationSymbol(data.OperationType, locale);
+		this.upgradeOperationValue = data.Value;
+	}
+	/**
+	* Plaintext description of upgrade
+	*/
+	get desc() {
+		return `${this.upgradeOperationValue}${this.operationSymbol} ${this.upgrade} for ${this.eta}`;
+	}
+	/**
+	* ETA string (at time of object creation)
+	*/
+	get eta() {
+		return timeDeltaToString(fromNow(this.expiry));
+	}
+	/**
+	* Whether or not this is expired (at time of object creation)
+	*/
+	get expired() {
+		return fromNow(this.expiry) < 0;
+	}
+};
+
+//#endregion
+export { GlobalUpgrade };

package/dist/ImgCdn-BnbJ9K-0.js

@@ -0,0 +1,7 @@
+//#region lib/supporting/ImgCdn.ts
+const cdn = (path) => `https://cdn.warframestat.us/genesis/${path}`;
+const wfCdn = (path) => `https://cdn.warframestat.us/img/${path}`;
+const deProxy = (url) => url.replace("https://forums.warframe.com/applications/core/interface/imageproxy/imageproxy.php?img=", "").replace(/&key=\w*/gi, "").replace("http://", "https://");
+
+//#endregion
+export { cdn, deProxy, wfCdn };

package/dist/Invasion-BMic1K12.js

@@ -0,0 +1,110 @@
+import { Reward } from "./Reward-OauJ45jJ.js";
+import { WorldstateObject } from "./WorldstateObject-BSTYuZwm.js";
+import { faction, languageString, node, timeDeltaToString, toNow } from "warframe-worldstate-data/utilities";
+
+//#region lib/models/Invasion.ts
+/**
+* Represents an invasion
+*/
+var Invasion = class extends WorldstateObject {
+	/**
+	* The node where the invasion is taking place
+	*/
+	node;
+	/**
+	* The node key where the invasion is taking place
+	*/
+	nodeKey;
+	/**
+	* The invasion's description
+	*/
+	desc;
+	/**
+	* Invasion attacker
+	*/
+	attacker;
+	/**
+	* Invasion defender
+	*/
+	defender;
+	/**
+	* Whether this invasion is against the infestation
+	*/
+	vsInfestation;
+	/**
+	* The signed count of completed runs. Supporting the attackers makes the count go up,
+	* supporting the defenders makes it go down
+	*/
+	count;
+	/**
+	* The number of runs that one side needs to win
+	*/
+	requiredRuns;
+	/**
+	* The invasion's completion percentage. Defenders win if it gets to 0
+	* Grineer vs. Corpus invasions start at 50, Infested invasions start at 100
+	*/
+	completion;
+	/**
+	* Whether the invasion has finished
+	*/
+	completed;
+	/**
+	* @param   {object}             data            The invasion data
+	* @param   {Dependency}         deps            The dependencies object
+	* @param   {string}             deps.locale     Locale to use for translations
+	*/
+	constructor(data, { locale = "en" } = { locale: "en" }) {
+		super(data);
+		const opts = { locale };
+		this.node = node(data.Node, locale);
+		this.nodeKey = node(data.Node);
+		this.desc = languageString(data.LocTag, locale);
+		this.attacker = {
+			reward: Object.keys(data?.AttackerReward || {})?.length ? new Reward(data.AttackerReward, opts) : void 0,
+			faction: faction(data.DefenderMissionInfo.faction, locale),
+			factionKey: faction(data.DefenderMissionInfo.faction, "en")
+		};
+		this.defender = {
+			reward: Object.keys(data?.DefenderReward || {})?.length ? new Reward(data.DefenderReward, opts) : void 0,
+			faction: faction(data.AttackerMissionInfo.faction, locale),
+			factionKey: faction(data.AttackerMissionInfo.faction, "en")
+		};
+		this.vsInfestation = /infest/i.test(data.DefenderMissionInfo.faction);
+		this.count = data.Count;
+		this.requiredRuns = data.Goal;
+		this.completion = (1 + data.Count / data.Goal) * (this.vsInfestation ? 100 : 50);
+		this.completed = data.Completed;
+	}
+	/**
+	* Whether or not the attackers are winning.
+	* This is always false when the infestation is attacking
+	*/
+	get isAttackerWinning() {
+		return this.count > 0;
+	}
+	/**
+	* ETA string (at time of object creation)
+	*/
+	get eta() {
+		return timeDeltaToString(this.getRemainingTime());
+	}
+	/**
+	* An array containing the types of all of the invasions's rewards
+	*/
+	get rewardTypes() {
+		return [...this.attacker.reward?.getTypes() ?? [], ...this.defender.reward?.getTypes() ?? []];
+	}
+	/**
+	* Get an estimation of how much time is left before the invasion ends in milliseconds
+	*/
+	getRemainingTime() {
+		const completedRuns = Math.abs(this.count);
+		const elapsedMillis = toNow(this.activation);
+		const remainingRuns = this.requiredRuns - completedRuns;
+		return remainingRuns * (elapsedMillis / completedRuns);
+	}
+};
+
+//#endregion
+export { Invasion };

package/dist/Invasion-BskF60zh.d.ts

@@ -0,0 +1,113 @@
+import { Dependency } from "./Dependency-DkOHLql6.js";
+import { RawReward, Reward } from "./Reward-5VIpHu9A.js";
+import { BaseContentObject, WorldstateObject } from "./WorldstateObject-wfRTeGpm.js";
+import { ContentTimestamp } from "warframe-worldstate-data/utilities";
+
+//#region lib/models/Invasion.d.ts
+interface RawInvasion extends BaseContentObject {
+  Node: string;
+  LocTag: string;
+  DefenderMissionInfo: {
+    faction: string;
+  };
+  AttackerReward: RawReward;
+  DefenderReward: RawReward;
+  AttackerMissionInfo: {
+    faction: string;
+  };
+  Activation: ContentTimestamp;
+  Count: number;
+  Goal: number;
+  Completed: boolean;
+}
+/**
+ * An invasion participant
+ */
+interface InvasionParticipant {
+  /**
+   * Reward for supporting this participant in the invasion
+   */
+  reward?: Reward;
+  /**
+   * Faction of this participant (localized)
+   */
+  faction: string;
+  /**
+   *  Faction of this participant (always English)
+   */
+  factionKey: string;
+}
+/**
+ * Represents an invasion
+ */
+declare class Invasion extends WorldstateObject {
+  /**
+   * The node where the invasion is taking place
+   */
+  node: string;
+  /**
+   * The node key where the invasion is taking place
+   */
+  nodeKey: string;
+  /**
+   * The invasion's description
+   */
+  desc: string;
+  /**
+   * Invasion attacker
+   */
+  attacker: InvasionParticipant;
+  /**
+   * Invasion defender
+   */
+  defender: InvasionParticipant;
+  /**
+   * Whether this invasion is against the infestation
+   */
+  vsInfestation: boolean;
+  /**
+   * The signed count of completed runs. Supporting the attackers makes the count go up,
+   * supporting the defenders makes it go down
+   */
+  count: number;
+  /**
+   * The number of runs that one side needs to win
+   */
+  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
+   */
+  completion: number;
+  /**
+   * Whether the invasion has finished
+   */
+  completed: boolean;
+  /**
+   * @param   {object}             data            The invasion data
+   * @param   {Dependency}         deps            The dependencies object
+   * @param   {string}             deps.locale     Locale to use for translations
+   */
+  constructor(data: RawInvasion, {
+    locale
+  }?: Dependency);
+  /**
+   * Whether or not the attackers are winning.
+   * This is always false when the infestation is attacking
+   */
+  get isAttackerWinning(): boolean;
+  /**
+   * ETA string (at time of object creation)
+   */
+  get eta(): string;
+  /**
+   * An array containing the types of all of the invasions's rewards
+   */
+  get rewardTypes(): string[];
+  /**
+   * Get an estimation of how much time is left before the invasion ends in milliseconds
+   */
+  private getRemainingTime;
+}
+//#endregion
+export { Invasion, RawInvasion };

package/dist/Kinepage-CRRKVulq.d.ts

@@ -0,0 +1,22 @@
+//#region lib/models/Kinepage.d.ts
+declare class Kinepage {
+  /**
+   * Timestamp of when the message appeared on
+   */
+  timestamp: Date;
+  /**
+   * The message itself
+   */
+  message: string;
+  /**
+   * Message translations
+   */
+  translations: {
+    [k: string]: unknown;
+  };
+  constructor(data: {
+    [k: string]: string | number;
+  }, locale?: string);
+}
+//#endregion
+export { Kinepage };

package/dist/Kinepage-iWFwTZtr.js

@@ -0,0 +1,24 @@
+//#region lib/models/Kinepage.ts
+var Kinepage = class {
+	/**
+	* Timestamp of when the message appeared on
+	*/
+	timestamp;
+	/**
+	* The message itself
+	*/
+	message;
+	/**
+	* Message translations
+	*/
+	translations;
+	constructor(data, locale = "en") {
+		this.timestamp = /* @__PURE__ */ new Date(Number(data.ts) * 1e3);
+		const translations = Object.fromEntries(Object.entries(data).filter(([key]) => key !== "ts"));
+		this.message = String(translations[locale] || data.en);
+		this.translations = Object.fromEntries(Object.entries(translations).filter(([key]) => key !== locale));
+	}
+};
+
+//#endregion
+export { Kinepage };

package/dist/Kuva-DqkxvPUg.js

@@ -0,0 +1,85 @@
+import { createHash } from "node:crypto";
+import { node, nodeMissionType } from "warframe-worldstate-data/utilities";
+
+//#region lib/models/Kuva.ts
+const HOURS_2 = 72e5;
+/**
+* Truncate time for a semlar-provided mission
+* @param mission parsed mission with re-aligned field names
+*/
+const truncateTime = (mission) => {
+	mission.expiry.setHours(mission.activation.getHours() + 1);
+	mission.expiry.setMinutes(4);
+	mission.expiry.setSeconds(0);
+	mission.expiry.setMilliseconds(0);
+	mission.activation.setMinutes(mission.activation.getMinutes() + 5.1);
+};
+/**
+* Scrub unnecessary details from the mission
+* @param mission parsed mission with re-aligned field names
+*/
+const scrub = (mission) => {
+	delete mission.solnode;
+	delete mission.name;
+	delete mission.node_type;
+	delete mission.tile;
+	delete mission.planet;
+};
+const hash = (str) => createHash("md5").update(str, "utf8").digest("hex");
+/**
+* Parse kuva & arbitration data
+* @param data   Data to split for kuva/arbitration
+* @param locale locale to translate
+* @returns Split parsed data
+*/
+const parse = (data, locale) => {
+	const parsed = {
+		kuva: [],
+		arbitration: {}
+	};
+	const now = /* @__PURE__ */ new Date();
+	if (!data) return void 0;
+	data?.forEach?.((mission) => {
+		const p = {
+			id: "",
+			activation: new Date(mission.start),
+			expiry: new Date(mission.end),
+			...mission.solnodedata,
+			node: node(mission.solnode, locale),
+			nodeKey: node(mission.solnode, "en"),
+			type: nodeMissionType(mission.solnode, locale),
+			typeKey: nodeMissionType(mission.solnode, "en"),
+			expired: false
+		};
+		truncateTime(p);
+		p.id = hash(JSON.stringify(p));
+		p.expired = Date.now() - p.expiry.getTime() < 0;
+		if (p.activation < now && now < p.expiry && new Date(p.activation.getTime() + HOURS_2) > now && new Date(p.expiry.getTime() - HOURS_2) < now) {
+			if (mission.missiontype === "EliteAlertMission") parsed.arbitration = p;
+			if (mission.missiontype.startsWith("KuvaMission")) parsed.kuva.push(p);
+		}
+		scrub(p);
+	});
+	parsed.kuva = Array.from(new Set(parsed.kuva));
+	return parsed;
+};
+/**
+* Stores and parses kuva data from https://10o.io/kuvalog.json
+* @property {ExternalMission[]} kuva currently active kuva missions
+* @property {ExternalMission} arbitration current arbitration
+*/
+var Kuva = class {
+	kuva;
+	arbitration;
+	constructor({ kuvaData, locale, logger }) {
+		if (!kuvaData) logger?.debug("No defined kuva data, skipping data");
+		else {
+			const parsed = parse(kuvaData, locale);
+			this.kuva = parsed?.kuva;
+			this.arbitration = parsed?.arbitration;
+		}
+	}
+};
+
+//#endregion
+export { Kuva };

package/dist/KuvaLogEntry-d5fskHaK.d.ts

@@ -0,0 +1,21 @@
+//#region lib/supporting/KuvaLogEntry.d.ts
+interface KuvaLogEntry {
+  start: string;
+  end: string;
+  missiontype: string;
+  solnode: string;
+  solnodedata: SolnodeData;
+  realtime: string;
+}
+interface SolnodeData {
+  name: string;
+  tile: string;
+  planet: string;
+  enemy: string;
+  type: string;
+  node_type: string;
+  archwing: boolean;
+  sharkwing: boolean;
+}
+//#endregion
+export { KuvaLogEntry, SolnodeData };

package/dist/MidrathCycle-BfQtfG4p.d.ts

@@ -0,0 +1,25 @@
+import { WorldstateObject } from "./WorldstateObject-wfRTeGpm.js";
+
+//#region lib/models/MidrathCycle.d.ts
+declare class MidrathCycle extends WorldstateObject {
+  #private;
+  /**
+   * Whether it's day or not
+   */
+  isDay: boolean;
+  /**
+   * The current state
+   */
+  state: string;
+  constructor();
+  /**
+   * Get whether or not the event has expired
+   */
+  get expired(): boolean;
+  /**
+   * The amount of time left as a string
+   */
+  get timeLeft(): string;
+}
+//#endregion
+export { MidrathCycle };

package/dist/MidrathCycle-DDfT7zVx.js

@@ -0,0 +1,69 @@
+import { WorldstateObject } from "./WorldstateObject-BSTYuZwm.js";
+import { createHash } from "node:crypto";
+import { fromNow, timeDeltaToString } from "warframe-worldstate-data/utilities";
+
+//#region lib/models/MidrathCycle.ts
+/**
+* Get the current Midrath cycle time
+*/
+function getCurrentMidrathCycle() {
+	const dayDuration = 1920 * 1e3;
+	const nightDuration = 960 * 1e3;
+	const totalDuration = dayDuration + nightDuration;
+	const refPoint = Date.parse("2025-08-07T16:05:29Z");
+	const now = Date.now();
+	const elapsedInCycle = (now - refPoint) % totalDuration;
+	const isDay = elapsedInCycle < dayDuration;
+	let phase = {
+		name: "night",
+		remaining: totalDuration - elapsedInCycle,
+		duration: nightDuration
+	};
+	if (isDay) phase = {
+		name: "day",
+		remaining: dayDuration - elapsedInCycle,
+		duration: dayDuration
+	};
+	const activation = new Date(now - (phase.duration - phase.remaining));
+	const expiry = new Date(activation.getTime() + phase.duration);
+	return {
+		activation,
+		expiry,
+		state: phase.name,
+		isDay
+	};
+}
+var MidrathCycle = class extends WorldstateObject {
+	#cycle = getCurrentMidrathCycle();
+	/**
+	* Whether it's day or not
+	*/
+	isDay;
+	/**
+	* The current state
+	*/
+	state;
+	constructor() {
+		super({ _id: { $oid: "midrathCycle0" } });
+		this.activation = this.#cycle.activation;
+		this.expiry = this.#cycle.expiry;
+		this.isDay = this.#cycle.isDay;
+		this.state = this.#cycle.state;
+		this.id = createHash("md5").update(JSON.stringify(this.expiry), "utf8").digest("hex");
+	}
+	/**
+	* Get whether or not the event has expired
+	*/
+	get expired() {
+		return fromNow(this.expiry) < 0;
+	}
+	/**
+	* The amount of time left as a string
+	*/
+	get timeLeft() {
+		return timeDeltaToString(fromNow(this.expiry));
+	}
+};
+
+//#endregion
+export { MidrathCycle };