33 posts tagged with "releases"

@InjectAssemblerQueryService#

In v0.11.1 a new @InjectAssemblerQueryService decorator has been introduced to reduce boiler plate code related to creating an AssemblerQueryService.

Example#

Define your assembler

import { Assembler, ClassTransformerAssembler } from '@nestjs-query/core';import { TodoItemDTO } from './todo-item.dto';import { TodoItemEntity } from './todo-item.entity';
@Assembler(TodoItemDTO, TodoItemEntity)export class TodoItemAssembler extends ClassTransformerAssembler<TodoItemDTO, TodoItemEntity> {  convertToDTO(entity: TodoItemEntity): TodoItemDTO {    const dto = super.convertToDTO(entity);    dto.age = Date.now() - entity.created.getMilliseconds();    return dto;  }}

Now, instead of defining an AssemblerQueryService you can use the decorator.

import { QueryService, InjectAssemblerQueryService } from '@nestjs-query/core';import { CRUDResolver } from '@nestjs-query/query-graphql';import { Resolver } from '@nestjs/graphql';import { TodoItemDTO } from './dto/todo-item.dto';
@Resolver(() => TodoItemDTO)export class TodoItemResolver extends CRUDResolver(TodoItemDTO) {  constructor(@InjectAssemblerQueryService(TodoItemAssembler) readonly service: QueryService<TodoItemDTO>) {    super(service);  }}

Using Assemblers in auto-generated Resolver#

There is a new AssemblerClass option when using the NestjsQueryGraphQLModule to generate your resolver to using a custom Assembler.

import { NestjsQueryGraphQLModule } from '@nestjs-query/query-graphql';import { NestjsQueryTypeOrmModule } from '@nestjs-query/query-typeorm';import { Module } from '@nestjs/common';import { TodoItemDTO } from './dto/todo-item.dto';import { TodoItemEntity } from './todo-item.entity';import { TodoItemAssembler } from './todo-item.assembler';
@Module({  imports: [    NestjsQueryGraphQLModule.forFeature({      imports: [NestjsQueryTypeOrmModule.forFeature([TodoItemEntity])],      // Register the assembler      assemblers: [TodoItemAssembler],      resolvers: [        {          DTOClass: TodoItemDTO,          // specify the assembler type to use.          AssemblerClass: TodoItemAssembler,        },      ],    }),  ],})export class TodoItemModule {}

Using Services in auto-generated Resolver#

There is a new ServiceClass option when using the NestjsQueryGraphQLModule to generate your resolver to a custom QueryService.

import { NestjsQueryGraphQLModule } from '@nestjs-query/query-graphql';import { NestjsQueryTypeOrmModule } from '@nestjs-query/query-typeorm';import { Module } from '@nestjs/common';import { TodoItemDTO } from './dto/todo-item.dto';import { TodoItemEntity } from './todo-item.entity';import { TodoItemService } from './todo-item.service';
@Module({  imports: [    NestjsQueryGraphQLModule.forFeature({      imports: [NestjsQueryTypeOrmModule.forFeature([TodoItemEntity])],      // Register the the custom QueryService      services: [TodoItemService],      resolvers: [        {          DTOClass: TodoItemDTO,          // specify the QueryService type to use.          ServiceClass: TodoItemService,        },      ],    }),  ],})export class TodoItemModule {}

@InjectQueryService#

In v0.11.x an new decorator was added @InjectQueryService, this decorator replaces the ORM specific decorators:

• @InjectTypeOrmQueryService
• @InjectSequelizeQueryService

To migrate replace all @InjectTypeOrmQueryService and @InjectSequelizeQueryService with @InjectQueryService.

import { QueryService, InjectQueryService } from '@nestjs-query/core';import { CRUDResolver } from '@nestjs-query/query-graphql';import { Resolver } from '@nestjs/graphql';import { TodoItemDTO } from './dto/todo-item.dto';import { TodoItemEntity } from './todo-item.entity';
@Resolver(() => TodoItemDTO)export class TodoItemResolver extends CRUDResolver(TodoItemDTO) {  constructor(@InjectQueryService(TodoItemEntity) readonly service: QueryService<TodoItemEntity>) {    super(service);  }}

Relation Decorators#

In v0.11.x two new decorators were introduced from the @nestjs-query/query-graphql package. The @Relation and @Connection allow specifying relations on the DTO rather than passing them in as options to the CRUDResolver.

@Relation#

The @Relation decorator allow specifying a single relation (e.g. one-to-one, many-to-one).

In this example we add a relation for a todoItem.

import { FilterableField, Relation } from '@nestjs-query/query-graphql';import { ObjectType, ID, GraphQLISODateTime } from '@nestjs/graphql';import { TodoItemDTO } from '../todo-item/todo-item.dto.ts';
@ObjectType('SubTask')@Relation('todoItem', () => TodoItemDTO, { disableRemove: true })export class SubTaskDTO {  @FilterableField(() => ID)  id!: string;
  @FilterableField()  title!: string;
  @FilterableField()  completed!: boolean;
  @FilterableField(() => GraphQLISODateTime)  created!: Date;
  @FilterableField(() => GraphQLISODateTime)  updated!: Date;
  @FilterableField()  todoItemId!: string;}

@Connection#

The @Connection decorator allow specifying a connection relation (e.g. many-to-many, one-to-many).

In this example we add a connection for subTasks.

import { FilterableField, Connection } from '@nestjs-query/query-graphql';import { ObjectType, ID, GraphQLISODateTime } from '@nestjs/graphql';import { SubTaskDTO } from '../sub-task/sub-task.dto'
@ObjectType('TodoItem')@Connection('subTasks', () => SubTaskDTO, { disableRemove: true })export class TodoItemDTO {  @FilterableField(() => ID)  id!: string;
  @FilterableField()  title!: string;
  @FilterableField()  completed!: boolean;
  @FilterableField(() => GraphQLISODateTime)  created!: Date;
  @FilterableField(() => GraphQLISODateTime)  updated!: Date;}

Auto Generated Resolvers#

In v0.11.x the @nestjs-query/query-graph package is now able to automatically create your resolvers.

To start using this feature update your module to import the NestjsQueryGraphQLModule

import { NestjsQueryGraphQLModule } from '@nestjs-query/query-graphql';import { NestjsQueryTypeOrmModule } from '@nestjs-query/query-typeorm';import { Module } from '@nestjs/common';import { TodoItemDTO } from './todo-item.dto';import { TodoItemEntity } from './todo-item.entity';
@Module({  imports: [    NestjsQueryGraphQLModule.forFeature({      imports: [NestjsQueryTypeOrmModule.forFeature([TodoItemEntity])],      resolvers: [{ DTOClass: TodoItemDTO, EntityClass: TodoItemEntity }],    }),  ],})export class TodoItemModule {}

import { NestjsQueryGraphQLModule } from '@nestjs-query/query-graphql';import { NestjsQuerySequelizeModule } from '@nestjs-query/query-sequelize';import { Module } from '@nestjs/common';import { TodoItemDTO } from './todo-item.dto';import { TodoItemEntity } from './todo-item.entity';
@Module({  imports: [    NestjsQueryGraphQLModule.forFeature({      imports: [NestjsQuerySequelizeModule.forFeature([TodoItemEntity])],      resolvers: [{ DTOClass: TodoItemDTO, EntityClass: TodoItemEntity }],    }),  ],})export class TodoItemModule {}

Once you have updated your module you can remove the old resolver.

To read more about the auto-generated resolvers check out the resolvers docs

Example#

Previously#

import { QueryService, InjectQueryService } from '@nestjs-query/core';import { CRUDResolver } from '@nestjs-query/query-graphql';import { Resolver } from '@nestjs/graphql';import { TodoItemInputDTO } from './todo-item.input';import { TodoItemDTO } from './todo-item.dto';import { TodoItemEntity } from './todo-item.entity';
@Resolver()export class TodoItemResolver extends CRUDResolver(TodoItemDTO) {  constructor(      @InjectQueryService(TodoItemEntity) readonly service: QueryService<TodoItemEntity>  ) {    super(service);  }}

import { NestjsQueryTypeOrmModule } from '@nestjs-query/query-typeorm';import { Module } from '@nestjs/common';import { TodoItemEntity } from './todo-item.entity';import { TodoItemResolver } from './todo-item.resolver';
@Module({  providers: [TodoItemResolver],  imports: [NestjsQueryTypeOrmModule.forFeature([TodoItemEntity])],})export class TodoItemModule {}

import { NestjsQuerySequelizeModule } from '@nestjs-query/query-sequelize';import { Module } from '@nestjs/common';import { TodoItemEntity } from './todo-item.entity';import { TodoItemResolver } from './todo-item.resolver';
@Module({  providers: [TodoItemResolver],  imports: [NestjsQuerySequelizeModule.forFeature([TodoItemEntity])],})export class TodoItemModule {}

New#

import { NestjsQueryGraphQLModule } from '@nestjs-query/query-graphql';import { NestjsQueryTypeOrmModule } from '@nestjs-query/query-typeorm';import { Module } from '@nestjs/common';import { TodoItemDTO } from './todo-item.dto';import { TodoItemEntity } from './todo-item.entity';
@Module({  imports: [    NestjsQueryGraphQLModule.forFeature({      imports: [NestjsQueryTypeOrmModule.forFeature([TodoItemEntity])],      resolvers: [{ DTOClass: TodoItemDTO, EntityClass: TodoItemEntity }],    }),  ],})export class TodoItemModule {}

import { NestjsQueryGraphQLModule } from '@nestjs-query/query-graphql';import { NestjsQuerySequelizeModule } from '@nestjs-query/query-sequelize';import { Module } from '@nestjs/common';import { TodoItemDTO } from './todo-item.dto';import { TodoItemEntity } from './todo-item.entity';
@Module({  imports: [    NestjsQueryGraphQLModule.forFeature({      imports: [NestjsQuerySequelizeModule.forFeature([TodoItemEntity])],      resolvers: [{ DTOClass: TodoItemDTO, EntityClass: TodoItemEntity }],    }),  ],})export class TodoItemModule {}

• chore(renovate): Renovate to include examples
• chore(renovate): Renovate set ignorePaths to empty
• fix(deps): pin dependencies
• chore(deps): Update package-lock.json
• chore(deps): Update postgres backing app to 11.7
• docs(): Update Federation Docs
• chore(lerna): add hoist to lerna.json
• chore(deps): update dependency @nestjs/graphql to v7.3.4
• chore(deps): update dependency @types/node to v13.13.2
• chore(renovate): Update to automerge devDeps
• chore(deps): update dependency coveralls to v3.0.13
• chore(deps): update dependency eslint-config-prettier to v6.11.0

• feat(graphql): basic federation support.
• docs(graphql): federation docs.

• docs(typeorm): Call out foreign keys in entity and DTO #84
• docs(typeorm): Relations on an entity/dto #85

• [TESTS] Updated graphql types tests to check schema rather than spies.

• [FIXED] Add support for extending abstract object types #82

• [FIXED] Mysql error "LIMIT in subquery" #77
  • Changed nestjs-query/query-typeorm to not use subqueries to fetch relations.

• [FIXED] Defining additional UpdateDtos breaks Schema. #72

• [FIXED] Tables with composite primary keys are not quoted properly.
• [DOCS] Added docs for working with multiple connections #73 - @johannesschobel

• [FIXED] code formatting
• Update root package.json with common dependencies

• [DOCS] Update docs to include a complete example of custom methods #64
• [FIXED] Issue where creating or updating allows specifying primary keys #65

• [FIXED] Issue where update input DTO was not automatically created

• [FIXED] Issue where update input DTO was not automatically created

• Updated to @nestjs/graphql v7.x.
  • This was a passive change for the library usage however you should still follow the migration guide found here

• [FIXED] Get Underlying Entity Object #41
  • Changed TypeOrmQueryService to operate on the Entity
  • Added new AssemblerQueryService to translate between the DTO and Entity
• [ADDED] New InjectTypeOrmQueryService decorator to auto-create a TypeOrm query service.

See the migration guide for a more in-depth review of the changes.

• [DOCS] Added clarification around individual resolvers and relations with examples #42
• [ADDED] Exposed Relatable mixin from @nestjs-query/graphql #42

• Updated all mutations to take a single input argument with custom fields.
  • createOne(input: DTO) -> createOne(input: { [dtoName]: DTO })
  • createMany(input: DTO[]) -> createOne(input: { [pluralDTOName]: DTO[] })
  • updateOne(id: ID, input: UpdateDTO) -> createOne(input: { id: ID, update: UpdateDTO })
  • updateMany(filter: Filter<DTO>, input: UpdateDTO) -> createOne(input: { filter: Filter<DTO>, update: UpdateDTO })
  • deleteOne(input: ID) -> deleteOne(input: {id: ID})
  • deleteMany(input: Filter<DTO>) -> createOne(input: { filter: Filter<DTO> })
• Updated docs to reflect changes.

• Added decorators option to resolver options to allow providing custom decorators to endpoints #36

• [FIXED] Validate Input for Create & Update #19

• [FIXED] Can't remove on Many-To-Many relations #31

• Update typescript to 3.8.
• Update dependency versions.

• Switched to github actions

• Added dataloader support!
• Fixed issue with loading of many-to-many relations #22

• Hardened TypeORM querying
  • Added filter for entity ids on relations to prevent querying for too many rows.
  • Qualify all filter and sorting columns, to prevent column name collisions.

• Fixed case where @FilterableField decorator was not passing arguments correctly to @Field decorator #20

In v0.2.0 the concept of Assemblers was introduced. Assemblers allow for converting to and from a DTO/entity that have different fields or computed values.

Read More About Assemblers!.

As of v0.1.0 you can specify relations in your graphql resolvers.

Checkout the docs!

• Add ability to specify query defaults.
  • defaultResultSize - the default number of results to return from a query. See Default Paging
  • maxResultsSize - the maximum number of results to return from a query. See Default Paging
  • defaultSort - The default sort to apply to queries. See Default Sort
  • defaultFilter - The default filter to apply to queries. See Default Filter

• Dont allow empty filters with updateMany or deleteMany operations.

• Add MIT license

• Add files field to @nestjs-query/core package.json

• Fix package READMEs
• Add security scanning on sub modules.