@supabase/storage-js 2.100.0 → 2.100.1

package/dist/index.mjs

@@ -407,7 +407,7 @@ var BaseApiClient = class {
 	* @param operation - Async function that performs the API call
 	* @returns Promise with { data, error } tuple
 	*
-	* @example
+	* @example Handling an operation
 	* ```typescript
 	* async listBuckets() {
 	*   return this.handleOperation(async () => {
@@ -613,6 +613,13 @@ var StorageFileApi = class extends BaseApiClient {
 	*     contentType: 'image/png'
 	*   })
 	* ```
+	*
+	* @remarks
+	* - RLS policy permissions required:
+	*   - `buckets` table permissions: none
+	*   - `objects` table permissions: only `insert` when you are uploading new files and `select`, `insert` and `update` when you are upserting files
+	* - Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works
+	* - For React Native, using either `Blob`, `File` or `FormData` does not work as intended. Upload file using `ArrayBuffer` from base64 file data instead, see example below.
 	*/
 	async upload(path, fileBody, fileOptions) {
 		return this.uploadOrUpdate("POST", path, fileBody, fileOptions);
@@ -647,6 +654,12 @@ var StorageFileApi = class extends BaseApiClient {
 	*   "error": null
 	* }
 	* ```
+	*
+	* @remarks
+	* - RLS policy permissions required:
+	*   - `buckets` table permissions: none
+	*   - `objects` table permissions: none
+	* - Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works
 	*/
 	async uploadToSignedUrl(path, token, fileBody, fileOptions) {
 		var _this3 = this;
@@ -656,7 +669,7 @@ var StorageFileApi = class extends BaseApiClient {
 		url.searchParams.set("token", token);
 		return _this3.handleOperation(async () => {
 			let body;
-			const options = _objectSpread2({ upsert: DEFAULT_FILE_OPTIONS.upsert }, fileOptions);
+			const options = _objectSpread2(_objectSpread2({}, DEFAULT_FILE_OPTIONS), fileOptions);
 			const headers = _objectSpread2(_objectSpread2({}, _this3.headers), { "x-upsert": String(options.upsert) });
 			if (typeof Blob !== "undefined" && fileBody instanceof Blob) {
 				body = new FormData();
@@ -705,6 +718,12 @@ var StorageFileApi = class extends BaseApiClient {
 	*   "error": null
 	* }
 	* ```
+	*
+	* @remarks
+	* - RLS policy permissions required:
+	*   - `buckets` table permissions: none
+	*   - `objects` table permissions: `insert`
+	* - Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works
 	*/
 	async createSignedUploadUrl(path, options) {
 		var _this4 = this;
@@ -766,6 +785,13 @@ var StorageFileApi = class extends BaseApiClient {
 	*     contentType: 'image/png'
 	*   })
 	* ```
+	*
+	* @remarks
+	* - RLS policy permissions required:
+	*   - `buckets` table permissions: none
+	*   - `objects` table permissions: `update` and `select`
+	* - Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works
+	* - For React Native, using either `Blob`, `File` or `FormData` does not work as intended. Update file using `ArrayBuffer` from base64 file data instead, see example below.
 	*/
 	async update(path, fileBody, fileOptions) {
 		return this.uploadOrUpdate("PUT", path, fileBody, fileOptions);
@@ -796,6 +822,12 @@ var StorageFileApi = class extends BaseApiClient {
 	*   "error": null
 	* }
 	* ```
+	*
+	* @remarks
+	* - RLS policy permissions required:
+	*   - `buckets` table permissions: none
+	*   - `objects` table permissions: `update` and `select`
+	* - Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works
 	*/
 	async move(fromPath, toPath, options) {
 		var _this6 = this;
@@ -834,6 +866,12 @@ var StorageFileApi = class extends BaseApiClient {
 	*   "error": null
 	* }
 	* ```
+	*
+	* @remarks
+	* - RLS policy permissions required:
+	*   - `buckets` table permissions: none
+	*   - `objects` table permissions: `insert` and `select`
+	* - Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works
 	*/
 	async copy(fromPath, toPath, options) {
 		var _this7 = this;
@@ -896,6 +934,12 @@ var StorageFileApi = class extends BaseApiClient {
 	*     download: true,
 	*   })
 	* ```
+	*
+	* @remarks
+	* - RLS policy permissions required:
+	*   - `buckets` table permissions: none
+	*   - `objects` table permissions: `select`
+	* - Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works
 	*/
 	async createSignedUrl(path, expiresIn, options) {
 		var _this8 = this;
@@ -945,6 +989,12 @@ var StorageFileApi = class extends BaseApiClient {
 	*   "error": null
 	* }
 	* ```
+	*
+	* @remarks
+	* - RLS policy permissions required:
+	*   - `buckets` table permissions: none
+	*   - `objects` table permissions: `select`
+	* - Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works
 	*/
 	async createSignedUrls(paths, expiresIn, options) {
 		var _this9 = this;
@@ -1014,6 +1064,12 @@ var StorageFileApi = class extends BaseApiClient {
 	*   .from('avatars')
 	*   .download('folder/avatar1.png', {}, { signal: controller.signal })
 	* ```
+	*
+	* @remarks
+	* - RLS policy permissions required:
+	*   - `buckets` table permissions: none
+	*   - `objects` table permissions: `select`
+	* - Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works
 	*/
 	download(path, options, parameters) {
 		const renderPath = typeof (options === null || options === void 0 ? void 0 : options.transform) !== "undefined" ? "render/image/authenticated" : "object";
@@ -1142,6 +1198,13 @@ var StorageFileApi = class extends BaseApiClient {
 	*     download: true,
 	*   })
 	* ```
+	*
+	* @remarks
+	* - The bucket needs to be set to public, either via [updateBucket()](/docs/reference/javascript/storage-updatebucket) or by going to Storage on [supabase.com/dashboard](https://supabase.com/dashboard), clicking the overflow menu on a bucket and choosing "Make public"
+	* - RLS policy permissions required:
+	*   - `buckets` table permissions: none
+	*   - `objects` table permissions: none
+	* - Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works
 	*/
 	getPublicUrl(path, options) {
 		const _path = this._getFinalPath(path);
@@ -1180,6 +1243,12 @@ var StorageFileApi = class extends BaseApiClient {
 	*   "error": null
 	* }
 	* ```
+	*
+	* @remarks
+	* - RLS policy permissions required:
+	*   - `buckets` table permissions: none
+	*   - `objects` table permissions: `delete` and `select`
+	* - Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works
 	*/
 	async remove(paths) {
 		var _this12 = this;
@@ -1233,7 +1302,7 @@ var StorageFileApi = class extends BaseApiClient {
 	* })
 	* ```
 	*
-	* Response (file entry):
+	* Response:
 	* ```json
 	* {
 	*   "data": [
@@ -1270,6 +1339,12 @@ var StorageFileApi = class extends BaseApiClient {
 	*     search: 'jon'
 	*   })
 	* ```
+	*
+	* @remarks
+	* - RLS policy permissions required:
+	*   - `buckets` table permissions: none
+	*   - `objects` table permissions: `select`
+	* - Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works
 	*/
 	async list(path, options, parameters) {
 		var _this13 = this;
@@ -1357,7 +1432,7 @@ var StorageFileApi = class extends BaseApiClient {
 
 //#endregion
 //#region src/lib/version.ts
-const version = "2.100.0";
+const version = "2.100.1";
 
 //#endregion
 //#region src/lib/constants.ts
@@ -1406,6 +1481,12 @@ var StorageBucketApi = class extends BaseApiClient {
 	*     search: 'prod'
 	*   })
 	* ```
+	*
+	* @remarks
+	* - RLS policy permissions required:
+	*   - `buckets` table permissions: `select`
+	*   - `objects` table permissions: none
+	* - Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works
 	*/
 	async listBuckets(options) {
 		var _this = this;
@@ -1446,6 +1527,12 @@ var StorageBucketApi = class extends BaseApiClient {
 	*   "error": null
 	* }
 	* ```
+	*
+	* @remarks
+	* - RLS policy permissions required:
+	*   - `buckets` table permissions: `select`
+	*   - `objects` table permissions: none
+	* - Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works
 	*/
 	async getBucket(id) {
 		var _this2 = this;
@@ -1489,6 +1576,12 @@ var StorageBucketApi = class extends BaseApiClient {
 	*   "error": null
 	* }
 	* ```
+	*
+	* @remarks
+	* - RLS policy permissions required:
+	*   - `buckets` table permissions: `insert`
+	*   - `objects` table permissions: none
+	* - Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works
 	*/
 	async createBucket(id, options = { public: false }) {
 		var _this3 = this;
@@ -1537,6 +1630,12 @@ var StorageBucketApi = class extends BaseApiClient {
 	*   "error": null
 	* }
 	* ```
+	*
+	* @remarks
+	* - RLS policy permissions required:
+	*   - `buckets` table permissions: `select` and `update`
+	*   - `objects` table permissions: none
+	* - Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works
 	*/
 	async updateBucket(id, options) {
 		var _this4 = this;
@@ -1573,6 +1672,12 @@ var StorageBucketApi = class extends BaseApiClient {
 	*   "error": null
 	* }
 	* ```
+	*
+	* @remarks
+	* - RLS policy permissions required:
+	*   - `buckets` table permissions: `select`
+	*   - `objects` table permissions: `select` and `delete`
+	* - Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works
 	*/
 	async emptyBucket(id) {
 		var _this5 = this;
@@ -1604,6 +1709,12 @@ var StorageBucketApi = class extends BaseApiClient {
 	*   "error": null
 	* }
 	* ```
+	*
+	* @remarks
+	* - RLS policy permissions required:
+	*   - `buckets` table permissions: `select` and `delete`
+	*   - `objects` table permissions: none
+	* - Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works
 	*/
 	async deleteBucket(id) {
 		var _this6 = this;
@@ -1643,7 +1754,7 @@ var StorageAnalyticsClient = class extends BaseApiClient {
 	* @param headers - HTTP headers to include in requests
 	* @param fetch - Optional custom fetch implementation
 	*
-	* @example
+	* @example Creating a StorageAnalyticsClient instance
 	* ```typescript
 	* const client = new StorageAnalyticsClient(url, headers)
 	* ```
@@ -1686,6 +1797,10 @@ var StorageAnalyticsClient = class extends BaseApiClient {
 	*   "error": null
 	* }
 	* ```
+	*
+	* @remarks
+	* - Creates a new analytics bucket using Iceberg tables
+	* - Analytics buckets are optimized for analytical queries and data processing
 	*/
 	async createBucket(name) {
 		var _this = this;
@@ -1738,6 +1853,10 @@ var StorageAnalyticsClient = class extends BaseApiClient {
 	*   "error": null
 	* }
 	* ```
+	*
+	* @remarks
+	* - Retrieves the details of all Analytics Storage buckets within an existing project
+	* - Only returns buckets of type 'ANALYTICS'
 	*/
 	async listBuckets(options) {
 		var _this2 = this;
@@ -1783,6 +1902,9 @@ var StorageAnalyticsClient = class extends BaseApiClient {
 	*   "error": null
 	* }
 	* ```
+	*
+	* @remarks
+	* - Deletes an analytics bucket
 	*/
 	async deleteBucket(bucketName) {
 		var _this3 = this;
@@ -2157,7 +2279,7 @@ var StorageVectorsClient = class extends VectorBucketApi {
 	* @param options.headers - Optional headers (for example `Authorization`) applied to every request.
 	* @param options.fetch - Optional custom `fetch` implementation for non-browser runtimes.
 	*
-	* @example
+	* @example Creating a StorageVectorsClient instance
 	* ```typescript
 	* const client = new StorageVectorsClient(url, options)
 	* ```
@@ -2178,7 +2300,7 @@ var StorageVectorsClient = class extends VectorBucketApi {
 	* @param vectorBucketName - Name of the vector bucket
 	* @returns Bucket-scoped client with index and vector operations
 	*
-	* @example
+	* @example Accessing a vector bucket
 	* ```typescript
 	* const bucket = supabase.storage.vectors.from('embeddings-prod')
 	* ```
@@ -2199,7 +2321,7 @@ var StorageVectorsClient = class extends VectorBucketApi {
 	* @param vectorBucketName - Unique name for the vector bucket
 	* @returns Promise with empty response on success or error
 	*
-	* @example
+	* @example Creating a vector bucket
 	* ```typescript
 	* const { data, error } = await supabase
 	*   .storage
@@ -2223,7 +2345,7 @@ var StorageVectorsClient = class extends VectorBucketApi {
 	* @param vectorBucketName - Name of the vector bucket
 	* @returns Promise with bucket metadata or error
 	*
-	* @example
+	* @example Get bucket metadata
 	* ```typescript
 	* const { data, error } = await supabase
 	*   .storage
@@ -2249,7 +2371,7 @@ var StorageVectorsClient = class extends VectorBucketApi {
 	* @param options - Optional filters (prefix, maxResults, nextToken)
 	* @returns Promise with list of buckets or error
 	*
-	* @example
+	* @example List vector buckets
 	* ```typescript
 	* const { data, error } = await supabase
 	*   .storage
@@ -2278,7 +2400,7 @@ var StorageVectorsClient = class extends VectorBucketApi {
 	* @param vectorBucketName - Name of the vector bucket to delete
 	* @returns Promise with empty response on success or error
 	*
-	* @example
+	* @example Delete a vector bucket
 	* ```typescript
 	* const { data, error } = await supabase
 	*   .storage
@@ -2309,7 +2431,7 @@ var VectorBucketScope = class extends VectorIndexApi {
 	* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
 	*
 	* @category Vector Buckets
-	* @example
+	* @example Creating a vector bucket scope
 	* ```typescript
 	* const bucket = supabase.storage.vectors.from('embeddings-prod')
 	* ```
@@ -2331,7 +2453,7 @@ var VectorBucketScope = class extends VectorIndexApi {
 	* @param options - Index configuration (vectorBucketName is automatically set)
 	* @returns Promise with empty response on success or error
 	*
-	* @example
+	* @example Creating a vector index
 	* ```typescript
 	* const bucket = supabase.storage.vectors.from('embeddings-prod')
 	* await bucket.createIndex({
@@ -2362,7 +2484,7 @@ var VectorBucketScope = class extends VectorIndexApi {
 	* @param options - Listing options (vectorBucketName is automatically set)
 	* @returns Promise with response containing indexes array and pagination token or error
 	*
-	* @example
+	* @example List indexes
 	* ```typescript
 	* const bucket = supabase.storage.vectors.from('embeddings-prod')
 	* const { data } = await bucket.listIndexes({ prefix: 'documents-' })
@@ -2385,7 +2507,7 @@ var VectorBucketScope = class extends VectorIndexApi {
 	* @param indexName - Name of the index to retrieve
 	* @returns Promise with index metadata or error
 	*
-	* @example
+	* @example Get index metadata
 	* ```typescript
 	* const bucket = supabase.storage.vectors.from('embeddings-prod')
 	* const { data } = await bucket.getIndex('documents-openai')
@@ -2409,7 +2531,7 @@ var VectorBucketScope = class extends VectorIndexApi {
 	* @param indexName - Name of the index to delete
 	* @returns Promise with empty response on success or error
 	*
-	* @example
+	* @example Delete an index
 	* ```typescript
 	* const bucket = supabase.storage.vectors.from('embeddings-prod')
 	* await bucket.deleteIndex('old-index')
@@ -2432,7 +2554,7 @@ var VectorBucketScope = class extends VectorIndexApi {
 	* @param indexName - Name of the index
 	* @returns Index-scoped client with vector data operations
 	*
-	* @example
+	* @example Accessing an index
 	* ```typescript
 	* const index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')
 	*
@@ -2473,7 +2595,7 @@ var VectorIndexScope = class extends VectorDataApi {
 	* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
 	*
 	* @category Vector Buckets
-	* @example
+	* @example Creating a vector index scope
 	* ```typescript
 	* const index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')
 	* ```
@@ -2496,7 +2618,7 @@ var VectorIndexScope = class extends VectorDataApi {
 	* @param options - Vector insertion options (bucket and index names automatically set)
 	* @returns Promise with empty response on success or error
 	*
-	* @example
+	* @example Insert vectors into an index
 	* ```typescript
 	* const index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')
 	* await index.putVectors({
@@ -2530,7 +2652,7 @@ var VectorIndexScope = class extends VectorDataApi {
 	* @param options - Vector retrieval options (bucket and index names automatically set)
 	* @returns Promise with response containing vectors array or error
 	*
-	* @example
+	* @example Get vectors by keys
 	* ```typescript
 	* const index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')
 	* const { data } = await index.getVectors({
@@ -2559,7 +2681,7 @@ var VectorIndexScope = class extends VectorDataApi {
 	* @param options - Listing options (bucket and index names automatically set)
 	* @returns Promise with response containing vectors array and pagination token or error
 	*
-	* @example
+	* @example List vectors with pagination
 	* ```typescript
 	* const index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')
 	* const { data } = await index.listVectors({
@@ -2588,7 +2710,7 @@ var VectorIndexScope = class extends VectorDataApi {
 	* @param options - Query options (bucket and index names automatically set)
 	* @returns Promise with response containing matches array of similar vectors ordered by distance or error
 	*
-	* @example
+	* @example Query similar vectors
 	* ```typescript
 	* const index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')
 	* const { data } = await index.queryVectors({
@@ -2620,7 +2742,7 @@ var VectorIndexScope = class extends VectorDataApi {
 	* @param options - Deletion options (bucket and index names automatically set)
 	* @returns Promise with empty response on success or error
 	*
-	* @example
+	* @example Delete vectors by keys
 	* ```typescript
 	* const index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')
 	* await index.deleteVectors({
@@ -2644,7 +2766,7 @@ var StorageClient = class extends StorageBucketApi {
 	* Creates a client for Storage buckets, files, analytics, and vectors.
 	*
 	* @category File Buckets
-	* @example
+	* @example Creating a Storage client
 	* ```ts
 	* import { StorageClient } from '@supabase/storage-js'
 	*
@@ -2663,7 +2785,7 @@ var StorageClient = class extends StorageBucketApi {
 	* @category File Buckets
 	* @param id The bucket id to operate on.
 	*
-	* @example
+	* @example Accessing a bucket
 	* ```typescript
 	* const avatars = supabase.storage.from('avatars')
 	* ```