@fboes/aerofly-custom-missions 1.2.2 → 1.3.0

package/dist/index.test.js

@@ -1,10 +1,18 @@
-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) => {
     const openingBrackets = aeroflyString.match(/</g);
     const closingBrackets = aeroflyString.match(/>/g);
     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");
 };
@@ -12,16 +20,12 @@ const assertIncludes = (string, includes) => {
     assert.ok(string.includes(includes), `Includes "${includes}"`);
 };
 {
-    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");
 }
@@ -202,6 +206,7 @@ const assertIncludes = (string, includes) => {
     assert.strictEqual(missionList.missions[0].aircraft.name, "c172");
     assert.strictEqual(missionList.missions[0].aircraft.icao, "C172");
     let missionListString = missionList.toString();
+    assert.strictEqual(missionListString, missionList.toString());
     assertIncludes(missionListString, "[origin]");
     assertIncludes(missionListString, "[tmmission_definition]");
     assertIncludes(missionListString, "[list_tmmission_checkpoint]");
@@ -248,5 +253,6 @@ const assertIncludes = (string, includes) => {
     assertValidAeroflyStructure(missionListString);
     //console.dir(missionList.missions[0], { depth: null });
     //console.log(missionListString);
+    //console.log(missionList.getElement().toXmlString());
     console.log("✅ AeroflyMissionsList test successful");
 }

package/dist/node/AeroflyConfigurationNode.js

@@ -0,0 +1,82 @@
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _AeroflyConfigurationNode_instances, _AeroflyConfigurationNode_children, _AeroflyConfigurationNode_aeroflyEscape, _AeroflyConfigurationNode_xmlEscape;
+export class AeroflyConfigurationNode {
+    constructor(type, name, value = "", _comment = "") {
+        this.type = type;
+        this.name = name;
+        this.value = value;
+        this._comment = _comment;
+        _AeroflyConfigurationNode_instances.add(this);
+        _AeroflyConfigurationNode_children.set(this, []);
+    }
+    append(...nodes) {
+        __classPrivateFieldGet(this, _AeroflyConfigurationNode_children, "f").push(...nodes);
+        return this;
+    }
+    appendChild(type, name, value = "", _comment = "") {
+        this.append(new AeroflyConfigurationNode(type, name, value, _comment));
+        return this;
+    }
+    get valueAsString() {
+        let value = "";
+        if (this.value instanceof Array) {
+            value = this.value.join(" ");
+        }
+        else if (typeof value === "boolean") {
+            value = this.value ? "true" : "false";
+        }
+        else {
+            value = this.value.toString();
+        }
+        return value;
+    }
+    toString(indent = 0) {
+        const indentation = " ".repeat(4 * indent);
+        let tag = `${indentation}<[${this.type}][${this.name}][${__classPrivateFieldGet(this, _AeroflyConfigurationNode_instances, "m", _AeroflyConfigurationNode_aeroflyEscape).call(this, this.valueAsString)}]`;
+        if (__classPrivateFieldGet(this, _AeroflyConfigurationNode_children, "f").length > 0) {
+            tag += "\n";
+            tag += __classPrivateFieldGet(this, _AeroflyConfigurationNode_children, "f").map((child) => child.toString(indent + 1)).join("\n");
+            tag += `\n${indentation}>`;
+        }
+        else {
+            tag += ">";
+        }
+        if (this._comment) {
+            tag += ` // ${this._comment.replace(/[\n\r]/g, " ")}`;
+        }
+        return tag;
+    }
+    toXmlString(indent = 0) {
+        const indentation = " ".repeat(4 * indent);
+        const name = this.name || this.type;
+        let tag = indentation;
+        if (__classPrivateFieldGet(this, _AeroflyConfigurationNode_children, "f").length > 0) {
+            const index = this.valueAsString ? ` index="${__classPrivateFieldGet(this, _AeroflyConfigurationNode_instances, "m", _AeroflyConfigurationNode_xmlEscape).call(this, this.valueAsString)}"` : "";
+            tag += `<${name} type="${this.type}"${index}>`;
+            tag += "\n";
+            tag += __classPrivateFieldGet(this, _AeroflyConfigurationNode_children, "f").map((child) => child.toXmlString(indent + 1)).join("\n");
+            tag += `\n${indentation}</${name}>`;
+        }
+        else {
+            tag += `<${name} type="${this.type}">${__classPrivateFieldGet(this, _AeroflyConfigurationNode_instances, "m", _AeroflyConfigurationNode_xmlEscape).call(this, this.valueAsString)}</${name}>`;
+        }
+        if (this._comment) {
+            tag += ` <!-- ${__classPrivateFieldGet(this, _AeroflyConfigurationNode_instances, "m", _AeroflyConfigurationNode_xmlEscape).call(this, this._comment)} -->`;
+        }
+        return tag;
+    }
+}
+_AeroflyConfigurationNode_children = new WeakMap(), _AeroflyConfigurationNode_instances = new WeakSet(), _AeroflyConfigurationNode_aeroflyEscape = function _AeroflyConfigurationNode_aeroflyEscape(text) {
+    return text.replace(/\[/g, "(").replace(/\]/g, ")");
+}, _AeroflyConfigurationNode_xmlEscape = function _AeroflyConfigurationNode_xmlEscape(text) {
+    return text
+        .replace(/&/g, "&amp;")
+        .replace(/</g, "&lt;")
+        .replace(/>/g, "&gt;")
+        .replace(/"/g, "&quot;")
+        .replace(/'/g, "&#039;");
+};

package/docs/custom_missions_user.tmc

@@ -1,7 +1,6 @@
 <[file][][]
     <[tmmissions_list][][]
         <[list_tmmission_definition][missions][]
-// -----------------------------------------------------------------------------
             <[tmmission_definition][mission][]
                 <[string8][title][KCCR #1: Concord / Buchanan Field]>
                 <[string8][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.
@@ -10,7 +9,7 @@
 - Local navigational aids: VOR/DME CCR (117.00) 3.4 NM to the north]>
                 <[string8][tutorial_name][c172]> // Opens https://www.aerofly.com/aircraft-tutorials/c172
                 <[list_tmmission_definition_localized][localized_text][]
-                   <[tmmission_definition_localized][element][0]
+                    <[tmmission_definition_localized][element][0]
                         <[string8u][language][de]>
                         <[string8][title][Landeübung #1]>
                         <[string8][description][Probier die Landung]>
@@ -21,7 +20,6 @@
                 <[bool][is_featured][true]>
                 <[string8][flight_setting][cruise]>
                 <[string8u][aircraft_name][c172]>
-                //<[string8u][aircraft_livery][]>
                 <[stringt8c][aircraft_icao][C172]>
                 <[stringt8c][callsign][N51911]>
                 <[stringt8c][origin_icao][KCCR]>
@@ -32,7 +30,7 @@
                 <[tmvector2d][destination_lon_lat][-70.6139 41.3934]>
                 <[float64][destination_alt][20]> // 66 ft MSL
                 <[float64][destination_dir][221]>
-                <[float64][distance][1400]> // 2 km
+                <[float64][distance][1400]> // 1 km
                 <[float64][duration][7200]> // 120 min
                 <[bool][is_scheduled][true]>
                 <[tmmission_target_plane][finish][]
@@ -95,8 +93,7 @@
                         <[bool][fly_over][false]>
                     >
                 >
-            >
-// -----------------------------------------------------------------------------
+            > // End of mission
         >
     >
 >

package/docs/custom_missions_user.xml

@@ -0,0 +1,100 @@
+<file type="file">
+    <tmmissions_list type="tmmissions_list">
+        <missions type="list_tmmission_definition">
+            <mission type="tmmission_definition">
+                <title type="string8">KCCR #1: Concord / Buchanan Field</title>
+                <description type="string8">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</description>
+                <tutorial_name type="string8">c172</tutorial_name> <!-- Opens https://www.aerofly.com/aircraft-tutorials/c172 -->
+                <localized_text type="list_tmmission_definition_localized">
+                    <element type="tmmission_definition_localized" index="0">
+                        <language type="string8u">de</language>
+                        <title type="string8">Landeübung #1</title>
+                        <description type="string8">Probier die Landung</description>
+                    </element>
+                </localized_text>
+                <tags type="string8u">approach pattern</tags>
+                <difficulty type="float64">1</difficulty>
+                <is_featured type="bool">true</is_featured>
+                <flight_setting type="string8">cruise</flight_setting>
+                <aircraft_name type="string8u">c172</aircraft_name>
+                <aircraft_icao type="stringt8c">C172</aircraft_icao>
+                <callsign type="stringt8c">N51911</callsign>
+                <origin_icao type="stringt8c">KCCR</origin_icao>
+                <origin_lon_lat type="tmvector2d">-122.0736009331662 38.122300745843944</origin_lon_lat>
+                <origin_alt type="float64">1066.799965862401</origin_alt> <!-- 3500 ft MSL -->
+                <origin_dir type="float64">174.37511511143452</origin_dir>
+                <destination_icao type="stringt8c">KMVY</destination_icao>
+                <destination_lon_lat type="tmvector2d">-70.6139 41.3934</destination_lon_lat>
+                <destination_alt type="float64">20</destination_alt> <!-- 66 ft MSL -->
+                <destination_dir type="float64">221</destination_dir>
+                <distance type="float64">1400</distance> <!-- 1 km -->
+                <duration type="float64">7200</duration> <!-- 120 min -->
+                <is_scheduled type="bool">true</is_scheduled>
+                <finish type="tmmission_target_plane">
+                    <lon_lat type="vector2_float64">0 1</lon_lat>
+                    <direction type="float64">2</direction>
+                </finish>
+                <conditions type="tmmission_conditions">
+                    <time type="tm_time_utc">
+                        <time_year type="int32">2024</time_year>
+                        <time_month type="int32">6</time_month>
+                        <time_day type="int32">14</time_day>
+                        <time_hours type="float64">13.260555555555555</time_hours> <!-- 13:15:38 UTC -->
+                    </time>
+                    <wind_direction type="float64">190</wind_direction>
+                    <wind_speed type="float64">11</wind_speed> <!-- kts -->
+                    <wind_gusts type="float64">22</wind_gusts> <!-- kts -->
+                    <turbulence_strength type="float64">1</turbulence_strength>
+                    <thermal_strength type="float64">0.5184</thermal_strength> <!-- 21 °C -->
+                    <visibility type="float64">14484.096000000001</visibility> <!-- 9 SM -->
+                    <cloud_cover type="float64">0.1</cloud_cover> <!-- CLR -->
+                    <cloud_base type="float64">1523.9999512320016</cloud_base> <!-- 5000 ft AGL -->
+                    <cirrus_cover type="float64">0.2</cirrus_cover> <!-- FEW -->
+                    <cirrus_base type="float64">2285.9999268480024</cirrus_base> <!-- 7500 ft AGL -->
+                </conditions>
+                <checkpoints type="list_tmmission_checkpoint">
+                    <element type="tmmission_checkpoint" index="0">
+                        <type type="string8u">origin</type>
+                        <name type="string8u">KCCR</name>
+                        <lon_lat type="vector2_float64">-122.057 37.9897</lon_lat>
+                        <altitude type="float64">8</altitude> <!-- 27 ft -->
+                        <direction type="float64">-1</direction>
+                        <slope type="float64">0</slope>
+                    </element>
+                    <element type="tmmission_checkpoint" index="1">
+                        <type type="string8u">departure_runway</type>
+                        <name type="string8u">19L</name>
+                        <lon_lat type="vector2_float64">-122.05504061196366 37.993168229891225</lon_lat>
+                        <altitude type="float64">0</altitude> <!-- 0 ft -->
+                        <direction type="float64">0</direction>
+                        <slope type="float64">0</slope>
+                        <length type="float64">844.2959729825288</length> <!-- 2770 ft -->
+                    </element>
+                    <element type="tmmission_checkpoint" index="2">
+                        <type type="string8u">destination_runway</type>
+                        <name type="string8u">24</name>
+                        <lon_lat type="vector2_float64">-70.60730234370952 41.399093035543366</lon_lat>
+                        <altitude type="float64">20</altitude> <!-- 66 ft -->
+                        <direction type="float64">0</direction>
+                        <slope type="float64">0</slope>
+                        <length type="float64">1677.6191463161874</length> <!-- 5504 ft -->
+                        <frequency type="float64">108700000</frequency> <!-- 108.7 MHz -->
+                    </element>
+                    <element type="tmmission_checkpoint" index="3">
+                        <type type="string8u">destination</type>
+                        <name type="string8u">KMVY</name>
+                        <lon_lat type="vector2_float64">-70.6139 41.3934</lon_lat>
+                        <altitude type="float64">20</altitude> <!-- 66 ft -->
+                        <direction type="float64">0</direction>
+                        <slope type="float64">0</slope>
+                        <fly_over type="bool">false</fly_over>
+                    </element>
+                </checkpoints>
+            </mission> <!-- End of mission -->
+        </missions>
+    </tmmissions_list>
+</file>

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@fboes/aerofly-custom-missions",
-  "version": "1.2.2",
+  "version": "1.3.0",
   "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/AeroflyLocalizedText.ts

@@ -0,0 +1,74 @@
+import { AeroflyConfigurationNode } from "../node/AeroflyConfigurationNode.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;
+    }
+
+    /**
+     * @returns {AeroflyConfigurationNode} to use in Aerofly FS4's `custom_missions_user.tmc`
+     */
+    getElement(): AeroflyConfigurationNode {
+        return new AeroflyConfigurationNode("tmmission_definition_localized", "element")
+            .appendChild("string8u", "language", this.language)
+            .appendChild("string8", "title", this.title)
+            .appendChild("string8", "description", this.description);
+    }
+
+    /**
+     * @returns {string} to use in Aerofly FS4's `custom_missions_user.tmc`
+     */
+    toString(): string {
+        return this.getElement().toString();
+    }
+}