warframe-worldstate-parser 5.2.16 → 5.2.17

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

@@ -1,3 +1,101 @@
-import "../../WorldStateObject-C1HEDkH7.mjs";
-import { n as RawNews, t as News } from "../../News-DxEm-q6V.mjs";
+import { BaseContentObject, WorldStateObject } from "./WorldStateObject.mjs";
+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/lib/models/News.mjs

@@ -1,4 +1,118 @@
-import "../../WorldStateObject-45dbRgp7.mjs";
-import { t as News } from "../../News-zAK-sYRg.mjs";
+import { cdn, deProxy } from "../supporting/ImgCdn.mjs";
+import { WorldStateObject } from "./WorldStateObject.mjs";
+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) return `in ${timeDeltaToString(fromNow(this.expiry))}`;
+		return `${timeDeltaToString(toNow(this.date))} 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/lib/models/Nightwave.d.mts

@@ -1,4 +1,59 @@
-import "../../WorldStateObject-C1HEDkH7.mjs";
-import "../../NightwaveChallenge-CG3uychc.mjs";
-import { n as RawNightwave, t as Nightwave } from "../../Nightwave-CPqMSqGK.mjs";
+import { BaseContentObject, WorldStateObject } from "./WorldStateObject.mjs";
+import { NightwaveChallenge, RawNightwaveChallenge } from "./NightwaveChallenge.mjs";
+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 a nightwave state
+ * @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/lib/models/Nightwave.mjs

@@ -1,5 +1,60 @@
-import "../../WorldStateObject-45dbRgp7.mjs";
-import "../../NightwaveChallenge-C8ARG7LC.mjs";
-import { t as Nightwave } from "../../Nightwave-cTRmlbwH.mjs";
+import { WorldStateObject } from "./WorldStateObject.mjs";
+import { NightwaveChallenge } from "./NightwaveChallenge.mjs";
+import { fromNow, languageString, timeDeltaToString } from "warframe-worldstate-data/utilities";
 
+//#region lib/models/Nightwave.ts
+/**
+* Represents a nightwave state
+* @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/lib/models/NightwaveChallenge.d.mts

@@ -1,3 +1,51 @@
-import "../../WorldStateObject-C1HEDkH7.mjs";
-import { n as RawNightwaveChallenge, t as NightwaveChallenge } from "../../NightwaveChallenge-CG3uychc.mjs";
+import { BaseContentObject, WorldStateObject } from "./WorldStateObject.mjs";
+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 };

package/dist/lib/models/NightwaveChallenge.mjs

@@ -1,4 +1,53 @@
-import "../../WorldStateObject-45dbRgp7.mjs";
-import { t as NightwaveChallenge } from "../../NightwaveChallenge-C8ARG7LC.mjs";
+import { WorldStateObject } from "./WorldStateObject.mjs";
+import { languageDesc, languageString } from "warframe-worldstate-data/utilities";
 
+//#region lib/models/NightwaveChallenge.ts
+const repBase = 1e3;
+/**
+* Represents an alert
+* @augments {WorldStateObject}
+*/
+var NightwaveChallenge = class extends WorldStateObject {
+	/**
+	* Whether or not this is a daily challenge
+	*/
+	isDaily;
+	/**
+	* Whether or not the challenge is an elite challenge
+	*/
+	isElite;
+	/**
+	* The descriptor for this challenge
+	*/
+	desc;
+	/**
+	* The title for this challenge
+	*/
+	title;
+	/**
+	* Reputation reward for ranking up in the Nightwave
+	*/
+	reputation;
+	/**
+	* Whether this challenge is permanent
+	*/
+	isPermanent;
+	/**
+	* @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);
+		this.isDaily = data.Daily || false;
+		this.isElite = /hard/gi.test(data.Challenge);
+		this.desc = languageDesc(data.Challenge, locale);
+		this.title = languageString(data.Challenge, locale);
+		this.id = `${this.expiry.getTime()}${data.Challenge.split("/").slice(-1)[0].toLowerCase()}`;
+		this.reputation = repBase + (!this.isDaily ? 3500 : 0) + (this.isElite ? 2500 : 0);
+		this.isPermanent = Boolean(data?.Permanent);
+	}
+};
+
+//#endregion
 export { NightwaveChallenge };

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

@@ -1,3 +1,79 @@
-import "../../WorldStateObject-C1HEDkH7.mjs";
-import { n as RawPersistentEnemy, t as PersistentEnemy } from "../../PersistentEnemy-DnnnreSz.mjs";
+import { BaseContentObject, WorldStateObject } from "./WorldStateObject.mjs";
+import { Locale } from "warframe-worldstate-data";
+import { ContentTimestamp } from "warframe-worldstate-data/utilities";
+
+//#region lib/models/PersistentEnemy.d.ts
+interface RawPersistentEnemy extends BaseContentObject {
+  AgentType: string;
+  LocTag: string;
+  Rank: number;
+  HealthPercent: string;
+  FleeDamage: number;
+  Region: number;
+  LastDiscoveredTime: ContentTimestamp;
+  LastDiscoveredLocation: string;
+  Discovered: boolean;
+  UseTicketing: boolean;
+}
+/**
+ * Represents a persistent enemy
+ * @augments {WorldStateObject}
+ */
+declare class PersistentEnemy extends WorldStateObject {
+  /**
+   * The enemy's type
+   */
+  agentType: string;
+  /**
+   * The location tag
+   */
+  locationTag: string;
+  /**
+   * The enemy's rank
+   */
+  rank: number;
+  /**
+   * The enemy's remaining health percentage
+   */
+  healthPercent: number;
+  /**
+   * The percentual damage that the enemy takes when it's defeated
+   */
+  fleeDamage: number;
+  /**
+   * The region where the enemy is located
+   */
+  region: string | number;
+  /**
+   * The last time the enemy was discovered
+   */
+  lastDiscoveredTime: Date;
+  /**
+   * The node at which the enemy was last discovered
+   */
+  lastDiscoveredAt: string;
+  /**
+   * Whether or not the enemy is currently available
+   */
+  isDiscovered: boolean;
+  /**
+   * Whether or not the enemy is using ticketing
+   */
+  isUsingTicketing: boolean;
+  /**
+   * Fake ID incorporating discovery
+   */
+  pid: string;
+  /**
+   * @param data        The persistent enemy data
+   * @param deps        The dependencies object
+   * @param deps.locale Locale to use for translations
+   */
+  constructor(data: RawPersistentEnemy, {
+    locale
+  }?: {
+    locale: Locale;
+  });
+}
+//#endregion
 export { PersistentEnemy, RawPersistentEnemy };

package/dist/lib/models/PersistentEnemy.mjs

@@ -1,4 +1,76 @@
-import "../../WorldStateObject-45dbRgp7.mjs";
-import { t as PersistentEnemy } from "../../PersistentEnemy-3Sw5E8AN.mjs";
+import { WorldStateObject } from "./WorldStateObject.mjs";
+import { languageString, node, parseDate, region } from "warframe-worldstate-data/utilities";
 
+//#region lib/models/PersistentEnemy.ts
+/**
+* Represents a persistent enemy
+* @augments {WorldStateObject}
+*/
+var PersistentEnemy = class extends WorldStateObject {
+	/**
+	* The enemy's type
+	*/
+	agentType;
+	/**
+	* The location tag
+	*/
+	locationTag;
+	/**
+	* The enemy's rank
+	*/
+	rank;
+	/**
+	* The enemy's remaining health percentage
+	*/
+	healthPercent;
+	/**
+	* The percentual damage that the enemy takes when it's defeated
+	*/
+	fleeDamage;
+	/**
+	* The region where the enemy is located
+	*/
+	region;
+	/**
+	* The last time the enemy was discovered
+	*/
+	lastDiscoveredTime;
+	/**
+	* The node at which the enemy was last discovered
+	*/
+	lastDiscoveredAt;
+	/**
+	* Whether or not the enemy is currently available
+	*/
+	isDiscovered;
+	/**
+	* Whether or not the enemy is using ticketing
+	*/
+	isUsingTicketing;
+	/**
+	* Fake ID incorporating discovery
+	*/
+	pid;
+	/**
+	* @param data        The persistent enemy data
+	* @param deps        The dependencies object
+	* @param deps.locale Locale to use for translations
+	*/
+	constructor(data, { locale } = { locale: "en" }) {
+		super(data);
+		this.agentType = languageString(data.AgentType, locale);
+		this.locationTag = languageString(data.LocTag, locale);
+		this.rank = data.Rank;
+		this.healthPercent = Number.parseFloat(data.HealthPercent);
+		this.fleeDamage = data.FleeDamage;
+		this.region = region(data.Region, locale);
+		this.lastDiscoveredTime = parseDate(data.LastDiscoveredTime);
+		this.lastDiscoveredAt = node(data.LastDiscoveredLocation, locale);
+		this.isDiscovered = data.Discovered;
+		this.isUsingTicketing = data.UseTicketing;
+		this.pid = `${this.id}${this.isDiscovered}`;
+	}
+};
+
+//#endregion
 export { PersistentEnemy };