uesp-eso-build-wrapper 0.1.0 → 0.2.0

package/README.md

@@ -1,5 +1,7 @@
 # uesp-eso-build-wrapper
 
+[![CI](https://github.com/srtomy/uesp-eso-build-wrapper/actions/workflows/ci.yml/badge.svg)](https://github.com/srtomy/uesp-eso-build-wrapper/actions/workflows/ci.yml)
+
 A Node.js/TypeScript wrapper around the [UESP ESO Build Editor](https://github.com/uesp/uesp-esochardata) math engine.
 
 Calculate Elder Scrolls Online **Computed Character Statistics** — Health, Magicka, Stamina, mitigation, crit chance, regeneration, and 200+ more — using UESP's own formulas. No formula reimplementation. No database.
@@ -35,10 +37,10 @@ const stats = calculateBuild({
   },
 });
 
-console.log(stats.Health);       // 16000
-console.log(stats.Magicka);      // 19104
+console.log(stats.Health); // 16000
+console.log(stats.Magicka); // 19104
 console.log(stats.MagickaRegen); // 514
-console.log(stats.SpellDamage);  // 1000
+console.log(stats.SpellDamage); // 1000
 ```
 
 ## With Equipped Items
@@ -48,7 +50,7 @@ Items are passed directly as returned by the [UESP public item API](https://esol
 ```ts
 // 1. Fetch item data from UESP API
 const res = await fetch(
-  'https://esolog.uesp.net/exportJson.php?table=minedItem&id=70&level=50&quality=5'
+  'https://esolog.uesp.net/exportJson.php?table=minedItem&id=70&level=50&quality=5',
 );
 const data = await res.json();
 const item = data.minedItem[0]; // pick the variant you want
@@ -77,10 +79,10 @@ Initializes the UESP math engine. **Must be called once** before `calculateBuild
 
 Safe to call multiple times — only executes on the first call.
 
-| Param | Type | Default | Description |
-|---|---|---|---|
-| `resourcesPath` | `string` | bundled vendor | Path to `esoEditBuild.js` and `esobuilddata.js` |
-| `initDataPath` | `string` | bundled vendor | Path to `uesp-init-data.json` with game formulas |
+| Param           | Type     | Default        | Description                                      |
+| --------------- | -------- | -------------- | ------------------------------------------------ |
+| `resourcesPath` | `string` | bundled vendor | Path to `esoEditBuild.js` and `esobuilddata.js`  |
+| `initDataPath`  | `string` | bundled vendor | Path to `uesp-init-data.json` with game formulas |
 
 ### `calculateBuild(input: BuildInput): ComputedStats`
 
@@ -91,20 +93,20 @@ Runs the UESP engine and returns the computed stats.
 ```ts
 interface BuildInput {
   character: {
-    race: string;             // "High Elf" | "Nord" | "Breton" | "Khajiit" | ...
-    class: string;            // "Sorcerer" | "Dragonknight" | "Nightblade" | ...
-    level: number;            // 1–50
+    race: string; // "High Elf" | "Nord" | "Breton" | "Khajiit" | ...
+    class: string; // "Sorcerer" | "Dragonknight" | "Nightblade" | ...
+    level: number; // 1–50
     attributes: {
-      health: number;         // attribute points (max 64 total)
+      health: number; // attribute points (max 64 total)
       magicka: number;
       stamina: number;
     };
-    mundusStone?: string;     // "The Thief" | "The Apprentice" | ...
-    cyrodiil?: boolean;       // Battle Spirit (PvP)
-    vampireStage?: number;    // 0–4
-    werewolfStage?: number;   // 0 or 1
-    championPoints?: number;  // 0–3600
-    rulesVersion?: string;    // "Live" (default) | "PTS"
+    mundusStone?: string; // "The Thief" | "The Apprentice" | ...
+    cyrodiil?: boolean; // Battle Spirit (PvP)
+    vampireStage?: number; // 0–4
+    werewolfStage?: number; // 0 or 1
+    championPoints?: number; // 0–3600
+    rulesVersion?: string; // "Live" (default) | "PTS"
   };
   items?: Partial<Record<EquipSlot, UespItemApiData>>;
 }
@@ -123,18 +125,18 @@ Poison1 | Poison2 | Food | Potion
 
 Key stats returned (see [`types.ts`](src/lib/eso-engine/types.ts) for full list):
 
-| Property | Description |
-|---|---|
-| `Health` / `Magicka` / `Stamina` | Maximum resource pools |
-| `HealthRegen` / `MagickaRegen` / `StaminaRegen` | Out-of-combat regeneration |
-| `WeaponDamage` / `SpellDamage` | Base damage |
-| `WeaponCrit` / `SpellCrit` | Critical chance |
-| `PhysicalResist` / `SpellResist` / `CritResist` | Resistances |
-| `PhysicalPenetration` / `SpellPenetration` | Armor penetration |
-| `DefensePhysicalMitigation` / `DefenseSpellMitigation` | Effective mitigation % |
-| `HealingDone` / `HealingTaken` | Healing modifiers |
-| `RunSpeed` / `SprintSpeed` | Movement speed |
-| `raw` | All 221 stats as `Record<string, number>` |
+| Property                                               | Description                               |
+| ------------------------------------------------------ | ----------------------------------------- |
+| `Health` / `Magicka` / `Stamina`                       | Maximum resource pools                    |
+| `HealthRegen` / `MagickaRegen` / `StaminaRegen`        | Out-of-combat regeneration                |
+| `WeaponDamage` / `SpellDamage`                         | Base damage                               |
+| `WeaponCrit` / `SpellCrit`                             | Critical chance                           |
+| `PhysicalResist` / `SpellResist` / `CritResist`        | Resistances                               |
+| `PhysicalPenetration` / `SpellPenetration`             | Armor penetration                         |
+| `DefensePhysicalMitigation` / `DefenseSpellMitigation` | Effective mitigation %                    |
+| `HealingDone` / `HealingTaken`                         | Healing modifiers                         |
+| `RunSpeed` / `SprintSpeed`                             | Movement speed                            |
+| `raw`                                                  | All 221 stats as `Record<string, number>` |
 
 > All stat IDs match `g_EsoComputedStats` from the UESP engine (version 49+).
 

package/THIRD_PARTY_NOTICES

@@ -35,5 +35,35 @@ Bundled files from uesp/uesp-esochardata:
   - vendor/uesp-esochardata/resources/esobuilddata.js
   - vendor/uesp-data/uesp-init-data.json (formulas extracted from the UESP website)
 
+--------------------------------------------------------------------------------
+uesp/uesp-esolog
+https://github.com/uesp/uesp-esolog
+
+MIT License
+
+Copyright (c) 2020 Dave Humphrey
+
+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.
+--------------------------------------------------------------------------------
+
+Bundled files from uesp/uesp-esolog:
+  - vendor/uesp-esolog/resources/esoskills.js
+
 Elder Scrolls Online is a trademark of ZeniMax Media Inc. This project is not
 affiliated with or endorsed by ZeniMax Media Inc. or Bethesda Softworks.

package/dist/browser-stub.js

@@ -0,0 +1 @@
+// This package is Node.js-only and has no browser exports.

package/dist/lib/eso-engine/calculator.d.ts

@@ -17,7 +17,7 @@
  *
  *   4. Ler os resultados de g_EsoComputedStats[statId].value
  */
-import type { BuildInput, ComputedStats } from './types';
+import type { BuffInfo, BuildInput, ComputedStats, PassiveSkillInfo, ToggleSkillInfo } from './types';
 /**
  * Calcula os Computed Character Statistics para a build fornecida.
  *
@@ -36,4 +36,71 @@ import type { BuildInput, ComputedStats } from './types';
  * ```
  */
 export declare function calculateBuild(input: BuildInput): ComputedStats;
+/**
+ * Returns the catalog of buffs available in the loaded UESP engine.
+ *
+ * Each entry maps to one row in the UESP buff tab. Pass `entry.name` to
+ * `BuildInput.activeBuffs` to enable that buff in a calculation.
+ *
+ * Must be called after `initEsoEngine()`.
+ *
+ * @param group - Optional filter. Ex: "Major", "Minor", "Set", "Target",
+ *   "Skill", "Potion", "Poison", "Cyrodiil", "Other".
+ *   Omit to return all 164 buffs.
+ */
+export declare function listAvailableBuffs(group?: string): BuffInfo[];
+/**
+ * Returns all racial passive skills for the given race.
+ * Each passive may appear in multiple ranks (rank 1, 2, 3).
+ * Pass the abilityId of the desired rank to BuildInput.passiveSkills.
+ *
+ * Must be called after initEsoEngine().
+ *
+ * @param race - Race name as passed to BuildInput.character.race.
+ *   Ex: "High Elf", "Nord", "Khajiit"
+ */
+export declare function listRacialPassives(race: string): PassiveSkillInfo[];
+/**
+ * Returns all class passive skills for the given class.
+ * Each passive may appear in multiple ranks (rank 1, 2, 3).
+ * Pass the abilityId of the desired rank to BuildInput.passiveSkills.
+ *
+ * Must be called after initEsoEngine().
+ *
+ * @param className - Class name as passed to BuildInput.character.class.
+ *   Ex: "Sorcerer", "Nightblade", "Dragonknight"
+ */
+export declare function listClassPassives(className: string): PassiveSkillInfo[];
+/**
+ * Returns all passive skills for the given skill line.
+ * Each passive may appear in multiple ranks (rank 1, 2, 3).
+ * Pass the abilityId of the desired rank to BuildInput.passiveSkills.
+ *
+ * Must be called after initEsoEngine().
+ *
+ * @param skillLine - Skill line name as it appears in g_SkillsData.
+ *   Use listAvailableSkillLines() to discover valid names.
+ *   Examples: "Light Armor", "Heavy Armor", "Undaunted", "Destruction Staff",
+ *   "Fighters Guild", "Mages Guild", "Psijic Order", "Assault", "Support",
+ *   "Vampire", "Werewolf"
+ */
+export declare function listPassivesBySkillLine(skillLine: string): PassiveSkillInfo[];
+/**
+ * Returns all skill line names that have passive skills available.
+ * Use the returned names with listPassivesBySkillLine().
+ *
+ * Must be called after initEsoEngine().
+ */
+export declare function listAvailableSkillLines(): string[];
+/**
+ * Returns all available toggle skills from the loaded UESP engine.
+ * Pass entry.name to BuildInput.toggleSkills to enable it.
+ *
+ * Note: toggle skills with requiresCyrodiil=true also need character.cyrodiil=true.
+ * Toggle skills backed by a passive (isPassive=true) need the associated skill
+ * in passiveSkills/skillBars for the engine to process the description match.
+ *
+ * Must be called after initEsoEngine().
+ */
+export declare function listAvailableToggleSkills(): ToggleSkillInfo[];
 //# sourceMappingURL=calculator.d.ts.map

package/dist/lib/eso-engine/calculator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"calculator.d.ts","sourceRoot":"","sources":["../../../src/lib/eso-engine/calculator.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAGH,OAAO,KAAK,EAAE,UAAU,EAAE,aAAa,EAAa,MAAM,SAAS,CAAC;AAuBpE;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,UAAU,GAAG,aAAa,CAyJ/D"}
+{"version":3,"file":"calculator.d.ts","sourceRoot":"","sources":["../../../src/lib/eso-engine/calculator.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAGH,OAAO,KAAK,EACV,QAAQ,EACR,UAAU,EAEV,aAAa,EAEb,gBAAgB,EAEhB,eAAe,EAEhB,MAAM,SAAS,CAAC;AAqCjB;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,UAAU,GAAG,aAAa,CAgc/D;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,QAAQ,EAAE,CA6B7D;AA2BD;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,gBAAgB,EAAE,CAKnE;AAED;;;;;;;;;GASG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,gBAAgB,EAAE,CAKvE;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,uBAAuB,CAAC,SAAS,EAAE,MAAM,GAAG,gBAAgB,EAAE,CAK7E;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,IAAI,MAAM,EAAE,CASlD;AAED;;;;;;;;;GASG;AACH,wBAAgB,yBAAyB,IAAI,eAAe,EAAE,CA6B7D"}