3.0.14

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@push.rocks/smartbucket",
-  "version": "3.0.10",
+  "version": "3.0.14",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@push.rocks/smartbucket",
-      "version": "3.0.10",
+      "version": "3.0.14",
       "license": "UNLICENSED",
       "dependencies": {
         "@push.rocks/smartpath": "^5.0.18",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@push.rocks/smartbucket",
-  "version": "3.0.10",
+  "version": "3.0.14",
   "description": "A TypeScript library offering simple and cloud-agnostic object storage with advanced features like bucket creation, file and directory management, and data streaming.",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
@@ -23,9 +23,10 @@
     "@push.rocks/smartpath": "^5.0.18",
     "@push.rocks/smartpromise": "^4.0.3",
     "@push.rocks/smartrx": "^3.0.7",
-    "@push.rocks/smartstream": "^3.0.42",
+    "@push.rocks/smartstream": "^3.0.44",
+    "@push.rocks/smartstring": "^4.0.15",
     "@push.rocks/smartunique": "^3.0.9",
-    "@tsclass/tsclass": "^4.0.54",
+    "@tsclass/tsclass": "^4.0.55",
     "minio": "^8.0.0"
   },
   "private": false,

pnpm-lock.yaml

@@ -21,14 +21,17 @@ importers:
         specifier: ^3.0.7
         version: 3.0.7
       '@push.rocks/smartstream':
-        specifier: ^3.0.42
-        version: 3.0.42
+        specifier: ^3.0.44
+        version: 3.0.44
+      '@push.rocks/smartstring':
+        specifier: ^4.0.15
+        version: 4.0.15
       '@push.rocks/smartunique':
         specifier: ^3.0.9
         version: 3.0.9
       '@tsclass/tsclass':
-        specifier: ^4.0.54
-        version: 4.0.54
+        specifier: ^4.0.55
+        version: 4.0.55
       minio:
         specifier: ^8.0.0
         version: 8.0.0
@@ -38,10 +41,10 @@ importers:
         version: 2.1.80
       '@git.zone/tsrun':
         specifier: ^1.2.46
-        version: 1.2.46(@types/node@20.14.0)
+        version: 1.2.46(@types/node@20.14.2)
       '@git.zone/tstest':
         specifier: ^1.0.90
-        version: 1.0.90(@types/node@20.14.0)
+        version: 1.0.90(@types/node@20.14.2)
       '@push.rocks/qenv':
         specifier: ^6.0.5
         version: 6.0.5
@@ -470,8 +473,8 @@ packages:
   '@push.rocks/smartstream@2.0.8':
     resolution: {integrity: sha512-GlF/9cCkvBHwKa3DK4DO5wjfSgqkj6gAS4TrY9uD5NMHu9RQv4WiNrElTYj7iCEpnZgUnLO3tzw1JA3NRIMnnA==}
 
-  '@push.rocks/smartstream@3.0.42':
-    resolution: {integrity: sha512-5/laFoH8wCO7GAys8zRJGnYT2fvV4q83OzIxEZ6zcwTPLfP92WNmlTBezKrNYCVpc4gmmCVArdEX1Ha6Y3HnvA==}
+  '@push.rocks/smartstream@3.0.44':
+    resolution: {integrity: sha512-BZwSUmhVD/CEzRdG/e2UachlyNjshiknqBnwHzIFPIjVKC66UgWX5lYCs2LOwJtuUEpfL1vTMOAYUFNcmPjW9A==}
 
   '@push.rocks/smartstring@4.0.15':
     resolution: {integrity: sha512-NTNeOjWyg+aHtBTiQEyXamr7oTvYZ3wS1fudHo9ua7CLrykpK+i+RxFyJaLg1zB5x9xQF3NLEQecB14HPFX8Cg==}
@@ -624,8 +627,8 @@ packages:
   '@tsclass/tsclass@3.0.48':
     resolution: {integrity: sha512-hC65UvDlp9qvsl6OcIZXz0JNiWZ0gyzsTzbXpg215sGxopgbkOLCr6E0s4qCTnweYm95gt2AdY95uP7M7kExaQ==}
 
-  '@tsclass/tsclass@4.0.54':
-    resolution: {integrity: sha512-v+Xc7M0BKNT79/kx7S5Jsc17zj+acUuMDxJtKbQgdU4H8ke3aHAHJr2KicXJeXDTcn41ZEbwJPQ1cc+bjy8bZw==}
+  '@tsclass/tsclass@4.0.55':
+    resolution: {integrity: sha512-zg774JF90/3/rJ7xk4LyGgxcUzxdKIQcwtBVxez4LhvegESxvHiFmX42WL105iBpE53ISJ8sctLWlwG1JQZdlA==}
 
   '@tsconfig/node10@1.0.11':
     resolution: {integrity: sha512-DcRjDCujK/kCk/cUe8Xz8ZSpm8mS3mNNpta+jGCA6USEDfktlNvm1+IuZ9eTcDbNk41BHwpHHeW+N1lKCz4zOw==}
@@ -768,8 +771,8 @@ packages:
   '@types/node@20.12.12':
     resolution: {integrity: sha512-eWLDGF/FOSPtAvEqeRAQ4C8LSA7M1I7i0ky1I8U7kD1J5ITyW3AsRhQrKVoWf5pFKZ2kILsEGJhsI9r93PYnOw==}
 
-  '@types/node@20.14.0':
-    resolution: {integrity: sha512-5cHBxFGJx6L4s56Bubp4fglrEpmyJypsqI6RgzMfBHWUJQGWAAi8cWcgetEbZXHYXo9C2Fa4EEds/uSyS4cxmA==}
+  '@types/node@20.14.2':
+    resolution: {integrity: sha512-xyu6WAMVwv6AKFLB+e/7ySZVr/0zLCzOa7rSpq6jNwpqOrUbcACDWC+53d4n2QHOnDou0fbIsg8wZu/sxrnI4Q==}
 
   '@types/parse5@6.0.3':
     resolution: {integrity: sha512-SuT16Q1K51EAVPz1K29DJ/sXjhSQ0zjvsypYJ6tlwVsRV9jwW5Adq2ch8Dq8kDBCkYnELS7N7VNCSB5nC56t/g==}
@@ -2827,8 +2830,8 @@ packages:
     resolution: {integrity: sha512-RAH822pAdBgcNMAfWnCBU3CFZcfZ/i1eZjwFU/dsLKumyuuP3niueg2UAukXYF0E2AAoc82ZSSf9J0WQBinzHA==}
     engines: {node: '>=12.20'}
 
-  type-fest@4.18.2:
-    resolution: {integrity: sha512-+suCYpfJLAe4OXS6+PPXjW3urOS4IoP9waSiLuXfLgqZODKw/aWwASvzqE886wA0kQgGy0mIWyhd87VpqIy6Xg==}
+  type-fest@4.20.0:
+    resolution: {integrity: sha512-MBh+PHUHHisjXf4tlx0CFWoMdjx8zCMLJHOjnV1prABYZFHqtFOyauCIK2/7w4oIfwkF8iNhLtnJEfVY2vn3iw==}
     engines: {node: '>=16'}
 
   type-is@1.6.18:
@@ -3133,12 +3136,12 @@ snapshots:
       '@push.rocks/smartrequest': 2.0.22
       '@push.rocks/smartrx': 3.0.7
       '@push.rocks/smartsitemap': 2.0.3
-      '@push.rocks/smartstream': 3.0.42
+      '@push.rocks/smartstream': 3.0.44
       '@push.rocks/smarttime': 4.0.6
       '@push.rocks/taskbuffer': 3.1.7
       '@push.rocks/webrequest': 3.0.37
       '@push.rocks/webstore': 2.0.17
-      '@tsclass/tsclass': 4.0.54
+      '@tsclass/tsclass': 4.0.55
       '@types/express': 4.17.21
       body-parser: 1.20.2
       cors: 2.8.5
@@ -3339,22 +3342,22 @@ snapshots:
     transitivePeerDependencies:
       - supports-color
 
-  '@git.zone/tsrun@1.2.46(@types/node@20.14.0)':
+  '@git.zone/tsrun@1.2.46(@types/node@20.14.2)':
     dependencies:
       '@push.rocks/smartfile': 10.0.41
       '@push.rocks/smartshell': 3.0.5
-      ts-node: 10.9.2(@types/node@20.14.0)(typescript@5.1.6)
+      ts-node: 10.9.2(@types/node@20.14.2)(typescript@5.1.6)
       typescript: 5.1.6
     transitivePeerDependencies:
       - '@swc/core'
       - '@swc/wasm'
       - '@types/node'
 
-  '@git.zone/tstest@1.0.90(@types/node@20.14.0)':
+  '@git.zone/tstest@1.0.90(@types/node@20.14.2)':
     dependencies:
       '@api.global/typedserver': 3.0.37
       '@git.zone/tsbundle': 2.0.15
-      '@git.zone/tsrun': 1.2.46(@types/node@20.14.0)
+      '@git.zone/tsrun': 1.2.46(@types/node@20.14.2)
       '@push.rocks/consolecolor': 2.0.2
       '@push.rocks/smartbrowser': 2.0.6
       '@push.rocks/smartdelay': 3.0.5
@@ -3603,7 +3606,7 @@ snapshots:
       '@push.rocks/smartpath': 5.0.18
       '@push.rocks/smartpromise': 4.0.3
       '@push.rocks/smartrequest': 2.0.22
-      '@push.rocks/smartstream': 3.0.42
+      '@push.rocks/smartstream': 3.0.44
       '@types/fs-extra': 11.0.4
       '@types/glob': 8.1.0
       '@types/js-yaml': 4.0.9
@@ -3717,7 +3720,7 @@ snapshots:
       '@push.rocks/smartpromise': 4.0.3
       '@push.rocks/smartpuppeteer': 2.0.2
       '@push.rocks/smartunique': 3.0.9
-      '@tsclass/tsclass': 4.0.54
+      '@tsclass/tsclass': 4.0.55
       '@types/express': 4.17.21
       express: 4.19.2
       pdf-lib: 1.17.1
@@ -3775,7 +3778,7 @@ snapshots:
       '@push.rocks/smartxml': 1.0.8
       '@push.rocks/smartyaml': 2.0.5
       '@push.rocks/webrequest': 3.0.37
-      '@tsclass/tsclass': 4.0.54
+      '@tsclass/tsclass': 4.0.55
 
   '@push.rocks/smartsocket@2.0.27':
     dependencies:
@@ -3827,7 +3830,7 @@ snapshots:
       from2: 2.3.0
       through2: 4.0.2
 
-  '@push.rocks/smartstream@3.0.42':
+  '@push.rocks/smartstream@3.0.44':
     dependencies:
       '@push.rocks/lik': 6.0.15
       '@push.rocks/smartenv': 5.0.12
@@ -3909,7 +3912,7 @@ snapshots:
     dependencies:
       '@pushrocks/smartdelay': 3.0.1
       '@pushrocks/smartpromise': 4.0.2
-      '@tsclass/tsclass': 4.0.54
+      '@tsclass/tsclass': 4.0.55
 
   '@push.rocks/webstore@2.0.17':
     dependencies:
@@ -4089,9 +4092,9 @@ snapshots:
     dependencies:
       type-fest: 2.19.0
 
-  '@tsclass/tsclass@4.0.54':
+  '@tsclass/tsclass@4.0.55':
     dependencies:
-      type-fest: 4.18.2
+      type-fest: 4.20.0
 
   '@tsconfig/node10@1.0.11': {}
 
@@ -4256,7 +4259,7 @@ snapshots:
     dependencies:
       undici-types: 5.26.5
 
-  '@types/node@20.14.0':
+  '@types/node@20.14.2':
     dependencies:
       undici-types: 5.26.5
 
@@ -6676,14 +6679,14 @@ snapshots:
 
   trough@2.2.0: {}
 
-  ts-node@10.9.2(@types/node@20.14.0)(typescript@5.1.6):
+  ts-node@10.9.2(@types/node@20.14.2)(typescript@5.1.6):
     dependencies:
       '@cspotcode/source-map-support': 0.8.1
       '@tsconfig/node10': 1.0.11
       '@tsconfig/node12': 1.0.11
       '@tsconfig/node14': 1.0.3
       '@tsconfig/node16': 1.0.4
-      '@types/node': 20.14.0
+      '@types/node': 20.14.2
       acorn: 8.11.3
       acorn-walk: 8.3.2
       arg: 4.1.3
@@ -6710,7 +6713,7 @@ snapshots:
 
   type-fest@2.19.0: {}
 
-  type-fest@4.18.2: {}
+  type-fest@4.20.0: {}
 
   type-is@1.6.18:
     dependencies:

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@push.rocks/smartbucket',
-  version: '3.0.10',
+  version: '3.0.14',
   description: 'A TypeScript library offering simple and cloud-agnostic object storage with advanced features like bucket creation, file and directory management, and data streaming.'
 }

ts/classes.bucket.ts

@@ -4,7 +4,13 @@ import * as interfaces from './interfaces.js';
 import { SmartBucket } from './classes.smartbucket.js';
 import { Directory } from './classes.directory.js';
 import { File } from './classes.file.js';
+import { Trash } from './classes.trash.js';
 
+/**
+ * The bucket class exposes the basc functionality of a bucket.
+ * The functions of the bucket alone are enough to
+ * operate in s3 basic fashion on blobs of data.
+ */
 export class Bucket {
   public static async getBucketByName(smartbucketRef: SmartBucket, bucketNameArg: string) {
     const buckets = await smartbucketRef.minioClient.listBuckets();
@@ -45,7 +51,17 @@ export class Bucket {
     return new Directory(this, null, '');
   }
 
-  public async getDirectoryFromPath(pathDescriptorArg: interfaces.IPathDecriptor): Promise<Directory> {
+  /**
+   * gets the trash directory
+   */
+  public async getTrash(): Promise<Trash> {
+    const trash = new Trash(this);
+    return trash;
+  }
+
+  public async getDirectoryFromPath(
+    pathDescriptorArg: interfaces.IPathDecriptor
+  ): Promise<Directory> {
     if (!pathDescriptorArg.path && !pathDescriptorArg.directory) {
       return this.getBaseDirectory();
     }
@@ -61,34 +77,37 @@ export class Bucket {
   /**
    * store file
    */
-  public async fastPut(optionsArg: {
-    path: string;
+  public async fastPut(optionsArg: interfaces.IPathDecriptor & {
     contents: string | Buffer;
     overwrite?: boolean;
   }): Promise<File> {
     try {
-      const reducedPath = await helpers.reducePathDescriptorToPath({
-        path: optionsArg.path,
-      })
+      const reducedPath = await helpers.reducePathDescriptorToPath(optionsArg);
       // Check if the object already exists
       const exists = await this.fastExists({ path: reducedPath });
-  
+
       if (exists && !optionsArg.overwrite) {
         console.error(`Object already exists at path '${reducedPath}' in bucket '${this.name}'.`);
         return;
       } else if (exists && optionsArg.overwrite) {
-        console.log(`Overwriting existing object at path '${reducedPath}' in bucket '${this.name}'.`);
+        console.log(
+          `Overwriting existing object at path '${reducedPath}' in bucket '${this.name}'.`
+        );
       } else {
         console.log(`Creating new object at path '${reducedPath}' in bucket '${this.name}'.`);
       }
-  
+
       // Proceed with putting the object
       const streamIntake = new plugins.smartstream.StreamIntake();
-      const putPromise = this.smartbucketRef.minioClient.putObject(this.name, reducedPath, streamIntake);
+      const putPromise = this.smartbucketRef.minioClient.putObject(
+        this.name,
+        reducedPath,
+        streamIntake
+      );
       streamIntake.pushData(optionsArg.contents);
       streamIntake.signalEnd();
       await putPromise;
-  
+
       console.log(`Object '${reducedPath}' has been successfully stored in bucket '${this.name}'.`);
       const parsedPath = plugins.path.parse(reducedPath);
       return new File({
@@ -98,18 +117,18 @@ export class Bucket {
         fileName: parsedPath.base,
       });
     } catch (error) {
-      console.error(`Error storing object at path '${optionsArg.path}' in bucket '${this.name}':`, error);
+      console.error(
+        `Error storing object at path '${optionsArg.path}' in bucket '${this.name}':`,
+        error
+      );
       throw error;
     }
   }
-  
 
   /**
    * get file
    */
-  public async fastGet(optionsArg: {
-    path: string
-  }): Promise<Buffer> {
+  public async fastGet(optionsArg: { path: string }): Promise<Buffer> {
     const done = plugins.smartpromise.defer();
     let completeFile: Buffer;
     const replaySubject = await this.fastGetReplaySubject(optionsArg);
@@ -137,7 +156,7 @@ export class Bucket {
    * good when time to first byte is important
    * and multiple subscribers are expected
    * @param optionsArg
-   * @returns 
+   * @returns
    */
   public async fastGetReplaySubject(optionsArg: {
     path: string;
@@ -154,34 +173,40 @@ export class Bucket {
       finalFunction: async (cb) => {
         replaySubject.complete();
         return;
-      }
+      },
     });
 
     if (!fileStream) {
       return null;
     }
 
-    const smartstream = new plugins.smartstream.StreamWrapper([
-      fileStream,
-      duplexStream,
-    ]);
+    const smartstream = new plugins.smartstream.StreamWrapper([fileStream, duplexStream]);
     smartstream.run();
     return replaySubject;
   }
 
-  public fastGetStream(optionsArg: {
-    path: string;
-  }, typeArg: 'webstream'): Promise<ReadableStream>
-  public async fastGetStream(optionsArg: {
-    path: string;
-  }, typeArg: 'nodestream'): Promise<plugins.stream.Readable>
+  public fastGetStream(
+    optionsArg: {
+      path: string;
+    },
+    typeArg: 'webstream'
+  ): Promise<ReadableStream>;
+  public async fastGetStream(
+    optionsArg: {
+      path: string;
+    },
+    typeArg: 'nodestream'
+  ): Promise<plugins.stream.Readable>;
 
   /**
    * fastGetStream
    * @param optionsArg
-   * @returns 
+   * @returns
    */
-  public async fastGetStream(optionsArg: { path: string; }, typeArg: 'webstream' | 'nodestream' = 'nodestream'): Promise<ReadableStream | plugins.stream.Readable>{
+  public async fastGetStream(
+    optionsArg: { path: string },
+    typeArg: 'webstream' | 'nodestream' = 'nodestream'
+  ): Promise<ReadableStream | plugins.stream.Readable> {
     const fileStream = await this.smartbucketRef.minioClient
       .getObject(this.name, optionsArg.path)
       .catch((e) => console.log(e));
@@ -191,21 +216,18 @@ export class Bucket {
       },
       finalFunction: async (cb) => {
         return null;
-      }
+      },
     });
 
     if (!fileStream) {
       return null;
     }
 
-    const smartstream = new plugins.smartstream.StreamWrapper([
-      fileStream,
-      duplexStream,
-    ]);
+    const smartstream = new plugins.smartstream.StreamWrapper([fileStream, duplexStream]);
     smartstream.run();
     if (typeArg === 'nodestream') {
       return duplexStream;
-    };
+    }
     if (typeArg === 'webstream') {
       return (await duplexStream.getWebStreams()).readable;
     }
@@ -216,46 +238,51 @@ export class Bucket {
    */
   public async fastPutStream(optionsArg: {
     path: string;
-    dataStream: plugins.stream.Readable | ReadableStream;
+    readableStream: plugins.stream.Readable | ReadableStream;
     nativeMetadata?: { [key: string]: string };
     overwrite?: boolean;
   }): Promise<void> {
     try {
       // Check if the object already exists
       const exists = await this.fastExists({ path: optionsArg.path });
-  
+
       if (exists && !optionsArg.overwrite) {
-        console.error(`Object already exists at path '${optionsArg.path}' in bucket '${this.name}'.`);
+        console.error(
+          `Object already exists at path '${optionsArg.path}' in bucket '${this.name}'.`
+        );
         return;
       } else if (exists && optionsArg.overwrite) {
-        console.log(`Overwriting existing object at path '${optionsArg.path}' in bucket '${this.name}'.`);
+        console.log(
+          `Overwriting existing object at path '${optionsArg.path}' in bucket '${this.name}'.`
+        );
       } else {
         console.log(`Creating new object at path '${optionsArg.path}' in bucket '${this.name}'.`);
       }
 
-      const streamIntake = await plugins.smartstream.StreamIntake.fromStream<Uint8Array>(optionsArg.dataStream);
-  
+      const streamIntake = await plugins.smartstream.StreamIntake.fromStream<Uint8Array>(
+        optionsArg.readableStream
+      );
+
       // Proceed with putting the object
       await this.smartbucketRef.minioClient.putObject(
         this.name,
         optionsArg.path,
         streamIntake,
         null,
-        ...(optionsArg.nativeMetadata
-          ? (() => {
-              const returnObject: any = {};
-              return returnObject;
-            })()
-          : {})
+        null // TODO: Add support for custom metadata once proper support is in minio.
+      );
+
+      console.log(
+        `Object '${optionsArg.path}' has been successfully stored in bucket '${this.name}'.`
       );
-  
-      console.log(`Object '${optionsArg.path}' has been successfully stored in bucket '${this.name}'.`);
     } catch (error) {
-      console.error(`Error storing object at path '${optionsArg.path}' in bucket '${this.name}':`, error);
+      console.error(
+        `Error storing object at path '${optionsArg.path}' in bucket '${this.name}':`,
+        error
+      );
       throw error;
     }
   }
-  
 
   public async fastCopy(optionsArg: {
     sourcePath: string;
@@ -296,60 +323,66 @@ export class Bucket {
     }
   }
 
-    /**
+  /**
    * Move object from one path to another within the same bucket or to another bucket
    */
-    public async fastMove(optionsArg: {
-      sourcePath: string;
-      destinationPath: string;
-      targetBucket?: Bucket;
-      overwrite?: boolean;
-    }): Promise<void> {
-      try {
-        // Check if the destination object already exists
-        const destinationBucket = optionsArg.targetBucket || this;
-        const exists = await destinationBucket.fastExists({ path: optionsArg.destinationPath });
-  
-        if (exists && !optionsArg.overwrite) {
-          console.error(`Object already exists at destination path '${optionsArg.destinationPath}' in bucket '${destinationBucket.name}'.`);
-          return;
-        } else if (exists && optionsArg.overwrite) {
-          console.log(`Overwriting existing object at destination path '${optionsArg.destinationPath}' in bucket '${destinationBucket.name}'.`);
-        } else {
-          console.log(`Moving object to path '${optionsArg.destinationPath}' in bucket '${destinationBucket.name}'.`);
-        }
-  
-        // Proceed with copying the object to the new path
-        await this.fastCopy(optionsArg);
-  
-        // Remove the original object after successful copy
-        await this.fastRemove({ path: optionsArg.sourcePath });
-  
-        console.log(`Object '${optionsArg.sourcePath}' has been successfully moved to '${optionsArg.destinationPath}' in bucket '${destinationBucket.name}'.`);
-      } catch (error) {
-        console.error(`Error moving object from '${optionsArg.sourcePath}' to '${optionsArg.destinationPath}':`, error);
-        throw error;
+  public async fastMove(optionsArg: {
+    sourcePath: string;
+    destinationPath: string;
+    targetBucket?: Bucket;
+    overwrite?: boolean;
+  }): Promise<void> {
+    try {
+      // Check if the destination object already exists
+      const destinationBucket = optionsArg.targetBucket || this;
+      const exists = await destinationBucket.fastExists({ path: optionsArg.destinationPath });
+
+      if (exists && !optionsArg.overwrite) {
+        console.error(
+          `Object already exists at destination path '${optionsArg.destinationPath}' in bucket '${destinationBucket.name}'.`
+        );
+        return;
+      } else if (exists && optionsArg.overwrite) {
+        console.log(
+          `Overwriting existing object at destination path '${optionsArg.destinationPath}' in bucket '${destinationBucket.name}'.`
+        );
+      } else {
+        console.log(
+          `Moving object to path '${optionsArg.destinationPath}' in bucket '${destinationBucket.name}'.`
+        );
       }
+
+      // Proceed with copying the object to the new path
+      await this.fastCopy(optionsArg);
+
+      // Remove the original object after successful copy
+      await this.fastRemove({ path: optionsArg.sourcePath });
+
+      console.log(
+        `Object '${optionsArg.sourcePath}' has been successfully moved to '${optionsArg.destinationPath}' in bucket '${destinationBucket.name}'.`
+      );
+    } catch (error) {
+      console.error(
+        `Error moving object from '${optionsArg.sourcePath}' to '${optionsArg.destinationPath}':`,
+        error
+      );
+      throw error;
     }
-  
+  }
 
   /**
    * removeObject
    */
-  public async fastRemove(optionsArg: {
-    path: string;
-  }) {
+  public async fastRemove(optionsArg: { path: string }) {
     await this.smartbucketRef.minioClient.removeObject(this.name, optionsArg.path);
   }
 
   /**
    * check wether file exists
    * @param optionsArg
-   * @returns 
+   * @returns
    */
-  public async fastExists(optionsArg: {
-    path: string;
-  }): Promise<boolean> {
+  public async fastExists(optionsArg: { path: string }): Promise<boolean> {
     try {
       await this.smartbucketRef.minioClient.statObject(this.name, optionsArg.path);
       console.log(`Object '${optionsArg.path}' exists in bucket '${this.name}'.`);
@@ -379,7 +412,7 @@ export class Bucket {
 
   public async isDirectory(pathDescriptor: interfaces.IPathDecriptor): Promise<boolean> {
     let checkPath = await helpers.reducePathDescriptorToPath(pathDescriptor);
-    
+
     // lets check if the checkPath is a directory
     const stream = this.smartbucketRef.minioClient.listObjectsV2(this.name, checkPath, true);
     const done = plugins.smartpromise.defer<boolean>();
@@ -389,21 +422,21 @@ export class Bucket {
         done.resolve(true);
       }
     });
-    
+
     stream.on('end', () => {
       done.resolve(false);
     });
-    
+
     stream.on('error', (err) => {
       done.reject(err);
     });
 
     return done.promise;
-  };
+  }
 
   public async isFile(pathDescriptor: interfaces.IPathDecriptor): Promise<boolean> {
     let checkPath = await helpers.reducePathDescriptorToPath(pathDescriptor);
-    
+
     // lets check if the checkPath is a directory
     const stream = this.smartbucketRef.minioClient.listObjectsV2(this.name, checkPath, true);
     const done = plugins.smartpromise.defer<boolean>();
@@ -413,11 +446,11 @@ export class Bucket {
         done.resolve(true);
       }
     });
-    
+
     stream.on('end', () => {
       done.resolve(false);
     });
-    
+
     stream.on('error', (err) => {
       done.reject(err);
     });

ts/classes.directory.ts

@@ -2,6 +2,8 @@ import * as plugins from './plugins.js';
 import { Bucket } from './classes.bucket.js';
 import { File } from './classes.file.js';
 
+import * as helpers from './helpers.js';
+
 export class Directory {
   public bucketRef: Bucket;
   public parentDirectoryRef: Directory;
@@ -65,24 +67,37 @@ export class Directory {
   public async getFile(optionsArg: {
     name: string;
     createWithContents?: string | Buffer;
+    getFromTrash?: boolean;
   }): Promise<File> {
+    const pathDescriptor = {
+      directory: this,
+      path: optionsArg.name,
+    };
     // check wether the file exists
     const exists = await this.bucketRef.fastExists({
-      path: this.getBasePath() + optionsArg.name,
+      path: await helpers.reducePathDescriptorToPath(pathDescriptor),
     });
+    if (!exists && optionsArg.getFromTrash) {
+      const trash = await this.bucketRef.getTrash();
+      const trashedFile = await trash.getTrashedFileByOriginalName(
+        pathDescriptor
+      )
+      return trashedFile;
+    }
     if (!exists && !optionsArg.createWithContents) {
       return null;
     }
     if (!exists && optionsArg.createWithContents) {
-      await this.fastPut({
-        path: optionsArg.name,
+      await File.create({
+        directory: this,
+        name: optionsArg.name,
         contents: optionsArg.createWithContents,
       });
     }
     return new File({
       directoryRefArg: this,
       fileName: optionsArg.name,
-    })
+    });
   }
 
   /**
@@ -120,7 +135,7 @@ export class Directory {
       },
       finalFunction: async (tools) => {
         done.resolve();
-      }
+      },
     });
     fileNameStream.pipe(duplexStream);
     await done.promise;
@@ -159,7 +174,7 @@ export class Directory {
       },
       finalFunction: async (tools) => {
         done.resolve();
-      }
+      },
     });
     completeDirStream.pipe(duplexStream);
     await done.promise;
@@ -234,26 +249,52 @@ export class Directory {
     return result;
   }
 
-  public fastGetStream(optionsArg: {
-    path: string;
-  }, typeArg: 'webstream'): Promise<ReadableStream>
-  public async fastGetStream(optionsArg: {
-    path: string;
-  }, typeArg: 'nodestream'): Promise<plugins.stream.Readable>
+  public fastGetStream(
+    optionsArg: {
+      path: string;
+    },
+    typeArg: 'webstream'
+  ): Promise<ReadableStream>;
+  public async fastGetStream(
+    optionsArg: {
+      path: string;
+    },
+    typeArg: 'nodestream'
+  ): Promise<plugins.stream.Readable>;
 
   /**
    * fastGetStream
    * @param optionsArg
-   * @returns 
+   * @returns
    */
-  public async fastGetStream(optionsArg: { path: string; }, typeArg: 'webstream' | 'nodestream'): Promise<ReadableStream | plugins.stream.Readable>{
+  public async fastGetStream(
+    optionsArg: { path: string },
+    typeArg: 'webstream' | 'nodestream'
+  ): Promise<ReadableStream | plugins.stream.Readable> {
     const path = plugins.path.join(this.getBasePath(), optionsArg.path);
-    const result = await this.bucketRef.fastGetStream({
-      path
-    }, typeArg as any);
+    const result = await this.bucketRef.fastGetStream(
+      {
+        path,
+      },
+      typeArg as any
+    );
     return result;
   }
 
+  /**
+   * fast put stream
+   */
+  public async fastPutStream(optionsArg: {
+    path: string;
+    stream: plugins.stream.Readable;
+  }): Promise<void> {
+    const path = plugins.path.join(this.getBasePath(), optionsArg.path);
+    await this.bucketRef.fastPutStream({
+      path,
+      readableStream: optionsArg.stream,
+    });
+  }
+
   /**
    * removes a file within the directory
    * @param optionsArg

ts/classes.file.ts

@@ -33,6 +33,10 @@ export class File {
       fileName: optionsArg.name,
     });
     if (contents instanceof plugins.stream.Readable) {
+      await optionsArg.directory.fastPutStream({
+        path: optionsArg.name,
+        stream: contents,
+      });
     } else {
       await optionsArg.directory.fastPut({
         path: optionsArg.name,
@@ -112,10 +116,10 @@ export class File {
           originalPath: this.getBasePath(),
         },
       });
-      const trashName = plugins.smartunique.uuid4();
+      const trash = await this.parentDirectoryRef.bucketRef.getTrash();
       await this.move({
-        directory: await this.parentDirectoryRef.bucketRef.getBaseDirectory(),
-        path: plugins.path.join('trash', trashName),
+        directory: await trash.getTrashDir(),
+        path: await trash.getTrashKeyByOriginalBasePath(this.getBasePath()),
       });
     }
     
@@ -160,7 +164,7 @@ export class File {
     ) {
       await this.parentDirectoryRef.bucketRef.fastPutStream({
         path: this.getBasePath(),
-        dataStream: optionsArg.contents,
+        readableStream: optionsArg.contents,
       });
     } else if (Buffer.isBuffer(optionsArg.contents)) {
       await this.parentDirectoryRef.bucketRef.fastPut({

ts/classes.trash.ts

@@ -0,0 +1,30 @@
+import * as plugins from './plugins.js';
+import * as interfaces from './interfaces.js';
+import * as helpers from './helpers.js';
+import type { Bucket } from './classes.bucket.js';
+import type { Directory } from './classes.directory.js';
+import type { File } from './classes.file.js';
+
+
+export class Trash {
+  public bucketRef: Bucket;
+
+  constructor(bucketRefArg: Bucket) {
+    this.bucketRef = bucketRefArg;
+  }
+
+  public async getTrashDir() {
+    return this.bucketRef.getDirectoryFromPath({ path: '.trash' });
+  }
+
+  public async getTrashedFileByOriginalName(pathDescriptor: interfaces.IPathDecriptor): Promise<File> {
+    const trashDir = await this.getTrashDir();
+    const originalPath = await helpers.reducePathDescriptorToPath(pathDescriptor);
+    const trashKey = await this.getTrashKeyByOriginalBasePath(originalPath);
+    return trashDir.getFile({ name: trashKey });
+  }
+
+  public async getTrashKeyByOriginalBasePath (originalPath: string): Promise<string> {
+    return plugins.smartstring.base64.encode(originalPath);
+  }
+}

ts/plugins.ts

@@ -10,9 +10,10 @@ 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';
+import * as smartstring from '@push.rocks/smartstring';
 import * as smartunique from '@push.rocks/smartunique';
 
-export { smartmime, smartpath, smartpromise, smartrx, smartstream, smartunique };
+export { smartmime, smartpath, smartpromise, smartrx, smartstream, smartstring, smartunique };
 
 // @tsclass
 import * as tsclass from '@tsclass/tsclass';