Merge pull request #10 from TriPSs/improvements

feat(query-graphql): Added `disableFilter` and `disableSort`
TriPSs · May 31, 2022 · 7079531 · 7079531
2 parents 9ac1a05 + 41190a1
commit 7079531
Show file tree

Hide file tree

Showing 171 changed files with 3,942 additions and 4,731 deletions.
diff --git a/.prettierrc b/.prettierrc
@@ -1,5 +1,5 @@
 {
     "singleQuote": true,
-    "printWidth": 120,
+    "printWidth": 130,
     "trailingComma": "none"
 }
diff --git a/documentation/docs/graphql/relations.mdx b/documentation/docs/graphql/relations.mdx
@@ -1127,6 +1127,51 @@ To disable the `read` `queries` you can set the `disableRead` option to `true`.
 </TabItem>
 </Tabs>
 
+#### Disable `filter` or `sorting` in relations
+
+To disable the `filter` or `sorting` of relations you can set the `disableFilter` or/and `disableSort` option to `true`.
+
+<Tabs
+  defaultValue="relation"
+  groupId="relation-type"
+  values={[
+    { label: 'Relation', value: 'relation', },
+    { label: 'CursorConnection', value: 'cursor-connection', },
+    { label: 'OffsetConnection', value: 'offset-connection', },
+    { label: 'UnPagedRelation', value: 'unpaged-relation', },
+  ]
+  }>
+  <TabItem value="relation">
+
+    This is not available in `relation` as it will only fetch one record.
+
+  </TabItem>
+  <TabItem value="cursor-connection">
+
+    ```ts
+    // disable reading the connection
+    @CursorConnection('subTasks', () => SubTaskDTO, { disableFilter: true, disableSort: true })
+    ```
+
+  </TabItem>
+  <TabItem value="offset-connection">
+
+    ```ts
+    // disable reading the relation
+    @OffsetConnection('subTaskConnection', () => SubTaskDTO, { disableFilter: true, disableSort: true })
+    ```
+
+  </TabItem>
+  <TabItem value="unpaged-relation">
+
+    ```ts
+    // disable reading the relation
+    @UnPagedRelation('subTaskConnection', () => SubTaskDTO, { disableFilter: true, disableSort: true })
+    ```
+
+  </TabItem>
+</Tabs>
+
 ### Disable Updates
 
 To disable the `update` `mutations` you can set the `disableUpdate` option to `true`.

diff --git a/examples/auth/e2e/sub-task.resolver.spec.ts b/examples/auth/e2e/sub-task.resolver.spec.ts
@@ -722,9 +722,7 @@ describe('SubTaskResolver (auth - e2e)', () => {
         .expect(400)
         .then(({ body }) => {
           expect(body.errors).toHaveLength(1);
-          expect(body.errors[0].message).toBe(
-            'Field "UpdateOneSubTaskInput.id" of required type "ID!" was not provided.'
-          );
+          expect(body.errors[0].message).toBe('Field "UpdateOneSubTaskInput.id" of required type "ID!" was not provided.');
         }));
 
     it('should validate an update', () =>
@@ -913,9 +911,7 @@ describe('SubTaskResolver (auth - e2e)', () => {
         .expect(400)
         .then(({ body }) => {
           expect(body.errors).toHaveLength(1);
-          expect(body.errors[0].message).toBe(
-            'Field "DeleteOneSubTaskInput.id" of required type "ID!" was not provided.'
-          );
+          expect(body.errors[0].message).toBe('Field "DeleteOneSubTaskInput.id" of required type "ID!" was not provided.');
         }));
   });
 

diff --git a/examples/auth/e2e/tag.resolver.spec.ts b/examples/auth/e2e/tag.resolver.spec.ts
@@ -1107,8 +1107,7 @@ describe('TagResolver (auth - e2e)', () => {
         })
         .expect(200)
         .then(({ body }) => {
-          const { edges, pageInfo, totalCount }: CursorConnectionType<TodoItemDTO> =
-            body.data.addTodoItemsToTag.todoItems;
+          const { edges, pageInfo, totalCount }: CursorConnectionType<TodoItemDTO> = body.data.addTodoItemsToTag.todoItems;
           expect(body.data.addTodoItemsToTag.id).toBe('1');
           expect(pageInfo).toEqual({
             endCursor: 'YXJyYXljb25uZWN0aW9uOjQ=',
@@ -1178,8 +1177,7 @@ describe('TagResolver (auth - e2e)', () => {
         })
         .expect(200)
         .then(({ body }) => {
-          const { edges, pageInfo, totalCount }: CursorConnectionType<TodoItemDTO> =
-            body.data.removeTodoItemsFromTag.todoItems;
+          const { edges, pageInfo, totalCount }: CursorConnectionType<TodoItemDTO> = body.data.removeTodoItemsFromTag.todoItems;
           expect(body.data.removeTodoItemsFromTag.id).toBe('1');
           expect(pageInfo).toEqual({
             endCursor: 'YXJyYXljb25uZWN0aW9uOjE=',

diff --git a/examples/auth/e2e/todo-item.resolver.spec.ts b/examples/auth/e2e/todo-item.resolver.spec.ts
@@ -1102,9 +1102,7 @@ describe('TodoItemResolver (auth - e2e)', () => {
         .expect(400)
         .then(({ body }) => {
           expect(body.errors).toHaveLength(1);
-          expect(body.errors[0].message).toBe(
-            'Field "UpdateOneTodoItemInput.id" of required type "ID!" was not provided.'
-          );
+          expect(body.errors[0].message).toBe('Field "UpdateOneTodoItemInput.id" of required type "ID!" was not provided.');
         }));
 
     it('should validate an update', () =>
@@ -1439,9 +1437,7 @@ describe('TodoItemResolver (auth - e2e)', () => {
         .expect(400)
         .then(({ body }) => {
           expect(body.errors).toHaveLength(1);
-          expect(body.errors[0].message).toBe(
-            'Field "DeleteOneTodoItemInput.id" of required type "ID!" was not provided.'
-          );
+          expect(body.errors[0].message).toBe('Field "DeleteOneTodoItemInput.id" of required type "ID!" was not provided.');
         }));
   });
 
@@ -1615,8 +1611,7 @@ describe('TodoItemResolver (auth - e2e)', () => {
         })
         .expect(200)
         .then(({ body }) => {
-          const { edges, pageInfo, totalCount }: CursorConnectionType<SubTaskDTO> =
-            body.data.addSubTasksToTodoItem.subTasks;
+          const { edges, pageInfo, totalCount }: CursorConnectionType<SubTaskDTO> = body.data.addSubTasksToTodoItem.subTasks;
           expect(body.data.addSubTasksToTodoItem.id).toBe('1');
           expect(pageInfo).toEqual({
             endCursor: 'YXJyYXljb25uZWN0aW9uOjU=',

diff --git a/examples/auth/src/auth/auth.service.ts b/examples/auth/src/auth/auth.service.ts
@@ -8,10 +8,7 @@ import { UserDTO } from '../user/user.dto';
 
 @Injectable()
 export class AuthService {
-  constructor(
-    @InjectQueryService(UserEntity) private usersService: QueryService<UserEntity>,
-    private jwtService: JwtService
-  ) {}
+  constructor(@InjectQueryService(UserEntity) private usersService: QueryService<UserEntity>, private jwtService: JwtService) {}
 
   async validateUser(username: string, pass: string): Promise<AuthenticatedUser | null> {
     const [user] = await this.usersService.query({ filter: { username: { eq: username } }, paging: { limit: 1 } });

diff --git a/examples/auth/src/sub-task/dto/subtask-input.dto.ts b/examples/auth/src/sub-task/dto/subtask-input.dto.ts
@@ -1,11 +1,6 @@
 import { Field, InputType, ID } from '@nestjs/graphql';
 import { IsOptional, IsString, IsBoolean, IsNotEmpty } from 'class-validator';
-import {
-  BeforeCreateMany,
-  BeforeCreateOne,
-  CreateManyInputType,
-  CreateOneInputType
-} from '@ptc-org/nestjs-query-graphql';
+import { BeforeCreateMany, BeforeCreateOne, CreateManyInputType, CreateOneInputType } from '@ptc-org/nestjs-query-graphql';
 import { UserContext } from '../../auth/auth.interfaces';
 
 @InputType('SubTaskInput')

diff --git a/examples/auth/src/sub-task/dto/subtask-update.dto.ts b/examples/auth/src/sub-task/dto/subtask-update.dto.ts
@@ -1,11 +1,6 @@
 import { Field, InputType } from '@nestjs/graphql';
 import { IsOptional, IsBoolean, IsString, IsNotEmpty } from 'class-validator';
-import {
-  BeforeUpdateMany,
-  BeforeUpdateOne,
-  UpdateManyInputType,
-  UpdateOneInputType
-} from '@ptc-org/nestjs-query-graphql';
+import { BeforeUpdateMany, BeforeUpdateOne, UpdateManyInputType, UpdateOneInputType } from '@ptc-org/nestjs-query-graphql';
 import { SubTaskDTO } from './sub-task.dto';
 import { UserContext } from '../../auth/auth.interfaces';
 

diff --git a/examples/auth/src/tag/tag.entity.ts b/examples/auth/src/tag/tag.entity.ts
@@ -1,12 +1,4 @@
-import {
-  Entity,
-  PrimaryGeneratedColumn,
-  Column,
-  CreateDateColumn,
-  UpdateDateColumn,
-  ObjectType,
-  ManyToMany
-} from 'typeorm';
+import { Entity, PrimaryGeneratedColumn, Column, CreateDateColumn, UpdateDateColumn, ObjectType, ManyToMany } from 'typeorm';
 import { TodoItemEntity } from '../todo-item/todo-item.entity';
 
 @Entity({ name: 'tag' })

diff --git a/examples/auth/src/todo-item/dto/todo-item-input.dto.ts b/examples/auth/src/todo-item/dto/todo-item-input.dto.ts
@@ -1,11 +1,6 @@
 import { IsString, MaxLength, IsBoolean } from 'class-validator';
 import { Field, InputType } from '@nestjs/graphql';
-import {
-  BeforeCreateMany,
-  BeforeCreateOne,
-  CreateManyInputType,
-  CreateOneInputType
-} from '@ptc-org/nestjs-query-graphql';
+import { BeforeCreateMany, BeforeCreateOne, CreateManyInputType, CreateOneInputType } from '@ptc-org/nestjs-query-graphql';
 import { UserContext } from '../../auth/auth.interfaces';
 
 @InputType('TodoItemInput')

diff --git a/examples/auth/src/todo-item/dto/todo-item-update.dto.ts b/examples/auth/src/todo-item/dto/todo-item-update.dto.ts
@@ -1,11 +1,6 @@
 import { Field, InputType } from '@nestjs/graphql';
 import { IsBoolean, IsNumber, IsOptional, IsString, MaxLength } from 'class-validator';
-import {
-  BeforeUpdateMany,
-  BeforeUpdateOne,
-  UpdateManyInputType,
-  UpdateOneInputType
-} from '@ptc-org/nestjs-query-graphql';
+import { BeforeUpdateMany, BeforeUpdateOne, UpdateManyInputType, UpdateOneInputType } from '@ptc-org/nestjs-query-graphql';
 import { TodoItemDTO } from './todo-item.dto';
 import { UserContext } from '../../auth/auth.interfaces';
 

diff --git a/examples/auth/src/user/user.entity.ts b/examples/auth/src/user/user.entity.ts
@@ -1,12 +1,4 @@
-import {
-  Column,
-  CreateDateColumn,
-  Entity,
-  PrimaryGeneratedColumn,
-  UpdateDateColumn,
-  OneToMany,
-  JoinTable
-} from 'typeorm';
+import { Column, CreateDateColumn, Entity, PrimaryGeneratedColumn, UpdateDateColumn, OneToMany, JoinTable } from 'typeorm';
 import { TodoItemEntity } from '../todo-item/todo-item.entity';
 
 @Entity({ name: 'user' })

diff --git a/examples/basic/e2e/sub-task.resolver.spec.ts b/examples/basic/e2e/sub-task.resolver.spec.ts
@@ -466,9 +466,7 @@ describe('SubTaskResolver (basic - e2e)', () => {
         .expect(400)
         .then(({ body }) => {
           expect(body.errors).toHaveLength(1);
-          expect(body.errors[0].message).toBe(
-            'Field "UpdateOneSubTaskInput.id" of required type "ID!" was not provided.'
-          );
+          expect(body.errors[0].message).toBe('Field "UpdateOneSubTaskInput.id" of required type "ID!" was not provided.');
         }));
 
     it('should validate an update', () =>
@@ -615,9 +613,7 @@ describe('SubTaskResolver (basic - e2e)', () => {
         .expect(400)
         .then(({ body }) => {
           expect(body.errors).toHaveLength(1);
-          expect(body.errors[0].message).toBe(
-            'Field "DeleteOneSubTaskInput.id" of required type "ID!" was not provided.'
-          );
+          expect(body.errors[0].message).toBe('Field "DeleteOneSubTaskInput.id" of required type "ID!" was not provided.');
         }));
   });
 

diff --git a/examples/basic/e2e/todo-item.resolver.spec.ts b/examples/basic/e2e/todo-item.resolver.spec.ts
@@ -510,9 +510,7 @@ describe('TodoItemResolver (basic - e2e)', () => {
         .expect(400)
         .then(({ body }) => {
           expect(body.errors).toHaveLength(1);
-          expect(body.errors[0].message).toBe(
-            'Field "UpdateOneTodoItemInput.id" of required type "ID!" was not provided.'
-          );
+          expect(body.errors[0].message).toBe('Field "UpdateOneTodoItemInput.id" of required type "ID!" was not provided.');
         }));
 
     it('should validate an update', () =>
@@ -661,9 +659,7 @@ describe('TodoItemResolver (basic - e2e)', () => {
         .expect(400)
         .then(({ body }) => {
           expect(body.errors).toHaveLength(1);
-          expect(body.errors[0].message).toBe(
-            'Field "DeleteOneTodoItemInput.id" of required type "ID!" was not provided.'
-          );
+          expect(body.errors[0].message).toBe('Field "DeleteOneTodoItemInput.id" of required type "ID!" was not provided.');
         }));
   });
 

diff --git a/examples/basic/src/tag/tag.entity.ts b/examples/basic/src/tag/tag.entity.ts
@@ -1,12 +1,4 @@
-import {
-  Entity,
-  PrimaryGeneratedColumn,
-  Column,
-  CreateDateColumn,
-  UpdateDateColumn,
-  ObjectType,
-  ManyToMany
-} from 'typeorm';
+import { Entity, PrimaryGeneratedColumn, Column, CreateDateColumn, UpdateDateColumn, ObjectType, ManyToMany } from 'typeorm';
 import { TodoItemEntity } from '../todo-item/todo-item.entity';
 
 @Entity({ name: 'tag' })

diff --git a/examples/complexity/e2e/sub-task.resolver.spec.ts b/examples/complexity/e2e/sub-task.resolver.spec.ts
@@ -502,9 +502,7 @@ describe('SubTaskResolver (complexity - e2e)', () => {
         .expect(400)
         .then(({ body }) => {
           expect(body.errors).toHaveLength(1);
-          expect(body.errors[0].message).toBe(
-            'Field "UpdateOneSubTaskInput.id" of required type "ID!" was not provided.'
-          );
+          expect(body.errors[0].message).toBe('Field "UpdateOneSubTaskInput.id" of required type "ID!" was not provided.');
         }));
 
     it('should validate an update', () =>
@@ -651,9 +649,7 @@ describe('SubTaskResolver (complexity - e2e)', () => {
         .expect(400)
         .then(({ body }) => {
           expect(body.errors).toHaveLength(1);
-          expect(body.errors[0].message).toBe(
-            'Field "DeleteOneSubTaskInput.id" of required type "ID!" was not provided.'
-          );
+          expect(body.errors[0].message).toBe('Field "DeleteOneSubTaskInput.id" of required type "ID!" was not provided.');
         }));
   });
 

diff --git a/examples/complexity/e2e/todo-item.resolver.spec.ts b/examples/complexity/e2e/todo-item.resolver.spec.ts
@@ -489,9 +489,7 @@ describe('TodoItemResolver (complexity - e2e)', () => {
         .expect(400)
         .then(({ body }) => {
           expect(body.errors).toHaveLength(1);
-          expect(body.errors[0].message).toBe(
-            'Field "UpdateOneTodoItemInput.id" of required type "ID!" was not provided.'
-          );
+          expect(body.errors[0].message).toBe('Field "UpdateOneTodoItemInput.id" of required type "ID!" was not provided.');
         }));
 
     it('should validate an update', () =>
@@ -640,9 +638,7 @@ describe('TodoItemResolver (complexity - e2e)', () => {
         .expect(400)
         .then(({ body }) => {
           expect(body.errors).toHaveLength(1);
-          expect(body.errors[0].message).toBe(
-            'Field "DeleteOneTodoItemInput.id" of required type "ID!" was not provided.'
-          );
+          expect(body.errors[0].message).toBe('Field "DeleteOneTodoItemInput.id" of required type "ID!" was not provided.');
         }));
   });
 

diff --git a/examples/complexity/src/tag/tag.entity.ts b/examples/complexity/src/tag/tag.entity.ts
@@ -1,12 +1,4 @@
-import {
-  Entity,
-  PrimaryGeneratedColumn,
-  Column,
-  CreateDateColumn,
-  UpdateDateColumn,
-  ObjectType,
-  ManyToMany
-} from 'typeorm';
+import { Entity, PrimaryGeneratedColumn, Column, CreateDateColumn, UpdateDateColumn, ObjectType, ManyToMany } from 'typeorm';
 import { TodoItemEntity } from '../todo-item/todo-item.entity';
 
 @Entity({ name: 'tag' })

diff --git a/examples/custom-id/e2e/sub-task.resolver.spec.ts b/examples/custom-id/e2e/sub-task.resolver.spec.ts
@@ -508,9 +508,7 @@ describe('SubTaskResolver (custom-id - e2e)', () => {
         .expect(400)
         .then(({ body }) => {
           expect(body.errors).toHaveLength(1);
-          expect(body.errors[0].message).toBe(
-            'Field "UpdateOneSubTaskInput.id" of required type "CustomID!" was not provided.'
-          );
+          expect(body.errors[0].message).toBe('Field "UpdateOneSubTaskInput.id" of required type "CustomID!" was not provided.');
         }));
 
     it('should validate an update', () =>
@@ -657,9 +655,7 @@ describe('SubTaskResolver (custom-id - e2e)', () => {
         .expect(400)
         .then(({ body }) => {
           expect(body.errors).toHaveLength(1);
-          expect(body.errors[0].message).toBe(
-            'Field "DeleteOneSubTaskInput.id" of required type "CustomID!" was not provided.'
-          );
+          expect(body.errors[0].message).toBe('Field "DeleteOneSubTaskInput.id" of required type "CustomID!" was not provided.');
         }));
   });
 

diff --git a/examples/custom-id/e2e/tag.resolver.spec.ts b/examples/custom-id/e2e/tag.resolver.spec.ts
@@ -385,9 +385,7 @@ describe('TagResolver (custom-id - e2e)', () => {
         .expect(400)
         .then(({ body }) => {
           expect(body.errors).toHaveLength(1);
-          expect(body.errors[0].message).toBe(
-            'Field "UpdateOneTagInput.id" of required type "CustomID!" was not provided.'
-          );
+          expect(body.errors[0].message).toBe('Field "UpdateOneTagInput.id" of required type "CustomID!" was not provided.');
         }));
 
     it('should validate an update', () =>
@@ -529,9 +527,7 @@ describe('TagResolver (custom-id - e2e)', () => {
         .expect(400)
         .then(({ body }) => {
           expect(body.errors).toHaveLength(1);
-          expect(body.errors[0].message).toBe(
-            'Field "DeleteOneTagInput.id" of required type "CustomID!" was not provided.'
-          );
+          expect(body.errors[0].message).toBe('Field "DeleteOneTagInput.id" of required type "CustomID!" was not provided.');
         }));
   });