warframe-worldstate-parser 5.2.15 → 5.2.17

package/dist/lib/models/WorldEvent.d.mts

@@ -1,18 +1,205 @@
-import "../../Dependency-CNqXngHD.mjs";
-import { a as WorldEvent, i as RawWorldEvent, n as InterimStep, r as ProgressStep, t as InterimRewardMessage } from "../../index-Bgx8kIDy.mjs";
-import "../../WorldStateObject-C1HEDkH7.mjs";
-import "../../Calendar-CRM0XhAy.mjs";
-import "../../CetusCycle-DQ4n05vO.mjs";
-import "../../CambionCycle-OI3v1knd.mjs";
-import "../../ConstructionProgress-DG2KzS0X.mjs";
-import "../../DarkSectorBattle-CiSe3kFm.mjs";
-import "../../EarthCycle-CxtijnVV.mjs";
-import "../../MidrathCycle-E0gMF3AR.mjs";
-import "../../News-DxEm-q6V.mjs";
-import "../../NightwaveChallenge-CG3uychc.mjs";
-import "../../Nightwave-CPqMSqGK.mjs";
-import "../../PersistentEnemy-DnnnreSz.mjs";
-import "../../SteelPathOffering-CQkoKi5T.mjs";
-import "../../VallisCycle-6DCaWFoR.mjs";
-import "../../ZarimanCycle-BrSLIWhD.mjs";
+import { Dependency } from "../supporting/Dependency.mjs";
+import "../supporting/index.mjs";
+import { RawReward, Reward } from "./Reward.mjs";
+import { BaseContentObject, Identifier, WorldStateObject } from "./WorldStateObject.mjs";
+import { RawSyndicateJob, SyndicateJob } from "./SyndicateJob.mjs";
+import { ContentTimestamp } from "warframe-worldstate-data/utilities";
+
+//#region lib/models/WorldEvent.d.ts
+/**
+ * Interim step for an event reward system.
+ */
+interface InterimStep {
+  goal: number;
+  reward: Reward | undefined;
+  winnerCount: number;
+  message: object;
+}
+/**
+ * Progress for one of multiple stages
+ */
+interface ProgressStep {
+  type: string;
+  progressAmt: number;
+}
+interface InterimRewardMessage {
+  sender: string;
+  subject: string;
+  message: string;
+  senderIcon: string;
+  attachments: string;
+}
+interface RawWorldEvent extends BaseContentObject {
+  Goal: number;
+  Count?: number;
+  GoalInterim?: string;
+  GoalInterim2?: string;
+  Faction?: string;
+  Desc: string;
+  ToolTip?: string;
+  Node?: string;
+  ConcurrentNodes?: string[] | undefined;
+  VictimNode?: string;
+  Fomorian?: string;
+  ScoreLocTag?: string;
+  HealthPct?: number;
+  JobPreviousVersion?: Identifier;
+  Reward?: RawReward;
+  InterimRewards?: RawReward[];
+  InterimRewardMessages?: InterimRewardMessage[];
+  InterimGoals: number[];
+  _interimWinnerCounts?: number[];
+  IsMultiProgress?: boolean;
+  Types?: string[];
+  MultiProgress?: string[];
+  ShowTotalAtEOM?: boolean;
+  Personal: boolean;
+  Community?: boolean;
+  RegionDrops?: string[];
+  ArchwingDrops?: string[];
+  Metadata?: string;
+  CompletionBonus?: number[];
+  ScoreVar: string;
+  AltExpiry?: ContentTimestamp;
+  AltActivation?: ContentTimestamp;
+  NextAltExpiry?: ContentTimestamp;
+  NextAltActivation?: ContentTimestamp;
+  JobAffiliationTag?: string;
+  Tag: string;
+  Jobs?: RawSyndicateJob[];
+  PreviousJobs?: RawSyndicateJob[];
+}
+/**
+ * Represents an in-game special event
+ * @augments {WorldStateObject}
+ */
+declare class WorldEvent extends WorldStateObject {
+  jobs: SyndicateJob[];
+  previousJobs: SyndicateJob[];
+  /**
+   * The event's main score goal
+   */
+  maximumScore: number;
+  /**
+   * The current score on the event
+   */
+  currentScore: number;
+  /**
+   * The first intermediate score goal
+   */
+  smallInterval: number;
+  /**
+   * The second intermediate score goal
+   */
+  largeInterval: number;
+  /**
+   * The faction that the players must fight in the event
+   */
+  faction: string | undefined;
+  /**
+   * The description of the event
+   */
+  description: string;
+  /**
+   * Tooltip for the event
+   */
+  tooltip: string | undefined;
+  /**
+   * The node where the event takes place
+   */
+  node: string | undefined;
+  /**
+   * The other nodes where the event takes place
+   */
+  concurrentNodes: string[];
+  /**
+   * The victim node
+   */
+  victimNode: string | undefined;
+  /**
+   * The score description
+   */
+  scoreLocTag: string | undefined;
+  /**
+   * The event's rewards
+   */
+  rewards: Reward[];
+  /**
+   * Health remaining for the target
+   */
+  health: number | undefined;
+  /**
+   * Previous job id
+   */
+  previousId: string | undefined;
+  /**
+   * Array of steps
+   */
+  interimSteps: InterimStep[];
+  /**
+   * Progress Steps, if any are present
+   */
+  progressSteps: ProgressStep[];
+  /**
+   * Total of all MultiProgress
+   */
+  progressTotal?: number;
+  /**
+   * Whether to show the total score at the end of the mission
+   */
+  showTotalAtEndOfMission: boolean;
+  /**
+   * Whether the event is personal
+   */
+  isPersonal: boolean;
+  /**
+   * Whether the event is community
+   */
+  isCommunity: boolean;
+  regionDrops: string[];
+  /**
+   * Archwing Drops in effect while this event is active
+   */
+  archwingDrops: string[];
+  /**
+   * Metadata provided by DE
+   */
+  metadata: object;
+  /**
+   * Bonuses given for completion
+   */
+  completionBonuses: number[];
+  scoreVar: string;
+  altExpiry: Date;
+  altActivation: Date;
+  nextAlt: {
+    expiry: Date;
+    activation: Date;
+  };
+  affiliatedWith?: string;
+  /**
+   * The event's tag
+   */
+  tag: string;
+  victim?: string;
+  /**
+   * Asynchronously build a new WorldEvent
+   * @param data The event data
+   * @param deps The dependencies object
+   * @returns The created WorldEvent object
+   */
+  static build(data: RawWorldEvent, deps: Dependency): Promise<WorldEvent>;
+  /**
+   * @param data The event data
+   * @param deps The dependencies object
+   */
+  constructor(data: RawWorldEvent, {
+    locale
+  }?: Dependency);
+  /**
+   * Whether the event has expired
+   */
+  get expired(): boolean;
+}
+//#endregion
 export { InterimRewardMessage, InterimStep, ProgressStep, RawWorldEvent, WorldEvent };

package/dist/lib/models/WorldEvent.mjs

@@ -1,9 +1,213 @@
-import "../../RewardTypes-DUrR7H3G.mjs";
-import "../../Reward-3FBJF_hS.mjs";
-import "../../WorldStateObject-45dbRgp7.mjs";
-import "../../FetchProxy-Bkdk15SX.mjs";
-import "../../supporting-BLSXhlWM.mjs";
-import "../../SyndicateJob-R89tWqvT.mjs";
-import { t as WorldEvent } from "../../WorldEvent-C-LaV2ug.mjs";
+import { Reward } from "./Reward.mjs";
+import { WorldStateObject } from "./WorldStateObject.mjs";
+import { SyndicateJob } from "./SyndicateJob.mjs";
+import { faction, fromNow, languageString, node, parseDate, syndicate } from "warframe-worldstate-data/utilities";
 
+//#region lib/models/WorldEvent.ts
+/**
+* Represents an in-game special event
+* @augments {WorldStateObject}
+*/
+var WorldEvent = class WorldEvent extends WorldStateObject {
+	jobs;
+	previousJobs;
+	/**
+	* The event's main score goal
+	*/
+	maximumScore;
+	/**
+	* The current score on the event
+	*/
+	currentScore;
+	/**
+	* The first intermediate score goal
+	*/
+	smallInterval;
+	/**
+	* The second intermediate score goal
+	*/
+	largeInterval;
+	/**
+	* The faction that the players must fight in the event
+	*/
+	faction;
+	/**
+	* The description of the event
+	*/
+	description;
+	/**
+	* Tooltip for the event
+	*/
+	tooltip;
+	/**
+	* The node where the event takes place
+	*/
+	node;
+	/**
+	* The other nodes where the event takes place
+	*/
+	concurrentNodes;
+	/**
+	* The victim node
+	*/
+	victimNode;
+	/**
+	* The score description
+	*/
+	scoreLocTag;
+	/**
+	* The event's rewards
+	*/
+	rewards;
+	/**
+	* Health remaining for the target
+	*/
+	health;
+	/**
+	* Previous job id
+	*/
+	previousId;
+	/**
+	* Array of steps
+	*/
+	interimSteps;
+	/**
+	* Progress Steps, if any are present
+	*/
+	progressSteps;
+	/**
+	* Total of all MultiProgress
+	*/
+	progressTotal;
+	/**
+	* Whether to show the total score at the end of the mission
+	*/
+	showTotalAtEndOfMission;
+	/**
+	* Whether the event is personal
+	*/
+	isPersonal;
+	/**
+	* Whether the event is community
+	*/
+	isCommunity;
+	regionDrops;
+	/**
+	* Archwing Drops in effect while this event is active
+	*/
+	archwingDrops;
+	/**
+	* Metadata provided by DE
+	*/
+	metadata;
+	/**
+	* Bonuses given for completion
+	*/
+	completionBonuses;
+	scoreVar;
+	altExpiry;
+	altActivation;
+	nextAlt;
+	affiliatedWith;
+	/**
+	* The event's tag
+	*/
+	tag;
+	victim;
+	/**
+	* Asynchronously build a new WorldEvent
+	* @param data The event data
+	* @param deps The dependencies object
+	* @returns The created WorldEvent object
+	*/
+	static async build(data, deps) {
+		const event = new WorldEvent(data, deps);
+		if (data.Jobs) {
+			const jobs = [];
+			for await (const job of data.Jobs ?? []) jobs.push(await SyndicateJob.build(job, event.expiry, deps));
+			event.jobs = jobs;
+		}
+		if (data.PreviousJobs) {
+			const previousJobs = [];
+			for await (const job of data.PreviousJobs ?? []) previousJobs.push(await SyndicateJob.build(job, event.expiry, deps));
+			event.previousJobs = previousJobs;
+		}
+		return event;
+	}
+	/**
+	* @param data The event data
+	* @param deps The dependencies object
+	*/
+	constructor(data, { locale = "en" } = { locale: "en" }) {
+		super(data);
+		const opts = { locale };
+		this.maximumScore = Number.parseInt(String(data.Goal), 10);
+		this.currentScore = Number.parseInt(String(data.Count), 10);
+		this.smallInterval = Number.parseInt(String(data.GoalInterim), 10);
+		this.largeInterval = Number.parseInt(String(data.GoalInterim2), 10);
+		this.faction = data.Faction ? faction(data.Faction, locale) : void 0;
+		this.description = languageString(data.Desc, locale);
+		this.tooltip = data.ToolTip ? languageString(data.ToolTip, locale) : void 0;
+		this.node = data.Node ? node(data.Node, locale) : void 0;
+		this.concurrentNodes = data.ConcurrentNodes ? data.ConcurrentNodes.map((n) => node(n, locale)) : [];
+		this.victimNode = data.VictimNode ? node(data.VictimNode, locale) : void 0;
+		this.scoreLocTag = data.ScoreLocTag ? languageString(data.ScoreLocTag, locale) : void 0;
+		if (data.Fomorian) this.scoreLocTag = "Fomorian Assault Score";
+		this.rewards = Object.keys(data).filter((k) => k.includes("Reward") || k.includes("reward")).map((k) => new Reward(data[k], opts)).filter((r) => r.items.length > 0);
+		this.health = typeof data.HealthPct !== "undefined" ? Number.parseFloat(((data.HealthPct || 0) * 100).toFixed(2)) : void 0;
+		this.jobs = [];
+		this.previousJobs = [];
+		this.previousId = data.JobPreviousVersion?.$oid;
+		this.interimSteps = [];
+		(data.InterimRewards || []).forEach((reward, index) => {
+			const msg = (data.InterimRewardMessages || [])[index] || {};
+			this.interimSteps[index] = {
+				goal: Number.parseInt(String(data.InterimGoals[index]), 10),
+				reward: reward ? new Reward(reward, opts) : void 0,
+				message: {
+					sender: languageString(msg.sender, locale),
+					subject: languageString(msg.subject, locale),
+					message: languageString(msg.message, locale),
+					senderIcon: msg.senderIcon,
+					attachments: msg.attachments
+				},
+				winnerCount: (data._interimWinnerCounts || [])[index]
+			};
+		});
+		this.progressSteps = [];
+		if (data.IsMultiProgress) {
+			data.Types?.forEach((type, index) => {
+				this.progressSteps[index] = {
+					type: languageString(type, locale),
+					progressAmt: Number.parseInt(String(data.MultiProgress[index]), 10)
+				};
+			});
+			this.progressTotal = Number.parseFloat(String(data.MultiProgress.reduce((acc, val) => acc + Number.parseFloat(val), 0)));
+		}
+		this.showTotalAtEndOfMission = data.ShowTotalAtEOM ?? false;
+		this.isPersonal = data.Personal;
+		this.isCommunity = data.Community ?? false;
+		this.regionDrops = (data.RegionDrops || []).map((drop) => languageString(drop, locale));
+		this.archwingDrops = (data.ArchwingDrops || []).map((drop) => languageString(drop, locale));
+		this.metadata = JSON.parse((data.Metadata || "{}").replace("\" ", "\""));
+		this.completionBonuses = data.CompletionBonus || [];
+		this.scoreVar = data.ScoreVar;
+		this.altExpiry = parseDate(data.AltExpiry);
+		this.altActivation = parseDate(data.AltActivation);
+		this.nextAlt = {
+			expiry: parseDate(data.NextAltExpiry),
+			activation: parseDate(data.NextAltActivation)
+		};
+		if (data.JobAffiliationTag) this.affiliatedWith = syndicate(data.JobAffiliationTag, locale);
+		this.tag = data.Tag;
+	}
+	/**
+	* Whether the event has expired
+	*/
+	get expired() {
+		return fromNow(this.expiry) < 0;
+	}
+};
+
+//#endregion
 export { WorldEvent };

package/dist/lib/models/WorldStateObject.d.mts

@@ -1,2 +1,48 @@
-import { n as Identifier, r as WorldStateObject, t as BaseContentObject } from "../../WorldStateObject-C1HEDkH7.mjs";
+import { ContentTimestamp } from "warframe-worldstate-data/utilities";
+
+//#region lib/models/WorldStateObject.d.ts
+interface Identifier {
+  $id?: string;
+  $oid?: string;
+}
+interface BaseContentObject {
+  _id?: Identifier;
+  Activation?: ContentTimestamp;
+  Expiry?: ContentTimestamp;
+}
+/**
+ * Represents a generic object from WorldState
+ */
+declare class WorldStateObject {
+  /**
+   * The object's id field
+   */
+  id?: string;
+  /**
+   * The date and time at which the WorldStateObject started
+   */
+  activation?: Date;
+  /**
+   * The date and time at which the WorldStateObject ends
+   */
+  expiry?: Date;
+  /**
+   * @param data The object data
+   */
+  constructor(data: BaseContentObject);
+  /**
+   * Whether the void trader is active (at time of object creation)
+   */
+  get active(): boolean;
+  /**
+   * A string indicating how long it will take for the trader to arrive
+   *  (at time of object creation)
+   */
+  get startString(): string | undefined;
+  /**
+   * Time delta string from now to the end
+   */
+  get endString(): string | undefined;
+}
+//#endregion
 export { BaseContentObject, Identifier, WorldStateObject };

package/dist/lib/models/WorldStateObject.mjs

@@ -1,3 +1,54 @@
-import { t as WorldStateObject } from "../../WorldStateObject-45dbRgp7.mjs";
+import { fromNow, insist, parseDate, timeDeltaToString } from "warframe-worldstate-data/utilities";
 
+//#region lib/models/WorldStateObject.ts
+/**
+* Represents a generic object from WorldState
+*/
+var WorldStateObject = class {
+	/**
+	* The object's id field
+	*/
+	id;
+	/**
+	* The date and time at which the WorldStateObject started
+	*/
+	activation;
+	/**
+	* The date and time at which the WorldStateObject ends
+	*/
+	expiry;
+	/**
+	* @param data The object data
+	*/
+	constructor(data) {
+		insist({ ...data });
+		this.id = data._id ? data._id.$oid || data._id.$id : void 0;
+		if (data.Activation) this.activation = parseDate(data.Activation);
+		if (data.Expiry) this.expiry = parseDate(data.Expiry);
+	}
+	/**
+	* Whether the void trader is active (at time of object creation)
+	*/
+	get active() {
+		if (!this.activation && !this.expiry) return false;
+		return fromNow(this.activation) < 0 && fromNow(this.expiry) > 0;
+	}
+	/**
+	* A string indicating how long it will take for the trader to arrive
+	*  (at time of object creation)
+	*/
+	get startString() {
+		if (!this.activation) return void 0;
+		return timeDeltaToString(fromNow(this.activation));
+	}
+	/**
+	* Time delta string from now to the end
+	*/
+	get endString() {
+		if (!this.expiry) return void 0;
+		return timeDeltaToString(fromNow(this.expiry));
+	}
+};
+
+//#endregion
 export { WorldStateObject };

package/dist/lib/models/ZarimanCycle.d.mts

@@ -1,3 +1,45 @@
-import "../../WorldStateObject-C1HEDkH7.mjs";
-import { n as ZarimanCycle, t as CurrentZarimanCycle } from "../../ZarimanCycle-BrSLIWhD.mjs";
+import { WorldStateObject } from "./WorldStateObject.mjs";
+
+//#region lib/models/ZarimanCycle.d.ts
+interface CurrentZarimanCycle {
+  isCorpus: boolean;
+  timeLeft: string;
+  expiry: Date;
+  expiresIn: number;
+  state: string;
+  start: number;
+}
+/**
+ * Represents the current Zariman Corpus/Grineer Cycle
+ * @augments {WorldStateObject}
+ */
+declare class ZarimanCycle extends WorldStateObject {
+  #private;
+  /**
+   * Whether or not this it's corpus or grineer
+   */
+  isCorpus: boolean;
+  /**
+   * Current cycle state. One of `corpus`, `grineer`
+   */
+  state: string;
+  /**
+   * Time remaining string
+   */
+  timeLeft: string;
+  /**
+   * @param {Date} bountiesEndDate The current Zariman cycle expiry
+   */
+  constructor(bountiesEndDate: Date);
+  /**
+   * Whether this is expired
+   */
+  get expired(): boolean;
+  getCurrentZarimanCycle(): CurrentZarimanCycle;
+  /**
+   * The event's string representation
+   */
+  get shortString(): string;
+}
+//#endregion
 export { CurrentZarimanCycle, ZarimanCycle };

package/dist/lib/models/ZarimanCycle.mjs

@@ -1,4 +1,79 @@
-import "../../WorldStateObject-45dbRgp7.mjs";
-import { t as ZarimanCycle } from "../../ZarimanCycle-DoAPwgaM.mjs";
+import { WorldStateObject } from "./WorldStateObject.mjs";
+import { fromNow, timeDeltaToString } from "warframe-worldstate-data/utilities";
 
+//#region lib/models/ZarimanCycle.ts
+const corpusTimeMillis = 16551828e5;
+const fullCycle = 18e6;
+const stateMaximum = 9e6;
+/**
+* Represents the current Zariman Corpus/Grineer Cycle
+* @augments {WorldStateObject}
+*/
+var ZarimanCycle = class extends WorldStateObject {
+	/**
+	* Whether or not this it's corpus or grineer
+	*/
+	isCorpus;
+	/**
+	* Current cycle state. One of `corpus`, `grineer`
+	*/
+	state;
+	/**
+	* Time remaining string
+	*/
+	timeLeft;
+	/**
+	* The current zariman cycle, for calculating the other fields
+	*/
+	#ec;
+	/**
+	* The end of the Zariman bounties timer, the faction changes exactly half way through
+	*/
+	#bountiesEndDate;
+	/**
+	* @param {Date} bountiesEndDate The current Zariman cycle expiry
+	*/
+	constructor(bountiesEndDate) {
+		super({ _id: { $oid: "zarimanCycle0" } });
+		this.#bountiesEndDate = bountiesEndDate;
+		this.#ec = this.getCurrentZarimanCycle();
+		this.expiry = this.#ec.expiry;
+		this.activation = new Date(this.#ec.start);
+		this.isCorpus = this.#ec.isCorpus;
+		this.state = this.#ec.state;
+		this.timeLeft = this.#ec.timeLeft;
+		this.id = `zarimanCycle${this.expiry.getTime()}`;
+	}
+	/**
+	* Whether this is expired
+	*/
+	get expired() {
+		return this.expiry ? fromNow(this.expiry) < 0 : true;
+	}
+	getCurrentZarimanCycle() {
+		const now = Date.now();
+		const bountiesClone = this.#bountiesEndDate.getTime() - 5e3;
+		const millisLeft = fromNow(new Date(bountiesClone));
+		const isCorpus = fullCycle - ((bountiesClone - corpusTimeMillis) % fullCycle + fullCycle) % fullCycle > stateMaximum;
+		const minutesCoef = 1e3 * 60;
+		const expiry = new Date(Math.round((now + millisLeft) / minutesCoef) * minutesCoef);
+		const state = isCorpus ? "corpus" : "grineer";
+		return {
+			isCorpus,
+			timeLeft: timeDeltaToString(millisLeft),
+			expiry,
+			expiresIn: millisLeft,
+			state,
+			start: expiry.getTime() - stateMaximum
+		};
+	}
+	/**
+	* The event's string representation
+	*/
+	get shortString() {
+		return `${this.timeLeft.replace(/\s\d*s/gi, "")} to ${this.isCorpus ? "grineer" : "corpus"}`;
+	}
+};
+
+//#endregion
 export { ZarimanCycle };