Add storage provider class

Author: jsbroks

package.json

@@ -10,12 +10,12 @@
     "release": "yarn clean && yarn build && lerna publish"
   },
   "devDependencies": {
-    "@types/node": "^13.13.4",
-    "lerna": "^3.20.2",
-    "prettier": "^2.0.5",
+    "@types/node": "^14.6.2",
+    "lerna": "^3.22.1",
+    "prettier": "^2.1.1",
     "rimraf": "^3.0.2",
-    "ts-node": "^8.9.1",
-    "typescript": "^3.8.3"
+    "ts-node": "^9.0.0",
+    "typescript": "^4.0.2"
   },
   "files": [
     "!tsconfig*"
@@ -24,6 +24,6 @@
     "packages/*"
   ],
   "dependencies": {
-    "storage-gcp": "^0.1.13"
+    "storage-gcp": "^0.6.4"
   }
 }

packages/aws/package.json

@@ -23,7 +23,7 @@
   ],
   "gitHead": "b05db75f50e3a44fd01b8c95d114f3fb5c9801c3",
   "dependencies": {
-    "aws-sdk": "^2.678.0",
+    "aws-sdk": "^2.743.0",
     "storage-core": "^0.6.2"
   },
   "keywords": [

packages/aws/src/AwsS3Storage.ts

@@ -1,4 +1,4 @@
-import { Storage, FilesReadable, ListResult } from 'storage-core'
+import { Storage, FilesReadable, ListResult, PathAbs } from 'storage-core'
 import { S3, AWSError } from 'aws-sdk'
 import pathModule from 'path'
 
@@ -24,6 +24,7 @@ export class AwsS3Storage extends Storage<AwsS3StorageOptions> {
     this.s3 = new S3({ ...options })
   }
 
+  @PathAbs()
   async getTopLevel(path?: string): Promise<ListResult[]> {
     const request = await this.s3
       .listObjectsV2({
@@ -55,6 +56,7 @@ export class AwsS3Storage extends Storage<AwsS3StorageOptions> {
     return dirs.concat(files)
   }
 
+  @PathAbs()
   getFilesStream(path?: string): Readable {
     let request: PromiseResult<S3.ListObjectsV2Output, AWSError> | undefined
     let ContinuationToken: string | undefined
@@ -81,6 +83,7 @@ export class AwsS3Storage extends Storage<AwsS3StorageOptions> {
     })
   }
 
+  @PathAbs()
   async readFile(filePath: string): Promise<Buffer> {
     const r = await this.s3
       .getObject({ Bucket: this.options.bucket, Key: filePath })
@@ -103,6 +106,7 @@ export class AwsS3Storage extends Storage<AwsS3StorageOptions> {
     return buffer
   }
 
+  @PathAbs()
   async writeFile(filePath: string, data: string | Buffer): Promise<void> {
     await this.s3
       .putObject({
@@ -113,19 +117,22 @@ export class AwsS3Storage extends Storage<AwsS3StorageOptions> {
       .promise()
   }
 
+  @PathAbs()
   async deleteFile(filePath: string): Promise<void> {
     await this.s3
       .deleteObject({ Bucket: this.options.bucket, Key: filePath })
       .promise()
   }
 
+  @PathAbs()
   async getFileSize(filePath: string): Promise<number> {
     const r = await this.s3
       .headObject({ Bucket: this.options.bucket, Key: filePath })
       .promise()
     return r.ContentLength || 0
   }
 
+  @PathAbs()
   async createWriteStream(filePath: string): Promise<Writable> {
     const pass = new PassThrough()
     this.s3
@@ -134,6 +141,7 @@ export class AwsS3Storage extends Storage<AwsS3StorageOptions> {
     return pass
   }
 
+  @PathAbs()
   async createReadStream(filePath: string): Promise<Readable> {
     return this.s3
       .getObject({ Bucket: this.options.bucket, Key: filePath })

packages/azure/package.json

@@ -23,7 +23,7 @@
   ],
   "gitHead": "b05db75f50e3a44fd01b8c95d114f3fb5c9801c3",
   "dependencies": {
-    "@azure/storage-blob": "^12.1.1",
+    "@azure/storage-blob": "^12.2.0-preview.1",
     "storage-core": "^0.6.2"
   },
   "keywords": [

packages/azure/src/AzureBlobStorage.ts

@@ -1,32 +1,34 @@
-import { Storage, FilesReadable } from 'storage-core'
+import { Storage, FilesReadable, PathAbs, StorageOptions } from 'storage-core'
 import pathModule from 'path'
-import {
-  BlobServiceClient,
-  StorageSharedKeyCredential,
-  ContainerClient
-} from '@azure/storage-blob'
-import { AzureBlobStorageOptions } from './AzureBlobStorageOptions'
+import { BlobServiceClient, ContainerClient } from '@azure/storage-blob'
 import { Readable, PassThrough } from 'stream'
 import { ListResult } from 'storage-core'
+import {
+  AzureStorageAccount,
+  AzureStorageAccountOptions
+} from './AzureStorageAccount'
+
+export interface AzureBlobStorageOptions
+  extends StorageOptions,
+    AzureStorageAccountOptions {
+  container: string
+}
 
 export class AzureBlobStorage extends Storage<AzureBlobStorageOptions> {
   blobClient: BlobServiceClient
   containerClient: ContainerClient
 
-  constructor(options: AzureBlobStorageOptions) {
+  constructor(
+    options: AzureBlobStorageOptions,
+    provider?: AzureStorageAccount
+  ) {
     super(options)
-    const credentials = new StorageSharedKeyCredential(
-      options.accountName,
-      options.accountKey
-    )
-    this.blobClient = new BlobServiceClient(
-      options.endpoint ||
-        `https://${options.accountName}.blob.core.windows.net`,
-      credentials
-    )
+
+    this.blobClient = (provider ?? new AzureStorageAccount(options)).blobClient
     this.containerClient = this.blobClient.getContainerClient(options.container)
   }
 
+  @PathAbs()
   async getTopLevel(path?: string): Promise<ListResult[]> {
     const iterator = this.containerClient
       .listBlobsByHierarchy('/', { prefix: path ? `${path}/` : '' })
@@ -54,13 +56,15 @@ export class AzureBlobStorage extends Storage<AzureBlobStorageOptions> {
     return dirs.concat(files)
   }
 
+  @PathAbs()
   async getFileSize(path: string): Promise<number> {
     const props = await this.containerClient
       .getBlockBlobClient(path)
       .getProperties()
     return props.contentLength || 0
   }
 
+  @PathAbs()
   getFilesStream(path?: string | undefined): Readable {
     let iterator = this.containerClient.listBlobsFlat({ prefix: path })
     return new FilesReadable(async () => {
@@ -80,20 +84,24 @@ export class AzureBlobStorage extends Storage<AzureBlobStorageOptions> {
     })
   }
 
+  @PathAbs()
   readFile(filePath: string): Promise<Buffer> {
     return this.containerClient.getBlockBlobClient(filePath).downloadToBuffer()
   }
 
+  @PathAbs()
   async writeFile(filePath: string, data: string | Buffer): Promise<void> {
     await this.containerClient
       .getBlockBlobClient(filePath)
       .upload(data, data.length)
   }
 
+  @PathAbs()
   async deleteFile(filePath: string): Promise<void> {
     await this.containerClient.getBlockBlobClient(filePath).delete()
   }
 
+  @PathAbs()
   async createWriteStream(filePath: string) {
     // Failed if file is not already created
     await this.writeFile(filePath, '')
@@ -103,6 +111,7 @@ export class AzureBlobStorage extends Storage<AzureBlobStorageOptions> {
     return stream
   }
 
+  @PathAbs()
   async createReadStream(filePath: string) {
     const download = await this.containerClient
       .getBlockBlobClient(filePath)

packages/azure/src/AzureBlobStorageOptions.ts

@@ -0,0 +1,47 @@
+import {
+  BlobServiceClient,
+  StorageSharedKeyCredential
+} from '@azure/storage-blob'
+import { StorageProvider } from 'storage-core'
+import { AzureBlobStorage } from './AzureBlobStorage'
+
+export interface AzureStorageAccountOptions {
+  accountName: string
+  accountKey: string
+  endpoint?: string
+}
+
+export class AzureStorageAccount extends StorageProvider<AzureBlobStorage> {
+  blobClient: BlobServiceClient
+
+  constructor(private options: AzureStorageAccountOptions) {
+    super()
+
+    const credentials = new StorageSharedKeyCredential(
+      options.accountName,
+      options.accountKey
+    )
+    this.blobClient = new BlobServiceClient(
+      options.endpoint ||
+        `https://${options.accountName}.blob.core.windows.net`,
+      credentials
+    )
+  }
+
+  getStorage(name: string) {
+    return new Promise<AzureBlobStorage>(resolve =>
+      resolve(new AzureBlobStorage({ ...this.options, container: name }))
+    )
+  }
+
+  async createStorage(name: string) {
+    const container = await this.blobClient.createContainer(name)
+    const storage = new AzureBlobStorage({ ...this.options, container: name })
+    storage.containerClient = container.containerClient
+    return storage
+  }
+
+  deleteStorage(name: string) {
+    return this.blobClient.deleteContainer(name)
+  }
+}

packages/azure/src/AzureStorageAccount.ts

@@ -1,2 +1,2 @@
-export { AzureBlobStorageOptions } from './AzureBlobStorageOptions'
-export { AzureBlobStorage } from './AzureBlobStorage'
+export * from './AzureBlobStorage'
+export * from './AzureStorageAccount'

packages/azure/src/index.ts

@@ -23,8 +23,8 @@
   },
   "dependencies": {
     "@types/lru-cache": "^5.1.0",
-    "globby": "^11.0.0",
-    "lru-cache": "^5.1.1"
+    "globby": "^11.0.1",
+    "lru-cache": "^6.0.0"
   },
   "gitHead": "b05db75f50e3a44fd01b8c95d114f3fb5c9801c3",
   "keywords": [

packages/core/package.json

@@ -5,6 +5,8 @@ export type FactoryStorageOption<O extends StorageOptions = any> = O & {
   type: string
 }
 
+export type FactoryProviderOptions<O = any> = O & { type: string }
+
 export class StorageFactory {
   private map = new Map<string, new (options: any) => Storage<any>>()