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

package/README.md

@@ -11,10 +11,10 @@ It is also possible to access all the specific functionality of the cloud servic
 If you are new to the Storage Abstraction library you may want to read [this](https://github.com/tweedegolf/storage-abstraction/blob/master/README.md#how-it-works) first.
 
 ```typescript
-import { Storage, StorageType } from "@tweedegolf/storage-abstraction";
+import { Storage, Provider } from "@tweedegolf/storage-abstraction";
 
 const configuration = {
-  type: StorageType.B2,
+  type: Provider.B2,
   applicationKey: "key",
   applicationKeyId: "keyId",
 };
@@ -28,13 +28,13 @@ console.log(result);
 
 The Storage class is cloud service agnostic and doesn't know anything about the adapter it uses and adapters are completely interchangeable. It only expects the adapter to have implemented all methods of the `IAdapter` interface, see the [API](https://github.com/tweedegolf/storage-abstraction/blob/master/README.md#adapter-api).
 
-When you create a Storage instance it checks the mandatory `type` key in the configuration object and then loads the appropriate adapter module automatically from your node_modules folder using `require()`. For more information please read [this](https://github.com/tweedegolf/storage-abstraction/blob/master/README.md#register-your-adapter).
+When you create a Storage instance it checks the mandatory `provider` key in the configuration object and then loads the appropriate adapter module automatically from your node_modules folder using `require()`. For more information please read [this](https://github.com/tweedegolf/storage-abstraction/blob/master/README.md#register-your-adapter).
 
 ## Configuration
 
 The configuration object that you pass to the Storage constructor is forwarded to the constructor of the adapter.
 
-The Storage constructor is only interested in the `type` key of the configuration object, all other keys are necessary for configuring the adapter.
+The Storage constructor is only interested in the `provider` key of the configuration object, all other keys are necessary for configuring the adapter.
 
 The Storage constructor expects the configuration to be of type `StorageAdapterConfig`.
 
@@ -66,13 +66,13 @@ Examples with configuration object:
 
 ```typescript
 const s = new Storage({
-  type: StorageType.B2,
+  type: Provider.B2,
   applicationKeyId: "your-key-id",
   applicationKey: "your-key",
 });
 
 const s = new Storage({
-  type: StorageType.B2,
+  type: Provider.B2,
   applicationKeyId: "your-key-id",
   applicationKey: "your-key",
   bucketName: "the-buck",

package/changelog.md

@@ -1,3 +1,15 @@
+# 3.0.1
+- added option `checkIfBucketExists` to the `addFile`, `addFileFromPath`, `addFileFromBuffer` and `addFileFromStream`
+
+# 3.0.0
+- version bump to match the version of Storage and the API
+- removed support for versioning (wasn't implemented consistently anyway)
+- removed `getFileAsURL`
+- removed option `{allVersions: boolean}` for `removeFile`
+- `removeFile` does not fail if the file doesn't exist
+- `deleteBucket` does not fail if the bucket doesn't exist
+- see also the [migration guide](https://github.com/tweedegolf/storage-abstraction/blob/master/migration_to_api3.0.md)
+
 # 1.0.7
 - include @deprecated functions
 

package/dist/AbstractAdapter.d.ts

@@ -1,45 +1,30 @@
-import { AdapterConfig, IAdapter, Options, StreamOptions } from "./types/general";
+import { AdapterConfig, IAdapter, Options, Provider, StreamOptions } from "./types/general";
 import { FileBufferParams, FilePathParams, FileStreamParams } from "./types/add_file_params";
-import { ResultObject, ResultObjectBoolean, ResultObjectBuckets, ResultObjectFiles, ResultObjectNumber, ResultObjectStream } from "./types/result";
+import { ResultObject, ResultObjectBoolean, ResultObjectBuckets, ResultObjectFiles, ResultObjectNumber, ResultObjectObject, ResultObjectStream } from "./types/result";
 export declare abstract class AbstractAdapter implements IAdapter {
-    protected _type: string;
-    protected _config: AdapterConfig | null;
-    protected _configError: string | null;
-    protected _bucketName: string;
+    protected _provider: Provider;
+    protected _config: AdapterConfig;
     protected _client: any;
+    protected _configError: null | string;
+    protected _bucketName: null | string;
     constructor(config: string | AdapterConfig);
-    get type(): string;
-    getType(): string;
+    get provider(): Provider;
+    getProvider(): Provider;
     get config(): AdapterConfig;
     getConfig(): AdapterConfig;
-    get configError(): string;
-    getConfigError(): string;
+    get configError(): null | string;
+    getConfigError(): null | string;
     get serviceClient(): any;
     getServiceClient(): any;
-    setSelectedBucket(bucketName: string | null): void;
-    getSelectedBucket(): string | null;
-    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 _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;
-    };
+    setSelectedBucket(bucketName: null | string): void;
+    getSelectedBucket(): null | string;
+    set selectedBucket(bucketName: null | string);
+    get selectedBucket(): null | string;
+    set bucketName(bucketName: null | string);
+    get bucketName(): null | string;
+    private getFileAndBucketAndOptions;
+    private checkBucket;
+    private checkFile;
     protected abstract _listBuckets(): Promise<ResultObjectBuckets>;
     protected abstract _createBucket(name: string, options: Options): Promise<ResultObject>;
     protected abstract _clearBucket(name: string): Promise<ResultObject>;
@@ -51,83 +36,26 @@ export declare abstract class AbstractAdapter implements IAdapter {
     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>;
+    protected abstract _removeFile(bucketName: string, fileName: string): Promise<ResultObject>;
+    protected abstract _getPresignedUploadURL(bucketName: string, fileName: string, options: Options): Promise<ResultObjectObject>;
     listBuckets(): Promise<ResultObjectBuckets>;
-    createBucket(...args: [
-        bucketName?: string,
-        options?: Options
-    ] | [
-        options?: Options
-    ]): Promise<ResultObject>;
+    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>;
     bucketIsPublic(name?: string): Promise<ResultObjectBoolean>;
-    listFiles(...args: [
-        bucketName?: string,
-        numFiles?: number
-    ] | [
-        numFiles?: number
-    ] | [
-        bucketName?: string
-    ]): Promise<ResultObjectFiles>;
+    listFiles(...args: [bucketName?: string, numFiles?: number] | [numFiles?: number] | [bucketName?: string]): Promise<ResultObjectFiles>;
+    addFileFromPath(params: FilePathParams): Promise<ResultObject>;
+    addFileFromBuffer(params: FileBufferParams): Promise<ResultObject>;
+    addFileFromStream(params: FileStreamParams): Promise<ResultObject>;
     addFile(params: FilePathParams | FileBufferParams | FileStreamParams): 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>;
+    getFileAsStream(...args: [bucketName: string, fileName: string, options?: StreamOptions] | [fileName: string, options?: StreamOptions]): Promise<ResultObjectStream>;
+    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] | [fileName: string]): Promise<ResultObject>;
+    getPresignedUploadURL(...args: [bucketName: string, fileName: string, options?: Options] | [fileName: string, options?: Options]): Promise<ResultObjectObject>;
 }