@wfcd/profile-parser 1.5.0 → 2.0.0

package/src/Utils.ts

@@ -0,0 +1,85 @@
+import Items, { type Category, type RawColors } from '@wfcd/items';
+import { WorldStateDate } from 'warframe-worldstate-data/utilities';
+
+/**
+ * interface for DE's ID data
+ */
+export interface RawId {
+  $oid: string;
+}
+
+// {"$date":{"$numberLong":"1462464026233"}}
+export type RawDate = WorldStateDate;
+
+export interface ProfileRawColors {
+  t0?: number;
+  t1?: number;
+  t2?: number;
+  t3?: number;
+  m0?: number;
+  m1?: number;
+  en?: number;
+  e1?: number;
+}
+
+/**
+ * Map base10 int colors to hex color strings
+ * @param colors color map
+ */
+export const mapToHex = (colors: ProfileRawColors): RawColors => {
+  const hex: Record<string, string> = {};
+  Object.entries(colors).forEach(([key, value]) => {
+    if (value) hex[key] = Math.abs(value).toString(16).toUpperCase();
+  });
+  return hex as RawColors;
+};
+
+const categories = [
+  'Skins',
+  'Primary',
+  'Secondary',
+  'Melee',
+  'Arch-Melee',
+  'Arch-Gun',
+  'Warframes',
+  'Archwing',
+  'Sentinels',
+  'Pets',
+];
+
+/**
+ * Find an item by Item#uniqueName
+ * @param name string with which to query
+ * @param locale locale to use for internationalization
+ * @returns {Item}
+ */
+export const find = (name: string, locale = 'en') => {
+  const items = new Items({
+    category: categories as (Category | 'SentinelWeapons')[],
+    i18n: [locale],
+    i18nOnObject: true,
+  });
+
+  const item = items.find((i) => i.uniqueName === name);
+
+  let itemClone: any = { ...item };
+  if (locale !== 'en' && itemClone.i18n[locale] && itemClone.i18n[locale]) {
+    itemClone = { ...itemClone, ...itemClone.i18n[locale] };
+
+    if (itemClone.abilities) {
+      itemClone.abilities = itemClone.abilities.map((ability: any) => ({
+        uniqueName: ability.abilityUniqueName || ability.uniqueName || undefined,
+        name: ability.abilityName || ability.name,
+        description: ability.abilityDescription || ability.description,
+        imageName: ability.imageName ?? undefined,
+      }));
+    }
+
+    delete itemClone.i18n;
+    return itemClone;
+  }
+
+  return item;
+};
+
+export const numberToLetter = (num: number) => String.fromCharCode(64 + (num + 1));

package/src/{Weapon.js → Weapon.ts}

@@ -1,13 +1,33 @@
+export interface RawWeapon {
+  type: string;
+  xp: number;
+  equipTime: number;
+  headShots: number;
+  hits: number;
+  assists: number;
+  kills: number;
+  fired: number;
+}
+
 /**
  * Represents a player's used weapon stats
  * @module
  */
 export default class Weapon {
+  uniqueName: string;
+  xp: number;
+  equipTime: number;
+  headShots: number;
+  hits: number;
+  assists: number;
+  kills: number;
+  fired: number;
+
   /**
    *
-   * @param {Object} weapon The weapon stats being parsed
+   * @param weapon The weapon stats being parsed
    */
-  constructor(weapon) {
+  constructor(weapon: RawWeapon) {
     /**
      * Weapon unique name
      * @type {String}
@@ -24,7 +44,7 @@ export default class Weapon {
      * Time using this weapon
      * @type {number}
      */
-    this.equiptime = weapon.equipTime;
+    this.equipTime = weapon.equipTime;
 
     /**
      * Headshots using this weapon

package/src/XpInfo.ts

@@ -0,0 +1,41 @@
+import { type Item } from '@wfcd/items';
+import { find } from './Utils';
+
+export interface RawXpItem {
+  ItemType: string;
+  XP: number;
+}
+
+/**
+ * An item that has contributed to a player's mastery rank
+ * @module
+ */
+export default class XpInfo {
+  /**
+   * Unique name
+   */
+  uniqueName: string;
+
+  /**
+   * XP earned
+   */
+  xp: number;
+
+  /**
+   * The item corrosponding to the unique name.
+   */
+  item?: Item;
+
+  /**
+   *
+   * @param info The info for a given ranked item
+   * @param locale langauge to return item in
+   * @param withItem Whether or not to include items
+   */
+  constructor(info: RawXpItem, locale = 'en', withItem = false) {
+    this.uniqueName = info.ItemType;
+    this.xp = info.XP;
+
+    if (withItem) this.item = find(info.ItemType, locale);
+  }
+}

package/src/Enemy.js

@@ -1,47 +0,0 @@
-/**
- * An enemy killed/executed by player
- * @module
- */
-export default class Enemy {
-  /**
-   *
-   * @param {Object} enemy The enemy
-   */
-  constructor(enemy) {
-    /**
-     * Enenmy's unique name
-     * @type {String}
-     */
-    this.uniqueName = enemy.type;
-
-    /**
-     * How many times the player has killed this enemy type
-     * @type {number}
-     */
-    this.kills = enemy.kills;
-
-    /**
-     * The amount of kills that were headshots
-     * @type {number}
-     */
-    this.headshots = enemy.headshots;
-
-    /**
-     * The amount of kills that were finishers
-     * @type {number}
-     */
-    this.executions = enemy.executions;
-
-    /**
-     * The amount of kills that were assits
-     * @type {number}
-     */
-    this.assists = enemy.assists;
-
-    /**
-     * How many times this enemy type has killed the player
-     * @type {number}
-     */
-    this.deaths = enemy.deaths;
-  }
-}

package/src/Intrinsics.js

@@ -1,77 +0,0 @@
-/**
- * Player's intrinsics ranks
- * @module
- */
-export default class Intrinsics {
-  /**
-   *
-   * @param {Object} skills The intrinsics object
-   */
-  constructor(skills) {
-    /**
-     * Intrinsic points for railjack
-     * @type {number}
-     */
-    this.railjack = Math.floor((skills.LPP_SPACE ?? 0) / 1000);
-
-    /**
-     * Railjack engineering rank
-     * @type {number}
-     */
-    this.engineering = skills.LPS_ENGINEERING ?? 0;
-
-    /**
-     * Railjack gunnery rank
-     * @type {number}
-     */
-    this.gunnery = skills.LPS_GUNNERY ?? 0;
-
-    /**
-     * Railjack piloting rank
-     * @type {number}
-     */
-    this.piloting = skills.LPS_PILOTING ?? 0;
-
-    /**
-     * Railjack tactical rank
-     * @type {number}
-     */
-    this.tactical = skills.LPS_TACTICAL ?? 0;
-
-    /**
-     * Railjack command rank
-     * @type {number}
-     */
-    this.command = skills.LPS_COMMAND ?? 0;
-
-    /**
-     * Intrinsic points for railjack
-     * @type {number}
-     */
-    this.drifter = Math.floor((skills.LPP_DRIFTER ?? 0) / 1000);
-
-    /**
-     * Drifter riding rank
-     * @type {number}
-     */
-    this.riding = skills.LPS_DRIFT_RIDING ?? 0;
-
-    /**
-     * Drifter combat rank
-     * @type {number}
-     */
-    this.combat = skills.LPS_DRIFT_COMBAT ?? 0;
-
-    /**
-     * Drifter opportunity rank
-     * @type {number}
-     */
-    this.opportunity = skills.LPS_DRIFT_OPPORTUNITY ?? 0;
-
-    /**
-     * Drifter endurance rank
-     * @type {number}
-     */
-    this.endurance = skills.LPS_DRIFT_ENDURANCE ?? 0;
-  }
-}

package/src/ItemConfig.js

@@ -1,52 +0,0 @@
-import { colors } from '@wfcd/items/utilities';
-
-import Skin from './Skin.js';
-import { mapToHex } from './Utils.js';
-
-/**
- * Item customizations such as colors and applied skins
- * @module
- */
-export default class ItemConfig {
-  /**
-   *
-   * @param {Object} config The configuration
-   */
-  constructor(config) {
-    /**
-     * Array of unique names for the skins applied to item
-     * @type {Array<String> | undefined}
-     */
-    this.skins = config.Skins?.filter(Boolean).map((s) => new Skin({ ItemType: s }));
-
-    /**
-     * Array of PVP unique name upgrades applied
-     * @type {Array<String>}
-     */
-    if (config.PvpUpgrades) this.conclaveUpgrades = config.PvpUpgrades;
-
-    /**
-     * Primary colors applied to item if they exist
-     * @type {module:"@wfcd/items".ColorMap | undefined}
-     */
-    if (config.pricol) this.primaryColor = colors.mapColors(mapToHex(config.pricol));
-
-    /**
-     * Sigil colors applied to item if they exist
-     * @type {module:"@wfcd/items".ColorMap | undefined}
-     */
-    if (config.sigcol) this.sigilColor = colors.mapColors(mapToHex(config.sigcol));
-
-    /**
-     * Attachment colors applied to item if they exist
-     * @type {module:"@wfcd/items".ColorMap | undefined}
-     */
-    if (config.attcol) this.attachmentsColor = colors.mapColors(mapToHex(config.attcol));
-
-    /**
-     * Syandana colors applied to item if they exist
-     * @type {module:"@wfcd/items".ColorMap | undefined}
-     */
-    if (config.syancol) this.syandanaColor = colors.mapColors(mapToHex(config.syancol));
-  }
-}

package/src/LoadOutInventory.js

@@ -1,53 +0,0 @@
-import LoadOutItem from './LoadOutItem.js';
-import Skin from './Skin.js';
-import XpInfo from './XpInfo.js';
-
-/**
- * Player loudout
- * @module
- */
-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', withItem = false) {
-    /**
-     * Skins applied to weapons
-     * @type {WeaponSkin}
-     */
-    this.weaponSkins = item.WeaponSkins.map((s) => new Skin(s));
-
-    /**
-     * An array of the player's currently equiped Warframe (or powersuits)
-     * @type {LoadOutItem}
-     */
-    this.suits = item.Suits.map((s) => new LoadOutItem(s, locale));
-
-    /**
-     * An array of the player's currently equiped secondary weapon
-     * @type {LoadOutItem | undefined}
-     */
-    this.secondary = item.Pistols?.map((p) => new LoadOutItem(p, locale));
-
-    /**
-     * An array of the player's currently equiped primary weapon
-     * @type {LoadOutItem | undefined}
-     */
-    this.primary = item.LongGuns?.map((lg) => new LoadOutItem(lg, locale));
-
-    /**
-     * An array of the player's currently equiped melee weapon
-     * @type {LoadOutItem | undefined}
-     */
-    this.melee = item.Melee?.map((m) => new LoadOutItem(m, locale));
-
-    /**
-     * Items that have counted towards the players mastery rank
-     * @type {XpInfo}
-     */
-    this.xpInfo = item.XPInfo.map((xp) => new XpInfo(xp, locale, withItem));
-  }
-}

package/src/LoadOutItem.js

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

package/src/LoadOutPreset.js

@@ -1,90 +0,0 @@
-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/Mission.js

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