@elite-dangerous-almanac/core 0.1.0-beta.1

package/dist/materials/materials.d.ts

@@ -0,0 +1,277 @@
+/**
+ * Engineering-material types and lookups.
+ *
+ * Elite Dangerous groups its engineering materials into three categories — raw,
+ * manufactured and encoded — each material carrying a **grade** ({@link MaterialGrade})
+ * and sitting in a **line** ({@link MaterialLine}: Chemical, Emission Data, the seven
+ * raw element families, …). This module holds the {@link Material} record shape, the
+ * grade ⇄ rarity mapping, and the functions that find one
+ * ({@link getMaterialBySymbol}, {@link getMaterialByName}, {@link materialsByGrade},
+ * {@link materialsInLine}, …).
+ *
+ * **Every lookup searches all 146 materials by default** — you do not have to hand it
+ * a catalogue:
+ *
+ * ```ts
+ * getMaterialByName('iron')?.grade; // -> MaterialGrade.VeryCommon (1)
+ * ```
+ *
+ * Each lookup takes an optional second argument to **narrow** the search to a
+ * subset — one category's catalogue, or any array you have filtered yourself:
+ *
+ * | Module | Export | Entries |
+ * | --- | --- | --- |
+ * | `./materials-raw` | `RAW_MATERIALS` | 28 |
+ * | `./materials-manufactured` | `MANUFACTURED_MATERIALS` | 71 |
+ * | `./materials-encoded` | `ENCODED_MATERIALS` | 47 |
+ * | `./materials-all` | `ALL_MATERIALS` | 146 (the default) |
+ *
+ * It narrows *results*, not bundle size: importing a lookup pulls all three
+ * catalogues, since that is what it falls back to — 16.9 KiB minified for all 146.
+ * {@link materialsInCategory} reaches the same subsets from a plain string.
+ *
+ * Data originates from EDCD FDevIDs, with Thargoid materials absent from that
+ * pinned source supplied by INARA; see [`data/materials/SOURCES.md`](https://github.com/DarkSession/Elite-Dangerous-Almanac/blob/main/data/materials/SOURCES.md).
+ *
+ * @example
+ * ```ts
+ * import { getMaterialByName, materialsInCategory } from '@elite-dangerous-almanac/core/materials';
+ *
+ * getMaterialByName('iron')?.grade;     // -> MaterialGrade.VeryCommon (1)
+ * materialsInCategory('raw').length;    // -> 28
+ * ```
+ *
+ * @packageDocumentation
+ */
+/** Which of the three engineering-material categories a material belongs to. */
+type MaterialCategory = 'raw' | 'manufactured' | 'encoded';
+/**
+ * A material grade, 1–5. **A material's grade is its rarity** — the members are named
+ * for the rarity each grade denotes, so there is no separate rarity field.
+ *
+ * @remarks
+ * Raw materials only reach {@link MaterialGrade.Rare} (4); grade 5 appears in the
+ * manufactured and encoded categories only. The numeric values match Frontier's own
+ * grading, so a `MaterialGrade` compares equal to the plain number (`grade === 5`).
+ * The member name is the rarity — read it with `MaterialGrade[grade]` (`"VeryCommon"`)
+ * if you need a string.
+ */
+declare enum MaterialGrade {
+    /** Grade 1 — Very Common. */
+    VeryCommon = 1,
+    /** Grade 2 — Common. */
+    Common = 2,
+    /** Grade 3 — Standard. */
+    Standard = 3,
+    /** Grade 4 — Rare. The highest grade a raw element reaches. */
+    Rare = 4,
+    /** Grade 5 — Very Rare. Manufactured and encoded materials only. */
+    VeryRare = 5
+}
+/**
+ * The in-game line (group) a material belongs to.
+ *
+ * @remarks
+ * The seven raw lines are named after their grade-1 element (Carbon, Phosphorus,
+ * Sulphur, Iron, Nickel, Rhenium, Lead). Manufactured and encoded materials use
+ * Frontier's group names. Guardian and Thargoid materials — which Frontier files
+ * outside the standard groups — are collected under {@link MaterialLine.Guardian}
+ * and {@link MaterialLine.Thargoid}.
+ */
+declare enum MaterialLine {
+    /** Raw element family, grades 1–4: Carbon, Vanadium, Niobium, Yttrium. */
+    Carbon = "Carbon",
+    /** Raw element family, grades 1–4, starting at Phosphorus. */
+    Phosphorus = "Phosphorus",
+    /** Raw element family, grades 1–4, starting at Sulphur. */
+    Sulphur = "Sulphur",
+    /** Raw element family, grades 1–4, starting at Iron. */
+    Iron = "Iron",
+    /** Raw element family, grades 1–4, starting at Nickel. */
+    Nickel = "Nickel",
+    /** Raw element family, grades 1–4, starting at Rhenium. */
+    Rhenium = "Rhenium",
+    /** Raw element family, grades 1–4, starting at Lead. */
+    Lead = "Lead",
+    /** Manufactured line, grades 1–5 (Chemical Storage Units → Chemical Manipulators). */
+    Chemical = "Chemical",
+    /** Manufactured line, grades 1–5 (Thermic alloys and processors). */
+    Thermic = "Thermic",
+    /** Manufactured line, grades 1–5 (heat conduction wiring → exchangers). */
+    Heat = "Heat",
+    /** Manufactured line, grades 1–5 (conductive components → polymers). */
+    Conductive = "Conductive",
+    /** Manufactured line, grades 1–5 (mechanical scrap → equipment). */
+    MechanicalComponents = "Mechanical Components",
+    /** Manufactured line, grades 1–5 (grid resistors → military supercapacitors). */
+    Capacitors = "Capacitors",
+    /** Manufactured line, grades 1–5 (worn shield emitters → imperial shielding). */
+    Shielding = "Shielding",
+    /** Manufactured line, grades 1–5 (compact composites → core dynamics composites). */
+    Composite = "Composite",
+    /** Manufactured line, grades 1–5 (crystal shards → exquisite focus crystals). */
+    Crystals = "Crystals",
+    /** Manufactured line, grades 1–5 (salvaged alloys → proto light alloys). */
+    Alloys = "Alloys",
+    /** Encoded line, grades 1–5 (exceptional scrambled emission data → abnormal compact emissions). */
+    EmissionData = "Emission Data",
+    /** Encoded line, grades 1–5 (atypical disrupted wake echoes → datamined wake exceptions). */
+    WakeScans = "Wake Scans",
+    /** Encoded line, grades 1–5 (distorted shield cycle recordings → inconsistent shield soak analysis). */
+    ShieldData = "Shield Data",
+    /** Encoded line, grades 1–5 (unusual encrypted files → adaptive encryptors capture). */
+    EncryptionFiles = "Encryption Files",
+    /** Encoded line, grades 1–5 (atypical encoded data → classified scan databanks). */
+    DataArchives = "Data Archives",
+    /** Encoded line, grades 1–5 (specialised legacy firmware → modified embedded firmware). */
+    EncodedFirmware = "Encoded Firmware",
+    /** Guardian technology materials, filed outside the standard lines. */
+    Guardian = "Guardian",
+    /** Thargoid materials (including the caustic/Titan set), outside the standard lines. */
+    Thargoid = "Thargoid"
+}
+/**
+ * One engineering material and how it is classified.
+ *
+ * @remarks
+ * A `Material` is a plain, frozen value object. `category` is derived from the
+ * catalogue the record lives in. There is no separate rarity field — the `grade` is
+ * the rarity (its {@link MaterialGrade} member name is the rarity tier).
+ */
+interface Material {
+    /** Which category this material belongs to. */
+    readonly category: MaterialCategory;
+    /**
+     * Frontier's internal symbol, e.g. `"GridResistors"` — the id the player journal
+     * reports (case-insensitively, so `"gridresistors"` matches). This is the same
+     * field, with the same meaning, as `symbol` on a ship or outfitting module.
+     */
+    readonly symbol: string;
+    /** Display name, e.g. `"Grid Resistors"`. */
+    readonly name: string;
+    /**
+     * The chemical element symbol for a raw material, e.g. `"Fe"` for Iron.
+     *
+     * @remarks
+     * Only raw materials — which are chemical elements — have one. Manufactured and
+     * encoded materials are `null`.
+     */
+    readonly elementSymbol: string | null;
+    /** The material grade, 1–5 (raw materials only reach 4) — this is its rarity. */
+    readonly grade: MaterialGrade;
+    /** The in-game line (group) this material sits in. */
+    readonly line: MaterialLine;
+}
+/**
+ * Look up a material by its Frontier symbol / journal id (case-insensitive).
+ *
+ * Here, `symbol` is Frontier's internal item id for the material.
+ *
+ * @param symbol - The internal symbol, e.g. `"GridResistors"`, or the lower-cased
+ * form the player journal reports (`"gridresistors"`).
+ * @param materials - Optional subset to search instead of all 146 materials —
+ * `RAW_MATERIALS`, `MANUFACTURED_MATERIALS`, `ENCODED_MATERIALS`, or any array you
+ * have filtered yourself. Omit it unless you specifically want to exclude the rest.
+ * @returns The matching {@link Material}, or `null` if no material has that symbol.
+ * @throws {TypeError} If `symbol` is present and not a string. A nullish
+ * `symbol` is a miss, answered the way an unrecognised one is.
+ * @example
+ * ```ts
+ * import { getMaterialBySymbol } from '@elite-dangerous-almanac/core/materials/materials';
+ *
+ * getMaterialBySymbol('temperedalloys')?.name; // -> 'Tempered Alloys'
+ * ```
+ */
+declare function getMaterialBySymbol(symbol: string, materials?: readonly Material[]): Material | null;
+/**
+ * Look up a material by its display name (case-insensitive).
+ *
+ * @param name - The display name as the catalogue spells it, e.g. `"Grid Resistors"`.
+ * @param materials - Optional subset to search (see {@link getMaterialBySymbol}).
+ * @returns The matching {@link Material}, or `null` if no material has that name.
+ * @throws {TypeError} If `name` is present and not a string. A nullish
+ * `name` is a miss, answered the way an unrecognised one is.
+ * @example
+ * ```ts
+ * import { getMaterialByName } from '@elite-dangerous-almanac/core/materials/materials';
+ *
+ * getMaterialByName('imperial shielding')?.grade; // -> 5
+ * ```
+ */
+declare function getMaterialByName(name: string, materials?: readonly Material[]): Material | null;
+/**
+ * Look up a raw material by its chemical element symbol (case-insensitive).
+ *
+ * @param elementSymbol - The element symbol, e.g. `"Fe"` or `"fe"`.
+ * @param materials - Optional subset to search (see {@link getMaterialBySymbol}).
+ * @returns The matching {@link Material}, or `null`. Only raw materials carry an
+ * element symbol, so a manufactured or encoded subset never matches.
+ * @throws {TypeError} If `elementSymbol` is present and not a string. A nullish
+ * `elementSymbol` is a miss, answered the way an unrecognised one is.
+ * @example
+ * ```ts
+ * import { getMaterialByElementSymbol } from '@elite-dangerous-almanac/core/materials/materials';
+ *
+ * getMaterialByElementSymbol('fe')?.name; // -> 'Iron'
+ * ```
+ */
+declare function getMaterialByElementSymbol(elementSymbol: string, materials?: readonly Material[]): Material | null;
+/**
+ * Every material of a given grade, in catalogue order.
+ *
+ * @param grade - The grade to match, 1–5 (or a {@link MaterialGrade} member).
+ * @param materials - Optional subset to search (see {@link getMaterialBySymbol}).
+ * @returns A new array of matches (possibly empty). The input is not modified.
+ * @example
+ * ```ts
+ * import { MaterialGrade, materialsByGrade } from '@elite-dangerous-almanac/core/materials/materials';
+ * import { RAW_MATERIALS } from '@elite-dangerous-almanac/core/materials/materials-raw';
+ *
+ * materialsByGrade(MaterialGrade.VeryRare).length;                 // -> across every category
+ * materialsByGrade(MaterialGrade.Rare, RAW_MATERIALS).length;      // -> 7, one per raw line
+ * ```
+ */
+declare function materialsByGrade(grade: MaterialGrade, materials?: readonly Material[]): Material[];
+/**
+ * Every material in a given line, in catalogue order.
+ *
+ * @param line - The line to match, e.g. `MaterialLine.Chemical`. A plain string of
+ * the line's value works too: leading/trailing whitespace and case are ignored, like
+ * every other lookup here.
+ * @param materials - Optional subset to search (see {@link getMaterialBySymbol}).
+ * @returns A new array of matches (possibly empty). The input is not modified.
+ * @throws {TypeError} If `line` is present and not a string. A nullish
+ * `line` is a miss, answered the way an unrecognised one is.
+ * @example
+ * ```ts
+ * import { MaterialLine, materialsInLine } from '@elite-dangerous-almanac/core/materials/materials';
+ *
+ * materialsInLine(MaterialLine.Chemical).map((m) => m.grade); // -> [1, 2, 3, 4, 5]
+ * ```
+ */
+declare function materialsInLine(line: string, materials?: readonly Material[]): Material[];
+/**
+ * Every material in a given category, in catalogue order.
+ *
+ * @remarks
+ * The same answer as importing that category's own catalogue module, reached from a
+ * string — which is what you have when the category came from a dropdown or a saved
+ * filter rather than from your own source code.
+ *
+ * @param category - The category to match: `'raw'`, `'manufactured'` or `'encoded'`.
+ * Leading/trailing whitespace and case are ignored, like every other lookup here.
+ * @param materials - Optional subset to search (see {@link getMaterialBySymbol}).
+ * @returns A new array of matches (possibly empty). The input is not modified.
+ * @throws {TypeError} If `category` is present and not a string. A nullish
+ * `category` is a miss, answered the way an unrecognised one is.
+ * @example
+ * ```ts
+ * import { materialsInCategory } from '@elite-dangerous-almanac/core/materials/materials';
+ *
+ * materialsInCategory('raw').length;          // -> 28
+ * materialsInCategory('Encoded').length;      // -> 47; case is ignored
+ * ```
+ */
+declare function materialsInCategory(category: string, materials?: readonly Material[]): Material[];
+
+export { type Material, type MaterialCategory, MaterialGrade, MaterialLine, getMaterialByElementSymbol, getMaterialByName, getMaterialBySymbol, materialsByGrade, materialsInCategory, materialsInLine };

package/dist/materials/materials.js

@@ -0,0 +1 @@
+export{MaterialGrade,MaterialLine,getMaterialByElementSymbol,getMaterialByName,getMaterialBySymbol,materialsByGrade,materialsInCategory,materialsInLine}from"../chunk-Q22LXT53.js";                                                                                                                                                                                                           //# sourceMappingURL=materials.js.map

package/dist/materials/materials.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"O"}

package/dist/materials/micro-resources-all.d.ts

@@ -0,0 +1,28 @@
+import { MicroResource } from './micro-resources.js';
+
+/**
+ * Every Odyssey micro resource — the component, consumable, data and item
+ * catalogues concatenated.
+ *
+ * Importing this pulls all four data modules; when you only need one category,
+ * import `COMPONENT_MICRO_RESOURCES`, `CONSUMABLE_MICRO_RESOURCES`,
+ * `DATA_MICRO_RESOURCES` or `ITEM_MICRO_RESOURCES` from their own module so a bundler
+ * can drop the rest.
+ *
+ * @packageDocumentation
+ */
+
+/**
+ * All 196 micro resources across every category — component, then consumable, then
+ * data, then item.
+ *
+ * @example
+ * ```ts
+ * import { ALL_MICRO_RESOURCES } from '@elite-dangerous-almanac/core/materials/micro-resources-all';
+ *
+ * ALL_MICRO_RESOURCES.length; // -> 196
+ * ```
+ */
+declare const ALL_MICRO_RESOURCES: readonly MicroResource[];
+
+export { ALL_MICRO_RESOURCES };

package/dist/materials/micro-resources-all.js

@@ -0,0 +1 @@
+export{ALL_MICRO_RESOURCES}from"../chunk-5H74FKY7.js";                                                                                                                                                                              //# sourceMappingURL=micro-resources-all.js.map

package/dist/materials/micro-resources-all.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"O"}

package/dist/materials/micro-resources-component.d.ts

@@ -0,0 +1,29 @@
+import { MicroResource } from './micro-resources.js';
+
+/**
+ * The catalogue of **component** micro resources — the manufactured parts spent
+ * upgrading suits and hand weapons at Pioneer Supplies.
+ *
+ * Search it with the query functions in `./micro-resources`.
+ *
+ * Data from EDCD FDevIDs (`microresources.csv`); see [`data/materials/SOURCES.md`](https://github.com/DarkSession/Elite-Dangerous-Almanac/blob/main/data/materials/SOURCES.md).
+ *
+ * @packageDocumentation
+ */
+
+/**
+ * All 33 component micro resources, in Frontier's registry order.
+ *
+ * @remarks
+ * Every record has `category: 'component'`. The array and its records are frozen.
+ *
+ * @example
+ * ```ts
+ * import { COMPONENT_MICRO_RESOURCES } from '@elite-dangerous-almanac/core/materials/micro-resources-component';
+ *
+ * COMPONENT_MICRO_RESOURCES.length; // -> 33
+ * ```
+ */
+declare const COMPONENT_MICRO_RESOURCES: readonly MicroResource[];
+
+export { COMPONENT_MICRO_RESOURCES };

package/dist/materials/micro-resources-component.js

@@ -0,0 +1 @@
+export{COMPONENT_MICRO_RESOURCES}from"../chunk-HTB52N6S.js";                                                          //# sourceMappingURL=micro-resources-component.js.map

package/dist/materials/micro-resources-component.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"O"}

package/dist/materials/micro-resources-consumable.d.ts

@@ -0,0 +1,29 @@
+import { MicroResource } from './micro-resources.js';
+
+/**
+ * The catalogue of **consumable** micro resources — the deployable field tools
+ * (medkits, energy cells, grenades, E-Breach) carried on foot.
+ *
+ * Search it with the query functions in `./micro-resources`.
+ *
+ * Data from EDCD FDevIDs (`microresources.csv`); see [`data/materials/SOURCES.md`](https://github.com/DarkSession/Elite-Dangerous-Almanac/blob/main/data/materials/SOURCES.md).
+ *
+ * @packageDocumentation
+ */
+
+/**
+ * All 6 consumable micro resources, in Frontier's registry order.
+ *
+ * @remarks
+ * Every record has `category: 'consumable'`. The array and its records are frozen.
+ *
+ * @example
+ * ```ts
+ * import { CONSUMABLE_MICRO_RESOURCES } from '@elite-dangerous-almanac/core/materials/micro-resources-consumable';
+ *
+ * CONSUMABLE_MICRO_RESOURCES.length; // -> 6
+ * ```
+ */
+declare const CONSUMABLE_MICRO_RESOURCES: readonly MicroResource[];
+
+export { CONSUMABLE_MICRO_RESOURCES };

package/dist/materials/micro-resources-consumable.js

@@ -0,0 +1 @@
+export{CONSUMABLE_MICRO_RESOURCES}from"../chunk-K7L7SMIR.js";                                                          //# sourceMappingURL=micro-resources-consumable.js.map

package/dist/materials/micro-resources-consumable.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"O"}

package/dist/materials/micro-resources-data.d.ts

@@ -0,0 +1,29 @@
+import { MicroResource } from './micro-resources.js';
+
+/**
+ * The catalogue of **data** micro resources — the intel and files downloaded,
+ * stolen or traded on foot.
+ *
+ * Search it with the query functions in `./micro-resources`.
+ *
+ * Data from EDCD FDevIDs (`microresources.csv`); see [`data/materials/SOURCES.md`](https://github.com/DarkSession/Elite-Dangerous-Almanac/blob/main/data/materials/SOURCES.md).
+ *
+ * @packageDocumentation
+ */
+
+/**
+ * All 114 data micro resources, in Frontier's registry order.
+ *
+ * @remarks
+ * Every record has `category: 'data'`. The array and its records are frozen.
+ *
+ * @example
+ * ```ts
+ * import { DATA_MICRO_RESOURCES } from '@elite-dangerous-almanac/core/materials/micro-resources-data';
+ *
+ * DATA_MICRO_RESOURCES.length; // -> 114
+ * ```
+ */
+declare const DATA_MICRO_RESOURCES: readonly MicroResource[];
+
+export { DATA_MICRO_RESOURCES };

package/dist/materials/micro-resources-data.js

@@ -0,0 +1 @@
+export{DATA_MICRO_RESOURCES}from"../chunk-RIT6MOO5.js";                                                          //# sourceMappingURL=micro-resources-data.js.map

package/dist/materials/micro-resources-data.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"O"}

package/dist/materials/micro-resources-item.d.ts

@@ -0,0 +1,29 @@
+import { MicroResource } from './micro-resources.js';
+
+/**
+ * The catalogue of **item** micro resources — the physical goods collected and
+ * traded on foot.
+ *
+ * Search it with the query functions in `./micro-resources`.
+ *
+ * Data from EDCD FDevIDs (`microresources.csv`); see [`data/materials/SOURCES.md`](https://github.com/DarkSession/Elite-Dangerous-Almanac/blob/main/data/materials/SOURCES.md).
+ *
+ * @packageDocumentation
+ */
+
+/**
+ * All 43 item micro resources, in Frontier's registry order.
+ *
+ * @remarks
+ * Every record has `category: 'item'`. The array and its records are frozen.
+ *
+ * @example
+ * ```ts
+ * import { ITEM_MICRO_RESOURCES } from '@elite-dangerous-almanac/core/materials/micro-resources-item';
+ *
+ * ITEM_MICRO_RESOURCES.length; // -> 43
+ * ```
+ */
+declare const ITEM_MICRO_RESOURCES: readonly MicroResource[];
+
+export { ITEM_MICRO_RESOURCES };

package/dist/materials/micro-resources-item.js

@@ -0,0 +1 @@
+export{ITEM_MICRO_RESOURCES}from"../chunk-CI3ACMRA.js";                                                          //# sourceMappingURL=micro-resources-item.js.map

package/dist/materials/micro-resources-item.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"O"}

package/dist/materials/micro-resources.d.ts

@@ -0,0 +1,136 @@
+/**
+ * Odyssey **micro resource** types and lookups.
+ *
+ * Elite Dangerous: Odyssey adds on-foot **micro resources** — the components, data,
+ * consumables and items a Commander carries on foot (distinct from the ship-side
+ * engineering {@link Material}s, which have a grade and a line). This module holds the
+ * {@link MicroResource} record shape and the functions that find one
+ * ({@link getMicroResourceBySymbol}, {@link getMicroResourceByName},
+ * {@link microResourcesInCategory}).
+ *
+ * **Every lookup searches all 196 micro resources by default** — you do not have to
+ * hand it a catalogue:
+ *
+ * ```ts
+ * getMicroResourceBySymbol('graphene')?.category; // -> 'component'
+ * ```
+ *
+ * Each lookup takes an optional second argument to **narrow** the search to a
+ * subset — one category's catalogue, or any array you have filtered yourself:
+ *
+ * | Module | Export | Entries |
+ * | --- | --- | --- |
+ * | `./micro-resources-component` | `COMPONENT_MICRO_RESOURCES` | 33 |
+ * | `./micro-resources-consumable` | `CONSUMABLE_MICRO_RESOURCES` | 6 |
+ * | `./micro-resources-data` | `DATA_MICRO_RESOURCES` | 114 |
+ * | `./micro-resources-item` | `ITEM_MICRO_RESOURCES` | 43 |
+ * | `./micro-resources-all` | `ALL_MICRO_RESOURCES` | 196 (the default) |
+ *
+ * It narrows *results*, not bundle size: importing a lookup pulls all four
+ * catalogues, since that is what it falls back to — 10.7 KiB minified for all 196.
+ * {@link microResourcesInCategory} reaches the same subsets from a plain string.
+ *
+ * Data originates from EDCD FDevIDs (`microresources.csv`); see
+ * [`data/materials/SOURCES.md`](https://github.com/DarkSession/Elite-Dangerous-Almanac/blob/main/data/materials/SOURCES.md).
+ *
+ * @example
+ * ```ts
+ * import { getMicroResourceBySymbol } from '@elite-dangerous-almanac/core/materials/micro-resources';
+ *
+ * getMicroResourceBySymbol('graphene')?.name; // -> 'Graphene'
+ * ```
+ *
+ * @packageDocumentation
+ */
+/**
+ * Frontier's micro-resource category — which on-foot inventory a micro resource
+ * belongs to.
+ *
+ * - `component` — the manufactured parts spent upgrading suits and hand weapons.
+ * - `consumable` — the deployable field tools (medkits, energy cells, grenades,
+ *   E-Breach).
+ * - `data` — the intel and files downloaded, stolen or traded on foot.
+ * - `item` — the physical goods collected and traded on foot.
+ */
+type MicroResourceCategory = 'component' | 'consumable' | 'data' | 'item';
+/**
+ * One Odyssey micro resource in Frontier's registry.
+ *
+ * @remarks
+ * A pure registry record — it tells you what a micro resource *is* (symbol, name,
+ * category), not where it is found or what it is worth. Unlike the ship-side
+ * {@link Material}, a micro resource has no grade or line.
+ */
+interface MicroResource {
+    /**
+     * Frontier's internal symbol, e.g. `"graphene"` — the id the player journal
+     * reports (case-insensitively). This is the same field, with the same meaning,
+     * as `symbol` on a ship, module or material.
+     */
+    readonly symbol: string;
+    /** Which on-foot inventory the micro resource belongs to. */
+    readonly category: MicroResourceCategory;
+    /** Display name, e.g. `"Graphene"`. */
+    readonly name: string;
+}
+/**
+ * Look up a micro resource by its Frontier symbol / journal id (case-insensitive).
+ *
+ * Here, `symbol` is Frontier's internal item id for the micro resource.
+ *
+ * @param symbol - The internal symbol, e.g. `"graphene"`, or the lower-cased form the
+ * player journal reports. Leading/trailing whitespace and case are ignored.
+ * @param microResources - Optional subset to search instead of all 196 micro
+ * resources — `COMPONENT_MICRO_RESOURCES`, `CONSUMABLE_MICRO_RESOURCES`,
+ * `DATA_MICRO_RESOURCES`, `ITEM_MICRO_RESOURCES`, or any array you have filtered
+ * yourself. Omit it unless you specifically want to exclude the rest.
+ * @returns The matching {@link MicroResource}, or `null` if no micro resource has
+ * that symbol.
+ * @throws {TypeError} If `symbol` is present and not a string. A nullish
+ * `symbol` is a miss, answered the way an unrecognised one is.
+ * @example
+ * ```ts
+ * import { getMicroResourceBySymbol } from '@elite-dangerous-almanac/core/materials/micro-resources';
+ *
+ * getMicroResourceBySymbol('circuitboard')?.name; // -> 'Circuit Board'
+ * ```
+ */
+declare function getMicroResourceBySymbol(symbol: string, microResources?: readonly MicroResource[]): MicroResource | null;
+/**
+ * Look up a micro resource by its display name (case-insensitive).
+ *
+ * @param name - The display name as the catalogue spells it, e.g. `"Circuit Board"`.
+ * Leading/trailing whitespace and case are ignored.
+ * @param microResources - Optional subset to search (see {@link getMicroResourceBySymbol}).
+ * @returns The matching {@link MicroResource}, or `null` if no micro resource has
+ * that name.
+ * @throws {TypeError} If `name` is present and not a string. A nullish
+ * `name` is a miss, answered the way an unrecognised one is.
+ * @example
+ * ```ts
+ * import { getMicroResourceByName } from '@elite-dangerous-almanac/core/materials/micro-resources';
+ *
+ * getMicroResourceByName('circuit board')?.symbol; // -> 'circuitboard'
+ * ```
+ */
+declare function getMicroResourceByName(name: string, microResources?: readonly MicroResource[]): MicroResource | null;
+/**
+ * Every micro resource in a given category, in catalogue order.
+ *
+ * @param category - The category to match, e.g. `'component'`. Leading/trailing
+ * whitespace and case are ignored, like every other lookup here.
+ * @param microResources - Optional subset to search (see {@link getMicroResourceBySymbol}).
+ * @returns A new array of matches (possibly empty). The input is not modified.
+ * @throws {TypeError} If `category` is present and not a string. A nullish
+ * `category` is a miss, answered the way an unrecognised one is.
+ * @example
+ * ```ts
+ * import { microResourcesInCategory } from '@elite-dangerous-almanac/core/materials/micro-resources';
+ *
+ * microResourcesInCategory('consumable').length; // -> 6
+ * microResourcesInCategory('Consumable').length; // -> 6; case is ignored
+ * ```
+ */
+declare function microResourcesInCategory(category: string, microResources?: readonly MicroResource[]): MicroResource[];
+
+export { type MicroResource, type MicroResourceCategory, getMicroResourceByName, getMicroResourceBySymbol, microResourcesInCategory };

package/dist/materials/micro-resources.js

@@ -0,0 +1 @@
+export{getMicroResourceByName,getMicroResourceBySymbol,microResourcesInCategory}from"../chunk-ELIZXUMI.js";                                                                                                                                                                                                                                                                     //# sourceMappingURL=micro-resources.js.map

package/dist/materials/micro-resources.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"O"}