warframe-worldstate-parser 4.6.1 → 5.0.1

package/lib/models/WorldstateObject.js

@@ -1,106 +0,0 @@
-import { parseDate, fromNow, timeDeltaToString, insist } from 'warframe-worldstate-data/utilities';
-
-/**
- * @typedef {object} Identifier
- * @property {string} $id older identifier schema
- * @property {string} $oid newer global identifier schema
- */
-/**
- * @typedef {object} LegacyTimestamp
- * @property {number} sec second-based timestamp
- */
-/**
- * @typedef {object} Timestamp
- * @property {number} $numberLong millisecond-based timestamp
- */
-/**
- * @typedef {object} ContentTimestamp
- * @property {LegacyTimestamp|Timestamp} $date timestamp number wrapper
- */
-/**
- * @typedef {object} BaseContentObject
- * @property {Identifier} _id object identifier
- * @property {ContentTimestamp} Activation activation timestamp
- * @property {ContentTimestamp} Expiry expiry timestamp
- */
-
-/**
- * Represents a generic object from Worldstate
- */
-export default class WorldstateObject {
-  /**
-   * @param   {BaseContentObject} data The object data
-   */
-  constructor(data) {
-    insist(data);
-    /**
-     * The object's id field
-     * @type {Identifier.$id|Identifier.$oid}
-     */
-    // eslint-disable-next-line no-underscore-dangle
-    this.id = data._id ? data._id.$oid || data._id.$id : undefined;
-
-    if (data.Activation) {
-      /**
-       * The date and time at which the void trader arrives
-       * @type {Date}
-       */
-      this.activation = parseDate(data.Activation);
-
-      /**
-       * A string indicating how long it will take for the trader to arrive
-       *  (at time of object creation)
-       * @type {string}
-       */
-      this.startString = this.getStartString();
-    }
-
-    if (data.Expiry) {
-      /**
-       * The date and time at which the void trader leaves
-       * @type {Date}
-       */
-      this.expiry = parseDate(data.Expiry);
-    }
-
-    if (data.Activation && data.Expiry) {
-      /**
-       * Whether the void trader is active (at time of object creation)
-       * @type {boolean}
-       */
-      this.active = this.isActive();
-    }
-  }
-
-  /**
-   * Returns a string representation of the object
-   * @returns {string} basic representation from the id
-   */
-  toString() {
-    return `id: ${this.id}`;
-  }
-
-  /**
-   * Get whether 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));
-  }
-}

package/lib/models/ZarimanCycle.js

@@ -1,124 +0,0 @@
-import { fromNow, timeDeltaToString } from 'warframe-worldstate-data/utilities';
-
-import mdConfig from '../supporting/MarkdownSettings.js';
-
-import WorldstateObject from './WorldstateObject.js';
-
-// This is a confirmed starting time for Corpus (in millis)
-// All faction operation should use this as a calculation point
-// Unless there's a better logic
-const corpusTimeMillis = 1655182800000;
-const fullCycle = 18000000;
-const stateMaximum = 9000000;
-
-/**
- * Represents the current Zariman Corpus/Grineer Cycle
- * @augments {WorldstateObject}
- */
-export default class ZarimanCycle extends WorldstateObject {
-  /**
-   * The current zariman cycle, for calculating the other fields
-   * @type {object}
-   * @private
-   */
-  #ec;
-  /**
-   * The end of the Zariman bounties timer, the faction changes exactly half way through
-   * @type {Date}
-   * @private
-   */
-  #bountiesEndDate;
-
-  /**
-   * @param {Date} bountiesEndDate The current Zariman cycle expiry
-   */
-  constructor(bountiesEndDate) {
-    super({ _id: { $oid: 'zarimanCycle0' } });
-
-    this.#bountiesEndDate = bountiesEndDate;
-    this.#ec = this.getCurrentZarimanCycle();
-
-    /**
-     * 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 = new Date(this.#ec.start);
-
-    /**
-     * Whether or not this it's corpus or grineer
-     * @type {boolean}
-     */
-    this.isCorpus = this.#ec.isCorpus;
-
-    /**
-     * Current cycle state. One of `corpus`, `grineer`
-     * @type {string}
-     */
-    this.state = this.#ec.state;
-
-    /**
-     * Time remaining string
-     * @type {string}
-     */
-    this.timeLeft = this.#ec.timeLeft;
-
-    this.id = `zarimanCycle${this.expiry.getTime()}`;
-
-    this.shortString = `${this.timeLeft.replace(/\s\d*s/gi, '')} to ${this.isCorpus ? 'grineer' : 'corpus'}`;
-  }
-
-  /**
-   * Get whether the event has expired
-   * @returns {boolean} whether this is expired
-   */
-  getExpired() {
-    return this.expiry ? fromNow(this.expiry) < 0 : /* istanbul ignore next */ true;
-  }
-
-  getCurrentZarimanCycle() {
-    const now = Date.now();
-    // determine if it is corpus cycle or grineer cycle based on bounty end time
-    // we subtract 5000 millis (5 seconds) to ensure the corpus/grineer calculation is correct
-    const bountiesClone = this.#bountiesEndDate.getTime() - 5000;
-    const millisLeft = fromNow(new Date(bountiesClone));
-    // the following line is a modulus operation
-    // this ensures that our calculation is correct if bountiesClone is before corpusTimeMillis
-    // if you really care, read https://torstencurdt.com/tech/posts/modulo-of-negative-numbers/
-    const cycleTimeElapsed = (((bountiesClone - corpusTimeMillis) % fullCycle) + fullCycle) % fullCycle;
-    const cycleTimeLeft = fullCycle - cycleTimeElapsed;
-    // if timeInCycle is more than 2.5 hours, it is corpus, otherwise it is grineer
-    const isCorpus = cycleTimeLeft > stateMaximum;
-
-    const minutesCoef = 1000 * 60;
-    const expiry = new Date(Math.round((now + millisLeft) / minutesCoef) * minutesCoef);
-    const state = isCorpus ? 'corpus' : 'grineer';
-
-    return {
-      isCorpus,
-      timeLeft: timeDeltaToString(millisLeft),
-      expiry,
-      expiresIn: millisLeft,
-      state,
-      start: expiry.getTime() - stateMaximum,
-    };
-  }
-
-  /**
-   * The event's string representation
-   * @returns {string} string representation
-   */
-  toString() {
-    const lines = [
-      `Operator, Zariman Ten Zero is currently occupied by ${this.state}`,
-      `Time remaining until ${this.isCorpus ? 'grineer' : 'corpus'} takeover: ${this.timeLeft}`,
-    ];
-
-    return lines.join(mdConfig.lineEnd);
-  }
-}

package/lib/supporting/Dependency.js

@@ -1,6 +0,0 @@
-/**
- * Dependency Object
- * @property   {string}             locale     Locale to use for translations
- * @property   {object}             logger     Generic logger to use if needed
- */
-export default class Dependency {}

package/lib/supporting/DuviriChoice.js

@@ -1,16 +0,0 @@
-/**
- * Single category of duviri choices
- */
-export default class DuviriChoice {
-  constructor(data) {
-    switch (data.Category) {
-      case 'EXC_NORMAL':
-        this.category = 'normal';
-        break;
-      case 'EXC_HARD':
-        this.category = 'hard';
-    }
-    this.categoryKey = data.Category;
-    this.choices = data.Choices;
-  }
-}

package/lib/supporting/ExternalMission.js

@@ -1,13 +0,0 @@
-/**
- * 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
- */
-export default class ExternalMission {}

package/lib/supporting/ImgCdn.js

@@ -1,9 +0,0 @@
-export const cdn = (path) => `https://cdn.warframestat.us/genesis/${path}`;
-
-export const wfCdn = (path) => `https://cdn.warframestat.us/img/${path}`;
-
-export const deProxy = (url) =>
-  url
-    .replace('https://forums.warframe.com/applications/core/interface/imageproxy/imageproxy.php?img=', '')
-    .replace(/&key=\w*/gi, '')
-    .replace('http://', 'https://');

package/lib/supporting/MarkdownSettings.js

@@ -1,30 +0,0 @@
-/**
- * A collection of strings that are used by the parser to produce markdown-formatted text
- * @property {string} lineEnd      - Line return character
- * @property {string} blockEnd     - Block end string
- * @property {string} doubleReturn - Double line return string
- * @property {string} linkBegin    - Link begin string
- * @property {string} linkMid      - Link middle string
- * @property {string} linkEnd      - Link end string
- * @property {string} bold         - String for denoting bold text
- * @property {string} italic       - String for denoting italicized text
- * @property {string} underline    - String for denoting underlined text
- * @property {string} strike       - String for denoting striked-through text
- * @property {string} codeLine     - String for denoting in-line code
- * @property {string} codeBlock    - String for denoting multi-line code blocks
- */
-export default class MarkdownSettings {
-  static lineEnd = '\n';
-  static blockEnd = '\n```';
-  static doubleReturn = '\n\n';
-  static linkBegin = '[';
-  static linkMid = '](';
-  static linkEnd = ')';
-  static bold = '**';
-  static italic = '*';
-  static underline = '__';
-  static strike = '~~';
-  static codeLine = '`';
-  static codeBlock = '```';
-  static spoiler = '||';
-}

package/lib/supporting/RewardData.js

@@ -1,77 +0,0 @@
-export const resources = [
-  'Alloy Plate',
-  'Argon Crystal',
-  'Circuits',
-  'Control Module',
-  'Cryotic',
-  'Ferrite',
-  'Gallium',
-  'Morphics',
-  'Nano Spores',
-  'Neural Sensors',
-  'Neurodes',
-  'Orokin Cell',
-  'Oxium',
-  'Plastids',
-  'Polymer Bundle',
-  'Rubedo',
-  'Salvage',
-  'Tellurium',
-];
-
-// Aura names
-export const auras = [
-  'Brief Respite',
-  'Corrosive Projection',
-  'Dead Eye',
-  'EMP Aura',
-  'Empowered Blades',
-  'Enemy Radar',
-  'Energy Siphon',
-  'Growing Power',
-  'Infested Impedance',
-  'Loot Detector',
-  'Physique',
-  'Pistol Amp',
-  'Pistol Scavenger',
-  'Rejuvenation',
-  'Rifle Amp',
-  'Rifle Scavenger',
-  'Shield Disruption',
-  'Shotgun Amp',
-  'Shotgun Scavenger',
-  'Sniper Scavenger',
-  'Speed Holster',
-  'Sprint Boost',
-  'Stand United',
-  'Steel Charge',
-];
-
-// Nightmare mod names
-export const nightmare = [
-  'Accelerated Blast',
-  'Animal Instinct',
-  'Armored Agility',
-  'Blaze',
-  'Chilling Reload',
-  'Constitution',
-  'Drifting Contact',
-  'Focus Energy',
-  'Fortitude',
-  'Hammer Shot',
-  'Ice Storm',
-  'Lethal Torrent',
-  'Rending Strike',
-  'Stunning Speed',
-  'Wildfire',
-  'Seeking Fury',
-  'Streamlined Form',
-  'Shred',
-  'Vigor',
-];
-
-export default {
-  nightmare,
-  auras,
-  resources,
-};