chore: refactor in favor of Headers API

Author: avallete

src/PostgrestBuilder.ts

@@ -24,23 +24,33 @@ export default abstract class PostgrestBuilder<
 {
   protected method: 'GET' | 'HEAD' | 'POST' | 'PATCH' | 'DELETE'
   protected url: URL
-  protected headers: Record<string, string>
+  protected headers: Headers
   protected schema?: string
   protected body?: unknown
   protected shouldThrowOnError = false
   protected signal?: AbortSignal
   protected fetch: Fetch
   protected isMaybeSingle: boolean
 
-  constructor(builder: PostgrestBuilder<ClientOptions, Result>) {
+  constructor(builder: {
+    method: 'GET' | 'HEAD' | 'POST' | 'PATCH' | 'DELETE'
+    url: URL
+    headers: HeadersInit
+    schema?: string
+    body?: unknown
+    shouldThrowOnError?: boolean
+    signal?: AbortSignal
+    fetch?: Fetch
+    isMaybeSingle?: boolean
+  }) {
     this.method = builder.method
     this.url = builder.url
-    this.headers = builder.headers
+    this.headers = new Headers(builder.headers)
     this.schema = builder.schema
     this.body = builder.body
-    this.shouldThrowOnError = builder.shouldThrowOnError
+    this.shouldThrowOnError = builder.shouldThrowOnError ?? false
     this.signal = builder.signal
-    this.isMaybeSingle = builder.isMaybeSingle
+    this.isMaybeSingle = builder.isMaybeSingle ?? false
 
     if (builder.fetch) {
       this.fetch = builder.fetch
@@ -66,8 +76,8 @@ export default abstract class PostgrestBuilder<
    * Set an HTTP header for the request.
    */
   setHeader(name: string, value: string): this {
-    this.headers = { ...this.headers }
-    this.headers[name] = value
+    this.headers = new Headers(this.headers)
+    this.headers.set(name, value)
     return this
   }
 
@@ -91,12 +101,12 @@ export default abstract class PostgrestBuilder<
     if (this.schema === undefined) {
       // skip
     } else if (['GET', 'HEAD'].includes(this.method)) {
-      this.headers['Accept-Profile'] = this.schema
+      this.headers.set('Accept-Profile', this.schema)
     } else {
-      this.headers['Content-Profile'] = this.schema
+      this.headers.set('Content-Profile', this.schema)
     }
     if (this.method !== 'GET' && this.method !== 'HEAD') {
-      this.headers['Content-Type'] = 'application/json'
+      this.headers.set('Content-Type', 'application/json')
     }
 
     // NOTE: Invoke w/o `this` to avoid illegal invocation error.
@@ -119,19 +129,19 @@ export default abstract class PostgrestBuilder<
           const body = await res.text()
           if (body === '') {
             // Prefer: return=minimal
-          } else if (this.headers['Accept'] === 'text/csv') {
+          } else if (this.headers.get('Accept') === 'text/csv') {
             data = body
           } else if (
-            this.headers['Accept'] &&
-            this.headers['Accept'].includes('application/vnd.pgrst.plan+text')
+            this.headers.get('Accept') &&
+            this.headers.get('Accept')?.includes('application/vnd.pgrst.plan+text')
           ) {
             data = body
           } else {
             data = JSON.parse(body)
           }
         }
 
-        const countHeader = this.headers['Prefer']?.match(/count=(exact|planned|estimated)/)
+        const countHeader = this.headers.get('Prefer')?.match(/count=(exact|planned|estimated)/)
         const contentRange = res.headers.get('content-range')?.split('/')
         if (countHeader && contentRange && contentRange.length > 1) {
           count = parseInt(contentRange[1])

src/PostgrestClient.ts

@@ -1,7 +1,5 @@
 import PostgrestQueryBuilder from './PostgrestQueryBuilder'
 import PostgrestFilterBuilder from './PostgrestFilterBuilder'
-import PostgrestBuilder from './PostgrestBuilder'
-import { DEFAULT_HEADERS } from './constants'
 import { Fetch, GenericSchema, ClientServerOptions, GetGenericDatabaseWithOptions } from './types'
 
 /**
@@ -29,7 +27,7 @@ export default class PostgrestClient<
     : any
 > {
   url: string
-  headers: Record<string, string>
+  headers: Headers
   schemaName?: SchemaName
   fetch?: Fetch
 
@@ -50,17 +48,16 @@ export default class PostgrestClient<
       schema,
       fetch,
     }: {
-      headers?: Record<string, string>
+      headers?: HeadersInit
       schema?: SchemaName
       fetch?: Fetch
     } = {}
   ) {
     this.url = url
-    this.headers = { ...DEFAULT_HEADERS, ...headers }
+    this.headers = new Headers(headers)
     this.schemaName = schema
     this.fetch = fetch
   }
-
   from<
     TableName extends string & keyof Schema['Tables'],
     Table extends Schema['Tables'][TableName]
@@ -76,7 +73,7 @@ export default class PostgrestClient<
   from(relation: string): PostgrestQueryBuilder<ClientOptions, Schema, any, any> {
     const url = new URL(`${this.url}/${relation}`)
     return new PostgrestQueryBuilder(url, {
-      headers: { ...this.headers },
+      headers: new Headers(this.headers),
       schema: this.schemaName,
       fetch: this.fetch,
     })
@@ -170,9 +167,9 @@ export default class PostgrestClient<
       body = args
     }
 
-    const headers = { ...this.headers }
+    const headers = new Headers(this.headers)
     if (count) {
-      headers['Prefer'] = `count=${count}`
+      headers.set('Prefer', `count=${count}`)
     }
 
     return new PostgrestFilterBuilder({
@@ -181,8 +178,7 @@ export default class PostgrestClient<
       headers,
       schema: this.schemaName,
       body,
-      fetch: this.fetch,
-      allowEmpty: false,
-    } as unknown as PostgrestBuilder<ClientOptions, Fn['Returns']>)
+      fetch: this.fetch ?? fetch,
+    })
   }
 }

src/PostgrestFilterBuilder.ts

@@ -1,7 +1,6 @@
 import PostgrestTransformBuilder from './PostgrestTransformBuilder'
 import { JsonPathToAccessor, JsonPathToType } from './select-query-parser/utils'
 import { ClientServerOptions, GenericSchema } from './types'
-import { HeaderManager } from './utils'
 
 type FilterOperator =
   | 'eq'
@@ -616,10 +615,8 @@ export default class PostgrestFilterBuilder<
       ? 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()
+    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'
         ? this

src/PostgrestQueryBuilder.ts

@@ -1,4 +1,3 @@
-import PostgrestBuilder from './PostgrestBuilder'
 import PostgrestFilterBuilder from './PostgrestFilterBuilder'
 import { GetResult } from './select-query-parser/result'
 import { ClientServerOptions, Fetch, GenericSchema, GenericTable, GenericView } from './types'
@@ -11,7 +10,7 @@ export default class PostgrestQueryBuilder<
   Relationships = Relation extends { Relationships: infer R } ? R : unknown
 > {
   url: URL
-  headers: Record<string, string>
+  headers: Headers
   schema?: string
   signal?: AbortSignal
   fetch?: Fetch
@@ -23,13 +22,13 @@ export default class PostgrestQueryBuilder<
       schema,
       fetch,
     }: {
-      headers?: Record<string, string>
+      headers?: HeadersInit
       schema?: string
       fetch?: Fetch
     }
   ) {
     this.url = url
-    this.headers = headers
+    this.headers = new Headers(headers)
     this.schema = schema
     this.fetch = fetch
   }
@@ -99,8 +98,9 @@ export default class PostgrestQueryBuilder<
       })
       .join('')
     this.url.searchParams.set('select', cleanedColumns)
+
     if (count) {
-      this.headers['Prefer'] = `count=${count}`
+      this.headers.append('Prefer', `count=${count}`)
     }
 
     return new PostgrestFilterBuilder({
@@ -109,8 +109,7 @@ export default class PostgrestQueryBuilder<
       headers: this.headers,
       schema: this.schema,
       fetch: this.fetch,
-      allowEmpty: false,
-    } as unknown as PostgrestBuilder<ClientOptions, ResultOne[]>)
+    })
   }
 
   // TODO(v3): Make `defaultToNull` consistent for both single & bulk inserts.
@@ -189,17 +188,12 @@ export default class PostgrestQueryBuilder<
   > {
     const method = 'POST'
 
-    const prefersHeaders = []
-    if (this.headers['Prefer']) {
-      prefersHeaders.push(this.headers['Prefer'])
-    }
     if (count) {
-      prefersHeaders.push(`count=${count}`)
+      this.headers.append('Prefer', `count=${count}`)
     }
     if (!defaultToNull) {
-      prefersHeaders.push('missing=default')
+      this.headers.append('Prefer', `missing=default`)
     }
-    this.headers['Prefer'] = prefersHeaders.join(',')
 
     if (Array.isArray(values)) {
       const columns = values.reduce((acc, x) => acc.concat(Object.keys(x)), [] as string[])
@@ -215,9 +209,8 @@ export default class PostgrestQueryBuilder<
       headers: this.headers,
       schema: this.schema,
       body: values,
-      fetch: this.fetch,
-      allowEmpty: false,
-    } as unknown as PostgrestBuilder<ClientOptions, null>)
+      fetch: this.fetch ?? fetch,
+    })
   }
 
   // TODO(v3): Make `defaultToNull` consistent for both single & bulk upserts.
@@ -316,19 +309,15 @@ export default class PostgrestQueryBuilder<
   > {
     const method = 'POST'
 
-    const prefersHeaders = [`resolution=${ignoreDuplicates ? 'ignore' : 'merge'}-duplicates`]
+    this.headers.append('Prefer', `resolution=${ignoreDuplicates ? 'ignore' : 'merge'}-duplicates`)
 
     if (onConflict !== undefined) this.url.searchParams.set('on_conflict', onConflict)
-    if (this.headers['Prefer']) {
-      prefersHeaders.push(this.headers['Prefer'])
-    }
     if (count) {
-      prefersHeaders.push(`count=${count}`)
+      this.headers.append('Prefer', `count=${count}`)
     }
     if (!defaultToNull) {
-      prefersHeaders.push('missing=default')
+      this.headers.append('Prefer', 'missing=default')
     }
-    this.headers['Prefer'] = prefersHeaders.join(',')
 
     if (Array.isArray(values)) {
       const columns = values.reduce((acc, x) => acc.concat(Object.keys(x)), [] as string[])
@@ -344,9 +333,8 @@ export default class PostgrestQueryBuilder<
       headers: this.headers,
       schema: this.schema,
       body: values,
-      fetch: this.fetch,
-      allowEmpty: false,
-    } as unknown as PostgrestBuilder<ClientOptions, null>)
+      fetch: this.fetch ?? fetch,
+    })
   }
 
   /**
@@ -387,24 +375,18 @@ export default class PostgrestQueryBuilder<
     'PATCH'
   > {
     const method = 'PATCH'
-    const prefersHeaders = []
-    if (this.headers['Prefer']) {
-      prefersHeaders.push(this.headers['Prefer'])
-    }
     if (count) {
-      prefersHeaders.push(`count=${count}`)
+      this.headers.append('Prefer', `count=${count}`)
     }
-    this.headers['Prefer'] = prefersHeaders.join(',')
 
     return new PostgrestFilterBuilder({
       method,
       url: this.url,
       headers: this.headers,
       schema: this.schema,
       body: values,
-      fetch: this.fetch,
-      allowEmpty: false,
-    } as unknown as PostgrestBuilder<ClientOptions, null>)
+      fetch: this.fetch ?? fetch,
+    })
   }
 
   /**
@@ -440,22 +422,16 @@ export default class PostgrestQueryBuilder<
     'DELETE'
   > {
     const method = 'DELETE'
-    const prefersHeaders = []
     if (count) {
-      prefersHeaders.push(`count=${count}`)
+      this.headers.append('Prefer', `count=${count}`)
     }
-    if (this.headers['Prefer']) {
-      prefersHeaders.unshift(this.headers['Prefer'])
-    }
-    this.headers['Prefer'] = prefersHeaders.join(',')
 
     return new PostgrestFilterBuilder({
       method,
       url: this.url,
       headers: this.headers,
       schema: this.schema,
-      fetch: this.fetch,
-      allowEmpty: false,
-    } as unknown as PostgrestBuilder<ClientOptions, null>)
+      fetch: this.fetch ?? fetch,
+    })
   }
 }