worldstate-emitter 2.2.13 → 2.3.0

package/handlers/events/eKeyOverrides.js

@@ -1,40 +0,0 @@
-import { logger } from '../../utilities/index.js';
-
-/**
- * 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 const fissures = (fissure) => `fissures.t${fissure.tierNum}.${(fissure.missionType || '').toLowerCase()}`;
-export const enemies = (acolyte) => ({
-  eventKey: `enemies${acolyte.isDiscovered ? '' : '.departed'}`,
-  activation: acolyte.lastDiscoveredAt,
-});
-
-/**
- * Parse an arbitration for its key
- * @param {ExternalMission} arbi arbitration data to parse
- * @returns {string}
- */
-export const arbitration = (arbi) => {
-  if (!arbi?.enemy) return '';
-
-  let k;
-  try {
-    k = `arbitration.${arbi.enemy.toLowerCase()}.${arbi.type.replace(/\s/g, '').toLowerCase()}`;
-  } catch (e) {
-    logger.error(`Unable to parse arbitraion: ${JSON.stringify(arbi)}\n${e}`);
-  }
-  return k;
-};
-
-export const events = 'operations';
-export const persistentEnemies = 'enemies';

package/handlers/events/kuva.js

@@ -1,31 +0,0 @@
-import { logger, groupBy } from '../../utilities/index.js';
-
-import objectLike from './objectLike.js';
-
-/**
- * Process kuva fields
- * @param  {Deps} deps    dependencies for processing
- * @param  {Object[]} packets  packets to emit
- * @returns {Object|Object[]}  object(s) to emit from kuva stuff
- */
-export default (deps, packets) => {
-  if (!deps.data) {
-    logger.error('no kuva data');
-    return undefined;
-  }
-  const data = groupBy(deps.data, 'type');
-  Object.keys(data).forEach((type) => {
-    deps = {
-      ...deps,
-      data: data[type],
-      id: `kuva.${data[type][0].type.replace(/\s/g, '').toLowerCase()}`,
-      activation: data[type][0].activation,
-      expiry: data[type][0].expiry,
-    };
-    const p = objectLike(deps.data, deps);
-    if (p) {
-      packets.push(p);
-    }
-  });
-  return packets.filter((p) => p);
-};

package/handlers/events/nightwave.js

@@ -1,35 +0,0 @@
-import objectLike from './objectLike.js';
-
-export default (nightwave, deps) => {
-  const groups = {
-    daily: [],
-    weekly: [],
-    elite: [],
-  };
-
-  (nightwave.activeChallenges || []).forEach((challenge) => {
-    if (challenge.isDaily) {
-      groups.daily.push(challenge);
-    } else if (challenge.isElite) {
-      groups.elite.push(challenge);
-    } else {
-      groups.weekly.push(challenge);
-    }
-  });
-
-  const packets = [];
-  Object.keys(groups).forEach((group) => {
-    const p = objectLike(
-      {
-        ...nightwave,
-        activeChallenges: groups[group],
-      },
-      {
-        ...deps,
-        id: `nightwave.${group}`,
-      }
-    );
-    packets.push(p);
-  });
-  return packets;
-};

package/handlers/events/objectLike.js

@@ -1,17 +0,0 @@
-import { between, lastUpdated } from '../../utilities/index.js';
-
-export default (data, deps) => {
-  if (!data) return undefined;
-  const last = new Date(lastUpdated[deps.platform][deps.language]);
-  const activation = new Date(data.activation);
-  const start = new Date(deps.cycleStart);
-  if (between(last, activation, start)) {
-    const p = {
-      ...deps,
-      data,
-      id: deps.id || deps.key,
-    };
-    return p;
-  }
-  return undefined;
-};

package/handlers/events/parse.js

@@ -1,82 +0,0 @@
-import { lastUpdated } from '../../utilities/index.js';
-
-import checkOverrides from './checkOverrides.js';
-import kuvaProcessing from './kuva.js';
-import arrayLike from './arrayLike.js';
-import objectLike from './objectLike.js';
-import nightwave from './nightwave.js';
-import cycleLike from './cycleLike.js';
-import * as eKeyOverrides from './eKeyOverrides.js';
-
-/**
- * @typedef {Object} Deps
- * @property {string} key event key being parsed
- * @property {string} platform platform the event is on
- * @property {string} language language the event is in
- * @property {Date} cycleStart start of the current cycle
- * @property {Object|Array} data data to parse
- */
-
-/**
- * Set up current cycle start if it's not been initiated
- * @param  {Deps} deps    dependencies for processing
- */
-const initCycleStart = (deps) => {
-  if (!lastUpdated[deps.platform][deps.language]) {
-    lastUpdated[deps.platform][deps.language] = deps.cycleStart;
-  }
-};
-
-/**
- * Parse new events from the provided worldstate
- * @param  {Deps} deps dependencies to parse out events
- * @returns {Packet|Packet[]}      packet(s) to emit
- */
-export default (deps) => {
-  initCycleStart(deps);
-
-  // anything in the eKeyOverrides goes first, then anything uniform
-  const packets = [];
-  switch (deps.key) {
-    case 'kuva':
-      return kuvaProcessing(deps, packets);
-    case 'events':
-      deps = {
-        ...deps,
-        id: eKeyOverrides[deps.key],
-      };
-    case 'alerts':
-    case 'conclaveChallenges':
-    case 'dailyDeals':
-    case 'flashSales':
-    case 'fissures':
-    case 'globalUpgrades':
-    case 'invasions':
-    case 'syndicateMissions':
-    case 'weeklyChallenges':
-      packets.push(...arrayLike(deps, packets));
-      break;
-    case 'cetusCycle':
-    case 'earthCycle':
-    case 'vallisCycle':
-      packets.push(cycleLike(deps.data, deps));
-      break;
-    case 'persistentEnemies':
-      deps = {
-        ...deps,
-        ...checkOverrides(deps.key, deps.data),
-      };
-    case 'sortie':
-    case 'voidTrader':
-    case 'arbitration':
-    case 'sentientOutposts':
-      deps.id = checkOverrides(deps.key, deps.data);
-      packets.push(objectLike(deps.data, deps));
-    case 'nightwave':
-      packets.push(nightwave(deps.data, deps));
-    default:
-      break;
-  }
-
-  return packets;
-};

package/index.js

@@ -1,96 +0,0 @@
-import EventEmitter from 'node:events';
-
-import RSS from './handlers/RSS.js';
-import Worldstate from './handlers/Worldstate.js';
-import Twitter from './handlers/Twitter.js';
-import { logger } from './utilities/index.js';
-import { FEATURES } from './resources/config.js';
-
-export default class WorldstateEmitter extends EventEmitter {
-  #locale;
-  #worldstate;
-  #twitter;
-  #rss;
-
-  static async make({ locale, features } = { locale: undefined, features: [] }) {
-    const emitter = new WorldstateEmitter({ locale });
-    await emitter.#init(features?.length ? features : FEATURES);
-    return emitter;
-  }
-
-  /**
-   * Pull in and instantiate emitters
-   * @param {string} locale language to restrict events to
-   */
-  constructor({ locale } = { locale: undefined }) {
-    super();
-    this.#locale = locale;
-  }
-
-  async #init(/** @type {string[]} */ features) {
-    if (features.includes('rss')) {
-      this.#rss = new RSS(this);
-    }
-    if (features.includes('worldstate')) {
-      this.#worldstate = new Worldstate(this, this.#locale);
-      await this.#worldstate.init();
-    }
-    if (features.includes('twitter')) {
-      this.#twitter = new Twitter(this);
-    }
-
-    logger.silly('hey look, i started up...');
-    this.setupLogging();
-  }
-
-  /**
-   * Set up internal logging
-   * @private
-   */
-  setupLogging() {
-    this.on('error', logger.error);
-
-    this.on('rss', (body) => logger.silly(`emitted: ${body.id}`));
-    this.on('ws:update:raw', (body) => logger.silly(`emitted raw: ${body.platform}`));
-    this.on('ws:update:parsed', (body) => logger.silly(`emitted parsed: ${body.platform} in ${body.language}`));
-    this.on('ws:update:event', (body) =>
-      logger.silly(`emitted event: ${body.id} ${body.platform} in ${body.language}`)
-    );
-    this.on('tweet', (body) => logger.silly(`emitted: ${body.id}`));
-  }
-
-  /**
-   * Get current rss feed items
-   * @returns {Object} [description]
-   */
-  getRss() {
-    if (!this.#rss) return undefined;
-    return this.#rss.feeder.list.map((i) => ({ url: i.url, items: i.items }));
-  }
-
-  /**
-   * Get a specific worldstate, defaulting to 'pc' for the platform and 'en' for the language
-   * @param  {string} [language='en']   locale/languate to fetch
-   * @returns {Object}                 Requested worldstate
-   */
-  getWorldstate(language = 'en') {
-    if (!this.#worldstate) return undefined;
-    return this.#worldstate?.get(language);
-  }
-
-  get debug() {
-    return {
-      rss: FEATURES.includes('rss') ? this.getRss() : undefined,
-      worldstate: FEATURES.includes('worldstate') ? this.#worldstate?.get() : undefined,
-      twitter: this.#twitter?.clientInfoValid ? this.#twitter.getData() : undefined,
-    };
-  }
-
-  /**
-   * Get Twitter data
-   * @returns {Promise} promised twitter data
-   */
-  async getTwitter() {
-    return this.#twitter?.clientInfoValid ? this.twitter.getData() : undefined;
-  }
-}

package/nodemon.json

@@ -1,9 +0,0 @@
-{
-  "delay": 5000,
-  "env": {
-    "LOG_LEVEL": "debug",
-    "CACHE_TIMEOUT": 60000,
-    "SEMLAR_TIMEOUT": 300000,
-    "FEATURES": "worldstate"
-  }
-}

package/resources/config.js

@@ -1,8 +0,0 @@
-export const worldstateUrl = process.env.WORLDSTATE_URL ?? 'https://api.warframe.com/cdn/worldState.php';
-export const kuvaUrl = process.env.KUVA_URL ?? 'https://10o.io/arbitrations.json';
-export const sentientUrl = process.env.SENTIENT_URL ?? 'https://semlar.com/anomaly.json';
-
-export const worldstateCron = process.env.WORLDSTATE_CRON ?? '25 */5 * * * *';
-export const externalCron = process.env.WS_EXTERNAL_CRON ?? '0 */10 * * * *';
-
-export const FEATURES = process.env.WS_EMITTER_FEATURES ? process.env.WS_EMITTER_FEATURES.split(',') : [];

package/resources/rssFeeds.json

@@ -1,129 +0,0 @@
-[
-  {
-    "url": "https://forums.warframe.com/forum/38-players-helping-players.xml",
-    "key": "players_helping_players",
-    "defaultAttach": "https://i.imgur.com/cuk4ro9.png"
-  },
-  {
-    "url": "https://forums.warframe.com/forum/3-pc-update-notes.xml",
-    "key": "forum.updates.pc",
-    "defaultAttach": "https://i.imgur.com/eY1NkzO.png"
-  },
-  {
-    "url": "https://forums.warframe.com/forum/170-announcements-events.xml",
-    "key": "forum.news",
-    "defaultAttach": "https://i.imgur.com/CNrsc7V.png"
-  },
-  {
-    "url": "https://forums.warframe.com/forum/123-developer-workshop-update-notes.xml",
-    "key": "forum.workshop"
-  },
-  {
-    "url": "https://forums.warframe.com/discover/837.xml",
-    "key": "forum.staff.megan",
-    "author": {
-      "name": "[DE]Megan",
-      "url": "https://forums.warframe.com/profile/384139-demegan/",
-      "icon_url": "https://content.invisioncic.com/Mwarframe/monthly_2017_06/ezgif.com-crop.thumb.gif.e510920610e8489a54dd5dbe8b9fd4db.gif"
-    }
-  },
-  {
-    "url": "https://forums.warframe.com/discover/839.xml",
-    "key": "forum.staff.rebecca",
-    "author": {
-      "name": "[DE]Rebecca",
-      "url": "https://forums.warframe.com/profile/4-derebecca/",
-      "icon_url": "https://content.invisioncic.com/Mwarframe/pages_media/1_PlayerAvatarsInkary.png"
-    }
-  },
-  {
-    "url": "https://forums.warframe.com/discover/840.xml",
-    "key": "forum.staff.danielle",
-    "author": {
-      "name": "[DE]Danielle",
-      "url": "https://forums.warframe.com/profile/869879-dedanielle/",
-      "icon_url": "https://content.invisioncic.com/Mwarframe/monthly_2018_04/profile.thumb.jpg.fe072e16d5b54892b95030ea410264e7.jpg"
-    }
-  },
-  {
-    "url": "https://forums.warframe.com/discover/841.xml",
-    "key": "forum.staff.drew",
-    "author": {
-      "name": "[DE]Drew",
-      "url": "https://forums.warframe.com/profile/488958-dedrew/",
-      "icon_url": "https://content.invisioncic.com/Mwarframe/monthly_2016_06/576c323f14e92_AnimatedAvatarMirrored.thumb.gif.f12f2373d0d4b91363647f35b30026e0.gif"
-    }
-  },
-  {
-    "url": "https://forums.warframe.com/discover/842.xml",
-    "key": "forum.staff.glen",
-    "author": {
-      "name": "[DE]Glen",
-      "url": "https://forums.warframe.com/profile/10-deglen/",
-      "icon_url": "https://content.invisioncic.com/Mwarframe/monthly_2016_05/57474a4312a72_GlensHorse.thumb.png.7b47cb0660f5af2e6101ed84d3192c03.png"
-    }
-  },
-  {
-    "url": "https://forums.warframe.com/discover/1171.xml",
-    "key": "forum.staff.taylor",
-    "author": {
-      "name": "[DE]taylor",
-      "url": "https://forums.warframe.com/profile/1943322-detaylor/",
-      "icon_url": "https://content.invisioncic.com/Mwarframe/monthly_2017_07/596ceb9b4e182_6FUC4s3%281%29.thumb.png.7045d25fc7b057c70ddcffe14cd1f43e.png"
-    }
-  },
-  {
-    "url": "https://forums.warframe.com/discover/1777.xml",
-    "key": "forum.staff.steve",
-    "author": {
-      "name": "[DE]Steve",
-      "url": "https://forums.warframe.com/profile/24-desteve/",
-      "icon_url": "https://content.invisioncic.com/Mwarframe/monthly_2016_06/575f13eaf3080_Pastedimageat2016_06_1304_11PM.thumb.png.fb98af24931a1820d00293a55c05baef.png"
-    }
-  },
-  {
-    "url": "https://forums.warframe.com/discover/1291.xml",
-    "key": "forum.staff.helen",
-    "author": {
-      "name": "[DE]Helen",
-      "url": "https://forums.warframe.com/profile/2522846-dehelen/",
-      "icon_url": "https://content.invisioncic.com/Mwarframe/monthly_2017_06/590e937e598f2_Helen-Icon.jpg.0ac6d3d86c1d48f3f3e1a035344ab87a.thumb.jpg.d2225fb0dcd980f081ddddbf46458072.jpg"
-    }
-  },
-  {
-    "url": "https://forums.warframe.com/discover/1294.xml",
-    "key": "forum.staff.saske",
-    "author": {
-      "name": "[DE]Saske",
-      "url": "https://forums.warframe.com/profile/4513168-nswdesaske/",
-      "icon_url": "https://content.invisioncic.com/Mwarframe/pages_media/1_TennoCon2018Glyph.png"
-    }
-  },
-  {
-    "url": "https://forums.warframe.com/discover/1295.xml",
-    "key": "forum.staff.syncrasis",
-    "author": {
-      "name": "[DE]Syncrasis",
-      "url": "https://forums.warframe.com/profile/2514676-desyncrasis//",
-      "icon_url": "https://content.invisioncic.com/Mwarframe/monthly_2017_02/aladv.thumb.jpg.a06cbfa091579eb9ce2ae96eb0b42e34.jpg"
-    }
-  },
-  {
-    "url": "https://forums.warframe.com/discover/1299.xml",
-    "key": "forum.staff.pablo",
-    "author": {
-      "name": "[DE]Pablo",
-      "url": "https://forums.warframe.com/profile/217656-depablo/",
-      "icon_url": "https://content.invisioncic.com/Mwarframe/monthly_2016_05/Pablo.thumb.png.35bb0384ef7b88e807d55ffc31af0896.png"
-    }
-  },
-  {
-    "url": "https://forums.warframe.com/discover/1779.xml",
-    "key": "forum.staff.marcus",
-    "author": {
-      "name": "[DE]Marcus",
-      "url": "https://forums.warframe.com/profile/3443485-demarcus/",
-      "icon_url": "https://content.invisioncic.com/Mwarframe/monthly_2018_01/5a55278d71caa_MarcusIIPrint.thumb.jpg.16cb689d778112333cffb6fe546b89ec.jpg"
-    }
-  }
-]

package/resources/tweeters.json

@@ -1,17 +0,0 @@
-[
-  { "acc_name": "@playwarframe", "plain": "warframe" },
-  { "acc_name": "@digitalextremes", "plain": "digitalextremes" },
-  { "acc_name": "@PabloMakes", "plain": "pablo" },
-  { "acc_name": "@Cam_Rogers", "plain": "cameron" },
-  { "acc_name": "@rebbford", "plain": "rebecca" },
-  { "acc_name": "@sj_sinclair", "plain": "steve" },
-  { "acc_name": "@soelloo", "plain": "danielle" },
-  { "acc_name": "@moitoi", "plain": "megan" },
-  { "acc_name": "@GameSoundDesign", "plain": "george" },
-  { "acc_name": "@msinilo", "plain": "maciej" },
-  { "acc_name": "@sheldoncarter", "plain": "sheldon" },
-  { "acc_name": "@MarcusKretz", "plain": "marcus" },
-  { "acc_name": "@Helen_Heikkila", "plain": "helen" },
-  { "acc_name": "@tobitenno", "plain": "tobiah" },
-  { "acc_name": "@wfdiscord", "plain": "wfdiscord" }
-]

package/utilities/Cache.js

@@ -1,69 +0,0 @@
-import { EventEmitter } from 'node:events';
-
-import { CronJob } from 'cron';
-
-import { logger } from './index.js';
-
-export default class CronCache extends EventEmitter {
-  #url = undefined;
-  #pattern = '0 */10 * * * *'; // default: every 10 minutes
-  #job /** @type {CronJob} */ = undefined;
-  /** @type string */ #data = '';
-  #updating = undefined;
-  #logger = logger;
-
-  static async make(url, pattern) {
-    const cache = new CronCache(url, pattern);
-    await cache.#update();
-    return cache;
-  }
-
-  constructor(/** @type string */ url, /** @type string */ pattern) {
-    super();
-    this.#url = url;
-    if (pattern) this.#pattern = pattern;
-    this.#job = new CronJob(this.#pattern, this.#update.bind(this), undefined, true);
-    this.#job.start();
-  }
-
-  async #update() {
-    this.#updating = this.#fetch();
-    this.#logger.debug(`update starting  for ${this.#url}`);
-    let error;
-    try {
-      this.#data = await this.#updating;
-      return this.#updating;
-    } catch (e) {
-      this.#data = undefined;
-      error = e;
-    } finally {
-      if (this.#data) {
-        this.emit('update', this.#data);
-        this.#logger.debug(`update done for ${this.#url}`);
-      } else {
-        this.#logger.debug(`update failed for ${this.#url} : ${error}`);
-      }
-      this.#updating = undefined;
-    }
-  }
-
-  async #fetch() {
-    logger.silly(`fetching... ${this.#url}`);
-    const updated = await fetch(this.#url);
-    this.#data = await updated.text();
-    return this.#data;
-  }
-
-  async get() {
-    if (this.#updating) {
-      logger.silly('returning in-progress update promise');
-      return this.#updating;
-    }
-    if (!this.#data) {
-      logger.silly('returning new update promise');
-      return this.#update();
-    }
-    logger.silly('returning cached data');
-    return this.#data;
-  }
-}

package/utilities/WSCache.js

@@ -1,96 +0,0 @@
-import WorldState from 'warframe-worldstate-parser';
-
-import { logger } from './index.js';
-
-/**
- * Warframe WorldState Cache - store and retrieve current worldstate data
- */
-export default class WSCache {
-  #inner;
-  #kuvaCache;
-  #sentientCache;
-  #logger = logger;
-  #emitter;
-  /** @type string */ #platform = 'pc';
-  /** @type string */ #language;
-
-  /**
-   * Set up a cache checking for data and updates to a specific worldstate set
-   * @param {string}        language      Language/translation to track
-   * @param {Cache}     kuvaCache     Cache of kuva data, provided by Semlar
-   * @param {Cache}     sentientCache Cache of sentient outpost data, provided by Semlar
-   * @param {EventEmitter}  eventEmitter  Emitter to push new worldstate updates to
-   */
-  constructor({ language, kuvaCache, sentientCache, eventEmitter }) {
-    this.#inner = undefined;
-    this.#kuvaCache = kuvaCache;
-    this.#sentientCache = sentientCache;
-    this.#language = language;
-    this.#emitter = eventEmitter;
-  }
-
-  /**
-   * Update the current data with new data
-   * @param {string} newData updated worldstate data
-   * @returns {Promise<void>}
-   */
-  #update = async (newData) => {
-    const deps = {
-      locale: this.#language,
-      kuvaData: {},
-      sentientData: {},
-    };
-    try {
-      deps.kuvaData = JSON.parse(await this.#kuvaCache.get());
-    } catch (err) {
-      logger.debug(`Error parsing kuva data for ${this.#language}: ${err}`);
-    }
-    try {
-      deps.sentientData = JSON.parse(await this.#sentientCache.get());
-    } catch (err) {
-      logger.warn(`Error parsing sentient data for ${this.#language}: ${err}`);
-    }
-
-    let t;
-    try {
-      t = await WorldState.build(newData, deps);
-      if (!t.timestamp) return;
-    } catch (err) {
-      this.#logger.warn(`Error parsing worldstate data for ${this.#language}: ${err}`);
-      return;
-    }
-
-    this.#inner = t;
-    this.#emitter.emit('ws:update:parsed', {
-      language: this.#language,
-      platform: this.#platform,
-      data: t,
-    });
-  };
-
-  /**
-   * Get the latest worldstate data from this cache
-   * @returns {Object} Current worldstate data
-   */
-  get data() {
-    return this.#inner;
-  }
-
-  /**
-   * Set the current data, aslso parses and emits data
-   * @param  {string} newData New string data to parse
-   */
-  set data(newData) {
-    logger.debug(`got new data for ${this.#language}, parsing...`);
-    this.#update(newData);
-  }
-
-  /**
-   * Set the current twitter data for the worldstate
-   * @param  {Object} newTwitter twitter data
-   */
-  set twitter(newTwitter) {
-    if (!(newTwitter && newTwitter.length)) return;
-    this.#inner.twitter = newTwitter;
-  }
-}

package/utilities/env.js

@@ -1,10 +0,0 @@
-// eslint-disable-next-line import/prefer-default-export
-export const LOG_LEVEL = process?.env?.LOG_LEVEL || 'error';
-
-export const twiClientInfo = {
-  consumer_key: process?.env?.TWITTER_KEY,
-  consumer_secret: process?.env?.TWITTER_SECRET,
-  bearer_token: process?.env?.TWITTER_BEARER_TOKEN,
-};
-
-export const TWITTER_TIMEOUT = process?.env?.TWITTER_TIMEOUT || 60000;