@wfcd/profile-parser 1.4.1 → 2.0.0

package/src/Profile.js

@@ -1,213 +0,0 @@
-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';
-import LoadOutPreset from './LoadOutPreset.js';
-
-/**
- * A player's profile
- * @module
- */
-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', withItem = false) {
-    /**
-     * Player's account ID
-     * @type {String}
-     */
-    this.accountId = profile.AccountId.$oid;
-
-    /**
-     * In-game name
-     * @type {String}
-     */
-    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 equipped
-     * @type {LoadOutPreset | undefined}
-     */
-    if (profile.LoadOutPreset) this.preset = new LoadOutPreset(profile.LoadOutPreset);
-
-    /**
-     * Current loadout
-     * @type {LoadOutInventory}
-     */
-    this.loadout = new LoadOutInventory(profile.LoadOutInventory, locale, withItem);
-
-    /**
-     * Railjack and drifter Intrinsics
-     * @type {Intrinsics}
-     */
-    this.intrinsics = new Intrinsics(profile.PlayerSkills ?? {});
-
-    /**
-     * Nightwave challenges progress
-     * @type {Array<ChallengeProgress>}
-     */
-    this.challengeProgress = profile.ChallengeProgress.map((c) => new ChallengeProgress(c));
-
-    /**
-     * Guild ID
-     * @type {String}
-     */
-    if (profile.GuildId?.$oid) 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 | undefined}
-     */
-    if (profile.AllianceId?.$oid) 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 {boolean}
-     */
-    this.harvestable = profile.Harvestable;
-
-    /**
-     * Whether or not the player is qualified as a target for a syndicate death squad
-     * @type {boolean}
-     */
-    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 {boolean}
-     */
-    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,
-      hex: profile.DailyAffiliationHex,
-    };
-
-    /**
-     * Daily focus
-     * @type {number}
-     */
-    this.dailyFocus = profile.DailyFocus;
-
-    /**
-     * Player wishlist for in-game market items
-     */
-    this.wishList = profile.Wishlist;
-
-    /**
-     * Whether the player has unlocked their operator or not
-     * @type {boolean}
-     */
-    this.unlockedOperator = profile.UnlockedOperator;
-
-    /**
-     * Whether the player has unlocked their alignment or not
-     * @type {boolean}
-     */
-    this.unlockedAlignment = profile.UnlockedAlignment;
-
-    /**
-     * Operator loadout
-     * @type {OperatorLoadOuts | undefined}
-     */
-    this.operatorLoadouts = profile.OperatorLoadOuts?.map((ol) => new OperatorLoadOuts(ol));
-
-    /**
-     * Player's alignment
-     * @type {Map<String,number | undefined>}
-     */
-    this.alignment = { wisdom: profile.Alignment?.Wisdom, alignment: profile.Alignment?.Alignment };
-  }
-}

package/src/ProfileParser.js

@@ -1,50 +0,0 @@
-import { parseDate } from 'warframe-worldstate-data/utilities';
-
-import Profile from './Profile.js';
-import Stats from './Stats.js';
-
-/**
- * Parser entry point
- * @module
- */
-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', withItem = false) {
-    /**
-     * Player's profile
-     * @type {Profile}
-     */
-    this.profile = new Profile(data.Results[0], locale, withItem);
-
-    /**
-     * @type {number}
-     */
-    this.techProjects = data.TechProjects;
-
-    /**
-     * @type {number}
-     */
-    this.xpComponents = data.XpCompoents;
-
-    /**
-     * @type {number}
-     */
-    this.xpCacheExpiryDate = parseDate(data.XpCacheExpiryDate);
-
-    /**
-     * @type {number}
-     */
-    this.ceremonyResetDate = parseDate(data.CeremonyResetDate);
-
-    /**
-     * Player stats
-     * @type {Stats}
-     */
-    this.stats = new Stats(data.Stats);
-  }
-}

package/src/Pvp.js

@@ -1,35 +0,0 @@
-/**
- * Player's conclave stats
- * @module
- */
-export default class Pvp {
-  /**
-   *
-   * @param {Object} pvp PVP data to parse
-   */
-  constructor(pvp) {
-    /**
-     * PVP match unique name
-     * @type {String}
-     */
-    this.uniqueName = pvp.type;
-
-    /**
-     * Deaths for this match
-     * @type {number | undefined}
-     */
-    this.suitDeaths = pvp.suitDeaths;
-
-    /**
-     * Warframe kills
-     * @type {number | undefined}
-     */
-    this.suitKills = pvp.suitKills;
-
-    /**
-     * Weapon killes
-     * @type {number | undefined}
-     */
-    this.weaponKills = pvp.weaponKills;
-  }
-}

package/src/Race.js

@@ -1,33 +0,0 @@
-/**
- * Represents a k-drive race
- * @module
- */
-export default class Race {
-  /**
-   *
-   * @param {string} type Race name
-   * @param {number} highScore high score
-   */
-  constructor(type, highScore) {
-    /**
-     * Race name
-     * @type {String}
-     */
-    this.uniqueName = type;
-
-    /**
-     * Race High score
-     * @type {number}
-     */
-    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

@@ -1,22 +0,0 @@
-/**
- * Represents an enemy scanned to the codex
- * @module
- */
-export default class Scan {
-  /**
-   * @param {Object} scan The scanned Warframe object
-   */
-  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

@@ -1,340 +0,0 @@
-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';
-
-/**
- * A player's overall career stats
- * @module
- */
-export default class Stats {
-  /**
-   *
-   * @param {Object} stats Player stats
-   */
-  constructor(stats) {
-    /**
-     * Guild name
-     * @type {String}
-     */
-    this.guildName = stats.GuildName;
-
-    /**
-     * Player's total accumulated 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 kills
-     * @type {number}
-     */
-    this.meleeKills = stats.MeleeKills;
-
-    /**
-     * Used abilities
-     * @type {number}
-     */
-    this.abilities = stats.Abilities.map((a) => new Ability(a));
-
-    /**
-     * Ciphers completed successfully
-     * @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,number>}
-     */
-    this.breedGrounds = {
-      personalScore: stats.HiveEventScore,
-      clanScore: stats.HiveEventScoreSum,
-    };
-
-    /**
-     * Event Scores for The Gradivus Dilemma
-     * @type {Map<String,number>}
-     */
-    this.gradivusDilemma = {
-      grineer: stats.InvasionEventGrineerScore,
-      corpus: stats.InvasionEventCorpusScore,
-    };
-
-    /**
-     * List of scanned Warframe objects
-     * @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>}
-     */
-    if (stats.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 = Race.fromRaceObject(stats.Races);
-
-    /**
-     * 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;
-  }
-}