ootk 3.0.0 → 4.0.0-1

package/.eslintrc.json

@@ -1,244 +0,0 @@
-{
-  "env": {
-    "browser": true,
-    "es2021": true,
-    "node": true,
-    "jest": true
-  },
-  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "ecmaVersion": 12,
-    "sourceType": "module"
-  },
-  "plugins": ["@typescript-eslint"],
-  "rules": {
-    "accessor-pairs": "error",
-    "array-bracket-newline": "error",
-    "array-bracket-spacing": "error",
-    "array-callback-return": "error",
-    "array-element-newline": "off",
-    "arrow-body-style": "error",
-    "arrow-parens": "error",
-    "arrow-spacing": "error",
-    "block-scoped-var": "error",
-    "block-spacing": "error",
-    "brace-style": "error",
-    "callback-return": "error",
-    "camelcase": "error",
-    "capitalized-comments": "off",
-    "class-methods-use-this": "error",
-    "comma-dangle": ["error", "always-multiline"],
-    "comma-spacing": "error",
-    "comma-style": "error",
-    "complexity": "error",
-    "computed-property-spacing": "error",
-    "consistent-return": "error",
-    "consistent-this": "error",
-    "curly": "error",
-    "default-case": "error",
-    "default-case-last": "error",
-    "default-param-last": "error",
-    "dot-location": "error",
-    "dot-notation": "error",
-    "eol-last": "error",
-    "eqeqeq": "error",
-    "func-call-spacing": "error",
-    "func-name-matching": "error",
-    "func-names": "error",
-    "func-style": "error",
-    "function-call-argument-newline": "off",
-    "function-paren-newline": "off",
-    "generator-star-spacing": "error",
-    "global-require": "error",
-    "grouped-accessor-pairs": "error",
-    "guard-for-in": "error",
-    "handle-callback-err": "error",
-    "id-blacklist": "error",
-    "id-denylist": "error",
-    "id-length": "off",
-    "id-match": "error",
-    "implicit-arrow-linebreak": "off",
-    "indent": ["error", 2, { "SwitchCase": 1 }],
-    "indent-legacy": ["error", 2, { "SwitchCase": 1 }],
-    "init-declarations": "error",
-    "jsx-quotes": "error",
-    "key-spacing": "error",
-    "keyword-spacing": "error",
-    "line-comment-position": "off",
-    "linebreak-style": ["error", "unix"],
-    "lines-around-comment": "off",
-    "lines-around-directive": "error",
-    "lines-between-class-members": "off",
-    "max-classes-per-file": "error",
-    "max-depth": "error",
-    "max-len": ["error", { "code": 120 }],
-    "max-lines": ["error", { "max": 1000 }],
-    "max-lines-per-function": ["error", { "max": 300 }],
-    "max-nested-callbacks": "error",
-    "max-params": ["error", { "max": 5 }],
-    "max-statements": ["error", { "max": 25 }],
-    "max-statements-per-line": "error",
-    "multiline-comment-style": "error",
-    "multiline-ternary": "off",
-    "new-cap": "error",
-    "new-parens": "error",
-    "newline-after-var": "error",
-    "newline-before-return": "error",
-    "newline-per-chained-call": "off",
-    "no-alert": "error",
-    "no-array-constructor": "error",
-    "no-await-in-loop": "error",
-    "no-bitwise": "error",
-    "no-buffer-constructor": "error",
-    "no-caller": "error",
-    "no-catch-shadow": "error",
-    "no-confusing-arrow": "error",
-    "no-console": "error",
-    "no-constructor-return": "error",
-    "no-continue": "error",
-    "no-div-regex": "error",
-    "no-duplicate-imports": "error",
-    "no-else-return": "error",
-    "no-empty-function": "error",
-    "no-eq-null": "error",
-    "no-eval": "error",
-    "no-extend-native": "error",
-    "no-extra-bind": "error",
-    "no-extra-label": "error",
-    "no-extra-parens": "off",
-    "no-floating-decimal": "error",
-    "no-implicit-coercion": "error",
-    "no-implicit-globals": "error",
-    "no-implied-eval": "error",
-    "no-inline-comments": "off",
-    "no-invalid-this": "error",
-    "no-iterator": "error",
-    "no-label-var": "error",
-    "no-labels": "error",
-    "no-lone-blocks": "error",
-    "no-lonely-if": "error",
-    "no-loop-func": "error",
-    "no-loss-of-precision": "off",
-    "no-magic-numbers": "off",
-    "no-mixed-operators": "off",
-    "no-mixed-requires": "error",
-    "no-multi-assign": "error",
-    "no-multi-spaces": "error",
-    "no-multi-str": "error",
-    "no-multiple-empty-lines": "error",
-    "no-native-reassign": "error",
-    "no-negated-condition": "off",
-    "no-negated-in-lhs": "error",
-    "no-nested-ternary": "error",
-    "no-new": "error",
-    "no-new-func": "error",
-    "no-new-object": "error",
-    "no-new-require": "error",
-    "no-new-wrappers": "error",
-    "no-nonoctal-decimal-escape": "error",
-    "no-octal-escape": "error",
-    "no-param-reassign": "off",
-    "no-path-concat": "error",
-    "no-plusplus": "off",
-    "no-process-env": "error",
-    "no-process-exit": "error",
-    "no-promise-executor-return": "error",
-    "no-proto": "error",
-    "no-restricted-exports": "error",
-    "no-restricted-globals": "error",
-    "no-restricted-imports": "error",
-    "no-restricted-modules": "error",
-    "no-restricted-properties": "error",
-    "no-restricted-syntax": "error",
-    "no-return-assign": "error",
-    "no-return-await": "error",
-    "no-script-url": "error",
-    "no-self-compare": "error",
-    "no-sequences": "error",
-    "no-shadow": "off",
-    "no-spaced-func": "error",
-    "no-sync": "error",
-    "no-tabs": "error",
-    "no-template-curly-in-string": "error",
-    "no-ternary": "off",
-    "no-throw-literal": "error",
-    "no-trailing-spaces": "error",
-    "no-undef-init": "error",
-    "no-undefined": "error",
-    "no-underscore-dangle": "off",
-    "no-unmodified-loop-condition": "error",
-    "no-unneeded-ternary": "error",
-    "no-unreachable-loop": "error",
-    "no-unsafe-optional-chaining": "error",
-    "no-unused-expressions": "error",
-    "no-use-before-define": "error",
-    "no-useless-backreference": "error",
-    "no-useless-call": "error",
-    "no-useless-computed-key": "error",
-    "no-useless-concat": "error",
-    "no-useless-constructor": "error",
-    "no-useless-rename": "error",
-    "no-useless-return": "error",
-    "no-var": "error",
-    "no-void": "error",
-    "no-warning-comments": "error",
-    "no-whitespace-before-property": "error",
-    "nonblock-statement-body-position": "error",
-    "object-curly-newline": "error",
-    "object-curly-spacing": "off",
-    "object-property-newline": "off",
-    "object-shorthand": "error",
-    "one-var": "off",
-    "one-var-declaration-per-line": "error",
-    "operator-assignment": "error",
-    "operator-linebreak": "error",
-    "padded-blocks": "off",
-    "padding-line-between-statements": "error",
-    "prefer-arrow-callback": "error",
-    "prefer-const": "error",
-    "prefer-destructuring": "error",
-    "prefer-exponentiation-operator": "error",
-    "prefer-named-capture-group": "error",
-    "prefer-numeric-literals": "error",
-    "prefer-object-spread": "error",
-    "prefer-promise-reject-errors": "error",
-    "prefer-reflect": "off",
-    "prefer-regex-literals": "error",
-    "prefer-rest-params": "error",
-    "prefer-spread": "error",
-    "prefer-template": "error",
-    "quote-props": "off",
-    "quotes": ["error", "single"],
-    "radix": "off",
-    "require-atomic-updates": "error",
-    "require-await": "error",
-    "require-jsdoc": "error",
-    "require-unicode-regexp": "error",
-    "rest-spread-spacing": "error",
-    "semi": "error",
-    "semi-spacing": "error",
-    "semi-style": "error",
-    "sort-imports": "off",
-    "sort-keys": "off",
-    "sort-vars": "error",
-    "space-before-blocks": "error",
-    "space-before-function-paren": "off",
-    "space-in-parens": "error",
-    "space-infix-ops": "error",
-    "space-unary-ops": "error",
-    "spaced-comment": "error",
-    "strict": "error",
-    "switch-colon-spacing": "error",
-    "symbol-description": "error",
-    "template-curly-spacing": "error",
-    "template-tag-spacing": "error",
-    "unicode-bom": "error",
-    "valid-jsdoc": "off",
-    "vars-on-top": "error",
-    "wrap-iife": "error",
-    "wrap-regex": "error",
-    "yield-star-spacing": "error",
-    "yoda": "error"
-  }
-}

package/.prettierrc

@@ -1,17 +0,0 @@
-{
-  "printWidth": 120,
-  "tabWidth": 2,
-  "useTabs": false,
-  "semi": true,
-  "singleQuote": true,
-  "quoteProps": "consistent",
-  "trailingComma": "all",
-  "bracketSpacing": true,
-  "arrowParens": "always",
-  "requirePragma": false,
-  "insertPragma": false,
-  "proseWrap": "never",
-  "htmlWhitespaceSensitivity": "ignore",
-  "endOfLine": "lf",
-  "embeddedLanguageFormatting": "off"
-}

package/babel.config.js

@@ -1,16 +0,0 @@
-// eslint-disable-next-line no-undef
-module.exports = {
-  presets: [
-    [
-      '@babel/preset-env',
-      {
-        targets: {
-          esmodules: true,
-        },
-        // modules: "umd", -- THIS IS FOR DOING THE LIB VERSION OF KEEPTRACK
-      },
-    ],
-    '@babel/preset-typescript',
-  ],
-  compact: 'auto',
-};

package/codecov.yml

@@ -1,21 +0,0 @@
-codecov:
-  require_ci_to_pass: yes
-  bot: Code Coverage Bot
-
-coverage:
-  precision: 2
-  round: down
-  range: "70...100"
-
-parsers:
-  gcov:
-    branch_detection:
-      conditional: yes
-      loop: yes
-      method: no
-      macro: no
-
-comment:
-  layout: "reach,diff,flags,files,footer"
-  behavior: default
-  require_changes: no

package/dist/objects/base-object.d.ts

@@ -1,40 +0,0 @@
-/**
- * @author Theodore Kruczek.
- * @description Orbital Object ToolKit (OOTK) is a collection of tools for working
- * with satellites and other orbital objects.
- *
- * @file The BaseObject class is used for creating core properties and methods applicable
- * to ground and space based objects.
- *
- * @license AGPL-3.0-or-later
- * @Copyright (c) 2020-2023 Theodore Kruczek
- *
- * 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 { EciVec3, SpaceObjectType } from '../types/types';
-interface ObjectInfo {
-    name?: string;
-    type?: SpaceObjectType;
-    position?: EciVec3;
-    time?: Date;
-}
-export declare class BaseObject {
-    name: string;
-    type: SpaceObjectType;
-    position: EciVec3;
-    time: Date;
-    constructor(info: ObjectInfo);
-    getName(): string;
-    getType(): SpaceObjectType;
-    getTypeString(): string;
-}
-export {};

package/dist/objects/detailed-sat.d.ts

@@ -1,66 +0,0 @@
-/**
- * @author Theodore Kruczek.
- * @description Orbital Object ToolKit (OOTK) is a collection of tools for working
- * with satellites and other orbital objects.
- *
- * @file The DetailedSat class is an extension of the Sat class that provides additional
- * properties for categorizing and filtering satellites.
- *
- * @license AGPL-3.0-or-later
- * @Copyright (c) 2020-2023 Theodore Kruczek
- *
- * 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 { LaunchDetails, OperationsDetails, SpaceCraftDetails, SpaceObjectType, TleLine1, TleLine2 } from '../types/types';
-import { Sat } from './sat';
-interface ObjectInfo {
-    name?: string;
-    type?: SpaceObjectType;
-    rcs?: number;
-    vmag?: number;
-    tle1: TleLine1;
-    tle2: TleLine2;
-}
-export declare class DetailedSat extends Sat {
-    launchDate: string;
-    launchMass: string;
-    launchSite: string;
-    launchVehicle: string;
-    lifetime: string | number;
-    maneuver: string;
-    manufacturer: string;
-    motor: string;
-    power: string;
-    payload: string;
-    purpose: string;
-    shape: string;
-    span: string;
-    user: string;
-    mission: string;
-    owner: string;
-    configuration: string;
-    equipment: string;
-    dryMass: string;
-    country: string;
-    constructor(info: ObjectInfo, options: any, details: {
-        launchDetails: LaunchDetails;
-        spaceCraftDetails: SpaceCraftDetails;
-        operationsDetails: OperationsDetails;
-    });
-    setLaunchDetails(details: LaunchDetails): void;
-    getLaunchDetails(): LaunchDetails;
-    setSpaceCraftDetails(details: SpaceCraftDetails): void;
-    getSpaceCraftDetails(): SpaceCraftDetails;
-    setOperationsDetails(details: OperationsDetails): void;
-    getOperationsDetails(): OperationsDetails;
-}
-export {};

package/dist/objects/sat.d.ts

@@ -1,92 +0,0 @@
-/**
- * @author Theodore Kruczek.
- * @description Orbital Object ToolKit (OOTK) is a collection of tools for working
- * with satellites and other orbital objects.
- *
- * @file The Sat class provides functions for calculating satellites positions relative
- * to earth based sensors and other orbital objects.
- *
- * @license AGPL-3.0-or-later
- * @Copyright (c) 2020-2023 Theodore Kruczek
- *
- * 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 { EcfVec3, EciVec3, LlaVec3, RaeVec3, SatelliteRecord, SpaceObjectType, StateVector, TleLine1, TleLine2 } from '../types/types';
-import { Sensor } from './sensor';
-import { SpaceObject } from './space-object';
-interface ObjectInfo {
-    name?: string;
-    type?: SpaceObjectType;
-    rcs?: number;
-    vmag?: number;
-    tle1: TleLine1;
-    tle2: TleLine2;
-}
-export declare class Sat extends SpaceObject {
-    satNum: number;
-    satrec: SatelliteRecord;
-    intlDes: string;
-    epochYear: number;
-    epochDay: number;
-    meanMoDev1: number;
-    meanMoDev2: number;
-    bstar: number;
-    inclination: number;
-    raan: number;
-    eccentricity: number;
-    argOfPerigee: number;
-    meanAnomaly: number;
-    meanMotion: number;
-    period: number;
-    apogee: number;
-    perigee: number;
-    options: any;
-    constructor(info: ObjectInfo, options?: any);
-    propagateTo(date: Date): Sat;
-    /**
-     * Calculates position and velocity in ECI coordinates at a given time.
-     * @param {Date} date Date to calculate the state vector for
-     * @returns {StateVector} State vector for the given date
-     */
-    getStateVec(date?: Date): StateVector;
-    /**
-     * Calculates ECI position at a given time.
-     * @param {Date} date Date to calculate
-     * @returns {EciVec3} ECI position vector
-     */
-    getEci(date?: Date): EciVec3;
-    /**
-     * Calculates ECF position at a given time.
-     * @param {Date} date Date to calculate
-     * @returns {EcfVec3} ECF position vector
-     */
-    getEcf(date?: Date): EcfVec3;
-    /**
-     * Calculates LLA position at a given time.
-     * @param {Date} date Date to calculate
-     * @returns {LlaVec3} LLA position vector
-     */
-    getLla(date?: Date): LlaVec3;
-    getRae(sensor: Sensor, date?: Date): RaeVec3;
-    getAzimuth(sensor: Sensor, date?: Date): number;
-    getElevation(sensor: Sensor, date?: Date): number;
-    getRange(sensor: Sensor, date?: Date): number;
-    /**
-     * Calculates the time variables for a given date relative to the TLE epoch.
-     * @param {Date} date Date to calculate
-     * @param {SatelliteRecord} satrec Satellite orbital information
-     * @returns {{m: number, gmst: GreenwichMeanSiderealTime, j: number}} Time variables
-     */
-    private static calculateTimeVariables;
-    static checkSatrec(satrec: SatelliteRecord): boolean;
-}
-export {};

package/dist/objects/sensor.d.ts

@@ -1,93 +0,0 @@
-/**
- * @author Theodore Kruczek.
- * @description Orbital Object ToolKit (OOTK) is a collection of tools for working
- * with satellites and other orbital objects.
- *
- * @file The Sensor class is used for creating ground based observers.
- *
- * @license AGPL-3.0-or-later
- * @Copyright (c) 2020-2023 Theodore Kruczek
- *
- * 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 { Degrees, Kilometers, Radians, RaeVec3, SpaceObjectType } from '../types/types';
-import { BaseObject } from './base-object';
-import { Sat } from './sat';
-interface ObjectInfo {
-    name?: string;
-    type?: SpaceObjectType;
-    lat: Radians;
-    lon: Radians;
-    alt: Kilometers;
-    minAz?: Degrees;
-    maxAz?: Degrees;
-    minEl?: Degrees;
-    maxEl?: Degrees;
-    minRng?: Kilometers;
-    maxRng?: Kilometers;
-}
-export declare enum PassType {
-    OUT_OF_VIEW = -1,
-    ENTER = 0,
-    IN_VIEW = 1,
-    EXIT = 2
-}
-type Lookangles = {
-    type: PassType;
-    time: Date;
-    az: Degrees;
-    el: Degrees;
-    rng: Kilometers;
-    maxElPass?: Degrees;
-};
-export declare class Sensor extends BaseObject {
-    lat: Radians;
-    lon: Radians;
-    alt: Kilometers;
-    minAz: Degrees;
-    maxAz: Degrees;
-    minEl: Degrees;
-    maxEl: Degrees;
-    minRng: Kilometers;
-    maxRng: Kilometers;
-    /**
-     * * name: Name as a string - OPTIONAL
-     * * type: SpaceObjectType - OPTIONAL
-     * * lat: Latitude in Radians
-     * * lon: Longitude in Radians
-     * * alt: Altitude in Kilometers
-     * * minAz: Minimum Azimuth in Degrees
-     * * maxAz: Maximum Azimuth in Degrees
-     * * minEl: Minimum Elevation in Degrees
-     * * maxEl: Maximum Elevation in Degrees
-     * * minRng: Minimum Range in Kilometers
-     * * maxRng: Maximum Range in Kilometers
-     * @param {ObjectInfo} info ObjectInfo object containing the object's information
-     */
-    constructor(info: ObjectInfo);
-    private validateInputData;
-    private validateFov;
-    private validateMaxRng;
-    private validateMinRng;
-    private validateMaxEl;
-    private validateMinEl;
-    private validateMaxAz;
-    private validateMinAz;
-    private validateLla;
-    setTime(date: Date): this;
-    getRae(sat: Sat, date?: Date): RaeVec3;
-    isRaeInFov(rae: RaeVec3): boolean;
-    isSatInFov(sat: Sat, date?: Date): boolean;
-    calculatePasses(planningInterval: number, sat: Sat, date?: Date): Lookangles[];
-    private static getPassType_;
-}
-export {};

package/dist/objects/star.d.ts

@@ -1,46 +0,0 @@
-/**
- * @author Theodore Kruczek.
- * @description Orbital Object ToolKit (OOTK) is a collection of tools for working
- * with satellites and other orbital objects.
- *
- * @file The Star class is meant to help with cacluating star positions relative to
- * satellites and earth based sensors.
- *
- * @license AGPL-3.0-or-later
- * @Copyright (c) 2020-2023 Theodore Kruczek
- *
- * 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 { EciVec3, LlaVec3, Radians, RaeVec3, SpaceObjectType } from '../types/types';
-import { SpaceObject } from './space-object';
-interface ObjectInfo {
-    bf?: string;
-    dec: Radians;
-    h?: string;
-    name?: string;
-    pname?: string;
-    ra: Radians;
-    type?: SpaceObjectType;
-    vmag?: number;
-}
-export declare class Star extends SpaceObject {
-    bf: string;
-    dec: Radians;
-    h: string;
-    pname: string;
-    ra: Radians;
-    constructor(info: ObjectInfo);
-    getEci(lla?: LlaVec3, date?: Date): EciVec3;
-    getRae(lla?: LlaVec3, date?: Date): RaeVec3;
-    private static calculateTimeVariables_;
-}
-export {};