1.0.20

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartbucket",
-  "version": "1.0.12",
+  "version": "1.0.20",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {
@@ -256,7 +256,7 @@
     },
     "@pushrocks/smartpath": {
       "version": "4.0.1",
-      "resolved": "https://registry.npmjs.org/@pushrocks/smartpath/-/smartpath-4.0.1.tgz",
+      "resolved": "https://verdaccio.lossless.one/@pushrocks%2fsmartpath/-/smartpath-4.0.1.tgz",
       "integrity": "sha512-MaI0+uLQPCr2V3WGnbdgb0pWa9xkWyrP4qYcbsHIjeismGLbn9s3jmP/HIXU8LkgzRgaVb+BJxmZJHOwl32DyA=="
     },
     "@pushrocks/smartpromise": {

package.json

@@ -1,15 +1,15 @@
 {
   "name": "@pushrocks/smartbucket",
-  "version": "1.0.12",
+  "version": "1.0.20",
   "description": "simple cloud independent object storage",
   "main": "dist/index.js",
   "typings": "dist/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",
@@ -20,6 +20,7 @@
   },
   "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",

test/test.ts

@@ -7,27 +7,28 @@ 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'
+    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
@@ -44,5 +45,34 @@ 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('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('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('file1.txt');
+});
 
 tap.start();

ts/smartbucket.classes.bucket.ts

@@ -1,5 +1,6 @@
 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) {
@@ -9,7 +10,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 {
@@ -34,6 +35,12 @@ export class Bucket {
     this.name = bucketName;
   }
 
+  /**
+   * gets the base directory of the bucket
+   */
+  public async getBaseDirectory() {
+    return new Directory(this, null, '');
+  }
 
   // ===============
   // Fast Operations
@@ -44,7 +51,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;
@@ -55,16 +64,21 @@ 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));
+    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 duplexStream = plugins.streamfunction.createDuplexStream<Buffer, Buffer>(
-      const chunkString = chunk.toString();
+      async chunk => {
-      completeFile += chunkString;
+        const chunkString = chunk.toString();
-      return chunk;
+        completeFile += chunkString;
-    }, async (cb) => {
+        return chunk;
-      done.resolve();
+      },
-      return Buffer.from('');
+      async cb => {
-    });
+        done.resolve();
+        return Buffer.from('');
+      }
+    );
 
     if (!fileStream) {
       return null;
@@ -78,7 +92,7 @@ export class Bucket {
   /**
    * 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,15 +4,48 @@ import { File } from './smartbucket.classes.file';
 
 export class Directory {
   public bucketRef: Bucket;
-  public basePath: string;
+  public parentDirectoryRef: Directory;
+  public name: string;
 
   public tree: string[];
   public files: string[];
   public folders: string[];
 
-  constructor(bucketRefArg: Bucket, basePathArg: string) {
+  constructor(bucketRefArg: Bucket, parentDiretory: Directory, name: string) {
     this.bucketRef = bucketRefArg;
-    this.basePath = basePathArg;
+    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) {
+      basePath = parentDir.name + '/' + basePath;
+    }
+    return basePath;
   }
 
   /**
@@ -22,14 +55,24 @@ export class Directory {
     const done = plugins.smartpromise.defer();
     const fileNameStream = await this.bucketRef.smartbucketRef.minioClient.listObjectsV2(
       this.bucketRef.name,
-      this.basePath
+      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;
-    });
+        }
+        const subtractedPath = bucketItem.name.replace(this.getBasePath(), '');
+        if (!subtractedPath.includes('/')) {
+          fileArray.push(new File(this, bucketItem.name));
+        }
+        
+      },
+      async tools => {
+        done.resolve();
+      }
+    );
     fileNameStream.pipe(duplexStream);
     await done.promise;
     return fileArray;
@@ -38,22 +81,32 @@ export class Directory {
   /**
    * lists all folders
    */
-  public async listDirectories() {
+  public async listDirectories(): Promise<Directory[]> {
     const done = plugins.smartpromise.defer();
     const completeDirStream = await this.bucketRef.smartbucketRef.minioClient.listObjectsV2(
       this.bucketRef.name,
-      this.basePath,
+      this.getBasePath(),
       true
     );
-    const fileArray: File[] = [];
+    const directoryArray: Directory[] = [];
-    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) => {
+        const subtractedPath = bucketItem.name.replace(this.getBasePath(), '');
-      done.resolve();
+        if (subtractedPath.includes('/')) {
-    });
+          const dirName = bucketItem.name.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 fileArray;
+    return directoryArray;
   }
 
   /**
@@ -62,8 +115,51 @@ export class Directory {
   public async getTreeArray() {
     const treeArray = await this.bucketRef.smartbucketRef.minioClient.listObjectsV2(
       this.bucketRef.name,
-      this.basePath,
+      this.getBasePath(),
       true
     );
   }
+
+  /**
+   * gets a sub directory
+   */
+  public async getSubDirectoryByName(dirNameArg: string): Promise<Directory> {
+    // TODO: make this recursive
+    const directories = await this.listDirectories();
+    return directories.find(directory => {
+      return directory.name === dirNameArg;
+    });
+  }
+
+  /**
+   * 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

@@ -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(
@@ -26,7 +22,7 @@ export class File {
     fileName: string,
     fileContent: Buffer
   ) {
-    const filePath = plugins.path.join(directoryRef.basePath, fileName);
+    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())
@@ -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,18 +1,15 @@
 // 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 streamfunction from '@pushrocks/streamfunction';
 
-export { smartpromise, streamfunction };
+export { smartpath, smartpromise, streamfunction };
 
 // third party scope
 import * as minio from 'minio';
 
-export {
+export { minio };
-  minio
-};