@fboes/aerofly-custom-missions 1.2.2 → 1.3.0

package/src/dto/AeroflyMissionConditions.ts

@@ -0,0 +1,189 @@
+import { AeroflyConfigurationNode } from "../node/AeroflyConfigurationNode.js";
+import { meterPerStatuteMile } from "./AeroflyMission.js";
+import { AeroflyMissionConditionsCloud } from "./AeroflyMissionConditionsCloud.js";
+
+/**
+ * Weather data for wind
+ * @property {number} direction in degree
+ * @property {number} speed in kts
+ * @property {number} gusts in kts
+ */
+export type AeroflyMissionConditionsWind = {
+    direction: number;
+    speed: number;
+    gusts: number;
+};
+
+/**
+ * @class
+ * Time and weather data for the given flight plan
+ *
+ * The purpose of this class is to collect data needed for Aerofly FS4's
+ * `custom_missions_user.tmc` flight plan file format, and export the structure
+ * for this file via the `toString()` method.
+ */
+export class AeroflyMissionConditions {
+    /**
+     * @property {Date} time of flight plan. Relevant is the UTC part, so
+     *    consider setting this date in UTC.
+     */
+    time: Date;
+
+    /**
+     * @property {object} wind state
+     */
+    wind: AeroflyMissionConditionsWind;
+
+    /**
+     * @property {number} turbulenceStrength 0..1, percentage
+     */
+    turbulenceStrength: number;
+
+    /**
+     * @property {number} thermalStrength 0..1, percentage
+     */
+    thermalStrength: number;
+
+    /**
+     * @property {number} visibility in meters
+     */
+    visibility: number;
+
+    /**
+     * @property {AeroflyMissionConditionsCloud[]} clouds for the whole flight
+     */
+    clouds: AeroflyMissionConditionsCloud[] = [];
+
+    /**
+     * @param {object} additionalAttributes allows to set additional attributes on creation
+     * @param {Date} [additionalAttributes.time]  of flight plan. Relevant is the UTC part, so
+     *    consider setting this date in UTC.
+     * @param {{direction: number, speed: number, gusts: number}} [additionalAttributes.wind] state
+     * @param {number} [additionalAttributes.turbulenceStrength] 0..1, percentage
+     * @param {number} [additionalAttributes.thermalStrength] 0..1, percentage
+     * @param {number} [additionalAttributes.visibility] in meters
+     * @param {?number} [additionalAttributes.visibility_sm] in statute miles, will overwrite visibility
+     * @param {?number} [additionalAttributes.temperature] in °C, will overwrite thermalStrength
+     * @param {AeroflyMissionConditionsCloud[]} [additionalAttributes.clouds] for the whole flight
+     */
+    constructor({
+        time = new Date(),
+        wind = {
+            direction: 0,
+            speed: 0,
+            gusts: 0,
+        },
+        turbulenceStrength = 0,
+        thermalStrength = 0,
+        visibility = 25_000,
+        visibility_sm = 0,
+        temperature = 0,
+        clouds = [],
+    }: Partial<AeroflyMissionConditions> & {
+        visibility_sm?: number;
+        temperature?: number;
+    } = {}) {
+        this.time = time;
+        this.wind = wind;
+        this.turbulenceStrength = turbulenceStrength;
+        this.thermalStrength = thermalStrength;
+        this.visibility = visibility;
+        this.clouds = clouds;
+
+        if (visibility_sm) {
+            this.visibility_sm = visibility_sm;
+        }
+        if (temperature) {
+            this.temperature = temperature;
+        }
+    }
+
+    /**
+     * @returns {number} the Aerofly value for UTC hours + minutes/60 + seconds/3600. Ignores milliseconds ;)
+     */
+    get time_hours(): number {
+        return this.time.getUTCHours() + this.time.getUTCMinutes() / 60 + this.time.getUTCSeconds() / 3600;
+    }
+
+    /**
+     * @returns {string} Time representation like "20:15:00"
+     */
+    get time_presentational(): string {
+        return [this.time.getUTCHours(), this.time.getUTCMinutes(), this.time.getUTCSeconds()]
+            .map((t) => {
+                return String(t).padStart(2, "0");
+            })
+            .join(":");
+    }
+
+    /**
+     * @param {number} visibility_sm `this.visibility` in statute miles instead of meters
+     */
+    set visibility_sm(visibility_sm: number) {
+        this.visibility = visibility_sm * meterPerStatuteMile;
+    }
+
+    /**
+     * @returns {number} `this.visibility` in statute miles instead of meters
+     */
+    get visibility_sm(): number {
+        return this.visibility / meterPerStatuteMile;
+    }
+
+    /**
+     * Will set `this.thermalStrength`
+     * @param {number} temperature in °C
+     */
+    set temperature(temperature: number) {
+        // Range from -15°C to 35°C
+        this.thermalStrength = Math.max(0, (temperature + 15) / 50) ** 2;
+    }
+
+    /**
+     * @returns {number} in °C
+     */
+    get temperature(): number {
+        return Math.sqrt(this.thermalStrength) * 50 - 15;
+    }
+
+    /**
+     * @returns {AeroflyConfigurationNode[]} cloud elements
+     */
+    getCloudElements(): AeroflyConfigurationNode[] {
+        return this.clouds
+            .slice(0, 2) // Aerofly FS4 supports max 2 cloud layers
+            .flatMap((c: AeroflyMissionConditionsCloud, index: number) => c.getElements(index));
+    }
+
+    /**
+     * @returns {string} to use in Aerofly FS4's `custom_missions_user.tmc`
+     */
+    getElement(): AeroflyConfigurationNode {
+        if (this.clouds.length < 1) {
+            this.clouds = [new AeroflyMissionConditionsCloud(0, 0)];
+        }
+
+        return new AeroflyConfigurationNode("tmmission_conditions", "conditions")
+            .append(
+                new AeroflyConfigurationNode("tm_time_utc", "time")
+                    .appendChild("int32", "time_year", this.time.getUTCFullYear())
+                    .appendChild("int32", "time_month", this.time.getUTCMonth() + 1)
+                    .appendChild("int32", "time_day", this.time.getUTCDate())
+                    .appendChild("float64", "time_hours", this.time_hours, `${this.time_presentational} UTC`),
+            )
+            .appendChild("float64", "wind_direction", this.wind.direction)
+            .appendChild("float64", "wind_speed", this.wind.speed, "kts")
+            .appendChild("float64", "wind_gusts", this.wind.gusts, "kts")
+            .appendChild("float64", "turbulence_strength", this.turbulenceStrength)
+            .appendChild("float64", "thermal_strength", this.thermalStrength, `${this.temperature} °C`)
+            .appendChild("float64", "visibility", this.visibility, `${this.visibility_sm} SM`)
+            .append(...this.getCloudElements());
+    }
+
+    /**
+     * @returns {string} to use in Aerofly FS4's `custom_missions_user.tmc`
+     */
+    toString(): string {
+        return this.getElement().toString();
+    }
+}

package/src/dto/AeroflyMissionConditionsCloud.ts

@@ -0,0 +1,111 @@
+import { AeroflyConfigurationNode } from "../node/AeroflyConfigurationNode.js";
+import { feetPerMeter } from "./AeroflyMission.js";
+
+/**
+ * Cloud coverage codes
+ */
+export type AeroflyMissionConditionsCloudCoverCode = "CLR" | "FEW" | "SCT" | "BKN" | "OVC";
+
+/**
+ * @class
+ * A cloud layer for the current flight plan's weather data
+ *
+ * The purpose of this class is to collect data needed for Aerofly FS4's
+ * `custom_missions_user.tmc` flight plan file format, and export the structure
+ * for this file via the `toString()` method.
+ */
+export class AeroflyMissionConditionsCloud {
+    /**
+     * @property {number} cover 0..1, percentage
+     */
+    cover: number;
+
+    /**
+     * @property {number} base altitude in meters AGL
+     */
+    base: number;
+
+    /**
+     * @param {number} cover 0..1, percentage
+     * @param {number} base altitude in meters AGL
+     */
+    constructor(cover: number, base: number) {
+        this.cover = cover;
+        this.base = base;
+    }
+
+    /**
+     * @param {number} cover 0..1, percentage
+     * @param {number} base_feet altitude, but in feet AGL instead of meters AGL
+     * @returns {AeroflyMissionConditionsCloud} self
+     */
+    static createInFeet(cover: number, base_feet: number): AeroflyMissionConditionsCloud {
+        return new AeroflyMissionConditionsCloud(cover, base_feet / feetPerMeter);
+    }
+
+    /**
+     * @param {number} base_feet `this.base` in feet instead of meters
+     */
+    set base_feet(base_feet: number) {
+        this.base = base_feet / feetPerMeter;
+    }
+
+    /**
+     * @returns {number} `this.base` in feet instead of meters
+     */
+    get base_feet(): number {
+        return this.base * feetPerMeter;
+    }
+
+    /**
+     * @returns {string} Cloud coverage as text representation like "OVC" for `this.cover`
+     */
+    get cover_code(): AeroflyMissionConditionsCloudCoverCode {
+        if (this.cover < 1 / 8) {
+            return "CLR";
+        } else if (this.cover <= 2 / 8) {
+            return "FEW";
+        } else if (this.cover <= 4 / 8) {
+            return "SCT";
+        } else if (this.cover <= 7 / 8) {
+            return "BKN";
+        }
+        return "OVC";
+    }
+
+    /**
+     * @param {number} index if used in an array will set the array index
+     * @returns {AeroflyConfigurationNode[]} to use in Aerofly FS4's `custom_missions_user.tmc`
+     */
+    getElements(index: number = 0): AeroflyConfigurationNode[] {
+        const getIndexString = (index: number) => {
+            switch (index) {
+                case 0:
+                    return "cloud";
+                case 1:
+                    return "cirrus";
+                case 2:
+                    return "cumulus_mediocris";
+                default:
+                    return "more_clouds";
+            }
+        };
+
+        const indexString = getIndexString(index);
+
+        return [
+            new AeroflyConfigurationNode("float64", `${indexString}_cover`, this.cover ?? 0, this.cover_code),
+            new AeroflyConfigurationNode("float64", `${indexString}_base`, this.base, `${this.base_feet} ft AGL`),
+        ];
+    }
+
+    /**
+     * @param {number} index if used in an array will set the array index
+     * @returns {string} to use in Aerofly FS4's `custom_missions_user.tmc`
+     */
+    toString(index: number = 0): string {
+        return this.getElements()
+            .map((element) => element.toString(index))
+            .join("\n");
+    }
+}

package/src/dto/AeroflyMissionTargetPlane.ts

@@ -0,0 +1,62 @@
+import { AeroflyConfigurationNode } from "../node/AeroflyConfigurationNode.js";
+
+/**
+ * @class
+ * A target plane which the aircraft needs to cross.
+ */
+export class AeroflyMissionTargetPlane {
+    /**
+     * @property {number} longitude easting, using the World Geodetic
+     *    System 1984 (WGS 84) [WGS84] datum, with longitude and latitude units
+     *    of decimal degrees; -180..180
+     */
+    longitude: number;
+
+    /**
+     * @property {number} latitude northing, using the World Geodetic
+     *    System 1984 (WGS 84) [WGS84] datum, with longitude and latitude units
+     *    of decimal degrees; -90..90
+     */
+    latitude: number;
+
+    /**
+     * @property {number} dir in degree
+     */
+    dir: number;
+
+    /**
+     * @property {string} name of property
+     */
+    name: string;
+
+    /**
+     *
+     * @param {number} longitude easting, using the World Geodetic
+     *    System 1984 (WGS 84) [WGS84] datum, with longitude and latitude units
+     *    of decimal degrees; -180..180
+     * @param {number}latitude northing, using the World Geodetic
+     *    System 1984 (WGS 84) [WGS84] datum, with longitude and latitude units
+     *    of decimal degrees; -90..90
+     * @param {number} dir in degree
+     * @param {string} name of property
+     */
+    constructor(longitude: number, latitude: number, dir: number, name: string = "finish") {
+        this.longitude = longitude;
+        this.latitude = latitude;
+        this.dir = dir;
+        this.name = name;
+    }
+
+    getElement(): AeroflyConfigurationNode {
+        return new AeroflyConfigurationNode("tmmission_target_plane", this.name)
+            .appendChild("vector2_float64", "lon_lat", [this.longitude, this.latitude])
+            .appendChild("float64", "direction", this.dir);
+    }
+
+    /**
+     * @returns {string} to use in Aerofly FS4's `custom_missions_user.tmc`
+     */
+    toString(): string {
+        return this.getElement().toString();
+    }
+}

package/src/dto/AeroflyMissionsList.ts

@@ -0,0 +1,52 @@
+import { AeroflyConfigurationNode } from "../node/AeroflyConfigurationNode.js";
+import { AeroflyMission } from "./AeroflyMission.js";
+
+/**
+ * @class
+ * A list of flight plans.
+ *
+ * The purpose of this class is to collect data needed for Aerofly FS4's
+ * `custom_missions_user.tmc` flight plan file format, and export the structure
+ * for this file via the `toString()` method.
+ */
+export class AeroflyMissionsList {
+    /**
+     * @property {AeroflyMission[]} missions in this mission list
+     */
+    missions: AeroflyMission[];
+
+    /**
+     * @param {AeroflyMission[]} missions in this mission list
+     */
+    constructor(missions: AeroflyMission[] = []) {
+        this.missions = missions;
+    }
+
+    getElement(): AeroflyConfigurationNode {
+        return new AeroflyConfigurationNode("file", "").append(
+            new AeroflyConfigurationNode("tmmissions_list", "").append(
+                new AeroflyConfigurationNode("list_tmmission_definition", "missions").append(
+                    ...this.missions.map((m): AeroflyConfigurationNode =>{
+                        const mission = m.getElement();
+                        mission._comment = `End of ${mission.name}`;
+                        return mission;
+                    }),
+                ),
+            ),
+        );
+    }
+
+    /**
+     * @returns {string} to use in Aerofly FS4's `custom_missions_user.tmc`
+     */
+    toString(): string {
+        return this.getElement().toString();
+    }
+
+    /**
+     * @returns {string} XML represenation of this mission list
+     */
+    toXmlString(): string {
+        return this.getElement().toXmlString();
+    }
+}

package/src/index.test.ts

@@ -1,14 +1,12 @@
-import {
-    AeroflyConfigFileSet,
-    AeroflyMissionsList,
-    AeroflyMission,
-    AeroflyMissionConditions,
-    AeroflyMissionConditionsCloud,
-    AeroflyMissionCheckpoint,
-    AeroflyLocalizedText,
-    AeroflyMissionTargetPlane,
-} from "./index.js";
 import { strict as assert } from "node:assert";
+import { AeroflyLocalizedText } from "./index.js";
+import { AeroflyMission } from "./index.js";
+import { AeroflyMissionCheckpoint } from "./index.js";
+import { AeroflyMissionConditions } from "./index.js";
+import { AeroflyMissionConditionsCloud } from "./index.js";
+import { AeroflyMissionsList } from "./index.js";
+import { AeroflyMissionTargetPlane } from "./index.js";
+import { AeroflyConfigurationNode } from "./node/AeroflyConfigurationNode.js";
 
 const assertValidAeroflyStructure = (aeroflyString: string): void => {
     const openingBrackets = aeroflyString.match(/</g);
@@ -16,6 +14,7 @@ const assertValidAeroflyStructure = (aeroflyString: string): void => {
     const openingBrackets2 = aeroflyString.match(/\[/g);
     const closingBrackets2 = aeroflyString.match(/\]/g);
 
+    assert.ok(openingBrackets?.length ?? 0 > 0, "Has opening <");
     assert.strictEqual(openingBrackets?.length, closingBrackets?.length, "Number of <> matches");
     assert.strictEqual(openingBrackets2?.length, closingBrackets2?.length, "Number of [] matches");
 };
@@ -25,21 +24,17 @@ const assertIncludes = (string: string, includes: string): void => {
 };
 
 {
-    const file = new AeroflyConfigFileSet(0, "file", "");
-    file.pushRaw(
-        new AeroflyConfigFileSet(1, "tmmissions_list", "")
-            .pushRaw(
-                new AeroflyConfigFileSet(2, "list_tmmission_definition", "missions")
-                    .pushRaw(
-                        new AeroflyConfigFileSet(3, "tmmission_definition", "mission")
-                            .push("string8", "title", "KCCR #1: Concord / Buchanan Field")
-                            .push("float64", "origin_alt", 1066.799965862401, "3500 ft MSL")
-                            .toString(),
-                    )
-                    .pushRaw(new AeroflyConfigFileSet(3, "tmmission_definition", "mission").toString())
-                    .toString(),
-            )
-            .toString(),
+    const file = new AeroflyConfigurationNode("file", "");
+    file.append(
+        new AeroflyConfigurationNode("tmmissions_list", "").append(
+            new AeroflyConfigurationNode("list_tmmission_definition", "missions")
+                .append(
+                    new AeroflyConfigurationNode("tmmission_definition", "mission")
+                        .appendChild("string8", "title", "KCCR #1: Concord / Buchanan Field")
+                        .appendChild("float64", "origin_alt", 1066.799965862401, "3500 ft MSL"),
+                )
+                .append(new AeroflyConfigurationNode("tmmission_definition", "mission")),
+        ),
     );
     assertValidAeroflyStructure(file.toString());
     console.log("✅ AeroflyMission test successful");
@@ -245,6 +240,7 @@ const assertIncludes = (string: string, includes: string): void => {
 
     let missionListString = missionList.toString();
 
+    assert.strictEqual(missionListString, missionList.toString());
     assertIncludes(missionListString, "[origin]");
     assertIncludes(missionListString, "[tmmission_definition]");
     assertIncludes(missionListString, "[list_tmmission_checkpoint]");
@@ -295,6 +291,7 @@ const assertIncludes = (string: string, includes: string): void => {
 
     //console.dir(missionList.missions[0], { depth: null });
     //console.log(missionListString);
+    //console.log(missionList.getElement().toXmlString());
 
     console.log("✅ AeroflyMissionsList test successful");
 }