feat(rec-suggestions): added api and suggestion box ui with minimal styling

Author: jimmypalelil

.gitignore

@@ -263,3 +263,5 @@ backend-el/*.iml
 k6_results/
 /public/backend/coverage
 /public/frontend/coverage
+admin/frontend/coverage/**/*
+admin/backend/coverage/**/*

admin/README.md

@@ -7,3 +7,10 @@ system.
 
 - [Doc link](docs/auth/auth.md) - Details about the authentication
   implementation using BC Gov SSO (Keycloak)
+
+## Data Fetching
+
+This project uses
+[TanStack React Query](https://tanstack.com/query/latest/docs/framework/react/overview)
+for data fetching and caching.  
+The `QueryClientProvider` is set up in `src/App.tsx`.

admin/backend/build-scripts/copy-prisma-generated-sql.js

@@ -0,0 +1,58 @@
+/**
+ * @fileOverview
+ * Script to copy Prisma-generated files (.js and .d.ts) containing functions and types to
+ * a target directory
+ */
+
+/**
+ * Target directory where files will be copied
+ */
+const TARGET_DIR = "./src/prisma-generated-sql";
+
+import { execSync } from "child_process";
+import { join } from "path";
+import { copyFileSync, existsSync, mkdirSync, readdirSync } from "fs";
+
+// Get the installation location of @prisma/client
+const output = execSync("npm list --depth 1 --parseable @prisma/client", {
+  encoding: "utf8",
+});
+
+// Find the specific line containing @prisma/client path
+const prismaClientLine = output
+  .split("\n")
+  .find((line) => line.includes("@prisma/client"));
+
+if (!prismaClientLine) {
+  throw new Error("@prisma/client not found");
+}
+
+// Construct the path to Prisma's SQL files
+const prismaClientPath = join(
+  prismaClientLine.replace(/@prisma\/client$/, ""),
+  ".prisma",
+  "client",
+  "sql",
+);
+
+// Create target directory if it doesn't exist
+if (!existsSync(TARGET_DIR)) {
+  mkdirSync(TARGET_DIR, { recursive: true });
+}
+
+/**
+ * Copy relevant files to target directory
+ * Includes only .js and .d.ts files, excluding edge-specific files
+ */
+readdirSync(prismaClientPath)
+  .filter(
+    (file) =>
+      (file.endsWith(".js") || file.endsWith(".d.ts")) &&
+      !file.includes(".edge."),
+  )
+  .forEach((file) => {
+    const sourcePath = join(prismaClientPath, file);
+    const targetPath = join(TARGET_DIR, file);
+
+    copyFileSync(sourcePath, targetPath);
+  });

admin/backend/package-lock.json

@@ -17,7 +17,8 @@
     "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
     "test": "vitest --exclude e2e",
     "test:cov": "vitest run --coverage --exclude e2e",
-    "test:e2e": "vitest --dir e2e"
+    "test:e2e": "vitest --dir e2e",
+    "copy-prisma-generated-sql": "prisma generate --sql && node build-scripts/copy-prisma-generated-sql.js"
   },
   "dependencies": {
     "@nestjs/cli": "^11.0.0",
@@ -29,6 +30,8 @@
     "@nestjs/swagger": "^11.2.0",
     "@nestjs/terminus": "^11.0.0",
     "@prisma/client": "^6.8.2",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.0",
     "helmet": "^8.1.0",
     "nest-winston": "^1.10.2",
     "passport": "^0.7.0",

admin/backend/package.json

@@ -0,0 +1,12 @@
+SELECT name, rec_resource_id,
+       recreation_resource_type,
+       recreation_resource_type_code,
+       district_description
+FROM recreation_resource_search_view
+WHERE similarity(name, $1) > 0.1
+   OR similarity(rec_resource_id, $1) > 0.3
+ORDER BY GREATEST(
+    similarity(name, $1),
+    similarity(rec_resource_id, $1)
+    ) DESC
+LIMIT 30;

admin/backend/prisma/sql/getRecreationResourceSuggestions.sql

@@ -3,10 +3,10 @@ import { AppService } from "./app.service";
 import { ApiBearerAuth, ApiTags } from "@nestjs/swagger";
 import { AuthGuard } from "@nestjs/passport";
 import {
-  AUTH_RST_ADMIN_ROLE,
   AUTH_STRATEGY,
   AuthRoles,
   AuthRolesGuard,
+  RecreationResourceAuthRole,
   ROLE_MODE,
 } from "./auth";
 
@@ -18,7 +18,7 @@ export class AppController {
   @Get()
   @ApiBearerAuth(AUTH_STRATEGY.KEYCLOAK)
   @UseGuards(AuthGuard(AUTH_STRATEGY.KEYCLOAK), AuthRolesGuard)
-  @AuthRoles([AUTH_RST_ADMIN_ROLE], ROLE_MODE.ALL)
+  @AuthRoles([RecreationResourceAuthRole.RST_ADMIN], ROLE_MODE.ALL)
   getHello(): string {
     return this.appService.getHello();
   }

admin/backend/src/app.controller.ts

@@ -7,13 +7,15 @@ import { HealthController } from "./health.controller";
 import { PassportModule } from "@nestjs/passport";
 import { AuthModule } from "./auth";
 import { PrismaService } from "./prisma.service";
+import { RecreationResourceModule } from "@/recreation-resource/recreation-resource.module";
 
 @Module({
   imports: [
     ConfigModule.forRoot({ isGlobal: true }),
     PassportModule,
     AuthModule,
     TerminusModule,
+    RecreationResourceModule,
   ],
   controllers: [AppController, HealthController],
   providers: [AppService, PrismaService],

admin/backend/src/app.module.ts

@@ -6,9 +6,11 @@ import { NestExpressApplication } from "@nestjs/platform-express";
 import helmet from "helmet";
 import { VersioningType } from "@nestjs/common";
 import { AUTH_STRATEGY } from "./auth";
+import { AllExceptionsFilter } from "@/common/filters/all-exceptions.filter";
+import { globalValidationPipe } from "@/config/validation-pipe.config";
 
 /**
- *
+ * Bootstrap function to initialize the NestJS application.
  */
 export async function bootstrap() {
   const app: NestExpressApplication =
@@ -20,6 +22,11 @@ export async function bootstrap() {
   app.set("trust proxy", 1);
   app.enableShutdownHooks();
   app.setGlobalPrefix("api");
+  app.useGlobalPipes(globalValidationPipe);
+
+  // global filters
+  app.useGlobalFilters(new AllExceptionsFilter());
+
   app.enableVersioning({
     type: VersioningType.URI,
     prefix: "v",
@@ -28,7 +35,7 @@ export async function bootstrap() {
     .setTitle("Recreation Sites and Trails BC Admin API")
     .setDescription("RST Admin API documentation")
     .setVersion("1.0")
-    .addTag("recreation-resource")
+    .addTag("recreation-resource-admin")
     .addBearerAuth(
       {
         name: "Authorization",

admin/backend/src/app.ts

@@ -1,7 +1,13 @@
 // Metadata keys for decorators
 export const AUTH_ROLES_KEY = "roles";
 
-export const AUTH_RST_ADMIN_ROLE = "rst-admin";
+/**
+ * Enum for authentication roles.
+ */
+export enum RecreationResourceAuthRole {
+  RST_ADMIN = "rst-admin",
+  RST_VIEWER = "rst-viewer",
+}
 
 // Role validation modes
 export const ROLE_MODE = {

admin/backend/src/auth/auth.constants.ts

@@ -0,0 +1,31 @@
+import { ApiProperty } from "@nestjs/swagger";
+import { GenericErrorResponseDto } from "./generic-error-response.dto"; // Import the generic DTO
+import { ValidationErrorDetailDto } from "./validation-error-detail.dto";
+
+export class BadRequestResponseDto extends GenericErrorResponseDto {
+  @ApiProperty({
+    description:
+      "An array of detailed validation errors specific to this bad request.",
+    type: [ValidationErrorDetailDto], // Reference the nested DTO
+    example: [
+      {
+        field: "email",
+        messages: ["email must be an email"],
+      },
+      {
+        field: "password",
+        messages: [
+          "password should not be empty",
+          "password must be longer than or equal to 6 characters",
+        ],
+      },
+    ],
+  })
+  details: ValidationErrorDetailDto[];
+
+  @ApiProperty({
+    type: "integer",
+    enum: [400],
+  })
+  declare readonly statusCode = 400;
+}

admin/backend/src/common/dtos/bad-request-response.dto.ts

@@ -0,0 +1,43 @@
+import { ApiProperty } from "@nestjs/swagger";
+import { HttpStatus } from "@nestjs/common";
+
+export const ErrorHttpStatusCodes = [
+  HttpStatus.BAD_REQUEST,
+  HttpStatus.UNAUTHORIZED,
+  HttpStatus.FORBIDDEN,
+  HttpStatus.NOT_FOUND,
+  HttpStatus.INTERNAL_SERVER_ERROR,
+] as const;
+
+export class GenericErrorResponseDto {
+  @ApiProperty({
+    description: "The HTTP status code of the error response.",
+    example: 404,
+    enum: ErrorHttpStatusCodes,
+  })
+  statusCode: number;
+
+  @ApiProperty({
+    description: "A general message describing the error.",
+    example: "Resource Not Found",
+  })
+  message: string; // Keep this as string if your generic filter always produces a string message here
+
+  @ApiProperty({
+    description: "The error type or short description of the HTTP status.",
+    example: "Not Found",
+  })
+  error?: string; // Optional, can be derived from status code
+
+  @ApiProperty({
+    description: "The timestamp of when the error occurred (ISO 8601 format).",
+    example: "2025-06-13T21:13:23.000Z", // Example based on current time
+  })
+  timestamp: string;
+
+  @ApiProperty({
+    description: "The request path that caused the error.",
+    example: "/api/v1/users/invalid-input",
+  })
+  path: string;
+}

admin/backend/src/common/dtos/generic-error-response.dto.ts

@@ -0,0 +1,19 @@
+import { ApiProperty } from "@nestjs/swagger";
+
+export class ValidationErrorDetailDto {
+  @ApiProperty({
+    description: "The name of the field that failed validation.",
+    example: "name",
+  })
+  field: string;
+
+  @ApiProperty({
+    description: "An array of error messages for the field.",
+    type: [String],
+    example: [
+      "name must be longer than or equal to 3 characters",
+      "name should not be empty",
+    ],
+  })
+  messages: string[];
+}