Update Filters shapes to handle nulls & empty lists correctly

Author: CarsonF

src/components/ceremony/dto/list-ceremony.dto.ts

@@ -1,13 +1,12 @@
-import { Field, InputType } from '@nestjs/graphql';
-import { FilterField, SortablePaginationInput } from '~/common';
+import { InputType } from '@nestjs/graphql';
+import { FilterField, OptionalField, SortablePaginationInput } from '~/common';
 import { CeremonyType } from './ceremony-type.enum';
 import { Ceremony } from './ceremony.dto';
 
 @InputType()
 export abstract class CeremonyFilters {
-  @Field(() => CeremonyType, {
+  @OptionalField(() => CeremonyType, {
     description: 'Only ceremonies of this type',
-    nullable: true,
   })
   readonly type?: CeremonyType;
 }

src/components/engagement/dto/list-engagements.dto.ts

@@ -1,10 +1,12 @@
-import { Field, InputType, ObjectType } from '@nestjs/graphql';
+import { InputType, ObjectType } from '@nestjs/graphql';
 import { Type } from 'class-transformer';
 import { ValidateNested } from 'class-validator';
 import {
   DateFilter,
   FilterField,
   ID,
+  ListField,
+  OptionalField,
   PaginatedList,
   SecuredList,
   SortablePaginationInput,
@@ -26,30 +28,28 @@ import { EngagementStatus } from './status.enum';
 
 @InputType()
 export abstract class EngagementFilters {
-  @Field({
+  @OptionalField({
     description: 'Only engagements matching this type',
-    nullable: true,
   })
   readonly type?: 'language' | 'internship';
 
-  @Field({
-    nullable: true,
+  @OptionalField({
     description:
       'Only engagements whose project or engaged entity (language / user) name match',
   })
   readonly name?: string;
 
-  @Field(() => [EngagementStatus], {
-    nullable: true,
+  @ListField(() => EngagementStatus, {
+    optional: true,
+    empty: 'omit',
   })
   readonly status?: readonly EngagementStatus[];
 
   readonly projectId?: ID;
   @FilterField(() => ProjectFilters)
   readonly project?: ProjectFilters & {};
 
-  @Field({
-    nullable: true,
+  @OptionalField({
     description:
       'Only engagements whose engaged entity (language / user) name match',
   })
@@ -64,26 +64,26 @@ export abstract class EngagementFilters {
 
   readonly partnerId?: ID<'Partner'>;
 
-  @Field({
-    nullable: true,
-  })
+  @OptionalField()
   @Type(() => DateFilter)
   @ValidateNested()
   readonly startDate?: DateFilter;
 
-  @Field({
-    nullable: true,
-  })
+  @OptionalField()
   @Type(() => DateFilter)
   @ValidateNested()
   readonly endDate?: DateFilter;
 
-  @Field(() => [LanguageMilestone], {
-    nullable: true,
+  @ListField(() => LanguageMilestone, {
+    optional: true,
+    empty: 'omit',
   })
   readonly milestoneReached?: readonly LanguageMilestone[];
 
-  @Field(() => [AIAssistedTranslation], { nullable: true })
+  @ListField(() => AIAssistedTranslation, {
+    optional: true,
+    empty: 'omit',
+  })
   readonly usingAIAssistedTranslation?: readonly AIAssistedTranslation[];
 }
 

src/components/file/dto/list.ts

@@ -1,19 +1,22 @@
-import { Field, InputType, ObjectType } from '@nestjs/graphql';
-import { FilterField, PaginatedList, SortablePaginationInput } from '~/common';
+import { InputType, ObjectType } from '@nestjs/graphql';
+import {
+  FilterField,
+  OptionalField,
+  PaginatedList,
+  SortablePaginationInput,
+} from '~/common';
 import { FileNodeType } from './file-node-type.enum';
 import { Directory, File, FileNode, IFileNode } from './node';
 
 @InputType()
 export abstract class FileFilters {
-  @Field({
+  @OptionalField({
     description: 'Only file nodes matching this name',
-    nullable: true,
   })
   readonly name?: string;
 
-  @Field(() => FileNodeType, {
+  @OptionalField(() => FileNodeType, {
     description: 'Only file nodes matching this type',
-    nullable: true,
   })
   readonly type?: FileNodeType;
 }

src/components/language/dto/list-language.dto.ts

@@ -1,7 +1,8 @@
-import { Field, InputType, ObjectType } from '@nestjs/graphql';
+import { InputType, ObjectType } from '@nestjs/graphql';
 import {
   FilterField,
   ID,
+  OptionalField,
   PaginatedList,
   SecuredList,
   SensitivitiesFilterField,
@@ -12,68 +13,52 @@ import { Language } from './language.dto';
 
 @InputType()
 export abstract class EthnologueLanguageFilters {
-  @Field({
-    nullable: true,
-  })
+  @OptionalField()
   readonly code?: string;
 
-  @Field({
-    nullable: true,
-  })
+  @OptionalField()
   readonly provisionalCode?: string;
 
-  @Field({
-    nullable: true,
-  })
+  @OptionalField()
   readonly name?: string;
 }
 
 @InputType()
 export abstract class LanguageFilters {
-  @Field({
-    nullable: true,
-  })
+  @OptionalField()
   readonly name?: string;
 
   @SensitivitiesFilterField()
   readonly sensitivity?: Sensitivity[];
 
-  @Field({
-    nullable: true,
+  @OptionalField({
     description: 'Is a Least Of These partnership',
   })
   readonly leastOfThese?: boolean;
 
-  @Field({
-    nullable: true,
-  })
+  @OptionalField()
   readonly isDialect?: boolean;
 
-  @Field({
-    nullable: true,
-  })
+  @OptionalField()
   readonly isSignLanguage?: boolean;
 
-  @Field({
-    nullable: true,
+  @OptionalField({
     description: 'Only languages that are (not) in the "Preset Inventory"',
   })
   readonly presetInventory?: boolean;
 
-  @Field({
+  @OptionalField({
     description:
       'Only languages that are pinned/unpinned by the requesting user',
-    nullable: true,
   })
   readonly pinned?: boolean;
 
-  @Field({
-    nullable: true,
+  @OptionalField({
     deprecationReason: 'Use `registryOfLanguageVarietiesCode` instead',
   })
   readonly registryOfDialectsCode?: string;
 
-  @Field({ nullable: true })
+  @OptionalField()
   readonly registryOfLanguageVarietiesCode?: string;
 
   readonly partnerId?: ID;

src/components/location/dto/list-locations.dto.ts

@@ -1,7 +1,8 @@
-import { Field, InputType, ObjectType } from '@nestjs/graphql';
+import { InputType, ObjectType } from '@nestjs/graphql';
 import {
   FilterField,
   ID,
+  OptionalField,
   PaginatedList,
   SecuredList,
   SortablePaginationInput,
@@ -10,9 +11,7 @@ import { Location } from './location.dto';
 
 @InputType()
 export abstract class LocationFilters {
-  @Field({
-    nullable: true,
-  })
+  @OptionalField()
   readonly name?: string;
 
   readonly fundingAccountId?: ID;

src/components/notifications/dto/notification-list.input.ts

@@ -1,12 +1,16 @@
 import { Field, InputType, Int, ObjectType } from '@nestjs/graphql';
-import { FilterField, PaginatedList, PaginationInput } from '~/common';
+import {
+  FilterField,
+  OptionalField,
+  PaginatedList,
+  PaginationInput,
+} from '~/common';
 import { Notification } from './notification.dto';
 
 @InputType()
 export abstract class NotificationFilters {
-  @Field(() => Boolean, {
+  @OptionalField(() => Boolean, {
     description: 'Only read/unread notifications',
-    nullable: true,
   })
   readonly unread?: boolean;
 }

src/components/organization/dto/list-organization.dto.ts

@@ -1,7 +1,8 @@
-import { Field, InputType, ObjectType } from '@nestjs/graphql';
+import { InputType, ObjectType } from '@nestjs/graphql';
 import {
   FilterField,
   ID,
+  OptionalField,
   PaginatedList,
   SecuredList,
   SortablePaginationInput,
@@ -10,9 +11,7 @@ import { Organization } from './organization.dto';
 
 @InputType()
 export abstract class OrganizationFilters {
-  @Field({
-    nullable: true,
-  })
+  @OptionalField()
   readonly name?: string;
 
   readonly userId?: ID;

src/components/partner/dto/list-partner.dto.ts

@@ -1,11 +1,13 @@
-import { Field, InputType, ObjectType } from '@nestjs/graphql';
+import { InputType, ObjectType } from '@nestjs/graphql';
 import { Type } from 'class-transformer';
 import { ValidateNested } from 'class-validator';
 import {
   DateFilter,
   DateTimeFilter,
   FilterField,
   ID,
+  ListField,
+  OptionalField,
   PaginatedList,
   SecuredList,
   SortablePaginationInput,
@@ -19,41 +21,36 @@ import { Partner } from './partner.dto';
 export abstract class PartnerFilters {
   readonly userId?: ID;
 
-  @Field({
+  @OptionalField({
     description:
       'Only partners that are pinned/unpinned by the requesting user',
-    nullable: true,
   })
   readonly pinned?: boolean;
 
-  @Field({
-    nullable: true,
-  })
+  @OptionalField()
   readonly globalInnovationsClient?: boolean;
 
   @FilterField(() => OrganizationFilters)
   readonly organization?: OrganizationFilters & {};
 
-  @Field(() => [PartnerType], {
-    nullable: true,
+  @ListField(() => PartnerType, {
+    optional: true,
+    empty: 'omit',
   })
-  readonly types?: PartnerType[];
+  readonly types?: readonly PartnerType[];
 
-  @Field(() => [FinancialReportingType], {
-    nullable: true,
+  @ListField(() => FinancialReportingType, {
+    optional: true,
+    empty: 'omit',
   })
-  readonly financialReportingTypes?: FinancialReportingType[];
+  readonly financialReportingTypes?: readonly FinancialReportingType[];
 
-  @Field({
-    nullable: true,
-  })
+  @OptionalField()
   @Type(() => DateFilter)
   @ValidateNested()
   readonly startDate?: DateFilter;
 
-  @Field({
-    nullable: true,
-  })
+  @OptionalField()
   @Type(() => DateTimeFilter)
   @ValidateNested()
   readonly createdAt?: DateTimeFilter;

src/components/partnership/dto/list-partnership.dto.ts

@@ -1,9 +1,8 @@
-import { Field, InputType, ObjectType } from '@nestjs/graphql';
-import { Transform } from 'class-transformer';
-import { uniq } from 'lodash';
+import { InputType, ObjectType } from '@nestjs/graphql';
 import {
   FilterField,
   ID,
+  ListField,
   PaginatedList,
   SecuredList,
   SortablePaginationInput,
@@ -18,12 +17,12 @@ export abstract class PartnershipFilters {
   @FilterField(() => PartnerFilters)
   readonly partner?: PartnerFilters & {};
 
-  @Field(() => [PartnerType], { nullable: true })
-  @Transform(({ value }) => {
-    const types = uniq(value);
-    return types.length > 0 && types.length < PartnerType.values.size
-      ? types
-      : undefined;
+  @ListField(() => PartnerType, {
+    optional: true,
+    empty: 'omit',
+    transform: (value) =>
+      // If given all options, there is no need to filter
+      !value || value.length === PartnerType.values.size ? undefined : value,
   })
   readonly types?: readonly PartnerType[];
 }