@wfcd/profile-parser 1.5.0 → 2.0.0

package/package.json

@@ -1,25 +1,24 @@
 {
   "name": "@wfcd/profile-parser",
-  "version": "1.5.0",
+  "version": "2.0.0",
   "description": "Parser for Digital Extreme's profile data",
   "type": "module",
-  "main": "src/ProfileParser.js",
   "exports": {
-    ".": {
-      "import": "./src/ProfileParser.js",
-      "types": "./types/index.d.ts"
+    "./Parser": {
+      "types": "./dist/ProfileParser.d.ts",
+      "default": "./dist/ProfileParser.js"
+    },
+    "./Profile": {
+      "types": "./dist/Profile.d.ts",
+      "default": "./dist/Profile.js"
     },
     "./XpInfo": {
-      "import": "./src/XpInfo.js",
-      "types": "./types/index.d.ts"
+      "types": "./dist/XpInfo.d.ts",
+      "default": "./dist/XpInfo.js"
     },
     "./Stats": {
-      "import": "./src/Stats.js",
-      "types": "./types/index.d.ts"
-    },
-    "./Profile": {
-      "import": "./src/Profile.js",
-      "types": "./types/index.d.ts"
+      "types": "./dist/Stats.d.ts",
+      "default": "./dist/Stats.js"
     }
   },
   "public": true,
@@ -30,27 +29,30 @@
     "types"
   ],
   "devDependencies": {
-    "@types/chai": "^4.3.14",
-    "@wfcd/eslint-config": "^1.6.1",
-    "c8": "^9.1.0",
-    "chai": "^5.1.0",
+    "@biomejs/biome": "2.0.6",
+    "@types/chai": "^5.2.2",
+    "@types/mocha": "^10.0.10",
+    "@wfcd/eslint-config": "^1.6.3",
+    "c8": "^10.1.3",
+    "chai": "^5.2.0",
     "chai-json-equal": "^0.0.1",
     "coveralls": "^3.1.1",
-    "husky": "^9.0.11",
-    "install-peerdeps": "^3.0.3",
-    "lint-staged": "^15.2.2",
-    "mocha": "^10.3.0",
-    "typescript": "^5.4.3"
+    "husky": "^9.1.7",
+    "install-peerdeps": "^3.0.7",
+    "lint-staged": "^16.1.2",
+    "mocha": "^11.7.1",
+    "tsdown": "^0.12.9",
+    "tsx": "^4.20.3",
+    "typescript": "^5.8.3"
   },
   "scripts": {
-    "test": "c8 mocha",
+    "build": "tsdown",
+    "build:docs": "tsdown && jsdoc -c .github/docs/conf.json -d docs",
     "coverage": "npm test && c8 report --reporter=text-lcov | coveralls",
-    "lint": "eslint src/",
-    "lint:fix": "eslint src/ test/ --fix",
-    "prepublishOnly": "npm run build:types",
-    "build:docs": "jsdoc -c .github/docs/conf.json -d docs",
-    "build:types": "tsc -p tsconfig.declaration.json",
-    "prepare": "husky && if [ \"$NODE_ENV\" = \"dev\" ] ; then npx -p install-peerdeps@latest install-peerdeps @wfcd/eslint-config@latest -S ; fi"
+    "lint": "biome lint",
+    "lint:fix": "biome lint --write",
+    "prepublishOnly": "npm run build",
+    "test": "c8 mocha"
   },
   "author": "SlayerOrnstein",
   "license": "MIT",
@@ -58,7 +60,7 @@
     "node": ">=20.0.0"
   },
   "peerDependencies": {
-    "@wfcd/items": "^1.1270.0",
-    "warframe-worldstate-data": "^2.5.0"
+    "@wfcd/items": "^1.1270.626",
+    "warframe-worldstate-data": "^3.0.0"
   }
 }

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

@@ -1,21 +1,28 @@
+
+export interface RawAbility {
+  type: string;
+  used: number
+}
+
 /**
  * Represents a players used ability
  * @module
  */
 export default class Ability {
+  uniqueName: string;
+  used: number;
+  
   /**
-   * @param {Object} ability The ability
+   * @param ability The ability
    */
-  constructor(ability) {
+  constructor(ability: RawAbility) {
     /**
      * The ability unique name
-     * @type {String}
      */
     this.uniqueName = ability.type;
 
     /**
      * How many time the ability was used in the player's lifetime
-     * @type {number}
      */
     this.used = ability.used;
   }

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

@@ -1,25 +1,32 @@
+import { Locale } from 'warframe-worldstate-data';
 import { archonShardColor, archonShardUpgradeType } from 'warframe-worldstate-data/utilities';
 
+interface RawArchonCrystal {
+  Color: string;
+  UpgradeType: string;
+}
+
 /**
  * Represents an Archon shard
  * @module
  */
 export default class ArchonCrystal {
+  color: string;
+  modifier: string;
+
   /**
    *
-   * @param {Object} crystal The archon crystal object
-   * @param {string} locale The locale to get translations in
+   * @param crystal The archon crystal object
+   * @param locale The locale to get translations in
    */
-  constructor(crystal, locale = 'en') {
+  constructor(crystal: RawArchonCrystal, locale: Locale = 'en') {
     /**
      * Archon shard color
-     * @type {String}
      */
     this.color = archonShardColor(crystal.Color, locale);
 
     /**
      * Archon shard modifier
-     * @type {String}
      */
     this.modifier = archonShardUpgradeType(crystal.Color, crystal.UpgradeType, locale);
   }

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

@@ -1,22 +1,29 @@
+
+export interface RawChallengeProgress {
+  Name: string;
+  Progress: number;
+}
+
 /**
  * Player completed or in progress challenges
  * @module
  */
 export default class ChallengeProgress {
+  name: string
+  progress: number;
+
   /**
    *
-   * @param {Object} challenge The challenge object to parse
+   * @param challenge The challenge object to parse
    */
-  constructor(challenge) {
+  constructor(challenge: RawChallengeProgress) {
     /**
      * Name of the challenge
-     * @type {String}
      */
     this.name = challenge.Name;
 
     /**
      * Progress towards completing this challenge
-     * @type {number}
      */
     this.progress = challenge.Progress;
   }

package/src/Enemy.ts

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

package/src/Intrinsics.ts

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

package/src/ItemConfig.ts

@@ -0,0 +1,71 @@
+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 RawItemConfig {
+  Skins?: string[];
+  PvpUpgrades?: string[];
+  pricol?: ProfileRawColors;
+  sigcol?: ProfileRawColors;
+  attcol?: ProfileRawColors;
+  syancol?: ProfileRawColors;
+}
+
+/**
+ * Item customizations such as colors and applied skins
+ * @module
+ */
+export default class ItemConfig {
+  /**
+   * Array of unique names for the skins applied to item
+   */
+  skins?: Skin[];
+
+  /**
+   * Array of PVP unique name upgrades applied
+   */
+  conclaveUpgrades?: string[];
+
+  /**
+   * Primary colors applied to item if they exist
+   */
+  primaryColor?: ColorMap;
+
+  /**
+   * Sigil colors applied to item if they exist
+   */
+  sigilColor?: ColorMap;
+
+  /**
+   * Attachment colors applied to item if they exist
+   */
+  attachmentsColor?: ColorMap;
+  
+  /**
+   * Syandana colors applied to item if they exist
+   */
+  syandanaColor?: ColorMap;
+
+  /**
+   *
+   * @param config The configuration
+   */
+  constructor(config: RawItemConfig, locale: Locale = 'en') {
+    this.skins = config.Skins?.filter(Boolean).map((s: string) => new Skin({ ItemType: s }, locale));
+
+    if (config.PvpUpgrades) this.conclaveUpgrades = config.PvpUpgrades;
+
+    if (config.pricol) this.primaryColor = colors.mapColors(mapToHex(config.pricol));
+
+    if (config.sigcol) this.sigilColor = colors.mapColors(mapToHex(config.sigcol));
+
+    if (config.attcol) this.attachmentsColor = colors.mapColors(mapToHex(config.attcol));
+
+    if (config.syancol) this.syandanaColor = colors.mapColors(mapToHex(config.syancol));
+  }
+}

package/src/LoadOutInventory.ts

@@ -0,0 +1,69 @@
+import { Locale } from 'warframe-worldstate-data';
+import LoadOutItem, { type RawLoadOutItem } from './LoadOutItem';
+import Skin, { type RawSkin } from './Skin';
+import XpInfo, { type RawXpItem } from './XpInfo';
+
+export interface RawLoadOut {
+  WeaponSkins: RawSkin[];
+  Suits: RawLoadOutItem[];
+  Pistols?: RawLoadOutItem[];
+  LongGuns?: RawLoadOutItem[];
+  Melee?: RawLoadOutItem[];
+  XPInfo: RawXpItem[];
+}
+
+/**
+ * Player loudout
+ * @module
+ */
+export default class LoadOutInventory {
+  /**
+   * Skins applied to weapons
+   */
+  weaponSkins: Skin[];
+
+  /**
+   * An array of the player's currently equiped Warframe (or powersuits)
+   */
+  suits: LoadOutItem[];
+
+  /**
+   * An array of the player's currently equiped secondary weapon
+   */
+  secondary?: LoadOutItem[];
+
+  /**
+   * An array of the player's currently equiped primary weapon
+   */
+  primary?: LoadOutItem[];
+
+  /**
+   * An array of the player's currently equiped melee weapon
+   */
+  melee?: LoadOutItem[];
+
+  /**
+   * Items that have counted towards the players mastery rank
+   */
+  xpInfo: XpInfo[];
+
+  /**
+   *
+   * @param item The loadout data
+   * @param locale The locale to return loudout items in. Default is en
+   * @param withItem Whether or not to include items
+   */
+  constructor(item: RawLoadOut, locale: Locale = 'en', withItem = false) {
+    this.weaponSkins = item.WeaponSkins.map((s) => new Skin(s, locale));
+
+    this.suits = item.Suits.map((s) => new LoadOutItem(s, locale));
+
+    this.secondary = item.Pistols?.map((p) => new LoadOutItem(p, locale));
+
+    this.primary = item.LongGuns?.map((lg) => new LoadOutItem(lg, locale));
+
+    this.melee = item.Melee?.map((m) => new LoadOutItem(m, locale));
+
+    this.xpInfo = item.XPInfo.map((xp) => new XpInfo(xp, locale, withItem));
+  }
+}

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