1.0.44

.gitlab-ci.yml

@@ -19,23 +19,37 @@ mirror:
   stage: security
   script:
     - npmci git mirror
+  only:
+    - tags
   tags:
     - lossless
     - docker
     - notpriv
 
-audit:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --production --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=prod --production
+  tags:
+    - docker
+  allow_failure: true
+
+
+auditDevDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
     - npmci command npm install --ignore-scripts
     - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm audit --audit-level=high
+    - npmci command npm audit --audit-level=high --only=dev
   tags:
-    - lossless
     - docker
-    - notpriv
+  allow_failure: true
 
 # ====================
 # test stage
@@ -50,9 +64,7 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 testBuild:
   stage: test
@@ -63,9 +75,7 @@ testBuild:
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -85,6 +95,8 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
     - npmci command npm install -g tslint typescript
     - npmci npm prepare

.vscode/settings.json

@@ -15,7 +15,7 @@
             "properties": {
               "projectType": {
                 "type": "string",
-                "enum": ["website", "element", "service", "npm"]
+                "enum": ["website", "element", "service", "npm", "wcc"]
               }
             }
           }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartbucket",
-  "version": "1.0.28",
+  "version": "1.0.44",
   "description": "simple cloud independent object storage",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
@@ -9,23 +9,23 @@
   "scripts": {
     "test": "(tstest test/)",
     "format": "(gitzone format)",
-    "build": "(tsbuild)"
+    "build": "(tsbuild --web)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.24",
+    "@gitzone/tsbuild": "^2.1.28",
-    "@gitzone/tstest": "^1.0.28",
+    "@gitzone/tstest": "^1.0.60",
-    "@pushrocks/tapbundle": "^3.2.1",
+    "@pushrocks/tapbundle": "^3.2.15",
-    "tslint": "^6.1.2",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/qenv": "^4.0.6",
+    "@pushrocks/qenv": "^4.0.10",
     "@pushrocks/smartpath": "^4.0.3",
-    "@pushrocks/smartpromise": "^3.0.6",
+    "@pushrocks/smartpromise": "^3.1.6",
-    "@pushrocks/smartrx": "^2.0.5",
+    "@pushrocks/smartrx": "^2.0.19",
-    "@pushrocks/streamfunction": "^1.0.24",
+    "@pushrocks/streamfunction": "^2.0.1",
-    "@types/minio": "^7.0.5",
+    "@types/minio": "^7.0.11",
-    "minio": "^7.0.16"
+    "minio": "^7.0.25"
   },
   "private": false,
   "files": [
@@ -39,5 +39,8 @@
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

readme.md

@@ -8,16 +8,24 @@ simple cloud independent object storage
 * [docs (typedoc)](https://pushrocks.gitlab.io/smartbucket/)
 
 ## Status for master
-[![pipeline status](https://gitlab.com/pushrocks/smartbucket/badges/master/pipeline.svg)](https://gitlab.com/pushrocks/smartbucket/commits/master)
+
-[![coverage report](https://gitlab.com/pushrocks/smartbucket/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartbucket/commits/master)
+Status Category | Status Badge
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartbucket.svg)](https://www.npmjs.com/package/@pushrocks/smartbucket)
+-- | --
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartbucket/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartbucket)
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartbucket/badges/master/pipeline.svg)](https://lossless.cloud)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartbucket/badges/master/coverage.svg)](https://lossless.cloud)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartbucket)](https://lossless.cloud)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartbucket)](https://lossless.cloud)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartbucket)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartbucket)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartbucket)](https://lossless.cloud)
+Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
 
 ## Usage
 
+Use TypeScript for best in class intellisense.
 
 ## Contribution
 

test/test.ts

@@ -13,16 +13,16 @@ tap.test('should create a valid smartbucket', async () => {
   testSmartbucket = new smartbucket.SmartBucket({
     accessKey: testQenv.getEnvVarOnDemand('S3_KEY'),
     accessSecret: testQenv.getEnvVarOnDemand('S3_SECRET'),
-    endpoint: 'fra1.digitaloceanspaces.com'
+    endpoint: 's3.eu-central-1.wasabisys.com',
   });
 });
 
 tap.skip.test('should create testbucket', async () => {
-  await testSmartbucket.createBucket('testzone');
+  // await testSmartbucket.createBucket('testzone');
 });
 
 tap.skip.test('should remove testbucket', async () => {
-  await testSmartbucket.removeBucket('testzone');
+  // await testSmartbucket.removeBucket('testzone');
 });
 
 tap.test('should get a bucket', async () => {

ts/smartbucket.classes.bucket.ts

@@ -6,7 +6,7 @@ import { Observable } from 'rxjs';
 export class Bucket {
   public static async getBucketByName(smartbucketRef: SmartBucket, bucketNameArg: string) {
     const buckets = await smartbucketRef.minioClient.listBuckets();
-    const foundBucket = buckets.find(bucket => {
+    const foundBucket = buckets.find((bucket) => {
       return bucket.name === bucketNameArg;
     });
 
@@ -20,12 +20,12 @@ export class Bucket {
   }
 
   public static async createBucketByName(smartbucketRef: SmartBucket, bucketName: string) {
-    await smartbucketRef.minioClient.makeBucket(bucketName, 'ams3').catch(e => console.log(e));
+    await smartbucketRef.minioClient.makeBucket(bucketName, 'ams3').catch((e) => console.log(e));
     return new Bucket(smartbucketRef, bucketName);
   }
 
   public static async removeBucketByName(smartbucketRef: SmartBucket, bucketName: string) {
-    await smartbucketRef.minioClient.removeBucket(bucketName).catch(e => console.log(e));
+    await smartbucketRef.minioClient.removeBucket(bucketName).catch((e) => console.log(e));
   }
 
   public smartbucketRef: SmartBucket;
@@ -50,11 +50,11 @@ export class Bucket {
   /**
    * store file
    */
-  public async fastStore(pathArg: string, fileContent: string) {
+  public async fastStore(pathArg: string, fileContent: string | Buffer): Promise<void> {
     const streamIntake = new plugins.streamfunction.Intake();
     const putPromise = this.smartbucketRef.minioClient
       .putObject(this.name, pathArg, streamIntake.getReadable())
-      .catch(e => console.log(e));
+      .catch((e) => console.log(e));
     streamIntake.pushData(fileContent);
     streamIntake.signalEnd();
     await putPromise;
@@ -63,38 +63,41 @@ export class Bucket {
   /**
    * get file
    */
-  public async fastGet(pathArg: string) {
+  public async fastGet(pathArg: string): Promise<Buffer> {
     const done = plugins.smartpromise.defer();
-    let completeFile: string = '';
+    let completeFile: Buffer;
     const replaySubject = await this.fastGetStream(pathArg);
-    replaySubject.subscribe(
+    const subscription = replaySubject.subscribe(
-      chunkString => {
+      (chunk) => {
-        completeFile += chunkString;
+        if (completeFile) {
+          completeFile = Buffer.concat([completeFile, chunk]);
+        } else {
+          completeFile = chunk;
+        }
       },
-      err => {
+      (err) => {
         console.log(err);
       },
       () => {
         done.resolve();
+        subscription.unsubscribe();
       }
     );
     await done.promise;
     return completeFile;
   }
 
-  public async fastGetStream(pathArg: string): Promise<plugins.smartrx.rxjs.ReplaySubject<string>> {
+  public async fastGetStream(pathArg: string): Promise<plugins.smartrx.rxjs.ReplaySubject<Buffer>> {
     const fileStream = await this.smartbucketRef.minioClient
       .getObject(this.name, pathArg)
-      .catch(e => console.log(e));
+      .catch((e) => console.log(e));
-    const replaySubject = new plugins.smartrx.rxjs.ReplaySubject<string>();
+    const replaySubject = new plugins.smartrx.rxjs.ReplaySubject<Buffer>();
     const duplexStream = plugins.streamfunction.createDuplexStream<Buffer, Buffer>(
-      async chunk => {
+      async (chunk) => {
-        const chunkString = chunk.toString();
+        replaySubject.next(chunk);
-        replaySubject.next(chunkString);
         return chunk;
       },
-      async cb => {
+      async (cb) => {
-        console.log('stream ended');
         replaySubject.complete();
         return Buffer.from('');
       }

ts/smartbucket.classes.directory.ts

@@ -43,11 +43,18 @@ export class Directory {
     const parentDirectories = this.getParentDirectories();
     let basePath = '';
     for (const parentDir of parentDirectories) {
-      if (parentDir.name === '') {
+      if (!parentDir.name && !basePath) {
-        basePath = this.name;
+        basePath = this.name + '/';
+        continue;
+      }
+      if (parentDir.name && !basePath) {
+        basePath = parentDir.name + '/' + this.name + '/';
+        continue;
+      }
+      if (parentDir.name && basePath) {
+        basePath = parentDir.name + '/' + basePath;
         continue;
       }
-      basePath = parentDir.name + '/' + this.name;
     }
     return basePath;
   }
@@ -57,13 +64,17 @@ export class Directory {
    */
   public async listFiles(): Promise<File[]> {
     const done = plugins.smartpromise.defer();
-    const fileNameStream = await this.bucketRef.smartbucketRef.minioClient.listObjects(
+    const fileNameStream = await this.bucketRef.smartbucketRef.minioClient.listObjectsV2(
       this.bucketRef.name,
-      this.getBasePath()
+      this.getBasePath(),
+      false
     );
     const fileArray: File[] = [];
     const duplexStream = plugins.streamfunction.createDuplexStream<plugins.minio.BucketItem, void>(
-      async bucketItem => {
+      async (bucketItem) => {
+        if (bucketItem.prefix) {
+          return;
+        }
         if (!bucketItem.name) {
           return;
         }
@@ -75,7 +86,7 @@ export class Directory {
           fileArray.push(new File(this, subtractedPath));
         }
       },
-      async tools => {
+      async (tools) => {
         done.resolve();
       }
     );
@@ -89,27 +100,31 @@ export class Directory {
    */
   public async listDirectories(): Promise<Directory[]> {
     const done = plugins.smartpromise.defer();
-    const completeDirStream = await this.bucketRef.smartbucketRef.minioClient.listObjects(
+    const basePath = this.getBasePath();
+    const completeDirStream = await this.bucketRef.smartbucketRef.minioClient.listObjectsV2(
       this.bucketRef.name,
       this.getBasePath(),
-      true
+      false
     );
     const directoryArray: Directory[] = [];
     const duplexStream = plugins.streamfunction.createDuplexStream<plugins.minio.BucketItem, void>(
-      async bucketItem => {
+      async (bucketItem) => {
-        let subtractedPath = bucketItem.name.replace(this.getBasePath(), '');
+        if (bucketItem.name) {
+          return;
+        }
+        let subtractedPath = bucketItem.prefix.replace(this.getBasePath(), '');
         if (subtractedPath.startsWith('/')) {
           subtractedPath = subtractedPath.substr(1);
         }
         if (subtractedPath.includes('/')) {
           const dirName = subtractedPath.split('/')[0];
-          if (directoryArray.find(directory => directory.name === dirName)) {
+          if (directoryArray.find((directory) => directory.name === dirName)) {
             return;
           }
           directoryArray.push(new Directory(this.bucketRef, this, dirName));
         }
       },
-      async tools => {
+      async (tools) => {
         done.resolve();
       }
     );
@@ -122,7 +137,7 @@ export class Directory {
    * gets an array that has all objects with a certain prefix;
    */
   public async getTreeArray() {
-    const treeArray = await this.bucketRef.smartbucketRef.minioClient.listObjects(
+    const treeArray = await this.bucketRef.smartbucketRef.minioClient.listObjectsV2(
       this.bucketRef.name,
       this.getBasePath(),
       true
@@ -137,7 +152,7 @@ export class Directory {
 
     const getDirectory = async (directoryArg: Directory, dirNameToSearch: string) => {
       const directories = await directoryArg.listDirectories();
-      return directories.find(directory => {
+      return directories.find((directory) => {
         return directory.name === dirNameToSearch;
       });
     };
@@ -154,18 +169,19 @@ export class Directory {
    */
   public async move() {
     // TODO
+    throw new Error('moving a directory is not yet implemented')
   }
 
   /**
    * creates a file within this directory
    * @param relativePathArg
    */
-  public async createFile(relativePathArg) {
+  public async createEmptyFile(relativePathArg: string) {
-    let completeFilePath: string = '';
+    const emtpyFile = await File.createFileFromString(this, relativePathArg, '');
   }
 
   // file operations
-  public async fastStore(pathArg: string, contentArg: string) {
+  public async fastStore(pathArg: string, contentArg: string | Buffer) {
     const path = plugins.path.join(this.getBasePath(), pathArg);
     await this.bucketRef.fastStore(path, contentArg);
   }
@@ -176,7 +192,7 @@ export class Directory {
     return result;
   }
 
-  public async fastGetStream(pathArg: string): Promise<plugins.smartrx.rxjs.ReplaySubject<string>> {
+  public async fastGetStream(pathArg: string): Promise<plugins.smartrx.rxjs.ReplaySubject<Buffer>> {
     const path = plugins.path.join(this.getBasePath(), pathArg);
     const result = await this.bucketRef.fastGetStream(path);
     return result;
@@ -186,4 +202,25 @@ export class Directory {
     const path = plugins.path.join(this.getBasePath(), pathArg);
     await this.bucketRef.fastRemove(path);
   }
+
+  /**
+   * deletes the directory with all its contents
+   */
+  public async deleteWithAllContents() {
+    const deleteDirectory = async (directoryArg: Directory) => {
+      const childDirectories = await directoryArg.listDirectories();
+      if (childDirectories.length === 0) {
+        console.log('directory empty! Path complete!');
+      } else {
+        for (const childDir of childDirectories) {
+          await deleteDirectory(childDir);
+        }
+      }
+      const files = await directoryArg.listFiles();
+      for (const file of files) {
+        await directoryArg.fastRemove(file.name);
+      }
+    };
+    await deleteDirectory(this);
+  }
 }

ts/smartbucket.classes.file.ts

@@ -26,7 +26,7 @@ export class File {
     const streamIntake = new plugins.streamfunction.Intake();
     const putPromise = directoryRef.bucketRef.smartbucketRef.minioClient
       .putObject(this.name, filePath, streamIntake.getReadable())
-      .catch(e => console.log(e));
+      .catch((e) => console.log(e));
     streamIntake.pushData(fileContent);
     streamIntake.signalEnd();
     await putPromise;
@@ -53,14 +53,14 @@ export class File {
     const done = plugins.smartpromise.defer();
     const fileStream = await this.parentDirectoryRef.bucketRef.smartbucketRef.minioClient
       .getObject(this.parentDirectoryRef.bucketRef.name, this.path)
-      .catch(e => console.log(e));
+      .catch((e) => console.log(e));
     let completeFile = new Buffer('');
     const duplexStream = plugins.streamfunction.createDuplexStream<Buffer, Buffer>(
-      async chunk => {
+      async (chunk) => {
         completeFile = Buffer.concat([chunk]);
         return chunk;
       },
-      async cb => {
+      async (cb) => {
         done.resolve();
         return Buffer.from('');
       }
@@ -76,8 +76,8 @@ export class File {
   }
 
   public async streamContent() {
-    throw new Error('not yet implemented');
     // TODO
+    throw new Error('not yet implemented');
   }
 
   /**

ts/smartbucket.classes.smartbucket.ts

@@ -3,6 +3,8 @@ import { Bucket } from './smartbucket.classes.bucket';
 
 export interface ISmartBucketConfig {
   endpoint: string;
+  port?: number;
+  useSsl?: boolean;
   accessKey: string;
   accessSecret: string;
 }
@@ -19,10 +21,10 @@ export class SmartBucket {
     this.config = configArg;
     this.minioClient = new plugins.minio.Client({
       endPoint: this.config.endpoint,
-      port: 443,
+      port: configArg.port || 443,
-      useSSL: true,
+      useSSL: configArg.useSsl !== undefined ? configArg.useSsl : true,
       accessKey: this.config.accessKey,
-      secretKey: this.config.accessSecret
+      secretKey: this.config.accessSecret,
     });
   }