Added new metadata field for ODDK datatargets

Author: fcv-iteratorIt

src/entities/dto/create-open-data-dk-dataset.dto.ts

@@ -1,5 +1,5 @@
 import { ApiProperty, ApiPropertyOptional } from "@nestjs/swagger";
-import { IsEmail, IsNotEmpty, IsOptional, IsString, IsUrl } from "class-validator";
+import { IsBoolean, IsEmail, IsNotEmpty, IsOptional, IsString, IsUrl } from "class-validator";
 
 export class CreateOpenDataDkDatasetDto {
   @ApiProperty({ required: true })
@@ -17,6 +17,11 @@ export class CreateOpenDataDkDatasetDto {
   @IsString({ each: true, always: true })
   keywords?: string[];
 
+  @ApiProperty({ required: false })
+  @IsOptional()
+  @IsString()
+  keywordTags: string;
+
   @ApiProperty({ required: true })
   @IsString()
   @IsUrl({ protocols: ["http", "https"] })
@@ -36,4 +41,18 @@ export class CreateOpenDataDkDatasetDto {
   @IsString()
   @IsNotEmpty()
   resourceTitle: string;
+
+  @ApiProperty({ required: false })
+  @IsOptional()
+  @IsString()
+  updateFrequency: string = "UNKNOWN";
+
+  @ApiProperty({ required: false })
+  @IsOptional()
+  @IsUrl()
+  documentationUrl: string;
+
+  @ApiProperty({ required: true })
+  @IsBoolean()
+  dataDirectory: boolean;
 }

src/entities/dto/open-data-dk-dcat.dto.ts

@@ -37,6 +37,9 @@ export class Dataset {
   distribution: Distribution[];
   spatial: string;
   theme: string[];
+  documentation: string;
+  frequency: string | undefined;
+  dataDirectory: boolean;
 }
 
 export class DCATRootObject {

src/entities/open-data-dk-dataset.entity.ts

@@ -18,6 +18,9 @@ export class OpenDataDkDataset extends DbBaseEntity {
   @Column("text", { array: true, nullable: true })
   keywords?: string[];
 
+  @Column({ nullable: true })
+  keywordTags?: string;
+
   @Column()
   license: string;
 
@@ -29,4 +32,13 @@ export class OpenDataDkDataset extends DbBaseEntity {
 
   @Column({ nullable: false, default: "" })
   resourceTitle: string;
+
+  @Column({ nullable: true })
+  updateFrequency?: string;
+
+  @Column({ nullable: true })
+  documentationUrl?: string;
+
+  @Column({ nullable: false, default: false })
+  dataDirectory: boolean;
 }

src/migration/1762524771197-added-new-fields-to-oddk-datatarget.ts

@@ -0,0 +1,20 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class AddedNewFieldsToOddkDatatarget1762524771197 implements MigrationInterface {
+    name = 'AddedNewFieldsToOddkDatatarget1762524771197'
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`ALTER TABLE "open_data_dk_dataset" ADD "keywordTags" character varying`);
+        await queryRunner.query(`ALTER TABLE "open_data_dk_dataset" ADD "updateFrequency" character varying`);
+        await queryRunner.query(`ALTER TABLE "open_data_dk_dataset" ADD "documentationUrl" character varying`);
+        await queryRunner.query(`ALTER TABLE "open_data_dk_dataset" ADD "dataDirectory" boolean NOT NULL DEFAULT false`);
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`ALTER TABLE "open_data_dk_dataset" DROP COLUMN "dataDirectory"`);
+        await queryRunner.query(`ALTER TABLE "open_data_dk_dataset" DROP COLUMN "documentationUrl"`);
+        await queryRunner.query(`ALTER TABLE "open_data_dk_dataset" DROP COLUMN "updateFrequency"`);
+        await queryRunner.query(`ALTER TABLE "open_data_dk_dataset" DROP COLUMN "keywordTags"`);
+    }
+
+}

src/services/data-management/open-data-dk-sharing.service.ts

@@ -3,7 +3,7 @@ import { Injectable, Logger } from "@nestjs/common";
 import { InjectRepository } from "@nestjs/typeorm";
 import { Repository } from "typeorm";
 
-import { DCATRootObject, Dataset, ContactPoint, Distribution } from "@dto/open-data-dk-dcat.dto";
+import { ContactPoint, Dataset, DCATRootObject, Distribution } from "@dto/open-data-dk-dcat.dto";
 import { OpenDataDkDataset } from "@entities/open-data-dk-dataset.entity";
 import { Organization } from "@entities/organization.entity";
 import { PayloadDecoderExecutorService } from "./payload-decoder-executor.service";
@@ -17,16 +17,16 @@ import { ChirpstackDeviceService } from "@services/chirpstack/chirpstack-device.
 
 @Injectable()
 export class OpenDataDkSharingService {
+  private readonly BACKEND_BASE_URL = configuration()["backend"]["baseurl"];
+  private readonly logger = new Logger(OpenDataDkSharingService.name);
+
   constructor(
     @InjectRepository(OpenDataDkDataset)
     private repository: Repository<OpenDataDkDataset>,
     private payloadDecoderExecutorService: PayloadDecoderExecutorService,
     private chirpstackDeviceService: ChirpstackDeviceService
   ) {}
 
-  private readonly BACKEND_BASE_URL = configuration()["backend"]["baseurl"];
-  private readonly logger = new Logger(OpenDataDkSharingService.name);
-
   async getDecodedDataInDataset(dataset: OpenDataDkDataset): Promise<any[] | { error: ErrorCodes }> {
     const rawData = await this.repository
       .createQueryBuilder("dataset")
@@ -46,6 +46,25 @@ export class OpenDataDkSharingService {
     return await this.decodeData(rawData);
   }
 
+  async createDCAT(organization: Organization): Promise<DCATRootObject> {
+    const datasets = await this.getAllOpenDataDkSharesForOrganization(organization);
+
+    return this.mapToDCAT(organization, datasets);
+  }
+
+  async findById(shareId: number, organizationId: number): Promise<OpenDataDkDataset> {
+    return await this.findDatasetWithRelations()
+      .where("dataset.id = :datasetId and org.id = :organizationId", {
+        datasetId: shareId,
+        organizationId: organizationId,
+      })
+      .getOne();
+  }
+
+  async getAllOpenDataDkSharesForOrganization(organization: Organization): Promise<OpenDataDkDataset[]> {
+    return this.findDatasetWithRelations().where("org.id = :orgId", { orgId: organization.id }).getMany();
+  }
+
   private async decodeData(rawData: OpenDataDkDataset) {
     const results: any[] = [];
     for (const connection of rawData.dataTarget.connections) {
@@ -96,25 +115,6 @@ export class OpenDataDkSharingService {
     }
   }
 
-  async createDCAT(organization: Organization): Promise<DCATRootObject> {
-    const datasets = await this.getAllOpenDataDkSharesForOrganization(organization);
-
-    return this.mapToDCAT(organization, datasets);
-  }
-
-  async findById(shareId: number, organizationId: number): Promise<OpenDataDkDataset> {
-    return await this.findDatasetWithRelations()
-      .where("dataset.id = :datasetId and org.id = :organizationId", {
-        datasetId: shareId,
-        organizationId: organizationId,
-      })
-      .getOne();
-  }
-
-  async getAllOpenDataDkSharesForOrganization(organization: Organization): Promise<OpenDataDkDataset[]> {
-    return this.findDatasetWithRelations().where("org.id = :orgId", { orgId: organization.id }).getMany();
-  }
-
   private findDatasetWithRelations() {
     return this.repository
       .createQueryBuilder("dataset")
@@ -146,7 +146,8 @@ export class OpenDataDkSharingService {
     ds.landingPage = undefined;
     ds.title = dataset.name;
     ds.description = dataset.description;
-    ds.keyword = dataset.keywords != null ? dataset.keywords : [];
+    ds.theme = dataset.keywords != null ? dataset.keywords : [];
+    ds.keyword = dataset.keywordTags != null ? dataset.keywordTags.split(",") : [];
     ds.issued = dataset.createdAt;
     ds.modified = dataset.updatedAt;
     ds.publisher = {
@@ -156,6 +157,9 @@ export class OpenDataDkSharingService {
     ds.contactPoint["@type"] = "vcard:Contact";
     ds.contactPoint.fn = dataset.authorName;
     ds.contactPoint.hasEmail = `mailto:${dataset.authorEmail}`;
+    ds.documentation = dataset.documentationUrl;
+    ds.frequency = dataset.updateFrequency;
+    ds.dataDirectory = dataset.dataDirectory;
 
     ds.distribution = [this.mapDistribution(organization, dataset)];
 

src/services/data-targets/data-target.service.ts

@@ -307,7 +307,12 @@ export class DataTargetService {
 
     o.description = dto.description;
     o.keywords = dto.keywords;
+    o.keywordTags = dto.keywordTags;
     o.resourceTitle = dto.resourceTitle;
+
+    o.updateFrequency = dto.updateFrequency;
+    o.documentationUrl = dto.documentationUrl;
+    o.dataDirectory = dto.dataDirectory;
     return o;
   }