@interstellar-tools/types 0.14.0 → 0.16.0

package/dist/index.d.ts

@@ -3,5 +3,6 @@ export * from './temporal';
 export * from './numeric';
 export * from './math';
 export * from './physics';
+export * from './orbits';
 export * from './celestial-bodies';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAE3B,cAAc,YAAY,CAAC;AAE3B,cAAc,WAAW,CAAC;AAE1B,cAAc,QAAQ,CAAC;AAEvB,cAAc,WAAW,CAAC;AAE1B,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAE3B,cAAc,YAAY,CAAC;AAE3B,cAAc,WAAW,CAAC;AAE1B,cAAc,QAAQ,CAAC;AAEvB,cAAc,WAAW,CAAC;AAE1B,cAAc,UAAU,CAAC;AAEzB,cAAc,oBAAoB,CAAC"}

package/dist/index.js

@@ -3,5 +3,6 @@ export * from './temporal';
 export * from './numeric';
 export * from './math';
 export * from './physics';
+export * from './orbits';
 export * from './celestial-bodies';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAE3B,cAAc,YAAY,CAAC;AAE3B,cAAc,WAAW,CAAC;AAE1B,cAAc,QAAQ,CAAC;AAEvB,cAAc,WAAW,CAAC;AAE1B,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAE3B,cAAc,YAAY,CAAC;AAE3B,cAAc,WAAW,CAAC;AAE1B,cAAc,QAAQ,CAAC;AAEvB,cAAc,WAAW,CAAC;AAE1B,cAAc,UAAU,CAAC;AAEzB,cAAc,oBAAoB,CAAC"}

package/dist/orbits.d.ts

@@ -0,0 +1,88 @@
+/**
+ * Clohessy–Wiltshire / Hill relative-motion **state vector** in the LVLH frame.
+ *
+ * Axes (LVLH / RSW-style):
+ * - `x`   — **radial** (outward from the central body / reference orbit radius)
+ * - `y`   — **along-track** / tangential (direction of motion of the reference orbit)
+ * - `z`   — **cross-track** (completes right-handed frame, roughly orbit-normal)
+ *
+ * Components:
+ * - `x`, `y`, `z` are relative position components.
+ * - `xDot`, `yDot`, `zDot` are relative velocity components (time derivatives).
+ *
+ * Units:
+ * - Positions in meters or kilometers (choose one and stay consistent).
+ * - Velocities in m/s or km/s accordingly.
+ *
+ * This tuple is commonly used as the state for integrating the CW/Hill ODEs.
+ *
+ * @example
+ * ```ts
+ * const s: CwState = [
+ *   100,   // x (m)
+ *   0,     // y (m)
+ *   0,     // z (m)
+ *   0,     // xDot (m/s)
+ *   0.01,  // yDot (m/s)
+ *   0      // zDot (m/s)
+ * ];
+ * ```
+ *
+ * @group Orbits
+ */
+export type CwState = readonly [
+    /** Radial relative position (outward). */
+    x: number,
+    /** Along-track relative position (tangential). */
+    y: number,
+    /** Cross-track relative position (orbit-normal). */
+    z: number,
+    /** Time derivative of `x` (radial relative velocity). */
+    xDot: number,
+    /** Time derivative of `y` (along-track relative velocity). */
+    yDot: number,
+    /** Time derivative of `z` (cross-track relative velocity). */
+    zDot: number
+];
+/**
+ * Time derivative of {@link CwState} for CW/Hill dynamics.
+ *
+ * Ordered as:
+ * - Position derivatives: `[xDot, yDot, zDot]`
+ * - Acceleration terms:   `[xDDot, yDDot, zDDot]`
+ *
+ * Units:
+ * - First three components: velocity (m/s or km/s).
+ * - Last three components: acceleration (m/s² or km/s²).
+ *
+ * Useful as the return type for an ODE RHS function, e.g. `cwHillDerivatives(state, n)`.
+ *
+ * @example
+ * ```ts
+ * const ds: CwStateDerivative = [
+ *   0,     // xDot (m/s)
+ *   0.01,  // yDot (m/s)
+ *   0,     // zDot (m/s)
+ *   0.0002,// xDDot (m/s²)
+ *   0,     // yDDot (m/s²)
+ *   0      // zDDot (m/s²)
+ * ];
+ * ```
+ *
+ * @group Orbits
+ */
+export type CwStateDerivative = readonly [
+    /** Time derivative of `x` (radial relative velocity). */
+    xDot: number,
+    /** Time derivative of `y` (along-track relative velocity). */
+    yDot: number,
+    /** Time derivative of `z` (cross-track relative velocity). */
+    zDot: number,
+    /** Time derivative of `xDot` (radial relative acceleration). */
+    xDDot: number,
+    /** Time derivative of `yDot` (along-track relative acceleration). */
+    yDDot: number,
+    /** Time derivative of `zDot` (cross-track relative acceleration). */
+    zDDot: number
+];
+//# sourceMappingURL=orbits.d.ts.map

package/dist/orbits.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"orbits.d.ts","sourceRoot":"","sources":["../src/orbits.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,MAAM,OAAO,GAAG,SAAS;IAC7B,0CAA0C;IAC1C,CAAC,EAAE,MAAM;IACT,kDAAkD;IAClD,CAAC,EAAE,MAAM;IACT,oDAAoD;IACpD,CAAC,EAAE,MAAM;IACT,yDAAyD;IACzD,IAAI,EAAE,MAAM;IACZ,8DAA8D;IAC9D,IAAI,EAAE,MAAM;IACZ,8DAA8D;IAC9D,IAAI,EAAE,MAAM;CACb,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,MAAM,iBAAiB,GAAG,SAAS;IACvC,yDAAyD;IACzD,IAAI,EAAE,MAAM;IACZ,8DAA8D;IAC9D,IAAI,EAAE,MAAM;IACZ,8DAA8D;IAC9D,IAAI,EAAE,MAAM;IACZ,gEAAgE;IAChE,KAAK,EAAE,MAAM;IACb,qEAAqE;IACrE,KAAK,EAAE,MAAM;IACb,qEAAqE;IACrE,KAAK,EAAE,MAAM;CACd,CAAC"}

package/dist/orbits.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=orbits.js.map

package/dist/orbits.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"orbits.js","sourceRoot":"","sources":["../src/orbits.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@interstellar-tools/types",
-  "version": "0.14.0",
+  "version": "0.16.0",
   "description": "Shared TypeScript types (e.g., 3D tuples, equation result interfaces) used across the monorepo to keep APIs predictable and safe.",
   "keywords": [
     "types",