@saber-usa/node-common 1.7.3 → 1.7.4

package/src/launchNominal.js

@@ -1,208 +1,208 @@
-import {twoline2satrec,
-    propagate,
-    gstime,
-    eciToGeodetic,
-    degreesToRadians,
-    radiansToDegrees,
-    eciToEcf,
-    ecfToLookAngles,
-    degreesLong,
-    degreesLat} from "satellite.js";
-import {distGeodetic} from "./astro.js";
-import {wrapToRange} from "./utils.js";
-
-const notamToCoordArray = (notam) => {
-    const regexPatterns = [
-        /(\d{4,6}[NS]|[N|S]\d{6})(\d{4,7}[EW]|[E|W]\d{7})/g,
-    ];
-
-    // clean up the NOTAM. Remove all spaces and unwanted characters and convert to upper case
-    notam = notam
-        .replace(/\s/g, "")
-        .replace(/-/g, "")
-        .replace(/\./g, "")
-        .toUpperCase();
-
-    const coordArray = [];
-    let matchFound = false;
-    let match;
-    for (const regex of regexPatterns) {
-        while ((match = regex.exec(notam)) !== null) {
-            matchFound = true;
-            // Depending on the pattern, you might need to adjust the indexing in convertToDecimal calls
-            const lat = match[1];
-            const lon = match[2];
-            const decimalLat = convertToDecimal(lat);
-            const decimalLon = convertToDecimal(lon);
-            coordArray.push([decimalLat, decimalLon]);
-        }
-        if (matchFound) break; // Stop iterating through patterns if a match is found
-    }
-
-    return coordArray;
-};
-
-// Helper function to convert coordinate string to decimal
-const convertToDecimal = (coord) => {
-    // Determine if the direction is at the beginning or the end
-    const direction = coord.charAt(0).match(/[NSWE]/) ? coord.charAt(0) : coord.charAt(coord.length - 1);
-    let degrees;
-    let minutes;
-    let seconds = 0; // Default to 0 for formats without seconds
-
-    if (direction === coord.charAt(0)) { // Direction at the beginning
-        coord = coord.substr(1); // Remove direction from coord for processing
-    } else { // Direction at the end
-        coord = coord.substr(0, coord.length - 1); // Remove direction from coord for processing
-    }
-
-    // Now, coord contains only the numeric part
-    if (coord.length === 4) { // Format DDMM
-        degrees = parseInt(coord.substr(0, 2), 10);
-        minutes = parseInt(coord.substr(2, 2), 10);
-    } else if (coord.length === 5) { // Format DDDMM
-        degrees = parseInt(coord.substr(0, 3), 10);
-        minutes = parseInt(coord.substr(3, 2), 10);
-    } else if (coord.length === 6) { // Format DDMMSS
-        degrees = parseInt(coord.substr(0, 2), 10);
-        minutes = parseInt(coord.substr(2, 2), 10);
-        seconds = parseInt(coord.substr(4, 2), 10);
-    } else if (coord.length === 7) { // Format DDDMMSS
-        degrees = parseInt(coord.substr(0, 3), 10);
-        minutes = parseInt(coord.substr(3, 2), 10);
-        seconds = parseInt(coord.substr(5, 2), 10);
-    } else {
-        return 0; // Invalid format
-    }
-
-    // Convert to decimal format
-    let decimal = degrees + (minutes / 60) + (seconds / 3600);
-    decimal = (direction === "S" || direction === "W") ? -decimal : decimal;
-    return decimal;
-};
-
-/** Gets the bearing of an orbiting object relative to it's launch pad.
- * @param {String} line1 The first line of the TLE
- * @param {String} line2 The second line of the TLE
- * @param {Date} otop The OTOP time (object time over pad) in UTC
- * @param {Object} opop The OPOP object with the following properties:
- * - latitude: The geocentric latitude of the object in degrees
- * - longitude: The geocentric longitude of the object in degrees
- * @return {Number} The bearing of the object in degrees
- */
-const getBearingFromTle = (line1, line2, otop, opop) => {
-    const satrec = twoline2satrec(line1, line2);
-    const propTime = new Date(otop.getTime() + 10000);
-    const propPos = eciToGeodetic(
-        propagate(satrec, propTime).position,
-        gstime(propTime),
-    );
-
-    const ascending = degreesToRadians(opop.latitude) < propPos.latitude;
-
-    return getBearing(
-        radiansToDegrees(satrec.inclo),
-        opop.latitude,
-        ascending,
-    );
-};
-
-/**
- * Calculates the bearing angle given inclination, latitude, and whether the orbit is ascending.
- * @param {number} i - Inclination angle in degrees.
- * @param {number} lat - Latitude angle in degrees.
- * @param {boolean} ascending - Whether the orbit is ascending. Defaults to true.
- * @return {number} The azimuth angle in degrees, wrapped to [0, 360).
- */
-const getBearing = (i, lat, ascending = true) => {
-    i = degreesToRadians(i);
-    lat = degreesToRadians(lat);
-    const azimuthRadians = Math.asin(Math.cos(i) / Math.cos(lat));
-    let azimuthDegrees = radiansToDegrees(azimuthRadians);
-
-    if (!ascending) {
-        azimuthDegrees = 180 - azimuthDegrees;
-    }
-
-    return wrapToRange(azimuthDegrees, 0, 360);
-};
-
-/** Gets the OPOP (Object Position Over Pad) and OTOP (Object Time Over Pad) of an orbiting object relative to it's launch pad.
- * @param {String} line1 The first line of the TLE
- * @param {String} line2 The second line of the TLE
- * @param {Number} padLat The latitude of the launch pad in degrees
- * @param {Number} padLon The longitude of the launch pad in degrees
- * @param {Number} padAlt The altitude of the launch pad in km
- * @param {Date} launchTime The launch time of the object
- * @param {Number} flyoutTimeThresholdMin The flyout time threshold in minutes, defaults to 20 min
- * @param {Number} opopDistThresholdKm The OPOP distance threshold in km, defaults to 250 km
- * @param {Number} maxIterations The maximum number of iterations, defaults to 100
- * @return {Object} The OPOP object with the following properties:
- * - opopLat: The geocentric latitude of the object in degrees
- * - opopLon: The geocentric longitude of the object in degrees
- * - otop: The time of the object over the pad in UTC
- */
-const getOpopOtop = (
-    line1,
-    line2,
-    padLat,
-    padLon,
-    padAlt,
-    launchTime,
-    flyoutTimeThresholdMin = 20,
-    opopDistThresholdKm = 250,
-    maxIterations = 100,
-) => {
-    const satrec = twoline2satrec(line1, line2);
-
-    // iterate time to find the time with closest range
-    let time = launchTime;
-    let stepSize = 60000; // 1 minute
-    let lastRange;
-    const timeTreshold = 500; // half second
-    for (let i = 0; i < maxIterations; i++) {
-        const sv = propagate(satrec, time);
-        const gmst = gstime(time);
-        const satEcf = eciToEcf(sv.position, gmst);
-        const padGd = {
-            longitude: degreesToRadians(padLon),
-            latitude: degreesToRadians(padLat),
-            height: padAlt,
-        };
-        const range = ecfToLookAngles(padGd, satEcf).rangeSat;
-        if (lastRange && lastRange < range) {
-            // we went too far, half the step size and invert the sign
-            stepSize = (-1 * stepSize) / 2;
-        }
-        time = new Date(time.getTime() + stepSize);
-        lastRange = range;
-
-        if (Math.abs(stepSize) < timeTreshold) {
-            break;
-        }
-    }
-
-    if (Math.abs(stepSize) >= timeTreshold) {
-        throw new Error(`Failed to converge on OPOP after ${maxIterations} iterations`);
-    }
-    if (Math.abs(time.getTime() - launchTime.getTime()) > flyoutTimeThresholdMin * 60000) {
-        throw new Error(`OTOP is more than ${flyoutTimeThresholdMin} minute(s) from launch`);
-    }
-
-    const sv = propagate(satrec, time);
-    const opop = eciToGeodetic(sv.position, gstime(time));
-    const opopLat = degreesLat(opop.latitude);
-    const opopLon = degreesLong(opop.longitude);
-
-    if (distGeodetic(opopLat, opopLon, padLat, padLon) > opopDistThresholdKm * 1000) {
-        throw new Error(`OPOP is more than ${opopDistThresholdKm}km from launch pad`);
-    }
-
-    return {
-        opopLat: opopLat,
-        opopLon: opopLon,
-        otop: time,
-    };
-};
-
-export {notamToCoordArray, getBearingFromTle, getBearing, getOpopOtop};
+import {twoline2satrec,
+    propagate,
+    gstime,
+    eciToGeodetic,
+    degreesToRadians,
+    radiansToDegrees,
+    eciToEcf,
+    ecfToLookAngles,
+    degreesLong,
+    degreesLat} from "satellite.js";
+import {distGeodetic} from "./astro.js";
+import {wrapToRange} from "./utils.js";
+
+const notamToCoordArray = (notam) => {
+    const regexPatterns = [
+        /(\d{4,6}[NS]|[N|S]\d{6})(\d{4,7}[EW]|[E|W]\d{7})/g,
+    ];
+
+    // clean up the NOTAM. Remove all spaces and unwanted characters and convert to upper case
+    notam = notam
+        .replace(/\s/g, "")
+        .replace(/-/g, "")
+        .replace(/\./g, "")
+        .toUpperCase();
+
+    const coordArray = [];
+    let matchFound = false;
+    let match;
+    for (const regex of regexPatterns) {
+        while ((match = regex.exec(notam)) !== null) {
+            matchFound = true;
+            // Depending on the pattern, you might need to adjust the indexing in convertToDecimal calls
+            const lat = match[1];
+            const lon = match[2];
+            const decimalLat = convertToDecimal(lat);
+            const decimalLon = convertToDecimal(lon);
+            coordArray.push([decimalLat, decimalLon]);
+        }
+        if (matchFound) break; // Stop iterating through patterns if a match is found
+    }
+
+    return coordArray;
+};
+
+// Helper function to convert coordinate string to decimal
+const convertToDecimal = (coord) => {
+    // Determine if the direction is at the beginning or the end
+    const direction = coord.charAt(0).match(/[NSWE]/) ? coord.charAt(0) : coord.charAt(coord.length - 1);
+    let degrees;
+    let minutes;
+    let seconds = 0; // Default to 0 for formats without seconds
+
+    if (direction === coord.charAt(0)) { // Direction at the beginning
+        coord = coord.substr(1); // Remove direction from coord for processing
+    } else { // Direction at the end
+        coord = coord.substr(0, coord.length - 1); // Remove direction from coord for processing
+    }
+
+    // Now, coord contains only the numeric part
+    if (coord.length === 4) { // Format DDMM
+        degrees = parseInt(coord.substr(0, 2), 10);
+        minutes = parseInt(coord.substr(2, 2), 10);
+    } else if (coord.length === 5) { // Format DDDMM
+        degrees = parseInt(coord.substr(0, 3), 10);
+        minutes = parseInt(coord.substr(3, 2), 10);
+    } else if (coord.length === 6) { // Format DDMMSS
+        degrees = parseInt(coord.substr(0, 2), 10);
+        minutes = parseInt(coord.substr(2, 2), 10);
+        seconds = parseInt(coord.substr(4, 2), 10);
+    } else if (coord.length === 7) { // Format DDDMMSS
+        degrees = parseInt(coord.substr(0, 3), 10);
+        minutes = parseInt(coord.substr(3, 2), 10);
+        seconds = parseInt(coord.substr(5, 2), 10);
+    } else {
+        return 0; // Invalid format
+    }
+
+    // Convert to decimal format
+    let decimal = degrees + (minutes / 60) + (seconds / 3600);
+    decimal = (direction === "S" || direction === "W") ? -decimal : decimal;
+    return decimal;
+};
+
+/** Gets the bearing of an orbiting object relative to it's launch pad.
+ * @param {String} line1 The first line of the TLE
+ * @param {String} line2 The second line of the TLE
+ * @param {Date} otop The OTOP time (object time over pad) in UTC
+ * @param {Object} opop The OPOP object with the following properties:
+ * - latitude: The geocentric latitude of the object in degrees
+ * - longitude: The geocentric longitude of the object in degrees
+ * @return {Number} The bearing of the object in degrees
+ */
+const getBearingFromTle = (line1, line2, otop, opop) => {
+    const satrec = twoline2satrec(line1, line2);
+    const propTime = new Date(otop.getTime() + 10000);
+    const propPos = eciToGeodetic(
+        propagate(satrec, propTime).position,
+        gstime(propTime),
+    );
+
+    const ascending = degreesToRadians(opop.latitude) < propPos.latitude;
+
+    return getBearing(
+        radiansToDegrees(satrec.inclo),
+        opop.latitude,
+        ascending,
+    );
+};
+
+/**
+ * Calculates the bearing angle given inclination, latitude, and whether the orbit is ascending.
+ * @param {number} i - Inclination angle in degrees.
+ * @param {number} lat - Latitude angle in degrees.
+ * @param {boolean} ascending - Whether the orbit is ascending. Defaults to true.
+ * @return {number} The azimuth angle in degrees, wrapped to [0, 360).
+ */
+const getBearing = (i, lat, ascending = true) => {
+    i = degreesToRadians(i);
+    lat = degreesToRadians(lat);
+    const azimuthRadians = Math.asin(Math.cos(i) / Math.cos(lat));
+    let azimuthDegrees = radiansToDegrees(azimuthRadians);
+
+    if (!ascending) {
+        azimuthDegrees = 180 - azimuthDegrees;
+    }
+
+    return wrapToRange(azimuthDegrees, 0, 360);
+};
+
+/** Gets the OPOP (Object Position Over Pad) and OTOP (Object Time Over Pad) of an orbiting object relative to it's launch pad.
+ * @param {String} line1 The first line of the TLE
+ * @param {String} line2 The second line of the TLE
+ * @param {Number} padLat The latitude of the launch pad in degrees
+ * @param {Number} padLon The longitude of the launch pad in degrees
+ * @param {Number} padAlt The altitude of the launch pad in km
+ * @param {Date} launchTime The launch time of the object
+ * @param {Number} flyoutTimeThresholdMin The flyout time threshold in minutes, defaults to 20 min
+ * @param {Number} opopDistThresholdKm The OPOP distance threshold in km, defaults to 250 km
+ * @param {Number} maxIterations The maximum number of iterations, defaults to 100
+ * @return {Object} The OPOP object with the following properties:
+ * - opopLat: The geocentric latitude of the object in degrees
+ * - opopLon: The geocentric longitude of the object in degrees
+ * - otop: The time of the object over the pad in UTC
+ */
+const getOpopOtop = (
+    line1,
+    line2,
+    padLat,
+    padLon,
+    padAlt,
+    launchTime,
+    flyoutTimeThresholdMin = 20,
+    opopDistThresholdKm = 250,
+    maxIterations = 100,
+) => {
+    const satrec = twoline2satrec(line1, line2);
+
+    // iterate time to find the time with closest range
+    let time = launchTime;
+    let stepSize = 60000; // 1 minute
+    let lastRange;
+    const timeTreshold = 500; // half second
+    for (let i = 0; i < maxIterations; i++) {
+        const sv = propagate(satrec, time);
+        const gmst = gstime(time);
+        const satEcf = eciToEcf(sv.position, gmst);
+        const padGd = {
+            longitude: degreesToRadians(padLon),
+            latitude: degreesToRadians(padLat),
+            height: padAlt,
+        };
+        const range = ecfToLookAngles(padGd, satEcf).rangeSat;
+        if (lastRange && lastRange < range) {
+            // we went too far, half the step size and invert the sign
+            stepSize = (-1 * stepSize) / 2;
+        }
+        time = new Date(time.getTime() + stepSize);
+        lastRange = range;
+
+        if (Math.abs(stepSize) < timeTreshold) {
+            break;
+        }
+    }
+
+    if (Math.abs(stepSize) >= timeTreshold) {
+        throw new Error(`Failed to converge on OPOP after ${maxIterations} iterations`);
+    }
+    if (Math.abs(time.getTime() - launchTime.getTime()) > flyoutTimeThresholdMin * 60000) {
+        throw new Error(`OTOP is more than ${flyoutTimeThresholdMin} minute(s) from launch`);
+    }
+
+    const sv = propagate(satrec, time);
+    const opop = eciToGeodetic(sv.position, gstime(time));
+    const opopLat = degreesLat(opop.latitude);
+    const opopLon = degreesLong(opop.longitude);
+
+    if (distGeodetic(opopLat, opopLon, padLat, padLon) > opopDistThresholdKm * 1000) {
+        throw new Error(`OPOP is more than ${opopDistThresholdKm}km from launch pad`);
+    }
+
+    return {
+        opopLat: opopLat,
+        opopLon: opopLon,
+        otop: time,
+    };
+};
+
+export {notamToCoordArray, getBearingFromTle, getBearing, getOpopOtop};

package/src/loggerFactory.cjs

@@ -1,98 +1,98 @@
-const winston = require("winston");
-const {
-    createLogger,
-    format,
-    transports,
-} = winston;
-const cj = (data) => Object.keys(data).length > 0
-    ? JSON.stringify(data, null, 2)
-    : null;
-
-const isTest = process.env.NODE_ENV === "test";
-
-const defaultLogger = new transports.Console({
-    silent: isTest,
-    level: "warn",
-    format: format.errors({stack: true}),
-    timestamp: true,
-});
-
-const errorLogger = new transports.Console({
-    silent: isTest,
-    format: format.errors({stack: true}),
-});
-
-/**
- * Creates a logger
- *
- * @param {String} nameSpace Namespace for the logger
- * @param {Object} additionalData additional data to include with logging
- * @param {string} level Default logging level to set (overwrites environment setting)
- * @return {winston.Logger}
- */
-module.exports.loggerFactory = ({
-    nameSpace = "saber",
-    additionalData = {},
-    level,
-} = {}) => {
-    const logLevel = process.env.LOG_LEVEL || "warn";
-    const isConsole = !!(process.env.CONSOLE_LOG);
-
-    const loggerTransport = isConsole
-        ? new transports.Console({
-            defaultMeta: additionalData,
-            level: level || logLevel,
-            format: format.combine(
-                format.errors({stack: true}),
-                format.cli(),
-                // eslint-disable-next-line max-len
-                format.printf(({
-                    level,
-                    message,
-                    nameSpace,
-                    stack,
-                    ...rest
-                }) =>
-                    [
-                        level,
-                        `[${nameSpace}]`,
-                        ":",
-                        message,
-                        stack,
-                        cj(rest),
-                    ].filter((value) => !!value)
-                        .join(" "),
-                ),
-            ),
-        })
-        : defaultLogger;
-
-    const config = {
-        levels: {
-            // RFC5424
-            emerg: 0,
-            alert: 1,
-            crit: 2,
-            error: 3,
-            warning: 4,
-            notice: 5,
-            info: 6,
-            debug: 7,
-            // npm levels
-            warn: 4,
-            verbose: 6,
-            silly: 8,
-        },
-        exitOnError: false,
-        transports: [loggerTransport],
-        // Console logger from above will log errors
-        exceptionHandlers: !isConsole ? [errorLogger] : [],
-        rejectionHandlers: !isConsole ? [errorLogger] : [],
-    };
-
-    return createLogger(config)
-        .child({
-            ...additionalData,
-            nameSpace: nameSpace,
-        });
-}
+const winston = require("winston");
+const {
+    createLogger,
+    format,
+    transports,
+} = winston;
+const cj = (data) => Object.keys(data).length > 0
+    ? JSON.stringify(data, null, 2)
+    : null;
+
+const isTest = process.env.NODE_ENV === "test";
+
+const defaultLogger = new transports.Console({
+    silent: isTest,
+    level: "warn",
+    format: format.errors({stack: true}),
+    timestamp: true,
+});
+
+const errorLogger = new transports.Console({
+    silent: isTest,
+    format: format.errors({stack: true}),
+});
+
+/**
+ * Creates a logger
+ *
+ * @param {String} nameSpace Namespace for the logger
+ * @param {Object} additionalData additional data to include with logging
+ * @param {string} level Default logging level to set (overwrites environment setting)
+ * @return {winston.Logger}
+ */
+module.exports.loggerFactory = ({
+    nameSpace = "saber",
+    additionalData = {},
+    level,
+} = {}) => {
+    const logLevel = process.env.LOG_LEVEL || "warn";
+    const isConsole = !!(process.env.CONSOLE_LOG);
+
+    const loggerTransport = isConsole
+        ? new transports.Console({
+            defaultMeta: additionalData,
+            level: level || logLevel,
+            format: format.combine(
+                format.errors({stack: true}),
+                format.cli(),
+                // eslint-disable-next-line max-len
+                format.printf(({
+                    level,
+                    message,
+                    nameSpace,
+                    stack,
+                    ...rest
+                }) =>
+                    [
+                        level,
+                        `[${nameSpace}]`,
+                        ":",
+                        message,
+                        stack,
+                        cj(rest),
+                    ].filter((value) => !!value)
+                        .join(" "),
+                ),
+            ),
+        })
+        : defaultLogger;
+
+    const config = {
+        levels: {
+            // RFC5424
+            emerg: 0,
+            alert: 1,
+            crit: 2,
+            error: 3,
+            warning: 4,
+            notice: 5,
+            info: 6,
+            debug: 7,
+            // npm levels
+            warn: 4,
+            verbose: 6,
+            silly: 8,
+        },
+        exitOnError: false,
+        transports: [loggerTransport],
+        // Console logger from above will log errors
+        exceptionHandlers: !isConsole ? [errorLogger] : [],
+        rejectionHandlers: !isConsole ? [errorLogger] : [],
+    };
+
+    return createLogger(config)
+        .child({
+            ...additionalData,
+            nameSpace: nameSpace,
+        });
+}