warframe-worldstate-parser 3.0.11 → 4.0.1

package/README.md

@@ -23,11 +23,12 @@ For the most part, you'll have a better experience consuming the product of this
 ## Example usage
 
 ```javascript
-const worldstateData = await require('request-promise')('http://content.warframe.com/dynamic/worldState.php');
+// import WorldState from 'warframe-worldstate-data';
+// using this syntax to make it precisely testable in a test
+const WorldStateParser = await import('warframe-worldstate-parser');
+const worldstateData = await fetch('https://content.warframe.com/dynamic/worldState.php').then((data) => data.text());
 
-const WorldState = require('warframe-worldstate-parser');
-
-const ws = new WorldState(worldstateData);
+const ws = await WorldStateParser(worldstateData);
 
 console.log(ws.alerts[0].toString());
 ```

package/lib/WorldState.js

@@ -58,7 +58,7 @@ export function parseArray(ParserClass, dataArray, deps, uniqueField) {
   const arr = (dataArray || []).map((d) => new ParserClass(d, deps));
   if (uniqueField) {
     const utemp = {};
-    arr.sort((a, b) => a.id.localeCompare(b.id));
+    arr.sort((a, b) => a.id?.localeCompare(b.id));
     arr.forEach((obj) => {
       utemp[obj[uniqueField]] = obj;
     });
@@ -71,14 +71,55 @@ export function parseArray(ParserClass, dataArray, deps, uniqueField) {
   return arr;
 }
 
+/**
+ * Parse array of objects that requires async parsing
+ * @param {object} ParserClass class for parsing data - must expose a static build method
+ * @param {Array<BaseContentObject>} dataArray array of raw data
+ * @param {Dependency} deps shared dependency object
+ * @param {*} [uniqueField] field to treat as unique
+ * @returns {Promise<WorldstateObject[]>} array of parsed objects
+ */
+export const parseAsyncArray = async (ParserClass, dataArray, deps, uniqueField) => {
+  const arr = [];
+  // eslint-disable-next-line no-restricted-syntax
+  for await (const d of dataArray ?? []) {
+    arr.push(await ParserClass.build(d, deps));
+  }
+  if (uniqueField) {
+    const utemp = {};
+    arr.sort((a, b) => a.id?.localeCompare(b.id));
+    arr.forEach((obj) => {
+      utemp[obj[uniqueField]] = obj;
+    });
+    return Array.from(arr).filter((obj) => {
+      if (obj && obj.active && typeof obj.active !== 'undefined') return obj.active;
+      /* istanbul ignore next */
+      return true;
+    });
+  }
+  return arr;
+};
+
 /**
  * Parses Warframe Worldstate JSON
  */
-export default class WorldState {
+export class WorldState {
+  static async build(json, deps = defaultDeps) {
+    const ws = new WorldState(json, deps);
+    const data = JSON.parse(json);
+
+    ws.events = await parseAsyncArray(WorldEvent, data.Goals, deps);
+    ws.syndicateMissions = await parseAsyncArray(SyndicateMission, data.SyndicateMissions, deps, 'syndicate');
+
+    return ws;
+  }
+
   /**
    * Generates the worldstate json as a string into usable objects
    * @param {string} json The worldstate JSON string
    * @param {Dependency} [deps] The options object
+   * @class
+   * @async
    */
   constructor(json, deps = defaultDeps) {
     if (typeof json !== 'string') {
@@ -114,7 +155,7 @@ export default class WorldState {
      * The current events
      * @type {Array.<WorldEvent>}
      */
-    this.events = parseArray(WorldEvent, data.Goals, deps);
+    this.events = [];
 
     /**
      * The current alerts
@@ -132,7 +173,7 @@ export default class WorldState {
      * The current syndicate missions
      * @type {Array.<SyndicateMission>}
      */
-    this.syndicateMissions = parseArray(SyndicateMission, data.SyndicateMissions, deps, 'syndicate');
+    this.syndicateMissions = [];
 
     /**
      * The current fissures: 'ActiveMissions' & 'VoidStorms'
@@ -298,7 +339,7 @@ export default class WorldState {
     }
 
     /**
-     * Current syndicate outposts
+     * Current sentient outposts
      * @type {SentientOutpost}
      */
     this.sentientOutposts = new SentientOutpost(data.Tmp, deps);
@@ -322,3 +363,5 @@ export default class WorldState {
     this.duviriCycle = new DuviriCycle(deps);
   }
 }
+
+export default async (json, deps) => WorldState.build(json, deps);

package/lib/models/SyndicateJob.js

@@ -84,10 +84,28 @@ const FIFTY_MINUTES = 3000000;
  */
 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({
@@ -103,9 +121,6 @@ export default class SyndicateJob extends WorldstateObject {
      * @type {Array.<string>}
      */
     this.rewardPool = [];
-    getBountyRewards(data.rewards, data.isVault, data).then((rewards) => {
-      this.rewardPool = rewards;
-    });
 
     const chamber = ((data.locationTag || '').match(/[A-Z]+(?![a-z])|[A-Z]?[a-z]+|\d+/g) || []).join(' ');
 

package/lib/models/SyndicateMission.js

@@ -10,6 +10,27 @@ import WorldstateObject from './WorldstateObject.js';
  * @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
@@ -18,10 +39,6 @@ export default class SyndicateMission extends WorldstateObject {
   constructor(data, { locale = 'en' } = { locale: 'en' }) {
     super(data);
 
-    const deps = {
-      locale,
-    };
-
     /**
      * The date and time at which the syndicate mission starts
      * @type {Date}
@@ -56,7 +73,7 @@ export default class SyndicateMission extends WorldstateObject {
      * The jobs for this syndicate. Will normally be []
      * @type {Array.<SyndicateJob>}
      */
-    this.jobs = (data.Jobs || []).map((j) => new SyndicateJob(j, this.expiry, deps));
+    this.jobs = [];
 
     /**
      * Unique identifier for this mission set built from the end time and syndicate

package/lib/models/WorldEvent.js

@@ -27,6 +27,34 @@ import Reward from './Reward.js';
  * @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
@@ -132,13 +160,8 @@ export default class WorldEvent extends WorldstateObject {
     this.health =
       typeof data.HealthPct !== 'undefined' ? Number.parseFloat(((data.HealthPct || 0.0) * 100).toFixed(2)) : undefined;
 
-    if (data.JobAffiliationTag) {
-      this.affiliatedWith = syndicate(data.JobAffiliationTag, locale);
-      if (data.Jobs) {
-        this.jobs = (data.Jobs || []).map((j) => new SyndicateJob(j, this.expiry, opts));
-        this.previousJobs = (data.PreviousJobs || []).map((j) => new SyndicateJob(j, this.expiry, opts));
-      }
-    }
+    this.jobs = [];
+    this.previousJobs = [];
 
     /**
      * Previous job id
@@ -191,22 +214,22 @@ export default class WorldEvent extends WorldstateObject {
     }
 
     /**
-     * Whether or not to show the total score at the end of the mission
+     * Whether to show the total score at the end of the mission
      * @type {boolean}
      */
     this.showTotalAtEndOfMission = data.ShowTotalAtEOM;
     /**
-     * Whether or not the event is personal
+     * Whether the event is personal
      * @type {boolean}
      */
     this.isPersonal = data.Personal;
     /**
-     * Whether or not the event is community
+     * Whether the event is community
      * @type {boolean}
      */
     this.isCommunity = data.Community;
 
-    /**
+    /*
      * Affectors for this mission
      * @type {string[]}
      */
@@ -241,10 +264,14 @@ export default class WorldEvent extends WorldstateObject {
       expiry: parseDate(data.NextAltExpiry),
       activation: parseDate(data.NextAltActivation),
     };
+
+    if (data.JobAffiliationTag) {
+      this.affiliatedWith = syndicate(data.JobAffiliationTag, locale);
+    }
   }
 
   /**
-   * Get whether or not the event has expired
+   * Get whether the event has expired
    * @returns {boolean} whether the event has expired
    */
   getExpired() {

package/lib/supporting/RewardTypes.js

@@ -242,7 +242,7 @@ export default [
   {
     name: 'endo',
     description: 'Endo',
-    test: (s) => /\d+\sendo/i.test(s),
+    test: (s) => /^\d+x?\sendo/i.test(s),
     thumbnail: wfCdn('endo.png'),
     color: 0xc2a24c,
   },

package/main.js

@@ -1,3 +1,4 @@
-import WorldState from './lib/WorldState.js';
+import { WorldState } from './lib/WorldState.js';
 
 export default WorldState;
+export * from './lib/WorldState.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "warframe-worldstate-parser",
-  "version": "3.0.11",
+  "version": "4.0.1",
   "description": "An Open parser for Warframe's Worldstate in Javascript",
   "keywords": [
     "warframe-worldstate",
@@ -17,6 +17,12 @@
     "nspacestd (https://github.com/nspacestd)"
   ],
   "type": "module",
+  "exports": {
+    ".": {
+      "import": "./main.js",
+      "types": "./types/index.d.ts"
+    }
+  },
   "main": "main.js",
   "types": "./types/main.d.ts",
   "files": [
@@ -25,16 +31,6 @@
     "LICENSE",
     "types"
   ],
-  "commitlint": {
-    "extends": [
-      "@commitlint/config-conventional"
-    ],
-    "rules": {
-      "body-max-line-length": [
-        0
-      ]
-    }
-  },
   "peerDependencies": {
     "warframe-worldstate-data": ">=2.0.3"
   },

package/types/lib/WorldState.d.ts

@@ -7,14 +7,18 @@
  * @returns {WorldstateObject[]} array of parsed objects
  */
 export function parseArray(ParserClass: object, dataArray: Array<BaseContentObject>, deps: Dependency, uniqueField?: any): WorldstateObject[];
+export function parseAsyncArray(ParserClass: object, dataArray: Array<BaseContentObject>, deps: Dependency, uniqueField?: any): Promise<WorldstateObject[]>;
 /**
  * Parses Warframe Worldstate JSON
  */
-export default class WorldState {
+export class WorldState {
+    static build(json: any, deps?: Dependency): Promise<WorldState>;
     /**
      * Generates the worldstate json as a string into usable objects
      * @param {string} json The worldstate JSON string
      * @param {Dependency} [deps] The options object
+     * @class
+     * @async
      */
     constructor(json: string, deps?: Dependency);
     /**
@@ -134,7 +138,7 @@ export default class WorldState {
     nightwave: Nightwave;
     arbitration: any;
     /**
-     * Current syndicate outposts
+     * Current sentient outposts
      * @type {SentientOutpost}
      */
     sentientOutposts: SentientOutpost;
@@ -145,6 +149,8 @@ export default class WorldState {
     steelPath: SteelPathOffering;
     duviriCycle: DuviriCycle;
 }
+declare function _default(json: any, deps: any): Promise<WorldState>;
+export default _default;
 import Dependency from './supporting/Dependency.js';
 import News from './models/News.js';
 import WorldEvent from './models/WorldEvent.js';

package/types/lib/models/SyndicateJob.d.ts

@@ -4,10 +4,24 @@
  */
 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 build(data: object, expiry: Date, deps: {
+        locale: string;
+    }): Promise<SyndicateJob>;
+    /**
+     * 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: object, expiry: Date, { locale }: {
         locale: string;

package/types/lib/models/SyndicateMission.d.ts

@@ -3,6 +3,16 @@
  * @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 build(data: object, deps: {
+        locale: string;
+    }): Promise<SyndicateMission>;
     /**
      * @param   {object}             data            The syndicate mission data
      * @param   {object}             deps            The dependencies object

package/types/lib/models/WorldEvent.d.ts

@@ -17,6 +17,16 @@
  * @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 build(data: object, deps: {
+        locale: string;
+    }): Promise<WorldEvent>;
     /**
      * @param   {object}            data            The event data
      * @param   {object}            deps            The dependencies object
@@ -95,9 +105,8 @@ export default class WorldEvent extends WorldstateObject {
      * @type {number}
      */
     health: number;
-    affiliatedWith: any;
-    jobs: any;
-    previousJobs: any;
+    jobs: any[];
+    previousJobs: any[];
     /**
      * Previous job id
      * @type {string}
@@ -119,25 +128,21 @@ export default class WorldEvent extends WorldstateObject {
      */
     progressTotal: number;
     /**
-     * Whether or not to show the total score at the end of the mission
+     * Whether to show the total score at the end of the mission
      * @type {boolean}
      */
     showTotalAtEndOfMission: boolean;
     /**
-     * Whether or not the event is personal
+     * Whether the event is personal
      * @type {boolean}
      */
     isPersonal: boolean;
     /**
-     * Whether or not the event is community
+     * Whether the event is community
      * @type {boolean}
      */
     isCommunity: boolean;
-    /**
-     * Affectors for this mission
-     * @type {string[]}
-     */
-    regionDrops: string[];
+    regionDrops: any;
     /**
      * Archwing Drops in effect while this event is active
      * @type {string[]}
@@ -161,8 +166,9 @@ export default class WorldEvent extends WorldstateObject {
         expiry: any;
         activation: any;
     };
+    affiliatedWith: any;
     /**
-     * Get whether or not the event has expired
+     * Get whether the event has expired
      * @returns {boolean} whether the event has expired
      */
     getExpired(): boolean;

package/types/main.d.ts

@@ -1,2 +1,3 @@
 export default WorldState;
-import WorldState from './lib/WorldState.js';
+export * from "./lib/WorldState.js";
+import { WorldState } from './lib/WorldState.js';