warframe-worldstate-parser 4.6.1 → 5.0.1

package/lib/models/GlobalUpgrade.js

@@ -1,122 +0,0 @@
-import {
-  parseDate,
-  fromNow,
-  timeDeltaToString,
-  upgrade,
-  operation,
-  operationSymbol,
-} from 'warframe-worldstate-data/utilities';
-
-import mdConfig from '../supporting/MarkdownSettings.js';
-/**
- * Represents an upgrade that applies to all players
- */
-export default class GlobalUpgrade {
-  /**
-   * @param   {object}             data            The global upgrade data
-   * @param   {object}             deps            The dependencies object
-   * @param   {string}             deps.locale     Locale to use for translations
-   */
-  constructor(data, { locale = 'en' } = { locale: 'en' }) {
-    if (!data.Activation || !data.ExpiryDate) {
-      throw new TypeError('The provided data does not have the required properties.');
-    }
-
-    /**
-     * The time and date at which the global upgrade starts being active
-     * @type {Date}
-     */
-    this.activation = parseDate(data.Activation);
-    /**
-     * @deprecated Use `activation` instead
-     */
-    this.start = this.activation;
-
-    /**
-     * The time and date at which the global upgrade stops being active
-     * @type {Date}
-     */
-    this.expiry = parseDate(data.ExpiryDate);
-    /**
-     * @deprecated Use `expiry` instead
-     */
-    this.end = parseDate(data.ExpiryDate);
-
-    /**
-     * The effect of the upgrade
-     * @type {string}
-     */
-    this.upgrade = upgrade(data.UpgradeType, locale);
-
-    /**
-     * The operation type
-     * @type {string}
-     */
-    this.operation = operation(data.OperationType, locale);
-
-    /**
-     * Symbol for operation
-     * @type {string}
-     */
-    this.operationSymbol = operationSymbol(data.OperationType, locale);
-
-    /**
-     * The operation value
-     * @type {string}
-     */
-    this.upgradeOperationValue = data.Value;
-
-    /**
-     * 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();
-
-    /**
-     * Plaintext description of upgrade
-     * @type {string}
-     */
-    this.desc = this.compileDesription();
-  }
-
-  /**
-   * Get whether or not the event has expired
-   * @returns {boolean} whether the event has expired
-   */
-  getExpired() {
-    return fromNow(this.end) < 0;
-  }
-
-  /**
-   * Get a string indicating how long it will take for the upgrade to expire
-   * @returns {string} estimated timer of the upgrade
-   */
-  getETAString() {
-    return timeDeltaToString(fromNow(this.end));
-  }
-
-  /**
-   * Turn the global upgrade into a plain text description
-   * @returns {string} Descriptio
-   */
-  compileDesription() {
-    return `${this.upgradeOperationValue}${this.operationSymbol} ${this.upgrade} for ${this.eta}`;
-  }
-
-  /**
-   * Returns a string representation of the upgrade
-   * @returns {string} string representation
-   */
-  toString() {
-    return (
-      `${mdConfig.codeBlock}[${this.getETAString()}] ${this.upgrade}` +
-      `${this.operation} ${this.upgradeOperationValue}${mdConfig.blockEnd}`
-    );
-  }
-}

package/lib/models/Invasion.js

@@ -1,183 +0,0 @@
-import { parseDate, timeDeltaToString, toNow, node, languageString, faction } from 'warframe-worldstate-data/utilities';
-
-import mdConfig from '../supporting/MarkdownSettings.js';
-
-import Reward from './Reward.js';
-import WorldstateObject from './WorldstateObject.js';
-/**
- * An invasion participant
- * @typedef {object} InvasionParticipant
- * @property {string} reward Reward for supporting this participant in the invasion
- * @property {string} faction Faction of this participant (localized)
- * @property {string} factionKey Faction of this participant (always English)
- */
-
-/**
- * Represents an invasion
- */
-export default class Invasion extends WorldstateObject {
-  /**
-   * @param   {object}             data            The invasion data
-   * @param   {Dependency}         deps            The dependencies object
-   * @param   {string}             deps.locale     Locale to use for translations
-   */
-  constructor(data, { locale = 'en' } = { locale: 'en' }) {
-    super(data);
-
-    const opts = {
-      locale,
-    };
-
-    /**
-     * The node where the invasion is taking place
-     * @type {string}
-     */
-    this.node = node(data.Node, locale);
-
-    /**
-     * The node key where the invasion is taking place
-     * @type {string}
-     */
-    this.nodeKey = node(data.Node);
-
-    /**
-     * The invasion's description
-     * @type {string}
-     */
-    this.desc = languageString(data.LocTag, locale);
-
-    /**
-     * The attacking faction
-     * @type {string}
-     */
-    this.attackingFaction = faction(data.DefenderMissionInfo.faction, locale);
-
-    /**
-     * Invasion attacker
-     * @type {InvasionParticipant}
-     */
-    this.attacker = {
-      reward: Object.keys(data?.AttackerReward || {})?.length ? new Reward(data.AttackerReward, opts) : undefined,
-      faction: faction(data.DefenderMissionInfo.faction, locale),
-      factionKey: faction(data.DefenderMissionInfo.faction, 'en'),
-    };
-
-    /**
-     * Invasion defender
-     * @type {InvasionParticipant}
-     */
-    this.defender = {
-      reward: Object.keys(data?.DefenderReward || {})?.length ? new Reward(data.DefenderReward, opts) : undefined,
-      faction: faction(data.AttackerMissionInfo.faction, locale),
-      factionKey: faction(data.AttackerMissionInfo.faction, 'en'),
-    };
-
-    /**
-     * Whether this invasion is against the infestation
-     * @type {boolean}
-     */
-    this.vsInfestation = /infest/i.test(data.DefenderMissionInfo.faction);
-
-    /**
-     * The time at which the invasion starts
-     * @type {Date}
-     */
-    this.activation = parseDate(data.Activation);
-
-    /**
-     * The signed count of completed runs. Supporting the attackers makes the count go up,
-     * supporting the defenders makes it go down
-     * @type {number}
-     */
-    this.count = data.Count;
-
-    /**
-     * The number of runs that one side needs to win
-     * @type {number}
-     */
-    this.requiredRuns = data.Goal;
-
-    /**
-     * The invasion's completion percentage. Defenders win if it gets to 0
-     * Grineer vs. Corpus invasions start at 50, Infested invasions start at 100
-     * @type {number}
-     */
-    this.completion = (1 + data.Count / data.Goal) * (this.vsInfestation ? 100 : 50);
-
-    /**
-     * Whether the invasion has finished
-     * @type {boolean}
-     */
-    this.completed = data.Completed;
-
-    /**
-     * ETA string (at time of object creation)
-     * @type {string}
-     */
-    this.eta = this.getETAString();
-
-    /**
-     * An array containing the types of all of the invasions's rewards
-     * @type {Array.<string>}
-     */
-    this.rewardTypes = this.getRewardTypes();
-  }
-
-  /**
-   * Whether or not the attackers are winning.
-   * This is always false when the infestation is attacking
-   * @returns {boolean} whether the attacker is winning
-   */
-  isAttackerWinning() {
-    return this.count > 0;
-  }
-
-  /**
-   * Get an estimation of how much time is left before the invasion ends in milliseconds
-   * @returns {number} remaining time in ms
-   */
-  getRemainingTime() {
-    const completedRuns = Math.abs(this.count);
-    const elapsedMillis = toNow(this.activation);
-    const remainingRuns = this.requiredRuns - completedRuns;
-    return remainingRuns * (elapsedMillis / completedRuns);
-  }
-
-  /**
-   * Get a string estimating how much time is left before the invasion ends
-   * @returns {string} time delta string from now to the end
-   */
-  getETAString() {
-    return timeDeltaToString(this.getRemainingTime());
-  }
-
-  /**
-   * Get the types of the items being rewarded in the invasion
-   * @returns {Array<string>} types of items being rewarded
-   */
-  getRewardTypes() {
-    return [...(this.attacker.reward?.getTypes() ?? []), ...(this.defender.reward?.getTypes() ?? [])];
-  }
-
-  /**
-   * The invasion's string representation
-   * @returns {string} string representation of the invasion
-   */
-  toString() {
-    let lines = [];
-    if (this.vsInfestation) {
-      lines = [
-        this.defender.reward?.toString(),
-        `${this.desc} on ${this.node}`,
-        `${Math.round(this.completion * 100) / 100}% - ETA: ${this.getETAString()}`,
-      ].filter(Boolean);
-    } else {
-      lines = [
-        `${this.attackingFaction} (${this.attacker.reward}) vs. ${this.defender.faction} (${this.defender.reward})`,
-        `${this.node} - ${this.desc}`,
-        `${Math.round(this.completion * 100) / 100}% - ETA: ${this.getETAString()}`,
-      ];
-    }
-    return `${mdConfig.codeBlock}${lines.join(mdConfig.lineEnd)}${mdConfig.blockEnd}`;
-  }
-}

package/lib/models/Kinepage.js

@@ -1,11 +0,0 @@
-export default class Kinepage {
-  constructor(data, locale = 'en') {
-    this.timestamp = new Date(Number(data.ts) * 1000);
-
-    const translations = Object.fromEntries(Object.entries(data).filter(([key]) => key !== 'ts'));
-
-    this.message = translations[locale] || data.en;
-
-    this.translations = Object.fromEntries(Object.entries(translations).filter(([key]) => key !== locale));
-  }
-}

package/lib/models/Kuva.js

@@ -1,122 +0,0 @@
-import { createHash } from 'node:crypto';
-
-import { node, nodeMissionType } from 'warframe-worldstate-data/utilities';
-
-/**
- * External mission data retrieved from https://10o.io/kuvalog.json
- * @typedef {object} ExternalMission
- * @property {Date} activation start time
- * @property {Date} expiry end timer
- * @property {string} node formatted node name with planet
- * @property {string} enemy Enemy on tile
- * @property {string} type Mission type of node
- * @property {boolean} archwing whether or not the tile requires archwing
- * @property {boolean} sharkwing whether or not the tile requires
- *    sumbersible archwing
- */
-
-/**
- * Stores and parses kuva data from https://10o.io/kuvalog.json
- * @typedef {object} Kuva
- * @property {ExternalMission[]} kuva currently active kuva missions
- * @property {ExternalMission} arbitration current arbitration
- */
-
-const HOURS_2 = 7200000;
-
-/**
- * Truncate time for a semlar-provided mission
- * @param  {object} mission parsed mission with re-aligned field names
- */
-const truncateTime = (mission) => {
-  mission.expiry.setHours(mission.activation.getHours() + 1);
-  mission.expiry.setMinutes(4);
-  mission.expiry.setSeconds(0);
-  mission.expiry.setMilliseconds(0);
-  mission.activation.setMinutes(mission.activation.getMinutes() + 5.1);
-};
-
-/**
- * Scrub unnecessary details from the mission
- * @param  {object} mission parsed mission with re-aligned field names
- */
-const scrub = (mission) => {
-  /* eslint-disable no-param-reassign */
-  delete mission.solnode;
-  delete mission.name;
-  delete mission.node_type;
-  delete mission.tile;
-  delete mission.planet;
-  /* eslint-enable no-param-reassign */
-};
-
-const hash = (str) => createHash('sha256').update(str, 'utf8').digest('hex');
-
-/**
- * Parse kuva & arbitration data
- * @param  {object} data       Data to split for kuva/arbitration
- * @param  {string} locale     locale to translate
- * @returns {Kuva}           Split parsed data
- */
-const parse = (data, locale) => {
-  const parsed = { kuva: [], arbitration: {} };
-  const now = new Date();
-  if (!data) return undefined;
-  data?.forEach?.((mission) => {
-    const p = {
-      activation: new Date(mission.start),
-      expiry: new Date(mission.end),
-      ...mission.solnodedata,
-      node: node(mission.solnode, locale),
-      nodeKey: node(mission.solnode, 'en'),
-      type: nodeMissionType(mission.solnode, locale),
-      typeKey: nodeMissionType(mission.solnode, 'en'),
-    };
-    truncateTime(p);
-    p.id = hash(JSON.stringify(p));
-    p.expired = Date.now() - p.expiry.getTime() < 0;
-
-    if (
-      p.activation < now &&
-      now < p.expiry &&
-      new Date(p.activation.getTime() + HOURS_2) > now &&
-      new Date(p.expiry.getTime() - HOURS_2) < now
-    ) {
-      if (mission.missiontype === 'EliteAlertMission') {
-        // if the diff is less than 2 hours?
-        parsed.arbitration = p;
-      }
-      if (mission.missiontype.startsWith('KuvaMission')) parsed.kuva.push(p);
-    }
-    scrub(p);
-  });
-  parsed.kuva = Array.from(new Set(parsed.kuva));
-
-  return parsed;
-};
-
-/**
- * Stores and parses kuva data from https://10o.io/kuvalog.json
- * @property {ExternalMission[]} kuva currently active kuva missions
- * @property {ExternalMission} arbitration current arbitration
- */
-export default class Kuva {
-  #locale;
-
-  constructor({ kuvaData, locale, logger }) {
-    /**
-     * The locale to leverage for translations
-     * @type {string}
-     * @private
-     */
-    this.#locale = locale;
-
-    if (!kuvaData) {
-      // eslint-ignore-next-line no-console
-      logger.debug('No defined kuva data, skipping data');
-    } else {
-      const parsed = parse(kuvaData, this.locale);
-      ({ kuva: this.kuva, arbitration: this.arbitration } = parsed);
-    }
-  }
-}

package/lib/models/MidrathCycle.js

@@ -1,94 +0,0 @@
-import { timeDeltaToString, fromNow } from 'warframe-worldstate-data/utilities';
-
-import mdConfig from '../supporting/MarkdownSettings.js';
-
-import WorldstateObject from './WorldstateObject.js';
-
-/**
- * @typedef {object} MidrathCycle
- * @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 {boolean} expired Whether or not the event has expired
- */
-
-/**
- * Get the current Midrath cycle time
- * @returns {MidrathCycle} Current midrath cycle time
- */
-function getCurrentMidrathCycle() {
-  const dayDuration = 32 * 60 * 1000; // 32 minutes in milliseconds
-  const nightDuration = 16 * 60 * 1000; // 16 minutes in milliseconds
-  const totalDuration = dayDuration + nightDuration;
-
-  const refPoint = Date.parse('2025-08-07T16:05:29Z');
-  const now = Date.now();
-  const elapsedInCycle = (now - refPoint) % totalDuration;
-  const isDay = elapsedInCycle < dayDuration;
-
-  let phase = {
-    name: 'night',
-    remaining: totalDuration - elapsedInCycle,
-    duration: nightDuration,
-  };
-
-  if (isDay) {
-    phase = {
-      name: 'day',
-      remaining: dayDuration - elapsedInCycle,
-      duration: dayDuration,
-    };
-  }
-
-  const activation = new Date(now - (phase.duration - phase.remaining));
-  const expiry = new Date(activation.getTime() + phase.duration);
-  const timeLeft = timeDeltaToString(phase.remaining);
-
-  return {
-    activation,
-    expiry,
-    state: phase.name,
-    timeLeft,
-    isDay,
-  };
-}
-
-export default class MidrathCycle extends WorldstateObject {
-  #mc = getCurrentMidrathCycle();
-  constructor() {
-    super({ _id: { $oid: 'midrathCycle0' } });
-
-    this.activation = this.#mc.activation;
-
-    this.expiry = this.#mc.expiry;
-
-    this.isDay = this.#mc.isDay;
-
-    this.state = this.#mc.state;
-
-    this.timeLeft = this.#mc.timeLeft;
-  }
-
-  /**
-   * 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 = [
-      `Envoy, it is currently ${this.isDay ? 'Day' : 'Night'}time in Midrath`,
-      `Time remaining until ${this.isDay ? 'night' : 'day'}: ${this.timeLeft}`,
-    ];
-
-    return lines.join(mdConfig.lineEnd);
-  }
-}

package/lib/models/Mission.js

@@ -1,179 +0,0 @@
-import { languageString, faction, missionType, node, insist } from 'warframe-worldstate-data/utilities';
-
-import mdConfig from '../supporting/MarkdownSettings.js';
-
-import Reward from './Reward.js';
-
-/**
- * Represents an in-game mission
- */
-export default class Mission {
-  /**
-   * @param   {object}             data            The mission data
-   * @param   {string}             locale     Locale to use for translations
-   */
-  constructor(data, { locale = 'en' } = { locale: 'en' }) {
-    const deps = {
-      locale,
-    };
-    insist(data);
-
-    /**
-     * The mission's description
-     * @type {?string}
-     */
-    this.description = languageString(data.descText, locale);
-
-    /**
-     * The node where the mission takes place
-     * @type {string}
-     */
-    this.node = node(data.location || data.node, locale);
-
-    /**
-     * Unlocalized {@link mission#node}
-     * @type {string}
-     */
-    this.nodeKey = node(data.location || data.node, 'en');
-
-    /**
-     * The mission's type
-     * @type {string}
-     */
-    this.type = missionType(data.missionType, locale);
-
-    /**
-     * The mission's type
-     * @type {string}
-     */
-    this.typeKey = missionType(data.missionType, 'en');
-
-    /**
-     * The factions that the players must fight in the mission
-     * @type {string}
-     */
-    this.faction = faction(data.faction, locale);
-
-    /**
-     * The factions that the players must fight in the mission
-     * @type {string}
-     */
-    this.factionKey = faction(data.faction, 'en');
-
-    /**
-     * The mission's reward
-     * @type {?Reward}
-     */
-    this.reward = data.missionReward ? new Reward(data.missionReward, deps) : undefined;
-
-    /**
-     * The minimum level of the enemies in the mission
-     * @type {number}
-     */
-    this.minEnemyLevel = data.minEnemyLevel;
-
-    /**
-     * The maximum level of the enemies in the mission
-     * @type {number}
-     */
-    this.maxEnemyLevel = data.maxEnemyLevel;
-
-    /**
-     * The number of waves that the players need to complete (undefined if not applicable)
-     * @type {?number}
-     */
-    this.maxWaveNum = data.maxWaveNum;
-
-    /**
-     * The Mission's nightmare boolean
-     * @type {boolean}
-     */
-    this.nightmare = data.nightmare || false;
-
-    /**
-     * The Mission's archwing requirement
-     * @type {boolean}
-     */
-    this.archwingRequired = data.archwingRequired || false;
-
-    /**
-     * The Mission's sharkwing requirement
-     * @type {boolean}
-     */
-    this.isSharkwing = data.isSharkwingMission || false;
-
-    /**
-     * Override for the map on this mission
-     * @type {string}
-     */
-    this.levelOverride = languageString(data.levelOverride, locale);
-
-    /**
-     * Enemy specification for the mission
-     * @type {string}
-     */
-    this.enemySpec = languageString(data.enemySpec, locale);
-
-    /**
-     * Array of strings denoting extra spawners for a mission
-     * @type {string[]}
-     */
-    this.advancedSpawners = (data.advancedSpawners || []).map((spawner) => languageString(spawner, locale));
-
-    /**
-     * Items required to enter the mission
-     * @type {string[]}
-     */
-    this.requiredItems = (data.requiredItems || []).map((reqItem) => languageString(reqItem, locale));
-
-    /**
-     * Whether or not the required items are consumed
-     * @type {boolean}
-     */
-    this.consumeRequiredItems = data.consumeRequiredItems;
-
-    /**
-     * Target for the mission
-     * @type {string}
-     */
-    this.target = languageString(data.vipAgent, locale);
-
-    /**
-     * Whether or not leaders are always allowed
-     * @type {boolean}
-     */
-    this.leadersAlwaysAllowed = data.leadersAlwaysAllowed;
-
-    /**
-     * A tag for the event that this corresponds to
-     * @type {string}
-     */
-    this.goalTag = data.goalTag;
-
-    /**
-     * Affectors for this mission
-     * @type {string[]}
-     */
-    this.levelAuras = (data.levelAuras || []).map((aura) => languageString(aura, locale));
-
-    /**
-     * Only weapon allowed for the mission
-     * @type {string}
-     */
-    this.exclusiveWeapon = languageString(data.exclusiveWeapon, locale);
-  }
-
-  /**
-   * The Mission's string representation
-   * @returns {string} Mission's string representation
-   */
-  toString() {
-    const lines = [this.reward.toString()];
-
-    lines.push(`${this.faction} (${this.type})`);
-    lines.push(this.node);
-    lines.push(`level ${this.minEnemyLevel} - ${this.maxEnemyLevel}`);
-
-    return lines.join(mdConfig.lineEnd);
-  }
-}