From 06060f394f9f5a19272be63f58f2ef11443f11ed Mon Sep 17 00:00:00 2001
From: Johan Ohly <johanohly@gmail.com>
Date: Thu, 26 Sep 2024 11:06:10 +0200
Subject: [PATCH] feat: export flights (#46)

* feat: export flights

* fix: export to csv and json

* fix: import from AirTrail export

* docs: add guide to importing from AirTrail export
---
 docs/docs/features/export.md                  |  93 ++++++++++++++
 docs/docs/features/import.md                  |  26 +++-
 .../modals/settings/SettingsModal.svelte      |   4 +
 .../modals/settings/pages/ExportPage.svelte   |  64 ++++++++++
 .../modals/settings/pages/ImportPage.svelte   |   6 +-
 .../modals/settings/pages/PageHeader.svelte   |  19 ++-
 .../components/modals/settings/pages/index.ts |   1 +
 src/lib/import/airtrail.ts                    | 116 ++++++++++++++++++
 src/lib/import/index.ts                       |   5 +-
 src/lib/server/routes/flight.ts               |  40 +++++-
 src/lib/utils/csv.ts                          |  28 +++++
 11 files changed, 387 insertions(+), 15 deletions(-)
 create mode 100644 docs/docs/features/export.md
 create mode 100644 src/lib/components/modals/settings/pages/ExportPage.svelte
 create mode 100644 src/lib/import/airtrail.ts

diff --git a/docs/docs/features/export.md b/docs/docs/features/export.md
new file mode 100644
index 0000000..a330848
--- /dev/null
+++ b/docs/docs/features/export.md
@@ -0,0 +1,93 @@
+---
+sidebar_position: 2
+---
+
+# Export
+
+The export feature allows you to export your flight data from AirTrail.
+
+## Export flights
+
+To export your flights, follow these steps:
+
+1. Go to the AirTrail application.
+2. Go to the settings page.
+3. Click on the "Export" tab.
+4. Choose your desired export format (CSV or JSON).
+
+## Export formats
+
+### CSV
+
+The CSV export option allows you to export your flights as a CSV file, which can be opened in any spreadsheet
+application like Microsoft Excel or Google Sheets. It is a simple and easy-to-use format that can be used to
+analyze your flight data.
+
+#### Format
+
+The CSV file contains the following columns:
+
+- `date`: The date of the flight (YYYY-MM-DD format).
+- `from`: The IATA code of the departure airport.
+- `to`: The IATA code of the arrival airport.
+- `departure`: The departure time in ISO 8601 format (if available).
+- `arrival`: The arrival time in ISO 8601 format (if available).
+- `duration`: The duration of the flight in seconds.
+- `flightNumber`: The flight number (if available).
+- `flightReason`: The reason for the flight (if provided).
+- `airline`: The airline operating the flight (if available).
+- `aircraft`: The type of aircraft used (if available).
+- `aircraftReg`: The registration number of the aircraft (if available).
+- `note`: Any additional notes about the flight.
+- `seat`: The type of seat (e.g., window, aisle, etc.).
+- `seatNumber`: The seat number (if available).
+- `seatClass`: The class of the seat (e.g., economy, business).
+
+### JSON
+
+:::tip
+The JSON format can be reimported into AirTrail using the import feature.
+:::
+
+The JSON export option provides a more structured format that is ideal for developers or when integrating the data into
+other systems. It contains nested objects for each flight and detailed data for each user and their seat information.
+
+#### Format
+
+The JSON file follows this structure:
+
+```json
+{
+  "users": [
+    {
+      "id": "user_id",
+      "displayName": "User Name",
+      "username": "username"
+    }
+  ],
+  "flights": [
+    {
+      "date": "YYYY-MM-DD",
+      "from": "ICAO_CODE",
+      "to": "ICAO_CODE",
+      "departure": "ISO_8601_DATETIME",
+      "arrival": "ISO_8601_DATETIME",
+      "duration": flight_duration_in_seconds,
+      "flightNumber": "FLIGHT_NUMBER",
+      "flightReason": "FLIGHT_REASON",
+      "airline": "ICAO_AIRLINE_CODE",
+      "aircraft": "ICAO_AIRCRAFT_TYPE",
+      "aircraftReg": "AIRCRAFT_REGISTRATION",
+      "note": "FLIGHT_NOTE",
+      "seats": [
+        {
+          "userId": "USER_ID",
+          "guestName": "GUEST_NAME",
+          "seat": "SEAT_TYPE",
+          "seatNumber": "SEAT_NUMBER",
+          "seatClass": "SEAT_CLASS"
+        }
+      ]
+    }
+  ]
+}
\ No newline at end of file
diff --git a/docs/docs/features/import.md b/docs/docs/features/import.md
index 2323e75..22c177a 100644
--- a/docs/docs/features/import.md
+++ b/docs/docs/features/import.md
@@ -6,7 +6,8 @@ sidebar_position: 1
 
 The import feature allows you to import flight data from other sources into AirTrail.
 Currently, AirTrail supports importing flights from [MyFlightradar24](https://my.flightradar24.com)
-, [App in the Air](https://appintheair.com) and [JetLog](https://github.com/pbogre/jetlog).
+, [App in the Air](https://appintheair.com), [JetLog](https://github.com/pbogre/jetlog)
+and [AirTrail JSON files](/docs/features/export).
 
 ## Import flights from MyFlightradar24
 
@@ -22,7 +23,7 @@ Once you have the CSV file, you can import it into AirTrail by following these s
 1. Go to the AirTrail application.
 2. Go to the settings page.
 3. Click on the "Import" tab.
-4. Click on the "Choose File" button and select the CSV file you downloaded from MyFlightradar24.
+4. Click on the "Select file" button and select the CSV file you downloaded from MyFlightradar24.
 5. Click on the "Import" button to start the import process.
 
 After the import process is complete, you will see your flights on the map.
@@ -41,7 +42,7 @@ Once you have the text file, you can import it into AirTrail by following these
 1. Go to the AirTrail application.
 2. Go to the settings page.
 3. Click on the "Import" tab.
-4. Click on the "Choose File" button and select the text file you received from App in the Air.
+4. Click on the "Select file" button and select the text file you received from App in the Air.
 5. Click on the "Import" button to start the import process.
 
 After the import process is complete, you will see your flights on the map.
@@ -63,7 +64,24 @@ Once you have the CSV file, you can import it into AirTrail by following these s
 1. Go to the AirTrail application.
 2. Go to the settings page.
 3. Click on the "Import" tab.
-4. Click on the "Choose File" button and select the CSV file you downloaded from JetLog.
+4. Click on the "Select file" button and select the CSV file you downloaded from JetLog.
+5. Click on the "Import" button to start the import process.
+
+After the import process is complete, you will see your flights on the map.
+
+## Import flights from AirTrail JSON files
+
+:::tip
+Make sure the file you are importing is called `airtrail.json`. If it is not, rename it to `airtrail.json` before
+importing.
+:::
+
+Once you have the JSON file, you can import it into AirTrail by following these steps:
+
+1. Go to the AirTrail application.
+2. Go to the settings page.
+3. Click on the "Import" tab.
+4. Click on the "Select file" button and select the JSON file you want to import.
 5. Click on the "Import" button to start the import process.
 
 After the import process is complete, you will see your flights on the map.
diff --git a/src/lib/components/modals/settings/SettingsModal.svelte b/src/lib/components/modals/settings/SettingsModal.svelte
index e4461f8..b4f3f69 100644
--- a/src/lib/components/modals/settings/SettingsModal.svelte
+++ b/src/lib/components/modals/settings/SettingsModal.svelte
@@ -10,6 +10,7 @@
     GeneralPage,
     AppearancePage,
     UsersPage,
+    ExportPage,
     OAuthPage,
     SecurityPage,
   } from './pages';
@@ -22,6 +23,7 @@
     { title: 'Security', id: 'security' },
     { title: 'Appearance', id: 'appearance' },
     { title: 'Import', id: 'import' },
+    { title: 'Export', id: 'export' },
   ] as const;
   const ADMIN_SETTINGS = [
     { title: 'Users', id: 'users' },
@@ -131,6 +133,8 @@
           <AppearancePage />
         {:else if activeTab === 'import'}
           <ImportPage {invalidator} />
+        {:else if activeTab === 'export'}
+          <ExportPage />
         {:else if activeTab === 'users'}
           <UsersPage />
         {:else if activeTab === 'oauth'}
diff --git a/src/lib/components/modals/settings/pages/ExportPage.svelte b/src/lib/components/modals/settings/pages/ExportPage.svelte
new file mode 100644
index 0000000..b46513a
--- /dev/null
+++ b/src/lib/components/modals/settings/pages/ExportPage.svelte
@@ -0,0 +1,64 @@
+<script lang="ts">
+  import { PageHeader } from '.';
+  import { api } from '$lib/trpc';
+  import { cn } from '$lib/utils';
+  import { FileSpreadsheet, FileJson } from '@o7/icon/lucide';
+  import { Card } from '$lib/components/ui/card';
+  import { toast } from 'svelte-sonner';
+
+  const downloadBlob = (blob: Blob, filename: string) => {
+    const url = URL.createObjectURL(blob);
+    const a = document.createElement('a');
+    a.href = url;
+    a.download = filename;
+    a.click();
+    toast.info('Your download should start shortly');
+    URL.revokeObjectURL(url);
+  };
+
+  const downloadCsv = async () => {
+    const csv = await api.flight.exportCsv.query();
+    const blob = new Blob([csv], { type: 'text/csv' });
+    downloadBlob(blob, 'airtrail.csv');
+  };
+
+  const downloadJson = async () => {
+    const json = await api.flight.exportJson.query();
+    const blob = new Blob([json], { type: 'application/json' });
+    downloadBlob(blob, 'airtrail.json');
+  };
+</script>
+
+<PageHeader title="Export">
+  {#snippet subtitleHtml()}
+    <p class="text-muted-foreground text-sm">
+      Export your data. Learn more about the data formats <a
+        href="https://johanohly.github.io/AirTrail/docs/features/export#export-formats"
+        target="_blank"
+        class="text-blue-500 underline">in the documentation</a
+      >.
+    </p>
+  {/snippet}
+  <div class="flex">
+    <button onclick={downloadCsv} class="w-full">
+      <Card
+        class={cn(
+          'cursor-pointer py-12 border-2 border-dashed border-r-0 rounded-r-none flex flex-col items-center hover:bg-card-hover dark:hover:bg-dark-2',
+        )}
+      >
+        <FileSpreadsheet size={64} />
+        <span class="text-muted-foreground">.csv</span>
+      </Card>
+    </button>
+    <button onclick={downloadJson} class="w-full">
+      <Card
+        class={cn(
+          'cursor-pointer py-12 border-2 border-dashed rounded-l-none flex flex-col items-center hover:bg-card-hover dark:hover:bg-dark-2',
+        )}
+      >
+        <FileJson size={64} />
+        <span class="text-muted-foreground">.json</span>
+      </Card>
+    </button>
+  </div>
+</PageHeader>
diff --git a/src/lib/components/modals/settings/pages/ImportPage.svelte b/src/lib/components/modals/settings/pages/ImportPage.svelte
index e004f8b..732367d 100644
--- a/src/lib/components/modals/settings/pages/ImportPage.svelte
+++ b/src/lib/components/modals/settings/pages/ImportPage.svelte
@@ -21,7 +21,7 @@
     const file = files?.[0];
     if (!file) return;
 
-    if (!file.name.endsWith('.csv') && !file.name.endsWith('.txt')) {
+    if (!file.name.endsWith('.csv') && !file.name.endsWith('.txt') && !file.name.endsWith('.json')) {
       fileError = 'File type not supported';
     } else if (file.size > 5 * 1024 * 1024) {
       fileError = 'File must be less than 5MB';
@@ -53,7 +53,7 @@
 
 <PageHeader
   title="Import"
-  subtitle="Supported platforms: FlightRadar24, App in the Air, JetLog"
+  subtitle="Supported platforms: FlightRadar24, App in the Air, JetLog and AirTrail backups"
 >
   <label for="file" class="block">
     <Card
@@ -75,7 +75,7 @@
     id="file"
     name="file"
     type="file"
-    accept=".csv,.txt"
+    accept=".csv,.txt,.json"
     bind:files
     class="hidden"
   />
diff --git a/src/lib/components/modals/settings/pages/PageHeader.svelte b/src/lib/components/modals/settings/pages/PageHeader.svelte
index b1f1317..f1eac81 100644
--- a/src/lib/components/modals/settings/pages/PageHeader.svelte
+++ b/src/lib/components/modals/settings/pages/PageHeader.svelte
@@ -1,17 +1,20 @@
 <script lang="ts">
+  /* eslint svelte/no-at-html-tags: 0 */
   import { Separator } from '$lib/components/ui/separator';
   import type { Snippet } from 'svelte';
 
   let {
     title,
     subtitle,
-    children,
+    subtitleHtml,
     headerRight,
+    children,
   }: {
     title: string;
-    subtitle: string;
-    children: Snippet;
+    subtitle?: string;
+    subtitleHtml?: Snippet;
     headerRight?: Snippet;
+    children: Snippet;
   } = $props();
 </script>
 
@@ -19,9 +22,13 @@
   <div class="flex items-center justify-between">
     <div>
       <h3 class="text-lg font-medium">{title}</h3>
-      <p class="text-muted-foreground text-sm">
-        {subtitle}
-      </p>
+      {#if subtitleHtml}
+        {@render subtitleHtml()}
+      {:else if subtitle}
+        <p class="text-muted-foreground text-sm">
+          {@html subtitle}
+        </p>
+      {/if}
     </div>
     {#if headerRight}
       {@render headerRight()}
diff --git a/src/lib/components/modals/settings/pages/index.ts b/src/lib/components/modals/settings/pages/index.ts
index 5150f3c..73dff76 100644
--- a/src/lib/components/modals/settings/pages/index.ts
+++ b/src/lib/components/modals/settings/pages/index.ts
@@ -4,4 +4,5 @@ export { default as UsersPage } from './users-page/UsersPage.svelte';
 export { default as GeneralPage } from './general-page/GeneralPage.svelte';
 export { default as SecurityPage } from './security-page/SecurityPage.svelte';
 export { default as ImportPage } from './ImportPage.svelte';
+export { default as ExportPage } from './ExportPage.svelte';
 export { default as OAuthPage } from './OAuthPage.svelte';
diff --git a/src/lib/import/airtrail.ts b/src/lib/import/airtrail.ts
new file mode 100644
index 0000000..9951bbd
--- /dev/null
+++ b/src/lib/import/airtrail.ts
@@ -0,0 +1,116 @@
+import { page } from '$app/stores';
+import { get } from 'svelte/store';
+import {
+  flightAirportsSchema,
+  flightOptionalInformationSchema,
+  flightSeatInformationSchema,
+} from '$lib/zod/flight';
+import { z } from 'zod';
+import type { CreateFlight } from '$lib/db/types';
+import { api } from '$lib/trpc';
+
+const AirTrailFile = z.object({
+  flights: z
+    .object({
+      date: z.string().regex(/^\d{4}-\d{2}-\d{2}$/),
+      departure: z.string().datetime('Invalid datetime').nullable(),
+      arrival: z.string().datetime('Invalid datetime').nullable(),
+      duration: z.number().int().positive().nullable(),
+    })
+    .merge(flightAirportsSchema)
+    .merge(flightOptionalInformationSchema)
+    .merge(flightSeatInformationSchema)
+    .array()
+    .min(1, 'At least one flight is required'),
+  users: z
+    .object({
+      id: z.string().min(3),
+      username: z
+        .string()
+        .min(3, { message: 'Username must be at least 3 characters long' })
+        .max(20, { message: 'Username must be at most 20 characters long' })
+        .regex(/^[a-zA-Z0-9_]+$/, {
+          message:
+            'Username can only contain letters, numbers, and underscores',
+        }),
+      displayName: z.string().min(3),
+    })
+    .array()
+    .min(1, 'At least one user is required'),
+});
+
+export const processAirTrailFile = async (input: string) => {
+  const user = get(page).data.user;
+  if (!user) {
+    throw new Error('User not found');
+  }
+
+  let parsed;
+  try {
+    parsed = JSON.parse(input);
+  } catch (e) {
+    return [];
+  }
+
+  const result = AirTrailFile.safeParse(parsed);
+  if (!result.success) {
+    return [];
+  }
+
+  const flights: CreateFlight[] = [];
+  const data = result.data;
+  const dataUsers = data.users.reduce<
+    Record<
+      string,
+      {
+        id: string;
+        username: string;
+        displayName: string;
+      }
+    >
+  >((acc, user) => {
+    acc[user.id] = user;
+    return acc;
+  }, {});
+  const users = await api.user.list.query();
+
+  data.flights.forEach((flight) => {
+    const seats = flight.seats.map((seat) => {
+      const dataUser = dataUsers?.[seat.userId ?? ''];
+      const user = dataUser
+        ? users.find((user) => user.username === dataUser?.username)
+        : null;
+      const guestName = user ? null : seat.guestName;
+
+      return {
+        ...seat,
+        userId: user?.id ?? null,
+        guestName,
+      };
+    });
+
+    // If exported with a different username, add the user to the list manually.
+    if (
+      !seats.some(
+        (seat) =>
+          users.find((usr) => usr.id === seat.userId)?.username ===
+          user.username,
+      )
+    ) {
+      seats.push({
+        userId: user.id,
+        guestName: null,
+        seat: null,
+        seatClass: null,
+        seatNumber: null,
+      });
+    }
+
+    flights.push({
+      ...flight,
+      seats,
+    });
+  });
+
+  return flights;
+};
diff --git a/src/lib/import/index.ts b/src/lib/import/index.ts
index 45fee0a..2afd248 100644
--- a/src/lib/import/index.ts
+++ b/src/lib/import/index.ts
@@ -3,11 +3,14 @@ import { processFR24File } from '$lib/import/fr24';
 import { processAITAFile } from '$lib/import/aita';
 import type { CreateFlight } from '$lib/db/types';
 import { processJetLogFile } from '$lib/import/jetlog';
+import { processAirTrailFile } from '$lib/import/airtrail';
 
 export const processFile = async (file: File): Promise<CreateFlight[]> => {
   const content = await readFile(file);
 
-  if (file.name.includes('jetlog')) {
+  if (file.name.includes('airtrail')) {
+    return processAirTrailFile(content);
+  } else if (file.name.includes('jetlog')) {
     return processJetLogFile(content);
   } else if (file.name.endsWith('.csv')) {
     return processFR24File(content);
diff --git a/src/lib/server/routes/flight.ts b/src/lib/server/routes/flight.ts
index 838a185..6f0d900 100644
--- a/src/lib/server/routes/flight.ts
+++ b/src/lib/server/routes/flight.ts
@@ -7,6 +7,7 @@ import {
   deleteFlight,
   listFlights,
 } from '$lib/server/utils/flight';
+import { generateCsv } from '$lib/utils/csv';
 
 export const flightRouter = router({
   list: authedProcedure.query(async ({ ctx: { user } }) => {
@@ -56,7 +57,8 @@ export const flightRouter = router({
           ) {
             return flightInput.seats.map((seat) => ({
               flightId: flight.id,
-              userId: seat.userId || user.id,
+              userId: seat.userId || (seat.guestName ? null : user.id),
+              guestName: seat.guestName,
               seat: seat.seat,
               seatNumber: seat.seatNumber,
               seatClass: seat.seatClass,
@@ -72,4 +74,40 @@ export const flightRouter = router({
         return await trx.insertInto('seat').values(seatData).execute();
       });
     }),
+  exportJson: authedProcedure.query(async ({ ctx: { user } }) => {
+    const users = await db
+      .selectFrom('user')
+      .select(['id', 'displayName', 'username'])
+      .execute();
+    const res = await listFlights(user.id);
+    const flights = res.map(({ id, ...flight }) => ({
+      ...flight,
+      seats: flight.seats.map(({ id, flightId, ...seat }) => ({
+        ...seat,
+      })),
+    }));
+    return JSON.stringify(
+      {
+        users,
+        flights,
+      },
+      null,
+      2,
+    );
+  }),
+  exportCsv: authedProcedure.query(async ({ ctx: { user } }) => {
+    const res = await listFlights(user.id);
+    const flights = res.map(({ id, seats, ...flight }) => {
+      const seat = seats.find((seat) => seat.userId === user.id);
+
+      return {
+        ...flight,
+        seat: seat?.seat,
+        seatNumber: seat?.seatNumber,
+        seatClass: seat?.seatClass,
+      };
+    });
+
+    return generateCsv(flights);
+  }),
 });
diff --git a/src/lib/utils/csv.ts b/src/lib/utils/csv.ts
index 3fc5049..c0578e0 100644
--- a/src/lib/utils/csv.ts
+++ b/src/lib/utils/csv.ts
@@ -44,3 +44,31 @@ const sanitizeHeader = (header: string) => {
     .replace(/^_/, '')
     .replace(/_$/, '');
 };
+
+type CsvCell = string | number | object | null | undefined;
+
+export const generateCsv = (data: Record<string, CsvCell>[]) => {
+  if (!data[0]) {
+    return '';
+  }
+
+  const headers = Object.keys(data[0]);
+  const headerRow = headers.map((header) => `"${header}"`).join(',') + '\n';
+
+  const rows = data.map((row) => {
+    return headers
+      .map((header) => {
+        if (typeof row[header] === 'object' && row[header] !== null) {
+          return stringify(row[header]);
+        }
+        return `"${row[header] ?? ''}"`;
+      })
+      .join(',');
+  });
+
+  return headerRow + rows.join('\n');
+};
+
+const stringify = (value: object) => {
+  return `"${JSON.stringify(value).replace(/,/g, '\\,')}"`;
+};