@supabase/postgrest-js 2.102.0-beta.0 → 2.103.0-canary.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supabase/postgrest-js",
-  "version": "2.102.0-beta.0",
+  "version": "2.103.0-canary.0",
   "description": "Isomorphic PostgREST client",
   "keywords": [
     "postgrest",

package/src/PostgrestError.ts

@@ -28,4 +28,14 @@ export default class PostgrestError extends Error {
     this.hint = context.hint
     this.code = context.code
   }
+
+  toJSON() {
+    return {
+      name: this.name,
+      message: this.message,
+      details: this.details,
+      hint: this.hint,
+      code: this.code,
+    }
+  }
 }

package/src/PostgrestQueryBuilder.ts

@@ -7,6 +7,7 @@ import {
   GenericTable,
   GenericView,
 } from './types/common/common'
+import { RejectExcessProperties } from './types/types'
 
 export default class PostgrestQueryBuilder<
   ClientOptions extends ClientServerOptions,
@@ -929,7 +930,10 @@ export default class PostgrestQueryBuilder<
 
   // TODO(v3): Make `defaultToNull` consistent for both single & bulk inserts.
   insert<Row extends Relation extends { Insert: unknown } ? Relation['Insert'] : never>(
-    values: Row,
+    values: RejectExcessProperties<
+      Relation extends { Insert: unknown } ? Relation['Insert'] : never,
+      Row
+    >,
     options?: {
       count?: 'exact' | 'planned' | 'estimated'
     }
@@ -943,7 +947,10 @@ export default class PostgrestQueryBuilder<
     'POST'
   >
   insert<Row extends Relation extends { Insert: unknown } ? Relation['Insert'] : never>(
-    values: Row[],
+    values: RejectExcessProperties<
+      Relation extends { Insert: unknown } ? Relation['Insert'] : never,
+      Row
+    >[],
     options?: {
       count?: 'exact' | 'planned' | 'estimated'
       defaultToNull?: boolean
@@ -1069,7 +1076,15 @@ export default class PostgrestQueryBuilder<
    * ```
    */
   insert<Row extends Relation extends { Insert: unknown } ? Relation['Insert'] : never>(
-    values: Row | Row[],
+    values:
+      | RejectExcessProperties<
+          Relation extends { Insert: unknown } ? Relation['Insert'] : never,
+          Row
+        >
+      | RejectExcessProperties<
+          Relation extends { Insert: unknown } ? Relation['Insert'] : never,
+          Row
+        >[],
     {
       count,
       defaultToNull = true,
@@ -1118,7 +1133,10 @@ export default class PostgrestQueryBuilder<
 
   // TODO(v3): Make `defaultToNull` consistent for both single & bulk upserts.
   upsert<Row extends Relation extends { Insert: unknown } ? Relation['Insert'] : never>(
-    values: Row,
+    values: RejectExcessProperties<
+      Relation extends { Insert: unknown } ? Relation['Insert'] : never,
+      Row
+    >,
     options?: {
       onConflict?: string
       ignoreDuplicates?: boolean
@@ -1134,7 +1152,10 @@ export default class PostgrestQueryBuilder<
     'POST'
   >
   upsert<Row extends Relation extends { Insert: unknown } ? Relation['Insert'] : never>(
-    values: Row[],
+    values: RejectExcessProperties<
+      Relation extends { Insert: unknown } ? Relation['Insert'] : never,
+      Row
+    >[],
     options?: {
       onConflict?: string
       ignoreDuplicates?: boolean
@@ -1360,7 +1381,15 @@ export default class PostgrestQueryBuilder<
    */
 
   upsert<Row extends Relation extends { Insert: unknown } ? Relation['Insert'] : never>(
-    values: Row | Row[],
+    values:
+      | RejectExcessProperties<
+          Relation extends { Insert: unknown } ? Relation['Insert'] : never,
+          Row
+        >
+      | RejectExcessProperties<
+          Relation extends { Insert: unknown } ? Relation['Insert'] : never,
+          Row
+        >[],
     {
       onConflict,
       ignoreDuplicates = false,
@@ -1554,7 +1583,10 @@ export default class PostgrestQueryBuilder<
    * ```
    */
   update<Row extends Relation extends { Update: unknown } ? Relation['Update'] : never>(
-    values: Row,
+    values: RejectExcessProperties<
+      Relation extends { Update: unknown } ? Relation['Update'] : never,
+      Row
+    >,
     {
       count,
     }: {

package/src/types/types.ts

@@ -38,6 +38,12 @@ export type DatabaseWithOptions<Database, Options extends ClientServerOptions> =
 // https://twitter.com/mattpocockuk/status/1622730173446557697
 export type Prettify<T> = { [K in keyof T]: T[K] } & {}
 
+// Rejects excess properties that aren't in Base.
+// Works around TypeScript not checking excess properties on generic parameters.
+export type RejectExcessProperties<Base, Row> = Row & {
+  [K in Exclude<keyof Row, keyof Base>]: never
+}
+
 // https://github.com/sindresorhus/type-fest
 export type SimplifyDeep<Type, ExcludeType = never> = ConditionalSimplifyDeep<
   Type,

package/src/version.ts

@@ -4,4 +4,4 @@
 // - Debugging and support (identifying which version is running)
 // - Telemetry and logging (version reporting in errors/analytics)
 // - Ensuring build artifacts match the published package version
-export const version = '2.102.0-beta.0'
+export const version = '2.103.0-canary.0'