Merge pull request #394 from supabase/fix/rpc-return-type

fix: rpc return type

Author: soedirgo

src/PostgrestBuilder.ts

@@ -1,9 +1,9 @@
 import crossFetch from 'cross-fetch'
 
-import type { Fetch, PostgrestResponse } from './types'
+import type { Fetch, PostgrestSingleResponse } from './types'
 
 export default abstract class PostgrestBuilder<Result>
-  implements PromiseLike<PostgrestResponse<Result>>
+  implements PromiseLike<PostgrestSingleResponse<Result>>
 {
   protected method: 'GET' | 'HEAD' | 'POST' | 'PATCH' | 'DELETE'
   protected url: URL
@@ -45,9 +45,9 @@ export default abstract class PostgrestBuilder<Result>
     return this
   }
 
-  then<TResult1 = PostgrestResponse<Result>, TResult2 = never>(
+  then<TResult1 = PostgrestSingleResponse<Result>, TResult2 = never>(
     onfulfilled?:
-      | ((value: PostgrestResponse<Result>) => TResult1 | PromiseLike<TResult1>)
+      | ((value: PostgrestSingleResponse<Result>) => TResult1 | PromiseLike<TResult1>)
       | undefined
       | null,
     onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null

src/PostgrestQueryBuilder.ts

@@ -52,7 +52,7 @@ export default class PostgrestQueryBuilder<
    * `"estimated"`: Uses exact count for low numbers and planned count for high
    * numbers.
    */
-  select<Query extends string = '*', Result = GetResult<Schema, Relation['Row'], Query>>(
+  select<Query extends string = '*', ResultOne = GetResult<Schema, Relation['Row'], Query>>(
     columns?: Query,
     {
       head = false,
@@ -61,7 +61,7 @@ export default class PostgrestQueryBuilder<
       head?: boolean
       count?: 'exact' | 'planned' | 'estimated'
     } = {}
-  ): PostgrestFilterBuilder<Schema, Relation['Row'], Result> {
+  ): PostgrestFilterBuilder<Schema, Relation['Row'], ResultOne[]> {
     const method = head ? 'HEAD' : 'GET'
     // Remove whitespaces except when quoted
     let quoted = false
@@ -89,7 +89,7 @@ export default class PostgrestQueryBuilder<
       schema: this.schema,
       fetch: this.fetch,
       allowEmpty: false,
-    } as unknown as PostgrestBuilder<Result>)
+    } as unknown as PostgrestBuilder<ResultOne[]>)
   }
 
   /**

src/PostgrestTransformBuilder.ts

@@ -1,11 +1,6 @@
 import PostgrestBuilder from './PostgrestBuilder'
 import { GetResult } from './select-query-parser'
-import {
-  GenericSchema,
-  PostgrestMaybeSingleResponse,
-  PostgrestResponse,
-  PostgrestSingleResponse,
-} from './types'
+import { GenericSchema } from './types'
 
 export default class PostgrestTransformBuilder<
   Schema extends GenericSchema,
@@ -21,9 +16,9 @@ export default class PostgrestTransformBuilder<
    *
    * @param columns - The columns to retrieve, separated by commas
    */
-  select<Query extends string = '*', NewResult = GetResult<Schema, Row, Query>>(
+  select<Query extends string = '*', NewResultOne = GetResult<Schema, Row, Query>>(
     columns?: Query
-  ): PostgrestTransformBuilder<Schema, Row, NewResult> {
+  ): PostgrestTransformBuilder<Schema, Row, NewResultOne[]> {
     // Remove whitespaces except when quoted
     let quoted = false
     const cleanedColumns = (columns ?? '*')
@@ -43,7 +38,7 @@ export default class PostgrestTransformBuilder<
       this.headers['Prefer'] += ','
     }
     this.headers['Prefer'] += 'return=representation'
-    return this as unknown as PostgrestTransformBuilder<Schema, Row, NewResult>
+    return this as unknown as PostgrestTransformBuilder<Schema, Row, NewResultOne[]>
   }
 
   order<ColumnName extends string & keyof Row>(
@@ -138,9 +133,11 @@ export default class PostgrestTransformBuilder<
    * Query result must be one row (e.g. using `.limit(1)`), otherwise this
    * returns an error.
    */
-  single(): PromiseLike<PostgrestSingleResponse<Result>> {
+  single<
+    ResultOne = Result extends (infer ResultOne)[] ? ResultOne : never
+  >(): PostgrestBuilder<ResultOne> {
     this.headers['Accept'] = 'application/vnd.pgrst.object+json'
-    return this as PromiseLike<PostgrestSingleResponse<Result>>
+    return this as PostgrestBuilder<ResultOne>
   }
 
   /**
@@ -149,26 +146,28 @@ export default class PostgrestTransformBuilder<
    * Query result must be zero or one row (e.g. using `.limit(1)`), otherwise
    * this returns an error.
    */
-  maybeSingle(): PromiseLike<PostgrestMaybeSingleResponse<Result>> {
+  maybeSingle<
+    ResultOne = Result extends (infer ResultOne)[] ? ResultOne : never
+  >(): PostgrestBuilder<ResultOne | null> {
     this.headers['Accept'] = 'application/vnd.pgrst.object+json'
     this.allowEmpty = true
-    return this as PromiseLike<PostgrestMaybeSingleResponse<Result>>
+    return this as PostgrestBuilder<ResultOne | null>
   }
 
   /**
    * Return `data` as a string in CSV format.
    */
-  csv(): PromiseLike<PostgrestSingleResponse<string>> {
+  csv(): PostgrestBuilder<string> {
     this.headers['Accept'] = 'text/csv'
-    return this as PromiseLike<PostgrestSingleResponse<string>>
+    return this as PostgrestBuilder<string>
   }
 
   /**
    * Return `data` as an object in [GeoJSON](https://geojson.org) format.
    */
-  geojson(): PromiseLike<PostgrestSingleResponse<Record<string, unknown>>> {
+  geojson(): PostgrestBuilder<Record<string, unknown>> {
     this.headers['Accept'] = 'application/geo+json'
-    return this as PromiseLike<PostgrestSingleResponse<Record<string, unknown>>>
+    return this as PostgrestBuilder<Record<string, unknown>>
   }
 
   /**
@@ -206,9 +205,7 @@ export default class PostgrestTransformBuilder<
     buffers?: boolean
     wal?: boolean
     format?: 'json' | 'text'
-  } = {}):
-    | PromiseLike<PostgrestResponse<Record<string, unknown>>>
-    | PromiseLike<PostgrestSingleResponse<string>> {
+  } = {}): PostgrestBuilder<Record<string, unknown>[]> | PostgrestBuilder<string> {
     const options = [
       analyze ? 'analyze' : null,
       verbose ? 'verbose' : null,
@@ -223,8 +220,8 @@ export default class PostgrestTransformBuilder<
     this.headers[
       'Accept'
     ] = `application/vnd.pgrst.plan+${format}; for="${forMediatype}"; options=${options};`
-    if (format === 'json') return this as PromiseLike<PostgrestResponse<Record<string, unknown>>>
-    else return this as PromiseLike<PostgrestSingleResponse<string>>
+    if (format === 'json') return this as PostgrestBuilder<Record<string, unknown>[]>
+    else return this as PostgrestBuilder<string>
   }
 
   /**

src/types.ts

@@ -21,28 +21,25 @@ interface PostgrestResponseBase {
   status: number
   statusText: string
 }
-
-interface PostgrestResponseSuccess<T> extends PostgrestResponseBase {
+interface PostgrestSingleResponseSuccess<T> extends PostgrestResponseBase {
   error: null
-  data: T[]
+  data: T
   count: number | null
 }
 interface PostgrestResponseFailure extends PostgrestResponseBase {
   error: PostgrestError
   data: null
   count: null
 }
-export type PostgrestResponse<T> = PostgrestResponseSuccess<T> | PostgrestResponseFailure
 
-interface PostgrestSingleResponseSuccess<T> extends PostgrestResponseBase {
-  error: null
-  data: T
-  count: number | null
-}
+// TODO: in v3:
+// - remove PostgrestResponse and PostgrestMaybeSingleResponse
+// - rename PostgrestSingleResponse to PostgrestResponse
 export type PostgrestSingleResponse<T> =
   | PostgrestSingleResponseSuccess<T>
   | PostgrestResponseFailure
 export type PostgrestMaybeSingleResponse<T> = PostgrestSingleResponse<T | null>
+export type PostgrestResponse<T> = PostgrestSingleResponse<T[]>
 
 export type GenericTable = {
   Row: Record<string, unknown>