Feature/iot 1416 (#211)

* Added missing packages to package lock

* Create .licrc for licensebat scan

* Deleting licensebat file as it is obsolete

* IOT-1416: Minor changes for supporting the front-end-changes for having OpenDataDK datatargets more separate from HTTP-Push..

* Finished implementing new flow for sending ODDK-registration-mails directly from OS2IoT, instead of having to go through users mail-client..

* Renamed the new entity for OpenDataDK datatargets, to match naming-convention of other ODDK-files..

---------

Co-authored-by: Frederik Christ Vestergaard <[email protected]>

Author: Fritsen

src/config/configuration.ts

@@ -39,15 +39,15 @@ export default (): any => {
         email: {
             host: process.env.EMAIL_HOST || "smtp.ethereal.email",
             port: process.env.EMAIL_PORT || 587,
-            user: process.env.EMAIL_USER || "ara.kertzmann8@ethereal.email",
-            pass: process.env.EMAIL_PASS || "KzRSyYReEygpFPPZdd",
+            user: process.env.EMAIL_USER || "tremayne38@ethereal.email",
+            pass: process.env.EMAIL_PASS || "UjbMtRZNkrUcVJsvTM",
             /**
              * Can be formatted to show a user-friendly name before the e-mail.
              * E.g. "OS2iot <[email protected]>"
              */
             from: process.env.EMAIL_FROM
                 ? formatEmail(process.env.EMAIL_FROM)
-                : "OS2iot ara.kertzmann8@ethereal.email",
+                : "OS2iot tremayne38@ethereal.email",
         },
         frontend: {
             baseurl: process.env.FRONTEND_BASEURL || "http://localhost:8081",

src/controllers/admin-controller/data-target.controller.ts

@@ -13,17 +13,17 @@ import {
     Req,
     UseGuards,
 } from "@nestjs/common";
-import { UnauthorizedException } from "@nestjs/common";
 import {
     ApiBadRequestResponse,
     ApiBearerAuth,
     ApiForbiddenResponse,
+    ApiNotFoundResponse,
     ApiOperation,
     ApiTags,
     ApiUnauthorizedResponse,
 } from "@nestjs/swagger";
 
-import { ComposeAuthGuard } from '@auth/compose-auth.guard';
+import { ComposeAuthGuard } from "@auth/compose-auth.guard";
 import { Read, ApplicationAdmin } from "@auth/roles.decorator";
 import { RolesGuard } from "@auth/roles.guard";
 import { CreateDataTargetDto } from "@dto/create-data-target.dto";
@@ -41,6 +41,8 @@ import {
 import { DataTargetService } from "@services/data-targets/data-target.service";
 import { AuditLog } from "@services/audit-log.service";
 import { ActionType } from "@entities/audit-log-entry";
+import { OrganizationService } from "@services/user-management/organization.service";
+import { OddkMailInfo } from "@dto/oddk-mail-info.dto";
 
 @ApiTags("Data Target")
 @Controller("data-target")
@@ -50,7 +52,10 @@ import { ActionType } from "@entities/audit-log-entry";
 @ApiForbiddenResponse()
 @ApiUnauthorizedResponse()
 export class DataTargetController {
-    constructor(private dataTargetService: DataTargetService) {}
+    constructor(
+        private dataTargetService: DataTargetService,
+        private organizationService: OrganizationService
+    ) {}
 
     @Get()
     @ApiOperation({ summary: "Find all DataTargets" })
@@ -65,7 +70,11 @@ export class DataTargetController {
                 query.applicationId = +query.applicationId;
             }
 
-            checkIfUserHasAccessToApplication(req, query.applicationId, ApplicationAccessScope.Read);
+            checkIfUserHasAccessToApplication(
+                req,
+                query.applicationId,
+                ApplicationAccessScope.Read
+            );
             const allowed = req.user.permissions.getAllApplicationsWithAtLeastRead();
 
             return await this.dataTargetService.findAndCountAllWithPagination(
@@ -83,7 +92,11 @@ export class DataTargetController {
     ): Promise<DataTarget> {
         try {
             const dataTarget = await this.dataTargetService.findOne(id);
-            checkIfUserHasAccessToApplication(req, dataTarget.application.id, ApplicationAccessScope.Read);
+            checkIfUserHasAccessToApplication(
+                req,
+                dataTarget.application.id,
+                ApplicationAccessScope.Read
+            );
             return dataTarget;
         } catch (err) {
             throw new NotFoundException(ErrorCodes.IdDoesNotExists);
@@ -132,9 +145,17 @@ export class DataTargetController {
     ): Promise<DataTarget> {
         const oldDataTarget = await this.dataTargetService.findOne(id);
         try {
-            checkIfUserHasAccessToApplication(req, oldDataTarget.application.id, ApplicationAccessScope.Write);
+            checkIfUserHasAccessToApplication(
+                req,
+                oldDataTarget.application.id,
+                ApplicationAccessScope.Write
+            );
             if (oldDataTarget.application.id !== updateDto.applicationId) {
-                checkIfUserHasAccessToApplication(req, updateDto.applicationId, ApplicationAccessScope.Write);
+                checkIfUserHasAccessToApplication(
+                    req,
+                    updateDto.applicationId,
+                    ApplicationAccessScope.Write
+                );
             }
         } catch (err) {
             AuditLog.fail(
@@ -172,7 +193,11 @@ export class DataTargetController {
     ): Promise<DeleteResponseDto> {
         try {
             const dt = await this.dataTargetService.findOne(id);
-            checkIfUserHasAccessToApplication(req, dt.application.id, ApplicationAccessScope.Write);
+            checkIfUserHasAccessToApplication(
+                req,
+                dt.application.id,
+                ApplicationAccessScope.Write
+            );
             const result = await this.dataTargetService.delete(id);
 
             if (result.affected === 0) {
@@ -188,4 +213,47 @@ export class DataTargetController {
             throw new NotFoundException(err);
         }
     }
+
+    @Get("getOpenDataDkRegistered/:organizationId")
+    @ApiOperation({ summary: "Get OpenDataDkRegistered-status for given OrganizationId" })
+    @ApiNotFoundResponse()
+    @Read()
+    async getOpenDataDkRegistered(@Param("organizationId", new ParseIntPipe()) organizationId: number): Promise<boolean> {
+        try {
+            return (await this.organizationService.findById(organizationId))?.openDataDkRegistered;
+        } catch (err) {
+            throw new NotFoundException(ErrorCodes.IdDoesNotExists);
+        }
+    }
+
+    @Put("updateOpenDataDkRegistered/:organizationId")
+    @ApiOperation({
+        summary: "Update the OpenDataDkRegistered to true, for the given OrganizationId - to stop showing the dialog for sending ODDK-mail on creation of new datatargets",
+    })
+    @ApiNotFoundResponse()
+    async updateOpenDataDkRegistered(
+        @Req() req: AuthenticatedRequest,
+        @Param("organizationId", new ParseIntPipe()) organizationId: number
+    ): Promise<boolean> {
+        try {
+            await this.organizationService.updateOpenDataDkRegistered(organizationId, req.user.userId);
+            return true;
+        } catch (err) {
+            if (err.name == "EntityNotFound") {
+                throw new NotFoundException();
+            }
+            throw err;
+        }
+    }
+
+    @Post("sendOpenDataDkMail")
+    @ApiOperation({summary: "Send mail for registering datatargets to Open Data DK, for the given OrganizationId"})
+    async sendOpenDataDkMail(
+        @Req() req: AuthenticatedRequest,
+        @Body() mailInfoDto: OddkMailInfo
+    ): Promise<boolean> {
+        await this.dataTargetService.sendOpenDataDkMail(mailInfoDto, req.user.userId);
+        await this.organizationService.updateOpenDataDkRegistered(mailInfoDto.organizationId, req.user.userId);
+        return true;
+    }
 }

src/controllers/admin-controller/open-data-dk-sharing.controller.ts

@@ -3,7 +3,6 @@ import { ErrorCodes } from "@enum/error-codes.enum";
 import { Controller, Get, NotFoundException, Param, ParseIntPipe } from "@nestjs/common";
 import { ApiTags } from "@nestjs/swagger";
 import { OpenDataDkSharingService } from "@services/data-management/open-data-dk-sharing.service";
-import { DataTargetService } from "@services/data-targets/data-target.service";
 import { OrganizationService } from "@services/user-management/organization.service";
 
 @ApiTags("OpenData.dk")

src/entities/dto/create-data-target.dto.ts

@@ -40,6 +40,7 @@ export class CreateDataTargetDto {
     @ApiProperty({ required: true })
     type: DataTargetType;
 
+    @ValidateIf((obj: CreateDataTargetDto) => obj.type !== DataTargetType.OpenDataDK)
     @ApiProperty({ required: true, example: "https://example.com/endpoint" })
     @IsString()
     @MaxLength(1024)
@@ -51,6 +52,7 @@ export class CreateDataTargetDto {
     })
     url: string;
 
+    @ValidateIf((obj: CreateDataTargetDto) => obj.type !== DataTargetType.OpenDataDK)
     @ApiProperty({ required: true, example: 30000 })
     @IsInt()
     timeout: number;

src/entities/dto/oddk-mail-info.dto.ts

@@ -0,0 +1,23 @@
+import { ApiProperty } from "@nestjs/swagger";
+import { IsNumber, IsString, IsUrl, MaxLength } from "class-validator";
+
+export class OddkMailInfo {
+    @ApiProperty({ required: true })
+    @IsNumber()
+    organizationId: number;
+
+    @ApiProperty({ required: true })
+    @IsString()
+    organizationOddkAlias: string;
+
+    @ApiProperty({ required: false })
+    comment?: string;
+
+    @ApiProperty({ required: true })
+    @IsString()
+    @MaxLength(1024)
+    @IsUrl({
+        require_tld: false,
+    })
+    sharingUrl: string;
+}

src/entities/enum/data-target-type-mapping.ts

@@ -1,10 +1,12 @@
 import { FiwareDataTarget } from "@entities/fiware-data-target.entity";
 import { HttpPushDataTarget } from "@entities/http-push-data-target.entity";
 import { MqttDataTarget } from "@entities/mqtt-data-target.entity";
+import { OpenDataDkDataTarget } from "@entities/open-data-dk-push-data-target.entity";
 import { DataTargetType } from "@enum/data-target-type.enum";
 
 export const dataTargetTypeMap = {
     [DataTargetType.HttpPush]: HttpPushDataTarget,
     [DataTargetType.Fiware]: FiwareDataTarget,
     [DataTargetType.MQTT]: MqttDataTarget,
+    [DataTargetType.OpenDataDK]: OpenDataDkDataTarget,
 };

src/entities/enum/data-target-type.enum.ts

@@ -2,4 +2,5 @@ export enum DataTargetType {
     HttpPush = "HTTP_PUSH",
     Fiware = "FIWARE",
     MQTT = "MQTT",
+    OpenDataDK = "OPENDATADK",
 }

src/entities/open-data-dk-push-data-target.entity.ts

@@ -0,0 +1,11 @@
+import { DataTarget } from "@entities/data-target.entity";
+import { DataTargetType } from "@enum/data-target-type.enum";
+import { BeforeInsert, ChildEntity } from "typeorm";
+
+@ChildEntity(DataTargetType.OpenDataDK)
+export class OpenDataDkDataTarget extends DataTarget {
+    @BeforeInsert()
+    private beforeInsert() {
+        this.type = DataTargetType.OpenDataDK;
+    }
+}

src/entities/organization.entity.ts

@@ -15,6 +15,9 @@ export class Organization extends DbBaseEntity {
     @Column({ unique: true })
     name: string;
 
+    @Column({ default: false })
+    openDataDkRegistered: boolean;
+
     @OneToMany(
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
         type => Application,

src/migration/1681915516234-open-data-dk-data-target.ts

@@ -0,0 +1,20 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class openDataDkDataTarget1681915516234 implements MigrationInterface {
+    name = 'openDataDkDataTarget1681915516234'
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`ALTER TYPE "public"."data_target_type_enum" RENAME TO "data_target_type_enum_old"`);
+        await queryRunner.query(`CREATE TYPE "public"."data_target_type_enum" AS ENUM('HTTP_PUSH', 'FIWARE', 'MQTT', 'OPENDATADK')`);
+        await queryRunner.query(`ALTER TABLE "data_target" ALTER COLUMN "type" TYPE "public"."data_target_type_enum" USING "type"::"text"::"public"."data_target_type_enum"`);
+        await queryRunner.query(`DROP TYPE "public"."data_target_type_enum_old"`);
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`CREATE TYPE "public"."data_target_type_enum_old" AS ENUM('HTTP_PUSH', 'FIWARE', 'MQTT')`);
+        await queryRunner.query(`ALTER TABLE "data_target" ALTER COLUMN "type" TYPE "public"."data_target_type_enum_old" USING "type"::"text"::"public"."data_target_type_enum_old"`);
+        await queryRunner.query(`DROP TYPE "public"."data_target_type_enum"`);
+        await queryRunner.query(`ALTER TYPE "public"."data_target_type_enum_old" RENAME TO "data_target_type_enum"`);
+    }
+
+}