warframe-worldstate-parser 4.6.1 → 5.0.1

package/dist/WorldEvent-nis9w9cn.js

@@ -0,0 +1,213 @@
+import { Reward } from "./Reward-OauJ45jJ.js";
+import { WorldstateObject } from "./WorldstateObject-BSTYuZwm.js";
+import { SyndicateJob } from "./SyndicateJob-BK7OMLmv.js";
+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(data.MultiProgress.reduce((accumulator, val) => accumulator + val));
+		}
+		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/WorldState-DNSPrZR_.d.ts

@@ -0,0 +1,257 @@
+import { Archimedea } from "./Archidemea-DOh4trTM.js";
+import { Kinepage } from "./Kinepage-CRRKVulq.js";
+import { Dependency } from "./Dependency-DkOHLql6.js";
+import { SentientOutpost } from "./SentientOutpost-DmlClvel.js";
+import { BaseContentObject, WorldstateObject } from "./WorldstateObject-wfRTeGpm.js";
+import { Alert, RawAlert } from "./Alert-BS8PWPP3.js";
+import { Calendar, RawCalender } from "./Calendar-CgEkm6e6.js";
+import { CetusCycle } from "./CetusCycle-ooMM7hkg.js";
+import { CambionCycle } from "./CambionCycle-uEBpbMim.js";
+import { ConclaveChallenge, RawChallenge } from "./ConclaveChallenge-JbcEcL4s.js";
+import { ConstructionProgress } from "./ConstructionProgress-FAySTEod.js";
+import { DailyDeal, RawDailyDeal } from "./DailyDeal-Na-EaiFS.js";
+import { DarkSector, RawDarkSector } from "./DarkSector-zkCUywz1.js";
+import { RawChoice } from "./DuviriChoice-MIHsOBS7.js";
+import { DuviriCycle } from "./DuviriCycle-B0zp0KxS.js";
+import { EarthCycle } from "./EarthCycle-RELuZL01.js";
+import { Fissure, RawFissure } from "./Fissure-Bj61i8dc.js";
+import { FlashSale, RawFlashSale } from "./FlashSale-PDG4uQq4.js";
+import { GlobalUpgrade, RawGlobalUpgrade } from "./GlobalUpgrade-BRQXf3JM.js";
+import { Invasion, RawInvasion } from "./Invasion-BskF60zh.js";
+import { MidrathCycle } from "./MidrathCycle-BfQtfG4p.js";
+import { News, RawNews } from "./News-BfAgbYSY.js";
+import { Nightwave, RawNightwave } from "./Nightwave-_0RzWikV.js";
+import { PersistentEnemy, RawPersistentEnemy } from "./PersistentEnemy-DRcO4V2r.js";
+import { LibraryInfo, Simaris } from "./Simaris-Bc-jNhED.js";
+import { RawSortie, Sortie } from "./Sortie-DPv-7SQ-.js";
+import { SteelPathOfferings } from "./SteelPathOffering-OHNTCFo5.js";
+import { RawSyndicateMission, SyndicateMission } from "./SyndicateMission-DmGG5lGy.js";
+import { VallisCycle } from "./VallisCycle-BXcmzqqG.js";
+import { RawVoidTrader, VoidTrader } from "./VoidTrader-CihLWgSV.js";
+import { RawWeeklyChallenge, WeeklyChallenge } from "./WeeklyChallenge-C6sc4j7i.js";
+import { RawWorldEvent, WorldEvent } from "./WorldEvent-BS9QHG_f.js";
+import { ZarimanCycle } from "./ZarimanCycle-CjNQXhVO.js";
+import { ExternalMission } from "./ExternalMission-DCzJkPC8.js";
+
+//#region lib/WorldState.d.ts
+
+/**
+ *
+ * @param ParserClass class for parsing data
+ * @param dataArray array of raw data
+ * @param deps shared dependency object
+ * @param uniqueField field to treat as unique
+ * @returns  array of parsed objects
+ */
+declare function parseArray<T, D extends BaseContentObject>(
+// Not all instances of T extend WorldstateObject
+ParserClass: new (data: D, deps: Dependency) => T, dataArray: Array<D>, deps: Dependency, uniqueField?: keyof T): T[];
+/**
+ * Parse array of objects that requires async parsing
+ * @param ParserClass class for parsing data - must expose a static build method
+ * @param dataArray array of raw data
+ * @param deps shared dependency object
+ * @param uniqueField field to treat as unique
+ * @returns array of parsed objects
+ */
+declare function parseAsyncArray<T extends WorldstateObject, D extends BaseContentObject>(ParserClass: {
+  build: (data: D, deps: Dependency) => Promise<T>;
+}, dataArray: Array<D>, deps: Dependency, uniqueField?: keyof T): Promise<T[]>;
+interface InitialWorldState {
+  Time: number;
+  BuildLabel: string;
+  Events: RawNews[];
+  Goals: RawWorldEvent[];
+  Alerts: RawAlert[];
+  Sorties: RawSortie[];
+  LiteSorties: RawSortie[];
+  SyndicateMissions: RawSyndicateMission[];
+  ActiveMissions: RawFissure[];
+  VoidStorms: RawFissure[];
+  GlobalUpgrades: RawGlobalUpgrade[];
+  FlashSales: RawFlashSale[];
+  Invasions: RawInvasion[];
+  BadlandNodes: RawDarkSector[];
+  VoidTraders: RawVoidTrader[];
+  DailyDeals: RawDailyDeal[];
+  LibraryInfo?: LibraryInfo;
+  PVPChallengeInstances: RawChallenge[];
+  PersistentEnemies: RawPersistentEnemy[];
+  WeeklyChallenges?: RawWeeklyChallenge;
+  ProjectPct: number[];
+  SeasonInfo: RawNightwave;
+  PrimeVaultTraders: RawVoidTrader[];
+  EndlessXpChoices: RawChoice[];
+  KnownCalendarSeasons: RawCalender[];
+  Tmp: string;
+}
+/**
+ * Parses Warframe Worldstate JSON
+ */
+declare class WorldState {
+  /**
+   * The date and time at which the World State was generated
+   */
+  timestamp: Date;
+  /**
+   * Current Warframe version
+   */
+  buildLabel: string;
+  /**
+   * The in-game news
+   */
+  news: News[];
+  /**
+   * The current events
+   */
+  events: WorldEvent[];
+  /**
+   * The current alerts
+   */
+  alerts: Alert[];
+  /**
+   * The current sortie
+   */
+  sortie: Sortie;
+  /**
+   * The current syndicate missions
+   */
+  syndicateMissions: SyndicateMission[];
+  /**
+   * The current fissures: 'ActiveMissions' & 'VoidStorms'
+   */
+  fissures: Fissure[];
+  /**
+   * The current global upgrades
+   */
+  globalUpgrades: GlobalUpgrade[];
+  /**
+   * The current flash sales
+   */
+  flashSales: FlashSale[];
+  /**
+   * The current invasions
+   */
+  invasions: Invasion[];
+  /**
+   * The state of the dark sectors
+   */
+  darkSectors: DarkSector[];
+  /**
+   * The state of all Void Traders
+   */
+  voidTraders: VoidTrader[];
+  /**
+   * The first entry for voidTraders
+   * @deprecated
+   */
+  voidTrader: VoidTrader;
+  /**
+   * The current daily deals
+   */
+  dailyDeals: DailyDeal[];
+  /**
+   * The state of the sanctuary synthesis targets
+   */
+  simaris: Simaris;
+  /**
+   * The current conclave challenges
+   */
+  conclaveChallenges: ConclaveChallenge[];
+  /**
+   * The currently active persistent enemies
+   */
+  persistentEnemies: PersistentEnemy[];
+  /**
+   * The current earth cycle
+   */
+  earthCycle: EarthCycle;
+  /**
+   * The current Cetus cycle
+   */
+  cetusCycle: CetusCycle;
+  /**
+   * Cambion Drift Cycle
+   */
+  cambionCycle: CambionCycle;
+  /**
+   * The current Zariman cycle based off current time
+   */
+  zarimanCycle: ZarimanCycle;
+  /**
+   * Midrath cycle (soulframe)
+   */
+  midrathCycle: MidrathCycle;
+  /**
+   * Weekly challenges
+   */
+  weeklyChallenges?: WeeklyChallenge;
+  /**
+   * The Current construction progress for Fomorians/Razorback/etc.
+   */
+  constructionProgress: ConstructionProgress;
+  /**
+   * The current Orb Vallis cycle state
+   */
+  vallisCycle: VallisCycle;
+  /**
+   * The current nightwave season
+   */
+  nightwave?: Nightwave;
+  /**
+   * Kuva missions array
+   */
+  kuva?: ExternalMission[];
+  /**
+   * Arbitration mission
+   */
+  arbitration?: ExternalMission;
+  /**
+   * Current sentient outposts
+   */
+  sentientOutposts: SentientOutpost;
+  /**
+   * Steel path offering rotation
+   */
+  steelPath: SteelPathOfferings;
+  /**
+   * The current prime resurgence
+   */
+  vaultTrader: VoidTrader;
+  /**
+   * The current archon hunt
+   */
+  archonHunt: Sortie;
+  /**
+   * Current Duviri circuit choices
+   */
+  duviriCycle: DuviriCycle;
+  /**
+   * Current kinepage message
+   */
+  kinepage: Kinepage;
+  /**
+   * The current Deep Archimedea missions and modifiers
+   */
+  deepArchimedea?: Archimedea;
+  /**
+   * The current Temporal Archimedea missions and modifiers
+   */
+  temporalArchimedea?: Archimedea;
+  /**
+   * The current calendar for 1999
+   */
+  calendar: Calendar;
+  /**
+   * Generates the worldstate json as a string into usable objects
+   */
+  static build(json: string, deps?: Dependency): Promise<WorldState>;
+  /**
+   * @param data The worldstate JSON string
+   * @param deps The options object
+   */
+  constructor(data: InitialWorldState, deps?: Dependency);
+}
+declare const _default: (json: string, deps: Dependency) => Promise<WorldState>;
+//#endregion
+export { InitialWorldState, WorldState, _default, parseArray, parseAsyncArray };