fix: jsonpath with embeded tables

Author: avallete

src/select-query-parser/utils.ts

@@ -555,6 +555,8 @@ export type JsonPathToAccessor<Path extends string> = Path extends `${infer P1}-
   ? JsonPathToAccessor<Rest>
   : Path extends `${infer P1}::${infer _}` // Handle type casting
   ? JsonPathToAccessor<P1>
+  : Path extends `${infer P1}${')' | ','}${infer _}` // Handle closing parenthesis and comma
+  ? P1
   : Path
 
 export type JsonPathToType<T, Path extends string> = Path extends ''

test/basic.ts

@@ -1,5 +1,5 @@
 import { PostgrestClient } from '../src/index'
-import { Database } from './types'
+import { CustomUserDataType, Database } from './types'
 
 const REST_URL = 'http://localhost:3000'
 const postgrest = new PostgrestClient<Database>(REST_URL)
@@ -1615,7 +1615,10 @@ test('select with no match', async () => {
 })
 
 test('update with no match - return=minimal', async () => {
-  const res = await postgrest.from('users').update({ data: '' }).eq('username', 'missing')
+  const res = await postgrest
+    .from('users')
+    .update({ data: '' as unknown as CustomUserDataType })
+    .eq('username', 'missing')
   expect(res).toMatchInlineSnapshot(`
     Object {
       "count": null,
@@ -1628,7 +1631,11 @@ test('update with no match - return=minimal', async () => {
 })
 
 test('update with no match - return=representation', async () => {
-  const res = await postgrest.from('users').update({ data: '' }).eq('username', 'missing').select()
+  const res = await postgrest
+    .from('users')
+    .update({ data: '' as unknown as CustomUserDataType })
+    .eq('username', 'missing')
+    .select()
   expect(res).toMatchInlineSnapshot(`
     Object {
       "count": null,

test/select-query-parser/parser.test-d.ts

@@ -662,3 +662,36 @@ import { selectParams } from '../relationships'
     0 as any as ParserError<'Unexpected input: ->->theme'>
   )
 }
+
+// JSON accessor within embedded tables
+{
+  expectType<ParseQuery<'users(data->bar->>baz, data->>en, data->bar)'>>([
+    {
+      type: 'field',
+      name: 'users',
+      children: [
+        {
+          type: 'field',
+          name: 'data',
+          alias: 'baz',
+          castType: 'text',
+          jsonPath: 'bar.baz',
+        },
+        {
+          type: 'field',
+          name: 'data',
+          alias: 'en',
+          castType: 'text',
+          jsonPath: 'en',
+        },
+        {
+          type: 'field',
+          name: 'data',
+          alias: 'bar',
+          castType: 'json',
+          jsonPath: 'bar',
+        },
+      ],
+    },
+  ])
+}

test/select-query-parser/result.test-d.ts

@@ -164,4 +164,33 @@ type SelectQueryFromTableResult<
     }
     expectType<TypeEqual<typeof result, typeof expected>>(true)
   }
+  // Should work with embeded Json object accessor
+  {
+    let result: SelectQueryFromTableResult<'messages', `users(data->bar->baz, data->en, data->bar)`>
+    let expected: {
+      users: {
+        baz: number
+        en: 'ONE' | 'TWO' | 'THREE'
+        bar: {
+          baz: number
+        }
+      }
+    }
+    expectType<TypeEqual<typeof result, typeof expected>>(true)
+  }
+  // Should work with embeded Json string accessor
+  {
+    let result: SelectQueryFromTableResult<
+      'messages',
+      `users(data->bar->>baz, data->>en, data->>bar)`
+    >
+    let expected: {
+      users: {
+        baz: string
+        en: 'ONE' | 'TWO' | 'THREE'
+        bar: string
+      }
+    }
+    expectType<TypeEqual<typeof result, typeof expected>>(true)
+  }
 }

test/select-query-parser/select.test-d.ts

@@ -3,7 +3,7 @@ import { TypeEqual } from 'ts-expect'
 import { Json } from '../../src/select-query-parser/types'
 import { SelectQueryError } from '../../src/select-query-parser/utils'
 import { Prettify } from '../../src/types'
-import { Database } from '../types'
+import { CustomUserDataType, Database } from '../types'
 import { selectQueries } from '../relationships'
 
 // This test file is here to ensure that for a query against a specfic datatabase
@@ -617,7 +617,7 @@ type Schema = Database['public']
     users: {
       age_range: unknown | null
       catchphrase: unknown | null
-      data: Json | null
+      data: CustomUserDataType | null
       status: Database['public']['Enums']['user_status'] | null
       username: string
     }

test/types.ts

@@ -1,6 +1,6 @@
 export type Json = string | number | boolean | null | { [key: string]: Json | undefined } | Json[]
 
-type CustomUserDataType = {
+export type CustomUserDataType = {
   foo: string
   bar: {
     baz: number
@@ -412,21 +412,21 @@ export type Database = {
         Row: {
           age_range: unknown | null
           catchphrase: unknown | null
-          data: Json | null
+          data: CustomUserDataType | null
           status: Database['public']['Enums']['user_status'] | null
           username: string
         }
         Insert: {
           age_range?: unknown | null
           catchphrase?: unknown | null
-          data?: Json | null
+          data?: CustomUserDataType | null
           status?: Database['public']['Enums']['user_status'] | null
           username: string
         }
         Update: {
           age_range?: unknown | null
           catchphrase?: unknown | null
-          data?: Json | null
+          data?: CustomUserDataType | null
           status?: Database['public']['Enums']['user_status'] | null
           username?: string
         }