Skip to content

Commit ea490dd

Browse files
7ttp7ttp
authored
fix(postgrest): cross-schema rpc setof type inference (#1900)
1 parent af85057 commit ea490dd

File tree

5 files changed

+64
-8
lines changed

5 files changed

+64
-8
lines changed

‎packages/core/postgrest-js/src/PostgrestClient.ts‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,15 @@ export default class PostgrestClient<
144144
*
145145
* `"estimated"`: Uses exact count for low numbers and planned count for high
146146
* numbers.
147+
*
148+
* @example
149+
* ```ts
150+
* // For cross-schema functions where type inference fails, use overrideTypes:
151+
* const { data } = await supabase
152+
* .schema('schema_b')
153+
* .rpc('function_a', {})
154+
* .overrideTypes<{ id: string; user_id: string }[]>()
155+
* ```
147156
*/
148157
rpc<
149158
FnName extends string & keyof Schema['Functions'],

‎packages/core/postgrest-js/src/types/common/rpc.ts‎

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,10 @@ type RpcFunctionNotFound<FnName> = {
6262
Relationships: null
6363
}
6464

65+
type CrossSchemaError<TableRef extends string> = {
66+
error: true
67+
} & `Function returns SETOF from a different schema ('${TableRef}'). Use .overrideTypes<YourReturnType>() to specify the return type explicitly.`
68+
6569
export type GetRpcFunctionFilterBuilderByArgs<
6670
Schema extends GenericSchema,
6771
FnName extends string & keyof Schema['Functions'],
@@ -98,13 +102,20 @@ export type GetRpcFunctionFilterBuilderByArgs<
98102
? // If we are dealing with an non-typed client everything is any
99103
IsAny<Fn> extends true
100104
? { Row: any; Result: any; RelationName: FnName; Relationships: null }
101-
: // Otherwise, we use the arguments based function definition narrowing to get the rigt value
105+
: // Otherwise, we use the arguments based function definition narrowing to get the right value
102106
Fn extends GenericFunction
103107
? {
104108
Row: Fn['SetofOptions'] extends GenericSetofOption
105-
? Fn['SetofOptions']['isSetofReturn'] extends true
109+
? Fn['SetofOptions']['to'] extends keyof TablesAndViews<Schema>
106110
? TablesAndViews<Schema>[Fn['SetofOptions']['to']]['Row']
107-
: TablesAndViews<Schema>[Fn['SetofOptions']['to']]['Row']
111+
: // Cross-schema fallback: use Returns type when table is not in current schema
112+
Fn['Returns'] extends any[]
113+
? Fn['Returns'][number] extends Record<string, unknown>
114+
? Fn['Returns'][number]
115+
: CrossSchemaError<Fn['SetofOptions']['to'] & string>
116+
: Fn['Returns'] extends Record<string, unknown>
117+
? Fn['Returns']
118+
: CrossSchemaError<Fn['SetofOptions']['to'] & string>
108119
: Fn['Returns'] extends any[]
109120
? Fn['Returns'][number] extends Record<string, unknown>
110121
? Fn['Returns'][number]
@@ -125,7 +136,9 @@ export type GetRpcFunctionFilterBuilderByArgs<
125136
Relationships: Fn['SetofOptions'] extends GenericSetofOption
126137
? Fn['SetofOptions']['to'] extends keyof Schema['Tables']
127138
? Schema['Tables'][Fn['SetofOptions']['to']]['Relationships']
128-
: Schema['Views'][Fn['SetofOptions']['to']]['Relationships']
139+
: Fn['SetofOptions']['to'] extends keyof Schema['Views']
140+
? Schema['Views'][Fn['SetofOptions']['to']]['Relationships']
141+
: null
129142
: null
130143
}
131144
: // If we failed to find the function by argument, we still pass with any but also add an overridable

‎packages/core/postgrest-js/test/override-types.test-d.ts‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -548,3 +548,12 @@ const postgrest = new PostgrestClient<Database>(REST_URL)
548548
>
549549
>(true)
550550
}
551+
552+
// Test cross-schema rpc falls back to Returns type
553+
{
554+
const result = await postgrest.schema('personal').rpc('get_public_users', {})
555+
if (result.error) {
556+
throw new Error(result.error.message)
557+
}
558+
expectType<TypeEqual<typeof result.data, { id: string; user_id: string }[]>>(true)
559+
}

‎packages/core/postgrest-js/test/types.override.ts‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,18 @@ export type Database = MergeDeep<
3232
}
3333
}
3434
}
35+
Functions: {
36+
get_public_users: {
37+
Args: Record<PropertyKey, never>
38+
Returns: { id: string; user_id: string }[]
39+
SetofOptions: {
40+
from: '*'
41+
to: 'public.users'
42+
isOneToOne: false
43+
isSetofReturn: true
44+
}
45+
}
46+
}
3547
Views: {}
3648
Enums: {}
3749
CompositeTypes: {}

‎packages/core/supabase-js/src/lib/rest/types/common/rpc.ts‎

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,10 @@ type RpcFunctionNotFound<FnName> = {
7272
Relationships: null
7373
}
7474

75+
type CrossSchemaError<TableRef extends string> = {
76+
error: true
77+
} & `Function returns SETOF from a different schema ('${TableRef}'). Use .overrideTypes<YourReturnType>() to specify the return type explicitly.`
78+
7579
export type GetRpcFunctionFilterBuilderByArgs<
7680
Schema extends GenericSchema,
7781
FnName extends string & keyof Schema['Functions'],
@@ -108,13 +112,20 @@ export type GetRpcFunctionFilterBuilderByArgs<
108112
? // If we are dealing with an non-typed client everything is any
109113
IsAny<Fn> extends true
110114
? { Row: any; Result: any; RelationName: FnName; Relationships: null }
111-
: // Otherwise, we use the arguments based function definition narrowing to get the rigt value
115+
: // Otherwise, we use the arguments based function definition narrowing to get the right value
112116
Fn extends GenericFunction
113117
? {
114118
Row: Fn['SetofOptions'] extends GenericSetofOption
115-
? Fn['SetofOptions']['isSetofReturn'] extends true
119+
? Fn['SetofOptions']['to'] extends keyof TablesAndViews<Schema>
116120
? TablesAndViews<Schema>[Fn['SetofOptions']['to']]['Row']
117-
: TablesAndViews<Schema>[Fn['SetofOptions']['to']]['Row']
121+
: // Cross-schema fallback: use Returns type when table is not in current schema
122+
Fn['Returns'] extends any[]
123+
? Fn['Returns'][number] extends Record<string, unknown>
124+
? Fn['Returns'][number]
125+
: CrossSchemaError<Fn['SetofOptions']['to'] & string>
126+
: Fn['Returns'] extends Record<string, unknown>
127+
? Fn['Returns']
128+
: CrossSchemaError<Fn['SetofOptions']['to'] & string>
118129
: Fn['Returns'] extends any[]
119130
? Fn['Returns'][number] extends Record<string, unknown>
120131
? Fn['Returns'][number]
@@ -135,7 +146,9 @@ export type GetRpcFunctionFilterBuilderByArgs<
135146
Relationships: Fn['SetofOptions'] extends GenericSetofOption
136147
? Fn['SetofOptions']['to'] extends keyof Schema['Tables']
137148
? Schema['Tables'][Fn['SetofOptions']['to']]['Relationships']
138-
: Schema['Views'][Fn['SetofOptions']['to']]['Relationships']
149+
: Fn['SetofOptions']['to'] extends keyof Schema['Views']
150+
? Schema['Views'][Fn['SetofOptions']['to']]['Relationships']
151+
: null
139152
: null
140153
}
141154
: // If we failed to find the function by argument, we still pass with any but also add an overridable

0 commit comments

Comments
 (0)