feat(types): add ClientOptions to handle multi postgrest versions

Author: avallete

src/PostgrestBuilder.ts

@@ -8,12 +8,16 @@ import type {
   CheckMatchingArrayTypes,
   MergePartialResult,
   IsValidResultOverride,
+  ClientServerOptions,
 } from './types'
 import PostgrestError from './PostgrestError'
 import { ContainsNull } from './select-query-parser/types'
 
-export default abstract class PostgrestBuilder<Result, ThrowOnError extends boolean = false>
-  implements
+export default abstract class PostgrestBuilder<
+  ClientOptions extends ClientServerOptions,
+  Result,
+  ThrowOnError extends boolean = false
+> implements
     PromiseLike<
       ThrowOnError extends true ? PostgrestResponseSuccess<Result> : PostgrestSingleResponse<Result>
     >
@@ -28,7 +32,7 @@ export default abstract class PostgrestBuilder<Result, ThrowOnError extends bool
   protected fetch: Fetch
   protected isMaybeSingle: boolean
 
-  constructor(builder: PostgrestBuilder<Result>) {
+  constructor(builder: PostgrestBuilder<ClientOptions, Result>) {
     this.method = builder.method
     this.url = builder.url
     this.headers = builder.headers
@@ -53,9 +57,9 @@ export default abstract class PostgrestBuilder<Result, ThrowOnError extends bool
    *
    * {@link https://github.com/supabase/supabase-js/issues/92}
    */
-  throwOnError(): this & PostgrestBuilder<Result, true> {
+  throwOnError(): this & PostgrestBuilder<ClientOptions, Result, true> {
     this.shouldThrowOnError = true
-    return this as this & PostgrestBuilder<Result, true>
+    return this as this & PostgrestBuilder<ClientOptions, Result, true>
   }
 
   /**
@@ -224,9 +228,14 @@ export default abstract class PostgrestBuilder<Result, ThrowOnError extends bool
    * @typeParam NewResult - The new result type to override with
    * @deprecated Use overrideTypes<yourType, { merge: false }>() method at the end of your call chain instead
    */
-  returns<NewResult>(): PostgrestBuilder<CheckMatchingArrayTypes<Result, NewResult>, ThrowOnError> {
+  returns<NewResult>(): PostgrestBuilder<
+    ClientOptions,
+    CheckMatchingArrayTypes<Result, NewResult>,
+    ThrowOnError
+  > {
     /* istanbul ignore next */
     return this as unknown as PostgrestBuilder<
+      ClientOptions,
       CheckMatchingArrayTypes<Result, NewResult>,
       ThrowOnError
     >
@@ -258,6 +267,7 @@ export default abstract class PostgrestBuilder<Result, ThrowOnError extends bool
     NewResult,
     Options extends { merge?: boolean } = { merge: true }
   >(): PostgrestBuilder<
+    ClientOptions,
     IsValidResultOverride<Result, NewResult, false, false> extends true
       ? // Preserve the optionality of the result if the overriden type is an object (case of chaining with `maybeSingle`)
         ContainsNull<Result> extends true
@@ -267,6 +277,7 @@ export default abstract class PostgrestBuilder<Result, ThrowOnError extends bool
     ThrowOnError
   > {
     return this as unknown as PostgrestBuilder<
+      ClientOptions,
       IsValidResultOverride<Result, NewResult, false, false> extends true
         ? // Preserve the optionality of the result if the overriden type is an object (case of chaining with `maybeSingle`)
           ContainsNull<Result> extends true

src/PostgrestClient.ts

@@ -2,7 +2,7 @@ import PostgrestQueryBuilder from './PostgrestQueryBuilder'
 import PostgrestFilterBuilder from './PostgrestFilterBuilder'
 import PostgrestBuilder from './PostgrestBuilder'
 import { DEFAULT_HEADERS } from './constants'
-import { Fetch, GenericSchema } from './types'
+import { Fetch, GenericSchema, ClientServerOptions } from './types'
 
 /**
  * PostgREST client.
@@ -16,6 +16,7 @@ import { Fetch, GenericSchema } from './types'
  */
 export default class PostgrestClient<
   Database = any,
+  ClientOptions extends ClientServerOptions = { postgrestVersion: 12 },
   SchemaName extends string & keyof Database = 'public' extends keyof Database
     ? 'public'
     : string & keyof Database,
@@ -59,16 +60,16 @@ export default class PostgrestClient<
   from<
     TableName extends string & keyof Schema['Tables'],
     Table extends Schema['Tables'][TableName]
-  >(relation: TableName): PostgrestQueryBuilder<Schema, Table, TableName>
+  >(relation: TableName): PostgrestQueryBuilder<ClientOptions, Schema, Table, TableName>
   from<ViewName extends string & keyof Schema['Views'], View extends Schema['Views'][ViewName]>(
     relation: ViewName
-  ): PostgrestQueryBuilder<Schema, View, ViewName>
+  ): 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<Schema, any, any> {
+  from(relation: string): PostgrestQueryBuilder<ClientOptions, Schema, any, any> {
     const url = new URL(`${this.url}/${relation}`)
     return new PostgrestQueryBuilder(url, {
       headers: { ...this.headers },
@@ -88,6 +89,7 @@ export default class PostgrestClient<
     schema: DynamicSchema
   ): PostgrestClient<
     Database,
+    ClientOptions,
     DynamicSchema,
     Database[DynamicSchema] extends GenericSchema ? Database[DynamicSchema] : any
   > {
@@ -134,6 +136,7 @@ export default class PostgrestClient<
       count?: 'exact' | 'planned' | 'estimated'
     } = {}
   ): PostgrestFilterBuilder<
+    ClientOptions,
     Schema,
     Fn['Returns'] extends any[]
       ? Fn['Returns'][number] extends Record<string, unknown>
@@ -176,6 +179,6 @@ export default class PostgrestClient<
       body,
       fetch: this.fetch,
       allowEmpty: false,
-    } as unknown as PostgrestBuilder<Fn['Returns']>)
+    } as unknown as PostgrestBuilder<ClientOptions, Fn['Returns']>)
   }
 }

src/PostgrestFilterBuilder.ts

@@ -1,6 +1,6 @@
 import PostgrestTransformBuilder from './PostgrestTransformBuilder'
 import { JsonPathToAccessor, JsonPathToType } from './select-query-parser/utils'
-import { GenericSchema } from './types'
+import { ClientServerOptions, GenericSchema } from './types'
 import { HeaderManager } from './utils'
 
 type FilterOperator =
@@ -73,13 +73,22 @@ type ResolveFilterRelationshipValue<
 export type InvalidMethodError<S extends string> = { Error: S }
 
 export default class PostgrestFilterBuilder<
+  ClientOptions extends ClientServerOptions,
   Schema extends GenericSchema,
   Row extends Record<string, unknown>,
   Result,
   RelationName = unknown,
   Relationships = unknown,
   Method = unknown
-> extends PostgrestTransformBuilder<Schema, Row, Result, RelationName, Relationships, Method> {
+> extends PostgrestTransformBuilder<
+  ClientOptions,
+  Schema,
+  Row,
+  Result,
+  RelationName,
+  Relationships,
+  Method
+> {
   maxAffected(
     value: number
   ): Method extends 'PATCH' | 'DELETE'

src/PostgrestQueryBuilder.ts

@@ -1,9 +1,10 @@
 import PostgrestBuilder from './PostgrestBuilder'
 import PostgrestFilterBuilder from './PostgrestFilterBuilder'
 import { GetResult } from './select-query-parser/result'
-import { Fetch, GenericSchema, GenericTable, GenericView } from './types'
+import { ClientServerOptions, Fetch, GenericSchema, GenericTable, GenericView } from './types'
 
 export default class PostgrestQueryBuilder<
+  ClientOptions extends ClientServerOptions,
   Schema extends GenericSchema,
   Relation extends GenericTable | GenericView,
   RelationName = unknown,
@@ -56,7 +57,14 @@ export default class PostgrestQueryBuilder<
    */
   select<
     Query extends string = '*',
-    ResultOne = GetResult<Schema, Relation['Row'], RelationName, Relationships, Query>
+    ResultOne = GetResult<
+      Schema,
+      Relation['Row'],
+      RelationName,
+      Relationships,
+      Query,
+      ClientOptions
+    >
   >(
     columns?: Query,
     {
@@ -67,6 +75,7 @@ export default class PostgrestQueryBuilder<
       count?: 'exact' | 'planned' | 'estimated'
     } = {}
   ): PostgrestFilterBuilder<
+    ClientOptions,
     Schema,
     Relation['Row'],
     ResultOne[],
@@ -101,7 +110,7 @@ export default class PostgrestQueryBuilder<
       schema: this.schema,
       fetch: this.fetch,
       allowEmpty: false,
-    } as unknown as PostgrestBuilder<ResultOne[]>)
+    } as unknown as PostgrestBuilder<ClientOptions, ResultOne[]>)
   }
 
   // TODO(v3): Make `defaultToNull` consistent for both single & bulk inserts.
@@ -110,14 +119,30 @@ export default class PostgrestQueryBuilder<
     options?: {
       count?: 'exact' | 'planned' | 'estimated'
     }
-  ): PostgrestFilterBuilder<Schema, Relation['Row'], null, RelationName, Relationships, 'POST'>
+  ): PostgrestFilterBuilder<
+    ClientOptions,
+    Schema,
+    Relation['Row'],
+    null,
+    RelationName,
+    Relationships,
+    'POST'
+  >
   insert<Row extends Relation extends { Insert: unknown } ? Relation['Insert'] : never>(
     values: Row[],
     options?: {
       count?: 'exact' | 'planned' | 'estimated'
       defaultToNull?: boolean
     }
-  ): PostgrestFilterBuilder<Schema, Relation['Row'], null, RelationName, Relationships, 'POST'>
+  ): PostgrestFilterBuilder<
+    ClientOptions,
+    Schema,
+    Relation['Row'],
+    null,
+    RelationName,
+    Relationships,
+    'POST'
+  >
   /**
    * Perform an INSERT into the table or view.
    *
@@ -153,7 +178,15 @@ export default class PostgrestQueryBuilder<
       count?: 'exact' | 'planned' | 'estimated'
       defaultToNull?: boolean
     } = {}
-  ): PostgrestFilterBuilder<Schema, Relation['Row'], null, RelationName, Relationships, 'POST'> {
+  ): PostgrestFilterBuilder<
+    ClientOptions,
+    Schema,
+    Relation['Row'],
+    null,
+    RelationName,
+    Relationships,
+    'POST'
+  > {
     const method = 'POST'
 
     const prefersHeaders = []
@@ -184,7 +217,7 @@ export default class PostgrestQueryBuilder<
       body: values,
       fetch: this.fetch,
       allowEmpty: false,
-    } as unknown as PostgrestBuilder<null>)
+    } as unknown as PostgrestBuilder<ClientOptions, null>)
   }
 
   // TODO(v3): Make `defaultToNull` consistent for both single & bulk upserts.
@@ -195,7 +228,15 @@ export default class PostgrestQueryBuilder<
       ignoreDuplicates?: boolean
       count?: 'exact' | 'planned' | 'estimated'
     }
-  ): PostgrestFilterBuilder<Schema, Relation['Row'], null, RelationName, Relationships, 'POST'>
+  ): PostgrestFilterBuilder<
+    ClientOptions,
+    Schema,
+    Relation['Row'],
+    null,
+    RelationName,
+    Relationships,
+    'POST'
+  >
   upsert<Row extends Relation extends { Insert: unknown } ? Relation['Insert'] : never>(
     values: Row[],
     options?: {
@@ -204,7 +245,15 @@ export default class PostgrestQueryBuilder<
       count?: 'exact' | 'planned' | 'estimated'
       defaultToNull?: boolean
     }
-  ): PostgrestFilterBuilder<Schema, Relation['Row'], null, RelationName, Relationships, 'POST'>
+  ): PostgrestFilterBuilder<
+    ClientOptions,
+    Schema,
+    Relation['Row'],
+    null,
+    RelationName,
+    Relationships,
+    'POST'
+  >
   /**
    * Perform an UPSERT on the table or view. Depending on the column(s) passed
    * to `onConflict`, `.upsert()` allows you to perform the equivalent of
@@ -256,7 +305,15 @@ export default class PostgrestQueryBuilder<
       count?: 'exact' | 'planned' | 'estimated'
       defaultToNull?: boolean
     } = {}
-  ): PostgrestFilterBuilder<Schema, Relation['Row'], null, RelationName, Relationships, 'POST'> {
+  ): PostgrestFilterBuilder<
+    ClientOptions,
+    Schema,
+    Relation['Row'],
+    null,
+    RelationName,
+    Relationships,
+    'POST'
+  > {
     const method = 'POST'
 
     const prefersHeaders = [`resolution=${ignoreDuplicates ? 'ignore' : 'merge'}-duplicates`]
@@ -289,7 +346,7 @@ export default class PostgrestQueryBuilder<
       body: values,
       fetch: this.fetch,
       allowEmpty: false,
-    } as unknown as PostgrestBuilder<null>)
+    } as unknown as PostgrestBuilder<ClientOptions, null>)
   }
 
   /**
@@ -320,7 +377,15 @@ export default class PostgrestQueryBuilder<
     }: {
       count?: 'exact' | 'planned' | 'estimated'
     } = {}
-  ): PostgrestFilterBuilder<Schema, Relation['Row'], null, RelationName, Relationships, 'PATCH'> {
+  ): PostgrestFilterBuilder<
+    ClientOptions,
+    Schema,
+    Relation['Row'],
+    null,
+    RelationName,
+    Relationships,
+    'PATCH'
+  > {
     const method = 'PATCH'
     const prefersHeaders = []
     if (this.headers['Prefer']) {
@@ -339,7 +404,7 @@ export default class PostgrestQueryBuilder<
       body: values,
       fetch: this.fetch,
       allowEmpty: false,
-    } as unknown as PostgrestBuilder<null>)
+    } as unknown as PostgrestBuilder<ClientOptions, null>)
   }
 
   /**
@@ -366,6 +431,7 @@ export default class PostgrestQueryBuilder<
   }: {
     count?: 'exact' | 'planned' | 'estimated'
   } = {}): PostgrestFilterBuilder<
+    ClientOptions,
     Schema,
     Relation['Row'],
     null,
@@ -390,6 +456,6 @@ export default class PostgrestQueryBuilder<
       schema: this.schema,
       fetch: this.fetch,
       allowEmpty: false,
-    } as unknown as PostgrestBuilder<null>)
+    } as unknown as PostgrestBuilder<ClientOptions, null>)
   }
 }