2.0.4

.gitignore

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

.gitlab-ci.yml

@@ -3,14 +3,17 @@ 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
+
+before_script:
+  - npm install -g @shipzone/npmci
 
 # ====================
 # security stage
@@ -18,21 +21,37 @@ 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 +60,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,34 +97,38 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
-    - npmci command npm install -g tslint typescript
+    - npmci command npm install -g 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
   script:
     - npmci node install lts
-    - npmci command npm install -g @gitzone/tsdoc
+    - npmci command npm install -g @git.zone/tsdoc
     - npmci npm prepare
     - npmci npm install
     - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -114,5 +136,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
   allow_failure: true

.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "npm test",
+      "name": "Run npm test",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm", "wcc"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

npmextra.json

@@ -3,12 +3,13 @@
     "npmGlobalTools": []
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
-      "gitscope": "pushrocks",
+      "gitscope": "push.rocks",
       "gitrepo": "smartbucket",
-      "shortDescription": "simple cloud independent object storage",
-      "npmPackagename": "@pushrocks/smartbucket",
+      "description": "simple cloud independent object storage",
+      "npmPackagename": "@push.rocks/smartbucket",
       "license": "MIT"
     }
   }

package.json

@@ -1,39 +1,46 @@
 {
-  "name": "@pushrocks/smartbucket",
-  "version": "1.0.9",
+  "name": "@push.rocks/smartbucket",
+  "version": "2.0.4",
   "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",
+  "type": "module",
   "author": "Lossless GmbH",
   "license": "UNLICENSED",
   "scripts": {
-    "test": "tstest test/",
-    "format": "(gitzone format)",
-    "build": "echo \"Not needed for now\""
+    "test": "(tstest test/)",
+    "build": "(tsbuild --web --allowimplicitany)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
-    "@gitzone/tstest": "^1.0.28",
-    "@pushrocks/tapbundle": "^3.0.13",
-    "tslint": "^5.20.0",
-    "tslint-config-prettier": "^1.18.0"
+    "@git.zone/tsbuild": "^2.1.63",
+    "@git.zone/tsrun": "^1.2.46",
+    "@git.zone/tstest": "^1.0.71",
+    "@push.rocks/qenv": "^6.0.4",
+    "@push.rocks/tapbundle": "^5.0.3"
   },
   "dependencies": {
-    "@pushrocks/qenv": "^4.0.6",
-    "@pushrocks/smartpromise": "^3.0.6",
-    "@types/minio": "^7.0.3",
-    "minio": "^7.0.12"
+    "@push.rocks/smartpath": "^5.0.5",
+    "@push.rocks/smartpromise": "^4.0.3",
+    "@push.rocks/smartrx": "^3.0.7",
+    "@push.rocks/smartstream": "^2.0.2",
+    "@tsclass/tsclass": "^4.0.50",
+    "@types/minio": "^7.0.13",
+    "minio": "^7.0.28"
   },
-  "private": true,
+  "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

@@ -1,23 +1,36 @@
-# @pushrocks/smartbucket
+# @push.rocks/smartbucket
 simple cloud independent object storage
 
 ## Availabililty and Links
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartbucket)
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/smartbucket)
 * [gitlab.com (source)](https://gitlab.com/pushrocks/smartbucket)
 * [github.com (source mirror)](https://github.com/pushrocks/smartbucket)
 * [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/@push.rocks/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/@push.rocks/smartbucket)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@push.rocks/smartbucket)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@push.rocks/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

@@ -1,37 +1,88 @@
-import { expect, tap } from '@pushrocks/tapbundle';
-import { Qenv } from '@pushrocks/qenv';
+import { expect, expectAsync, tap } from '@push.rocks/tapbundle';
+import { Qenv } from '@push.rocks/qenv';
 
-import * as smartbucket from '../ts/index';
+import * as smartbucket from '../ts/index.js';
 
 const testQenv = new Qenv('./', './.nogit/');
 
 let testSmartbucket: smartbucket.SmartBucket;
 let myBucket: smartbucket.Bucket;
+let baseDirectory: smartbucket.Directory;
 
 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'
+    accessKey: await testQenv.getEnvVarOnDemand('S3_KEY'),
+    accessSecret: await testQenv.getEnvVarOnDemand('S3_SECRET'),
+    endpoint: 's3.eu-central-1.wasabisys.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');
-  expect(myBucket).to.be.instanceOf(smartbucket.Bucket);
-  expect(myBucket.name).to.equal('smartbucket');
+  myBucket = await testSmartbucket.getBucketByName('testzone');
+  expect(myBucket).toBeInstanceOf(smartbucket.Bucket);
+  expect(myBucket.name).toEqual('testzone');
 });
 
-tap.test('should store data in bucket', async () => {
-  
+// Fast operations
+tap.test('should store data in bucket fast', async () => {
+  await myBucket.fastStore('hithere/socool.txt', 'hi there!');
+});
+
+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);
+});
+
+tap.test('should delete data in bucket', async () => {
+  await myBucket.fastRemove('hithere/socool.txt');
+});
+
+// fs operations
+
+tap.test('prepare for directory style tests', async () => {
+  await myBucket.fastStore('dir1/file1.txt', 'dir1/file1.txt content');
+  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).toEqual(3);
+  const files = await baseDirectory.listFiles();
+  console.log('Found the following files:');
+  console.log(files);
+  expect(files.length).toEqual(1);
+});
+
+tap.test('should correctly build paths for sub directories', async () => {
+  const dir4 = await baseDirectory.getSubDirectoryByName('dir3/dir4');
+  expect(dir4).toBeInstanceOf(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/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@push.rocks/smartbucket',
+  version: '2.0.4',
+  description: 'simple cloud independent object storage'
+}

ts/index.ts

@@ -1,4 +1,4 @@
-export * from './smartbucket.classes.smartbucket';
-export * from './smartbucket.classes.bucket';
-export * from './smartbucket.classes.directory';
-export * from './smartbucket.classes.file';
+export * from './smartbucket.classes.smartbucket.js';
+export * from './smartbucket.classes.bucket.js';
+export * from './smartbucket.classes.directory.js';
+export * from './smartbucket.classes.file.js';

ts/smartbucket.classes.bucket.ts

@@ -1,15 +1,16 @@
-import * as plugins from './smartbucket.plugins';
-import { SmartBucket } from './smartbucket.classes.smartbucket';
+import * as plugins from './smartbucket.plugins.js';
+import { SmartBucket } from './smartbucket.classes.smartbucket.js';
+import { Directory } from './smartbucket.classes.directory.js';
 
 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;
     });
 
     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 {
@@ -18,12 +19,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;
@@ -34,10 +35,90 @@ export class Bucket {
     this.name = bucketName;
   }
 
+  /**
+   * gets the base directory of the bucket
+   */
+  public async getBaseDirectory() {
+    return new Directory(this, null, '');
+  }
+
+  // ===============
+  // Fast Operations
+  // ===============
+
   /**
    * store file
    */
-  public store(fileName:) {
+  public async fastStore(pathArg: string, fileContent: string | Buffer): Promise<void> {
+    const streamIntake = new plugins.smartstream.StreamIntake();
+    const putPromise = this.smartbucketRef.minioClient
+      .putObject(this.name, pathArg, streamIntake.getReadable())
+      .catch((e) => console.log(e));
+    streamIntake.pushData(fileContent);
+    streamIntake.signalEnd();
+    await putPromise;
+  }
 
+  /**
+   * get file
+   */
+  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));
+    const replaySubject = new plugins.smartrx.rxjs.ReplaySubject<Buffer>();
+    const duplexStream = plugins.smartstream.createDuplexStream<Buffer, Buffer>(
+      async (chunk) => {
+        replaySubject.next(chunk);
+        return chunk;
+      },
+      async (cb) => {
+        replaySubject.complete();
+        return Buffer.from('');
+      }
+    );
+
+    if (!fileStream) {
+      return null;
+    }
+
+    const smartstream = new plugins.smartstream.StreamWrapper([
+      fileStream,
+      duplexStream,
+      plugins.smartstream.cleanPipe(),
+    ]);
+    smartstream.run();
+    return replaySubject;
+  }
+
+  /**
+   * removeObject
+   */
+  public async fastRemove(pathArg: string) {
+    await this.smartbucketRef.minioClient.removeObject(this.name, pathArg);
   }
 }

ts/smartbucket.classes.directory.ts

@@ -1,3 +1,226 @@
-import * as plugins from './smartbucket.plugins';
+import * as plugins from './smartbucket.plugins.js';
+import { Bucket } from './smartbucket.classes.bucket.js';
+import { File } from './smartbucket.classes.file.js';
 
-export class Directory {}
+export class Directory {
+  public bucketRef: Bucket;
+  public parentDirectoryRef: Directory;
+  public name: string;
+
+  public tree: string[];
+  public files: string[];
+  public folders: string[];
+
+  constructor(bucketRefArg: Bucket, parentDiretory: Directory, name: string) {
+    this.bucketRef = bucketRefArg;
+    this.parentDirectoryRef = parentDiretory;
+    this.name = name;
+  }
+
+  /**
+   * returns an array of parent directories
+   */
+  public getParentDirectories(): Directory[] {
+    let parentDirectories: Directory[] = [];
+    if (this.parentDirectoryRef) {
+      parentDirectories.push(this.parentDirectoryRef);
+      parentDirectories = parentDirectories.concat(this.parentDirectoryRef.getParentDirectories());
+    }
+    return parentDirectories;
+  }
+
+  /**
+   * returns the directory level
+   */
+  public getDirectoryLevel(): number {
+    return this.getParentDirectories().length;
+  }
+
+  /**
+   * updates the base path
+   */
+  public getBasePath(): string {
+    const parentDirectories = this.getParentDirectories();
+    let basePath = '';
+    for (const parentDir of parentDirectories) {
+      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;
+      }
+    }
+    return basePath;
+  }
+
+  /**
+   * lists all files
+   */
+  public async listFiles(): Promise<File[]> {
+    const done = plugins.smartpromise.defer();
+    const fileNameStream = await this.bucketRef.smartbucketRef.minioClient.listObjectsV2(
+      this.bucketRef.name,
+      this.getBasePath(),
+      false
+    );
+    const fileArray: File[] = [];
+    const duplexStream = plugins.smartstream.createDuplexStream<plugins.minio.BucketItem, void>(
+      async (bucketItem) => {
+        if (bucketItem.prefix) {
+          return;
+        }
+        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) => {
+        done.resolve();
+      }
+    );
+    fileNameStream.pipe(duplexStream);
+    await done.promise;
+    return fileArray;
+  }
+
+  /**
+   * lists all folders
+   */
+  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(),
+      false
+    );
+    const directoryArray: Directory[] = [];
+    const duplexStream = plugins.smartstream.createDuplexStream<plugins.minio.BucketItem, void>(
+      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)) {
+            return;
+          }
+          directoryArray.push(new Directory(this.bucketRef, this, dirName));
+        }
+      },
+      async (tools) => {
+        done.resolve();
+      }
+    );
+    completeDirStream.pipe(duplexStream);
+    await done.promise;
+    return directoryArray;
+  }
+
+  /**
+   * gets an array that has all objects with a certain prefix;
+   */
+  public async getTreeArray() {
+    const treeArray = await this.bucketRef.smartbucketRef.minioClient.listObjectsV2(
+      this.bucketRef.name,
+      this.getBasePath(),
+      true
+    );
+  }
+
+  /**
+   * gets a sub directory
+   */
+  public async getSubDirectoryByName(dirNameArg: string): Promise<Directory> {
+    const dirNameArray = dirNameArg.split('/');
+
+    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() {
+    // TODO
+    throw new Error('moving a directory is not yet implemented');
+  }
+
+  /**
+   * creates a file within this directory
+   * @param relativePathArg
+   */
+  public async createEmptyFile(relativePathArg: string) {
+    const emtpyFile = await File.createFileFromString(this, relativePathArg, '');
+  }
+
+  // file operations
+  public async fastStore(pathArg: string, contentArg: string | Buffer) {
+    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<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

@@ -1,3 +1,93 @@
-import * as plugins from './smartbucket.plugins';
+import * as plugins from './smartbucket.plugins.js';
+import { Directory } from './smartbucket.classes.directory.js';
 
-export class File {}
+export interface IFileMetaData {
+  name: string;
+  fileType: string;
+  size: string;
+}
+
+export class File {
+  // STATIC
+  public static async createFileFromString(
+    dirArg: Directory,
+    fileName: string,
+    fileContent: string
+  ) {
+    await this.createFileFromBuffer(dirArg, fileName, Buffer.from(fileContent));
+  }
+
+  public static async createFileFromBuffer(
+    directoryRef: Directory,
+    fileName: string,
+    fileContent: Buffer
+  ) {
+    const filePath = plugins.path.join(directoryRef.getBasePath(), fileName);
+    const streamIntake = new plugins.smartstream.StreamIntake();
+    const putPromise = directoryRef.bucketRef.smartbucketRef.minioClient
+      .putObject(this.name, filePath, streamIntake.getReadable())
+      .catch((e) => console.log(e));
+    streamIntake.pushData(fileContent);
+    streamIntake.signalEnd();
+    await putPromise;
+  }
+
+  // INSTANCE
+  public parentDirectoryRef: Directory;
+  public name: string;
+
+  public path: string;
+  public metaData: IFileMetaData;
+
+  constructor(directoryRefArg: Directory, fileName: string) {
+    this.parentDirectoryRef = directoryRefArg;
+    this.name = fileName;
+  }
+
+  public async getContentAsString() {
+    const fileBuffer = await this.getContentAsBuffer();
+    return fileBuffer.toString();
+  }
+
+  public async getContentAsBuffer() {
+    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));
+    let completeFile = Buffer.from('');
+    const duplexStream = plugins.smartstream.createDuplexStream<Buffer, Buffer>(
+      async (chunk) => {
+        completeFile = Buffer.concat([chunk]);
+        return chunk;
+      },
+      async (cb) => {
+        done.resolve();
+        return Buffer.from('');
+      }
+    );
+
+    if (!fileStream) {
+      return null;
+    }
+
+    fileStream.pipe(duplexStream);
+    await done.promise;
+    return completeFile;
+  }
+
+  public async streamContent() {
+    // TODO
+    throw new Error('not yet implemented');
+  }
+
+  /**
+   * removes this file
+   */
+  public async remove() {
+    await this.parentDirectoryRef.bucketRef.smartbucketRef.minioClient.removeObject(
+      this.parentDirectoryRef.bucketRef.name,
+      this.path
+    );
+    await this.parentDirectoryRef.listFiles();
+  }
+}

ts/smartbucket.classes.smartbucket.ts

@@ -1,28 +1,22 @@
-import * as plugins from './smartbucket.plugins';
-import { Bucket } from './smartbucket.classes.bucket';
-
-export interface ISmartBucketConfig {
-  endpoint: string;
-  accessKey: string;
-  accessSecret: string;
-}
+import * as plugins from './smartbucket.plugins.js';
+import { Bucket } from './smartbucket.classes.bucket.js';
 
 export class SmartBucket {
-  public config: ISmartBucketConfig;
+  public config: plugins.tsclass.storage.IS3Descriptor;
 
   public minioClient: plugins.minio.Client;
 
   /**
    * the constructor of SmartBucket
    */
-  constructor(configArg: ISmartBucketConfig) {
+  constructor(configArg: plugins.tsclass.storage.IS3Descriptor) {
     this.config = configArg;
     this.minioClient = new plugins.minio.Client({
       endPoint: this.config.endpoint,
-      port: 443,
-      useSSL: true,
+      port: configArg.port || 443,
+      useSSL: configArg.useSsl !== undefined ? configArg.useSsl : true,
       accessKey: this.config.accessKey,
-      secretKey: this.config.accessSecret
+      secretKey: this.config.accessSecret,
     });
   }
 

ts/smartbucket.plugins.ts

@@ -1,10 +1,24 @@
-import * as smartpromise from '@pushrocks/smartpromise';
+// node native
+import * as path from 'path';
 
-export { smartpromise };
+export { path };
+
+// @push.rocks scope
+import * as smartpath from '@push.rocks/smartpath';
+import * as smartpromise from '@push.rocks/smartpromise';
+import * as smartrx from '@push.rocks/smartrx';
+import * as smartstream from '@push.rocks/smartstream';
+
+export { smartpath, smartpromise, smartrx, smartstream };
+
+// @tsclass
+import * as tsclass from '@tsclass/tsclass';
+
+export {
+  tsclass,
+}
 
 // third party scope
 import * as minio from 'minio';
 
-export {
-  minio
-};
+export { minio };

tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "esModuleInterop": true,
+    "verbatimModuleSyntax": true
+  },
+  "exclude": [
+    "dist_*/**/*.d.ts"
+  ]
+}

tslint.json

@@ -1,17 +0,0 @@
-{
-  "extends": ["tslint:latest", "tslint-config-prettier"],
-  "rules": {
-    "semicolon": [true, "always"],
-    "no-console": false,
-    "ordered-imports": false,
-    "object-literal-sort-keys": false,
-    "member-ordering": {
-      "options":{
-        "order": [
-          "static-method"
-        ]
-      }
-    }
-  },
-  "defaultSeverity": "warning"
-}