@elite-dangerous-almanac/core 0.1.8 → 0.2.0

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