Merge branch 'avallete/psql-436-feedback-request-postgrest-js-and-postgrest-v13-integration' into avallete/psql-372-postgrest-add-maxaffected-in-client-libraries

Author: avallete

src/PostgrestClient.ts

@@ -16,7 +16,7 @@ export default class PostgrestClient<
   Database = any,
   ClientOptions extends ClientServerOptions = GetGenericDatabaseWithOptions<
     Database,
-    { postgrestVersion: 12 }
+    { postgrestVersion: '12' }
   >['options'],
   SchemaName extends string &
     keyof GetGenericDatabaseWithOptions<Database>['db'] = 'public' extends keyof GetGenericDatabaseWithOptions<Database>['db']

src/index.ts

@@ -29,7 +29,6 @@ export type {
   PostgrestSingleResponse,
   PostgrestMaybeSingleResponse,
   ClientServerOptions,
-  PostgRESTVersion,
 } from './types'
 // https://github.com/supabase/postgrest-js/issues/551
 // To be replaced with a helper type that only uses public types

src/select-query-parser/result.ts

@@ -21,6 +21,9 @@ import {
   SelectQueryError,
 } from './utils'
 
+export type SpreadOnManyEnabled<postgrestVersion extends string | undefined> =
+  postgrestVersion extends `13${string}` ? true : false
+
 /**
  * Main entry point for constructing the result type of a PostgREST query.
  *
@@ -445,7 +448,7 @@ type ProcessSpreadNode<
   ? Result extends SelectQueryError<infer E>
     ? SelectQueryError<E>
     : ExtractFirstProperty<Result> extends unknown[]
-    ? ClientOptions['postgrestVersion'] extends 13 // Spread over an many-to-many relationship, turn all the result fields into correlated arrays
+    ? SpreadOnManyEnabled<ClientOptions['postgrestVersion']> extends true // Spread over an many-to-many relationship, turn all the result fields into correlated arrays
       ? ProcessManyToManySpreadNodeResult<Result>
       : {
           [K in Spread['target']['name']]: SelectQueryError<`"${RelationName}" and "${Spread['target']['name']}" do not form a many-to-one or one-to-one relationship spread not possible`>

src/types.ts

@@ -71,9 +71,8 @@ export type GenericSchema = {
   Functions: Record<string, GenericFunction>
 }
 
-export type PostgRESTVersion = 12 | 13
 export type ClientServerOptions = {
-  postgrestVersion?: PostgRESTVersion
+  postgrestVersion?: string
 }
 
 export type DatabaseWithOptions<Database, Options extends ClientServerOptions> = {
@@ -85,7 +84,7 @@ const INTERNAL_SUPABASE_OPTIONS = '__internal_supabase'
 
 export type GetGenericDatabaseWithOptions<
   Database,
-  Opts extends ClientServerOptions = { postgrestVersion: 12 }
+  Opts extends ClientServerOptions = { postgrestVersion: '12' }
 > = IsAny<Database> extends true
   ? DatabaseWithOptions<Database, Opts>
   : typeof INTERNAL_SUPABASE_OPTIONS extends keyof Database

test/basic.ts

@@ -319,9 +319,12 @@ describe('custom prefer headers with ', () => {
 })
 
 test('switch schema', async () => {
-  const postgrest = new PostgrestClient<Database, { postgrestVersion: 12 }, 'personal'>(REST_URL, {
-    schema: 'personal',
-  })
+  const postgrest = new PostgrestClient<Database, { postgrestVersion: '12' }, 'personal'>(
+    REST_URL,
+    {
+      schema: 'personal',
+    }
+  )
   const res = await postgrest.from('users').select()
   expect(res).toMatchInlineSnapshot(`
     Object {

test/relationships.ts

@@ -5,7 +5,7 @@ import { Database as DatabaseWithOptions13 } from './types.override-with-options
 const REST_URL = 'http://localhost:3000'
 export const postgrest = new PostgrestClient<Database>(REST_URL)
 const REST_URL_13 = 'http://localhost:3001'
-const postgrest13 = new PostgrestClient<Database, { postgrestVersion: 13 }>(REST_URL_13)
+const postgrest13 = new PostgrestClient<Database, { postgrestVersion: '13' }>(REST_URL_13)
 const postgrest13FromDatabaseTypes = new PostgrestClient<DatabaseWithOptions13>(REST_URL_13)
 
 const userColumn: 'catchphrase' | 'username' = 'username'

test/returns.test-d.ts

@@ -53,7 +53,7 @@ const postgrest = new PostgrestClient<Database>(REST_URL)
     .returns<{ username: string }[]>()
   expectType<
     PostgrestBuilder<
-      { postgrestVersion: 12 },
+      { 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

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

test/types.generated-with-options-postgrest13.ts

@@ -4,7 +4,7 @@ export type Database = {
   // This is a dummy non existent schema to allow automatically passing down options
   // to the instanciated client at type levels from the introspected database
   __internal_supabase: {
-    postgrestVersion: 13
+    postgrestVersion: '13.0.12'
     // We make this still abide to `GenericSchema` to allow types helpers bellow to work the same
     Tables: {
       [_ in never]: never