@wfcd/profile-parser 1.4.1 → 2.0.0

package/src/LoadOutItem.ts

@@ -0,0 +1,194 @@
+import { colors } from '@wfcd/items/utilities';
+import { parseDate, toTitleCase, WorldStateDate } from 'warframe-worldstate-data/utilities';
+
+import ItemConfig, { type RawItemConfig } from './ItemConfig';
+import Polarity, { type RawPolarity } from './Polarity';
+import { find, RawDate } from './Utils';
+import type { ColorMap, Item, RawColors } from '@wfcd/items';
+import { Locale } from 'warframe-worldstate-data';
+
+
+export interface RawLoadOutItem {
+  ItemId: { $oid: string };
+  ItemType: string;
+  ItemName?: string;
+  Configs: RawItemConfig[];
+  UpgradeType?: string;
+  UpgradeFingerprint?: unknown;
+  Features: number;
+  UpgradeVer: number;
+  XP?: number;
+  Polarized?: number;
+  Polarity?: RawPolarity[];
+  FocusLens?: string;
+  CustomizationSlotPurchases?: number;
+  pricol?: RawColors;
+  sigcol?: RawColors;
+  ugly?: boolean;
+  attcol?: RawColors;
+  syancol?: RawColors;
+  InfestationDate?: RawDate;
+}
+
+/**
+ * An an item in LoadOutInventory
+ * @module
+ */
+export default class LoadOutItem {
+  /**
+   * Item ID
+   */
+  itemId: string;
+
+  /**
+   * Item unique name
+   */
+  uniqueName: string;
+
+  /**
+   * Item in-game name
+   */
+  name?: string;
+
+  /**
+   * Complete item from @wfcd/items
+   */
+  item?: Item;
+
+  /**
+   * The name of the Lich, Sister, or Technocyte
+   */
+  nemesis?: string;
+
+  /**
+   * Configuration for this weapon. Such as colors and skins applied by the player
+   */
+  configs: ItemConfig[];
+
+  /**
+   * The upgrade that was applied to this weapon
+   */
+  upgradeType?: string;
+
+  /**
+   * Information on the upgradeType that was applied
+   * TODO need model for for fingerprint
+   */
+  upgradeFingerprint: unknown;
+
+  features: number;
+
+  // Not sure what this is for
+  upgradeVer: number;
+
+  /**
+   * XP earned with this weapon
+   */
+  xp?: number;
+
+  /**
+   * How many mod slots are currently polarized.
+   */
+  polarized?: number;
+
+  /**
+   * Which polarity types exist on the weapon
+   */
+  polarity?: Polarity[];
+
+  /**
+   * Focus lens applied
+   */
+  focuseLens?: string;
+
+  // Not sure what this is for
+  customizationSlotPurchases: number;
+
+  /**
+   * Primary colors applied to item if they exist
+   */
+  primaryColor?: ColorMap;
+
+  /**
+   * Sigil colors applied to item if they exist
+   */
+  sigilColor?: ColorMap;
+
+  /**
+   * Whether prime details are enabled or not
+   */
+  enablePrime: boolean;
+
+  /**
+   * Attachment colors applied to item if they exist
+   */
+  attachmentsColor?: ColorMap;
+  /**
+   * Syandana colors applied to item if they exist
+   */
+  syandanaColor?: ColorMap;
+  /**
+   * If set will show when the player's warframe was infested.
+   */
+  infestationDate?: Date;
+
+  /**
+   *
+   * @param {Object} loadOutItem The loadout item from LoadoutInventory
+   * @param {string} [locale='en'] The locale to return item in
+   */
+  constructor(loadOutItem: RawLoadOutItem, locale: Locale = 'en') {
+    this.itemId = loadOutItem.ItemId.$oid;
+
+    this.uniqueName = loadOutItem.ItemType;
+
+    const item = find(loadOutItem.ItemType, locale);
+    if (item) {
+      this.name = item.name;
+
+      this.item = item;
+    }
+
+    if (loadOutItem.ItemName) {
+      const [, nemesis] = loadOutItem.ItemName.split('|');
+
+      if (nemesis !== undefined) {
+        this.nemesis = toTitleCase(nemesis);
+      } else {
+        this.name = loadOutItem.ItemName;
+      }
+    }
+
+    this.configs = loadOutItem.Configs.map((c) => new ItemConfig(c));
+
+    if (loadOutItem.UpgradeType) this.upgradeType = loadOutItem.UpgradeType;
+
+    this.upgradeFingerprint = loadOutItem.UpgradeFingerprint;
+
+    this.features = loadOutItem.Features;
+
+    this.upgradeVer = loadOutItem.UpgradeVer;
+
+    this.xp = loadOutItem.XP;
+
+    this.polarized = loadOutItem.Polarized;
+
+    this.polarity = loadOutItem.Polarity?.map((p) => new Polarity(p));
+
+    this.focuseLens = loadOutItem.FocusLens;
+
+    this.customizationSlotPurchases = loadOutItem.CustomizationSlotPurchases ?? 0;
+
+    if (loadOutItem.pricol) this.primaryColor = colors.mapColors(loadOutItem.pricol);
+
+    if (loadOutItem.sigcol) this.sigilColor = colors.mapColors(loadOutItem.sigcol);
+
+    this.enablePrime = loadOutItem.ugly ?? false;
+
+    if (loadOutItem.attcol) this.attachmentsColor = colors.mapColors(loadOutItem.attcol);
+
+    if (loadOutItem.syancol) this.syandanaColor = colors.mapColors(loadOutItem.syancol);
+
+    if (loadOutItem.InfestationDate) this.infestationDate = parseDate(loadOutItem.InfestationDate);
+  }
+}

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;
+  }
+}