warframe-worldstate-parser 4.6.2 → 5.0.1

package/lib/models/Sortie.js

@@ -1,143 +0,0 @@
-import wsData from 'warframe-worldstate-data';
-import {
-  fromNow,
-  parseDate,
-  timeDeltaToString,
-  languageString,
-  sortieBoss,
-  sortieFaction,
-} from 'warframe-worldstate-data/utilities';
-
-import mdConfig from '../supporting/MarkdownSettings.js';
-
-import WorldstateObject from './WorldstateObject.js';
-import SortieVariant from './SortieVariant.js';
-import Mission from './Mission.js';
-
-const { sortie: sortieData } = wsData;
-
-/**
- * Represents a daily sortie
- * @augments {WorldstateObject}
- */
-export default class Sortie extends WorldstateObject {
-  /**
-   * @param   {object}            data               The data for all daily sorties
-   * @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 = {
-      mdConfig,
-      sortieData,
-      locale,
-    };
-
-    /**
-     * The date and time at which the sortie starts
-     * @type {Date}
-     */
-    this.activation = parseDate(data.Activation);
-
-    /**
-     * The date and time at which the sortie ends
-     * @type {Date}
-     */
-    this.expiry = parseDate(data.Expiry);
-
-    /**
-     * The sortie's reward pool
-     * @type {string}
-     */
-    this.rewardPool = languageString(data.Reward, locale);
-
-    /**
-     * The sortie's variants
-     * @type {Array.<SortieVariant>}
-     */
-    this.variants = (data.Variants ?? []).map((v) => new SortieVariant(v, opts));
-
-    this.missions = (data.Missions ?? []).map((v) => new Mission(v, opts));
-
-    /**
-     * The sortie's boss
-     * @type {string}
-     */
-    this.boss = sortieBoss(data.Boss, locale);
-
-    /**
-     * The sortie's faction
-     * @type {string}
-     */
-    this.faction = sortieFaction(data.Boss, locale);
-
-    /**
-     * The sortie's faction
-     * @type {string}
-     */
-    this.factionKey = sortieFaction(data.Boss, 'en');
-
-    /**
-     * Whether this is expired (at time of object creation)
-     * @type {boolean}
-     */
-    this.expired = this.isExpired();
-
-    /**
-     * ETA string (at time of object creation)
-     * @type {string}
-     */
-    this.eta = this.getETAString();
-  }
-
-  /**
-   * Get the sortie's boss
-   * @returns {string} the sortie's boss
-   */
-  getBoss() {
-    return this.boss;
-  }
-
-  /**
-   * Get the sortie's faction
-   * @returns {string} the sortie's faction
-   */
-  getFaction() {
-    return this.faction;
-  }
-
-  /**
-   * Gets a string indicating how long it will take for the sortie to end
-   * @returns {string} estimated time of arrival
-   */
-  getETAString() {
-    return timeDeltaToString(fromNow(this.expiry));
-  }
-
-  /**
-   * Get whether or not the sortie has expired
-   * @returns {boolean} whether the sortie has expired
-   */
-  isExpired() {
-    return fromNow(this.expiry) < 0;
-  }
-
-  /**
-   * Returns the sortie's string representation
-   * @returns {string} the string representation
-   */
-  toString() {
-    if (this.isExpired()) {
-      return `${mdConfig.codeBlock}There's currently no sortie${mdConfig.blockEnd}`;
-    }
-
-    const variantString = this.variants.map((v) => v.toString()).join('');
-
-    return (
-      `${mdConfig.codeBlock}${this.getBoss()}: ends in ${this.getETAString()}` +
-      `${mdConfig.doubleReturn}${variantString}${mdConfig.blockEnd}`
-    );
-  }
-}

package/lib/models/SortieVariant.js

@@ -1,57 +0,0 @@
-import { missionType, node, sortieModDesc, sortieModifier, insist } from 'warframe-worldstate-data/utilities';
-
-import mdConfig from '../supporting/MarkdownSettings.js';
-
-/**
- * Represents a sortie variant
- * @class
- */
-export default class SortieVariant {
-  /**
-   * Make the SortieVariant
-   * @class
-   * @param {object} data Sortie variant data
-   * @param {object} deps Dependencies
-   * @param {string} deps.locale Locale to use for translations
-   */
-  constructor(data, { locale = 'en' } = { locale: 'en' }) {
-    insist(data);
-    /**
-     * The variant's mission type
-     * @type {string}
-     */
-    this.missionType = missionType(data.missionType, locale);
-
-    this.missionTypeKey = missionType(data.missionType, 'en');
-
-    /**
-     * The variant's modifier
-     * @type {string}
-     */
-    this.modifier = sortieModifier(data.modifierType, locale);
-
-    /**
-     * The variant's modifier description
-     * @type {string}
-     */
-    this.modifierDescription = sortieModDesc(data.modifierType, locale);
-
-    /**
-     * The node where the variant takes place
-     * @type {string}
-     */
-    this.node = node(data.node, locale);
-
-    this.nodeKey = node(data.node, 'en');
-  }
-
-  /**
-   * Returns a string representation of the sortie variant
-   * @returns {string} string representation
-   */
-  toString() {
-    return this.modifier
-      ? `${this.node.padEnd(25, ' ')} |  ${this.modifier.padEnd(20, ' ')} | ${this.missionType}${mdConfig.lineEnd}`
-      : `${this.node.padEnd(25, ' ')} | ${this.missionType}${mdConfig.lineEnd}`;
-  }
-}

package/lib/models/SteelPathOffering.js

@@ -1,99 +0,0 @@
-import { timeDeltaToString, steelPath } from 'warframe-worldstate-data/utilities';
-
-const monday = 1;
-
-/**
- * Gets the first day of the week
- * @returns {Date} first day of the week
- */
-function getFirstDayOfWeek() {
-  const resultDate = new Date();
-  /* istanbul ignore next */
-  const offset = resultDate.getUTCDay() === 0 ? 6 : resultDate.getUTCDay() - monday;
-  resultDate.setUTCDate(resultDate.getUTCDate() - offset);
-  resultDate.setUTCHours(0);
-  resultDate.setUTCMinutes(0);
-  resultDate.setUTCSeconds(0);
-  resultDate.setUTCMilliseconds(0);
-  return resultDate;
-}
-
-/**
- * Get the last day of the week
- * @returns {Date} last day of the week
- */
-function getLastDayOfWeek() {
-  const last = new Date(getFirstDayOfWeek());
-  last.setUTCDate(last.getUTCDate() + 6);
-  last.setUTCHours(23);
-  last.setUTCMinutes(59);
-  last.setUTCSeconds(59);
-  last.setUTCMilliseconds(0);
-  return last;
-}
-
-/**
- * When was the start of the day
- * @returns {Date} start of the day
- */
-function getStartOfDay() {
-  const today = new Date();
-  today.setUTCHours(0);
-  today.setUTCMinutes(0);
-  today.setUTCSeconds(0);
-  today.setUTCMilliseconds(0);
-  return today;
-}
-
-/**
- * When was the end of the day
- * @returns {Date} end of the day
- */
-function getEndOfDay() {
-  const last = new Date();
-  last.setUTCHours(23);
-  last.setUTCMinutes(59);
-  last.setUTCSeconds(59);
-  last.setUTCMilliseconds(0);
-  return last;
-}
-
-/**
- * Start of Steel Path cycle calculations
- * @type {Date}
- */
-const start = new Date('2020-11-16T00:00:00.000Z');
-
-export default class SteelPathOffering {
-  constructor({ locale }) {
-    const sSinceStart = (Date.now() - start.getTime()) / 1000;
-    const eightWeeks = 4838400;
-    const sevenDays = 604800;
-
-    const ind = Math.floor((sSinceStart % eightWeeks) / sevenDays);
-
-    this.currentReward = steelPath(locale).rotation[ind];
-
-    this.activation = getFirstDayOfWeek();
-
-    this.expiry = getLastDayOfWeek();
-
-    this.remaining = timeDeltaToString(this.expiry.getTime() - Date.now());
-
-    this.rotation = steelPath(locale).rotation;
-    this.evergreens = steelPath(locale).evergreen;
-
-    /**
-     * General data pertaining to incursions
-     * @type {object}
-     * @property {string} id Identifier for steel path incursion based on start of day.
-     * @property {Date} activation when the current incursions became active
-     * @property {Date} expiry when the current incursions become inactive
-     */
-    this.incursions = {
-      id: `spi:${getStartOfDay().getTime()}`,
-      activation: getStartOfDay(),
-      expiry: getEndOfDay(),
-    };
-  }
-}

package/lib/models/SyndicateJob.js

@@ -1,185 +0,0 @@
-import { languageString } from 'warframe-worldstate-data/utilities';
-
-import WorldstateObject from './WorldstateObject.js';
-
-const apiBase = process.env.API_BASE_URL || 'https://api.warframestat.us';
-const bountyRewardRegex = /(?:Tier([ABCDE])|Narmer)Table([ABC])Rewards/i;
-const ghoulRewardRegex = /GhoulBountyTable([AB])Rewards/i;
-
-/**
- * Determine the level string for the bounty
- * @param  {object} job Original raw job data
- * @returns {string}               level range string
- */
-const getLevelString = (job) => `${job.minEnemyLevel} - ${job.maxEnemyLevel}`;
-
-const determineLocation = (i18n, isVault, raw) => {
-  const last = String(i18n).split('/').slice(-1)[0];
-
-  const bountyMatches = last.match(bountyRewardRegex);
-  const ghoulMatches = last.match(ghoulRewardRegex);
-
-  const isBounty = bountyMatches && bountyMatches.length;
-  const isGhoul = ghoulMatches && ghoulMatches.length;
-  const isCetus = /eidolonjob/i.test(i18n);
-  const isVallis = /venusjob/i.test(i18n);
-  const isDeimos = /deimosmissionrewards/i.test(i18n);
-  const rotation = isBounty ? bountyMatches[2] : '';
-  const levelString = getLevelString(raw);
-
-  let location;
-  let levelClause;
-  if (isCetus) {
-    location = 'Earth/Cetus ';
-    if (isGhoul) {
-      levelClause = `(Level ${levelString} Ghoul Bounty)`;
-    } else {
-      levelClause = `(Level ${levelString} Cetus Bounty)`;
-    }
-  }
-  if (isVallis) {
-    location = 'Venus/Orb Vallis ';
-    levelClause = `(Level ${levelString} Orb Vallis Bounty)`;
-  }
-  if (isDeimos) {
-    location = 'Deimos/Cambion Drift '; // this will need to be updated when the actual drops are released
-    const variant = isVault ? 'Isolation Vault' : 'Cambion Drift Bounty';
-    levelClause = `(Level ${levelString} ${variant})`;
-  }
-  const locationWRot = `${location}${levelClause}, Rot ${rotation.length ? rotation : 'A'}`;
-  return { location, locationWRot };
-};
-
-const getBountyRewards = async (i18n, isVault, raw) => {
-  let location;
-  let locationWRot;
-  if (i18n.endsWith('PlagueStarTableRewards')) {
-    location = 'plague star';
-    locationWRot = 'Earth/Cetus (Level 15 - 25 Plague Star), Rot A';
-  }
-  if (!location || !locationWRot) {
-    ({ location, locationWRot } = determineLocation(i18n, isVault, raw));
-  }
-  const url = `${apiBase}/drops/search/${encodeURIComponent(location)}?grouped_by=location`;
-  const reply = await fetch(url)
-    .then((res) => res.json())
-    .catch(() => {}); // swallow errors
-  const pool = (reply || {})[locationWRot];
-  if (!pool) {
-    return ['Pattern Mismatch. Results inaccurate.'];
-  }
-  const results = pool.rewards;
-  if (results) {
-    return Array.from(new Set(results.map((result) => result.item)));
-  }
-  /* istanbul ignore next */
-  return [];
-};
-
-const FIFTY_MINUTES = 3000000;
-
-/**
- * Represents a syndicate daily mission
- * @augments {WorldstateObject}
- */
-export default class SyndicateJob extends WorldstateObject {
-  /**
-   * Generate a job with async data (reward pool)
-   * @param {object} data The syndicate mission data
-   * @param {Date} expiry The syndicate job expiration
-   * @param {object} deps The dependencies object
-   * @param {string} deps.locale Locale to use for translations
-   * @returns {Promise<SyndicateJob>} The created SyndicateJob object with rewardPool
-   */
-  static async build(data, expiry, deps) {
-    const job = new SyndicateJob(data, expiry, deps);
-    job.rewardPool = await getBountyRewards(data.rewards, data.isVault, data);
-
-    return job;
-  }
-
-  /**
-   * Construct a job without async data (reward pool)
-   * @param {object} data The syndicate mission data
-   * @param {Date} expiry The syndicate job expiration
-   * @param {object} deps The dependencies object
-   * @param {string} deps.locale Locale to use for translations
-   *
-   * This DOES NOT populate the reward pool
-   */
-  constructor(data, expiry, { locale = 'en' }) {
-    super({
-      _id: {
-        $oid: data.JobCurrentVersion
-          ? data.JobCurrentVersion.$oid
-          : `${(data.jobType || '').split('/').slice(-1)[0]}${expiry.getTime()}`,
-      },
-    });
-
-    /**
-     * Array of strings describing rewards
-     * @type {Array.<string>}
-     */
-    this.rewardPool = [];
-
-    const chamber = ((data.locationTag || '').match(/[A-Z]+(?![a-z])|[A-Z]?[a-z]+|\d+/g) || []).join(' ');
-
-    /**
-     * The type of job this is
-     * @type {string}
-     */
-    this.type = languageString(data.jobType, locale) || `${data.isVault ? 'Isolation Vault' : ''} ${chamber}`;
-
-    /**
-     * Array of enemy levels
-     * @type {Array.<number>}
-     */
-    this.enemyLevels = [data.minEnemyLevel, data.maxEnemyLevel];
-
-    /**
-     * Array of standing gains per stage of job
-     * @type {Array.<number>}
-     */
-    this.standingStages = data.xpAmounts;
-
-    /**
-     * Minimum mastery required to participate
-     * @type {number}
-     */
-    this.minMR = data.masteryReq || 0;
-
-    /**
-     * Whether or not this is a Vault job.
-     * No indication for difference of normal vs arcana vaults.
-     * @type {boolean}
-     */
-    this.isVault = data.isVault;
-
-    /**
-     * Corresponding chamber. Nullable
-     * @type {string|null}
-     */
-    this.locationTag = data.locationTag;
-
-    /**
-     * End time for the syndicate mission.
-     * Should be inherited from the Syndicate, but some are timebound.
-     * @type {Date}
-     */
-    this.expiry = expiry;
-
-    /**
-     * What time phase this bounty is bound to
-     * @type {string}
-     */
-    this.timeBound = undefined;
-    if (data.jobType && data.jobType.toLowerCase().includes('narmer')) {
-      if (data.jobType.toLowerCase().includes('eidolon')) {
-        this.timeBound = 'day';
-        this.expiry = new Date(this.expiry.getTime() - FIFTY_MINUTES);
-      } else {
-        this.timeBoound = 'night';
-      }
-    }
-  }
-}

package/lib/models/SyndicateMission.js

@@ -1,111 +0,0 @@
-import { fromNow, parseDate, timeDeltaToString, node, syndicate } from 'warframe-worldstate-data/utilities';
-
-import mdConfig from '../supporting/MarkdownSettings.js';
-
-import SyndicateJob from './SyndicateJob.js';
-import WorldstateObject from './WorldstateObject.js';
-
-/**
- * Represents a syndicate daily mission
- * @augments {WorldstateObject}
- */
-export default class SyndicateMission extends WorldstateObject {
-  /**
-   * Build a new SyndicateMission with async operations & data
-   * @param   {object}             data            The syndicate mission data
-   * @param   {object}             deps            The dependencies object
-   * @param   {string}             deps.locale     Locale to use for translations
-   * @returns {Promise.<SyndicateMission>}         SyndicateMission object w/ async resolution of jobs
-   */
-  static async build(data, deps) {
-    const syndicateMission = new SyndicateMission(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, syndicateMission.expiry, deps));
-      }
-      syndicateMission.jobs = jobs;
-    }
-
-    return syndicateMission;
-  }
-
-  /**
-   * @param   {object}             data            The syndicate mission 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 date and time at which the syndicate mission starts
-     * @type {Date}
-     */
-    this.activation = parseDate(data.Activation);
-
-    /**
-     * The date and time at which the syndicate mission ends
-     * @type {Date}
-     */
-    this.expiry = parseDate(data.Expiry);
-
-    /**
-     * The syndicate that is offering the mission
-     * @type {string}
-     */
-    this.syndicate = syndicate(data.Tag, locale);
-
-    /**
-     * The syndicate that is offering the mission
-     * @type {string}
-     */
-    this.syndicateKey = syndicate(data.Tag, 'en');
-
-    /**
-     * The nodes on which the missions are taking place
-     * @type {Array.<string>}
-     */
-    this.nodes = data.Nodes.map((n) => node(n), locale);
-
-    /**
-     * The jobs for this syndicate. Will normally be []
-     * @type {Array.<SyndicateJob>}
-     */
-    this.jobs = [];
-
-    /**
-     * Unique identifier for this mission set built from the end time and syndicate
-     * @type {string}
-     */
-    this.id = `${this.expiry.getTime()}${data.Tag}`;
-
-    /**
-     * ETA string (at time of object creation)
-     * @type {string} time delta string from now to the expiry
-     */
-    this.eta = this.getETAString();
-  }
-
-  /**
-   * Get a string indicating how much time is left before the syndicate mission expries
-   * @returns {string} time delta string from now to the expiry
-   */
-  getETAString() {
-    return timeDeltaToString(fromNow(this.expiry));
-  }
-
-  /**
-   * Returns a string representation of the syndicate mission
-   * @returns {string} the string representation
-   */
-  toString() {
-    if (this.nodes.length > 0) {
-      const missions = this.nodes.map((n) => `  \u2022${n.toString()}`).join(mdConfig.lineEnd);
-      return `[${this.getETAString()}] ${this.syndicate} currently has missions on:${mdConfig.lineEnd}${missions}`;
-    }
-
-    return `No missions available for ${this.syndicate}`;
-  }
-}