@supabase/postgrest-js 2.104.0-canary.1 → 2.104.0

package/package.json

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

package/src/PostgrestBuilder.ts

@@ -92,25 +92,23 @@ export default abstract class PostgrestBuilder<
   /**
    * Creates a builder configured for a specific PostgREST request.
    *
-   * @example
+   * @example Using supabase-js (recommended)
    * ```ts
-   * import { PostgrestQueryBuilder } from '@supabase/postgrest-js'
+   * import { createClient } from '@supabase/supabase-js'
    *
-   * const builder = new PostgrestQueryBuilder(
-   *   new URL('https://xyzcompany.supabase.co/rest/v1/users'),
-   *   { headers: new Headers({ apikey: 'public-anon-key' }) }
-   * )
+   * const supabase = createClient('https://xyzcompany.supabase.co', 'publishable-or-anon-key')
+   * const { data, error } = await supabase.from('users').select('*')
    * ```
    *
    * @category Database
    *
-   * @example Creating a Postgrest query builder
+   * @example Standalone import for bundle-sensitive environments
    * ```ts
    * import { PostgrestQueryBuilder } from '@supabase/postgrest-js'
    *
    * const builder = new PostgrestQueryBuilder(
    *   new URL('https://xyzcompany.supabase.co/rest/v1/users'),
-   *   { headers: new Headers({ apikey: 'public-anon-key' }) }
+   *   { headers: new Headers({ apikey: 'publishable-or-anon-key' }) }
    * )
    * ```
    */

package/src/PostgrestClient.ts

@@ -58,15 +58,12 @@ export default class PostgrestClient<
    *   When enabled, idempotent requests (GET, HEAD, OPTIONS) that fail with network
    *   errors or HTTP 503/520 responses will be automatically retried up to 3 times
    *   with exponential backoff (1s, 2s, 4s). Defaults to `true`.
-   * @example
+   * @example Using supabase-js (recommended)
    * ```ts
-   * import { PostgrestClient } from '@supabase/postgrest-js'
+   * import { createClient } from '@supabase/supabase-js'
    *
-   * const postgrest = new PostgrestClient('https://xyzcompany.supabase.co/rest/v1', {
-   *   headers: { apikey: 'public-anon-key' },
-   *   schema: 'public',
-   *   timeout: 30000, // 30 second timeout
-   * })
+   * const supabase = createClient('https://xyzcompany.supabase.co', 'publishable-or-anon-key')
+   * const { data, error } = await supabase.from('profiles').select('*')
    * ```
    *
    * @category Database
@@ -75,25 +72,14 @@ export default class PostgrestClient<
    * - A `timeout` option (in milliseconds) can be set to automatically abort requests that take too long.
    * - A `urlLengthLimit` option (default: 8000) can be set to control when URL length warnings are included in error messages for aborted requests.
    *
-   * @example Creating a Postgrest client
-   * ```ts
-   * import { PostgrestClient } from '@supabase/postgrest-js'
-   *
-   * const postgrest = new PostgrestClient('https://xyzcompany.supabase.co/rest/v1', {
-   *   headers: { apikey: 'public-anon-key' },
-   *   schema: 'public',
-   * })
-   * ```
-   *
-   * @example With timeout
+   * @example Standalone import for bundle-sensitive environments
    * ```ts
    * import { PostgrestClient } from '@supabase/postgrest-js'
    *
    * const postgrest = new PostgrestClient('https://xyzcompany.supabase.co/rest/v1', {
-   *   headers: { apikey: 'public-anon-key' },
+   *   headers: { apikey: 'publishable-or-anon-key' },
    *   schema: 'public',
    *   timeout: 30000, // 30 second timeout
-   *   retry: false, // Disable automatic retries
    * })
    * ```
    */

package/src/PostgrestQueryBuilder.ts

@@ -44,13 +44,21 @@ export default class PostgrestQueryBuilder<
    * @param options.urlLengthLimit - Maximum URL length before warning
    * @param options.retry - Enable automatic retries for transient errors (default: true)
    *
-   * @example Creating a Postgrest query builder
+   * @example Using supabase-js (recommended)
+   * ```ts
+   * import { createClient } from '@supabase/supabase-js'
+   *
+   * const supabase = createClient('https://xyzcompany.supabase.co', 'publishable-or-anon-key')
+   * const { data, error } = await supabase.from('users').select('*')
+   * ```
+   *
+   * @example Standalone import for bundle-sensitive environments
    * ```ts
    * import { PostgrestQueryBuilder } from '@supabase/postgrest-js'
    *
    * const query = new PostgrestQueryBuilder(
    *   new URL('https://xyzcompany.supabase.co/rest/v1/users'),
-   *   { headers: { apikey: 'public-anon-key' }, retry: true }
+   *   { headers: { apikey: 'publishable-or-anon-key' }, retry: true }
    * )
    * ```
    */

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.104.0-canary.1'
+export const version = '2.104.0'