warframe-worldstate-parser 4.6.1 → 5.0.1

package/lib/models/DarkSector.js

@@ -1,154 +0,0 @@
-import { parseDate, languageString } from 'warframe-worldstate-data/utilities';
-
-import WorldstateObject from './WorldstateObject.js';
-import Mission from './Mission.js';
-import DarkSectorBattle from './DarkSectorBattle.js';
-
-/**
- * Represents a dark sector
- * @augments {WorldstateObject}
- */
-export default class DarkSector extends WorldstateObject {
-  /**
-   * @param   {object}             data                  The dark sector data
-   * @param   {object}             deps                  The dependencies object
-   * @param   {string}             deps.locale           Locale to use for translations
-   */
-  constructor(data, { locale = 'en' } = { locale: 'en' }) {
-    super(data);
-
-    const deps = {
-      locale,
-    };
-
-    /**
-     * The dark sector credit tax rate
-     * @type {number}
-     */
-    this.creditTaxRate = data.DefenderInfo.CreditsTaxRate;
-
-    /**
-     * The dark sector credit tax rate for clan/alliance members
-     * @type {number}
-     */
-    this.memberCreditsTaxRate = data.DefenderInfo.MemberCreditsTax;
-
-    /**
-     * The dark sector resource tax rate
-     * @type {number}
-     */
-    this.itemsTaxRate = data.DefenderInfo.ItemsTaxRate;
-
-    /**
-     * The dark sector resource tax rate for clan/alliance members
-     * @type {number}
-     */
-    this.memberItemsTaxRate = data.DefenderInfo.MemberItemsTaxRate;
-
-    /**
-     * Whether the dark sector holder is an alliance or not
-     * @type {boolean}
-     */
-    this.isAlliance = data.DefenderInfo.IsAlliance;
-
-    /**
-     * The current holder of the dark sector
-     * @type {string}
-     */
-    this.defenderName = data.DefenderInfo.Name;
-
-    /**
-     * The remaining health of the current solar rail
-     * @type {number}
-     */
-    this.defenderPoolRemaining = Number.parseFloat(data.DefenderInfo.StrengthRemaining);
-
-    /**
-     * The maximum health of the solar rail
-     * @type {number}
-     */
-    this.defenderMaxPool = Number.parseFloat(data.DefenderInfo.MaxStrength);
-
-    /**
-     * The date and time at which the rail was deployed
-     * @type {Date}
-     */
-    this.defenderDeployemntActivation = data.DefenderInfo.DeploymentActivationTime
-      ? parseDate(data.DefenderInfo.DeploymentActivationTime)
-      : 0;
-
-    /**
-     * The solar rail type
-     * @type {string}
-     */
-    this.railType = languageString(data.DefenderInfo.RailType, locale);
-
-    /**
-     * The MOTD set by the dark sector holder
-     * @type {string}
-     */
-    this.defenderMOTD = data.DefenderInfo.MOTD;
-
-    /**
-     * The player who deployed the solar rail
-     * @type {string}
-     */
-    this.deployerName = data.DefenderInfo.DeployerName;
-
-    /**
-     * The clan of the player who deployed the solar rail
-     * @type {string}
-     */
-    this.deployerClan = data.DefenderInfo.DeployerClan;
-
-    this.defenderRailHealReserve = data.DefenderInfo.RailHealReserve;
-
-    this.healRate = Number.parseFloat(data.DefenderInfo.healRate);
-
-    this.damagePerMission = data.DefenderInfo.DamagePerMission;
-
-    /**
-     * The dark sector's mission
-     * @type {?Mission}
-     */
-    this.mission = data.DefenderInfo.MissionInfo ? new Mission(data.DefenderInfo.MissionInfo, deps) : undefined;
-
-    this.battlePayReserve = data.DefenderInfo.BattlePayReserve;
-
-    /**
-     * The battle pay per mission offered to players
-     * @type {number}
-     */
-    this.perMissionBattlePay = data.DefenderInfo.MissionBattlePay;
-
-    /**
-     * The player who set the battle pay
-     * @type {string}
-     */
-    this.battlePaySetBy = data.DefenderInfo.BattlePaySetBy;
-
-    /**
-     * The clan of the player who set the battle pay
-     * @type {string}
-     */
-    this.battlePaySetByClan = data.DefenderInfo.BattlePaySetByClan;
-
-    /**
-     * The player who changed the tax
-     * @type {string}
-     */
-    this.taxChangedBy = data.DefenderInfo.TaxLastChangedBy;
-
-    /**
-     * The clan of the player who set the tax
-     * @type {string}
-     */
-    this.taxChangedByClan = data.DefenderInfo.TaxLastChangedByClan;
-
-    /**
-     * The history of the dark sector
-     * @type {Array.<DarkSectorBattle>}
-     */
-    this.history = data.History ? data.History.map((b) => new DarkSectorBattle(b, deps)) : [];
-  }
-}

package/lib/models/DarkSectorBattle.js

@@ -1,56 +0,0 @@
-import { parseDate } from 'warframe-worldstate-data/utilities';
-
-/**
- * Represents a battle over a dark sector
- */
-export default class DarkSectorBattle {
-  /**
-   * @param   {object} data The battle data
-   */
-  constructor(data) {
-    /**
-     * The defenders of the dark sector
-     * @type {string}
-     */
-    this.defender = data.Def;
-
-    /**
-     * Whether the defenders are an alliance or not
-     * @type {boolean}
-     */
-    this.defenderIsAlliance = data.DefAli;
-
-    /**
-     * The attackers of the dark sector
-     * @type {string}
-     */
-    this.attacker = data.Att;
-
-    /**
-     * Whether the attackers are an alliance or not
-     * @type {boolean}
-     */
-    this.attackerIsAlliance = data.AttAli;
-
-    const defId = data.DefId.$oid || data.DefId.$id;
-    const winId = data.WinId.$oid || data.WinId.$id;
-
-    /**
-     * The winner of the battle
-     * @type {string}
-     */
-    this.winner = defId === winId ? this.defender : this.attacker;
-
-    /**
-     * The date and time at which the battle started
-     * @type {Date}
-     */
-    this.start = parseDate(data.Start);
-
-    /**
-     * The date and time at which the battle ended
-     * @type {Date}
-     */
-    this.end = parseDate(data.End);
-  }
-}

package/lib/models/DeepArchidemea.js

@@ -1,33 +0,0 @@
-import { languageDesc, languageString } from 'warframe-worldstate-data/utilities';
-
-class DeepArchidemeaMission {
-  constructor(mission, deviation, risks, locale) {
-    this.mission = mission;
-
-    this.deviation = {
-      key: deviation,
-      name: languageString(deviation, locale),
-      description: languageDesc(deviation, locale),
-    };
-
-    this.riskVariables = risks.map((i) => {
-      return { key: i, name: languageString(i, locale), description: languageDesc(i, locale) };
-    });
-  }
-}
-
-export default class DeepArchimedea {
-  constructor(activation, expiry, data, locale = 'en') {
-    this.id = `${new Date(activation).getTime()}DeepArchimedea`;
-
-    this.activation = activation;
-
-    this.expiry = expiry;
-
-    this.missions = data.mt.map((m, i) => new DeepArchidemeaMission(m, data.mv[i], data.c[i], locale));
-
-    this.personalModifiers = data.fv.map((i) => {
-      return { key: i, name: languageString(i, locale), description: languageDesc(i, locale) };
-    });
-  }
-}

package/lib/models/DuviriCycle.js

@@ -1,65 +0,0 @@
-import { timeDeltaToString, toTitleCase } from 'warframe-worldstate-data/utilities';
-
-import WorldstateObject from './WorldstateObject.js';
-
-const cycleTime = 36000;
-const stateTime = 7200;
-
-const states = ['sorrow', 'fear', 'joy', 'anger', 'envy'];
-
-const getStageInfo = () => {
-  const cycleDelta = (Math.floor(Date.now() / 1000) - 52) % cycleTime;
-  const stateInd = Math.floor(cycleDelta / stateTime);
-  const stateDelta = cycleDelta % stateTime;
-  const untilNext = stateTime - stateDelta;
-  const expiry = new Date(Date.now() + untilNext * 1000);
-  expiry.setSeconds(0);
-  expiry.setMilliseconds(0);
-  const activation = new Date(expiry.getTime() - stateTime * 1000);
-  activation.setSeconds(0);
-  activation.setMilliseconds(0);
-  return {
-    state: states[stateInd],
-    expiry,
-    activation,
-  };
-};
-
-/**
- * @typedef {WorldstateObject} DuviriCycle
- * @augments {WorldstateObject}
- */
-export default class DuviriCycle extends WorldstateObject {
-  constructor({ duviriChoices }) {
-    super({ _id: { $oid: 'duviriCycle0' } });
-    const { activation, expiry, state } = getStageInfo();
-
-    /**
-     * When the cycle start(s/ed)
-     * @type {Date}
-     */
-    this.activation = activation;
-    /**
-     * When the cycle end(s/ed)
-     * @type {Date}
-     */
-    this.expiry = expiry;
-    /**
-     * Current stage key
-     * @type {string}
-     */
-    this.state = state;
-    /**
-     * Choice options for this Cycle
-     */
-    this.choices = duviriChoices;
-
-    this.id = `duviriCycle${this.state}${this.expiry.getTime()}`;
-  }
-
-  toString() {
-    return `${toTitleCase(this.state)} spiral. ${toTitleCase(
-      states[(states.indexOf(this.state) + 1) % 5]
-    )} in ${timeDeltaToString(new Date(this.expiry).getTime() - Date.now())}`;
-  }
-}

package/lib/models/EarthCycle.js

@@ -1,119 +0,0 @@
-import { fromNow } from 'warframe-worldstate-data/utilities';
-
-import mdConfig from '../supporting/MarkdownSettings.js';
-
-import WorldstateObject from './WorldstateObject.js';
-
-/**
- * @typedef {object} EarthCycle
- * @property {Date} expiry The date and time at which the event ends
- * @property {Date} activation The date and time at which the event started
- * @property {boolean} isDay Whether or not this it's daytime
- * @property {string} state Current cycle state. One of `day`, `night`
- * @property {string} timeLeft Time remaining string
- * @property {Date} rounded The date and time at which the event ends, rounded to the nearest minute
- * @property {Date} start The date and time at which the event started, 4 hours before the end
- * @property {boolean} expired Whether or not the event has expired
- */
-
-/**
- * Get the current Earth Day/Night Cycle
- * @returns {EarthCycle} The current Earth Day/Night Cycle
- */
-function getCurrentEarthCycle() {
-  const now = Date.now();
-  const cycleSeconds = Math.floor(now / 1000) % 28800; // One cycle = 8 hours = 28800 seconds
-  const dayTime = cycleSeconds < 14400;
-
-  let secondsLeft = 14400 - (cycleSeconds % 14400);
-  const millisLeft = secondsLeft * 1000;
-  const expiry = new Date(now + secondsLeft * 1000);
-
-  const minutesCoef = 1000 * 60;
-  const rounded = new Date(Math.round((now + millisLeft) / minutesCoef) * minutesCoef);
-
-  const timePieces = [];
-  if (secondsLeft > 3600) {
-    timePieces.push(`${Math.floor(secondsLeft / 3600)}h`);
-    secondsLeft %= 3600;
-  }
-  if (secondsLeft > 60) {
-    timePieces.push(`${Math.floor(secondsLeft / 60)}m`);
-    secondsLeft %= 60;
-  }
-  timePieces.push(`${secondsLeft}s`);
-
-  return {
-    dayTime,
-    timeLeft: timePieces.join(' '),
-    expiry,
-    expiresIn: millisLeft,
-    rounded,
-    state: dayTime ? 'day' : 'night',
-    start: new Date(expiry.getTime() - 1000 * 60 * 60 * 4), // start is 4h before end
-  };
-}
-
-/**
- * Represents the current Earth Day/Night Cycle
- * @augments {WorldstateObject}
- */
-export default class EarthCycle extends WorldstateObject {
-  #ec = getCurrentEarthCycle();
-  constructor() {
-    super({ _id: { $oid: 'earthCycle0' } });
-
-    /**
-     * 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 = this.#ec.start;
-
-    /**
-     * Whether or not this 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;
-
-    this.id = `earthCycle${this.#ec.rounded.getTime()}`;
-  }
-
-  /**
-   * Get whether or not the event has expired
-   * @returns {boolean} Whether or not the event has expired
-   */
-  getExpired() {
-    return fromNow(this.expiry) < 0;
-  }
-
-  /**
-   * The event's string representation
-   * @returns {string} The string representation of the event
-   */
-  toString() {
-    const lines = [
-      `Operator, Earth is currently in ${this.isDay ? 'Day' : 'Night'}time`,
-      `Time remaining until ${this.isDay ? 'night' : 'day'}: ${this.timeLeft}`,
-    ];
-
-    return lines.join(mdConfig.lineEnd);
-  }
-}

package/lib/models/Fissure.js

@@ -1,136 +0,0 @@
-import {
-  parseDate,
-  fromNow,
-  timeDeltaToString,
-  node,
-  nodeMissionType,
-  missionType,
-  nodeEnemy,
-  fissureModifier,
-  fissureTier,
-} from 'warframe-worldstate-data/utilities';
-
-import WorldstateObject from './WorldstateObject.js';
-
-/**
- * Represents a fissure mission
- * @augments {WorldstateObject}
- */
-export default class Fissure extends WorldstateObject {
-  /**
-   * @param   {object}             data            The fissure data
-   * @param   {Dependency}             deps            The dependencies object
-   * @param   {string}             deps.locale     Locale to use for translations
-   */
-  constructor(data, { locale = 'en' } = { locale: 'en' }) {
-    super(data);
-
-    /**
-     * The node where the fissure has appeared
-     * @type {string}
-     */
-    this.node = node(data.Node, locale);
-
-    /**
-     * The fissure mission type
-     * @type {string}
-     */
-    this.missionType = data.MissionType ? missionType(data.MissionType, locale) : nodeMissionType(data.Node, locale);
-
-    /**
-     * The fissure mission type key
-     * @type {string}
-     */
-    this.missionKey = data.MissionType ? missionType(data.MissionType) : nodeMissionType(data.Node);
-
-    /**
-     * The faction controlling the node where the fissure has appeared
-     * @type {string}
-     */
-    this.enemy = nodeEnemy(data.Node, locale);
-
-    /**
-     * Faction enum for the faction controlling the node where the fissure has appeared
-     * @type {string}
-     */
-    this.enemyKey = nodeEnemy(data.Node);
-
-    /**
-     * The node key where the fissure has appeared
-     * @type {string}
-     */
-    this.nodeKey = node(data.Node);
-
-    /**
-     * The fissure's tier
-     * @type {string}
-     */
-    this.tier = fissureModifier(data.Modifier || data.ActiveMissionTier, locale);
-
-    /**
-     * The fissure's tier as a number
-     * @type {number}
-     */
-    this.tierNum = fissureTier(data.Modifier || data.ActiveMissionTier, locale);
-
-    /**
-     * The date and time at which the fissure appeared
-     * @type {Date}
-     */
-    this.activation = parseDate(data.Activation);
-
-    /**
-     * The date and time at which the fissure will disappear
-     * @type {Date}
-     */
-    this.expiry = parseDate(data.Expiry);
-
-    /**
-     * Whether this is expired (at time of object creation)
-     * @type {boolean}
-     */
-    this.expired = this.getExpired();
-
-    /**
-     * ETA string (at time of object creation)
-     * @type {string}
-     */
-    this.eta = this.getETAString();
-
-    /**
-     * Whether this fissure corresponds to a RailJack Void Storm
-     * @type {boolean}
-     */
-    this.isStorm = Boolean(data.ActiveMissionTier);
-
-    /**
-     * Whether this fissure is a Steel Path fissure
-     * @type {boolean}
-     */
-    this.isHard = Boolean(data.Hard);
-  }
-
-  /**
-   * Get whether this deal has expired
-   * @returns {boolean} Whether or not the deal has expired
-   */
-  getExpired() {
-    return fromNow(this.expiry) < 0;
-  }
-
-  /**
-   * Get a string representation of how long the void fissure will remain active
-   * @returns {string} The string representation of the fissure's remaining time
-   */
-  getETAString() {
-    return timeDeltaToString(fromNow(this.expiry));
-  }
-
-  /**
-   * Returns a string representation of the fissure
-   * @returns {string}  The string representation of the fissure
-   */
-  toString() {
-    return `[${this.getETAString()}] ${this.tier} fissure at ${this.node} - ${this.enemy} ${this.missionType}`;
-  }
-}

package/lib/models/FlashSale.js

@@ -1,123 +0,0 @@
-import { parseDate, fromNow, timeDeltaToString, languageString } from 'warframe-worldstate-data/utilities';
-
-import mdConfig from '../supporting/MarkdownSettings.js';
-
-/**
- * Represents a flash sale
- */
-export default class FlashSale {
-  /**
-   * @param   {object}             data            The flash sale data
-   * @param   {Dependency}             deps            The dependencies object
-   * @param   {string}             deps.locale     Locale to use for translations
-   */
-  constructor(data, { locale = 'en' } = { locale: 'en' }) {
-    /**
-     * The item being offered in the flash sale
-     * @type {string}
-     */
-    this.item = languageString(data.TypeName, locale);
-
-    /**
-     * The date and time at which the sale will end
-     * @type {Date}
-     */
-    this.expiry = parseDate(data.EndDate);
-
-    /**
-     * The date and time at which the sale will or did start
-     * @type {Date}
-     */
-    this.activation = parseDate(data.StartDate);
-
-    /**
-     * The item's discount percentage
-     * @type {number}
-     */
-    this.discount = data.Discount;
-
-    /**
-     * The item's discounted credit price
-     * @type {number}
-     */
-    this.regularOverride = data.RegularOverride;
-
-    /**
-     * The item's discounted platinum price
-     * @type {number}
-     */
-    this.premiumOverride = data.PremiumOverride;
-
-    /**
-     * Whether this item is show in the in-game market
-     * @type {boolean}
-     */
-    this.isShownInMarket = data.ShowInMarket;
-
-    /**
-     * Whether this item is featured in the in-game market
-     * @type {boolean}
-     */
-    this.isFeatured = data.Featured;
-
-    /**
-     * Whether this item is marked as popular in the in-game market
-     * @type {boolean}
-     */
-    this.isPopular = data.Popular;
-
-    /**
-     * Unique identifier for this sale built from the end time and reward
-     * @type {string}
-     */
-    this.id = `${data.TypeName.split('/').slice(-1)[0]}${this.expiry.getTime()}`;
-
-    /**
-     * Whether or not this is expired (at time of object creation)
-     * @type {boolean}
-     */
-    this.expired = this.getExpired();
-
-    /**
-     * ETA string (at time of object creation)
-     * @type {string}
-     */
-    this.eta = this.getETAString();
-  }
-
-  /**
-   * Get how much time is left before the deal expires
-   * @returns {string} The time left before the deal expires
-   */
-  getETAString() {
-    return timeDeltaToString(fromNow(this.expiry));
-  }
-
-  /**
-   * Get whether or not this deal has expired
-   * @returns {boolean} Whether or not the deal has expired
-   */
-  getExpired() {
-    return fromNow(this.expiry) < 0;
-  }
-
-  /**
-   * Returns a string representation of the flash sale
-   * @returns {string} The string representation of the flash sale
-   */
-  toString() {
-    const lines = [`${this.item}, ${this.premiumOverride}p`, `Expires in ${this.getETAString()}`];
-
-    if (this.discount) {
-      lines.unshift(`${this.discount}% off!`);
-    } else if (this.isShownInMarket) {
-      lines.unshift('**ShowInMarket**');
-    } else if (this.isPopular) {
-      lines.unshift('**Popular**');
-    } else if (this.isFeatured) {
-      lines.unshift('**Featured**');
-    }
-
-    return `${mdConfig.codeBlock}${lines.join(mdConfig.lineEnd)}${mdConfig.blockEnd}`;
-  }
-}