@supabase/storage-js 1.4.1 → 1.6.0

package/src/lib/StorageBucketApi.ts

@@ -1,14 +1,16 @@
-import { get, post, put, remove } from './fetch'
+import { Fetch, get, post, put, remove } from './fetch'
 import { Bucket } from './types'
 import { DEFAULT_HEADERS } from './constants'
 
 export class StorageBucketApi {
   protected url: string
   protected headers: { [key: string]: string }
+  protected fetch?: Fetch
 
-  constructor(url: string, headers: { [key: string]: string } = {}) {
+  constructor(url: string, headers: { [key: string]: string } = {}, fetch?: Fetch) {
     this.url = url
     this.headers = { ...DEFAULT_HEADERS, ...headers }
+    this.fetch = fetch
   }
 
   /**
@@ -16,7 +18,7 @@ export class StorageBucketApi {
    */
   async listBuckets(): Promise<{ data: Bucket[] | null; error: Error | null }> {
     try {
-      const data = await get(`${this.url}/bucket`, { headers: this.headers })
+      const data = await get(this.fetch, `${this.url}/bucket`, { headers: this.headers })
       return { data, error: null }
     } catch (error) {
       return { data: null, error }
@@ -30,7 +32,7 @@ export class StorageBucketApi {
    */
   async getBucket(id: string): Promise<{ data: Bucket | null; error: Error | null }> {
     try {
-      const data = await get(`${this.url}/bucket/${id}`, { headers: this.headers })
+      const data = await get(this.fetch, `${this.url}/bucket/${id}`, { headers: this.headers })
       return { data, error: null }
     } catch (error) {
       return { data: null, error }
@@ -49,6 +51,7 @@ export class StorageBucketApi {
   ): Promise<{ data: string | null; error: Error | null }> {
     try {
       const data = await post(
+        this.fetch,
         `${this.url}/bucket`,
         { id, name: id, public: options.public },
         { headers: this.headers }
@@ -70,6 +73,7 @@ export class StorageBucketApi {
   ): Promise<{ data: { message: string } | null; error: Error | null }> {
     try {
       const data = await put(
+        this.fetch,
         `${this.url}/bucket/${id}`,
         { id, name: id, public: options.public },
         { headers: this.headers }
@@ -89,7 +93,12 @@ export class StorageBucketApi {
     id: string
   ): Promise<{ data: { message: string } | null; error: Error | null }> {
     try {
-      const data = await post(`${this.url}/bucket/${id}/empty`, {}, { headers: this.headers })
+      const data = await post(
+        this.fetch,
+        `${this.url}/bucket/${id}/empty`,
+        {},
+        { headers: this.headers }
+      )
       return { data, error: null }
     } catch (error) {
       return { data: null, error }
@@ -106,7 +115,12 @@ export class StorageBucketApi {
     id: string
   ): Promise<{ data: { message: string } | null; error: Error | null }> {
     try {
-      const data = await remove(`${this.url}/bucket/${id}`, {}, { headers: this.headers })
+      const data = await remove(
+        this.fetch,
+        `${this.url}/bucket/${id}`,
+        {},
+        { headers: this.headers }
+      )
       return { data, error: null }
     } catch (error) {
       return { data: null, error }

package/src/lib/StorageFileApi.ts

@@ -1,4 +1,4 @@
-import { FetchParameters, get, post, remove } from './fetch'
+import { Fetch, FetchParameters, get, post, remove } from './fetch'
 import { isBrowser } from './helpers'
 import { FileObject, FileOptions, SearchOptions } from './types'
 import fetch from 'cross-fetch'
@@ -22,11 +22,18 @@ export class StorageFileApi {
   protected url: string
   protected headers: { [key: string]: string }
   protected bucketId?: string
+  protected fetch?: Fetch
 
-  constructor(url: string, headers: { [key: string]: string } = {}, bucketId?: string) {
+  constructor(
+    url: string,
+    headers: { [key: string]: string } = {},
+    bucketId?: string,
+    fetch?: Fetch
+  ) {
     this.url = url
     this.headers = headers
     this.bucketId = bucketId
+    this.fetch = fetch
   }
 
   /**
@@ -77,8 +84,10 @@ export class StorageFileApi {
         headers['content-type'] = options.contentType as string
       }
 
-      const _path = this._getFinalPath(path)
-      const res = await fetch(`${this.url}/object/${_path}`, {
+      const cleanPath = this._removeEmptyFolders(path)
+      const _path = this._getFinalPath(cleanPath)
+      const fetcher = this.fetch ?? fetch
+      const res = await fetcher(`${this.url}/object/${_path}`, {
         method,
         body: body as BodyInit,
         headers,
@@ -154,10 +163,10 @@ export class StorageFileApi {
   }
 
   /**
-   * Moves an existing file, optionally renaming it at the same time.
+   * Moves an existing file.
    *
    * @param fromPath The original file path, including the current file name. For example `folder/image.png`.
-   * @param toPath The new file path, including the new file name. For example `folder/image-copy.png`.
+   * @param toPath The new file path, including the new file name. For example `folder/image-new.png`.
    */
   async move(
     fromPath: string,
@@ -165,6 +174,7 @@ export class StorageFileApi {
   ): Promise<{ data: { message: string } | null; error: Error | null }> {
     try {
       const data = await post(
+        this.fetch,
         `${this.url}/object/move`,
         { bucketId: this.bucketId, sourceKey: fromPath, destinationKey: toPath },
         { headers: this.headers }
@@ -176,7 +186,30 @@ export class StorageFileApi {
   }
 
   /**
-   * Create signed url to download file without requiring permissions. This URL can be valid for a set number of seconds.
+   * Copies an existing file.
+   *
+   * @param fromPath The original file path, including the current file name. For example `folder/image.png`.
+   * @param toPath The new file path, including the new file name. For example `folder/image-copy.png`.
+   */
+  async copy(
+    fromPath: string,
+    toPath: string
+  ): Promise<{ data: { message: string } | null; error: Error | null }> {
+    try {
+      const data = await post(
+        this.fetch,
+        `${this.url}/object/copy`,
+        { bucketId: this.bucketId, sourceKey: fromPath, destinationKey: toPath },
+        { headers: this.headers }
+      )
+      return { data, error: null }
+    } catch (error) {
+      return { data: null, error }
+    }
+  }
+
+  /**
+   * Create signed URL to download file without requiring permissions. This URL can be valid for a set number of seconds.
    *
    * @param path The file path to be downloaded, including the current file name. For example `folder/image.png`.
    * @param expiresIn The number of seconds until the signed URL expires. For example, `60` for a URL which is valid for one minute.
@@ -192,6 +225,7 @@ export class StorageFileApi {
     try {
       const _path = this._getFinalPath(path)
       let data = await post(
+        this.fetch,
         `${this.url}/object/sign/${_path}`,
         { expiresIn },
         { headers: this.headers }
@@ -204,6 +238,32 @@ export class StorageFileApi {
     }
   }
 
+  /**
+   * Create signed URLs to download files without requiring permissions. These URLs can be valid for a set number of seconds.
+   *
+   * @param paths The file paths to be downloaded, including the current file names. For example [`folder/image.png`, 'folder2/image2.png'].
+   * @param expiresIn The number of seconds until the signed URLs expire. For example, `60` for URLs which are valid for one minute.
+   */
+  async createSignedUrls(
+    paths: string[],
+    expiresIn: number
+  ): Promise<{
+    data: { path: string; signedURL: string }[] | null
+    error: Error | null
+  }> {
+    try {
+      const data = await post(
+        this.fetch,
+        `${this.url}/object/sign/${this.bucketId}`,
+        { expiresIn, paths },
+        { headers: this.headers }
+      )
+      return { data, error: null }
+    } catch (error) {
+      return { data: null, error }
+    }
+  }
+
   /**
    * Downloads a file.
    *
@@ -212,7 +272,7 @@ export class StorageFileApi {
   async download(path: string): Promise<{ data: Blob | null; error: Error | null }> {
     try {
       const _path = this._getFinalPath(path)
-      const res = await get(`${this.url}/object/${_path}`, {
+      const res = await get(this.fetch, `${this.url}/object/${_path}`, {
         headers: this.headers,
         noResolveJson: true,
       })
@@ -248,11 +308,12 @@ export class StorageFileApi {
   /**
    * Deletes files within the same bucket
    *
-   * @param paths An array of files to be deletes, including the path and file name. For example [`folder/image.png`].
+   * @param paths An array of files to be deleted, including the path and file name. For example [`folder/image.png`].
    */
   async remove(paths: string[]): Promise<{ data: FileObject[] | null; error: Error | null }> {
     try {
       const data = await remove(
+        this.fetch,
         `${this.url}/object/${this.bucketId}`,
         { prefixes: paths },
         { headers: this.headers }
@@ -307,6 +368,7 @@ export class StorageFileApi {
     try {
       const body = { ...DEFAULT_SEARCH_OPTIONS, ...options, prefix: path || '' }
       const data = await post(
+        this.fetch,
         `${this.url}/object/list/${this.bucketId}`,
         body,
         { headers: this.headers },
@@ -321,4 +383,8 @@ export class StorageFileApi {
   _getFinalPath(path: string) {
     return `${this.bucketId}/${path}`
   }
+
+  _removeEmptyFolders(path: string) {
+    return path.replace(/^\/|\/$/g, '').replace(/\/+/g, '/')
+  }
 }

package/src/lib/fetch.ts

@@ -1,4 +1,6 @@
-import fetch from 'cross-fetch'
+import crossFetch from 'cross-fetch'
+
+export type Fetch = typeof fetch
 
 export interface FetchOptions {
   headers?: {
@@ -46,6 +48,7 @@ const _getRequestParams = (
 }
 
 async function _handleRequest(
+  fetcher: Fetch = crossFetch,
   method: RequestMethodType,
   url: string,
   options?: FetchOptions,
@@ -53,7 +56,7 @@ async function _handleRequest(
   body?: object
 ): Promise<any> {
   return new Promise((resolve, reject) => {
-    fetch(url, _getRequestParams(method, options, parameters, body))
+    fetcher(url, _getRequestParams(method, options, parameters, body))
       .then((result) => {
         if (!result.ok) throw result
         if (options?.noResolveJson) return resolve(result)
@@ -65,36 +68,40 @@ async function _handleRequest(
 }
 
 export async function get(
+  fetcher: Fetch | undefined,
   url: string,
   options?: FetchOptions,
   parameters?: FetchParameters
 ): Promise<any> {
-  return _handleRequest('GET', url, options, parameters)
+  return _handleRequest(fetcher, 'GET', url, options, parameters)
 }
 
 export async function post(
+  fetcher: Fetch | undefined,
   url: string,
   body: object,
   options?: FetchOptions,
   parameters?: FetchParameters
 ): Promise<any> {
-  return _handleRequest('POST', url, options, parameters, body)
+  return _handleRequest(fetcher, 'POST', url, options, parameters, body)
 }
 
 export async function put(
+  fetcher: Fetch | undefined,
   url: string,
   body: object,
   options?: FetchOptions,
   parameters?: FetchParameters
 ): Promise<any> {
-  return _handleRequest('PUT', url, options, parameters, body)
+  return _handleRequest(fetcher, 'PUT', url, options, parameters, body)
 }
 
 export async function remove(
+  fetcher: Fetch | undefined,
   url: string,
   body: object,
   options?: FetchOptions,
   parameters?: FetchParameters
 ): Promise<any> {
-  return _handleRequest('DELETE', url, options, parameters, body)
+  return _handleRequest(fetcher, 'DELETE', url, options, parameters, body)
 }