feat: added pdf docs link in maps and location section (#468)

Co-authored-by: jimmypalelil <[email protected]>

Author: jimmypalelil

backend/prisma/schema.prisma

@@ -27,6 +27,7 @@ model recreation_resource {
   recreation_fee             recreation_fee[]
   recreation_map_feature     recreation_map_feature[]
   recreation_district_code   recreation_district_code?    @relation(fields: [district_code], references: [district_code], onDelete: NoAction, onUpdate: NoAction)
+  recreation_resource_docs   recreation_resource_docs[]
   recreation_resource_images recreation_resource_images[]
   recreation_resource_type   recreation_resource_type?
   recreation_status          recreation_status?
@@ -523,3 +524,24 @@ model recreation_resource_images {
 
   @@unique([rec_resource_id, ref_id])
 }
+
+/// This model or at least one of its fields has comments in the database, and requires an additional setup for migrations: Read more: https://pris.ly/d/database-comments
+model recreation_resource_doc_code {
+  doc_code                 String                     @id @db.VarChar
+  description              String?                    @db.VarChar
+  recreation_resource_docs recreation_resource_docs[]
+}
+
+/// This model or at least one of its fields has comments in the database, and requires an additional setup for migrations: Read more: https://pris.ly/d/database-comments
+model recreation_resource_docs {
+  ref_id                       String                        @id(map: "recreation_resource_doc_pkey") @db.VarChar
+  rec_resource_id              String?                       @db.VarChar(10)
+  title                        String?                       @db.VarChar
+  url                          String?                       @db.VarChar
+  doc_code                     String?                       @db.VarChar
+  extension                    String?                       @db.VarChar
+  recreation_resource_doc_code recreation_resource_doc_code? @relation(fields: [doc_code], references: [doc_code], onDelete: NoAction, onUpdate: NoAction, map: "recreation_resource_doc_doc_code_fkey")
+  recreation_resource          recreation_resource?          @relation(fields: [rec_resource_id], references: [rec_resource_id], onDelete: NoAction, onUpdate: NoAction, map: "recreation_resource_doc_rec_resource_id_fkey")
+
+  @@unique([rec_resource_id, ref_id], map: "recreation_resource_doc_rec_resource_id_ref_id_key")
+}

backend/src/recreation-resource/dto/recreation-resource-doc.dto.spec.ts

@@ -0,0 +1,40 @@
+import {
+  RecreationResourceDocCode,
+  RecreationResourceDocDto,
+} from "./recreation-resource-doc.dto";
+
+describe("RecreationResourceDocDto", () => {
+  it("should create a valid DTO instance", () => {
+    const dto = new RecreationResourceDocDto();
+    dto.ref_id = "1000";
+    dto.title = "Campbell river site map";
+    dto.url = "https://example.com/map.pdf";
+    dto.doc_code = RecreationResourceDocCode.RM;
+    dto.doc_code_description = "Recreation Map";
+    dto.extension = "pdf";
+
+    expect(dto).toBeDefined();
+    expect(dto.ref_id).toBe("1000");
+    expect(dto.title).toBe("Campbell river site map");
+    expect(dto.url).toBe("https://example.com/map.pdf");
+    expect(dto.doc_code).toBe(RecreationResourceDocCode.RM);
+    expect(dto.doc_code_description).toBe("Recreation Map");
+    expect(dto.extension).toBe("pdf");
+  });
+
+  it("should validate enum values", () => {
+    expect(Object.values(RecreationResourceDocCode)).toContain("RM");
+    expect(Object.keys(RecreationResourceDocCode)).toHaveLength(1);
+  });
+
+  it("should handle empty values", () => {
+    const dto = new RecreationResourceDocDto();
+    expect(dto).toBeDefined();
+    expect(dto.ref_id).toBeUndefined();
+    expect(dto.title).toBeUndefined();
+    expect(dto.url).toBeUndefined();
+    expect(dto.doc_code).toBeUndefined();
+    expect(dto.doc_code_description).toBeUndefined();
+    expect(dto.extension).toBeUndefined();
+  });
+});

backend/src/recreation-resource/dto/recreation-resource-doc.dto.ts

@@ -0,0 +1,44 @@
+import { ApiProperty } from "@nestjs/swagger";
+
+/**
+ * Enum representing available image size options for the recreation API
+ */
+export enum RecreationResourceDocCode {
+  /** Recreation Map */
+  RM = "RM",
+}
+
+export class RecreationResourceDocDto {
+  @ApiProperty({
+    description: "Reference ID for the image",
+    example: "1000",
+  })
+  ref_id: string;
+
+  @ApiProperty({
+    description: "Doc title",
+    example: "Campbell river site map",
+  })
+  title: string;
+
+  @ApiProperty({
+    description: "doc link",
+  })
+  url: string;
+
+  @ApiProperty({
+    description: "Document code that indicates the type of document",
+    enum: RecreationResourceDocCode,
+  })
+  doc_code: RecreationResourceDocCode;
+
+  @ApiProperty({
+    description: "Description of the document code",
+  })
+  doc_code_description: string;
+
+  @ApiProperty({
+    description: "File extension",
+  })
+  extension: string;
+}

backend/src/recreation-resource/dto/recreation-resource.dto.ts

@@ -1,5 +1,6 @@
 import { ApiProperty } from "@nestjs/swagger";
 import { RecreationResourceImageDto } from "./recreation-resource-image.dto";
+import { RecreationResourceDocDto } from "./recreation-resource-doc.dto";
 
 export class RecreationActivityDto {
   @ApiProperty({
@@ -236,6 +237,13 @@ export class RecreationResourceDetailDto extends BaseRecreationResourceDto {
     ],
   })
   spatial_feature_geometry?: string[];
+
+  @ApiProperty({
+    description: "List of documents for the recreation resource",
+    type: [RecreationResourceDocDto],
+    required: false,
+  })
+  recreation_resource_docs?: RecreationResourceDocDto[];
 }
 
 /**

backend/src/recreation-resource/recreation-resource.controller.ts

@@ -1,5 +1,11 @@
 import { Controller, Get, HttpException, Param, Query } from "@nestjs/common";
-import { ApiOperation, ApiQuery, ApiResponse, ApiTags } from "@nestjs/swagger";
+import {
+  ApiOperation,
+  ApiParam,
+  ApiQuery,
+  ApiResponse,
+  ApiTags,
+} from "@nestjs/swagger";
 import { RecreationResourceService } from "./recreation-resource.service";
 import { PaginatedRecreationResourceDto } from "./dto/paginated-recreation-resource.dto";
 import { RecreationResourceImageSize } from "./dto/recreation-resource-image.dto";
@@ -116,6 +122,13 @@ export class RecreationResourceController {
     summary: "Find recreation resource by ID",
     operationId: "getRecreationResourceById",
   })
+  @ApiParam({
+    name: "id",
+    required: true,
+    description: "Resource identifier",
+    type: "string",
+    example: "REC204117",
+  })
   @ApiQuery({
     name: "imageSizeCodes",
     required: false,