@wfcd/profile-parser 1.3.1 → 1.4.1

package/README.md

@@ -23,7 +23,9 @@ $ npm i -S @wfcd/profile-parser
 import { ProfileParser } from 'profile-parser';
 
 const profileData = await fetch('https://content.warframe.com/dynamic/getProfileViewingData.php?n=${username}');
-const user = new ProfileParser(await profileData.text());
+const user = new ProfileParser(await profileData.json());
 
 console.log(user.profile.displayName);
 ```
+
+If this data is stale, you can check the `Cache-Control` header of the response from DE's server to see how long to wait for retry, and you could have the above retry after that amount of time. However, this may cause _significant_ delay if the data is not saved/hydrated in a fully asynchronous or event-based timeframe.

package/package.json

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

package/src/Intrinsics.js

@@ -12,66 +12,66 @@ export default class Intrinsics {
      * Intrinsic points for railjack
      * @type {number}
      */
-    this.railjack = Math.floor(skills.LPP_SPACE / 1000);
+    this.railjack = Math.floor((skills.LPP_SPACE ?? 0) / 1000);
 
     /**
      * Railjack engineering rank
      * @type {number}
      */
-    this.engineering = skills.LPS_ENGINEERING;
+    this.engineering = skills.LPS_ENGINEERING ?? 0;
 
     /**
      * Railjack gunnery rank
      * @type {number}
      */
-    this.gunnery = skills.LPS_GUNNERY;
+    this.gunnery = skills.LPS_GUNNERY ?? 0;
 
     /**
      * Railjack piloting rank
      * @type {number}
      */
-    this.piloting = skills.LPS_PILOTING;
+    this.piloting = skills.LPS_PILOTING ?? 0;
 
     /**
      * Railjack tactical rank
      * @type {number}
      */
-    this.tactical = skills.LPS_TACTICAL;
+    this.tactical = skills.LPS_TACTICAL ?? 0;
 
     /**
      * Railjack command rank
      * @type {number}
      */
-    this.command = skills.LPS_COMMAND;
+    this.command = skills.LPS_COMMAND ?? 0;
 
     /**
      * Intrinsic points for railjack
      * @type {number}
      */
-    this.drifter = Math.floor(skills.LPP_DRIFTER / 1000);
+    this.drifter = Math.floor((skills.LPP_DRIFTER ?? 0) / 1000);
 
     /**
      * Drifter riding rank
      * @type {number}
      */
-    this.riding = skills.LPS_DRIFT_RIDING;
+    this.riding = skills.LPS_DRIFT_RIDING ?? 0;
 
     /**
      * Drifter combat rank
      * @type {number}
      */
-    this.combat = skills.LPS_DRIFT_COMBAT;
+    this.combat = skills.LPS_DRIFT_COMBAT ?? 0;
 
     /**
      * Drifter opportunity rank
      * @type {number}
      */
-    this.opportunity = skills.LPS_DRIFT_OPPORTUNITY;
+    this.opportunity = skills.LPS_DRIFT_OPPORTUNITY ?? 0;
 
     /**
      * Drifter endurance rank
      * @type {number}
      */
-    this.endurance = skills.LPS_DRIFT_ENDURANCE;
+    this.endurance = skills.LPS_DRIFT_ENDURANCE ?? 0;
   }
 }

package/src/LoadOutItem.js

@@ -46,11 +46,15 @@ export default class LoadOutItem {
     if (weapon.ItemName) {
       const [, nemesis] = weapon.ItemName.split('|');
 
-      /**
-       * Item lich name
-       * @type {String}
-       */
-      this.nemesis = toTitleCase(nemesis);
+      if (nemesis !== undefined) {
+        /**
+         * The name of the Lich, Sister, or Technocyte
+         * @type {String}
+         */
+        this.nemesis = toTitleCase(nemesis);
+      } else {
+        this.name = weapon.ItemName;
+      }
     }
 
     /**
@@ -124,6 +128,12 @@ export default class LoadOutItem {
      */
     if (weapon.sigcol) this.sigilColor = colors.mapColors(weapon.sigcol.toString(16));
 
+    /**
+     * Whether prime details are enabled or not
+     * @type {boolean}
+     */
+    this.enablePrime = weapon.ugly ?? false;
+
     /**
      * Attachment colors applied to item if they exist
      * @type {module:"warframe-items".ColorMap | undefined}

package/src/Profile.js

@@ -21,8 +21,8 @@ export default class Profile {
    */
   constructor(profile, locale = 'en', withItem = false) {
     /**
-     * Player's acount ID
-     * @type {Stirng}
+     * Player's account ID
+     * @type {String}
      */
     this.accountId = profile.AccountId.$oid;
 
@@ -45,7 +45,7 @@ export default class Profile {
     this.masteryRank = profile.PlayerLevel;
 
     /**
-     * Load out preset equiped
+     * Load out preset equipped
      * @type {LoadOutPreset | undefined}
      */
     if (profile.LoadOutPreset) this.preset = new LoadOutPreset(profile.LoadOutPreset);
@@ -60,7 +60,7 @@ export default class Profile {
      * Railjack and drifter Intrinsics
      * @type {Intrinsics}
      */
-    this.intrinsics = new Intrinsics(profile.PlayerSkills);
+    this.intrinsics = new Intrinsics(profile.PlayerSkills ?? {});
 
     /**
      * Nightwave challenges progress
@@ -72,7 +72,7 @@ export default class Profile {
      * Guild ID
      * @type {String}
      */
-    this.guildId = profile.GuildId.$oid;
+    if (profile.GuildId?.$oid) this.guildId = profile.GuildId.$oid;
 
     /**
      * Guild name
@@ -118,13 +118,13 @@ export default class Profile {
 
     /**
      * Whether or not the player is qualified as a target for Zanuka
-     * @type {bool}
+     * @type {boolean}
      */
     this.harvestable = profile.Harvestable;
 
     /**
      * Whether or not the player is qualified as a target for a syndicate death squad
-     * @type {bool}
+     * @type {boolean}
      */
     this.deathSquadable = profile.DeathSquadable;
 
@@ -136,13 +136,13 @@ export default class Profile {
 
     /**
      * Whether the user has migrated to console or not
-     * @type {bool}
+     * @type {boolean}
      */
     this.migratedToConsole = profile.MigratedToConsole;
 
     /**
      * List of completed missions and their completions
-     * @type {MIssion}
+     * @type {Mission}
      */
     this.missions = profile.Missions.map((m) => new Mission(m, locale));
 
@@ -150,7 +150,7 @@ export default class Profile {
      * Player standing and title across all syndicates
      * @type {Array<Syndicate>}
      */
-    this.syndicates = profile.Affiliations.map((a) => new Syndicate(a));
+    this.syndicates = profile.Affiliations?.map((a) => new Syndicate(a)) ?? [];
 
     /**
      * Daily standing per Syndicate
@@ -172,6 +172,7 @@ export default class Profile {
       holdfasts: profile.DailyAffiliationZariman,
       kahl: profile.DailyAffiliationKahl,
       cavia: profile.DailyAffiliationCavia,
+      hex: profile.DailyAffiliationHex,
     };
 
     /**
@@ -186,14 +187,14 @@ export default class Profile {
     this.wishList = profile.Wishlist;
 
     /**
-     * Whhether the player has unlocked thier operator or not
-     * @type {bool}
+     * Whether the player has unlocked their operator or not
+     * @type {boolean}
      */
     this.unlockedOperator = profile.UnlockedOperator;
 
     /**
-     * Whether the player has unlocked their alignement or not
-     * @type {bool}
+     * Whether the player has unlocked their alignment or not
+     * @type {boolean}
      */
     this.unlockedAlignment = profile.UnlockedAlignment;
 
@@ -205,8 +206,8 @@ export default class Profile {
 
     /**
      * Player's alignment
-     * @type {Map<String,number>}
+     * @type {Map<String,number | undefined>}
      */
-    this.alignment = { wisdom: profile.Alignment.Wisdom, alignment: profile.Alignment.Alignment };
+    this.alignment = { wisdom: profile.Alignment?.Wisdom, alignment: profile.Alignment?.Alignment };
   }
 }

package/src/Race.js

@@ -28,6 +28,6 @@ export default class Race {
    * @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));
+    return Object.entries(races ?? []).map(([type, { highScore }]) => new Race(type, highScore));
   }
 }

package/src/Stats.js

@@ -23,7 +23,7 @@ export default class Stats {
     this.guildName = stats.GuildName;
 
     /**
-     * Player's total accumalted xp
+     * Player's total accumulated xp
      * @type {String}
      */
     this.xp = stats.XP;
@@ -35,25 +35,25 @@ export default class Stats {
     this.missionsCompleted = stats.MissionsCompleted;
 
     /**
-     * MIssions quit
+     * Missions quit
      * @type {number}
      */
     this.missionsQuit = stats.MissionsQuit;
 
     /**
-     * MIsions failed
+     * Misions failed
      * @type {number}
      */
     this.missionsFailed = stats.missionsFailed;
 
     /**
-     * MIssions interrupted
+     * Missions interrupted
      * @type {number}
      */
     this.missionsInterrupted = stats.MissionsInterrupted;
 
     /**
-     * MIssions dumped
+     * Missions dumped
      * @type {number}
      */
     this.missionsDumped = stats.MissionsDumped;
@@ -95,7 +95,7 @@ export default class Stats {
     this.forestEventScoreSum = stats.ForestEventScoreSum;
 
     /**
-     * Melee kilss
+     * Melee kills
      * @type {number}
      */
     this.meleeKills = stats.MeleeKills;
@@ -107,7 +107,7 @@ export default class Stats {
     this.abilities = stats.Abilities.map((a) => new Ability(a));
 
     /**
-     * Ciphers completed succefully
+     * Ciphers completed successfully
      * @type {number}
      */
     this.ciphersSolved = stats.CiphersSolved;
@@ -194,7 +194,7 @@ export default class Stats {
      * List of scanned Warframe objects
      * @type {Array<Scan>}
      */
-    this.scans = stats.Scans.map((s) => new Scan(s));
+    this.scans = stats.Scans?.map((s) => new Scan(s)) ?? [];
 
     /**
      * Team revives

package/types/LoadOutItem.d.ts

@@ -30,7 +30,7 @@ export default class LoadOutItem {
      */
     item: any;
     /**
-     * Item lich name
+     * The name of the Lich, Sister, or Technocyte
      * @type {String}
      */
     nemesis: string;
@@ -79,6 +79,11 @@ export default class LoadOutItem {
     customizationSlotPurchases: number;
     primaryColor: any;
     sigilColor: any;
+    /**
+     * Whether prime details are enabled or not
+     * @type {boolean}
+     */
+    enablePrime: boolean;
     attachmentsColor: any;
     syandanaColor: any;
     infestationDate: any;

package/types/Profile.d.ts

@@ -11,10 +11,10 @@ export default class Profile {
      */
     constructor(profile: any, locale?: string, withItem?: boolean);
     /**
-     * Player's acount ID
-     * @type {Stirng}
+     * Player's account ID
+     * @type {String}
      */
-    accountId: Stirng;
+    accountId: string;
     /**
      * In-game name
      * @type {String}
@@ -46,11 +46,7 @@ export default class Profile {
      * @type {Array<ChallengeProgress>}
      */
     challengeProgress: Array<ChallengeProgress>;
-    /**
-     * Guild ID
-     * @type {String}
-     */
-    guildId: string;
+    guildId: any;
     /**
      * Guild name
      * @type {String}
@@ -84,14 +80,14 @@ export default class Profile {
     deathMarks: Array<string>;
     /**
      * Whether or not the player is qualified as a target for Zanuka
-     * @type {bool}
+     * @type {boolean}
      */
-    harvestable: bool;
+    harvestable: boolean;
     /**
      * Whether or not the player is qualified as a target for a syndicate death squad
-     * @type {bool}
+     * @type {boolean}
      */
-    deathSquadable: bool;
+    deathSquadable: boolean;
     /**
      * Date the account was created
      * @type {Date}
@@ -99,14 +95,14 @@ export default class Profile {
     created: Date;
     /**
      * Whether the user has migrated to console or not
-     * @type {bool}
+     * @type {boolean}
      */
-    migratedToConsole: bool;
+    migratedToConsole: boolean;
     /**
      * List of completed missions and their completions
-     * @type {MIssion}
+     * @type {Mission}
      */
-    missions: MIssion;
+    missions: Mission;
     /**
      * Player standing and title across all syndicates
      * @type {Array<Syndicate>}
@@ -129,15 +125,15 @@ export default class Profile {
      */
     wishList: any;
     /**
-     * Whhether the player has unlocked thier operator or not
-     * @type {bool}
+     * Whether the player has unlocked their operator or not
+     * @type {boolean}
      */
-    unlockedOperator: bool;
+    unlockedOperator: boolean;
     /**
-     * Whether the player has unlocked their alignement or not
-     * @type {bool}
+     * Whether the player has unlocked their alignment or not
+     * @type {boolean}
      */
-    unlockedAlignment: bool;
+    unlockedAlignment: boolean;
     /**
      * Operator loadout
      * @type {OperatorLoadOuts | undefined}
@@ -145,13 +141,14 @@ export default class Profile {
     operatorLoadouts: OperatorLoadOuts | undefined;
     /**
      * Player's alignment
-     * @type {Map<String,number>}
+     * @type {Map<String,number | undefined>}
      */
-    alignment: Map<string, number>;
+    alignment: Map<string, number | undefined>;
 }
 import LoadOutPreset from './LoadOutPreset.js';
 import LoadOutInventory from './LoadOutInventory.js';
 import Intrinsics from './Intrinsics.js';
 import ChallengeProgress from './ChallengeProgress.js';
+import Mission from './Mission.js';
 import Syndicate from './Syndicate.js';
 import OperatorLoadOuts from './OperatorLoadOuts.js';

package/types/Stats.d.ts

@@ -14,7 +14,7 @@ export default class Stats {
      */
     guildName: string;
     /**
-     * Player's total accumalted xp
+     * Player's total accumulated xp
      * @type {String}
      */
     xp: string;
@@ -24,22 +24,22 @@ export default class Stats {
      */
     missionsCompleted: number;
     /**
-     * MIssions quit
+     * Missions quit
      * @type {number}
      */
     missionsQuit: number;
     /**
-     * MIsions failed
+     * Misions failed
      * @type {number}
      */
     missionsFailed: number;
     /**
-     * MIssions interrupted
+     * Missions interrupted
      * @type {number}
      */
     missionsInterrupted: number;
     /**
-     * MIssions dumped
+     * Missions dumped
      * @type {number}
      */
     missionsDumped: number;
@@ -74,7 +74,7 @@ export default class Stats {
      */
     forestEventScoreSum: number;
     /**
-     * Melee kilss
+     * Melee kills
      * @type {number}
      */
     meleeKills: number;
@@ -84,7 +84,7 @@ export default class Stats {
      */
     abilities: number;
     /**
-     * Ciphers completed succefully
+     * Ciphers completed successfully
      * @type {number}
      */
     ciphersSolved: number;