warframe-worldstate-parser 4.6.2 → 5.0.1

package/lib/models/VallisCycle.js

@@ -1,125 +0,0 @@
-import { fromNow, timeDeltaToString } from 'warframe-worldstate-data/utilities';
-
-import mdConfig from '../supporting/MarkdownSettings.js';
-
-import WorldstateObject from './WorldstateObject.js';
-
-const lStart = new Date('November 10, 2018 08:13:48 UTC');
-const loopTime = 1600000;
-const warmTime = 400000;
-const coldTime = loopTime - warmTime;
-
-/**
- * @typedef {object} CurrentCycle
- * @property {string} state - Current cycle state. One of `warm`, `cold`
- * @property {number} toNextMinor - Time remaining in the current cycle state
- * @property {number} toNextFull - Time remaining until the next cycle
- * @property {Date} timeAtPrevious - Date and time at which the event started
- * @property {Date} timeAtNext - Date and time at which the event start
- */
-
-/**
- * Get the current cycle state for Orb Vallis
- * @returns {CurrentCycle} current cycle state
- */
-function getCurrentCycle() {
-  const sinceLast = (Date.now() - lStart) % loopTime;
-  const toNextFull = loopTime - sinceLast;
-  let state = 'cold';
-  if (toNextFull > coldTime) {
-    state = 'warm';
-  }
-  let toNextMinor;
-  if (toNextFull < coldTime) {
-    toNextMinor = toNextFull;
-  } else {
-    toNextMinor = toNextFull - coldTime;
-  }
-  const milliAtNext = Date.now() + toNextMinor;
-  const milliAtPrev = Date.now() + toNextFull - (state === 'warm' ? loopTime : coldTime);
-  const timeAtPrevious = new Date(milliAtPrev);
-  timeAtPrevious.setSeconds(0);
-
-  return {
-    state,
-    toNextMinor,
-    toNextFull,
-    timeAtNext: new Date(milliAtNext),
-    timeAtPrevious,
-  };
-}
-
-/**
- * Represents the current Earth Day/Night Cycle
- * @augments {WorldstateObject}
- */
-export default class VallisCycle extends WorldstateObject {
-  /**
-   * The current cetus cycle, for calculating the other fields
-   * @property {string} state - Current cycle state. One of `warm`, `cold`
-   * @property {number} toNextMinor - Time remaining in the current cycle state
-   * @property {number} toNextFull - Time remaining until the next cycle
-   * @property {Date} timeAtPrevious - Date and time at which the event started
-   * @private
-   */
-  #ec = getCurrentCycle();
-
-  constructor() {
-    super({ _id: { $oid: 'vallisCycle0' } });
-
-    /**
-     * The date and time at which the event ends
-     * @type {Date}
-     */
-    this.expiry = this.#ec.timeAtNext;
-
-    /**
-     * Whether or not this it's daytime
-     * @type {boolean}
-     */
-    this.isWarm = this.#ec.state === 'warm';
-
-    /**
-     * Current cycle state. One of `warm`, `cold`
-     * @type {string}
-     */
-    this.state = this.#ec.state;
-
-    /**
-     * Date and time at which the event started
-     * @type {Date}
-     */
-    this.activation = this.#ec.timeAtPrevious;
-
-    /**
-     * Time remaining string
-     * @type {string}
-     */
-    this.timeLeft = timeDeltaToString(this.#ec.toNextMinor);
-
-    this.id = `vallisCycle${this.#ec.timeAtPrevious.getTime()}`;
-
-    this.shortString = `${this.timeLeft.replace(/\s\d*s/gi, '')} to ${this.isWarm ? 'Cold' : 'Warm'}`;
-  }
-
-  /**
-   * Get whether or not the event has expired
-   * @returns {boolean} whether this event has expired
-   */
-  getExpired() {
-    return fromNow(this.expiry) < 0;
-  }
-
-  /**
-   * The event's string representation
-   * @returns {string} the event's string representation
-   */
-  toString() {
-    const lines = [
-      `Operator, the Orb Vallis is currently ${this.isWarm ? 'Warm' : 'Cold'}`,
-      `Time remaining until ${this.isWarm ? 'Cold' : 'Warm'}: ${this.timeLeft}`,
-    ];
-
-    return lines.join(mdConfig.lineEnd);
-  }
-}

package/lib/models/VoidTrader.js

@@ -1,134 +0,0 @@
-import { fromNow, parseDate, timeDeltaToString, node, insist } from 'warframe-worldstate-data/utilities';
-
-import mdConfig from '../supporting/MarkdownSettings.js';
-
-import WorldstateObject from './WorldstateObject.js';
-import VoidTraderItem from './VoidTraderItem.js';
-import VoidTraderSchedule from './VoidTraderSchedule.js';
-
-/**
- * Represents a void trader
- * @augments {WorldstateObject}
- */
-export default class VoidTrader extends WorldstateObject {
-  /**
-   * @param   {object}             data            The Void trader data
-   * @param   {object}             deps            The dependencies object
-   * @param   {string}             deps.locale     Locale to use for translations
-   */
-  constructor(data, { locale = 'en' } = { locale: 'en' }) {
-    super(data);
-    insist(data, 'Activation', 'Expiry');
-
-    /**
-     * The date and time at which the void trader arrives
-     * @type {Date}
-     */
-    this.activation = parseDate(data.Activation);
-
-    /**
-     * The date and time at which the void trader leaves
-     * @type {Date}
-     */
-    this.expiry = parseDate(data.Expiry);
-
-    /**
-     * The void trader's name
-     * @type {string}
-     */
-    this.character = data.Character ? data.Character.replace("Baro'Ki Teel", "Baro Ki'Teer") : '';
-
-    /**
-     * The node at which the Void Trader appears
-     * @type {string}
-     */
-    this.location = node(data.Node, locale);
-
-    /**
-     * The trader's inventory
-     * @type {VoidTraderItem[]}
-     */
-    this.inventory = data.Manifest ? data.Manifest.map((i) => new VoidTraderItem(i, { locale })) : [];
-
-    /**
-     * Pseudo Identifier for identifying changes in inventory
-     * @type {string}
-     */
-    this.psId = `${this.id}${this.inventory.length}`;
-
-    /**
-     * Whether or not the void trader is active (at time of object creation)
-     * @type {boolean}
-     */
-    this.active = this.isActive();
-
-    /**
-     * A string indicating how long it will take for the trader to arrive
-     *  (at time of object creation)
-     * @type {string}
-     */
-    this.startString = this.getStartString();
-
-    /**
-     * A string indicating how long it will take for the trader to leave
-     *  (at time of object creation)
-     * @type {string}
-     */
-    this.endString = this.getEndString();
-
-    this.initialStart = parseDate(data.InitialStartDate);
-    this.completed = data.Completed;
-    this.schedule = data.ScheduleInfo ? data.ScheduleInfo.map((i) => new VoidTraderSchedule(i, { locale })) : [];
-  }
-
-  /**
-   * Get whether or not the trader is currently active
-   * @returns {boolean} whether the trader is active
-   */
-  isActive() {
-    return fromNow(this.activation) < 0 && fromNow(this.expiry) > 0;
-  }
-
-  /**
-   * Get a string indicating how long it will take for the trader to arrive
-   * @returns {string} time delta string from now to the start
-   */
-  getStartString() {
-    return timeDeltaToString(fromNow(this.activation));
-  }
-
-  /**
-   * Get a string indicating how long it will take for the trader to leave
-   * @returns {string} time delta string from now to the end
-   */
-  getEndString() {
-    return timeDeltaToString(fromNow(this.expiry));
-  }
-
-  /**
-   * Returns a string representation of the trader
-   * @returns {string} string representation
-   */
-  toString() {
-    if (!this.isActive()) {
-      const timeDelta = fromNow(this.activation);
-      const nextArrivalTime = timeDeltaToString(timeDelta);
-      return (
-        `${mdConfig.codeBlock}${this.character} is not here yet, he will arrive in ` +
-        `${nextArrivalTime} at ${this.location}${mdConfig.blockEnd}`
-      );
-    }
-
-    const inventoryString = this.inventory
-      .map((i) => `  ${i.item} - ${i.ducats} ducats + ${i.credits}cr%s`)
-      .join(mdConfig.lineEnd);
-
-    const lines = [
-      `${mdConfig.codeBlock}Void Trader at ${this.location}`,
-      inventoryString,
-      `Trader departing in ${this.getEndString()}${mdConfig.blockEnd}`,
-    ];
-
-    return lines.join(mdConfig.lineEnd);
-  }
-}

package/lib/models/VoidTraderItem.js

@@ -1,24 +0,0 @@
-import { languageString } from 'warframe-worldstate-data/utilities';
-
-/**
- * A void trader inventory item
- * @property {string} item The name of the inventory item
- * @property {number|string} ducats Ducat cost of the item
- * @property {number|string} credits Credit cost of the item
- */
-export default class VoidTraderItem {
-  /**
-   * @param   {object}             data            The void trader item data
-   * @param   {string}             data.ItemType   Worldstate Item i18n path
-   * @param   {string}             data.PrimePrice Ducat cost of the item
-   * @param   {string}             data.RegularPrice Credit price of the item
-   * @param   {Dependency}         deps            The dependencies object
-   * @param   {string}             deps.locale     Locale to use for translations
-   */
-  constructor({ ItemType, PrimePrice, RegularPrice }, { locale = 'en' } = { locale: 'en' }) {
-    this.uniqueName = ItemType;
-    this.item = languageString(ItemType, locale);
-    this.ducats = Number.parseInt(PrimePrice, 10);
-    this.credits = Number.parseInt(RegularPrice, 10);
-  }
-}

package/lib/models/VoidTraderSchedule.js

@@ -1,8 +0,0 @@
-import { parseDate, languageString } from 'warframe-worldstate-data/utilities';
-
-export default class VoidTraderSchedule {
-  constructor(data, { locale = 'en' } = { locale: 'en' }) {
-    this.expiry = parseDate(data.Expiry);
-    this.item = languageString(data.FeaturedItem, locale);
-  }
-}

package/lib/models/WeeklyChallenge.js

@@ -1,27 +0,0 @@
-import WorldstateObject from './WorldstateObject.js';
-import ChallengeInstance from './ChallengeInstance.js';
-
-/**
- * Represents a void trader
- * @augments {WorldstateObject}
- */
-export default class WeeklyChallenge extends WorldstateObject {
-  /**
-   * @param   {object}             data            The Void trader data
-   */
-  constructor(data) {
-    super(data);
-
-    this.challenges = data.Challenges.map((challengeData) => new ChallengeInstance(challengeData));
-  }
-
-  /**
-   * Returns a string representation of the trader
-   * @returns {string} string representation
-   */
-  toString() {
-    return `Starts: ${this.getStartString()}\nEnds: ${this.getEndString()}\nChallenges:\n${this.challenges
-      .map((challenge) => `\t${challenge.toString()}`)
-      .join('\n')}`;
-  }
-}

package/lib/models/WorldEvent.js

@@ -1,326 +0,0 @@
-import { fromNow, parseDate, faction, languageString, node, syndicate } from 'warframe-worldstate-data/utilities';
-
-import mdConfig from '../supporting/MarkdownSettings.js';
-
-import WorldstateObject from './WorldstateObject.js';
-import SyndicateJob from './SyndicateJob.js';
-import Reward from './Reward.js';
-
-/**
- * Interim step for an event reward system.
- * @typedef {object} InterimStep
- * @property {number} goal          Goal amount
- * @property {Reward} reward        Reward for reaching the step
- * @property {number} winnerCount   Amount of players at this step
- * @property {object} message       Message received when reaching the interim step
- */
-
-/**
- * Progress for one of multiple stages
- * @typedef {object} ProgressStep
- * @property {string} type         Type of progress
- * @property {number} progressAmt Amount of progress
- */
-
-/**
- * Represents an in-game special event
- * @augments {WorldstateObject}
- */
-export default class WorldEvent extends WorldstateObject {
-  /**
-   * Asynchronously build a new WorldEvent
-   * @param   {object}            data            The event data
-   * @param   {object}            deps            The dependencies object
-   * @param   {string}            deps.locale     Locale to use for translations
-   * @returns {Promise.<WorldEvent>}              The created WorldEvent object
-   */
-  static async build(data, deps) {
-    const event = new WorldEvent(data, deps);
-    if (data.Jobs) {
-      const jobs = [];
-      // eslint-disable-next-line no-restricted-syntax
-      for await (const job of data.Jobs ?? []) {
-        jobs.push(await SyndicateJob.build(job, event.expiry, deps));
-      }
-      event.jobs = jobs;
-    }
-    if (data.PreviousJobs) {
-      const previousJobs = [];
-      // eslint-disable-next-line no-restricted-syntax
-      for await (const job of data.PreviousJobs ?? []) {
-        previousJobs.push(await SyndicateJob.build(job, event.expiry, deps));
-      }
-      event.previousJobs = previousJobs;
-    }
-    return event;
-  }
-
-  /**
-   * @param   {object}            data            The event 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 opts = {
-      locale,
-    };
-
-    /**
-     * The date and time at which the event ends
-     * @type {Date}
-     */
-    this.expiry = parseDate(data.Expiry);
-
-    /**
-     * The event's main score goal
-     * @type {number}
-     */
-    this.maximumScore = Number.parseInt(data.Goal, 10);
-
-    /**
-     * The current score on the event
-     * @type {number}
-     */
-    this.currentScore = Number.parseInt(data.Count, 10);
-
-    /**
-     * The first intermediate score goal
-     * @type {?number}
-     */
-    this.smallInterval = Number.parseInt(data.GoalInterim, 10);
-
-    /**
-     * The second intermediate score goal
-     * @type {?number}
-     */
-    this.largeInterval = Number.parseInt(data.GoalInterim2, 10);
-
-    /**
-     * The faction that the players must fight in the event
-     * @type {string}
-     */
-    this.faction = faction(data.Faction, locale);
-
-    /**
-     * The description of the event
-     * @type {string}
-     */
-    this.description = languageString(data.Desc, locale);
-
-    /**
-     * Tooltip for the event
-     * @type {?string}
-     */
-    this.tooltip = languageString(data.ToolTip, locale);
-
-    /**
-     * The node where the event takes place
-     * @type {?string}
-     */
-    this.node = node(data.Node, locale);
-
-    /**
-     * The other nodes where the event takes place
-     * @type {string[]}
-     */
-    this.concurrentNodes = data.ConcurrentNodes ? data.ConcurrentNodes.map((n) => node(n), locale) : [];
-
-    /**
-     * The victim node
-     * @type {?string}
-     */
-    this.victimNode = node(data.VictimNode, locale);
-
-    /**
-     * The score description
-     * @type {?string}
-     */
-    this.scoreLocTag = data.Fomorian ? 'Fomorian Assault Score' : languageString(data.ScoreLocTag, locale);
-
-    /**
-     * The event's rewards
-     * @type {Reward[]}
-     */
-    this.rewards = Object.keys(data)
-      .filter((k) => k.includes('Reward') || k.includes('reward'))
-      .map((k) => new Reward(data[k], opts));
-
-    /**
-     * Whether or not this is expired (at time of object creation)
-     * @type {boolean}
-     */
-    this.expired = this.getExpired();
-
-    /**
-     * Health remaining for the target
-     * @type {number}
-     */
-    this.health =
-      typeof data.HealthPct !== 'undefined' ? Number.parseFloat(((data.HealthPct || 0.0) * 100).toFixed(2)) : undefined;
-
-    this.jobs = [];
-    this.previousJobs = [];
-
-    /**
-     * Previous job id
-     * @type {string}
-     */
-    this.previousId = (data.JobPreviousVersion || {}).$oid;
-
-    /**
-     * Array of steps
-     * @type {InterimStep[]}
-     */
-    this.interimSteps = [];
-
-    (data.InterimRewards || []).forEach((reward, index) => {
-      const msg = (data.InterimRewardMessages || [])[index] || {};
-      this.interimSteps[index] = {
-        goal: Number.parseInt(data.InterimGoals[index], 10),
-        reward: reward ? new Reward(reward, opts) : undefined,
-        message: {
-          sender: languageString(msg.sender, locale),
-          subject: languageString(msg.subject, locale),
-          message: languageString(msg.message, locale),
-          senderIcon: msg.senderIcon,
-          attachments: msg.attachments,
-        },
-        // eslint-disable-next-line no-underscore-dangle
-        winnerCount: (data._interimWinnerCounts || [])[index],
-      };
-    });
-
-    /**
-     * Progress Steps, if any are present
-     * @type {ProgressStep[]}
-     */
-    this.progressSteps = [];
-
-    if (data.IsMultiProgress) {
-      data.Types.forEach((type, index) => {
-        this.progressSteps[index] = {
-          type: languageString(type, locale),
-          progressAmt: Number.parseInt(data.MultiProgress[index], 10),
-        };
-      });
-
-      /**
-       * Total of all MultiProgress
-       * @type {number}
-       */
-      this.progressTotal = Number.parseFloat(data.MultiProgress.reduce((accumulator, val) => accumulator + val));
-    }
-
-    /**
-     * Whether to show the total score at the end of the mission
-     * @type {boolean}
-     */
-    this.showTotalAtEndOfMission = data.ShowTotalAtEOM;
-    /**
-     * Whether the event is personal
-     * @type {boolean}
-     */
-    this.isPersonal = data.Personal;
-    /**
-     * Whether the event is community
-     * @type {boolean}
-     */
-    this.isCommunity = data.Community;
-
-    /*
-     * Affectors for this mission
-     * @type {string[]}
-     */
-    this.regionDrops = (data.RegionDrops || []).map((drop) => languageString(drop, locale));
-
-    /**
-     * Archwing Drops in effect while this event is active
-     * @type {string[]}
-     */
-    this.archwingDrops = (data.ArchwingDrops || []).map((drop) => languageString(drop, locale));
-
-    this.asString = this.toString();
-
-    /**
-     * Metadata provided by DE
-     * @type {object}
-     */
-    this.metadata = JSON.parse((data.Metadata || '{}').replace('" ', '"'));
-
-    /**
-     * Bonuses given for completion
-     * @type {Array.<number>}
-     */
-    this.completionBonuses = data.CompletionBonus || [];
-
-    this.scoreVar = data.ScoreVar;
-
-    this.altExpiry = parseDate(data.AltExpiry);
-    this.altActivation = parseDate(data.AltActivation);
-
-    this.nextAlt = {
-      expiry: parseDate(data.NextAltExpiry),
-      activation: parseDate(data.NextAltActivation),
-    };
-
-    if (data.JobAffiliationTag) {
-      this.affiliatedWith = syndicate(data.JobAffiliationTag, locale);
-    }
-
-    /**
-     * The event's tag
-     * @type {string}
-     */
-    this.tag = data.Tag;
-  }
-
-  /**
-   * Get whether the event has expired
-   * @returns {boolean} whether the event has expired
-   */
-  getExpired() {
-    return fromNow(this.expiry) < 0;
-  }
-
-  /**
-   * The event's string representation
-   * @returns {string} the event's string representation
-   */
-  toString() {
-    let lines = [];
-    if (this.faction) {
-      lines.push(`${this.description} : ${this.faction}`);
-    } else {
-      lines.push(this.description);
-    }
-
-    if (this.scoreLocTag && this.maximumScore) {
-      lines.push(`${this.scoreLocTag} : ${this.maximumScore}`);
-    }
-
-    if (this.rewards.length) {
-      lines.push('Rewards:');
-      lines = lines.concat(this.rewards.map((r) => r.toString()));
-    }
-    if (this.node) {
-      lines.push(`Battle on ${this.node}`);
-    }
-    if (this.victim) {
-      lines.push(`Protect ${this.victimNode}`);
-    }
-    if (this.health) {
-      lines.push(`${this.health}% Remaining`);
-    }
-
-    if (this.affiliatedWith && this.jobs) {
-      lines.push(
-        `${this.affiliatedWith} will reward you for performing ` +
-          `${this.jobs.map((job) => job.type).join(', ')} job${this.jobs.length > 1 ? 's' : ''}`
-      );
-    }
-
-    return lines.join(mdConfig.lineEnd);
-  }
-}