fix(publisheddata): return the correct format for publisher in v3

src/published-data/dto/published-data.obsolete.dto.ts

@@ -1,8 +1,63 @@
 import { ApiProperty } from "@nestjs/swagger";
-import { IsDateString, IsNumber, IsOptional, IsString } from "class-validator";
+import { Expose, Transform } from "class-transformer";
+import {
+  IsDateString,
+  IsNumber,
+  IsOptional,
+  IsString,
+  NotEquals,
+} from "class-validator";
+import _ from "lodash";
+import { PublishedDataStatus } from "../interfaces/published-data.interface";
+import { PublishedData } from "../schemas/published-data.schema";
+
+function mapPublishedDataV3toV4Field(
+  publishedData: PublishedData,
+  key: keyof PublishedDataObsoleteDto | string,
+):
+  | PublishedDataObsoleteDto[keyof PublishedDataObsoleteDto]
+  | PublishedData[keyof PublishedData]
+  | unknown
+  | null {
+  if (!publishedData) return null;
+  return (
+    publishedData[key as keyof PublishedData] ??
+    _.get(publishedData, publishedDataV3tov4FieldMap(key))
+  );
+}
+
+function publishedDataV3tov4FieldMap(key: string): string {
+  switch (key) {
+    case "pidArray":
+      return "datasetPids";
+    case "creator":
+      return "metadata.creators";
+    case "relatedPublications":
+      return "metadata.relatedIdentifiers";
+    default:
+      return `metadata.${key}`;
+  }
+}
+
+function extractPropertyFromMetadata(
+  obj: PublishedData,
+  key: keyof PublishedDataObsoleteDto | string,
+  propertyName: string,
+): string | string[] | null {
+  const hasName = (entry: unknown): entry is { [propertyName]: string } =>
+    typeof entry === "object" && entry !== null && propertyName in entry;
+
+  const metadataEntry = mapPublishedDataV3toV4Field(obj, key);
+  if (Array.isArray(metadataEntry)) {
+    return metadataEntry.filter(hasName).map((e) => e[propertyName]);
+  }
+
+  return hasName(metadataEntry) ? metadataEntry[propertyName] : null;
+}
 
 export class PublishedDataObsoleteDto {
   @IsString()
+  @Expose()
   _id: string;
 
   @ApiProperty({
@@ -12,6 +67,7 @@ export class PublishedDataObsoleteDto {
       ' "10.xxx/9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d".',
   })
   @IsString()
+  @Expose()
   doi: string;
 
   @ApiProperty({
@@ -23,6 +79,10 @@ export class PublishedDataObsoleteDto {
   })
   @IsString()
   @IsOptional()
+  @Expose()
+  @Transform(({ obj, key }) => mapPublishedDataV3toV4Field(obj, key), {
+    toClassOnly: true,
+  })
   affiliation?: string;
 
   @ApiProperty({
@@ -34,6 +94,10 @@ export class PublishedDataObsoleteDto {
       " and [DataCite Creator/creatorName](https://datacite-metadata-schema.readthedocs.io/en/4.5/properties/creator/#creatorname).",
   })
   @IsString({ each: true })
+  @Expose()
+  @Transform(({ obj, key }) => extractPropertyFromMetadata(obj, key, "name"), {
+    toClassOnly: true,
+  })
   creator: string[];
 
   @ApiProperty({
@@ -45,6 +109,11 @@ export class PublishedDataObsoleteDto {
       " and [DataCite publisher](https://datacite-metadata-schema.readthedocs.io/en/4.5/properties/publisher).",
   })
   @IsString()
+  @NotEquals(null)
+  @Expose()
+  @Transform(({ obj, key }) => extractPropertyFromMetadata(obj, key, "name"), {
+    toClassOnly: true,
+  })
   publisher: string;
 
   @ApiProperty({
@@ -56,6 +125,10 @@ export class PublishedDataObsoleteDto {
       " and [DataCite publicationYear](https://datacite-metadata-schema.readthedocs.io/en/4.5/properties/publicationyear/).",
   })
   @IsNumber()
+  @Expose()
+  @Transform(({ obj, key }) => mapPublishedDataV3toV4Field(obj, key), {
+    toClassOnly: true,
+  })
   publicationYear: number;
 
   @ApiProperty({
@@ -67,6 +140,7 @@ export class PublishedDataObsoleteDto {
       " and [DataCite title](https://datacite-metadata-schema.readthedocs.io/en/4.5/properties/title/).",
   })
   @IsString()
+  @Expose()
   title: string;
 
   @ApiProperty({
@@ -76,6 +150,10 @@ export class PublishedDataObsoleteDto {
   })
   @IsString()
   @IsOptional()
+  @Expose()
+  @Transform(({ obj, key }) => mapPublishedDataV3toV4Field(obj, key), {
+    toClassOnly: true,
+  })
   url?: string;
 
   @ApiProperty({
@@ -87,6 +165,7 @@ export class PublishedDataObsoleteDto {
       " with [Abstract descriptionType](https://datacite-metadata-schema.readthedocs.io/en/4.5/appendices/appendix-1/descriptionType/#abstract).",
   })
   @IsString()
+  @Expose()
   abstract: string;
 
   @ApiProperty({
@@ -99,6 +178,10 @@ export class PublishedDataObsoleteDto {
       " with [Abstract descriptionType](https://datacite-metadata-schema.readthedocs.io/en/4.5/appendices/appendix-1/descriptionType/#abstract).",
   })
   @IsString()
+  @Expose()
+  @Transform(({ obj, key }) => mapPublishedDataV3toV4Field(obj, key), {
+    toClassOnly: true,
+  })
   dataDescription: string;
 
   @ApiProperty({
@@ -107,6 +190,10 @@ export class PublishedDataObsoleteDto {
     description: "e.g. raw/ derived",
   })
   @IsString()
+  @Expose()
+  @Transform(({ obj, key }) => mapPublishedDataV3toV4Field(obj, key), {
+    toClassOnly: true,
+  })
   resourceType: string;
 
   @ApiProperty({
@@ -116,6 +203,7 @@ export class PublishedDataObsoleteDto {
   })
   @IsNumber()
   @IsOptional()
+  @Expose()
   numberOfFiles?: number;
 
   @ApiProperty({
@@ -125,6 +213,7 @@ export class PublishedDataObsoleteDto {
   })
   @IsNumber()
   @IsOptional()
+  @Expose()
   sizeOfArchive?: number;
 
   @ApiProperty({
@@ -135,6 +224,10 @@ export class PublishedDataObsoleteDto {
       " make up the published data.",
   })
   @IsString({ each: true })
+  @Expose()
+  @Transform(({ obj, key }) => mapPublishedDataV3toV4Field(obj, key), {
+    toClassOnly: true,
+  })
   pidArray: string[];
 
   @ApiProperty({
@@ -144,13 +237,18 @@ export class PublishedDataObsoleteDto {
   })
   @IsString({ each: true })
   @IsOptional()
+  @Expose()
+  @Transform(({ obj, key }) => extractPropertyFromMetadata(obj, key, "name"), {
+    toClassOnly: true,
+  })
   authors?: string[];
 
   @ApiProperty({
     type: Date,
     description: "Time when doi is successfully registered",
   })
   @IsDateString()
+  @Expose()
   registeredTime: Date;
 
   @ApiProperty({
@@ -159,6 +257,16 @@ export class PublishedDataObsoleteDto {
       "Indication of position in publication workflow e.g. doiRegistered",
   })
   @IsString()
+  @Expose()
+  @Transform(
+    ({ obj }) =>
+      [PublishedDataStatus.REGISTERED, PublishedDataStatus.AMENDED].includes(
+        obj.status,
+      )
+        ? "registered"
+        : "pending_registration",
+    { toClassOnly: true },
+  )
   status: string;
 
   @ApiProperty({
@@ -169,6 +277,10 @@ export class PublishedDataObsoleteDto {
   })
   @IsString()
   @IsOptional()
+  @Expose()
+  @Transform(({ obj, key }) => mapPublishedDataV3toV4Field(obj, key), {
+    toClassOnly: true,
+  })
   scicatUser?: string;
 
   @ApiProperty({
@@ -178,6 +290,10 @@ export class PublishedDataObsoleteDto {
   })
   @IsString()
   @IsOptional()
+  @Expose()
+  @Transform(({ obj, key }) => mapPublishedDataV3toV4Field(obj, key), {
+    toClassOnly: true,
+  })
   thumbnail?: string;
 
   @ApiProperty({
@@ -188,6 +304,12 @@ export class PublishedDataObsoleteDto {
   })
   @IsString({ each: true })
   @IsOptional()
+  @Expose()
+  @Transform(
+    ({ obj, key }) =>
+      extractPropertyFromMetadata(obj, key, "relatedIdentifier"),
+    { toClassOnly: true },
+  )
   relatedPublications?: string[];
 
   @ApiProperty({
@@ -197,6 +319,10 @@ export class PublishedDataObsoleteDto {
   })
   @IsString()
   @IsOptional()
+  @Expose()
+  @Transform(({ obj, key }) => mapPublishedDataV3toV4Field(obj, key), {
+    toClassOnly: true,
+  })
   downloadLink?: string;
 
   @ApiProperty({
@@ -205,6 +331,7 @@ export class PublishedDataObsoleteDto {
       "Date when the published data was created. This property is added and maintained by the system",
   })
   @IsDateString()
+  @Expose()
   createdAt: Date;
 
   @ApiProperty({
@@ -213,5 +340,6 @@ export class PublishedDataObsoleteDto {
       "Date when the published data was last updated. This property is added and maintained by the system",
   })
   @IsDateString()
+  @Expose()
   updatedAt: Date;
 }

src/published-data/published-data.controller.spec.ts

@@ -60,29 +60,4 @@ describe("PublishedDataController", () => {
       PublishedDataStatus.PRIVATE,
     );
   });
-  it("should result in 'pending_registration'", () => {
-    expect(controller.convertCurrentStatusToObsolete(undefined)).toEqual(
-      "pending_registration",
-    );
-  });
-  it("should result in 'pending_registration'", () => {
-    expect(
-      controller.convertCurrentStatusToObsolete(PublishedDataStatus.PRIVATE),
-    ).toEqual("pending_registration");
-  });
-  it("should result in 'pending_registration'", () => {
-    expect(
-      controller.convertCurrentStatusToObsolete(PublishedDataStatus.PUBLIC),
-    ).toEqual("pending_registration");
-  });
-  it("should result in 'registered'", () => {
-    expect(
-      controller.convertCurrentStatusToObsolete(PublishedDataStatus.REGISTERED),
-    ).toEqual("registered");
-  });
-  it("should result in 'registered'", () => {
-    expect(
-      controller.convertCurrentStatusToObsolete(PublishedDataStatus.AMENDED),
-    ).toEqual("registered");
-  });
 });