warframe-worldstate-parser 4.6.1 → 5.0.1

package/dist/ConclaveChallenge-Dp5yOxVu.js

@@ -0,0 +1,80 @@
+import { WorldstateObject } from "./WorldstateObject-BSTYuZwm.js";
+import { conclaveCategory, conclaveChallenge, conclaveMode, fromNow, parseDate, timeDeltaToString } from "warframe-worldstate-data/utilities";
+
+//#region lib/models/ConclaveChallenge.ts
+/**
+* Represents a Conclave challenge
+* @augments {WorldstateObject}
+*/
+var ConclaveChallenge = class extends WorldstateObject {
+	/**
+	* The number of times that the challenge's objective needs to be completed
+	*/
+	amount;
+	/**
+	* The PVP mode that the challenge must be completed in
+	*/
+	mode;
+	/**
+	* The challenge's category (daily, weekly...)
+	*/
+	category;
+	/**
+	* The challenge category unlocalized
+	*/
+	categoryKey;
+	/**
+	* The challenge's description text
+	*/
+	description;
+	/**
+	* Title of the challenge
+	*/
+	title;
+	/**
+	* Standing granted by completing challenge.
+	*/
+	standing;
+	/**
+	* Whether or not this is a daily conclave challenge.
+	*/
+	daily;
+	/**
+	* Whether or not this is the root challenge
+	*/
+	rootChallenge;
+	/**
+	* @param   {object}             data            The challenge 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.expiry = parseDate(data.endDate);
+		this.activation = parseDate(data.startDate);
+		this.amount = data.params[0].v;
+		this.mode = conclaveMode(data.PVPMode, locale);
+		this.category = conclaveCategory(data.Category, locale);
+		this.categoryKey = conclaveCategory(data.Category, "en");
+		this.daily = this.categoryKey.toLowerCase() === "day";
+		this.rootChallenge = this.categoryKey.toLowerCase() === "week_root";
+		const challenge = conclaveChallenge(data.challengeTypeRefID, locale);
+		({title: this.title, description: this.description, standing: this.standing} = challenge);
+	}
+	/**
+	* Whether or not this is expired (at time of object creation)
+	*/
+	get expired() {
+		return fromNow(this.expiry) < 0;
+	}
+	/**
+	* ETA string (at time of object creation)
+	*/
+	get eta() {
+		const timeDelta = fromNow(this.expiry);
+		return timeDeltaToString(timeDelta);
+	}
+};
+
+//#endregion
+export { ConclaveChallenge };

package/dist/ConclaveChallenge-JbcEcL4s.d.ts

@@ -0,0 +1,76 @@
+import { Dependency } from "./Dependency-DkOHLql6.js";
+import { BaseContentObject, WorldstateObject } from "./WorldstateObject-wfRTeGpm.js";
+import { ContentTimestamp } from "warframe-worldstate-data/utilities";
+
+//#region lib/models/ConclaveChallenge.d.ts
+interface RawChallenge extends BaseContentObject {
+  endDate: ContentTimestamp;
+  startDate: ContentTimestamp;
+  params: {
+    n: string;
+    v: number;
+  }[];
+  PVPMode: string;
+  Category: string;
+  challengeTypeRefID: string;
+}
+/**
+ * Represents a Conclave challenge
+ * @augments {WorldstateObject}
+ */
+declare class ConclaveChallenge extends WorldstateObject {
+  /**
+   * The number of times that the challenge's objective needs to be completed
+   */
+  amount: number;
+  /**
+   * The PVP mode that the challenge must be completed in
+   */
+  mode: string;
+  /**
+   * The challenge's category (daily, weekly...)
+   */
+  category: string;
+  /**
+   * The challenge category unlocalized
+   */
+  categoryKey: string;
+  /**
+   * The challenge's description text
+   */
+  description?: string;
+  /**
+   * Title of the challenge
+   */
+  title?: string;
+  /**
+   * Standing granted by completing challenge.
+   */
+  standing?: number;
+  /**
+   * Whether or not this is a daily conclave challenge.
+   */
+  daily: boolean;
+  /**
+   * Whether or not this is the root challenge
+   */
+  rootChallenge: boolean;
+  /**
+   * @param   {object}             data            The challenge data
+   * @param   {object}             deps            The dependencies object
+   * @param   {string}             deps.locale     Locale to use for translations
+   */
+  constructor(data: RawChallenge, {
+    locale
+  }?: Dependency);
+  /**
+   * Whether or not this is expired (at time of object creation)
+   */
+  get expired(): boolean;
+  /**
+   * ETA string (at time of object creation)
+   */
+  get eta(): string;
+}
+//#endregion
+export { ConclaveChallenge, RawChallenge };

package/dist/ConstructionProgress-DfcpaGL5.js

@@ -0,0 +1,25 @@
+import { WorldstateObject } from "./WorldstateObject-BSTYuZwm.js";
+import { createHash } from "node:crypto";
+
+//#region lib/models/ConstructionProgress.ts
+/**
+* Represents enemy construction progress
+* @augments {WorldstateObject}
+*/
+var ConstructionProgress = class extends WorldstateObject {
+	fomorianProgress;
+	razorbackProgress;
+	unknownProgress;
+	/**
+	* @param data The construction data
+	*/
+	constructor(data) {
+		super({ _id: { $oid: createHash("md5").update(JSON.stringify(data), "utf8").digest("hex") } });
+		this.fomorianProgress = (data[0] ?? 0).toFixed(2);
+		this.razorbackProgress = (data[1] ?? 0).toFixed(2);
+		this.unknownProgress = (data[2] ?? 0).toFixed(2);
+	}
+};
+
+//#endregion
+export { ConstructionProgress };

package/dist/ConstructionProgress-FAySTEod.d.ts

@@ -0,0 +1,19 @@
+import { WorldstateObject } from "./WorldstateObject-wfRTeGpm.js";
+
+//#region lib/models/ConstructionProgress.d.ts
+
+/**
+ * Represents enemy construction progress
+ * @augments {WorldstateObject}
+ */
+declare class ConstructionProgress extends WorldstateObject {
+  fomorianProgress: string;
+  razorbackProgress: string;
+  unknownProgress: string;
+  /**
+   * @param data The construction data
+   */
+  constructor(data: number[]);
+}
+//#endregion
+export { ConstructionProgress };

package/dist/DailyDeal-BGqZAp-j.js

@@ -0,0 +1,66 @@
+import { WorldstateObject } from "./WorldstateObject-BSTYuZwm.js";
+import { fromNow, languageString, timeDeltaToString } from "warframe-worldstate-data/utilities";
+
+//#region lib/models/DailyDeal.ts
+/**
+* Represents a daily deal
+*/
+var DailyDeal = class extends WorldstateObject {
+	/**
+	* The item that is being offered in the sale
+	*/
+	item;
+	/**
+	* The uniqueName for the item on sale
+	*/
+	uniqueName;
+	/**
+	* The item's original price
+	*/
+	originalPrice;
+	/**
+	* The item's discounted price
+	*/
+	salePrice;
+	/**
+	* The number of available items on sale
+	*/
+	total;
+	/**
+	* The number of items that have already been sold
+	*/
+	sold;
+	/**
+	* Unique identifier for this deal built from the end time and item
+	*/
+	id;
+	/**
+	* Percent discount
+	*/
+	discount;
+	/**
+	* @param data        The deal data
+	* @param deps        The dependencies object
+	* @param deps.locale Locale to use for translations
+	*/
+	constructor(data, { locale = "en" } = { locale: "en" }) {
+		super(data);
+		this.item = languageString(data.StoreItem, locale);
+		this.uniqueName = data.StoreItem;
+		this.originalPrice = data.OriginalPrice;
+		this.salePrice = data.SalePrice;
+		this.total = data.AmountTotal;
+		this.sold = data.AmountSold;
+		this.id = `${data.StoreItem.split("/").slice(-1)[0]}${this.expiry.getTime()}`;
+		this.discount = data.Discount;
+	}
+	/**
+	* Get a string indicating how much time is left before the deal expires
+	*/
+	get eta() {
+		return timeDeltaToString(fromNow(this.expiry));
+	}
+};
+
+//#endregion
+export { DailyDeal };

package/dist/DailyDeal-Na-EaiFS.d.ts

@@ -0,0 +1,66 @@
+import { Dependency } from "./Dependency-DkOHLql6.js";
+import { WorldstateObject } from "./WorldstateObject-wfRTeGpm.js";
+import { ContentTimestamp } from "warframe-worldstate-data/utilities";
+
+//#region lib/models/DailyDeal.d.ts
+interface RawDailyDeal {
+  StoreItem: string;
+  Expiry: ContentTimestamp;
+  Activation: ContentTimestamp;
+  OriginalPrice: number;
+  SalePrice: number;
+  AmountTotal: number;
+  AmountSold: number;
+  Discount: number;
+}
+/**
+ * Represents a daily deal
+ */
+declare class DailyDeal extends WorldstateObject {
+  /**
+   * The item that is being offered in the sale
+   */
+  item: string;
+  /**
+   * The uniqueName for the item on sale
+   */
+  uniqueName: string;
+  /**
+   * The item's original price
+   */
+  originalPrice: number;
+  /**
+   * The item's discounted price
+   */
+  salePrice: number;
+  /**
+   * The number of available items on sale
+   */
+  total: number;
+  /**
+   * The number of items that have already been sold
+   */
+  sold: number;
+  /**
+   * Unique identifier for this deal built from the end time and item
+   */
+  id: string;
+  /**
+   * Percent discount
+   */
+  discount: number;
+  /**
+   * @param data        The deal data
+   * @param deps        The dependencies object
+   * @param deps.locale Locale to use for translations
+   */
+  constructor(data: RawDailyDeal, {
+    locale
+  }?: Dependency);
+  /**
+   * Get a string indicating how much time is left before the deal expires
+   */
+  get eta(): string;
+}
+//#endregion
+export { DailyDeal, RawDailyDeal };

package/dist/DarkSector-BQ97_8h6.js

@@ -0,0 +1,138 @@
+import { Mission } from "./Mission-ZuSsAYNm.js";
+import { WorldstateObject } from "./WorldstateObject-BSTYuZwm.js";
+import { DarkSectorBattle } from "./DarkSectorBattle-5PyUPhxY.js";
+import { languageString, parseDate } from "warframe-worldstate-data/utilities";
+
+//#region lib/models/DarkSector.ts
+/**
+* Represents a dark sector
+* @augments {WorldstateObject}
+*/
+var DarkSector = class extends WorldstateObject {
+	/**
+	* The dark sector credit tax rate
+	*/
+	creditTaxRate;
+	/**
+	* The dark sector credit tax rate for clan/alliance members
+	*/
+	memberCreditsTaxRate;
+	/**
+	* The dark sector resource tax rate
+	*/
+	itemsTaxRate;
+	/**
+	* The dark sector resource tax rate for clan/alliance members
+	*/
+	memberItemsTaxRate;
+	/**
+	* Whether the dark sector holder is an alliance or not
+	*/
+	isAlliance;
+	/**
+	* The current holder of the dark sector
+	*/
+	defenderName;
+	/**
+	* The remaining health of the current solar rail
+	*/
+	defenderPoolRemaining;
+	/**
+	* The maximum health of the solar rail
+	*/
+	defenderMaxPool;
+	/**
+	* The date and time at which the rail was deployed
+	*/
+	defenderDeployemntActivation;
+	/**
+	* The solar rail type
+	*/
+	railType;
+	/**
+	* The MOTD set by the dark sector holder
+	*/
+	defenderMOTD;
+	/**
+	* The player who deployed the solar rail
+	*/
+	deployerName;
+	/**
+	* The clan of the player who deployed the solar rail
+	*/
+	deployerClan;
+	defenderRailHealReserve;
+	healRate;
+	damagePerMission;
+	/**
+	* The dark sector's mission
+	*/
+	mission;
+	battlePayReserve;
+	/**
+	* The battle pay per mission offered to players
+	* @type {number}
+	*/
+	perMissionBattlePay;
+	/**
+	* The player who set the battle pay
+	* @type {string}
+	*/
+	battlePaySetBy;
+	/**
+	* The clan of the player who set the battle pay
+	* @type {string}
+	*/
+	battlePaySetByClan;
+	/**
+	* The player who changed the tax
+	* @type {string}
+	*/
+	taxChangedBy;
+	/**
+	* The clan of the player who set the tax
+	* @type {string}
+	*/
+	taxChangedByClan;
+	/**
+	* The history of the dark sector
+	* @type {Array.<DarkSectorBattle>}
+	*/
+	history;
+	/**
+	* @param   {object}             data                  The dark sector data
+	* @param   {object}             deps                  The dependencies object
+	* @param   {string}             deps.locale           Locale to use for translations
+	*/
+	constructor(data, { locale = "en" } = { locale: "en" }) {
+		super(data);
+		const deps = { locale };
+		this.creditTaxRate = data.DefenderInfo.CreditsTaxRate;
+		this.memberCreditsTaxRate = data.DefenderInfo.MemberCreditsTax;
+		this.itemsTaxRate = data.DefenderInfo.ItemsTaxRate;
+		this.memberItemsTaxRate = data.DefenderInfo.MemberItemsTaxRate;
+		this.isAlliance = data.DefenderInfo.IsAlliance;
+		this.defenderName = data.DefenderInfo.Name;
+		this.defenderPoolRemaining = Number.parseFloat(data.DefenderInfo.StrengthRemaining);
+		this.defenderMaxPool = Number.parseFloat(data.DefenderInfo.MaxStrength);
+		this.defenderDeployemntActivation = data.DefenderInfo.DeploymentActivationTime ? parseDate(data.DefenderInfo.DeploymentActivationTime) : 0;
+		this.railType = languageString(data.DefenderInfo.RailType, locale);
+		this.defenderMOTD = data.DefenderInfo.MOTD;
+		this.deployerName = data.DefenderInfo.DeployerName;
+		this.deployerClan = data.DefenderInfo.DeployerClan;
+		this.defenderRailHealReserve = data.DefenderInfo.RailHealReserve;
+		this.healRate = Number.parseFloat(data.DefenderInfo.healRate);
+		this.damagePerMission = data.DefenderInfo.DamagePerMission;
+		this.mission = data.DefenderInfo.MissionInfo ? new Mission(data.DefenderInfo.MissionInfo, deps) : void 0;
+		this.battlePayReserve = data.DefenderInfo.BattlePayReserve;
+		this.perMissionBattlePay = data.DefenderInfo.MissionBattlePay;
+		this.battlePaySetBy = data.DefenderInfo.BattlePaySetBy;
+		this.battlePaySetByClan = data.DefenderInfo.BattlePaySetByClan;
+		this.taxChangedBy = data.DefenderInfo.TaxLastChangedBy;
+		this.taxChangedByClan = data.DefenderInfo.TaxLastChangedByClan;
+		this.history = data.History ? data.History.map((b) => new DarkSectorBattle(b)) : [];
+	}
+};
+
+//#endregion
+export { DarkSector };

package/dist/DarkSector-zkCUywz1.d.ts

@@ -0,0 +1,142 @@
+import { Dependency } from "./Dependency-DkOHLql6.js";
+import { Mission, RawMission } from "./Mission-CWE16ouO.js";
+import { BaseContentObject, WorldstateObject } from "./WorldstateObject-wfRTeGpm.js";
+import { DarkSectorBattle, RawDarkSectorBattle } from "./DarkSectorBattle-DY33Bfuq.js";
+import { ContentTimestamp } from "warframe-worldstate-data/utilities";
+
+//#region lib/models/DarkSector.d.ts
+interface DefenderInfo {
+  CreditsTaxRate: number;
+  MemberCreditsTax: number;
+  ItemsTaxRate: number;
+  MemberItemsTaxRate: number;
+  IsAlliance: boolean;
+  Name: string;
+  StrengthRemaining: string;
+  MaxStrength: string;
+  DeploymentActivationTime: ContentTimestamp;
+  RailType: string;
+  MOTD: string;
+  DeployerName: string;
+  DeployerClan: string;
+  RailHealReserve: number;
+  healRate: string;
+  DamagePerMission: number;
+  MissionInfo?: RawMission;
+  BattlePayReserve: number;
+  MissionBattlePay: number;
+  BattlePaySetBy: string;
+  BattlePaySetByClan: string;
+  TaxLastChangedBy: string;
+  TaxLastChangedByClan: string;
+}
+interface RawDarkSector extends BaseContentObject {
+  DefenderInfo: DefenderInfo;
+  History: RawDarkSectorBattle[];
+}
+/**
+ * Represents a dark sector
+ * @augments {WorldstateObject}
+ */
+declare class DarkSector extends WorldstateObject {
+  /**
+   * The dark sector credit tax rate
+   */
+  creditTaxRate: number;
+  /**
+   * The dark sector credit tax rate for clan/alliance members
+   */
+  memberCreditsTaxRate: number;
+  /**
+   * The dark sector resource tax rate
+   */
+  itemsTaxRate: number;
+  /**
+   * The dark sector resource tax rate for clan/alliance members
+   */
+  memberItemsTaxRate: number;
+  /**
+   * Whether the dark sector holder is an alliance or not
+   */
+  isAlliance: boolean;
+  /**
+   * The current holder of the dark sector
+   */
+  defenderName: string;
+  /**
+   * The remaining health of the current solar rail
+   */
+  defenderPoolRemaining: number;
+  /**
+   * The maximum health of the solar rail
+   */
+  defenderMaxPool: number;
+  /**
+   * The date and time at which the rail was deployed
+   */
+  defenderDeployemntActivation: number | Date;
+  /**
+   * The solar rail type
+   */
+  railType: string;
+  /**
+   * The MOTD set by the dark sector holder
+   */
+  defenderMOTD: string;
+  /**
+   * The player who deployed the solar rail
+   */
+  deployerName: string;
+  /**
+   * The clan of the player who deployed the solar rail
+   */
+  deployerClan: string;
+  defenderRailHealReserve: number;
+  healRate: number;
+  damagePerMission: number;
+  /**
+   * The dark sector's mission
+   */
+  mission?: Mission;
+  battlePayReserve: number;
+  /**
+   * 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.<DarkSectorBattle>}
+   */
+  history: DarkSectorBattle[];
+  /**
+   * @param   {object}             data                  The dark sector data
+   * @param   {object}             deps                  The dependencies object
+   * @param   {string}             deps.locale           Locale to use for translations
+   */
+  constructor(data: RawDarkSector, {
+    locale
+  }?: Dependency);
+}
+//#endregion
+export { DarkSector, RawDarkSector };

package/dist/DarkSectorBattle-5PyUPhxY.js

@@ -0,0 +1,53 @@
+import { parseDate } from "warframe-worldstate-data/utilities";
+
+//#region lib/models/DarkSectorBattle.ts
+/**
+* Represents a battle over a dark sector
+*/
+var DarkSectorBattle = class {
+	/**
+	* The defenders of the dark sector
+	*/
+	defender;
+	/**
+	* Whether the defenders are an alliance or not
+	*/
+	defenderIsAlliance;
+	/**
+	* The attackers of the dark sector
+	*/
+	attacker;
+	/**
+	* Whether the attackers are an alliance or not
+	*/
+	attackerIsAlliance;
+	/**
+	* The winner of the battle
+	*/
+	winner;
+	/**
+	* The date and time at which the battle started
+	*/
+	start;
+	/**
+	* The date and time at which the battle ended
+	*/
+	end;
+	/**
+	* @param data The battle data
+	*/
+	constructor(data) {
+		this.defender = data.Def;
+		this.defenderIsAlliance = data.DefAli;
+		this.attacker = data.Att;
+		this.attackerIsAlliance = data.AttAli;
+		const defId = data.DefId.$oid || data.DefId.$id;
+		const winId = data.WinId.$oid || data.WinId.$id;
+		this.winner = defId === winId ? this.defender : this.attacker;
+		this.start = parseDate(data.Start);
+		this.end = parseDate(data.End);
+	}
+};
+
+//#endregion
+export { DarkSectorBattle };