Skip to content

fix(postgrest): preserve nullability when using JSON path #2011

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mandarini wants to merge 10 commits into
base: master
Choose a base branch
from
Open

fix(postgrest): preserve nullability when using JSON path #2011

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
cf26e82
fix (postgrest-js): preserve nullability when using JSON path (->) (#…
dev-hari-prasad Dec 10, 2025
929ddb5
test(postgrest): add type tests for nullable JSON path behavior
dev-hari-prasad Dec 16, 2025
5c1b4b8
test(postgrest): add some tests around json accessors type inference
avallete Dec 23, 2025
a4dfbbe
fix(postgrest): keep union and add null to inference
avallete Dec 23, 2025
b0a12b7
chore(postgrest): make custom json data override schema nullable
avallete Dec 23, 2025
6f08605
test(postgrest): add json path tests for non-nullable json
avallete Dec 23, 2025
7b60492
test(postgrest): fix returns.test-d.ts expect
avallete Dec 23, 2025
07427a5
test(postgrest): fix index.test-d.ts tests
avallete Dec 23, 2025
79d87ca
chore(repo): use local npm controlled supabase cli instance
avallete Jan 7, 2026
7bb36a5
chore(repo): use workdir when used with npx
avallete Jan 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions packages/core/postgrest-js/src/select-query-parser/result.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,14 +308,17 @@ type ResolveJsonPathType<
? PathResult extends string
? // Use the result if it's a string as we know that even with the string accessor ->> it's a valid type
PathResult
: IsStringUnion<PathResult> extends true
? // Use the result if it's a union of strings
: IsStringUnion<Exclude<PathResult, null>> extends true
? // Use the result if it's a union of strings (even if nullable)
PathResult
: CastType extends 'json'
? // If the type is not a string, ensure it was accessed with json accessor ->
: IsStringUnion<PathResult> extends true
? // Use the result if it's a union of strings (non-nullable)
PathResult
: // Otherwise it means non-string value accessed with string accessor ->> use the TypeScriptTypes result
TypeScriptTypes<CastType>
: CastType extends 'json'
? // If the type is not a string, ensure it was accessed with json accessor ->
PathResult
: // Otherwise it means non-string value accessed with string accessor ->> use the TypeScriptTypes result
TypeScriptTypes<CastType>
: TypeScriptTypes<CastType>
: // No json path, use regular type casting
TypeScriptTypes<CastType>
Expand Down
2 changes: 1 addition & 1 deletion packages/core/postgrest-js/src/select-query-parser/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -618,7 +618,7 @@ export type JsonPathToAccessor<Path extends string> = Path extends `${infer P1}-
export type JsonPathToType<T, Path extends string> = Path extends ''
? T
: ContainsNull<T> extends true
? JsonPathToType<Exclude<T, null>, Path>
? JsonPathToType<Exclude<T, null>, Path> | null
: Path extends `${infer Key}.${infer Rest}`
? Key extends keyof T
? JsonPathToType<T[Key], Rest>
Expand Down
46 changes: 45 additions & 1 deletion packages/core/postgrest-js/test/advanced_rpc.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1169,7 +1169,8 @@ describe('advanced rpc', () => {
"age_range": "[20,30)",
"catchphrase": "'json' 'test'",
"data": {
"foo": {
"foo": "string value",
"fooRecord": {
"bar": {
"nested": "value",
},
Expand All @@ -1179,6 +1180,49 @@ describe('advanced rpc', () => {
"status": "ONLINE",
"username": "jsonuser",
},
{
"age_range": "[20,30)",
"catchphrase": "'json' 'null' 'test'",
"data": {
"bar": null,
"en": "ONE",
"foo": "string value",
"fooRecord": {
"bar": null,
"baz": "string value",
},
},
"status": "ONLINE",
"username": "jsonusernull",
},
{
"age_range": "[20,30)",
"catchphrase": "'json' 'obj' 'test'",
"data": {
"bar": {
"baz": 42,
},
"en": "TWO",
"fooRecord": {
"bar": {
"nested": "deep",
},
"baz": "test",
},
},
"status": "ONLINE",
"username": "jsonuserobj",
},
{
"age_range": "[20,30)",
"catchphrase": "'json' 'missing' 'test'",
"data": {
"en": "THREE",
"foo": "string",
},
"status": "ONLINE",
"username": "jsonusermissing",
},
],
"error": null,
"status": 200,
Expand Down
204 changes: 196 additions & 8 deletions packages/core/postgrest-js/test/basic.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ test('basic select table', async () => {
"age_range": "[20,30)",
"catchphrase": "'json' 'test'",
"data": {
"foo": {
"foo": "string value",
"fooRecord": {
"bar": {
"nested": "value",
},
Expand All @@ -52,6 +53,49 @@ test('basic select table', async () => {
"status": "ONLINE",
"username": "jsonuser",
},
{
"age_range": "[20,30)",
"catchphrase": "'json' 'null' 'test'",
"data": {
"bar": null,
"en": "ONE",
"foo": "string value",
"fooRecord": {
"bar": null,
"baz": "string value",
},
},
"status": "ONLINE",
"username": "jsonusernull",
},
{
"age_range": "[20,30)",
"catchphrase": "'json' 'obj' 'test'",
"data": {
"bar": {
"baz": 42,
},
"en": "TWO",
"fooRecord": {
"bar": {
"nested": "deep",
},
"baz": "test",
},
},
"status": "ONLINE",
"username": "jsonuserobj",
},
{
"age_range": "[20,30)",
"catchphrase": "'json' 'missing' 'test'",
"data": {
"en": "THREE",
"foo": "string",
},
"status": "ONLINE",
"username": "jsonusermissing",
},
],
"error": null,
"status": 200,
Expand Down Expand Up @@ -98,7 +142,8 @@ test('basic select returns types override', async () => {
"age_range": "[20,30)",
"catchphrase": "'json' 'test'",
"data": {
"foo": {
"foo": "string value",
"fooRecord": {
"bar": {
"nested": "value",
},
Expand All @@ -108,6 +153,49 @@ test('basic select returns types override', async () => {
"status": "ONLINE",
"username": "jsonuser",
},
{
"age_range": "[20,30)",
"catchphrase": "'json' 'null' 'test'",
"data": {
"bar": null,
"en": "ONE",
"foo": "string value",
"fooRecord": {
"bar": null,
"baz": "string value",
},
},
"status": "ONLINE",
"username": "jsonusernull",
},
{
"age_range": "[20,30)",
"catchphrase": "'json' 'obj' 'test'",
"data": {
"bar": {
"baz": 42,
},
"en": "TWO",
"fooRecord": {
"bar": {
"nested": "deep",
},
"baz": "test",
},
},
"status": "ONLINE",
"username": "jsonuserobj",
},
{
"age_range": "[20,30)",
"catchphrase": "'json' 'missing' 'test'",
"data": {
"en": "THREE",
"foo": "string",
},
"status": "ONLINE",
"username": "jsonusermissing",
},
],
"error": null,
"status": 200,
Expand Down Expand Up @@ -172,7 +260,7 @@ test('basic select with maybeSingle yielding more than one result', async () =>
"data": null,
"error": {
"code": "PGRST116",
"details": "Results contain 5 rows, application/vnd.pgrst.object+json requires 1 row",
"details": "Results contain 8 rows, application/vnd.pgrst.object+json requires 1 row",
"hint": null,
"message": "JSON object requested, multiple (or no) rows returned",
},
Expand All @@ -190,7 +278,7 @@ test('basic select with single yielding more than one result', async () => {
"data": null,
"error": {
"code": "PGRST116",
"details": "The result contains 5 rows",
"details": "The result contains 8 rows",
"hint": null,
"message": "Cannot coerce the result to a single JSON object",
},
Expand Down Expand Up @@ -226,6 +314,18 @@ test('basic select view', async () => {
"non_updatable_column": 1,
"username": "jsonuser",
},
{
"non_updatable_column": 1,
"username": "jsonusernull",
},
{
"non_updatable_column": 1,
"username": "jsonuserobj",
},
{
"non_updatable_column": 1,
"username": "jsonusermissing",
},
],
"error": null,
"status": 200,
Expand Down Expand Up @@ -1039,7 +1139,8 @@ test('allow ordering on JSON column', async () => {
"age_range": "[20,30)",
"catchphrase": "'json' 'test'",
"data": {
"foo": {
"foo": "string value",
"fooRecord": {
"bar": {
"nested": "value",
},
Expand All @@ -1049,6 +1150,49 @@ test('allow ordering on JSON column', async () => {
"status": "ONLINE",
"username": "jsonuser",
},
{
"age_range": "[20,30)",
"catchphrase": "'json' 'null' 'test'",
"data": {
"bar": null,
"en": "ONE",
"foo": "string value",
"fooRecord": {
"bar": null,
"baz": "string value",
},
},
"status": "ONLINE",
"username": "jsonusernull",
},
{
"age_range": "[20,30)",
"catchphrase": "'json' 'obj' 'test'",
"data": {
"bar": {
"baz": 42,
},
"en": "TWO",
"fooRecord": {
"bar": {
"nested": "deep",
},
"baz": "test",
},
},
"status": "ONLINE",
"username": "jsonuserobj",
},
{
"age_range": "[20,30)",
"catchphrase": "'json' 'missing' 'test'",
"data": {
"en": "THREE",
"foo": "string",
},
"status": "ONLINE",
"username": "jsonusermissing",
},
{
"age_range": "[20,30)",
"catchphrase": "'fat' 'rat'",
Expand Down Expand Up @@ -1084,7 +1228,7 @@ test('select with head:true, count:exact', async () => {
const res = await postgrest.from('users').select('*', { head: true, count: 'exact' })
expect(res).toMatchInlineSnapshot(`
{
"count": 5,
"count": 8,
"data": null,
"error": null,
"status": 200,
Expand Down Expand Up @@ -1133,7 +1277,7 @@ test('select with count:exact', async () => {
const res = await postgrest.from('users').select('*', { count: 'exact' })
expect(res).toMatchInlineSnapshot(`
{
"count": 5,
"count": 8,
"data": [
{
"age_range": "[1,2)",
Expand All @@ -1160,7 +1304,8 @@ test('select with count:exact', async () => {
"age_range": "[20,30)",
"catchphrase": "'json' 'test'",
"data": {
"foo": {
"foo": "string value",
"fooRecord": {
"bar": {
"nested": "value",
},
Expand All @@ -1170,6 +1315,49 @@ test('select with count:exact', async () => {
"status": "ONLINE",
"username": "jsonuser",
},
{
"age_range": "[20,30)",
"catchphrase": "'json' 'null' 'test'",
"data": {
"bar": null,
"en": "ONE",
"foo": "string value",
"fooRecord": {
"bar": null,
"baz": "string value",
},
},
"status": "ONLINE",
"username": "jsonusernull",
},
{
"age_range": "[20,30)",
"catchphrase": "'json' 'obj' 'test'",
"data": {
"bar": {
"baz": 42,
},
"en": "TWO",
"fooRecord": {
"bar": {
"nested": "deep",
},
"baz": "test",
},
},
"status": "ONLINE",
"username": "jsonuserobj",
},
{
"age_range": "[20,30)",
"catchphrase": "'json' 'missing' 'test'",
"data": {
"en": "THREE",
"foo": "string",
},
"status": "ONLINE",
"username": "jsonusermissing",
},
{
"age_range": "[20,30)",
"catchphrase": "'fat' 'rat'",
Expand Down
Loading
Loading