feat: add max-affected method

Author: avallete

src/PostgrestFilterBuilder.ts

@@ -89,19 +89,6 @@ export default class PostgrestFilterBuilder<
   Relationships,
   Method
 > {
-  maxAffected(
-    value: number
-  ): Method extends 'PATCH' | 'DELETE'
-    ? this
-    : InvalidMethodError<'maxAffected method only available on update or delete'> {
-    const preferHeaderManager = new HeaderManager('Prefer', this.headers['Prefer'])
-    preferHeaderManager.add('handling=strict')
-    preferHeaderManager.add(`max-affected=${value}`)
-    this.headers['Prefer'] = preferHeaderManager.get()
-    return this as unknown as Method extends 'PATCH' | 'DELETE'
-      ? this
-      : InvalidMethodError<'maxAffected method only available on update or delete'>
-  }
   /**
    * Match only rows where `column` is equal to `value`.
    *
@@ -615,4 +602,28 @@ export default class PostgrestFilterBuilder<
     this.url.searchParams.append(column, `${operator}.${value}`)
     return this
   }
+
+  /**
+   * Set the maximum number of rows that can be affected by the query.
+   * Only available in PostgREST v13+ and only works with PATCH and DELETE methods.
+   *
+   * @param value - The maximum number of rows that can be affected
+   */
+  maxAffected(
+    value: number
+  ): ClientOptions['postgrestVersion'] extends 13
+    ? Method extends 'PATCH' | 'DELETE'
+      ? this
+      : InvalidMethodError<'maxAffected method only available on update or delete'>
+    : InvalidMethodError<'maxAffected method only available on postgrest 13+'> {
+    const preferHeaderManager = new HeaderManager('Prefer', this.headers['Prefer'])
+    preferHeaderManager.add('handling=strict')
+    preferHeaderManager.add(`max-affected=${value}`)
+    this.headers['Prefer'] = preferHeaderManager.get()
+    return this as unknown as ClientOptions['postgrestVersion'] extends 13
+      ? Method extends 'PATCH' | 'DELETE'
+        ? this
+        : InvalidMethodError<'maxAffected method only available on update or delete'>
+      : InvalidMethodError<'maxAffected method only available on postgrest 13+'>
+  }
 }

test/index.test.ts

@@ -5,4 +5,4 @@ import './resource-embedding'
 import './transforms'
 import './rpc'
 import './utils'
-// import './max-affected'
+import './max-affected'

test/max-affected.ts

@@ -4,11 +4,20 @@ import { expectType } from 'tsd'
 import { InvalidMethodError } from '../src/PostgrestFilterBuilder'
 
 const REST_URL_13 = 'http://localhost:3001'
-const postgrest13 = new PostgrestClient<Database>(REST_URL_13)
+const postgrest13 = new PostgrestClient<Database, { postgrestVersion: 13 }>(REST_URL_13)
+const postgrest12 = new PostgrestClient<Database>(REST_URL_13)
 
 describe('maxAffected', () => {
   // Type checking tests
-  test('maxAffected should show warning on non update / delete', async () => {
+  test('maxAffected should show type warning on postgrest 12 clients', async () => {
+    const resUpdate = await postgrest12
+      .from('messages')
+      .update({ channel_id: 2 })
+      .eq('message', 'foo')
+      .maxAffected(1)
+    expectType<InvalidMethodError<'maxAffected method only available on postgrest 13+'>>(resUpdate)
+  })
+  test('maxAffected should show type warning on non update / delete', async () => {
     const resSelect = await postgrest13.from('messages').select('*').maxAffected(10)
     const resInsert = await postgrest13
       .from('messages')

test/relationships.ts

@@ -1762,15 +1762,18 @@ test('select spread on many relation postgrest13', async () => {
   expect(res).toMatchInlineSnapshot(`
     Object {
       "count": null,
-      "data": null,
-      "error": Object {
-        "code": "PGRST119",
-        "details": "'channels' and 'messages' do not form a many-to-one or one-to-one relationship",
-        "hint": null,
-        "message": "A spread operation on 'messages' is not possible",
+      "data": Object {
+        "channel_id": 1,
+        "id": Array [
+          1,
+        ],
+        "message": Array [
+          "Hello World 👋",
+        ],
       },
-      "status": 400,
-      "statusText": "Bad Request",
+      "error": null,
+      "status": 200,
+      "statusText": "OK",
     }
   `)
 })

test/returns.test-d.ts

@@ -53,6 +53,7 @@ const postgrest = new PostgrestClient<Database>(REST_URL)
     .returns<{ username: string }[]>()
   expectType<
     PostgrestBuilder<
+      { postgrestVersion: 12 },
       {
         Error: 'Type mismatch: Cannot cast single object to array type. Remove Array wrapper from return type or make sure you are not using .single() up in the calling chain'
       },

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

@@ -15,7 +15,8 @@ type SelectQueryFromTableResult<
   Database['public']['Tables'][TableName]['Row'],
   TableName,
   Database['public']['Tables'][TableName]['Relationships'],
-  Q
+  Q,
+  { postgrestVersion: 12 }
 >
 
 // This test file is here to help develop, debug and maintain the GetResult
@@ -130,7 +131,8 @@ type SelectQueryFromTableResult<
     Database['personal']['Tables'][TableName]['Row'],
     TableName,
     Database['personal']['Tables'][TableName]['Relationships'],
-    Q
+    Q,
+    { postgrestVersion: 12 }
   >
   // Should work with Json object accessor
   {