UNPKG

@supabase/storage-js

Version:

Isomorphic storage client for Supabase.

163 lines 7.04 kB
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) { function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); } return new (P || (P = Promise))(function (resolve, reject) { function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } } function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } } function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); } step((generator = generator.apply(thisArg, _arguments || [])).next()); }); }; import { DEFAULT_HEADERS } from '../lib/constants'; import { isStorageError } from '../lib/errors'; import { get, post, put, remove } from '../lib/fetch'; import { resolveFetch } from '../lib/helpers'; export default class StorageBucketApi { constructor(url, headers = {}, fetch) { this.url = url; this.headers = Object.assign(Object.assign({}, DEFAULT_HEADERS), headers); this.fetch = resolveFetch(fetch); } /** * Retrieves the details of all Storage buckets within an existing project. */ listBuckets() { return __awaiter(this, void 0, void 0, function* () { try { const data = yield get(this.fetch, `${this.url}/bucket`, { headers: this.headers }); return { data, error: null }; } catch (error) { if (isStorageError(error)) { return { data: null, error }; } throw error; } }); } /** * Retrieves the details of an existing Storage bucket. * * @param id The unique identifier of the bucket you would like to retrieve. */ getBucket(id) { return __awaiter(this, void 0, void 0, function* () { try { const data = yield get(this.fetch, `${this.url}/bucket/${id}`, { headers: this.headers }); return { data, error: null }; } catch (error) { if (isStorageError(error)) { return { data: null, error }; } throw error; } }); } /** * Creates a new Storage bucket * * @param id A unique identifier for the bucket you are creating. * @param options.public The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private. * @param options.fileSizeLimit specifies the max file size in bytes that can be uploaded to this bucket. * The global file size limit takes precedence over this value. * The default value is null, which doesn't set a per bucket file size limit. * @param options.allowedMimeTypes specifies the allowed mime types that this bucket can accept during upload. * The default value is null, which allows files with all mime types to be uploaded. * Each mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png. * @returns newly created bucket id */ createBucket(id, options = { public: false, }) { return __awaiter(this, void 0, void 0, function* () { try { const data = yield post(this.fetch, `${this.url}/bucket`, { id, name: id, public: options.public, file_size_limit: options.fileSizeLimit, allowed_mime_types: options.allowedMimeTypes, }, { headers: this.headers }); return { data, error: null }; } catch (error) { if (isStorageError(error)) { return { data: null, error }; } throw error; } }); } /** * Updates a Storage bucket * * @param id A unique identifier for the bucket you are updating. * @param options.public The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. * @param options.fileSizeLimit specifies the max file size in bytes that can be uploaded to this bucket. * The global file size limit takes precedence over this value. * The default value is null, which doesn't set a per bucket file size limit. * @param options.allowedMimeTypes specifies the allowed mime types that this bucket can accept during upload. * The default value is null, which allows files with all mime types to be uploaded. * Each mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png. */ updateBucket(id, options) { return __awaiter(this, void 0, void 0, function* () { try { const data = yield put(this.fetch, `${this.url}/bucket/${id}`, { id, name: id, public: options.public, file_size_limit: options.fileSizeLimit, allowed_mime_types: options.allowedMimeTypes, }, { headers: this.headers }); return { data, error: null }; } catch (error) { if (isStorageError(error)) { return { data: null, error }; } throw error; } }); } /** * Removes all objects inside a single bucket. * * @param id The unique identifier of the bucket you would like to empty. */ emptyBucket(id) { return __awaiter(this, void 0, void 0, function* () { try { const data = yield post(this.fetch, `${this.url}/bucket/${id}/empty`, {}, { headers: this.headers }); return { data, error: null }; } catch (error) { if (isStorageError(error)) { return { data: null, error }; } throw error; } }); } /** * Deletes an existing bucket. A bucket can't be deleted with existing objects inside it. * You must first `empty()` the bucket. * * @param id The unique identifier of the bucket you would like to delete. */ deleteBucket(id) { return __awaiter(this, void 0, void 0, function* () { try { const data = yield remove(this.fetch, `${this.url}/bucket/${id}`, {}, { headers: this.headers }); return { data, error: null }; } catch (error) { if (isStorageError(error)) { return { data: null, error }; } throw error; } }); } } //# sourceMappingURL=StorageBucketApi.js.map