Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(resource): Updated with latest standards #5

Merged
merged 1 commit into from
Mar 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/lib/resource/files/ts/__name__.controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,15 @@ export class <%= classify(name) %>Controller {
@Body() create<%= singular(classify(name)) %>Dto: Create<%= singular(classify(name)) %>Dto
): Promise<<%= singular(classify(name)) %>Dto> {
const <%= singular(camelize(name)) %> = await this.<%= lowercased(name) %>Service.create(request.user, create<%= singular(classify(name)) %>Dto);
return <%= singular(classify(name)) %>Dto.from(<%= singular(camelize(name)) %>);
return new <%= singular(classify(name)) %>Dto(<%= singular(camelize(name)) %>);
}

@ApiOperation({ operationId: 'list<%= singular(classify(name)) %>' })
@ApiOkResponse({ type: <%= singular(classify(name)) %>Dto, isArray: true })
@Get()
public async findAll(@Req() request: RequestWithBannerUser): Promise<<%= singular(classify(name)) %>Dto[]> {
const <%= camelize(name) %> = await this.<%= lowercased(name) %>Service.findAll(request.user);
return <%= camelize(name) %>.map(<%= singular(classify(name)) %>Dto.from);
return <%= camelize(name) %>.map(<%= singular(camelize(name)) %> => new <%= singular(classify(name)) %>Dto(<%= singular(camelize(name)) %>));
}

@ApiOperation({ operationId: 'get<%= singular(classify(name)) %>' })
Expand All @@ -48,7 +48,7 @@ export class <%= classify(name) %>Controller {
@Get(':id')
public async findOne(@Req() request: RequestWithBannerUser, @Param() params: FindOneParams) {
const <%= singular(camelize(name)) %> = await this.<%= lowercased(name) %>Service.findOne(request.user, params.id);
return <%= singular(classify(name)) %>Dto.from(<%= singular(camelize(name)) %>);
return new <%= singular(classify(name)) %>Dto(<%= singular(camelize(name)) %>);
}

@ApiOperation({ operationId: 'update<%= singular(classify(name)) %>' })
Expand All @@ -58,7 +58,7 @@ export class <%= classify(name) %>Controller {
@Patch(':id')
public async update(@Req() request: RequestWithBannerUser, @Param() params: FindOneParams, @Body() update<%= singular(classify(name)) %>Dto: Update<%= singular(classify(name)) %>Dto) {
const <%= singular(camelize(name)) %> = await this.<%= lowercased(name) %>Service.update(request.user, params.id, update<%= singular(classify(name)) %>Dto);
return <%= singular(classify(name)) %>Dto.from(<%= singular(camelize(name)) %>);
return new <%= singular(classify(name)) %>Dto(<%= singular(camelize(name)) %>);
}

@ApiOperation({ operationId: 'delete<%= singular(classify(name)) %>' })
Expand Down
8 changes: 4 additions & 4 deletions src/lib/resource/files/ts/__name__.e2e.__specFileSuffix__.ts
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ describe('/v1/<%= dasherize(name) %>', () => {
// TODO Assert values stored in database

expect(response.body).toEqual(
instanceToPlain(<%= singular(classify(name)) %>Dto.from(<%= singular(camelize(name)) %>))
instanceToPlain(new <%= singular(classify(name)) %>Dto(<%= singular(camelize(name)) %>))
);
});
});
Expand Down Expand Up @@ -128,7 +128,7 @@ describe('/v1/<%= dasherize(name) %>', () => {
.expect(200);
expect(response.body).toEqual(
orderBy(<%= camelize(name) %>, 'createdAt', 'desc').map(
<%= singular(classify(name)) %>Dto.from
<%= singular(camelize(name)) %> => new <%= singular(classify(name)) %>Dto(<%= singular(camelize(name)) %>)
)
);
});
Expand Down Expand Up @@ -160,7 +160,7 @@ describe('/v1/<%= dasherize(name) %>', () => {
.expect(200);

expect(response.body).toEqual(
instanceToPlain(<%= singular(classify(name)) %>Dto.from(<%= singular(camelize(name)) %>))
instanceToPlain(new <%= singular(classify(name)) %>Dto(<%= singular(camelize(name)) %>))
);
});
});
Expand Down Expand Up @@ -212,7 +212,7 @@ describe('/v1/<%= dasherize(name) %>', () => {

expect(response.body).toEqual(
instanceToPlain(
<%= singular(classify(name)) %>Dto.from(reloaded<%= singular(classify(name)) %>)
new <%= singular(classify(name)) %>Dto(reloaded<%= singular(classify(name)) %>)
)
);
});
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { faker } from '@faker-js/faker';
import { instanceToPlain } from 'class-transformer';

import { getDataSource } from '@vori/providers/database';

Expand All @@ -10,12 +11,12 @@ describe('<%= singular(classify(name)) %>Dto', () => {
await getDataSource();
});

describe('from', () => {
describe('constructor', () => {
it('converts an entity to a DTO', () => {
const <%= singular(camelize(name)) %> = make<%= singular(classify(name)) %>({
id: faker.datatype.number({ min: 1 }).toString(),
});
const dto = <%= singular(classify(name)) %>Dto.from(<%= singular(camelize(name)) %>);
const dto = instanceToPlain(new <%= singular(classify(name)) %>Dto(<%= singular(camelize(name)) %>));

expect(dto).toMatchObject({
id: <%= singular(camelize(name)) %>.id,
Expand Down
8 changes: 3 additions & 5 deletions src/lib/resource/files/ts/dto/__name@singular__.dto.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
<% if (isSwaggerInstalled) { %>import { PartialType } from '@nestjs/swagger';<% } else { %>import { PartialType } from '@nestjs/mapped-types';<% } %>
import { BaseEntityDto } from '@vori/nest/libs/dto';
import { BaseEntityDto } from '@vori/nest/libs/dto/base-entity.dto';
import { <%= classify(singular(name)) %> } from '../entities/<%= singular(name) %>.entity';

export class <%= singular(classify(name)) %>Dto extends BaseEntityDto {
public static from(<%= singular(camelize(name)) %>: <%= singular(classify(name)) %>): <%= singular(classify(name)) %>Dto {
return {
...BaseEntityDto.from(<%= singular(camelize(name)) %>),
};
public constructor(<%= singular(camelize(name)) %>: <%= singular(classify(name)) %>) {
super(<%= singular(camelize(name)) %>);
}
}

Expand Down
45 changes: 20 additions & 25 deletions src/lib/resource/resource.factory.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -138,15 +138,15 @@ export class UsersController {
@Body() createUserDto: CreateUserDto
): Promise<UserDto> {
const user = await this.usersService.create(request.user, createUserDto);
return UserDto.from(user);
return new UserDto(user);
}

@ApiOperation({ operationId: 'listUser' })
@ApiOkResponse({ type: UserDto, isArray: true })
@Get()
public async findAll(@Req() request: RequestWithBannerUser): Promise<UserDto[]> {
const users = await this.usersService.findAll(request.user);
return users.map(UserDto.from);
return users.map(user => new UserDto(user));
}

@ApiOperation({ operationId: 'getUser' })
Expand All @@ -155,7 +155,7 @@ export class UsersController {
@Get(':id')
public async findOne(@Req() request: RequestWithBannerUser, @Param() params: FindOneParams) {
const user = await this.usersService.findOne(request.user, params.id);
return UserDto.from(user);
return new UserDto(user);
}

@ApiOperation({ operationId: 'updateUser' })
Expand All @@ -165,7 +165,7 @@ export class UsersController {
@Patch(':id')
public async update(@Req() request: RequestWithBannerUser, @Param() params: FindOneParams, @Body() updateUserDto: UpdateUserDto) {
const user = await this.usersService.update(request.user, params.id, updateUserDto);
return UserDto.from(user);
return new UserDto(user);
}

@ApiOperation({ operationId: 'deleteUser' })
Expand Down Expand Up @@ -283,14 +283,12 @@ export class User extends BaseEntity {}
it('should generate "CreateUserDto" and "UpdateUserDto" classes', () => {
expect(tree.readContent('/users/dto/user.dto.ts')).toEqual(
`import { PartialType } from '@nestjs/swagger';
import { BaseEntityDto } from '@vori/nest/libs/dto';
import { BaseEntityDto } from '@vori/nest/libs/dto/base-entity.dto';
import { User } from '../entities/user.entity';

export class UserDto extends BaseEntityDto {
public static from(user: User): UserDto {
return {
...BaseEntityDto.from(user),
};
public constructor(user: User) {
super(user);
}
}

Expand All @@ -304,6 +302,7 @@ export class UpdateUserDto extends PartialType(CreateUserDto) {}
it('should generate "UserDto" spec file', () => {
expect(tree.readContent('/users/dto/user.dto.spec.ts')).toEqual(
`import { faker } from '@faker-js/faker';
import { instanceToPlain } from 'class-transformer';

import { getDataSource } from '@vori/providers/database';

Expand All @@ -315,12 +314,12 @@ describe('UserDto', () => {
await getDataSource();
});

describe('from', () => {
describe('constructor', () => {
it('converts an entity to a DTO', () => {
const user = makeUser({
id: faker.datatype.number({ min: 1 }).toString(),
});
const dto = UserDto.from(user);
const dto = instanceToPlain(new UserDto(user));

expect(dto).toMatchObject({
id: user.id,
Expand Down Expand Up @@ -432,7 +431,7 @@ describe('/v1/users', () => {
// TODO Assert values stored in database

expect(response.body).toEqual(
instanceToPlain(UserDto.from(user))
instanceToPlain(new UserDto(user))
);
});
});
Expand Down Expand Up @@ -466,7 +465,7 @@ describe('/v1/users', () => {
.expect(200);
expect(response.body).toEqual(
orderBy(users, 'createdAt', 'desc').map(
UserDto.from
user => new UserDto(user)
)
);
});
Expand Down Expand Up @@ -498,7 +497,7 @@ describe('/v1/users', () => {
.expect(200);

expect(response.body).toEqual(
instanceToPlain(UserDto.from(user))
instanceToPlain(new UserDto(user))
);
});
});
Expand Down Expand Up @@ -550,7 +549,7 @@ describe('/v1/users', () => {

expect(response.body).toEqual(
instanceToPlain(
UserDto.from(reloadedUser)
new UserDto(reloadedUser)
)
);
});
Expand Down Expand Up @@ -987,14 +986,12 @@ export class User extends BaseEntity {}
it('should generate "CreateUserDto" and "UpdateUserDto" classes', () => {
expect(tree.readContent('/users/dto/user.dto.ts')).toEqual(
`import { PartialType } from '@nestjs/mapped-types';
import { BaseEntityDto } from '@vori/nest/libs/dto';
import { BaseEntityDto } from '@vori/nest/libs/dto/base-entity.dto';
import { User } from '../entities/user.entity';

export class UserDto extends BaseEntityDto {
public static from(user: User): UserDto {
return {
...BaseEntityDto.from(user),
};
public constructor(user: User) {
super(user);
}
}

Expand Down Expand Up @@ -1350,14 +1347,12 @@ export class User extends BaseEntity {}
it('should generate "CreateUserDto" and "UpdateUserDto" classes', () => {
expect(tree.readContent('/users/dto/user.dto.ts')).toEqual(
`import { PartialType } from '@nestjs/mapped-types';
import { BaseEntityDto } from '@vori/nest/libs/dto';
import { BaseEntityDto } from '@vori/nest/libs/dto/base-entity.dto';
import { User } from '../entities/user.entity';

export class UserDto extends BaseEntityDto {
public static from(user: User): UserDto {
return {
...BaseEntityDto.from(user),
};
public constructor(user: User) {
super(user);
}
}

Expand Down
Loading