warframe-worldstate-parser 4.6.1 → 5.0.1

package/lib/models/News.js

@@ -1,174 +0,0 @@
-import { fromNow, parseDate, timeDeltaToString, toNow, languageString } from 'warframe-worldstate-data/utilities';
-
-import { cdn, deProxy } from '../supporting/ImgCdn.js';
-import mdConfig from '../supporting/MarkdownSettings.js';
-
-import WorldstateObject from './WorldstateObject.js';
-
-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}
- */
-export default class News extends WorldstateObject {
-  /**
-   * @param   {object}             data            The news data
-   * @param   {string}             locale     Locale to use for determining language
-   */
-  constructor(data, { locale = 'en' } = { locale: 'en' }) {
-    super(data);
-
-    /**
-     * The news message
-     * @type {string}
-     */
-    this.message = (data.Messages.find((msg) => msg.LanguageCode === locale) || { Message: '' }).Message;
-    if (langString.test(this.message)) {
-      this.message = languageString(this.message, locale);
-    }
-
-    /**
-     * The link to the forum post
-     * @type {string}
-     */
-    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;
-    }
-
-    /**
-     * The news's image link
-     * @type {string}
-     */
-    this.imageLink = data.ImageUrl ? deProxy(data.ImageUrl) : cdn('img/news-placeholder.png');
-
-    /**
-     * Whether this has priority over other news or not
-     * @type {boolean}
-     */
-    this.priority = data.Priority;
-
-    /**
-     * The date at which the post was published
-     * @type {Date}
-     */
-    this.date = parseDate(data.Date);
-
-    /**
-     * The date at which the event starts
-     * @type {?Date}
-     */
-    this.startDate = data.EventStartDate ? parseDate(data.EventStartDate) : undefined;
-
-    /**
-     * The date at which the event ends
-     * @type {?Date}
-     */
-    this.endDate = data.EventEndDate ? parseDate(data.EventEndDate) : undefined;
-
-    /**
-     * ETA string (at time of object creation)
-     * @type {string}
-     */
-    this.eta = this.getETAString();
-
-    /**
-     * Whether this is an update news item
-     * @type {boolean}
-     */
-    this.update = this.isUpdate();
-
-    /**
-     * Whether this is a prime access news item
-     * @type {boolean}
-     */
-    this.primeAccess = this.isPrimeAccess();
-
-    /**
-     * Whether or not this is a stream
-     * @type {boolean}
-     */
-    this.stream = this.isStream();
-
-    /**
-     * Translation of the news item
-     * @type {Record<string, string>}
-     */
-    this.translations = {};
-    data.Messages.forEach((message) => {
-      this.translations[message.LanguageCode ?? 'en'] = message.Message;
-
-      if (langString.test(message.Message)) {
-        this.translations[message.LanguageCode] = languageString(message.Message, message.LanguageCode);
-      }
-    });
-
-    /**
-     * The string representation of this object at creation
-     * @type {string}
-     */
-    this.asString = this.toString();
-  }
-
-  /**
-   * Get a string indicating how long it will take for the event to start or
-   * how long it's been since the news went up
-   * @returns {string} the estimated time of arrival for the event
-   */
-  getETAString() {
-    if (this.endDate) {
-      const timeDelta = fromNow(this.endDate);
-      return `in ${timeDeltaToString(timeDelta)}`;
-    }
-    const timeDelta = toNow(this.date);
-    return `${timeDeltaToString(timeDelta)} ago`;
-  }
-
-  /**
-   * Whether or not this is about a game update
-   * @returns {boolean} whether the news is about an update
-   */
-  isUpdate() {
-    return updateReg.test(this.link);
-  }
-
-  /**
-   * Whether this is about a new Prime Access
-   * @returns {boolean} whether the news is about a new Prime Access
-   */
-  isPrimeAccess() {
-    return primeAccessReg.test(this.link);
-  }
-
-  /**
-   * Whether this is about a new stream
-   * @returns {boolean} whether the news is for a stream
-   */
-  isStream() {
-    return streamReg.test(this.message);
-  }
-
-  /**
-   * String representation
-   * @returns {string} string representation
-   */
-  toString() {
-    return (
-      `[${this.getETAString()}] ${mdConfig.linkBegin}${this.message}` +
-      `${mdConfig.linkMid}${this.link}${mdConfig.linkEnd}`
-    );
-  }
-
-  /**
-   * 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;
-  }
-}

package/lib/models/Nightwave.js

@@ -1,91 +0,0 @@
-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
-    }`;
-  }
-}

package/lib/models/NightwaveChallenge.js

@@ -1,63 +0,0 @@
-import { languageDesc, languageString } from 'warframe-worldstate-data/utilities';
-
-import WorldstateObject from './WorldstateObject.js';
-
-const repBase = 1000;
-
-/**
- * Represents an alert
- * @augments {WorldstateObject}
- */
-export default class NightwaveChallenge 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);
-
-    /**
-     * Whether or not this is a daily challenge
-     * @type {boolean}
-     */
-    this.isDaily = data.Daily || false;
-
-    /**
-     * Whether or not the challenge is an elite challenge
-     * @type {boolean}
-     */
-    this.isElite = /hard/gi.test(data.Challenge);
-
-    /**
-     * The descriptor for this challenge
-     * @type {string}
-     */
-    this.desc = languageDesc(data.Challenge, locale);
-
-    /**
-     * The title for this challenge
-     * @type {string}
-     */
-    this.title = languageString(data.Challenge, locale);
-
-    /**
-     * Generated id from expiry, challenge string,
-     *  and whether or not it has `[PH]` (designating placeholder text)
-     * @type {string}
-     */
-    this.id = `${this.expiry.getTime()}${data.Challenge.split('/').slice(-1)[0].toLowerCase()}`;
-
-    /**
-     * Reputation reward for ranking up in the Nightwave
-     * @type {number}
-     */
-    this.reputation = repBase + (!this.isDaily ? 3500 : 0) + (this.isElite ? 2500 : 0);
-
-    /**
-     * Whether this challenge is permanent
-     * @type {boolean}
-     */
-    this.isPermanent = Boolean(data?.Permanent);
-  }
-}

package/lib/models/PersistentEnemy.js

@@ -1,100 +0,0 @@
-import { parseDate, languageString, node, region } from 'warframe-worldstate-data/utilities';
-
-import mdConfig from '../supporting/MarkdownSettings.js';
-
-import WorldstateObject from './WorldstateObject.js';
-
-/**
- * Represents a persistent enemy
- * @augments {WorldstateObject}
- */
-export default class PersistentEnemy extends WorldstateObject {
-  /**
-   * @param   {object}             data            The persistent enemy 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 enemy's type
-     * @type {string}
-     */
-    this.agentType = languageString(data.AgentType, locale);
-
-    /**
-     * The location tag
-     * @type {string}
-     */
-    this.locationTag = languageString(data.LocTag, locale);
-
-    /**
-     * The enemy's rank
-     * @type {number}
-     */
-    this.rank = data.Rank;
-
-    /**
-     * The enemy's remaining health percentage
-     * @type {number}
-     */
-    this.healthPercent = Number.parseFloat(data.HealthPercent);
-
-    /**
-     * The percentual damage that the enemy takes when it's defeated
-     * @type {number}
-     */
-    this.fleeDamage = data.FleeDamage;
-
-    /**
-     * The region where the enemy is located
-     * @type {string}
-     */
-    this.region = region(data.Region, locale);
-
-    /**
-     * The last time the enemy was discovered
-     * @type {Date}
-     */
-    this.lastDiscoveredTime = parseDate(data.LastDiscoveredTime);
-
-    /**
-     * The node at which the enemy was last discovered
-     * @type {string}
-     */
-    this.lastDiscoveredAt = node(data.LastDiscoveredLocation, locale);
-
-    /**
-     * Whether or not the enemy is currently available
-     * @type {boolean}
-     */
-    this.isDiscovered = data.Discovered;
-
-    /**
-     * Whether or not the enemy is using ticketing
-     * @type {boolean}
-     */
-    this.isUsingTicketing = data.UseTicketing;
-
-    /**
-     * Fake ID incorporating discovery
-     * @type {string}
-     */
-    this.pid = `${this.id}${this.isDiscovered}`;
-  }
-
-  /**
-   * Returns a string representation of the persistent enemy
-   * @returns {string} string representation
-   */
-  toString() {
-    const status = this.isDiscovered ? 'discovered' : 'not discovered';
-    const lines = [
-      `${this.agentType} last discovered at ${this.lastDiscoveredAt}.`,
-      `It has ${this.healthPercent}% health remaining and is currently ${status}`,
-    ];
-
-    return lines.join(mdConfig.lineEnd);
-  }
-}

package/lib/models/Reward.js

@@ -1,111 +0,0 @@
-import { languageString, insist } from 'warframe-worldstate-data/utilities';
-
-import rewardTypes from '../supporting/RewardTypes.js';
-
-/**
- * An object describing a type of reward, including name, description,
- * test function to verify type from a string, thumbnail url, and color
- * @typedef {object} RewardType
- * @property {string} name          - Name of the reward type
- * @property {string} description   - Description of the reward type
- * @property {string} test          - Function for testing the return type against a string
- * @property {string} thumbnail     - Thumbnail url for this reward type
- * @property {string} color         - Summary color representing this reward type
- */
-
-/**
- * Returns the type of a given item
- * @param   {string}          item The item whose type needs to be determined
- * @param   {Array.<RewardType>}  [types] The possible types
- * @returns {string}          The type name
- */
-export function getItemType(item, types = rewardTypes) {
-  return types.find((t) => t.test(item)).name;
-}
-
-/**
- * Returns the full type of a given item
- * @param   {string}          item The item whose type needs to be determined
- * @param   {Array.<RewardType>}  [types] The possible types
- * @returns {RewardType}      The type
- */
-export function getItemTypeFull(item, types = rewardTypes) {
-  return types.find((t) => t.test(item));
-}
-
-/**
- * Represents a mission reward
- */
-export default class Reward {
-  /**
-   * @param   {object} data        The mission data
-   * @param   {Dependency}         deps            The dependencies object
-   * @param   {string}             deps.locale     Locale to use for translations
-   */
-  constructor(data, { locale = 'en' } = { locale: 'en' }) {
-    insist(data);
-    /**
-     * The items being rewarded
-     * @type {Array.<string>}
-     */
-    this.items = data.items ? data.items.map((i) => languageString(i), locale) : [];
-
-    /**
-     * The counted items being rewarded
-     * @type {Array.<object>}
-     */
-    this.countedItems = data.countedItems
-      ? data.countedItems.map((i) => ({
-          count: i.ItemCount,
-          type: languageString(i.ItemType, locale),
-          key: languageString(i.ItemType),
-        }))
-      : [];
-
-    /**
-     * The credits being rewarded
-     * @type {number}
-     */
-    this.credits = data.credits || 0;
-
-    this.asString = this.toString();
-
-    this.itemString = this.items
-      .concat(this.countedItems.map((i) => `${i.count > 1 ? i.count : ''} ${i.type}`.trim()))
-      .join(' + ');
-
-    this.thumbnail = this.getTypesFull()[0] ? this.getTypesFull()[0].thumbnail : 'https://i.imgur.com/JCKyUXJ.png';
-
-    this.color = this.getTypesFull()[0] ? this.getTypesFull()[0].color : 0xf1c40f;
-  }
-
-  /**
-   * The types of all items that are being rewarded
-   * @returns {Array.<string>} types as array of string
-   */
-  getTypes() {
-    return this.items.concat(this.countedItems.map((i) => i.key)).map((t) => getItemType(t));
-  }
-
-  /**
-   * The types of all the items that are being rewarded
-   * @returns {Array.<RewardType>} array of reward types
-   */
-  getTypesFull() {
-    return this.items.concat(this.countedItems.map((i) => i.key)).map((t) => getItemTypeFull(t));
-  }
-
-  /**
-   * The reward's string representation
-   * @returns {string} reward's string representation
-   */
-  toString() {
-    const tokens = this.items.concat(this.countedItems.map((i) => `${i.count > 1 ? i.count : ''} ${i.type}`.trim()));
-
-    if (this.credits) {
-      tokens.push(`${this.credits}cr`);
-    }
-
-    return tokens.join(' + ');
-  }
-}

package/lib/models/SentientOutpost.js

@@ -1,68 +0,0 @@
-import { node, nodeEnemy, nodeMissionType } from 'warframe-worldstate-data/utilities';
-
-const duration = 1800;
-
-const sat = () => {
-  const now = Math.floor(Date.now() / 1000);
-  // One cycle = 3 hours
-  const cycleSeconds = now % duration;
-  // active range is after 30m and lasts for 30m
-  const active = cycleSeconds > 0 && cycleSeconds < 1800;
-  const start = (now - cycleSeconds) * 1000;
-  const end = (now - cycleSeconds + duration) * 1000;
-
-  return {
-    active,
-    expiry: new Date(end),
-    activation: new Date(start),
-  };
-};
-
-/**
- * Mission typeDef
- * @typedef {object} Mission
- * @property {string} node Mission node name
- * @property {string} enemy Node enemy
- * @property {string} type Mission type of the node
- */
-
-/**
- * Represents a set of sentient outposts that are present
- * Parsed source is combined data from DE's worldstate and semlar.com/anomaly.json
- * @property {Mission} mission    List of current missions
- * @property {string}  id         Identifier for the mission node with active indicator
- * @property {boolean} active     Whether or not the mission is active
- * @property {Date}    activation When the mission became or becomes active
- * @property {Date}    expiry     When the mission became or becomes inactive
- * @property {object}  previous   Estimation data for the last mission that was active.
- *                                Could also be the current.
- * @property {Date}    previous.activation  When the mission became or becomes active
- * @property {Date}    previous.expiry     When the mission became or becomes inactive
- */
-export default class SentientOutpost {
-  #node;
-  constructor(sfn, { locale, sentientData, logger }) {
-    this.#node = sfn || '000';
-    const id = `CrewBattleNode${this.#node}`;
-    /* istanbul ignore if */
-    if (this.#node === '000') {
-      this.mission = undefined;
-    } else {
-      this.mission = {
-        node: node(id, locale),
-        faction: nodeEnemy(id, locale),
-        type: nodeMissionType(id, locale),
-      };
-    }
-    ({ activation: this.activation, expiry: this.expiry } = sat());
-    this.active = Boolean(this.mission);
-    this.id = `${id}:${this.active}`;
-
-    if (!sentientData) {
-      logger.debug('No outpost data, skipping');
-    } else {
-      this.activation = new Date(sentientData.start * 1000);
-      this.expiry = new Date(sentientData.end * 1000);
-    }
-  }
-}

package/lib/models/Simaris.js

@@ -1,47 +0,0 @@
-import { languageString } from 'warframe-worldstate-data/utilities';
-
-/**
- * Contains information about sanctuary targets
- */
-export default class Simaris {
-  /**
-   * @param   {object}             data            The sanctuary data
-   * @param   {object}             deps            The dependencies object
-   * @param   {string}             deps.locale     Locale to use for translations
-   */
-  constructor(data, { locale = 'en' } = { locale: 'en' }) {
-    if (!data || !Object.keys(data).length) {
-      // eslint-disable-next-line no-param-reassign
-      data = {};
-    }
-
-    /**
-     * The sanctuary target
-     * @type {string}
-     */
-    this.target = languageString(data.LastCompletedTargetType, locale) || 'N/A';
-
-    /**
-     * Whether or not the target is currently active
-     * @type {boolean}
-     */
-    this.isTargetActive = !data.LastCompletedTargetType;
-
-    /**
-     * A string representation of the current sanctuary status
-     * @type {string}
-     */
-    this.asString = this.toString();
-  }
-
-  /**
-   * Returns a string representation of the current sanctuary status
-   * @returns {string} a string representation of the current sanctuary status
-   */
-  toString() {
-    return (
-      `Simaris's ${this.isTargetActive ? 'current' : 'previous'} objective ` +
-      `${this.isTargetActive ? 'is' : 'was'} ${this.target}`
-    );
-  }
-}