@saber-usa/node-common 1.7.37 → 1.7.39

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@saber-usa/node-common",
-  "version": "1.7.37",
+  "version": "1.7.39",
   "description": "Common node functions for Saber",
   "main": "src/index.js",
   "type": "module",

package/src/astro.js

@@ -334,44 +334,80 @@ const orbitalMeanMotionRevPerDay = (aKm, muKm3s2) => {
 };
 
 /**
- * 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
+ * Classify orbit regime using JCO v1.0.0 primary period/eccentricity cuts
+ * (Orbit_Class_Definitions_v1.0.0_11Jun2024.csv).
+ *
+ * Documentation:
+ * https://unifieddatalibrary.com/scs/download?id=/CommunityData/JCO_DOK/JCO_JSON_Requirements/Orbit_Class_Definitions_v1.0.0_11Jun2024.xlsx
+ *
+ * Symbols (from the `orbit` argument, case-insensitive keys via lowerCaseObjectKeys):
+ * - e — eccentricity (dimensionless), where: `orbit.eccentricity`
+ * - T — orbital period (minutes), where: `orbit.period`
+ * - n — mean motion (revolutions per day), where: `orbit.meanmotion`
+ * - i — inclination (degrees), where: `orbit.inclination`
+ *
+ * Evaluation order:
+ *
+ * 1. e ≥ 0.25 → HEO (4)
+ * 2. 1300 < T < 1800 → GEO family: GeoStationary (256), GeoInclined (8), or GeoDrifter (512)
+ *    - 256 when 0.99 ≤ n ≤ 1.01 and i ≤ 0.01°
+ *    - 8 when 0.99 ≤ n ≤ 1.01 and i > 0.01°
+ *    - 512 for the remainder of the JCO GEO period window (near-geosync / drifters)
+ * 3. 600 < T < 900 → MEO (16)
+ * 4. T ≤ 225 → LEO (2)
+ * 5. else → Undetermined (1) — JCO OTHER, XGEO, and period gaps (no dedicated enums yet)
+ *
+ * Guards:
+ * - missing or undefined `orbit` → Undetermined (1)
+ * - missing e → Undetermined (1)
+ * - missing T, or T ≤ 0 → Undetermined (1)
+ * - GEO subclass (step 2) requires n and i; if either is missing → Undetermined (1)
+ *
  * @param {Object} orbit Object with keys eccentricity, inclination (deg), meanmotion (rev/day) and period (min)
- * @return {number} the regime index
+ * @return {number} REGIMES bitflag index (see constants.js)
  */
 const calcRegime = (orbit) => {
     if (!isDefined(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;
 };
 
 /**