@elite-dangerous-almanac/core 0.2.1 → 0.2.2

package/dist/astro/codex-region-lookup.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/astro/codex-region-lookup.ts"],"names":["getCodexRegion","boxelEdgeLy","decodeSystemAddress","galactic_region_cells_default","projection","x0","y0","z0","scaleNumerator","scaleDenominator","lyPerCell","gridWidth","gridHeight","regions","id","cells","minPz","rows","ROW_INDEX","index","Map","region","forEach","runs","i","pz","row","get","set","run","px","len","push","CODEX_REGION_MAP_X0","CODEX_REGION_MAP_Y0","CODEX_REGION_MAP_Z0","CODEX_REGION_MAP_LY_PER_CELL","regionIdAtCell","pxStart","pxEnd","findCodexRegionAt","point","Math","floor","x","z","findCodexRegionForBoxel","id64","sizeClass","absoluteBoxel","edge","y"],"mappings":"O,gzqMAkCA,IAAMI,WAAEA,WAAAS,QAAYA,SAAYV,8BAwBhC,IAAMe,UAAA,MACF,MAAMC,qBAAA,IAAYC,IAClB,IAAA,MAAWC,UAAUR,QAAS,CAC1B,MAAMG,MAAEA,MAAAC,KAAOA,MAASI,OAAON,MAC/BE,KAAKK,QAAQ,CAACC,KAAMC,KAChB,MAAMC,GAAKT,MAAQQ,EACnB,IAAIE,IAAMP,MAAMQ,IAAIF,IACpB,IAAKC,IAAK,CACNA,IAAM,GACNP,MAAMS,IAAIH,GAAIC,IAClB,CACA,IAAA,MAAWG,OAAON,KAAM,CACpB,MAAMO,GAAKD,IAAI,IAAM,EACrB,MAAME,IAAMF,IAAI,IAAM,EACtBH,IAAIM,KAAK,CAACF,GAAIA,GAAKC,IAAKV,OAAOP,IACnC,GAER,CACA,OAAOK,KACX,EAnBM,GAkCC,IAAMc,oBAAsB7B,WAAWC,GAWvC,IAAM6B,oBAAsB9B,WAAWE,GAWvC,IAAM6B,oBAAsB/B,WAAWG,GAWvC,IAAM6B,6BAA+BhC,WAAWM,UAgDvD,SAAS2B,eAAeP,GAAYL,IAChC,GAAIK,GAAK,GAAKL,GAAK,GAAKK,IAAM1B,WAAWO,WAAac,IAAMrB,WAAWQ,WAAY,CAC/E,OAAO,CACX,CACA,MAAMc,IAAMR,UAAUS,IAAIF,IAC1B,IAAKC,IAAK,OAAO,EAEjB,IAAA,MAAYY,QAASC,MAAOzB,MAAOY,IAAK,CACpC,GAAII,IAAMQ,SAAWR,GAAKS,MAAO,OAAOzB,EAC5C,CACA,OAAO,CACX,CAuBO,SAAS0B,kBAAkBC,OAC9B,MAAMX,GAAKY,KAAKC,OACVF,MAAMG,EAAIxC,WAAWC,IAAMD,WAAWI,eAAkBJ,WAAWK,kBAEzE,MAAMgB,GAAKiB,KAAKC,OACVF,MAAMI,EAAIzC,WAAWG,IAAMH,WAAWI,eAAkBJ,WAAWK,kBAEzE,OAAOT,eAAeqC,eAAeP,GAAIL,IAC7C,CA8BO,SAASqB,wBAAwBC,MACpC,MAAMC,UAAEA,UAAAC,cAAWA,eAAkB/C,oBAAoB6C,MACzD,MAAMG,KAAOjD,YAAY+C,WACzB,MAAMJ,EAAIK,cAAcL,EAAIM,KAAO9C,WAAWC,GAC9C,MAAM8C,EAAIF,cAAcE,EAAID,KAAO9C,WAAWE,GAC9C,MAAMuC,EAAII,cAAcJ,EAAIK,KAAO9C,WAAWG,GAC9C,MAAO,CAAEqC,IAAGO,IAAGN,IAAGxB,OAAQmB,kBAAkB,CAAEI,IAAGC,MACrD,QAAAT,6BAAAH,oBAAAC,oBAAAC,oBAAAK,kBAAAM"}
+{"version":3,"sources":["../../src/astro/codex-region-lookup.ts"],"names":["boxelEdgeLy","decodeSystemAddress","getCodexRegion","galactic_region_cells_default","projection","x0","y0","z0","scaleNumerator","scaleDenominator","lyPerCell","gridWidth","gridHeight","regions","id","cells","minPz","rows","ROW_INDEX","index","Map","region","forEach","runs","i","pz","row","get","set","run","px","len","push","CODEX_REGION_MAP_X0","CODEX_REGION_MAP_Y0","CODEX_REGION_MAP_Z0","CODEX_REGION_MAP_LY_PER_CELL","regionIdAtCell","pxStart","pxEnd","findCodexRegionAt","point","Math","floor","x","z","findCodexRegionForBoxel","id64","sizeClass","absoluteBoxel","edge","y"],"mappings":"O,gzqMAkCA,IAAMI,WAAEA,WAAAS,QAAYA,SAAYV,8BAwBhC,IAAMe,UAAA,MACF,MAAMC,qBAAA,IAAYC,IAClB,IAAA,MAAWC,UAAUR,QAAS,CAC1B,MAAMG,MAAEA,MAAAC,KAAOA,MAASI,OAAON,MAC/BE,KAAKK,QAAQ,CAACC,KAAMC,KAChB,MAAMC,GAAKT,MAAQQ,EACnB,IAAIE,IAAMP,MAAMQ,IAAIF,IACpB,IAAKC,IAAK,CACNA,IAAM,GACNP,MAAMS,IAAIH,GAAIC,IAClB,CACA,IAAA,MAAWG,OAAON,KAAM,CACpB,MAAMO,GAAKD,IAAI,IAAM,EACrB,MAAME,IAAMF,IAAI,IAAM,EACtBH,IAAIM,KAAK,CAACF,GAAIA,GAAKC,IAAKV,OAAOP,IACnC,GAER,CACA,OAAOK,KACX,EAnBM,GAkCC,IAAMc,oBAAsB7B,WAAWC,GAWvC,IAAM6B,oBAAsB9B,WAAWE,GAWvC,IAAM6B,oBAAsB/B,WAAWG,GAWvC,IAAM6B,6BAA+BhC,WAAWM,UAgDvD,SAAS2B,eAAeP,GAAYL,IAChC,GAAIK,GAAK,GAAKL,GAAK,GAAKK,IAAM1B,WAAWO,WAAac,IAAMrB,WAAWQ,WAAY,CAC/E,OAAO,CACX,CACA,MAAMc,IAAMR,UAAUS,IAAIF,IAC1B,IAAKC,IAAK,OAAO,EAEjB,IAAA,MAAYY,QAASC,MAAOzB,MAAOY,IAAK,CACpC,GAAII,IAAMQ,SAAWR,GAAKS,MAAO,OAAOzB,EAC5C,CACA,OAAO,CACX,CAuBO,SAAS0B,kBAAkBC,OAC9B,MAAMX,GAAKY,KAAKC,OACVF,MAAMG,EAAIxC,WAAWC,IAAMD,WAAWI,eAAkBJ,WAAWK,kBAEzE,MAAMgB,GAAKiB,KAAKC,OACVF,MAAMI,EAAIzC,WAAWG,IAAMH,WAAWI,eAAkBJ,WAAWK,kBAEzE,OAAOP,eAAemC,eAAeP,GAAIL,IAC7C,CA8BO,SAASqB,wBAAwBC,MACpC,MAAMC,UAAEA,UAAAC,cAAWA,eAAkBhD,oBAAoB8C,MACzD,MAAMG,KAAOlD,YAAYgD,WACzB,MAAMJ,EAAIK,cAAcL,EAAIM,KAAO9C,WAAWC,GAC9C,MAAM8C,EAAIF,cAAcE,EAAID,KAAO9C,WAAWE,GAC9C,MAAMuC,EAAII,cAAcJ,EAAIK,KAAO9C,WAAWG,GAC9C,MAAO,CAAEqC,IAAGO,IAAGN,IAAGxB,OAAQmB,kBAAkB,CAAEI,IAAGC,MACrD,QAAAT,6BAAAH,oBAAAC,oBAAAC,oBAAAK,kBAAAM"}

package/dist/astro/index.d.ts

@@ -24,6 +24,22 @@
  * the rest — {@link astro/nebulae-planetary!PLANETARY_NEBULAE | PLANETARY_NEBULAE} and
  * {@link astro/nebulae-all!ALL_NEBULAE | ALL_NEBULAE}.
  *
+ * **Bodies arrive as the journal writes them.** {@link BodyScanEvent} is the game's `Scan`
+ * event typed field for field — the record every journal reader, EDDN relay and body
+ * database already speaks — so a parsed line is already the right type and needs no
+ * adapter. Its `SystemAddress` is the same {@link SystemAddressInput} every address entry
+ * point takes.
+ *
+ * **The body calculations read {@link BodyProperties}, the physical half of that.** A
+ * `BodyScanEvent` is one, so a parsed line goes straight in; so does a record rebuilt from
+ * a database, because none of the journal's bookkeeping — `event`, `BodyID`, the discovery
+ * flags — is required. They work in the journal's own units and answer `null` rather than
+ * guess: {@link bulkDensity} and {@link rocheLimits} on `./body-physics`,
+ * {@link orbitExtents} and {@link spinOrbitResonance} on `./body-orbit`,
+ * {@link ringDynamics} on `./body-rings`, {@link classifyNeutronStar} and
+ * {@link mainSequenceLifetime} on `./star-physics`. A calculation comparing a body with
+ * the one it orbits takes both, since a scan names its parent only by `BodyID`.
+ *
  * **Coordinate spaces have different shapes.**
  * {@link GalacticPosition} is `{x, y, z}` in light-years with Sol at the origin — what the journal,
  * EDSM and Spansh report, and what {@link findHandAuthoredRegionAt} and
@@ -89,7 +105,7 @@
  * ```
  *
  * The catalogue argument is required here rather than defaulted: `ALL_NEBULAE` is
- * 431.7 KiB, so importing it must be your decision.
+ * ~432 KiB, so importing it must be your decision.
  *
  * @example
  * The two coordinate spaces, side by side. Light-years and sector indices are both
@@ -120,10 +136,31 @@
  * permitLockForSystemName('Synuefe EN-H d11-96'); // -> null       not locked at all
  * ```
  *
+ * @example
+ * Bodies: a journal `Scan` line goes in as it comes, and each calculation reads only the
+ * fields it needs — so a record with just a mass and a radius works too.
+ *
+ * ```ts
+ * import { bulkDensity, rocheLimits } from '@elite-dangerous-almanac/core/astro/body-physics';
+ * import { orbitExtents } from '@elite-dangerous-almanac/core/astro/body-orbit';
+ *
+ * const moon = { MassEM: 0.0123, Radius: 1_737_400, SemiMajorAxis: 3.844e8, Eccentricity: 0.0549 };
+ * const earth = { MassEM: 1, Radius: 6_371_000 };
+ *
+ * bulkDensity(moon); // -> 3343.7…
+ * orbitExtents(moon)?.periapsis; // -> 363296440
+ * rocheLimits(moon, earth)?.rigid; // -> 9483500.2…
+ * ```
+ *
  * @packageDocumentation
  */
 export { ProceduralSystem } from './procedural-system.js';
 export { G as GalacticPosition } from '../galactic-position-shLkm4Qg.js';
+export { A as AtmosphereComponent, B as BodyComposition, a as BodyParent, b as BodyProperties, c as BodyRing, d as BodyScanEvent, S as SurfaceMaterial } from '../body-scan-CEUYjCfH.js';
+export { GRAVITATIONAL_CONSTANT, KG_PER_EARTH_MASS, KG_PER_SOLAR_MASS, RocheLimits, bodyMass, bulkDensity, hillRadius, primaryAngularDiameter, rocheLimits, rocheLimitsForDensity } from './body-physics.js';
+export { EccentricityClass, OrbitExtents, SpinOrbitResonance, classifyEccentricity, equatorialVelocity, orbitExtents, spinOrbitResonance } from './body-orbit.js';
+export { RING_NOMINAL_RADIUS_FRACTION, RingDynamics, VISIBLE_RING_MAX_WIDTH, VISIBLE_RING_MIN_SURFACE_DENSITY, isInvisibleRing, ringDynamics, ringParticleDensity, ringRocheLimits, ringSurfaceDensity } from './body-rings.js';
+export { CHANDRASEKHAR_LIMIT_SOLAR_MASSES, MassStabilityAssessment, MassStabilityLimit, NEUTRON_STAR_MASS_DROP_OFF_SOLAR_MASSES, NeutronStarClass, SOLAR_RADIUS, SPEED_OF_LIGHT, TOV_LIMIT_SOLAR_MASSES, absoluteBolometricMagnitude, assessMassStability, classifyNeutronStar, mainSequenceLifetime, schwarzschildRadius } from './star-physics.js';
 export { BoxelLetters, IsProceduralSystemNameOptions, SystemNameParts, boxelCodeToLetters, canonicalizeSystemName, formatSystemName, isProceduralSystemName, lettersToBoxelCode, parseSystemName } from './system-name.js';
 export { A as AbsoluteBoxel, D as DecodedAddress, N as NamingRegionOrigin, S as SECTOR_INTERNAL_SIZE, a as absoluteBoxelToBoxelCode, b as boxelCodeToAbsoluteBoxel, c as boxelInternalSize, d as decodeModSystemAddress, e as decodeSystemAddress, f as encodeModSystemAddress, g as encodeSystemAddress, h as getHandAuthoredRegionOrigin, r as resolveNamingRegionOrigin } from '../system-address-cyJaeZIS.js';
 export { SystemAddressInput, toSystemAddress, tryToSystemAddress } from './system-address-input.js';

package/dist/astro/index.js

@@ -1 +1 @@
-export{getNebulaByName,nearestNebulae,nebulaeWithin}from"../chunk-L7CLUYZ6.js";export{isPermitLockedSystemName,permitLockForSystemName}from"../chunk-CIULJH3G.js";export{PERMIT_LOCKED_SYSTEMS,permitLockedSystemForAddress,permitLockedSystemForName}from"../chunk-BMT3U46U.js";export{ProceduralSystem}from"../chunk-TBZJIQ5P.js";export{boxelCodeToLetters,canonicalizeSystemName,formatSystemName,isProceduralSystemName,lettersToBoxelCode,parseSystemName}from"../chunk-7ATBEOVC.js";export{PERMIT_LOCKED_REGIONS,isPermitLockedRegionName,permitLockedRegionForSystemName}from"../chunk-NLBUKXNV.js";export{CODEX_REGIONS,getCodexRegion,getCodexRegionByName}from"../chunk-ADLVPKUV.js";export{GALAXY_ORIGIN,SECTOR_EDGE_LY,sectorGridPositionFromGalacticPosition,sectorNameFromGalacticPosition}from"../chunk-4QYTVSNR.js";export{HAND_AUTHORED_REGIONS,findHandAuthoredRegionAt}from"../chunk-AVZI6VKA.js";export{BASE_BOXEL_LY,MASS_CODE_COUNT,boxelEdgeLy,massCodeToSizeClass,sizeClassToMassCode}from"../chunk-POZTXBSN.js";export{getHandAuthoredRegionOrigin,resolveNamingRegionOrigin}from"../chunk-DWRNXUAX.js";export{SECTOR_INTERNAL_SIZE,absoluteBoxelToBoxelCode,boxelCodeToAbsoluteBoxel,boxelInternalSize,decodeModSystemAddress,decodeSystemAddress,encodeModSystemAddress,encodeSystemAddress}from"../chunk-DI5RXSJR.js";export{toSystemAddress,tryToSystemAddress}from"../chunk-NEEFT7WH.js";export{canonicalizeSectorName,sectorGridPositionFromName,sectorNameFromGridPosition}from"../chunk-H47K3UWG.js";                                                          export{PROCGEN_NEBULAE}from"../chunk-K7F6WC4T.js";export{REAL_NEBULAE}from"../chunk-HI7FCS3G.js";                                                          //# sourceMappingURL=index.js.map
+export{isPermitLockedSystemName,permitLockForSystemName}from"../chunk-CIULJH3G.js";export{PERMIT_LOCKED_SYSTEMS,permitLockedSystemForAddress,permitLockedSystemForName}from"../chunk-BMT3U46U.js";export{ProceduralSystem}from"../chunk-7TVFV3VO.js";export{CHANDRASEKHAR_LIMIT_SOLAR_MASSES,NEUTRON_STAR_MASS_DROP_OFF_SOLAR_MASSES,SOLAR_RADIUS,SPEED_OF_LIGHT,TOV_LIMIT_SOLAR_MASSES,absoluteBolometricMagnitude,assessMassStability,classifyNeutronStar,mainSequenceLifetime,schwarzschildRadius}from"../chunk-GBTCWNO6.js";export{boxelCodeToLetters,canonicalizeSystemName,formatSystemName,isProceduralSystemName,lettersToBoxelCode,parseSystemName}from"../chunk-7ATBEOVC.js";export{getHandAuthoredRegionOrigin,resolveNamingRegionOrigin}from"../chunk-DWRNXUAX.js";export{PROCGEN_NEBULAE}from"../chunk-K7F6WC4T.js";export{REAL_NEBULAE}from"../chunk-HI7FCS3G.js";                             export{getNebulaByName,nearestNebulae,nebulaeWithin}from"../chunk-L7CLUYZ6.js";export{PERMIT_LOCKED_REGIONS,isPermitLockedRegionName,permitLockedRegionForSystemName}from"../chunk-NLBUKXNV.js";export{classifyEccentricity,equatorialVelocity,orbitExtents,spinOrbitResonance}from"../chunk-ZZ376WHL.js";export{RING_NOMINAL_RADIUS_FRACTION,VISIBLE_RING_MAX_WIDTH,VISIBLE_RING_MIN_SURFACE_DENSITY,isInvisibleRing,ringDynamics,ringParticleDensity,ringRocheLimits,ringSurfaceDensity}from"../chunk-NEXDA73Y.js";export{GRAVITATIONAL_CONSTANT,KG_PER_EARTH_MASS,KG_PER_SOLAR_MASS,bodyMass,bulkDensity,hillRadius,primaryAngularDiameter,rocheLimits,rocheLimitsForDensity}from"../chunk-TMXKC6JL.js";                             export{BASE_BOXEL_LY,MASS_CODE_COUNT,boxelEdgeLy,massCodeToSizeClass,sizeClassToMassCode}from"../chunk-POZTXBSN.js";export{SECTOR_INTERNAL_SIZE,absoluteBoxelToBoxelCode,boxelCodeToAbsoluteBoxel,boxelInternalSize,decodeModSystemAddress,decodeSystemAddress,encodeModSystemAddress,encodeSystemAddress}from"../chunk-DI5RXSJR.js";export{toSystemAddress,tryToSystemAddress}from"../chunk-NEEFT7WH.js";export{CODEX_REGIONS,getCodexRegion,getCodexRegionByName}from"../chunk-ADLVPKUV.js";export{GALAXY_ORIGIN,SECTOR_EDGE_LY,sectorGridPositionFromGalacticPosition,sectorNameFromGalacticPosition}from"../chunk-4QYTVSNR.js";export{canonicalizeSectorName,sectorGridPositionFromName,sectorNameFromGridPosition}from"../chunk-H47K3UWG.js";                                                          export{HAND_AUTHORED_REGIONS,findHandAuthoredRegionAt}from"../chunk-AVZI6VKA.js";                             //# sourceMappingURL=index.js.map

package/dist/astro/nebulae.d.ts

@@ -16,10 +16,10 @@ import { G as GalacticPosition } from '../galactic-position-shLkm4Qg.js';
  *
  * | Module | Export | Entries | Minified | Gzipped |
  * | --- | --- | --- | --- | --- |
- * | `./nebulae-real` | `REAL_NEBULAE` | 180 | 16.4 KiB | 5.3 KiB |
- * | `./nebulae-procgen` | `PROCGEN_NEBULAE` | 166 | 16.4 KiB | 5.7 KiB |
- * | `./nebulae-planetary` | `PLANETARY_NEBULAE` | 5489 | 399.4 KiB | 116.0 KiB |
- * | `./nebulae-all` | `ALL_NEBULAE` | 5835 | 431.7 KiB | 126.5 KiB |
+ * | `./nebulae-real` | `REAL_NEBULAE` | 180 | ~16 KiB | ~5 KiB |
+ * | `./nebulae-procgen` | `PROCGEN_NEBULAE` | 166 | ~16 KiB | ~6 KiB |
+ * | `./nebulae-planetary` | `PLANETARY_NEBULAE` | 5489 | ~399 KiB | ~116 KiB |
+ * | `./nebulae-all` | `ALL_NEBULAE` | 5835 | ~432 KiB | ~127 KiB |
  *
  * Importing a query function from here costs nothing but the function: pass in
  * whichever catalogue you imported. The catalogue argument is **required** — 94% of

package/dist/astro/procedural-system.js

@@ -1 +1 @@
-export{ProceduralSystem}from"../chunk-TBZJIQ5P.js";                                                                                                                                                                                                                                                                                                                               //# sourceMappingURL=procedural-system.js.map
+export{ProceduralSystem}from"../chunk-7TVFV3VO.js";                                                                                                                                                                                                                                                                                                                               //# sourceMappingURL=procedural-system.js.map

package/dist/astro/star-physics.d.ts

@@ -0,0 +1,255 @@
+import { b as BodyProperties } from '../body-scan-CEUYjCfH.js';
+import './system-address-input.js';
+
+/**
+ * What a scanned star's own numbers imply: how long it should live, how bright it really
+ * is, how small it would have to be to become a black hole, what kind of pulsar it is, and
+ * when its mass says it should not exist at all.
+ *
+ * Every function takes {@link BodyProperties} — a journal `Scan` line as it comes, or any
+ * record carrying the same fields — and reads the star's own fields only. Masses are solar
+ * masses, radii metres, periods seconds, ages millions of years: the journal's units
+ * throughout. The type itself is exported from `../astro`, alongside `BodyScanEvent`.
+ *
+ * **These are order-of-magnitude astrophysics, and the game is procedural.** A relation
+ * like the main-sequence lifetime is a textbook scaling, not a measurement, and Elite
+ * Dangerous generates stars that sometimes sit outside what the relation allows. That is
+ * the point of {@link assessMassStability}: it names an implausibility, never a fact about
+ * a real star.
+ *
+ * The maths is ported from the Canonn Research Group's
+ * [canonn-signals](https://github.com/canonn-science/canonn-signals); see
+ * [ATTRIBUTIONS.md](https://github.com/DarkSession/Elite-Dangerous-Almanac/blob/main/ATTRIBUTIONS.md).
+ *
+ * @example
+ * ```ts
+ * import { mainSequenceLifetime } from '@elite-dangerous-almanac/core/astro/star-physics';
+ *
+ * // The Sun: about ten billion years on the main sequence.
+ * mainSequenceLifetime({ StellarMass: 1 }); // -> 10000
+ *
+ * // Twice the mass burns through it more than five times faster.
+ * mainSequenceLifetime({ StellarMass: 2 }); // -> 1767.7…
+ * ```
+ *
+ * @packageDocumentation
+ */
+
+/** Speed of light in vacuum, in m/s. */
+declare const SPEED_OF_LIGHT = 299792458;
+/** Metres in one nominal solar radius, for the magnitude relation below. */
+declare const SOLAR_RADIUS = 695700000;
+/**
+ * The Chandrasekhar limit, in solar masses — the most mass electron degeneracy pressure
+ * can hold up, and so the heaviest a white dwarf can be.
+ */
+declare const CHANDRASEKHAR_LIMIT_SOLAR_MASSES = 1.44;
+/**
+ * The Tolman–Oppenheimer–Volkoff limit, in solar masses — the theoretical ceiling on a
+ * neutron star, as constrained by the GW170817 neutron-star merger.
+ */
+declare const TOV_LIMIT_SOLAR_MASSES = 2.17;
+/**
+ * The mass, in solar masses, past which neutron stars become rare **in Elite Dangerous**.
+ *
+ * @remarks
+ * A figure from the game's own generated galaxy rather than from astronomy, and not a
+ * ceiling: the game does produce neutron stars above it. It is where the observed
+ * population drops off sharply, so a star past it is unusual even by the game's standards.
+ */
+declare const NEUTRON_STAR_MASS_DROP_OFF_SOLAR_MASSES = 2.51;
+/**
+ * Which mass threshold a star has passed: one of the two degeneracy-pressure ceilings, or
+ * the mass past which the game rarely generates neutron stars.
+ */
+type MassStabilityLimit = 'chandrasekhar' | 'tolman-oppenheimer-volkoff' | 'neutron-star-mass-drop-off';
+/** A star whose mass exceeds a limit its kind should not be able to exceed. */
+interface MassStabilityAssessment {
+    /** The limit that was passed. */
+    readonly limit: MassStabilityLimit;
+    /** That limit's value, in solar masses. */
+    readonly limitSolarMasses: number;
+    /**
+     * How far outside expectation the star is: `warning` for a neutron star past the
+     * theoretical TOV limit but still in the mass range the game generates freely, `danger`
+     * for a white dwarf past the Chandrasekhar limit, which should not be a white dwarf at
+     * all, or a neutron star past the mass where the game's own population drops off.
+     */
+    readonly severity: 'warning' | 'danger';
+}
+/**
+ * How a neutron star's spin classes it, in the scheme the Canonn tooling uses.
+ *
+ * @remarks
+ * The bands are cut at 10 ms, 5 s, 30 s and 1 hour of rotation period. `anomalous-mass-`
+ * marks a star above {@link TOV_LIMIT_SOLAR_MASSES}, and the two ultra-long-period bands
+ * are split by absolute magnitude rather than mass: brighter than 10 reads as a magnetar.
+ */
+type NeutronStarClass = 'millisecond-pulsar' | 'hyper-massive-millisecond-pulsar' | 'standard-pulsar' | 'anomalous-mass-pulsar' | 'slow-period-pulsar' | 'anomalous-mass-slow-period-pulsar' | 'ultra-long-period-magnetar' | 'ultra-long-period-pulsar' | 'anomalous-slow-rotator';
+/**
+ * How long a star of a given mass spends on the main sequence, in millions of years.
+ *
+ * @remarks
+ * The standard scaling `t ≈ 10 Gyr · (M/M☉)^−2.5`, anchored so that the Sun reads 10 Gyr.
+ * Mass is what sets a star's whole life: doubling it cuts the lifetime more than fivefold,
+ * because the star burns its larger fuel supply very much faster.
+ *
+ * Compare it against {@link BodyProperties.Age_MY | Age_MY} to judge a generated star. An
+ * ordinary star older than its own main-sequence lifetime should already have left it, and
+ * a giant younger than one should not yet have arrived.
+ *
+ * @param body - The star. Needs {@link BodyProperties.StellarMass | StellarMass}.
+ * @returns The lifetime in millions of years, or `null` when no usable stellar mass is
+ * written — which is the case for every planet, and for a scan that resolved nothing.
+ * @throws {TypeError} If `body` is not an object.
+ * @example
+ * ```ts
+ * import { mainSequenceLifetime } from '@elite-dangerous-almanac/core/astro/star-physics';
+ *
+ * mainSequenceLifetime({ StellarMass: 1 }); // -> 10000
+ *
+ * // A heavy blue star lives a few million years.
+ * mainSequenceLifetime({ StellarMass: 20 }); // -> 5.5…
+ *
+ * // A red dwarf outlives the universe many times over.
+ * mainSequenceLifetime({ StellarMass: 0.2 }); // -> 559016.9…
+ *
+ * mainSequenceLifetime({ MassEM: 1 }); // -> null
+ * ```
+ */
+declare function mainSequenceLifetime(body: BodyProperties): number | null;
+/**
+ * A star's absolute bolometric magnitude, worked out from how big and how hot it is.
+ *
+ * @remarks
+ * Stefan–Boltzmann gives the luminosity — `L/L☉ = (R/R☉)² · (T/T☉)⁴` — and the magnitude
+ * follows as `M☉ − 2.5 log₁₀(L/L☉)`.
+ *
+ * The reason to compute one when the scan usually reports
+ * {@link BodyProperties.AbsoluteMagnitude | AbsoluteMagnitude} directly is that some stars
+ * carry no magnitude at all: a white dwarf is written with a radius and a temperature and
+ * nothing else to place it by. The two figures are not interchangeable — this is
+ * bolometric, over all wavelengths, while a reported magnitude is closer to visual — so
+ * expect them to differ by a magnitude or so on a very hot or very cool star, and use this
+ * as the fallback rather than the correction.
+ *
+ * @param body - The star. Needs {@link BodyProperties.Radius | Radius} in metres and
+ * {@link BodyProperties.SurfaceTemperature | SurfaceTemperature} in kelvin.
+ * @returns The absolute bolometric magnitude — smaller is brighter, and a luminous star is
+ * negative — or `null` when either field is missing.
+ * @throws {TypeError} If `body` is not an object.
+ * @example
+ * ```ts
+ * import { absoluteBolometricMagnitude } from '@elite-dangerous-almanac/core/astro/star-physics';
+ *
+ * // A star the size and temperature of the Sun is the Sun's magnitude.
+ * absoluteBolometricMagnitude({ Radius: 695_700_000, SurfaceTemperature: 5772 }); // -> 4.74
+ *
+ * // An Earth-sized white dwarf at 15 000 K: faint despite being fiercely hot.
+ * absoluteBolometricMagnitude({ Radius: 6_371_000, SurfaceTemperature: 15_000 }); // -> 10.78…
+ * ```
+ */
+declare function absoluteBolometricMagnitude(body: BodyProperties): number | null;
+/**
+ * The Schwarzschild radius for a body's mass, in metres.
+ *
+ * @remarks
+ * `r_s = 2GM/c²`. For a black hole this is the event horizon itself, and the game reports
+ * no radius for one; for anything else it is how small that mass would have to be squeezed
+ * to become one, which is what makes it worth comparing against a neutron star's actual
+ * radius — the ratio is how close the star sits to collapse.
+ *
+ * @param body - The body. Needs a mass — see `bodyMass` in `./body-physics`. Stars are the
+ * bodies this is asked about, but the relation is general and a planet's mass answers too.
+ * @returns The radius in metres, or `null` when no usable mass is written.
+ * @throws {TypeError} If `body` is not an object.
+ * @example
+ * ```ts
+ * import { schwarzschildRadius } from '@elite-dangerous-almanac/core/astro/star-physics';
+ *
+ * // The Sun would have to fit inside about 3 km.
+ * schwarzschildRadius({ StellarMass: 1 }); // -> 2954.1…
+ *
+ * // A neutron star of two solar masses sits a few times outside its own horizon.
+ * schwarzschildRadius({ StellarMass: 2 }); // -> 5908.2…
+ * ```
+ */
+declare function schwarzschildRadius(body: BodyProperties): number | null;
+/**
+ * Whether a degenerate star's mass exceeds what its kind can hold up.
+ *
+ * @remarks
+ * A white dwarf is supported by electron degeneracy pressure and a neutron star by neutron
+ * degeneracy pressure, and each gives out at a mass: past the Chandrasekhar limit a white
+ * dwarf should collapse or detonate, past the TOV limit a neutron star should become a
+ * black hole. Elite Dangerous generates stars that sometimes sit beyond both, and this is
+ * what says so.
+ *
+ * The kind is read from {@link BodyProperties.StarType | StarType}, which the journal
+ * writes as `"N"` for a neutron star and `"D"`-prefixed for the white-dwarf classes
+ * (`"D"`, `"DA"`, `"DAB"`, …). Black holes are outside this: `"H"` has already collapsed,
+ * so no ceiling is left for it to breach.
+ *
+ * @param body - The star. Needs {@link BodyProperties.StarType | StarType} and
+ * {@link BodyProperties.StellarMass | StellarMass}.
+ * @returns The limit passed and how far outside expectation that puts the star, or `null`
+ * when the star is within its limits, is not a degenerate object, or carries no mass.
+ * @throws {TypeError} If `body` is not an object.
+ * @example
+ * ```ts
+ * import { assessMassStability } from '@elite-dangerous-almanac/core/astro/star-physics';
+ *
+ * // An ordinary neutron star is unremarkable.
+ * assessMassStability({ StarType: 'N', StellarMass: 1.8 }); // -> null
+ *
+ * // Past the theoretical ceiling, but in the range the game generates freely.
+ * assessMassStability({ StarType: 'N', StellarMass: 2.3 })?.severity; // -> 'warning'
+ *
+ * // A white dwarf this heavy should not be a white dwarf.
+ * assessMassStability({ StarType: 'DA', StellarMass: 1.6 })?.limit; // -> 'chandrasekhar'
+ * ```
+ */
+declare function assessMassStability(body: BodyProperties): MassStabilityAssessment | null;
+/**
+ * What kind of pulsar a neutron star's spin makes it.
+ *
+ * @remarks
+ * A neutron star is classed by how fast it turns, from a millisecond pulsar whipping round
+ * a hundred times a second to a slow rotator barely turning at all. Rotation is a
+ * magnitude here: the journal writes retrograde rotation as a negative
+ * {@link BodyProperties.RotationPeriod | RotationPeriod}, and which way a pulsar spins does
+ * not change what it is.
+ *
+ * The scheme is Canonn's, not astronomy's — it exists to give the game's generated neutron
+ * stars useful names, and the `anomalous-mass-` bands mark stars the game produced above
+ * the theoretical mass ceiling.
+ *
+ * @param body - The star. Needs {@link BodyProperties.StellarMass | StellarMass},
+ * {@link BodyProperties.RotationPeriod | RotationPeriod} and
+ * {@link BodyProperties.AbsoluteMagnitude | AbsoluteMagnitude} — the magnitude only to
+ * separate a magnetar from a pulsar at the slow end, but it is required throughout so the
+ * answer never depends on which band the star happened to land in.
+ * @returns The class, or `null` when any of the three is missing. This does not check
+ * {@link BodyProperties.StarType | StarType}: hand it a neutron star, since the bands mean
+ * nothing for anything else.
+ * @throws {TypeError} If `body` is not an object.
+ * @example
+ * ```ts
+ * import { classifyNeutronStar } from '@elite-dangerous-almanac/core/astro/star-physics';
+ *
+ * // Twenty turns a second.
+ * classifyNeutronStar({ StellarMass: 1.5, RotationPeriod: 0.05, AbsoluteMagnitude: 12 });
+ * // -> 'standard-pulsar'
+ *
+ * // The same spin, but heavier than the TOV limit allows.
+ * classifyNeutronStar({ StellarMass: 2.4, RotationPeriod: 0.05, AbsoluteMagnitude: 12 });
+ * // -> 'anomalous-mass-pulsar'
+ *
+ * // Half an hour per turn, and bright with it.
+ * classifyNeutronStar({ StellarMass: 1.5, RotationPeriod: 1800, AbsoluteMagnitude: 8 });
+ * // -> 'ultra-long-period-magnetar'
+ * ```
+ */
+declare function classifyNeutronStar(body: BodyProperties): NeutronStarClass | null;
+
+export { CHANDRASEKHAR_LIMIT_SOLAR_MASSES, type MassStabilityAssessment, type MassStabilityLimit, NEUTRON_STAR_MASS_DROP_OFF_SOLAR_MASSES, type NeutronStarClass, SOLAR_RADIUS, SPEED_OF_LIGHT, TOV_LIMIT_SOLAR_MASSES, absoluteBolometricMagnitude, assessMassStability, classifyNeutronStar, mainSequenceLifetime, schwarzschildRadius };

package/dist/astro/star-physics.js

@@ -0,0 +1 @@
+export{CHANDRASEKHAR_LIMIT_SOLAR_MASSES,NEUTRON_STAR_MASS_DROP_OFF_SOLAR_MASSES,SOLAR_RADIUS,SPEED_OF_LIGHT,TOV_LIMIT_SOLAR_MASSES,absoluteBolometricMagnitude,assessMassStability,classifyNeutronStar,mainSequenceLifetime,schwarzschildRadius}from"../chunk-GBTCWNO6.js";                                                                                       //# sourceMappingURL=star-physics.js.map

package/dist/astro/star-physics.js.map

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