warframe-worldstate-parser 4.6.1 → 5.0.1

package/dist/VoidTrader-CbLMfEVj.js

@@ -0,0 +1,77 @@
+import { WorldstateObject } from "./WorldstateObject-BSTYuZwm.js";
+import { VoidTraderItem } from "./VoidTraderItem-BzeD-S6-.js";
+import { VoidTraderSchedule } from "./VoidTraderSchedule-C-K8Zdfk.js";
+import { fromNow, insist, node, parseDate, timeDeltaToString } from "warframe-worldstate-data/utilities";
+
+//#region lib/models/VoidTrader.ts
+/**
+* Represents a void trader
+* @augments {WorldstateObject}
+*/
+var VoidTrader = class extends WorldstateObject {
+	/**
+	* The void trader's name
+	*/
+	character;
+	/**
+	* The node at which the Void Trader appears
+	*/
+	location;
+	/**
+	* The trader's inventory
+	*/
+	inventory;
+	/**
+	* Pseudo Identifier for identifying changes in inventory
+	*/
+	psId;
+	/**
+	* The initial start date
+	*/
+	initialStart;
+	/**
+	* Whether it's completed or not
+	*/
+	completed;
+	/**
+	* Possible schedule
+	*/
+	schedule;
+	/**
+	* @param data        The Void trader data
+	* @param deps        The dependencies object
+	* @param deps.locale Locale to use for translations
+	*/
+	constructor(data, { locale = "en" } = { locale: "en" }) {
+		super(data);
+		insist({ ...data }, "Activation", "Expiry");
+		this.character = data.Character ? data.Character.replace("Baro'Ki Teel", "Baro Ki'Teer") : "";
+		this.location = node(data.Node, locale);
+		this.inventory = data.Manifest ? data.Manifest.map((i) => new VoidTraderItem(i, { locale })) : [];
+		this.psId = `${this.id}${this.inventory.length}`;
+		this.initialStart = parseDate(data.InitialStartDate);
+		this.completed = data.Completed;
+		this.schedule = data.ScheduleInfo ? data.ScheduleInfo.map((i) => new VoidTraderSchedule(i, { locale })) : [];
+	}
+	/**
+	* Whether the trader is active
+	*/
+	get active() {
+		return fromNow(this.activation) < 0 && fromNow(this.expiry) > 0;
+	}
+	/**
+	* Time delta string from now to the start
+	*/
+	get startString() {
+		return timeDeltaToString(fromNow(this.activation));
+	}
+	/**
+	* Time delta string from now to the end
+	*/
+	get endString() {
+		return timeDeltaToString(fromNow(this.expiry));
+	}
+};
+
+//#endregion
+export { VoidTrader };

package/dist/VoidTrader-CihLWgSV.d.ts

@@ -0,0 +1,74 @@
+import { Dependency } from "./Dependency-DkOHLql6.js";
+import { BaseContentObject, WorldstateObject } from "./WorldstateObject-wfRTeGpm.js";
+import { RawVoidTraderItem, VoidTraderItem } from "./VoidTraderItem-CkYAKAEn.js";
+import { VoidTraderSchedule } from "./VoidTraderSchedule-DKDtu-9d.js";
+import { ContentTimestamp } from "warframe-worldstate-data/utilities";
+
+//#region lib/models/VoidTrader.d.ts
+interface RawVoidTrader extends BaseContentObject {
+  Character?: string;
+  Node: string;
+  Manifest: RawVoidTraderItem[];
+  InitialStartDate: ContentTimestamp;
+  Completed: boolean;
+  ScheduleInfo: {
+    Expiry: ContentTimestamp;
+    FeaturedItem: string;
+  }[];
+}
+/**
+ * Represents a void trader
+ * @augments {WorldstateObject}
+ */
+declare class VoidTrader extends WorldstateObject {
+  /**
+   * The void trader's name
+   */
+  character: string;
+  /**
+   * The node at which the Void Trader appears
+   */
+  location: string;
+  /**
+   * The trader's inventory
+   */
+  inventory: VoidTraderItem[];
+  /**
+   * Pseudo Identifier for identifying changes in inventory
+   */
+  psId: string;
+  /**
+   * The initial start date
+   */
+  initialStart: Date;
+  /**
+   * Whether it's completed or not
+   */
+  completed: boolean;
+  /**
+   * Possible schedule
+   */
+  schedule: VoidTraderSchedule[];
+  /**
+   * @param data        The Void trader data
+   * @param deps        The dependencies object
+   * @param deps.locale Locale to use for translations
+   */
+  constructor(data: RawVoidTrader, {
+    locale
+  }?: Dependency);
+  /**
+   * Whether the trader is active
+   */
+  get active(): boolean;
+  /**
+   * Time delta string from now to the start
+   */
+  get startString(): string;
+  /**
+   * Time delta string from now to the end
+   */
+  get endString(): string;
+}
+//#endregion
+export { RawVoidTrader, VoidTrader };

package/dist/VoidTraderItem-BzeD-S6-.js

@@ -0,0 +1,38 @@
+import { languageString } from "warframe-worldstate-data/utilities";
+
+//#region lib/models/VoidTraderItem.ts
+/**
+* A void trader inventory item
+*/
+var VoidTraderItem = class {
+	uniqueName;
+	/**
+	*  The name of the inventory item
+	*/
+	item;
+	/**
+	* Ducat cost of the item
+	*/
+	ducats;
+	/**
+	* Credit cost of the item
+	*/
+	credits;
+	/**
+	* @param data              The void trader item data
+	* @param data.ItemType     Worldstate Item i18n path
+	* @param data.PrimePrice   Ducat cost of the item
+	* @param data.RegularPrice Credit price of the item
+	* @param deps              The dependencies object
+	* @param deps.locale       Locale to use for translations
+	*/
+	constructor({ ItemType, PrimePrice, RegularPrice }, { locale = "en" } = { locale: "en" }) {
+		this.uniqueName = ItemType;
+		this.item = languageString(ItemType, locale);
+		this.ducats = Number.parseInt(String(PrimePrice), 10);
+		this.credits = Number.parseInt(String(RegularPrice), 10);
+	}
+};
+
+//#endregion
+export { VoidTraderItem };

package/dist/VoidTraderItem-CkYAKAEn.d.ts

@@ -0,0 +1,43 @@
+import { Dependency } from "./Dependency-DkOHLql6.js";
+
+//#region lib/models/VoidTraderItem.d.ts
+interface RawVoidTraderItem {
+  ItemType: string;
+  PrimePrice?: number;
+  RegularPrice?: number;
+}
+/**
+ * A void trader inventory item
+ */
+declare class VoidTraderItem {
+  uniqueName: string;
+  /**
+   *  The name of the inventory item
+   */
+  item: string;
+  /**
+   * Ducat cost of the item
+   */
+  ducats: number;
+  /**
+   * Credit cost of the item
+   */
+  credits: number;
+  /**
+   * @param data              The void trader item data
+   * @param data.ItemType     Worldstate Item i18n path
+   * @param data.PrimePrice   Ducat cost of the item
+   * @param data.RegularPrice Credit price of the item
+   * @param deps              The dependencies object
+   * @param deps.locale       Locale to use for translations
+   */
+  constructor({
+    ItemType,
+    PrimePrice,
+    RegularPrice
+  }: RawVoidTraderItem, {
+    locale
+  }?: Dependency);
+}
+//#endregion
+export { RawVoidTraderItem, VoidTraderItem };

package/dist/VoidTraderSchedule-C-K8Zdfk.js

@@ -0,0 +1,14 @@
+import { languageString, parseDate } from "warframe-worldstate-data/utilities";
+
+//#region lib/models/VoidTraderSchedule.ts
+var VoidTraderSchedule = class {
+	expiry;
+	item;
+	constructor(data, { locale = "en" } = { locale: "en" }) {
+		this.expiry = parseDate(data.Expiry);
+		this.item = languageString(data.FeaturedItem, locale);
+	}
+};
+
+//#endregion
+export { VoidTraderSchedule };

package/dist/VoidTraderSchedule-DKDtu-9d.d.ts

@@ -0,0 +1,16 @@
+import { Dependency } from "./Dependency-DkOHLql6.js";
+import { ContentTimestamp } from "warframe-worldstate-data/utilities";
+
+//#region lib/models/VoidTraderSchedule.d.ts
+declare class VoidTraderSchedule {
+  expiry: Date;
+  item: string;
+  constructor(data: {
+    Expiry: ContentTimestamp;
+    FeaturedItem: string;
+  }, {
+    locale
+  }?: Dependency);
+}
+//#endregion
+export { VoidTraderSchedule };

package/dist/WeeklyChallenge-C6sc4j7i.d.ts

@@ -0,0 +1,20 @@
+import { BaseContentObject, WorldstateObject } from "./WorldstateObject-wfRTeGpm.js";
+import { ChallengeInstance, RawChallengeInstance } from "./ChallengeInstance-Bi2zg4q-.js";
+
+//#region lib/models/WeeklyChallenge.d.ts
+interface RawWeeklyChallenge extends BaseContentObject {
+  Challenges: RawChallengeInstance[];
+}
+/**
+ * Represents a void trader
+ * @augments {WorldstateObject}
+ */
+declare class WeeklyChallenge extends WorldstateObject {
+  challenges: ChallengeInstance[];
+  /**
+   * @param data The Void trader data
+   */
+  constructor(data: RawWeeklyChallenge);
+}
+//#endregion
+export { RawWeeklyChallenge, WeeklyChallenge };

package/dist/WeeklyChallenge-MzUEZAjv.js

@@ -0,0 +1,21 @@
+import { WorldstateObject } from "./WorldstateObject-BSTYuZwm.js";
+import { ChallengeInstance } from "./ChallengeInstance-DHwTTwMH.js";
+
+//#region lib/models/WeeklyChallenge.ts
+/**
+* Represents a void trader
+* @augments {WorldstateObject}
+*/
+var WeeklyChallenge = class extends WorldstateObject {
+	challenges;
+	/**
+	* @param data The Void trader data
+	*/
+	constructor(data) {
+		super(data);
+		this.challenges = data.Challenges.map((challengeData) => new ChallengeInstance(challengeData));
+	}
+};
+
+//#endregion
+export { WeeklyChallenge };

package/dist/WorldEvent-BS9QHG_f.d.ts

@@ -0,0 +1,205 @@
+import { Dependency } from "./Dependency-DkOHLql6.js";
+import { RawReward, Reward } from "./Reward-5VIpHu9A.js";
+import { BaseContentObject, Identifier, WorldstateObject } from "./WorldstateObject-wfRTeGpm.js";
+import { RawSyndicateJob, SyndicateJob } from "./SyndicateJob-DOtXWjRF.js";
+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 };