@elite-dangerous-almanac/core 0.2.8 → 0.2.9

package/dist/ships/modules.d.ts

@@ -5,12 +5,12 @@ import { ModuleSlot, SlotRestriction } from './slots.js';
 /**
  * Outfitting-module types and lookups.
  *
- * Elite Dangerous has ~1200 fittable modules. This module holds the
+ * Elite Dangerous fits ships from a large outfitting registry. This module holds the
  * {@link OutfittingModule} record shape — a module's **identity and its stats**
  * together — and the functions that find one ({@link getModuleBySymbol},
  * {@link getModulesByName}, {@link getBulkheadsForShip}).
  *
- * **Every lookup searches all 1194 modules by default.** A journal `Item` string does
+ * **Every lookup searches every module by default.** A journal `Item` string does
  * not identify its outfitting category, so callers need no category for lookup:
  *
  * ```ts
@@ -21,13 +21,16 @@ import { ModuleSlot, SlotRestriction } from './slots.js';
  * subset — any array you have filtered yourself. The catalogue is also exported split
  * by Frontier's four outfitting categories:
  *
- * | Module | Export | Entries |
- * | --- | --- | --- |
- * | `./modules-core` | `CORE_MODULES` | 516 |
- * | `./modules-internal` | `INTERNAL_MODULES` | 484 |
- * | `./modules-hardpoint` | `HARDPOINT_MODULES` | 159 |
- * | `./modules-utility` | `UTILITY_MODULES` | 35 |
- * | `./modules-all` | `ALL_MODULES` | 1194 (the default) |
+ * Sizes are each module's import graph once your bundler has minified it — the
+ * published package itself is not minified — before any transport compression.
+ *
+ * | Module | Export | Minified | Gzipped |
+ * | --- | --- | --- | --- |
+ * | `./modules-core` | `CORE_MODULES` | ~129 KiB | ~12 KiB |
+ * | `./modules-internal` | `INTERNAL_MODULES` | ~128 KiB | ~13 KiB |
+ * | `./modules-hardpoint` | `HARDPOINT_MODULES` | ~70 KiB | ~8 KiB |
+ * | `./modules-utility` | `UTILITY_MODULES` | ~10 KiB | ~2 KiB |
+ * | `./modules-all` | `ALL_MODULES` | ~335 KiB | ~33 KiB |
  *
  * Those four are for **listing** a category — an outfitting screen's hardpoint tab.
  * They make poor narrowing arguments: no module symbol or display name is shared
@@ -44,7 +47,7 @@ import { ModuleSlot, SlotRestriction } from './slots.js';
  *
  * @remarks
  * **This is the one default that costs real bundle weight.** A lookup imported from
- * here pulls all four catalogues — ~338 KiB minified (~33 KiB gzipped) — since
+ * here pulls all four catalogues — ~337 KiB minified (~33 KiB gzipped) — since
  * that is what it falls back to, and passing an explicit catalogue does not undo it.
  * A build that must carry only one category should import that catalogue and search
  * it directly:
@@ -266,7 +269,7 @@ interface OutfittingModuleIdentity {
      * the seven {@link CoreSlotType} core functions.
      *
      * @remarks
-     * Present on every `core` module, and on the fifteen Guardian Hybrid power plants
+     * Present on every `core` module, and on the Guardian Hybrid power plants
      * and power distributors — which Frontier files under `internal`, but which go in
      * a core mount. Absent on everything else, because there is no one mount to name:
      * a weapon, a utility fitting or an ordinary optional internal fits any mount of
@@ -342,8 +345,8 @@ interface OutfittingModuleIdentity {
      * that no outfitting screen sells. Absent on every module a station offers.
      *
      * @remarks
-     * The fifteen are the nine starter `*_free` fittings and the six bundle-granted
-     * Vessel Hangars. Each is a second identity for an article the game already sells:
+     * They are the starter `*_free` fittings and the bundle-granted Vessel Hangars. Each
+     * is a second identity for an article the game already sells:
      * `Int_Engine_Size2_Class1_free` is the 2E Thrusters again, which is why
      * {@link ShipLoadout.modulesForSlot} leaves them out — a picker that offered both
      * would list "2E Thrusters" twice, once unpriced.
@@ -381,7 +384,7 @@ interface OutfittingModuleIdentity {
      * rule: a mount's restriction says which modules it takes, this says which mounts
      * a module goes in. Most restricted families bind one way only — a cargo rack fits
      * a `cargo` mount *and* any unrestricted optional — so this is present on just the
-     * five records the game sells for one kind of mount and nowhere else:
+     * records the game sells for one kind of mount and nowhere else:
      *
      * | Module | Requires |
      * | --- | --- |
@@ -438,12 +441,11 @@ interface OutfittingModuleIdentity {
      * discount or markup, which is what an outfitting screen quotes at 0% discount.
      *
      * @remarks
-     * Absent on the handful of records no registry prices: the starter `*_free`
-     * variants, the two Community Goal Corrosion Resistant Cargo Racks, and the 1B
-     * shield generator — records no outfitting
-     * registry carries a figure for — among them the two Corrosion Resistant Cargo
-     * Racks no station sells, which are not free. Treat `undefined` as "unknown", never
-     * as free — see [`data/ships/SOURCES.md`](https://github.com/DarkSession/Elite-Dangerous-Almanac/blob/main/data/ships/SOURCES.md).
+     * Absent on the handful of records no registry prices: the grant-only `*_free`
+     * articles, the Community Goal Corrosion Resistant Cargo Racks, which no station
+     * sells but which are not free, and the 1B shield generator. Treat `undefined` as
+     * "unknown", never as free; see
+     * [`data/ships/SOURCES.md`](https://github.com/DarkSession/Elite-Dangerous-Almanac/blob/main/data/ships/SOURCES.md).
      */
     readonly cost?: number;
 }
@@ -529,8 +531,8 @@ interface OutfittingModuleStats {
      * outfitting screen labels SCO.
      *
      * @remarks
-     * A sparse capability flag on the 36 Overcharge drives and absent everywhere else,
-     * including on the 31 ordinary drives of the same sizes and ratings. Read it rather
+     * A sparse capability flag on the Overcharge drives and absent everywhere else,
+     * including on the ordinary drives of the same sizes and ratings. Read it rather
      * than matching `Int_Hyperdrive_Overcharge` on the symbol: the capability is the
      * record's to state, and a pre-engineered or fitted article carries the flag
      * through while its symbol is not always the one you looked up.
@@ -605,7 +607,7 @@ interface OutfittingModuleStats {
      * @remarks
      * A sparse capability flag rather than a percentage: `true` means the protection is
      * inherent or the grade-1 blueprint grants it, while absence means it is not granted.
-     * The two Guardian Nanite Torpedo Pylons carry it inherently; read engineered
+     * The Guardian Nanite Torpedo Pylons carry it inherently; read engineered
      * protection from a fitted module's {@link FittedModule.effectiveStats}.
      */
     readonly guardianZoneResistance?: boolean;
@@ -802,7 +804,7 @@ interface OutfittingModule extends OutfittingModuleIdentity, OutfittingModuleSta
  * @param symbol - The internal identifier, e.g. `"Hpt_PulseLaser_Fixed_Small"`.
  * Leading/trailing whitespace and case are ignored, so the journal's lower-cased
  * form resolves too.
- * @param modules - Optional subset to search instead of all 1194 modules —
+ * @param modules - Optional subset to search instead of every module —
  * `CORE_MODULES`, `INTERNAL_MODULES`, `HARDPOINT_MODULES`, `UTILITY_MODULES`, or any
  * array you have filtered yourself. Omit it unless you specifically want to exclude
  * the other categories; a symbol is unique across all four.

package/dist/ships/modules.js

@@ -1 +1 @@
-export{getBulkheadsForShip,getModuleBySymbol,getModulesByName}from"../chunk-5YEHJM6V.js";                                                                                                                                                                                                                                                                     //# sourceMappingURL=modules.js.map
+export{getBulkheadsForShip,getModuleBySymbol,getModulesByName}from"../chunk-OSMBAFRW.js";                                                                                                                                                                                                                                                                     //# sourceMappingURL=modules.js.map

package/dist/ships/pre-engineered-stats.d.ts

@@ -99,7 +99,7 @@ declare function getPreEngineeredJournalModifiers(variant: PreEngineeredVariant)
  * The module symbol and blueprint therefore identify the purchase at grade 1 and after
  * upgrading it through grades 2–5. The fitted grade and experimental effect remain the
  * loadout's current engineering state; the returned variant carries the original purchase
- * grade, Merc Coin price and — on the ten rows sold with one — the effect the shop bakes
+ * grade, Merc Coin price and, on the rows sold with one, the effect the shop bakes
  * in. So a capture that states a different effect, or none, still identifies the article
  * it was bought as: read the capture for what is fitted now, the variant for what was
  * bought.

package/dist/ships/pre-engineered-stats.js

@@ -1 +1 @@
-export{getPreEngineeredJournalModifiers,getPreEngineeredModifiers,getPreEngineeredStats,identifyPreEngineeredVariant,unresolvedModifiers}from"../chunk-IN36YSS4.js";                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             //# sourceMappingURL=pre-engineered-stats.js.map
+export{getPreEngineeredJournalModifiers,getPreEngineeredModifiers,getPreEngineeredStats,identifyPreEngineeredVariant,unresolvedModifiers}from"../chunk-C3YZ5KTA.js";                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             //# sourceMappingURL=pre-engineered-stats.js.map

package/dist/ships/pre-engineered.d.ts

@@ -18,16 +18,16 @@
  * grade already applied. Most blueprint ids join to `BLUEPRINTS`; the festive
  * `Decorative_*` ids instead identify fixed grade-5 reward articles with no craftable
  * recipe or material cost.
- * The 22 Mercenary entries are bought at grade 1 and their bespoke recipes start at
+ * Mercenary entries are bought at grade 1 and their bespoke recipes start at
  * grade 2 — price the remaining upgrade with `getBlueprintCost(blueprint, target,
  * grade)` from `ships/blueprint-costs`, which answers with the materials and the Merc
  * Coin the climb costs.
  * Community-goal and tech-broker entries instead identify fixed reward articles; their
  * blueprint ids do not grant a recipe to the stock module.
  *
- * Note that one base module can appear more than once: the medium Seeker Missile Rack is
- * sold or awarded in six different pre-engineered flavours, so
- * `Hpt_BasicMissileRack_Fixed_Medium` has six entries. Look variants up with
+ * One base module can appear more than once: the medium Seeker Missile Rack is sold or
+ * awarded in several pre-engineered flavours, so `Hpt_BasicMissileRack_Fixed_Medium` has
+ * one entry per flavour. Look variants up with
  * {@link getPreEngineeredVariants} (plural) rather than assuming one.
  *
  * Most variants carry a `modifiers` block — the hand-set stat
@@ -35,19 +35,19 @@
  * computed. Resolve them against the base module with `getPreEngineeredStats` from
  * `./pre-engineered-stats.js`; it lives in its own module so that consumers who only
  * want the catalogue do not bundle the module and engineering tables.
- * Final articles carry {@link PreEngineeredVariant.engineeringLocked}. These are the seven
+ * Final articles carry {@link PreEngineeredVariant.engineeringLocked}. These are the
  * pre-engineered Guardian weapons, whose stock counterparts can take Anti-Guardian Zone
- * Resistance, and five fixed Enzyme/AX rewards whose stock modules have no engineering menu.
+ * Resistance, and the fixed Enzyme/AX rewards whose stock modules have no engineering menu.
  *
  * @packageDocumentation
  */
 /**
  * Where a pre-engineered variant is obtained.
  *
- * - `mercenary` — bought from the Merc-Coin shop; always arrives at grade 1, ten of them
+ * - `mercenary` — bought from the Merc-Coin shop; always arrives at grade 1, some of them
  *   with an experimental effect already applied beside that grade-1 blueprint.
- * - `communityGoal` — awarded for taking part in a community goal; mostly grade 5, 8 of
- *   the 30 carrying an experimental effect.
+ * - `communityGoal` — awarded for taking part in a community goal; mostly grade 5, a
+ *   minority carrying an experimental effect.
  * - `techBroker` — unlocked at a tech broker. Records the route stated by the source.
  * - `eventReward` — awarded already transformed by an event; the festive articles are grade 5.
  */
@@ -150,7 +150,6 @@ interface PreEngineeredVariant {
  * ```ts
  * import { PRE_ENGINEERED_MODULES } from '@elite-dangerous-almanac/core/ships/pre-engineered';
  *
- * PRE_ENGINEERED_MODULES.length; // -> 76
  * PRE_ENGINEERED_MODULES[0];
  * // -> { symbol: 'Hpt_Mining_AbrBlstr_Fixed_Small', name: 'Abrasion Blaster',
  * //      blueprintSymbol: 'AbrasionBlaster_FarReaching', grade: 1,

package/dist/ships/pre-engineered.js

@@ -1 +1 @@
-export{PRE_ENGINEERED_MODULES,getPreEngineeredVariants,isPreEngineered}from"../chunk-BJU27V6C.js";                                                                                       //# sourceMappingURL=pre-engineered.js.map
+export{PRE_ENGINEERED_MODULES,getPreEngineeredVariants,isPreEngineered}from"../chunk-AUBV6S7V.js";                                                                                       //# sourceMappingURL=pre-engineered.js.map

package/dist/ships/shield-capacitor.js

@@ -1 +1 @@
-export{shieldCapacitorMetrics}from"../chunk-JCYOE3C4.js";                                                                                       //# sourceMappingURL=shield-capacitor.js.map
+export{shieldCapacitorMetrics}from"../chunk-XQJERZUS.js";                                                                                       //# sourceMappingURL=shield-capacitor.js.map

package/dist/ships/ship-loadout.d.ts

@@ -314,8 +314,8 @@ type LoadoutEditErrorCode = 'immutableSlot' | 'requiredSlot' | 'incompatibleModu
  * An editor request that the current hull or build constraints cannot accept.
  *
  * @remarks
- * This remains a `TypeError`, so existing `instanceof TypeError` handling continues to
- * work. Localized editors should switch on {@link code}, then use {@link constraint}
+ * It is a `TypeError`, so `instanceof TypeError` handling catches it. Localized editors
+ * should switch on {@link code}, then use {@link constraint}
  * and {@link params} instead of parsing the English fallback in `message`.
  *
  * @example
@@ -990,7 +990,7 @@ declare class ShipLoadout {
      * omitted.
      *
      * @remarks
-     * This is the outfitting *offer*, so the fifteen {@link ships!OutfittingModule.grantOnly | grantOnly}
+     * This is the outfitting *offer*, so the {@link ships!OutfittingModule.grantOnly | grantOnly}
      * articles are never in it: each is a second identity for a module the game already
      * sells — `Int_Engine_Size2_Class1_free` is the 2E Thrusters — and listing both puts
      * the same article on the screen twice, once with no price. A build that already
@@ -1162,7 +1162,7 @@ declare class ShipLoadout {
      * leave the build unchanged and return stable structured data.
      *
      * A Mercenary article is recomputed rather than composed, and that limits what can be
-     * done to the effect ten of those rows are sold carrying. At its purchase grade there
+     * done to the effect some of those rows are sold carrying. At its purchase grade there
      * is no recipe to recompute from — the bespoke recipe starts at grade 2 — so every
      * edit is refused with `unsupportedEngineering`. Once engineered to grade 2 or above
      * an edit recomputes normally, but only to an effect the module's own menu offers:
@@ -1298,9 +1298,9 @@ declare class ShipLoadout {
      * Set a fitted module's power-priority group.
      *
      * @param slotKey - The slot's journal key, matched case-insensitively.
-     * @param priority - The journal's **zero-based** group, `0`–`4`. Note that the
-     * outfitting panel — and {@link ships!BuildMetrics.powerBudget | BuildMetrics.powerBudget}'s `bands[].priority` — number the same
-     * five groups `1`–`5`.
+     * @param priority - The journal's **zero-based** group, `0`–`4`. The outfitting
+     * panel, and {@link ships!BuildMetrics.powerBudget | BuildMetrics.powerBudget}'s
+     * `bands[].priority`, number the same five groups `1`–`5`.
      * @returns `this`, for chaining.
      * @throws {RangeError} If the slot is empty, or `priority` is not an integer in `[0, 4]`.
      * @throws {TypeError} If `slotKey` is not a string.

package/dist/ships/ship-loadout.js

@@ -1 +1 @@
-export{LoadoutEditError,ShipLoadout}from"../chunk-SC4MEHVY.js";                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    //# sourceMappingURL=ship-loadout.js.map
+export{LoadoutEditError,ShipLoadout}from"../chunk-HIJR7DOC.js";                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    //# sourceMappingURL=ship-loadout.js.map

package/dist/ships/ships.d.ts

@@ -5,7 +5,7 @@ import { CoreSlots, HardpointSlotSpec, OptionalSlotSpec, ShipSlots } from './slo
  * stats, and its slot layout in one record**, with the lookups an app needs to turn
  * an internal symbol or a display name into a {@link Ship}.
  *
- * There is only one list of ships and it is tiny (48 records), so the lookups here
+ * There is only one list of ships and it is small, so the lookups here
  * take no catalogue argument at all — they always search {@link SHIPS}. Importing one
  * bundles the whole ship list, which is what you wanted anyway. Stock module identities
  * live in `./default-loadouts`, keeping this small hull catalogue independent of them.
@@ -143,7 +143,6 @@ interface Ship {
  * ```ts
  * import { SHIPS } from '@elite-dangerous-almanac/core/ships/ships';
  *
- * SHIPS.length;                                  // -> 48
  * SHIPS.find((s) => s.symbol === 'Anaconda')?.name; // -> 'Anaconda'
  * ```
  */

package/dist/ships/ships.js

@@ -1 +1 @@
-export{SHIPS,getShipByName,getShipBySymbol,getShipSlots}from"../chunk-6UNAD74Z.js";                                                                                       //# sourceMappingURL=ships.js.map
+export{SHIPS,getShipByName,getShipBySymbol,getShipSlots}from"../chunk-C4FUV6GF.js";                                                                                       //# sourceMappingURL=ships.js.map

package/dist/ships/slots.d.ts

@@ -5,7 +5,7 @@
  * A hull offers a fixed set of mounts: seven core internals, a handful of weapon
  * hardpoints, some tiny utility mounts, and a column of optional internals. Some of
  * those mounts are **restricted** to one family of modules — military and
- * planetary-approach optionals on most hulls, and, on three hulls, cargo-only,
+ * planetary-approach optionals on most hulls, and, on a few hulls, cargo-only,
  * limpet-controller-only, vessel-hangar-only and passenger-cabin-only optionals and
  * mining-only hardpoints (see {@link SlotRestriction}). This module gives
  * each mount a stable **slot key** and a {@link BuildSlot} descriptor, and
@@ -15,7 +15,7 @@
  *
  * It holds no data; {@link enumerateSlots} takes a {@link ShipSlots} layout (from a
  * hull's `Ship` record via `getShipSlots` in `./ships`) and expands it into keyed
- * {@link BuildSlot}s. Most hulls number their mounts by rule; on ten the game does
+ * {@link BuildSlot}s. Most hulls number their mounts by rule; on some the game does
  * not, and a mount there carries its own `name` — see {@link enumerateSlots}.
  *
  * @packageDocumentation
@@ -149,7 +149,7 @@ interface BuildSlotBase {
      * `core` function name is a *different* string (`thrusters` vs the key
      * `MainEngines`); see {@link CoreSlotType}.
      *
-     * **Do not compute one.** The numbering looks regular and on ten hulls is
+     * **Do not compute one.** The numbering looks regular and on some hulls is
      * not: the Anaconda's smallest optionals are `Slot13_Size2` and `Slot14_Size1`
      * with no slots 11 or 12, the Type-9 Heavy starts at `Slot00_Size8`, the Type-7
      * Transporter uses the number `09` twice, and the Keelback's `Slot03_Size3` sits
@@ -341,7 +341,7 @@ interface ParsedSlot {
  * @returns Every mount the hull offers, as {@link BuildSlot}s.
  * @remarks
  * Unrestricted optionals are numbered `Slot01_SizeN`, `Slot02_SizeN`, … with no gaps,
- * and hardpoints `1, 2, 3` within each size class. **Ten hulls disagree**, and no
+ * and hardpoints `1, 2, 3` within each size class. **Some hulls disagree**, and no
  * rule derives what they do instead, so a mount on one of them carries its own
  * {@link OptionalSlotSpec.name} / {@link HardpointSlotSpec.name} and that wins:
  *
@@ -394,7 +394,7 @@ declare function enumerateSlots(layout: ShipSlots): BuildSlot[];
  * mount. The returned `core` and `restriction` values keep this library's own
  * camelCase spelling whatever the input looked like.
  *
- * **A `_SizeN` suffix is what the name says, not what the mount is.** On three hulls
+ * **A `_SizeN` suffix is what the name says, not what the mount is.** On some hulls
  * the game's own key disagrees with the mount it names — the Keelback's
  * `Slot03_Size3` is a size-4 mount, the Asp Scout's `Slot01_Size4` a size-5 one, and
  * five of the Type-7 Transporter's ten are off. To size a mount, find it in the hull's

package/dist/ships/weapons.js

@@ -1 +1 @@
-export{armourPiercingFactor,combinedRateOfFire,damageFalloff,damagePerSecond,energyPerSecond,heatPerSecond,splitDamage,sumWeaponMetrics,sustainedDamagePerSecond,sustainedFireFactor,weaponMetrics}from"../chunk-2OBUSQA7.js";                                                          //# sourceMappingURL=weapons.js.map
+export{armourPiercingFactor,combinedRateOfFire,damageFalloff,damagePerSecond,energyPerSecond,heatPerSecond,splitDamage,sumWeaponMetrics,sustainedDamagePerSecond,sustainedFireFactor,weaponMetrics}from"../chunk-AAU7OM47.js";                                                          //# sourceMappingURL=weapons.js.map