@wfcd/profile-parser 1.2.2 → 1.3.0

package/README.md

@@ -14,7 +14,7 @@ You can find the documentation [here](https://wfcd.github.io/profile-parser/)
 ## Installation
 
 ```shell
-$ npm i -S profile-parser
+$ npm i -S @wfcd/profile-parser
 ```
 
 ## Example usage

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wfcd/profile-parser",
-  "version": "1.2.2",
+  "version": "1.3.0",
   "description": "Parser for Digital Extreme's profile data",
   "type": "module",
   "main": "src/ProfileParser.js",
@@ -55,7 +55,7 @@
   "author": "SlayerOrnstein",
   "license": "MIT",
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.0.0"
   },
   "eslintConfig": {
     "extends": "@wfcd/eslint-config/esm",

package/src/LoadOutInventory.js

@@ -11,8 +11,9 @@ export default class LoadOutInventory {
    *
    * @param {Object} item The loadout data
    * @param {string} [locale='en'] The locale to return loudout items in
+   * @param {boolean} [withItem=false] Whether or not to include items
    */
-  constructor(item, locale = 'en') {
+  constructor(item, locale = 'en', withItem = false) {
     /**
      * Skins applied to weapons
      * @type {WeaponSkin}
@@ -47,6 +48,6 @@ export default class LoadOutInventory {
      * Items that have counted towards the players mastery rank
      * @type {XpInfo}
      */
-    this.xpInfo = item.XPInfo.map((xp) => new XpInfo(xp, locale));
+    this.xpInfo = item.XPInfo.map((xp) => new XpInfo(xp, locale, withItem));
   }
 }

package/src/LoadOutPreset.js

@@ -0,0 +1,90 @@
+import { translatePolarity } from 'warframe-worldstate-data/utilities';
+
+import { numberToLetter } from './Utils.js';
+
+class SlotPreset {
+  constructor(slot) {
+    if (slot?.ItemId?.$oid) this.id = slot.ItemId.$oid;
+
+    if (slot?.mod !== undefined) this.modPreset = numberToLetter(slot.mod);
+
+    if (slot?.cus !== undefined) this.appearancePreset = numberToLetter(slot.cus);
+
+    this.isHidden = slot?.hide ?? false;
+  }
+}
+
+export default class LoadOutPreset {
+  constructor(preset) {
+    /**
+     * Focus School
+     * @type {String}
+     */
+    this.focusSchool = translatePolarity(preset.FocusSchool);
+
+    /**
+     * Preset icon
+     *
+     * Note:
+     * Icon in-game seems to be an image of whatever Warframe is equipped on it
+     * @type {String}
+     */
+    this.icon = preset.PresetIcon;
+
+    /**
+     * Whether this preset is a favorite
+     * @type {boolean}
+     */
+    this.isFavorite = preset.Favorite;
+
+    /**
+     * Preset name
+     * @type {String}
+     */
+    this.name = preset.n;
+
+    /**
+     * Warframe equipped in preset
+     * @type {SlotPreset}
+     */
+    this.warframe = new SlotPreset(preset.s);
+
+    /**
+     * Primary equipped in preset
+     * @type {SlotPreset}
+     */
+    if (preset.l) this.primary = new SlotPreset(preset.l);
+
+    /**
+     * Secondary equipped in preset
+     * @type {SlotPreset}
+     */
+    if (preset.p) this.secondary = new SlotPreset(preset.p);
+
+    /**
+     * Heavy equipped in preset
+     * @type {SlotPreset}
+     */
+    if (preset.h) this.heavy = new SlotPreset(preset.h);
+
+    /**
+     * Melee equiped in preset
+     * @type {SlotPreset}
+     */
+    if (preset.m) this.melee = new SlotPreset(preset.m);
+
+    /**
+     * Exalted ability
+     * @type {SlotPreset}
+     */
+    if (preset.a) this.exalted = new SlotPreset(preset.a);
+
+    /**
+     * Secondary exalted ability
+     *
+     * i.e Sevagoth has his shadow and his shadow's claws both of which can be modded separately
+     * @type {SlotPreset}
+     */
+    if (preset.b) this.exaltedB = new SlotPreset(preset.b);
+  }
+}

package/src/Profile.js

@@ -6,6 +6,7 @@ import LoadOutInventory from './LoadOutInventory.js';
 import Mission from './Mission.js';
 import OperatorLoadOuts from './OperatorLoadOuts.js';
 import Syndicate from './Syndicate.js';
+import LoadOutPreset from './LoadOutPreset.js';
 
 /**
  * A player's profile
@@ -16,8 +17,9 @@ export default class Profile {
    *
    * @param {Object} profile The profile data to parse
    * @param {string} locale The locale to return in where possible
+   * @param {boolean} [withItem=false] Whether or not to include items
    */
-  constructor(profile, locale = 'en') {
+  constructor(profile, locale = 'en', withItem = false) {
     /**
      * Player's acount ID
      * @type {Stirng}
@@ -30,17 +32,29 @@ export default class Profile {
      */
     this.displayName = profile.DisplayName;
 
+    /**
+     * List of usernames across supported platforms
+     * @type {Array<String>}
+     */
+    this.platformNames = profile.PlatformNames;
+
     /**
      * Mastery rank
      * @type {String}
      */
     this.masteryRank = profile.PlayerLevel;
 
+    /**
+     * Load out preset equiped
+     * @type {LoadOutPreset | undefined}
+     */
+    if (profile.LoadOutPreset) this.preset = new LoadOutPreset(profile.LoadOutPreset);
+
     /**
      * Current loadout
      * @type {LoadOutInventory}
      */
-    this.loadout = new LoadOutInventory(profile.LoadOutInventory, locale);
+    this.loadout = new LoadOutInventory(profile.LoadOutInventory, locale, withItem);
 
     /**
      * Railjack and drifter Intrinsics
@@ -50,7 +64,7 @@ export default class Profile {
 
     /**
      * Nightwave challenges progress
-     * @type {}
+     * @type {Array<ChallengeProgress>}
      */
     this.challengeProgress = profile.ChallengeProgress.map((c) => new ChallengeProgress(c));
 
@@ -92,9 +106,9 @@ export default class Profile {
 
     /**
      * Alliance ID
-     * @type {String}
+     * @type {String | undefined}
      */
-    this.allianceId = profile.AllianceId.$oid;
+    if (profile.AllianceId?.$oid) this.allianceId = profile.AllianceId.$oid;
 
     /**
      * Assassins currently asfter the player

package/src/ProfileParser.js

@@ -12,13 +12,14 @@ export default class ProfileParser {
    *
    * @param {Object} data The data returned by getProfile endpoint
    * @param {string} locale The locale to return where possible
+   * @param {boolean} [withItem=false] Whether or not to include items
    */
-  constructor(data, locale = 'en') {
+  constructor(data, locale = 'en', withItem = false) {
     /**
      * Player's profile
      * @type {Profile}
      */
-    this.profile = new Profile(data.Results[0], locale);
+    this.profile = new Profile(data.Results[0], locale, withItem);
 
     /**
      * @type {number}

package/src/Stats.js

@@ -211,7 +211,7 @@ export default class Stats {
      * Conclave scores
      * @type {Array<Pvp>}
      */
-    this.pvp = stats.PVP.map((pvp) => new Pvp(pvp));
+    if (stats.PVP) this.pvp = stats.PVP.map((pvp) => new Pvp(pvp));
 
     /**
      * Lunaro stats

package/src/Utils.js

@@ -62,3 +62,5 @@ export const find = (name, locale = 'en') => {
 
   return item;
 };
+
+export const numberToLetter = (num) => String.fromCharCode(64 + (num + 1));

package/src/XpInfo.js

@@ -9,8 +9,9 @@ export default class XpInfo {
    *
    * @param {Object} info The info for a given ranked item
    * @param {string} locale langauge to return item in
+   * @param {boolean} [withItem=false] Whether or not to include items
    */
-  constructor(info, locale = 'en') {
+  constructor(info, locale = 'en', withItem = false) {
     /**
      * Unique name
      * @type {String}
@@ -23,10 +24,12 @@ export default class XpInfo {
      */
     this.xp = info.XP;
 
-    /**
-     * The item corrosponding to the unique name.
-     * @type {module:"warframe-items".Item | undefined}
-     */
-    this.item = find(info.ItemType, locale);
+    if (withItem) {
+      /**
+       * The item corrosponding to the unique name.
+       * @type {module:"warframe-items".Item | undefined}
+       */
+      this.item = find(info.ItemType, locale);
+    }
   }
 }

package/types/LoadOutInventory.d.ts

@@ -7,8 +7,9 @@ export default class LoadOutInventory {
      *
      * @param {Object} item The loadout data
      * @param {string} [locale='en'] The locale to return loudout items in
+     * @param {boolean} [withItem=false] Whether or not to include items
      */
-    constructor(item: any, locale?: string);
+    constructor(item: any, locale?: string, withItem?: boolean);
     /**
      * Skins applied to weapons
      * @type {WeaponSkin}

package/types/LoadOutPreset.d.ts

@@ -0,0 +1,45 @@
+export default class LoadOutPreset {
+    constructor(preset: any);
+    /**
+     * Focus School
+     * @type {String}
+     */
+    focusSchool: string;
+    /**
+     * Preset icon
+     *
+     * Note:
+     * Icon in-game seems to be an image of whatever Warframe is equipped on it
+     * @type {String}
+     */
+    icon: string;
+    /**
+     * Whether this preset is a favorite
+     * @type {boolean}
+     */
+    isFavorite: boolean;
+    /**
+     * Preset name
+     * @type {String}
+     */
+    name: string;
+    /**
+     * Warframe equipped in preset
+     * @type {SlotPreset}
+     */
+    warframe: SlotPreset;
+    primary: SlotPreset;
+    secondary: SlotPreset;
+    heavy: SlotPreset;
+    melee: SlotPreset;
+    exalted: SlotPreset;
+    exaltedB: SlotPreset;
+}
+declare class SlotPreset {
+    constructor(slot: any);
+    id: any;
+    modPreset: string;
+    appearancePreset: string;
+    isHidden: any;
+}
+export {};

package/types/Profile.d.ts

@@ -7,8 +7,9 @@ export default class Profile {
      *
      * @param {Object} profile The profile data to parse
      * @param {string} locale The locale to return in where possible
+     * @param {boolean} [withItem=false] Whether or not to include items
      */
-    constructor(profile: any, locale?: string);
+    constructor(profile: any, locale?: string, withItem?: boolean);
     /**
      * Player's acount ID
      * @type {Stirng}
@@ -19,11 +20,17 @@ export default class Profile {
      * @type {String}
      */
     displayName: string;
+    /**
+     * List of usernames across supported platforms
+     * @type {Array<String>}
+     */
+    platformNames: Array<string>;
     /**
      * Mastery rank
      * @type {String}
      */
     masteryRank: string;
+    preset: LoadOutPreset;
     /**
      * Current loadout
      * @type {LoadOutInventory}
@@ -36,9 +43,9 @@ export default class Profile {
     intrinsics: Intrinsics;
     /**
      * Nightwave challenges progress
-     * @type {}
+     * @type {Array<ChallengeProgress>}
      */
-    challengeProgress: any;
+    challengeProgress: Array<ChallengeProgress>;
     /**
      * Guild ID
      * @type {String}
@@ -69,11 +76,7 @@ export default class Profile {
      * @type {String}
      */
     guildEmblem: string;
-    /**
-     * Alliance ID
-     * @type {String}
-     */
-    allianceId: string;
+    allianceId: any;
     /**
      * Assassins currently asfter the player
      * @type {Array<String>}
@@ -146,7 +149,9 @@ export default class Profile {
      */
     alignment: Map<string, number>;
 }
+import LoadOutPreset from './LoadOutPreset.js';
 import LoadOutInventory from './LoadOutInventory.js';
 import Intrinsics from './Intrinsics.js';
+import ChallengeProgress from './ChallengeProgress.js';
 import Syndicate from './Syndicate.js';
 import OperatorLoadOuts from './OperatorLoadOuts.js';

package/types/ProfileParser.d.ts

@@ -7,8 +7,9 @@ export default class ProfileParser {
      *
      * @param {Object} data The data returned by getProfile endpoint
      * @param {string} locale The locale to return where possible
+     * @param {boolean} [withItem=false] Whether or not to include items
      */
-    constructor(data: any, locale?: string);
+    constructor(data: any, locale?: string, withItem?: boolean);
     /**
      * Player's profile
      * @type {Profile}

package/types/Stats.d.ts

@@ -161,11 +161,7 @@ export default class Stats {
      * Score for Operation: Eyes of Blight
      */
     fomorianEventScore: any;
-    /**
-     * Conclave scores
-     * @type {Array<Pvp>}
-     */
-    pvp: Array<Pvp>;
+    pvp: any;
     /**
      * Lunaro stats
      * @type {Map<String,number>}
@@ -256,5 +252,4 @@ import Weapon from './Weapon.js';
 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/Utils.d.ts

@@ -1,2 +1,3 @@
 export function mapToHex(colors: Record<string, number | undefined>): Record<string, string>;
 export function find(name: string, locale?: string): Item;
+export function numberToLetter(num: any): string;

package/types/XpInfo.d.ts

@@ -7,8 +7,9 @@ export default class XpInfo {
      *
      * @param {Object} info The info for a given ranked item
      * @param {string} locale langauge to return item in
+     * @param {boolean} [withItem=false] Whether or not to include items
      */
-    constructor(info: any, locale?: string);
+    constructor(info: any, locale?: string, withItem?: boolean);
     /**
      * Unique name
      * @type {String}