@wfcd/profile-parser 1.5.0 → 2.0.0

package/src/LoadOutPreset.ts

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

package/src/Mission.ts

@@ -0,0 +1,75 @@
+import { Locale } from 'warframe-worldstate-data';
+import { node, nodeEnemy, nodeMissionType } from 'warframe-worldstate-data/utilities';
+
+export interface RawMission {
+  Tag?: string | undefined;
+  type?: string;
+  Mission?: string;
+  highScore?: number;
+  Completes?: number;
+  Tier?: number;
+}
+
+/**
+ * A mission completed by the player
+ * @module
+ */
+export default class Mission {
+  /**
+   * Node name
+   */
+  node: string;
+  
+  /**
+   * Node unique name
+   */
+  nodeKey: string;
+
+  /**
+   * Node mission type
+   */
+  missionType: string;
+
+  /**
+   * Node faction
+   */
+  faction: string;
+
+  /**
+   * Highest score earned in this mission
+   */
+  highScore?: number;
+
+  /**
+   * How many times the mission was completed
+   */
+  completes?: number;
+
+  /**
+   * Denotes a steel path node
+   */
+  tier?: number;
+
+  /**
+   *
+   * @param mission The mission data
+   * @param locale The locale to return in
+   */
+  constructor(mission: RawMission, locale: Locale = 'en') {
+    const uniqueName = (mission.type || mission.Tag)!;
+
+    this.node = node(uniqueName, locale);
+
+    this.nodeKey = uniqueName;
+
+    this.missionType = nodeMissionType(uniqueName, locale);
+
+    this.faction = nodeEnemy(uniqueName, locale);
+
+    if (mission.highScore) this.highScore = mission.highScore;
+
+    if (mission.Completes) this.completes = mission.Completes;
+
+    if (mission.Tier) this.tier = mission.Tier;
+  }
+}

package/src/OperatorLoadOuts.ts

@@ -0,0 +1,108 @@
+import { colors } from '@wfcd/items/utilities';
+
+import Skin from './Skin';
+import { mapToHex, type ProfileRawColors } from './Utils';
+import type { ColorMap } from '@wfcd/items';
+import { Locale } from 'warframe-worldstate-data';
+
+export interface RawOperatorLoadOuts {
+  Skins: string[];
+  OperatorAmp?: { $oid: string };
+  Upgrades: string[];
+  AbilityOverride: any;
+  pricol?: ProfileRawColors;
+  sigcol?: ProfileRawColors;
+  attcol?: ProfileRawColors;
+  syancol?: ProfileRawColors;
+  eyecol?: ProfileRawColors;
+  facial?: ProfileRawColors;
+  cloth?: ProfileRawColors;
+}
+
+/**
+ * Player's operator loadout
+ * @module
+ */
+export default class OperatorLoadOuts {
+  /**
+   * Skins that have been applied to the player's operator.
+   */
+  skins: Skin[];
+
+  /**
+   * Operator amp ID
+   */
+  operatorAmp?: string;
+
+  /**
+   * Applied upgrade IDs
+   */
+  upgrades: string[];
+  abilityOverride: any;
+
+  /**
+   * Operator primary colors
+   */
+  primaryColor?: ColorMap;
+
+  /**
+   * Operator sigil colors
+   */
+  sigilColor?: ColorMap;
+
+  /**
+   * Operator attachment colors
+   */
+  attachmentsColor?: ColorMap;
+
+  /**
+   * Operator syandana colors
+   */
+  syandanaColor?: ColorMap;
+
+  /**
+   * Operator eye colors
+   */
+  eyeColor?: ColorMap;
+
+  /**
+   * Operator facial colors
+   */
+  facial?: ColorMap;
+
+  /**
+   * Operator cloth colors
+   */
+  cloth?: ColorMap;
+
+  /**
+   *
+   * @param {Object} loadout The operator loadout
+   */
+  constructor(loadout: RawOperatorLoadOuts, locale: Locale = 'en') {
+    this.skins = loadout.Skins.filter(Boolean).map((s) => new Skin({ ItemType: s }, locale));
+
+    this.operatorAmp = loadout.OperatorAmp?.$oid;
+
+    /**
+     * Applied upgrade IDs
+     * @type {Array<String>}
+     */
+    this.upgrades = loadout.Upgrades;
+    this.abilityOverride = loadout.AbilityOverride;
+
+    if (loadout.pricol) this.primaryColor = colors.mapColors(mapToHex(loadout.pricol));
+
+    if (loadout.sigcol) this.sigilColor = colors.mapColors(mapToHex(loadout.sigcol));
+
+    if (loadout.attcol) this.attachmentsColor = colors.mapColors(mapToHex(loadout.attcol));
+
+    if (loadout.syancol) this.syandanaColor = colors.mapColors(mapToHex(loadout.syancol));
+
+    if (loadout.eyecol) this.eyeColor = colors.mapColors(mapToHex(loadout.eyecol));
+
+    if (loadout.facial) this.facial = colors.mapColors(mapToHex(loadout.facial));
+
+    if (loadout.cloth) this.cloth = colors.mapColors(mapToHex(loadout.cloth));
+  }
+}

package/src/Polarity.ts

@@ -0,0 +1,31 @@
+import { translatePolarity } from 'warframe-worldstate-data/utilities';
+
+export interface RawPolarity {
+  Value: string;
+  Slot: number;
+}
+
+/**
+ * A polarity in a LoadOutItem
+ * @module
+ */
+export default class Polarity {
+  /**
+   * Polarity name
+   */
+  polarity: string;
+
+  /**
+   * Polarized slot
+   */
+  slot: number;
+
+  /**
+   *
+   * @param {Object} raw The polarity to parse
+   */
+  constructor(raw: RawPolarity) {
+    this.polarity = translatePolarity(raw.Value);
+    this.slot = raw.Slot;
+  }
+}

package/src/Profile.ts

@@ -0,0 +1,308 @@
+import { parseDate, WorldStateDate } from 'warframe-worldstate-data/utilities';
+
+import ChallengeProgress, { type RawChallengeProgress } from './ChallengeProgress';
+import Intrinsics, { type RawIntrinsics } from './Intrinsics';
+import LoadOutInventory, { type RawLoadOut } from './LoadOutInventory';
+import Mission, { type RawMission } from './Mission';
+import OperatorLoadOuts, { type RawOperatorLoadOuts } from './OperatorLoadOuts';
+import Syndicate, { type RawAffiliation } from './Syndicate';
+import LoadOutPreset, { type RawLoadOutPreset } from './LoadOutPreset';
+import type { RawDate, RawId } from './Utils';
+import { Locale } from 'warframe-worldstate-data';
+
+export interface RawProfile {
+  AccountId: { $oid: string };
+  DisplayName: string;
+  PlatformNames?: string[];
+  PlayerLevel: number;
+  LoadOutPreset: RawLoadOutPreset;
+  LoadOutInventory: RawLoadOut;
+  PlayerSkills: RawIntrinsics;
+  ChallengeProgress: RawChallengeProgress[];
+  GuildId: RawId;
+  GuildName: string;
+  GuildTier: number;
+  GuildXp: number;
+  GuildClass: number;
+  GuildEmblem: boolean;
+  AllianceId?: RawId;
+  DeathMarks: string[];
+  Harvestable: boolean;
+  DeathSquadable: boolean;
+  Created: RawDate;
+  MigratedToConsole: boolean;
+  Missions: RawMission[];
+  Affiliations: RawAffiliation[];
+  DailyAffiliation: number;
+  DailyAffiliationPvp?: number;
+  DailyAffiliationLibrary?: number;
+  DailyAffiliationCetus?: number;
+  DailyAffiliationQuills?: number;
+  DailyAffiliationSolaris?: number;
+  DailyAffiliationVentkids?: number;
+  DailyAffiliationVox?: number;
+  DailyAffiliationEntrati?: number;
+  DailyAffiliationNecraloid?: number;
+  DailyAffiliationZariman?: number;
+  DailyAffiliationKahl?: number;
+  DailyAffiliationCavia?: number;
+  DailyAffiliationHex?: number;
+  DailyFocus?: number;
+  Wishlist?: any;
+  UnlockedOperator: boolean;
+  UnlockedAlignment: boolean;
+  OperatorLoadOuts: RawOperatorLoadOuts[];
+  Alignment: { Wisdom: number; Alignment: number };
+}
+
+/**
+ * A player's profile
+ * @module
+ */
+export default class Profile {
+  /**
+   * Player's account ID
+   */
+  accountId: string;
+
+  /**
+   * In-game name
+   */
+  displayName: string;
+
+  /**
+   * List of usernames across supported platforms
+   */
+  platformNames: string[];
+
+  /**
+   * Mastery rank
+   */
+  masteryRank: number;
+
+  /**
+   * Load out preset equipped
+   */
+  preset?: LoadOutPreset;
+
+  /**
+   * Current loadout
+   */
+  loadout: LoadOutInventory;
+
+  /**
+   * Railjack and drifter Intrinsics
+   */
+  intrinsics?: Intrinsics;
+
+  /**
+   * Nightwave challenges progress
+   */
+  challengeProgress: ChallengeProgress[];
+
+  /**
+   * Guild ID
+   */
+  guildId?: string;
+
+  /**
+   * Guild name
+   */
+  guildName?: string;
+
+  /**
+   * Guild tier
+   */
+  guildTier?: number;
+
+  /**
+   * Guild XP
+   */
+  guildXp?: number;
+
+  /**
+   * Guild class
+   */
+  guildClass?: number;
+
+  /**
+   * Guild emblem.
+   */
+  guildEmblem: boolean;
+
+  /**
+   * Alliance ID
+   */
+  allianceId?: string;
+
+  /**
+   * Assassins currently asfter the player
+   */
+  deathMarks: string[];
+
+  /**
+   * Whether or not the player is qualified as a target for Zanuka
+   * @type {boolean}
+   */
+  harvestable: boolean;
+
+  /**
+   * Whether or not the player is qualified as a target for a syndicate death squad
+   */
+  deathSquadable: boolean;
+
+  /**
+   * Date the account was created
+   */
+  created: Date;
+
+  /**
+   * Whether the user has migrated to console or not
+   */
+  migratedToConsole: boolean;
+
+  /**
+   * List of completed missions and their completions
+   */
+  missions: Mission[];
+
+  /**
+   * Player standing and title across all syndicates
+   */
+  syndicates?: Syndicate[];
+
+  /**
+   * Daily standing per Syndicate
+   *
+   * Faction syndicates all share daily standing
+   */
+  dailyStanding: {
+    daily: number;
+    conclave?: number;
+    simaris?: number;
+    ostron?: number;
+    quills?: number;
+    solaris?: number;
+    ventKids?: number;
+    voxSolaris?: number;
+    entrati?: number;
+    necraloid?: number;
+    holdfasts?: number;
+    kahl?: number;
+    cavia?: number;
+    hex?: number;
+  };
+
+  /**
+   * Daily focus
+   */
+  dailyFocus?: number;
+
+  /**
+   * Player wishlist for in-game market items
+   */
+  wishList: any;
+
+  /**
+   * Whether the player has unlocked their operator or not
+   */
+  unlockedOperator: boolean;
+
+  /**
+   * Whether the player has unlocked their alignment or not
+   */
+  unlockedAlignment: boolean;
+
+  /**
+   * Operator loadout
+   */
+  operatorLoadouts?: OperatorLoadOuts[];
+
+  /**
+   * Player's alignment
+   */
+  alignment?: { wisdom: number; alignment: number };
+
+  /**
+   *
+   * @param profile The profile data to parse
+   * @param locale The locale to return in where possible
+   * @param withItem Whether or not to include items
+   */
+  constructor(profile: RawProfile, locale: Locale = 'en', withItem: boolean = false) {
+    this.accountId = profile.AccountId.$oid;
+
+    this.displayName = profile.DisplayName;
+
+    this.platformNames = profile.PlatformNames ?? [];
+
+    this.masteryRank = profile.PlayerLevel;
+
+    if (profile.LoadOutPreset) this.preset = new LoadOutPreset(profile.LoadOutPreset);
+
+    this.loadout = new LoadOutInventory(profile.LoadOutInventory, locale, withItem);
+
+    this.intrinsics = new Intrinsics(profile.PlayerSkills ?? {});
+
+    this.challengeProgress = profile.ChallengeProgress.map((c) => new ChallengeProgress(c));
+
+    if (profile.GuildId?.$oid) this.guildId = profile.GuildId.$oid;
+
+    this.guildName = profile.GuildName;
+
+    this.guildTier = profile.GuildTier;
+
+    this.guildXp = profile.GuildXp;
+
+    this.guildClass = profile.GuildClass;
+
+    this.guildEmblem = profile.GuildEmblem;
+
+    if (profile.AllianceId) this.allianceId = profile.AllianceId.$oid;
+
+    this.deathMarks = profile.DeathMarks;
+
+    this.harvestable = profile.Harvestable;
+
+    this.deathSquadable = profile.DeathSquadable;
+
+    this.created = parseDate(profile.Created);
+
+    this.migratedToConsole = profile.MigratedToConsole;
+
+    this.missions = profile.Missions.map((m) => new Mission(m, locale));
+
+    this.syndicates = profile.Affiliations?.map((a) => new Syndicate(a, locale)) ?? [];
+
+    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,
+    };
+
+    this.dailyFocus = profile.DailyFocus;
+
+    this.wishList = profile.Wishlist;
+
+    this.unlockedOperator = profile.UnlockedOperator;
+
+    this.unlockedAlignment = profile.UnlockedAlignment;
+
+    this.operatorLoadouts = profile.OperatorLoadOuts?.map((ol) => new OperatorLoadOuts(ol, locale));
+
+    if (profile.Alignment) {
+      this.alignment = { wisdom: profile.Alignment?.Wisdom, alignment: profile.Alignment?.Alignment };
+    }
+  }
+}

package/src/ProfileParser.ts

@@ -0,0 +1,66 @@
+import { parseDate } from 'warframe-worldstate-data/utilities';
+
+import Profile, { type RawProfile } from './Profile';
+import Stats, { type RawStats } from './Stats';
+import type { RawDate } from './Utils';
+import { Locale } from 'warframe-worldstate-data';
+
+interface ProfileData {
+  Results: RawProfile[];
+  TechProjects?: any;
+  XpCompoents?: any;
+  XpCacheExpiryDate?: RawDate;
+  CeremonyResetDate?: RawDate;
+  Stats: RawStats;
+}
+
+/**
+ * Parser entry point
+ * @module
+ */
+export default class ProfileParser {
+  /**
+   * Player's profile
+   */
+  profile: Profile;
+
+  /**
+   * N/A
+   */
+  techProjects: any;
+
+  /**
+   * N/A
+   */
+  xpComponents: any;
+
+  /**
+   * N/A
+   */
+  xpCacheExpiryDate: Date;
+
+  /**
+   * N/A
+   */
+  ceremonyResetDate: Date;
+
+  /**
+   * Player stats
+   */
+  stats: Stats;
+
+  /**
+   *
+   * @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: ProfileData, locale: Locale = 'en', withItem: boolean = false) {
+    this.profile = new Profile(data.Results[0], locale, withItem);
+    this.techProjects = data.TechProjects;
+    this.xpComponents = data.XpCompoents;
+    this.xpCacheExpiryDate = parseDate(data.XpCacheExpiryDate);
+    this.ceremonyResetDate = parseDate(data.CeremonyResetDate);
+    this.stats = new Stats(data.Stats);
+  }
+}