Allow null and undefined as filter value

Author: IlyaSemenov

.changeset/empty-jobs-yell.md

@@ -0,0 +1,6 @@
+---
+"objection-graphql-resolver": patch
+"orchid-graphql": patch
+---
+
+Allow null and undefined as filter value.

packages/base/src/filter/filter.ts

@@ -6,7 +6,7 @@ export type FilterConfig = boolean
 
 export type FieldFilterScalarValue = null | string | number | boolean
 export type FieldFilterValue = FieldFilterScalarValue | Exclude<FieldFilterScalarValue, null>[]
-export type FilterValue = { [property: string]: FieldFilterValue }
+export type FilterValue = { [property: string]: FieldFilterValue } | null | undefined
 
 export type FilterQueryOptions<Orm extends OrmAdapter, Context = unknown> = {
 	modifiers?: FilterModifiers<Orm, Context>

packages/objection/tests/filter/filter.test.ts

@@ -1,6 +1,6 @@
 import type { QueryBuilder } from "objection"
 import { Model, ref } from "objection"
-import type { FilterModifiers } from "objection-graphql-resolver"
+import type { FilterModifiers, FilterValue } from "objection-graphql-resolver"
 import { filterQuery } from "objection-graphql-resolver"
 import { expect, test } from "vitest"
 
@@ -220,3 +220,33 @@ test("filter by parametrized modifier (search)", async () => {
 		filterQuery(PostModel.query().select("text"), { search: "news" }, { modifiers }),
 	).resolves.toMatchInlineSnapshot(`[]`)
 })
+
+test("no filter", async () => {
+	await expect(
+		filterQuery(PostModel.query().count(), null),
+	).resolves.toMatchInlineSnapshot(`
+		[
+		  {
+		    "count(*)": 6,
+		  },
+		]
+	`)
+	await expect(
+		filterQuery(PostModel.query().count(), undefined),
+	).resolves.toMatchInlineSnapshot(`
+		[
+		  {
+		    "count(*)": 6,
+		  },
+		]
+	`)
+})
+
+test("invalid filter type", async () => {
+	expect(
+		() => filterQuery(PostModel.query().count(), true as unknown as FilterValue),
+	).toThrowError("Invalid filter")
+	expect(
+		() => filterQuery(PostModel.query().count(), "published" as unknown as FilterValue),
+	).toThrowError("Invalid filter")
+})

packages/orchid/tests/filter/filter.test.ts

@@ -1,4 +1,4 @@
-import type { FilterModifiers } from "orchid-graphql"
+import type { FilterModifiers, FilterValue } from "orchid-graphql"
 import { filterQuery } from "orchid-graphql"
 import { expect, test } from "vitest"
 
@@ -175,3 +175,21 @@ test("filter by parametrized modifier (search)", async () => {
 		]
 	`)
 })
+
+test("no filter", async () => {
+	await expect(
+		filterQuery(db.post.count(), null),
+	).resolves.toMatchInlineSnapshot(`6`)
+	await expect(
+		filterQuery(db.post.count(), undefined),
+	).resolves.toMatchInlineSnapshot(`6`)
+})
+
+test("invalid filter type", async () => {
+	expect(
+		() => filterQuery(db.post.count(), true as unknown as FilterValue),
+	).toThrowError("Invalid filter")
+	expect(
+		() => filterQuery(db.post.count(), "published" as unknown as FilterValue),
+	).toThrowError("Invalid filter")
+})