warframe-worldstate-parser 4.6.1 → 5.0.1

package/dist/Alert-BS8PWPP3.d.ts

@@ -0,0 +1,45 @@
+import { Dependency } from "./Dependency-DkOHLql6.js";
+import { Reward } from "./Reward-5VIpHu9A.js";
+import { Mission, RawMission } from "./Mission-CWE16ouO.js";
+import { BaseContentObject, WorldstateObject } from "./WorldstateObject-wfRTeGpm.js";
+
+//#region lib/models/Alert.d.ts
+interface RawAlert extends BaseContentObject {
+  MissionInfo: RawMission;
+  Tag?: string;
+}
+/**
+ * Represents an alert
+ * @augments {WorldstateObject}
+ */
+declare class Alert extends WorldstateObject {
+  /**
+   * The mission that the players have to complete
+   */
+  mission: Mission;
+  /**
+   * A tag that DE occasionally provides, such as `LotusGift`
+   */
+  tag?: string;
+  constructor(data: RawAlert, {
+    locale
+  }?: Dependency);
+  /**
+   * Alert's description
+   */
+  get description(): string;
+  /**
+   * Alert rewards
+   */
+  get reward(): Reward | undefined;
+  /**
+   * How much time is left before the alert expires
+   */
+  get eta(): string;
+  /**
+  * An array containing the types of all of the alert's rewards
+  */
+  get rewardTypes(): string[] | undefined;
+}
+//#endregion
+export { Alert, RawAlert };

package/dist/Alert-DH1kglDU.js

@@ -0,0 +1,52 @@
+import { Mission } from "./Mission-ZuSsAYNm.js";
+import { WorldstateObject } from "./WorldstateObject-BSTYuZwm.js";
+import { fromNow, timeDeltaToString } from "warframe-worldstate-data/utilities";
+
+//#region lib/models/Alert.ts
+/**
+* Represents an alert
+* @augments {WorldstateObject}
+*/
+var Alert = class extends WorldstateObject {
+	/**
+	* The mission that the players have to complete
+	*/
+	mission;
+	/**
+	* A tag that DE occasionally provides, such as `LotusGift`
+	*/
+	tag;
+	constructor(data, { locale = "en" } = { locale: "en" }) {
+		super(data);
+		const deps = { locale };
+		this.mission = new Mission(data.MissionInfo, deps);
+		this.tag = data.Tag || void 0;
+	}
+	/**
+	* Alert's description
+	*/
+	get description() {
+		return this.mission.description;
+	}
+	/**
+	* Alert rewards
+	*/
+	get reward() {
+		return this.mission.reward;
+	}
+	/**
+	* How much time is left before the alert expires
+	*/
+	get eta() {
+		return timeDeltaToString(fromNow(this.expiry));
+	}
+	/**
+	* An array containing the types of all of the alert's rewards
+	*/
+	get rewardTypes() {
+		return this.reward?.getTypes()?.length ? this.reward.getTypes() : ["credits"];
+	}
+};
+
+//#endregion
+export { Alert };

package/dist/Archidemea-C0EMRUKc.js

@@ -0,0 +1,59 @@
+import { createHash } from "node:crypto";
+import { languageDesc, languageString, weeklyReset } from "warframe-worldstate-data/utilities";
+
+//#region lib/models/Archidemea.ts
+var ArchidemeaMission = class {
+	mission;
+	deviation;
+	riskVariables;
+	/**
+	* @param mission   Challenge mission type
+	* @param deviation Mission deviation
+	* @param risks     Mission risks
+	* @param locale    Locale to tranlslate to
+	*/
+	constructor(mission, deviation, risks, locale) {
+		this.mission = mission;
+		this.deviation = {
+			key: deviation,
+			name: languageString(deviation, locale),
+			description: languageDesc(deviation, locale)
+		};
+		this.riskVariables = risks.map((i) => {
+			return {
+				key: i,
+				name: languageString(i, locale),
+				description: languageDesc(i, locale)
+			};
+		});
+	}
+};
+var Archimedea = class {
+	id;
+	activation;
+	expiry;
+	missions;
+	personalModifiers;
+	/**
+	*
+	* @param activation Start timestamp
+	* @param expiry     End timestamp
+	* @param data       Data to parse
+	* @param locale     Locale to translate to
+	*/
+	constructor(data, locale = "en") {
+		({activation: this.activation, expiry: this.expiry} = weeklyReset());
+		this.id = createHash("md5").update(JSON.stringify(data), "utf8").digest("hex");
+		this.missions = data.mt.map((m, i) => new ArchidemeaMission(m, data.mv[i], data.c[i], locale));
+		this.personalModifiers = data.fv.map((i) => {
+			return {
+				key: i,
+				name: languageString(i, locale),
+				description: languageDesc(i, locale)
+			};
+		});
+	}
+};
+
+//#endregion
+export { Archimedea };

package/dist/Archidemea-DOh4trTM.d.ts

@@ -0,0 +1,55 @@
+import { Locale } from "warframe-worldstate-data";
+
+//#region lib/models/Archidemea.d.ts
+
+/**
+ * @deprecated use Archimedea to reference temporal and deep
+ */
+type DeepArchimedea = Archimedea;
+interface RawArchimedea {
+  mt: string[];
+  mv: string[];
+  c: string[][];
+  fv: string[];
+}
+declare class ArchidemeaMission {
+  mission: string;
+  deviation: {
+    key: string;
+    name: string;
+    description: string;
+  };
+  riskVariables: {
+    key: string;
+    name: string;
+    description: string;
+  }[];
+  /**
+   * @param mission   Challenge mission type
+   * @param deviation Mission deviation
+   * @param risks     Mission risks
+   * @param locale    Locale to tranlslate to
+   */
+  constructor(mission: string, deviation: string, risks: string[], locale: Locale);
+}
+declare class Archimedea {
+  id: string;
+  activation: Date;
+  expiry: Date;
+  missions: ArchidemeaMission[];
+  personalModifiers: {
+    key: string;
+    name: string;
+    description: string;
+  }[];
+  /**
+   *
+   * @param activation Start timestamp
+   * @param expiry     End timestamp
+   * @param data       Data to parse
+   * @param locale     Locale to translate to
+   */
+  constructor(data: RawArchimedea, locale?: Locale);
+}
+//#endregion
+export { Archimedea, DeepArchimedea, RawArchimedea };

package/dist/Calendar-CgEkm6e6.d.ts

@@ -0,0 +1,78 @@
+import { BaseContentObject, WorldstateObject } from "./WorldstateObject-wfRTeGpm.js";
+
+//#region lib/models/Calendar.d.ts
+interface RawCalender extends BaseContentObject {
+  Days: {
+    day: number;
+    events: RawDay[];
+  }[];
+  Season: string;
+  YearIteration: number;
+  Version: number;
+  UpgradeAvaliabilityRequirements: string[];
+}
+interface RawDay {
+  type: string;
+  challenge?: string;
+  upgrade?: string;
+  reward?: string;
+  dialogueName?: string;
+  dialogueConvo?: string;
+}
+/**
+ * Event data for a 1999 calendar day
+ */
+declare class DayEvent {
+  type: string;
+  challenge?: {
+    title: string;
+    description: string;
+  };
+  upgrade?: {
+    title: string;
+    description: string;
+  };
+  reward?: string;
+  dialogueName?: string;
+  dialogueConvo?: string;
+  /**
+   * @param event raw event data
+   */
+  constructor(event: RawDay);
+  private eventDescription;
+}
+declare class Calendar extends WorldstateObject {
+  /**
+   * Rewards, Challenges, and Calender events
+   */
+  days: {
+    date: string;
+    events: DayEvent[];
+  }[];
+  /**
+   * Current Calender Season
+   */
+  season: string;
+  /**
+   * Current loop number
+   */
+  yearIteration: number;
+  /**
+   * Version
+   */
+  version: number;
+  /**
+   * Player requirements needed to view this calender
+   */
+  requirements: string[];
+  /**
+   * @param calendar RawCalender data to parse from
+   */
+  constructor(calendar: RawCalender);
+  /**
+   * Converts number of day to a date in 1999 in UTC
+   */
+  private getDate;
+}
+//#endregion
+export { Calendar, DayEvent, RawCalender, RawDay };

package/dist/Calendar-CtzZQXj7.js

@@ -0,0 +1,81 @@
+import { WorldstateObject } from "./WorldstateObject-BSTYuZwm.js";
+import { languageDesc, languageString, translateCalendarEvent, translateSeason } from "warframe-worldstate-data/utilities";
+
+//#region lib/models/Calendar.ts
+/**
+* Event data for a 1999 calendar day
+*/
+var DayEvent = class {
+	type;
+	challenge;
+	upgrade;
+	reward;
+	dialogueName;
+	dialogueConvo;
+	/**
+	* @param event raw event data
+	*/
+	constructor(event) {
+		this.type = translateCalendarEvent(event.type);
+		if (event.challenge) this.challenge = this.eventDescription(event.challenge);
+		if (event.upgrade) this.upgrade = this.eventDescription(event.upgrade);
+		if (event.reward) this.reward = languageString(event.reward);
+		if (event.type === "CET_PLOT") {
+			this.dialogueName = event.dialogueName;
+			this.dialogueConvo = event.dialogueConvo;
+		}
+	}
+	eventDescription(name) {
+		return {
+			title: languageString(name),
+			description: languageDesc(name)
+		};
+	}
+};
+var Calendar = class extends WorldstateObject {
+	/**
+	* Rewards, Challenges, and Calender events
+	*/
+	days;
+	/**
+	* Current Calender Season
+	*/
+	season;
+	/**
+	* Current loop number
+	*/
+	yearIteration;
+	/**
+	* Version
+	*/
+	version;
+	/**
+	* Player requirements needed to view this calender
+	*/
+	requirements;
+	/**
+	* @param calendar RawCalender data to parse from
+	*/
+	constructor(calendar) {
+		super(calendar);
+		this.days = Array.isArray(calendar.Days) ? calendar.Days.filter(Boolean).map((d) => ({
+			date: this.getDate(d.day).toISOString(),
+			events: d.events.map((e) => new DayEvent(e))
+		})) : [];
+		this.season = translateSeason(calendar.Season);
+		this.yearIteration = calendar.YearIteration;
+		this.version = calendar.Version;
+		this.requirements = calendar.UpgradeAvaliabilityRequirements;
+	}
+	/**
+	* Converts number of day to a date in 1999 in UTC
+	*/
+	getDate(day) {
+		const date = new Date(Date.UTC(1999));
+		date.setUTCDate(date.getUTCDate() + day - 1);
+		return date;
+	}
+};
+
+//#endregion
+export { Calendar, DayEvent };

package/dist/CambionCycle-C6NHUjOU.js

@@ -0,0 +1,30 @@
+import { WorldstateObject } from "./WorldstateObject-BSTYuZwm.js";
+import { fromNow } from "warframe-worldstate-data/utilities";
+
+//#region lib/models/CambionCycle.ts
+/**
+* Represents the current Cambion Drift Fass/Vome Cycle
+* @augments {WorldstateObject}
+*/
+var CambionCycle = class extends WorldstateObject {
+	timeLeft;
+	state;
+	/**
+	* @param {CetusCycle} cetusCycle Match data from cetus cycle for data
+	*/
+	constructor(cetusCycle) {
+		super({ _id: { $oid: "cambionCycle0" } });
+		({activation: this.activation, expiry: this.expiry, timeLeft: this.timeLeft} = cetusCycle);
+		this.state = cetusCycle.isDay ? "fass" : "vome";
+		this.id = `cambionCycle${this.expiry.getTime()}`;
+	}
+	/**
+	* Get whether the event has expired
+	*/
+	get expired() {
+		return fromNow(this.expiry) < 0;
+	}
+};
+
+//#endregion
+export { CambionCycle };

package/dist/CambionCycle-uEBpbMim.d.ts

@@ -0,0 +1,23 @@
+import { WorldstateObject } from "./WorldstateObject-wfRTeGpm.js";
+import { CetusCycle } from "./CetusCycle-ooMM7hkg.js";
+
+//#region lib/models/CambionCycle.d.ts
+
+/**
+ * Represents the current Cambion Drift Fass/Vome Cycle
+ * @augments {WorldstateObject}
+ */
+declare class CambionCycle extends WorldstateObject {
+  timeLeft: string;
+  state: string;
+  /**
+   * @param {CetusCycle} cetusCycle Match data from cetus cycle for data
+   */
+  constructor(cetusCycle: CetusCycle);
+  /**
+   * Get whether the event has expired
+   */
+  get expired(): boolean;
+}
+//#endregion
+export { CambionCycle };

package/dist/CetusCycle-DIZdevob.js

@@ -0,0 +1,90 @@
+import { WorldstateObject } from "./WorldstateObject-BSTYuZwm.js";
+import { fromNow, timeDeltaToString } from "warframe-worldstate-data/utilities";
+
+//#region lib/models/CetusCycle.ts
+const nightTime = 3e3;
+const maximums = {
+	day: 6e6,
+	night: 3e6
+};
+/**
+* Represents the current Earth Day/Night Cycle
+* @augments {WorldstateObject}
+*/
+var CetusCycle = class extends WorldstateObject {
+	/**
+	* The end of the Ostron bounties timer (marks the end of night)
+	*/
+	#bountiesEndDate;
+	/**
+	* The current cetus cycle, for calculating the other fields
+	*/
+	#ec;
+	/**
+	* Whether it's daytime
+	*/
+	isDay;
+	/**
+	* Current cycle state. One of `day`, `night`
+	*/
+	state;
+	/**
+	* Time remaining string
+	*/
+	timeLeft;
+	/**
+	* Whether this is for Cetus Cycle
+	*/
+	isCetus;
+	/**
+	* @param bountiesEndDate The end date for Ostron bounties
+	*/
+	constructor(bountiesEndDate) {
+		super({ _id: { $oid: "cetusCycle0" } });
+		this.#bountiesEndDate = bountiesEndDate;
+		this.#ec = this.getCurrentCetusCycle();
+		this.expiry = this.#ec.expiry;
+		this.activation = new Date(this.#ec.start);
+		this.isDay = this.#ec.dayTime;
+		this.state = this.#ec.state;
+		this.timeLeft = this.#ec.timeLeft;
+		this.isCetus = true;
+		this.id = `cetusCycle${this.expiry.getTime()}`;
+	}
+	/**
+	* Whether or not the event has expired
+	*/
+	get expired() {
+		return fromNow(this.expiry) < 0;
+	}
+	/**
+	* Short summary of the current state
+	*/
+	get shortString() {
+		return `${this.timeLeft.replace(/\s\d*s/gi, "")} to ${this.isDay ? "Night" : "Day"}`;
+	}
+	getCurrentCetusCycle() {
+		const now = Date.now();
+		const bountiesClone = this.#bountiesEndDate;
+		bountiesClone.setSeconds(0);
+		let millisLeft = fromNow(bountiesClone);
+		const secondsToNightEnd = Number((millisLeft / 1e3).toFixed(0));
+		const dayTime = secondsToNightEnd > nightTime;
+		const secondsRemainingInCycle = dayTime ? secondsToNightEnd - nightTime : secondsToNightEnd;
+		millisLeft = secondsRemainingInCycle * 1e3;
+		const minutesCoef = 1e3 * 60;
+		const expiry = new Date(Math.round((now + millisLeft) / minutesCoef) * minutesCoef);
+		const state = dayTime ? "day" : "night";
+		return {
+			dayTime,
+			timeLeft: timeDeltaToString(millisLeft),
+			expiry,
+			expiresIn: millisLeft,
+			state,
+			start: expiry.getTime() - maximums[state]
+		};
+	}
+};
+
+//#endregion
+export { CetusCycle };

package/dist/CetusCycle-ooMM7hkg.d.ts

@@ -0,0 +1,49 @@
+import { WorldstateObject } from "./WorldstateObject-wfRTeGpm.js";
+
+//#region lib/models/CetusCycle.d.ts
+interface CurrentCetusCycle {
+  dayTime: boolean;
+  timeLeft: string;
+  expiry: Date;
+  expiresIn: number;
+  state: string;
+  start: number;
+}
+/**
+ * Represents the current Earth Day/Night Cycle
+ * @augments {WorldstateObject}
+ */
+declare class CetusCycle extends WorldstateObject {
+  #private;
+  /**
+   * Whether it's daytime
+   */
+  isDay: boolean;
+  /**
+   * Current cycle state. One of `day`, `night`
+   */
+  state: string;
+  /**
+   * Time remaining string
+   */
+  timeLeft: string;
+  /**
+   * Whether this is for Cetus Cycle
+   */
+  isCetus: boolean;
+  /**
+   * @param bountiesEndDate The end date for Ostron bounties
+   */
+  constructor(bountiesEndDate: Date);
+  /**
+   * Whether or not the event has expired
+   */
+  get expired(): boolean;
+  /**
+   * Short summary of the current state
+   */
+  get shortString(): string;
+  private getCurrentCetusCycle;
+}
+//#endregion
+export { CetusCycle, CurrentCetusCycle };

package/dist/ChallengeInstance-Bi2zg4q-.d.ts

@@ -0,0 +1,53 @@
+import { Dependency } from "./Dependency-DkOHLql6.js";
+
+//#region lib/models/ChallengeInstance.d.ts
+interface RawChallengeInstance {
+  Type: string;
+  MinimumEnemyLevel: string;
+  RequiredCount: string;
+  ProgressIndicatorFreq: string;
+  DamageType?: string;
+  VictimType?: string[];
+  Script?: {
+    _faction: string;
+  };
+}
+/**
+ * Describes a world challenge instance
+ */
+declare class ChallengeInstance {
+  /**
+   * Type of challenge
+   */
+  type: string;
+  /**
+   * Minimum enemy level to fulfill challenge
+   */
+  minEnemyLevel: number;
+  /**
+   * Required number of units to complete challenge
+   */
+  requiredAmount: number;
+  /**
+   * Waypoint for amount of units between progression updates
+   */
+  progressAmount: number;
+  /**
+   * Required damage type
+   */
+  damageType?: string;
+  /**
+   * Target to fulfill challenge
+   */
+  target?: string;
+  /**
+   * @param   data        The challenge instance data
+   * @param   deps        The dependencies object
+   * @param   deps.locale Locale to use for translations
+   */
+  constructor(data: RawChallengeInstance, {
+    locale
+  }?: Dependency);
+}
+//#endregion
+export { ChallengeInstance, RawChallengeInstance };

package/dist/ChallengeInstance-DHwTTwMH.js

@@ -0,0 +1,48 @@
+import { languageString } from "warframe-worldstate-data/utilities";
+
+//#region lib/models/ChallengeInstance.ts
+/**
+* Describes a world challenge instance
+*/
+var ChallengeInstance = class {
+	/**
+	* Type of challenge
+	*/
+	type;
+	/**
+	* Minimum enemy level to fulfill challenge
+	*/
+	minEnemyLevel;
+	/**
+	* Required number of units to complete challenge
+	*/
+	requiredAmount;
+	/**
+	* Waypoint for amount of units between progression updates
+	*/
+	progressAmount;
+	/**
+	* Required damage type
+	*/
+	damageType;
+	/**
+	* Target to fulfill challenge
+	*/
+	target;
+	/**
+	* @param   data        The challenge instance data
+	* @param   deps        The dependencies object
+	* @param   deps.locale Locale to use for translations
+	*/
+	constructor(data, { locale = "en" } = { locale: "en" }) {
+		this.type = languageString(data.Type, locale);
+		this.minEnemyLevel = Number(data.MinimumEnemyLevel);
+		this.requiredAmount = Number(data.RequiredCount);
+		this.progressAmount = Number(data.ProgressIndicatorFreq);
+		this.damageType = data.DamageType ? languageString(data.DamageType, locale) : void 0;
+		this.target = data.VictimType?.[0] ? languageString(data.VictimType[0], locale) : data.Script?._faction;
+	}
+};
+
+//#endregion
+export { ChallengeInstance };