@elite-dangerous-almanac/core 0.1.7 → 0.2.0

package/dist/ships/blueprint-costs.d.ts

@@ -39,7 +39,7 @@ import './slots.js';
  */
 type BlueprintGradeCosts = Readonly<Record<string, readonly EngineeringMaterial[]>>;
 /**
- * Every craftable blueprint's per-roll material recipes, keyed by Frontier `fdname` and then grade.
+ * Every craftable blueprint's per-roll material recipes, keyed by Frontier symbol and then grade.
  *
  * @remarks
  * Its ids and grade sets are the craftable subset of `BLUEPRINTS` from
@@ -59,7 +59,7 @@ declare const BLUEPRINT_COSTS: Readonly<Record<string, BlueprintGradeCosts>>;
 /**
  * Look up all per-grade material recipes for one blueprint.
  *
- * @param fdname - The blueprint id, e.g. `"FSD_LongRange"`, matched
+ * @param blueprintSymbol - The blueprint id, e.g. `"FSD_LongRange"`, matched
  * case-insensitively after trimming surrounding whitespace.
  * @remarks
  * The material half only, straight from the catalogue. The Merc Coin some recipes charge
@@ -68,8 +68,8 @@ declare const BLUEPRINT_COSTS: Readonly<Record<string, BlueprintGradeCosts>>;
  *
  * @returns The frozen grade-to-material-list record, or `null` if no ordinary craft
  * cost is catalogued (including a known fixed reward identity).
- * @throws {TypeError} If `fdname` is present and not a string. A nullish
- * `fdname` is a miss, answered the way an unrecognised one is.
+ * @throws {TypeError} If `blueprintSymbol` is present and not a string. A nullish
+ * `blueprintSymbol` is a miss, answered the way an unrecognised one is.
  * @example
  * ```ts
  * import { getBlueprintCosts } from '@elite-dangerous-almanac/core/ships/blueprint-costs';
@@ -78,7 +78,7 @@ declare const BLUEPRINT_COSTS: Readonly<Record<string, BlueprintGradeCosts>>;
  * // -> [{ symbol: 'Arsenic', name: 'Arsenic', count: 1 }, ...]
  * ```
  */
-declare function getBlueprintCosts(fdname: string): BlueprintGradeCosts | null;
+declare function getBlueprintCosts(blueprintSymbol: string): BlueprintGradeCosts | null;
 /**
  * What one engineering step costs — the materials it consumes and the Merc Coin billed
  * beside them.
@@ -109,15 +109,15 @@ interface BlueprintCost {
 /**
  * Look up what **one roll** at one blueprint grade costs.
  *
- * @param fdname - The blueprint id, e.g. `"FSD_LongRange"`, matched
+ * @param blueprintSymbol - The blueprint id, e.g. `"FSD_LongRange"`, matched
  * case-insensitively after trimming surrounding whitespace.
  * @param grade - The grade, `1`–`5`.
  * @returns The materials one roll consumes and the Merc Coin it bills, or `null` if no
  * ordinary craft cost is catalogued for the blueprint and grade. `materials` is the
  * frozen catalogue list; `mercCoins` is `0` unless the recipe charges a currency.
  * @throws {RangeError} If `grade` is not an integer from 1 through 5.
- * @throws {TypeError} If `fdname` is present and not a string. A nullish
- * `fdname` is a miss, answered the way an unrecognised one is.
+ * @throws {TypeError} If `blueprintSymbol` is present and not a string. A nullish
+ * `blueprintSymbol` is a miss, answered the way an unrecognised one is.
  * @example
  * ```ts
  * import { getBlueprintGradeCost } from '@elite-dangerous-almanac/core/ships/blueprint-costs';
@@ -128,12 +128,15 @@ interface BlueprintCost {
  * getBlueprintGradeCost('RailGun_LongShot', 5)?.mercCoins; // -> 50
  * ```
  */
-declare function getBlueprintGradeCost(fdname: string, grade: number): BlueprintCost | null;
+declare function getBlueprintGradeCost(blueprintSymbol: string, grade: number): BlueprintCost | null;
 /**
  * Compute the **total** cost of engineering a module up to a grade — every grade the
- * module still has to climb, each rolled the number of times it takes to complete
- * ({@link rollsForGrade}: grade `g` needs `g` rolls), summed into one shopping list and
- * one Merc Coin total.
+ * module still has to climb, each rolled the number of times it takes to complete,
+ * summed into one shopping list and one Merc Coin total.
+ *
+ * **Grade `N` takes `N` rolls** to fill its progress bar (grade 1 → 1 roll, grade 2 → 2
+ * rolls, … grade 5 → 5 rolls), and each roll costs that grade's recipe once, so the
+ * climb is weighted rather than a plain sum — for the materials and the Merc Coin alike.
  *
  * By default it prices the whole climb from unengineered; pass `currentGrade` to price
  * only what remains. Each grade `g` in `currentGrade + 1 … grade` contributes
@@ -153,7 +156,7 @@ declare function getBlueprintGradeCost(fdname: string, grade: number): Blueprint
  * same at every grade. Either spelling therefore prices correctly without a fitted
  * module; cross-catalogue tests pin that invariant.
  *
- * @param fdname - The blueprint id, e.g. `"FSD_LongRange"`, matched
+ * @param blueprintSymbol - The blueprint id, e.g. `"FSD_LongRange"`, matched
  * case-insensitively after trimming surrounding whitespace.
  * @param grade - The target grade, `1`–`5`.
  * @param currentGrade - The completed grade, `0`–`5`; defaults to `0` for an
@@ -166,8 +169,8 @@ declare function getBlueprintGradeCost(fdname: string, grade: number): Blueprint
  * charges no currency, so `null` remains the one answer meaning "not catalogued".
  * @throws {RangeError} If `grade` is not an integer from 1 through 5, or `currentGrade`
  * is not an integer from 0 through 5.
- * @throws {TypeError} If `fdname` is present and not a string. A nullish
- * `fdname` is a miss, answered the way an unrecognised one is.
+ * @throws {TypeError} If `blueprintSymbol` is present and not a string. A nullish
+ * `blueprintSymbol` is a miss, answered the way an unrecognised one is.
  * @example
  * ```ts
  * import { getBlueprintCost } from '@elite-dangerous-almanac/core/ships/blueprint-costs';
@@ -181,7 +184,7 @@ declare function getBlueprintGradeCost(fdname: string, grade: number): Blueprint
  * getBlueprintCost('FuelScoop_Efficiency', 5)?.mercCoins; // -> 350
  * ```
  */
-declare function getBlueprintCost(fdname: string, grade: number, currentGrade?: number): BlueprintCost | null;
+declare function getBlueprintCost(blueprintSymbol: string, grade: number, currentGrade?: number): BlueprintCost | null;
 /**
  * Merc Coin charged for **one roll** of a blueprint, keyed by grade (`"1"`–`"5"`).
  *
@@ -195,7 +198,7 @@ declare function getBlueprintCost(fdname: string, grade: number, currentGrade?:
 type BlueprintMercCoinCosts = Readonly<Record<string, number>>;
 /**
  * The Merc Coin charged per roll by every blueprint that charges any, keyed by Frontier
- * `fdname` and then grade.
+ * symbol and then grade.
  *
  * @remarks
  * The raw catalogue behind {@link BlueprintCost.mercCoins}; reach for

package/dist/ships/blueprint-costs.js

@@ -1 +1 @@
-export{BLUEPRINT_COSTS,BLUEPRINT_MERC_COIN_COSTS,getBlueprintCost,getBlueprintCosts,getBlueprintGradeCost}from"../chunk-TEOJCBSG.js";                                                                                                                    //# sourceMappingURL=blueprint-costs.js.map
+export{BLUEPRINT_COSTS,BLUEPRINT_MERC_COIN_COSTS,getBlueprintCost,getBlueprintCosts,getBlueprintGradeCost}from"../chunk-MTJ4MS7W.js";                                                                                                                    //# sourceMappingURL=blueprint-costs.js.map

package/dist/ships/blueprint-journal.d.ts

@@ -39,17 +39,18 @@
  * unaffected — both spellings of a pair bill the same at every grade, so
  * `getBlueprintCost` needs no module.
  *
- * @param symbol - A module symbol, e.g. `"Hpt_CloudScanner_Size0_Class5"`.
- * @param fdname - A blueprint catalogue or journal id, matched case-insensitively and
- * trimmed. Colliding journal spellings are resolved against `symbol`.
+ * @param moduleSymbol - A module symbol, e.g. `"Hpt_CloudScanner_Size0_Class5"`.
+ * @param blueprintSymbol - A blueprint catalogue or journal id, matched case-insensitively and
+ * trimmed. Colliding journal spellings are resolved against `moduleSymbol`.
  * @returns The id to join to `BLUEPRINTS`, in that catalogue's spelling when a journal
- * name resolved, and otherwise `fdname` exactly as it was passed — byte for byte, so a
+ * name resolved, and otherwise `blueprintSymbol` exactly as it was passed — byte for byte, so a
  * caller who never meets the collision never sees their own spelling rewritten.
  *
- * @throws {TypeError} If `fdname` is not a string, including when it is missing — this
+ * @throws {TypeError} If `blueprintSymbol` is not a string, including when it is missing — this
  * returns an id rather than reporting whether one is known, so there is no miss for a
- * nullish one to be. A nullish `symbol` *is* a miss: an unknown module offers no menu,
- * and `fdname` comes back unchanged.
+ * nullish one to be. A nullish `moduleSymbol` *is* a miss: an unknown module offers no
+ * menu,
+ * and `blueprintSymbol` comes back unchanged.
  * @example
  * ```ts
  * import { resolveBlueprintForModule } from '@elite-dangerous-almanac/core/ships/blueprint-journal';
@@ -69,6 +70,6 @@
  * // -> 'Weapon_Overcharged'
  * ```
  */
-declare function resolveBlueprintForModule(symbol: string, fdname: string): string;
+declare function resolveBlueprintForModule(moduleSymbol: string, blueprintSymbol: string): string;
 
 export { resolveBlueprintForModule };

package/dist/ships/blueprint-journal.js

@@ -1 +1 @@
-export{resolveBlueprintForModule}from"../chunk-2TW4ZBI3.js";                                                                                                                    //# sourceMappingURL=blueprint-journal.js.map
+export{resolveBlueprintForModule}from"../chunk-OLKNYGGT.js";                                                                                                                    //# sourceMappingURL=blueprint-journal.js.map

package/dist/ships/blueprints.d.ts

@@ -7,7 +7,7 @@ import './slots.js';
 
 /**
  * The **blueprint mechanics catalogue** — every engineering blueprint's per-grade stat
- * modifiers, keyed by the blueprint's Frontier `fdname`
+ * modifiers, keyed by the blueprint's Frontier symbol
  * (as it appears in a journal `Loadout` event's `Engineering.BlueprintName`).
  *
  * Its own module (and data file) so consumers who never engineer a build do not bundle
@@ -18,7 +18,7 @@ import './slots.js';
  * costs — though `ShipLoadout` carries both, since it prices a build as well as
  * engineering one.
  *
- * Keys are Frontier `fdname`s — normally the exact strings a journal `Loadout` event
+ * Keys are Frontier symbols — normally the exact strings a journal `Loadout` event
  * carries in `Engineering.BlueprintName` (e.g. `"FSD_LongRange"`), not the in-game display
  * names. **Three keys collide**: each is a recipe the game writes under an id another
  * record already answers to:
@@ -49,7 +49,7 @@ import './slots.js';
  */
 
 /**
- * Every blueprint, keyed by Frontier `fdname` (e.g. `"FSD_LongRange"`). Each is a
+ * Every blueprint, keyed by Frontier symbol (e.g. `"FSD_LongRange"`). Each is a
  * {@link Blueprint} — its display `name` and its per-grade `grades`, where each grade
  * carries its `features` (modifiers) and optional converted `damageDistribution`.
  *
@@ -65,9 +65,10 @@ import './slots.js';
  */
 declare const BLUEPRINTS: Readonly<Record<string, Blueprint>>;
 /**
- * Look up a blueprint by its Frontier `fdname`, case-insensitively.
+ * Look up a blueprint by its Frontier symbol, case-insensitively.
  *
- * @param fdname - The blueprint id, e.g. `"FSD_LongRange"`.
+ * @param blueprintSymbol - The blueprint id, e.g. `"FSD_LongRange"`. Leading/trailing
+ * whitespace and case are ignored.
  * @returns The blueprint (its `name` and `grades`), or `null` if this catalogue stores no
  * blueprint under that id.
  * @remarks
@@ -77,21 +78,22 @@ declare const BLUEPRINTS: Readonly<Record<string, Blueprint>>;
  * engineer — and are carried by the variants returned from
  * `getPreEngineeredVariants` in `ships/pre-engineered`. Their fixed modifiers still
  * change the fitted article's stats.
- * @throws {TypeError} If `fdname` is present and not a string. A nullish
- * `fdname` is a miss, answered the way an unrecognised one is.
+ * @throws {TypeError} If `blueprintSymbol` is present and not a string. A nullish
+ * `blueprintSymbol` is a miss, answered the way an unrecognised one is.
  */
-declare function getBlueprint(fdname: string): Blueprint | null;
+declare function getBlueprint(blueprintSymbol: string): Blueprint | null;
 /**
  * Look up one complete grade of a blueprint, case-insensitively.
  *
- * @param fdname - The blueprint id, e.g. `"FSD_LongRange"`.
+ * @param blueprintSymbol - The blueprint id, e.g. `"FSD_LongRange"`. Leading/trailing
+ * whitespace and case are ignored.
  * @param grade - The grade, `1`–`5`.
  * @returns The grade record — its modifier `features` and optional converted
  * `damageDistribution` — or `null` if the catalogue holds no such blueprint or grade.
  * See {@link getBlueprint} for what an absent blueprint can mean besides "unknown".
  * @throws {RangeError} If `grade` is not an integer from 1 through 5.
- * @throws {TypeError} If `fdname` is present and not a string. A nullish
- * `fdname` is a miss, answered the way an unrecognised one is.
+ * @throws {TypeError} If `blueprintSymbol` is present and not a string. A nullish
+ * `blueprintSymbol` is a miss, answered the way an unrecognised one is.
  * @example
  * ```ts
  * import { getBlueprintGrade } from '@elite-dangerous-almanac/core/ships/blueprints';
@@ -100,6 +102,6 @@ declare function getBlueprint(fdname: string): Blueprint | null;
  * grade?.features;  // -> [{ label: 'Integrity', ... }, ...]
  * ```
  */
-declare function getBlueprintGrade(fdname: string, grade: number): BlueprintGrade | null;
+declare function getBlueprintGrade(blueprintSymbol: string, grade: number): BlueprintGrade | null;
 
 export { BLUEPRINTS, getBlueprint, getBlueprintGrade };

package/dist/ships/blueprints.js

@@ -1 +1 @@
-export{BLUEPRINTS,getBlueprint,getBlueprintGrade}from"../chunk-Q3QCLNVG.js";                                                                                       //# sourceMappingURL=blueprints.js.map
+export{BLUEPRINTS,getBlueprint,getBlueprintGrade}from"../chunk-AYAKU4YA.js";                                                                                       //# sourceMappingURL=blueprints.js.map