feat: implement use download

Author: openscript

apps/backend/src/system/export/export.controller.ts

@@ -0,0 +1,35 @@
+import { Controller, Get, Response } from "@nestjs/common";
+import { ApiOperation, ApiResponse } from "@nestjs/swagger";
+import { FastifyReply } from "fastify";
+import { ExportService } from "./export.service";
+
+@Controller("export")
+export class ExportController {
+  constructor(private readonly exportService: ExportService) {}
+
+  @Get()
+  @ApiOperation({ summary: "Offers the backends data for download" })
+  @ApiResponse({
+    status: 200,
+    description: "Database dump file",
+    content: {
+      "text/sql": {
+        schema: { type: "string", format: "binary" },
+      },
+    },
+    headers: {
+      "Content-Disposition": {
+        description: "Attachment dump.sql",
+        schema: { type: "string", example: "attachment; filename=dump.sql" },
+      },
+    },
+  })
+  get(@Response() res: FastifyReply) {
+    const data = this.exportService.fullDatabaseDump();
+    const buffer = Buffer.from(data, "utf-8");
+    res.header("Content-Disposition", "attachment; filename=dump.sql");
+    res.header("Content-Type", "text/sql");
+    res.header("Content-Length", buffer.byteLength);
+    res.send(data);
+  }
+}

apps/backend/src/system/export/export.service.ts

@@ -0,0 +1,8 @@
+import { Injectable } from "@nestjs/common";
+
+@Injectable()
+export class ExportService {
+  fullDatabaseDump() {
+    return "Hoi";
+  }
+}

apps/backend/src/system/health/health.controller.ts

@@ -1,6 +1,7 @@
 import { Controller, Get } from "@nestjs/common";
 import { HealthCheck, HealthCheckService, MikroOrmHealthIndicator } from "@nestjs/terminus";
 import { Public } from "../session/public.decorator";
+import { ApiOperation } from "@nestjs/swagger";
 
 @Controller("health")
 export class HealthController {
@@ -10,6 +11,7 @@ export class HealthController {
   ) {}
 
   @Get()
+  @ApiOperation({ summary: "Returns the backends health information" })
   @HealthCheck()
   @Public()
   get() {

apps/backend/src/system/status/status.controller.ts

@@ -1,10 +1,12 @@
 import { Controller, Get } from "@nestjs/common";
 import { Public } from "../session/public.decorator";
 import { version } from "../../../package.json";
+import { ApiOperation } from "@nestjs/swagger";
 
 @Controller("status")
 export class StatusController {
   @Get()
+  @ApiOperation({ summary: "Returns the backends status information" })
   @Public()
   get() {
     return { version };

apps/backend/src/system/system.module.ts

@@ -11,10 +11,18 @@ import { RolesGuard } from "./users/roles.guard";
 import { HealthController } from "./health/health.controller";
 import { TerminusModule } from "@nestjs/terminus";
 import { StatusController } from "./status/status.controller";
+import { ExportController } from "./export/export.controller";
+import { ExportService } from "./export/export.service";
 
 @Module({
   imports: [MikroOrmModule.forFeature([User]), TerminusModule],
-  controllers: [UsersController, SessionController, HealthController, StatusController],
-  providers: [UsersService, SessionService, { provide: APP_GUARD, useClass: SessionGuard }, { provide: APP_GUARD, useClass: RolesGuard }],
+  controllers: [UsersController, SessionController, HealthController, StatusController, ExportController],
+  providers: [
+    UsersService,
+    SessionService,
+    ExportService,
+    { provide: APP_GUARD, useClass: SessionGuard },
+    { provide: APP_GUARD, useClass: RolesGuard },
+  ],
 })
 export class SystemModule {}

apps/frontend/package.json

@@ -40,6 +40,7 @@
     "@vitest/coverage-v8": "2.1.8",
     "jsdom": "^25.0.1",
     "openapi-typescript": "^7.4.4",
+    "openapi-typescript-helpers": "^0.0.15",
     "typescript": "^5.7.2",
     "vite": "^6.0.2",
     "vitest": "^2.1.8"

apps/frontend/src/api.gen.ts

@@ -67,6 +67,7 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
+        /** Returns the backends health information */
         get: operations["HealthController_get"];
         put?: never;
         post?: never;
@@ -83,6 +84,7 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
+        /** Returns the backends status information */
         get: operations["StatusController_get"];
         put?: never;
         post?: never;
@@ -92,6 +94,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/export": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Offers the backends data for download */
+        get: operations["ExportController_get"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/carers": {
         parameters: {
             query?: never;
@@ -1272,6 +1291,28 @@ export interface operations {
             };
         };
     };
+    ExportController_get: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Database dump file */
+            200: {
+                headers: {
+                    /** @description Attachment dump.sql */
+                    "Content-Disposition"?: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/sql": string;
+                };
+            };
+        };
+    };
     CarersController_index: {
         parameters: {
             query?: never;

apps/frontend/src/routeTree.gen.ts

@@ -31,6 +31,7 @@ import { Route as AuthAdministrationStudiesIndexImport } from "./routes/_auth/ad
 import { Route as AuthAdministrationQuestionnairesIndexImport } from "./routes/_auth/administration/questionnaires/index";
 import { Route as AuthAdministrationParticipantsIndexImport } from "./routes/_auth/administration/participants/index";
 import { Route as AuthAdministrationLanguagesIndexImport } from "./routes/_auth/administration/languages/index";
+import { Route as AuthAdministrationExportIndexImport } from "./routes/_auth/administration/export/index";
 import { Route as AuthAdministrationCarersIndexImport } from "./routes/_auth/administration/carers/index";
 import { Route as AuthQuestionnaireQuestionnaireParticipantImport } from "./routes/_auth/questionnaire/_questionnaire/participant";
 import { Route as AuthQuestionnaireQuestionnaireNewImport } from "./routes/_auth/questionnaire/_questionnaire/new";
@@ -179,6 +180,13 @@ const AuthAdministrationLanguagesIndexRoute =
     getParentRoute: () => AuthAdministrationLanguagesRoute,
   } as any);
 
+const AuthAdministrationExportIndexRoute =
+  AuthAdministrationExportIndexImport.update({
+    id: "/",
+    path: "/",
+    getParentRoute: () => AuthAdministrationExportRoute,
+  } as any);
+
 const AuthAdministrationCarersIndexRoute =
   AuthAdministrationCarersIndexImport.update({
     id: "/",
@@ -471,6 +479,13 @@ declare module "@tanstack/react-router" {
       preLoaderRoute: typeof AuthAdministrationCarersIndexImport;
       parentRoute: typeof AuthAdministrationCarersImport;
     };
+    "/_auth/administration/export/": {
+      id: "/_auth/administration/export/";
+      path: "/";
+      fullPath: "/administration/export/";
+      preLoaderRoute: typeof AuthAdministrationExportIndexImport;
+      parentRoute: typeof AuthAdministrationExportImport;
+    };
     "/_auth/administration/languages/": {
       id: "/_auth/administration/languages/";
       path: "/";
@@ -599,6 +614,20 @@ const AuthAdministrationCarersRouteWithChildren =
     AuthAdministrationCarersRouteChildren,
   );
 
+interface AuthAdministrationExportRouteChildren {
+  AuthAdministrationExportIndexRoute: typeof AuthAdministrationExportIndexRoute;
+}
+
+const AuthAdministrationExportRouteChildren: AuthAdministrationExportRouteChildren =
+  {
+    AuthAdministrationExportIndexRoute: AuthAdministrationExportIndexRoute,
+  };
+
+const AuthAdministrationExportRouteWithChildren =
+  AuthAdministrationExportRoute._addFileChildren(
+    AuthAdministrationExportRouteChildren,
+  );
+
 interface AuthAdministrationLanguagesRouteChildren {
   AuthAdministrationLanguagesNewRoute: typeof AuthAdministrationLanguagesNewRoute;
   AuthAdministrationLanguagesIndexRoute: typeof AuthAdministrationLanguagesIndexRoute;
@@ -696,7 +725,7 @@ const AuthAdministrationUsersRouteWithChildren =
 
 interface AuthAdministrationRouteChildren {
   AuthAdministrationCarersRoute: typeof AuthAdministrationCarersRouteWithChildren;
-  AuthAdministrationExportRoute: typeof AuthAdministrationExportRoute;
+  AuthAdministrationExportRoute: typeof AuthAdministrationExportRouteWithChildren;
   AuthAdministrationLanguagesRoute: typeof AuthAdministrationLanguagesRouteWithChildren;
   AuthAdministrationParticipantsRoute: typeof AuthAdministrationParticipantsRouteWithChildren;
   AuthAdministrationQuestionnairesRoute: typeof AuthAdministrationQuestionnairesRouteWithChildren;
@@ -707,7 +736,7 @@ interface AuthAdministrationRouteChildren {
 
 const AuthAdministrationRouteChildren: AuthAdministrationRouteChildren = {
   AuthAdministrationCarersRoute: AuthAdministrationCarersRouteWithChildren,
-  AuthAdministrationExportRoute: AuthAdministrationExportRoute,
+  AuthAdministrationExportRoute: AuthAdministrationExportRouteWithChildren,
   AuthAdministrationLanguagesRoute:
     AuthAdministrationLanguagesRouteWithChildren,
   AuthAdministrationParticipantsRoute:
@@ -787,7 +816,7 @@ export interface FileRoutesByFullPath {
   "/questionnaire": typeof AuthQuestionnaireQuestionnaireRouteWithChildren;
   "/": typeof AuthIndexRoute;
   "/administration/carers": typeof AuthAdministrationCarersRouteWithChildren;
-  "/administration/export": typeof AuthAdministrationExportRoute;
+  "/administration/export": typeof AuthAdministrationExportRouteWithChildren;
   "/administration/languages": typeof AuthAdministrationLanguagesRouteWithChildren;
   "/administration/participants": typeof AuthAdministrationParticipantsRouteWithChildren;
   "/administration/questionnaires": typeof AuthAdministrationQuestionnairesRouteWithChildren;
@@ -803,6 +832,7 @@ export interface FileRoutesByFullPath {
   "/questionnaire/new": typeof AuthQuestionnaireQuestionnaireNewRoute;
   "/questionnaire/participant": typeof AuthQuestionnaireQuestionnaireParticipantRoute;
   "/administration/carers/": typeof AuthAdministrationCarersIndexRoute;
+  "/administration/export/": typeof AuthAdministrationExportIndexRoute;
   "/administration/languages/": typeof AuthAdministrationLanguagesIndexRoute;
   "/administration/participants/": typeof AuthAdministrationParticipantsIndexRoute;
   "/administration/questionnaires/": typeof AuthAdministrationQuestionnairesIndexRoute;
@@ -823,7 +853,6 @@ export interface FileRoutesByFullPath {
 export interface FileRoutesByTo {
   "/session": typeof SessionRoute;
   "/": typeof AuthIndexRoute;
-  "/administration/export": typeof AuthAdministrationExportRoute;
   "/questionnaire": typeof AuthQuestionnaireIndexRoute;
   "/administration": typeof AuthAdministrationIndexRoute;
   "/administration/carers/new": typeof AuthAdministrationCarersNewRoute;
@@ -834,6 +863,7 @@ export interface FileRoutesByTo {
   "/questionnaire/new": typeof AuthQuestionnaireQuestionnaireNewRoute;
   "/questionnaire/participant": typeof AuthQuestionnaireQuestionnaireParticipantRoute;
   "/administration/carers": typeof AuthAdministrationCarersIndexRoute;
+  "/administration/export": typeof AuthAdministrationExportIndexRoute;
   "/administration/languages": typeof AuthAdministrationLanguagesIndexRoute;
   "/administration/participants": typeof AuthAdministrationParticipantsIndexRoute;
   "/administration/questionnaires": typeof AuthAdministrationQuestionnairesIndexRoute;
@@ -859,7 +889,7 @@ export interface FileRoutesById {
   "/_auth/questionnaire": typeof AuthQuestionnaireRouteWithChildren;
   "/_auth/": typeof AuthIndexRoute;
   "/_auth/administration/carers": typeof AuthAdministrationCarersRouteWithChildren;
-  "/_auth/administration/export": typeof AuthAdministrationExportRoute;
+  "/_auth/administration/export": typeof AuthAdministrationExportRouteWithChildren;
   "/_auth/administration/languages": typeof AuthAdministrationLanguagesRouteWithChildren;
   "/_auth/administration/participants": typeof AuthAdministrationParticipantsRouteWithChildren;
   "/_auth/administration/questionnaires": typeof AuthAdministrationQuestionnairesRouteWithChildren;
@@ -876,6 +906,7 @@ export interface FileRoutesById {
   "/_auth/questionnaire/_questionnaire/new": typeof AuthQuestionnaireQuestionnaireNewRoute;
   "/_auth/questionnaire/_questionnaire/participant": typeof AuthQuestionnaireQuestionnaireParticipantRoute;
   "/_auth/administration/carers/": typeof AuthAdministrationCarersIndexRoute;
+  "/_auth/administration/export/": typeof AuthAdministrationExportIndexRoute;
   "/_auth/administration/languages/": typeof AuthAdministrationLanguagesIndexRoute;
   "/_auth/administration/participants/": typeof AuthAdministrationParticipantsIndexRoute;
   "/_auth/administration/questionnaires/": typeof AuthAdministrationQuestionnairesIndexRoute;
@@ -918,6 +949,7 @@ export interface FileRouteTypes {
     | "/questionnaire/new"
     | "/questionnaire/participant"
     | "/administration/carers/"
+    | "/administration/export/"
     | "/administration/languages/"
     | "/administration/participants/"
     | "/administration/questionnaires/"
@@ -937,7 +969,6 @@ export interface FileRouteTypes {
   to:
     | "/session"
     | "/"
-    | "/administration/export"
     | "/questionnaire"
     | "/administration"
     | "/administration/carers/new"
@@ -948,6 +979,7 @@ export interface FileRouteTypes {
     | "/questionnaire/new"
     | "/questionnaire/participant"
     | "/administration/carers"
+    | "/administration/export"
     | "/administration/languages"
     | "/administration/participants"
     | "/administration/questionnaires"
@@ -988,6 +1020,7 @@ export interface FileRouteTypes {
     | "/_auth/questionnaire/_questionnaire/new"
     | "/_auth/questionnaire/_questionnaire/participant"
     | "/_auth/administration/carers/"
+    | "/_auth/administration/export/"
     | "/_auth/administration/languages/"
     | "/_auth/administration/participants/"
     | "/_auth/administration/questionnaires/"
@@ -1078,7 +1111,10 @@ export const routeTree = rootRoute
     },
     "/_auth/administration/export": {
       "filePath": "_auth/administration/export.tsx",
-      "parent": "/_auth/administration"
+      "parent": "/_auth/administration",
+      "children": [
+        "/_auth/administration/export/"
+      ]
     },
     "/_auth/administration/languages": {
       "filePath": "_auth/administration/languages.tsx",
@@ -1176,6 +1212,10 @@ export const routeTree = rootRoute
       "filePath": "_auth/administration/carers/index.tsx",
       "parent": "/_auth/administration/carers"
     },
+    "/_auth/administration/export/": {
+      "filePath": "_auth/administration/export/index.tsx",
+      "parent": "/_auth/administration/export"
+    },
     "/_auth/administration/languages/": {
       "filePath": "_auth/administration/languages/index.tsx",
       "parent": "/_auth/administration/languages"

apps/frontend/src/routes/_auth/administration/carers/index.tsx

@@ -1,10 +1,9 @@
 import { createFileRoute, Link } from "@tanstack/react-router";
 import { $api } from "../../../../stores/api";
 import { Button, Table } from "@quassel/ui";
-import { useSuspenseQuery } from "@tanstack/react-query";
 
 function AdministrationCarersIndex() {
-  const carers = useSuspenseQuery($api.queryOptions("get", "/carers"));
+  const carers = $api.useSuspenseQuery("get", "/carers");
   const deleteCarerMutation = $api.useMutation("delete", "/carers/{id}", {
     onSuccess: () => carers.refetch(),
   });

apps/frontend/src/routes/_auth/administration/export.tsx

@@ -1,5 +1,17 @@
-import { createFileRoute } from "@tanstack/react-router";
+import { Paper, Title } from "@quassel/ui";
+import { createFileRoute, Outlet } from "@tanstack/react-router";
+
+function AdministrationExport() {
+  return (
+    <>
+      <Title>Export</Title>
+      <Paper my="lg">
+        <Outlet />
+      </Paper>
+    </>
+  );
+}
 
 export const Route = createFileRoute("/_auth/administration/export")({
-  component: () => <div>Hello /_auth/administration/export!</div>,
+  component: AdministrationExport,
 });