feat: implement setup on backend

Author: joshunrau

apps/api/src/setup/dto/update-setup-state.dto.ts

@@ -0,0 +1,10 @@
+import { ValidationSchema } from '@douglasneuroinformatics/libnest/core';
+import { ApiProperty } from '@nestjs/swagger';
+import { $UpdateSetupStateData } from '@opendatacapture/schemas/setup';
+import type { UpdateSetupStateData } from '@opendatacapture/schemas/setup';
+
+@ValidationSchema($UpdateSetupStateData)
+export class UpdateSetupStateDto implements UpdateSetupStateData {
+  @ApiProperty()
+  isExperimentalFeaturesEnabled?: boolean;
+}

apps/api/src/setup/setup.controller.ts

@@ -1,10 +1,11 @@
-import { Body, Controller, Get, Post } from '@nestjs/common';
+import { Body, Controller, Get, Patch, Post } from '@nestjs/common';
 import { ApiOperation, ApiTags } from '@nestjs/swagger';
 import type { SetupState } from '@opendatacapture/schemas/setup';
 
 import { RouteAccess } from '@/core/decorators/route-access.decorator';
 
 import { InitAppDto } from './dto/init-app.dto';
+import { UpdateSetupStateDto } from './dto/update-setup-state.dto';
 import { SetupService } from './setup.service';
 
 @ApiTags('Setup')
@@ -34,4 +35,14 @@ export class SetupController {
   initApp(@Body() initAppDto: InitAppDto): Promise<{ success: boolean }> {
     return this.setupService.initApp(initAppDto);
   }
+
+  @ApiOperation({
+    description: 'Update the setup state',
+    summary: 'Update State'
+  })
+  @Patch()
+  @RouteAccess({ action: 'manage', subject: 'all' })
+  updateState(@Body() data: UpdateSetupStateDto): Promise<Partial<SetupState>> {
+    return this.setupService.updateState(data);
+  }
 }

apps/api/src/setup/setup.service.ts

@@ -1,6 +1,6 @@
-import { ForbiddenException, Injectable } from '@nestjs/common';
+import { ForbiddenException, Injectable, ServiceUnavailableException } from '@nestjs/common';
 import { type CreateAdminData } from '@opendatacapture/schemas/setup';
-import type { InitAppOptions, SetupState } from '@opendatacapture/schemas/setup';
+import type { InitAppOptions, SetupState, UpdateSetupStateData } from '@opendatacapture/schemas/setup';
 
 import { ConfigurationService } from '@/configuration/configuration.service';
 import { DemoService } from '@/demo/demo.service';
@@ -55,6 +55,19 @@ export class SetupService {
     return { success: true };
   }
 
+  async updateState(data: UpdateSetupStateData): Promise<Partial<SetupState>> {
+    const setupState = await this.getSavedOptions();
+    if (!setupState?.isSetup) {
+      throw new ServiceUnavailableException('Cannot update state before setup');
+    }
+    return this.setupStateModel.update({
+      data,
+      where: {
+        id: setupState.id
+      }
+    });
+  }
+
   private async getSavedOptions() {
     return await this.setupStateModel.findFirst();
   }

packages/schemas/src/setup/setup.ts

@@ -26,13 +26,20 @@ export const $ReleaseInfo = z.union([$DevelopmentReleaseInfo, $ProductionRelease
 export type SetupState = z.infer<typeof $SetupState>;
 export const $SetupState = z.object({
   isDemo: z.boolean(),
-  isExperimentalFeaturesEnabled: z.boolean(),
+  isExperimentalFeaturesEnabled: z.boolean().nullish(),
   isGatewayEnabled: z.boolean(),
   isSetup: z.boolean().nullable(),
   release: $ReleaseInfo,
   uptime: z.number()
 });
 
+export type UpdateSetupStateData = z.infer<typeof $UpdateSetupStateData>;
+export const $UpdateSetupStateData = $SetupState
+  .pick({
+    isExperimentalFeaturesEnabled: true
+  })
+  .partial();
+
 export type CreateAdminData = z.infer<typeof $CreateAdminData>;
 export const $CreateAdminData = $CreateUserData.omit({
   basePermissionLevel: true,