@saber-usa/node-common 1.7.36 → 1.7.38

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@saber-usa/node-common",
-  "version": "1.7.36",
+  "version": "1.7.38",
   "description": "Common node functions for Saber",
   "main": "src/index.js",
   "type": "module",
@@ -23,13 +23,13 @@
   "author": "Saber USA",
   "license": "ISC",
   "dependencies": {
-    "@aws-sdk/client-s3": "^3.1092.0",
+    "@aws-sdk/client-s3": "^3.1119.0",
     "date-fns": "^4.4.0",
     "lodash": "4.18.1",
     "mathjs": "^15.2.0",
     "pious-squid": "^2.3.0",
     "plotly": "^1.0.6",
-    "satellite.js": "^7.0.1",
+    "satellite.js": "^7.1.0",
     "solar-calculator": "^0.3.0",
     "three": "^0.185.1",
     "winston": "3.19.0"
@@ -41,16 +41,17 @@
     "@jest/globals": "^30.4.1",
     "@sonar/scan": "^5.0.0",
     "cross-env": "^10.1.0",
-    "eslint": "^10.7.0",
-    "eslint-plugin-jest": "^29.15.5",
-    "globals": "^17.7.0",
+    "eslint": "^10.9.1",
+    "eslint-plugin-jest": "^29.16.2",
+    "globals": "^17.11.0",
     "jest": "^30.4.2",
     "jest-diff": "^30.4.1",
     "nodemon": "3.1.14"
   },
   "overrides": {
     "braces": "3.0.3",
-    "brace-expansion": "2.1.2",
+    "brace-expansion": "2.1.4",
+    "js-yaml": "3.15.2",
     "lodash": "4.18.1"
   }
 }

package/src/astro.js

@@ -40,6 +40,7 @@ import {DEG2RAD,
     REGIMES,
     GRAV_CONST,
     EARTH_MASS,
+    MU,
     WGS72_EARTH_EQUATORIAL_RADIUS_KM,
     WGS84_EARTH_EQUATORIAL_RADIUS_KM,
     MILLIS_PER_DAY,
@@ -49,6 +50,7 @@ import TLEValidator from "./tle/TLEValidator.js";
 import MultiLineTLEValidator from "./tle/MultiLineTLEValidator.js";
 import {TLE_ERRORS} from "./tle/tleErrors.js";
 import {TleParseUtils} from "./tle/TleParseUtils.js";
+import {OrbitUtils} from "./OrbitUtils.js";
 
 // Solar Terminator
 // Returns sun latitude and longitude as -180/180
@@ -310,8 +312,34 @@ const getLonAndDrift = (line1, line2, datetime) => {
 };
 
 /**
- * Given eccentricity, inclination, meanmotion, and period
- * Calculates & returns type of orbit to include LEO, MEO, HEO, GEO Drifter, GEO Inclined,GEO Stationary, and undetermined if applicable
+ * Orbital period in minutes from semi-major axis and gravitational parameter.
+ * @param {number} aKm Semi-major axis (km)
+ * @param {number} muKm3s2 Standard gravitational parameter (km³/s²)
+ * @return {number|null} Period in minutes, or null if a ≤ 0
+ */
+const orbitalPeriodMinutes = (aKm, muKm3s2) => {
+    const periodSec = OrbitUtils.getPeriod(aKm, muKm3s2);
+    return periodSec === null ? null : periodSec / 60;
+};
+
+/**
+ * Mean motion in revolutions per day from semi-major axis and gravitational parameter.
+ * @param {number} aKm Semi-major axis (km)
+ * @param {number} muKm3s2 Standard gravitational parameter (km³/s²)
+ * @return {number} Mean motion in rev/day
+ */
+const orbitalMeanMotionRevPerDay = (aKm, muKm3s2) => {
+    const nRadS = OrbitUtils.getMeanMotion(aKm, muKm3s2);
+    return nRadS * 86400 / (2 * Math.PI);
+};
+
+/**
+ * Classify orbit regime using JCO v1.0.0 primary period/eccentricity cuts
+ * (Orbit_Class_Definitions_v1.0.0_11Jun2024.csv). Evaluation order matters:
+ * HEO first, then GEO family (1300–1800 min), MEO, LEO, else Undetermined.
+ * 
+ * Documentation available at: https://unifieddatalibrary.com/scs/download?id=/CommunityData/JCO_DOK/JCO_JSON_Requirements/Orbit_Class_Definitions_v1.0.0_11Jun2024.xlsx
+ *
  * @param {Object} orbit Object with keys eccentricity, inclination (deg), meanmotion (rev/day) and period (min)
  * @return {number} the regime index
  */
@@ -320,34 +348,43 @@ const calcRegime = (orbit) => {
         return REGIMES.Undetermined;
     }
 
-    const {eccentricity, inclination, meanmotion, period}
+    const {eccentricity: e, inclination: i, meanmotion: n, period: T}
         = lowerCaseObjectKeys(orbit);
 
-    if (!isDefined(meanmotion) && (!isDefined(period) || !isDefined(eccentricity))) {
+    if (!isDefined(e)) {
         return REGIMES.Undetermined;
     }
 
-    if (meanmotion >= 0.99 && meanmotion <= 1.01 && inclination <= 0.01) {
-        return REGIMES.GeoStationary;
+    if (e >= 0.25) {
+        return REGIMES.Heo;
     }
 
-    if (meanmotion >= 0.99 && meanmotion <= 1.01 && inclination > 0.01) {
-        return REGIMES.GeoInclined;
+    if (!isDefined(T) || T <= 0) {
+        return REGIMES.Undetermined;
     }
 
-    if (meanmotion >= 0.94 && meanmotion <= 1.06) {
+    if (T > 1300 && T < 1800) {
+        if (!isDefined(n) || !isDefined(i)) {
+            return REGIMES.Undetermined;
+        }
+        if (n >= 0.99 && n <= 1.01 && i <= 0.01) {
+            return REGIMES.GeoStationary;
+        }
+        if (n >= 0.99 && n <= 1.01 && i > 0.01) {
+            return REGIMES.GeoInclined;
+        }
         return REGIMES.GeoDrifter;
     }
 
-    if (period >= 600 && period <= 800 && eccentricity < 0.25) {
+    if (T > 600 && T < 900) {
         return REGIMES.Meo;
     }
 
-    if (meanmotion > 11.25 && eccentricity < 0.25) {
+    if (T <= 225) {
         return REGIMES.Leo;
     }
 
-    return eccentricity > 0.25 ? REGIMES.Heo : REGIMES.Undetermined;
+    return REGIMES.Undetermined;
 };
 
 /**
@@ -1748,11 +1785,9 @@ const cartesianToElsetElements = (pv, epoch) => {
         ArgOfPerigee: kepl.w,
     };
 
-    // Mean motion in radians per second
-    const mu = 3.986004418e14; // (m^3)/(s^2) WGS-84 Earth Mu
-    const meanMotion = Math.sqrt(mu/Math.pow((elset.SemiMajorAxis*1000), 3));
-
-    elset.MeanMotion = meanMotion / (2*Math.PI) * 60 * 60 * 24; // rads/s to revs per day
+    const muKm3s2 = MU / 1e9;
+    elset.MeanMotion = orbitalMeanMotionRevPerDay(elset.SemiMajorAxis, muKm3s2);
+    elset.Period = orbitalPeriodMinutes(elset.SemiMajorAxis, muKm3s2);
 
     const trueAnomaly = kepl.f;
 
@@ -1763,7 +1798,6 @@ const cartesianToElsetElements = (pv, epoch) => {
     // Compute Mean Anomaly from Eccentric Anomaly and Eccentricity
     elset.MeanAnomaly = (E - (elset.Eccentricity)*Math.sin(E)) * RAD2DEG;
 
-    elset.Period = 2*Math.PI/meanMotion / 60; // period in minutes
     elset.Apogee = elset.SemiMajorAxis * (1 + elset.Eccentricity); // km
     elset.Perigee = elset.SemiMajorAxis * (1 - elset.Eccentricity); // km
 
@@ -3590,6 +3624,8 @@ export {
 } from "satellite.js";
 export {
     calcRegime,
+    orbitalPeriodMinutes,
+    orbitalMeanMotionRevPerDay,
     altToRegime,
     cartesianToRIC,
     angleBetween3DCoords,

package/src/udl.js

@@ -5,11 +5,14 @@ import {
     getElsetUdlFromTle,
     getLonAndDrift,
     getRaanPrecession,
+    orbitalMeanMotionRevPerDay,
+    orbitalPeriodMinutes,
     raDecToAzEl,
     azElToRaDec,
     raDecToGeodetic,
     estimateSlantRange,
 } from "./astro.js";
+import {REGIMES, MU} from "./constants.js";
 import {lowerCaseObjectKeys, jsonArrayOrNull} from "./transform.js";
 import {isDefined} from "./utils.js";
 import _ from "lodash";
@@ -327,6 +330,28 @@ const getSVSatno = (udlRow) => {
     return null;
 };
 
+const computeStateRegimeFromKeplerians = (keplerians) => {
+    const {a, e, i} = keplerians;
+    if (!isDefined(a) || a <= 0 || !isDefined(e) || e >= 1) {
+        return REGIMES.Undetermined;
+    }
+
+    const muKm3s2 = MU / 1e9;
+    const period = orbitalPeriodMinutes(a, muKm3s2);
+    const meanmotion = orbitalMeanMotionRevPerDay(a, muKm3s2);
+
+    if (period === null) {
+        return REGIMES.Undetermined;
+    }
+
+    return calcRegime({
+        eccentricity: e,
+        inclination: i,
+        meanmotion,
+        period,
+    });
+};
+
 const udlToNpsState = (udlRow) => {
     const Xpos = _.get(udlRow, "xpos", null); // kilometers
     const Ypos = _.get(udlRow, "ypos", null);
@@ -351,6 +376,8 @@ const udlToNpsState = (udlRow) => {
         keplerians = cartesianToKeplerian(pos, vel);
     }
 
+    const regime = computeStateRegimeFromKeplerians(keplerians);
+
     const npsState = lowerCaseObjectKeys({
         satno: getSVSatno(udlRow),
         Epoch: fixDate(_.get(udlRow, "epoch", null)),
@@ -388,7 +415,7 @@ const udlToNpsState = (udlRow) => {
         Longitude: null,
         LonDriftDegreesPerDay: null,
         RaanPrecessionDegreesPerDay: null,
-        Regime: 1,
+        Regime: regime,
     });
     return npsState;
 };