refactor(postgrest): integrate postgrest-js changes into new monorepo

Author: stenlan

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

@@ -2,6 +2,8 @@ import PostgrestQueryBuilder from './PostgrestQueryBuilder'
 import PostgrestFilterBuilder from './PostgrestFilterBuilder'
 import { Fetch, GenericSchema, ClientServerOptions } from './types/common/common'
 import { GetRpcFunctionFilterBuilderByArgs } from './types/common/rpc'
+import { PostgrestQueryBuilderOptions, PostgrestQueryBuilderOptionsWithSchema } from './types/types'
+import { mergeHeaders } from './utils'
 
 /**
  * PostgREST client.
@@ -18,21 +20,21 @@ export default class PostgrestClient<
   ClientOptions extends ClientServerOptions = Database extends {
     __InternalSupabase: infer I extends ClientServerOptions
   }
-    ? I
-    : {},
+  ? I
+  : {},
   SchemaName extends string &
-    keyof Omit<Database, '__InternalSupabase'> = 'public' extends keyof Omit<
+  keyof Omit<Database, '__InternalSupabase'> = 'public' extends keyof Omit<
     Database,
     '__InternalSupabase'
   >
-    ? 'public'
-    : string & keyof Omit<Database, '__InternalSupabase'>,
+  ? 'public'
+  : string & keyof Omit<Database, '__InternalSupabase'>,
   Schema extends GenericSchema = Omit<
     Database,
     '__InternalSupabase'
   >[SchemaName] extends GenericSchema
-    ? Omit<Database, '__InternalSupabase'>[SchemaName]
-    : any,
+  ? Omit<Database, '__InternalSupabase'>[SchemaName]
+  : any,
 > {
   url: string
   headers: Headers
@@ -55,11 +57,7 @@ export default class PostgrestClient<
       headers = {},
       schema,
       fetch,
-    }: {
-      headers?: HeadersInit
-      schema?: SchemaName
-      fetch?: Fetch
-    } = {}
+    }: PostgrestQueryBuilderOptionsWithSchema<SchemaName> = {}
   ) {
     this.url = url
     this.headers = new Headers(headers)
@@ -69,21 +67,28 @@ export default class PostgrestClient<
   from<
     TableName extends string & keyof Schema['Tables'],
     Table extends Schema['Tables'][TableName],
-  >(relation: TableName): PostgrestQueryBuilder<ClientOptions, Schema, Table, TableName>
+  >(
+    relation: TableName,
+    options?: PostgrestQueryBuilderOptions
+  ): PostgrestQueryBuilder<ClientOptions, Schema, Table, TableName>;
   from<ViewName extends string & keyof Schema['Views'], View extends Schema['Views'][ViewName]>(
-    relation: ViewName
-  ): PostgrestQueryBuilder<ClientOptions, Schema, View, ViewName>
+    relation: ViewName,
+    options?: PostgrestQueryBuilderOptions
+  ): PostgrestQueryBuilder<ClientOptions, Schema, View, ViewName>;
   /**
    * Perform a query on a table or a view.
    *
    * @param relation - The table or view name to query
    */
-  from(relation: string): PostgrestQueryBuilder<ClientOptions, Schema, any, any> {
+  from(
+    relation: string,
+    options?: PostgrestQueryBuilderOptions
+  ): PostgrestQueryBuilder<ClientOptions, Schema, any, any> {
     const url = new URL(`${this.url}/${relation}`)
     return new PostgrestQueryBuilder(url, {
-      headers: new Headers(this.headers),
+      headers: mergeHeaders(this.headers, options?.headers),
       schema: this.schemaName,
-      fetch: this.fetch,
+      fetch: options?.fetch ?? this.fetch,
     })
   }
 

packages/core/postgrest-js/src/PostgrestQueryBuilder.ts

@@ -7,6 +7,7 @@ import {
   GenericTable,
   GenericView,
 } from './types/common/common'
+import { PostgrestQueryBuilderOptionsWithSchema } from './types/types'
 
 export default class PostgrestQueryBuilder<
   ClientOptions extends ClientServerOptions,
@@ -27,11 +28,7 @@ export default class PostgrestQueryBuilder<
       headers = {},
       schema,
       fetch,
-    }: {
-      headers?: HeadersInit
-      schema?: string
-      fetch?: Fetch
-    }
+    }: PostgrestQueryBuilderOptionsWithSchema<string>
   ) {
     this.url = url
     this.headers = new Headers(headers)

packages/core/postgrest-js/src/index.ts

@@ -28,6 +28,8 @@ export type {
   PostgrestResponseSuccess,
   PostgrestSingleResponse,
   PostgrestMaybeSingleResponse,
+  PostgrestQueryBuilderOptions,
+  PostgrestQueryBuilderOptionsWithSchema
 } from './types/types'
 export type { ClientServerOptions as PostgrestClientOptions } from './types/common/common'
 // https://github.com/supabase/postgrest-js/issues/551

packages/core/postgrest-js/src/types/types.ts

@@ -1,7 +1,7 @@
 import PostgrestError from '../PostgrestError'
 import { ContainsNull } from '../select-query-parser/types'
 import { SelectQueryError } from '../select-query-parser/utils'
-import { ClientServerOptions } from './common/common'
+import { ClientServerOptions, Fetch } from './common/common'
 
 /**
  * Response format
@@ -30,6 +30,15 @@ export type PostgrestSingleResponse<T> = PostgrestResponseSuccess<T> | Postgrest
 export type PostgrestMaybeSingleResponse<T> = PostgrestSingleResponse<T | null>
 export type PostgrestResponse<T> = PostgrestSingleResponse<T[]>
 
+export type PostgrestQueryBuilderOptions = {
+  headers?: HeadersInit
+  fetch?: Fetch
+}
+
+export type PostgrestQueryBuilderOptionsWithSchema<TSchema extends string> = PostgrestQueryBuilderOptions & {
+  schema?: TSchema
+}
+
 export type DatabaseWithOptions<Database, Options extends ClientServerOptions> = {
   db: Database
   options: Options

packages/core/postgrest-js/src/utils.ts

@@ -0,0 +1,23 @@
+/**
+ * Non-destructively merges an optional {@link HeadersInit} into a {@link Headers} object, where {@link right} takes precedence over {@link left} if it exists.
+ * @param {Headers} left Base {@link Headers} object
+ * @param {HeadersInit?} right Optional {@link HeadersInit} to merge into {@link left}
+ * @returns The resulting merged {@link HeadersInit} object.
+ */
+
+export function mergeHeaders(left: Headers, right?: HeadersInit): HeadersInit {
+  if (!right) return new Headers(left)
+
+  const merged = new Headers(left)
+  const rightEntries =
+    right instanceof Headers
+      ? right.entries()
+      : Array.isArray(right)
+      ? right
+      : Object.entries(right)
+  for (const [key, value] of rightEntries) {
+    merged.set(key, value)
+  }
+
+  return merged
+}