feat: generic wrapper for JSON APIs

.github/CHANGELOG.md

@@ -1,10 +1,15 @@
 ## Changelog
 
+Update <small>_ November 2024</small>
+
+- feat: generic wrapper for JSON APIs (01/11/2024)
+
 Update <small>_ October 2024</small>
 
 - fix: Changing A32NX Releases to Aircraft Releases in Role assignment (30/10/2024)
 - fix: Bugs with permissions causing crash during startup or prefix command handling (30/10/2024)
 - feat: Prefix Command Management (28/10/2024)
+
 - fix: role assignment typo for server announcements (22/10/2024)
 
 Update <small>_ August 2024</small>

package.json

@@ -27,7 +27,8 @@
     "moment": "^2.29.4",
     "mongoose": "^8.0.3",
     "node-fetch": "^2.6.10",
-    "winston": "^3.3.4"
+    "winston": "^3.3.4",
+    "zod": "^3.23.8"
   },
   "devDependencies": {
     "@flybywiresim/eslint-config": "^0.1.0",

src/commands/utils/liveFlights.ts

@@ -1,5 +1,6 @@
 import { ApplicationCommandType, Colors } from 'discord.js';
-import { slashCommand, slashCommandStructure, makeEmbed, Logger } from '../../lib';
+import { ZodError } from 'zod';
+import { slashCommand, slashCommandStructure, makeEmbed, Logger, fetchForeignAPI, TelexCountSchema } from '../../lib';
 
 const data = slashCommandStructure({
     name: 'live-flights',
@@ -11,24 +12,34 @@ const FBW_WEB_MAP_URL = 'https://flybywiresim.com/map';
 const FBW_API_BASE_URL = 'https://api.flybywiresim.com';
 
 export default slashCommand(data, async ({ interaction }) => {
+    await interaction.deferReply();
+
     try {
-        const flights = await fetch(`${FBW_API_BASE_URL}/txcxn/_count`).then((res) => res.json());
+        const flights = await fetchForeignAPI(`${FBW_API_BASE_URL}/txcxn/_count`, TelexCountSchema);
         const flightsEmbed = makeEmbed({
             title: 'Live Flights',
             description: `There are currently **${flights}** active flights with TELEX enabled.`,
             footer: { text: 'Note: This includes the A32NX, and other aircraft using FlyByWire systems' },
             url: FBW_WEB_MAP_URL,
             timestamp: new Date().toISOString(),
         });
-        return interaction.reply({ embeds: [flightsEmbed] });
+        return interaction.editReply({ embeds: [flightsEmbed] });
     } catch (e) {
+        if (e instanceof ZodError) {
+            const errorEmbed = makeEmbed({
+                title: 'TELEX Error',
+                description: 'The API returned unknown data.',
+                color: Colors.Red,
+            });
+            return interaction.editReply({ embeds: [errorEmbed] });
+        }
         const error = e as Error;
         Logger.error(error);
         const errorEmbed = makeEmbed({
             title: 'Error | Live Flights',
             description: error.message,
             color: Colors.Red,
         });
-        return interaction.reply({ embeds: [errorEmbed] });
+        return interaction.editReply({ embeds: [errorEmbed] });
     }
 });

src/commands/utils/metar.ts

@@ -1,6 +1,7 @@
 import { ApplicationCommandOptionType, ApplicationCommandType, Colors } from 'discord.js';
-import fetch from 'node-fetch';
-import { constantsConfig, slashCommand, slashCommandStructure, makeEmbed, makeLines, Logger } from '../../lib';
+import { Request } from 'node-fetch';
+import { ZodError } from 'zod';
+import { constantsConfig, fetchForeignAPI, makeEmbed, makeLines, slashCommand, slashCommandStructure, Metar, MetarSchema, Logger } from '../../lib';
 
 const data = slashCommandStructure({
     name: 'metar',
@@ -16,6 +17,12 @@ const data = slashCommandStructure({
     }],
 });
 
+const errorEmbed = (error: string) => makeEmbed({
+    title: 'METAR Error',
+    description: error,
+    color: Colors.Red,
+});
+
 export default slashCommand(data, async ({ interaction }) => {
     await interaction.deferReply();
 
@@ -32,55 +39,45 @@ export default slashCommand(data, async ({ interaction }) => {
         return interaction.editReply({ embeds: [noTokenEmbed] });
     }
 
+    let metar: Metar;
     try {
-        const metarReport: any = await fetch(`https://avwx.rest/api/metar/${icao}`, {
+        metar = await fetchForeignAPI(new Request(`https://avwx.rest/api/metar/${icao}`, {
             method: 'GET',
             headers: { Authorization: metarToken },
-        })
-            .then((res) => res.json());
-
-        if (metarReport.error) {
-            const invalidEmbed = makeEmbed({
-                title: `Metar Error | ${icao.toUpperCase()}`,
-                description: metarReport.error,
-                color: Colors.Red,
-            });
-            return interaction.editReply({ embeds: [invalidEmbed] });
-        }
-        const metarEmbed = makeEmbed({
-            title: `METAR Report | ${metarReport.station}`,
-            description: makeLines([
-                '**Raw Report**',
-                metarReport.raw,
-                '',
-                '**Basic Report:**',
-                `**Time Observed:** ${metarReport.time.dt}`,
-                `**Station:** ${metarReport.station}`,
-                `**Wind:** ${metarReport.wind_direction.repr}${metarReport.wind_direction.repr === 'VRB' ? '' : constantsConfig.units.DEGREES} at ${metarReport.wind_speed.repr} ${metarReport.units.wind_speed}`,
-                `**Visibility:** ${metarReport.visibility.repr} ${Number.isNaN(+metarReport.visibility.repr) ? '' : metarReport.units.visibility}`,
-                `**Temperature:** ${metarReport.temperature.repr} ${constantsConfig.units.CELSIUS}`,
-                `**Dew Point:** ${metarReport.dewpoint.repr} ${constantsConfig.units.CELSIUS}`,
-                `**Altimeter:** ${metarReport.altimeter.value.toString()} ${metarReport.units.altimeter}`,
-                `**Flight Rules:** ${metarReport.flight_rules}`,
-            ]),
-            fields: [
-                {
-                    name: 'Unsure of how to read the raw report?',
-                    value: 'Please refer to our guide [here.](https://docs.flybywiresim.com/pilots-corner/airliner-flying-guide/weather/)',
-                    inline: false,
-                },
-            ],
-            footer: { text: 'This METAR report may not accurately reflect the weather in the simulator. However, it will always be similar to the current conditions present in the sim.' },
-        });
-
-        return interaction.editReply({ embeds: [metarEmbed] });
+        }), MetarSchema);
     } catch (e) {
-        Logger.error('metar:', e);
-        const fetchErrorEmbed = makeEmbed({
-            title: 'Metar Error | Fetch Error',
-            description: 'There was an error fetching the METAR report. Please try again later.',
-            color: Colors.Red,
-        });
-        return interaction.editReply({ embeds: [fetchErrorEmbed] });
+        if (e instanceof ZodError) {
+            return interaction.editReply({ embeds: [errorEmbed('The API returned unknown data.')] });
+        }
+        Logger.error(`Error occured while fetching METAR: ${String(e)}`);
+        return interaction.editReply({ embeds: [errorEmbed(`An error occurred while fetching the latest METAR for ${icao.toUpperCase()}.`)] });
     }
+
+    const metarEmbed = makeEmbed({
+        title: `METAR Report | ${metar.station}`,
+        description: makeLines([
+            '**Raw Report**',
+            metar.raw,
+            '',
+            '**Basic Report:**',
+            `**Time Observed:** ${metar.time.dt}`,
+            `**Station:** ${metar.station}`,
+            `**Wind:** ${metar.wind_direction.repr}${metar.wind_direction.repr === 'VRB' ? '' : constantsConfig.units.DEGREES} at ${metar.wind_speed.repr} ${metar.units.wind_speed}`,
+            `**Visibility:** ${metar.visibility.repr} ${Number.isNaN(+metar.visibility.repr) ? '' : metar.units.visibility}`,
+            `**Temperature:** ${metar.temperature.repr} ${constantsConfig.units.CELSIUS}`,
+            `**Dew Point:** ${metar.dewpoint.repr} ${constantsConfig.units.CELSIUS}`,
+            `**Altimeter:** ${metar.altimeter.value.toString()} ${metar.units.altimeter}`,
+            `**Flight Rules:** ${metar.flight_rules}`,
+        ]),
+        fields: [
+            {
+                name: 'Unsure of how to read the raw report?',
+                value: 'Please refer to our guide [here](https://docs.flybywiresim.com/pilots-corner/airliner-flying-guide/weather/).',
+                inline: false,
+            },
+        ],
+        footer: { text: 'This METAR report may not accurately reflect the weather in the simulator. However, it will always be similar to the current conditions present in the sim.' },
+    });
+
+    return interaction.editReply({ embeds: [metarEmbed] });
 });

src/commands/utils/simbriefData.ts

@@ -1,6 +1,7 @@
 import { ApplicationCommandOptionType, ApplicationCommandType, Colors } from 'discord.js';
 import moment from 'moment';
-import { slashCommand, makeEmbed, makeLines, slashCommandStructure } from '../../lib';
+import { ZodError } from 'zod';
+import { fetchForeignAPI, Logger, makeEmbed, makeLines, SimbriefFlightPlan, SimbriefFlightPlanSchema, slashCommand, slashCommandStructure } from '../../lib';
 
 const data = slashCommandStructure({
     name: 'simbrief-data',
@@ -40,9 +41,9 @@ const simbriefdatarequestEmbed = makeEmbed({
     ]),
 });
 
-const errorEmbed = (errorMessage: any) => makeEmbed({
+const errorEmbed = (error: string) => makeEmbed({
     title: 'SimBrief Error',
-    description: makeLines(['SimBrief data could not be read.', errorMessage]),
+    description: error,
     color: Colors.Red,
 });
 
@@ -53,10 +54,10 @@ const simbriefIdMismatchEmbed = (enteredId: any, flightplanId: any) => makeEmbed
     ]),
 });
 
-const simbriefEmbed = (flightplan: any) => makeEmbed({
+const simbriefEmbed = (flightplan: SimbriefFlightPlan) => makeEmbed({
     title: 'SimBrief Data',
     description: makeLines([
-        `**Generated at**: ${moment(flightplan.params.time_generated * 1000).format('DD.MM.YYYY, HH:mm:ss')}`,
+        `**Generated at**: ${moment(Number.parseInt(flightplan.params.time_generated) * 1000).format('DD.MM.YYYY, HH:mm:ss')}`,
         `**AirFrame**: ${flightplan.aircraft.name} ${flightplan.aircraft.internal_id} ${(flightplan.aircraft.internal_id === FBW_AIRFRAME_ID) ? '(provided by FBW)' : ''}`,
         `**AIRAC Cycle**: ${flightplan.params.airac}`,
         `**Origin**: ${flightplan.origin.icao_code} ${flightplan.origin.plan_rwy}`,
@@ -71,23 +72,33 @@ export default slashCommand(data, async ({ interaction }) => {
         return interaction.reply({ embeds: [simbriefdatarequestEmbed] });
     }
 
+    await interaction.deferReply();
+
     if (interaction.options.getSubcommand() === 'retrieve') {
         const simbriefId = interaction.options.getString('pilot_id');
-        if (!simbriefId) return interaction.reply({ content: 'Invalid pilot ID!', ephemeral: true });
+        if (!simbriefId) return interaction.editReply({ content: 'Invalid pilot ID!' });
 
-        const flightplan = await fetch(`https://www.simbrief.com/api/xml.fetcher.php?json=1&userid=${simbriefId}&username=${simbriefId}`).then((res) => res.json());
+        let flightplan: SimbriefFlightPlan;
+        try {
+            flightplan = await fetchForeignAPI<SimbriefFlightPlan>(`https://www.simbrief.com/api/xml.fetcher.php?json=1&userid=${simbriefId}&username=${simbriefId}`, SimbriefFlightPlanSchema);
+        } catch (e) {
+            if (e instanceof ZodError) {
+                return interaction.editReply({ embeds: [errorEmbed('The API returned unknown data.')] });
+            }
+            Logger.error(`Error while fetching SimBrief flightplan: ${String(e)}`);
+            return interaction.editReply({ embeds: [errorEmbed('An error occurred while fetching the SimBrief flightplan.')] });
+        }
 
         if (flightplan.fetch.status !== 'Success') {
-            interaction.reply({ embeds: [errorEmbed(flightplan.fetch.status)], ephemeral: true });
-            return Promise.resolve();
+            return interaction.editReply({ embeds: [errorEmbed(flightplan.fetch.status)] });
         }
 
         if (!simbriefId.match(/\D/) && simbriefId !== flightplan.params.user_id) {
-            interaction.reply({ embeds: [simbriefIdMismatchEmbed(simbriefId, flightplan.params.user_id)] });
+            return interaction.editReply({ embeds: [simbriefIdMismatchEmbed(simbriefId, flightplan.params.user_id)] });
         }
-        interaction.reply({ embeds: [simbriefEmbed(flightplan)] });
 
-        return Promise.resolve();
+        return interaction.editReply({ embeds: [simbriefEmbed(flightplan)] });
     }
-    return Promise.resolve();
+
+    return interaction.editReply({ content: 'Unknown subcommand.' });
 });