@wfcd/profile-parser 1.0.0

package/src/Profile.js

@@ -0,0 +1,189 @@
+import { parseDate } from 'warframe-worldstate-data/utilities';
+
+import ChallengeProgress from './ChallengeProgress.js';
+import Intrinsics from './Intrinsics.js';
+import LoadOutInventory from './LoadOutInventory.js';
+import Mission from './Mission.js';
+import OperatorLoadOuts from './OperatorLoadOuts.js';
+import Syndicate from './Syndicate.js';
+
+export default class Profile {
+  constructor(profile, locale) {
+    /**
+     * Player's acount ID
+     * @type {Stirng}
+     */
+    this.accountId = profile.AccountId.$oid;
+
+    /**
+     * In-game name
+     * @type {String}
+     */
+    this.displayName = profile.DisplayName;
+
+    /**
+     * Mastery rank
+     * @type {String}
+     */
+    this.masteryRank = profile.PlayerLevel;
+
+    /**
+     * Current loadout
+     * @type {LoadOutInventory}
+     */
+    this.loadout = new LoadOutInventory(profile.LoadOutInventory);
+
+    /**
+     * Railjack and drifter Intrinsics
+     * @type {Intrinsics}
+     */
+    this.intrinsics = new Intrinsics(profile.PlayerSkills);
+
+    /**
+     * Nightwave challenges progress
+     * @type {}
+     */
+    this.challengeProgress = profile.ChallengeProgress.map((c) => new ChallengeProgress(c));
+
+    /**
+     * Guild ID
+     * @type {String}
+     */
+    this.guildId = profile.GuildId.$oid;
+
+    /**
+     * Guild name
+     * @type {String}
+     */
+    this.guildName = profile.GuildName;
+
+    /**
+     * Guild tier
+     * @type {number}
+     */
+    this.guildTier = profile.GuildTier;
+
+    /**
+     * Guild XP
+     * @type {number}
+     */
+    this.guildXp = profile.GuildXp;
+
+    /**
+     * Guild class
+     * @type {String}
+     */
+    this.guildClass = profile.GuildClass;
+
+    /**
+     * Guild emblem.
+     * @type {String}
+     */
+    this.guildEmblem = profile.GuildEmblem;
+
+    /**
+     * Alliance ID
+     * @type {String}
+     */
+    this.allianceId = profile.AllianceId.$oid;
+
+    /**
+     * Assassins currently asfter the player
+     * @type {Array<String>}
+     */
+    this.deathMarks = profile.DeathMarks;
+
+    /**
+     * Whether or not the player is qualified as a target for Zanuka
+     * @type {bool}
+     */
+    this.harvestable = profile.Harvestable;
+
+    /**
+     * Whether or not the player is qualified as a target for a syndicate death squad
+     * @type {bool}
+     */
+    this.deathSquadable = profile.DeathSquadable;
+
+    /**
+     * Date the account was created
+     * @type {Date}
+     */
+    this.created = parseDate(profile.Created);
+
+    /**
+     * Whether the user has migrated to console or not
+     * @type {bool}
+     */
+    this.migratedToConsole = profile.MigratedToConsole;
+
+    /**
+     * List of completed missions and their completions
+     * @type {MIssion}
+     */
+    this.missions = profile.Missions.map((m) => new Mission(m, locale));
+
+    /**
+     * Player standing and title across all syndicates
+     * @type {Array<Syndicate>}
+     */
+    this.syndicates = profile.Affiliations.map((a) => new Syndicate(a));
+
+    /**
+     * Daily standing per Syndicate
+     *
+     * Faction syndicates all share daily standing
+     * @type {Map<String,number>}
+     */
+    this.dailyStanding = {
+      daily: profile.DailyAffiliation,
+      conclave: profile.DailyAffiliationPvp,
+      simaris: profile.DailyAffiliationLibrary,
+      ostron: profile.DailyAffiliationCetus,
+      quills: profile.DailyAffiliationQuills,
+      solaris: profile.DailyAffiliationSolaris,
+      ventKids: profile.DailyAffiliationVentkids,
+      voxSolaris: profile.DailyAffiliationVox,
+      entrati: profile.DailyAffiliationEntrati,
+      necraloid: profile.DailyAffiliationNecraloid,
+      holdfasts: profile.DailyAffiliationZariman,
+      kahl: profile.DailyAffiliationKahl,
+      cavia: profile.DailyAffiliationCavia,
+    };
+
+    /**
+     * Daily focus
+     * @type {number}
+     */
+    this.dailyFocus = profile.DailyFocus;
+
+    /**
+     * Player wishlist for in-game market items
+     */
+    this.wishList = profile.Wishlist;
+
+    /**
+     * Whhether the player has unlocked thier operator or not
+     * @type {bool}
+     */
+    this.unlockedOperator = profile.UnlockedOperator;
+
+    /**
+     * Whether the player has unlocked their alignement or not
+     * @type {bool}
+     */
+    this.unlockedAlignment = profile.UnlockedAlignment;
+
+    /**
+     * Operator loadout
+     * @type {OperatorLoadOuts}
+     */
+    this.operatorLoadouts = profile.OperatorLoadOuts.map((ol) => new OperatorLoadOuts(ol));
+
+    /**
+     * Player's alignment
+     * @type {Map<String,number>}
+     */
+    this.alignment = { wisdom: profile.Alignment.Wisdom, alignment: profile.Alignment.Alignment };
+  }
+}

package/src/ProfileParser.js

@@ -0,0 +1,32 @@
+import { parseDate } from 'warframe-worldstate-data/utilities';
+
+import Profile from './Profile.js';
+import Stats from './Stats.js';
+
+export default class ProfileParser {
+  constructor(data, locale) {
+    /**
+     * Player's profile
+     * @type {Profile}
+     */
+    this.profile = new Profile(data.Results[0], locale);
+
+    // N/A
+    this.techProjects = data.TechProjects;
+
+    // N/A
+    this.xpComponents = data.XpCompoents;
+
+    // N/A
+    this.xpCacheExpiryDate = parseDate(data.XpCacheExpiryDate);
+
+    // N/A
+    this.ceremonyResetDate = parseDate(data.CeremonyResetDate);
+
+    /**
+     * Player stats
+     * @type {Stats}
+     */
+    this.stats = new Stats(data.Stats);
+  }
+}

package/src/Pvp.js

@@ -0,0 +1,27 @@
+export default class Pvp {
+  constructor(pvp) {
+    /**
+     * PVP match unique name
+     * @type {String}
+     */
+    this.uniqueName = pvp.type;
+
+    /**
+     * Deaths for this match
+     * @type {number}
+     */
+    this.suitDeaths = pvp.suitDeaths;
+
+    /**
+     * Warframe kills
+     * @type {number}
+     */
+    this.suitKills = pvp.suitKills;
+
+    /**
+     * Weapon killes
+     * @type {number}
+     */
+    this.weaponKills = pvp.weaponKills;
+  }
+}

package/src/Race.js

@@ -0,0 +1,15 @@
+export default class Race {
+  constructor(race) {
+    /**
+     * Race name
+     * @type {String}
+     */
+    this.uniqueName = race.type;
+
+    /**
+     * Race High score
+     * @type {number}
+     */
+    this.highScore = race.highScore;
+  }
+}

package/src/Scan.js

@@ -0,0 +1,15 @@
+export default class Scan {
+  constructor(scan) {
+    /**
+     * Enemy unique name
+     * @type {String}
+     */
+    this.uniqueName = scan.type;
+
+    /**
+     * Number of scans done
+     * @type {number}
+     */
+    this.scans = scan.scans;
+  }
+}

package/src/Stats.js

@@ -0,0 +1,339 @@
+import Ability from './Ability.js';
+import Enemy from './Enemy.js';
+import Mission from './Mission.js';
+import Pvp from './Pvp.js';
+import Race from './Race.js';
+import Scan from './Scan.js';
+import Weapon from './Weapon.js';
+
+/**
+ * Player stats
+ */
+export default class Stats {
+  /**
+   *
+   * @param {Object} stats Player stats
+   */
+  constructor(stats) {
+    /**
+     * Guild name
+     * @type {String}
+     */
+    this.guildName = stats.GuildName;
+
+    /**
+     * Player's total accumalted xp
+     * @type {String}
+     */
+    this.xp = stats.XP;
+
+    /**
+     * Missions completed
+     * @type {number}
+     */
+    this.missionsCompleted = stats.MissionsCompleted;
+
+    /**
+     * MIssions quit
+     * @type {number}
+     */
+    this.missionsQuit = stats.MissionsQuit;
+
+    /**
+     * MIsions failed
+     * @type {number}
+     */
+    this.missionsFailed = stats.missionsFailed;
+
+    /**
+     * MIssions interrupted
+     * @type {number}
+     */
+    this.missionsInterrupted = stats.MissionsInterrupted;
+
+    /**
+     * MIssions dumped
+     * @type {number}
+     */
+    this.missionsDumped = stats.MissionsDumped;
+
+    /**
+     * Items picked up
+     * @type {number}
+     */
+    this.pickupCount = stats.PickupCount;
+
+    /**
+     * Stats per weapon
+     * @type {Array<Weapon>}
+     */
+    this.weapons = stats.Weapons.map((w) => new Weapon(w));
+
+    /**
+     * Stats on enemy encounters.
+     * @type {Array<Enemy>}
+     */
+    this.enemies = stats.Enemies.map((e) => new Enemy(e));
+
+    /**
+     * Max score for Operation: Cryotic Front
+     * @type {number}
+     */
+    this.excavationEventScoreMax = stats.ExcavationEventScoreMax;
+
+    /**
+     * Max scoring for The Cicero crisis
+     * @type {number}
+     */
+    this.forestEventScoreMax = stats.ForestEventScoreMax;
+
+    /**
+     * Clan scoring for The Cicero crisis
+     * @type {number}
+     */
+    this.forestEventScoreSum = stats.ForestEventScoreSum;
+
+    /**
+     * Melee kilss
+     * @type {number}
+     */
+    this.meleeKills = stats.MeleeKills;
+
+    /**
+     * Used abilities
+     * @type {number}
+     */
+    this.abilities = stats.Abilities.map((a) => new Ability(a));
+
+    /**
+     * Ciphers completed succefully
+     * @type {number}
+     */
+    this.ciphersSolved = stats.CiphersSolved;
+
+    /**
+     * Ciphers failed
+     * @type {number}
+     */
+    this.ciphersFailed = stats.CiphersFaileds;
+
+    /**
+     * Gross income
+     * @type {number}
+     */
+    this.income = stats.Income;
+
+    /**
+     * Total play time since account creation
+     * @type {string}
+     */
+    this.timePlayedSec = stats.TimePlayedSec;
+
+    /**
+     * Average time to hack a panel
+     * @type {number}
+     */
+    this.cipherTime = stats.CipherTime;
+
+    // Not sure
+    /**
+     * @type {number}
+     */
+    this.rating = stats.Rating;
+
+    /**
+     * Mastery rank
+     * @type {number}
+     */
+    this.rank = stats.Rank;
+
+    /**
+     * Total deaths since account creation
+     * @type {number}
+     */
+    this.deaths = stats.Deaths;
+
+    /**
+     * Mastery rank
+     * @type {number}
+     */
+    this.playerLevel = stats.PlayerLevel;
+
+    /**
+     * List of missions and high scores
+     * @type {Array<Mission>}
+     */
+    this.missions = stats.Missions.map((m) => new Mission(m));
+
+    /**
+     * Team heals
+     * @type {number}
+     */
+    this.healCount = stats.HealCount;
+
+    /**
+     * Event Scores for Operation breeding grounds
+     * @type {Map<String,numbert>}
+     */
+    this.breedGrounds = {
+      personalScore: stats.HiveEventScore,
+      clanScore: stats.HiveEventScoreSum,
+    };
+
+    /**
+     * Event Scores for The Gradivus Dilemma
+     * @type {Map<String,numbert>}
+     */
+    this.gradivusDilemma = {
+      grineer: stats.InvasionEventGrineerScore,
+      corpus: stats.InvasionEventCorpusScore,
+    };
+
+    /**
+     * List of scans
+     * @type {Array<Scan>}
+     */
+    this.scans = stats.Scans.map((s) => new Scan(s));
+
+    /**
+     * Team revives
+     * @type {number}
+     */
+    this.reviveCount = stats.ReviveCount;
+
+    /**
+     * Score for Operation: Eyes of Blight
+     */
+    this.fomorianEventScore = stats.FomorianEventScore;
+
+    /**
+     * Conclave scores
+     * @type {Array<Pvp>}
+     */
+    this.pvp = stats.PVP.map((pvp) => new Pvp(pvp));
+
+    /**
+     * Lunaro stats
+     * @type {Map<String,number>}
+     */
+    this.lunaro = {
+      ties: stats.PVPSpeedballTies,
+      checks: stats.PVPSpeedballChecks,
+      goals: stats.PVPSpeedballGoals,
+      interceptions: stats.PVPSpeedballInterceptions,
+      steals: stats.PVPSpeedballSteals,
+      points: stats.PVPSpeedballPoints,
+      losses: stats.PVPSpeedballLosses,
+      assists: stats.PVPSpeedballAssists,
+      wins: stats.PVPSpeedballWins,
+      saves: stats.PVPSpeedballSaves,
+      passes: stats.PVPSpeedballPasses,
+    };
+
+    /**
+     * Dojo obstacle course goal
+     * @type {number}
+     */
+    this.dojoObstacleScore = stats.DojoObstacleScore;
+
+    /**
+     * @type {number}
+     */
+    this.pvpGamesPendingMask = stats.PvpGamesPendingMask;
+
+    /**
+     * @type {number}
+     */
+    this.dedicatedServerGamesCompleted = stats.DedicatedServerGamesCompleted;
+
+    /**
+     * Event score for the Pacifism Defect
+     * @type {number}
+     */
+    this.pacifismDefect = stats.ColonistRescueEventScoreMax;
+
+    /**
+     * Score for operation Ambulas reborn.
+     * @type {number}
+     */
+    this.ambulasReborn = stats.AmbulasEventScoreMax;
+
+    /**
+     * Score for Wyrmius mini game
+     * @type {number}
+     */
+    this.sentinelGameScore = stats.SentinelGameScore;
+
+    /**
+     * Event score for operation hostile merger
+     * @type {number}
+     */
+    this.amalgamEventScoreMax = stats.AmalgamEventScoreMax;
+
+    /**
+     * Operation Scarlet spear event score and badges
+     * @type {Map<String,number>}
+     */
+    this.scarletSpear = {
+      eventScore: stats.FlotillaEventScore,
+      condrixTier1: stats.FlotillaGroundBadgesTier1,
+      condrixTier2: stats.FlotillaGroundBadgesTier2,
+      condrixTier3: stats.FlotillaGroundBadgesTier3,
+      murexTier1: stats.FlotillaSpaceBadgesTier1,
+      murexTier2: stats.FlotillaSpaceBadgesTier2,
+      murexTier3: stats.FlotillaSpaceBadgesTier3,
+    };
+
+    this.orphixVenomScore = stats.MechSurvivalScoreMax;
+    this.happyZephyrScore = stats.ZephyrScore;
+
+    this.kDriveRaces = Object.entries(stats.Races).map(([type, { highScore }]) => new Race({ type, highScore }));
+
+    /**
+     * Operation Gate Crash event
+     * @type {number}
+     */
+    this.gateCrash = stats.PortalEventScore;
+
+    /**
+     * Per mission score for Operation: False Profit
+     * @type {number}
+     */
+    this.falseProfitMissionScore = stats.RiotMoaEventScore;
+
+    /**
+     * Total even score for Operation: False Profit
+     * @type {number}
+     */
+    this.fasleProfitEventScore = stats.RiotMoaEventScoreMax;
+
+    /**
+     * Operation: Shadow Debt event score
+     * @type {number}
+     */
+    this.shadowDebtEventScore = stats.ProjectSinisterEventScore;
+
+    /**
+     * Operation: Rathuum event score
+     * @type {number}
+     */
+    this.rathuumEventScore = stats.KelaEventBonusScoreMax;
+
+    /**
+     * Hollowed flame event max score
+     * @type {number}
+     */
+    this.hallowedFlameScoreMax = stats.Halloween19ScoreMax;
+
+    /**
+     * Survival Weekend event score
+     * @type {number}
+     */
+    this.survivalWeekenedEventScore = stats.SurvivalEventScore;
+
+    /**
+     * @type {number}
+     */
+    this.infestedEventScore = stats.InfestedEventScore;
+  }
+}

package/src/Syndicate.js

@@ -0,0 +1,30 @@
+/**
+ * Represents a player's progress with a Syndicate
+ */
+export default class Syndicate {
+  /**
+   * @param {Object} affiliation The syndicate data
+   */
+  constructor(affiliation) {
+    // TODO: name is readable but still might want to clean them up
+    // i.e "NewLokaSyndicate" can be "New Loka"" instead
+
+    /**
+     * Name of the syndicate
+     * @type {String}
+     */
+    this.name = affiliation.Tag;
+
+    /**
+     * Current standing the player has with the syndicate
+     * @type {number}
+     */
+    this.standing = affiliation.Standing;
+
+    /**
+     * The player's current syndicate title
+     * @type {String}
+     */
+    this.title = affiliation.Title;
+  }
+}

package/src/Util.js

@@ -0,0 +1,12 @@
+/**
+ * Map base10 int colors to hex color strings
+ * @param {Record<string, number | undefined>} colors color map
+ * @returns {Record<string, string>}
+ */
+export default function mapToHex(colors) {
+  const hex = {};
+  Object.entries(colors).forEach(([key, /** @type {undefined | number}  */ value]) => {
+    hex[key] = Math.abs(value).toString(16).toUpperCase();
+  });
+  return hex;
+}

package/src/Weapon.js

@@ -0,0 +1,51 @@
+export default class Weapon {
+  constructor(weapon) {
+    /**
+     * Weapon unique name
+     * @type {String}
+     */
+    this.uniqueName = weapon.type;
+
+    /**
+     * Earned XP with weapon
+     * @type {number}
+     */
+    this.xp = weapon.xp;
+
+    /**
+     * Time using this weapon
+     * @type {number}
+     */
+    this.equiptime = weapon.equipTime;
+
+    /**
+     * Headshots using this weapon
+     * @type {number}
+     */
+    this.headShots = weapon.headShots;
+
+    /**
+     * Hits using weapon
+     * @type {number}
+     */
+    this.hits = weapon.hits;
+
+    /**
+     * Assists using weapon
+     * @type {number}
+     */
+    this.assists = weapon.assists;
+
+    /**
+     * Kills with weapon
+     * @type {number}
+     */
+    this.kills = weapon.kills;
+
+    /**
+     * Shots fired
+     * @type {number}
+     */
+    this.fired = weapon.fired;
+  }
+}