warframe-worldstate-parser 4.6.2 → 5.0.1

package/lib/models/Alert.js

@@ -1,90 +0,0 @@
-import { fromNow, timeDeltaToString } from 'warframe-worldstate-data/utilities';
-
-import mdConfig from '../supporting/MarkdownSettings.js';
-
-import WorldstateObject from './WorldstateObject.js';
-import Mission from './Mission.js';
-
-/**
- * Represents an alert
- * @augments {WorldstateObject}
- */
-export default class Alert extends WorldstateObject {
-  /**
-   * @param   {object}             data       The alert data
-   * @param   {string}             locale     Locale to use for translations
-   */
-  constructor(data, { locale = 'en' } = { locale: 'en' }) {
-    super(data);
-
-    const deps = {
-      locale,
-    };
-
-    /**
-     * The mission that the players have to complete
-     * @type {Mission}
-     */
-    this.mission = new Mission(data.MissionInfo, deps);
-
-    /**
-     * ETA string (at time of object creation)
-     * @type {string}
-     */
-    this.eta = this.getETAString();
-
-    /**
-     * An array containing the types of all of the alert's rewards
-     * @type {Array.<string>}
-     */
-    this.rewardTypes = this.getRewardTypes().length ? this.getRewardTypes() : ['credits'];
-
-    /**
-     * A tag that DE occasionally provides, such as `LotusGift`
-     * @type {string}
-     */
-    this.tag = data.Tag || undefined;
-  }
-
-  /**
-   * Get the alert's description text
-   * @returns {string} the description
-   */
-  getDescription() {
-    return this.mission.description;
-  }
-
-  /**
-   * Get the alert's reward
-   * @returns {Reward} the reward
-   */
-  getReward() {
-    return this.mission.reward;
-  }
-
-  /**
-   * Get a string indicating how much time is left before the alert expires
-   * @returns {string} the time left
-   */
-  getETAString() {
-    return timeDeltaToString(fromNow(this.expiry));
-  }
-
-  /**
-   * Get an array containing the types of all of the alert's rewards
-   * @returns {Array.<string>} an array containing the types of all of the alert's rewards
-   */
-  getRewardTypes() {
-    return this.mission.reward.getTypes();
-  }
-
-  /**
-   * The alert's string representation
-   * @returns {string} the string representation
-   */
-  toString() {
-    const lines = [this.mission.toString(), this.getETAString()];
-
-    return `${mdConfig.codeBlock}${lines.join(mdConfig.lineEnd)}${mdConfig.blockEnd}`;
-  }
-}

package/lib/models/Calendar.js

@@ -1,74 +0,0 @@
-import {
-  languageDesc,
-  languageString,
-  parseDate,
-  translateCalendarEvent,
-  translateSeason,
-} from 'warframe-worldstate-data/utilities';
-
-const EventTypes = Object.freeze({
-  PLOT: 'CET_PLOT',
-  REWARD: 'CET_REWARD',
-  CHALLENGE: 'CET_CHALLENGE',
-  UPGRADE: 'CET_UPGRADE',
-});
-
-/**
- * Event data for a 1999 calendar day
- * @param {object} event raw event data
- */
-class DayEvent {
-  constructor(event) {
-    this.type = translateCalendarEvent(event.type);
-
-    if (event.challenge) this.challenge = this.eventDescription(event.challenge);
-
-    if (event.upgrade) this.upgrade = this.eventDescription(event.upgrade);
-
-    if (event.reward) this.reward = languageString(event.reward);
-
-    if (event.type === EventTypes.PLOT) {
-      this.dialogueName = event.dialogueName;
-      this.dialogueConvo = event.dialogueConvo;
-    }
-  }
-
-  eventDescription(name) {
-    return { title: languageString(name), description: languageDesc(name) };
-  }
-}
-
-export default class Calendar {
-  constructor(calendar) {
-    this.activation = parseDate(calendar.Activation);
-
-    this.expiry = parseDate(calendar.Expiry);
-
-    this.days = Array.isArray(calendar.Days)
-      ? calendar.Days.filter(Boolean).map((d) => ({
-          ...d,
-          date: this.getDate(d.day).toISOString(),
-          events: d.events.map((e) => new DayEvent(e)),
-        }))
-      : [];
-
-    this.season = translateSeason(calendar.Season);
-
-    this.yearIteration = calendar.YearIteration;
-
-    this.version = calendar.Version;
-
-    this.requirements = calendar.UpgradeAvaliabilityRequirements;
-  }
-
-  /**
-   * Converts number of day to a date in 1999 in UTC
-   * @param {number} day number of the day in a year
-   * @returns {Date} the date in 1999
-   */
-  getDate(day) {
-    const date = new Date(Date.UTC(1999));
-    date.setUTCDate(date.getUTCDate() + day - 1);
-    return date;
-  }
-}

package/lib/models/CambionCycle.js

@@ -1,32 +0,0 @@
-import { fromNow } from 'warframe-worldstate-data/utilities';
-
-import WorldstateObject from './WorldstateObject.js';
-
-/**
- * Represents the current Cambion Drift Fass/Vome Cycle
- * @augments {WorldstateObject}
- * @property {string} timeLeft time rendering of amount of time left
- */
-export default class CambionCycle extends WorldstateObject {
-  /**
-   * @param   {CetusCycle}        cetusCycle Match data from cetus cycle for data
-   */
-  constructor(cetusCycle) {
-    super({ _id: { $oid: 'cambionCycle0' } });
-
-    ({ activation: this.activation, expiry: this.expiry, timeLeft: this.timeLeft } = cetusCycle);
-
-    this.state = cetusCycle.isDay ? 'fass' : 'vome';
-    this.active = this.state;
-
-    this.id = `cambionCycle${this.expiry.getTime()}`;
-  }
-
-  /**
-   * Get whether the event has expired
-   * @returns {boolean} whether the event has expired
-   */
-  getExpired() {
-    return fromNow(this.expiry) < 0;
-  }
-}

package/lib/models/CetusCycle.js

@@ -1,126 +0,0 @@
-import { fromNow, timeDeltaToString } from 'warframe-worldstate-data/utilities';
-
-import mdConfig from '../supporting/MarkdownSettings.js';
-
-import WorldstateObject from './WorldstateObject.js';
-
-const nightTime = 3000;
-
-const maximums = {
-  day: 6000000,
-  night: 3000000,
-};
-
-/**
- * Represents the current Earth Day/Night Cycle
- * @augments {WorldstateObject}
- */
-export default class CetusCycle extends WorldstateObject {
-  /**
-   * The end of the Ostron bounties timer (marks the end of night)
-   * @type {Date}
-   * @private
-   */
-  #bountiesEndDate;
-  /**
-   * The current cetus cycle, for calculating the other fields
-   * @type {object}
-   * @private
-   */
-  #ec;
-
-  /**
-   * @param   {Date}              bountiesEndDate The end date for Ostron bounties
-   */
-  constructor(bountiesEndDate) {
-    super({ _id: { $oid: 'cetusCycle0' } });
-
-    this.#bountiesEndDate = bountiesEndDate;
-    this.#ec = this.getCurrentCetusCycle();
-
-    /**
-     * The date and time at which the event ends
-     * @type {Date}
-     */
-    this.expiry = this.#ec.expiry;
-
-    /**
-     * The date and time at which the event started
-     * @type {Date}
-     */
-    this.activation = new Date(this.#ec.start);
-
-    /**
-     * Whether it's daytime
-     * @type {boolean}
-     */
-    this.isDay = this.#ec.dayTime;
-
-    /**
-     * Current cycle state. One of `day`, `night`
-     * @type {string}
-     */
-    this.state = this.#ec.state;
-
-    /**
-     * Time remaining string
-     * @type {string}
-     */
-    this.timeLeft = this.#ec.timeLeft;
-
-    /**
-     * Whether this is for Cetus Cycle
-     * @type {boolean}
-     */
-    this.isCetus = true;
-
-    this.id = `cetusCycle${this.expiry.getTime()}`;
-
-    this.shortString = `${this.timeLeft.replace(/\s\d*s/gi, '')} to ${this.isDay ? 'Night' : 'Day'}`;
-  }
-
-  /**
-   * Get whether or not the event has expired
-   * @returns {boolean} whether the event has expired
-   */
-  getExpired() {
-    return fromNow(this.expiry) < 0;
-  }
-
-  getCurrentCetusCycle() {
-    const now = Date.now();
-    const bountiesClone = this.#bountiesEndDate;
-    bountiesClone.setSeconds(0);
-    let millisLeft = fromNow(bountiesClone);
-    const secondsToNightEnd = (millisLeft / 1000).toFixed(0);
-    const dayTime = secondsToNightEnd > nightTime;
-
-    const secondsRemainingInCycle = dayTime ? secondsToNightEnd - nightTime : secondsToNightEnd;
-    millisLeft = secondsRemainingInCycle * 1000;
-    const minutesCoef = 1000 * 60;
-    const expiry = new Date(Math.round((now + millisLeft) / minutesCoef) * minutesCoef);
-    const state = dayTime ? 'day' : 'night';
-
-    return {
-      dayTime,
-      timeLeft: timeDeltaToString(millisLeft),
-      expiry,
-      expiresIn: millisLeft,
-      state,
-      start: expiry.getTime() - maximums[state],
-    };
-  }
-
-  /**
-   * The event's string representation
-   * @returns {string} The string representation of the event
-   */
-  toString() {
-    const lines = [
-      `Operator, Cetus is currently in ${this.state}time`,
-      `Time remaining until ${this.isDay ? 'night' : 'day'}: ${this.timeLeft}`,
-    ];
-
-    return lines.join(mdConfig.lineEnd);
-  }
-}

package/lib/models/ChallengeInstance.js

@@ -1,57 +0,0 @@
-import { languageString } from 'warframe-worldstate-data/utilities';
-
-/**
- * Describes a world challenge instance
- */
-export default class ChallengeInstance {
-  /**
-   * @param   {object}             data            The challenge instance data
-   * @param   {Dependency}         deps            The dependencies object
-   * @param   {string}             deps.locale     Locale to use for translations
-   */
-  constructor(data, { locale = 'en' } = { locale: 'en' }) {
-    /**
-     * Type of challenge
-     * @type {string}
-     */
-    this.type = languageString(data.Type, locale);
-
-    /**
-     * Minimum enemy level to fulfill challenge
-     * @type {number}
-     */
-    this.minEnemyLevel = Number(data.MinimumEnemyLevel);
-
-    /**
-     * Required number of units to complete challenge
-     * @type {number}
-     */
-    this.requiredAmount = Number(data.RequiredCount);
-
-    /**
-     * Waypoint for amount of units between progression updates
-     * @type {number}
-     */
-    this.progressAmount = Number(data.ProgressIndicatorFreq);
-
-    /**
-     * Required damage type
-     * @type {string | undefined}
-     */
-    this.damageType = data.DamageType ? languageString(data.DamageType, locale) : undefined;
-
-    /**
-     * Target to fulfill challenge
-     * @type {string}
-     */
-    this.target =
-      data.VictimType && data.VictimType[0]
-        ? languageString(data.VictimType[0], locale)
-        : // eslint-disable-next-line no-underscore-dangle
-          data.Script._faction;
-  }
-
-  toString() {
-    return `Task: ${this.type}\nAmount: ${this.requiredAmount}\nTarget: ${this.target}`;
-  }
-}

package/lib/models/ConclaveChallenge.js

@@ -1,154 +0,0 @@
-import {
-  parseDate,
-  fromNow,
-  timeDeltaToString,
-  conclaveMode,
-  conclaveCategory,
-  conclaveChallenge,
-} from 'warframe-worldstate-data/utilities';
-
-import WorldstateObject from './WorldstateObject.js';
-
-/**
- * Represents a Conclave challenge
- * @augments {WorldstateObject}
- */
-export default class ConclaveChallenge extends WorldstateObject {
-  /**
-   * @param   {object}             data            The challenge data
-   * @param   {object}             deps            The dependencies object
-   * @param   {string}             deps.locale     Locale to use for translations
-   */
-  constructor(data, { locale = 'en' } = { locale: 'en' }) {
-    super(data);
-
-    /**
-     * The time and date at which the challenge expires
-     * @type {Date}
-     */
-    this.expiry = parseDate(data.endDate);
-
-    /**
-     * The time and date at which the challenge starts
-     * @type {Date}
-     */
-    this.activation = parseDate(data.startDate);
-
-    /**
-     * The number of times that the challenge's objective needs to be completed
-     * @type {number}
-     */
-    this.amount = data.params[0].v;
-
-    /**
-     * The PVP mode that the challenge must be completed in
-     * @type {string}
-     */
-    this.mode = conclaveMode(data.PVPMode, locale);
-
-    /**
-     * The challenge's category (daily, weekly...)
-     * @type {string}
-     */
-    this.category = conclaveCategory(data.Category, locale);
-
-    /**
-     * ETA string (at time of object creation)
-     * @type {string}
-     */
-    this.eta = this.getEndString();
-
-    /**
-     * Whether or not this is expired (at time of object creation)
-     * @type {boolean}
-     */
-    this.expired = this.isExpired();
-
-    /**
-     * Whether or not this is a daily conclave challenge.
-     * @type {boolean}
-     */
-    this.daily = this.isDaily();
-
-    /**
-     * Whether or not this is the root challenge
-     * @type {boolean}
-     */
-    this.rootChallenge = this.isRootChallenge();
-
-    /**
-     * the end string
-     * @type {string}
-     */
-    this.endString = this.getEndString();
-
-    /**
-     * The challenge's description text
-     * @type {string}
-     */
-    this.description = undefined;
-
-    /**
-     * Title of the challenge
-     * @type {string}
-     */
-    this.title = undefined;
-
-    /**
-     * Standing granted by completing challenge.
-     * @type {number}
-     */
-    this.standing = undefined;
-
-    const challenge = conclaveChallenge(data.challengeTypeRefID, locale);
-
-    ({ title: this.title, description: this.description, standing: this.standing } = challenge);
-
-    /**
-     * This challenge as a string
-     * @type {string}
-     */
-    this.asString = this.toString();
-  }
-
-  /**
-   * Get whether or not the challenge is daily
-   * @returns {boolean} whether the category is daily
-   */
-  isDaily() {
-    return this.category.toLowerCase() === 'day';
-  }
-
-  /**
-   * Get whether or not this is the weekly root challenge
-   * @returns {boolean} whether this is the root challenge
-   */
-  isRootChallenge() {
-    return this.category.toLowerCase() === 'week_root';
-  }
-
-  /**
-   * Get whether or not the challenge has expired
-   * @returns {boolean} Whether or not the challenge has expired
-   */
-  isExpired() {
-    return fromNow(this.expiry) < 0;
-  }
-
-  /**
-   * Get a string indicating how much time is left before the challenge expires
-   * @returns {string} The time left before the challenge expires
-   */
-  getEndString() {
-    const timeDelta = fromNow(this.expiry);
-    return timeDeltaToString(timeDelta);
-  }
-
-  /**
-   * The conclave challenge's string representation
-   * @returns {string} The string representation of the conclave challenge
-   */
-  toString() {
-    return `${this.description} on ${this.mode} ${this.amount} times in a ${this.category}`;
-  }
-}

package/lib/models/ConstructionProgress.js

@@ -1,31 +0,0 @@
-import mdConfig from '../supporting/MarkdownSettings.js';
-
-import WorldstateObject from './WorldstateObject.js';
-
-/**
- * Represents enemy construction progress
- * @augments {WorldstateObject}
- */
-export default class ConstructionProgress extends WorldstateObject {
-  /**
-   * @param   {object}             data            The construction data
-   */
-  constructor(data) {
-    super(data);
-
-    this.fomorianProgress = (data.ProjectPct[0] || 0.0).toFixed(2);
-    this.razorbackProgress = (data.ProjectPct[1] || 0.0).toFixed(2);
-    this.unknownProgress = (data.ProjectPct[2] || 0.0).toFixed(2);
-  }
-
-  /**
-   * The alert's string representation
-   * @returns {string} string representation
-   */
-  toString() {
-    return (
-      `${mdConfig.codeBlock}Fomorian: ${this.fomorianProgress}%${mdConfig.lineEnd}Razorback: ` +
-      `${this.razorbackProgress}%${mdConfig.lineEnd}Unknown: ${this.unknownProgress}%${mdConfig.blockEnd}`
-    );
-  }
-}

package/lib/models/DailyDeal.js

@@ -1,103 +0,0 @@
-import { parseDate, timeDeltaToString, fromNow, languageString } from 'warframe-worldstate-data/utilities';
-
-import mdConfig from '../supporting/MarkdownSettings.js';
-
-/**
- * Represents a daily deal
- */
-export default class DailyDeal {
-  /**
-   * @param   {object}            data            The deal data
-   * @param   {object}            deps            The dependencies object
-   * @param   {string}            deps.locale     Locale to use for translations
-   */
-  constructor(data, { locale = 'en' } = { locale: 'en' }) {
-    /**
-     * The item that is being offered in the sale
-     * @type {string}
-     */
-    this.item = languageString(data.StoreItem, locale);
-
-    /**
-     * The uniqueName for the item on sale.
-     * @type {string}
-     */
-    this.uniqueName = data.StoreItem;
-
-    /**
-     * The date and time at which the deal will expire
-     * @type {Date}
-     */
-    this.expiry = parseDate(data.Expiry);
-
-    /**
-     * The date and time at which the deal will or did start
-     * @type {Date}
-     */
-    this.activation = parseDate(data.Activation);
-
-    /**
-     * The item's original price
-     * @type {number}
-     */
-    this.originalPrice = data.OriginalPrice;
-
-    /**
-     * The item's discounted price
-     * @type {number}
-     */
-    this.salePrice = data.SalePrice;
-
-    /**
-     * The number of available items on sale
-     * @type {number}
-     */
-    this.total = data.AmountTotal;
-
-    /**
-     * The number of items that have already been sold
-     * @type {number}
-     */
-    this.sold = data.AmountSold;
-
-    /**
-     * Unique identifier for this deal built from the end time and item
-     * @type {string}
-     */
-    this.id = `${data.StoreItem.split('/').slice(-1)[0]}${this.expiry.getTime()}`;
-
-    /**
-     * ETA string (at time of object creation)
-     * @type {string}
-     */
-    this.eta = this.getETAString();
-
-    /**
-     * Percent discount
-     * @type {number}
-     */
-    this.discount = data.Discount;
-  }
-
-  /**
-   * Get a string indicating how much time is left before the deal expires
-   * @returns {string} estimated time remaining on the deal
-   */
-  getETAString() {
-    return timeDeltaToString(fromNow(this.expiry));
-  }
-
-  /**
-   * Returns a string representation of the daily deal
-   * @returns {string} The string representation of the daily deal
-   */
-  toString() {
-    const lines = [
-      `Daily Deal: ${this.item}`,
-      `${this.salePrice}p (original ${this.originalPrice}p)`,
-      `${this.sold} / ${this.total} sold`,
-      `Expires in ${this.getETAString()}`,
-    ];
-    return lines.join(mdConfig.lineEnd);
-  }
-}