0

mapped-typesと を使用する方法はありますswaggerclass-transformer

ここで何がうまくいかないかの例を手に入れました: https://stackblitz.com/edit/nestjs-starter-demo-aq1sw2?file=src/dtos/user-descriptor.dto.ts

DTO:

ProjectDescriptorDto

// import { PickType } from '@nestjs/mapped-types';
import { PickType } from '@nestjs/swagger';
import { ProjectDto } from './project.dto';

export class ProjectDescriptorDto extends PickType(ProjectDto, [
  'id',
  'title',
] as const) {}

ProjectDto

import { Expose, Type } from 'class-transformer';
import { UserDescriptorDto } from './user-descriptor.dto';

export class ProjectDto {
  @Expose()
  id: number;

  @Expose()
  description: string;

  @Expose()
  @Type(() => UserDescriptorDto)
  starredBy: UserDescriptorDto[];

  @Expose()
  title: string;
}

UserDescriptorDto

// import { PickType } from '@nestjs/mapped-types';
import { PickType } from '@nestjs/swagger';
import { UserDto } from './user.dto';

export class UserDescriptorDto extends PickType(UserDto, [
  'id',
  'firstName',
  'lastName',
  'email',
] as const) {}

ユーザーDto

import { ProjectDescriptorDto } from './project-descriptor.dto';
import { Type } from 'class-transformer';
import { ApiProperty } from '@nestjs/swagger';

export class UserDto {
  id: number;
  firstName: string;
  lastName: string;
  email: string;
  @ApiProperty({
    isArray: true,
    type: ProjectDescriptorDto,
  })
  @Type(() => ProjectDescriptorDto)
  favourites: ProjectDescriptorDto[];
}

この例では、PickTypefromを使用@nestjs/mapped-typesしてコードをコンパイルしますが、拡張クラスの正しい swagger 仕様を生成しません。

Swagger 仕様を正しく生成するにはPickTypefromを使用する必要がありますが、パッケージのデコレーターと組み合わせると、コードは正しくコンパイルされません。@nestjs/swagger@Type()class-transform

TypeError: Cannot read properties of undefined (reading 'prototype')
    at Object.PickType (/home/projects/nestjs-starter-demo-aq1sw2/node_modules/@nestjs/swagger/dist/type-helpers/pick-type.helper.js:13:38)
    at Object.eval (/home/projects/nestjs-starter-demo-aq1sw2/dist/dtos/project-descriptor.dto.js:7:46)
    at Object.function (https://nestjs-starter-demo-aq1sw2.jw.staticblitz.com/blitz.88a7151d177878d00bf438b30e057ed5805fdcd2.js:11:119417)
    at Module._compile (https://nestjs-starter-demo-aq1sw2.jw.staticblitz.com/blitz.88a7151d177878d00bf438b30e057ed5805fdcd2.js:6:167880)
    at Object.Module._extensions..js (https://nestjs-starter-demo-aq1sw2.jw.staticblitz.com/blitz.88a7151d177878d00bf438b30e057ed5805fdcd2.js:6:168239)
    at Module.load (https://nestjs-starter-demo-aq1sw2.jw.staticblitz.com/blitz.88a7151d177878d00bf438b30e057ed5805fdcd2.js:6:166317)
    at Function.Module._load (https://nestjs-starter-demo-aq1sw2.jw.staticblitz.com/blitz.88a7151d177878d00bf438b30e057ed5805fdcd2.js:6:163857)
    at Module.require (https://nestjs-starter-demo-aq1sw2.jw.staticblitz.com/blitz.88a7151d177878d00bf438b30e057ed5805fdcd2.js:6:166635)
    at i (https://nestjs-starter-demo-aq1sw2.jw.staticblitz.com/blitz.88a7151d177878d00bf438b30e057ed5805fdcd2.js:6:435073)
    at _0x4139bb (https://nestjs-starter-demo-aq1sw2.jw.staticblitz.com/blitz.88a7151d177878d00bf438b30e057ed5805fdcd2.js:11:119029)

問題は次のとおりです。これを回避する方法はありますか、mapped-typesまたは代わりに記述子を拡張しないでください。現在の回避策は、次を使用することです。

SomeDescriptorDto implements Pick<SomeDto, 'id' | ...> {
    id: number;
    // variables
}
4

0 に答える 0