1.0.41

.gitignore

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

.gitlab-ci.yml

@@ -3,14 +3,14 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
-- test
-- release
-- metadata
+  - security
+  - test
+  - release
+  - metadata
 
 # ====================
 # security stage
@@ -18,21 +18,38 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
+  only:
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
-snyk:
+auditProductionDependencies:
+  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 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
-  - notpriv
+    - 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 --only=dev
+  tags:
+    - docker
+  allow_failure: true
 
 # ====================
 # test stage
@@ -41,37 +58,36 @@ snyk:
 testStable:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install stable
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - priv
+    - docker
 
 testBuild:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install stable
-  - npmci npm install
-  - npmci command npm run build
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
+    - docker
 
 release:
   stage: release
   script:
-  - npmci node install stable
-  - npmci npm publish
+    - npmci node install stable
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
@@ -79,24 +95,28 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
     - npmci command npm install -g tslint typescript
     - npmci npm prepare
     - npmci npm install
     - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
-  - docker
-  - priv
+    - lossless
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 pages:
   stage: metadata
@@ -107,6 +127,7 @@ pages:
     - npmci npm install
     - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -114,5 +135,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", "wcc"]
+              }
+            }
           }
         }
       }

npmextra.json

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

package.json

@@ -1,41 +1,46 @@
 {
   "name": "@pushrocks/smartbucket",
-  "version": "1.0.22",
+  "version": "1.0.41",
   "description": "simple cloud independent object storage",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
   "author": "Lossless GmbH",
   "license": "UNLICENSED",
   "scripts": {
     "test": "(tstest test/)",
     "format": "(gitzone format)",
-    "build": "(tsbuild)"
+    "build": "(tsbuild --web)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
-    "@gitzone/tstest": "^1.0.28",
-    "@pushrocks/tapbundle": "^3.0.13",
-    "tslint": "^5.20.0",
+    "@gitzone/tsbuild": "^2.1.25",
+    "@gitzone/tstest": "^1.0.54",
+    "@pushrocks/tapbundle": "^3.2.14",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/qenv": "^4.0.6",
-    "@pushrocks/smartpath": "^4.0.1",
-    "@pushrocks/smartpromise": "^3.0.6",
-    "@pushrocks/streamfunction": "^1.0.24",
-    "@types/minio": "^7.0.3",
-    "minio": "^7.0.12"
+    "@pushrocks/qenv": "^4.0.10",
+    "@pushrocks/smartpath": "^4.0.3",
+    "@pushrocks/smartpromise": "^3.1.6",
+    "@pushrocks/smartrx": "^2.0.19",
+    "@pushrocks/streamfunction": "^2.0.1",
+    "@types/minio": "^7.0.7",
+    "minio": "^7.0.18"
   },
   "private": false,
   "files": [
     "ts/**/*",
     "ts_web/**/*",
     "dist/**/*",
-    "dist_web/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
     "dist_ts_web/**/*",
     "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

readme.md

@@ -8,16 +8,29 @@ 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)
-[![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)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartbucket/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartbucket/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartbucket)](https://lossless.cloud)
+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
+
+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,7 +13,7 @@ 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: 'fra1.digitaloceanspaces.com',
   });
 });
 
@@ -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);
 });
 
@@ -75,6 +76,18 @@ tap.test('should correctly build paths for sub directories', async () => {
   console.log(dir4BasePath);
 });
 
+tap.test('should list huge file directory', async () => {
+  const servezoneBucket = await smartbucket.Bucket.getBucketByName(testSmartbucket, 'servezone');
+  const servezoneBaseDirectory = await servezoneBucket.getBaseDirectory();
+  const brandfileDirectory = await servezoneBaseDirectory.getSubDirectoryByName(
+    'public/brandfiles'
+  );
+  const files = await brandfileDirectory.listFiles();
+  const directories = await brandfileDirectory.listDirectories();
+  console.log(files);
+  console.log(directories);
+});
+
 tap.test('clean up directory style tests', async () => {
   await myBucket.fastRemove('dir1/file1.txt');
   await myBucket.fastRemove('dir1/file2.txt');

ts/smartbucket.classes.bucket.ts

@@ -1,11 +1,12 @@
 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) {
     const buckets = await smartbucketRef.minioClient.listBuckets();
-    const foundBucket = buckets.find(bucket => {
+    const foundBucket = buckets.find((bucket) => {
       return bucket.name === bucketNameArg;
     });
 
@@ -19,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;
@@ -49,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;
@@ -62,20 +63,42 @@ export class Bucket {
   /**
    * get file
    */
-  public async fastGet(pathArg: string) {
+  public async fastGet(pathArg: string): Promise<Buffer> {
     const done = plugins.smartpromise.defer();
+    let completeFile: Buffer;
+    const replaySubject = await this.fastGetStream(pathArg);
+    const subscription = replaySubject.subscribe(
+      (chunk) => {
+        if (completeFile) {
+          completeFile = Buffer.concat([completeFile, chunk]);
+        } else {
+          completeFile = chunk;
+        }
+      },
+      (err) => {
+        console.log(err);
+      },
+      () => {
+        done.resolve();
+        subscription.unsubscribe();
+      }
+    );
+    await done.promise;
+    return completeFile;
+  }
+
+  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));
-    let completeFile: string = '';
+      .catch((e) => console.log(e));
+    const replaySubject = new plugins.smartrx.rxjs.ReplaySubject<Buffer>();
     const duplexStream = plugins.streamfunction.createDuplexStream<Buffer, Buffer>(
-      async chunk => {
-        const chunkString = chunk.toString();
-        completeFile += chunkString;
+      async (chunk) => {
+        replaySubject.next(chunk);
         return chunk;
       },
-      async cb => {
-        done.resolve();
+      async (cb) => {
+        replaySubject.complete();
         return Buffer.from('');
       }
     );
@@ -85,8 +108,7 @@ export class Bucket {
     }
 
     fileStream.pipe(duplexStream);
-    await done.promise;
-    return completeFile;
+    return replaySubject;
   }
 
   /**

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 === '') {
-        basePath = this.name;
+      if (!parentDir.name && !basePath) {
+        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;
   }
@@ -59,21 +66,27 @@ export class Directory {
     const done = plugins.smartpromise.defer();
     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 => {
-        if(!bucketItem.name) {
+      async (bucketItem) => {
+        if (bucketItem.prefix) {
           return;
         }
-        const subtractedPath = bucketItem.name.replace(this.getBasePath(), '');
-        if (!subtractedPath.includes('/')) {
-          fileArray.push(new File(this, bucketItem.name));
+        if (!bucketItem.name) {
+          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 => {
+      async (tools) => {
         done.resolve();
       }
     );
@@ -87,27 +100,31 @@ export class Directory {
    */
   public async listDirectories(): Promise<Directory[]> {
     const done = plugins.smartpromise.defer();
+    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 => {
-        let subtractedPath = bucketItem.name.replace(this.getBasePath(), '');
+      async (bucketItem) => {
+        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();
       }
     );
@@ -135,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;
       });
     };
@@ -152,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) {
-    let completeFilePath: string = '';
+  public async createEmptyFile(relativePathArg: 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);
   }
@@ -174,8 +192,35 @@ export class Directory {
     return result;
   }
 
+  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;
+  }
+
   public async fastRemove(pathArg: string) {
     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

@@ -22,7 +22,7 @@ export class SmartBucket {
       port: 443,
       useSSL: true,
       accessKey: this.config.accessKey,
-      secretKey: this.config.accessSecret
+      secretKey: this.config.accessSecret,
     });
   }
 

ts/smartbucket.plugins.ts

@@ -5,9 +5,10 @@ export { 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';