@wfcd/profile-parser 1.0.2 → 1.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wfcd/profile-parser",
-  "version": "1.0.2",
+  "version": "1.1.1",
   "description": "Parser for Digital Extreme's profile data",
   "type": "module",
   "main": "src/ProfileParser.js",

package/src/ArchonCrystal.js

@@ -5,6 +5,11 @@ import { archonShardColor, archonShardUpgradeType } from 'warframe-worldstate-da
  * @module
  */
 export default class ArchonCrystal {
+  /**
+   *
+   * @param {Object} crystal The archon crystal object
+   * @param {string} local The locale to get translations in
+   */
   constructor(crystal, local) {
     /**
      * Archon shard color

package/src/ChallengeProgress.js

@@ -3,6 +3,10 @@
  * @module
  */
 export default class ChallengeProgress {
+  /**
+   *
+   * @param {Object} challenge The challenge object to parse
+   */
   constructor(challenge) {
     /**
      * Name of the challenge

package/src/Enemy.js

@@ -4,6 +4,7 @@
  */
 export default class Enemy {
   /**
+   *
    * @param {Object} enemy The enemy
    */
   constructor(enemy) {

package/src/Intrinsics.js

@@ -3,6 +3,10 @@
  * @module
  */
 export default class Intrinsics {
+  /**
+   *
+   * @param {Object} skills The intrinsics object
+   */
   constructor(skills) {
     // I know this is railjack but I'm not sure what the context is
     /**

package/src/ItemConfig.js

@@ -1,5 +1,6 @@
-import { colors, find } from 'warframe-items/utilities';
+import { colors } from 'warframe-items/utilities';
 
+import Skin from './Skin.js';
 import mapToHex from './Util.js';
 
 /**
@@ -8,6 +9,7 @@ import mapToHex from './Util.js';
  */
 export default class ItemConfig {
   /**
+   *
    * @param {Object} config The configuration
    */
   constructor(config) {
@@ -15,9 +17,7 @@ export default class ItemConfig {
      * Array of unique names for the skins applied to item
      * @type {Array<String>}
      */
-    this.skins = config.Skins.filter(Boolean)
-      .map((s) => find.findItem(s))
-      .filter(Boolean);
+    this.skins = config.Skins.filter(Boolean).map((s) => new Skin({ ItemType: s }));
 
     /**
      * Array of PVP unique name upgrades applied
@@ -27,25 +27,25 @@ export default class ItemConfig {
 
     /**
      * Primary colors applied to item if they exist
-     * @type {module:"warframe-items".ColorMap}
+     * @type {module:"warframe-items".ColorMap | undefined}
      */
     if (config.pricol) this.primaryColor = colors.mapColors(mapToHex(config.pricol));
 
     /**
      * Sigil colors applied to item if they exist
-     * @type {module:"warframe-items".ColorMap}
+     * @type {module:("warframe-items").ColorMap | undefined}
      */
     if (config.sigcol) this.sigilColor = colors.mapColors(mapToHex(config.sigcol));
 
     /**
      * Attachment colors applied to item if they exist
-     * @type {module:"warframe-items".ColorMap}
+     * @type {module:"warframe-items".ColorMap | undefined}
      */
     if (config.attcol) this.attachmentsColor = colors.mapColors(mapToHex(config.attcol));
 
     /**
      * Syandana colors applied to item if they exist
-     * @type {module:"warframe-items".ColorMap}
+     * @type {module:"warframe-items".ColorMap | undefined}
      */
     if (config.syancol) this.syandanaColor = colors.mapColors(mapToHex(config.syancol));
   }

package/src/LoadOutInventory.js

@@ -1,5 +1,5 @@
 import LoadOutItem from './LoadOutItem.js';
-import WeaponSkin from './WeaponSkin.js';
+import Skin from './Skin.js';
 import XpInfo from './XpInfo.js';
 
 /**
@@ -7,12 +7,16 @@ import XpInfo from './XpInfo.js';
  * @module
  */
 export default class LoadOutInventory {
+  /**
+   *
+   * @param {Object} item The loadout data
+   */
   constructor(item) {
     /**
      * Skins applied to weapons
      * @type {WeaponSkin}
      */
-    this.weaponSkins = item.WeaponSkins.map((s) => new WeaponSkin(s));
+    this.weaponSkins = item.WeaponSkins.map((s) => new Skin(s));
 
     /**
      * An array of the player's currently equiped Warframe (or powersuits)

package/src/LoadOutItem.js

@@ -9,6 +9,10 @@ import Polarity from './Polarity.js';
  * @module
  */
 export default class LoadOutItem {
+  /**
+   *
+   * @param {Object} weapon The loadout item from LoadoutInventory
+   */
   constructor(weapon) {
     /**
      * Item ID
@@ -108,31 +112,31 @@ export default class LoadOutItem {
 
     /**
      * Primary colors applied to item if they exist
-     * @type {ColorMap}
+     * @type {module:"warframe-items".ColorMap | undefined}
      */
     if (weapon.pricol) this.primaryColor = colors.mapColors(weapon.pricol);
 
     /**
      * Sigil colors applied to item if they exist
-     * @type {ColorMap}
+     * @type {module:"warframe-items".ColorMap | undefined}
      */
     if (weapon.sigcol) this.sigilColor = colors.mapColors(weapon.sigcol.toString(16));
 
     /**
      * Attachment colors applied to item if they exist
-     * @type {ColorMap}
+     * @type {module:"warframe-items".ColorMap | undefined}
      */
     if (weapon.attcol) this.attachmentsColor = colors.mapColors(weapon.attcol.toString(16));
 
     /**
      * Syandana colors applied to item if they exist
-     * @type {ColorMap}
+     * @type {module:"warframe-items".ColorMap | undefined}
      */
     if (weapon.syancol) this.syandanaColor = colors.mapColors(weapon.syancol.toString(16));
 
     /**
      * If set will show when the player's warframe was infested.
-     * @type {ColorMap}
+     * @type {module:"warframe-items".ColorMap | undefined}
      */
     if (weapon.InfestationDate) this.infestationDate = parseDate(weapon.InfestationDate);
   }

package/src/Mission.js

@@ -5,8 +5,13 @@ import { node, nodeEnemy, nodeMissionType } from 'warframe-worldstate-data/utili
  * @module
  */
 export default class Mission {
+  /**
+   *
+   * @param {Object} mission The mission data
+   * @param {string} locale The locale to return in
+   */
   constructor(mission, locale) {
-    const uniqueName = mission.Type || mission.Tag;
+    const uniqueName = mission.type || mission.Tag;
 
     /**
      * Node name
@@ -18,7 +23,7 @@ export default class Mission {
      * Node mission type
      * @type {String}
      */
-    this.misstionType = nodeMissionType(uniqueName, locale);
+    this.missionType = nodeMissionType(uniqueName, locale);
 
     /**
      * Node faction
@@ -28,17 +33,20 @@ export default class Mission {
 
     /**
      * Highest score earned in this mission
-     * @type {number}
+     * @type {number | undefined}
      */
-    if (mission.highScore) this.highScore = mission.HighScore;
+    if (mission.highScore) this.highScore = mission.highScore;
 
     /**
      * How many times the mission was completed
-     * @type {number}
+     * @type {number | undefined}
      */
     if (mission.Completes) this.completes = mission.Completes;
 
-    // Not sure.
+    /**
+     * Denotes a steel path node
+     * @type {number | undefined}
+     */
     if (mission.Tier) this.tier = mission.Tier;
   }
 }

package/src/OperatorLoadOuts.js

@@ -1,5 +1,6 @@
 import { colors } from 'warframe-items/utilities';
 
+import Skin from './Skin.js';
 import mapToHex from './Util.js';
 
 /**
@@ -7,12 +8,16 @@ import mapToHex from './Util.js';
  * @module
  */
 export default class OperatorLoadOuts {
+  /**
+   *
+   * @param {Object} loadout The operator loadout
+   */
   constructor(loadout) {
     /**
      * Skins that have been applied to the player's operator.
-     * @type {Array<String>}
+     * @type {Array<Skin>}
      */
-    this.skins = loadout.Skins;
+    this.skins = loadout.Skins.filter(Boolean).map((s) => new Skin({ ItemType: s }));
 
     /**
      * Operator amp ID
@@ -29,43 +34,43 @@ export default class OperatorLoadOuts {
 
     /**
      * Operator primary colors
-     * @type {module:"warframe-items".ColorMap}
+     * @type {module:"warframe-items".ColorMap | undefined}
      */
     if (loadout.pricol) this.primaryColor = colors.mapColors(mapToHex(loadout.pricol));
 
     /**
      * Operator sigil colors
-     * @type {module:"warframe-items".ColorMap}
+     * @type {module:"warframe-items".ColorMap | undefined}
      */
     if (loadout.sigcol) this.sigilColor = colors.mapColors(mapToHex(loadout.sigcol));
 
     /**
      * Operator attachment colors
-     * @type {module:"warframe-items".ColorMap}
+     * @type {module:"warframe-items".ColorMap | undefined}
      */
     if (loadout.attcol) this.attachmentsColor = colors.mapColors(mapToHex(loadout.attcol));
 
     /**
      * Operator syandana colors
-     * @type {module:"warframe-items".ColorMap}
+     * @type {module:"warframe-items".ColorMap | undefined}
      */
     if (loadout.syancol) this.syandanaColor = colors.mapColors(mapToHex(loadout.syancol));
 
     /**
      * Operator eye colors
-     * @type {module:"warframe-items".ColorMap}
+     * @type {module:"warframe-items".ColorMap | undefined}
      */
     if (loadout.eyecol) this.eyeColor = colors.mapColors(mapToHex(loadout.eyecol));
 
     /**
      * Operator facial colors
-     * @type {module:"warframe-items".ColorMap}
+     * @type {module:"warframe-items".ColorMap | undefined}
      */
     if (loadout.facial) this.facial = colors.mapColors(mapToHex(loadout.facial));
 
     /**
      * Operator cloth colors
-     * @type {module:"warframe-items".ColorMap}
+     * @type {module:"warframe-items".ColorMap | undefined}
      */
     if (loadout.cloth) this.cloth = colors.mapColors(mapToHex(loadout.cloth));
   }

package/src/Polarity.js

@@ -5,6 +5,10 @@ import { translatePolarity } from 'warframe-worldstate-data/utilities';
  * @module
  */
 export default class Polarity {
+  /**
+   *
+   * @param {Object} polarity The polarity to parse
+   */
   constructor(polarity) {
     /**
      * Polarity name

package/src/Profile.js

@@ -12,6 +12,11 @@ import Syndicate from './Syndicate.js';
  * @module
  */
 export default class Profile {
+  /**
+   *
+   * @param {Object} profile The profile data to parse
+   * @param {string} locale The locale to return in where possible
+   */
   constructor(profile, locale) {
     /**
      * Player's acount ID

package/src/ProfileParser.js

@@ -8,6 +8,11 @@ import Stats from './Stats.js';
  * @module
  */
 export default class ProfileParser {
+  /**
+   *
+   * @param {Object} data The data returned by getProfile endpoint
+   * @param {string} locale The locale to return where possible
+   */
   constructor(data, locale) {
     /**
      * Player's profile

package/src/Pvp.js

@@ -3,6 +3,10 @@
  * @module
  */
 export default class Pvp {
+  /**
+   *
+   * @param {Object} pvp PVP data to parse
+   */
   constructor(pvp) {
     /**
      * PVP match unique name
@@ -12,19 +16,19 @@ export default class Pvp {
 
     /**
      * Deaths for this match
-     * @type {number}
+     * @type {number | undefined}
      */
     this.suitDeaths = pvp.suitDeaths;
 
     /**
      * Warframe kills
-     * @type {number}
+     * @type {number | undefined}
      */
     this.suitKills = pvp.suitKills;
 
     /**
      * Weapon killes
-     * @type {number}
+     * @type {number | undefined}
      */
     this.weaponKills = pvp.weaponKills;
   }

package/src/Race.js

@@ -3,17 +3,31 @@
  * @module
  */
 export default class Race {
-  constructor(race) {
+  /**
+   *
+   * @param {string} type Race name
+   * @param {number} highScore high score
+   */
+  constructor(type, highScore) {
     /**
      * Race name
      * @type {String}
      */
-    this.uniqueName = race.type;
+    this.uniqueName = type;
 
     /**
      * Race High score
      * @type {number}
      */
-    this.highScore = race.highScore;
+    this.highScore = highScore;
+  }
+
+  /**
+   * Created an array of Race objects from DE's Races array
+   * @param {Object} races Array of races
+   * @returns {Race[]} An array of races formatted in a more consumable way.
+   */
+  static fromRaceObject(races) {
+    return Object.entries(races).map(([type, { highScore }]) => new Race(type, highScore));
   }
 }

package/src/Scan.js

@@ -3,6 +3,9 @@
  * @module
  */
 export default class Scan {
+  /**
+   * @param {Object} scan The scanned Warframe object
+   */
   constructor(scan) {
     /**
      * Enemy unique name

package/src/Skin.js

@@ -0,0 +1,32 @@
+import { find } from 'warframe-items/utilities';
+
+/**
+ * A skin class
+ * @module
+ */
+export default class Skin {
+  /**
+   *
+   * @param {Object} skin The skin data  to parse
+   */
+  constructor(skin) {
+    /**
+     * Unique name
+     * @type {String}
+     */
+    this.uniqueName = skin.ItemType;
+
+    const item = find.findItem(skin.ItemType);
+    /**
+     * The Warframe item that matches the unique name
+     */
+    if (item) this.item = item;
+  }
+}
+
+/**
+ * @deprecated Move to Skin, this is just here to not break anything for early users
+ * @param {Object} skin Skin object
+ * @returns {Skin} Skin object with possible item
+ */
+export const WeaponSkin = (skin) => new Skin(skin);

package/src/Stats.js

@@ -174,7 +174,7 @@ export default class Stats {
 
     /**
      * Event Scores for Operation breeding grounds
-     * @type {Map<String,numbert>}
+     * @type {Map<String,number>}
      */
     this.breedGrounds = {
       personalScore: stats.HiveEventScore,
@@ -183,7 +183,7 @@ export default class Stats {
 
     /**
      * Event Scores for The Gradivus Dilemma
-     * @type {Map<String,numbert>}
+     * @type {Map<String,number>}
      */
     this.gradivusDilemma = {
       grineer: stats.InvasionEventGrineerScore,
@@ -191,7 +191,7 @@ export default class Stats {
     };
 
     /**
-     * List of scans
+     * List of scanned Warframe objects
      * @type {Array<Scan>}
      */
     this.scans = stats.Scans.map((s) => new Scan(s));
@@ -288,7 +288,7 @@ export default class Stats {
     this.orphixVenomScore = stats.MechSurvivalScoreMax;
     this.happyZephyrScore = stats.ZephyrScore;
 
-    this.kDriveRaces = Object.entries(stats.Races).map(([type, { highScore }]) => new Race({ type, highScore }));
+    this.kDriveRaces = Race.fromRaceObject(stats.Races);
 
     /**
      * Operation Gate Crash event

package/src/Weapon.js

@@ -3,6 +3,10 @@
  * @module
  */
 export default class Weapon {
+  /**
+   *
+   * @param {Object} weapon The weapon stats being parsed
+   */
   constructor(weapon) {
     /**
      * Weapon unique name

package/src/XpInfo.js

@@ -5,6 +5,10 @@ import { find } from 'warframe-items/utilities';
  * @module
  */
 export default class XpInfo {
+  /**
+   *
+   * @param {Object} info The info for a given ranked item
+   */
   constructor(info) {
     /**
      * Unique name

package/types/ArchonCrystal.d.ts

@@ -3,7 +3,12 @@
  * @module
  */
 export default class ArchonCrystal {
-    constructor(crystal: any, local: any);
+    /**
+     *
+     * @param {Object} crystal The archon crystal object
+     * @param {string} local The locale to get translations in
+     */
+    constructor(crystal: any, local: string);
     /**
      * Archon shard color
      * @type {String}

package/types/ChallengeProgress.d.ts

@@ -3,6 +3,10 @@
  * @module
  */
 export default class ChallengeProgress {
+    /**
+     *
+     * @param {Object} challenge The challenge object to parse
+     */
     constructor(challenge: any);
     /**
      * Name of the challenge

package/types/Enemy.d.ts

@@ -4,6 +4,7 @@
  */
 export default class Enemy {
     /**
+     *
      * @param {Object} enemy The enemy
      */
     constructor(enemy: any);

package/types/Intrinsics.d.ts

@@ -3,6 +3,10 @@
  * @module
  */
 export default class Intrinsics {
+    /**
+     *
+     * @param {Object} skills The intrinsics object
+     */
     constructor(skills: any);
     /**
      * @type {number}

package/types/ItemConfig.d.ts

@@ -4,6 +4,7 @@
  */
 export default class ItemConfig {
     /**
+     *
      * @param {Object} config The configuration
      */
     constructor(config: any);

package/types/LoadOutInventory.d.ts

@@ -3,6 +3,10 @@
  * @module
  */
 export default class LoadOutInventory {
+    /**
+     *
+     * @param {Object} item The loadout data
+     */
     constructor(item: any);
     /**
      * Skins applied to weapons
@@ -35,6 +39,5 @@ export default class LoadOutInventory {
      */
     xpInfo: XpInfo;
 }
-import WeaponSkin from './WeaponSkin.js';
 import LoadOutItem from './LoadOutItem.js';
 import XpInfo from './XpInfo.js';

package/types/LoadOutItem.d.ts

@@ -3,6 +3,10 @@
  * @module
  */
 export default class LoadOutItem {
+    /**
+     *
+     * @param {Object} weapon The loadout item from LoadoutInventory
+     */
     constructor(weapon: any);
     /**
      * Item ID

package/types/Mission.d.ts

@@ -3,7 +3,12 @@
  * @module
  */
 export default class Mission {
-    constructor(mission: any, locale: any);
+    /**
+     *
+     * @param {Object} mission The mission data
+     * @param {string} locale The locale to return in
+     */
+    constructor(mission: any, locale: string);
     /**
      * Node name
      * @type {String}
@@ -13,7 +18,7 @@ export default class Mission {
      * Node mission type
      * @type {String}
      */
-    misstionType: string;
+    missionType: string;
     /**
      * Node faction
      * @type {String}

package/types/OperatorLoadOuts.d.ts

@@ -3,12 +3,16 @@
  * @module
  */
 export default class OperatorLoadOuts {
+    /**
+     *
+     * @param {Object} loadout The operator loadout
+     */
     constructor(loadout: any);
     /**
      * Skins that have been applied to the player's operator.
-     * @type {Array<String>}
+     * @type {Array<Skin>}
      */
-    skins: Array<string>;
+    skins: Array<Skin>;
     /**
      * Operator amp ID
      * @type {String | undefined}
@@ -28,3 +32,4 @@ export default class OperatorLoadOuts {
     facial: any;
     cloth: any;
 }
+import Skin from './Skin.js';

package/types/Polarity.d.ts

@@ -3,6 +3,10 @@
  * @module
  */
 export default class Polarity {
+    /**
+     *
+     * @param {Object} polarity The polarity to parse
+     */
     constructor(polarity: any);
     /**
      * Polarity name

package/types/Profile.d.ts

@@ -3,7 +3,12 @@
  * @module
  */
 export default class Profile {
-    constructor(profile: any, locale: any);
+    /**
+     *
+     * @param {Object} profile The profile data to parse
+     * @param {string} locale The locale to return in where possible
+     */
+    constructor(profile: any, locale: string);
     /**
      * Player's acount ID
      * @type {Stirng}

package/types/ProfileParser.d.ts

@@ -3,7 +3,12 @@
  * @module
  */
 export default class ProfileParser {
-    constructor(data: any, locale: any);
+    /**
+     *
+     * @param {Object} data The data returned by getProfile endpoint
+     * @param {string} locale The locale to return where possible
+     */
+    constructor(data: any, locale: string);
     /**
      * Player's profile
      * @type {Profile}

package/types/Pvp.d.ts

@@ -3,6 +3,10 @@
  * @module
  */
 export default class Pvp {
+    /**
+     *
+     * @param {Object} pvp PVP data to parse
+     */
     constructor(pvp: any);
     /**
      * PVP match unique name
@@ -11,17 +15,17 @@ export default class Pvp {
     uniqueName: string;
     /**
      * Deaths for this match
-     * @type {number}
+     * @type {number | undefined}
      */
-    suitDeaths: number;
+    suitDeaths: number | undefined;
     /**
      * Warframe kills
-     * @type {number}
+     * @type {number | undefined}
      */
-    suitKills: number;
+    suitKills: number | undefined;
     /**
      * Weapon killes
-     * @type {number}
+     * @type {number | undefined}
      */
-    weaponKills: number;
+    weaponKills: number | undefined;
 }

package/types/Race.d.ts

@@ -3,7 +3,18 @@
  * @module
  */
 export default class Race {
-    constructor(race: any);
+    /**
+     * Created an array of Race objects from DE's Races array
+     * @param {Object} races Array of races
+     * @returns {Race[]} An array of races formatted in a more consumable way.
+     */
+    static fromRaceObject(races: any): Race[];
+    /**
+     *
+     * @param {string} type Race name
+     * @param {number} highScore high score
+     */
+    constructor(type: string, highScore: number);
     /**
      * Race name
      * @type {String}

package/types/Scan.d.ts

@@ -3,6 +3,9 @@
  * @module
  */
 export default class Scan {
+    /**
+     * @param {Object} scan The scanned Warframe object
+     */
     constructor(scan: any);
     /**
      * Enemy unique name

package/types/Skin.d.ts

@@ -0,0 +1,18 @@
+/**
+ * A skin class
+ * @module
+ */
+export default class Skin {
+    /**
+     *
+     * @param {Object} skin The skin data  to parse
+     */
+    constructor(skin: any);
+    /**
+     * Unique name
+     * @type {String}
+     */
+    uniqueName: string;
+    item: any;
+}
+export function WeaponSkin(skin: any): Skin;

package/types/Stats.d.ts

@@ -139,16 +139,16 @@ export default class Stats {
     healCount: number;
     /**
      * Event Scores for Operation breeding grounds
-     * @type {Map<String,numbert>}
+     * @type {Map<String,number>}
      */
-    breedGrounds: Map<string, numbert>;
+    breedGrounds: Map<string, number>;
     /**
      * Event Scores for The Gradivus Dilemma
-     * @type {Map<String,numbert>}
+     * @type {Map<String,number>}
      */
-    gradivusDilemma: Map<string, numbert>;
+    gradivusDilemma: Map<string, number>;
     /**
-     * List of scans
+     * List of scanned Warframe objects
      * @type {Array<Scan>}
      */
     scans: Array<Scan>;
@@ -211,7 +211,7 @@ export default class Stats {
     scarletSpear: Map<string, number>;
     orphixVenomScore: any;
     happyZephyrScore: any;
-    kDriveRaces: any;
+    kDriveRaces: Race[];
     /**
      * Operation Gate Crash event
      * @type {number}
@@ -257,3 +257,4 @@ import Enemy from './Enemy.js';
 import Mission from './Mission.js';
 import Scan from './Scan.js';
 import Pvp from './Pvp.js';
+import Race from './Race.js';

package/types/Weapon.d.ts

@@ -3,6 +3,10 @@
  * @module
  */
 export default class Weapon {
+    /**
+     *
+     * @param {Object} weapon The weapon stats being parsed
+     */
     constructor(weapon: any);
     /**
      * Weapon unique name

package/types/XpInfo.d.ts

@@ -3,6 +3,10 @@
  * @module
  */
 export default class XpInfo {
+    /**
+     *
+     * @param {Object} info The info for a given ranked item
+     */
     constructor(info: any);
     /**
      * Unique name

package/src/WeaponSkin.js

@@ -1,13 +0,0 @@
-/**
- * A weapon skin
- * @module
- */
-export default class WeaponSkin {
-  constructor(skin) {
-    /**
-     * Unique name
-     * @type {String}
-     */
-    this.unuqueName = skin.ItemType;
-  }
-}

package/types/WeaponSkin.d.ts

@@ -1,12 +0,0 @@
-/**
- * A weapon skin
- * @module
- */
-export default class WeaponSkin {
-    constructor(skin: any);
-    /**
-     * Unique name
-     * @type {String}
-     */
-    unuqueName: string;
-}