@interstellar-tools/types 0.2.0 → 0.3.0

package/dist/celestial-bodies/asteroid-belts.d.ts

@@ -8,7 +8,7 @@ import { CartesianCoordinatesInterface } from './planets';
  * - **Color and Opacity**: Used for visualization.
  * - **Orbit Path (Optional)**: Stores a precomputed path for asteroid positioning.
  *
- * @category Celestial Bodies
+ * @group Celestial Bodies
  */
 export interface AsteroidBeltInterface {
     /** Name of the asteroid belt. */
@@ -41,7 +41,7 @@ export interface AsteroidBeltInterface {
  *   density: 100,
  * };
  * ```
- * @category Celestial Bodies
+ * @group Celestial Bodies
  */
 export type AsteroidBeltsType = AsteroidBeltInterface[];
 //# sourceMappingURL=asteroid-belts.d.ts.map

package/dist/celestial-bodies/asteroids.d.ts

@@ -17,7 +17,7 @@ import { CartesianCoordinatesInterface } from './planets';
  *
  * :::
  *
- * @category Celestial Bodies
+ * @group Celestial Bodies
  */
 export type AsteroidType = 'main-belt asteroid' | 'near-earth asteroid' | 'trojan asteroid' | 'centaur' | 'trans-neptunian object';
 /**
@@ -32,7 +32,7 @@ export type AsteroidType = 'main-belt asteroid' | 'near-earth asteroid' | 'troja
  *
  * :::
  *
- * @category Celestial Bodies
+ * @group Celestial Bodies
  */
 export type AsteroidCategory = 'dwarf planet' | 'large asteroid' | 'amor group' | 'apollo group' | 'aten group' | 'atira group' | 'cybele group' | 'hilda group' | 'jupiter trojan' | 'plutino' | 'cubewano' | 'scattered disk object';
 /**
@@ -48,7 +48,7 @@ export type AsteroidCategory = 'dwarf planet' | 'large asteroid' | 'amor group'
  *
  * :::
  *
- * @category Celestial Bodies
+ * @group Celestial Bodies
  */
 export type AsteroidSpectralType = 'c-type' | 's-type' | 'v-type' | 'm-type' | 'b-type' | 'd-type' | 'p-type' | 'f-type' | 'g-type' | 'x-type' | 'e-type' | 'other';
 /**
@@ -80,7 +80,7 @@ export type AsteroidSpectralType = 'c-type' | 's-type' | 'v-type' | 'm-type' | '
  *
  * :::
  *
- * @category Celestial Bodies
+ * @group Celestial Bodies
  */
 export interface AsteroidInterface {
     /** Name of the asteroid (e.g., `"Ceres"`, `"Vesta"`). */
@@ -185,7 +185,7 @@ export interface AsteroidInterface {
 }
 /**
  * Convenience alias for a list of asteroids.
- * @category Celestial Bodies
+ * @group Celestial Bodies
  */
 export type AsteroidsType = AsteroidInterface[];
 //# sourceMappingURL=asteroids.d.ts.map

package/dist/celestial-bodies/celestial-bodies.d.ts

@@ -21,7 +21,7 @@ import { StarInterface, StarsType } from './stars';
  *   { name: 'Earth', type: 'planet', mass: 5.972e24 }
  * ];
  * ```
- * @category Celestial Bodies
+ * @group Celestial Bodies
  */
 export type CelestialBodiesType = StarsType | PlanetsType | MoonsType | CometsType | AsteroidsType;
 /**
@@ -39,7 +39,7 @@ export type CelestialBodiesType = StarsType | PlanetsType | MoonsType | CometsTy
  * ```ts
  * const earth: CelestialBodyType = { name: 'Earth', type: 'planet', mass: 5.972e24 };
  * ```
- * @category Celestial Bodies
+ * @group Celestial Bodies
  */
 export type CelestialBodyType = StarInterface | PlanetInterface | MoonInterface | CometInterface | AsteroidInterface;
 //# sourceMappingURL=celestial-bodies.d.ts.map

package/dist/celestial-bodies/comets.d.ts

@@ -18,7 +18,7 @@ import { CartesianCoordinatesInterface } from './planets';
  * - **Color (`color`)**: Used for visual representation.
  * - **Size (`size`)**: Scaled size for display (not the actual physical size).
  *
- * @category Celestial Bodies
+ * @group Celestial Bodies
  */
 export interface CometInterface {
     /** Name of the comet (e.g., "Halley", "Hale-Bopp"). */
@@ -88,7 +88,7 @@ export interface CometInterface {
  *   size: 1.2
  * };
  * ```
- * @category Celestial Bodies
+ * @group Celestial Bodies
  */
 export type CometsType = CometInterface[];
 //# sourceMappingURL=comets.d.ts.map

package/dist/celestial-bodies/galaxies.d.ts

@@ -17,7 +17,7 @@ import { DistanceInterface } from '../distance';
  *   y: { value: 0, unit: 'au' }
  * };
  * ```
- * @category Celestial Bodies
+ * @group Celestial Bodies
  */
 export interface BlackHoleInterface {
     /** Name of the central black hole. */
@@ -51,7 +51,7 @@ export interface BlackHoleInterface {
  *   blackHole: sagittariusA
  * };
  * ```
- * @category Celestial Bodies
+ * @group Celestial Bodies
  */
 export interface GalaxyInterface {
     /** Name of the galaxy. */
@@ -69,14 +69,14 @@ export interface GalaxyInterface {
  * Type alias for a collection of **galaxies**.
  *
  * @typedef {GalaxyInterface[]} GalaxiesType
- * @category Celestial Bodies
+ * @group Celestial Bodies
  */
 export type GalaxiesType = GalaxyInterface[];
 /**
  * Type alias for a collection of **black holes**.
  *
  * @typedef {BlackHoleInterface[]} BlackHolesType
- * @category Celestial Bodies
+ * @group Celestial Bodies
  */
 export type BlackHolesType = BlackHoleInterface[];
 //# sourceMappingURL=galaxies.d.ts.map

package/dist/celestial-bodies/moons.d.ts

@@ -30,7 +30,7 @@ import { CartesianCoordinatesInterface } from './planets';
  *   angle: 0,
  * };
  * ```
- * @category Celestial Bodies
+ * @group Celestial Bodies
  */
 export interface MoonInterface {
     /** Name of the moon (e.g., "Io", "Europa", "Titan"). */
@@ -69,7 +69,7 @@ export interface MoonInterface {
  * Type alias for a collection of **moons**.
  *
  * @typedef {MoonInterface[]} MoonsType
- * @category Celestial Bodies
+ * @group Celestial Bodies
  */
 export type MoonsType = MoonInterface[];
 //# sourceMappingURL=moons.d.ts.map

package/dist/celestial-bodies/planets.d.ts

@@ -11,7 +11,7 @@ import { TemporalInterface } from '../temporal';
  * ```ts
  * const position: CartesianCoordinatesInterface = { x: 100, y: 200 };
  * ```
- * @category Celestial Bodies
+ * @group Celestial Bodies
  */
 export interface CartesianCoordinatesInterface {
     x: number;
@@ -50,7 +50,7 @@ export interface CartesianCoordinatesInterface {
  *   z: { value: 0, unit: 'au' }
  * };
  * ```
- * @category Celestial Bodies
+ * @group Celestial Bodies
  */
 export interface PlanetInterface {
     /** Name of the planet (e.g., "Earth", "Mars"). */
@@ -90,7 +90,7 @@ export interface PlanetInterface {
  * Type alias for a collection of **planets**.
  *
  * @typedef {PlanetInterface[]} PlanetsType
- * @category Celestial Bodies
+ * @group Celestial Bodies
  */
 export type PlanetsType = PlanetInterface[];
 //# sourceMappingURL=planets.d.ts.map

package/dist/celestial-bodies/stars.d.ts

@@ -15,7 +15,7 @@ import { CartesianCoordinatesInterface } from './planets';
  *   type: 'planetary system'
  * };
  * ```
- * @category Celestial Bodies
+ * @group Celestial Bodies
  */
 export interface StarSystemInterface {
     name: string;
@@ -54,7 +54,7 @@ export interface StarSystemInterface {
  *   z: { value: 0, unit: 'au' }
  * };
  * ```
- * @category Celestial Bodies
+ * @group Celestial Bodies
  */
 export interface StarInterface {
     /** Name of the star. */
@@ -94,7 +94,7 @@ export interface StarInterface {
  * Type alias for a collection of **stars**.
  *
  * @typedef {StarInterface[]} StarsType
- * @category Celestial Bodies
+ * @group Celestial Bodies
  */
 export type StarsType = StarInterface[];
 //# sourceMappingURL=stars.d.ts.map

package/dist/celestial-bodies/systems.d.ts

@@ -1,6 +1,6 @@
 /**
  * Represents a star system within the space visualization.
- * @category Celestial Bodies
+ * @group Celestial Bodies
  */
 export interface SystemInterface {
     /** Name of the star system. */
@@ -12,7 +12,7 @@ export interface SystemInterface {
 }
 /**
  * Type alias for a collection of star systems.
- * @category Celestial Bodies
+ * @group Celestial Bodies
  */
 export type SystemsType = SystemInterface[];
 //# sourceMappingURL=systems.d.ts.map

package/dist/distance.d.ts

@@ -1,6 +1,6 @@
 import { ValueInterface } from './numeric';
 /**
- * @showCategories
+ *
  * @module
  */
 /**
@@ -36,7 +36,7 @@ import { ValueInterface } from './numeric';
  * @see https://www.iau.org/static/resolutions/IAU2012_English.pdf (IAU 2012 B2 - definition of the astronomical unit)
  * @see https://en.wikipedia.org/wiki/Light-year (Light-year based on Julian year)
  * @see https://en.wikipedia.org/wiki/Parsec (Parsec definition & meter equivalence)
- * @category Distance
+ * @group Distance
  */
 export type DistanceUnitType = 'm' | 'km' | 'au' | 'ly' | 'kly' | 'Mly' | 'Gly' | 'pc' | 'kpc' | 'Mpc' | 'Gpc';
 /**
@@ -75,7 +75,7 @@ export type DistanceUnitType = 'm' | 'km' | 'au' | 'ly' | 'kly' | 'Mly' | 'Gly'
  * @see https://www.iau.org/static/resolutions/IAU2012_English.pdf (IAU 2012 B2 - astronomical unit, symbol "au")
  * @see https://en.wikipedia.org/wiki/Light-year (Light-year; Julian-year convention)
  * @see https://en.wikipedia.org/wiki/Parsec (Parsec definition)
- * @category Distance
+ * @group Distance
  */
 export type DistanceUnitAliasType = 'meter' | 'meters' | 'metre' | 'metres' | 'kilometer' | 'kilometers' | 'kilometre' | 'kilometres' | 'AU' | 'Au' | 'astronomical-unit' | 'astronomical-units' | 'astronomical unit' | 'astronomical units' | 'lightyear' | 'lightyears' | 'light-year' | 'light-years' | 'kilolightyear' | 'kilolightyears' | 'kly' | 'megalightyear' | 'megalightyears' | 'Mly' | 'gigalightyear' | 'gigalightyears' | 'Gly' | 'parsec' | 'parsecs' | 'kiloparsec' | 'kiloparsecs' | 'kpc' | 'megaparsec' | 'megaparsecs' | 'Mpc' | 'gigaparsec' | 'gigaparsecs' | 'Gpc';
 /**
@@ -88,7 +88,7 @@ export type DistanceUnitAliasType = 'meter' | 'meters' | 'metre' | 'metres' | 'k
  * ```ts
  * const planetRadius: MeasureInterface = { value: 6371, unit: 'km' };
  * ```
- * @category Distance
+ * @group Distance
  */
 export interface MeasureInterface extends ValueInterface {
     unit: DistanceUnitType;
@@ -103,7 +103,7 @@ export interface MeasureInterface extends ValueInterface {
  * ```ts
  * const distanceToAlphaCentauri: DistanceInterface = { value: 4.367, unit: 'lightyears' };
  * ```
- * @category Distance
+ * @group Distance
  */
 export interface DistanceInterface extends ValueInterface {
     unit: DistanceUnitType;

package/dist/numeric.d.ts

@@ -1,5 +1,5 @@
 /**
- * @showCategories
+ *
  * @module
  */
 /**
@@ -11,7 +11,7 @@
  * ```ts
  * const distance: ValueInterface = { value: 100 };
  * ```
- * @category Numeric
+ * @group Numeric
  */
 export interface ValueInterface {
     value: number;
@@ -25,7 +25,7 @@ export interface ValueInterface {
  * ```ts
  * const angle: Radians = Math.PI / 2; // 90 degrees in radians
  * ```
- * @category Numeric
+ * @group Numeric
  */
 export type Radians = number;
 //# sourceMappingURL=numeric.d.ts.map

package/dist/numeric.js

@@ -1,5 +1,5 @@
 /**
- * @showCategories
+ *
  * @module
  */
 export {};

package/dist/physics.d.ts

@@ -27,9 +27,9 @@ import { Vector3DTupleType } from './math';
  * $$
  *
  * **Mappings to fields**
- * - `vector`  ↔ \( \mathbf F \)
- * - `magnitude` ↔ \( \|\mathbf F\| \)
- * - `direction` ↔ \( \hat{\mathbf r} \)
+ * - `vector`  ↔ ($  \mathbf F  $)
+ * - `magnitude` ↔ ($  \|\mathbf F\|  $)
+ * - `direction` ↔ ($  \hat{\mathbf r}  $)
  *
  * @property vector     Force vector on body 1 due to body 2 (N).
  * @property magnitude  Scalar magnitude of the force (N).
@@ -54,4 +54,44 @@ export interface ForceResultInterface {
     /** Unit direction from body 1 to body 2 (dimensionless). */
     readonly direction: Vector3DTupleType;
 }
+/**
+ * **Peri/apoapsis radii pair**.
+ *
+ * **Definitions**
+ *
+ * $$
+ * r_p = a(1-e),\qquad r_a = a(1+e)
+ * $$
+ *
+ * **Conic validity**
+ * - **Elliptic / circular** (($ a>0,\;0\le e<1 $)): both ($ r_p>0 $) and ($ r_a>0 $).
+ * - **Hyperbolic** (($ a<0,\;e>1 $)): ($ r_p = |a|(e-1) > 0 $) and **no apoapsis** (unbounded), so set `ra = null`.
+ * - **Parabolic** (($ e=1 $)) with finite ($ a $) is not represented; use parabolic relations or state vectors.
+ *
+ * **Units**
+ * - Values are in **meters (m)**.
+ *
+ * @property {number} rp Periapsis radius ($ r_p $) (m).
+ * @property {number|null} ra Apoapsis radius ($ r_a $) (m) for closed orbits; `null` for hyperbolic trajectories.
+ *
+ * @example
+ * ```ts
+ * // Elliptic example
+ * const radii: PeriApoRadiiType = { rp: 6930e3, ra: 7070e3 };
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Hyperbolic example - no apoapsis
+ * const flyby: PeriApoRadiiType = { rp: 10_000e3, ra: null };
+ * ```
+ *
+ * @see periApoapsisRadii - function that computes `{ rp, ra }` from `(a, e)`.
+ * @see https://en.wikipedia.org/wiki/Apsis
+ * @group Orbits
+ */
+export type PeriApoRadiiType = {
+    rp: number;
+    ra: number | null;
+};
 //# sourceMappingURL=physics.d.ts.map

package/dist/physics.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"physics.d.ts","sourceRoot":"","sources":["../src/physics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,QAAQ,CAAC;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,MAAM,WAAW,oBAAoB;IACnC,yDAAyD;IACzD,QAAQ,CAAC,MAAM,EAAE,iBAAiB,CAAC;IACnC,yDAAyD;IACzD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,4DAA4D;IAC5D,QAAQ,CAAC,SAAS,EAAE,iBAAiB,CAAC;CACvC"}
+{"version":3,"file":"physics.d.ts","sourceRoot":"","sources":["../src/physics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,QAAQ,CAAC;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,MAAM,WAAW,oBAAoB;IACnC,yDAAyD;IACzD,QAAQ,CAAC,MAAM,EAAE,iBAAiB,CAAC;IACnC,yDAAyD;IACzD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,4DAA4D;IAC5D,QAAQ,CAAC,SAAS,EAAE,iBAAiB,CAAC;CACvC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,CAAC"}

package/dist/temporal.d.ts

@@ -1,6 +1,6 @@
 import { ValueInterface } from './numeric';
 /**
- * @showCategories
+ *
  * @module
  */
 /**
@@ -30,7 +30,7 @@ import { ValueInterface } from './numeric';
  *
  * @see https://www.bipm.org/en/publications/si-brochure  ([SI](https://en.wikipedia.org/wiki/International_System_of_Units) Brochure - second & day)
  * @see https://en.wikipedia.org/wiki/Julian_year_(astronomy) (Julian year used for `yr`)
- * @category Temporal
+ * @group Temporal
  */
 export type TemporalUnitType = 's' | 'ms' | 'μs' | 'ns' | 'ps' | 'fs' | 'as' | 'zs' | 'ys' | 'min' | 'h' | 'd' | 'yr' | 'kyr' | 'Myr' | 'Gyr';
 /**
@@ -57,7 +57,7 @@ export type TemporalUnitType = 's' | 'ms' | 'μs' | 'ns' | 'ps' | 'fs' | 'as' |
  * @see https://www.bipm.org/en/publications/si-brochure ([SI](https://en.wikipedia.org/wiki/International_System_of_Units) Brochure - second & day)
  * @see https://en.wikipedia.org/wiki/Julian_year_(astronomy) (Julian year used for `yr`/`kyr`/`Myr`/`Gyr`)
  * @see https://en.wikipedia.org/wiki/Year#SI_multiples (Usage of `ka`/`Ma`/`Ga` vs `kyr`/`Myr`/`Gyr`)
- * @category Temporal
+ * @group Temporal
  */
 export type TemporalUnitAliasType = 'second' | 'seconds' | 'millisecond' | 'milliseconds' | 'microsecond' | 'microseconds' | 'us' | 'minute' | 'minutes' | 'hour' | 'hours' | 'day' | 'days' | 'year' | 'years' | 'yr' | 'yrs' | 'kiloyear' | 'kiloyears' | 'kyr' | 'megayear' | 'megayears' | 'megaannum' | 'megaannums' | 'Myr' | 'Ma' | 'gigayear' | 'gigayears' | 'gigaannum' | 'gigaannums' | 'Gyr' | 'Ga';
 /**
@@ -76,7 +76,7 @@ export type TemporalUnitAliasType = 'second' | 'seconds' | 'millisecond' | 'mill
  *
  *
  * @see {@link TemporalUnitType}
- * @category Temporal
+ * @group Temporal
  */
 export interface TemporalInterface extends ValueInterface {
     /** Canonical temporal unit symbol (case-sensitive). */
@@ -92,7 +92,7 @@ export interface TemporalInterface extends ValueInterface {
  * ```ts
  * const timeStep: TimeStepInterface = { value: 1, unit: 'day' };
  * ```
- * @category Temporal
+ * @group Temporal
  */
 export interface TimeStepInterface extends ValueInterface {
     unit: 'd';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@interstellar-tools/types",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "types",
   "keywords": [
     "types",