@fboes/aerofly-custom-missions 1.6.0 → 1.8.0

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 This changelog documents all notable changes to the Aerofly Custom Missions project. Each version entry includes a list of changes, with the most recent version at the top.
 
+## [1.7.0] - 2026-04-19
+
+- Added new flight configuration strings to `AeroflySettingsFlight`
+
+## [1.6.0]
+
+- Added `toJSON` improvements to most DTOs
+- Added JSON schema for custom missions as JSON
+
 ## [1.5.0]
 
 - Added clouds elements getter

package/dist/dto/AeroflyMission.js

@@ -180,4 +180,47 @@ export class AeroflyMission {
     toString() {
         return this.getElement().toString();
     }
+    static fromJSON(json) {
+        if (typeof json !== "object" || json === null) {
+            throw new Error("Invalid mission data");
+        }
+        const data = json;
+        return new AeroflyMission(String(data.title ?? ""), {
+            tutorialName: String(data.tutorialName ?? ""),
+            description: String(data.description ?? ""),
+            localizedTexts: [], // TODO
+            tags: [], // TODO
+            isFeatured: data.isFeatured !== undefined ? Boolean(data.isFeatured) : null,
+            difficulty: data.difficulty !== undefined ? Number(data.difficulty) : null,
+            flightSetting: String(data.flightSetting ?? "taxi"),
+            aircraft: {
+                name: "c172",
+                icao: "",
+                livery: "",
+            },
+            callsign: String(data.callsign ?? ""),
+            fuelMass: data.fuelMass !== undefined ? Number(data.fuelMass) : null,
+            payloadMass: data.payloadMass !== undefined ? Number(data.payloadMass) : null,
+            origin: {
+                icao: "",
+                longitude: 0,
+                latitude: 0,
+                dir: 0,
+                alt: 0,
+            },
+            destination: {
+                icao: "",
+                longitude: 0,
+                latitude: 0,
+                dir: 0,
+                alt: 0,
+            },
+            distance: data.distance !== undefined ? Number(data.distance) : null,
+            duration: data.duration !== undefined ? Number(data.duration) : null,
+            isScheduled: data.isScheduled !== undefined ? Boolean(data.isScheduled) : null,
+            finish: null, // TODO
+            conditions: AeroflyMissionConditions.fromJSON(data.conditions),
+            checkpoints: [], // TODO
+        });
+    }
 }

package/dist/dto/AeroflyMission.test.js

@@ -75,10 +75,11 @@ describe("AeroflyMission", () => {
                 flyOver: false,
             }),
         ];
-        const mission = new AeroflyMission("KCCR #1: Concord / Buchanan Field", {
+        const mission = new AeroflyMission("Landing practice #1: Concord / Buchanan Field", {
             checkpoints,
             conditions,
-            description: `It is a gusty, clear early morning, and you are 8 NM to the north of the towered airport Concord / Buchanan Field (27ft). As the wind is 11 kts from 190°, the main landing runway is 19L (191° / 844m). Fly the pattern and land safely.
+            description: `\
+It is a gusty, clear early morning, and you are 8 NM to the north of the towered airport Concord / Buchanan Field (27ft). As the wind is 11 kts from 190°, the main landing runway is 19L (191° / 844m). Fly the pattern and land safely.
 
 - Local tower / CTAF frequency: 123.90
 - Local navigational aids: VOR/DME CCR (117.00) 3.4 NM to the north`,
@@ -89,6 +90,8 @@ describe("AeroflyMission", () => {
                 icao: "C172",
             },
             callsign: "N51911",
+            fuelMass: 80,
+            payloadMass: 90,
             origin: {
                 icao: "KCCR",
                 longitude: -122.0736009331662,
@@ -133,7 +136,11 @@ describe("AeroflyMission", () => {
         //console.log(missionListString);
         mission.difficulty = 1.0;
         mission.isFeatured = true;
-        mission.localizedTexts.push(new AeroflyLocalizedText("de", "Landeübung #1", "Probier die Landung"));
+        mission.localizedTexts.push(new AeroflyLocalizedText("de", `\
+Landeübung #1: Concord / Buchanan Field`, `Es ist ein böiger, klarer früher Morgen, und du bist 8 Seemeilen nördlich des turmhohen Flughafens Concord / Buchanan Field (27 Fuß). Da der Wind 11 Knoten aus 190° erreicht, beträgt die Hauptlandebahn 19L (191° / 844m). Fliege das Muster und lande sicher.
+
+- Lokaler Tower / CTAF-Frequenz: 123,90
+- Lokale Navigationshilfen: VOR/DME CCR (117,00) 3,4 Seemeilen nördlich`));
         mission.distance = 1400;
         mission.duration = 2 * 60 * 60;
         mission.tags.push("approach");
@@ -162,5 +169,6 @@ describe("AeroflyMission", () => {
         fs.writeFileSync("docs/custom_missions_user.tmc", fileContent);
         const xmlContent = file.toXmlString();
         fs.writeFileSync("docs/custom_missions_user.xml", xmlContent);
+        fs.writeFileSync("docs/custom_missions_user.json", JSON.stringify(file, null, 2));
     });
 });

package/dist/dto/AeroflyMissionConditions.js

@@ -119,4 +119,28 @@ export class AeroflyMissionConditions {
     toString() {
         return this.getElement().toString();
     }
+    static fromJSON(json) {
+        if (typeof json !== "object" || json === null) {
+            throw new Error("Invalid mission condition data");
+        }
+        const data = json;
+        if (typeof data.wind !== "object" || data.wind === null) {
+            throw new Error("Invalid wind data");
+        }
+        const wind = data.wind;
+        return new AeroflyMissionConditions({
+            time: data.time ? new Date(String(data.time)) : new Date(),
+            wind: {
+                direction: Number(wind.direction ?? 0),
+                speed: Number(wind.speed ?? 0),
+                gusts: Number(wind.gusts ?? 0),
+            },
+            turbulenceStrength: Number(data.turbulenceStrength ?? 0),
+            thermalStrength: Number(data.thermalStrength ?? 0),
+            visibility: Number(data.visibility ?? 25_000),
+            visibility_sm: Number(data.visibility_sm ?? 0),
+            temperature: Number(data.temperature ?? 0),
+            clouds: [], // TODO
+        });
+    }
 }

package/dist/dto/AeroflyMissionsList.js

@@ -1,4 +1,5 @@
 import { AeroflyConfigurationNode, AeroflyConfigurationNodeSpacer } from "../node/AeroflyConfigurationNode.js";
+import { AeroflyMission } from "./AeroflyMission.js";
 /**
  * @class
  * A list of flight plans.
@@ -29,4 +30,14 @@ export class AeroflyMissionsList {
     toXmlString() {
         return this.getElement().toXmlString();
     }
+    toJSON() {
+        return this.missions;
+    }
+    static fromJSON(json) {
+        if (!Array.isArray(json)) {
+            throw new Error("Mission list base node must be of array type");
+        }
+        const data = json;
+        return new AeroflyMissionsList(data.map((d) => AeroflyMission.fromJSON(d)));
+    }
 }

package/dist/dto-flight/AeroflyFlight.test.js

@@ -63,6 +63,7 @@ describe("AeroflyFlight", () => {
         fs.writeFileSync("docs/flight.mcf", fileContent);
         const xmlContent = flight.toXmlString();
         fs.writeFileSync("docs/flight.xml", xmlContent);
+        fs.writeFileSync("docs/flight.json", JSON.stringify(flight, null, 2));
         assertValidAeroflyStructure(fileContent);
         assert.ok(fileContent.includes("c172"));
     });

package/dist/dto-flight/AeroflyNavRouteAirports.js

@@ -34,6 +34,14 @@ class AeroflyNavRouteAirport extends AeroflyNavRouteBase {
         }
         return element;
     }
+    toJSON() {
+        return {
+            ...this,
+            uid: this.uid !== null ? this.uid.toString() : null,
+            elevation: undefined,
+            elevation_ft: this.elevation_ft,
+        };
+    }
 }
 export class AeroflyNavRouteOrigin extends AeroflyNavRouteAirport {
     /**

package/dist/dto-flight/AeroflyNavRouteBase.js

@@ -45,6 +45,12 @@ export class AeroflyNavRouteBase {
             : new AeroflyConfigurationNodeComment("uint64", "Uid", ""));
         return element;
     }
+    toJSON() {
+        return {
+            ...this,
+            uid: this.uid !== null ? this.uid.toString() : null,
+        };
+    }
     /**
      * @returns {string} to use in Aerofly FS4's `main.mcf`
      */

package/dist/dto-flight/AeroflyNavRouteRunway.js

@@ -51,6 +51,16 @@ class AeroflyNavRouteRunway extends AeroflyNavRouteBase {
         }
         return element;
     }
+    toJSON() {
+        return {
+            ...this,
+            uid: this.uid !== null ? this.uid.toString() : null,
+            elevation: undefined,
+            elevation_ft: this.elevation_ft,
+            runwayLength: undefined,
+            runwayLength_ft: this.runwayLength_ft,
+        };
+    }
 }
 export class AeroflyNavRouteDepartureRunway extends AeroflyNavRouteRunway {
     /**

package/dist/dto-flight/AeroflyNavRouteTransition.js

@@ -39,6 +39,15 @@ class AeroflyNavRouteTransition extends AeroflyNavRouteBase {
             .appendChild("uint64", "TransitionUid", this.transitionUid ?? 0);
         return element;
     }
+    toJSON() {
+        return {
+            ...this,
+            uid: this.uid !== null ? this.uid.toString() : null,
+            transitionUid: this.transitionUid !== null ? this.transitionUid.toString() : null,
+            elevation: undefined,
+            elevation_ft: this.elevation_ft,
+        };
+    }
 }
 export class AeroflyNavRouteApproach extends AeroflyNavRouteTransition {
     /**

package/dist/dto-flight/AeroflyNavRouteWaypoint.js

@@ -12,7 +12,7 @@ export class AeroflyNavRouteWaypoint extends AeroflyNavRouteBase {
      * @param {boolean} [options.flyOver] if true, the waypoint is meant to be flown over, otherwise it can be used as a fly-by waypoint
      * @param {?bigint} [options.uid] unique identifier for the waypoint, will be generated automatically if not provided
      */
-    constructor(identifier, longitude, latitude, { navaidFrequency = null, altitude = null, altitude_ft = null, flyOver = false, uid = null, } = {}) {
+    constructor(identifier, longitude, latitude, { navaidFrequency = null, navaidFrequency_khz = null, navaidFrequency_mhz = null, altitude = null, altitude_ft = null, flyOver = false, uid = null, } = {}) {
         super("waypoint", identifier, longitude, latitude, { uid });
         this.identifier = identifier;
         this.longitude = longitude;
@@ -22,6 +22,12 @@ export class AeroflyNavRouteWaypoint extends AeroflyNavRouteBase {
         if (altitude_ft !== null) {
             this.altitude_ft = altitude_ft;
         }
+        if (navaidFrequency_khz !== null) {
+            this.navaidFrequency_khz = navaidFrequency_khz;
+        }
+        if (navaidFrequency_mhz !== null) {
+            this.navaidFrequency_mhz = navaidFrequency_mhz;
+        }
         this.flyOver = flyOver;
     }
     /**
@@ -33,6 +39,18 @@ export class AeroflyNavRouteWaypoint extends AeroflyNavRouteBase {
     set altitude_ft(altitude_ft) {
         this.altitude = altitude_ft !== null ? Convert.convertFeetToMeter(altitude_ft) : null;
     }
+    get navaidFrequency_khz() {
+        return this.navaidFrequency ? this.navaidFrequency / 1000 : null;
+    }
+    set navaidFrequency_khz(navaidFrequency_khz) {
+        this.navaidFrequency = navaidFrequency_khz !== null ? navaidFrequency_khz * 1000 : null;
+    }
+    get navaidFrequency_mhz() {
+        return this.navaidFrequency ? this.navaidFrequency / 1000_000 : null;
+    }
+    set navaidFrequency_mhz(navaidFrequency_mhz) {
+        this.navaidFrequency = navaidFrequency_mhz !== null ? navaidFrequency_mhz * 1000_000 : null;
+    }
     /**
      * @returns {AeroflyVector3Float} to use in Aerofly FS4's `main.mcf`
      */
@@ -55,4 +73,14 @@ export class AeroflyNavRouteWaypoint extends AeroflyNavRouteBase {
             .appendChild("bool", "FlyOver", this.flyOver);
         return element;
     }
+    toJSON() {
+        return {
+            ...this,
+            uid: this.uid !== null ? this.uid.toString() : null,
+            altitude: undefined,
+            altitude_ft: this.altitude_ft,
+            navaidFrequency: undefined,
+            navaidFrequency_khz: this.navaidFrequency_khz,
+        };
+    }
 }

package/dist/dto-flight/AeroflyNavigationConfig.js

@@ -41,6 +41,13 @@ export class AeroflyNavigationConfig {
             .append(new AeroflyConfigurationNode("pointer_list_tmnav_route_way", "Ways").append(...this.getCheckpointElements())))
             .append(new AeroflyConfigurationNode("list_fixed_tmnav_fix", "Fixes", []));
     }
+    toJSON() {
+        return {
+            ...this,
+            cruiseAltitude: undefined,
+            cruiseAltitude_ft: this.cruiseAltitude_ft,
+        };
+    }
     /**
      * @returns {string} to use in Aerofly FS4's `main.mcf`
      */

package/dist/dto-flight/AeroflySettingsCloud.js

@@ -91,6 +91,13 @@ export class AeroflySettingsCloud {
                 new AeroflyConfigurationNodeComment("float64", `${indexString}_height`, this.height, `${Math.floor(this.height_ft)} ft AGL`),
             ];
     }
+    toJSON() {
+        return {
+            ...this,
+            height: undefined,
+            height_ft: this.height_ft,
+        };
+    }
     /**
      * @param {number} index if used in an array will set the array index
      * @returns {string} to use in Aerofly FS4's `main.mcf`

package/dist/dto-flight/AeroflySettingsFlight.js

@@ -86,6 +86,13 @@ export class AeroflySettingsFlight {
             .appendChild("string8u", "airport", this.airport)
             .appendChild("string8u", "runway", this.runway);
     }
+    toJSON() {
+        return {
+            ...this,
+            altitude_meter: undefined,
+            altitude_ft: this.altitude_ft,
+        };
+    }
     /**
      * @returns {string} to use in Aerofly FS4's `main.mcf`
      */

package/dist/dto-flight/AeroflySettingsFuelLoad.js

@@ -1,4 +1,5 @@
 import { AeroflyConfigurationNode } from "../node/AeroflyConfigurationNode.js";
+import { Convert } from "../node/Convert.js";
 export class AeroflySettingsFuelLoad {
     /**
      * @param {string} aircraft  aerofly aircraft name (e.g. "c172")
@@ -14,6 +15,18 @@ export class AeroflySettingsFuelLoad {
         this.payloadMass = payloadMass;
         this.configuration = configuration;
     }
+    get fuelMass_lb() {
+        return Convert.convertKgToLb(this.fuelMass);
+    }
+    set fuelMass_lb(fuelMass_lb) {
+        this.fuelMass = Convert.convertLbToKg(fuelMass_lb);
+    }
+    get payloadMass_lb() {
+        return Convert.convertKgToLb(this.payloadMass);
+    }
+    set payloadMass_lb(payloadMass_lb) {
+        this.payloadMass = Convert.convertLbToKg(payloadMass_lb);
+    }
     getElement() {
         return new AeroflyConfigurationNode("tmsettings_fuel_load", "fuel_load_setting")
             .appendChild("fuel_load_configuration", "configuration", this.fuelMass > 0 ? "Keep" : this.configuration)

package/dist/node/Convert.js

@@ -69,4 +69,10 @@ export class Convert {
     static convertFeetToMeter(feet) {
         return feet / 3.28084;
     }
+    static convertKgToLb(kg) {
+        return kg;
+    }
+    static convertLbToKg(lb) {
+        return lb;
+    }
 }

package/docs/custom_missions_user.json

@@ -0,0 +1,131 @@
+[
+  {
+    "tutorialName": "c172",
+    "title": "Landing practice #1: Concord / Buchanan Field",
+    "checkpoints": [
+      {
+        "type": "origin",
+        "name": "KCCR",
+        "longitude": -122.057,
+        "latitude": 37.9897,
+        "altitude": 8,
+        "altitudeConstraint": null,
+        "direction": null,
+        "slope": null,
+        "length": null,
+        "frequency": null,
+        "flyOver": null
+      },
+      {
+        "type": "departure_runway",
+        "name": "19L",
+        "longitude": -122.05504061196366,
+        "latitude": 37.993168229891225,
+        "altitude": 0,
+        "altitudeConstraint": null,
+        "direction": null,
+        "slope": null,
+        "length": 844.2959729825288,
+        "frequency": null,
+        "flyOver": null
+      },
+      {
+        "type": "destination_runway",
+        "name": "24",
+        "longitude": -70.60730234370952,
+        "latitude": 41.399093035543366,
+        "altitude": 20,
+        "altitudeConstraint": null,
+        "direction": null,
+        "slope": null,
+        "length": 1677.6191463161874,
+        "frequency": 108700000,
+        "flyOver": null
+      },
+      {
+        "type": "destination",
+        "name": "KMVY",
+        "longitude": -70.6139,
+        "latitude": 41.3934,
+        "altitude": 20,
+        "altitudeConstraint": null,
+        "direction": null,
+        "slope": null,
+        "length": null,
+        "frequency": null,
+        "flyOver": false
+      }
+    ],
+    "description": "It is a gusty, clear early morning, and you are 8 NM to the north of the towered airport Concord / Buchanan Field (27ft). As the wind is 11 kts from 190°, the main landing runway is 19L (191° / 844m). Fly the pattern and land safely.\n\n- Local tower / CTAF frequency: 123.90\n- Local navigational aids: VOR/DME CCR (117.00) 3.4 NM to the north",
+    "localizedTexts": [
+      {
+        "language": "de",
+        "title": "Landeübung #1: Concord / Buchanan Field",
+        "description": "Es ist ein böiger, klarer früher Morgen, und du bist 8 Seemeilen nördlich des turmhohen Flughafens Concord / Buchanan Field (27 Fuß). Da der Wind 11 Knoten aus 190° erreicht, beträgt die Hauptlandebahn 19L (191° / 844m). Fliege das Muster und lande sicher.\n\n- Lokaler Tower / CTAF-Frequenz: 123,90\n- Lokale Navigationshilfen: VOR/DME CCR (117,00) 3,4 Seemeilen nördlich"
+      }
+    ],
+    "tags": [
+      "approach",
+      "pattern"
+    ],
+    "isFeatured": true,
+    "difficulty": 1,
+    "flightSetting": "cruise",
+    "aircraft": {
+      "name": "c172",
+      "livery": "default",
+      "icao": "C172"
+    },
+    "callsign": "N51911",
+    "fuelMass": 80,
+    "payloadMass": 90,
+    "origin": {
+      "icao": "KCCR",
+      "longitude": -122.0736009331662,
+      "latitude": 38.122300745843944,
+      "dir": 174.37511511143452,
+      "alt": 1066.799965862401
+    },
+    "destination": {
+      "icao": "KMVY",
+      "longitude": -70.6139,
+      "latitude": 41.3934,
+      "dir": 221,
+      "alt": 20
+    },
+    "distance": 1400,
+    "duration": 7200,
+    "isScheduled": true,
+    "finish": {
+      "longitude": 0,
+      "latitude": 1,
+      "dir": 2,
+      "name": "finish"
+    },
+    "conditions": {
+      "clouds": [
+        {
+          "cover": 0.1,
+          "base": 1523.9999512320016
+        },
+        {
+          "cover": 0.2,
+          "base": 2285.9999268480024
+        },
+        {
+          "cover": 0.1,
+          "base": 2895.599907340803
+        }
+      ],
+      "time": "2024-06-14T13:15:38.000Z",
+      "wind": {
+        "direction": 190,
+        "speed": 11,
+        "gusts": 22
+      },
+      "turbulenceStrength": 1,
+      "thermalStrength": 0.5184,
+      "visibility": 14484.096000000001
+    }
+  }
+]