feat: throw on error types

.github/workflows/pkg.pr.new.yml

@@ -0,0 +1,14 @@
+name: pkg.pr.new
+
+on:
+  push: {}
+
+jobs:
+  run:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v4
+      - run: npm clean-install
+      - run: npm run build
+      - name: Create pkg.pr.new release
+        run: npx pkg-pr-new publish

src/PostgrestBuilder.ts

@@ -1,23 +1,23 @@
 // @ts-ignore
 import nodeFetch from '@supabase/node-fetch'
 
-import type { Fetch, PostgrestSingleResponse } from './types'
+import type { Fetch, PostgrestResponseSuccess, PostgrestSingleResponse } from './types'
 import PostgrestError from './PostgrestError'
 
-export default abstract class PostgrestBuilder<Result>
+export default abstract class PostgrestBuilder<Result, ThrowOnError extends boolean = false>
   implements PromiseLike<PostgrestSingleResponse<Result>>
 {
   protected method: 'GET' | 'HEAD' | 'POST' | 'PATCH' | 'DELETE'
   protected url: URL
   protected headers: Record<string, string>
   protected schema?: string
   protected body?: unknown
-  protected shouldThrowOnError = false
+  protected shouldThrowOnError: boolean
   protected signal?: AbortSignal
   protected fetch: Fetch
   protected isMaybeSingle: boolean
 
-  constructor(builder: PostgrestBuilder<Result>) {
+  constructor(builder: PostgrestBuilder<Result, ThrowOnError>) {
     this.method = builder.method
     this.url = builder.url
     this.headers = builder.headers
@@ -36,15 +36,9 @@ export default abstract class PostgrestBuilder<Result>
     }
   }
 
-  /**
-   * If there's an error with the query, throwOnError will reject the promise by
-   * throwing the error instead of returning it as part of a successful response.
-   *
-   * {@link https://github.com/supabase/supabase-js/issues/92}
-   */
-  throwOnError(): this {
+  throwOnError(): PostgrestBuilder<Result, true> {
     this.shouldThrowOnError = true
-    return this
+    return this as PostgrestBuilder<Result, true>
   }
 
   /**
@@ -58,7 +52,11 @@ export default abstract class PostgrestBuilder<Result>
 
   then<TResult1 = PostgrestSingleResponse<Result>, TResult2 = never>(
     onfulfilled?:
-      | ((value: PostgrestSingleResponse<Result>) => TResult1 | PromiseLike<TResult1>)
+      | ((
+          value: ThrowOnError extends true
+            ? PostgrestResponseSuccess<Result>
+            : PostgrestSingleResponse<Result>
+        ) => TResult1 | PromiseLike<TResult1>)
       | undefined
       | null,
     onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null

src/PostgrestClient.ts

@@ -21,12 +21,14 @@ export default class PostgrestClient<
     : string & keyof Database,
   Schema extends GenericSchema = Database[SchemaName] extends GenericSchema
     ? Database[SchemaName]
-    : any
+    : any,
+  ThrowOnError extends boolean = false
 > {
   url: string
   headers: Record<string, string>
   schemaName?: SchemaName
   fetch?: Fetch
+  shouldThrowOnError: ThrowOnError
 
   // TODO: Add back shouldThrowOnError once we figure out the typings
   /**
@@ -44,36 +46,63 @@ export default class PostgrestClient<
       headers = {},
       schema,
       fetch,
+      shouldThrowOnError,
     }: {
       headers?: Record<string, string>
       schema?: SchemaName
       fetch?: Fetch
+      shouldThrowOnError?: ThrowOnError
     } = {}
   ) {
     this.url = url
     this.headers = { ...DEFAULT_HEADERS, ...headers }
     this.schemaName = schema
     this.fetch = fetch
+    this.shouldThrowOnError = Boolean(shouldThrowOnError) as ThrowOnError
+  }
+
+  throwOnError(): PostgrestClient<Database, SchemaName, Schema, true> {
+    return new PostgrestClient(this.url, {
+      headers: this.headers,
+      schema: this.schemaName,
+      fetch: this.fetch,
+      shouldThrowOnError: true,
+    }) as PostgrestClient<Database, SchemaName, Schema, true>
   }
 
   from<
     TableName extends string & keyof Schema['Tables'],
     Table extends Schema['Tables'][TableName]
-  >(relation: TableName): PostgrestQueryBuilder<Schema, Table, TableName>
+  >(
+    relation: TableName
+  ): PostgrestQueryBuilder<
+    Schema,
+    Table,
+    any,
+    Table extends { Relationships: infer R } ? R : unknown,
+    ThrowOnError
+  >
   from<ViewName extends string & keyof Schema['Views'], View extends Schema['Views'][ViewName]>(
     relation: ViewName
-  ): PostgrestQueryBuilder<Schema, View, ViewName>
+  ): PostgrestQueryBuilder<
+    Schema,
+    View,
+    any,
+    View extends { Relationships: infer R } ? R : unknown,
+    ThrowOnError
+  >
   /**
    * 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<Schema, any, any, any, ThrowOnError> {
     const url = new URL(`${this.url}/${relation}`)
-    return new PostgrestQueryBuilder(url, {
+    return new PostgrestQueryBuilder<Schema, any, any, any, ThrowOnError>(url, {
       headers: { ...this.headers },
       schema: this.schemaName,
       fetch: this.fetch,
+      shouldThrowOnError: this.shouldThrowOnError,
     })
   }
 
@@ -89,12 +118,14 @@ export default class PostgrestClient<
   ): PostgrestClient<
     Database,
     DynamicSchema,
-    Database[DynamicSchema] extends GenericSchema ? Database[DynamicSchema] : any
+    Database[DynamicSchema] extends GenericSchema ? Database[DynamicSchema] : any,
+    ThrowOnError
   > {
     return new PostgrestClient(this.url, {
       headers: this.headers,
       schema,
       fetch: this.fetch,
+      shouldThrowOnError: this.shouldThrowOnError,
     })
   }
 
@@ -140,7 +171,9 @@ export default class PostgrestClient<
         ? Fn['Returns'][number]
         : never
       : never,
-    Fn['Returns']
+    Fn['Returns'],
+    unknown,
+    ThrowOnError
   > {
     let method: 'HEAD' | 'GET' | 'POST'
     const url = new URL(`${this.url}/rpc/${fn}`)
@@ -174,6 +207,7 @@ export default class PostgrestClient<
       body,
       fetch: this.fetch,
       allowEmpty: false,
-    } as unknown as PostgrestBuilder<Fn['Returns']>)
+      shouldThrowOnError: this.shouldThrowOnError,
+    } as never)
   }
 }

src/PostgrestFilterBuilder.ts

@@ -30,8 +30,16 @@ export default class PostgrestFilterBuilder<
   Row extends Record<string, unknown>,
   Result,
   RelationName = unknown,
-  Relationships = unknown
-> extends PostgrestTransformBuilder<Schema, Row, Result, RelationName, Relationships> {
+  Relationships = unknown,
+  ThrowOnError extends boolean = false
+> extends PostgrestTransformBuilder<
+  Schema,
+  Row,
+  Result,
+  RelationName,
+  Relationships,
+  ThrowOnError
+> {
   eq<ColumnName extends string & keyof Row>(
     column: ColumnName,
     value: NonNullable<Row[ColumnName]>