@elite-dangerous-almanac/core 0.2.7 → 0.2.9

package/README.md

@@ -48,7 +48,8 @@ The package has six feature areas:
 - `astro`: procedural names, id64 addresses, regions, nebulae, permit locks, and scanned
   bodies with their physics;
 - `ships`: ships, modules, SLEF loadouts, engineering and build metrics;
-- `equipment`: Odyssey suits, handheld weapons, grade upgrades and modifications;
+- `equipment`: Odyssey suits, handheld weapons and their damage per second, suit tools,
+  grade upgrades and modifications;
 - `i18n`: sparse localized catalogue names, descriptions, slot labels and structured
   diagnostic messages;
 - `materials`: ship engineering materials and Odyssey micro resources;
@@ -141,11 +142,12 @@ data-free leaf modules under `ships/jump-range`, `ships/power`, `ships/shields`,
 
 `build.validation()` reports validity and operational completeness. `cargoCapacity`,
 `passengerCapacity`, `fuelCapacity` and `unladenMass` always have an answer, because no
-article the catalogue cannot weigh reaches a build; the eight metrics that depend on
-build state (`mobilityMetrics`, `mobilityCapacitorMetrics`, `shieldMetrics`,
-`shieldCapacitorMetrics`, `shieldRecovery`, `heatMetrics`, `distributorMetrics` and
-`standardLoad`) are nullable and each has a `…Result` counterpart naming what is
-missing, switched off, shed or unpowered. `parseSlef`
+article the catalogue cannot weigh reaches a build. The eight build-state methods
+(`mobilityMetricsResult`, `mobilityCapacitorMetricsResult`, `shieldMetricsResult`,
+`shieldCapacitorMetricsResult`, `shieldRecoveryResult`, `heatMetricsResult`,
+`distributorMetricsResult` and `standardLoadResult`) return a diagnostic result whose
+value is either complete or `null`, with issues naming what is missing, unresolved,
+switched off, shed or invalid. `parseSlef`
 is strict; `inspectSlef` is the tolerant importer for mixed files and returns indexed
 diagnostics instead of silently dropping entries.
 
@@ -168,20 +170,38 @@ pinned sources carry no translation instead of silently substituting English:
 ```ts
 import {
     getBlueprintName,
+    getCommodityName,
     getMaterialName,
     getMicroResourceName,
     getModuleName,
     getOutfittingFamilyName,
+    getPersonalModificationName,
+    getPersonalToolName,
+    getSuitName,
 } from '@elite-dangerous-almanac/core/i18n';
 
 getModuleName('Int_Hyperdrive_Size6_Class5', 'de-DE'); // -> "Frameshiftantrieb"
 getBlueprintName('FSD_LongRange', 'fr-FR'); // -> "Portée FSD améliorée"
 getMaterialName('GridResistors', 'de'); // -> "Gitterwiderstände"
 getMicroResourceName('graphene', 'fr'); // -> "Graphène"
+getCommodityName('LavianBrandy', 'de'); // -> "Lave-Brandy"
+getSuitName('explorationsuit_class3', 'de'); // -> "Artemis-Anzug"
+getPersonalToolName('profile-analyser', 'es'); // -> "Analizador de perfiles"
+getPersonalModificationName('suit_nightvision', 'fr'); // -> "Vision nocturne"
 getOutfittingFamilyName('shieldGenerators', 'de'); // -> "Schildgeneratoren"
 getOutfittingFamilyName('xenoScanners', 'de'); // -> null
 ```
 
+Display prose the game shows a player — a suit's or a handheld weapon's blurb, what an
+experimental effect or an engineer's modification does — has its own lookups in the same
+`i18n` area, each on its own subpath, complete in all six locales:
+
+```ts
+import { getSuitDescription } from '@elite-dangerous-almanac/core/i18n/suits';
+
+getSuitDescription('utilitysuit', 'en')?.slice(0, 20); // -> "The Maverick suit is"
+```
+
 The functions return an explicit source value verbatim, so a source-backed spelling may
 happen to equal English; the library itself never supplies an English fallback. The
 catalogues carry English, French, German, Portuguese, Russian and Spanish, each stored
@@ -229,7 +249,10 @@ families, so `resolvePersonalModificationForWeapon` resolves those spellings aga
 weapon before joining to `PERSONAL_MODIFICATIONS` or `PERSONAL_MODIFICATION_COSTS`.
 Material shopping lists live on the separate `equipment/modification-costs` subpath and
 consume the
-micro-resource symbols from the `materials` feature area.
+micro-resource symbols from the `materials` feature area. Suit tools are the one
+personal-equipment record with no Frontier symbol — the journal never names a tool — so
+`PersonalTool.id` is a library key such as `arc-cutter`, and `getPersonalToolName` takes
+that same id.
 
 ## Important behavior
 

package/THIRD_PARTY_NOTICES.md

@@ -108,6 +108,11 @@ a verbatim copy produced at build time — edit this file, never the copy.
   Frontier notice below. Heat dissipation is the one entry the game never shows a player:
   it is community measurement of Frontier's game, described under Algorithms above, and
   carried here on the same terms as the rest.
+- **[EDCD/EDMarketConnector](https://github.com/EDCD/EDMarketConnector)** by the
+  **EDMarketConnector contributors**, **GPL-2.0** for its code — supplies the Frontier
+  journal `SlotName` keys that identify a suit's weapon mounts. What is taken are the
+  verbatim loadout events quoted in its `monitor.py` comments; no EDMarketConnector code
+  is incorporated. The values are game data — see the Frontier notice below.
 - **[EDDI](https://github.com/EDCD/EDDI)** by the **EDDI contributors**, **Apache 2.0**
   for its code — its module definitions and resource tables supply localized outfitting
   names. The names are factual Elite Dangerous game data; no EDDI code is incorporated.
@@ -161,7 +166,13 @@ a verbatim copy produced at build time — edit this file, never the copy.
   with its [announcement](https://x.com/EliteDangerous/status/1812792503776489745).
   Frontier's own **in-game localisation** supplies the outfitting category labels behind
   the module families and their German, Spanish, French, Brazilian Portuguese and Russian
-  display text, and the engineering modification names in the six stored locales.
+  display text, the engineering modification names in the six stored locales, the market
+  commodity names in `data/i18n/commodity-names.jsonc`, and the personal-equipment
+  display text in `data/i18n/`: the suit names and descriptions, the suit tool names, the
+  handheld-weapon descriptions, and the names and descriptions of the engineer-applied
+  suit and weapon modifications. The game's own **commodity registry** supplies the
+  symbols and names of the mineral and chemical goods
+  `data/commodities/commodities.jsonc` holds beyond the FDevIDs snapshot.
   Values read directly from the running game are Frontier's too — see the notice below.
 - **A [community description](https://www.reddit.com/r/EliteDangerous/comments/1uk2zhp/plasma_laser_theorycrafting_following_new/)
   by u/Techno3020** — linked only as corroboration that the Operations Plasma conversion's

package/dist/astro/body-rings.d.ts

@@ -166,8 +166,8 @@ declare function isInvisibleRing(ring: BodyRing): boolean;
  * The `3/8` is a fitted constant, not a derivation — the Canonn Research Group arrived at
  * it from in-game measurements, having also weighed `1/e` (≈ 0.368) and `1/φ²` (≈ 0.382),
  * which it sits between. Two things bound how exact the result can be: the journal writes
- * ring radii to four significant figures, and the fit is still being refined against new
- * observations. Treat the figures as close, not exact.
+ * ring radii to four significant figures, and the constant is a fit to in-game
+ * observations rather than an exact value. Treat the figures as close, not exact.
  *
  * @param ring - The ring. Needs {@link BodyRing.InnerRad | InnerRad} and
  * {@link BodyRing.OuterRad | OuterRad}, in metres.

package/dist/astro/codex-region-lookup.d.ts

@@ -21,7 +21,7 @@ import { SystemAddressInput } from './system-address-input.js';
  * These can differ near a region border; see the upstream discussion linked in the
  * data file's attribution.
  *
- * Algorithm ported from klightspeed's EliteDangerousRegionMap (`RegionMap.js`),
+ * Algorithm ported from klightspeed's EliteDangerousRegionMap (`RegionMap.js`).
  * See [ATTRIBUTIONS.md](https://github.com/DarkSession/Elite-Dangerous-Almanac/blob/main/ATTRIBUTIONS.md) for credit and licence terms.
  *
  * @packageDocumentation