1.0.23

update

See merge request pushrocks/smartbucket!1

.gitignore

@@ -1,5 +1,22 @@
 .nogit/
-node_modules/
+
+# artifacts
 coverage/
 public/
 pages/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_web/
+dist_serve/
+dist_ts_web/
+
+# custom

.gitlab-ci.yml

@@ -1,96 +1,118 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .yarn/
+  - .npmci_cache/
   key: "$CI_BUILD_STAGE"
 
 stages:
-- mirror
 - security
 - test
 - release
-- trigger
-- pages
+- metadata
 
+# ====================
+# security stage
+# ====================
 mirror:
-  stage: mirror
+  stage: security
   script:
   - npmci git mirror
   tags:
   - docker
+  - notpriv
 
-security:
+snyk:
   stage: security
   script:
-    - npmci command yarn global add snyk
-    - npmci command yarn install --ignore-scripts
+    - npmci npm prepare
+    - npmci command npm install -g snyk
+    - npmci command npm install --ignore-scripts
     - npmci command snyk test
   tags:
   - docker
+  - notpriv
 
-testLEGACY:
-  stage: test
-  script:
-  - npmci node install legacy
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  allow_failure: true
+# ====================
+# test stage
+# ====================
 
-testLTS:
-  stage: test
-  script:
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-    
-testSTABLE:
+testStable:
   stage: test
   script:
+  - npmci npm prepare
   - npmci node install stable
   - npmci npm install
   - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - docker
+  - priv
+
+testBuild:
+  stage: test
+  script:
+  - npmci npm prepare
+  - npmci node install stable
+  - npmci npm install
+  - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+  - docker
+  - notpriv
 
 release:
   stage: release
   script:
-  - npmci npm prepare
+  - npmci node install stable
   - npmci npm publish
   only:
   - tags
   tags:
   - docker
+  - notpriv
+
+# ====================
+# metadata stage
+# ====================
+codequality:
+  stage: metadata
+  allow_failure: true
+  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
 
 trigger:
-  stage: trigger
+  stage: metadata
   script:
   - npmci trigger
   only:
   - tags
   tags:
   - docker
+  - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
-  stage: pages
+  stage: metadata
   script:
-    - npmci command yarn global add npmpage
-    - npmci command npmpage
+    - npmci node install lts
+    - npmci command npm install -g @gitzone/tsdoc
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command tsdoc
   tags:
     - docker
+    - notpriv
   only:
     - tags
   artifacts:
     expire_in: 1 week
     paths:
     - public
+  allow_failure: true

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "${relativeFile}"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    },
+    {
+      "name": "test.ts",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "test/test.ts"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,20 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone"
+          }
+        }
+      }
+    }
+  ]
+}

dist/index.d.ts

@@ -1 +0,0 @@
-export declare let standardExport: string;

dist/index.js

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.standardExport = 'Hi there! :) This is an exported string';
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUVXLFFBQUEsY0FBYyxHQUFHLHlDQUF5QyxDQUFDIn0=

dist/smartbucket.plugins.d.ts

@@ -1,2 +0,0 @@
-declare const removeme: {};
-export { removeme };

dist/smartbucket.plugins.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const removeme = {};
-exports.removeme = removeme;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRidWNrZXQucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0YnVja2V0LnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSxNQUFNLFFBQVEsR0FBRyxFQUFFLENBQUM7QUFFbEIsNEJBQVEifQ==

npmextra.json

@@ -1,7 +1,15 @@
 {
   "npmci": {
-    "npmGlobalTools": [
-      "npmts"
-    ]
+    "npmGlobalTools": []
+  },
+  "gitzone": {
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartbucket",
+      "shortDescription": "simple cloud independent object storage",
+      "npmPackagename": "@pushrocks/smartbucket",
+      "license": "MIT"
+    }
   }
-}
+}

package.json

@@ -1,17 +1,41 @@
 {
   "name": "@pushrocks/smartbucket",
-  "version": "1.0.3",
-  "description": "simple cloud independent bucket storage",
+  "version": "1.0.23",
+  "description": "simple cloud independent object storage",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "author": "Lossless GmbH",
-  "license": "",
+  "license": "UNLICENSED",
   "scripts": {
-    "test": "(npmts)",
-    "format": "(gitzone format)"
+    "test": "(tstest test/)",
+    "format": "(gitzone format)",
+    "build": "(tsbuild)"
   },
   "devDependencies": {
-    "tapbundle": "^1.0.13"
+    "@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"
   },
-  "dependencies": {}
+  "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"
+  },
+  "private": false,
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_web/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

qenv.yml

@@ -0,0 +1,3 @@
+required:
+  - S3_KEY
+  - S3_SECRET

readme.md

@@ -0,0 +1,26 @@
+# @pushrocks/smartbucket
+simple cloud independent object storage
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/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/)
+
+## Usage
+
+For further information read the linked docs at the top of this readme.
+
+> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
+
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.ts

@@ -1,8 +1,87 @@
-import { expect, tap } from 'tapbundle'
-import * as smartbucket from '../ts/index'
+import { expect, tap } from '@pushrocks/tapbundle';
+import { Qenv } from '@pushrocks/qenv';
 
-tap.test('first test', async () => {
-  console.log(smartbucket.standardExport)
-})
+import * as smartbucket from '../ts/index';
 
-tap.start()
+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: 'fra1.digitaloceanspaces.com'
+  });
+});
+
+tap.skip.test('should create testbucket', async () => {
+  await testSmartbucket.createBucket('testzone');
+});
+
+tap.skip.test('should remove testbucket', async () => {
+  await testSmartbucket.removeBucket('testzone');
+});
+
+tap.test('should get a bucket', async () => {
+  myBucket = await testSmartbucket.getBucketByName('testzone');
+  expect(myBucket).to.be.instanceOf(smartbucket.Bucket);
+  expect(myBucket.name).to.equal('testzone');
+});
+
+// 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');
+  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).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/index.ts

@@ -1,3 +1,4 @@
-import * as plugins from './smartbucket.plugins';
-
-export let standardExport = 'Hi there! :) This is an exported string';
+export * from './smartbucket.classes.smartbucket';
+export * from './smartbucket.classes.bucket';
+export * from './smartbucket.classes.directory';
+export * from './smartbucket.classes.file';

ts/smartbucket.classes.bucket.ts

@@ -0,0 +1,98 @@
+import * as plugins from './smartbucket.plugins';
+import { SmartBucket } from './smartbucket.classes.smartbucket';
+import { Directory } from './smartbucket.classes.directory';
+
+export class Bucket {
+  public static async getBucketByName(smartbucketRef: SmartBucket, bucketNameArg: string) {
+    const buckets = await smartbucketRef.minioClient.listBuckets();
+    const foundBucket = buckets.find(bucket => {
+      return bucket.name === bucketNameArg;
+    });
+
+    if (foundBucket) {
+      console.log(`bucket with name ${bucketNameArg} exists.`);
+      console.log(`Taking this as base for new Bucket instance`);
+      return new this(smartbucketRef, bucketNameArg);
+    } else {
+      return null;
+    }
+  }
+
+  public static async createBucketByName(smartbucketRef: SmartBucket, bucketName: string) {
+    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));
+  }
+
+  public smartbucketRef: SmartBucket;
+  public name: string;
+
+  constructor(smartbucketRef: SmartBucket, bucketName: string) {
+    this.smartbucketRef = smartbucketRef;
+    this.name = bucketName;
+  }
+
+  /**
+   * gets the base directory of the bucket
+   */
+  public async getBaseDirectory() {
+    return new Directory(this, null, '');
+  }
+
+  // ===============
+  // Fast Operations
+  // ===============
+
+  /**
+   * store file
+   */
+  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));
+    streamIntake.pushData(fileContent);
+    streamIntake.signalEnd();
+    await putPromise;
+  }
+
+  /**
+   * get file
+   */
+  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 chunkString = chunk.toString();
+        completeFile += chunkString;
+        return chunk;
+      },
+      async cb => {
+        done.resolve();
+        return Buffer.from('');
+      }
+    );
+
+    if (!fileStream) {
+      return null;
+    }
+
+    fileStream.pipe(duplexStream);
+    await done.promise;
+    return completeFile;
+  }
+
+  /**
+   * removeObject
+   */
+  public async fastRemove(pathArg: string) {
+    await this.smartbucketRef.minioClient.removeObject(this.name, pathArg);
+  }
+}

ts/smartbucket.classes.directory.ts

@@ -0,0 +1,184 @@
+import * as plugins from './smartbucket.plugins';
+import { Bucket } from './smartbucket.classes.bucket';
+import { File } from './smartbucket.classes.file';
+
+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 = this.name;
+        continue;
+      }
+      basePath = parentDir.name + '/' + this.name;
+    }
+    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()
+    );
+    const fileArray: File[] = [];
+    const duplexStream = plugins.streamfunction.createDuplexStream<plugins.minio.BucketItem, void>(
+      async bucketItem => {
+        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 completeDirStream = await this.bucketRef.smartbucketRef.minioClient.listObjectsV2(
+      this.bucketRef.name,
+      this.getBasePath(),
+      true
+    );
+    const directoryArray: Directory[] = [];
+    const duplexStream = plugins.streamfunction.createDuplexStream<plugins.minio.BucketItem, void>(
+      async bucketItem => {
+        let subtractedPath = bucketItem.name.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
+  }
+
+  /**
+   * creates a file within this directory
+   * @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 fastRemove(pathArg: string) {
+    const path = plugins.path.join(this.getBasePath(), pathArg);
+    await this.bucketRef.fastRemove(path);
+  }
+}

ts/smartbucket.classes.file.ts

@@ -0,0 +1,93 @@
+import * as plugins from './smartbucket.plugins';
+import { Directory } from './smartbucket.classes.directory';
+
+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.streamfunction.Intake();
+    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 = new Buffer('');
+    const duplexStream = plugins.streamfunction.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() {
+    throw new Error('not yet implemented');
+    // TODO
+  }
+
+  /**
+   * 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

@@ -0,0 +1,41 @@
+import * as plugins from './smartbucket.plugins';
+import { Bucket } from './smartbucket.classes.bucket';
+
+export interface ISmartBucketConfig {
+  endpoint: string;
+  accessKey: string;
+  accessSecret: string;
+}
+
+export class SmartBucket {
+  public config: ISmartBucketConfig;
+
+  public minioClient: plugins.minio.Client;
+
+  /**
+   * the constructor of SmartBucket
+   */
+  constructor(configArg: ISmartBucketConfig) {
+    this.config = configArg;
+    this.minioClient = new plugins.minio.Client({
+      endPoint: this.config.endpoint,
+      port: 443,
+      useSSL: true,
+      accessKey: this.config.accessKey,
+      secretKey: this.config.accessSecret
+    });
+  }
+
+  public async createBucket(bucketNameArg: string) {
+    const bucket = await Bucket.createBucketByName(this, bucketNameArg);
+    return bucket;
+  }
+
+  public async removeBucket(bucketName: string) {
+    await Bucket.removeBucketByName(this, bucketName);
+  }
+
+  public async getBucketByName(bucketName: string) {
+    return Bucket.getBucketByName(this, bucketName);
+  }
+}

ts/smartbucket.plugins.ts

@@ -1,4 +1,15 @@
-const removeme = {};
-export {
-  removeme
-}
+// node native
+import * as path from 'path';
+
+export { path };
+
+import * as smartpath from '@pushrocks/smartpath';
+import * as smartpromise from '@pushrocks/smartpromise';
+import * as streamfunction from '@pushrocks/streamfunction';
+
+export { smartpath, smartpromise, streamfunction };
+
+// third party scope
+import * as minio from 'minio';
+
+export { minio };

tslint.json

@@ -1,3 +1,17 @@
 {
-    "extends": "tslint-config-standard"
+  "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"
 }

yarn.lock

@@ -1,193 +0,0 @@
-# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
-# yarn lockfile v1
-
-
-"@types/code@^4.0.3":
-  version "4.0.4"
-  resolved "https://registry.yarnpkg.com/@types/code/-/code-4.0.4.tgz#527fbdbb487dabc4346b8a2ccca3496d8198bae7"
-
-"@types/node@^8.0.33":
-  version "8.10.1"
-  resolved "https://registry.yarnpkg.com/@types/node/-/node-8.10.1.tgz#aac98b810c50568054486f2bb8c486d824713be8"
-
-ansi-256-colors@^1.1.0:
-  version "1.1.0"
-  resolved "https://registry.yarnpkg.com/ansi-256-colors/-/ansi-256-colors-1.1.0.tgz#910de50efcc7c09e3d82f2f87abd6b700c18818a"
-
-beautycolor@^1.0.7:
-  version "1.0.11"
-  resolved "https://registry.yarnpkg.com/beautycolor/-/beautycolor-1.0.11.tgz#71c5568d5a7ed5c144d3a54f753ad1b08862aea5"
-  dependencies:
-    ansi-256-colors "^1.1.0"
-    typings-global "^1.0.14"
-
-bindings@^1.2.1:
-  version "1.3.0"
-  resolved "https://registry.yarnpkg.com/bindings/-/bindings-1.3.0.tgz#b346f6ecf6a95f5a815c5839fc7cdb22502f1ed7"
-
-code@^5.1.0:
-  version "5.2.0"
-  resolved "https://registry.yarnpkg.com/code/-/code-5.2.0.tgz#fb3a5e247afc17e3d65c49e7ce0f69ebe51a75b5"
-  dependencies:
-    hoek "5.x.x"
-
-define-properties@^1.1.2:
-  version "1.1.2"
-  resolved "https://registry.yarnpkg.com/define-properties/-/define-properties-1.1.2.tgz#83a73f2fea569898fb737193c8f873caf6d45c94"
-  dependencies:
-    foreach "^2.0.5"
-    object-keys "^1.0.8"
-
-early@^2.1.1:
-  version "2.1.1"
-  resolved "https://registry.yarnpkg.com/early/-/early-2.1.1.tgz#841e23254ea5dc54d8afaeee82f5ab65c00ee23c"
-  dependencies:
-    beautycolor "^1.0.7"
-    smartq "^1.1.1"
-    typings-global "^1.0.16"
-
-es-abstract@^1.5.1:
-  version "1.11.0"
-  resolved "https://registry.yarnpkg.com/es-abstract/-/es-abstract-1.11.0.tgz#cce87d518f0496893b1a30cd8461835535480681"
-  dependencies:
-    es-to-primitive "^1.1.1"
-    function-bind "^1.1.1"
-    has "^1.0.1"
-    is-callable "^1.1.3"
-    is-regex "^1.0.4"
-
-es-to-primitive@^1.1.1:
-  version "1.1.1"
-  resolved "https://registry.yarnpkg.com/es-to-primitive/-/es-to-primitive-1.1.1.tgz#45355248a88979034b6792e19bb81f2b7975dd0d"
-  dependencies:
-    is-callable "^1.1.1"
-    is-date-object "^1.0.1"
-    is-symbol "^1.0.1"
-
-es6-error@^4.0.2:
-  version "4.1.1"
-  resolved "https://registry.yarnpkg.com/es6-error/-/es6-error-4.1.1.tgz#9e3af407459deed47e9a91f9b885a84eb05c561d"
-
-foreach@^2.0.5:
-  version "2.0.5"
-  resolved "https://registry.yarnpkg.com/foreach/-/foreach-2.0.5.tgz#0bee005018aeb260d0a3af3ae658dd0136ec1b99"
-
-function-bind@^1.0.2, function-bind@^1.1.1:
-  version "1.1.1"
-  resolved "https://registry.yarnpkg.com/function-bind/-/function-bind-1.1.1.tgz#a56899d3ea3c9bab874bb9773b7c5ede92f4895d"
-
-has@^1.0.1:
-  version "1.0.1"
-  resolved "https://registry.yarnpkg.com/has/-/has-1.0.1.tgz#8461733f538b0837c9361e39a9ab9e9704dc2f28"
-  dependencies:
-    function-bind "^1.0.2"
-
-hoek@5.x.x:
-  version "5.0.3"
-  resolved "https://registry.yarnpkg.com/hoek/-/hoek-5.0.3.tgz#b71d40d943d0a95da01956b547f83c4a5b4a34ac"
-
-is-callable@^1.1.1, is-callable@^1.1.3:
-  version "1.1.3"
-  resolved "https://registry.yarnpkg.com/is-callable/-/is-callable-1.1.3.tgz#86eb75392805ddc33af71c92a0eedf74ee7604b2"
-
-is-date-object@^1.0.1:
-  version "1.0.1"
-  resolved "https://registry.yarnpkg.com/is-date-object/-/is-date-object-1.0.1.tgz#9aa20eb6aeebbff77fbd33e74ca01b33581d3a16"
-
-is-regex@^1.0.4:
-  version "1.0.4"
-  resolved "https://registry.yarnpkg.com/is-regex/-/is-regex-1.0.4.tgz#5517489b547091b0930e095654ced25ee97e9491"
-  dependencies:
-    has "^1.0.1"
-
-is-symbol@^1.0.1:
-  version "1.0.1"
-  resolved "https://registry.yarnpkg.com/is-symbol/-/is-symbol-1.0.1.tgz#3cc59f00025194b6ab2e38dbae6689256b660572"
-
-leakage@^0.3.0:
-  version "0.3.0"
-  resolved "https://registry.yarnpkg.com/leakage/-/leakage-0.3.0.tgz#15d698abdc76bbc6439601f4f3020e77e2d50c39"
-  dependencies:
-    es6-error "^4.0.2"
-    left-pad "^1.1.3"
-    memwatch-next "^0.3.0"
-    minimist "^1.2.0"
-    pretty-bytes "^4.0.2"
-
-left-pad@^1.1.3:
-  version "1.2.0"
-  resolved "https://registry.yarnpkg.com/left-pad/-/left-pad-1.2.0.tgz#d30a73c6b8201d8f7d8e7956ba9616087a68e0ee"
-
-memwatch-next@^0.3.0:
-  version "0.3.0"
-  resolved "https://registry.yarnpkg.com/memwatch-next/-/memwatch-next-0.3.0.tgz#2111050f9a906e0aa2d72a4ec0f0089c78726f8f"
-  dependencies:
-    bindings "^1.2.1"
-    nan "^2.3.2"
-
-minimist@^1.2.0:
-  version "1.2.0"
-  resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.0.tgz#a35008b20f41383eec1fb914f4cd5df79a264284"
-
-nan@^2.3.2:
-  version "2.10.0"
-  resolved "https://registry.yarnpkg.com/nan/-/nan-2.10.0.tgz#96d0cd610ebd58d4b4de9cc0c6828cda99c7548f"
-
-object-keys@^1.0.8:
-  version "1.0.11"
-  resolved "https://registry.yarnpkg.com/object-keys/-/object-keys-1.0.11.tgz#c54601778ad560f1142ce0e01bcca8b56d13426d"
-
-object.getownpropertydescriptors@^2.0.3:
-  version "2.0.3"
-  resolved "https://registry.yarnpkg.com/object.getownpropertydescriptors/-/object.getownpropertydescriptors-2.0.3.tgz#8758c846f5b407adab0f236e0986f14b051caa16"
-  dependencies:
-    define-properties "^1.1.2"
-    es-abstract "^1.5.1"
-
-pretty-bytes@^4.0.2:
-  version "4.0.2"
-  resolved "https://registry.yarnpkg.com/pretty-bytes/-/pretty-bytes-4.0.2.tgz#b2bf82e7350d65c6c33aa95aaa5a4f6327f61cd9"
-
-smartchai@^1.0.3:
-  version "1.0.8"
-  resolved "https://registry.yarnpkg.com/smartchai/-/smartchai-1.0.8.tgz#a074836f4ddd4b98c50f1e7ae9e8e8ad9f6f1902"
-  dependencies:
-    "@types/code" "^4.0.3"
-    code "^5.1.0"
-    typings-global "^1.0.20"
-
-smartdelay@^1.0.3:
-  version "1.0.4"
-  resolved "https://registry.yarnpkg.com/smartdelay/-/smartdelay-1.0.4.tgz#791c1a4ee6770494064c10b1d2d2b8e6f3105b82"
-  dependencies:
-    smartq "^1.1.1"
-    typings-global "^1.0.16"
-
-smartq@^1.1.1:
-  version "1.1.8"
-  resolved "https://registry.yarnpkg.com/smartq/-/smartq-1.1.8.tgz#7e2f3b9739eb5d6c9f45f2a86e339ec81e49e8d2"
-  dependencies:
-    util.promisify "^1.0.0"
-
-tapbundle@^1.0.13:
-  version "1.1.8"
-  resolved "https://registry.yarnpkg.com/tapbundle/-/tapbundle-1.1.8.tgz#e08aee0e100a830d8a26a583a85d37ce53312e02"
-  dependencies:
-    "@types/node" "^8.0.33"
-    early "^2.1.1"
-    leakage "^0.3.0"
-    smartchai "^1.0.3"
-    smartdelay "^1.0.3"
-    smartq "^1.1.1"
-    typings-global "^1.0.19"
-
-typings-global@^1.0.14, typings-global@^1.0.16, typings-global@^1.0.19, typings-global@^1.0.20:
-  version "1.0.28"
-  resolved "https://registry.yarnpkg.com/typings-global/-/typings-global-1.0.28.tgz#e28cc965476564cbc00e438739e0aa0735d323d4"
-
-util.promisify@^1.0.0:
-  version "1.0.0"
-  resolved "https://registry.yarnpkg.com/util.promisify/-/util.promisify-1.0.0.tgz#440f7165a459c9a16dc145eb8e72f35687097030"
-  dependencies:
-    define-properties "^1.1.2"
-    object.getownpropertydescriptors "^2.0.3"