@supabase/postgrest-js 2.104.0-canary.0 → 2.104.0-canary.2

package/dist/index.cjs

@@ -103,30 +103,28 @@ var PostgrestBuilder = class {
 	/**
 	* 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' }) }
 	* )
 	* ```
 	*/
 	constructor(builder) {
-		var _builder$shouldThrowO, _builder$isMaybeSingl, _builder$urlLengthLim, _builder$retry;
+		var _builder$shouldThrowO, _builder$isMaybeSingl, _builder$shouldStripN, _builder$urlLengthLim, _builder$retry;
 		this.shouldThrowOnError = false;
 		this.retryEnabled = true;
 		this.method = builder.method;
@@ -137,6 +135,7 @@ var PostgrestBuilder = class {
 		this.shouldThrowOnError = (_builder$shouldThrowO = builder.shouldThrowOnError) !== null && _builder$shouldThrowO !== void 0 ? _builder$shouldThrowO : false;
 		this.signal = builder.signal;
 		this.isMaybeSingle = (_builder$isMaybeSingl = builder.isMaybeSingle) !== null && _builder$isMaybeSingl !== void 0 ? _builder$isMaybeSingl : false;
+		this.shouldStripNulls = (_builder$shouldStripN = builder.shouldStripNulls) !== null && _builder$shouldStripN !== void 0 ? _builder$shouldStripN : false;
 		this.urlLengthLimit = (_builder$urlLengthLim = builder.urlLengthLimit) !== null && _builder$urlLengthLim !== void 0 ? _builder$urlLengthLim : 8e3;
 		this.retryEnabled = (_builder$retry = builder.retry) !== null && _builder$retry !== void 0 ? _builder$retry : true;
 		if (builder.fetch) this.fetch = builder.fetch;
@@ -155,6 +154,60 @@ var PostgrestBuilder = class {
 		return this;
 	}
 	/**
+	* Strip null values from the response data. Properties with `null` values
+	* will be omitted from the returned JSON objects.
+	*
+	* Requires PostgREST 11.2.0+.
+	*
+	* {@link https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls}
+	*
+	* @category Database
+	*
+	* @example With `select()`
+	* ```ts
+	* const { data, error } = await supabase
+	*   .from('characters')
+	*   .select()
+	*   .stripNulls()
+	* ```
+	*
+	* @exampleSql With `select()`
+	* ```sql
+	* create table
+	*   characters (id int8 primary key, name text, bio text);
+	*
+	* insert into
+	*   characters (id, name, bio)
+	* values
+	*   (1, 'Luke', null),
+	*   (2, 'Leia', 'Princess of Alderaan');
+	* ```
+	*
+	* @exampleResponse With `select()`
+	* ```json
+	* {
+	*   "data": [
+	*     {
+	*       "id": 1,
+	*       "name": "Luke"
+	*     },
+	*     {
+	*       "id": 2,
+	*       "name": "Leia",
+	*       "bio": "Princess of Alderaan"
+	*     }
+	*   ],
+	*   "status": 200,
+	*   "statusText": "OK"
+	* }
+	* ```
+	*/
+	stripNulls() {
+		if (this.headers.get("Accept") === "text/csv") throw new Error("stripNulls() cannot be used with csv()");
+		this.shouldStripNulls = true;
+		return this;
+	}
+	/**
 	* Set an HTTP header for the request.
 	*
 	* @category Database
@@ -193,6 +246,11 @@ var PostgrestBuilder = class {
 		if (this.schema === void 0) {} else if (["GET", "HEAD"].includes(this.method)) this.headers.set("Accept-Profile", this.schema);
 		else this.headers.set("Content-Profile", this.schema);
 		if (this.method !== "GET" && this.method !== "HEAD") this.headers.set("Content-Type", "application/json");
+		if (this.shouldStripNulls) {
+			const currentAccept = this.headers.get("Accept");
+			if (currentAccept === "application/vnd.pgrst.object+json") this.headers.set("Accept", "application/vnd.pgrst.object+json;nulls=stripped");
+			else if (!currentAccept || currentAccept === "application/json") this.headers.set("Accept", "application/vnd.pgrst.array+json;nulls=stripped");
+		}
 		const _fetch = this.fetch;
 		const executeWithRetry = async () => {
 			let attemptCount = 0;
@@ -204,7 +262,7 @@ var PostgrestBuilder = class {
 					res$1 = await _fetch(_this.url.toString(), {
 						method: _this.method,
 						headers: requestHeaders,
-						body: JSON.stringify(_this.body),
+						body: JSON.stringify(_this.body, (_, value) => typeof value === "bigint" ? value.toString() : value),
 						signal: _this.signal
 					});
 				} catch (fetchError) {
@@ -3028,13 +3086,21 @@ var PostgrestQueryBuilder = class {
 	* @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 }
 	* )
 	* ```
 	*/
@@ -4608,15 +4674,12 @@ var PostgrestClient = 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
@@ -4625,25 +4688,14 @@ var PostgrestClient = 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
 	* })
 	* ```
 	*/