feat: templated external links (draft)

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

@@ -5,6 +5,7 @@ import {
   IsObject,
   IsOptional,
   IsString,
+  ValidateNested,
 } from "class-validator";
 import { ApiProperty, getSchemaPath } from "@nestjs/swagger";
 import { UpdateDatasetObsoleteDto } from "./update-dataset-obsolete.dto";
@@ -13,6 +14,7 @@ import { OrigDatablock } from "src/origdatablocks/schemas/origdatablock.schema";
 import { Datablock } from "src/datablocks/schemas/datablock.schema";
 import { DatasetType } from "../types/dataset-type.enum";
 import { OutputAttachmentV3Dto } from "src/attachments/dto-obsolete/output-attachment.v3.dto";
+import { ExternalLinkClass } from "../schemas/externallink.class";
 
 export class OutputDatasetObsoleteDto extends UpdateDatasetObsoleteDto {
   @ApiProperty({
@@ -200,6 +202,18 @@ export class OutputDatasetObsoleteDto extends UpdateDatasetObsoleteDto {
   @Type(() => Datablock)
   datablocks?: Datablock[];
 
+  @ApiProperty({
+    type: [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/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({
@@ -47,6 +55,18 @@
   @IsDateString()
   updatedAt: Date;
 
+  @ApiProperty({
+    type: [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/dataset.schema.ts

@@ -1,8 +1,9 @@
-import { Prop, Schema, SchemaFactory } from "@nestjs/mongoose";
+import { Prop, Virtual, Schema, SchemaFactory } from "@nestjs/mongoose";
 import { ApiProperty, getSchemaPath } from "@nestjs/swagger";
 import { Document } from "mongoose";
 import { OwnableClass } from "src/common/schemas/ownable.schema";
 import { v4 as uuidv4 } from "uuid";
+import { ExternalLinkClass } from "./externallink.class";
 import { HistoryClass, HistorySchema } from "./history.schema";
 import { LifecycleClass, LifecycleSchema } from "./lifecycle.schema";
 import { RelationshipClass, RelationshipSchema } from "./relationship.schema";
@@ -14,8 +15,12 @@
   collection: "Dataset",
   minimize: false,
   timestamps: true,
+  toObject: {
+    virtuals: true,
+  },
   toJSON: {
     getters: true,
+    virtuals: true,
   },
 })
 export class DatasetClass extends OwnableClass {
@@ -265,6 +270,25 @@
   @Prop({ type: String, required: true })
   version: string;
 
+  @ApiProperty({
+    type: [ExternalLinkClass],
+    required: false,
+    default: [],
+    description: "List of external links that involve this data set.",
+  })
+  @Virtual({
+    get: function (this: ExternalLinkClass[]) {
+      //`${this.firstName} ${this.lastName}`;
+      return [
+        { url: "test_url",
+          title: "test_title",
+          description: "test_description"
+        }
+      ];
+    },
+  })
+  externalLinks?: ExternalLinkClass[];
+
   @ApiProperty({
     type: "array",
     items: { $ref: getSchemaPath(HistoryClass) },

src/datasets/schemas/externallink.class.ts

@@ -0,0 +1,31 @@
+import { ApiProperty } from "@nestjs/swagger";
+import { IsString } from "class-validator";
+
+// 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.",
+  })
+  @IsString()
+  readonly url: string;
+
+  @ApiProperty({
+    type: String,
+    required: true,
+    description: "Text to display representing the external link.",
+  })
+  @IsString()
+  readonly title: string;
+
+  @ApiProperty({
+    type: String,
+    required: false,
+    description: "Description of the link destination.",
+  })
+  @IsString()
+  readonly description?: string;
+}