refactor(backend): fix nestjs-typed linting errors

Signed-off-by: David Mehren <git@herrmehren.de>

backend/src/auth/auth-token.dto.ts

@@ -40,5 +40,6 @@ export class AuthTokenCreateDto extends BaseDto {
   label: string;
 
   @IsNumber()
+  @Type(() => Number)
   validUntil: TimestampMillis;
 }

backend/src/auth/auth.module.ts

@@ -11,7 +11,8 @@ import { LoggerModule } from '../logger/logger.module';
 import { UsersModule } from '../users/users.module';
 import { AuthToken } from './auth-token.entity';
 import { AuthService } from './auth.service';
-import { TokenStrategy } from './token.strategy';
+import { MockAuthGuard } from './mock-auth.guard';
+import { TokenAuthGuard, TokenStrategy } from './token.strategy';
 
 @Module({
   imports: [
@@ -20,7 +21,7 @@ import { TokenStrategy } from './token.strategy';
     LoggerModule,
     TypeOrmModule.forFeature([AuthToken]),
   ],
-  providers: [AuthService, TokenStrategy],
+  providers: [AuthService, TokenStrategy, MockAuthGuard, TokenAuthGuard],
   exports: [AuthService],
 })
 export class AuthModule {}

backend/src/frontend-config/frontend-config.dto.ts

@@ -3,6 +3,7 @@
  *
  * SPDX-License-Identifier: AGPL-3.0-only
  */
+import { Type } from 'class-transformer';
 import {
   IsArray,
   IsBoolean,
@@ -50,6 +51,7 @@ export class AuthProviderWithoutCustomNameDto extends BaseDto {
    * The type of the auth provider.
    */
   @IsString()
+  @Type(() => String)
   type: AuthProviderTypeWithoutCustomName;
 }
 
@@ -58,6 +60,7 @@ export class AuthProviderWithCustomNameDto extends BaseDto {
    * The type of the auth provider.
    */
   @IsString()
+  @Type(() => String)
   type: AuthProviderTypeWithCustomName;
 
   /**
@@ -94,6 +97,7 @@ export class BrandingDto extends BaseDto {
    */
   @IsUrl()
   @IsOptional()
+  @Type(() => URL)
   logo?: URL;
 }
 
@@ -104,6 +108,7 @@ export class SpecialUrlsDto extends BaseDto {
    */
   @IsUrl()
   @IsOptional()
+  @Type(() => URL)
   privacy?: URL;
 
   /**
@@ -112,6 +117,7 @@ export class SpecialUrlsDto extends BaseDto {
    */
   @IsUrl()
   @IsOptional()
+  @Type(() => URL)
   termsOfUse?: URL;
 
   /**
@@ -120,6 +126,7 @@ export class SpecialUrlsDto extends BaseDto {
    */
   @IsUrl()
   @IsOptional()
+  @Type(() => URL)
   imprint?: URL;
 }
 
@@ -139,6 +146,7 @@ export class FrontendConfigDto extends BaseDto {
   /**
    * Which auth providers are enabled and how are they configured?
    */
+  // eslint-disable-next-line @darraghor/nestjs-typed/validated-non-primitive-property-needs-type-decorator
   @IsArray()
   @ValidateNested({ each: true })
   authProviders: AuthProviderDto[];
@@ -147,6 +155,7 @@ export class FrontendConfigDto extends BaseDto {
    * Individual branding information
    */
   @ValidateNested()
+  @Type(() => BrandingDto)
   branding: BrandingDto;
 
   /**
@@ -159,12 +168,14 @@ export class FrontendConfigDto extends BaseDto {
    * Links to some special pages
    */
   @ValidateNested()
+  @Type(() => SpecialUrlsDto)
   specialUrls: SpecialUrlsDto;
 
   /**
    * The version of HedgeDoc
    */
   @ValidateNested()
+  @Type(() => ServerVersion)
   version: ServerVersion;
 
   /**
@@ -172,6 +183,7 @@ export class FrontendConfigDto extends BaseDto {
    */
   @IsUrl()
   @IsOptional()
+  @Type(() => URL)
   plantUmlServer?: URL;
 
   /**

backend/src/history/history-entry.dto.ts

@@ -37,7 +37,7 @@ export class HistoryEntryDto extends BaseDto {
 
   @IsArray()
   @IsString({ each: true })
-  @ApiProperty()
+  @ApiProperty({ isArray: true, type: String })
   tags: string[];
 
   /**

backend/src/identity/identity.module.ts

@@ -12,8 +12,8 @@ import { User } from '../users/user.entity';
 import { UsersModule } from '../users/users.module';
 import { Identity } from './identity.entity';
 import { IdentityService } from './identity.service';
-import { LdapStrategy } from './ldap/ldap.strategy';
+import { LdapAuthGuard, LdapStrategy } from './ldap/ldap.strategy';
-import { LocalStrategy } from './local/local.strategy';
+import { LocalAuthGuard, LocalStrategy } from './local/local.strategy';
 
 @Module({
   imports: [
@@ -23,7 +23,13 @@ import { LocalStrategy } from './local/local.strategy';
     LoggerModule,
   ],
   controllers: [],
-  providers: [IdentityService, LocalStrategy, LdapStrategy],
+  providers: [
+    IdentityService,
+    LocalStrategy,
+    LdapStrategy,
+    LdapAuthGuard,
+    LocalAuthGuard,
+  ],
   exports: [IdentityService, LocalStrategy, LdapStrategy],
 })
 export class IdentityModule {}

backend/src/identity/local/login.dto.ts

@@ -3,11 +3,13 @@
  *
  * SPDX-License-Identifier: AGPL-3.0-only
  */
+import { Type } from 'class-transformer';
 import { IsLowercase, IsString } from 'class-validator';
 
 import { Username } from '../../utils/username';
 
 export class LoginDto {
+  @Type(() => String)
   @IsString()
   @IsLowercase()
   username: Username;

backend/src/identity/local/register.dto.ts

@@ -3,11 +3,13 @@
  *
  * SPDX-License-Identifier: AGPL-3.0-only
  */
+import { Type } from 'class-transformer';
 import { IsLowercase, IsString } from 'class-validator';
 
 import { Username } from '../../utils/username';
 
 export class RegisterDto {
+  @Type(() => String)
   @IsString()
   @IsLowercase()
   username: Username;

backend/src/media/media-upload.dto.ts

@@ -43,6 +43,7 @@ export class MediaUploadDto extends BaseDto {
    */
   @IsString()
   @IsLowercase()
+  @IsOptional()
   @ApiProperty()
   username: Username | null;
 }

backend/src/monitoring/server-status.dto.ts

@@ -3,7 +3,7 @@
  *
  * SPDX-License-Identifier: AGPL-3.0-only
  */
-import { ApiProperty } from '@nestjs/swagger';
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
 
 import { BaseDto } from '../utils/base.dto.';
 
@@ -14,9 +14,9 @@ export class ServerVersion {
   minor: number;
   @ApiProperty()
   patch: number;
-  @ApiProperty()
+  @ApiPropertyOptional()
   preRelease?: string;
-  @ApiProperty()
+  @ApiPropertyOptional()
   commit?: string;
   @ApiProperty()
   fullString: string;

backend/src/notes/note-metadata.dto.ts

@@ -29,9 +29,10 @@ export class NoteMetadataDto extends BaseDto {
   /**
    * All aliases of the note (including the primaryAlias)
    */
+  @Type(() => AliasDto)
   @IsArray()
-  @ValidateNested()
+  @ValidateNested({ each: true })
-  @ApiProperty()
+  @ApiProperty({ isArray: true, type: AliasDto })
   aliases: AliasDto[];
 
   /**
@@ -67,7 +68,7 @@ export class NoteMetadataDto extends BaseDto {
    */
   @IsArray()
   @IsString({ each: true })
-  @ApiProperty()
+  @ApiProperty({ isArray: true, type: String })
   tags: string[];
 
   @IsNumber()
@@ -86,8 +87,9 @@ export class NoteMetadataDto extends BaseDto {
   /**
    * User that last edited the note
    */
-  @IsString()
+  // eslint-disable-next-line @darraghor/nestjs-typed/api-property-matches-property-optionality
   @ApiPropertyOptional()
+  @IsString()
   @IsOptional()
   updateUsername: string | null;
 
@@ -114,13 +116,13 @@ export class NoteMetadataDto extends BaseDto {
    */
   @IsArray()
   @IsString({ each: true })
-  @ApiProperty()
+  @ApiProperty({ isArray: true, type: String })
   editedBy: string[];
 
   /**
    * Permissions currently in effect for the note
    */
-  @ValidateNested({ each: true })
+  @ValidateNested()
   @Type(() => NotePermissionsDto)
   @ApiProperty({ type: NotePermissionsDto })
   permissions: NotePermissionsDto;
@@ -151,6 +153,6 @@ export class NoteMetadataUpdateDto {
    */
   @IsArray()
   @IsString({ each: true })
-  @ApiProperty()
+  @ApiProperty({ isArray: true, type: String })
   tags: string[];
 }

backend/src/notes/note-permissions.dto.ts

@@ -21,6 +21,7 @@ export class NoteUserPermissionEntryDto extends BaseDto {
   /**
    * Username of the User this permission applies to
    */
+  @Type(() => String)
   @IsString()
   @IsLowercase()
   @ApiProperty()
@@ -40,6 +41,7 @@ export class NoteUserPermissionUpdateDto {
    * Username of the user this permission should apply to
    * @example "john.smith"
    */
+  @Type(() => String)
   @IsString()
   @IsLowercase()
   @ApiProperty()
@@ -93,6 +95,9 @@ export class NotePermissionsDto {
   /**
    * Username of the User this permission applies to
    */
+  // nestjs-typed does not detect '| null' types as optional
+  // eslint-disable-next-line @darraghor/nestjs-typed/api-property-matches-property-optionality
+  @Type(() => String)
   @IsString()
   @ApiPropertyOptional()
   @IsOptional()

backend/src/notes/note.dto.ts

@@ -23,6 +23,7 @@ export class NoteDto extends BaseDto {
   /**
    * Metadata of the note
    */
+  @Type(() => NoteMetadataDto)
   @ValidateNested()
   @ApiProperty({ type: NoteMetadataDto })
   metadata: NoteMetadataDto;

backend/src/revisions/edit.dto.ts

@@ -16,6 +16,8 @@ export class EditDto extends BaseDto {
    * Is `null` if the user is anonymous
    * @example "john.smith"
    */
+  // nestjs-typed does not detect '| null' types as optional
+  // eslint-disable-next-line @darraghor/nestjs-typed/api-property-matches-property-optionality
   @IsString()
   @IsOptional()
   @ApiPropertyOptional()

backend/src/revisions/revision-metadata.dto.ts

@@ -15,6 +15,7 @@ export class RevisionMetadataDto extends BaseDto {
    * ID of this revision
    * @example 13
    */
+  @Type(() => Number)
   @IsNumber()
   @ApiProperty()
   id: Revision['id'];
@@ -41,7 +42,7 @@ export class RevisionMetadataDto extends BaseDto {
    * Does not include anonymous users
    */
   @IsString()
-  @ApiProperty()
+  @ApiProperty({ isArray: true, type: String })
   authorUsernames: string[];
 
   /**
@@ -75,6 +76,6 @@ export class RevisionMetadataDto extends BaseDto {
    */
   @IsArray()
   @IsString({ each: true })
-  @ApiProperty()
+  @ApiProperty({ isArray: true, type: String })
   tags: string[];
 }

backend/src/revisions/revision.dto.ts

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: AGPL-3.0-only
  */
 import { ApiProperty } from '@nestjs/swagger';
+import { Type } from 'class-transformer';
 import { IsString, ValidateNested } from 'class-validator';
 
 import { EditDto } from './edit.dto';
@@ -28,7 +29,8 @@ export class RevisionDto extends RevisionMetadataDto {
   /**
    * All edit objects which are used in the revision.
    */
-  @ValidateNested()
+  @Type(() => EditDto)
-  @ApiProperty()
+  @ValidateNested({ each: true })
+  @ApiProperty({ isArray: true, type: EditDto })
   edits: EditDto[];
 }

backend/src/users/user-info.dto.ts

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: AGPL-3.0-only
  */
 import { ApiProperty } from '@nestjs/swagger';
+import { Type } from 'class-transformer';
 import { IsLowercase, IsString } from 'class-validator';
 
 import { BaseDto } from '../utils/base.dto.';
@@ -14,6 +15,7 @@ export class UserInfoDto extends BaseDto {
    * The username
    * @example "john.smith"
    */
+  @Type(() => String)
   @IsString()
   @IsLowercase()
   @ApiProperty()