1.0.27

.gitignore

@@ -15,8 +15,6 @@ node_modules/
 
 # builds
 dist/
-dist_web/
+dist_*/
-dist_serve/
-dist_ts_web/
 
 # custom

.gitlab-ci.yml

@@ -3,14 +3,14 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
+    - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
+  - security
-- test
+  - test
-- release
+  - release
-- metadata
+  - metadata
 
 # ====================
 # security stage
@@ -18,21 +18,24 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
-snyk:
+audit:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
     - npmci command npm install --ignore-scripts
-    - npmci command snyk test
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 # ====================
 # test stage
@@ -41,37 +44,40 @@ snyk:
 testStable:
   stage: test
   script:
-  - npmci npm prepare
+    - npmci npm prepare
-  - npmci node install stable
+    - npmci node install stable
-  - npmci npm install
+    - npmci npm install
-  - npmci npm test
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - lossless
-  - priv
+    - docker
+    - priv
 
 testBuild:
   stage: test
   script:
-  - npmci npm prepare
+    - npmci npm prepare
-  - npmci node install stable
+    - npmci node install stable
-  - npmci npm install
+    - npmci npm install
-  - npmci command npm run build
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install stable
+    - npmci node install stable
-  - npmci npm publish
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
@@ -85,18 +91,20 @@ codequality:
     - npmci npm install
     - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
-  - docker
+    - lossless
-  - priv
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 pages:
   stage: metadata
@@ -107,6 +115,7 @@ pages:
     - npmci npm install
     - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -114,5 +123,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
   allow_failure: true

.vscode/settings.json

@@ -11,7 +11,13 @@
           },
           "gitzone": {
             "type": "object",
-            "description": "settings for gitzone"
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm"]
+              }
+            }
           }
         }
       }

npmextra.json

@@ -3,6 +3,7 @@
     "npmGlobalTools": []
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "pushrocks",

package.json

@@ -1,37 +1,39 @@
 {
   "name": "@pushrocks/smartbucket",
-  "version": "1.0.13",
+  "version": "1.0.27",
   "description": "simple cloud independent object storage",
-  "main": "dist/index.js",
+  "main": "dist_ts/index.js",
-  "typings": "dist/index.d.ts",
+  "typings": "dist_ts/index.d.ts",
   "author": "Lossless GmbH",
   "license": "UNLICENSED",
   "scripts": {
-    "test": "tstest test/",
+    "test": "(tstest test/)",
     "format": "(gitzone format)",
-    "build": "echo \"Not needed for now\""
+    "build": "(tsbuild)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
+    "@gitzone/tsbuild": "^2.1.24",
     "@gitzone/tstest": "^1.0.28",
-    "@pushrocks/tapbundle": "^3.0.13",
+    "@pushrocks/tapbundle": "^3.2.1",
-    "tslint": "^5.20.0",
+    "tslint": "^6.1.2",
     "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
     "@pushrocks/qenv": "^4.0.6",
-    "@pushrocks/smartpath": "^4.0.1",
+    "@pushrocks/smartpath": "^4.0.3",
     "@pushrocks/smartpromise": "^3.0.6",
+    "@pushrocks/smartrx": "^2.0.5",
     "@pushrocks/streamfunction": "^1.0.24",
-    "@types/minio": "^7.0.3",
+    "@types/minio": "^7.0.5",
-    "minio": "^7.0.12"
+    "minio": "7.0.12"
   },
   "private": false,
   "files": [
     "ts/**/*",
     "ts_web/**/*",
     "dist/**/*",
-    "dist_web/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
     "dist_ts_web/**/*",
     "assets/**/*",
     "cli.js",

readme.md

@@ -8,7 +8,7 @@ simple cloud independent object storage
 * [docs (typedoc)](https://pushrocks.gitlab.io/smartbucket/)
 
 ## Status for master
-[![build status](https://gitlab.com/pushrocks/smartbucket/badges/master/build.svg)](https://gitlab.com/pushrocks/smartbucket/commits/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)
 [![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)
@@ -18,6 +18,11 @@ simple cloud independent object storage
 
 ## Usage
 
+
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
 For further information read the linked docs at the top of this readme.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)

test/test.ts

@@ -13,22 +13,22 @@ tap.test('should create a valid smartbucket', async () => {
   testSmartbucket = new smartbucket.SmartBucket({
     accessKey: testQenv.getEnvVarOnDemand('S3_KEY'),
     accessSecret: testQenv.getEnvVarOnDemand('S3_SECRET'),
-    endpoint: 'ams3.digitaloceanspaces.com'
+    endpoint: 'fra1.digitaloceanspaces.com'
   });
 });
 
 tap.skip.test('should create testbucket', async () => {
-  await testSmartbucket.createBucket('smartbucket');
+  await testSmartbucket.createBucket('testzone');
 });
 
 tap.skip.test('should remove testbucket', async () => {
-  await testSmartbucket.removeBucket('pushrocks-smartbucket');
+  await testSmartbucket.removeBucket('testzone');
 });
 
 tap.test('should get a bucket', async () => {
-  myBucket = await testSmartbucket.getBucketByName('smartbucket');
+  myBucket = await testSmartbucket.getBucketByName('testzone');
   expect(myBucket).to.be.instanceOf(smartbucket.Bucket);
-  expect(myBucket.name).to.equal('smartbucket');
+  expect(myBucket.name).to.equal('testzone');
 });
 
 // Fast operations
@@ -38,6 +38,7 @@ tap.test('should store data in bucket fast', async () => {
 
 tap.test('should get data in bucket', async () => {
   const fileString = await myBucket.fastGet('hithere/socool.txt');
+  const fileStringStream = await myBucket.fastGetStream('hithere/socool.txt');
   console.log(fileString);
 });
 
@@ -52,24 +53,36 @@ tap.test('prepare for directory style tests', async () => {
   await myBucket.fastStore('dir1/file2.txt', 'dir1/file2.txt content');
   await myBucket.fastStore('dir2/file1.txt', 'dir2/file1.txt content');
   await myBucket.fastStore('dir3/file1.txt', 'dir3/file1.txt content');
+  await myBucket.fastStore('dir3/dir4/file1.txt', 'dir3/dir4/file1.txt content');
   await myBucket.fastStore('file1.txt', 'file1 content');
 });
 
 tap.test('should get base directory', async () => {
   baseDirectory = await myBucket.getBaseDirectory();
   const directories = await baseDirectory.listDirectories();
+  console.log('Found the following directories:');
+  console.log(directories);
   expect(directories.length).to.equal(3);
   const files = await baseDirectory.listFiles();
+  console.log('Found the following files:');
+  console.log(files);
+  expect(files.length).to.equal(1);
 });
 
+tap.test('should correctly build paths for sub directories', async () => {
+  const dir4 = await baseDirectory.getSubDirectoryByName('dir3/dir4');
+  expect(dir4).to.be.instanceOf(smartbucket.Directory);
+  const dir4BasePath = dir4.getBasePath();
+  console.log(dir4BasePath);
+});
 
 tap.test('clean up directory style tests', async () => {
   await myBucket.fastRemove('dir1/file1.txt');
   await myBucket.fastRemove('dir1/file2.txt');
   await myBucket.fastRemove('dir2/file1.txt');
   await myBucket.fastRemove('dir3/file1.txt');
+  await myBucket.fastRemove('dir3/dir4/file1.txt');
   await myBucket.fastRemove('file1.txt');
 });
 
-
 tap.start();

ts/smartbucket.classes.bucket.ts

@@ -1,6 +1,7 @@
 import * as plugins from './smartbucket.plugins';
 import { SmartBucket } from './smartbucket.classes.smartbucket';
 import { Directory } from './smartbucket.classes.directory';
+import { Observable } from 'rxjs';
 
 export class Bucket {
   public static async getBucketByName(smartbucketRef: SmartBucket, bucketNameArg: string) {
@@ -10,7 +11,7 @@ export class Bucket {
     });
 
     if (foundBucket) {
-      console.log(`bucket with name ${bucketNameArg} exists.`)
+      console.log(`bucket with name ${bucketNameArg} exists.`);
       console.log(`Taking this as base for new Bucket instance`);
       return new this(smartbucketRef, bucketNameArg);
     } else {
@@ -42,7 +43,6 @@ export class Bucket {
     return new Directory(this, null, '');
   }
 
-  
   // ===============
   // Fast Operations
   // ===============
@@ -52,7 +52,9 @@ export class Bucket {
    */
   public async fastStore(pathArg: string, fileContent: string) {
     const streamIntake = new plugins.streamfunction.Intake();
-    const putPromise = this.smartbucketRef.minioClient.putObject(this.name, pathArg, streamIntake.getReadable()).catch(e => console.log(e));
+    const putPromise = this.smartbucketRef.minioClient
+      .putObject(this.name, pathArg, streamIntake.getReadable())
+      .catch(e => console.log(e));
     streamIntake.pushData(fileContent);
     streamIntake.signalEnd();
     await putPromise;
@@ -63,30 +65,53 @@ export class Bucket {
    */
   public async fastGet(pathArg: string) {
     const done = plugins.smartpromise.defer();
-    const fileStream = await this.smartbucketRef.minioClient.getObject(this.name, pathArg).catch(e => console.log(e));
     let completeFile: string = '';
-    const duplexStream = plugins.streamfunction.createDuplexStream<Buffer, Buffer>(async (chunk) => {
+    const replaySubject = await this.fastGetStream(pathArg);
-      const chunkString = chunk.toString();
+    replaySubject.subscribe(
-      completeFile += chunkString;
+      chunkString => {
-      return chunk;
+        completeFile += chunkString;
-    }, async (cb) => {
+      },
-      done.resolve();
+      err => {
-      return Buffer.from('');
+        console.log(err);
-    });
+      },
+      () => {
+        done.resolve();
+      }
+    );
+    await done.promise;
+    return completeFile;
+  }
+
+  public async fastGetStream(pathArg: string): Promise<plugins.smartrx.rxjs.ReplaySubject<string>> {
+    const fileStream = await this.smartbucketRef.minioClient
+      .getObject(this.name, pathArg)
+      .catch(e => console.log(e));
+    const replaySubject = new plugins.smartrx.rxjs.ReplaySubject<string>();
+    const duplexStream = plugins.streamfunction.createDuplexStream<Buffer, Buffer>(
+      async chunk => {
+        const chunkString = chunk.toString();
+        replaySubject.next(chunkString);
+        return chunk;
+      },
+      async cb => {
+        console.log('stream ended');
+        replaySubject.complete();
+        return Buffer.from('');
+      }
+    );
 
     if (!fileStream) {
       return null;
     }
 
     fileStream.pipe(duplexStream);
-    await done.promise;
+    return replaySubject;
-    return completeFile;
   }
 
   /**
    * removeObject
    */
-  public async fastRemove (pathArg: string) {
+  public async fastRemove(pathArg: string) {
     await this.smartbucketRef.minioClient.removeObject(this.name, pathArg);
   }
 }

ts/smartbucket.classes.directory.ts

@@ -4,7 +4,7 @@ import { File } from './smartbucket.classes.file';
 
 export class Directory {
   public bucketRef: Bucket;
-  public parentDirectory: Directory;
+  public parentDirectoryRef: Directory;
   public name: string;
 
   public tree: string[];
@@ -13,7 +13,7 @@ export class Directory {
 
   constructor(bucketRefArg: Bucket, parentDiretory: Directory, name: string) {
     this.bucketRef = bucketRefArg;
-    this.parentDirectory = parentDiretory;
+    this.parentDirectoryRef = parentDiretory;
     this.name = name;
   }
 
@@ -22,9 +22,9 @@ export class Directory {
    */
   public getParentDirectories(): Directory[] {
     let parentDirectories: Directory[] = [];
-    if (this.parentDirectory) {
+    if (this.parentDirectoryRef) {
-      parentDirectories.push(this.parentDirectory);
+      parentDirectories.push(this.parentDirectoryRef);
-      parentDirectories = parentDirectories.concat(this.parentDirectory.getParentDirectories());
+      parentDirectories = parentDirectories.concat(this.parentDirectoryRef.getParentDirectories());
     }
     return parentDirectories;
   }
@@ -34,7 +34,7 @@ export class Directory {
    */
   public getDirectoryLevel(): number {
     return this.getParentDirectories().length;
-  };
+  }
 
   /**
    * updates the base path
@@ -42,8 +42,12 @@ export class Directory {
   public getBasePath(): string {
     const parentDirectories = this.getParentDirectories();
     let basePath = '';
-    for(const parentDir of parentDirectories) {
+    for (const parentDir of parentDirectories) {
-      basePath = parentDir.name + '/' + basePath;
+      if (parentDir.name === '') {
+        basePath = this.name;
+        continue;
+      }
+      basePath = parentDir.name + '/' + this.name;
     }
     return basePath;
   }
@@ -58,11 +62,23 @@ export class Directory {
       this.getBasePath()
     );
     const fileArray: File[] = [];
-    const duplexStream = plugins.streamfunction.createDuplexStream<string, void>(async fileName => {
+    const duplexStream = plugins.streamfunction.createDuplexStream<plugins.minio.BucketItem, void>(
-      fileArray.push(new File(this, fileName));
+      async bucketItem => {
-    }, async (tools) => {
+        if (!bucketItem.name) {
-      done.resolve();
+          return;
-    });
+        }
+        let subtractedPath = bucketItem.name.replace(this.getBasePath(), '');
+        if (subtractedPath.startsWith('/')) {
+          subtractedPath = subtractedPath.substr(1);
+        }
+        if (!subtractedPath.includes('/')) {
+          fileArray.push(new File(this, subtractedPath));
+        }
+      },
+      async tools => {
+        done.resolve();
+      }
+    );
     fileNameStream.pipe(duplexStream);
     await done.promise;
     return fileArray;
@@ -79,19 +95,24 @@ export class Directory {
       true
     );
     const directoryArray: Directory[] = [];
-    const duplexStream = plugins.streamfunction.createDuplexStream<plugins.minio.BucketItem, void>(async fileName => {
+    const duplexStream = plugins.streamfunction.createDuplexStream<plugins.minio.BucketItem, void>(
-      console.log(fileName);
+      async bucketItem => {
-      const subtractedPath = fileName.name.replace(this.getBasePath(), '');
+        let subtractedPath = bucketItem.name.replace(this.getBasePath(), '');
-      if (subtractedPath.includes('/')) {
+        if (subtractedPath.startsWith('/')) {
-        const dirName = fileName.name.split('/')[0];
+          subtractedPath = subtractedPath.substr(1);
-        if (directoryArray.find(directory => directory.name === dirName)) {
-          return;
         }
-        directoryArray.push(new Directory(this.bucketRef, this, dirName));
+        if (subtractedPath.includes('/')) {
+          const dirName = subtractedPath.split('/')[0];
+          if (directoryArray.find(directory => directory.name === dirName)) {
+            return;
+          }
+          directoryArray.push(new Directory(this.bucketRef, this, dirName));
+        }
+      },
+      async tools => {
+        done.resolve();
       }
-    }, async (tools) => {
+    );
-      done.resolve();
-    });
     completeDirStream.pipe(duplexStream);
     await done.promise;
     return directoryArray;
@@ -111,24 +132,58 @@ export class Directory {
   /**
    * gets a sub directory
    */
-  public async getSubDirectory(): Promise<Directory> {
+  public async getSubDirectoryByName(dirNameArg: string): Promise<Directory> {
-    return this;
+    const dirNameArray = dirNameArg.split('/');
-    // TODO
+
+    const getDirectory = async (directoryArg: Directory, dirNameToSearch: string) => {
+      const directories = await directoryArg.listDirectories();
+      return directories.find(directory => {
+        return directory.name === dirNameToSearch;
+      });
+    };
+    let wantedDirectory: Directory;
+    for (const dirNameToSearch of dirNameArray) {
+      const directoryToSearchIn = wantedDirectory ? wantedDirectory : this;
+      wantedDirectory = await getDirectory(directoryToSearchIn, dirNameToSearch);
+    }
+    return wantedDirectory;
   }
 
   /**
    * moves the directory
    */
-  public async move () {
+  public async move() {
     // TODO
   }
 
-
   /**
    * creates a file within this directory
-   * @param relativePathArg 
+   * @param relativePathArg
    */
   public async createFile(relativePathArg) {
     let completeFilePath: string = '';
   }
+
+  // file operations
+  public async fastStore(pathArg: string, contentArg: string) {
+    const path = plugins.path.join(this.getBasePath(), pathArg);
+    await this.bucketRef.fastStore(path, contentArg);
+  }
+
+  public async fastGet(pathArg: string) {
+    const path = plugins.path.join(this.getBasePath(), pathArg);
+    const result = await this.bucketRef.fastGet(path);
+    return result;
+  }
+
+  public async fastGetStream(pathArg: string): Promise<plugins.smartrx.rxjs.ReplaySubject<string>> {
+    const path = plugins.path.join(this.getBasePath(), pathArg);
+    const result = await this.bucketRef.fastGetStream(path);
+    return result;
+  }
+
+  public async fastRemove(pathArg: string) {
+    const path = plugins.path.join(this.getBasePath(), pathArg);
+    await this.bucketRef.fastRemove(path);
+  }
 }

ts/smartbucket.classes.file.ts

@@ -14,11 +14,7 @@ export class File {
     fileName: string,
     fileContent: string
   ) {
-    await this.createFileFromBuffer(
+    await this.createFileFromBuffer(dirArg, fileName, Buffer.from(fileContent));
-      dirArg,
-      fileName,
-      Buffer.from(fileContent)
-    );
   }
 
   public static async createFileFromBuffer(
@@ -37,13 +33,15 @@ export class File {
   }
 
   // INSTANCE
-  public directoryRef: Directory;
+  public parentDirectoryRef: Directory;
+  public name: string;
 
   public path: string;
   public metaData: IFileMetaData;
 
   constructor(directoryRefArg: Directory, fileName: string) {
-    this.directoryRef = directoryRefArg;
+    this.parentDirectoryRef = directoryRefArg;
+    this.name = fileName;
   }
 
   public async getContentAsString() {
@@ -53,15 +51,20 @@ export class File {
 
   public async getContentAsBuffer() {
     const done = plugins.smartpromise.defer();
-    const fileStream = await this.directoryRef.bucketRef.smartbucketRef.minioClient.getObject(this.directoryRef.bucketRef.name, this.path).catch(e => console.log(e));
+    const fileStream = await this.parentDirectoryRef.bucketRef.smartbucketRef.minioClient
+      .getObject(this.parentDirectoryRef.bucketRef.name, this.path)
+      .catch(e => console.log(e));
     let completeFile = new Buffer('');
-    const duplexStream = plugins.streamfunction.createDuplexStream<Buffer, Buffer>(async (chunk) => {
+    const duplexStream = plugins.streamfunction.createDuplexStream<Buffer, Buffer>(
-      completeFile = Buffer.concat([chunk]);
+      async chunk => {
-      return chunk;
+        completeFile = Buffer.concat([chunk]);
-    }, async (cb) => {
+        return chunk;
-      done.resolve();
+      },
-      return Buffer.from('');
+      async cb => {
-    });
+        done.resolve();
+        return Buffer.from('');
+      }
+    );
 
     if (!fileStream) {
       return null;
@@ -80,8 +83,11 @@ export class File {
   /**
    * removes this file
    */
-  public async remove () {
+  public async remove() {
-    await this.directoryRef.bucketRef.smartbucketRef.minioClient.removeObject(this.directoryRef.bucketRef.name, this.path);
+    await this.parentDirectoryRef.bucketRef.smartbucketRef.minioClient.removeObject(
-    await this.directoryRef.listFiles();
+      this.parentDirectoryRef.bucketRef.name,
+      this.path
+    );
+    await this.parentDirectoryRef.listFiles();
   }
 }

ts/smartbucket.plugins.ts

@@ -1,19 +1,16 @@
 // node native
 import * as path from 'path';
 
-export {
+export { path };
-  path
-};
 
 import * as smartpath from '@pushrocks/smartpath';
 import * as smartpromise from '@pushrocks/smartpromise';
+import * as smartrx from '@pushrocks/smartrx';
 import * as streamfunction from '@pushrocks/streamfunction';
 
-export { smartpath, smartpromise, streamfunction };
+export { smartpath, smartpromise, smartrx, streamfunction };
 
 // third party scope
 import * as minio from 'minio';
 
-export {
+export { minio };
-  minio
-};