warframe-worldstate-parser/lib/models/Nightwave.js

An Open parser for Warframe's Worldstate in Javascript

import { fromNow, timeDeltaToString, languageString } from 'warframe-worldstate-data/utilities';

import mdConfig from '../supporting/MarkdownSettings.js';

import WorldstateObject from './WorldstateObject.js';
import NightwaveChallenge from './NightwaveChallenge.js';

/**
 * Represents an alert
 * @augments {WorldstateObject}
 */
export default class Nightwave extends WorldstateObject {
  /**
   * @param   {object}             data            The alert data
   * @param   {object}             deps            The dependencies object
   * @param   {string}             deps.locale     Locale to use for translations
   */
  constructor(data, { locale = 'en' } = { locale: 'en' }) {
    super(data);

    this.id = `nightwave${new Date(this.expiry).getTime()}`;

    const deps = {
      locale,
    };

    /**
     * The current season. 0-indexed.
     * @type {number}
     */
    this.season = data.Season;

    /**
     * Descriptor for affiliation
     * @type {string}
     */
    this.tag = languageString(data.AffiliationTag, locale);

    /**
     * The current season's current phase. 0-indexed.
     * @type {number}
     */
    this.phase = data.Phase;

    /**
     * Misc params provided.
     * @type {object}
     */
    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);

    /**
     * An array containing the types of all of the alert's rewards
     * @type {Array.<string>}
     */
    this.rewardTypes = this.getRewardTypes().length ? this.getRewardTypes() : ['credits'];
  }

  /**
   * Get a string indicating how much time is left before the alert expires
   * @returns {string} estimated timer of the alert
   */
  getETAString() {
    return timeDeltaToString(fromNow(this.expiry));
  }

  /**
   * Get an array containing the types of all of the nightwave season's rewards
   * @returns {Array.<string>} an array containing the types of all of the nightwave season's rewards
   */
  getRewardTypes() {
    return [];
  }

  /**
   * The alert's string representation
   * @returns {string} string representation of the alert
   */
  toString() {
    return `${mdConfig.codeBlock}Nightwave Season ${this.season + 1} - ${this.tag} - Phase ${this.phase + 1}${
      mdConfig.blockEnd
    }`;
  }
}