@supabase/storage-js 2.1.0-next.3 → 2.1.0

package/README.md

@@ -15,12 +15,12 @@ npm install @supabase/storage-js
 ### Connecting to the storage backend
 
 ```js
-import { SupabaseStorageClient } from '@supabase/storage-js'
+import { StorageClient } 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, {
+const storageClient = new StorageClient(STORAGE_URL, {
   apikey: SERVICE_KEY,
   Authorization: `Bearer ${SERVICE_KEY}`,
 })

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

@@ -63,8 +63,20 @@ export interface Metadata {
     name: string;
 }
 export interface TransformOptions {
+    /**
+     * The width of the image in pixels.
+     */
     width?: number;
+    /**
+     * The height of the image in pixels.
+     */
     height?: number;
+    /**
+     * The resize mode can be cover, contain or fill. Defaults to cover.
+     * Cover resizes the image to maintain it's aspect ratio while filling the entire width and height.
+     * Contain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.
+     * Fill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit.
+     */
     resize?: 'cover' | 'contain' | 'fill';
 }
 //# sourceMappingURL=types.d.ts.map

package/dist/main/lib/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/lib/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,OAAO,CAAA;CAChB;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,MAAM,CAAA;IACb,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,gBAAgB,EAAE,MAAM,CAAA;IACxB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC7B,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,MAAM;IACrB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAA;CACrB;AAGD,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,gBAAgB;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM,CAAA;CACtC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/lib/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,OAAO,CAAA;CAChB;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,MAAM,CAAA;IACb,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,gBAAgB,EAAE,MAAM,CAAA;IACxB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC7B,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,MAAM;IACrB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAA;CACrB;AAGD,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;;;OAKG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM,CAAA;CACtC"}

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

@@ -1,2 +1,2 @@
-export declare const version = "2.1.0-next.3";
+export declare const version = "2.1.0";
 //# sourceMappingURL=version.d.ts.map

package/dist/main/lib/version.js

@@ -2,5 +2,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
 // generated by genversion
-exports.version = '2.1.0-next.3';
+exports.version = '2.1.0';
 //# sourceMappingURL=version.js.map

package/dist/main/packages/StorageFileApi.d.ts

@@ -86,7 +86,7 @@ export default class StorageFileApi {
      * @param path The file path, 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.
      * @param options.download triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
-     * @param options.transform The visiting client will receive the transformed variant of the image by providing transform options
+     * @param options.transform Transform the asset before serving it to the client.
      */
     createSignedUrl(path: string, expiresIn: number, options?: {
         download?: string | boolean;
@@ -124,7 +124,7 @@ export default class StorageFileApi {
      * Downloads a file.
      *
      * @param path The full path and file name of the file to be downloaded. For example `folder/image.png`.
-     * @param options.download download a transformed image
+     * @param options.transform Transform the asset before serving it to the client.
      */
     download(path: string, options?: {
         transform?: TransformOptions;
@@ -140,8 +140,8 @@ export default class StorageFileApi {
      * This function does not verify if the bucket is public. If a public URL is created for a bucket which is not public, you will not be able to download the asset.
      *
      * @param path The path and name of the file to generate the public URL for. For example `folder/image.png`.
-     * @param options.download triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
-     * @param options.transform adds image transformations parameters to the generated url
+     * @param options.download Triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
+     * @param options.transform Transform the asset before serving it to the client.
      */
     getPublicUrl(path: string, options?: {
         download?: string | boolean;

package/dist/main/packages/StorageFileApi.js

@@ -153,7 +153,7 @@ class StorageFileApi {
      * @param path The file path, 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.
      * @param options.download triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
-     * @param options.transform The visiting client will receive the transformed variant of the image by providing transform options
+     * @param options.transform Transform the asset before serving it to the client.
      */
     createSignedUrl(path, expiresIn, options) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -208,7 +208,7 @@ class StorageFileApi {
      * Downloads a file.
      *
      * @param path The full path and file name of the file to be downloaded. For example `folder/image.png`.
-     * @param options.download download a transformed image
+     * @param options.transform Transform the asset before serving it to the client.
      */
     download(path, options) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -238,8 +238,8 @@ class StorageFileApi {
      * This function does not verify if the bucket is public. If a public URL is created for a bucket which is not public, you will not be able to download the asset.
      *
      * @param path The path and name of the file to generate the public URL for. For example `folder/image.png`.
-     * @param options.download triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
-     * @param options.transform adds image transformations parameters to the generated url
+     * @param options.download Triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
+     * @param options.transform Transform the asset before serving it to the client.
      */
     getPublicUrl(path, options) {
         const _path = this._getFinalPath(path);

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

@@ -63,8 +63,20 @@ export interface Metadata {
     name: string;
 }
 export interface TransformOptions {
+    /**
+     * The width of the image in pixels.
+     */
     width?: number;
+    /**
+     * The height of the image in pixels.
+     */
     height?: number;
+    /**
+     * The resize mode can be cover, contain or fill. Defaults to cover.
+     * Cover resizes the image to maintain it's aspect ratio while filling the entire width and height.
+     * Contain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.
+     * Fill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit.
+     */
     resize?: 'cover' | 'contain' | 'fill';
 }
 //# sourceMappingURL=types.d.ts.map

package/dist/module/lib/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/lib/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,OAAO,CAAA;CAChB;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,MAAM,CAAA;IACb,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,gBAAgB,EAAE,MAAM,CAAA;IACxB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC7B,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,MAAM;IACrB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAA;CACrB;AAGD,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,gBAAgB;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM,CAAA;CACtC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/lib/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,OAAO,CAAA;CAChB;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,MAAM,CAAA;IACb,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,gBAAgB,EAAE,MAAM,CAAA;IACxB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC7B,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,MAAM;IACrB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAA;CACrB;AAGD,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;;;OAKG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM,CAAA;CACtC"}

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

@@ -1,2 +1,2 @@
-export declare const version = "2.1.0-next.3";
+export declare const version = "2.1.0";
 //# sourceMappingURL=version.d.ts.map

package/dist/module/lib/version.js

@@ -1,3 +1,3 @@
 // generated by genversion
-export const version = '2.1.0-next.3';
+export const version = '2.1.0';
 //# sourceMappingURL=version.js.map

package/dist/module/packages/StorageFileApi.d.ts

@@ -86,7 +86,7 @@ export default class StorageFileApi {
      * @param path The file path, 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.
      * @param options.download triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
-     * @param options.transform The visiting client will receive the transformed variant of the image by providing transform options
+     * @param options.transform Transform the asset before serving it to the client.
      */
     createSignedUrl(path: string, expiresIn: number, options?: {
         download?: string | boolean;
@@ -124,7 +124,7 @@ export default class StorageFileApi {
      * Downloads a file.
      *
      * @param path The full path and file name of the file to be downloaded. For example `folder/image.png`.
-     * @param options.download download a transformed image
+     * @param options.transform Transform the asset before serving it to the client.
      */
     download(path: string, options?: {
         transform?: TransformOptions;
@@ -140,8 +140,8 @@ export default class StorageFileApi {
      * This function does not verify if the bucket is public. If a public URL is created for a bucket which is not public, you will not be able to download the asset.
      *
      * @param path The path and name of the file to generate the public URL for. For example `folder/image.png`.
-     * @param options.download triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
-     * @param options.transform adds image transformations parameters to the generated url
+     * @param options.download Triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
+     * @param options.transform Transform the asset before serving it to the client.
      */
     getPublicUrl(path: string, options?: {
         download?: string | boolean;

package/dist/module/packages/StorageFileApi.js

@@ -151,7 +151,7 @@ export default class StorageFileApi {
      * @param path The file path, 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.
      * @param options.download triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
-     * @param options.transform The visiting client will receive the transformed variant of the image by providing transform options
+     * @param options.transform Transform the asset before serving it to the client.
      */
     createSignedUrl(path, expiresIn, options) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -206,7 +206,7 @@ export default class StorageFileApi {
      * Downloads a file.
      *
      * @param path The full path and file name of the file to be downloaded. For example `folder/image.png`.
-     * @param options.download download a transformed image
+     * @param options.transform Transform the asset before serving it to the client.
      */
     download(path, options) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -236,8 +236,8 @@ export default class StorageFileApi {
      * This function does not verify if the bucket is public. If a public URL is created for a bucket which is not public, you will not be able to download the asset.
      *
      * @param path The path and name of the file to generate the public URL for. For example `folder/image.png`.
-     * @param options.download triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
-     * @param options.transform adds image transformations parameters to the generated url
+     * @param options.download Triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
+     * @param options.transform Transform the asset before serving it to the client.
      */
     getPublicUrl(path, options) {
         const _path = this._getFinalPath(path);

package/package.json

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

package/src/lib/types.ts

@@ -74,7 +74,19 @@ export interface Metadata {
 }
 
 export interface TransformOptions {
+  /**
+   * The width of the image in pixels.
+   */
   width?: number
+  /**
+   * The height of the image in pixels.
+   */
   height?: number
+  /**
+   * The resize mode can be cover, contain or fill. Defaults to cover.
+   * Cover resizes the image to maintain it's aspect ratio while filling the entire width and height.
+   * Contain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.
+   * Fill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit.
+   */
   resize?: 'cover' | 'contain' | 'fill'
 }

package/src/lib/version.ts

@@ -1,2 +1,2 @@
 // generated by genversion
-export const version = '2.1.0-next.3'
+export const version = '2.1.0'

package/src/packages/StorageFileApi.ts

@@ -265,7 +265,7 @@ export default class StorageFileApi {
    * @param path The file path, 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.
    * @param options.download triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
-   * @param options.transform The visiting client will receive the transformed variant of the image by providing transform options
+   * @param options.transform Transform the asset before serving it to the client.
    */
   async createSignedUrl(
     path: string,
@@ -359,7 +359,7 @@ export default class StorageFileApi {
    * Downloads a file.
    *
    * @param path The full path and file name of the file to be downloaded. For example `folder/image.png`.
-   * @param options.download download a transformed image
+   * @param options.transform Transform the asset before serving it to the client.
    */
   async download(
     path: string,
@@ -401,8 +401,8 @@ export default class StorageFileApi {
    * This function does not verify if the bucket is public. If a public URL is created for a bucket which is not public, you will not be able to download the asset.
    *
    * @param path The path and name of the file to generate the public URL for. For example `folder/image.png`.
-   * @param options.download triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
-   * @param options.transform adds image transformations parameters to the generated url
+   * @param options.download Triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
+   * @param options.transform Transform the asset before serving it to the client.
    */
   getPublicUrl(
     path: string,