ootk 4.0.9 → 5.1.0

package/dist/sgp4/index.js

@@ -0,0 +1,24 @@
+/**
+ * @author @thkruz Theodore Kruczek
+ * @description Orbital Object ToolKit (ootk) is a collection of tools for working
+ * with satellites and other orbital objects.
+ * @license AGPL-3.0-or-later
+ * @copyright (c) 2025 Kruczek Labs LLC
+ *
+ * Many of the classes are based off of the work of @david-rc-dayton and his
+ * Pious Squid library (https://github.com/david-rc-dayton/pious_squid) which
+ * is licensed under the MIT license.
+ *
+ * Orbital Object ToolKit is free software: you can redistribute it and/or modify it under the
+ * terms of the GNU Affero General Public License as published by the Free Software
+ * Foundation, either version 3 of the License, or (at your option) any later version.
+ *
+ * Orbital Object ToolKit is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
+ * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License along with
+ * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
+ */
+export { Sgp4 } from './sgp4.js';
+//# sourceMappingURL=index.js.map

package/dist/sgp4/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/sgp4/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC"}

package/dist/sgp4/sgp4-error.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Improved error handling for SGP4
+ */
+export declare enum Sgp4ErrorCode {
+    NO_ERROR = 0,
+    MEAN_ELEMENTS_INVALID = 1,// ecc >= 1.0 or ecc < -0.001 or a < 0.95 er
+    MEAN_MOTION_NEGATIVE = 2,// mean motion less than 0.0
+    PERT_ELEMENTS_INVALID = 3,// pert elements, ecc < 0.0 or ecc > 1.0
+    SEMI_LATUS_RECTUM_NEGATIVE = 4,// semi-latus rectum < 0.0
+    EPOCH_ELEMENTS_SUBORBITAL = 5,// epoch elements are sub-orbital
+    SATELLITE_DECAYED = 6
+}
+export declare class Sgp4Error extends Error {
+    code: Sgp4ErrorCode;
+    constructor(code: Sgp4ErrorCode, message?: string);
+    static getDefaultMessage(code: Sgp4ErrorCode): string;
+}
+export interface Sgp4Result<T> {
+    success: boolean;
+    value?: T;
+    error?: Sgp4Error;
+}

package/dist/sgp4/sgp4-error.js

@@ -0,0 +1,44 @@
+/**
+ * Improved error handling for SGP4
+ */
+// Define specific error types
+export var Sgp4ErrorCode;
+(function (Sgp4ErrorCode) {
+    Sgp4ErrorCode[Sgp4ErrorCode["NO_ERROR"] = 0] = "NO_ERROR";
+    Sgp4ErrorCode[Sgp4ErrorCode["MEAN_ELEMENTS_INVALID"] = 1] = "MEAN_ELEMENTS_INVALID";
+    Sgp4ErrorCode[Sgp4ErrorCode["MEAN_MOTION_NEGATIVE"] = 2] = "MEAN_MOTION_NEGATIVE";
+    Sgp4ErrorCode[Sgp4ErrorCode["PERT_ELEMENTS_INVALID"] = 3] = "PERT_ELEMENTS_INVALID";
+    Sgp4ErrorCode[Sgp4ErrorCode["SEMI_LATUS_RECTUM_NEGATIVE"] = 4] = "SEMI_LATUS_RECTUM_NEGATIVE";
+    Sgp4ErrorCode[Sgp4ErrorCode["EPOCH_ELEMENTS_SUBORBITAL"] = 5] = "EPOCH_ELEMENTS_SUBORBITAL";
+    Sgp4ErrorCode[Sgp4ErrorCode["SATELLITE_DECAYED"] = 6] = "SATELLITE_DECAYED"; // satellite has decayed
+})(Sgp4ErrorCode || (Sgp4ErrorCode = {}));
+// Error class for SGP4 errors
+export class Sgp4Error extends Error {
+    code;
+    constructor(code, message) {
+        super(message ?? Sgp4Error.getDefaultMessage(code));
+        this.name = 'Sgp4Error';
+        this.code = code;
+    }
+    static getDefaultMessage(code) {
+        switch (code) {
+            case Sgp4ErrorCode.NO_ERROR:
+                return 'No error';
+            case Sgp4ErrorCode.MEAN_ELEMENTS_INVALID:
+                return 'Mean elements invalid: eccentricity out of range or semi-major axis too small';
+            case Sgp4ErrorCode.MEAN_MOTION_NEGATIVE:
+                return 'Mean motion is negative';
+            case Sgp4ErrorCode.PERT_ELEMENTS_INVALID:
+                return 'Perturbed elements invalid: eccentricity out of range';
+            case Sgp4ErrorCode.SEMI_LATUS_RECTUM_NEGATIVE:
+                return 'Semi-latus rectum is negative';
+            case Sgp4ErrorCode.EPOCH_ELEMENTS_SUBORBITAL:
+                return 'Epoch elements are sub-orbital';
+            case Sgp4ErrorCode.SATELLITE_DECAYED:
+                return 'Satellite has decayed';
+            default:
+                return `Unknown error code: ${code}`;
+        }
+    }
+}
+//# sourceMappingURL=sgp4-error.js.map

package/dist/sgp4/sgp4-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sgp4-error.js","sourceRoot":"","sources":["../../src/sgp4/sgp4-error.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,8BAA8B;AAC9B,MAAM,CAAN,IAAY,aAQX;AARD,WAAY,aAAa;IACvB,yDAAY,CAAA;IACZ,mFAAyB,CAAA;IACzB,iFAAwB,CAAA;IACxB,mFAAyB,CAAA;IACzB,6FAA8B,CAAA;IAC9B,2FAA6B,CAAA;IAC7B,2EAAqB,CAAA,CAAC,wBAAwB;AAChD,CAAC,EARW,aAAa,KAAb,aAAa,QAQxB;AAED,8BAA8B;AAC9B,MAAM,OAAO,SAAU,SAAQ,KAAK;IAClC,IAAI,CAAgB;IAEpB,YAAY,IAAmB,EAAE,OAAgB;QAC/C,KAAK,CAAC,OAAO,IAAI,SAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC;QACpD,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,MAAM,CAAC,iBAAiB,CAAC,IAAmB;QAC1C,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,aAAa,CAAC,QAAQ;gBACzB,OAAO,UAAU,CAAC;YACpB,KAAK,aAAa,CAAC,qBAAqB;gBACtC,OAAO,+EAA+E,CAAC;YACzF,KAAK,aAAa,CAAC,oBAAoB;gBACrC,OAAO,yBAAyB,CAAC;YACnC,KAAK,aAAa,CAAC,qBAAqB;gBACtC,OAAO,uDAAuD,CAAC;YACjE,KAAK,aAAa,CAAC,0BAA0B;gBAC3C,OAAO,+BAA+B,CAAC;YACzC,KAAK,aAAa,CAAC,yBAAyB;gBAC1C,OAAO,gCAAgC,CAAC;YAC1C,KAAK,aAAa,CAAC,iBAAiB;gBAClC,OAAO,uBAAuB,CAAC;YACjC;gBACE,OAAO,uBAAuB,IAAI,EAAE,CAAC;QACzC,CAAC;IACH,CAAC;CACF"}

package/dist/sgp4/sgp4.d.ts

@@ -0,0 +1,99 @@
+/**
+ * @author @thkruz Theodore Kruczek
+ * @description Orbital Object ToolKit (ootk) is a collection of tools for working
+ * with satellites and other orbital objects.
+ * @license AGPL-3.0-or-later
+ * @copyright (c) 2025 Kruczek Labs LLC
+ *
+ * This class was ported from the python-sgp4 library by Brandon Rhodes. That library
+ * is licensed under the MIT license and he maintains the copyright for that work.
+ *
+ * Orbital Object ToolKit is free software: you can redistribute it and/or modify it under the
+ * terms of the GNU Affero General Public License as published by the Free Software
+ * Foundation, either version 3 of the License, or (at your option) any later version.
+ *
+ * Orbital Object ToolKit is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
+ * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License along with
+ * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
+ */
+import { OmmParsedDataFormat } from '../interfaces/OmmFormat.js';
+import { Sgp4OpsMode } from '../enums/Sgp4OpsMode.js';
+import { GreenwichMeanSiderealTime, SatelliteRecord, StateVectorSgp4, Vec3Flat } from '../types/types.js';
+export declare enum Sgp4GravConstants {
+    wgs72old = "wgs72old",
+    wgs72 = "wgs72",
+    wgs84 = "wgs84"
+}
+export declare enum Sgp4Methods {
+    NEAR_EARTH = "n",
+    DEEP_SPACE = "d"
+}
+export declare class Sgp4 {
+    private static angle_;
+    private static asinh_;
+    static createSatrec(tleLine1: string, tleLine2: string, whichconst?: Sgp4GravConstants, opsmode?: Sgp4OpsMode): SatelliteRecord;
+    static createSatrecFromOmm(omm: OmmParsedDataFormat, whichconst?: Sgp4GravConstants, opsmode?: Sgp4OpsMode): SatelliteRecord;
+    private static cross_;
+    static days2mdhms(year: number, days: number): {
+        mon: number;
+        day: number;
+        hr: number;
+        min: number;
+        sec: number;
+    };
+    private static dot_;
+    static gstime(jdut1: number): GreenwichMeanSiderealTime;
+    static invjday(jd: number, jdfrac: number): {
+        year: number;
+        mon: number;
+        day: number;
+        hr: number;
+        min: number;
+        sec: number;
+    };
+    static jday(year: number | Date, mon?: number, day?: number, hr?: number, min?: number, sec?: number, ms?: number): {
+        jd: number;
+        jdFrac: number;
+    };
+    private static mag_;
+    private static newtonnu_;
+    static propagate(satrec: SatelliteRecord, tsince: number): StateVectorSgp4;
+    static rv2coe(r: Vec3Flat, v: Vec3Flat, mus: number): {
+        p: number;
+        a: number;
+        ecc: number;
+        incl: number;
+        omega: number;
+        argp: number;
+        nu: number;
+        m: number;
+        arglat: number;
+        truelon: number;
+        lonper: number;
+    };
+    /**
+     * Determines the sign of a given number.
+     * @param x - The input number to evaluate.
+     * @returns `-1.0` if the input number is less than `0.0`, otherwise `1.0`.
+     */
+    private static sgn_;
+    /**
+     * Computes the hyperbolic sine of a given number.
+     *
+     * The hyperbolic sine is calculated using the formula:
+     * sinh(x) = (e^x - e^(-x)) / 2
+     * @param x - The input number for which to calculate the hyperbolic sine.
+     * @returns The hyperbolic sine of the input number.
+     */
+    private static sinh_;
+    private static dpper_;
+    private static dscom_;
+    private static dsinit_;
+    private static dspace_;
+    private static getgravconst_;
+    private static initl_;
+    private static sgp4init_;
+}