feat: templated external links (draft)

src/datasets/dto/output-dataset.dto.ts

@@ -1,6 +1,14 @@
-import { ApiProperty, PartialType } from "@nestjs/swagger";
+import { ApiProperty, getSchemaPath, PartialType } from "@nestjs/swagger";
 import { CreateDatasetDto } from "./create-dataset.dto";
-import { IsDateString, IsString } from "class-validator";
+import { Type } from "class-transformer";
+import {
+  IsArray,
+  IsDateString,
+  IsOptional,
+  IsString,
+  ValidateNested,
+} from "class-validator";
+import { ExternalLinkClass } from "../schemas/externallink.class";
 
 export class OutputDatasetDto extends CreateDatasetDto {
   @ApiProperty({
@@ -39,6 +47,19 @@ export class OutputDatasetDto extends CreateDatasetDto {
   @IsDateString()
   updatedAt: Date;
 
+  @ApiProperty({
+    type: "array",
+    items: { $ref: getSchemaPath(ExternalLinkClass) },
+    required: false,
+    default: [],
+    description: "List of external links that involve this data set.",
+  })
+  @IsArray()
+  @IsOptional()
+  @ValidateNested({ each: true })
+  @Type(() => ExternalLinkClass)
+  readonly externalLinks?: ExternalLinkClass[];
+
   @ApiProperty({
     type: String,
     required: true,

src/datasets/schemas/externallink.class.ts

@@ -0,0 +1,27 @@
+import { ApiProperty } from "@nestjs/swagger";
+
+// This data is not represented in Mongoose.
+// It is generated internally based on the user-defined link templates.
+
+export class ExternalLinkClass {
+  @ApiProperty({
+    type: String,
+    required: true,
+    description: "URL of the external link.",
+  })
+  url: string;
+
+  @ApiProperty({
+    type: String,
+    required: true,
+    description: "Text to display representing the external link.",
+  })
+  title: string;
+
+  @ApiProperty({
+    type: String,
+    required: false,
+    description: "Description of the link destination.",
+  })
+  description?: string;
+}