@supabase/postgrest-js 3.0.0-next.2 → 3.0.0-next.21

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supabase/postgrest-js",
-  "version": "3.0.0-next.2",
+  "version": "3.0.0-next.21",
   "description": "Isomorphic PostgREST client",
   "keywords": [
     "postgrest",

package/src/PostgrestBuilder.ts

@@ -96,7 +96,7 @@ export default abstract class PostgrestBuilder<
    * ```ts
    * import { createClient } from '@supabase/supabase-js'
    *
-   * const supabase = createClient('https://xyzcompany.supabase.co', 'publishable-or-anon-key')
+   * const supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')
    * const { data, error } = await supabase.from('users').select('*')
    * ```
    *
@@ -108,7 +108,7 @@ export default abstract class PostgrestBuilder<
    *
    * const builder = new PostgrestQueryBuilder(
    *   new URL('https://xyzcompany.supabase.co/rest/v1/users'),
-   *   { headers: new Headers({ apikey: 'publishable-or-anon-key' }) }
+   *   { headers: new Headers({ apikey: 'your-publishable-key' }) }
    * )
    * ```
    */
@@ -321,9 +321,13 @@ export default abstract class PostgrestBuilder<
             ),
             signal: this.signal,
           })
-        } catch (fetchError: any) {
+        } catch (fetchError) {
           // Never retry aborted requests
-          if (fetchError?.name === 'AbortError' || fetchError?.code === 'ABORT_ERR') {
+          if (
+            fetchError instanceof Error &&
+            (fetchError.name === 'AbortError' ||
+              ('code' in fetchError && (fetchError as { code?: string }).code === 'ABORT_ERR'))
+          ) {
             throw fetchError
           }
 
@@ -446,7 +450,7 @@ export default abstract class PostgrestBuilder<
    */
   private async processResponse(res: Response): Promise<{
     success: boolean
-    error: any
+    error: PostgrestError | null
     data: any
     count: number | null
     status: number
@@ -533,7 +537,7 @@ export default abstract class PostgrestBuilder<
 
     return {
       success: error === null,
-      error,
+      error: error ? new PostgrestError(error) : null,
       data,
       count,
       status,

package/src/PostgrestClient.ts

@@ -62,7 +62,7 @@ export default class PostgrestClient<
    * ```ts
    * import { createClient } from '@supabase/supabase-js'
    *
-   * const supabase = createClient('https://xyzcompany.supabase.co', 'publishable-or-anon-key')
+   * const supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')
    * const { data, error } = await supabase.from('profiles').select('*')
    * ```
    *
@@ -77,7 +77,7 @@ export default class PostgrestClient<
    * import { PostgrestClient } from '@supabase/postgrest-js'
    *
    * const postgrest = new PostgrestClient('https://xyzcompany.supabase.co/rest/v1', {
-   *   headers: { apikey: 'publishable-or-anon-key' },
+   *   headers: { apikey: 'your-publishable-key' },
    *   schema: 'public',
    *   timeout: 30000, // 30 second timeout
    * })
@@ -389,7 +389,7 @@ export default class PostgrestClient<
     }: {
       head?: boolean
       get?: boolean
-      count?: 'exact' | 'planned' | 'estimated'
+      count?: 'exact' | 'planned' | 'estimated' | (string & {})
     } = {}
   ): PostgrestFilterBuilder<
     ClientOptions,

package/src/PostgrestError.ts

@@ -23,6 +23,12 @@ export default class PostgrestError extends Error {
    */
   constructor(context: { message: string; details: string; hint: string; code: string }) {
     super(context.message)
+    Object.defineProperty(this, 'message', {
+      value: context.message,
+      enumerable: true,
+      writable: true,
+      configurable: true,
+    })
     this.name = 'PostgrestError'
     this.details = context.details
     this.hint = context.hint

package/src/PostgrestFilterBuilder.ts

@@ -76,6 +76,22 @@ type ResolveFilterRelationshipValue<
 
 export type InvalidMethodError<S extends string> = { Error: S }
 
+type NonNullableColumn<T extends Record<string, unknown>, Col extends string> = Col extends keyof T
+  ? { [K in keyof T]: K extends Col ? NonNullable<T[K]> : T[K] }
+  : T
+
+type NarrowResultColumn<T, Col extends string> = T extends (infer Item)[]
+  ? Item extends Record<string, unknown>
+    ? Col extends keyof Item
+      ? { [K in keyof Item]: K extends Col ? NonNullable<Item[K]> : Item[K] }[]
+      : T
+    : T
+  : T extends Record<string, unknown>
+    ? Col extends keyof T
+      ? { [K in keyof T]: K extends Col ? NonNullable<T[K]> : T[K] }
+      : T
+    : T
+
 export default class PostgrestFilterBuilder<
   ClientOptions extends ClientServerOptions,
   Schema extends GenericSchema,
@@ -1719,6 +1735,20 @@ export default class PostgrestFilterBuilder<
     return this
   }
 
+  not<ColumnName extends string & keyof Row>(
+    column: ColumnName,
+    operator: 'is',
+    value: null
+  ): PostgrestFilterBuilder<
+    ClientOptions,
+    Schema,
+    NonNullableColumn<Row, ColumnName>,
+    NarrowResultColumn<Result, ColumnName>,
+    RelationName,
+    Relationships,
+    Method
+  > &
+    this
   not<ColumnName extends string & keyof Row>(
     column: ColumnName,
     operator: FilterOperator,
@@ -1783,9 +1813,14 @@ export default class PostgrestFilterBuilder<
    *
    * ```
    */
-  not(column: string, operator: string, value: unknown): this {
+  not(
+    column: string,
+    operator: string,
+    value: unknown
+  ): PostgrestFilterBuilder<ClientOptions, Schema, any, any, RelationName, Relationships, Method> &
+    this {
     this.url.searchParams.append(column, `not.${operator}.${value}`)
-    return this
+    return this as any
   }
 
   /**

package/src/PostgrestQueryBuilder.ts

@@ -48,7 +48,7 @@ export default class PostgrestQueryBuilder<
    * ```ts
    * import { createClient } from '@supabase/supabase-js'
    *
-   * const supabase = createClient('https://xyzcompany.supabase.co', 'publishable-or-anon-key')
+   * const supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')
    * const { data, error } = await supabase.from('users').select('*')
    * ```
    *
@@ -58,7 +58,7 @@ export default class PostgrestQueryBuilder<
    *
    * const query = new PostgrestQueryBuilder(
    *   new URL('https://xyzcompany.supabase.co/rest/v1/users'),
-   *   { headers: { apikey: 'publishable-or-anon-key' }, retry: true }
+   *   { headers: { apikey: 'your-publishable-key' }, retry: true }
    * )
    * ```
    */
@@ -889,7 +889,7 @@ export default class PostgrestQueryBuilder<
     columns?: Query,
     options?: {
       head?: boolean
-      count?: 'exact' | 'planned' | 'estimated'
+      count?: 'exact' | 'planned' | 'estimated' | (string & {})
     }
   ): PostgrestFilterBuilder<
     ClientOptions,
@@ -936,42 +936,6 @@ 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: RejectExcessProperties<
-      Relation extends { Insert: unknown } ? Relation['Insert'] : never,
-      Row
-    >,
-    options?: {
-      count?: 'exact' | 'planned' | 'estimated'
-    }
-  ): PostgrestFilterBuilder<
-    ClientOptions,
-    Schema,
-    Relation['Row'],
-    null,
-    RelationName,
-    Relationships,
-    'POST'
-  >
-  insert<Row extends Relation extends { Insert: unknown } ? Relation['Insert'] : never>(
-    values: RejectExcessProperties<
-      Relation extends { Insert: unknown } ? Relation['Insert'] : never,
-      Row
-    >[],
-    options?: {
-      count?: 'exact' | 'planned' | 'estimated'
-      defaultToNull?: boolean
-    }
-  ): PostgrestFilterBuilder<
-    ClientOptions,
-    Schema,
-    Relation['Row'],
-    null,
-    RelationName,
-    Relationships,
-    'POST'
-  >
   /**
    * Perform an INSERT into the table or view.
    *
@@ -1097,7 +1061,7 @@ export default class PostgrestQueryBuilder<
       count,
       defaultToNull = true,
     }: {
-      count?: 'exact' | 'planned' | 'estimated'
+      count?: 'exact' | 'planned' | 'estimated' | (string & {})
       defaultToNull?: boolean
     } = {}
   ): PostgrestFilterBuilder<
@@ -1139,46 +1103,6 @@ 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: RejectExcessProperties<
-      Relation extends { Insert: unknown } ? Relation['Insert'] : never,
-      Row
-    >,
-    options?: {
-      onConflict?: string
-      ignoreDuplicates?: boolean
-      count?: 'exact' | 'planned' | 'estimated'
-    }
-  ): PostgrestFilterBuilder<
-    ClientOptions,
-    Schema,
-    Relation['Row'],
-    null,
-    RelationName,
-    Relationships,
-    'POST'
-  >
-  upsert<Row extends Relation extends { Insert: unknown } ? Relation['Insert'] : never>(
-    values: RejectExcessProperties<
-      Relation extends { Insert: unknown } ? Relation['Insert'] : never,
-      Row
-    >[],
-    options?: {
-      onConflict?: string
-      ignoreDuplicates?: boolean
-      count?: 'exact' | 'planned' | 'estimated'
-      defaultToNull?: boolean
-    }
-  ): 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
@@ -1406,7 +1330,7 @@ export default class PostgrestQueryBuilder<
     }: {
       onConflict?: string
       ignoreDuplicates?: boolean
-      count?: 'exact' | 'planned' | 'estimated'
+      count?: 'exact' | 'planned' | 'estimated' | (string & {})
       defaultToNull?: boolean
     } = {}
   ): PostgrestFilterBuilder<
@@ -1598,7 +1522,7 @@ export default class PostgrestQueryBuilder<
     {
       count,
     }: {
-      count?: 'exact' | 'planned' | 'estimated'
+      count?: 'exact' | 'planned' | 'estimated' | (string & {})
     } = {}
   ): PostgrestFilterBuilder<
     ClientOptions,
@@ -1749,7 +1673,7 @@ export default class PostgrestQueryBuilder<
   delete({
     count,
   }: {
-    count?: 'exact' | 'planned' | 'estimated'
+    count?: 'exact' | 'planned' | 'estimated' | (string & {})
   } = {}): PostgrestFilterBuilder<
     ClientOptions,
     Schema,

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 = '3.0.0-next.2'
+export const version = '3.0.0-next.21'