worldstate-emitter 2.2.12 → 2.3.0

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "worldstate-emitter",
-  "version": "2.2.12",
-  "description": "Event emitter for worldstate & other warframe events",
+  "version": "2.3.0",
+  "description": "Event emitter for Warframe worldstate & other events - TypeScript support included",
   "keywords": [
     "warframe",
     "worldstate",
     "event",
-    "emitter"
+    "emitter",
+    "typescript",
+    "types"
   ],
   "homepage": "https://wfcd.github.io/worldstate-emitter/",
   "bugs": {
@@ -20,50 +22,73 @@
   "author": "tobiah <tobiah@protonmail.com>",
   "type": "module",
   "exports": {
-    ".": "./index.js"
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
+    }
   },
-  "main": "index.js",
+  "main": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
   "directories": {
     "test": "test/specs"
   },
+  "files": [
+    "dist/",
+    "LICENSE"
+  ],
   "scripts": {
-    "build:docs": "jsdoc -c jsdoc-config.json -d docs",
-    "coverage": "npm test && npm run report && npx coveralls < coverage/lcov.info",
-    "dev": "nodemon test/tester.js",
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix",
-    "prepare": "husky && npx install-peerdeps @wfcd/eslint-config@latest -S",
+    "build": "tsdown",
+    "build:docs": "typedoc",
+    "precoverage": "npm run build",
+    "coverage": "c8 mocha --config .mocharc.integration.yml && npm run report && npx coveralls < coverage/lcov.info",
+    "dev": "nodemon --exec tsx test/tester.ts",
+    "lint": "biome check",
+    "lint:fix": "biome check --write",
+    "prepare": "husky",
+    "prepublishOnly": "npm run build",
     "report": "c8 report --reporter=text-lcov > coverage/lcov.info",
-    "pretest": "npm i --no-save warframe-worldstate-data@^3 warframe-worldstate-parser@^5",
-    "test": "c8 mocha"
+    "pretest": "npm i --no-save warframe-worldstate-data@^3 warframe-worldstate-parser@^5 && npm run build",
+    "test": "LOG_LEVEL=silent mocha",
+    "test:all": "npm test && npm run test:integration",
+    "test:integration": "LOG_LEVEL=silent mocha --config .mocharc.integration.yml"
   },
   "dependencies": {
     "cron": "^4.3.4",
     "rss-feed-emitter": "^3.2.4",
+    "sanitize-html": "^2.17.0",
     "twitter": "^1.7.1"
   },
   "devDependencies": {
+    "@biomejs/biome": "^2.3.11",
     "@commitlint/cli": "^20.1.0",
     "@commitlint/config-conventional": "^20.0.0",
-    "@wfcd/eslint-config": "latest",
+    "@types/chai": "^5.2.3",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^20.19.28",
+    "@types/sanitize-html": "^2.16.0",
+    "@types/sinon": "^21.0.0",
+    "@types/twitter": "^1.7.4",
     "c8": "^10.1.3",
     "chai": "^6.2.1",
     "husky": "^9.1.7",
-    "install-peerdeps": "^3.0.7",
     "lint-staged": "^16.2.7",
     "mocha": "^11.7.5",
     "nodemon": "^3.1.11",
-    "prettier": "^3.7.2"
+    "sinon": "^21.0.1",
+    "tsdown": "^0.19.0",
+    "tsx": "^4.21.0",
+    "typedoc": "^0.28.15",
+    "typescript": "^5.9.3"
   },
   "peerDependencies": {
     "warframe-worldstate-data": "^3.x",
-    "warframe-worldstate-parser": "^5.x"
+    "warframe-worldstate-parser": "^5.2.14"
   },
   "optionalDependencies": {
     "winston": "^3.18.3"
   },
   "engines": {
-    "node": ">= 18.19.0"
+    "node": ">=20.10.0"
   },
   "publishConfig": {
     "provenance": true

package/.babelrc.json

@@ -1,4 +0,0 @@
-{
-  "plugins": ["@babel/plugin-transform-class-properties", "@babel/plugin-transform-private-methods"],
-  "presets": ["@babel/preset-env"]
-}

package/.commitlintrc.yml

@@ -1,5 +0,0 @@
-extends:
-  - '@commitlint/config-conventional'
-rules:
-  body-max-line-length:
-    - 0

package/.eslintignore

@@ -1,5 +0,0 @@
-.github/**
-docs/**
-resources/**
-!resources/config.js
-types/**

package/.eslintrc.yml

@@ -1,9 +0,0 @@
-parser: '@babel/eslint-parser'
-parserOptions:
-  ecmaFeatures:
-    modules: true
-  ecmaVersion: 6
-  sourceType: module
-extends: '@wfcd/eslint-config/esm'
-rules:
-  no-underscore-dangle: 'off'

package/.husky/commit-msg

@@ -1 +0,0 @@
-npx --no -- commitlint --edit $1

package/.husky/pre-commit

@@ -1 +0,0 @@
-npx lint-staged

package/.lintstagedrc.yml

@@ -1,9 +0,0 @@
-'*.js':
-  - eslint --cache --fix
-  - npm test
-package*.json:
-  - prettier --write
-  - npm dedupe
-  - npx sort-package-json
-'*.{json,yml,yaml}':
-  - prettier --write

package/.mocharc.yml

@@ -1,3 +0,0 @@
-exit: true
-spec: test/specs/**/*.spec.js
-timeout: 250000

package/.nvmrc

@@ -1 +0,0 @@
-lts/jod

package/.nycrc.yml

@@ -1,4 +0,0 @@
-reporter:
-  - lcov
-  - text
-skip-full: true

package/.prettierrc

@@ -1 +0,0 @@
-"@wfcd/eslint-config/prettier"

package/.releaserc.yml

@@ -1 +0,0 @@
-branches: master

package/SECURITY.md

@@ -1,17 +0,0 @@
-# Security Policy
-
-## Supported Versions
-
-All versions are supported, but it's recommended to stay on the always current version.
-There may be known vulnerabilities in development dependencies that are avoidable.
-
-| Version | Supported          |
-| ------- | ------------------ |
-| 1.x+    | :white_check_mark: |
-| < 1.0   | :x:
-
-## Reporting a Vulnerability
-
-Vulnerabilities from version updates should have automated PRs from dependabot.
-
-If there is a vulnerability in the code itself, please submit an issue (or also a PR if you have the solution), mentioning the vulnerability.

package/handlers/RSS.js

@@ -1,66 +0,0 @@
-import RssFeedEmitter from 'rss-feed-emitter';
-
-import feeds from '../resources/rssFeeds.json' with { type: 'json' };
-import { logger } from '../utilities/index.js';
-
-/**
- * RSS Emitter, leverages [rss-feed-emitter](https://npmjs.org/package/rss-feed-emitter)
- */
-export default class RSS {
-  /**
-   * Set up emitting events for warframe forum entries
-   * @param {EventEmitter} eventEmitter Emitter to send events from
-   */
-  constructor(eventEmitter) {
-    this.logger = logger;
-    this.emitter = eventEmitter;
-    this.feeder = new RssFeedEmitter({
-      userAgent: 'WFCD Feed Notifier',
-      skipFirstLoad: true,
-    });
-
-    feeds.forEach((feed) => {
-      this.feeder.add({ url: feed.url, timeout: 30000 });
-    });
-    this.logger.debug('RSS Feed active');
-
-    this.start = Date.now();
-    this.feeder.on('error', this.logger.error.bind(this.logger));
-    this.feeder.on('new-item', this.handleNew.bind(this));
-  }
-
-  handleNew(item) {
-    try {
-      if (Object.keys(item.image).length) {
-        this.logger.debug(`Image: ${JSON.stringify(item.image)}`);
-      }
-      if (new Date(item.pubDate).getTime() <= this.start) return;
-
-      const feed = feeds.filter((feedEntry) => feedEntry.url === item.meta.link)[0];
-      let firstImg = ((item.description || '').match(/<img.*src="(.*)".*>/i) || [])[1];
-      if (!firstImg) {
-        firstImg = feed.defaultAttach;
-      } else if (firstImg.startsWith('//')) {
-        firstImg = firstImg.replace('//', 'https://');
-      }
-
-      const rssSummary = {
-        body: (item.description || '\u200B').replace(/<(?:.|\n)*?>/gm, '').replace(/\n\n+\s*/gm, '\n\n'),
-        url: item.link,
-        timestamp: item.pubDate,
-        description: item.meta.description,
-        author: feed.author || {
-          name: 'Warframe Forums',
-          url: item['rss:link']['#'],
-          icon_url: 'https://i.imgur.com/hE2jdpv.png',
-        },
-        title: item.title,
-        image: firstImg,
-        id: feed.key,
-      };
-      this.emitter.emit('rss', rssSummary);
-    } catch (error) {
-      this.logger.error(error);
-    }
-  }
-}

package/handlers/Twitter.js

@@ -1,169 +0,0 @@
-import Twitter from 'twitter';
-
-import toWatch from '../resources/tweeters.json' with { type: 'json' };
-import { logger } from '../utilities/index.js';
-import { twiClientInfo, TWITTER_TIMEOUT } from '../utilities/env.js';
-
-const determineTweetType = (tweet) => {
-  if (tweet.in_reply_to_status_id) {
-    return 'reply';
-  }
-  if (tweet.quoted_status_id) {
-    return 'quote';
-  }
-  if (tweet.retweeted_status) {
-    return 'retweet';
-  }
-  return 'tweet';
-};
-
-const parseAuthor = (tweet) => ({
-  name: tweet.user.name,
-  handle: tweet.user.screen_name,
-  url: `https://twitter.com/${tweet.user.screen_name}`,
-  avatar: `${tweet.user.profile_image_url.replace('_normal.jpg', '.jpg')}`,
-});
-
-const parseQuoted = (tweet, type) =>
-  tweet[type]
-    ? {
-        text: tweet[type].full_text,
-        author: {
-          name: tweet[type].user.name,
-          handle: tweet[type].user.screen_name,
-        },
-      }
-    : undefined;
-
-const parseTweet = (tweets, watchable) => {
-  const [tweet] = tweets;
-  const type = determineTweetType(tweet);
-  return {
-    id: `twitter.${watchable.plain}.${type}`,
-    uniqueId: String(tweets[0].id_str),
-    text: tweet.full_text,
-    url: `https://twitter.com/${tweet.user.screen_name}/status/${tweet.id_str}`,
-    mediaUrl: tweet.entities.media ? tweet.entities.media[0].media_url : undefined,
-    isReply: typeof tweet.in_reply_to_status_id !== 'undefined',
-    author: parseAuthor(tweet),
-    quote: parseQuoted(tweet, 'quoted_status'),
-    retweet: parseQuoted(tweet, 'retweeted_status'),
-    createdAt: new Date(tweet.created_at),
-  };
-};
-
-/**
- * Twitter event handler
- */
-export default class TwitterCache {
-  /**
-   * Create a new Twitter self-updating cache
-   * @param {EventEmitter} eventEmitter emitter to push new tweets to
-   */
-  constructor(eventEmitter) {
-    this.emitter = eventEmitter;
-    this.timeout = TWITTER_TIMEOUT;
-    this.clientInfoValid = twiClientInfo.consumer_key && twiClientInfo.consumer_secret && twiClientInfo.bearer_token;
-    this.initClient(twiClientInfo);
-  }
-
-  initClient(clientInfo) {
-    try {
-      if (this.clientInfoValid) {
-        this.client = new Twitter(clientInfo);
-
-        // don't attempt anything else if authentication fails
-        this.toWatch = toWatch;
-        this.currentData = undefined;
-        this.lastUpdated = Date.now() - 60000;
-        this.updateInterval = setInterval(() => this.update(), this.timeout);
-        this.update();
-      } else {
-        logger.warn(`Twitter client not initialized... invalid token: ${clientInfo.bearer_token}`);
-      }
-    } catch (err) {
-      this.client = undefined;
-      this.clientInfoValid = false;
-      logger.error(err);
-    }
-  }
-
-  /**
-   * Force the cache to update
-   * @returns {Promise} the currently updating promise.
-   */
-  async update() {
-    if (!this.clientInfoValid) return undefined;
-
-    if (!this.toWatch) {
-      logger.verbose('Not processing twitter, no data to watch.');
-      return undefined;
-    }
-
-    if (!this.client) {
-      logger.verbose('Not processing twitter, no client to connect.');
-      return undefined;
-    }
-
-    this.updating = this.getParseableData();
-
-    return this.updating;
-  }
-
-  /**
-   * Get data able to be parsed from twitter.
-   * @returns {Promise.<Array.<Object>>} Tweets
-   */
-  async getParseableData() {
-    logger.silly('Starting Twitter update...');
-    const parsedData = [];
-    try {
-      await Promise.all(
-        this.toWatch.map(async (watchable) => {
-          const tweets = await this.client.get('statuses/user_timeline', {
-            screen_name: watchable.acc_name,
-            tweet_mode: 'extended',
-            count: 1,
-          });
-          const tweet = parseTweet(tweets, watchable);
-          parsedData.push(tweet);
-
-          if (tweet.createdAt.getTime() > this.lastUpdated) {
-            this.emitter.emit('tweet', tweet);
-          }
-        })
-      );
-    } catch (error) {
-      this.onError(error);
-    }
-    this.lastUpdated = Date.now();
-    return parsedData;
-  }
-
-  /**
-   * Handle errors that arise while fetching data from twitter
-   * @param  {Error} error twitter error
-   */
-  onError(error) {
-    if (error[0] && error[0].code === 32) {
-      this.clientInfoValid = false;
-      logger.info('wiping twitter client data, could not authenticate...');
-    } else {
-      logger.debug(JSON.stringify(error));
-    }
-  }
-
-  /**
-   * Get the current data or a promise with the current data
-   * @returns {Promise.<Object> | Object} either the current data
-   *  if it's not updating, or the promise returning the new data
-   */
-  async getData() {
-    if (!this.clientInfoValid) return undefined;
-
-    if (this.updating) {
-      return this.updating;
-    }
-    return this.currentData;
-  }
-}

package/handlers/Worldstate.js

@@ -1,154 +0,0 @@
-import wsData from 'warframe-worldstate-data';
-
-import WSCache from '../utilities/WSCache.js';
-import { logger, lastUpdated } from '../utilities/index.js';
-import Cache from '../utilities/Cache.js';
-import { sentientUrl, kuvaUrl, worldstateUrl, externalCron, worldstateCron } from '../resources/config.js';
-
-import parseNew from './events/parse.js';
-
-const { locales } = wsData;
-const debugEvents = ['arbitration', 'kuva', 'nightwave'];
-
-/**
- * Handler for worldstate data
- */
-export default class Worldstate {
-  #emitter;
-  #locale;
-  #worldStates = {};
-  #wsRawCache;
-  #kuvaCache;
-  #sentientCache;
-
-  /**
-   * Set up listening for specific platform and locale if provided.
-   * @param {EventEmitter} eventEmitter Emitter to push new worldstate events to
-   * @param {string} locale       Locale (actually just language) to watch
-   */
-  constructor(eventEmitter, locale) {
-    this.#emitter = eventEmitter;
-    this.#locale = locale;
-    logger.debug('starting up worldstate listener...');
-    if (locale) {
-      logger.debug(`only listening for ${locale}...`);
-    }
-  }
-
-  async init() {
-    this.#wsRawCache = await Cache.make(worldstateUrl, worldstateCron);
-    this.#kuvaCache = await Cache.make(kuvaUrl, externalCron);
-    this.#sentientCache = await Cache.make(sentientUrl, externalCron);
-
-    await this.setUpRawEmitters();
-    this.setupParsedEvents();
-  }
-
-  /**
-   * Set up emitting raw worldstate data
-   */
-  async setUpRawEmitters() {
-    this.#worldStates = {};
-
-    // eslint-disable-next-line no-restricted-syntax
-    for await (const locale of locales) {
-      if (!this.#locale || this.#locale === locale) {
-        this.#worldStates[locale] = new WSCache({
-          language: locale,
-          kuvaCache: this.#kuvaCache,
-          sentientCache: this.#sentientCache,
-          eventEmitter: this.#emitter,
-        });
-      }
-    }
-
-    /* listen for the raw cache updates so we can emit them from the super emitter */
-    this.#wsRawCache.on('update', (dataStr) => {
-      this.#emitter.emit('ws:update:raw', { platform: 'pc', data: dataStr });
-    });
-
-    /* when the raw emits happen, parse them and store them on parsed worldstate caches */
-    this.#emitter.on('ws:update:raw', ({ data }) => {
-      logger.debug('ws:update:raw - updating locales data');
-      locales.forEach((locale) => {
-        if (!this.#locale || this.#locale === locale) {
-          this.#worldStates[locale].data = data;
-        }
-      });
-    });
-  }
-
-  /**
-   * Set up listeners for the parsed worldstate updates
-   */
-  setupParsedEvents() {
-    this.#emitter.on('ws:update:parsed', ({ language, platform, data }) => {
-      const packet = { platform, worldstate: data, language };
-      this.parseEvents(packet);
-    });
-  }
-
-  /**
-   * Parse new worldstate events
-   * @param  {Object} worldstate     worldstate to find packets from
-   * @param  {string} platform       platform the worldstate corresponds to
-   * @param  {string} [language='en'] language of the worldstate (defaults to 'en')
-   */
-  parseEvents({ worldstate, platform, language = 'en' }) {
-    const cycleStart = Date.now();
-    const packets = [];
-    Object.keys(worldstate).forEach(async (key) => {
-      if (worldstate && worldstate[key]) {
-        const packet = parseNew({
-          data: worldstate[key],
-          key,
-          language,
-          platform,
-          cycleStart,
-        });
-
-        if (Array.isArray(packet)) {
-          if (packet.length) {
-            packets.push(...packet.filter((p) => p && p));
-          }
-        } else if (packet) {
-          packets.push(packet);
-        }
-      }
-    });
-
-    lastUpdated[platform][language] = Date.now();
-    packets
-      .filter((p) => p && p.id && packets)
-      .forEach((packet) => {
-        this.emit('ws:update:event', packet);
-      });
-  }
-
-  /**
-   * Emit an event with given id
-   * @param  {string} id     Id of the event to emit
-   * @param  {Object} packet Data packet to emit
-   */
-  emit(id, packet) {
-    if (debugEvents.includes(packet.key)) logger.warn(packet.key);
-
-    logger.debug(`ws:update:event - emitting ${packet.id}`);
-    delete packet.cycleStart;
-    this.#emitter.emit(id, packet);
-  }
-
-  /**
-   * get a specific worldstate version
-   * @param  {string} [language='en'] Locale of the worldsttate
-   * @returns {Object}                Worldstate corresponding to provided data
-   * @throws {Error} when the platform or locale aren't tracked and aren't updated
-   */
-  get(language = 'en') {
-    logger.debug(`getting worldstate ${language}...`);
-    if (this.#worldStates?.[language]) {
-      return this.#worldStates?.[language]?.data;
-    }
-    throw new Error(`Language (${language}) not tracked.\nEnsure that the parameters passed are correct`);
-  }
-}

package/handlers/events/arrayLike.js

@@ -1,27 +0,0 @@
-import { logger } from '../../utilities/index.js';
-
-import checkOverrides from './checkOverrides.js';
-import objectLike from './objectLike.js';
-
-/**
- * arrayLike are all just arrays of objectLike
- * @param  {Object} deps    dependencies for processing
- * @param  {Object[]} packets  packets to emit
- * @returns {Object|Object[]}  object(s) to emit from arrayLike processing
- */
-export default (deps, packets) => {
-  try {
-    deps.data.forEach((arrayItem) => {
-      const k = checkOverrides(deps.key, arrayItem);
-      packets.push(
-        objectLike(arrayItem, {
-          ...deps,
-          id: k,
-        })
-      );
-    });
-    return packets;
-  } catch (err) {
-    logger.error(err);
-  }
-};

package/handlers/events/checkOverrides.js

@@ -1,17 +0,0 @@
-import * as eKeyOverrides from './eKeyOverrides.js';
-
-/**
- * Find overrides for the provided key
- * @param  {string} key  worldsate field to find overrides
- * @param  {Object} data data corresponding to the key from provided worldstate
- * @returns {string}      overrided key
- */
-export default (key, data) => {
-  if (typeof eKeyOverrides[key] === 'string') {
-    return eKeyOverrides[key];
-  }
-  if (typeof eKeyOverrides[key] === 'function') {
-    return eKeyOverrides[key](data);
-  }
-  return key;
-};

package/handlers/events/cycleLike.js

@@ -1,38 +0,0 @@
-import { between, lastUpdated, fromNow } from '../../utilities/index.js';
-
-/**
- * @typedef {Object} CycleLike
- * @property {string} state
- * @property {string} key
- * @property {Date} activation
- */
-
-/**
- * CylceData parser
- * @param {CycleLike} cycleData data for parsing all cycles like this
- * @param {Deps} deps dependencies for processing
- * @returns {Object[]}
- */
-export default (cycleData, deps) => {
-  const packet = {
-    ...deps,
-    data: cycleData,
-    id: `${deps.key.replace('Cycle', '')}.${cycleData.state}`,
-  };
-
-  const last = new Date(lastUpdated[deps.platform][deps.language]);
-  const activation = new Date(cycleData.activation);
-  const start = new Date(deps.cycleStart);
-
-  const packets = [];
-  if (between(last, activation, start)) {
-    packets.push(packet);
-  }
-
-  const timePacket = {
-    ...packet,
-    id: `${packet.id}.${Math.round(fromNow(deps.data.expiry) / 60000)}`,
-  };
-  packets.push(timePacket);
-  return packets;
-};