feat: add maxAffected for rpc calls

Author: avallete

src/PostgrestClient.ts

@@ -146,7 +146,8 @@ export default class PostgrestClient<
       : never,
     Fn['Returns'],
     FnName,
-    null
+    null,
+    'RPC'
   > {
     let method: 'HEAD' | 'GET' | 'POST'
     const url = new URL(`${this.url}/rpc/${fn}`)

src/PostgrestTransformBuilder.ts

@@ -346,17 +346,16 @@ export default class PostgrestTransformBuilder<
    *
    * @param value - The maximum number of rows that can be affected
    */
-  maxAffected(
-    value: number
-  ): ClientOptions['postgrestVersion'] extends 13
-    ? Method extends 'PATCH' | 'DELETE'
+  maxAffected(value: number): ClientOptions['postgrestVersion'] extends 13
+    ? // TODO: update the RPC case to only work on RPC that returns SETOF rows
+      Method extends 'PATCH' | 'DELETE' | 'RPC'
       ? this
       : InvalidMethodError<'maxAffected method only available on update or delete'>
     : InvalidMethodError<'maxAffected method only available on postgrest 13+'> {
     this.headers.append('Prefer', 'handling=strict')
     this.headers.append('Prefer', `max-affected=${value}`)
     return this as unknown as ClientOptions['postgrestVersion'] extends 13
-      ? Method extends 'PATCH' | 'DELETE'
+      ? Method extends 'PATCH' | 'DELETE' | 'RPC'
         ? this
         : InvalidMethodError<'maxAffected method only available on update or delete'>
       : InvalidMethodError<'maxAffected method only available on postgrest 13+'>

test/db/00-schema.sql

@@ -115,6 +115,12 @@ RETURNS user_status AS $$
   RETURNING status;
 $$ LANGUAGE SQL VOLATILE;
 
+
+CREATE FUNCTION public.set_users_offline(name_param text)
+RETURNS SETOF users AS $$
+  UPDATE users SET status = 'OFFLINE' WHERE username LIKE name_param RETURNING *;
+$$ LANGUAGE SQL;
+
 CREATE FUNCTION public.void_func()
 RETURNS void AS $$
 $$ LANGUAGE SQL;

test/max-affected.ts

@@ -136,4 +136,45 @@ describe('maxAffected', () => {
     expect(data).toHaveLength(1)
     expect(data?.[0].message).toBe('test4')
   })
+
+  test('should be able to use .maxAffected with setof records returning rpc', async () => {
+    // First create a user that will be returned by the RPC
+    await postgrest13.from('users').insert([{ username: 'testuser', status: 'ONLINE' }])
+    // Call the RPC function that returns a set of records
+    const { data, error } = await postgrest13
+      .rpc('set_users_offline', { name_param: 'testuser' })
+      .maxAffected(1)
+      .select()
+
+    expect(error).toBeNull()
+    expect(data).toHaveLength(1)
+    expect(data).toEqual([
+      {
+        username: 'testuser',
+        data: null,
+        age_range: null,
+        status: 'OFFLINE',
+        catchphrase: null,
+      },
+    ])
+  })
+
+  test('should fail when rpc returns more results than maxAffected', async () => {
+    // First create multiple users that will be returned by the RPC
+    await postgrest13.from('users').insert([
+      { username: 'testuser1', status: 'ONLINE' },
+      { username: 'testuser2', status: 'ONLINE' },
+      { username: 'testuser3', status: 'ONLINE' },
+    ])
+
+    // Call the RPC function that returns a set of records
+    const { data, error } = await postgrest13
+      .rpc('set_users_offline', { name_param: 'testuser%' })
+      .maxAffected(1)
+      .select()
+
+    expect(error).toBeDefined()
+    expect(error?.code).toBe('PGRST124')
+    expect(data).toBeNull()
+  })
 })

test/types.generated-with-options-postgrest13.ts

@@ -533,6 +533,18 @@ export type Database = {
         }
         Returns: Database['public']['Enums']['user_status']
       }
+      set_users_offline: {
+        Args: {
+          name_param: string
+        }
+        Returns: {
+          age_range: unknown | null
+          catchphrase: unknown | null
+          data: Json | null
+          status: Database['public']['Enums']['user_status'] | null
+          username: string
+        }[]
+      }
       void_func: {
         Args: Record<PropertyKey, never>
         Returns: undefined

test/types.generated.ts

@@ -512,6 +512,18 @@ export type Database = {
         }
         Returns: Database['public']['Enums']['user_status']
       }
+      set_users_offline: {
+        Args: {
+          name_param: string
+        }
+        Returns: {
+          age_range: unknown | null
+          catchphrase: unknown | null
+          data: Json | null
+          status: Database['public']['Enums']['user_status'] | null
+          username: string
+        }[]
+      }
       void_func: {
         Args: Record<PropertyKey, never>
         Returns: undefined