@tweedegolf/sab-adapter-backblaze-b2 1.0.5 → 1.0.7

package/changelog.md

@@ -1,9 +1,13 @@
-# 1.0.5
+# 1.0.7
+- include @deprecated functions
+
+# 1.0.6
+- implemented new API methods `bucketIsPublic`, `getPublicURL` and `getSignedURL`
 
+# 1.0.5
 - fix bug in selected bucket
 
 # 1.0.3
-
 - revert to v1 format of config URLs
 - re-implement storing the selected bucket in local state
   - `selectBucket` and `geSelectedBucket`

package/dist/AbstractAdapter.d.ts

@@ -18,42 +18,116 @@ export declare abstract class AbstractAdapter implements IAdapter {
     getServiceClient(): any;
     setSelectedBucket(bucketName: string | null): void;
     getSelectedBucket(): string | null;
-    set(bucketName: string | null): void;
+    set selectedBucket(bucketName: string | null);
+    get selectedBucket(): string | null;
+    set bucketName(bucketName: string | null);
     get bucketName(): string | null;
     addFileFromPath(params: FilePathParams): Promise<ResultObject>;
     addFileFromBuffer(params: FileBufferParams): Promise<ResultObject>;
     addFileFromStream(params: FileStreamParams): Promise<ResultObject>;
-    protected _getFileAndBucket(arg1: string, arg2?: string): {
+    protected _getFileAndBucketAndOptions(...args: [
+        bucketName: string,
+        fileName: string,
+        options?: boolean | Options | StreamOptions
+    ] | [
+        fileName: string,
+        options?: boolean | Options | StreamOptions
+    ] | [
+        options: boolean | Options | StreamOptions
+    ]): {
         bucketName: string;
         fileName: string;
+        options: object | boolean;
         error: string;
     };
+    protected abstract _listBuckets(): Promise<ResultObjectBuckets>;
+    protected abstract _createBucket(name: string, options: Options): Promise<ResultObject>;
     protected abstract _clearBucket(name: string): Promise<ResultObject>;
     protected abstract _deleteBucket(name: string): Promise<ResultObject>;
     protected abstract _bucketExists(name: string): Promise<ResultObjectBoolean>;
+    protected abstract _bucketIsPublic(name: string): Promise<ResultObjectBoolean>;
     protected abstract _listFiles(bucketName: string, numFiles: number): Promise<ResultObjectFiles>;
     protected abstract _sizeOf(bucketName: string, fileName: string): Promise<ResultObjectNumber>;
     protected abstract _addFile(params: FilePathParams | FileBufferParams | FileStreamParams): Promise<ResultObject>;
     protected abstract _fileExists(bucketName: string, fileName: string): Promise<ResultObjectBoolean>;
     protected abstract _getFileAsStream(bucketName: string, fileName: string, options: StreamOptions): Promise<ResultObjectStream>;
     protected abstract _getFileAsURL(bucketName: string, fileName: string, options: Options): Promise<ResultObject>;
+    protected abstract _getPublicURL(bucketName: string, fileName: string, options: Options): Promise<ResultObject>;
+    protected abstract _getSignedURL(bucketName: string, fileName: string, options: Options): Promise<ResultObject>;
     protected abstract _removeFile(bucketName: string, fileName: string, allVersions: boolean): Promise<ResultObject>;
-    abstract listBuckets(): Promise<ResultObjectBuckets>;
-    abstract createBucket(name: string, options?: Options): Promise<ResultObject>;
+    listBuckets(): Promise<ResultObjectBuckets>;
+    createBucket(...args: [
+        bucketName?: string,
+        options?: Options
+    ] | [
+        options?: Options
+    ]): Promise<ResultObject>;
     clearBucket(name?: string): Promise<ResultObject>;
     deleteBucket(name?: string): Promise<ResultObject>;
     bucketExists(name?: string): Promise<ResultObjectBoolean>;
-    listFiles(bucketName: string, numFiles?: number): Promise<ResultObjectFiles>;
-    listFiles(numFiles?: number): Promise<ResultObjectFiles>;
+    bucketIsPublic(name?: string): Promise<ResultObjectBoolean>;
+    listFiles(...args: [
+        bucketName?: string,
+        numFiles?: number
+    ] | [
+        numFiles?: number
+    ] | [
+        bucketName?: string
+    ]): Promise<ResultObjectFiles>;
     addFile(params: FilePathParams | FileBufferParams | FileStreamParams): Promise<ResultObject>;
-    getFileAsStream(bucketName: string, fileName: string, options?: StreamOptions): Promise<ResultObjectStream>;
-    getFileAsStream(fileName: string, options?: StreamOptions): Promise<ResultObjectStream>;
-    getFileAsURL(bucketName: string, fileName: string, options?: Options): Promise<ResultObject>;
-    getFileAsURL(fileName: string, options?: Options): Promise<ResultObject>;
-    sizeOf(bucketName: string, fileName: string): Promise<ResultObjectNumber>;
-    sizeOf(fileName: string): Promise<ResultObjectNumber>;
-    fileExists(bucketName: string, fileName: string): Promise<ResultObjectBoolean>;
-    fileExists(fileName: string): Promise<ResultObjectBoolean>;
-    removeFile(bucketName: string, fileName: string, allVersions?: boolean): Promise<ResultObject>;
-    removeFile(fileName: string, allVersions?: boolean): Promise<ResultObject>;
+    getFileAsStream(...args: [
+        bucketName: string,
+        fileName: string,
+        options?: StreamOptions
+    ] | [
+        fileName: string,
+        options?: StreamOptions
+    ]): Promise<ResultObjectStream>;
+    /**
+     * @deprecated: please use getPublicURL or getSignedURL
+     */
+    getFileAsURL(...args: [
+        bucketName: string,
+        fileName: string,
+        options?: Options
+    ] | [
+        fileName: string,
+        options?: Options
+    ]): Promise<ResultObject>;
+    getPublicURL(...args: [
+        bucketName: string,
+        fileName: string,
+        options?: Options
+    ] | [
+        fileName: string,
+        options?: Options
+    ]): Promise<ResultObject>;
+    getSignedURL(...args: [
+        bucketName: string,
+        fileName: string,
+        options?: Options
+    ] | [
+        fileName: string,
+        options?: Options
+    ]): Promise<ResultObject>;
+    sizeOf(...args: [
+        bucketName: string,
+        fileName: string
+    ] | [
+        fileName: string
+    ]): Promise<ResultObjectNumber>;
+    fileExists(...args: [
+        bucketName: string,
+        fileName: string
+    ] | [
+        fileName: string
+    ]): Promise<ResultObjectBoolean>;
+    removeFile(...args: [
+        bucketName: string,
+        fileName: string,
+        allVersions?: boolean
+    ] | [
+        fileName: string,
+        allVersions?: boolean
+    ]): Promise<ResultObject>;
 }