docs: additional doc touch ups for jsdoc

package.json

@@ -38,10 +38,9 @@
     "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"
+    "prepare": "husky && if [ \"$NODE_ENV\" = \"dev\" ] ; then npx -p install-peerdeps@latest install-peerdeps @wfcd/eslint-config@latest -S ; fi"
   },
-  "author": "",
+  "author": "SlayerOrnstein",
   "license": "MIT",
   "engines": {
     "node": ">=18.0.0"

src/Ability.js

@@ -1,5 +1,8 @@
 /** @module */
 
+/**
+ * Represents a players used ability
+ */
 export default class Ability {
   /**
    * @param {Object} ability The ability

src/ArchonCrystal.js

@@ -2,6 +2,9 @@
 
 import { archonShardColor, archonShardUpgradeType } from 'warframe-worldstate-data/utilities';
 
+/**
+ * Represents an Archon shard
+ */
 export default class ArchonCrystal {
   constructor(crystal, local) {
     /**

src/ChallengeProgress.js

@@ -1,5 +1,8 @@
 /** @module */
 
+/**
+ * Player completed or in progress challenges
+ */
 export default class ChallengeProgress {
   constructor(challenge) {
     /**

src/Enemy.js

@@ -1,5 +1,8 @@
 /** @module */
 
+/**
+ * An enemy killed/executed by player
+ */
 export default class Enemy {
   /**
    * @param {Object} enemy The enemy

src/Intrinsics.js

@@ -1,5 +1,8 @@
 /** @module */
 
+/**
+ * Player's intrinsics ranks
+ */
 export default class Intrinsics {
   constructor(skills) {
     // I know this is railjack but I'm not sure what the context is

src/ItemConfig.js

@@ -4,6 +4,9 @@ import { colors, find } from 'warframe-items/utilities';
 
 import mapToHex from './Util.js';
 
+/**
+ * Item customizations such as colors and applied skins
+ */
 export default class ItemConfig {
   /**
    * @param {Object} config The configuration

src/LoadOutInventory.js

@@ -4,6 +4,9 @@ import LoadOutItem from './LoadOutItem.js';
 import WeaponSkin from './WeaponSkin.js';
 import XpInfo from './XpInfo.js';
 
+/**
+ * Player loudout
+ */
 export default class LoadOutInventory {
   constructor(item) {
     /**

src/LoadOutItem.js

@@ -6,6 +6,9 @@ import { parseDate, toTitleCase } from 'warframe-worldstate-data/utilities';
 import ItemConfig from './ItemConfig.js';
 import Polarity from './Polarity.js';
 
+/**
+ * An an item in LoadOutInventory
+ */
 export default class LoadOutItem {
   constructor(weapon) {
     /**

src/Mission.js

@@ -2,6 +2,9 @@
 
 import { node, nodeEnemy, nodeMissionType } from 'warframe-worldstate-data/utilities';
 
+/**
+ * A mission completed by the player
+ */
 export default class Mission {
   constructor(mission, locale) {
     const uniqueName = mission.Type || mission.Tag;

src/OperatorLoadOuts.js

@@ -4,6 +4,9 @@ import { colors } from 'warframe-items/utilities';
 
 import mapToHex from './Util.js';
 
+/**
+ * Player's operator loadout
+ */
 export default class OperatorLoadOuts {
   constructor(loadout) {
     /**

src/Polarity.js

@@ -2,6 +2,9 @@
 
 import { translatePolarity } from 'warframe-worldstate-data/utilities';
 
+/**
+ * A polarity in a LoadOutItem
+ */
 export default class Polarity {
   constructor(polarity) {
     /**

src/Profile.js

@@ -9,6 +9,9 @@ import Mission from './Mission.js';
 import OperatorLoadOuts from './OperatorLoadOuts.js';
 import Syndicate from './Syndicate.js';
 
+/**
+ * A player's profile
+ */
 export default class Profile {
   constructor(profile, locale) {
     /**

src/ProfileParser.js

@@ -5,6 +5,9 @@ import { parseDate } from 'warframe-worldstate-data/utilities';
 import Profile from './Profile.js';
 import Stats from './Stats.js';
 
+/**
+ * Parser entry point
+ */
 export default class ProfileParser {
   constructor(data, locale) {
     /**
@@ -13,16 +16,24 @@ export default class ProfileParser {
      */
     this.profile = new Profile(data.Results[0], locale);
 
-    // N/A
+    /**
+     * @type {number}
+     */
     this.techProjects = data.TechProjects;
 
-    // N/A
+    /**
+     * @type {number}
+     */
     this.xpComponents = data.XpCompoents;
 
-    // N/A
+    /**
+     * @type {number}
+     */
     this.xpCacheExpiryDate = parseDate(data.XpCacheExpiryDate);
 
-    // N/A
+    /**
+     * @type {number}
+     */
     this.ceremonyResetDate = parseDate(data.CeremonyResetDate);
 
     /**

src/Pvp.js

@@ -1,5 +1,8 @@
 /** @module */
 
+/**
+ * Player's conclave stats
+ */
 export default class Pvp {
   constructor(pvp) {
     /**

src/Race.js

@@ -1,5 +1,8 @@
 /** @module */
 
+/**
+ * Represents a k-drive race
+ */
 export default class Race {
   constructor(race) {
     /**

src/Scan.js

@@ -1,5 +1,8 @@
 /** @module */
 
+/**
+ * Represents an enemy scanned to the codex
+ */
 export default class Scan {
   constructor(scan) {
     /**

src/Stats.js

@@ -8,6 +8,9 @@ import Race from './Race.js';
 import Scan from './Scan.js';
 import Weapon from './Weapon.js';
 
+/**
+ * A player's overall career stats
+ */
 export default class Stats {
   /**
    *

src/Syndicate.js

@@ -1,18 +1,21 @@
 /** @module */
 
+import { syndicate } from 'warframe-worldstate-data/utilities';
+
 export default class Syndicate {
   /**
    * @param {Object} affiliation The syndicate data
+   * @param {string} locale  locale code
    */
-  constructor(affiliation) {
+  constructor(affiliation, locale) {
     // TODO: name is readable but still might want to clean them up
     // i.e "NewLokaSyndicate" can be "New Loka"" instead
 
     /**
      * Name of the syndicate
      * @type {String}
      */
-    this.name = affiliation.Tag;
+    this.name = syndicate(affiliation.Tag, locale);
 
     /**
      * Current standing the player has with the syndicate

src/Weapon.js

@@ -1,5 +1,8 @@
 /** @module */
 
+/**
+ * Represents a player's used weapon stats
+ */
 export default class Weapon {
   constructor(weapon) {
     /**

src/WeaponSkin.js

@@ -1,5 +1,8 @@
 /** @module */
 
+/**
+ * A weapon skin
+ */
 export default class WeaponSkin {
   constructor(skin) {
     /**

src/XpInfo.js

@@ -2,6 +2,9 @@
 
 import { find } from 'warframe-items/utilities';
 
+/**
+ * An item that has contributed to a player's mastery rank
+ */
 export default class XpInfo {
   constructor(info) {
     /**