@wfcd/profile-parser 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Warframe Community Developers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1 @@
+# profile-parser

package/package.json

@@ -0,0 +1,104 @@
+{
+  "name": "@wfcd/profile-parser",
+  "version": "1.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"
+    }
+  },
+  "public": true,
+  "files": [
+    "src",
+    "LICENSE",
+    "README.md",
+    "types"
+  ],
+  "devDependencies": {
+    "@types/chai": "^4.3.14",
+    "@wfcd/eslint-config": "^1.6.1",
+    "c8": "^9.1.0",
+    "chai": "^5.1.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"
+  },
+  "scripts": {
+    "test": "c8 mocha",
+    "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",
+    "postinstall": "if [ \"$NODE_ENV\" = \"dev\" ] ; then npx -p install-peerdeps@latest install-peerdeps @wfcd/eslint-config@latest -S ; fi",
+    "prepare": "husky"
+  },
+  "author": "",
+  "license": "MIT",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "eslintConfig": {
+    "extends": "@wfcd/eslint-config/esm",
+    "parser": "@babel/eslint-parser",
+    "parserOptions": {
+      "sourceType": "module",
+      "ecmaVersion": 6,
+      "ecmaFeatures": {
+        "modules": true
+      },
+      "babelOptions": {
+        "plugins": [
+          "@babel/plugin-transform-class-properties",
+          "@babel/plugin-transform-private-methods"
+        ]
+      }
+    }
+  },
+  "babel": {
+    "presets": [
+      "@babel/preset-env"
+    ],
+    "plugins": [
+      "@babel/plugin-transform-class-properties",
+      "@babel/plugin-transform-private-methods"
+    ]
+  },
+  "prettier": "@wfcd/eslint-config/prettier",
+  "mocha": {
+    "exit": true,
+    "spec": "test/**/*.spec.js"
+  },
+  "c8": {
+    "reporter": [
+      "lcov",
+      "text"
+    ],
+    "skip-full": true
+  },
+  "peerDependencies": {
+    "warframe-items": "^1.1262.30",
+    "warframe-worldstate-data": "^2.5.0"
+  },
+  "lint-staged": {
+    "*.js": [
+      "eslint --cache --fix",
+      "npm test"
+    ],
+    "package*.json": [
+      "prettier --write",
+      "npm -q --no-progress dedupe"
+    ],
+    "*.{json,md,yaml}": [
+      "prettier --write"
+    ]
+  }
+}

package/src/Ability.js

@@ -0,0 +1,21 @@
+/**
+ * Represents an ability used by the player
+ */
+export default class Ability {
+  /**
+   * @param {Object} ability The ability
+   */
+  constructor(ability) {
+    /**
+     * 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

@@ -0,0 +1,8 @@
+import { archonShardColor, archonShardUpgradeType } from 'warframe-worldstate-data/utilities';
+
+export default class ArchonCrystal {
+  constructor(crystal, local) {
+    this.color = archonShardColor(crystal.Color, local);
+    this.modifier = archonShardUpgradeType(crystal.Color, crystal.UpgradeType, local);
+  }
+}

package/src/ChallengeProgress.js

@@ -0,0 +1,15 @@
+export default class ChallengeProgress {
+  constructor(challenge) {
+    /**
+     * Name of the challenge
+     * @type {String}
+     */
+    this.name = challenge.Name;
+
+    /**
+     * Progress towards completing this challenge
+     * @type {number}
+     */
+    this.progress = challenge.Progress;
+  }
+}

package/src/Enemy.js

@@ -0,0 +1,45 @@
+/**
+ * Represents the enemies killed
+ */
+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 tis enemy type has killed the player
+     * @type {number}
+     */
+    this.deaths = enemy.deaths;
+  }
+}

package/src/Intrinsics.js

@@ -0,0 +1,69 @@
+export default class Intrinsics {
+  constructor(skills) {
+    // I know this is railjack but I'm not sure what the context is
+    /**
+     * @type {number}
+     */
+    this.space = skills.LPP_SPACE;
+
+    /**
+     * Railjack engineering rank
+     * @type {number}
+     */
+    this.engineering = skills.LPS_ENGINEERING;
+
+    /**
+     * Railjack gunnery rank
+     * @type {number}
+     */
+    this.gunnery = skills.LPS_GUNNERY;
+
+    /**
+     * Railjack piloting rank
+     * @type {number}
+     */
+    this.piloting = skills.LPS_PILOTING;
+
+    /**
+     * Railjack tactical rank
+     * @type {number}
+     */
+    this.tactical = skills.LPS_TACTICAL;
+
+    /**
+     * Railjack command rank
+     * @type {number}
+     */
+    this.command = skills.LPS_COMMAND;
+
+    // Not sure what the context for this one is either
+    /**
+     * @type {number}
+     */
+    this.drifter = skills.LPP_DRIFTER;
+
+    /**
+     * Drifter riding rank
+     * @type {number}
+     */
+    this.riding = skills.LPS_DRIFT_RIDING;
+
+    /**
+     * Drifter combat rank
+     * @type {number}
+     */
+    this.combat = skills.LPS_DRIFT_COMBAT;
+
+    /**
+     * Drifter opportunity rank
+     * @type {number}
+     */
+    this.opportunity = skills.LPS_DRIFT_OPPORTUNITY;
+
+    /**
+     * Drifter endurance rank
+     * @type {number}
+     */
+    this.endurance = skills.LPS_DRIFT_ENDURANCE;
+  }
+}

package/src/ItemConfig.js

@@ -0,0 +1,51 @@
+import { colors, find } from 'warframe-items/utilities';
+
+import mapToHex from './Util.js';
+
+/**
+ * Represents the data configuration for an item
+ */
+export default class ItemConfig {
+  /**
+   * @param {Object} config The configuration
+   */
+  constructor(config) {
+    /**
+     * Array of unique names for the skins applied to item
+     * @type {Array<String>}
+     */
+    this.skins = config.Skins.filter(Boolean)
+      .map((s) => find.findItem(s))
+      .filter(Boolean);
+
+    /**
+     * 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:"warframe-items".ColorMap}
+     */
+    if (config.pricol) this.primaryColor = colors.mapColors(mapToHex(config.pricol));
+
+    /**
+     * Sigil colors applied to item if they exist
+     * @type {module:"warframe-items".ColorMap}
+     */
+    if (config.sigcol) this.sigilColor = colors.mapColors(mapToHex(config.sigcol));
+
+    /**
+     * Attachment colors applied to item if they exist
+     * @type {module:"warframe-items".ColorMap}
+     */
+    if (config.attcol) this.attachmentsColor = colors.mapColors(mapToHex(config.attcol));
+
+    /**
+     * Syandana colors applied to item if they exist
+     * @type {module:"warframe-items".ColorMap}
+     */
+    if (config.syancol) this.syandanaColor = colors.mapColors(mapToHex(config.syancol));
+  }
+}

package/src/LoadOutInventory.js

@@ -0,0 +1,43 @@
+import LoadOutItem from './LoadOutItem.js';
+import WeaponSkin from './WeaponSkin.js';
+import XpInfo from './XpInfo.js';
+
+export default class LoadOutInventory {
+  constructor(item) {
+    /**
+     * Skins applied to weapons
+     * @type {WeaponSkin}
+     */
+    this.weaponSkins = item.WeaponSkins.map((s) => new WeaponSkin(s));
+
+    /**
+     * An array of the player's currently equiped Warframe (or powersuits)
+     * @type {LoadOutItem}
+     */
+    this.suits = item.Suits.map((s) => new LoadOutItem(s));
+
+    /**
+     * An array of the player's currently equiped secondary weapon
+     * @type {LoadOutItem}
+     */
+    this.secondary = item.Pistols.map((p) => new LoadOutItem(p));
+
+    /**
+     * An array of the player's currently equiped primary weapon
+     * @type {LoadOutItem}
+     */
+    this.primary = item.LongGuns.map((lg) => new LoadOutItem(lg));
+
+    /**
+     * An array of the player's currently equiped melee weapon
+     * @type {LoadOutItem}
+     */
+    this.melee = item.Melee.map((m) => new LoadOutItem(m));
+
+    /**
+     * Items that have counted towards the players mastery rank
+     * @type {XpInfo}
+     */
+    this.xpInfo = item.XPInfo.map((xp) => new XpInfo(xp));
+  }
+}

package/src/LoadOutItem.js

@@ -0,0 +1,135 @@
+import { colors, find } from 'warframe-items/utilities';
+import { parseDate, toTitleCase } from 'warframe-worldstate-data/utilities';
+
+import ItemConfig from './ItemConfig.js';
+import Polarity from './Polarity.js';
+
+export default class LoadOutItem {
+  constructor(weapon) {
+    /**
+     * Item ID
+     * @type {String}
+     */
+    this.itemId = weapon.ItemId.$oid;
+
+    /**
+     * Item unique name
+     * @type {String}
+     */
+    this.uniqueName = weapon.ItemType;
+
+    const item = find.findItem(weapon.ItemType);
+    if (item) {
+      /**
+       * Item in-game name
+       * @type {String}
+       */
+      this.name = item.name;
+
+      /**
+       * Complete item from Warframe-items
+       * @type {module:"warframe-items".Item}
+       */
+      this.item = item;
+    }
+
+    if (weapon.ItemName) {
+      const [, nemesis] = weapon.ItemName.split('|');
+
+      /**
+       * Item lich name
+       * @type {String}
+       */
+      this.nemesis = toTitleCase(nemesis);
+    }
+
+    /**
+     * 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>}
+     */
+    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 {ColorMap}
+     */
+    if (weapon.pricol) this.primaryColor = colors.mapColors(weapon.pricol);
+
+    /**
+     * Sigil colors applied to item if they exist
+     * @type {ColorMap}
+     */
+    if (weapon.sigcol) this.sigilColor = colors.mapColors(weapon.sigcol.toString(16));
+
+    /**
+     * Attachment colors applied to item if they exist
+     * @type {ColorMap}
+     */
+    if (weapon.attcol) this.attachmentsColor = colors.mapColors(weapon.attcol.toString(16));
+
+    /**
+     * Syandana colors applied to item if they exist
+     * @type {ColorMap}
+     */
+    if (weapon.syancol) this.syandanaColor = colors.mapColors(weapon.syancol.toString(16));
+
+    /**
+     * If set will show when the player's warframe was infested.
+     * @type {ColorMap}
+     */
+    if (weapon.InfestationDate) this.infestationDate = parseDate(weapon.InfestationDate);
+  }
+}

package/src/Mission.js

@@ -0,0 +1,40 @@
+import { node, nodeEnemy, nodeMissionType } from 'warframe-worldstate-data/utilities';
+
+export default class Mission {
+  constructor(mission, locale) {
+    const uniqueName = mission.Type || mission.Tag;
+
+    /**
+     * Node name
+     * @type {String}
+     */
+    this.node = node(uniqueName, locale);
+
+    /**
+     * Node mission type
+     * @type {String}
+     */
+    this.misstionType = nodeMissionType(uniqueName, locale);
+
+    /**
+     * Node faction
+     * @type {String}
+     */
+    this.faction = nodeEnemy(uniqueName, locale);
+
+    /**
+     * Highest score earned in this mission
+     * @type {number}
+     */
+    if (mission.highScore) this.highScore = mission.HighScore;
+
+    /**
+     * How many times the mission was completed
+     * @type {number}
+     */
+    if (mission.Completes) this.completes = mission.Completes;
+
+    // Not sure.
+    if (mission.Tier) this.tier = mission.Tier;
+  }
+}

package/src/OperatorLoadOuts.js

@@ -0,0 +1,68 @@
+import { colors } from 'warframe-items/utilities';
+
+import mapToHex from './Util.js';
+
+export default class OperatorLoadOuts {
+  constructor(loadout) {
+    /**
+     * Skins that have been applied to the player's operator.
+     * @type {Array<String>}
+     */
+    this.skins = loadout.Skins;
+
+    /**
+     * Operator amp ID
+     * @type {String}
+     */
+    this.operatorAmp = loadout.OperatorAmp.$oid;
+
+    /**
+     * Applied upgrade IDs
+     * @type {Array<String>}
+     */
+    this.upgrades = loadout.Upgrades;
+    this.abilityOverride = loadout.AbilityOverride;
+
+    /**
+     * Operator primary colors
+     * @type {module:"warframe-items".ColorMap}
+     */
+    if (loadout.pricol) this.primaryColor = colors.mapColors(mapToHex(loadout.pricol));
+
+    /**
+     * Operator sigil colors
+     * @type {module:"warframe-items".ColorMap}
+     */
+    if (loadout.sigcol) this.sigilColor = colors.mapColors(mapToHex(loadout.sigcol));
+
+    /**
+     * Operator attachment colors
+     * @type {module:"warframe-items".ColorMap}
+     */
+    if (loadout.attcol) this.attachmentsColor = colors.mapColors(mapToHex(loadout.attcol));
+
+    /**
+     * Operator syandana colors
+     * @type {module:"warframe-items".ColorMap}
+     */
+    if (loadout.syancol) this.syandanaColor = colors.mapColors(mapToHex(loadout.syancol));
+
+    /**
+     * Operator eye colors
+     * @type {module:"warframe-items".ColorMap}
+     */
+    if (loadout.eyecol) this.eyeColor = colors.mapColors(mapToHex(loadout.eyecol));
+
+    /**
+     * Operator facial colors
+     * @type {module:"warframe-items".ColorMap}
+     */
+    if (loadout.facial) this.facial = colors.mapColors(mapToHex(loadout.facial));
+
+    /**
+     * Operator cloth colors
+     * @type {module:"warframe-items".ColorMap}
+     */
+    if (loadout.cloth) this.cloth = colors.mapColors(mapToHex(loadout.cloth));
+  }
+}

package/src/Polarity.js

@@ -0,0 +1,17 @@
+import { translatePolarity } from 'warframe-worldstate-data/utilities';
+
+export default class Polarity {
+  constructor(polarity) {
+    /**
+     * Polarity name
+     * @type {String}
+     */
+    this.polarity = translatePolarity(polarity.Value);
+
+    /**
+     * Polarized slot
+     * @type {number}
+     */
+    this.slot = polarity.Slot;
+  }
+}