v0.24.0 Release Notes

[doug-martin]

v0.24.0

Typegoose Support!

• Added new @nestjs-query/query-typegoose persistence package. Thank you @JohnMcInall @smolinari. Check out the docs here

Disabling and/or filters on DTO queries.

To enable setting this option a new @QueryOptions decorator was introduced to allow specifying all query related options along side the DTO, instead of splitting the configuration between the resolver and DTO. The new @QueryOptions provides a few benefits.

• Better re-use across types by avoiding passing configuration options all the way through the code to each piece that may need them.
• Decoupling query options from the resolver. This puts us in a better position to decouple the DTO definition from the transport layer (e.g. graphql)
• Keeps DTO configuration options closer to the source.

Examples:

Disabling or filters

import { FilterableField, QueryOptions, PagingStrategies } from '@nestjs-query/query-graphql';
import { ObjectType, ID, GraphQLISODateTime, Field } from '@nestjs/graphql';

@ObjectType('TodoItem')
@QueryOptions({ allowedBooleanExpressions: ['and'] })
export class TodoItemDTO {
  @FilterableField(() => ID, { allowedComparisons: ['eq'] })
  id!: string;

  @Field()
  title!: string;

  @Field()
  completed!: boolean;

  @Field(() => GraphQLISODateTime)
  created!: Date;

  @Field(() => GraphQLISODateTime)
  updated!: Date;
}

Disabling and filters:

import { FilterableField, QueryOptions, PagingStrategies } from '@nestjs-query/query-graphql';
import { ObjectType, ID, GraphQLISODateTime, Field } from '@nestjs/graphql';

@ObjectType('TodoItem')
@QueryOptions({ allowedBooleanExpressions: ['or'] })
export class TodoItemDTO {
  @FilterableField(() => ID, { allowedComparisons: ['eq'] })
  id!: string;

  @Field()
  title!: string;

  @Field()
  completed!: boolean;

  @Field(() => GraphQLISODateTime)
  created!: Date;

  @Field(() => GraphQLISODateTime)
  updated!: Date;
}

Disabling both and/or filters:

import { FilterableField, QueryOptions, PagingStrategies } from '@nestjs-query/query-graphql';
import { ObjectType, ID, GraphQLISODateTime, Field } from '@nestjs/graphql';

@ObjectType('TodoItem')
@QueryOptions({ allowedBooleanExpressions: [] })
export class TodoItemDTO {
  @FilterableField(() => ID, { allowedComparisons: ['eq'] })
  id!: string;

  @Field()
  title!: string;

  @Field()
  completed!: boolean;

  @Field(() => GraphQLISODateTime)
  created!: Date;

  @Field(() => GraphQLISODateTime)
  updated!: Date;
}

This example shows the other options you can specify using the @QueryOptions Decorator instead of passing them to the resolver.

import { FilterableField, QueryOptions, PagingStrategies } from '@nestjs-query/query-graphql';
import { ObjectType, ID, GraphQLISODateTime, Field } from '@nestjs/graphql';

@ObjectType('TodoItem')
@QueryOptions({ 
  pagingStrategy: PagingStrategies.OFFSET, // use offset based paging for this DTO
  enableTotalCount: true, // enable querying for totalCount
  defaultResultSize: 5, // return 5 records by default
  maxResultSize: 100, // do not allow querying for more than 100 records at a time
  defaultFilter: { completed: { is: true } }, // default filter when one is not provided
  defaultSort: [{ field: 'title', direction: SortDirection.ASC }], // default sort when one is not provided. 
})
export class TodoItemDTO {
  @FilterableField(() => ID, { allowedComparisons: ['eq'] })
  id!: string;

  @Field()
  title!: string;

  @Field()
  completed!: boolean;

  @Field(() => GraphQLISODateTime)
  created!: Date;

  @Field(() => GraphQLISODateTime)
  updated!: Date;
}

[smolinari]

Awesome! 🥳 Thanks @doug-martin

Scott

[llanicm]

Great :) Thanks @doug-martin