@fboes/aerofly-custom-missions 1.2.2 → 1.2.3

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@fboes/aerofly-custom-missions",
-  "version": "1.2.2",
+  "version": "1.2.3",
   "description": "Builder for Aerofly FS4 Custom Missions Files",
   "main": "dist/index.js",
   "scripts": {
     "test": "node ./dist/index.test.js",
     "start": "node ./dist/index.js",
     "prettier": "npx prettier --cache --write .",
-    "eslint": "npx eslint **/*.js --fix",
+    "eslint": "npx eslint src/*.ts --fix",
     "tsc": "npx tsc --build",
     "tsc-watch": "npx tsc --watch",
     "build": "npm run tsc && npm run eslint && npm run prettier"
@@ -21,15 +21,14 @@
   "license": "MIT",
   "type": "module",
   "devDependencies": {
-    "@eslint/js": "^9.5.0",
-    "@types/node": "^20.14.2",
-    "eslint": "^9.5.0",
+    "@types/node": "^20.11.19",
+    "@typescript-eslint/eslint-plugin": "^7.0.1",
+    "@typescript-eslint/parser": "^7.0.1",
+    "eslint": "^8.56.0",
     "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-jsdoc": "^48.2.12",
-    "eslint-plugin-prettier": "^5.1.3",
-    "globals": "^15.4.0",
-    "prettier": "3.3.2",
-    "typescript": "^5.4.5"
+    "eslint-plugin-jsdoc": "^48.1.0",
+    "prettier": "3.2.4",
+    "typescript": "^5.3.3"
   },
   "types": "./types/index.d.ts"
 }

package/src/dto/AeroflyConfigFileSet.ts

@@ -0,0 +1,35 @@
+export class AeroflyConfigFileSet {
+    #indent: number;
+    elements: string[];
+
+    constructor(indent: number, type: string, name: string, value: string = "") {
+        this.#indent = indent;
+        this.elements = [`${this.indent}<[${type}][${name}][${value}]`];
+    }
+
+    get indent(): string {
+        return "    ".repeat(this.#indent);
+    }
+
+    push(type: string, name: string, value: string | number | string[] | number[] | boolean, comment: string = "") {
+        if (value instanceof Array) {
+            value = value.join(" ");
+        } else if (typeof value === "boolean") {
+            value = value ? "true" : "false";
+        }
+        let tag = `${this.indent}    <[${type}][${name}][${value}]>`;
+        if (comment) {
+            tag += ` // ${comment}`;
+        }
+        return this.pushRaw(tag);
+    }
+
+    pushRaw(s: string) {
+        this.elements.push(s);
+        return this;
+    }
+
+    toString() {
+        return this.elements.join("\n") + "\n" + `${this.indent}>`;
+    }
+}

package/src/dto/AeroflyLocalizedText.ts

@@ -0,0 +1,69 @@
+import { AeroflyConfigFileSet } from "./AeroflyConfigFileSet.js";
+
+/**
+ * @class
+ * A translation for the mission title and description.
+ */
+export class AeroflyLocalizedText {
+    /**
+     * @property {string} language ISO 639-1 like
+     * - br
+     * - cn
+     * - de
+     * - es
+     * - fr
+     * - id
+     * - it
+     * - jp
+     * - kr
+     * - pl
+     * - sv
+     * - tr
+     */
+    language: string;
+
+    /**
+     * @property {string} title of this flight plan
+     */
+    title: string;
+
+    /**
+     * @property {string} description text, mission briefing, etc
+     */
+    description: string;
+
+    /**
+     * @param {string} language ISO 639-1 like
+     * - br
+     * - cn
+     * - de
+     * - es
+     * - fr
+     * - id
+     * - it
+     * - jp
+     * - kr
+     * - pl
+     * - sv
+     * - tr
+     * @param {string} title of this flight plan
+     * @param {string} description text, mission briefing, etc
+     */
+    constructor(language: string, title: string, description: string) {
+        this.language = language;
+        this.title = title;
+        this.description = description;
+    }
+
+    /**
+     * @param {number} index if used in an array will se the array index
+     * @returns {string} to use in Aerofly FS4's `custom_missions_user.tmc`
+     */
+    toString(index: number = 0): string {
+        return new AeroflyConfigFileSet(4, "tmmission_definition_localized", "element", String(index))
+            .push("string8u", "language", this.language)
+            .push("string8", "title", this.title)
+            .push("string8", "description", this.description)
+            .toString();
+    }
+}

package/src/dto/AeroflyMission.ts

@@ -0,0 +1,377 @@
+import { AeroflyConfigFileSet } from "./AeroflyConfigFileSet.js";
+import { AeroflyLocalizedText } from "./AeroflyLocalizedText.js";
+import { AeroflyMissionCheckpoint } from "./AeroflyMissionCheckpoint.js";
+import { AeroflyMissionConditions } from "./AeroflyMissionConditions.js";
+import { AeroflyMissionTargetPlane } from "./AeroflyMissionTargetPlane.js";
+
+export const feetPerMeter = 3.28084;
+export const meterPerStatuteMile = 1609.344;
+
+/**
+ * Data for the aircraft to use on this mission
+ * @property name lowercase Aerofly aircraft ID
+ * @property icao ICAO aircraft code
+ * @property livery (not used yet)
+ */
+export type AeroflyMissionAircraft = {
+    name: string;
+    icao: string;
+    livery: string;
+};
+
+/**
+ * State of aircraft systems. Configures power settings, flap positions etc
+ */
+export type AeroflyMissionSetting =
+    | "cold_and_dark"
+    | "before_start"
+    | "taxi"
+    | "takeoff"
+    | "cruise"
+    | "approach"
+    | "landing"
+    | "winch_launch"
+    | "aerotow"
+    | "pushback";
+
+/**
+ * Represents origin or destination conditions for flight
+ * @property icao uppercase ICAO airport ID
+ * @property longitude easting, using the World Geodetic
+ *    System 1984 (WGS 84) [WGS84] datum, with longitude and latitude units
+ *    of decimal degrees; -180..180
+ * @property latitude northing, using the World Geodetic
+ *    System 1984 (WGS 84) [WGS84] datum, with longitude and latitude units
+ *    of decimal degrees; -90..90
+ * @property dir in degree
+ * @property alt the height in meters above or below the WGS
+ *    84 reference ellipsoid
+ */
+export type AeroflyMissionPosition = {
+    icao: string;
+    longitude: number;
+    latitude: number;
+    dir: number;
+    alt: number;
+};
+
+/**
+ * @class
+ * A single flighplan, containing aircraft and weather data as well.
+ *
+ * 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 AeroflyMission {
+    /**
+     * @property {?string} tutorialName will create a link to a tutorial page at https://www.aerofly.com/aircraft-tutorials/
+     */
+    tutorialName: string | null;
+
+    /**
+     * @property {string} title of this flight plan
+     */
+    title: string;
+
+    /**
+     * @property {string} description text, mission briefing, etc
+     */
+    description: string;
+
+    /**
+     * @property {AeroflyLocalizedText[]} localizedTexts for title and description
+     */
+    localizedTexts: AeroflyLocalizedText[];
+
+    /**
+     * @property {string[]} tags
+     */
+    tags: string[];
+
+    /**
+     * @property {?boolean} isFeatured makes this mission pop up in "Challenges"
+     */
+    isFeatured: boolean | null;
+
+    /**
+     * @property {?number} difficulty values between 0.00 and 2.00 have been encountered, but they seem to be without limit
+     */
+    difficulty: number | null;
+
+    /**
+     * @property {"cold_and_dark"|"before_start"|"taxi"|"takeoff"|"cruise"|"approach"|"landing"|"winch_launch"|"aerotow"|"pushback"} flightSetting of aircraft, like "taxi", "cruise"
+     */
+    flightSetting: AeroflyMissionSetting;
+
+    /**
+     * @property {object} aircraft for this mission
+     */
+    aircraft: AeroflyMissionAircraft;
+
+    /**
+     * @property {string} callsign of aircraft, uppercased
+     */
+    callsign: string;
+
+    /**
+     * @property {object} origin position of aircraft, as well as name of starting airport. Position does not have match airport.
+     */
+    origin: AeroflyMissionPosition;
+
+    /**
+     * @property {object} destination position of aircraft, as well as name of destination airport. Position does not have match airport.
+     */
+    destination: AeroflyMissionPosition;
+
+    /**
+     * @property {?number} distance in meters
+     */
+    distance: number | null;
+
+    /**
+     * @property {?number} duration in seconds
+     */
+    duration: number | null;
+
+    /**
+     * @property {?boolean} isScheduled marks this flight as "Scheduled flight".
+     */
+    isScheduled: boolean | null;
+
+    /**
+     * @property {?AeroflyMissionTargetPlane} finish as finish condition
+     */
+    finish: AeroflyMissionTargetPlane | null;
+
+    /**
+     * @property {AeroflyMissionConditions} conditions like time and weather for mission
+     */
+    conditions: AeroflyMissionConditions;
+
+    /**
+     * @property {AeroflyMissionConditions} checkpoints form the actual flight plan
+     */
+    checkpoints: AeroflyMissionCheckpoint[];
+
+    /**
+     * @param {string} title of this flight plan
+     * @param {object} [additionalAttributes] allows to set additional attributes on creation
+     * @param {string} [additionalAttributes.description] text, mission briefing, etc
+     * @param {AeroflyLocalizedText[]} [additionalAttributes.localizedTexts] translations for title and description
+     * @param {?string} [additionalAttributes.tutorialName] will create a link to a tutorial page at https://www.aerofly.com/aircraft-tutorials/
+     * @param {string[]} [additionalAttributes.tags]
+     * @param {?boolean} [additionalAttributes.isFeatured] makes this mission pop up in "Challenges"
+     * @param {?number} [additionalAttributes.difficulty] values between 0.00 and 2.00 have been encountered, but they seem to be without limit
+     * @param {"cold_and_dark"|"before_start"|"taxi"|"takeoff"|"cruise"|"approach"|"landing"|"winch_launch"|"aerotow"|"pushback"} [additionalAttributes.flightSetting] of aircraft, like "taxi", "cruise"
+     * @param {{name:string,livery:string,icao:string}} [additionalAttributes.aircraft] for this mission
+     * @param {string} [additionalAttributes.callsign] of aircraft, uppercased
+     * @param {object} [additionalAttributes.origin] position of aircraft, as well as name of starting airport. Position does not have match airport.
+     * @param {object} [additionalAttributes.destination] position of aircraft, as well as name of destination airport. Position does not have match airport.
+     * @param {?number} [additionalAttributes.distance] in meters
+     * @param {?number} [additionalAttributes.duration] in seconds
+     * @param {?boolean} [additionalAttributes.isScheduled] marks this flight as "Scheduled flight".
+     * @param {?AeroflyMissionTargetPlane} [additionalAttributes.finish] as finish condition
+     * @param {AeroflyMissionConditions} [additionalAttributes.conditions] like time and weather for mission
+     * @param {AeroflyMissionCheckpoint[]} [additionalAttributes.checkpoints] form the actual flight plan
+     */
+    constructor(
+        title: string,
+        {
+            tutorialName = null,
+            description = "",
+            localizedTexts = [],
+            tags = [],
+            isFeatured = null,
+            difficulty = null,
+            flightSetting = "taxi",
+            aircraft = {
+                name: "c172",
+                icao: "",
+                livery: "",
+            },
+            callsign = "",
+            origin = {
+                icao: "",
+                longitude: 0,
+                latitude: 0,
+                dir: 0,
+                alt: 0,
+            },
+            destination = {
+                icao: "",
+                longitude: 0,
+                latitude: 0,
+                dir: 0,
+                alt: 0,
+            },
+            distance = null,
+            duration = null,
+            isScheduled = null,
+            finish = null,
+            conditions = new AeroflyMissionConditions(),
+            checkpoints = [],
+        }: {
+            tutorialName?: string | null;
+            description?: string;
+            localizedTexts?: AeroflyLocalizedText[];
+            tags?: string[];
+            isFeatured?: boolean | null;
+            difficulty?: number | null;
+            flightSetting?: AeroflyMissionSetting;
+            aircraft?: AeroflyMissionAircraft;
+            callsign?: string;
+            origin?: AeroflyMissionPosition;
+            destination?: AeroflyMissionPosition;
+            distance?: number | null;
+            duration?: number | null;
+            isScheduled?: boolean | null;
+            finish?: AeroflyMissionTargetPlane | null;
+            conditions?: AeroflyMissionConditions;
+            checkpoints?: AeroflyMissionCheckpoint[];
+        } = {},
+    ) {
+        this.tutorialName = tutorialName;
+        this.title = title;
+        this.checkpoints = checkpoints;
+        this.description = description;
+        this.localizedTexts = localizedTexts;
+        this.tags = tags;
+        this.isFeatured = isFeatured;
+        this.difficulty = difficulty;
+        this.flightSetting = flightSetting;
+        this.aircraft = aircraft;
+        this.callsign = callsign;
+        this.origin = origin;
+        this.destination = destination;
+        this.distance = distance;
+        this.duration = duration;
+        this.isScheduled = isScheduled;
+        this.finish = finish;
+        this.conditions = conditions;
+    }
+
+    /**
+     * @returns {string} indexed checkpoints
+     */
+    getCheckpointsString(): string {
+        return this.checkpoints
+            .map((c: AeroflyMissionCheckpoint, index: number): string => {
+                return c.toString(index);
+            })
+            .join("\n");
+    }
+
+    /**
+     * @returns {string} indexed checkpoints
+     */
+    getLocalizedTextsString(): string {
+        return this.localizedTexts
+            .map((c: AeroflyLocalizedText, index: number): string => {
+                return c.toString(index);
+            })
+            .join("\n");
+    }
+
+    /**
+     * @throws {Error} on missing waypoints
+     * @returns {string} to use in Aerofly FS4's `custom_missions_user.tmc`
+     */
+    toString(): string {
+        if (!this.origin.icao) {
+            const firstCheckpoint = this.checkpoints[0];
+            this.origin = {
+                icao: firstCheckpoint.name,
+                longitude: firstCheckpoint.longitude,
+                latitude: firstCheckpoint.latitude,
+                dir: this.origin.dir,
+                alt: firstCheckpoint.altitude,
+            };
+        }
+
+        if (!this.destination.icao) {
+            const lastCheckpoint = this.checkpoints[this.checkpoints.length - 1];
+            this.destination = {
+                icao: lastCheckpoint.name,
+                longitude: lastCheckpoint.longitude,
+                latitude: lastCheckpoint.latitude,
+                dir: lastCheckpoint.direction ?? 0,
+                alt: lastCheckpoint.altitude,
+            };
+        }
+
+        const fileSet = new AeroflyConfigFileSet(3, "tmmission_definition", "mission");
+        fileSet.push("string8", "title", this.title);
+        fileSet.push("string8", "description", this.description);
+
+        if (this.tutorialName !== null) {
+            fileSet.push(
+                "string8",
+                "tutorial_name",
+                this.tutorialName,
+                `Opens https://www.aerofly.com/aircraft-tutorials/${this.tutorialName}`,
+            );
+        }
+        if (this.localizedTexts.length > 0) {
+            fileSet.pushRaw(
+                new AeroflyConfigFileSet(4, "list_tmmission_definition_localized", "localized_text")
+                    .pushRaw(this.getLocalizedTextsString())
+                    .toString(),
+            );
+        }
+        if (this.tags.length > 0) {
+            fileSet.push("string8u", "tags", this.tags.join(" "));
+        }
+        if (this.difficulty !== null) {
+            fileSet.push("float64", "difficulty", this.difficulty);
+        }
+        if (this.isFeatured !== null) {
+            fileSet.push("bool", "is_featured", this.isFeatured);
+        }
+
+        fileSet.push("string8", "flight_setting", this.flightSetting);
+        fileSet.push("string8u", "aircraft_name", this.aircraft.name);
+        /*if (this.aircraft.livery) {
+            fileSet.push("string8", "aircraft_livery", this.aircraft.livery);
+        }*/
+        fileSet.push("stringt8c", "aircraft_icao", this.aircraft.icao);
+        fileSet.push("stringt8c", "callsign", this.callsign);
+        fileSet.push("stringt8c", "origin_icao", this.origin.icao);
+        fileSet.push("tmvector2d", "origin_lon_lat", [this.origin.longitude, this.origin.latitude]);
+        fileSet.push("float64", "origin_alt", this.origin.alt, `${Math.ceil(this.origin.alt * feetPerMeter)} ft MSL`);
+        fileSet.push("float64", "origin_dir", this.origin.dir);
+        fileSet.push("stringt8c", "destination_icao", this.destination.icao);
+        fileSet.push("tmvector2d", "destination_lon_lat", [this.destination.longitude, this.destination.latitude]);
+        fileSet.push(
+            "float64",
+            "destination_alt",
+            this.destination.alt,
+            `${Math.ceil(this.destination.alt * feetPerMeter)} ft MSL`,
+        );
+        fileSet.push("float64", "destination_dir", this.destination.dir);
+
+        if (this.distance !== null) {
+            fileSet.push("float64", "distance", this.distance, `${Math.round(this.distance / 1000)} km`);
+        }
+        if (this.duration !== null) {
+            fileSet.push("float64", "duration", this.duration, `${Math.round(this.duration / 60)} min`);
+        }
+        if (this.isScheduled !== null) {
+            fileSet.push("bool", "is_scheduled", this.isScheduled ? "true" : "false");
+        }
+        if (this.finish !== null) {
+            fileSet.pushRaw(this.finish.toString());
+        }
+
+        fileSet.pushRaw(this.conditions.toString());
+        if (this.checkpoints.length > 0) {
+            fileSet.pushRaw(
+                new AeroflyConfigFileSet(4, "list_tmmission_checkpoint", "checkpoints")
+                    .pushRaw(this.getCheckpointsString())
+                    .toString(),
+            );
+        }
+
+        return fileSet.toString();
+    }
+}