@supabase/storage-js 1.7.0 → 1.7.1

package/README.md

@@ -4,6 +4,142 @@ JS Client library to interact with Supabase Storage.
 
 - Documentation: https://supabase.io/docs/reference/javascript/storage-createbucket
 
+## Quick Start Guide
+
+### Installing the module
+
+```bash
+npm install @supabase/storage-js
+```
+
+### Connecting to the storage backend
+
+```js
+import { SupabaseStorageClient } from '@supabase/storage-js'
+
+const STORAGE_URL = 'https://<project_ref>.supabase.co/storage/v1'
+const SERVICE_KEY = '<service_role>' //! service key, not anon key
+
+const storageClient = new SupabaseStorageClient(STORAGE_URL, {
+  apikey: SERVICE_KEY,
+  Authorization: `Bearer ${SERVICE_KEY}`,
+})
+```
+
+### Handling resources
+
+#### Handling Storage Buckets
+
+- Create a new Storage bucket:
+
+  ```js
+  const { data, error } = await storageClient.createBucket(
+    'test_bucket', // Bucket name (must be unique)
+    { public: false } // Bucket options
+  )
+  ```
+
+- Retrieve the details of an existing Storage bucket:
+
+  ```js
+  const { data, error } = await storageClient.getBucket('test_bucket')
+  ```
+
+- Update a new Storage bucket:
+
+  ```js
+  const { data, error } = await storageClient.updateBucket(
+    'test_bucket', // Bucket name
+    { public: false } // Bucket options
+  )
+  ```
+
+- Remove all objects inside a single bucket:
+
+  ```js
+  const { data, error } = await storageClient.emptyBucket('test_bucket')
+  ```
+
+- Delete an existing bucket (a bucket can't be deleted with existing objects inside it):
+
+  ```js
+  const { data, error } = await storageClient.deleteBucket('test_bucket')
+  ```
+
+- Retrieve the details of all Storage buckets within an existing project:
+
+  ```js
+  const { data, error } = await storageClient.listBuckets()
+  ```
+
+#### Handling Files
+
+- Upload a file to an existing bucket:
+
+  ```js
+  const fileBody = ... // load your file here
+
+  const { data, error } = await storageClient.from('bucket').upload('path/to/file', fileBody)
+  ```
+
+  > Note: The `upload` method also accepts a map of optional parameters. For a complete list see the [Supabase API reference](https://supabase.com/docs/reference/javascript/storage-from-upload).
+
+- Download a file from an exisiting bucket:
+
+  ```js
+  const { data, error } = await storageClient.from('bucket').download('path/to/file')
+  ```
+
+- List all the files within a bucket:
+
+  ```js
+  const { data, error } = await storageClient.from('bucket').list('folder')
+  ```
+
+  > Note: The `list` method also accepts a map of optional parameters. For a complete list see the [Supabase API reference](https://supabase.com/docs/reference/javascript/storage-from-list).
+
+- Replace an existing file at the specified path with a new one:
+
+  ```js
+  const fileBody = ... // load your file here
+
+  const { data, error } = await storageClient
+    .from('bucket')
+    .update('path/to/file', fileBody)
+  ```
+
+  > Note: The `upload` method also accepts a map of optional parameters. For a complete list see the [Supabase API reference](https://supabase.com/docs/reference/javascript/storage-from-upload).
+
+- Move an existing file:
+
+  ```js
+  const { data, error } = await storageClient
+    .from('bucket')
+    .move('old/path/to/file', 'new/path/to/file')
+  ```
+
+- Delete files within the same bucket:
+
+  ```js
+  const { data, error } = await storageClient.from('bucket').remove(['path/to/file'])
+  ```
+
+- Create signed URL to download file without requiring permissions:
+
+  ```js
+  const expireIn = 60
+  
+  const { data, error } = await storageClient
+    .from('bucket')
+    .createSignedUrl('path/to/file', expireIn)
+  ```
+
+- Retrieve URLs for assets in public buckets:
+
+  ```js
+  const { data, error } = await storageClient.from('public-bucket').getPublicUrl('path/to/file')
+  ```
+
 ## Sponsors
 
 We are building the features of Firebase using enterprise-grade, open source products. We support existing communities wherever possible, and if the products don’t exist we build them and open source them ourselves. Thanks to these sponsors who are making the OSS ecosystem better for everyone.

package/dist/main/lib/StorageBucketApi.d.ts

@@ -10,7 +10,7 @@ export declare class StorageBucketApi {
         [key: string]: string;
     }, fetch?: Fetch);
     /**
-     * Retrieves the details of all Storage buckets within an existing product.
+     * Retrieves the details of all Storage buckets within an existing project.
      */
     listBuckets(): Promise<{
         data: Bucket[] | null;
@@ -40,7 +40,7 @@ export declare class StorageBucketApi {
     /**
      * Updates a new Storage bucket
      *
-     * @param id A unique identifier for the bucket you are creating.
+     * @param id A unique identifier for the bucket you are updating.
      */
     updateBucket(id: string, options: {
         public: boolean;

package/dist/main/lib/StorageBucketApi.js

@@ -20,7 +20,7 @@ class StorageBucketApi {
         this.fetch = helpers_1.resolveFetch(fetch);
     }
     /**
-     * Retrieves the details of all Storage buckets within an existing product.
+     * Retrieves the details of all Storage buckets within an existing project.
      */
     listBuckets() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -69,7 +69,7 @@ class StorageBucketApi {
     /**
      * Updates a new Storage bucket
      *
-     * @param id A unique identifier for the bucket you are creating.
+     * @param id A unique identifier for the bucket you are updating.
      */
     updateBucket(id, options) {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/module/lib/StorageBucketApi.d.ts

@@ -10,7 +10,7 @@ export declare class StorageBucketApi {
         [key: string]: string;
     }, fetch?: Fetch);
     /**
-     * Retrieves the details of all Storage buckets within an existing product.
+     * Retrieves the details of all Storage buckets within an existing project.
      */
     listBuckets(): Promise<{
         data: Bucket[] | null;
@@ -40,7 +40,7 @@ export declare class StorageBucketApi {
     /**
      * Updates a new Storage bucket
      *
-     * @param id A unique identifier for the bucket you are creating.
+     * @param id A unique identifier for the bucket you are updating.
      */
     updateBucket(id: string, options: {
         public: boolean;

package/dist/module/lib/StorageBucketApi.js

@@ -17,7 +17,7 @@ export class StorageBucketApi {
         this.fetch = resolveFetch(fetch);
     }
     /**
-     * Retrieves the details of all Storage buckets within an existing product.
+     * Retrieves the details of all Storage buckets within an existing project.
      */
     listBuckets() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -66,7 +66,7 @@ export class StorageBucketApi {
     /**
      * Updates a new Storage bucket
      *
-     * @param id A unique identifier for the bucket you are creating.
+     * @param id A unique identifier for the bucket you are updating.
      */
     updateBucket(id, options) {
         return __awaiter(this, void 0, void 0, function* () {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supabase/storage-js",
-  "version": "1.7.0",
+  "version": "1.7.1",
   "description": "Isomorphic storage client for Supabase.",
   "keywords": [
     "javascript",

package/src/lib/StorageBucketApi.ts

@@ -15,7 +15,7 @@ export class StorageBucketApi {
   }
 
   /**
-   * Retrieves the details of all Storage buckets within an existing product.
+   * Retrieves the details of all Storage buckets within an existing project.
    */
   async listBuckets(): Promise<{ data: Bucket[] | null; error: Error | null }> {
     try {
@@ -66,7 +66,7 @@ export class StorageBucketApi {
   /**
    * Updates a new Storage bucket
    *
-   * @param id A unique identifier for the bucket you are creating.
+   * @param id A unique identifier for the bucket you are updating.
    */
   async updateBucket(
     id: string,