feat(types): add jsonpath parser

Author: avallete

src/select-query-parser/parser.ts

@@ -2,6 +2,7 @@
 // See https://github.com/PostgREST/postgrest/blob/2f91853cb1de18944a4556df09e52450b881cfb3/src/PostgREST/ApiRequest/QueryParams.hs#L282-L284
 
 import { SimplifyDeep } from '../types'
+import { JsonPathToAccessor } from './utils'
 
 /**
  * Parses a query.
@@ -220,13 +221,24 @@ type ParseNonEmbeddedResourceField<Input extends string> = ParseIdentifier<Input
 ]
   ? // Parse optional JSON path.
     (
-      Remainder extends `->${infer _}`
+      Remainder extends `->${infer PathAndRest}`
         ? ParseJsonAccessor<Remainder> extends [
             infer PropertyName,
             infer PropertyType,
             `${infer Remainder}`
           ]
-          ? [{ type: 'field'; name: Name; alias: PropertyName; castType: PropertyType }, Remainder]
+          ? [
+              {
+                type: 'field'
+                name: Name
+                alias: PropertyName
+                castType: PropertyType
+                jsonPath: JsonPathToAccessor<
+                  PathAndRest extends `${infer Path},${string}` ? Path : PathAndRest
+                >
+              },
+              Remainder
+            ]
           : ParseJsonAccessor<Remainder>
         : [{ type: 'field'; name: Name }, Remainder]
     ) extends infer Parsed
@@ -401,6 +413,7 @@ export namespace Ast {
     hint?: string
     innerJoin?: true
     castType?: string
+    jsonPath?: string
     aggregateFunction?: Token.AggregateFunction
     children?: Node[]
   }

src/select-query-parser/utils.ts

@@ -544,3 +544,11 @@ export type FindFieldMatchingRelationships<
       name: Field['name']
     }
   : SelectQueryError<'Failed to find matching relation via name'>
+
+export type JsonPathToAccessor<Path extends string> = Path extends `${infer P1}->${infer P2}`
+  ? P2 extends `>${infer Rest}` // Check if P2 starts with > (from ->>)
+    ? JsonPathToAccessor<`${P1}.${Rest}`>
+    : JsonPathToAccessor<`${P1}.${P2}`>
+  : Path extends `${infer P1}::${infer _}` // Handle type casting
+  ? JsonPathToAccessor<P1> // Process the path without the cast type
+  : Path

test/index.test-d.ts

@@ -211,3 +211,14 @@ const postgrest = new PostgrestClient<Database>(REST_URL)
   expectType<typeof x>(y)
   expectType<typeof x>(z)
 }
+
+// Json Accessor with custom types overrides
+{
+  const { error } = await postgrest
+    .schema('personal')
+    .from('users')
+    .select('data->foo->bar, data->foo->>baz')
+  if (error) {
+    throw new Error(error.message)
+  }
+}

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

@@ -81,17 +81,28 @@ import { selectParams } from '../relationships'
 // Select with JSON accessor
 {
   expectType<ParseQuery<'data->preferences->theme'>>([
-    { type: 'field', name: 'data', alias: 'theme', castType: 'json' },
+    {
+      type: 'field',
+      name: 'data',
+      alias: 'theme',
+      castType: 'json',
+      jsonPath: 'preferences.theme',
+    },
   ])
 }
 
 // Select with JSON accessor and text conversion
 {
   expectType<ParseQuery<'data->preferences->>theme'>>([
-    { type: 'field', name: 'data', alias: 'theme', castType: 'text' },
+    {
+      type: 'field',
+      name: 'data',
+      alias: 'theme',
+      castType: 'text',
+      jsonPath: 'preferences.theme',
+    },
   ])
 }
-
 // Select with spread
 {
   expectType<ParseQuery<'username, ...posts(id, title)'>>([
@@ -196,7 +207,13 @@ import { selectParams } from '../relationships'
         },
       ],
     },
-    { type: 'field', name: 'profile', alias: 'theme', castType: 'text' },
+    {
+      type: 'field',
+      name: 'profile',
+      alias: 'theme',
+      castType: 'text',
+      jsonPath: 'settings.theme',
+    },
   ])
 }
 {
@@ -327,7 +344,13 @@ import { selectParams } from '../relationships'
 // Select with nested JSON accessors
 {
   expectType<ParseQuery<'data->preferences->theme->color'>>([
-    { type: 'field', name: 'data', alias: 'color', castType: 'json' },
+    {
+      type: 'field',
+      name: 'data',
+      alias: 'color',
+      castType: 'json',
+      jsonPath: 'preferences.theme.color',
+    },
   ])
 }
 
@@ -464,7 +487,7 @@ import { selectParams } from '../relationships'
   expectType<ParseQuery<'id::text, created_at::date, data->age::int'>>([
     { type: 'field', name: 'id', castType: 'text' },
     { type: 'field', name: 'created_at', castType: 'date' },
-    { type: 'field', name: 'data', alias: 'age', castType: 'int' },
+    { type: 'field', name: 'data', alias: 'age', castType: 'int', jsonPath: 'age' },
   ])
 }
 
@@ -480,8 +503,8 @@ import { selectParams } from '../relationships'
 // select JSON accessor
 {
   expect<ParseQuery<typeof selectParams.selectJsonAccessor.select>>([
-    { type: 'field', name: 'data', alias: 'bar', castType: 'json' },
-    { type: 'field', name: 'data', alias: 'baz', castType: 'text' },
+    { type: 'field', name: 'data', alias: 'bar', castType: 'json', jsonPath: 'foo.bar' },
+    { type: 'field', name: 'data', alias: 'baz', castType: 'text', jsonPath: 'foo.baz' },
   ])
 }
 

test/types.ts

@@ -1,24 +1,32 @@
 export type Json = string | number | boolean | null | { [key: string]: Json | undefined } | Json[]
 
+type CustomUserDataType = {
+  foo: string
+  bar: {
+    baz: number
+  }
+  en: 'ONE' | 'TWO' | 'THREE'
+}
+
 export type Database = {
   personal: {
     Tables: {
       users: {
         Row: {
           age_range: unknown | null
-          data: Json | null
+          data: CustomUserDataType | null
           status: Database['public']['Enums']['user_status'] | null
           username: string
         }
         Insert: {
           age_range?: unknown | null
-          data?: Json | null
+          data?: CustomUserDataType | null
           status?: Database['public']['Enums']['user_status'] | null
           username: string
         }
         Update: {
           age_range?: unknown | null
-          data?: Json | null
+          data?: CustomUserDataType | null
           status?: Database['public']['Enums']['user_status'] | null
           username?: string
         }