@supabase/postgrest-js 0.33.2 → 0.35.0

package/src/lib/PostgrestRpcBuilder.ts

@@ -1,12 +1,16 @@
-import { PostgrestBuilder } from './types'
+import { Fetch, PostgrestBuilder } from './types'
 import PostgrestFilterBuilder from './PostgrestFilterBuilder'
 
 export default class PostgrestRpcBuilder<T> extends PostgrestBuilder<T> {
   constructor(
     url: string,
-    { headers = {}, schema }: { headers?: { [key: string]: string }; schema?: string } = {}
+    {
+      headers = {},
+      schema,
+      fetch,
+    }: { headers?: { [key: string]: string }; schema?: string; fetch?: Fetch } = {}
   ) {
-    super({} as PostgrestBuilder<T>)
+    super(({ fetch } as unknown) as PostgrestBuilder<T>)
     this.url = new URL(url)
     this.headers = { ...headers }
     this.schema = schema
@@ -18,13 +22,25 @@ export default class PostgrestRpcBuilder<T> extends PostgrestBuilder<T> {
   rpc(
     params?: object,
     {
+      head = false,
       count = null,
     }: {
+      head?: boolean
       count?: null | 'exact' | 'planned' | 'estimated'
     } = {}
   ): PostgrestFilterBuilder<T> {
-    this.method = 'POST'
-    this.body = params
+    if (head) {
+      this.method = 'HEAD'
+
+      if (params) {
+        Object.entries(params).forEach(([name, value]) => {
+          this.url.searchParams.append(name, value)
+        })
+      }
+    } else {
+      this.method = 'POST'
+      this.body = params
+    }
 
     if (count) {
       if (this.headers['Prefer'] !== undefined) this.headers['Prefer'] += `,count=${count}`

package/src/lib/PostgrestTransformBuilder.ts

@@ -85,6 +85,14 @@ export default class PostgrestTransformBuilder<T> extends PostgrestBuilder<T> {
     return this
   }
 
+  /**
+   * Sets the AbortSignal for the fetch request.
+   */
+  abortSignal(signal: AbortSignal): this {
+    this.signal = signal
+    return this
+  }
+
   /**
    * Retrieves only one row from the result. Result must be one row (e.g. using
    * `limit`), otherwise this will result in an error.

package/src/lib/constants.ts

@@ -0,0 +1,2 @@
+import { version } from './version'
+export const DEFAULT_HEADERS = { 'X-Client-Info': `postgrest-js/${version}` }

package/src/lib/types.ts

@@ -1,4 +1,6 @@
-import fetch from 'cross-fetch'
+import crossFetch from 'cross-fetch'
+
+export type Fetch = typeof fetch
 
 /**
  * Error format
@@ -54,10 +56,13 @@ export abstract class PostgrestBuilder<T> implements PromiseLike<PostgrestRespon
   protected headers!: { [key: string]: string }
   protected schema?: string
   protected body?: Partial<T> | Partial<T>[]
-  protected shouldThrowOnError?: boolean
+  protected shouldThrowOnError = false
+  protected signal?: AbortSignal
+  protected fetch: Fetch
 
   constructor(builder: PostgrestBuilder<T>) {
     Object.assign(this, builder)
+    this.fetch = builder.fetch || crossFetch
   }
 
   /**
@@ -90,53 +95,69 @@ export abstract class PostgrestBuilder<T> implements PromiseLike<PostgrestRespon
       this.headers['Content-Type'] = 'application/json'
     }
 
-    return fetch(this.url.toString(), {
+    let res = this.fetch(this.url.toString(), {
       method: this.method,
       headers: this.headers,
       body: JSON.stringify(this.body),
-    })
-      .then(async (res) => {
-        let error = null
-        let data = null
-        let count = null
-
-        if (res.ok) {
-          const isReturnMinimal = this.headers['Prefer']?.split(',').includes('return=minimal')
-          if (this.method !== 'HEAD' && !isReturnMinimal) {
-            const text = await res.text()
-            if (!text) {
-              // discard `text`
-            } else if (this.headers['Accept'] === 'text/csv') {
-              data = text
-            } else {
-              data = JSON.parse(text)
-            }
-          }
+      signal: this.signal,
+    }).then(async (res) => {
+      let error = null
+      let data = null
+      let count = null
 
-          const countHeader = this.headers['Prefer']?.match(/count=(exact|planned|estimated)/)
-          const contentRange = res.headers.get('content-range')?.split('/')
-          if (countHeader && contentRange && contentRange.length > 1) {
-            count = parseInt(contentRange[1])
+      if (res.ok) {
+        const isReturnMinimal = this.headers['Prefer']?.split(',').includes('return=minimal')
+        if (this.method !== 'HEAD' && !isReturnMinimal) {
+          const text = await res.text()
+          if (!text) {
+            // discard `text`
+          } else if (this.headers['Accept'] === 'text/csv') {
+            data = text
+          } else {
+            data = JSON.parse(text)
           }
-        } else {
-          error = await res.json()
+        }
 
-          if (error && this.shouldThrowOnError) {
-            throw error
-          }
+        const countHeader = this.headers['Prefer']?.match(/count=(exact|planned|estimated)/)
+        const contentRange = res.headers.get('content-range')?.split('/')
+        if (countHeader && contentRange && contentRange.length > 1) {
+          count = parseInt(contentRange[1])
         }
+      } else {
+        error = await res.json()
 
-        const postgrestResponse: PostgrestResponse<T> = {
-          error,
-          data,
-          count,
-          status: res.status,
-          statusText: res.statusText,
-          body: data,
+        if (error && this.shouldThrowOnError) {
+          throw error
         }
+      }
+
+      const postgrestResponse = {
+        error,
+        data,
+        count,
+        status: res.status,
+        statusText: res.statusText,
+        body: data,
+      }
+
+      return postgrestResponse
+    })
+    if (!this.shouldThrowOnError) {
+      res = res.catch((fetchError) => ({
+        error: {
+          message: `FetchError: ${fetchError.message}`,
+          details: '',
+          hint: '',
+          code: fetchError.code || '',
+        },
+        data: null,
+        body: null,
+        count: null,
+        status: 400,
+        statusText: 'Bad Request',
+      }))
+    }
 
-        return postgrestResponse
-      })
-      .then(onfulfilled, onrejected)
+    return res.then(onfulfilled, onrejected)
   }
 }

package/src/lib/version.ts

@@ -0,0 +1,2 @@
+// generated by genversion
+export const version = '0.35.0'