warframe-worldstate-parser 4.6.2 → 5.0.1

package/dist/Mission-CWE16ouO.d.ts

@@ -0,0 +1,138 @@
+import { Dependency } from "./Dependency-DkOHLql6.js";
+import { RawReward, Reward } from "./Reward-5VIpHu9A.js";
+
+//#region lib/models/Mission.d.ts
+interface RawMission {
+  descText: string;
+  location: string;
+  node?: string;
+  missionType: string;
+  faction: string;
+  missionReward: RawReward;
+  minEnemyLevel: number;
+  maxEnemyLevel: number;
+  maxWaveNum?: number;
+  nightmare?: boolean;
+  archwingRequired?: boolean;
+  isSharkwingMission?: boolean;
+  levelOverride: string;
+  enemySpec: string;
+  advancedSpawners?: string[];
+  requiredItems?: string[];
+  consumeRequiredItems?: boolean;
+  vipAgent?: string;
+  leadersAlwaysAllowed?: boolean;
+  goalTag?: string;
+  levelAuras?: string[];
+  exclusiveWeapon: string;
+}
+/**
+ * Represents an in-game mission
+ */
+declare class Mission {
+  /**
+   * The mission's description
+   */
+  description: string;
+  /**
+   * The node where the mission takes place
+   */
+  node: string;
+  /**
+   * Unlocalized node
+   */
+  nodeKey: string;
+  /**
+   * The mission's type
+   */
+  type: string;
+  /**
+   * The mission's type
+   */
+  typeKey: string;
+  /**
+   * The factions that the players must fight in the mission
+   */
+  faction: string;
+  /**
+   * The factions that the players must fight in the mission
+   */
+  factionKey: string;
+  /**
+   * The mission's reward
+   */
+  reward?: Reward;
+  /**
+   * The minimum level of the enemies in the mission
+   */
+  minEnemyLevel: number;
+  /**
+   * The maximum level of the enemies in the mission
+   */
+  maxEnemyLevel: number;
+  /**
+   * The number of waves that the players need to complete (undefined if not applicable)
+   */
+  maxWaveNum?: number;
+  /**
+   * The Mission's nightmare boolean
+   */
+  nightmare: boolean;
+  /**
+   * The Mission's archwing requirement
+   */
+  archwingRequired: boolean;
+  /**
+   * The Mission's sharkwing requirement
+   */
+  isSharkwing: boolean;
+  /**
+   * Override for the map on this mission
+   */
+  levelOverride: string;
+  /**
+   * Enemy specification for the mission
+   */
+  enemySpec: string;
+  /**
+   * Array of strings denoting extra spawners for a mission
+   */
+  advancedSpawners: string[];
+  /**
+   * Items required to enter the mission
+   */
+  requiredItems: string[];
+  /**
+   * Whether or not the required items are consumed
+   */
+  consumeRequiredItems?: boolean;
+  /**
+   * Target for the mission
+   */
+  target?: string;
+  /**
+   * Whether or not leaders are always allowed
+   */
+  leadersAlwaysAllowed?: boolean;
+  /**
+   * A tag for the event that this corresponds to
+   */
+  goalTag?: string;
+  /**
+   * Affectors for this mission
+   */
+  levelAuras: string[];
+  /**
+   * Only weapon allowed for the mission
+   */
+  exclusiveWeapon: string;
+  /**
+   * @param data   The mission data
+   * @param locale Locale to use for translations
+   */
+  constructor(data: RawMission, {
+    locale
+  }?: Dependency);
+}
+//#endregion
+export { Mission, RawMission };

package/dist/Mission-ZuSsAYNm.js

@@ -0,0 +1,140 @@
+import { Reward } from "./Reward-OauJ45jJ.js";
+import { faction, insist, languageString, missionType, node } from "warframe-worldstate-data/utilities";
+
+//#region lib/models/Mission.ts
+/**
+* Represents an in-game mission
+*/
+var Mission = class {
+	/**
+	* The mission's description
+	*/
+	description;
+	/**
+	* The node where the mission takes place
+	*/
+	node;
+	/**
+	* Unlocalized node
+	*/
+	nodeKey;
+	/**
+	* The mission's type
+	*/
+	type;
+	/**
+	* The mission's type
+	*/
+	typeKey;
+	/**
+	* The factions that the players must fight in the mission
+	*/
+	faction;
+	/**
+	* The factions that the players must fight in the mission
+	*/
+	factionKey;
+	/**
+	* The mission's reward
+	*/
+	reward;
+	/**
+	* The minimum level of the enemies in the mission
+	*/
+	minEnemyLevel;
+	/**
+	* The maximum level of the enemies in the mission
+	*/
+	maxEnemyLevel;
+	/**
+	* The number of waves that the players need to complete (undefined if not applicable)
+	*/
+	maxWaveNum;
+	/**
+	* The Mission's nightmare boolean
+	*/
+	nightmare;
+	/**
+	* The Mission's archwing requirement
+	*/
+	archwingRequired;
+	/**
+	* The Mission's sharkwing requirement
+	*/
+	isSharkwing;
+	/**
+	* Override for the map on this mission
+	*/
+	levelOverride;
+	/**
+	* Enemy specification for the mission
+	*/
+	enemySpec;
+	/**
+	* Array of strings denoting extra spawners for a mission
+	*/
+	advancedSpawners;
+	/**
+	* Items required to enter the mission
+	*/
+	requiredItems;
+	/**
+	* Whether or not the required items are consumed
+	*/
+	consumeRequiredItems;
+	/**
+	* Target for the mission
+	*/
+	target;
+	/**
+	* Whether or not leaders are always allowed
+	*/
+	leadersAlwaysAllowed;
+	/**
+	* A tag for the event that this corresponds to
+	*/
+	goalTag;
+	/**
+	* Affectors for this mission
+	*/
+	levelAuras;
+	/**
+	* Only weapon allowed for the mission
+	*/
+	exclusiveWeapon;
+	/**
+	* @param data   The mission data
+	* @param locale Locale to use for translations
+	*/
+	constructor(data, { locale = "en" } = { locale: "en" }) {
+		const deps = { locale };
+		insist({ ...data });
+		this.description = languageString(data.descText, locale);
+		this.node = node(data.node || data.location, locale);
+		this.nodeKey = node(data.node || data.location, "en");
+		this.type = missionType(data.missionType, locale);
+		this.typeKey = missionType(data.missionType, "en");
+		this.faction = faction(data.faction, locale);
+		this.factionKey = faction(data.faction, "en");
+		this.reward = data.missionReward ? new Reward(data.missionReward, deps) : void 0;
+		this.minEnemyLevel = data.minEnemyLevel;
+		this.maxEnemyLevel = data.maxEnemyLevel;
+		this.maxWaveNum = data.maxWaveNum;
+		this.nightmare = data.nightmare || false;
+		this.archwingRequired = data.archwingRequired || false;
+		this.isSharkwing = data.isSharkwingMission || false;
+		this.levelOverride = languageString(data.levelOverride, locale);
+		this.enemySpec = languageString(data.enemySpec, locale);
+		this.advancedSpawners = (data.advancedSpawners || []).map((spawner) => languageString(spawner, locale));
+		this.requiredItems = (data.requiredItems || []).map((reqItem) => languageString(reqItem, locale));
+		this.consumeRequiredItems = data.consumeRequiredItems;
+		this.target = data.vipAgent ? languageString(data.vipAgent, locale) : void 0;
+		this.leadersAlwaysAllowed = data.leadersAlwaysAllowed;
+		this.goalTag = data.goalTag;
+		this.levelAuras = (data.levelAuras || []).map((aura) => languageString(aura, locale));
+		this.exclusiveWeapon = languageString(data.exclusiveWeapon, locale);
+	}
+};
+
+//#endregion
+export { Mission };

package/dist/News-7F8Nbp4A.js

@@ -0,0 +1,122 @@
+import { cdn, deProxy } from "./ImgCdn-BnbJ9K-0.js";
+import { WorldstateObject } from "./WorldstateObject-BSTYuZwm.js";
+import { fromNow, languageString, parseDate, timeDeltaToString, toNow } from "warframe-worldstate-data/utilities";
+
+//#region lib/models/News.ts
+const updateReg = /(update|hotfix|patch-notes)/i;
+const primeAccessReg = /(access)/i;
+const streamReg = /(devstream|prime-time|warframeinternational|stream)/i;
+const langString = /(\/Lotus\/Language\/)/i;
+/**
+* Represents a game news item
+* @augments {WorldstateObject}
+*/
+var News = class extends WorldstateObject {
+	/**
+	* The news message
+	*/
+	message;
+	/**
+	* The link to the forum post
+	*/
+	link;
+	/**
+	* The news's image link
+	*/
+	imageLink;
+	/**
+	* Whether this has priority over other news or not
+	*/
+	priority;
+	/**
+	* The date at which the post was published
+	*/
+	date;
+	/**
+	* The message translated into different locales
+	*/
+	translations;
+	/**
+	* Whether this is an update news item
+	*/
+	update;
+	/**
+	* Whether this is a prime access news item
+	*/
+	primeAccess;
+	/**
+	* Whether or not this is a stream
+	*/
+	stream;
+	/**
+	* Whether or not this news is mobile only.
+	*/
+	mobileOnly;
+	/**
+	* @param  data    The news data
+	* @param  locale  Locale to use for determining language
+	*/
+	constructor(data, { locale } = { locale: "en" }) {
+		super({
+			...data,
+			Activation: data.EventStartDate,
+			Expiry: data.EventEndDate
+		});
+		this.message = (data.Messages.find((msg) => msg.LanguageCode === locale) || { Message: "" }).Message;
+		if (langString.test(this.message)) this.message = languageString(this.message, locale);
+		this.link = data.Prop;
+		if ((!this.link || !this.link.length) && data.Links && data.Links.length) this.link = (data.Links.find((l) => l.LanguageCode === locale) || { Link: "https://www.warframe.com/" }).Link;
+		this.imageLink = data.ImageUrl ? deProxy(data.ImageUrl) : cdn("img/news-placeholder.png");
+		this.priority = data.Priority;
+		this.date = parseDate(data.Date);
+		this.translations = {};
+		data.Messages.forEach((message) => {
+			this.translations[message.LanguageCode] = message.Message;
+			if (langString.test(message.Message)) this.translations[message.LanguageCode] = languageString(message.Message, message.LanguageCode);
+		});
+		this.update = this.isUpdate();
+		this.primeAccess = this.isPrimeAccess();
+		this.stream = this.isStream();
+		this.mobileOnly = data.MobileOnly;
+	}
+	/**
+	* Whether or not this is about a game update
+	*/
+	isUpdate() {
+		return updateReg.test(this.link);
+	}
+	/**
+	* Whether this is about a new Prime Access
+	*/
+	isPrimeAccess() {
+		return primeAccessReg.test(this.link);
+	}
+	/**
+	* Whether this is about a new stream
+	*/
+	isStream() {
+		return streamReg.test(this.message);
+	}
+	/**
+	* ETA string (at time of object creation)
+	*/
+	get eta() {
+		if (this.expiry) {
+			const timeDelta$1 = fromNow(this.expiry);
+			return `in ${timeDeltaToString(timeDelta$1)}`;
+		}
+		const timeDelta = toNow(this.date);
+		return `${timeDeltaToString(timeDelta)} ago`;
+	}
+	/**
+	* The title of the news item in the specified language
+	* @param {string} langCode Ex. 'es', 'de', 'fr'
+	* @returns {string} The title of the news item in the specified language
+	*/
+	getTitle(langCode) {
+		return langCode in this.translations ? this.translations[langCode] : this.message;
+	}
+};
+
+//#endregion
+export { News };

package/dist/News-BfAgbYSY.d.ts

@@ -0,0 +1,101 @@
+import { BaseContentObject, WorldstateObject } from "./WorldstateObject-wfRTeGpm.js";
+import { Locale } from "warframe-worldstate-data";
+import { ContentTimestamp } from "warframe-worldstate-data/utilities";
+
+//#region lib/models/News.d.ts
+interface RawNews extends BaseContentObject {
+  Messages: {
+    LanguageCode: string;
+    Message: string;
+  }[];
+  Prop: string;
+  Links?: {
+    LanguageCode: string;
+    Link: string;
+  }[];
+  ImageUrl: string;
+  Priority: boolean;
+  MobileOnly: boolean;
+  Date: ContentTimestamp;
+  EventStartDate?: ContentTimestamp;
+  EventEndDate?: ContentTimestamp;
+}
+/**
+ * Represents a game news item
+ * @augments {WorldstateObject}
+ */
+declare class News extends WorldstateObject {
+  /**
+   * The news message
+   */
+  message: string;
+  /**
+   * The link to the forum post
+   */
+  link: string;
+  /**
+   * The news's image link
+   */
+  imageLink: string;
+  /**
+   * Whether this has priority over other news or not
+   */
+  priority: boolean;
+  /**
+   * The date at which the post was published
+   */
+  date: Date;
+  /**
+   * The message translated into different locales
+   */
+  translations: Record<string, string>;
+  /**
+   * Whether this is an update news item
+   */
+  update: boolean;
+  /**
+   * Whether this is a prime access news item
+   */
+  primeAccess: boolean;
+  /**
+   * Whether or not this is a stream
+   */
+  stream: boolean;
+  /**
+   * Whether or not this news is mobile only.
+   */
+  mobileOnly: boolean;
+  /**
+   * @param  data    The news data
+   * @param  locale  Locale to use for determining language
+   */
+  constructor(data: RawNews, {
+    locale
+  }?: {
+    locale: Locale;
+  });
+  /**
+   * Whether or not this is about a game update
+   */
+  isUpdate(): boolean;
+  /**
+   * Whether this is about a new Prime Access
+   */
+  isPrimeAccess(): boolean;
+  /**
+   * Whether this is about a new stream
+   */
+  isStream(): boolean;
+  /**
+   * ETA string (at time of object creation)
+   */
+  get eta(): string;
+  /**
+   * The title of the news item in the specified language
+   * @param {string} langCode Ex. 'es', 'de', 'fr'
+   * @returns {string} The title of the news item in the specified language
+   */
+  getTitle(langCode: Locale): string;
+}
+//#endregion
+export { News, RawNews };

package/dist/Nightwave-DDX0_zJU.js

@@ -0,0 +1,60 @@
+import { WorldstateObject } from "./WorldstateObject-BSTYuZwm.js";
+import { NightwaveChallenge } from "./NightwaveChallenge-DwilvXfi.js";
+import { fromNow, languageString, timeDeltaToString } from "warframe-worldstate-data/utilities";
+
+//#region lib/models/Nightwave.ts
+/**
+* Represents an alert
+* @augments {WorldstateObject}
+*/
+var Nightwave = class extends WorldstateObject {
+	/**
+	* The current season. 0-indexed.
+	*/
+	season;
+	/**
+	* Descriptor for affiliation
+	*/
+	tag;
+	/**
+	* The current season's current phase. 0-indexed.
+	*/
+	phase;
+	/**
+	* Misc params provided.
+	*/
+	params;
+	/**
+	* Array of possible challenges
+	*/
+	possibleChallenges;
+	/**
+	* Array of active challenges
+	*/
+	activeChallenges;
+	/**
+	* @param data        The alert data
+	* @param deps        The dependencies object
+	* @param deps.locale Locale to use for translations
+	*/
+	constructor(data, { locale } = { locale: "en" }) {
+		super(data);
+		const deps = { locale };
+		this.id = `nightwave${new Date(this.expiry).getTime()}`;
+		this.season = data.Season;
+		this.tag = languageString(data.AffiliationTag, locale);
+		this.phase = data.Phase;
+		this.params = JSON.parse(data.Params || "{}");
+		this.possibleChallenges = (data.Challenges || []).map((challenge) => new NightwaveChallenge(challenge, deps)).filter((challenge) => challenge);
+		this.activeChallenges = (data.ActiveChallenges || []).map((challenge) => new NightwaveChallenge(challenge, deps)).filter((challenge) => challenge);
+	}
+	/**
+	* How much time is left before the nightwave expires
+	*/
+	get eta() {
+		return timeDeltaToString(fromNow(this.expiry));
+	}
+};
+
+//#endregion
+export { Nightwave };

package/dist/Nightwave-_0RzWikV.d.ts

@@ -0,0 +1,59 @@
+import { BaseContentObject, WorldstateObject } from "./WorldstateObject-wfRTeGpm.js";
+import { NightwaveChallenge, RawNightwaveChallenge } from "./NightwaveChallenge-DDdrqvge.js";
+import { Locale } from "warframe-worldstate-data";
+
+//#region lib/models/Nightwave.d.ts
+interface RawNightwave extends BaseContentObject {
+  Season: number;
+  AffiliationTag: string;
+  Phase: number;
+  Params: string;
+  Challenges?: RawNightwaveChallenge[];
+  ActiveChallenges: RawNightwaveChallenge[];
+}
+/**
+ * Represents an alert
+ * @augments {WorldstateObject}
+ */
+declare class Nightwave extends WorldstateObject {
+  /**
+   * The current season. 0-indexed.
+   */
+  season: number;
+  /**
+   * Descriptor for affiliation
+   */
+  tag: string;
+  /**
+   * The current season's current phase. 0-indexed.
+   */
+  phase: number;
+  /**
+   * Misc params provided.
+   */
+  params: Record<string, unknown>;
+  /**
+   * Array of possible challenges
+   */
+  possibleChallenges: NightwaveChallenge[];
+  /**
+   * Array of active challenges
+   */
+  activeChallenges: NightwaveChallenge[];
+  /**
+   * @param data        The alert data
+   * @param deps        The dependencies object
+   * @param deps.locale Locale to use for translations
+   */
+  constructor(data: RawNightwave, {
+    locale
+  }?: {
+    locale: Locale;
+  });
+  /**
+   * How much time is left before the nightwave expires
+   */
+  get eta(): string;
+}
+//#endregion
+export { Nightwave, RawNightwave };

package/dist/NightwaveChallenge-DDdrqvge.d.ts

@@ -0,0 +1,51 @@
+import { BaseContentObject, WorldstateObject } from "./WorldstateObject-wfRTeGpm.js";
+import { Locale } from "warframe-worldstate-data";
+
+//#region lib/models/NightwaveChallenge.d.ts
+interface RawNightwaveChallenge extends BaseContentObject {
+  Daily?: boolean;
+  Challenge: string;
+  Permanent?: number | string | boolean;
+}
+/**
+ * Represents an alert
+ * @augments {WorldstateObject}
+ */
+declare class NightwaveChallenge extends WorldstateObject {
+  /**
+   * Whether or not this is a daily challenge
+   */
+  isDaily: boolean;
+  /**
+   * Whether or not the challenge is an elite challenge
+   */
+  isElite: boolean;
+  /**
+   * The descriptor for this challenge
+   */
+  desc: string;
+  /**
+   * The title for this challenge
+   */
+  title: string;
+  /**
+   * Reputation reward for ranking up in the Nightwave
+   */
+  reputation: number;
+  /**
+   * Whether this challenge is permanent
+   */
+  isPermanent: boolean;
+  /**
+   * @param data        The alert data
+   * @param deps        The dependencies object
+   * @param deps.locale Locale to use for translations
+   */
+  constructor(data: RawNightwaveChallenge, {
+    locale
+  }?: {
+    locale: Locale;
+  });
+}
+//#endregion
+export { NightwaveChallenge, RawNightwaveChallenge };